Get started
Reference

Entry points

Entry points

Import from the narrowest entry point that holds what you need: each one brings only the peers listed under it.

@mountaya/client

The Mountaya API client: Map Studio API, Tile API and the GraphQL Data API, with no runtime dependencies.

No peer dependencies.

@mountaya/client

The Mountaya API client: the Map Studio API, the Tile API and the GraphQL Data API, behind one credential.

  • Requires no peer

@mountaya/client/browser

The browser-safe entry point of @mountaya/client.

  • Requires no peer

@mountaya/client/events

The Server-Sent Events half of talking to Mountaya: a frame parser that turns a text/event-stream byte stream into decoded records, a reader that drives a Response body through it frame by frame, and an opener that wires those over a fetch the caller supplies, with resume and abort.

  • Requires no peer

@mountaya/client-react

React bindings for @mountaya/client: provider, session lifecycle and query hooks. Renders nothing.

PeerRangeOptional
@mountaya/client0.1.0
@tanstack/react-query^5
react^19

@mountaya/client-react

React bindings for the Mountaya API client.

  • Requires @mountaya/client, @tanstack/react-query, react

@mountaya/client-react/query

The query keys and read options, with no React behind them.

  • Requires @mountaya/client
  • Types name @tanstack/react-query
  • Holds no React: a React Server Component can import it and call what it exports

@mountaya/elements

Render Mountaya data on MapLibre GL JS. Never calls fetch.

PeerRangeOptional
@maplibre/maplibre-gl-directions^0.10.1Yes
@mountaya/client0.1.0Yes
maplibre-gl^6.10.0Yes
mediabunny^1.61.6Yes
terra-draw^1.38.0Yes
terra-draw-maplibre-gl-adapter^1.5.0Yes

@mountaya/elements

Render Mountaya data on MapLibre GL JS.

  • Requires maplibre-gl
  • Types name @mountaya/client

@mountaya/elements/agent

Driving a co-pilot run, and the conversation it produces.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/camera

Plans a flight over a route, with nothing to draw it on.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/collab

The live collaboration engine.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/data

Reads one Mountaya resource, for an element handed an id.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/editor

The map client an editor drives.

  • Requires @maplibre/maplibre-gl-directions, maplibre-gl, terra-draw, terra-draw-maplibre-gl-adapter
  • Types name @mountaya/client

@mountaya/elements/errors

The error family, on an entry of its own because every other entry needs it.

  • Requires no peer

@mountaya/elements/geo

The geographic core, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/i18n

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/i18n/fr

@mountaya/elements/i18n/fr: the elements' copy in French, an entry of its own so a page that reads in English never loads it.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/icons

The glyph pipeline, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/layers

What this package draws, and in what order, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/map-client

  • Requires no peer
  • Types name @mountaya/client, maplibre-gl

@mountaya/elements/navigation

Following a route, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/profile

The elevation profile's maths, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/seams

The sockets an element is HANDED, rather than the ones it reaches for.

  • Requires no peer
  • Types name @mountaya/client

A search box's state machine and its row model, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/elements/style

The style builders, with no renderer attached.

  • Requires no peer
  • Types name @mountaya/client, maplibre-gl

@mountaya/elements/styles.css

The stylesheet the package's components paint with. Import it once, at your application's entry.

@mountaya/elements/maplibre-worker.mjs

MapLibre's web worker, for a build that serves it from an address of its own.

@mountaya/elements/testing

  • Requires maplibre-gl
  • Types name @mountaya/client

@mountaya/elements/timezone

Where a timezone puts you on the map.

  • Requires no peer

@mountaya/elements/units

Every unit conversion the SDK makes, with no renderer attached.

  • Requires no peer

@mountaya/elements/video

Recording a map, and the elevation profile burnt into the frame.

  • Requires maplibre-gl
  • Loads on demand mediabunny
  • Types name @maplibre/maplibre-gl-directions, @mountaya/client, terra-draw, terra-draw-maplibre-gl-adapter

@mountaya/elements/view

The map client of a host that shows a map and never edits one.

  • Requires maplibre-gl
  • Types name @mountaya/client

