@astralibx/email-rule-engine 12.10.0 → 12.11.0

package/README.md

@@ -15,6 +15,7 @@ npm install @astralibx/email-rule-engine
 
 | Peer Dependency | Version |
 |-----------------|---------|
+| `@astralibx/core` | `^1.2.0` |
 | `express` | `^4.18.0 \|\| ^5.0.0` |
 | `mongoose` | `^7.0.0 \|\| ^8.0.0` |
 | `ioredis` | `^5.0.0` |

package/dist/index.cjs

@@ -205,7 +205,7 @@ function createEmailRuleSchema(platformValues, audienceValues, collectionPrefix)
     },
     conditions: [RuleConditionSchema],
     identifiers: [{ type: String }],
-    collection: { type: String }
+    collectionName: { type: String }
   }, { _id: false });
   const RuleRunStatsSchema = createRunStatsSchema();
   const schema = new mongoose.Schema(
@@ -375,7 +375,16 @@ function createEmailThrottleConfigSchema(collectionPrefix) {
       maxPerUserPerDay: { type: Number, default: 1 },
       maxPerUserPerWeek: { type: Number, default: 2 },
       minGapDays: { type: Number, default: 3 },
-      throttleWindow: { type: String, enum: Object.values(THROTTLE_WINDOW), default: THROTTLE_WINDOW.Rolling }
+      throttleWindow: { type: String, enum: Object.values(THROTTLE_WINDOW), default: THROTTLE_WINDOW.Rolling },
+      sendWindow: {
+        type: {
+          startHour: { type: Number, min: 0, max: 23 },
+          endHour: { type: Number, min: 0, max: 23 },
+          timezone: { type: String }
+        },
+        _id: false,
+        default: void 0
+      }
     },
     {
       timestamps: true,
@@ -1093,8 +1102,8 @@ var RuleService = class {
         throw new RuleTemplateIncompatibleError("target.identifiers must be a non-empty array for list mode, validation failed");
       }
     }
-    if (isQueryTarget(input.target) && input.target.collection && this.config.collections?.length) {
-      const condErrors = validateConditions(input.target.conditions, input.target.collection, this.config.collections);
+    if (isQueryTarget(input.target) && input.target.collectionName && this.config.collections?.length) {
+      const condErrors = validateConditions(input.target.conditions, input.target.collectionName, this.config.collections);
       if (condErrors.length > 0) {
         throw new RuleTemplateIncompatibleError(
           `Invalid conditions: ${condErrors.map((e) => e.message).join("; ")}`
@@ -1132,8 +1141,8 @@ var RuleService = class {
     }
     if (isQueryTarget(effectiveTarget)) {
       const qt = effectiveTarget;
-      if (qt.collection && this.config.collections?.length) {
-        const condErrors = validateConditions(qt.conditions || [], qt.collection, this.config.collections);
+      if (qt.collectionName && this.config.collections?.length) {
+        const condErrors = validateConditions(qt.conditions || [], qt.collectionName, this.config.collections);
         if (condErrors.length > 0) {
           throw new RuleTemplateIncompatibleError(
             `Invalid conditions: ${condErrors.map((e) => e.message).join("; ")}`
@@ -1191,7 +1200,7 @@ var RuleService = class {
       return { matchedCount: matchedCount2, effectiveLimit, willProcess: willProcess2, ruleId: id, sample: sample2 };
     }
     const queryTarget = rule.target;
-    const collectionName = queryTarget.collection;
+    const collectionName = queryTarget.collectionName;
     const collectionSchema = collectionName ? this.config.collections?.find((c) => c.name === collectionName) : void 0;
     const users = await this.config.adapters.queryUsers(rule.target, 5e4, collectionSchema ? { collectionSchema } : void 0);
     const matchedCount = users.length;
@@ -1279,16 +1288,6 @@ var RuleRunnerService = class {
   async runAllRules(triggeredBy = RUN_TRIGGER.Cron, runId) {
     if (!runId) runId = crypto__default.default.randomUUID();
     const startedAt = (/* @__PURE__ */ new Date()).toISOString();
-    if (this.config.options?.sendWindow) {
-      const { startHour, endHour, timezone } = this.config.options.sendWindow;
-      const now = /* @__PURE__ */ new Date();
-      const formatter = new Intl.DateTimeFormat("en-US", { hour: "numeric", hour12: false, timeZone: timezone });
-      const currentHour = parseInt(formatter.format(now), 10);
-      if (currentHour < startHour || currentHour >= endHour) {
-        this.logger.info("Outside send window, skipping run", { currentHour, startHour, endHour, timezone });
-        return { runId };
-      }
-    }
     const lockAcquired = await this.lock.acquire();
     if (!lockAcquired) {
       this.logger.warn("Rule runner already executing, skipping");
@@ -1307,9 +1306,20 @@ var RuleRunnerService = class {
     let runStatus = "completed";
     try {
       const throttleConfig = await this.EmailThrottleConfig.getConfig();
+      const sendWindow = throttleConfig.sendWindow ?? this.config.options?.sendWindow;
+      if (sendWindow) {
+        const { startHour, endHour, timezone } = sendWindow;
+        const now2 = /* @__PURE__ */ new Date();
+        const formatter = new Intl.DateTimeFormat("en-US", { hour: "numeric", hour12: false, timeZone: timezone });
+        const currentHour = parseInt(formatter.format(now2), 10);
+        if (currentHour < startHour || currentHour >= endHour) {
+          this.logger.info("Outside send window, skipping run", { currentHour, startHour, endHour, timezone });
+          return { runId };
+        }
+      }
       const allActiveRules = await this.EmailRule.findActive();
       const now = /* @__PURE__ */ new Date();
-      const tz = this.config.options?.sendWindow?.timezone;
+      const tz = sendWindow?.timezone ?? this.config.options?.sendWindow?.timezone;
       const activeRules = allActiveRules.filter((rule) => {
         if (rule.validFrom) {
           const localNow = getLocalDate(now, tz);
@@ -1710,7 +1720,7 @@ var RuleRunnerService = class {
     const limit = rule.maxPerRun || this.config.options?.defaultMaxPerRun || 500;
     let users;
     try {
-      const collectionName = rule.target?.collection;
+      const collectionName = rule.target?.collectionName;
       const collectionSchema = collectionName ? this.config.collections?.find((c) => c.name === collectionName) : void 0;
       users = await this.config.adapters.queryUsers(rule.target, limit, collectionSchema ? { collectionSchema } : void 0);
     } catch (err) {
@@ -2211,7 +2221,7 @@ function createSettingsController(EmailThrottleConfig) {
     res.json({ success: true, data: { config } });
   });
   const updateThrottleConfig = asyncHandler(async (req, res) => {
-    const { maxPerUserPerDay, maxPerUserPerWeek, minGapDays } = req.body;
+    const { maxPerUserPerDay, maxPerUserPerWeek, minGapDays, sendWindow } = req.body;
     const updates = {};
     if (maxPerUserPerDay !== void 0) {
       if (!Number.isInteger(maxPerUserPerDay) || maxPerUserPerDay < 1) {
@@ -2231,6 +2241,23 @@ function createSettingsController(EmailThrottleConfig) {
       }
       updates.minGapDays = minGapDays;
     }
+    if (sendWindow !== void 0) {
+      if (sendWindow === null) {
+        updates.sendWindow = void 0;
+      } else {
+        const { startHour, endHour, timezone } = sendWindow;
+        if (!Number.isInteger(startHour) || startHour < 0 || startHour > 23) {
+          return res.status(400).json({ success: false, error: "sendWindow.startHour must be an integer 0-23" });
+        }
+        if (!Number.isInteger(endHour) || endHour < 0 || endHour > 23) {
+          return res.status(400).json({ success: false, error: "sendWindow.endHour must be an integer 0-23" });
+        }
+        if (typeof timezone !== "string" || !timezone.trim()) {
+          return res.status(400).json({ success: false, error: "sendWindow.timezone must be a non-empty string" });
+        }
+        updates.sendWindow = { startHour, endHour, timezone: timezone.trim() };
+      }
+    }
     if (Object.keys(updates).length === 0) {
       return res.status(400).json({ success: false, error: "No valid fields to update" });
     }
@@ -2240,9 +2267,21 @@ function createSettingsController(EmailThrottleConfig) {
     if (finalWeekly < finalDaily) {
       return res.status(400).json({ success: false, error: "maxPerUserPerWeek must be >= maxPerUserPerDay" });
     }
+    const setFields = {};
+    const unsetFields = {};
+    for (const [key, value] of Object.entries(updates)) {
+      if (value === void 0) {
+        unsetFields[key] = "";
+      } else {
+        setFields[key] = value;
+      }
+    }
+    const updateOp = {};
+    if (Object.keys(setFields).length > 0) updateOp["$set"] = setFields;
+    if (Object.keys(unsetFields).length > 0) updateOp["$unset"] = unsetFields;
     const updated = await EmailThrottleConfig.findByIdAndUpdate(
       config._id,
-      { $set: updates },
+      updateOp,
       { new: true }
     );
     res.json({ success: true, data: { config: updated } });