mailery 0.5.1 → 0.7.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, e as SuppressionScope, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-BYB6v4Iv.cjs';
-export { g as AuditLogDoc, B as BroadcastDoc, h as BroadcastStatus, i as CircuitBreakerThresholds, j as Collections, k as ContactTagDoc, E as EventDoc, l as FlowDoc, m as FlowGoal, n as FlowRunDoc, o as FlowRunStatus, p as FlowVersionDoc, H as HealthDoc, q as HealthStatus, L as LeadDoc, r as MailerConfig, s as NullProvider, O as OutboxDoc, t as RedisOptions, u as SegmentDefinition, v as SendDoc, w as SendStatus, x as SenderDomainConfig, y as SenderDomainRegistry, z as SenderDomainValidation, D as SubscriptionDoc, G as SubscriptionStatus, I as SuppressionDoc, J as SuppressionReason, K as TemplateKind, Q as TemplateVersionDoc, W as WebhookEventDoc, U as ensureIndexes, V as getCollections, X as validateSenderDomain } from './null-BYB6v4Iv.cjs';
+import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, e as SuppressionScope, D as DeliveryWindow, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-B0rPgE5_.cjs';
+export { g as AuditLogDoc, B as BroadcastDoc, h as BroadcastStatus, i as CircuitBreakerThresholds, j as Collections, k as ContactTagDoc, E as EventDoc, l as FlowDoc, m as FlowGoal, n as FlowRunDoc, o as FlowRunStatus, p as FlowVersionDoc, H as HealthDoc, q as HealthStatus, L as LeadDoc, r as MailerConfig, s as NullProvider, O as OutboxDoc, t as RESERVED_VAR_KEYS, u as RedisOptions, v as SegmentDefinition, w as SendDoc, x as SendStatus, y as SenderDomainConfig, z as SenderDomainRegistry, G as SenderDomainValidation, I as SubscriptionDoc, J as SubscriptionStatus, K as SuppressionDoc, Q as SuppressionReason, U as TemplateKind, V as TemplateVersionDoc, W as VarsAdapter, X as VarsResolveInfo, Y as WebhookEventDoc, Z as defineVars, _ as ensureIndexes, $ as getCollections, a0 as validateSenderDomain, a1 as varsJsonSchema } from './null-B0rPgE5_.cjs';
 import { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -250,8 +250,16 @@ declare function compileMailyTemplate(content: unknown): Promise<CompileResult>;
 /** Auto-derive plain text from compiled HTML. */
 declare function derivePlaintext(html: string): string;
 interface RenderContext {
+    /**
+     * Host-resolved variables (varsAdapter) live at the context root, so a
+     * schema key `user` renders as `{{user.name}}`. Reserved keys below always
+     * win over resolved keys.
+     */
+    [resolvedVar: string]: unknown;
     contact: Contact;
     vars: Record<string, unknown>;
+    /** Properties of the event that triggered the flow run ({{event.*}}). Empty outside flow sends. */
+    event?: Record<string, unknown>;
     /** URL the recipient hits to one-click unsubscribe. */
     unsubscribeUrl: string;
     /** URL to view this email in a browser (when implemented). */
@@ -325,6 +333,20 @@ declare function verifyUnsubscribeToken(token: string, secret: string, now?: Dat
  */
 declare function sha256Hex(input: string): string;
 
+/**
+ * Delivery-window math. Pure — no I/O, no Date.now(); callers pass `now`.
+ *
+ * Given the moment a send step becomes runnable, `computeDeliveryTime`
+ * returns the earliest instant the email is allowed to go out. It only ever
+ * moves forward: a send already inside its window returns `now` unchanged.
+ *
+ * Timezone handling uses the Intl API (no dependency). DST transitions are
+ * resolved with a two-pass offset fix; the worst case during a transition is
+ * being off by the shifted hour, which is fine for email delivery.
+ */
+
+declare function computeDeliveryTime(now: Date, window: DeliveryWindow, contactTimezone?: string): Date;
+
 /**
  * Enumerable option lists for the union types in `./types.ts`. Used by the
  * admin client to render dropdowns + by tooling to enumerate the surface.
@@ -376,6 +398,6 @@ declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
 /**
  * Public exports for the `mailery` package.
  */
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.7.0";
 
-export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, applyWebhookEvent, compileMailyTemplate, compileTemplate, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, dispatchSend, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, renderTemplate, runTick, sha256Hex, signUnsubscribeToken, sweepStrandedFlowRuns, verifyUnsubscribeToken };
+export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, DeliveryWindow, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, applyWebhookEvent, compileMailyTemplate, compileTemplate, computeDeliveryTime, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, dispatchSend, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, renderTemplate, runTick, sha256Hex, signUnsubscribeToken, sweepStrandedFlowRuns, verifyUnsubscribeToken };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, e as SuppressionScope, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-BYB6v4Iv.js';
-export { g as AuditLogDoc, B as BroadcastDoc, h as BroadcastStatus, i as CircuitBreakerThresholds, j as Collections, k as ContactTagDoc, E as EventDoc, l as FlowDoc, m as FlowGoal, n as FlowRunDoc, o as FlowRunStatus, p as FlowVersionDoc, H as HealthDoc, q as HealthStatus, L as LeadDoc, r as MailerConfig, s as NullProvider, O as OutboxDoc, t as RedisOptions, u as SegmentDefinition, v as SendDoc, w as SendStatus, x as SenderDomainConfig, y as SenderDomainRegistry, z as SenderDomainValidation, D as SubscriptionDoc, G as SubscriptionStatus, I as SuppressionDoc, J as SuppressionReason, K as TemplateKind, Q as TemplateVersionDoc, W as WebhookEventDoc, U as ensureIndexes, V as getCollections, X as validateSenderDomain } from './null-BYB6v4Iv.js';
+import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, e as SuppressionScope, D as DeliveryWindow, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-B0rPgE5_.js';
+export { g as AuditLogDoc, B as BroadcastDoc, h as BroadcastStatus, i as CircuitBreakerThresholds, j as Collections, k as ContactTagDoc, E as EventDoc, l as FlowDoc, m as FlowGoal, n as FlowRunDoc, o as FlowRunStatus, p as FlowVersionDoc, H as HealthDoc, q as HealthStatus, L as LeadDoc, r as MailerConfig, s as NullProvider, O as OutboxDoc, t as RESERVED_VAR_KEYS, u as RedisOptions, v as SegmentDefinition, w as SendDoc, x as SendStatus, y as SenderDomainConfig, z as SenderDomainRegistry, G as SenderDomainValidation, I as SubscriptionDoc, J as SubscriptionStatus, K as SuppressionDoc, Q as SuppressionReason, U as TemplateKind, V as TemplateVersionDoc, W as VarsAdapter, X as VarsResolveInfo, Y as WebhookEventDoc, Z as defineVars, _ as ensureIndexes, $ as getCollections, a0 as validateSenderDomain, a1 as varsJsonSchema } from './null-B0rPgE5_.js';
 import { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -250,8 +250,16 @@ declare function compileMailyTemplate(content: unknown): Promise<CompileResult>;
 /** Auto-derive plain text from compiled HTML. */
 declare function derivePlaintext(html: string): string;
 interface RenderContext {
+    /**
+     * Host-resolved variables (varsAdapter) live at the context root, so a
+     * schema key `user` renders as `{{user.name}}`. Reserved keys below always
+     * win over resolved keys.
+     */
+    [resolvedVar: string]: unknown;
     contact: Contact;
     vars: Record<string, unknown>;
+    /** Properties of the event that triggered the flow run ({{event.*}}). Empty outside flow sends. */
+    event?: Record<string, unknown>;
     /** URL the recipient hits to one-click unsubscribe. */
     unsubscribeUrl: string;
     /** URL to view this email in a browser (when implemented). */
@@ -325,6 +333,20 @@ declare function verifyUnsubscribeToken(token: string, secret: string, now?: Dat
  */
 declare function sha256Hex(input: string): string;
 
+/**
+ * Delivery-window math. Pure — no I/O, no Date.now(); callers pass `now`.
+ *
+ * Given the moment a send step becomes runnable, `computeDeliveryTime`
+ * returns the earliest instant the email is allowed to go out. It only ever
+ * moves forward: a send already inside its window returns `now` unchanged.
+ *
+ * Timezone handling uses the Intl API (no dependency). DST transitions are
+ * resolved with a two-pass offset fix; the worst case during a transition is
+ * being off by the shifted hour, which is fine for email delivery.
+ */
+
+declare function computeDeliveryTime(now: Date, window: DeliveryWindow, contactTimezone?: string): Date;
+
 /**
  * Enumerable option lists for the union types in `./types.ts`. Used by the
  * admin client to render dropdowns + by tooling to enumerate the surface.
@@ -376,6 +398,6 @@ declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
 /**
  * Public exports for the `mailery` package.
  */
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.7.0";
 
-export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, applyWebhookEvent, compileMailyTemplate, compileTemplate, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, dispatchSend, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, renderTemplate, runTick, sha256Hex, signUnsubscribeToken, sweepStrandedFlowRuns, verifyUnsubscribeToken };
+export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, DeliveryWindow, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, applyWebhookEvent, compileMailyTemplate, compileTemplate, computeDeliveryTime, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, dispatchSend, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, renderTemplate, runTick, sha256Hex, signUnsubscribeToken, sweepStrandedFlowRuns, verifyUnsubscribeToken };