feat: add Adrapid plugin

demo/mcp/corsair.ts

@@ -1,6 +1,5 @@
 import 'dotenv/config';
 import { github } from '@corsair-dev/github';
-import { gmail } from '@corsair-dev/gmail';
 import { linear } from '@corsair-dev/linear';
 // import { googlecalendar } from '@corsair-dev/googlecalendar'
 import { slack } from '@corsair-dev/slack';

packages/adrapid/client.ts

@@ -0,0 +1,60 @@
+import type { ApiRequestOptions, OpenAPIConfig } from 'corsair/http';
+import { request } from 'corsair/http';
+
+export class AdrapidAPIError extends Error {
+	constructor(
+		message: string,
+		public readonly code?: string,
+	) {
+		super(message);
+		this.name = 'AdrapidAPIError';
+	}
+}
+
+// TODO: Update with your API base URL
+const ADRAPID_API_BASE = 'https://api.example.com';
+
+export async function makeAdrapidRequest<T>(
+	endpoint: string,
+	apiKey: string,
+	options: {
+		method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+		body?: Record<string, unknown>;
+		query?: Record<string, string | number | boolean | undefined>;
+	} = {},
+): Promise<T> {
+	const { method = 'GET', body, query } = options;
+
+	const config: OpenAPIConfig = {
+		BASE: ADRAPID_API_BASE,
+		VERSION: '1.0.0',
+		WITH_CREDENTIALS: false,
+		CREDENTIALS: 'omit',
+		TOKEN: apiKey,
+		HEADERS: {
+			'Content-Type': 'application/json',
+			// TODO: Add authentication headers
+			// 'Authorization': \`Bearer \${apiKey}\`
+		},
+	};
+
+	const requestOptions: ApiRequestOptions = {
+		method,
+		url: endpoint,
+		body:
+			method === 'POST' || method === 'PUT' || method === 'PATCH'
+				? body
+				: undefined,
+		mediaType: 'application/json; charset=utf-8',
+		query: method === 'GET' ? query : undefined,
+	};
+
+	try {
+		return await request<T>(config, requestOptions);
+	} catch (error) {
+		if (error instanceof Error) {
+			throw new AdrapidAPIError(error.message);
+		}
+		throw new AdrapidAPIError('Unknown error');
+	}
+}

packages/adrapid/endpoints/example.ts

@@ -0,0 +1,18 @@
+import { logEventFromContext } from 'corsair/core';
+import type { AdrapidEndpoints } from '..';
+import { makeAdrapidRequest } from '../client';
+import type { AdrapidEndpointOutputs } from './types';
+
+export const get: AdrapidEndpoints['exampleGet'] = async (ctx, input) => {
+	const response = await makeAdrapidRequest<
+		AdrapidEndpointOutputs['exampleGet']
+	>(`example/${input.id}`, ctx.key, { method: 'GET' });
+
+	await logEventFromContext(
+		ctx,
+		'adrapid.example.get',
+		{ ...input },
+		'completed',
+	);
+	return response;
+};

packages/adrapid/endpoints/index.ts

@@ -0,0 +1,7 @@
+import { get as exampleGet } from './example';
+
+export const Example = {
+	get: exampleGet,
+};
+
+export * from './types';

packages/adrapid/endpoints/types.ts

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+
+const ExampleGetInputSchema = z.object({
+	id: z.string(),
+});
+
+export type ExampleGetInput = z.infer<typeof ExampleGetInputSchema>;
+
+const ExampleGetResponseSchema = z.object({
+	id: z.string(),
+});
+
+export type ExampleGetResponse = z.infer<typeof ExampleGetResponseSchema>;
+
+export type AdrapidEndpointInputs = {
+	exampleGet: ExampleGetInput;
+};
+
+export type AdrapidEndpointOutputs = {
+	exampleGet: ExampleGetResponse;
+};
+
+export const AdrapidEndpointInputSchemas = {
+	exampleGet: ExampleGetInputSchema,
+} as const;
+
+export const AdrapidEndpointOutputSchemas = {
+	exampleGet: ExampleGetResponseSchema,
+} as const;

packages/adrapid/error-handlers.ts

