Prox OS Internal Docs
PlatformPackagesFrontendData

Maps Package

@prox-os/maps is the official map and geospatial surface package for Prox OS.

@prox-os/maps is the official map and geospatial surface package for Prox OS. It provides contracts, MapLibre-based preview components, markers, popups, layer declarations, provider badges, attribution, static fallback previews, and context action intent.

Core Types

  • OsCoordinate
  • OsGeoPoint
  • OsGeoBounds
  • OsGeoSourceRef
  • OsMapSource
  • OsMapLayerConfig
  • OsMapAction

Core Components

  • OsMap
  • MapLibreMapPreview
  • OsMapCard
  • OsMapMarker
  • OsMapPopup
  • OsMapLayer
  • OsMapProviderBadge
  • OsMapAttribution
  • OsStaticMapPlaceholder
  • OsMapContextActions

Renderer Policy

MapLibre GL JS is the Phase 1 default renderer. @vis.gl/react-maplibre is the first React wrapper, but app code should consume @prox-os/maps rather than the wrapper directly.

OSM data is open, but public OSM tile servers are not a production CDN for Prox OS. Production deployments should use self-hosted, static-hosted, cached, or properly licensed tile infrastructure such as PMTiles, Protomaps/OpenMapTiles, R2, and Cloudflare caching.

Storybook

Open UI Workshop and look under Maps for Madrid demos, markers, popups, GeoJSON layer previews, provider badges, attribution notices, loading/error states, static placeholders, context actions, and MapLibre demo style previews.

Current Limitations

  • No real geocoding.
  • No real routing.
  • No production tile service.
  • No map editor.
  • No offline map downloads.

See docs/platform/architecture/media/maps.md for the Phase 2+ roadmap.

On this page