mailery 0.19.0 → 0.20.0

package/dist/{null-DxTHQSrJ.d.cts → null-B3N6bTpc.d.cts}

@@ -1,4 +1,4 @@
-import { Db, ObjectId, Collection, ClientSession } from 'mongodb';
+import { Db, MongoClientOptions, ObjectId, Collection, ClientSession } from 'mongodb';
 import { z } from 'zod';
 import Handlebars from 'handlebars';
 import IORedis from 'ioredis';
@@ -765,10 +765,31 @@ interface BotFilterConfig {
      */
     minOpenDelayMs?: number;
 }
+/**
+ * A MongoDB connection mailery opens itself, on its own driver: `Mailer.init`
+ * connects, and `mailer.stop()` closes it. For hosts whose code is on another
+ * `mongodb` major (every Mongoose 8 app bundles driver 6), where sharing a
+ * `Db` is not possible.
+ */
+interface MailerMongoConnection {
+    uri: string;
+    /** Database name. Defaults to the one named in `uri`. */
+    dbName?: string;
+    clientOptions?: MongoClientOptions;
+}
+/**
+ * Builds the contact adapter on the database mailery connected to. Use it with
+ * `mongo`, when the host has no `Db` of its own to hand the adapter:
+ * `adapter: (db) => new MongoContactAdapter({ db, collection: 'users' })`.
+ */
+type ContactAdapterFactory = (db: Db) => ContactAdapter;
 interface MailerConfig {
-    db: Db;
+    /** An open database on the host's own client. Give exactly one of `db` or `mongo`. */
+    db?: Db;
+    /** A connection mailery opens and owns. Give exactly one of `db` or `mongo`. */
+    mongo?: MailerMongoConnection;
     collectionPrefix?: string;
-    adapter: ContactAdapter;
+    adapter: ContactAdapter | ContactAdapterFactory;
     /**
      * Optional host-provided template variables. `resolve(contact)` runs at
      * send/preview/test render time; its result is merged into the template
@@ -980,7 +1001,12 @@ interface MailerConfig {
 type ResolvedConfig = Required<Pick<MailerConfig, 'collectionPrefix' | 'requireDoubleOptIn' | 'unsubscribeTokenLifetimeDays' | 'transactionalRespectUnsubscribe' | 'unsubscribeWriteTimeoutMs' | 'doiTemplateSlug' | 'doiTokenLifetimeDays' | 'broadcastConfirmationThreshold' | 'broadcastEnqueueBatchSize' | 'broadcastEnqueueMaxWaiting' | 'workerless' | 'tickIntervalSeconds' | 'sendConcurrency' | 'sendRatePerSecond' | 'softBouncePromotionThreshold' | 'softBouncePromotionWindowDays' | 'webhookRetryAttempts' | 'sendRetryAttempts' | 'trackOpens' | 'trackClicks' | 'storeTrackingIp' | 'storeRenderedBody' | 'requireSignedTrackingUrls' | 'trackingUrlLifetimeDays'>> & {
     circuitBreaker: CircuitBreakerThresholds;
     broadcastStopRules: BroadcastStopRules;
-} & MailerConfig;
+} & StorageResolvedConfig;
+/** `MailerConfig` once `Mailer.init` has opened storage: one `db`, one built adapter. */
+type StorageResolvedConfig = Omit<MailerConfig, 'db' | 'mongo' | 'adapter'> & {
+    db: Db;
+    adapter: ContactAdapter;
+};
 
 /**
  * Mongo collection helpers + indexes for every mailer-owned collection.
@@ -1717,6 +1743,8 @@ declare class Mailer {
     readonly config: ResolvedConfig;
     readonly events: EventRegistry;
     private queueDriver;
+    /** The client `Mailer.init` opened from `config.mongo`; closed by `stop()`. Null when the host gave `db`. */
+    private ownedClient;
     private workersStarted;
     private runnerContext;
     private constructor();
@@ -1869,4 +1897,4 @@ declare class NullProvider implements MailProvider {
     reset(): void;
 }
 
-export { type VarsResolveInfo as $, type AdapterFilter as A, type BotFilterConfig as B, type ContactAdapter as C, type DeliveryWindow as D, type EventDoc as E, type FlowStep as F, type SendDoc as G, type HealthDoc as H, type SendStatus as I, type SenderDomainConfig as J, type SenderDomainRegistry as K, type LeadDoc as L, type MailProvider as M, type NormalizedEvent as N, type OutboxDoc as O, type Predicate as P, type SenderDomainValidation as Q, type RunnerContext as R, type SendArgs as S, type TemplateDoc as T, type SubscriptionDoc as U, type SubscriptionStatus as V, type SuppressionDoc as W, type SuppressionReason as X, type TemplateKind as Y, type TemplateVersionDoc as Z, type VarsAdapter as _, type Contact as a, type WebhookEventDoc as a0, defineVars as a1, ensureIndexes as a2, getCollections as a3, validateSenderDomain as a4, varsJsonSchema as a5, type FlowTrigger as a6, type QueueDriverConfig as a7, type AdapterSort as b, type SendResult as c, type MailTesterFeedback as d, Mailer as e, type Collections as f, type FlowDoc as g, type SuppressionScope as h, type SegmentFilter as i, type AuditLogDoc as j, type BroadcastDoc as k, type BroadcastOrder as l, type BroadcastPauseReason as m, type BroadcastStatus as n, type CircuitBreakerThresholds as o, type ContactTagDoc as p, type FlowGoal as q, type FlowRunDoc as r, type FlowRunStatus as s, type FlowVersionDoc as t, type HealthStatus as u, type MailerConfig as v, NullProvider as w, RESERVED_VAR_KEYS as x, type RedisOptions as y, type SegmentDefinition as z };
+export { type TemplateVersionDoc as $, type AdapterFilter as A, type BotFilterConfig as B, type ContactAdapter as C, type DeliveryWindow as D, type EventDoc as E, type FlowStep as F, type RedisOptions as G, type HealthDoc as H, type SegmentDefinition as I, type SendDoc as J, type SendStatus as K, type LeadDoc as L, type MailProvider as M, type NormalizedEvent as N, type OutboxDoc as O, type Predicate as P, type SenderDomainConfig as Q, type RunnerContext as R, type SendArgs as S, type TemplateDoc as T, type SenderDomainRegistry as U, type SenderDomainValidation as V, type SubscriptionDoc as W, type SubscriptionStatus as X, type SuppressionDoc as Y, type SuppressionReason as Z, type TemplateKind as _, type Contact as a, type VarsAdapter as a0, type VarsResolveInfo as a1, type WebhookEventDoc as a2, defineVars as a3, ensureIndexes as a4, getCollections as a5, validateSenderDomain as a6, varsJsonSchema as a7, type FlowTrigger as a8, type QueueDriverConfig as a9, type AdapterSort as b, type SendResult as c, type MailTesterFeedback as d, Mailer as e, type Collections as f, type FlowDoc as g, type SuppressionScope as h, type SegmentFilter as i, type AuditLogDoc as j, type BroadcastDoc as k, type BroadcastOrder as l, type BroadcastPauseReason as m, type BroadcastStatus as n, type CircuitBreakerThresholds as o, type ContactAdapterFactory as p, type ContactTagDoc as q, type FlowGoal as r, type FlowRunDoc as s, type FlowRunStatus as t, type FlowVersionDoc as u, type HealthStatus as v, type MailerConfig as w, type MailerMongoConnection as x, NullProvider as y, RESERVED_VAR_KEYS as z };

package/dist/{null-DxTHQSrJ.d.ts → null-B3N6bTpc.d.ts}

@@ -1,4 +1,4 @@
-import { Db, ObjectId, Collection, ClientSession } from 'mongodb';
+import { Db, MongoClientOptions, ObjectId, Collection, ClientSession } from 'mongodb';
 import { z } from 'zod';
 import Handlebars from 'handlebars';
 import IORedis from 'ioredis';
@@ -765,10 +765,31 @@ interface BotFilterConfig {
      */
     minOpenDelayMs?: number;
 }
+/**
+ * A MongoDB connection mailery opens itself, on its own driver: `Mailer.init`
+ * connects, and `mailer.stop()` closes it. For hosts whose code is on another
+ * `mongodb` major (every Mongoose 8 app bundles driver 6), where sharing a
+ * `Db` is not possible.
+ */
+interface MailerMongoConnection {
+    uri: string;
+    /** Database name. Defaults to the one named in `uri`. */
+    dbName?: string;
+    clientOptions?: MongoClientOptions;
+}
+/**
+ * Builds the contact adapter on the database mailery connected to. Use it with
+ * `mongo`, when the host has no `Db` of its own to hand the adapter:
+ * `adapter: (db) => new MongoContactAdapter({ db, collection: 'users' })`.
+ */
+type ContactAdapterFactory = (db: Db) => ContactAdapter;
 interface MailerConfig {
-    db: Db;
+    /** An open database on the host's own client. Give exactly one of `db` or `mongo`. */
+    db?: Db;
+    /** A connection mailery opens and owns. Give exactly one of `db` or `mongo`. */
+    mongo?: MailerMongoConnection;
     collectionPrefix?: string;
-    adapter: ContactAdapter;
+    adapter: ContactAdapter | ContactAdapterFactory;
     /**
      * Optional host-provided template variables. `resolve(contact)` runs at
      * send/preview/test render time; its result is merged into the template
@@ -980,7 +1001,12 @@ interface MailerConfig {
 type ResolvedConfig = Required<Pick<MailerConfig, 'collectionPrefix' | 'requireDoubleOptIn' | 'unsubscribeTokenLifetimeDays' | 'transactionalRespectUnsubscribe' | 'unsubscribeWriteTimeoutMs' | 'doiTemplateSlug' | 'doiTokenLifetimeDays' | 'broadcastConfirmationThreshold' | 'broadcastEnqueueBatchSize' | 'broadcastEnqueueMaxWaiting' | 'workerless' | 'tickIntervalSeconds' | 'sendConcurrency' | 'sendRatePerSecond' | 'softBouncePromotionThreshold' | 'softBouncePromotionWindowDays' | 'webhookRetryAttempts' | 'sendRetryAttempts' | 'trackOpens' | 'trackClicks' | 'storeTrackingIp' | 'storeRenderedBody' | 'requireSignedTrackingUrls' | 'trackingUrlLifetimeDays'>> & {
     circuitBreaker: CircuitBreakerThresholds;
     broadcastStopRules: BroadcastStopRules;
-} & MailerConfig;
+} & StorageResolvedConfig;
+/** `MailerConfig` once `Mailer.init` has opened storage: one `db`, one built adapter. */
+type StorageResolvedConfig = Omit<MailerConfig, 'db' | 'mongo' | 'adapter'> & {
+    db: Db;
+    adapter: ContactAdapter;
+};
 
 /**
  * Mongo collection helpers + indexes for every mailer-owned collection.
@@ -1717,6 +1743,8 @@ declare class Mailer {
     readonly config: ResolvedConfig;
     readonly events: EventRegistry;
     private queueDriver;
+    /** The client `Mailer.init` opened from `config.mongo`; closed by `stop()`. Null when the host gave `db`. */
+    private ownedClient;
     private workersStarted;
     private runnerContext;
     private constructor();
@@ -1869,4 +1897,4 @@ declare class NullProvider implements MailProvider {
     reset(): void;
 }
 
-export { type VarsResolveInfo as $, type AdapterFilter as A, type BotFilterConfig as B, type ContactAdapter as C, type DeliveryWindow as D, type EventDoc as E, type FlowStep as F, type SendDoc as G, type HealthDoc as H, type SendStatus as I, type SenderDomainConfig as J, type SenderDomainRegistry as K, type LeadDoc as L, type MailProvider as M, type NormalizedEvent as N, type OutboxDoc as O, type Predicate as P, type SenderDomainValidation as Q, type RunnerContext as R, type SendArgs as S, type TemplateDoc as T, type SubscriptionDoc as U, type SubscriptionStatus as V, type SuppressionDoc as W, type SuppressionReason as X, type TemplateKind as Y, type TemplateVersionDoc as Z, type VarsAdapter as _, type Contact as a, type WebhookEventDoc as a0, defineVars as a1, ensureIndexes as a2, getCollections as a3, validateSenderDomain as a4, varsJsonSchema as a5, type FlowTrigger as a6, type QueueDriverConfig as a7, type AdapterSort as b, type SendResult as c, type MailTesterFeedback as d, Mailer as e, type Collections as f, type FlowDoc as g, type SuppressionScope as h, type SegmentFilter as i, type AuditLogDoc as j, type BroadcastDoc as k, type BroadcastOrder as l, type BroadcastPauseReason as m, type BroadcastStatus as n, type CircuitBreakerThresholds as o, type ContactTagDoc as p, type FlowGoal as q, type FlowRunDoc as r, type FlowRunStatus as s, type FlowVersionDoc as t, type HealthStatus as u, type MailerConfig as v, NullProvider as w, RESERVED_VAR_KEYS as x, type RedisOptions as y, type SegmentDefinition as z };
+export { type TemplateVersionDoc as $, type AdapterFilter as A, type BotFilterConfig as B, type ContactAdapter as C, type DeliveryWindow as D, type EventDoc as E, type FlowStep as F, type RedisOptions as G, type HealthDoc as H, type SegmentDefinition as I, type SendDoc as J, type SendStatus as K, type LeadDoc as L, type MailProvider as M, type NormalizedEvent as N, type OutboxDoc as O, type Predicate as P, type SenderDomainConfig as Q, type RunnerContext as R, type SendArgs as S, type TemplateDoc as T, type SenderDomainRegistry as U, type SenderDomainValidation as V, type SubscriptionDoc as W, type SubscriptionStatus as X, type SuppressionDoc as Y, type SuppressionReason as Z, type TemplateKind as _, type Contact as a, type VarsAdapter as a0, type VarsResolveInfo as a1, type WebhookEventDoc as a2, defineVars as a3, ensureIndexes as a4, getCollections as a5, validateSenderDomain as a6, varsJsonSchema as a7, type FlowTrigger as a8, type QueueDriverConfig as a9, type AdapterSort as b, type SendResult as c, type MailTesterFeedback as d, Mailer as e, type Collections as f, type FlowDoc as g, type SuppressionScope as h, type SegmentFilter as i, type AuditLogDoc as j, type BroadcastDoc as k, type BroadcastOrder as l, type BroadcastPauseReason as m, type BroadcastStatus as n, type CircuitBreakerThresholds as o, type ContactAdapterFactory as p, type ContactTagDoc as q, type FlowGoal as r, type FlowRunDoc as s, type FlowRunStatus as t, type FlowVersionDoc as u, type HealthStatus as v, type MailerConfig as w, type MailerMongoConnection as x, NullProvider as y, RESERVED_VAR_KEYS as z };

package/dist/testing.cjs

@@ -16140,7 +16140,7 @@ function derivePlaintext(html) {
 var PLAIN_TEXT = { noEscape: true };
 async function renderTemplate(template, ctx, opts = {}) {
   const hb = makeHandlebars(opts.helpers);
-  const subject = hb.compile(template.subject)(ctx);
+  const subject = hb.compile(template.subject, PLAIN_TEXT)(ctx).replace(/[\r\n]+/g, " ");
   const preheader = hb.compile(template.preheader)(ctx);
   let html;
   if (template.body.html) {
@@ -17525,7 +17525,7 @@ async function runDnsblChecks(ctx, opts = {}) {
   let listedCount = 0;
   async function processPair(p) {
     const queryName = buildQueryName(p.target, p.targetKind, spamhausQueryHost(p.list.host, cfg.spamhausDqsKey));
-    const lookup2 = queryName ? await queryDnsbl(resolver, queryName) : { result: "error", returnCodes: [], errorMessage: "unsupported target format" };
+    const lookup2 = queryName ? await queryDnsbl(resolver, queryName, p.list.host) : { result: "error", returnCodes: [], errorMessage: "unsupported target format" };
     if (lookup2.transient) return;
     if (lookup2.result === "listed") listedCount++;
     await ctx.collections.dnsblChecks.updateOne(
@@ -17586,10 +17586,10 @@ function buildQueryName(target, kind, listHost) {
   return `${domain}.${listHost}`;
 }
 var TRANSIENT_DNS_CODES = /* @__PURE__ */ new Set(["ESERVFAIL", "EREFUSED", "ETIMEOUT", "ETIMEDOUT", "ECONNRESET", "ECONNREFUSED"]);
-async function queryDnsbl(resolver, query) {
+async function queryDnsbl(resolver, query, listHost) {
   try {
     const records = await resolver.resolve4(query);
-    return interpretRecords(records);
+    return interpretRecords(records, listHost);
   } catch (err) {
     const code = err?.code;
     if (code === "ENOTFOUND" || code === "ENODATA") {
@@ -17615,10 +17615,17 @@ var REFUSAL_REASONS = {
   "127.255.255.254": "queried through a public or shared DNS resolver, which Spamhaus blocks. Set dnsbl.spamhausDqsKey (free Spamhaus DQS key) or use a private resolver",
   "127.255.255.255": "this resolver has exceeded the free query limit"
 };
-function interpretRecords(records) {
+function interpretRecords(records, listHost) {
   if (!records || records.length === 0) {
     return { result: "clean", returnCodes: [], errorMessage: null };
   }
+  if (listHost && REGISTRABLE_ONLY_LISTS.has(listHost) && records.every((r) => r === "127.0.0.1")) {
+    return {
+      result: "error",
+      returnCodes: records,
+      errorMessage: `${listHost} refused the query (127.0.0.1): queried through a public or shared DNS resolver, or over the free query limit. Use a private resolver`
+    };
+  }
   const errorish = records.filter((r) => r.startsWith("127.255.255."));
   if (errorish.length === records.length) {
     const reasons = [...new Set(records.map((r) => REFUSAL_REASONS[r] ?? "unrecognised refusal code"))];
@@ -18472,6 +18479,7 @@ async function processScheduledBroadcasts2(ctx) {
 }
 
 // src/server/mailer.ts
+var STORAGE_REQUIRED = "Mailer.init: give exactly one of `db` (an open Db) or `mongo` (a connection mailery opens)";
 var Mailer = class _Mailer {
   db;
   collections;
@@ -18481,6 +18489,8 @@ var Mailer = class _Mailer {
   config;
   events;
   queueDriver;
+  /** The client `Mailer.init` opened from `config.mongo`; closed by `stop()`. Null when the host gave `db`. */
+  ownedClient;
   workersStarted = false;
   runnerContext;
   constructor(args) {
@@ -18490,6 +18500,7 @@ var Mailer = class _Mailer {
     this.adapter = args.adapter;
     this.providers = args.providers;
     this.queueDriver = args.queueDriver;
+    this.ownedClient = args.ownedClient;
     this.queues = args.queueDriver.queues;
     this.events = args.events;
     this.runnerContext = {
@@ -18586,36 +18597,58 @@ var Mailer = class _Mailer {
     });
   }
   static async init(input) {
-    const config = resolveConfig(input);
-    if (!resolveProvider(config.providers, config.defaultProvider)) {
+    if (input.db == null === (input.mongo == null)) throw new Error(STORAGE_REQUIRED);
+    if (!resolveProvider(input.providers, input.defaultProvider)) {
       throw new Error(
-        `defaultProvider "${config.defaultProvider}" is not a registered provider. Registered: ${registeredProviderNames(config.providers).join(", ") || "(none)"}`
+        `defaultProvider "${input.defaultProvider}" is not a registered provider. Registered: ${registeredProviderNames(input.providers).join(", ") || "(none)"}`
       );
     }
-    if (config.defaultTransactionalProvider != null && !resolveProvider(config.providers, config.defaultTransactionalProvider)) {
+    if (input.defaultTransactionalProvider != null && !resolveProvider(input.providers, input.defaultTransactionalProvider)) {
       throw new Error(
-        `defaultTransactionalProvider "${config.defaultTransactionalProvider}" is not a registered provider. Registered: ${registeredProviderNames(config.providers).join(", ") || "(none)"}`
+        `defaultTransactionalProvider "${input.defaultTransactionalProvider}" is not a registered provider. Registered: ${registeredProviderNames(input.providers).join(", ") || "(none)"}`
       );
     }
-    if (config.varsAdapter) {
+    if (input.varsAdapter) {
       const { assertNoReservedVarKeys: assertNoReservedVarKeys2 } = await Promise.resolve().then(() => (init_vars(), vars_exports));
-      assertNoReservedVarKeys2(config.varsAdapter);
-    }
-    const collections = getCollections(config.db, config.collectionPrefix);
-    await ensureIndexes(config.db, config.collectionPrefix);
-    const queueDriver = await createQueueDriver(config.queue, config.db);
-    if (!config.workerless && config.queue.driver !== "noop") {
-      await queueDriver.scheduleRepeatingTick(config.tickIntervalSeconds);
-    }
-    return new _Mailer({
-      config,
-      db: config.db,
-      collections,
-      adapter: config.adapter,
-      providers: config.providers,
-      queueDriver,
-      events: new EventRegistry()
-    });
+      assertNoReservedVarKeys2(input.varsAdapter);
+    }
+    let ownedClient = null;
+    let db;
+    if (input.mongo) {
+      const { MongoClient: MongoClient2 } = await import('mongodb');
+      ownedClient = await MongoClient2.connect(input.mongo.uri, input.mongo.clientOptions);
+      db = ownedClient.db(input.mongo.dbName);
+    } else if (input.db) {
+      db = input.db;
+    } else {
+      throw new Error(STORAGE_REQUIRED);
+    }
+    try {
+      const config = resolveConfig({
+        ...input,
+        db,
+        adapter: typeof input.adapter === "function" ? input.adapter(db) : input.adapter
+      });
+      const collections = getCollections(config.db, config.collectionPrefix);
+      await ensureIndexes(config.db, config.collectionPrefix);
+      const queueDriver = await createQueueDriver(config.queue, config.db);
+      if (!config.workerless && config.queue.driver !== "noop") {
+        await queueDriver.scheduleRepeatingTick(config.tickIntervalSeconds);
+      }
+      return new _Mailer({
+        config,
+        db: config.db,
+        collections,
+        adapter: config.adapter,
+        providers: config.providers,
+        queueDriver,
+        events: new EventRegistry(),
+        ownedClient
+      });
+    } catch (err) {
+      await ownedClient?.close();
+      throw err;
+    }
   }
   // -------------------------------------------------------------------------
   // Event registration + firing
@@ -19088,6 +19121,8 @@ var Mailer = class _Mailer {
   async stop() {
     await this.queueDriver.close();
     this.workersStarted = false;
+    await this.ownedClient?.close();
+    this.ownedClient = null;
   }
   /** Used internally by the admin router and tests; not part of the public API. */
   getRunnerContext() {