@@ -0,0 +1,31 @@
+import type { CorsairErrorHandler } from 'corsair/core';
+import { ApiError } from 'corsair/http';
+
+export const errorHandlers = {
+	RATE_LIMIT_ERROR: {
+		match: (error: Error) => {
+			if (error instanceof ApiError && error.status === 429) return true;
+			const msg = error.message.toLowerCase();
+			return msg.includes('rate_limited') || msg.includes('429');
+		},
+		handler: async (error: Error) => {
+			let retryAfterMs: number | undefined;
+			if (error instanceof ApiError && error.retryAfter !== undefined) {
+				retryAfterMs = error.retryAfter;
+			}
+			return { maxRetries: 5, headersRetryAfterMs: retryAfterMs };
+		},
+	},
+	AUTH_ERROR: {
+		match: (error: Error) => {
+			if (error instanceof ApiError && error.status === 401) return true;
+			const msg = error.message.toLowerCase();
+			return msg.includes('unauthorized') || msg.includes('invalid_auth');
+		},
+		handler: async () => ({ maxRetries: 0 }),
+	},
+	DEFAULT: {
+		match: () => true,
+		handler: async () => ({ maxRetries: 0 }),
+	},
+} satisfies CorsairErrorHandler;

packages/adrapid/index.ts

