Radar plugin

• No Bearer prefix. Radar reads the raw key, so Authorization: prj_live_sk_… is correct and Authorization: Bearer … is not. The plugin sets the header literally for that reason.
• Results follow the operation schema. Radar wire responses include meta, but the plugin returns fields such as addresses, user or geofence. A resolved call has passed output validation. Only read meta.code on results that retain meta, such as list results.
• A 402 is a spent quota, not a rate limit. It means the organisation is disabled or the usage allowance is exhausted, and no retry fixes it. The plugin matches it first and stops immediately.
• 429 may mean selective throttling. Radar says no state changed in that case, so a read is safe to repeat; the plugin retries replayable reads three times and honours Retry-After. Writes are never replayed.
• 451 is a country blocklist. It is a legal refusal, not a request defect, and no retry clears it.
• Paging is by timestamp. Users and geofences use the last row’s updatedAt as updated_before. Trips use created_before with sort_by: createdAt. List results retain meta; has_more is true only when Radar supplies meta.hasMore. If that flag is absent, continue until an empty page.
• Choosing a geofence type. type takes circle, polygon or isochrone; a circle takes a centre and a radius in meters, an isochrone takes a centre, travel mode and duration in minutes, and a polygon takes a closed ring.
• A geofence is a circle, a polygon or an isochrone. A circle takes a center and a radius, a polygon takes a closed ring with the first point repeated last, and the schema rejects a shape that is missing its required part.
• geofences.upsert is an upsert. Supplying a tag and external id creates the geofence when none matches; supplying geofence_id selects an update by Radar id. The plugin still requires tag, external_id, description, type and the geometry inputs for that type.
• track creates a user. It is the write that turns a location update into a user, so it needs a device_id, both coordinates and a positive accuracy. The plugin never replays it.
• Coordinates are [longitude, latitude] in bodies. Geofence geometry follows the GeoJSON convention, which is the reverse of the latitude,longitude string the geocode routes take.

• 16 typed API operations

​

Setup

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

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		radar(),
	],
	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!,
	},
});

radar()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.radar.api.geocode.reverse({ coordinates: '40.70390,-73.98670' });

const tenant = corsair.withTenant('acme');
await tenant.radar.api.geofences.upsert({
	tag: 'store',
	external_id: 'store-42',
	description: 'Brooklyn store',
	type: 'circle',
	center: [-73.9867, 40.7039],
	radius: 100,
});

​

What’s next