groundmail 0.14.3 → 0.14.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/authjs.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail } from './client-xZ_HIfb9.js';
1
+ import { G as Groundmail } from './client-BysKOdUg.js';
2
2
 
3
3
  /** Subset of Auth.js theme used for the default magic-link email. */
4
4
  type AuthjsTheme = {
@@ -1,4 +1,4 @@
1
- import { S as SendEmailResult, G as Groundmail } from './client-xZ_HIfb9.js';
1
+ import { S as SendEmailResult, G as Groundmail } from './client-BysKOdUg.js';
2
2
 
3
3
  type BetterAuthEmailUser = {
4
4
  email: string;
package/dist/clerk.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail, S as SendEmailResult } from './client-xZ_HIfb9.js';
1
+ import { G as Groundmail, S as SendEmailResult } from './client-BysKOdUg.js';
2
2
 
3
3
  /**
4
4
  * Subset of Clerk `email.created` webhook `data` used for delivery.
@@ -94,6 +94,10 @@ type EmailListItem = {
94
94
  sent_at: string | null;
95
95
  delivered_at: string | null;
96
96
  bounced_at: string | null;
97
+ /** First open; requires open tracking on the sending domain. */
98
+ opened_at: string | null;
99
+ /** First tracked-link click; requires click tracking on the sending domain. */
100
+ clicked_at: string | null;
97
101
  };