@@ -0,0 +1,206 @@
+import type {
+	AuthTypes,
+	BindEndpoints,
+	BindWebhooks,
+	CorsairEndpoint,
+	CorsairErrorHandler,
+	CorsairPlugin,
+	CorsairPluginContext,
+	CorsairWebhook,
+	KeyBuilderContext,
+	PickAuth,
+	PluginAuthConfig,
+	PluginPermissionsConfig,
+	RequiredPluginEndpointMeta,
+	RequiredPluginEndpointSchemas,
+	RequiredPluginWebhookSchemas,
+} from 'corsair/core';
+import { Example } from './endpoints';
+import type {
+	AdrapidEndpointInputs,
+	AdrapidEndpointOutputs,
+} from './endpoints/types';
+import {
+	AdrapidEndpointInputSchemas,
+	AdrapidEndpointOutputSchemas,
+} from './endpoints/types';
+import { errorHandlers } from './error-handlers';
+import { AdrapidSchema } from './schema';
+import { ExampleWebhooks } from './webhooks';
+import { resolveAdrapidOAuthWebhookTenantLink } from './webhooks/oauth-tenant-link';
+import { matchAdrapidTenantWebhook } from './webhooks/tenant-matcher';
+import type { AdrapidWebhookOutputs, ExampleEvent } from './webhooks/types';
+import { ExampleEventSchema } from './webhooks/types';
+
+export type AdrapidPluginOptions = {
+	authType?: PickAuth<'api_key' | 'oauth_2'>;
+	key?: string;
+	webhookSecret?: string;
+	hooks?: InternalAdrapidPlugin['hooks'];
+	webhookHooks?: InternalAdrapidPlugin['webhookHooks'];
+	errorHandlers?: CorsairErrorHandler;
+	permissions?: PluginPermissionsConfig<typeof adrapidEndpointsNested>;
+};
+
+export type AdrapidContext = CorsairPluginContext<
+	typeof AdrapidSchema,
+	AdrapidPluginOptions
+>;
+
+export type AdrapidKeyBuilderContext = KeyBuilderContext<AdrapidPluginOptions>;
+
+export type AdrapidBoundEndpoints = BindEndpoints<
+	typeof adrapidEndpointsNested
+>;
+
+type AdrapidEndpoint<K extends keyof AdrapidEndpointOutputs> = CorsairEndpoint<
+	AdrapidContext,
+	AdrapidEndpointInputs[K],
+	AdrapidEndpointOutputs[K]
+>;
+
+export type AdrapidEndpoints = {
+	exampleGet: AdrapidEndpoint<'exampleGet'>;
+};
+
+type AdrapidWebhook<
+	K extends keyof AdrapidWebhookOutputs,
+	TEvent,
+> = CorsairWebhook<AdrapidContext, TEvent, AdrapidWebhookOutputs[K]>;
+
+export type AdrapidWebhooks = {
+	example: AdrapidWebhook<'example', ExampleEvent>;
+};
+
+export type AdrapidBoundWebhooks = BindWebhooks<AdrapidWebhooks>;
+
+const adrapidEndpointsNested = {
+	example: {
+		get: Example.get,
+	},
+} as const;
+
+const adrapidWebhooksNested = {
+	example: {
+		example: ExampleWebhooks.example,
+	},
+} as const;
+
+export const adrapidEndpointSchemas = {
+	'example.get': {
+		input: AdrapidEndpointInputSchemas.exampleGet,
+		output: AdrapidEndpointOutputSchemas.exampleGet,
+	},
+} as const satisfies RequiredPluginEndpointSchemas<
+	typeof adrapidEndpointsNested
+>;
+
+const adrapidWebhookSchemas = {
+	'example.example': {
+		description: 'An example webhook event',
+		payload: ExampleEventSchema,
+		response: ExampleEventSchema,
+	},
+} as const satisfies RequiredPluginWebhookSchemas<typeof adrapidWebhooksNested>;
+
+const defaultAuthType: AuthTypes = 'api_key' as const;
+
+const adrapidEndpointMeta = {
+	'example.get': {
+		riskLevel: 'read',
+		description: 'Get an example resource by ID',
+	},
+} as const satisfies RequiredPluginEndpointMeta<typeof adrapidEndpointsNested>;
+
+export const adrapidAuthConfig = {
+	api_key: {
+		account: ['tenant_external_id'] as const,
+	},
+	oauth_2: {
+		account: ['tenant_external_id'] as const,
+	},
+} as const satisfies PluginAuthConfig;
+
+export type BaseAdrapidPlugin<T extends AdrapidPluginOptions> = CorsairPlugin<
+	'adrapid',
+	typeof AdrapidSchema,
+	typeof adrapidEndpointsNested,
+	typeof adrapidWebhooksNested,
+	T,
+	typeof defaultAuthType
+>;
+
+export type InternalAdrapidPlugin = BaseAdrapidPlugin<AdrapidPluginOptions>;
+
+export type ExternalAdrapidPlugin<T extends AdrapidPluginOptions> =
+	BaseAdrapidPlugin<T>;
+
+export function adrapid<const T extends AdrapidPluginOptions>(
+	incomingOptions: AdrapidPluginOptions & T = {} as AdrapidPluginOptions & T,
+): ExternalAdrapidPlugin<T> {
+	const options = {
+		...incomingOptions,
+		authType: incomingOptions.authType ?? defaultAuthType,
+	};
+	return {
+		id: 'adrapid',
+		authConfig: adrapidAuthConfig,
+		schema: AdrapidSchema,
+		options: options,
+		hooks: options.hooks,
+		webhookHooks: options.webhookHooks,
+		endpoints: adrapidEndpointsNested,
+		webhooks: adrapidWebhooksNested,
+		endpointMeta: adrapidEndpointMeta,
+		endpointSchemas: adrapidEndpointSchemas,
+		webhookSchemas: adrapidWebhookSchemas,
+		pluginWebhookMatcher: (request) => {
+			const headers = request.headers;
+			// TODO: Update to match your webhook signature headers
+			return 'x-adrapid-signature' in headers;
+		},
+		pluginTenantWebhookMatcher: matchAdrapidTenantWebhook,
+		oauthWebhookTenantLinkResolver: resolveAdrapidOAuthWebhookTenantLink,
+		errorHandlers: {
+			...errorHandlers,
+			...options.errorHandlers,
+		},
+		keyBuilder: async (ctx: AdrapidKeyBuilderContext, source) => {
+			if (source === 'webhook' && options.webhookSecret) {
+				return options.webhookSecret;
+			}
+
+			if (source === 'webhook') {
+				const res = await ctx.keys.get_webhook_signature();
+				return res ?? '';
+			}
+
+			if (source === 'endpoint' && options.key) {
+				return options.key;
+			}
+
+			if (source === 'endpoint' && ctx.authType === 'api_key') {
+				const res = await ctx.keys.get_api_key();
+				return res ?? '';
+			}
+
+			if (source === 'endpoint' && ctx.authType === 'oauth_2') {
+				const res = await ctx.keys.get_access_token();
+				return res ?? '';
+			}
+
+			return '';
+		},
+	} satisfies InternalAdrapidPlugin;
+}
+
+export type {
+	AdrapidEndpointInputs,
+	AdrapidEndpointOutputs,
+	ExampleGetInput,
+	ExampleGetResponse,
+} from './endpoints/types';
+export type {
+	AdrapidWebhookOutputs,
+	ExampleEvent,
+} from './webhooks/types';