feat: setup Convolo AI plugin

packages/convoloai/client.ts

@@ -0,0 +1,61 @@
+import type { ApiRequestOptions } from 'corsair/http';
+import type { OpenAPIConfig } from 'corsair/http';
+import { request } from 'corsair/http';
+
+export class ConvoloAiAPIError extends Error {
+	constructor(
+		message: string,
+		public readonly code?: string,
+	) {
+		super(message);
+		this.name = 'ConvoloAiAPIError';
+	}
+}
+
+// TODO: Update with your API base URL
+const CONVOLOAI_API_BASE = 'https://api.example.com';
+
+export async function makeConvoloAiRequest<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: CONVOLOAI_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 ConvoloAiAPIError(error.message);
+		}
+		throw new ConvoloAiAPIError('Unknown error');
+	}
+}

packages/convoloai/endpoints/example.ts

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

packages/convoloai/endpoints/index.ts

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

packages/convoloai/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 ConvoloAiEndpointInputs = {
+	exampleGet: ExampleGetInput;
+};
+
+export type ConvoloAiEndpointOutputs = {
+	exampleGet: ExampleGetResponse;
+};
+
+export const ConvoloAiEndpointInputSchemas = {
+	exampleGet: ExampleGetInputSchema,
+} as const;
+
+export const ConvoloAiEndpointOutputSchemas = {
+	exampleGet: ExampleGetResponseSchema,
+} as const;

packages/convoloai/error-handlers.ts

@@ -0,0 +1,31 @@
+import { ApiError } from 'corsair/http';
+import type { CorsairErrorHandler } from 'corsair/core';
+
+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/convoloai/index.ts

