Mapbox plugin

• Longitude comes first. Coordinates are { longitude, latitude } objects, and the plugin writes them into URLs as longitude,latitude as Mapbox expects. A latitude outside -90 to 90 or a longitude outside -180 to 180 is rejected before a request is sent.
• Profiles are mapbox/driving-traffic, mapbox/driving, mapbox/walking and mapbox/cycling, with the mapbox/ prefix.
• No match is not an error for geocoding. A query with no result is a successful answer with an empty features list.
• No route is an error for routing. Directions, matrix and trip calls that Mapbox answers with HTTP 200 and code: 'NoRoute', 'NoSegment' or 'NotImplemented' throw a MapboxAPIError carrying that code, rather than returning an empty routes list.
• Mapbox silently ignores some bad values, so the plugin rejects them first: a geocoding limit above 10 (above 5 for reverse), isochrone contours that are not strictly increasing, annotations without overview: 'full', language without steps: true, and exclude values the profile does not support.
• Reverse geocoding needs exactly one entry in types when limit is above 1.
• Limits are per product and per minute, and Mapbox reports yours in x-rate-limit-limit; a default token showed 1,000 for geocoding v6, 300 for directions and isochrone, 60 for matrix and 50 for tilequery. A 429 is retried twice, waiting for x-rate-limit-reset, or 60 seconds when Mapbox sends no timing header.
• Left out. The Static Images API returns PNG bytes, which the shared HTTP client cannot return intact. Optimization v2 (/optimized-trips/v2, async jobs) answered 403 Account does not have access to this service on a default token, so only Optimization v1, which answers immediately, is wrapped as trips.optimize. Geocoding’s permanent storage flag, batch geocoding and structured input are not wrapped.
• Webhooks. Mapbox sends none for these APIs, so the plugin handles none.

• 7 typed API operations

​

Setup

npm install corsair @corsair-dev/mapbox better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/mapbox better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/mapbox better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/mapbox better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { mapbox } from '@corsair-dev/mapbox';

export const corsair = createCorsair({
	plugins: [
		mapbox(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

mapbox()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'mapbox',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.mapbox.api.geocoding.forward({ q: 'Paris', limit: 3 });

​

What’s next