Add Mailcheck integration: verify email and validate domain

packages/corsair/core/constants.ts

@@ -18,7 +18,6 @@ export const BaseProviders = [
 	'abyssale',
 	'accrediblecertificates',
 	'activecampaign',
-	'anchorbrowser',
 	'activetrail',
 	'addresszen',
 	'aeroleads',
@@ -40,14 +39,15 @@ export const BaseProviders = [
 	'ambientweather',
 	'amcards',
 	'amplitude',
+	'anchorbrowser',
 	'anthropicadministrator',
 	'apaleo',
 	'api2pdf',
 	'apibible',
-	'apipie',
 	'apify',
 	'apilabz',
 	'apininjas',
+	'apipie',
 	'apisports',
 	'asana',
 	'asindataapi',
@@ -92,8 +92,8 @@ export const BaseProviders = [
 	'facebook',
 	'figma',
 	'firecrawl',
-	'formbricks',
 	'fireflies',
+	'formbricks',
 	'gemini',
 	'github',
 	'gitlab',
@@ -123,6 +123,7 @@ export const BaseProviders = [
 	'linear',
 	'linkedin',
 	'loyverse',
+	'mailcheck',
 	'mailchimp',
 	'mailtrap',
 	'monday',
@@ -185,7 +186,6 @@ export const ProviderDisplayNames = {
 	abyssale: 'Abyssale',
 	accrediblecertificates: 'Accredible Certificates',
 	activecampaign: 'ActiveCampaign',
-	anchorbrowser: 'Anchor Browser',
 	activetrail: 'Active Trail',
 	addresszen: 'Addresszen',
 	aeroleads: 'Aeroleads',
@@ -207,14 +207,15 @@ export const ProviderDisplayNames = {
 	ambientweather: 'Ambient Weather',
 	amcards: 'AMcards',
 	amplitude: 'Amplitude',
+	anchorbrowser: 'Anchor Browser',
 	anthropicadministrator: 'Anthropic Administrator',
 	apaleo: 'Apaleo',
 	api2pdf: 'API2PDF',
 	apibible: 'API.Bible',
-	apipie: 'APIpie AI',
 	apify: 'Apify',
 	apilabz: 'API Labz',
 	apininjas: 'API Ninjas',
+	apipie: 'APIpie AI',
 	apisports: 'API-Sports',
 	asana: 'Asana',
 	asindataapi: 'ASIN Data API',
@@ -259,8 +260,8 @@ export const ProviderDisplayNames = {
 	facebook: 'Facebook',
 	figma: 'Figma',
 	firecrawl: 'Firecrawl',
-	formbricks: 'Formbricks',
 	fireflies: 'Fireflies',
+	formbricks: 'Formbricks',
 	gemini: 'Gemini',
 	github: 'GitHub',
 	gitlab: 'GitLab',
@@ -290,6 +291,7 @@ export const ProviderDisplayNames = {
 	linear: 'Linear',
 	linkedin: 'LinkedIn',
 	loyverse: 'Loyverse',
+	mailcheck: 'Mailcheck',
 	mailchimp: 'Mailchimp',
 	mailtrap: 'Mailtrap',
 	monday: 'Monday',
@@ -359,7 +361,6 @@ export type AllProviders =
 	| 'abyssale'
 	| 'accrediblecertificates'
 	| 'activecampaign'
-	| 'anchorbrowser'
 	| 'activetrail'
 	| 'addresszen'
 	| 'aeroleads'
@@ -381,14 +382,15 @@ export type AllProviders =
 	| 'ambientweather'
 	| 'amcards'
 	| 'amplitude'
+	| 'anchorbrowser'
 	| 'anthropicadministrator'
 	| 'apaleo'
 	| 'api2pdf'
 	| 'apibible'
-	| 'apipie'
 	| 'apify'
 	| 'apilabz'
 	| 'apininjas'
+	| 'apipie'
 	| 'apisports'
 	| 'asana'
 	| 'asindataapi'
@@ -433,8 +435,8 @@ export type AllProviders =
 	| 'facebook'
 	| 'figma'
 	| 'firecrawl'
-	| 'formbricks'
 	| 'fireflies'
+	| 'formbricks'
 	| 'gemini'
 	| 'github'
 	| 'gitlab'
@@ -464,6 +466,7 @@ export type AllProviders =
 	| 'linear'
 	| 'linkedin'
 	| 'loyverse'
+	| 'mailcheck'
 	| 'mailchimp'
 	| 'mailtrap'
 	| 'monday'

packages/mailcheck/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 MailcheckAPIError extends Error {
+	constructor(
+		message: string,
+		public readonly code?: string,
+	) {
+		super(message);
+		this.name = 'MailcheckAPIError';
+	}
+}
+
+// TODO: Update with your API base URL
+const MAILCHECK_API_BASE = 'https://api.mailcheck.ing/v1';
+
+export async function makeMailcheckRequest<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: MAILCHECK_API_BASE,
+		VERSION: '1.0.0',
+		WITH_CREDENTIALS: false,
+		CREDENTIALS: 'omit',
+		TOKEN: apiKey,
+		HEADERS: {
+			'Content-Type': 'application/json',
+
+			'Authorization': 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 MailcheckAPIError(error.message);
+		}
+		throw new MailcheckAPIError('Unknown error');
+	}
+}

packages/mailcheck/endpoints/index.ts

@@ -0,0 +1,9 @@
+import { verifyEmail } from './verify-email';
+import { validateDomain } from './validate-domain';
+
+export const Mailcheck = {
+	verifyEmail,
+	validateDomain,
+};
+
+export * from './types';

packages/mailcheck/endpoints/types.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod';
+
+const VerifyEmailInputSchema = z.object({
+	email: z.string(),
+	verify: z.boolean().optional(),
+	check_breach: z.boolean().optional(),
+});
+export type VerifyEmailInput = z.infer<typeof VerifyEmailInputSchema>;
+
+const VerifyEmailResponseSchema = z.object({
+	email: z.string(),
+}).passthrough();
+export type VerifyEmailResponse = z.infer<typeof VerifyEmailResponseSchema>;
+
+const ValidateDomainInputSchema = z.object({
+	domain: z.string(),
+});
+export type ValidateDomainInput = z.infer<typeof ValidateDomainInputSchema>;
+
+const ValidateDomainResponseSchema = z.object({
+	domain: z.string(),
+}).passthrough();
+export type ValidateDomainResponse = z.infer<typeof ValidateDomainResponseSchema>;
+
+export type MailcheckEndpointInputs = {
+	verifyEmail: VerifyEmailInput;
+	validateDomain: ValidateDomainInput;
+};
+
+export type MailcheckEndpointOutputs = {
+	verifyEmail: VerifyEmailResponse;
+	validateDomain: ValidateDomainResponse;
+};
+
+export const MailcheckEndpointInputSchemas = {
+	verifyEmail: VerifyEmailInputSchema,
+	validateDomain: ValidateDomainInputSchema,
+} as const;
+
+export const MailcheckEndpointOutputSchemas = {
+	verifyEmail: VerifyEmailResponseSchema,
+	validateDomain: ValidateDomainResponseSchema,
+} as const;

packages/mailcheck/endpoints/validate-domain.ts

@@ -0,0 +1,15 @@
+import { logEventFromContext } from 'corsair/core';
+import type { MailcheckEndpoints } from '..';
+import type { MailcheckEndpointOutputs } from './types';
+import { makeMailcheckRequest } from '../client';
+
+export const validateDomain: MailcheckEndpoints['validateDomain'] = async (ctx, input) => {
+	const response = await makeMailcheckRequest<MailcheckEndpointOutputs['validateDomain']>(
+		`domain/${input.domain}`,
+		ctx.key,
+		{ method: 'GET' },
+	);
+
+	await logEventFromContext(ctx, 'mailcheck.validate_domain', { ...input }, 'completed');
+	return response;
+};

packages/mailcheck/endpoints/verify-email.ts

@@ -0,0 +1,22 @@
+import { logEventFromContext } from 'corsair/core';
+import type { MailcheckEndpoints } from '..';
+import type { MailcheckEndpointOutputs } from './types';
+import { makeMailcheckRequest } from '../client';
+
+export const verifyEmail: MailcheckEndpoints['verifyEmail'] = async (ctx, input) => {
+	const response = await makeMailcheckRequest<MailcheckEndpointOutputs['verifyEmail']>(
+		'verify',
+		ctx.key,
+		{
+			method: 'POST',
+			body: {
+				email: input.email,
+				verify: input.verify ?? true,
+				check_breach: input.check_breach ?? false,
+			},
+		},
+	);
+
+	await logEventFromContext(ctx, 'mailcheck.verify_email', { ...input }, 'completed');
+	return response;
+};

packages/mailcheck/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;