@@ -0,0 +1,202 @@
+import type {
+	BindEndpoints,
+	BindWebhooks,
+	CorsairEndpoint,
+	CorsairErrorHandler,
+	CorsairPlugin,
+	CorsairPluginContext,
+	CorsairWebhook,
+	KeyBuilderContext,
+	PickAuth,
+	PluginAuthConfig,
+	PluginPermissionsConfig,
+	RequiredPluginEndpointMeta,
+	RequiredPluginEndpointSchemas,
+	RequiredPluginWebhookSchemas,
+} from 'corsair/core';
+import type { AuthTypes } from 'corsair/core';
+import type { ConvoloAiEndpointInputs, ConvoloAiEndpointOutputs } from './endpoints/types';
+import { ConvoloAiEndpointInputSchemas, ConvoloAiEndpointOutputSchemas } from './endpoints/types';
+import type {
+	ConvoloAiWebhookOutputs,
+	ExampleEvent,
+} from './webhooks/types';
+import { ExampleEventSchema } from './webhooks/types';
+import { Example } from './endpoints';
+import { ConvoloAiSchema } from './schema';
+import { ExampleWebhooks } from './webhooks';
+import { errorHandlers } from './error-handlers';
+import { matchConvoloAiTenantWebhook } from './webhooks/tenant-matcher';
+import { resolveConvoloAiOAuthWebhookTenantLink } from './webhooks/oauth-tenant-link';
+
+export type ConvoloAiPluginOptions = {
+	authType?: PickAuth<'api_key' | 'oauth_2'>;
+	key?: string;
+	webhookSecret?: string;
+	hooks?: InternalConvoloAiPlugin['hooks'];
+	webhookHooks?: InternalConvoloAiPlugin['webhookHooks'];
+	errorHandlers?: CorsairErrorHandler;
+	permissions?: PluginPermissionsConfig<typeof convoloAiEndpointsNested>;
+};
+
+export type ConvoloAiContext = CorsairPluginContext<
+	typeof ConvoloAiSchema,
+	ConvoloAiPluginOptions
+>;
+
+export type ConvoloAiKeyBuilderContext = KeyBuilderContext<ConvoloAiPluginOptions>;
+
+export type ConvoloAiBoundEndpoints = BindEndpoints<typeof convoloAiEndpointsNested>;
+
+type ConvoloAiEndpoint<
+	K extends keyof ConvoloAiEndpointOutputs,
+> = CorsairEndpoint<
+	ConvoloAiContext,
+	ConvoloAiEndpointInputs[K],
+	ConvoloAiEndpointOutputs[K]
+>;
+
+export type ConvoloAiEndpoints = {
+	exampleGet: ConvoloAiEndpoint<'exampleGet'>;
+};
+
+type ConvoloAiWebhook<
+	K extends keyof ConvoloAiWebhookOutputs,
+	TEvent,
+> = CorsairWebhook<ConvoloAiContext, TEvent, ConvoloAiWebhookOutputs[K]>;
+
+export type ConvoloAiWebhooks = {
+	example: ConvoloAiWebhook<'example', ExampleEvent>;
+};
+
+export type ConvoloAiBoundWebhooks = BindWebhooks<ConvoloAiWebhooks>;
+
+const convoloAiEndpointsNested = {
+	example: {
+		get: Example.get,
+	},
+} as const;
+
+const convoloAiWebhooksNested = {
+	example: {
+		example: ExampleWebhooks.example,
+	},
+} as const;
+
+export const convoloAiEndpointSchemas = {
+	'example.get': {
+		input: ConvoloAiEndpointInputSchemas.exampleGet,
+		output: ConvoloAiEndpointOutputSchemas.exampleGet,
+	},
+} as const satisfies RequiredPluginEndpointSchemas<typeof convoloAiEndpointsNested>;
+
+const convoloAiWebhookSchemas = {
+	'example.example': {
+		description: 'An example webhook event',
+		payload: ExampleEventSchema,
+		response: ExampleEventSchema,
+	},
+} as const satisfies RequiredPluginWebhookSchemas<typeof convoloAiWebhooksNested>;
+
+const defaultAuthType: AuthTypes = 'api_key' as const;
+
+const convoloAiEndpointMeta = {
+	'example.get': {
+		riskLevel: 'read',
+		description: 'Get an example resource by ID',
+	},
+} as const satisfies RequiredPluginEndpointMeta<typeof convoloAiEndpointsNested>;
+
+export const convoloAiAuthConfig = {
+	api_key: {
+		account: ['tenant_external_id'] as const,
+	},
+	oauth_2: {
+		account: ['tenant_external_id'] as const,
+	},
+} as const satisfies PluginAuthConfig;
+
+export type BaseConvoloAiPlugin<T extends ConvoloAiPluginOptions> = CorsairPlugin<
+	'convoloai',
+	typeof ConvoloAiSchema,
+	typeof convoloAiEndpointsNested,
+	typeof convoloAiWebhooksNested,
+	T,
+	typeof defaultAuthType
+>;
+
+export type InternalConvoloAiPlugin = BaseConvoloAiPlugin<ConvoloAiPluginOptions>;
+
+export type ExternalConvoloAiPlugin<T extends ConvoloAiPluginOptions> =
+	BaseConvoloAiPlugin<T>;
+
+export function convoloai<const T extends ConvoloAiPluginOptions>(
+	incomingOptions: ConvoloAiPluginOptions & T = {} as ConvoloAiPluginOptions & T,
+): ExternalConvoloAiPlugin<T> {
+	const options = {
+		...incomingOptions,
+		authType: incomingOptions.authType ?? defaultAuthType,
+	};
+	return {
+		id: 'convoloai',
+		authConfig: convoloAiAuthConfig,
+		schema: ConvoloAiSchema,
+		options: options,
+		hooks: options.hooks,
+		webhookHooks: options.webhookHooks,
+		endpoints: convoloAiEndpointsNested,
+		webhooks: convoloAiWebhooksNested,
+		endpointMeta: convoloAiEndpointMeta,
+		endpointSchemas: convoloAiEndpointSchemas,
+		webhookSchemas: convoloAiWebhookSchemas,
+		pluginWebhookMatcher: (request) => {
+			const headers = request.headers;
+			// TODO: Update to match your webhook signature headers
+			return 'x-convoloai-signature' in headers;
+		},
+		pluginTenantWebhookMatcher: matchConvoloAiTenantWebhook,
+		oauthWebhookTenantLinkResolver: resolveConvoloAiOAuthWebhookTenantLink,
+		errorHandlers: {
+			...errorHandlers,
+			...options.errorHandlers,
+		},
+		keyBuilder: async (ctx: ConvoloAiKeyBuilderContext, 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 InternalConvoloAiPlugin;
+}
+
+export type {
+	ExampleEvent,
+	ConvoloAiWebhookOutputs,
+} from './webhooks/types';
+
+export type {
+	ConvoloAiEndpointInputs,
+	ConvoloAiEndpointOutputs,
+	ExampleGetInput,
+	ExampleGetResponse,
+} from './endpoints/types';