@astralibx/email-rule-engine 12.3.0 → 12.5.0

package/dist/index.d.mts

@@ -95,6 +95,11 @@ interface EmailRule {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType: EmailType;
     totalSent: number;
     totalSkipped: number;
@@ -117,6 +122,11 @@ interface CreateEmailRuleInput {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle?: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType?: EmailType;
 }
 interface UpdateEmailRuleInput {
@@ -134,6 +144,11 @@ interface UpdateEmailRuleInput {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle?: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType?: EmailType;
 }
 interface EmailRuleSend {
@@ -557,6 +572,8 @@ declare class RuleService {
     toggleActive(id: string): Promise<EmailRuleDocument | null>;
     dryRun(id: string): Promise<{
         matchedCount: number;
+        effectiveLimit: number;
+        willProcess: number;
         ruleId: string;
     }>;
     getRunHistory(limit?: number): Promise<unknown[]>;

package/dist/index.d.ts

@@ -95,6 +95,11 @@ interface EmailRule {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType: EmailType;
     totalSent: number;
     totalSkipped: number;
@@ -117,6 +122,11 @@ interface CreateEmailRuleInput {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle?: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType?: EmailType;
 }
 interface UpdateEmailRuleInput {
@@ -134,6 +144,11 @@ interface UpdateEmailRuleInput {
     validFrom?: Date;
     validTill?: Date;
     bypassThrottle?: boolean;
+    throttleOverride?: {
+        maxPerUserPerDay?: number;
+        maxPerUserPerWeek?: number;
+        minGapDays?: number;
+    };
     emailType?: EmailType;
 }
 interface EmailRuleSend {
@@ -557,6 +572,8 @@ declare class RuleService {
     toggleActive(id: string): Promise<EmailRuleDocument | null>;
     dryRun(id: string): Promise<{
         matchedCount: number;
+        effectiveLimit: number;
+        willProcess: number;
         ruleId: string;
     }>;
     getRunHistory(limit?: number): Promise<unknown[]>;

package/dist/index.mjs

@@ -170,6 +170,15 @@ function createEmailRuleSchema(platformValues, audienceValues, collectionPrefix)
       validFrom: { type: Date },
       validTill: { type: Date },
       bypassThrottle: { type: Boolean, default: false },
+      throttleOverride: {
+        type: {
+          maxPerUserPerDay: { type: Number },
+          maxPerUserPerWeek: { type: Number },
+          minGapDays: { type: Number }
+        },
+        _id: false,
+        default: void 0
+      },
       emailType: { type: String, enum: Object.values(EMAIL_TYPE), default: EMAIL_TYPE.Automated },
       totalSent: { type: Number, default: 0 },
       totalSkipped: { type: Number, default: 0 },
@@ -202,6 +211,7 @@ function createEmailRuleSchema(platformValues, audienceValues, collectionPrefix)
             validFrom: input.validFrom,
             validTill: input.validTill,
             bypassThrottle: input.bypassThrottle ?? false,
+            throttleOverride: input.throttleOverride,
             emailType: input.emailType ?? EMAIL_TYPE.Automated,
             totalSent: 0,
             totalSkipped: 0
@@ -742,6 +752,7 @@ var UPDATEABLE_FIELDS2 = /* @__PURE__ */ new Set([
   "autoApprove",
   "maxPerRun",
   "bypassThrottle",
+  "throttleOverride",
   "emailType",
   "validFrom",
   "validTill"
@@ -875,13 +886,19 @@ var RuleService = class {
     if (!rule) {
       throw new RuleNotFoundError(id);
     }
+    const defaultMaxPerRun = this.config.options?.defaultMaxPerRun;
+    const effectiveLimit = rule.maxPerRun || defaultMaxPerRun || 500;
     const target = rule.target;
     if (target.mode === "list") {
       const identifiers = target.identifiers || [];
-      return { matchedCount: identifiers.length, ruleId: id };
+      const matchedCount2 = identifiers.length;
+      const willProcess2 = Math.min(matchedCount2, effectiveLimit);
+      return { matchedCount: matchedCount2, effectiveLimit, willProcess: willProcess2, ruleId: id };
     }
     const users = await this.config.adapters.queryUsers(rule.target, 5e4);
-    return { matchedCount: users.length, ruleId: id };
+    const matchedCount = users.length;
+    const willProcess = Math.min(matchedCount, effectiveLimit);
+    return { matchedCount, effectiveLimit, willProcess, ruleId: id };
   }
   async getRunHistory(limit = 20) {
     return this.EmailRuleRunLog.getRecent(limit);
@@ -1138,6 +1155,9 @@ var RuleRunnerService = class {
     const rawIdentifiers = rule.target.identifiers || [];
     const uniqueEmails = [...new Set(rawIdentifiers.map((e) => e.toLowerCase().trim()).filter(Boolean))];
     const limit = rule.maxPerRun || this.config.options?.defaultMaxPerRun || 500;
+    if (uniqueEmails.length > limit) {
+      this.logger.warn(`Rule "${rule.name}" matched ${uniqueEmails.length} users but maxPerRun is ${limit} \u2014 only ${limit} will be processed`, { ruleId: rule._id.toString(), matchedCount: uniqueEmails.length, maxPerRun: limit });
+    }
     const emailsToProcess = uniqueEmails.slice(0, limit);
     stats.matched = emailsToProcess.length;
     const ruleId = rule._id.toString();
@@ -1336,14 +1356,18 @@ var RuleRunnerService = class {
     return stats;
   }
   async executeQueryMode(rule, template, throttleMap, throttleConfig, stats, runId) {
+    const limit = rule.maxPerRun || this.config.options?.defaultMaxPerRun || 500;
     let users;
     try {
-      users = await this.config.adapters.queryUsers(rule.target, rule.maxPerRun || this.config.options?.defaultMaxPerRun || 500);
+      users = await this.config.adapters.queryUsers(rule.target, limit);
     } catch (err) {
       this.logger.error(`Rule "${rule.name}": query failed`, { error: err });
       stats.errorCount = 1;
       return stats;
     }
+    if (users.length > limit) {
+      this.logger.warn(`Rule "${rule.name}" matched ${users.length} users but maxPerRun is ${limit} \u2014 only ${limit} will be processed`, { ruleId: rule._id.toString(), matchedCount: users.length, maxPerRun: limit });
+    }
     stats.matched = users.length;
     this.config.hooks?.onRuleStart?.({ ruleId: rule._id.toString(), ruleName: rule.name, matchedCount: users.length, templateId: rule.templateId.toString(), runId: runId || "" });
     if (users.length === 0) return stats;
@@ -1533,20 +1557,24 @@ var RuleRunnerService = class {
   }
   checkThrottle(rule, userId, email, throttleMap, config, stats, templateId, runId) {
     if (rule.emailType === EMAIL_TYPE.Transactional || rule.bypassThrottle) return true;
+    const overrides = rule.throttleOverride || {};
+    const dailyLimit = overrides.maxPerUserPerDay ?? config.maxPerUserPerDay;
+    const weeklyLimit = overrides.maxPerUserPerWeek ?? config.maxPerUserPerWeek;
+    const minGap = overrides.minGapDays ?? config.minGapDays;
     const userThrottle = throttleMap.get(userId) || { today: 0, thisWeek: 0, lastSentDate: null };
-    if (userThrottle.today >= config.maxPerUserPerDay) {
+    if (userThrottle.today >= dailyLimit) {
       stats.skippedByThrottle++;
       this.config.hooks?.onSend?.({ ruleId: rule._id.toString(), ruleName: rule.name, email, status: "throttled", accountId: "", templateId: templateId || "", runId: runId || "", subjectIndex: -1, bodyIndex: -1, failureReason: "daily throttle limit" });
       return false;
     }
-    if (userThrottle.thisWeek >= config.maxPerUserPerWeek) {
+    if (userThrottle.thisWeek >= weeklyLimit) {
       stats.skippedByThrottle++;
       this.config.hooks?.onSend?.({ ruleId: rule._id.toString(), ruleName: rule.name, email, status: "throttled", accountId: "", templateId: templateId || "", runId: runId || "", subjectIndex: -1, bodyIndex: -1, failureReason: "weekly throttle limit" });
       return false;
     }
     if (userThrottle.lastSentDate) {
       const daysSinceLastSend = (Date.now() - userThrottle.lastSentDate.getTime()) / MS_PER_DAY;
-      if (daysSinceLastSend < config.minGapDays) {
+      if (daysSinceLastSend < minGap) {
         stats.skippedByThrottle++;
         this.config.hooks?.onSend?.({ ruleId: rule._id.toString(), ruleName: rule.name, email, status: "throttled", accountId: "", templateId: templateId || "", runId: runId || "", subjectIndex: -1, bodyIndex: -1, failureReason: "min gap days" });
         return false;