@astralibx/email-rule-engine 12.7.1 → 12.7.2

package/dist/index.d.mts

@@ -55,6 +55,17 @@ declare const EMAIL_SEND_STATUS: {
     readonly Throttled: "throttled";
 };
 type EmailSendStatus = (typeof EMAIL_SEND_STATUS)[keyof typeof EMAIL_SEND_STATUS];
+declare const TARGET_MODE: {
+    readonly Query: "query";
+    readonly List: "list";
+};
+type TargetMode = (typeof TARGET_MODE)[keyof typeof TARGET_MODE];
+declare const RUN_LOG_STATUS: {
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+    readonly Failed: "failed";
+};
+type RunLogStatus = (typeof RUN_LOG_STATUS)[keyof typeof RUN_LOG_STATUS];
 
 interface RuleCondition {
     field: string;
@@ -202,6 +213,11 @@ interface SendEmailParams {
     textBody: string;
     ruleId: string;
     autoApprove: boolean;
+    attachments?: Array<{
+        filename: string;
+        url: string;
+        contentType: string;
+    }>;
 }
 interface AgentSelection {
     accountId: string;
@@ -272,7 +288,11 @@ interface EmailRuleEngineConfig {
             templateId: string;
         }) => Promise<AgentSelection | null>;
         findIdentifier: (email: string) => Promise<RecipientIdentifier | null>;
-        sendTestEmail?: (to: string, subject: string, html: string, text: string) => Promise<void>;
+        sendTestEmail?: (to: string, subject: string, html: string, text: string, attachments?: Array<{
+            filename: string;
+            url: string;
+            contentType: string;
+        }>) => Promise<void>;
     };
     platforms?: string[];
     audiences?: string[];
@@ -331,6 +351,11 @@ interface EmailRuleEngineConfig {
     };
 }
 
+interface EmailAttachment {
+    filename: string;
+    url: string;
+    contentType: string;
+}
 interface EmailTemplate {
     _id: string;
     name: string;
@@ -347,6 +372,7 @@ interface EmailTemplate {
     variables: string[];
     version: number;
     isActive: boolean;
+    attachments?: EmailAttachment[];
     createdAt: Date;
     updatedAt: Date;
 }
@@ -363,6 +389,7 @@ interface CreateEmailTemplateInput {
     preheaders?: string[];
     fields?: Record<string, string>;
     variables?: string[];
+    attachments?: EmailAttachment[];
 }
 interface UpdateEmailTemplateInput {
     name?: string;
@@ -376,6 +403,7 @@ interface UpdateEmailTemplateInput {
     preheaders?: string[];
     fields?: Record<string, string>;
     variables?: string[];
+    attachments?: EmailAttachment[];
     isActive?: boolean;
 }
 
@@ -766,4 +794,4 @@ interface EmailRuleEngine {
  */
 declare function createEmailRuleEngine(config: EmailRuleEngineConfig): EmailRuleEngine;
 
-export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CompiledTemplate, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, 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, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunTrigger, SchedulerService, type SendEmailParams, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };
+export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CompiledTemplate, 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, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, 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 TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };

package/dist/index.d.ts

@@ -55,6 +55,17 @@ declare const EMAIL_SEND_STATUS: {
     readonly Throttled: "throttled";
 };
 type EmailSendStatus = (typeof EMAIL_SEND_STATUS)[keyof typeof EMAIL_SEND_STATUS];
+declare const TARGET_MODE: {
+    readonly Query: "query";
+    readonly List: "list";
+};
+type TargetMode = (typeof TARGET_MODE)[keyof typeof TARGET_MODE];
+declare const RUN_LOG_STATUS: {
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+    readonly Failed: "failed";
+};
+type RunLogStatus = (typeof RUN_LOG_STATUS)[keyof typeof RUN_LOG_STATUS];
 
 interface RuleCondition {
     field: string;
@@ -202,6 +213,11 @@ interface SendEmailParams {
     textBody: string;
     ruleId: string;
     autoApprove: boolean;
+    attachments?: Array<{
+        filename: string;
+        url: string;
+        contentType: string;
+    }>;
 }
 interface AgentSelection {
     accountId: string;
@@ -272,7 +288,11 @@ interface EmailRuleEngineConfig {
             templateId: string;
         }) => Promise<AgentSelection | null>;
         findIdentifier: (email: string) => Promise<RecipientIdentifier | null>;
-        sendTestEmail?: (to: string, subject: string, html: string, text: string) => Promise<void>;
+        sendTestEmail?: (to: string, subject: string, html: string, text: string, attachments?: Array<{
+            filename: string;
+            url: string;
+            contentType: string;
+        }>) => Promise<void>;
     };
     platforms?: string[];
     audiences?: string[];
@@ -331,6 +351,11 @@ interface EmailRuleEngineConfig {
     };
 }
 
