Aller au contenu principal

SDK TypeScript

Toutes les API Mountaya typées de bout en bout

@mountaya/client appelle l'API de Map Studio, la Data API et la Tile API depuis Node, un navigateur ou React Native. Généré à partir du schéma public, il ne comporte aucune dépendance à l'exécution.

Compatible avec les outils que vous utilisez déjà

Nos réponses à vos défis

Appelez toutes les API Mountaya depuis TypeScript sans écrire de client.

Un seul ajout à votre lockfile

Le client n'a aucune dépendance à l'exécution : rien de plus ne se charge dans votre bundle.

Aucune clé secrète côté navigateur

Le paquet expose un point d'entrée ./browser dépourvu de type d'identifiant pour les clés secrètes. Si une clé serveur est transmise à du code navigateur, la compilation échoue.

Des horodatages convertis en dates

Les réponses arrivent dans leur véritable type : un horodatage devient un objet Date, et une réponse binaire, des octets accompagnés de leur type de contenu.

Paquets

Les paquets à installer pour TypeScript

Le client appelle toutes les API Mountaya, et les composants affichent le résultat avec leur propre moteur de rendu.

@mountaya/client

npm install @mountaya/client

@mountaya/elements

npm install @mountaya/elements @mountaya/client maplibre-gl@6.18.0

Intégration

Installer, s'authentifier, appeler, afficher

Chaque extrait contient ses propres imports et fonctionne tel quel. Émettez le jeton de session depuis votre serveur, puis laissez la carte signer elle-même ses requêtes.

TypeScript

Installer

MapLibre s'installe à côté des composants, dans la version exacte sur laquelle leur worker de carte est construit.

npm install @mountaya/client @mountaya/elements maplibre-gl@6.18.0

S'authentifier

Une clé publiable peut figurer sans risque dans un navigateur et suffit pour afficher la carte. La Data API exige en plus, à chaque requête, un jeton de session émis par votre serveur à partir de votre clé secrète.

// On your server, and only there: a secret key can never reach a browser.
import { Mountaya } from "@mountaya/client";

const secretKey = process.env.MOUNTAYA_SECRET_KEY;
if (secretKey === undefined) {
  throw new Error("MOUNTAYA_SECRET_KEY is not set.");
}

const client = new Mountaya({ credential: { secretKey } });

const { data } = await client.admin.sessions.postSession({
  body: { publishable_key: "pk_…" },
});

// Return data.token and data.expires_at to the browser. The token is short-lived.

Appeler

Chaque opération correspond à une méthode typée. La Data API repose sur GraphQL, mais c'est le client qui rédige la requête à votre place.

import { Mountaya } from "@mountaya/client";

const client = new Mountaya({
  credential: { publishableKey: "pk_…", sessionToken },
});

const route = await client.data.directions({
  activity: "HIKING_AND_TRAIL",
  waypoints: [[6.8712, 45.9231], [6.9271, 45.9822]], // Chamonix to Argentière
});

Afficher

Transmettez le client à la carte : elle signe ensuite elle-même ses requêtes de tuiles.

import { Mountaya } from "@mountaya/client";
import { MountayaMap } from "@mountaya/elements";
import "@mountaya/elements/styles.css";

const client = new Mountaya({ credential: { publishableKey: "pk_…" } });

const map = new MountayaMap({
  container: "map",
  client,
  center: [6.86, 45.83],
  zoom: 12,
});

// All three return a promise: they fetch a specification through the client.
await map.setItinerary(itineraryId);
await map.setOverlay("aspectslope");  // exclusive: replaces the previous overlay
await map.addEnrichment("hillshade"); // additive: stacks underneath

Qu'allez-vous construire avec les SDK et Elements ?

Expliquez-nous ce que votre produit doit afficher. Nous vous montrerons les SDK et Elements qui s'en chargent.

Questions fréquentes

@mountaya/client pour appeler les API et @mountaya/elements pour afficher une carte. maplibre-gl s'installe à côté des composants, dans la version exacte sur laquelle leur worker de carte est construit. Les composants en tirent le moteur de rendu et signent ses requêtes.

Oui. Le même paquet fonctionne dans Node, dans les navigateurs et dans React Native. Le point d'entrée ./browser donne accès au même client, sans les types d'identifiants qui doivent rester sur un serveur.

Une clé publiable peut figurer sans risque dans un navigateur et suffit pour afficher la carte. La Data API exige en plus un jeton de session à chaque requête. Vous l'émettez depuis votre serveur à partir de votre clé secrète, qui ne le quitte jamais.

Il est généré à partir du dépôt public de schémas : chaque méthode reprend ainsi l'identifiant d'opération du schéma. Chaque version indique le tag du schéma à partir duquel elle a été générée.