mailery 0.8.1 → 0.10.0

package/dist/index.cjs

@@ -414,7 +414,25 @@ var tagInputSchema = zod.z.object({
 var abortFlowInputSchema = zod.z.object({
   flowSlug: slugSchema,
   externalId: externalIdSchema,
-  reason: zod.z.string().min(1).max(200).optional()
+  reason: zod.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: zod.z.record(
+    zod.z.string().regex(/^[A-Za-z0-9_]+$/),
+    zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.null()])
+  ).optional()
 });
 var abortAllFlowsInputSchema = abortFlowInputSchema.omit({ flowSlug: true });
 var sendOneOffInputSchema = zod.z.object({
@@ -483,6 +501,13 @@ var predicateSchema = zod.z.lazy(
     zod.z.object({ notHasTag: zod.z.string() }),
     zod.z.object({ fieldEquals: zod.z.object({ field: zod.z.string(), value: zod.z.unknown() }) }),
     zod.z.object({ fieldExists: zod.z.string() }),
+    zod.z.object({
+      triggerPropertyEquals: zod.z.object({
+        key: zod.z.string().min(1),
+        value: zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean(), zod.z.null()])
+      })
+    }),
+    zod.z.object({ triggerPropertyTruthy: zod.z.string().min(1) }),
     zod.z.object({
       hasFiredEvent: zod.z.string(),
       sinceFlowStart: zod.z.boolean().optional(),
@@ -897,7 +922,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');
@@ -906,14 +931,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 }
@@ -945,7 +978,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,
@@ -1197,7 +1230,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,
@@ -1658,6 +1691,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;
@@ -2410,7 +2449,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()
@@ -3941,6 +3987,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)
@@ -3989,7 +4036,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,
@@ -4240,14 +4291,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) {
@@ -4255,7 +4317,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;
@@ -7421,6 +7485,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" },
@@ -7448,6 +7514,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":
@@ -7538,7 +7608,7 @@ var DEDUPE_POLICIES = [
 ];
 
 // src/server/index.ts
-var VERSION = "0.8.1";
+var VERSION = "0.10.0" ;
 
 exports.DEDUPE_POLICIES = DEDUPE_POLICIES;
 exports.FLOW_STEP_KINDS = FLOW_STEP_KINDS;