groundmail 0.25.1 → 0.26.0

package/README.md

@@ -60,6 +60,25 @@ await tx.emails.send({
 Outcomes: `delivered`, `bounce`, `block`, `complaint`, `suppressed`, `delayed`. Details:
 https://docs.groundmail.dev/testing
 
+## Email testing
+
+Your team has a test domain (`<team>.test.groundmail.dev`). Mail sent to any address there is
+caught in your test inbox and never delivered, whichever provider your app sends with. Give each
+test its own address, then wait for the email and read the extracted code and links:
+
+```ts
+const to = await tx.testInbox.address({ prefix: 'signup' }) // signup-k3m9x2pq@acme.test.groundmail.dev
+// …your app sends the signup email to `to`…
+const email = await tx.testInbox.waitFor({ to, timeout: 30_000 })
+email.code  // '482913'
+email.links // ['https://app.example.com/verify?token=…']
+```
+
+`waitFor` throws a `GroundmailError` with status 408 and code `timeout` when nothing arrives in
+time. Also: `tx.testInbox.list({ to, since })`, `tx.testInbox.get(id)` and `tx.testInbox.info()`
+(domain and monthly usage). Emails sent with a `gm_test_` key land here too. Details:
+https://docs.groundmail.dev/email-testing
+
 ## Tenants
 
 If you send email for your own customers, create one tenant per customer. Each tenant has its

package/dist/authjs.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-DJB1l4zk.js';
+import { G as Groundmail } from './client-DAetJZCf.js';
 
 /** Subset of Auth.js theme used for the default magic-link email. */
 type AuthjsTheme = {

package/dist/authjs.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-NQWM7F3N.js";
+} from "./chunk-E6G7G2PM.js";
 
 // src/authjs.ts
 function escapeHtml(value) {

package/dist/better-auth.d.ts

@@ -1,4 +1,4 @@
-import { S as SendEmailResult, G as Groundmail } from './client-DJB1l4zk.js';
+import { S as SendEmailResult, G as Groundmail } from './client-DAetJZCf.js';
 
 type BetterAuthEmailUser = {
     email: string;

package/dist/better-auth.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-NQWM7F3N.js";
+} from "./chunk-E6G7G2PM.js";
 
 // src/better-auth.ts
 function linkHtml(label, url) {

package/dist/{chunk-NQWM7F3N.js → chunk-E6G7G2PM.js}

@@ -802,6 +802,97 @@ var MigrationsResource = class {
   }
 };
 
+// src/test-inbox.ts
+var TEST_INBOX_WAIT_MAX_SECONDS = 60;
+var TEST_INBOX_WAIT_DEFAULT_MS = 3e4;
+var ALPHABET = "abcdefghijkmnpqrstuvwxyz23456789";
+function randomSuffix(length = 8) {
+  const bytes = new Uint8Array(length);
+  const cryptoImpl = globalThis.crypto;
+  if (cryptoImpl?.getRandomValues) cryptoImpl.getRandomValues(bytes);
+  else for (let i = 0; i < length; i++) bytes[i] = Math.floor(Math.random() * 256);
+  let out = "";
+  for (const byte of bytes) out += ALPHABET[byte % ALPHABET.length];
+  return out;
+}
+function cleanPrefix(prefix) {
+  const cleaned = (prefix ?? "").trim().toLowerCase().replace(/[^a-z0-9._+-]+/g, "-").replace(/^[-.]+|[-.]+$/g, "").slice(0, 48);
+  return cleaned || "run";
+}
+function isoTime(value) {
+  if (value === void 0 || value === null || value === "") return null;
+  return value instanceof Date ? value.toISOString() : String(value);
+}
+var TestInboxResource = class {
+  constructor(client) {
+    this.client = client;
+    this.domain = null;
+  }
+  /** The team's test domain, an example address and this month's usage. */
+  async info() {
+    const { test_inbox } = await this.client.request("/test-inbox", { method: "GET" });
+    this.domain = test_inbox.domain;
+    return test_inbox;
+  }
+  /** A fresh unique address on your test domain: `run-k3m9x2pq@acme.test.groundmail.dev`. */
+  async address(options = {}) {
+    const domain = this.domain ?? (await this.info()).domain;
+    return `${cleanPrefix(options.prefix)}-${randomSuffix()}@${domain}`;
+  }
+  /** Caught emails, newest first. */
+  async list(params = {}) {
+    const search = new URLSearchParams();
+    if (params.to) search.set("to", params.to);
+    const since = isoTime(params.since);
+    if (since) search.set("since", since);
+    if (params.limit != null) search.set("limit", String(params.limit));
+    if (params.cursor) search.set("cursor", params.cursor);
+    const query = search.toString();
+    return this.client.request(`/test-inbox/emails${query ? `?${query}` : ""}`, { method: "GET" });
+  }
+  /** One caught email with bodies, headers and source. */
+  async get(id) {
+    const { email } = await this.client.request(
+      `/test-inbox/emails/${encodeURIComponent(id)}`,
+      { method: "GET" }
+    );
+    return email;
+  }
+  /**
+   * Wait for an email to `to` and return it. An email that already arrived is
+   * returned at once. Waits up to `timeout` ms (default 30s), then throws a
+   * `GroundmailError` with status 408 and code `timeout`.
+   */
+  async waitFor(params) {
+    if (!params?.to) throw new Error("testInbox.waitFor: `to` is required");
+    const totalMs = params.timeout ?? TEST_INBOX_WAIT_DEFAULT_MS;
+    const deadline = Date.now() + totalMs;
+    const since = isoTime(params.since);
+    for (; ; ) {
+      const remainingMs = Math.max(0, deadline - Date.now());
+      const seconds = Math.min(TEST_INBOX_WAIT_MAX_SECONDS, Math.ceil(remainingMs / 1e3));
+      const search = new URLSearchParams({ to: params.to, timeout: String(seconds) });
+      if (since) search.set("since", since);
+      try {
+        const { email } = await this.client.request(`/test-inbox/wait?${search}`, {
+          method: "GET"
+        });
+        return email;
+      } catch (error) {
+        const timedOut = error instanceof GroundmailError && error.status === 408;
+        if (!timedOut) throw error;
+        if (Date.now() >= deadline || seconds === 0) {
+          throw new GroundmailError(`No email to ${params.to} arrived within ${Math.round(totalMs / 1e3)} seconds`, 408, error.details, {
+            code: "timeout",
+            hint: error.hint,
+            docsUrl: error.docsUrl
+          });
+        }
+      }
+    }
+  }
+};
+
 // src/webhooks/verify.ts
 import { createHmac, timingSafeEqual } from "crypto";
 function signWebhookPayload(secret, payload, timestamp) {
@@ -1592,6 +1683,7 @@ var _Groundmail = class _Groundmail {
     this.tenants = new TenantsResource(this);
     this.migrations = new MigrationsResource(this);
     this.dmarc = new DmarcResource(this);
+    this.testInbox = new TestInboxResource(this);
   }
   /**
    * Check one address with Groundmail validation before you accept it (for
@@ -1687,6 +1779,9 @@ export {
   mergeSpfInclude,
   applyDnsRecords,
   mergeMigrations,
+  TEST_INBOX_WAIT_MAX_SECONDS,
+  TEST_INBOX_WAIT_DEFAULT_MS,
+  TestInboxResource,
   signWebhookPayload,
   buildSignatureHeader,
   verifyWebhookSignature,

package/dist/clerk.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail, S as SendEmailResult } from './client-DJB1l4zk.js';
+import { G as Groundmail, S as SendEmailResult } from './client-DAetJZCf.js';
 
 /**
  * Subset of Clerk `email.created` webhook `data` used for delivery.

package/dist/clerk.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-NQWM7F3N.js";
+} from "./chunk-E6G7G2PM.js";
 
 // src/clerk.ts
 function resolveApiKey(options) {

package/dist/{client-DJB1l4zk.d.ts → client-DAetJZCf.d.ts}

@@ -4,7 +4,9 @@ type ApiErrorCode = 'validation_error' | 'unauthorized' | 'forbidden' | 'not_fou
 /** 403: the request names a tenant, but tenants are not enabled for this account (Scale and Dedicated plans). */
  | 'tenants_not_enabled'
 /** 403: the send uses `category: 'newsletter'`, but newsletter sending isn't enabled on this account (approved accounts only). */
- | 'newsletter_not_enabled' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
+ | 'newsletter_not_enabled' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited'
+/** 408: a long-poll ended before anything matched (`testInbox.waitFor`). Safe to call again. */
+ | 'timeout' | 'upstream_error' | 'not_configured' | 'internal_error';
 type SendEmailParams = {
     from: string | {
         email: string;
@@ -1324,6 +1326,89 @@ type TenantStatsResult = {
 type ListTenantDomainsResult = {
     data: Domain[];
 };
+/** Monthly test email usage for the team. */
+type TestInboxUsage = {
+    /** `YYYY-MM`, UTC. */
+    month: string;
+    received: number;
+    /** Refused this month because the limit was reached. */
+    rejected: number;
+    /** 100 free, 5,000 with the email testing add-on. */
+    included: number;
+    /** True with the add-on: mail past `included` is accepted and billed per 1,000. */
+    overage: boolean;
+    resets_at: string;
+};
+/** The team's test domain: mail to any address at it is caught, never delivered. */
+type TestInbox = {
+    object: 'test_inbox';
+    /** e.g. `acme.test.groundmail.dev` */
+    domain: string;
+    /** An example fresh address. Use a new one per test. */
+    address: string;
+    addon: {
+        active: boolean;
+        status: string | null;
+    };
+    usage: TestInboxUsage;
+    retention_days: number;
+};
+/** A caught test email (list item). */
+type TestInboxEmail = {
+    object: 'test_inbox_email';
+    /** `tie_…` */
+    id: string;
+    /** `inbound`: received at your test domain. `test_key`: sent with a `gm_test_` key. */
+    source: 'inbound' | 'test_key';
+    /** With `test_key`: the sent email's id. */
+    email_id: string | null;
+    from: string;
+    to: string[];
+    cc: string[];
+    subject: string;
+    /** The one-time code (4 to 8 digits) found in the email, or null. */
+    code: string | null;
+    /** http(s) links in the email, in order. */
+    links: string[];
+    received_at: string;
+    expires_at: string;
+};
+type TestInboxHeader = {
+    name: string;
+    value: string;
+};
+/** A caught test email with bodies, headers and source. */
+type TestInboxEmailDetail = TestInboxEmail & {
+    text_body: string | null;
+    html_body: string | null;
+    headers: TestInboxHeader[];
+    raw_source: string | null;
+};
+type ListTestInboxEmailsParams = {
+    /** Only emails to this exact address. */
+    to?: string;
+    /** Only emails received at or after this time. */
+    since?: Date | string;
+    limit?: number;
+    cursor?: string;
+};
+type ListTestInboxEmailsResult = {
+    emails: TestInboxEmail[];
+    has_more: boolean;
+    next_cursor: string | null;
+};
+type TestInboxAddressOptions = {
+    /** Start of the local part, e.g. `signup` → `signup-k3m9x2pq@…`. Default `run`. */
+    prefix?: string;
+};
+type WaitForTestEmailParams = {
+    /** The exact address your app sent to. */
+    to: string;
+    /** Total time to wait in milliseconds. Default 30,000. */
+    timeout?: number;
+    /** Only emails received at or after this time. */
+    since?: Date | string;
+};
 
 declare class AutomationsResource {
     private readonly client;
@@ -1712,6 +1797,41 @@ declare class TenantDomainsResource {
     }>;
 }
 
+/** Longest single wait the API holds open, in seconds. */
+declare const TEST_INBOX_WAIT_MAX_SECONDS = 60;
+declare const TEST_INBOX_WAIT_DEFAULT_MS = 30000;
+/**
+ * Hosted test inbox: your team's test domain catches mail from any email
+ * provider and never delivers it. Give each test its own address, then wait for
+ * the email and read its `code` and `links`:
+ *
+ * ```ts
+ * const to = await groundmail.testInbox.address({ prefix: 'signup' })
+ * await page.fill('#email', to) // your app sends with any provider
+ * const email = await groundmail.testInbox.waitFor({ to })
+ * await page.fill('#code', email.code!)
+ * ```
+ */
+declare class TestInboxResource {
+    private readonly client;
+    private domain;
+    constructor(client: Groundmail);
+    /** The team's test domain, an example address and this month's usage. */
+    info(): Promise<TestInbox>;
+    /** A fresh unique address on your test domain: `run-k3m9x2pq@acme.test.groundmail.dev`. */
+    address(options?: TestInboxAddressOptions): Promise<string>;
+    /** Caught emails, newest first. */
+    list(params?: ListTestInboxEmailsParams): Promise<ListTestInboxEmailsResult>;
+    /** One caught email with bodies, headers and source. */
+    get(id: string): Promise<TestInboxEmailDetail>;
+    /**
+     * Wait for an email to `to` and return it. An email that already arrived is
+     * returned at once. Waits up to `timeout` ms (default 30s), then throws a
+     * `GroundmailError` with status 408 and code `timeout`.
+     */
+    waitFor(params: WaitForTestEmailParams): Promise<TestInboxEmailDetail>;
+}
+
 declare class WebhooksResource {
     private readonly client;
     constructor(client: Groundmail);
@@ -1756,6 +1876,8 @@ declare class Groundmail {
     readonly migrations: MigrationsResource;
     /** DMARC monitoring per domain: report address, sources, pass rates and readiness. */
     readonly dmarc: DmarcResource;
+    /** Hosted test inbox: catch test mail from any provider and wait for it in your tests. */
+    readonly testInbox: TestInboxResource;
     private readonly apiKey;
     private readonly options;
     private readonly getToken;
@@ -1791,4 +1913,4 @@ declare function normalizeAccessToken(value: GroundmailAccessToken | null | unde
     expiresAt: number | null;
 };
 
-export { type DmarcStatus as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryOptOut as C, type DnsRecord as D, type CreateDomainResult as E, type CreateMigrationParams as F, Groundmail as G, type CreateSuppressionParams as H, type CreateTemplateParams as I, type CreateTenantParams as J, type CreateWebhookParams as K, DEFAULT_API_BASE_URL as L, type DailyRampLimitErrorDetails as M, type DeleteTenantResult as N, type DeliverabilityBucket as O, type DeliverabilityDomainInsight as P, type DeliverabilityInsightsResult as Q, type DeliverabilityMailServerRelay as R, type SendEmailResult as S, type DeliverabilityWindow as T, type DmarcDailyPoint as U, type DmarcMonitoring as V, type DmarcMonitoringDisabled as W, type DmarcReadiness as X, type DmarcReadinessVerdict as Y, type DmarcSource as Z, type DmarcSourceStatus as _, type ApiErrorCode as a, type SendEmailParams as a$, type DnsProviderName as a0, type Domain as a1, type DomainBimiAnalysis as a2, type DomainDetailResult as a3, type DomainDmarcAnalysis as a4, type DomainDnsAnalysis as a5, type DomainStatus as a6, type DomainTlsMode as a7, type DomainTrackingDns as a8, type DomainTrackingStatus as a9, type ListReceivedEmailsResult as aA, type ListSuppressionsParams as aB, type ListSuppressionsResult as aC, type ListTemplatesParams as aD, type ListTemplatesResult as aE, type ListTenantDomainsResult as aF, type ListTenantsParams as aG, type ListTenantsResult as aH, type MailServerSigningStatus as aI, type MailStream as aJ, type Migration as aK, type MigrationDnsChange as aL, type MigrationDnsPlan as aM, type MigrationDomainItem as aN, type MigrationItemStatus as aO, type MigrationProvider as aP, type MigrationResource as aQ, type MigrationSummary as aR, type MigrationTemplateItem as aS, type MigrationTotals as aT, type MigrationWebhookItem as aU, type ReceivedEmail as aV, type ReceivedEmailAttachment as aW, type ReceivedEmailAttachmentMeta as aX, type RemoteApplyDnsCredentials as aY, type RemoveCategoryOptOutOptions as aZ, type RunMigrationOptions as a_, type EmailListItem as aa, type EmailWebhookEventPayload as ab, type EmailWebhookEventType as ac, type EnableDmarcParams as ad, type EnableDmarcResult as ae, type EnrollmentSkip as af, type EventRecord as ag, type GroundmailAccessToken as ah, type GroundmailOptions as ai, type GroundmailTokenOptions as aj, type GroundmailTokenProvider as ak, type HeldBackErrorDetails as al, type HeldBackReason as am, type HeldBackRecipient as an, type ListApiKeysParams as ao, type ListApiKeysResult as ap, type ListAutomationRunsParams as aq, type ListAutomationRunsResult as ar, type ListAutomationsResult as as, type ListCategoryOptOutsParams as at, type ListCategoryOptOutsResult as au, type ListDomainsParams as av, type ListDomainsResult as aw, type ListEmailsParams as ax, type ListEmailsResult as ay, type ListReceivedEmailsParams as az, type ApiKey as b, type StreamDeliverability as b0, type SuppressedErrorDetails as b1, type Suppression as b2, type Template as b3, type TemplateFormat as b4, type TemplateLintWarning as b5, type TemplateStarter as b6, type TemplateStatus as b7, type TemplateVersion as b8, type Tenant as b9, mergeMigrations as bA, normalizeAccessToken as bB, type TenantPauseSource as ba, type TenantRamp as bb, type TenantStats as bc, type TenantStatsResult as bd, type TenantStatus as be, type TenantStreamPolicy as bf, type TestEmailWebhookParams as bg, type TestEmailWebhookResult as bh, type TriggerEventParams as bi, type TriggerEventResult as bj, type TwilioIntegrationResponse as bk, type TwilioIntegrationStatus as bl, type UpdateAutomationParams as bm, type UpdateDomainParams as bn, type UpdateEmailParams as bo, type UpdateTemplateParams as bp, type UpdateTenantParams as bq, type UpdateWebhookParams as br, type ValidateEmailResult as bs, type ValidationReason as bt, type ValidationVerdict as bu, type VerifyDomainResult as bv, type WebhookEmailTag as bw, type WebhookEndpoint as bx, type WebhookEndpointWithSecret as by, type WebhookEventType as bz, type ApiKeyScope as c, type ApplyDnsParams as d, type ApplyDnsRecordResult as e, type ApplyDnsResult as f, type Asset as g, type Automation as h, type AutomationResult as i, type AutomationRun as j, type AutomationRunResponse as k, type AutomationRunStatus as l, type AutomationRunStep as m, type AutomationRunStepStatus as n, type AutomationStatus as o, type AutomationStep as p, type AutomationTrigger as q, type BounceType as r, type CategoryOptOutCategory as s, type CategoryUnsubscribedErrorDetails as t, type ConnectTwilioParams as u, type ContactWebhookEventPayload as v, type CreateApiKeyParams as w, type CreateApiKeyResult as x, type CreateAutomationParams as y, type CreateDomainParams as z };
+export { type DmarcStatus as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryOptOut as C, type DnsRecord as D, type CreateDomainResult as E, type CreateMigrationParams as F, Groundmail as G, type CreateSuppressionParams as H, type CreateTemplateParams as I, type CreateTenantParams as J, type CreateWebhookParams as K, DEFAULT_API_BASE_URL as L, type DailyRampLimitErrorDetails as M, type DeleteTenantResult as N, type DeliverabilityBucket as O, type DeliverabilityDomainInsight as P, type DeliverabilityInsightsResult as Q, type DeliverabilityMailServerRelay as R, type SendEmailResult as S, type DeliverabilityWindow as T, type DmarcDailyPoint as U, type DmarcMonitoring as V, type DmarcMonitoringDisabled as W, type DmarcReadiness as X, type DmarcReadinessVerdict as Y, type DmarcSource as Z, type DmarcSourceStatus as _, type ApiErrorCode as a, type RemoveCategoryOptOutOptions as a$, type DnsProviderName as a0, type Domain as a1, type DomainBimiAnalysis as a2, type DomainDetailResult as a3, type DomainDmarcAnalysis as a4, type DomainDnsAnalysis as a5, type DomainStatus as a6, type DomainTlsMode as a7, type DomainTrackingDns as a8, type DomainTrackingStatus as a9, type ListReceivedEmailsResult as aA, type ListSuppressionsParams as aB, type ListSuppressionsResult as aC, type ListTemplatesParams as aD, type ListTemplatesResult as aE, type ListTenantDomainsResult as aF, type ListTenantsParams as aG, type ListTenantsResult as aH, type ListTestInboxEmailsParams as aI, type ListTestInboxEmailsResult as aJ, type MailServerSigningStatus as aK, type MailStream as aL, type Migration as aM, type MigrationDnsChange as aN, type MigrationDnsPlan as aO, type MigrationDomainItem as aP, type MigrationItemStatus as aQ, type MigrationProvider as aR, type MigrationResource as aS, type MigrationSummary as aT, type MigrationTemplateItem as aU, type MigrationTotals as aV, type MigrationWebhookItem as aW, type ReceivedEmail as aX, type ReceivedEmailAttachment as aY, type ReceivedEmailAttachmentMeta as aZ, type RemoteApplyDnsCredentials as a_, type EmailListItem as aa, type EmailWebhookEventPayload as ab, type EmailWebhookEventType as ac, type EnableDmarcParams as ad, type EnableDmarcResult as ae, type EnrollmentSkip as af, type EventRecord as ag, type GroundmailAccessToken as ah, type GroundmailOptions as ai, type GroundmailTokenOptions as aj, type GroundmailTokenProvider as ak, type HeldBackErrorDetails as al, type HeldBackReason as am, type HeldBackRecipient as an, type ListApiKeysParams as ao, type ListApiKeysResult as ap, type ListAutomationRunsParams as aq, type ListAutomationRunsResult as ar, type ListAutomationsResult as as, type ListCategoryOptOutsParams as at, type ListCategoryOptOutsResult as au, type ListDomainsParams as av, type ListDomainsResult as aw, type ListEmailsParams as ax, type ListEmailsResult as ay, type ListReceivedEmailsParams as az, type ApiKey as b, type RunMigrationOptions as b0, type SendEmailParams as b1, type StreamDeliverability as b2, type SuppressedErrorDetails as b3, type Suppression as b4, TEST_INBOX_WAIT_DEFAULT_MS as b5, TEST_INBOX_WAIT_MAX_SECONDS as b6, type Template as b7, type TemplateFormat as b8, type TemplateLintWarning as b9, type UpdateTemplateParams as bA, type UpdateTenantParams as bB, type UpdateWebhookParams as bC, type ValidateEmailResult as bD, type ValidationReason as bE, type ValidationVerdict as bF, type VerifyDomainResult as bG, type WaitForTestEmailParams as bH, type WebhookEmailTag as bI, type WebhookEndpoint as bJ, type WebhookEndpointWithSecret as bK, type WebhookEventType as bL, mergeMigrations as bM, normalizeAccessToken as bN, type TemplateStarter as ba, type TemplateStatus as bb, type TemplateVersion as bc, type Tenant as bd, type TenantPauseSource as be, type TenantRamp as bf, type TenantStats as bg, type TenantStatsResult as bh, type TenantStatus as bi, type TenantStreamPolicy as bj, type TestEmailWebhookParams as bk, type TestEmailWebhookResult as bl, type TestInbox as bm, type TestInboxAddressOptions as bn, type TestInboxEmail as bo, type TestInboxEmailDetail as bp, type TestInboxHeader as bq, TestInboxResource as br, type TestInboxUsage as bs, type TriggerEventParams as bt, type TriggerEventResult as bu, type TwilioIntegrationResponse as bv, type TwilioIntegrationStatus as bw, type UpdateAutomationParams as bx, type UpdateDomainParams as by, type UpdateEmailParams as bz, type ApiKeyScope as c, type ApplyDnsParams as d, type ApplyDnsRecordResult as e, type ApplyDnsResult as f, type Asset as g, type Automation as h, type AutomationResult as i, type AutomationRun as j, type AutomationRunResponse as k, type AutomationRunStatus as l, type AutomationRunStep as m, type AutomationRunStepStatus as n, type AutomationStatus as o, type AutomationStep as p, type AutomationTrigger as q, type BounceType as r, type CategoryOptOutCategory as s, type CategoryUnsubscribedErrorDetails as t, type ConnectTwilioParams as u, type ContactWebhookEventPayload as v, type CreateApiKeyParams as w, type CreateApiKeyResult as x, type CreateAutomationParams as y, type CreateDomainParams as z };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiErrorBody, D as DnsRecord } from './client-DJB1l4zk.js';
-export { a as ApiErrorCode, b as ApiKey, c as ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryOptOut, s as CategoryOptOutCategory, t as CategoryUnsubscribedErrorDetails, u as ConnectTwilioParams, v as ContactWebhookEventPayload, w as CreateApiKeyParams, x as CreateApiKeyResult, y as CreateAutomationParams, z as CreateDomainParams, E as CreateDomainResult, F as CreateMigrationParams, H as CreateSuppressionParams, I as CreateTemplateParams, J as CreateTenantParams, K as CreateWebhookParams, L as DEFAULT_API_BASE_URL, M as DailyRampLimitErrorDetails, N as DeleteTenantResult, O as DeliverabilityBucket, P as DeliverabilityDomainInsight, Q as DeliverabilityInsightsResult, R as DeliverabilityMailServerRelay, T as DeliverabilityWindow, U as DmarcDailyPoint, V as DmarcMonitoring, W as DmarcMonitoringDisabled, X as DmarcReadiness, Y as DmarcReadinessVerdict, Z as DmarcSource, _ as DmarcSourceStatus, $ as DmarcStatus, a0 as DnsProviderName, a1 as Domain, a2 as DomainBimiAnalysis, a3 as DomainDetailResult, a4 as DomainDmarcAnalysis, a5 as DomainDnsAnalysis, a6 as DomainStatus, a7 as DomainTlsMode, a8 as DomainTrackingDns, a9 as DomainTrackingStatus, aa as EmailListItem, ab as EmailWebhookEventPayload, ac as EmailWebhookEventType, ad as EnableDmarcParams, ae as EnableDmarcResult, af as EnrollmentSkip, ag as EventRecord, G as Groundmail, ah as GroundmailAccessToken, ai as GroundmailOptions, aj as GroundmailTokenOptions, ak as GroundmailTokenProvider, al as HeldBackErrorDetails, am as HeldBackReason, an as HeldBackRecipient, ao as ListApiKeysParams, ap as ListApiKeysResult, aq as ListAutomationRunsParams, ar as ListAutomationRunsResult, as as ListAutomationsResult, at as ListCategoryOptOutsParams, au as ListCategoryOptOutsResult, av as ListDomainsParams, aw as ListDomainsResult, ax as ListEmailsParams, ay as ListEmailsResult, az as ListReceivedEmailsParams, aA as ListReceivedEmailsResult, aB as ListSuppressionsParams, aC as ListSuppressionsResult, aD as ListTemplatesParams, aE as ListTemplatesResult, aF as ListTenantDomainsResult, aG as ListTenantsParams, aH as ListTenantsResult, aI as MailServerSigningStatus, aJ as MailStream, aK as Migration, aL as MigrationDnsChange, aM as MigrationDnsPlan, aN as MigrationDomainItem, aO as MigrationItemStatus, aP as MigrationProvider, aQ as MigrationResource, aR as MigrationSummary, aS as MigrationTemplateItem, aT as MigrationTotals, aU as MigrationWebhookItem, aV as ReceivedEmail, aW as ReceivedEmailAttachment, aX as ReceivedEmailAttachmentMeta, aY as RemoteApplyDnsCredentials, aZ as RemoveCategoryOptOutOptions, a_ as RunMigrationOptions, a$ as SendEmailParams, S as SendEmailResult, b0 as StreamDeliverability, b1 as SuppressedErrorDetails, b2 as Suppression, b3 as Template, b4 as TemplateFormat, b5 as TemplateLintWarning, b6 as TemplateStarter, b7 as TemplateStatus, b8 as TemplateVersion, b9 as Tenant, ba as TenantPauseSource, bb as TenantRamp, bc as TenantStats, bd as TenantStatsResult, be as TenantStatus, bf as TenantStreamPolicy, bg as TestEmailWebhookParams, bh as TestEmailWebhookResult, bi as TriggerEventParams, bj as TriggerEventResult, bk as TwilioIntegrationResponse, bl as TwilioIntegrationStatus, bm as UpdateAutomationParams, bn as UpdateDomainParams, bo as UpdateEmailParams, bp as UpdateTemplateParams, bq as UpdateTenantParams, br as UpdateWebhookParams, bs as ValidateEmailResult, bt as ValidationReason, bu as ValidationVerdict, bv as VerifyDomainResult, bw as WebhookEmailTag, bx as WebhookEndpoint, by as WebhookEndpointWithSecret, bz as WebhookEventType, bA as mergeMigrations, bB as normalizeAccessToken } from './client-DJB1l4zk.js';
+import { A as ApiErrorBody, D as DnsRecord } from './client-DAetJZCf.js';
+export { a as ApiErrorCode, b as ApiKey, c as ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryOptOut, s as CategoryOptOutCategory, t as CategoryUnsubscribedErrorDetails, u as ConnectTwilioParams, v as ContactWebhookEventPayload, w as CreateApiKeyParams, x as CreateApiKeyResult, y as CreateAutomationParams, z as CreateDomainParams, E as CreateDomainResult, F as CreateMigrationParams, H as CreateSuppressionParams, I as CreateTemplateParams, J as CreateTenantParams, K as CreateWebhookParams, L as DEFAULT_API_BASE_URL, M as DailyRampLimitErrorDetails, N as DeleteTenantResult, O as DeliverabilityBucket, P as DeliverabilityDomainInsight, Q as DeliverabilityInsightsResult, R as DeliverabilityMailServerRelay, T as DeliverabilityWindow, U as DmarcDailyPoint, V as DmarcMonitoring, W as DmarcMonitoringDisabled, X as DmarcReadiness, Y as DmarcReadinessVerdict, Z as DmarcSource, _ as DmarcSourceStatus, $ as DmarcStatus, a0 as DnsProviderName, a1 as Domain, a2 as DomainBimiAnalysis, a3 as DomainDetailResult, a4 as DomainDmarcAnalysis, a5 as DomainDnsAnalysis, a6 as DomainStatus, a7 as DomainTlsMode, a8 as DomainTrackingDns, a9 as DomainTrackingStatus, aa as EmailListItem, ab as EmailWebhookEventPayload, ac as EmailWebhookEventType, ad as EnableDmarcParams, ae as EnableDmarcResult, af as EnrollmentSkip, ag as EventRecord, G as Groundmail, ah as GroundmailAccessToken, ai as GroundmailOptions, aj as GroundmailTokenOptions, ak as GroundmailTokenProvider, al as HeldBackErrorDetails, am as HeldBackReason, an as HeldBackRecipient, ao as ListApiKeysParams, ap as ListApiKeysResult, aq as ListAutomationRunsParams, ar as ListAutomationRunsResult, as as ListAutomationsResult, at as ListCategoryOptOutsParams, au as ListCategoryOptOutsResult, av as ListDomainsParams, aw as ListDomainsResult, ax as ListEmailsParams, ay as ListEmailsResult, az as ListReceivedEmailsParams, aA as ListReceivedEmailsResult, aB as ListSuppressionsParams, aC as ListSuppressionsResult, aD as ListTemplatesParams, aE as ListTemplatesResult, aF as ListTenantDomainsResult, aG as ListTenantsParams, aH as ListTenantsResult, aI as ListTestInboxEmailsParams, aJ as ListTestInboxEmailsResult, aK as MailServerSigningStatus, aL as MailStream, aM as Migration, aN as MigrationDnsChange, aO as MigrationDnsPlan, aP as MigrationDomainItem, aQ as MigrationItemStatus, aR as MigrationProvider, aS as MigrationResource, aT as MigrationSummary, aU as MigrationTemplateItem, aV as MigrationTotals, aW as MigrationWebhookItem, aX as ReceivedEmail, aY as ReceivedEmailAttachment, aZ as ReceivedEmailAttachmentMeta, a_ as RemoteApplyDnsCredentials, a$ as RemoveCategoryOptOutOptions, b0 as RunMigrationOptions, b1 as SendEmailParams, S as SendEmailResult, b2 as StreamDeliverability, b3 as SuppressedErrorDetails, b4 as Suppression, b5 as TEST_INBOX_WAIT_DEFAULT_MS, b6 as TEST_INBOX_WAIT_MAX_SECONDS, b7 as Template, b8 as TemplateFormat, b9 as TemplateLintWarning, ba as TemplateStarter, bb as TemplateStatus, bc as TemplateVersion, bd as Tenant, be as TenantPauseSource, bf as TenantRamp, bg as TenantStats, bh as TenantStatsResult, bi as TenantStatus, bj as TenantStreamPolicy, bk as TestEmailWebhookParams, bl as TestEmailWebhookResult, bm as TestInbox, bn as TestInboxAddressOptions, bo as TestInboxEmail, bp as TestInboxEmailDetail, bq as TestInboxHeader, br as TestInboxResource, bs as TestInboxUsage, bt as TriggerEventParams, bu as TriggerEventResult, bv as TwilioIntegrationResponse, bw as TwilioIntegrationStatus, bx as UpdateAutomationParams, by as UpdateDomainParams, bz as UpdateEmailParams, bA as UpdateTemplateParams, bB as UpdateTenantParams, bC as UpdateWebhookParams, bD as ValidateEmailResult, bE as ValidationReason, bF as ValidationVerdict, bG as VerifyDomainResult, bH as WaitForTestEmailParams, bI as WebhookEmailTag, bJ as WebhookEndpoint, bK as WebhookEndpointWithSecret, bL as WebhookEventType, bM as mergeMigrations, bN as normalizeAccessToken } from './client-DAetJZCf.js';
 
 type GroundmailErrorOptions = {
     code?: string;

package/dist/index.js

@@ -2,6 +2,9 @@ import {
   DEFAULT_API_BASE_URL,
   Groundmail,
   GroundmailError,
+  TEST_INBOX_WAIT_DEFAULT_MS,
+  TEST_INBOX_WAIT_MAX_SECONDS,
+  TestInboxResource,
   applyDnsRecords,
   buildSignatureHeader,
   mergeMigrations,
@@ -9,7 +12,7 @@ import {
   normalizeAccessToken,
   signWebhookPayload,
   verifyWebhookSignature
-} from "./chunk-NQWM7F3N.js";
+} from "./chunk-E6G7G2PM.js";
 
 // src/simulator.ts
 var SIMULATOR_DOMAIN = "simulator.groundmail.dev";
@@ -37,6 +40,9 @@ export {
   SIMULATOR_DOMAIN,
   SIMULATOR_OUTCOMES,
   TEST_API_KEY_PREFIX,
+  TEST_INBOX_WAIT_DEFAULT_MS,
+  TEST_INBOX_WAIT_MAX_SECONDS,
+  TestInboxResource,
   applyDnsRecords,
   buildSignatureHeader,
   isSimulatorAddress,

package/dist/payload.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-DJB1l4zk.js';
+import { G as Groundmail } from './client-DAetJZCf.js';
 
 /**
  * Minimal Payload `SendEmailOptions` / address shapes used by this adapter.

package/dist/payload.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-NQWM7F3N.js";
+} from "./chunk-E6G7G2PM.js";
 
 // src/payload.ts
 function resolveApiKey(args) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "description": "Groundmail transactional email API client",
   "license": "MIT",
   "type": "module",
@@ -89,7 +89,7 @@
     "prepublishOnly": "npm run build && npm run build:nodemailer-bridge"
   },
   "dependencies": {
-    "groundmail-nodemailer": "0.15.12"
+    "groundmail-nodemailer": "0.15.13"
   },
   "devDependencies": {
     "@types/nodemailer": "^8.0.1",