@astralibx/email-rule-engine 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +192 -0
  2. package/dist/controllers/index.d.ts +5 -0
  3. package/dist/controllers/index.d.ts.map +1 -0
  4. package/dist/controllers/index.js +12 -0
  5. package/dist/controllers/index.js.map +1 -0
  6. package/dist/controllers/rule.controller.d.ts +13 -0
  7. package/dist/controllers/rule.controller.d.ts.map +1 -0
  8. package/dist/controllers/rule.controller.js +142 -0
  9. package/dist/controllers/rule.controller.js.map +1 -0
  10. package/dist/controllers/runner.controller.d.ts +8 -0
  11. package/dist/controllers/runner.controller.d.ts.map +1 -0
  12. package/dist/controllers/runner.controller.js +22 -0
  13. package/dist/controllers/runner.controller.js.map +1 -0
  14. package/dist/controllers/settings.controller.d.ts +7 -0
  15. package/dist/controllers/settings.controller.d.ts.map +1 -0
  16. package/dist/controllers/settings.controller.js +56 -0
  17. package/dist/controllers/settings.controller.js.map +1 -0
  18. package/dist/controllers/template.controller.d.ts +15 -0
  19. package/dist/controllers/template.controller.d.ts.map +1 -0
  20. package/dist/controllers/template.controller.js +169 -0
  21. package/dist/controllers/template.controller.js.map +1 -0
  22. package/dist/index.d.ts +32 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +67 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/routes/index.d.ts +16 -0
  27. package/dist/routes/index.d.ts.map +1 -0
  28. package/dist/routes/index.js +47 -0
  29. package/dist/routes/index.js.map +1 -0
  30. package/dist/schemas/index.d.ts +6 -0
  31. package/dist/schemas/index.d.ts.map +1 -0
  32. package/dist/schemas/index.js +14 -0
  33. package/dist/schemas/index.js.map +1 -0
  34. package/dist/schemas/rule-send.schema.d.ts +25 -0
  35. package/dist/schemas/rule-send.schema.d.ts.map +1 -0
  36. package/dist/schemas/rule-send.schema.js +41 -0
  37. package/dist/schemas/rule-send.schema.js.map +1 -0
  38. package/dist/schemas/rule.schema.d.ts +22 -0
  39. package/dist/schemas/rule.schema.d.ts.map +1 -0
  40. package/dist/schemas/rule.schema.js +81 -0
  41. package/dist/schemas/rule.schema.js.map +1 -0
  42. package/dist/schemas/run-log.schema.d.ts +39 -0
  43. package/dist/schemas/run-log.schema.d.ts.map +1 -0
  44. package/dist/schemas/run-log.schema.js +47 -0
  45. package/dist/schemas/run-log.schema.js.map +1 -0
  46. package/dist/schemas/template.schema.d.ts +24 -0
  47. package/dist/schemas/template.schema.d.ts.map +1 -0
  48. package/dist/schemas/template.schema.js +65 -0
  49. package/dist/schemas/template.schema.js.map +1 -0
  50. package/dist/schemas/throttle-config.schema.d.ts +19 -0
  51. package/dist/schemas/throttle-config.schema.d.ts.map +1 -0
  52. package/dist/schemas/throttle-config.schema.js +32 -0
  53. package/dist/schemas/throttle-config.schema.js.map +1 -0
  54. package/dist/services/index.d.ts +5 -0
  55. package/dist/services/index.d.ts.map +1 -0
  56. package/dist/services/index.js +12 -0
  57. package/dist/services/index.js.map +1 -0
  58. package/dist/services/rule-runner.service.d.ts +31 -0
  59. package/dist/services/rule-runner.service.d.ts.map +1 -0
  60. package/dist/services/rule-runner.service.js +253 -0
  61. package/dist/services/rule-runner.service.js.map +1 -0
  62. package/dist/services/rule.service.d.ts +27 -0
  63. package/dist/services/rule.service.d.ts.map +1 -0
  64. package/dist/services/rule.service.js +127 -0
  65. package/dist/services/rule.service.js.map +1 -0
  66. package/dist/services/template-render.service.d.ts +23 -0
  67. package/dist/services/template-render.service.d.ts.map +1 -0
  68. package/dist/services/template-render.service.js +178 -0
  69. package/dist/services/template-render.service.js.map +1 -0
  70. package/dist/services/template.service.d.ts +42 -0
  71. package/dist/services/template.service.d.ts.map +1 -0
  72. package/dist/services/template.service.js +128 -0
  73. package/dist/services/template.service.js.map +1 -0
  74. package/dist/types/config.types.d.ts +50 -0
  75. package/dist/types/config.types.d.ts.map +1 -0
  76. package/dist/types/config.types.js +3 -0
  77. package/dist/types/config.types.js.map +1 -0
  78. package/dist/types/enums.d.ts +43 -0
  79. package/dist/types/enums.d.ts.map +1 -0
  80. package/dist/types/enums.js +40 -0
  81. package/dist/types/enums.js.map +1 -0
  82. package/dist/types/index.d.ts +6 -0
  83. package/dist/types/index.d.ts.map +1 -0
  84. package/dist/types/index.js +11 -0
  85. package/dist/types/index.js.map +1 -0
  86. package/dist/types/rule.types.d.ts +91 -0
  87. package/dist/types/rule.types.d.ts.map +1 -0
  88. package/dist/types/rule.types.js +3 -0
  89. package/dist/types/rule.types.js.map +1 -0
  90. package/dist/types/template.types.d.ts +43 -0
  91. package/dist/types/template.types.d.ts.map +1 -0
  92. package/dist/types/template.types.js +3 -0
  93. package/dist/types/template.types.js.map +1 -0
  94. package/dist/types/throttle.types.d.ts +15 -0
  95. package/dist/types/throttle.types.d.ts.map +1 -0
  96. package/dist/types/throttle.types.js +3 -0
  97. package/dist/types/throttle.types.js.map +1 -0
  98. package/dist/utils/express-helpers.d.ts +4 -0
  99. package/dist/utils/express-helpers.d.ts.map +1 -0
  100. package/dist/utils/express-helpers.js +15 -0
  101. package/dist/utils/express-helpers.js.map +1 -0
  102. package/dist/utils/redis-lock.d.ts +13 -0
  103. package/dist/utils/redis-lock.d.ts.map +1 -0
  104. package/dist/utils/redis-lock.js +36 -0
  105. package/dist/utils/redis-lock.js.map +1 -0
  106. package/package.json +49 -0
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ThrottleWindow = exports.RunTrigger = exports.EmailType = exports.RuleOperator = exports.TemplateAudience = exports.TemplateCategory = void 0;
4
+ exports.TemplateCategory = {
5
+ Onboarding: 'onboarding',
6
+ Engagement: 'engagement',
7
+ Transactional: 'transactional',
8
+ ReEngagement: 're-engagement',
9
+ Announcement: 'announcement'
10
+ };
11
+ exports.TemplateAudience = {
12
+ Customer: 'customer',
13
+ Provider: 'provider',
14
+ All: 'all'
15
+ };
16
+ exports.RuleOperator = {
17
+ Eq: 'eq',
18
+ Neq: 'neq',
19
+ Gt: 'gt',
20
+ Gte: 'gte',
21
+ Lt: 'lt',
22
+ Lte: 'lte',
23
+ Exists: 'exists',
24
+ NotExists: 'not_exists',
25
+ In: 'in',
26
+ NotIn: 'not_in',
27
+ Contains: 'contains'
28
+ };
29
+ exports.EmailType = {
30
+ Automated: 'automated',
31
+ Transactional: 'transactional'
32
+ };
33
+ exports.RunTrigger = {
34
+ Cron: 'cron',
35
+ Manual: 'manual'
36
+ };
37
+ exports.ThrottleWindow = {
38
+ Rolling: 'rolling'
39
+ };
40
+ //# sourceMappingURL=enums.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/types/enums.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG;IAC9B,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,cAAc;CACpB,CAAC;AAGE,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,GAAG,EAAE,KAAK;CACF,CAAC;AAGE,QAAA,YAAY,GAAG;IAC1B,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,KAAK;IACV,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,KAAK;IACV,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,YAAY;IACvB,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,QAAQ;IACf,QAAQ,EAAE,UAAU;CACZ,CAAC;AAGE,QAAA,SAAS,GAAG;IACvB,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;CACtB,CAAC;AAGE,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACR,CAAC;AAGE,QAAA,cAAc,GAAG;IAC5B,OAAO,EAAE,SAAS;CACV,CAAC"}
@@ -0,0 +1,6 @@
1
+ export { TemplateCategory, TemplateAudience, RuleOperator, EmailType, RunTrigger, ThrottleWindow } from './enums';
2
+ export type { EmailTemplate, CreateEmailTemplateInput, UpdateEmailTemplateInput } from './template.types';
3
+ export type { RuleCondition, RuleRunStats, RuleTarget, EmailRule, CreateEmailRuleInput, UpdateEmailRuleInput, EmailRuleSend, PerRuleStats, EmailRuleRunLog } from './rule.types';
4
+ export type { EmailThrottleConfig, UpdateEmailThrottleConfigInput } from './throttle.types';
5
+ export type { EmailRuleEngineConfig, SendEmailParams, AgentSelection, RecipientIdentifier, LogAdapter } from './config.types';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAClH,YAAY,EACV,aAAa,EAAE,wBAAwB,EAAE,wBAAwB,EAClE,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,aAAa,EAAE,YAAY,EAAE,UAAU,EACvC,SAAS,EAAE,oBAAoB,EAAE,oBAAoB,EACrD,aAAa,EAAE,YAAY,EAAE,eAAe,EAC7C,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAC;AAC5F,YAAY,EACV,qBAAqB,EAAE,eAAe,EAAE,cAAc,EACtD,mBAAmB,EAAE,UAAU,EAChC,MAAM,gBAAgB,CAAC"}
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ThrottleWindow = exports.RunTrigger = exports.EmailType = exports.RuleOperator = exports.TemplateAudience = exports.TemplateCategory = void 0;
4
+ var enums_1 = require("./enums");
5
+ Object.defineProperty(exports, "TemplateCategory", { enumerable: true, get: function () { return enums_1.TemplateCategory; } });
6
+ Object.defineProperty(exports, "TemplateAudience", { enumerable: true, get: function () { return enums_1.TemplateAudience; } });
7
+ Object.defineProperty(exports, "RuleOperator", { enumerable: true, get: function () { return enums_1.RuleOperator; } });
8
+ Object.defineProperty(exports, "EmailType", { enumerable: true, get: function () { return enums_1.EmailType; } });
9
+ Object.defineProperty(exports, "RunTrigger", { enumerable: true, get: function () { return enums_1.RunTrigger; } });
10
+ Object.defineProperty(exports, "ThrottleWindow", { enumerable: true, get: function () { return enums_1.ThrottleWindow; } });
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,iCAAkH;AAAzG,yGAAA,gBAAgB,OAAA;AAAE,yGAAA,gBAAgB,OAAA;AAAE,qGAAA,YAAY,OAAA;AAAE,kGAAA,SAAS,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,uGAAA,cAAc,OAAA"}
@@ -0,0 +1,91 @@
1
+ import { RuleOperator, EmailType, RunTrigger, TemplateAudience } from './enums';
2
+ export interface RuleCondition {
3
+ field: string;
4
+ operator: RuleOperator;
5
+ value: unknown;
6
+ }
7
+ export interface RuleRunStats {
8
+ matched: number;
9
+ sent: number;
10
+ skipped: number;
11
+ skippedByThrottle: number;
12
+ errors: number;
13
+ }
14
+ export interface RuleTarget {
15
+ role: TemplateAudience;
16
+ platform: string;
17
+ conditions: RuleCondition[];
18
+ }
19
+ export interface EmailRule {
20
+ _id: string;
21
+ name: string;
22
+ description?: string;
23
+ isActive: boolean;
24
+ sortOrder: number;
25
+ target: RuleTarget;
26
+ templateId: string;
27
+ sendOnce: boolean;
28
+ resendAfterDays?: number;
29
+ cooldownDays?: number;
30
+ autoApprove: boolean;
31
+ maxPerRun?: number;
32
+ bypassThrottle: boolean;
33
+ emailType: EmailType;
34
+ totalSent: number;
35
+ totalSkipped: number;
36
+ lastRunAt?: Date;
37
+ lastRunStats?: RuleRunStats;
38
+ createdAt: Date;
39
+ updatedAt: Date;
40
+ }
41
+ export interface CreateEmailRuleInput {
42
+ name: string;
43
+ description?: string;
44
+ target: RuleTarget;
45
+ templateId: string;
46
+ sortOrder?: number;
47
+ sendOnce?: boolean;
48
+ resendAfterDays?: number;
49
+ cooldownDays?: number;
50
+ autoApprove?: boolean;
51
+ maxPerRun?: number;
52
+ bypassThrottle?: boolean;
53
+ emailType?: EmailType;
54
+ }
55
+ export interface UpdateEmailRuleInput {
56
+ name?: string;
57
+ description?: string;
58
+ isActive?: boolean;
59
+ sortOrder?: number;
60
+ target?: RuleTarget;
61
+ templateId?: string;
62
+ sendOnce?: boolean;
63
+ resendAfterDays?: number;
64
+ cooldownDays?: number;
65
+ autoApprove?: boolean;
66
+ maxPerRun?: number;
67
+ bypassThrottle?: boolean;
68
+ emailType?: EmailType;
69
+ }
70
+ export interface EmailRuleSend {
71
+ _id: string;
72
+ ruleId: string;
73
+ userId: string;
74
+ emailIdentifierId?: string;
75
+ messageId?: string;
76
+ sentAt: Date;
77
+ }
78
+ export interface PerRuleStats extends RuleRunStats {
79
+ ruleId: string;
80
+ ruleName: string;
81
+ }
82
+ export interface EmailRuleRunLog {
83
+ _id: string;
84
+ runAt: Date;
85
+ triggeredBy: RunTrigger;
86
+ duration: number;
87
+ rulesProcessed: number;
88
+ totalStats: RuleRunStats;
89
+ perRuleStats: PerRuleStats[];
90
+ }
91
+ //# sourceMappingURL=rule.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rule.types.d.ts","sourceRoot":"","sources":["../../src/types/rule.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhF,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,SAAS,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,IAAI,CAAC;IACZ,WAAW,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,YAAY,CAAC;IACzB,YAAY,EAAE,YAAY,EAAE,CAAC;CAC9B"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=rule.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rule.types.js","sourceRoot":"","sources":["../../src/types/rule.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,43 @@
1
+ import { TemplateCategory, TemplateAudience } from './enums';
2
+ export interface EmailTemplate {
3
+ _id: string;
4
+ name: string;
5
+ slug: string;
6
+ description?: string;
7
+ category: TemplateCategory;
8
+ audience: TemplateAudience;
9
+ platform: string;
10
+ subject: string;
11
+ body: string;
12
+ textBody?: string;
13
+ variables: string[];
14
+ version: number;
15
+ isActive: boolean;
16
+ createdAt: Date;
17
+ updatedAt: Date;
18
+ }
19
+ export interface CreateEmailTemplateInput {
20
+ name: string;
21
+ slug: string;
22
+ description?: string;
23
+ category: TemplateCategory;
24
+ audience: TemplateAudience;
25
+ platform: string;
26
+ subject: string;
27
+ body: string;
28
+ textBody?: string;
29
+ variables?: string[];
30
+ }
31
+ export interface UpdateEmailTemplateInput {
32
+ name?: string;
33
+ description?: string;
34
+ category?: TemplateCategory;
35
+ audience?: TemplateAudience;
36
+ platform?: string;
37
+ subject?: string;
38
+ body?: string;
39
+ textBody?: string;
40
+ variables?: string[];
41
+ isActive?: boolean;
42
+ }
43
+ //# sourceMappingURL=template.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"template.types.d.ts","sourceRoot":"","sources":["../../src/types/template.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE7D,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAElB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=template.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"template.types.js","sourceRoot":"","sources":["../../src/types/template.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,15 @@
1
+ import { ThrottleWindow } from './enums';
2
+ export interface EmailThrottleConfig {
3
+ _id: string;
4
+ maxPerUserPerDay: number;
5
+ maxPerUserPerWeek: number;
6
+ minGapDays: number;
7
+ throttleWindow: ThrottleWindow;
8
+ updatedAt: Date;
9
+ }
10
+ export interface UpdateEmailThrottleConfigInput {
11
+ maxPerUserPerDay?: number;
12
+ maxPerUserPerWeek?: number;
13
+ minGapDays?: number;
14
+ }
15
+ //# sourceMappingURL=throttle.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle.types.d.ts","sourceRoot":"","sources":["../../src/types/throttle.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=throttle.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle.types.js","sourceRoot":"","sources":["../../src/types/throttle.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { Request } from 'express';
2
+ export declare function getParam(req: Request, name: string): string;
3
+ export declare function getQueryString(req: Request, name: string): string | undefined;
4
+ //# sourceMappingURL=express-helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"express-helpers.d.ts","sourceRoot":"","sources":["../../src/utils/express-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG3D;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAI7E"}
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getParam = getParam;
4
+ exports.getQueryString = getQueryString;
5
+ function getParam(req, name) {
6
+ const val = req.params[name];
7
+ return Array.isArray(val) ? val[0] : val;
8
+ }
9
+ function getQueryString(req, name) {
10
+ const val = req.query[name];
11
+ if (val === undefined)
12
+ return undefined;
13
+ return Array.isArray(val) ? String(val[0]) : String(val);
14
+ }
15
+ //# sourceMappingURL=express-helpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"express-helpers.js","sourceRoot":"","sources":["../../src/utils/express-helpers.ts"],"names":[],"mappings":";;AAEA,4BAGC;AAED,wCAIC;AATD,SAAgB,QAAQ,CAAC,GAAY,EAAE,IAAY;IACjD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED,SAAgB,cAAc,CAAC,GAAY,EAAE,IAAY;IACvD,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC"}
@@ -0,0 +1,13 @@
1
+ import type { Redis } from 'ioredis';
2
+ import type { LogAdapter } from '../types/config.types';
3
+ export declare class RedisLock {
4
+ private redis;
5
+ private lockKey;
6
+ private ttlMs;
7
+ private logger?;
8
+ private lockValue;
9
+ constructor(redis: Redis, lockKey: string, ttlMs: number, logger?: LogAdapter | undefined);
10
+ acquire(): Promise<boolean>;
11
+ release(): Promise<void>;
12
+ }
13
+ //# sourceMappingURL=redis-lock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"redis-lock.d.ts","sourceRoot":"","sources":["../../src/utils/redis-lock.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,qBAAa,SAAS;IAIlB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,MAAM,CAAC;IANjB,OAAO,CAAC,SAAS,CAAM;gBAGb,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,UAAU,YAAA;IAGvB,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAM3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ/B"}
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.RedisLock = void 0;
7
+ const crypto_1 = __importDefault(require("crypto"));
8
+ class RedisLock {
9
+ redis;
10
+ lockKey;
11
+ ttlMs;
12
+ logger;
13
+ lockValue = '';
14
+ constructor(redis, lockKey, ttlMs, logger) {
15
+ this.redis = redis;
16
+ this.lockKey = lockKey;
17
+ this.ttlMs = ttlMs;
18
+ this.logger = logger;
19
+ }
20
+ async acquire() {
21
+ this.lockValue = crypto_1.default.randomUUID();
22
+ const result = await this.redis.set(this.lockKey, this.lockValue, 'PX', this.ttlMs, 'NX');
23
+ return result === 'OK';
24
+ }
25
+ async release() {
26
+ try {
27
+ const script = "if redis.call('get',KEYS[1]) == ARGV[1] then return redis.call('del',KEYS[1]) else return 0 end";
28
+ await this.redis.eval(script, 1, this.lockKey, this.lockValue);
29
+ }
30
+ catch (err) {
31
+ this.logger?.error('Failed to release lock', { error: err });
32
+ }
33
+ }
34
+ }
35
+ exports.RedisLock = RedisLock;
36
+ //# sourceMappingURL=redis-lock.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"redis-lock.js","sourceRoot":"","sources":["../../src/utils/redis-lock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAI5B,MAAa,SAAS;IAIV;IACA;IACA;IACA;IANF,SAAS,GAAG,EAAE,CAAC;IAEvB,YACU,KAAY,EACZ,OAAe,EACf,KAAa,EACb,MAAmB;QAHnB,UAAK,GAAL,KAAK,CAAO;QACZ,YAAO,GAAP,OAAO,CAAQ;QACf,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAAa;IAC1B,CAAC;IAEJ,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,SAAS,GAAG,gBAAM,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1F,OAAO,MAAM,KAAK,IAAI,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,iGAAiG,CAAC;YACjH,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;CACF;AAxBD,8BAwBC"}
package/package.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "name": "@astralibx/email-rule-engine",
3
+ "version": "1.0.0",
4
+ "description": "Rule-based email automation engine with MJML + Handlebars templates, throttling, and distributed locking",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "scripts": {
11
+ "build": "tsc",
12
+ "test": "jest",
13
+ "prepublishOnly": "npm run build",
14
+ "clean": "rm -rf dist"
15
+ },
16
+ "keywords": [
17
+ "email",
18
+ "automation",
19
+ "rule-engine",
20
+ "mjml",
21
+ "handlebars",
22
+ "throttle"
23
+ ],
24
+ "license": "MIT",
25
+ "peerDependencies": {
26
+ "express": "^4.18.0 || ^5.0.0",
27
+ "handlebars": "^4.7.0",
28
+ "html-to-text": "^9.0.0",
29
+ "ioredis": "^5.0.0",
30
+ "mjml": "^4.0.0",
31
+ "mongoose": "^7.0.0 || ^8.0.0"
32
+ },
33
+ "devDependencies": {
34
+ "@types/jest": "^29.5.0",
35
+ "@types/express": "^5.0.0",
36
+ "@types/html-to-text": "^9.0.4",
37
+ "@types/mjml": "^4.7.4",
38
+ "@types/node": "^22.0.0",
39
+ "express": "^5.0.0",
40
+ "handlebars": "^4.7.8",
41
+ "html-to-text": "^9.0.5",
42
+ "ioredis": "^5.4.2",
43
+ "mjml": "^4.15.3",
44
+ "mongoose": "^8.12.1",
45
+ "jest": "^29.7.0",
46
+ "ts-jest": "^29.2.0",
47
+ "typescript": "^5.8.2"
48
+ }
49
+ }