mailery 0.3.2 → 0.5.1

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 Mailer, T as TemplateDoc, d as SuppressionScope, F as FlowStep, e as SegmentFilter, P as Predicate } from './null-CGaNDDlQ.cjs';
-export { f as AuditLogDoc, B as BroadcastDoc, g as BroadcastStatus, h as CircuitBreakerThresholds, i as Collections, j as ContactTagDoc, E as EventDoc, k as FlowDoc, l as FlowGoal, m as FlowRunDoc, n as FlowRunStatus, o as FlowVersionDoc, H as HealthDoc, p as HealthStatus, L as LeadDoc, q as MailerConfig, r as NullProvider, O as OutboxDoc, s as RedisOptions, t as SegmentDefinition, u as SendDoc, v as SendStatus, w as SenderDomainConfig, x as SenderDomainRegistry, y as SenderDomainValidation, z as SubscriptionDoc, D as SubscriptionStatus, G as SuppressionDoc, I as SuppressionReason, J as TemplateKind, K as TemplateVersionDoc, W as WebhookEventDoc, Q as ensureIndexes, U as getCollections, V as validateSenderDomain } from './null-CGaNDDlQ.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, 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 { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -140,6 +140,37 @@ declare class SendGridProvider implements MailProvider {
     parseWebhookEvents(payload: unknown): NormalizedEvent[];
 }
 
+/**
+ * Mail-Tester deliverability check.
+ *
+ *  1. Operator clicks "Run deliverability check" in the template editor.
+ *  2. Mailery provisions a check (gets a unique test address from Mail-Tester).
+ *  3. Mailery sends the rendered draft to that address via the operator's
+ *     default provider.
+ *  4. Mailery polls Mail-Tester for the score (typically arrives 10-30s after
+ *     receipt) and caches it keyed on a content fingerprint.
+ *  5. If the score is below `minScore` the publish endpoint refuses unless
+ *     the operator passes `bypassMailTester: true` in the publish request.
+ *
+ * The client interface is pluggable so tests inject a stub. Real
+ * implementation hits https://mail-tester.com/api/.
+ */
+
+interface ProvisionedCheck {
+    checkId: string;
+    emailAddress: string;
+}
+interface MailTesterResult {
+    ready: boolean;
+    score: number;
+    feedback: MailTesterFeedback[];
+    rawSummary: string | null;
+}
+interface MailTesterClient {
+    provisionCheck(): Promise<ProvisionedCheck>;
+    fetchResult(checkId: string): Promise<MailTesterResult>;
+}
+
 /**
  * Admin router — serves the prebuilt React SPA + REST endpoints the SPA
  * consumes. Mount inside a host Express app, gated by host auth.
@@ -154,6 +185,11 @@ interface AdminRouterOptions {
     spaDir?: string;
     /** Resolve actor metadata from a Request. Defaults to `human:${req.user?.email || 'anonymous'}`. */
     getActor?: (req: Request) => string;
+    /**
+     * Inject a Mail-Tester client (tests use a stub). When omitted, a real
+     * client is created from `mailer.config.mailTester`.
+     */
+    mailTesterClient?: MailTesterClient;
 }
 declare function createAdminRouter(mailer: Mailer, opts?: AdminRouterOptions): Router;
 

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 Mailer, T as TemplateDoc, d as SuppressionScope, F as FlowStep, e as SegmentFilter, P as Predicate } from './null-CGaNDDlQ.js';
-export { f as AuditLogDoc, B as BroadcastDoc, g as BroadcastStatus, h as CircuitBreakerThresholds, i as Collections, j as ContactTagDoc, E as EventDoc, k as FlowDoc, l as FlowGoal, m as FlowRunDoc, n as FlowRunStatus, o as FlowVersionDoc, H as HealthDoc, p as HealthStatus, L as LeadDoc, q as MailerConfig, r as NullProvider, O as OutboxDoc, s as RedisOptions, t as SegmentDefinition, u as SendDoc, v as SendStatus, w as SenderDomainConfig, x as SenderDomainRegistry, y as SenderDomainValidation, z as SubscriptionDoc, D as SubscriptionStatus, G as SuppressionDoc, I as SuppressionReason, J as TemplateKind, K as TemplateVersionDoc, W as WebhookEventDoc, Q as ensureIndexes, U as getCollections, V as validateSenderDomain } from './null-CGaNDDlQ.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, 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 { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -140,6 +140,37 @@ declare class SendGridProvider implements MailProvider {
     parseWebhookEvents(payload: unknown): NormalizedEvent[];
 }
 
+/**
+ * Mail-Tester deliverability check.
+ *
+ *  1. Operator clicks "Run deliverability check" in the template editor.
+ *  2. Mailery provisions a check (gets a unique test address from Mail-Tester).
+ *  3. Mailery sends the rendered draft to that address via the operator's
+ *     default provider.
+ *  4. Mailery polls Mail-Tester for the score (typically arrives 10-30s after
+ *     receipt) and caches it keyed on a content fingerprint.
+ *  5. If the score is below `minScore` the publish endpoint refuses unless
+ *     the operator passes `bypassMailTester: true` in the publish request.
+ *
+ * The client interface is pluggable so tests inject a stub. Real
+ * implementation hits https://mail-tester.com/api/.
+ */
+
+interface ProvisionedCheck {
+    checkId: string;
+    emailAddress: string;
+}
+interface MailTesterResult {
+    ready: boolean;
+    score: number;
+    feedback: MailTesterFeedback[];
+    rawSummary: string | null;
+}
+interface MailTesterClient {
+    provisionCheck(): Promise<ProvisionedCheck>;
+    fetchResult(checkId: string): Promise<MailTesterResult>;
+}
+
 /**
  * Admin router — serves the prebuilt React SPA + REST endpoints the SPA
  * consumes. Mount inside a host Express app, gated by host auth.
@@ -154,6 +185,11 @@ interface AdminRouterOptions {
     spaDir?: string;
     /** Resolve actor metadata from a Request. Defaults to `human:${req.user?.email || 'anonymous'}`. */
     getActor?: (req: Request) => string;
+    /**
+     * Inject a Mail-Tester client (tests use a stub). When omitted, a real
+     * client is created from `mailer.config.mailTester`.
+     */
+    mailTesterClient?: MailTesterClient;
 }
 declare function createAdminRouter(mailer: Mailer, opts?: AdminRouterOptions): Router;