groundmail 0.0.0-stage → 0.14.1

package/dist/clerk.d.ts

@@ -0,0 +1,64 @@
+import { G as Groundmail, S as SendEmailResult } from './client-DdrSVDkA.js';
+
+/**
+ * Subset of Clerk `email.created` webhook `data` used for delivery.
+ * Compatible with Clerk's EmailEventPayload without requiring `@clerk/*` at build time.
+ */
+type ClerkEmailCreatedData = {
+    to_email_address: string;
+    subject: string;
+    /** HTML body Clerk would have sent. */
+    body: string;
+    body_plain?: string | null;
+    /** When true, Clerk still delivers — skip unless `force` is set. */
+    delivered_by_clerk?: boolean;
+    slug?: string | null;
+    id?: string;
+};
+type GroundmailClerkOptions = {
+    /** Verified sender, e.g. `Auth <noreply@yourdomain.com>`. Required. */
+    from: string;
+    /** Groundmail API key (`gm_…`). Falls back to `GROUNDMAIL_API_KEY`. */
+    apiKey?: string;
+    /** Override API base URL (tests / self-hosted). */
+    baseUrl?: string;
+    /** Injected client (tests). */
+    client?: Groundmail;
+    /**
+     * Skip sends when `delivered_by_clerk` is true (default `true`).
+     * Set false only if you intentionally dual-send.
+     */
+    skipIfDeliveredByClerk?: boolean;
+    /** Force send even when `delivered_by_clerk` is true. */
+    force?: boolean;
+};
+/**
+ * Deliver one Clerk `email.created` payload through Groundmail.
+ * Returns `null` when skipped because Clerk still delivers the template.
+ */
+declare function deliverClerkEmail(data: ClerkEmailCreatedData, options: GroundmailClerkOptions): Promise<SendEmailResult | null>;
+/**
+ * Returns a deliverer bound to your Groundmail options — use after verifying the Clerk webhook.
+ *
+ * @example
+ * ```ts
+ * import { verifyWebhook } from '@clerk/nextjs/webhooks'
+ * import { createClerkEmailDeliverer } from 'groundmail-clerk'
+ *
+ * const deliver = createClerkEmailDeliverer({
+ *   from: 'noreply@yourdomain.com',
+ *   apiKey: process.env.GROUNDMAIL_API_KEY!,
+ * })
+ *
+ * export async function POST(req: Request) {
+ *   const evt = await verifyWebhook(req)
+ *   if (evt.type === 'email.created') {
+ *     await deliver(evt.data)
+ *   }
+ *   return new Response('ok')
+ * }
+ * ```
+ */
+declare function createClerkEmailDeliverer(options: GroundmailClerkOptions): (data: ClerkEmailCreatedData) => Promise<SendEmailResult | null>;
+
+export { type ClerkEmailCreatedData, type GroundmailClerkOptions, createClerkEmailDeliverer, deliverClerkEmail };

package/dist/clerk.js

@@ -0,0 +1,51 @@
+import {
+  DEFAULT_API_BASE_URL,
+  Groundmail
+} from "./chunk-IZYE7HGT.js";
+
+// src/clerk.ts
+function resolveApiKey(options) {
+  return options.apiKey || process.env.GROUNDMAIL_API_KEY;
+}
+function resolveClient(options) {
+  if (options.client) return options.client;
+  const apiKey = resolveApiKey(options);
+  if (!apiKey) {
+    throw new Error(
+      "Groundmail Clerk deliverer: missing apiKey. Pass options.apiKey or set GROUNDMAIL_API_KEY."
+    );
+  }
+  return new Groundmail(apiKey, {
+    baseUrl: options.baseUrl ?? DEFAULT_API_BASE_URL
+  });
+}
+async function deliverClerkEmail(data, options) {
+  if (!options.from) {
+    throw new Error("Groundmail Clerk deliverer: options.from is required.");
+  }
+  if (!data?.to_email_address) {
+    throw new Error("Groundmail Clerk deliverer: missing to_email_address on webhook data.");
+  }
+  const skip = options.skipIfDeliveredByClerk !== false;
+  if (skip && data.delivered_by_clerk && !options.force) {
+    return null;
+  }
+  const client = resolveClient(options);
+  const tagValue = data.slug ? `clerk-${data.slug}` : "clerk-email";
+  return client.emails.send({
+    from: options.from,
+    to: data.to_email_address,
+    subject: data.subject || "Notification",
+    html: data.body,
+    text: data.body_plain ?? void 0,
+    tags: [{ name: "auth", value: tagValue }],
+    idempotencyKey: data.id ? `clerk-email-${data.id}` : void 0
+  });
+}
+function createClerkEmailDeliverer(options) {
+  return (data) => deliverClerkEmail(data, options);
+}
+export {
+  createClerkEmailDeliverer,
+  deliverClerkEmail
+};