+interface EmailAttachment {
+    filename: string;
+    url: string;
+    contentType: string;
+}
 interface EmailTemplate {
     _id: string;
     name: string;
@@ -347,6 +372,7 @@ interface EmailTemplate {
     variables: string[];
     version: number;
     isActive: boolean;
+    attachments?: EmailAttachment[];
     createdAt: Date;
     updatedAt: Date;
 }
@@ -363,6 +389,7 @@ interface CreateEmailTemplateInput {
     preheaders?: string[];
     fields?: Record<string, string>;
     variables?: string[];
+    attachments?: EmailAttachment[];
 }
 interface UpdateEmailTemplateInput {
     name?: string;
@@ -376,6 +403,7 @@ interface UpdateEmailTemplateInput {
     preheaders?: string[];
     fields?: Record<string, string>;
     variables?: string[];
+    attachments?: EmailAttachment[];
     isActive?: boolean;
 }
 
@@ -766,4 +794,4 @@ interface EmailRuleEngine {
  */
 declare function createEmailRuleEngine(config: EmailRuleEngineConfig): EmailRuleEngine;
 
-export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CompiledTemplate, ConfigValidationError, type CreateEmailRuleInput, type CreateEmailTemplateInput, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, 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, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, type ListTarget, LockAcquisitionError, type PerRuleStats, type QueryTarget, RULE_OPERATOR, RUN_TRIGGER, type RecipientIdentifier, type RenderResult, type RuleCondition, RuleNotFoundError, type RuleOperator, type RuleRunStats, RuleRunnerService, RuleService, type RuleTarget, RuleTemplateIncompatibleError, type RunTrigger, SchedulerService, type SendEmailParams, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };
+export { type AgentSelection, AlxEmailError, type BeforeSendParams, type BeforeSendResult, type CompiledTemplate, 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, type IEmailRule, type IEmailRuleRunLog, type IEmailRuleSend, type IEmailTemplate, type IEmailThrottleConfig, 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 TargetMode, type TemplateAudience, type TemplateCategory, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, type ThrottleWindow, type UpdateEmailRuleInput, type UpdateEmailTemplateInput, type UpdateEmailThrottleConfigInput, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };

package/dist/index.mjs

@@ -10387,13 +10387,22 @@ var EMAIL_SEND_STATUS = {
   Invalid: "invalid",
   Throttled: "throttled"
 };
+var TARGET_MODE = {
+  Query: "query",
+  List: "list"
+};
+var RUN_LOG_STATUS = {
+  Completed: "completed",
+  Cancelled: "cancelled",
+  Failed: "failed"
+};
 
 // src/schemas/template.schema.ts
 function createEmailTemplateSchema(platformValues, audienceValues, categoryValues, collectionPrefix) {
   const schema = new Schema(
     {
       name: { type: String, required: true },
-      slug: { type: String, required: true, unique: true },
+      slug: { type: String, required: true, unique: true, maxlength: 200 },
       description: String,
       category: { type: String, enum: categoryValues || Object.values(TEMPLATE_CATEGORY), required: true },
       audience: { type: String, enum: audienceValues || Object.values(TEMPLATE_AUDIENCE), required: true },
@@ -10418,6 +10427,15 @@ function createEmailTemplateSchema(platformValues, audienceValues, categoryValue
         }
       },
       variables: [{ type: String }],
+      attachments: {
+        type: [{
+          _id: false,
+          filename: { type: String, required: true },
+          url: { type: String, required: true },
+          contentType: { type: String, required: true }
+        }],
+        default: []
+      },
       version: { type: Number, default: 1 },
       isActive: { type: Boolean, default: true }
     },
@@ -10454,6 +10472,7 @@ function createEmailTemplateSchema(platformValues, audienceValues, categoryValue
             preheaders: input.preheaders || [],
             fields: input.fields || {},
             variables: input.variables || [],
+            attachments: input.attachments || [],
             version: 1,
             isActive: true
           });
@@ -10472,7 +10491,7 @@ function createEmailRuleSchema(platformValues, audienceValues, collectionPrefix)
     value: { type: Schema.Types.Mixed }
   }, { _id: false });
   const RuleTargetSchema = new Schema({
-    mode: { type: String, enum: ["query", "list"], required: true },
+    mode: { type: String, enum: Object.values(TARGET_MODE), required: true },
     role: { type: String, enum: audienceValues || Object.values(TEMPLATE_AUDIENCE) },
     platform: {
       type: String,
@@ -10636,7 +10655,7 @@ function createEmailRuleRunLogSchema(collectionPrefix) {
     {
       runId: { type: String, index: true },
       runAt: { type: Date, required: true, default: () => /* @__PURE__ */ new Date() },
-      status: { type: String, enum: ["completed", "cancelled", "failed"], default: "completed" },
+      status: { type: String, enum: Object.values(RUN_LOG_STATUS), default: RUN_LOG_STATUS.Completed },
       triggeredBy: { type: String, enum: Object.values(RUN_TRIGGER), required: true },
       duration: { type: Number, required: true },
       rulesProcessed: { type: Number, required: true },
@@ -10931,6 +10950,9 @@ var DuplicateSlugError = class extends AlxEmailError {
 };
 
 // src/services/template.service.ts
+function stripScriptTags(text) {
+  return text.replace(/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi, "");
+}
 var UPDATEABLE_FIELDS = /* @__PURE__ */ new Set([
   "name",
   "description",
@@ -10943,7 +10965,8 @@ var UPDATEABLE_FIELDS = /* @__PURE__ */ new Set([
   "preheaders",
   "variables",
   "isActive",
-  "fields"
+  "fields",
+  "attachments"
 ]);
 function slugify(name) {
   return name.toLowerCase().trim().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
@@ -10974,7 +10997,8 @@ var TemplateService = class {
     if (existing) {
       throw new DuplicateSlugError(slug);
     }
-    const { subjects, bodies } = input;
+    const subjects = input.subjects.map((s) => stripScriptTags(s));
+    const bodies = input.bodies.map((b) => stripScriptTags(b));
     if (subjects.length === 0) throw new TemplateSyntaxError("At least one subject is required", ["At least one subject is required"]);
     if (bodies.length === 0) throw new TemplateSyntaxError("At least one body is required", ["At least one body is required"]);
     for (const b of bodies) {
@@ -10996,6 +11020,12 @@ var TemplateService = class {
   async update(id, input) {
     const template = await this.EmailTemplate.findById(id);
     if (!template) return null;
+    if (input.subjects) {
+      input.subjects = input.subjects.map((s) => stripScriptTags(s));
+    }
+    if (input.bodies) {
+      input.bodies = input.bodies.map((b) => stripScriptTags(b));
+    }
     if (input.subjects && input.subjects.length === 0) {
       throw new TemplateSyntaxError("At least one subject is required", ["At least one subject is required"]);
     }
@@ -11104,7 +11134,8 @@ var TemplateService = class {
         testEmail,
         `[TEST] ${rendered.subject}`,
         rendered.html,
-        rendered.text
+        rendered.text,
+        template.attachments || []
       );
       return { success: true };
     } catch (error) {
@@ -11675,7 +11706,8 @@ var RuleRunnerService = class {
           htmlBody: finalHtml,
           textBody: finalText,
           ruleId,
-          autoApprove: rule.autoApprove ?? true
+          autoApprove: rule.autoApprove ?? true,
+          attachments: template.attachments || []
         });
         await this.EmailRuleSend.logSend(
           ruleId,
@@ -11890,7 +11922,8 @@ var RuleRunnerService = class {
           htmlBody: finalHtml,
           textBody: finalText,
           ruleId,
-          autoApprove: rule.autoApprove ?? true
+          autoApprove: rule.autoApprove ?? true,
+          attachments: template.attachments || []
         });
         await this.EmailRuleSend.logSend(
           ruleId,
@@ -30136,6 +30169,6 @@ function createEmailRuleEngine(config) {
   };
 }
 
-export { AlxEmailError, ConfigValidationError, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, LockAcquisitionError, RULE_OPERATOR, RUN_TRIGGER, RuleNotFoundError, RuleRunnerService, RuleService, RuleTemplateIncompatibleError, SchedulerService, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };
+export { AlxEmailError, ConfigValidationError, DuplicateSlugError, EMAIL_SEND_STATUS, EMAIL_TYPE, LockAcquisitionError, RULE_OPERATOR, RUN_LOG_STATUS, RUN_TRIGGER, RuleNotFoundError, RuleRunnerService, RuleService, RuleTemplateIncompatibleError, SchedulerService, TARGET_MODE, TEMPLATE_AUDIENCE, TEMPLATE_CATEGORY, THROTTLE_WINDOW, TemplateNotFoundError, TemplateRenderService, TemplateService, TemplateSyntaxError, createEmailRuleEngine, createEmailRuleRunLogSchema, createEmailRuleSchema, createEmailRuleSendSchema, createEmailTemplateSchema, createEmailThrottleConfigSchema, validateConfig };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map