@astralibx/email-rule-engine 12.10.0 → 12.11.0

package/dist/index.d.mts

@@ -128,7 +128,7 @@ interface QueryTarget {
     role: string;
     platform: string;
     conditions: RuleCondition[];
-    collection?: string;
+    collectionName?: string;
 }
 interface ListTarget {
     mode: 'list';
@@ -578,18 +578,25 @@ declare function createEmailRuleRunLogSchema(collectionPrefix?: string): Schema<
     __v: number;
 }>;
 
+interface SendWindowConfig {
+    startHour: number;
+    endHour: number;
+    timezone: string;
+}
 interface EmailThrottleConfig {
     _id: string;
     maxPerUserPerDay: number;
     maxPerUserPerWeek: number;
     minGapDays: number;
     throttleWindow: ThrottleWindow;
+    sendWindow?: SendWindowConfig;
     updatedAt: Date;
 }
 interface UpdateEmailThrottleConfigInput {
     maxPerUserPerDay?: number;
     maxPerUserPerWeek?: number;
     minGapDays?: number;
+    sendWindow?: SendWindowConfig | null;
 }
 
 interface IEmailThrottleConfig extends Omit<EmailThrottleConfig, '_id'> {
@@ -881,4 +888,4 @@ interface EmailRuleEngine {
  */
 declare function createEmailRuleEngine(config: EmailRuleEngineConfig): EmailRuleEngine;
 
-export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CollectionSchema, type CompiledTemplate, type ConditionValidationError, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, type EmailAttachment, type EmailRule, type EmailRuleDocument, type EmailRuleEngine, type EmailRuleEngineConfig, type EmailRuleModel, type EmailRuleRunLog, type EmailRuleRunLogDocument, type EmailRuleRunLogModel, type EmailRuleRunLogStatics, type EmailRuleSend, type EmailRuleSendDocument, type EmailRuleSendModel, type EmailRuleSendStatics, type EmailRuleStatics, type EmailSendStatus, type EmailTemplate, type EmailTemplateDocument, type EmailTemplateModel, type EmailTemplateStatics, type EmailThrottleConfig, type EmailThrottleConfigDocument, type EmailThrottleConfigModel, type EmailThrottleConfigStatics, type EmailType, FIELD_TYPE, type FieldDefinition, type FieldType, type FlattenedField, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type JoinDefinition, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_LOG_STATUS, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunLogStatus, type RunTrigger, SchedulerService, type SendEmailParams, TARGET_MODE, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TYPE_OPERATORS, type TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, flattenFields, validateConditions, validateConfig };
+export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CollectionSchema, type CompiledTemplate, type ConditionValidationError, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, type EmailAttachment, type EmailRule, type EmailRuleDocument, type EmailRuleEngine, type EmailRuleEngineConfig, type EmailRuleModel, type EmailRuleRunLog, type EmailRuleRunLogDocument, type EmailRuleRunLogModel, type EmailRuleRunLogStatics, type EmailRuleSend, type EmailRuleSendDocument, type EmailRuleSendModel, type EmailRuleSendStatics, type EmailRuleStatics, type EmailSendStatus, type EmailTemplate, type EmailTemplateDocument, type EmailTemplateModel, type EmailTemplateStatics, type EmailThrottleConfig, type EmailThrottleConfigDocument, type EmailThrottleConfigModel, type EmailThrottleConfigStatics, type EmailType, FIELD_TYPE, type FieldDefinition, type FieldType, type FlattenedField, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type JoinDefinition, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_LOG_STATUS, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunLogStatus, type RunTrigger, SchedulerService, type SendEmailParams, type SendWindowConfig, TARGET_MODE, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TYPE_OPERATORS, type TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, flattenFields, validateConditions, validateConfig };

package/dist/index.d.ts

@@ -128,7 +128,7 @@ interface QueryTarget {
     role: string;
     platform: string;
     conditions: RuleCondition[];
-    collection?: string;
+    collectionName?: string;
 }
 interface ListTarget {
     mode: 'list';
@@ -578,18 +578,25 @@ declare function createEmailRuleRunLogSchema(collectionPrefix?: string): Schema<
     __v: number;
 }>;
 
