GageList plugin

• The pair mints a token, and the token expires. The plugin posts the pair to /api/token with grant_type=password, caches the token for the hour GageList allows, and mints a new one after a 401. A 401 from a protected route means the token was refused, not that the pair is wrong; a rejected pair comes back from the token endpoint as invalid_client.
• Field names are PascalCase and case-sensitive. The API binds SerialNumber, CalibrationDueDate and so on, and one of them is misspelled in the API itself: DateAquired, not DateAcquired. Use the API’s spelling.
• The lists are POST, not GET. gages.list, calibrations.list and manufacturers.list take their paging in the request body as start and record_number, and answer total plus count. The plugin returns next_start, which is null on the last page.
• An update replaces the record. gages.update and calibrations.update take the whole object with its Id, so a field left out is not “unchanged” in the way a PATCH would leave it. Read the record with gages.get or calibrations.get, change the fields you mean to change, and send the whole record back.
• Deletes are POSTs. GageList deletes with POST to a Delete/{id} path rather than an HTTP DELETE, and a gage is marked deleted rather than erased.
• The custom-value route takes a bare array. customFields.updateValues posts [{ FieldId, RefID, RefType, FieldValue }], not the usual object wrapper. RefType is 1 for a gage and 2 for a calibration, and a wrong one writes to the other table, so it is constrained to those two values.
• A certificate is a PDF, not JSON. calibrations.certificate returns the file’s bytes base64-encoded in certificate, with encoding, contentType and byteLength; decode it before saving the file.
• No webhooks. GageList does not push; a caller polls.

• 18 typed API operations

Setup

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

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

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

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

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

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

gagelist()

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

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.gagelist.api.gages.list({ start: 0, record_number: 25 });

const tenant = corsair.withTenant('acme');
await tenant.gagelist.api.calibrations.create({
	EquipmentRefId: 12,
	EquipmentAsFound: '0.01',
	EquipmentAsLeft: '0.00',
	CalibrationDueDate: '2027-04-24T00:00:00Z',
});

What’s next