mailery 0.8.1 → 0.10.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, D as DeliveryWindow, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-CwXmiVLe.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-CwXmiVLe.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-CU_EApC6.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-CU_EApC6.cjs';
 import { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -367,7 +367,7 @@ interface FlowStepKindOption {
 }
 declare const FLOW_STEP_KINDS: readonly FlowStepKindOption[];
 declare function defaultFlowStep(type: FlowStep['type']): FlowStep;
-type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
+type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'triggerPropertyEquals' | 'triggerPropertyTruthy' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
 interface PredicateKindOption {
     value: PredicateKind;
     label: string;
@@ -398,6 +398,10 @@ declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
 /**
  * Public exports for the `mailery` package.
  */
-declare const VERSION = "0.8.1";
+/**
+ * Library version, stamped from package.json at build time (tsup/vitest
+ * `define`). 'dev' when the source runs without a bundler define (plain tsx).
+ */
+declare const VERSION: string;
 
 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, D as DeliveryWindow, F as FlowStep, f as SegmentFilter, P as Predicate } from './null-CwXmiVLe.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-CwXmiVLe.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-CU_EApC6.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-CU_EApC6.js';
 import { ObjectId, Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -367,7 +367,7 @@ interface FlowStepKindOption {
 }
 declare const FLOW_STEP_KINDS: readonly FlowStepKindOption[];
 declare function defaultFlowStep(type: FlowStep['type']): FlowStep;
-type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
+type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'triggerPropertyEquals' | 'triggerPropertyTruthy' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
 interface PredicateKindOption {
     value: PredicateKind;
     label: string;
@@ -398,6 +398,10 @@ declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
 /**
  * Public exports for the `mailery` package.
  */
-declare const VERSION = "0.8.1";
+/**
+ * Library version, stamped from package.json at build time (tsup/vitest
+ * `define`). 'dev' when the source runs without a bundler define (plain tsx).
+ */
+declare const VERSION: string;
 
 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.js

@@ -396,7 +396,25 @@ var tagInputSchema = z.object({
 var abortFlowInputSchema = z.object({
   flowSlug: slugSchema,
   externalId: externalIdSchema,
-  reason: z.string().min(1).max(200).optional()
+  reason: z.string().min(1).max(200).optional(),
+  /**
+   * Restrict the abort to runs whose trigger event carried these properties —
+   * e.g. `{ accountId }` to cancel one account's series while the same
+   * contact's other accounts keep running. Omit to abort every active run for
+   * the contact on this flow.
+   *
+   * Keys and values are both constrained because these go straight into a
+   * Mongo query. Values are primitives only: an object value like
+   * `{ $ne: null }` would reach the query as an OPERATOR and match every
+   * scoped run, turning a one-account abort into abort-everything. Hosts
+   * typically pass an id from a request body, so treat it as untrusted. The
+   * key regex likewise blocks `$`-prefixed keys and dots (a dot would silently
+   * extend the path and change match semantics).
+   */
+  matchTriggerProperties: z.record(
+    z.string().regex(/^[A-Za-z0-9_]+$/),
+    z.union([z.string(), z.number(), z.boolean(), z.null()])
+  ).optional()
 });
 var abortAllFlowsInputSchema = abortFlowInputSchema.omit({ flowSlug: true });
 var sendOneOffInputSchema = z.object({
@@ -465,6 +483,13 @@ var predicateSchema = z.lazy(
     z.object({ notHasTag: z.string() }),
     z.object({ fieldEquals: z.object({ field: z.string(), value: z.unknown() }) }),
     z.object({ fieldExists: z.string() }),
+    z.object({
+      triggerPropertyEquals: z.object({
+        key: z.string().min(1),
+        value: z.union([z.string(), z.number(), z.boolean(), z.null()])
+      })
+    }),
+    z.object({ triggerPropertyTruthy: z.string().min(1) }),
     z.object({
       hasFiredEvent: z.string(),
       sinceFlowStart: z.boolean().optional(),
@@ -879,7 +904,7 @@ var BullDriver = class _BullDriver {
   bullQueues;
   workers = null;
   bull;
-  static async create(redisConfig) {
+  static async create(redisConfig, prefix) {
     let bull;
     try {
       bull = await import('bullmq');
@@ -888,14 +913,22 @@ var BullDriver = class _BullDriver {
         "mailery: queue driver 'bull' requires the 'bullmq' peer dependency. Run `npm install bullmq ioredis`."
       );
     }
+    if (prefix?.includes(":")) {
+      throw new Error(
+        `mailery: queue prefix "${prefix}" must not contain ':' \u2014 BullMQ uses it as the Redis key separator.`
+      );
+    }
     const redis = isRedisLike(redisConfig) ? redisConfig : connect(redisConfig);
-    return new _BullDriver(bull, redis);
+    return new _BullDriver(bull, redis, prefix);
   }
-  constructor(bull, redis) {
+  prefix;
+  constructor(bull, redis, prefix) {
     this.bull = bull;
     this.redis = redis;
+    this.prefix = prefix;
     const opts = {
       connection: redis,
+      prefix,
       defaultJobOptions: {
         removeOnComplete: { age: 24 * 3600, count: 1e3 },
         removeOnFail: { age: 7 * 24 * 3600 }
@@ -927,7 +960,7 @@ var BullDriver = class _BullDriver {
   }
   async startWorkers(opts) {
     if (this.workers) return;
-    const base = { connection: this.redis };
+    const base = { connection: this.redis, prefix: this.prefix };
     const { Worker } = this.bull;
     const tick = new Worker(
       QUEUE_NAMES.tick,
@@ -1179,7 +1212,7 @@ var NoopDriver = class {
 async function createQueueDriver(config, fallbackDb) {
   switch (config.driver) {
     case "bull":
-      return BullDriver.create(config.redis);
+      return BullDriver.create(config.redis, config.prefix);
     case "agenda":
       return AgendaDriver.create({
         db: config.db ?? fallbackDb,
@@ -1640,6 +1673,12 @@ async function evaluatePredicate(predicate, ctx) {
   if ("fieldExists" in p) {
     return ctx.contact.fields[p.fieldExists] !== void 0;
   }
+  if ("triggerPropertyEquals" in p) {
+    return (ctx.run.triggerEvent?.properties ?? {})[p.triggerPropertyEquals.key] === p.triggerPropertyEquals.value;
+  }
+  if ("triggerPropertyTruthy" in p) {
+    return Boolean((ctx.run.triggerEvent?.properties ?? {})[p.triggerPropertyTruthy]);
+  }
   if ("subscriptionStatus" in p) {
     const sub = await ctx.collections.subscriptions.findOne({ externalId: ctx.contact.externalId });
     return sub?.status === p.subscriptionStatus;
@@ -2392,7 +2431,14 @@ async function handleFireEvent(run, step, ctx) {
     await ctx.collections.events.insertOne({
       externalId: run.externalId,
       name: step.eventName,
-      properties: step.properties ?? {},
+      // Inherit the triggering event's properties so a handoff carries the
+      // context that identifies what the run is ABOUT (which account, order,
+      // subscription, ...). A step's `properties` are static — authored once in
+      // the flow definition — so without this a fired event can only ever say
+      // "this contact", losing the scope the originating event supplied, and
+      // the receiving flow has nothing to resolve variables against. Explicit
+      // step.properties win on conflict.
+      properties: { ...run.triggerEvent?.properties ?? {}, ...step.properties ?? {} },
       dedupeKey,
       occurredAt: /* @__PURE__ */ new Date(),
       createdAt: /* @__PURE__ */ new Date()
@@ -3923,6 +3969,7 @@ var Mailer = class _Mailer {
    *   MAILER_MONGODB_URI                — Mongo connection string (required)
    *   MAILER_MONGODB_DB                 — database name (optional; defaults to the URI default)
    *   MAILER_REDIS_URL                  — Redis connection URL (required)
+   *   MAILER_QUEUE_PREFIX               — Redis key prefix to namespace this instance (optional)
    *   MAILER_PUBLIC_URL                 — base for tracking/unsub URLs (required)
    *   MAILER_UNSUBSCRIBE_SECRET         — HMAC key (required)
    *   MAILER_SENDER_ADDRESS             — postal address for CAN-SPAM (optional)
@@ -3971,7 +4018,11 @@ var Mailer = class _Mailer {
     }
     const defaultProvider = env.MAILER_DEFAULT_PROVIDER ?? Object.keys(providers)[0];
     const driverEnv = env.MAILER_QUEUE_DRIVER ?? "bull";
-    const queue = driverEnv === "agenda" ? { driver: "agenda" } : driverEnv === "noop" ? { driver: "noop" } : { driver: "bull", redis: { url: required("MAILER_REDIS_URL") } };
+    const queue = driverEnv === "agenda" ? { driver: "agenda" } : driverEnv === "noop" ? { driver: "noop" } : {
+      driver: "bull",
+      redis: { url: required("MAILER_REDIS_URL") },
+      prefix: env.MAILER_QUEUE_PREFIX
+    };
     return _Mailer.init({
       db,
       adapter,
@@ -4222,14 +4273,25 @@ var Mailer = class _Mailer {
    * same handler that processes the business event ("user upgraded").
    */
   async abortFlow(flowSlug, externalId, opts = {}) {
-    const parsed = abortFlowInputSchema.parse({ flowSlug, externalId, reason: opts.reason });
+    const parsed = abortFlowInputSchema.parse({
+      flowSlug,
+      externalId,
+      reason: opts.reason,
+      matchTriggerProperties: opts.matchTriggerProperties
+    });
     const flow = await this.collections.flows.findOne(
       { slug: parsed.flowSlug },
       { projection: { _id: 1 } }
     );
     if (!flow) throw new Error(`abortFlow: unknown flow slug "${parsed.flowSlug}"`);
+    const triggerMatch = Object.fromEntries(
+      Object.entries(parsed.matchTriggerProperties ?? {}).map(([k, v]) => [
+        `triggerEvent.properties.${k}`,
+        v
+      ])
+    );
     const result = await this.abortActiveRuns(
-      { externalId: parsed.externalId, flowId: flow._id },
+      { externalId: parsed.externalId, flowId: flow._id, ...triggerMatch },
       parsed.reason ? `aborted_by_host:${parsed.reason}` : "aborted_by_host"
     );
     if (result.abortedRuns > 0 || result.cancelledSends > 0) {
@@ -4237,7 +4299,9 @@ var Mailer = class _Mailer {
         actor: "host",
         action: "flow.abort",
         resource: { collection: "mailer_flow_runs", slug: parsed.flowSlug },
-        diffSummary: `abortFlow slug=${parsed.flowSlug} externalId=${parsed.externalId} runs=${result.abortedRuns} sends=${result.cancelledSends}${parsed.reason ? ` reason=${parsed.reason}` : ""}`
+        // Record the scope: without it a one-account abort and an abort-every-
+        // run-for-this-contact are indistinguishable in the audit trail.
+        diffSummary: `abortFlow slug=${parsed.flowSlug} externalId=${parsed.externalId} scope=${parsed.matchTriggerProperties ? JSON.stringify(parsed.matchTriggerProperties) : "all"} runs=${result.abortedRuns} sends=${result.cancelledSends}${parsed.reason ? ` reason=${parsed.reason}` : ""}`
       });
     }
     return result;
@@ -7403,6 +7467,8 @@ var PREDICATE_KINDS = [
   { value: "notHasTag", label: "does NOT have tag" },
   { value: "fieldEquals", label: "field equals" },
   { value: "fieldExists", label: "field exists" },
+  { value: "triggerPropertyEquals", label: "trigger property equals" },
+  { value: "triggerPropertyTruthy", label: "trigger property is set" },
   { value: "hasFiredEvent", label: "fired event" },
   { value: "notHasFiredEvent", label: "has NOT fired event" },
   { value: "subscriptionStatus", label: "subscription status" },
@@ -7430,6 +7496,10 @@ function defaultPredicate(kind) {
       return { fieldEquals: { field: "tier", value: "Pro" } };
     case "fieldExists":
       return { fieldExists: "tier" };
+    case "triggerPropertyEquals":
+      return { triggerPropertyEquals: { key: "plan", value: "pro" } };
+    case "triggerPropertyTruthy":
+      return { triggerPropertyTruthy: "wasReferred" };
     case "hasFiredEvent":
       return { hasFiredEvent: "Activated app" };
     case "notHasFiredEvent":
@@ -7520,7 +7590,7 @@ var DEDUPE_POLICIES = [
 ];
 
 // src/server/index.ts
-var VERSION = "0.8.1";
+var VERSION = "0.10.0" ;
 
 export { DEDUPE_POLICIES, FLOW_STEP_KINDS, Mailer, MongoContactAdapter, NullProvider, PREDICATE_KINDS, RESERVED_VAR_KEYS, SEGMENT_FILTER_KINDS, SendGridProvider, VERSION, applyTracking, applyWebhookEvent, compileMailyTemplate, compileTemplate, computeDeliveryTime, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, defineVars, derivePlaintext, dispatchSend, ensureIndexes, getCollections, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, renderTemplate, runTick, sha256Hex, signUnsubscribeToken, sweepStrandedFlowRuns, validateSenderDomain, varsJsonSchema, verifyUnsubscribeToken };
 //# sourceMappingURL=index.js.map