+interface SendWindowConfig {
+    startHour: number;
+    endHour: number;
+    timezone: string;
+}
 interface EmailThrottleConfig {
     _id: string;
     maxPerUserPerDay: number;
     maxPerUserPerWeek: number;
     minGapDays: number;
     throttleWindow: ThrottleWindow;
+    sendWindow?: SendWindowConfig;
     updatedAt: Date;
 }
 interface UpdateEmailThrottleConfigInput {
     maxPerUserPerDay?: number;
     maxPerUserPerWeek?: number;
     minGapDays?: number;
+    sendWindow?: SendWindowConfig | null;
 }
 
 interface IEmailThrottleConfig extends Omit<EmailThrottleConfig, '_id'> {
@@ -881,4 +888,4 @@ interface EmailRuleEngine {
  */
 declare function createEmailRuleEngine(config: EmailRuleEngineConfig): EmailRuleEngine;
 
-export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CollectionSchema, type CompiledTemplate, type ConditionValidationError, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, type EmailAttachment, type EmailRule, type EmailRuleDocument, type EmailRuleEngine, type EmailRuleEngineConfig, type EmailRuleModel, type EmailRuleRunLog, type EmailRuleRunLogDocument, type EmailRuleRunLogModel, type EmailRuleRunLogStatics, type EmailRuleSend, type EmailRuleSendDocument, type EmailRuleSendModel, type EmailRuleSendStatics, type EmailRuleStatics, type EmailSendStatus, type EmailTemplate, type EmailTemplateDocument, type EmailTemplateModel, type EmailTemplateStatics, type EmailThrottleConfig, type EmailThrottleConfigDocument, type EmailThrottleConfigModel, type EmailThrottleConfigStatics, type EmailType, FIELD_TYPE, type FieldDefinition, type FieldType, type FlattenedField, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type JoinDefinition, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_LOG_STATUS, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunLogStatus, type RunTrigger, SchedulerService, type SendEmailParams, TARGET_MODE, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TYPE_OPERATORS, type TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, flattenFields, validateConditions, validateConfig };
+export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CollectionSchema, type CompiledTemplate, type ConditionValidationError, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, type EmailAttachment, type EmailRule, type EmailRuleDocument, type EmailRuleEngine, type EmailRuleEngineConfig, type EmailRuleModel, type EmailRuleRunLog, type EmailRuleRunLogDocument, type EmailRuleRunLogModel, type EmailRuleRunLogStatics, type EmailRuleSend, type EmailRuleSendDocument, type EmailRuleSendModel, type EmailRuleSendStatics, type EmailRuleStatics, type EmailSendStatus, type EmailTemplate, type EmailTemplateDocument, type EmailTemplateModel, type EmailTemplateStatics, type EmailThrottleConfig, type EmailThrottleConfigDocument, type EmailThrottleConfigModel, type EmailThrottleConfigStatics, type EmailType, FIELD_TYPE, type FieldDefinition, type FieldType, type FlattenedField, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type JoinDefinition, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_LOG_STATUS, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunLogStatus, type RunTrigger, SchedulerService, type SendEmailParams, type SendWindowConfig, TARGET_MODE, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TYPE_OPERATORS, type TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, flattenFields, validateConditions, validateConfig };

package/dist/index.mjs

@@ -198,7 +198,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 Schema(
@@ -368,7 +368,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,
@@ -1086,8 +1095,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("; ")}`
@@ -1125,8 +1134,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("; ")}`
@@ -1184,7 +1193,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;
@@ -1272,16 +1281,6 @@ var RuleRunnerService = class {
   async runAllRules(triggeredBy = RUN_TRIGGER.Cron, runId) {
     if (!runId) runId = crypto.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");
@@ -1300,9 +1299,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);
@@ -1703,7 +1713,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) {
@@ -2204,7 +2214,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) {
@@ -2224,6 +2234,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" });
     }
@@ -2233,9 +2260,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 } });