98
102
  type ReceivedEmailAttachmentMeta = {
99
103
  filename: string;
@@ -321,12 +325,25 @@ type TriggerEventResult = {
321
325
  matched_automations: number;
322
326
  resumed_runs: number;
323
327
  cancelled_runs: number;
328
+ /** Automations whose trigger matched but did not enrol this recipient again. */
329
+ skipped_enrollments?: number;
330
+ enrollment_skips?: EnrollmentSkip[];
331
+ };
332
+ type EnrollmentSkip = {
333
+ automation_id: string;
334
+ reason: 'once_per_contact' | 'cooldown';
335
+ prior_run_id: string;
336
+ prior_run_at: string;
324
337
  };
325
338
  type AutomationStatus = 'draft' | 'active' | 'paused';
326
339
  type AutomationTrigger = {
327
340
  type: 'event';
328
341
  event: string;
329
342
  cancel_on_events?: string[];
343
+ /** Enrol each recipient at most once, matched on the event's email or user_id. */
344
+ once_per_contact?: boolean;
345
+ /** Do not enrol the same recipient again within this many days. */
346
+ cooldown_days?: number;
330
347
  };
331
348
  type AutomationStep = {
332
349
  type: 'delay' | 'send_email' | 'send_sms' | 'condition' | 'wait_for_event';
@@ -367,6 +384,11 @@ type UpdateAutomationParams = {
367
384
  trigger?: AutomationTrigger;
368
385
  steps?: AutomationStep[];
369
386
  };
387
+ type AutomationResult = {
388
+ automation: Automation;
389
+ /** Steps that saved but should not ship as written, e.g. a product email with no unsubscribe link. */
390
+ warnings?: string[];
391
+ };
370
392
  type ListAutomationsResult = {
371
393
  automations: Automation[];
372
394
  };
@@ -755,12 +777,8 @@ declare class AutomationsResource {
755
777
  get(id: string): Promise<{
756
778
  automation: Automation;
757
779
  }>;
758
- create(params: CreateAutomationParams): Promise<{
759
- automation: Automation;
760
- }>;
761
- update(id: string, params: UpdateAutomationParams): Promise<{
762
- automation: Automation;
763
- }>;
780
+ create(params: CreateAutomationParams): Promise<AutomationResult>;
781
+ update(id: string, params: UpdateAutomationParams): Promise<AutomationResult>;
764
782
  remove(id: string): Promise<{
765
783
  ok: boolean;
766
784
  }>;
@@ -967,4 +985,4 @@ declare class Groundmail {
967
985
  request<T>(path: string, init: RequestInit): Promise<T>;
968
986
  }
969
987
 
970
- export { type ListApiKeysResult as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryUnsubscribedErrorDetails as C, type DnsRecord as D, DEFAULT_API_BASE_URL as E, type DeliverabilityBucket as F, Groundmail as G, type DeliverabilityDomainInsight as H, type DeliverabilityInsightsResult as I, type DeliverabilityMailServerRelay as J, type DeliverabilityWindow as K, type DnsProviderName as L, type Domain as M, type DomainBimiAnalysis as N, type DomainDetailResult as O, type DomainDmarcAnalysis as P, type DomainDnsAnalysis as Q, type DomainStatus as R, type SendEmailResult as S, type DomainTlsMode as T, type DomainTrackingDns as U, type DomainTrackingStatus as V, type EmailListItem as W, type EmailWebhookEventType as X, type EventRecord as Y, type GroundmailOptions as Z, type ListApiKeysParams as _, type ApiErrorCode as a, type ListAutomationRunsParams as a0, type ListAutomationRunsResult as a1, type ListAutomationsResult as a2, type ListDomainsParams as a3, type ListDomainsResult as a4, type ListEmailsParams as a5, type ListEmailsResult as a6, type ListReceivedEmailsParams as a7, type ListReceivedEmailsResult as a8, type ListSuppressionsParams as a9, type UpdateTemplateParams as aA, type UpdateWebhookParams as aB, type VerifyDomainResult as aC, type WebhookEndpoint as aD, type WebhookEndpointWithSecret as aE, type WebhookEventType as aF, type ListSuppressionsResult as aa, type ListTemplatesParams as ab, type ListTemplatesResult as ac, type MailServerSigningStatus as ad, type ReceivedEmail as ae, type ReceivedEmailAttachment as af, type ReceivedEmailAttachmentMeta as ag, type RemoteApplyDnsCredentials as ah, type SendEmailParams as ai, type SuppressedErrorDetails as aj, type Suppression as ak, type Template as al, type TemplateFormat as am, type TemplateLintWarning as an, type TemplateStarter as ao, type TemplateStatus as ap, type TemplateVersion as aq, type TestEmailWebhookParams as ar, type TestEmailWebhookResult as as, type TriggerEventParams as at, type TriggerEventResult as au, type TwilioIntegrationResponse as av, type TwilioIntegrationStatus as aw, type UpdateAutomationParams as ax, type UpdateDomainParams as ay, type UpdateEmailParams as az, type ApiKey as b, 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 AutomationRun as i, type AutomationRunResponse as j, type AutomationRunStatus as k, type AutomationRunStep as l, type AutomationRunStepStatus as m, type AutomationStatus as n, type AutomationStep as o, type AutomationTrigger as p, type ConnectTwilioParams as q, type ContactWebhookEventPayload as r, type CreateApiKeyParams as s, type CreateApiKeyResult as t, type CreateAutomationParams as u, type CreateDomainParams as v, type CreateDomainResult as w, type CreateSuppressionParams as x, type CreateTemplateParams as y, type CreateWebhookParams as z };
988
+ export { type GroundmailOptions as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryUnsubscribedErrorDetails as C, type DnsRecord as D, type CreateWebhookParams as E, DEFAULT_API_BASE_URL as F, Groundmail as G, type DeliverabilityBucket as H, type DeliverabilityDomainInsight as I, type DeliverabilityInsightsResult as J, type DeliverabilityMailServerRelay as K, type DeliverabilityWindow as L, type DnsProviderName as M, type Domain as N, type DomainBimiAnalysis as O, type DomainDetailResult as P, type DomainDmarcAnalysis as Q, type DomainDnsAnalysis as R, type SendEmailResult as S, type DomainStatus as T, type DomainTlsMode as U, type DomainTrackingDns as V, type DomainTrackingStatus as W, type EmailListItem as X, type EmailWebhookEventType as Y, type EnrollmentSkip as Z, type EventRecord as _, type ApiErrorCode as a, type ListApiKeysParams as a0, type ListApiKeysResult as a1, type ListAutomationRunsParams as a2, type ListAutomationRunsResult as a3, type ListAutomationsResult as a4, type ListDomainsParams as a5, type ListDomainsResult as a6, type ListEmailsParams as a7, type ListEmailsResult as a8, type ListReceivedEmailsParams as a9, type UpdateDomainParams as aA, type UpdateEmailParams as aB, type UpdateTemplateParams as aC, type UpdateWebhookParams as aD, type VerifyDomainResult as aE, type WebhookEndpoint as aF, type WebhookEndpointWithSecret as aG, type WebhookEventType as aH, type ListReceivedEmailsResult as aa, type ListSuppressionsParams as ab, type ListSuppressionsResult as ac, type ListTemplatesParams as ad, type ListTemplatesResult as ae, type MailServerSigningStatus as af, type ReceivedEmail as ag, type ReceivedEmailAttachment as ah, type ReceivedEmailAttachmentMeta as ai, type RemoteApplyDnsCredentials as aj, type SendEmailParams as ak, type SuppressedErrorDetails as al, type Suppression as am, type Template as an, type TemplateFormat as ao, type TemplateLintWarning as ap, type TemplateStarter as aq, type TemplateStatus as ar, type TemplateVersion as as, type TestEmailWebhookParams as at, type TestEmailWebhookResult as au, type TriggerEventParams as av, type TriggerEventResult as aw, type TwilioIntegrationResponse as ax, type TwilioIntegrationStatus as ay, type UpdateAutomationParams as az, type ApiKey as b, 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 ConnectTwilioParams as r, type ContactWebhookEventPayload as s, type CreateApiKeyParams as t, type CreateApiKeyResult as u, type CreateAutomationParams as v, type CreateDomainParams as w, type CreateDomainResult as x, type CreateSuppressionParams as y, type CreateTemplateParams as z };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiErrorBody, D as DnsRecord } from './client-xZ_HIfb9.js';
2
- 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 AutomationRun, j as AutomationRunResponse, k as AutomationRunStatus, l as AutomationRunStep, m as AutomationRunStepStatus, n as AutomationStatus, o as AutomationStep, p as AutomationTrigger, B as BatchSendEmailResult, C as CategoryUnsubscribedErrorDetails, q as ConnectTwilioParams, r as ContactWebhookEventPayload, s as CreateApiKeyParams, t as CreateApiKeyResult, u as CreateAutomationParams, v as CreateDomainParams, w as CreateDomainResult, x as CreateSuppressionParams, y as CreateTemplateParams, z as CreateWebhookParams, E as DEFAULT_API_BASE_URL, F as DeliverabilityBucket, H as DeliverabilityDomainInsight, I as DeliverabilityInsightsResult, J as DeliverabilityMailServerRelay, K as DeliverabilityWindow, L as DnsProviderName, M as Domain, N as DomainBimiAnalysis, O as DomainDetailResult, P as DomainDmarcAnalysis, Q as DomainDnsAnalysis, R as DomainStatus, T as DomainTlsMode, U as DomainTrackingDns, V as DomainTrackingStatus, W as EmailListItem, X as EmailWebhookEventType, Y as EventRecord, G as Groundmail, Z as GroundmailOptions, _ as ListApiKeysParams, $ as ListApiKeysResult, a0 as ListAutomationRunsParams, a1 as ListAutomationRunsResult, a2 as ListAutomationsResult, a3 as ListDomainsParams, a4 as ListDomainsResult, a5 as ListEmailsParams, a6 as ListEmailsResult, a7 as ListReceivedEmailsParams, a8 as ListReceivedEmailsResult, a9 as ListSuppressionsParams, aa as ListSuppressionsResult, ab as ListTemplatesParams, ac as ListTemplatesResult, ad as MailServerSigningStatus, ae as ReceivedEmail, af as ReceivedEmailAttachment, ag as ReceivedEmailAttachmentMeta, ah as RemoteApplyDnsCredentials, ai as SendEmailParams, S as SendEmailResult, aj as SuppressedErrorDetails, ak as Suppression, al as Template, am as TemplateFormat, an as TemplateLintWarning, ao as TemplateStarter, ap as TemplateStatus, aq as TemplateVersion, ar as TestEmailWebhookParams, as as TestEmailWebhookResult, at as TriggerEventParams, au as TriggerEventResult, av as TwilioIntegrationResponse, aw as TwilioIntegrationStatus, ax as UpdateAutomationParams, ay as UpdateDomainParams, az as UpdateEmailParams, aA as UpdateTemplateParams, aB as UpdateWebhookParams, aC as VerifyDomainResult, aD as WebhookEndpoint, aE as WebhookEndpointWithSecret, aF as WebhookEventType } from './client-xZ_HIfb9.js';
1
+ import { A as ApiErrorBody, D as DnsRecord } from './client-BysKOdUg.js';
2
+ 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, C as CategoryUnsubscribedErrorDetails, r as ConnectTwilioParams, s as ContactWebhookEventPayload, t as CreateApiKeyParams, u as CreateApiKeyResult, v as CreateAutomationParams, w as CreateDomainParams, x as CreateDomainResult, y as CreateSuppressionParams, z as CreateTemplateParams, E as CreateWebhookParams, F as DEFAULT_API_BASE_URL, H as DeliverabilityBucket, I as DeliverabilityDomainInsight, J as DeliverabilityInsightsResult, K as DeliverabilityMailServerRelay, L as DeliverabilityWindow, M as DnsProviderName, N as Domain, O as DomainBimiAnalysis, P as DomainDetailResult, Q as DomainDmarcAnalysis, R as DomainDnsAnalysis, T as DomainStatus, U as DomainTlsMode, V as DomainTrackingDns, W as DomainTrackingStatus, X as EmailListItem, Y as EmailWebhookEventType, Z as EnrollmentSkip, _ as EventRecord, G as Groundmail, $ as GroundmailOptions, a0 as ListApiKeysParams, a1 as ListApiKeysResult, a2 as ListAutomationRunsParams, a3 as ListAutomationRunsResult, a4 as ListAutomationsResult, a5 as ListDomainsParams, a6 as ListDomainsResult, a7 as ListEmailsParams, a8 as ListEmailsResult, a9 as ListReceivedEmailsParams, aa as ListReceivedEmailsResult, ab as ListSuppressionsParams, ac as ListSuppressionsResult, ad as ListTemplatesParams, ae as ListTemplatesResult, af as MailServerSigningStatus, ag as ReceivedEmail, ah as ReceivedEmailAttachment, ai as ReceivedEmailAttachmentMeta, aj as RemoteApplyDnsCredentials, ak as SendEmailParams, S as SendEmailResult, al as SuppressedErrorDetails, am as Suppression, an as Template, ao as TemplateFormat, ap as TemplateLintWarning, aq as TemplateStarter, ar as TemplateStatus, as as TemplateVersion, at as TestEmailWebhookParams, au as TestEmailWebhookResult, av as TriggerEventParams, aw as TriggerEventResult, ax as TwilioIntegrationResponse, ay as TwilioIntegrationStatus, az as UpdateAutomationParams, aA as UpdateDomainParams, aB as UpdateEmailParams, aC as UpdateTemplateParams, aD as UpdateWebhookParams, aE as VerifyDomainResult, aF as WebhookEndpoint, aG as WebhookEndpointWithSecret, aH as WebhookEventType } from './client-BysKOdUg.js';
3
3
 
4
4
  type GroundmailErrorOptions = {
5
5
  code?: string;
package/dist/payload.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail } from './client-xZ_HIfb9.js';
1
+ import { G as Groundmail } from './client-BysKOdUg.js';
2
2
 
3
3
  /**
4
4
  * Minimal Payload `SendEmailOptions` / address shapes used by this adapter.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "groundmail",
3
- "version": "0.14.3",
3
+ "version": "0.14.5",
4
4
  "description": "Groundmail transactional email API client",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -89,7 +89,7 @@
89
89
  "prepublishOnly": "npm run build && npm run build:nodemailer-bridge"
90
90
  },
91
91
  "dependencies": {
92
- "groundmail-nodemailer": "0.14.3"
92
+ "groundmail-nodemailer": "0.14.5"
93
93
  },
94
94
  "devDependencies": {
95
95
  "@types/nodemailer": "^8.0.1",