@mountaya/elements-react

React elements for Mountaya: MapView, the map controls and a standalone elevation profile. Fetches nothing, and brings no design system.

PeerRangeOptional
@googlemaps/js-api-loader^2Yes
@maplibre/maplibre-gl-directions^0.10.1Yes
@mountaya/elements0.1.0
@types/google.maps^3.53.1Yes
maplibre-gl^6.10.0Yes
react^19
terra-draw^1.38.0Yes
terra-draw-maplibre-gl-adapter^1.5.0Yes

@mountaya/elements-react

  • Requires @mountaya/elements, maplibre-gl, react
  • Loads on demand @googlemaps/js-api-loader

@mountaya/elements-react/editor

React over a map a host drives through a MapClient.

  • Requires @maplibre/maplibre-gl-directions, @mountaya/elements, maplibre-gl, react, terra-draw, terra-draw-maplibre-gl-adapter

@mountaya/elements-react/elements

The elements that need no map.

  • Requires @mountaya/elements, react
  • Types name maplibre-gl

@mountaya/elements-react/headless

The context these elements read, and the lifecycle primitives they are built on, with no renderer attached.

  • Requires @mountaya/elements, react
  • Types name maplibre-gl

@mountaya/elements-react/styles.css

The stylesheet the package's components paint with. Import it once, at your application's entry.

@mountaya/studio

The Mountaya map studio's rules, contracts and stores: renderer-free, framework-free, never calls fetch.

PeerRangeOptional
@mountaya/client0.1.0Yes
@mountaya/elements0.1.0

@mountaya/studio

The map studio's logic, with no renderer and no framework attached.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/agent

Which tools an assistant may reach for, when, and the machines that run the studio's conversations over them.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/engines

The studio's stateful machines, each one object a binding drives.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/handlers

The map studio's behaviour: one handler per published tool name, written against the StudioToolContext every dispatch carries.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/plugins

What a third party may ADD to a studio, and the machine that holds it.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/seams

Every capability the studio takes from the world around it.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/strings

The studio's words, and the pure rules that pick one.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/strings/fr

The studio's copy in French, an entry of its own so a page that reads in English never loads it.

  • Requires no peer
  • Types name @mountaya/client

@mountaya/studio/testing

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio/time

Where the sun is, seen from a point on the ground.

  • Requires @mountaya/elements
  • Types name @mountaya/client

@mountaya/studio-react

Mountaya's map studio, assembled: the rows, lists, pickers and panels a working editor is made of.

PeerRangeOptional
@mountaya/client0.1.0
@mountaya/client-react0.1.0
@mountaya/elements0.1.0
@mountaya/elements-react0.1.0
@mountaya/studio0.1.0
@tanstack/react-query^5
maplibre-gl^6.10.0
react^19

@mountaya/studio-react

Mountaya's map studio, as components.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, maplibre-gl, react

@mountaya/studio-react/headless

The studio's state, lifecycle and actions, with no markup of any kind.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, react
  • Types name maplibre-gl

@mountaya/studio-react/map

The hooks that bind a studio's state to the map it draws on.

  • Requires @mountaya/elements, @mountaya/elements-react, @mountaya/studio, maplibre-gl, react
  • Types name @mountaya/client, @tanstack/react-query

@mountaya/studio-react/embed

Configuring an Embedded Studio, and previewing what it will be.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, maplibre-gl, react

@mountaya/studio-react/import

Bringing an itinerary in from somewhere else.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, maplibre-gl, react

@mountaya/studio-react/video

The wizard that plans and records a flight over a route.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, maplibre-gl, react

@mountaya/studio-react/copilot

The studio's co-pilot, for a host that arranges its own studio.

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, maplibre-gl, react

@mountaya/studio-react/testing

  • Requires @mountaya/client, @mountaya/client-react, @mountaya/elements, @mountaya/elements-react, @mountaya/studio, @tanstack/react-query, react
  • Types name maplibre-gl

@mountaya/studio-react/styles.css

The stylesheet the package's components paint with. Import it once, at your application's entry.