@kizunajs/resend 2.0.0-beta.12

package/dist/index.d.cts

@@ -0,0 +1,262 @@
+import * as _$resend from "resend";
+import { CreateBroadcastOptions, CreateEmailOptions, ErrorResponse, Resend, ResendOptions, WebhookEvent, WebhookEventPayload } from "resend";
+import * as _$kizunajs from "kizunajs";
+import * as _$kizunajs_plugin0 from "kizunajs/plugin";
+import { ApiContext, PluginRoutes } from "kizunajs/plugin";
+import { z } from "zod";
+
+//#region src/webhooks.d.ts
+/**
+ * What a webhook event's function receives.
+ */
+type ResendEventContext<Type extends WebhookEvent, Config = unknown> = ApiContext<Config> & {
+  event: Extract<WebhookEventPayload, {
+    type: Type;
+  }>;
+  /**
+   * The same on every delivery of one event.
+   */
+  deliveryId: string;
+};
+/**
+ * A method, so a function typed from the app's `Config` still fits `on`.
+ */
+type EventHandler<Context> = {
+  handle(context: Context): Promise<void> | void;
+}['handle'];
+/**
+ * What runs for each webhook event, keyed by its type.
+ */
+type ResendEventHandlers<Config = unknown> = { [Type in WebhookEvent]?: EventHandler<ResendEventContext<Type, Config>> };
+/**
+ * The webhook event functions, with `jobs` and `plugins` typed from `Config`.
+ *
+ * @example
+ * export const resendEvents = defineResendEvents<Config>({
+ *     'email.bounced': async ({ event, jobs }) => {
+ *         await jobs.users.markUndeliverable.queue({
+ *             input: {
+ *                 email: event.data.to[0],
+ *             },
+ *         });
+ *     },
+ * });
+ */
+declare const defineResendEvents: <Config = unknown>(handlers: ResendEventHandlers<Config>) => ResendEventHandlers<Config>;
+//#endregion
+//#region src/options.d.ts
+/**
+ * A list an app sends to: the Resend segment its contacts sit in, and the topic
+ * they opt in and out of.
+ */
+declare const ResendListSchema: z.ZodObject<{
+  segmentId: z.ZodString;
+  topicId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const ResendPluginOptionsSchema: z.ZodObject<{
+  apiKey: z.ZodString;
+  from: z.ZodString;
+  lists: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    segmentId: z.ZodString;
+    topicId: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>>;
+  webhookSecret: z.ZodOptional<z.ZodString>;
+  on: z.ZodOptional<z.ZodCustom<ResendEventHandlers, ResendEventHandlers>>;
+  intercept: z.ZodOptional<z.ZodObject<{
+    enabled: z.ZodBoolean;
+    forwardTo: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodEmail>]>>;
+    deliverTo: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    subjectPrefix: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  resend: z.ZodOptional<z.ZodCustom<ResendOptions, ResendOptions>>;
+}, z.core.$strip>;
+type ResendPluginProps = z.output<typeof ResendPluginOptionsSchema>;
+type ResendList = z.output<typeof ResendListSchema>;
+//#endregion
+//#region src/requests.d.ts
+/**
+ * A call to Resend that answered with an error.
+ */
+declare class ResendRequestError extends Error {
+  readonly action: string;
+  readonly error: ErrorResponse;
+  constructor(action: string, error: ErrorResponse);
+}
+type DistributiveOmit<Value, Key extends PropertyKey> = Value extends unknown ? Omit<Value, Key> : never;
+/**
+ * An email, with `from` falling back to the plugin's.
+ */
+type ResendEmail = DistributiveOmit<CreateEmailOptions, 'from'> & {
+  from?: string;
+};
+/**
+ * A broadcast to one of the plugin's lists, with `from` falling back to the
+ * plugin's.
+ */
+type ResendBroadcast = DistributiveOmit<CreateBroadcastOptions, 'from' | 'segmentId' | 'audienceId' | 'topicId' | 'send' | 'scheduledAt'> & {
+  /**
+   * The list it goes to.
+   */
+  list: string;
+  from?: string;
+  /**
+   * When to send it, as an ISO 8601 date or a relative time like `in 2 days`.
+   * Leave it out to send now.
+   */
+  scheduledAt?: string;
+};
+interface ResendSubscriber {
+  email: string;
+  /**
+   * The list they join.
+   */
+  list: string;
+  firstName?: string;
+  lastName?: string;
+}
+interface ResendEmailChange {
+  /**
+   * The contact's current address.
+   */
+  from: string;
+  /**
+   * Its new address.
+   */
+  to: string;
+}
+interface ResendUnsubscriber {
+  email: string;
+  /**
+   * The list they leave. Leave it out to unsubscribe them from everything.
+   */
+  list?: string;
+}
+//#endregion
+//#region src/plugin.d.ts
+/**
+ * Send email, run newsletters and broadcasts, and receive webhooks through
+ * Resend. Handlers reach it at `plugins.resend`.
+ *
+ * @example
+ * ```ts
+ * export default defineConfig({
+ *     routes,
+ *     plugins: [
+ *         resendPlugin({
+ *             apiKey: process.env.RESEND_API_KEY,
+ *             from: 'Kizuna <hello@example.com>',
+ *         }),
+ *     ],
+ * });
+ * ```
+ */
+declare const resendPlugin: {
+  <const Slug extends string>(options: {
+    apiKey: string;
+    from: string;
+    lists?: Record<string, {
+      segmentId: string;
+      topicId?: string | undefined;
+    }> | undefined;
+    webhookSecret?: string | undefined;
+    on?: ResendEventHandlers | undefined;
+    intercept?: {
+      enabled: boolean;
+      forwardTo?: string | string[] | undefined;
+      deliverTo?: string[] | undefined;
+      subjectPrefix?: string | undefined;
+    } | undefined;
+    resend?: _$resend.ResendOptions | undefined;
+  } & {
+    basePath?: _$kizunajs.RoutePath;
+  } & _$kizunajs_plugin0.SlugOption<Slug>): _$kizunajs.PluginDeclaration<Slug, {
+    exports: {
+      client: Resend;
+      sendEmail: (email: ResendEmail) => Promise<{
+        id: string;
+      }>;
+      subscribe: ({
+        email,
+        list: name,
+        firstName,
+        lastName
+      }: ResendSubscriber) => Promise<{
+        contactId: string;
+      }>;
+      changeEmail: ({
+        from,
+        to
+      }: ResendEmailChange) => Promise<{
+        contactId: string;
+      }>;
+      unsubscribe: ({
+        email,
+        list: name
+      }: ResendUnsubscriber) => Promise<void>;
+      sendBroadcast: ({
+        list: name,
+        from,
+        scheduledAt,
+        ...content
+      }: ResendBroadcast) => Promise<{
+        id: string;
+      }>;
+    };
+    routes: PluginRoutes;
+  }>;
+  (options: {
+    apiKey: string;
+    from: string;
+    lists?: Record<string, {
+      segmentId: string;
+      topicId?: string | undefined;
+    }> | undefined;
+    webhookSecret?: string | undefined;
+    on?: ResendEventHandlers | undefined;
+    intercept?: {
+      enabled: boolean;
+      forwardTo?: string | string[] | undefined;
+      deliverTo?: string[] | undefined;
+      subjectPrefix?: string | undefined;
+    } | undefined;
+    resend?: _$resend.ResendOptions | undefined;
+  } & {
+    basePath?: _$kizunajs.RoutePath;
+  }): _$kizunajs.PluginDeclaration<"resend", {
+    exports: {
+      client: Resend;
+      sendEmail: (email: ResendEmail) => Promise<{
+        id: string;
+      }>;
+      subscribe: ({
+        email,
+        list: name,
+        firstName,
+        lastName
+      }: ResendSubscriber) => Promise<{
+        contactId: string;
+      }>;
+      changeEmail: ({
+        from,
+        to
+      }: ResendEmailChange) => Promise<{
+        contactId: string;
+      }>;
+      unsubscribe: ({
+        email,
+        list: name
+      }: ResendUnsubscriber) => Promise<void>;
+      sendBroadcast: ({
+        list: name,
+        from,
+        scheduledAt,
+        ...content
+      }: ResendBroadcast) => Promise<{
+        id: string;
+      }>;
+    };
+    routes: PluginRoutes;
+  }>;
+};
+//#endregion
+export { type ResendBroadcast, type ResendEmail, type ResendEmailChange, type ResendEventContext, type ResendEventHandlers, type ResendList, ResendListSchema, ResendPluginOptionsSchema, type ResendPluginProps, ResendRequestError, type ResendSubscriber, type ResendUnsubscriber, defineResendEvents, resendPlugin };

package/dist/index.d.mts

@@ -0,0 +1,262 @@
+import * as _$resend from "resend";
+import { CreateBroadcastOptions, CreateEmailOptions, ErrorResponse, Resend, ResendOptions, WebhookEvent, WebhookEventPayload } from "resend";
+import * as _$kizunajs_plugin0 from "kizunajs/plugin";
+import { ApiContext, PluginRoutes } from "kizunajs/plugin";
+import { z } from "zod";
+import * as _$kizunajs from "kizunajs";
+
+//#region src/webhooks.d.ts
+/**
+ * What a webhook event's function receives.
+ */
+type ResendEventContext<Type extends WebhookEvent, Config = unknown> = ApiContext<Config> & {
+  event: Extract<WebhookEventPayload, {
+    type: Type;
+  }>;
+  /**
+   * The same on every delivery of one event.
+   */
+  deliveryId: string;
+};
+/**
+ * A method, so a function typed from the app's `Config` still fits `on`.
+ */
+type EventHandler<Context> = {
+  handle(context: Context): Promise<void> | void;
+}['handle'];
+/**
+ * What runs for each webhook event, keyed by its type.
+ */
+type ResendEventHandlers<Config = unknown> = { [Type in WebhookEvent]?: EventHandler<ResendEventContext<Type, Config>> };
+/**
+ * The webhook event functions, with `jobs` and `plugins` typed from `Config`.
+ *
+ * @example
+ * export const resendEvents = defineResendEvents<Config>({
+ *     'email.bounced': async ({ event, jobs }) => {
+ *         await jobs.users.markUndeliverable.queue({
+ *             input: {
+ *                 email: event.data.to[0],
+ *             },
+ *         });
+ *     },
+ * });
+ */
+declare const defineResendEvents: <Config = unknown>(handlers: ResendEventHandlers<Config>) => ResendEventHandlers<Config>;
+//#endregion
+//#region src/options.d.ts
+/**
+ * A list an app sends to: the Resend segment its contacts sit in, and the topic
+ * they opt in and out of.
+ */
+declare const ResendListSchema: z.ZodObject<{
+  segmentId: z.ZodString;
+  topicId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const ResendPluginOptionsSchema: z.ZodObject<{
+  apiKey: z.ZodString;
+  from: z.ZodString;
+  lists: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    segmentId: z.ZodString;
+    topicId: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>>;
+  webhookSecret: z.ZodOptional<z.ZodString>;
+  on: z.ZodOptional<z.ZodCustom<ResendEventHandlers, ResendEventHandlers>>;
+  intercept: z.ZodOptional<z.ZodObject<{
+    enabled: z.ZodBoolean;
+    forwardTo: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodEmail>]>>;
+    deliverTo: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    subjectPrefix: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  resend: z.ZodOptional<z.ZodCustom<ResendOptions, ResendOptions>>;
+}, z.core.$strip>;
+type ResendPluginProps = z.output<typeof ResendPluginOptionsSchema>;
+type ResendList = z.output<typeof ResendListSchema>;
+//#endregion
+//#region src/requests.d.ts
+/**
+ * A call to Resend that answered with an error.
+ */
+declare class ResendRequestError extends Error {
+  readonly action: string;
+  readonly error: ErrorResponse;
+  constructor(action: string, error: ErrorResponse);
+}
+type DistributiveOmit<Value, Key extends PropertyKey> = Value extends unknown ? Omit<Value, Key> : never;
+/**
+ * An email, with `from` falling back to the plugin's.
+ */
+type ResendEmail = DistributiveOmit<CreateEmailOptions, 'from'> & {
+  from?: string;
+};
+/**
+ * A broadcast to one of the plugin's lists, with `from` falling back to the
+ * plugin's.
+ */
+type ResendBroadcast = DistributiveOmit<CreateBroadcastOptions, 'from' | 'segmentId' | 'audienceId' | 'topicId' | 'send' | 'scheduledAt'> & {
+  /**
+   * The list it goes to.
+   */
+  list: string;
+  from?: string;
+  /**
+   * When to send it, as an ISO 8601 date or a relative time like `in 2 days`.
+   * Leave it out to send now.
+   */
+  scheduledAt?: string;
+};
+interface ResendSubscriber {
+  email: string;
+  /**
+   * The list they join.
+   */
+  list: string;
+  firstName?: string;
+  lastName?: string;
+}
+interface ResendEmailChange {
+  /**
+   * The contact's current address.
+   */
+  from: string;
+  /**
+   * Its new address.
+   */
+  to: string;
+}
+interface ResendUnsubscriber {
+  email: string;
+  /**
+   * The list they leave. Leave it out to unsubscribe them from everything.
+   */
+  list?: string;
+}
+//#endregion
+//#region src/plugin.d.ts
+/**
+ * Send email, run newsletters and broadcasts, and receive webhooks through
+ * Resend. Handlers reach it at `plugins.resend`.
+ *
+ * @example
+ * ```ts
+ * export default defineConfig({
+ *     routes,
+ *     plugins: [
+ *         resendPlugin({
+ *             apiKey: process.env.RESEND_API_KEY,
+ *             from: 'Kizuna <hello@example.com>',
+ *         }),
+ *     ],
+ * });
+ * ```
+ */
+declare const resendPlugin: {
+  <const Slug extends string>(options: {
+    apiKey: string;
+    from: string;
+    lists?: Record<string, {
+      segmentId: string;
+      topicId?: string | undefined;
+    }> | undefined;
+    webhookSecret?: string | undefined;
+    on?: ResendEventHandlers | undefined;
+    intercept?: {
+      enabled: boolean;
+      forwardTo?: string | string[] | undefined;
+      deliverTo?: string[] | undefined;
+      subjectPrefix?: string | undefined;
+    } | undefined;
+    resend?: _$resend.ResendOptions | undefined;
+  } & {
+    basePath?: _$kizunajs.RoutePath;
+  } & _$kizunajs_plugin0.SlugOption<Slug>): _$kizunajs.PluginDeclaration<Slug, {
+    exports: {
+      client: Resend;
+      sendEmail: (email: ResendEmail) => Promise<{
+        id: string;
+      }>;
+      subscribe: ({
+        email,
+        list: name,
+        firstName,
+        lastName
+      }: ResendSubscriber) => Promise<{
+        contactId: string;
+      }>;
+      changeEmail: ({
+        from,
+        to
+      }: ResendEmailChange) => Promise<{
+        contactId: string;
+      }>;
+      unsubscribe: ({
+        email,
+        list: name
+      }: ResendUnsubscriber) => Promise<void>;
+      sendBroadcast: ({
+        list: name,
+        from,
+        scheduledAt,
+        ...content
+      }: ResendBroadcast) => Promise<{
+        id: string;
+      }>;
+    };
+    routes: PluginRoutes;
+  }>;
+  (options: {
+    apiKey: string;
+    from: string;
+    lists?: Record<string, {
+      segmentId: string;
+      topicId?: string | undefined;
+    }> | undefined;
+    webhookSecret?: string | undefined;
+    on?: ResendEventHandlers | undefined;
+    intercept?: {
+      enabled: boolean;
+      forwardTo?: string | string[] | undefined;
+      deliverTo?: string[] | undefined;
+      subjectPrefix?: string | undefined;
+    } | undefined;
+    resend?: _$resend.ResendOptions | undefined;
+  } & {
+    basePath?: _$kizunajs.RoutePath;
+  }): _$kizunajs.PluginDeclaration<"resend", {
+    exports: {
+      client: Resend;
+      sendEmail: (email: ResendEmail) => Promise<{
+        id: string;
+      }>;
+      subscribe: ({
+        email,
+        list: name,
+        firstName,
+        lastName
+      }: ResendSubscriber) => Promise<{
+        contactId: string;
+      }>;
+      changeEmail: ({
+        from,
+        to
+      }: ResendEmailChange) => Promise<{
+        contactId: string;
+      }>;
+      unsubscribe: ({
+        email,
+        list: name
+      }: ResendUnsubscriber) => Promise<void>;
+      sendBroadcast: ({
+        list: name,
+        from,
+        scheduledAt,
+        ...content
+      }: ResendBroadcast) => Promise<{
+        id: string;
+      }>;
+    };
+    routes: PluginRoutes;
+  }>;
+};
+//#endregion
+export { type ResendBroadcast, type ResendEmail, type ResendEmailChange, type ResendEventContext, type ResendEventHandlers, type ResendList, ResendListSchema, ResendPluginOptionsSchema, type ResendPluginProps, ResendRequestError, type ResendSubscriber, type ResendUnsubscriber, defineResendEvents, resendPlugin };