@ackplus/nest-dynamic-templates 1.1.16 → 2.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 (80) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/MIGRATION.md +97 -0
  3. package/README.md +201 -116
  4. package/dist/index.d.ts +2 -0
  5. package/dist/index.js +2 -0
  6. package/dist/index.js.map +1 -1
  7. package/dist/lib/config/resolve-config.d.ts +7 -0
  8. package/dist/lib/config/resolve-config.js +50 -0
  9. package/dist/lib/config/resolve-config.js.map +1 -0
  10. package/dist/lib/constant.d.ts +1 -0
  11. package/dist/lib/constant.js +2 -1
  12. package/dist/lib/constant.js.map +1 -1
  13. package/dist/lib/dto/create-template-layout.dto.js +49 -12
  14. package/dist/lib/dto/create-template-layout.dto.js.map +1 -1
  15. package/dist/lib/dto/create-template.dto.js +59 -14
  16. package/dist/lib/dto/create-template.dto.js.map +1 -1
  17. package/dist/lib/dto/render-template.dto.d.ts +3 -6
  18. package/dist/lib/dto/render-template.dto.js +17 -38
  19. package/dist/lib/dto/render-template.dto.js.map +1 -1
  20. package/dist/lib/engines/language/html.engine.d.ts +2 -3
  21. package/dist/lib/engines/language/html.engine.js +4 -34
  22. package/dist/lib/engines/language/html.engine.js.map +1 -1
  23. package/dist/lib/engines/language/markdown.engine.d.ts +4 -2
  24. package/dist/lib/engines/language/markdown.engine.js +20 -20
  25. package/dist/lib/engines/language/markdown.engine.js.map +1 -1
  26. package/dist/lib/engines/language/mjml.engine.d.ts +4 -2
  27. package/dist/lib/engines/language/mjml.engine.js +18 -20
  28. package/dist/lib/engines/language/mjml.engine.js.map +1 -1
  29. package/dist/lib/engines/language/text.engine.d.ts +2 -1
  30. package/dist/lib/engines/language/text.engine.js +2 -1
  31. package/dist/lib/engines/language/text.engine.js.map +1 -1
  32. package/dist/lib/engines/language-engine.d.ts +4 -1
  33. package/dist/lib/engines/language-engine.js +2 -0
  34. package/dist/lib/engines/language-engine.js.map +1 -1
  35. package/dist/lib/engines/load-peer.d.ts +1 -0
  36. package/dist/lib/engines/load-peer.js +21 -0
  37. package/dist/lib/engines/load-peer.js.map +1 -0
  38. package/dist/lib/engines/template/ejs.engine.d.ts +6 -3
  39. package/dist/lib/engines/template/ejs.engine.js +13 -12
  40. package/dist/lib/engines/template/ejs.engine.js.map +1 -1
  41. package/dist/lib/engines/template/handlebars.engine.d.ts +8 -3
  42. package/dist/lib/engines/template/handlebars.engine.js +26 -13
  43. package/dist/lib/engines/template/handlebars.engine.js.map +1 -1
  44. package/dist/lib/engines/template/nunjucks.engine.d.ts +8 -8
  45. package/dist/lib/engines/template/nunjucks.engine.js +25 -37
  46. package/dist/lib/engines/template/nunjucks.engine.js.map +1 -1
  47. package/dist/lib/engines/template/pug.engine.d.ts +7 -5
  48. package/dist/lib/engines/template/pug.engine.js +11 -20
  49. package/dist/lib/engines/template/pug.engine.js.map +1 -1
  50. package/dist/lib/engines/template-engine.d.ts +4 -1
  51. package/dist/lib/engines/template-engine.js +2 -0
  52. package/dist/lib/engines/template-engine.js.map +1 -1
  53. package/dist/lib/entities/template-layout.entity.js +51 -14
  54. package/dist/lib/entities/template-layout.entity.js.map +1 -1
  55. package/dist/lib/entities/template.entity.js +58 -15
  56. package/dist/lib/entities/template.entity.js.map +1 -1
  57. package/dist/lib/errors/diagnose.d.ts +11 -0
  58. package/dist/lib/errors/diagnose.js +162 -0
  59. package/dist/lib/errors/diagnose.js.map +1 -0
  60. package/dist/lib/errors/template.errors.d.ts +77 -13
  61. package/dist/lib/errors/template.errors.js +104 -59
  62. package/dist/lib/errors/template.errors.js.map +1 -1
  63. package/dist/lib/interfaces/module-config.interface.d.ts +29 -18
  64. package/dist/lib/nest-dynamic-templates.module.d.ts +1 -4
  65. package/dist/lib/nest-dynamic-templates.module.js +40 -96
  66. package/dist/lib/nest-dynamic-templates.module.js.map +1 -1
  67. package/dist/lib/services/template-config.service.d.ts +12 -15
  68. package/dist/lib/services/template-config.service.js +30 -45
  69. package/dist/lib/services/template-config.service.js.map +1 -1
  70. package/dist/lib/services/template-engine.registry.d.ts +6 -10
  71. package/dist/lib/services/template-engine.registry.js +42 -50
  72. package/dist/lib/services/template-engine.registry.js.map +1 -1
  73. package/dist/lib/services/template-layout.service.d.ts +1 -3
  74. package/dist/lib/services/template-layout.service.js +80 -152
  75. package/dist/lib/services/template-layout.service.js.map +1 -1
  76. package/dist/lib/services/template.service.d.ts +1 -3
  77. package/dist/lib/services/template.service.js +107 -209
  78. package/dist/lib/services/template.service.js.map +1 -1
  79. package/dist/tsconfig.build.tsbuildinfo +1 -1
  80. package/package.json +17 -20
package/dist/lib/dto/create-template-layout.dto.js CHANGED
@@ -29,72 +29,109 @@ class CreateTemplateLayoutDto {
29
29
  }
30
30
  exports.CreateTemplateLayoutDto = CreateTemplateLayoutDto;
31
31
  __decorate([
32
- (0, swagger_1.ApiProperty)({ type: String }),
32
+ (0, swagger_1.ApiProperty)({
33
+ type: String,
34
+ example: 'email-shell',
35
+ description: 'Stable identifier you reference by (lowercase letters, numbers, "-" and "_").',
36
+ }),
33
37
  (0, class_validator_1.IsString)(),
34
38
  (0, class_validator_1.IsNotEmpty)(),
35
39
  (0, class_validator_1.Matches)(/^[a-z0-9\-_]+$/, { message: 'Invalid template name format' }),
36
40
  __metadata("design:type", String)
37
41
  ], CreateTemplateLayoutDto.prototype, "name", void 0);
38
42
  __decorate([
39
- (0, swagger_1.ApiProperty)({ type: String }),
43
+ (0, swagger_1.ApiProperty)({ type: String, description: 'Free category for grouping/filtering.' }),
40
44
  (0, class_validator_1.IsString)(),
41
45
  (0, class_validator_1.IsOptional)(),
42
46
  __metadata("design:type", String)
43
47
  ], CreateTemplateLayoutDto.prototype, "type", void 0);
44
48
  __decorate([
45
- (0, swagger_1.ApiPropertyOptional)({ type: String }),
49
+ (0, swagger_1.ApiPropertyOptional)({ type: String, description: 'Human-friendly label for admin UIs.' }),
46
50
  (0, class_validator_1.IsString)(),
47
51
  (0, class_validator_1.IsNotEmpty)(),
48
52
  __metadata("design:type", String)
49
53
  ], CreateTemplateLayoutDto.prototype, "displayName", void 0);
50
54
  __decorate([
51
- (0, swagger_1.ApiProperty)({ type: String, nullable: true }),
55
+ (0, swagger_1.ApiProperty)({ type: String, nullable: true, description: 'Free-text notes about what this layout is for.' }),
52
56
  (0, class_validator_1.IsString)(),
53
57
  (0, class_validator_1.IsOptional)(),
54
58
  __metadata("design:type", String)
55
59
  ], CreateTemplateLayoutDto.prototype, "description", void 0);
56
60
  __decorate([
57
- (0, swagger_1.ApiProperty)({ enum: template_types_1.TemplateEngineEnum, type: String }),
61
+ (0, swagger_1.ApiProperty)({
62
+ enum: template_types_1.TemplateEngineEnum,
63
+ type: String,
64
+ description: 'Template engine that interpolates variables: njk (Nunjucks), hbs, ejs, pug.',
65
+ }),
58
66
  (0, class_validator_1.IsEnum)(template_types_1.TemplateEngineEnum),
59
67
  (0, class_validator_1.IsOptional)(),
60
68
  __metadata("design:type", String)
61
69
  ], CreateTemplateLayoutDto.prototype, "engine", void 0);
62
70
  __decorate([
63
- (0, swagger_1.ApiProperty)({ enum: template_types_1.TemplateLanguageEnum, type: String }),
71
+ (0, swagger_1.ApiProperty)({
72
+ enum: template_types_1.TemplateLanguageEnum,
73
+ type: String,
74
+ description: 'Output processor applied after interpolation: html, mjml, md, txt.',
75
+ }),
64
76
  (0, class_validator_1.IsEnum)(template_types_1.TemplateLanguageEnum),
65
77
  (0, class_validator_1.IsNotEmpty)(),
66
78
  __metadata("design:type", String)
67
79
  ], CreateTemplateLayoutDto.prototype, "language", void 0);
68
80
  __decorate([
69
- (0, swagger_1.ApiProperty)({ type: String, nullable: true }),
81
+ (0, swagger_1.ApiProperty)({
82
+ type: String,
83
+ nullable: true,
84
+ example: '<html><body>{{ content }}</body></html>',
85
+ description: 'The layout body. Use {{ content }} where the wrapped template should be injected.',
86
+ }),
70
87
  (0, class_validator_1.IsString)(),
71
88
  __metadata("design:type", String)
72
89
  ], CreateTemplateLayoutDto.prototype, "content", void 0);
73
90
  __decorate([
74
- (0, swagger_1.ApiPropertyOptional)({ type: String, default: 'system' }),
91
+ (0, swagger_1.ApiPropertyOptional)({
92
+ type: String,
93
+ default: 'system',
94
+ description: 'Who owns this version: "system" (shared default) or a custom owner kind like "tenant"/"user".',
95
+ }),
75
96
  (0, class_validator_1.IsString)(),
76
97
  (0, class_validator_1.IsOptional)(),
77
98
  __metadata("design:type", String)
78
99
  ], CreateTemplateLayoutDto.prototype, "scope", void 0);
79
100
  __decorate([
80
- (0, swagger_1.ApiPropertyOptional)({ type: String }),
101
+ (0, swagger_1.ApiPropertyOptional)({
102
+ type: String,
103
+ description: 'Which owner inside the scope (e.g. the tenant id). Leave empty for system layouts.',
104
+ }),
81
105
  (0, class_validator_1.IsString)(),
82
106
  (0, class_validator_1.IsOptional)(),
83
107
  __metadata("design:type", String)
84
108
  ], CreateTemplateLayoutDto.prototype, "scopeId", void 0);
85
109
  __decorate([
86
- (0, swagger_1.ApiPropertyOptional)({ type: String, nullable: true, default: 'en' }),
110
+ (0, swagger_1.ApiPropertyOptional)({
111
+ type: String,
112
+ nullable: true,
113
+ default: 'en',
114
+ description: 'Language variant, e.g. en, fr, es. Missing locales fall back to "en".',
115
+ }),
87
116
  (0, class_validator_1.IsString)(),
88
117
  (0, class_validator_1.IsOptional)(),
89
118
  __metadata("design:type", String)
90
119
  ], CreateTemplateLayoutDto.prototype, "locale", void 0);
91
120
  __decorate([
92
- (0, swagger_1.ApiPropertyOptional)({ type: Object, nullable: true }),
121
+ (0, swagger_1.ApiPropertyOptional)({
122
+ type: Object,
123
+ nullable: true,
124
+ description: 'Sample data used to preview the layout (not applied during render).',
125
+ }),
93
126
  (0, class_validator_1.IsOptional)(),
94
127
  __metadata("design:type", Object)
95
128
  ], CreateTemplateLayoutDto.prototype, "previewContext", void 0);
96
129
  __decorate([
97
- (0, swagger_1.ApiPropertyOptional)({ type: Boolean, nullable: true }),
130
+ (0, swagger_1.ApiPropertyOptional)({
131
+ type: Boolean,
132
+ nullable: true,
133
+ description: 'Set false to disable without deleting.',
134
+ }),
98
135
  (0, class_validator_1.IsOptional)(),
99
136
  __metadata("design:type", Boolean)
100
137
  ], CreateTemplateLayoutDto.prototype, "isActive", void 0);
package/dist/lib/dto/create-template-layout.dto.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"create-template-layout.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/create-template-layout.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAoF;AACpF,iEAAwF;AACxF,6CAAmE;AAGnE,MAAa,uBAAuB;IAMhC,IAAI,CAAS;IAKb,IAAI,CAAU;IAKd,WAAW,CAAS;IAKpB,WAAW,CAAU;IAKrB,MAAM,GAAuB,mCAAkB,CAAC,QAAQ,CAAC;IAKzD,QAAQ,CAAuB;IAI/B,OAAO,CAAS;IAKhB,KAAK,GAAW,QAAQ,CAAC;IAKzB,OAAO,CAAU;IAKjB,MAAM,GAAY,IAAI,CAAC;IAIvB,cAAc,CAAuB;IAIrC,QAAQ,GAAa,IAAI,CAAC;CAC7B;AA3DD,0DA2DC;AArDG;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;qDAC1D;AAKb;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qDACC;AAKd;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACO;AAKpB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC7C,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACQ;AAKrB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,mCAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACvD,IAAA,wBAAM,EAAC,mCAAkB,CAAC;IAC1B,IAAA,4BAAU,GAAE;;uDAC4C;AAKzD;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,qCAAoB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzD,IAAA,wBAAM,EAAC,qCAAoB,CAAC;IAC5B,IAAA,4BAAU,GAAE;;yDACkB;AAI/B;IAFC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC7C,IAAA,0BAAQ,GAAE;;wDACK;AAKhB;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IACxD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACY;AAKzB;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;wDACI;AAKjB;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACpE,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;uDACU;AAIvB;IAFC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrD,IAAA,4BAAU,GAAE;;+DACwB;AAIrC;IAFC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACtD,IAAA,4BAAU,GAAE;;yDACa"}
1
+ {"version":3,"file":"create-template-layout.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/create-template-layout.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAoF;AACpF,iEAAwF;AACxF,6CAAmE;AAGnE,MAAa,uBAAuB;IAUhC,IAAI,CAAS;IAKb,IAAI,CAAU;IAKd,WAAW,CAAS;IAKpB,WAAW,CAAU;IASrB,MAAM,GAAuB,mCAAkB,CAAC,QAAQ,CAAC;IASzD,QAAQ,CAAuB;IAS/B,OAAO,CAAS;IAUhB,KAAK,GAAW,QAAQ,CAAC;IAQzB,OAAO,CAAU;IAUjB,MAAM,GAAY,IAAI,CAAC;IAQvB,cAAc,CAAuB;IAQrC,QAAQ,GAAa,IAAI,CAAC;CAC7B;AAjGD,0DAiGC;AAvFG;IARC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,aAAa;QACtB,WAAW,EAAE,+EAA+E;KAC/F,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;qDAC1D;AAKb;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,uCAAuC,EAAE,CAAC;IACnF,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qDACC;AAKd;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,qCAAqC,EAAE,CAAC;IACzF,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACO;AAKpB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,gDAAgD,EAAE,CAAC;IAC5G,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACQ;AASrB;IAPC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,mCAAkB;QACxB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,6EAA6E;KAC7F,CAAC;IACD,IAAA,wBAAM,EAAC,mCAAkB,CAAC;IAC1B,IAAA,4BAAU,GAAE;;uDAC4C;AASzD;IAPC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,qCAAoB;QAC1B,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,oEAAoE;KACpF,CAAC;IACD,IAAA,wBAAM,EAAC,qCAAoB,CAAC;IAC5B,IAAA,4BAAU,GAAE;;yDACkB;AAS/B;IAPC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,yCAAyC;QAClD,WAAW,EAAE,mFAAmF;KACnG,CAAC;IACD,IAAA,0BAAQ,GAAE;;wDACK;AAUhB;IARC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,QAAQ;QACjB,WAAW,EACP,+FAA+F;KACtG,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACY;AAQzB;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,oFAAoF;KACpG,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;wDACI;AAUjB;IARC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uEAAuE;KACvF,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;uDACU;AAQvB;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,qEAAqE;KACrF,CAAC;IACD,IAAA,4BAAU,GAAE;;+DACwB;AAQrC;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,wCAAwC;KACxD,CAAC;IACD,IAAA,4BAAU,GAAE;;yDACa"}
package/dist/lib/dto/create-template.dto.js CHANGED
@@ -32,74 +32,111 @@ class CreateTemplateDto {
32
32
  }
33
33
  exports.CreateTemplateDto = CreateTemplateDto;
34
34
  __decorate([
35
- (0, swagger_1.ApiProperty)({ type: String }),
35
+ (0, swagger_1.ApiProperty)({
36
+ type: String,
37
+ example: 'welcome-email',
38
+ description: 'Stable identifier you render by (lowercase letters, numbers, "-" and "_"). Stays the same across scopes and locales.',
39
+ }),
36
40
  (0, class_validator_1.IsString)(),
37
41
  (0, class_validator_1.IsNotEmpty)(),
38
42
  (0, class_validator_1.Matches)(/^[a-z0-9\-_]+$/, { message: 'Invalid template name format' }),
39
43
  __metadata("design:type", String)
40
44
  ], CreateTemplateDto.prototype, "name", void 0);
41
45
  __decorate([
42
- (0, swagger_1.ApiPropertyOptional)({ type: String, nullable: true }),
46
+ (0, swagger_1.ApiPropertyOptional)({ type: String, nullable: true, description: 'Name of a layout to wrap this content in.' }),
43
47
  (0, class_validator_1.IsString)(),
44
48
  (0, class_validator_1.IsOptional)(),
45
49
  __metadata("design:type", String)
46
50
  ], CreateTemplateDto.prototype, "templateLayoutName", void 0);
47
51
  __decorate([
48
- (0, swagger_1.ApiProperty)({ type: String }),
52
+ (0, swagger_1.ApiProperty)({
53
+ type: String,
54
+ example: 'email',
55
+ description: 'Free category for grouping/filtering, e.g. email, sms, push, pdf.',
56
+ }),
49
57
  (0, class_validator_1.IsString)(),
50
58
  (0, class_validator_1.IsOptional)(),
51
59
  __metadata("design:type", String)
52
60
  ], CreateTemplateDto.prototype, "type", void 0);
53
61
  __decorate([
54
- (0, swagger_1.ApiPropertyOptional)({ type: String }),
62
+ (0, swagger_1.ApiPropertyOptional)({ type: String, description: 'Human-friendly label for admin UIs, e.g. "Welcome email".' }),
55
63
  (0, class_validator_1.IsString)(),
56
64
  (0, class_validator_1.IsNotEmpty)(),
57
65
  __metadata("design:type", String)
58
66
  ], CreateTemplateDto.prototype, "displayName", void 0);
59
67
  __decorate([
60
- (0, swagger_1.ApiProperty)({ type: String, nullable: true }),
68
+ (0, swagger_1.ApiProperty)({ type: String, nullable: true, description: 'Free-text notes about what this template is for.' }),
61
69
  (0, class_validator_1.IsString)(),
62
70
  (0, class_validator_1.IsOptional)(),
63
71
  __metadata("design:type", String)
64
72
  ], CreateTemplateDto.prototype, "description", void 0);
65
73
  __decorate([
66
- (0, swagger_1.ApiProperty)({ enum: template_types_1.TemplateEngineEnum, type: String }),
74
+ (0, swagger_1.ApiProperty)({
75
+ enum: template_types_1.TemplateEngineEnum,
76
+ type: String,
77
+ description: 'Template engine that interpolates variables: njk (Nunjucks), hbs, ejs, pug.',
78
+ }),
67
79
  (0, class_validator_1.IsEnum)(template_types_1.TemplateEngineEnum),
68
80
  (0, class_validator_1.IsOptional)(),
69
81
  __metadata("design:type", String)
70
82
  ], CreateTemplateDto.prototype, "engine", void 0);
71
83
  __decorate([
72
- (0, swagger_1.ApiProperty)({ enum: template_types_1.TemplateLanguageEnum, type: String }),
84
+ (0, swagger_1.ApiProperty)({
85
+ enum: template_types_1.TemplateLanguageEnum,
86
+ type: String,
87
+ description: 'Output processor applied after interpolation: html, mjml, md, txt.',
88
+ }),
73
89
  (0, class_validator_1.IsEnum)(template_types_1.TemplateLanguageEnum),
74
90
  __metadata("design:type", String)
75
91
  ], CreateTemplateDto.prototype, "language", void 0);
76
92
  __decorate([
77
- (0, swagger_1.ApiProperty)({ type: String, nullable: true }),
93
+ (0, swagger_1.ApiProperty)({
94
+ type: String,
95
+ nullable: true,
96
+ example: '<h1>Hello {{ firstName }}</h1>',
97
+ description: "The template body, written in the chosen engine's syntax.",
98
+ }),
78
99
  (0, class_validator_1.IsString)(),
79
100
  (0, class_validator_1.IsOptional)(),
80
101
  __metadata("design:type", String)
81
102
  ], CreateTemplateDto.prototype, "content", void 0);
82
103
  __decorate([
83
- (0, swagger_1.ApiPropertyOptional)({ type: String, nullable: true }),
104
+ (0, swagger_1.ApiPropertyOptional)({
105
+ type: String,
106
+ nullable: true,
107
+ description: 'Optional subject line (emails). Rendered with the engine, so it can use variables.',
108
+ }),
84
109
  (0, class_validator_1.IsString)(),
85
110
  (0, class_validator_1.IsOptional)(),
86
111
  __metadata("design:type", String)
87
112
  ], CreateTemplateDto.prototype, "subject", void 0);
88
113
  __decorate([
89
- (0, swagger_1.ApiPropertyOptional)({ type: String, default: 'system' }),
114
+ (0, swagger_1.ApiPropertyOptional)({
115
+ type: String,
116
+ default: 'system',
117
+ description: 'Who owns this version: "system" (shared default) or a custom owner kind like "tenant"/"user". Note: createTemplate only creates system templates.',
118
+ }),
90
119
  (0, class_validator_1.IsString)(),
91
120
  (0, class_validator_1.IsOptional)(),
92
121
  (0, class_transformer_1.Transform)(({ value }) => value || 'system'),
93
122
  __metadata("design:type", String)
94
123
  ], CreateTemplateDto.prototype, "scope", void 0);
95
124
  __decorate([
96
- (0, swagger_1.ApiPropertyOptional)({ type: String }),
125
+ (0, swagger_1.ApiPropertyOptional)({
126
+ type: String,
127
+ description: 'Which owner inside the scope (e.g. the tenant id). Leave empty for system templates.',
128
+ }),
97
129
  (0, class_validator_1.IsString)(),
98
130
  (0, class_validator_1.IsOptional)(),
99
131
  __metadata("design:type", String)
100
132
  ], CreateTemplateDto.prototype, "scopeId", void 0);
101
133
  __decorate([
102
- (0, swagger_1.ApiPropertyOptional)({ type: String, nullable: true, default: 'en' }),
134
+ (0, swagger_1.ApiPropertyOptional)({
135
+ type: String,
136
+ nullable: true,
137
+ default: 'en',
138
+ description: 'Language variant, e.g. en, fr, es. Missing locales fall back to "en".',
139
+ }),
103
140
  (0, class_validator_1.IsString)(),
104
141
  (0, class_validator_1.IsOptional)(),
105
142
  (0, class_validator_1.IsNotEmpty)(),
@@ -107,12 +144,20 @@ __decorate([
107
144
  __metadata("design:type", String)
108
145
  ], CreateTemplateDto.prototype, "locale", void 0);
109
146
  __decorate([
110
- (0, swagger_1.ApiPropertyOptional)({ type: Object, nullable: true }),
147
+ (0, swagger_1.ApiPropertyOptional)({
148
+ type: Object,
149
+ nullable: true,
150
+ description: 'Sample data used to preview the template (not applied during render).',
151
+ }),
111
152
  (0, class_validator_1.IsOptional)(),
112
153
  __metadata("design:type", Object)
113
154
  ], CreateTemplateDto.prototype, "previewContext", void 0);
114
155
  __decorate([
115
- (0, swagger_1.ApiPropertyOptional)({ type: Boolean, nullable: true }),
156
+ (0, swagger_1.ApiPropertyOptional)({
157
+ type: Boolean,
158
+ nullable: true,
159
+ description: 'Set false to disable without deleting; inactive templates are skipped during resolution.',
160
+ }),
116
161
  (0, class_validator_1.IsBoolean)(),
117
162
  (0, class_validator_1.IsOptional)(),
118
163
  __metadata("design:type", Boolean)
package/dist/lib/dto/create-template.dto.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"create-template.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/create-template.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+F;AAC/F,iEAA0G;AAC1G,6CAAmE;AACnE,yDAA8C;AAE9C,MAAa,iBAAiB;IAM1B,IAAI,CAAS;IAKb,kBAAkB,CAAU;IAK5B,IAAI,CAAU;IAKd,WAAW,CAAS;IAKpB,WAAW,CAAU;IAKrB,MAAM,GAAuB,mCAAkB,CAAC,QAAQ,CAAC;IAIzD,QAAQ,CAAuB;IAK/B,OAAO,CAAS;IAKhB,OAAO,CAAU;IAMjB,KAAK,GAAW,QAAQ,CAAC;IAKzB,OAAO,CAAU;IAOjB,MAAM,GAAY,IAAI,CAAC;IAIvB,cAAc,CAAuB;IAKrC,QAAQ,GAAa,IAAI,CAAC;CAE7B;AA1ED,8CA0EC;AApEG;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;+CAC1D;AAKb;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;6DACe;AAK5B;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;+CACC;AAKd;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACO;AAKpB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC7C,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACQ;AAKrB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,mCAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACvD,IAAA,wBAAM,EAAC,mCAAkB,CAAC;IAC1B,IAAA,4BAAU,GAAE;;iDAC4C;AAIzD;IAFC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,qCAAoB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzD,IAAA,wBAAM,EAAC,qCAAoB,CAAC;;mDACE;AAK/B;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC7C,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACG;AAKhB;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AAMjB;IAJC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IACxD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,IAAI,QAAQ,CAAC;;gDACnB;AAKzB;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AAOjB;IALC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACpE,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC;;iDACjB;AAIvB;IAFC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrD,IAAA,4BAAU,GAAE;;yDACwB;AAKrC;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACtD,IAAA,2BAAS,GAAE;IACX,IAAA,4BAAU,GAAE;;mDACa"}
1
+ {"version":3,"file":"create-template.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/create-template.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+F;AAC/F,iEAAwF;AACxF,6CAAmE;AACnE,yDAA8C;AAE9C,MAAa,iBAAiB;IAW1B,IAAI,CAAS;IAKb,kBAAkB,CAAU;IAS5B,IAAI,CAAU;IAKd,WAAW,CAAS;IAKpB,WAAW,CAAU;IASrB,MAAM,GAAuB,mCAAkB,CAAC,QAAQ,CAAC;IAQzD,QAAQ,CAAuB;IAU/B,OAAO,CAAS;IAShB,OAAO,CAAU;IAWjB,KAAK,GAAW,QAAQ,CAAC;IAQzB,OAAO,CAAU;IAYjB,MAAM,GAAY,IAAI,CAAC;IAQvB,cAAc,CAAuB;IASrC,QAAQ,GAAa,IAAI,CAAC;CAE7B;AAzHD,8CAyHC;AA9GG;IATC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,eAAe;QACxB,WAAW,EACP,sHAAsH;KAC7H,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,yBAAO,EAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;;+CAC1D;AAKb;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,2CAA2C,EAAE,CAAC;IAC/G,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;6DACe;AAS5B;IAPC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,OAAO;QAChB,WAAW,EAAE,mEAAmE;KACnF,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;+CACC;AAKd;IAHC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,2DAA2D,EAAE,CAAC;IAC/G,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACO;AAKpB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,kDAAkD,EAAE,CAAC;IAC9G,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;sDACQ;AASrB;IAPC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,mCAAkB;QACxB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,6EAA6E;KAC7F,CAAC;IACD,IAAA,wBAAM,EAAC,mCAAkB,CAAC;IAC1B,IAAA,4BAAU,GAAE;;iDAC4C;AAQzD;IANC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,qCAAoB;QAC1B,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,oEAAoE;KACpF,CAAC;IACD,IAAA,wBAAM,EAAC,qCAAoB,CAAC;;mDACE;AAU/B;IARC,IAAA,qBAAW,EAAC;QACT,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,gCAAgC;QACzC,WAAW,EAAE,2DAA2D;KAC3E,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACG;AAShB;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,oFAAoF;KACpG,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AAWjB;IATC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,QAAQ;QACjB,WAAW,EACP,mJAAmJ;KAC1J,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,IAAI,QAAQ,CAAC;;gDACnB;AAQzB;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,sFAAsF;KACtG,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AAYjB;IAVC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uEAAuE;KACvF,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC;;iDACjB;AAQvB;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,uEAAuE;KACvF,CAAC;IACD,IAAA,4BAAU,GAAE;;yDACwB;AASrC;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,0FAA0F;KAC1G,CAAC;IACD,IAAA,2BAAS,GAAE;IACX,IAAA,4BAAU,GAAE;;mDACa"}
package/dist/lib/dto/render-template.dto.d.ts CHANGED
@@ -1,14 +1,11 @@
1
- import { TemplateLanguageEnum } from '../interfaces/template.types';
2
1
  export declare class RenderTemplateDto {
3
- locale?: string;
4
- name?: string;
5
- content?: string;
6
- language?: TemplateLanguageEnum;
2
+ name: string;
7
3
  scope?: string;
8
4
  scopeId?: string;
5
+ locale?: string;
9
6
  context?: Record<string, any>;
10
7
  }
11
8
  export declare class RenderTemplateOutputDTO {
12
9
  content: string;
13
- subject: string;
10
+ subject: string | null;
14
11
  }
package/dist/lib/dto/render-template.dto.js CHANGED
@@ -11,54 +11,26 @@ var __metadata = (this && this.__metadata) || function (k, v) {
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.RenderTemplateOutputDTO = exports.RenderTemplateDto = void 0;
13
13
  const class_validator_1 = require("class-validator");
14
- const template_types_1 = require("../interfaces/template.types");
15
14
  const swagger_1 = require("@nestjs/swagger");
16
15
  class RenderTemplateDto {
17
- locale = 'en';
18
16
  name;
19
- content;
20
- language;
21
17
  scope = 'system';
22
18
  scopeId;
19
+ locale = 'en';
23
20
  context;
24
21
  }
25
22
  exports.RenderTemplateDto = RenderTemplateDto;
26
23
  __decorate([
27
- (0, swagger_1.ApiPropertyOptional)({
28
- type: String,
29
- default: 'en',
30
- description: 'The locale code, i.e en, fr, es, etc.'
31
- }),
32
- (0, class_validator_1.IsString)(),
33
- (0, class_validator_1.IsOptional)(),
34
- __metadata("design:type", String)
35
- ], RenderTemplateDto.prototype, "locale", void 0);
36
- __decorate([
37
- (0, swagger_1.ApiProperty)({ type: String }),
24
+ (0, swagger_1.ApiProperty)({ type: String, description: 'Name of the stored template to render.' }),
38
25
  (0, class_validator_1.IsString)(),
39
26
  (0, class_validator_1.IsNotEmpty)(),
40
- (0, class_validator_1.ValidateIf)((object, value) => !object?.content),
41
27
  __metadata("design:type", String)
42
28
  ], RenderTemplateDto.prototype, "name", void 0);
43
- __decorate([
44
- (0, swagger_1.ApiProperty)({ type: String }),
45
- (0, class_validator_1.IsString)(),
46
- (0, class_validator_1.IsNotEmpty)(),
47
- (0, class_validator_1.ValidateIf)((object, value) => !object?.name),
48
- __metadata("design:type", String)
49
- ], RenderTemplateDto.prototype, "content", void 0);
50
- __decorate([
51
- (0, swagger_1.ApiProperty)({ enum: template_types_1.TemplateLanguageEnum, type: String }),
52
- (0, class_validator_1.IsEnum)(template_types_1.TemplateLanguageEnum),
53
- (0, class_validator_1.IsNotEmpty)(),
54
- (0, class_validator_1.ValidateIf)((object, value) => !object?.name),
55
- __metadata("design:type", String)
56
- ], RenderTemplateDto.prototype, "language", void 0);
57
29
  __decorate([
58
30
  (0, swagger_1.ApiPropertyOptional)({
59
31
  type: String,
60
32
  default: 'system',
61
- description: 'The scope of the template, i.e user, organization, etc.'
33
+ description: 'Who owns the version to resolve: "system" (default) or a custom owner kind like "tenant"/"user". Falls back to "system" if no override exists.',
62
34
  }),
63
35
  (0, class_validator_1.IsString)(),
64
36
  (0, class_validator_1.IsOptional)(),
@@ -67,8 +39,7 @@ __decorate([
67
39
  __decorate([
68
40
  (0, swagger_1.ApiPropertyOptional)({
69
41
  type: String,
70
- default: null,
71
- description: 'The scope id of the template, i.e user id, organization id, etc.'
42
+ description: 'Which owner inside the scope (e.g. the tenant/user id).',
72
43
  }),
73
44
  (0, class_validator_1.IsString)(),
74
45
  (0, class_validator_1.IsOptional)(),
@@ -77,8 +48,17 @@ __decorate([
77
48
  __decorate([
78
49
  (0, swagger_1.ApiPropertyOptional)({
79
50
  type: String,
80
- nullable: true,
81
- description: 'The context of the template'
51
+ default: 'en',
52
+ description: 'Locale code, e.g. en, fr, es. Falls back to "en".',
53
+ }),
54
+ (0, class_validator_1.IsString)(),
55
+ (0, class_validator_1.IsOptional)(),
56
+ __metadata("design:type", String)
57
+ ], RenderTemplateDto.prototype, "locale", void 0);
58
+ __decorate([
59
+ (0, swagger_1.ApiPropertyOptional)({
60
+ type: Object,
61
+ description: 'Data passed to the template (the render context).',
82
62
  }),
83
63
  (0, class_validator_1.IsObject)(),
84
64
  (0, class_validator_1.IsOptional)(),
@@ -92,13 +72,12 @@ exports.RenderTemplateOutputDTO = RenderTemplateOutputDTO;
92
72
  __decorate([
93
73
  (0, swagger_1.ApiProperty)({ type: String }),
94
74
  (0, class_validator_1.IsString)(),
95
- (0, class_validator_1.IsNotEmpty)(),
96
75
  __metadata("design:type", String)
97
76
  ], RenderTemplateOutputDTO.prototype, "content", void 0);
98
77
  __decorate([
99
- (0, swagger_1.ApiProperty)({ type: String }),
78
+ (0, swagger_1.ApiProperty)({ type: String, nullable: true, description: 'Rendered subject, or null if the template has none.' }),
79
+ (0, class_validator_1.IsOptional)(),
100
80
  (0, class_validator_1.IsString)(),
101
- (0, class_validator_1.IsNotEmpty)(),
102
81
  __metadata("design:type", String)
103
82
  ], RenderTemplateOutputDTO.prototype, "subject", void 0);
104
83
  //# sourceMappingURL=render-template.dto.js.map
package/dist/lib/dto/render-template.dto.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"render-template.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/render-template.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA0G;AAC1G,iEAAsF;AACtF,6CAAmE;AAGnE,MAAa,iBAAiB;IAS1B,MAAM,GAAY,IAAI,CAAC;IAMvB,IAAI,CAAU;IAMd,OAAO,CAAU;IAMjB,QAAQ,CAAwB;IAShC,KAAK,GAAY,QAAQ,CAAC;IAS1B,OAAO,CAAU;IASjB,OAAO,CAAuB;CACjC;AAvDD,8CAuDC;AA9CG;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uCAAuC;KACvD,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACU;AAMvB;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,EAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC;;+CAClC;AAMd;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,EAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC;;kDAC5B;AAMjB;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,qCAAoB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzD,IAAA,wBAAM,EAAC,qCAAoB,CAAC;IAC5B,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,EAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC;;mDACb;AAShC;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,QAAQ;QACjB,WAAW,EAAE,yDAAyD;KACzE,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gDACa;AAS1B;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,kEAAkE;KAClF,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AASjB;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,6BAA6B;KAC7C,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACiB;AAIlC,MAAa,uBAAuB;IAIhC,OAAO,CAAS;IAKhB,OAAO,CAAS;CACnB;AAVD,0DAUC;AANG;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;wDACG;AAKhB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;wDACG"}
1
+ {"version":3,"file":"render-template.dto.js","sourceRoot":"","sources":["../../../src/lib/dto/render-template.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA6E;AAC7E,6CAAmE;AAMnE,MAAa,iBAAiB;IAI1B,IAAI,CAAS;IAUb,KAAK,GAAY,QAAQ,CAAC;IAQ1B,OAAO,CAAU;IASjB,MAAM,GAAY,IAAI,CAAC;IAQvB,OAAO,CAAuB;CACjC;AAxCD,8CAwCC;AApCG;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,wCAAwC,EAAE,CAAC;IACpF,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;+CACA;AAUb;IARC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,QAAQ;QACjB,WAAW,EACP,gJAAgJ;KACvJ,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gDACa;AAQ1B;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,yDAAyD;KACzE,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACI;AASjB;IAPC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,mDAAmD;KACnE,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACU;AAQvB;IANC,IAAA,6BAAmB,EAAC;QACjB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,mDAAmD;KACnE,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kDACiB;AAGlC,MAAa,uBAAuB;IAGhC,OAAO,CAAS;IAKhB,OAAO,CAAgB;CAC1B;AATD,0DASC;AANG;IAFC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7B,IAAA,0BAAQ,GAAE;;wDACK;AAKhB;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,qDAAqD,EAAE,CAAC;IACjH,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;wDACY"}
package/dist/lib/engines/language/html.engine.d.ts CHANGED
@@ -2,8 +2,7 @@ import { TemplateLanguageEnum } from '../../interfaces/template.types';
2
2
  import { LanguageEngine } from '../language-engine';
3
3
  export declare class HtmlEngine extends LanguageEngine {
4
4
  static engineName: TemplateLanguageEnum;
5
- private options;
6
- constructor(options?: any);
5
+ static displayName: string;
7
6
  render(content: string): Promise<string>;
8
- validate(content: string): Promise<boolean>;
7
+ validate(): Promise<boolean>;
9
8
  }
package/dist/lib/engines/language/html.engine.js CHANGED
@@ -5,42 +5,12 @@ const template_types_1 = require("../../interfaces/template.types");
5
5
  const language_engine_1 = require("../language-engine");
6
6
  class HtmlEngine extends language_engine_1.LanguageEngine {
7
7
  static engineName = template_types_1.TemplateLanguageEnum.HTML;
8
- options;
9
- constructor(options) {
10
- super();
11
- this.options = options;
12
- }
8
+ static displayName = 'HTML';
13
9
  async render(content) {
14
- try {
15
- const isValid = await this.validate(content);
16
- if (!isValid) {
17
- throw new Error('Invalid HTML content');
18
- }
19
- return content;
20
- }
21
- catch (error) {
22
- throw new Error(`Failed to render HTML: ${error?.message || 'Unknown error'}`);
23
- }
10
+ return content;
24
11
  }
25
- async validate(content) {
26
- try {
27
- const { Parser } = await import('htmlparser2');
28
- return new Promise((resolve) => {
29
- const parser = new Parser({
30
- onerror: () => {
31
- resolve(false);
32
- },
33
- onend: () => {
34
- resolve(true);
35
- }
36
- }, this.options);
37
- parser.write(content);
38
- parser.end();
39
- });
40
- }
41
- catch (error) {
42
- return false;
43
- }
12
+ async validate() {
13
+ return true;
44
14
  }
45
15
  }
46
16
  exports.HtmlEngine = HtmlEngine;
package/dist/lib/engines/language/html.engine.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"html.engine.js","sourceRoot":"","sources":["../../../../src/lib/engines/language/html.engine.ts"],"names":[],"mappings":";;;AAAA,oEAAuE;AACvE,wDAAoD;AAEpD,MAAa,UAAW,SAAQ,gCAAc;IAC1C,MAAM,CAAU,UAAU,GAAG,qCAAoB,CAAC,IAAI,CAAC;IAE/C,OAAO,CAAM;IAErB,YAAY,OAAa;QACrB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QACxB,IAAI,CAAC;YAGD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,OAAO,CAAC;QACnB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC,CAAC;QACnF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC1B,IAAI,CAAC;YACD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;YAE/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;oBACtB,OAAO,EAAE,GAAG,EAAE;wBACV,OAAO,CAAC,KAAK,CAAC,CAAC;oBACnB,CAAC;oBACD,KAAK,EAAE,GAAG,EAAE;wBACR,OAAO,CAAC,IAAI,CAAC,CAAC;oBAClB,CAAC;iBACJ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEjB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,EAAE,CAAC;YACjB,CAAC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;;AA5CL,gCA6CC"}
1
+ {"version":3,"file":"html.engine.js","sourceRoot":"","sources":["../../../../src/lib/engines/language/html.engine.ts"],"names":[],"mappings":";;;AAAA,oEAAuE;AACvE,wDAAoD;AAQpD,MAAa,UAAW,SAAQ,gCAAc;IAC1C,MAAM,CAAU,UAAU,GAAG,qCAAoB,CAAC,IAAI,CAAC;IACvD,MAAM,CAAU,WAAW,GAAG,MAAM,CAAC;IAErC,KAAK,CAAC,MAAM,CAAC,OAAe;QACxB,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,OAAO,IAAI,CAAC;IAChB,CAAC;;AAVL,gCAWC"}
package/dist/lib/engines/language/markdown.engine.d.ts CHANGED
@@ -1,9 +1,11 @@
1
1
  import { TemplateLanguageEnum } from '../../interfaces/template.types';
2
2
  import { LanguageEngine } from '../language-engine';
3
3
  export declare class MarkdownEngine extends LanguageEngine {
4
+ private readonly options;
4
5
  static engineName: TemplateLanguageEnum;
5
- private options;
6
- constructor(options?: any);
6
+ static displayName: string;
7
+ static peerPackage: string;
8
+ constructor(options?: Record<string, any>);
7
9
  render(content: string): Promise<string>;
8
10
  validate(content: string): Promise<boolean>;
9
11
  }
package/dist/lib/engines/language/markdown.engine.js CHANGED
@@ -1,35 +1,35 @@
1
1
  "use strict";
2
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
- return c > 3 && r && Object.defineProperty(target, key, r), r;
7
- };
8
- var __metadata = (this && this.__metadata) || function (k, v) {
9
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
- };
11
2
  Object.defineProperty(exports, "__esModule", { value: true });
12
3
  exports.MarkdownEngine = void 0;
13
- const common_1 = require("@nestjs/common");
14
4
  const template_types_1 = require("../../interfaces/template.types");
15
5
  const language_engine_1 = require("../language-engine");
16
- let MarkdownEngine = class MarkdownEngine extends language_engine_1.LanguageEngine {
17
- static engineName = template_types_1.TemplateLanguageEnum.MARKDOWN;
6
+ const load_peer_1 = require("../load-peer");
7
+ class MarkdownEngine extends language_engine_1.LanguageEngine {
18
8
  options;
19
- constructor(options) {
9
+ static engineName = template_types_1.TemplateLanguageEnum.MARKDOWN;
10
+ static displayName = 'Markdown';
11
+ static peerPackage = 'marked';
12
+ constructor(options = {}) {
20
13
  super();
21
14
  this.options = options;
22
15
  }
23
16
  async render(content) {
24
- return content;
17
+ const mod = await (0, load_peer_1.loadPeer)('marked', 'md', 'language');
18
+ const marked = mod.marked ?? mod.default ?? mod;
19
+ const out = typeof marked.parse === 'function'
20
+ ? marked.parse(content, this.options)
21
+ : marked(content, this.options);
22
+ return typeof out === 'string' ? out : await out;
25
23
  }
26
24
  async validate(content) {
27
- return true;
25
+ try {
26
+ await this.render(content);
27
+ return true;
28
+ }
29
+ catch {
30
+ return false;
31
+ }
28
32
  }
29
- };
33
+ }
30
34
  exports.MarkdownEngine = MarkdownEngine;
31
- exports.MarkdownEngine = MarkdownEngine = __decorate([
32
- (0, common_1.Injectable)(),
33
- __metadata("design:paramtypes", [Object])
34
- ], MarkdownEngine);
35
35
  //# sourceMappingURL=markdown.engine.js.map
package/dist/lib/engines/language/markdown.engine.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"markdown.engine.js","sourceRoot":"","sources":["../../../../src/lib/engines/language/markdown.engine.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,oEAAuE;AACvE,wDAAoD;AAG7C,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,gCAAc;IAC9C,MAAM,CAAU,UAAU,GAAG,qCAAoB,CAAC,QAAQ,CAAC;IAEnD,OAAO,CAAM;IAErB,YAAY,OAAa;QACrB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QAOxB,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAe;QAS1B,OAAO,IAAI,CAAC;IAChB,CAAC;;AA9BQ,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;;GACA,cAAc,CA+B1B"}
1
+ {"version":3,"file":"markdown.engine.js","sourceRoot":"","sources":["../../../../src/lib/engines/language/markdown.engine.ts"],"names":[],"mappings":";;;AAAA,oEAAuE;AACvE,wDAAoD;AACpD,4CAAwC;AAMxC,MAAa,cAAe,SAAQ,gCAAc;IAKjB;IAJ7B,MAAM,CAAU,UAAU,GAAG,qCAAoB,CAAC,QAAQ,CAAC;IAC3D,MAAM,CAAU,WAAW,GAAG,UAAU,CAAC;IACzC,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC;IAEvC,YAA6B,UAA+B,EAAE;QAC1D,KAAK,EAAE,CAAC;QADiB,YAAO,GAAP,OAAO,CAA0B;IAE9D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QACxB,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAQ,EAAM,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC;QAChD,MAAM,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU;YAC1C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;YACrC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC1B,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;;AAzBL,wCA0BC"}
package/dist/lib/engines/language/mjml.engine.d.ts CHANGED
@@ -1,9 +1,11 @@
1
1
  import { TemplateLanguageEnum } from '../../interfaces/template.types';
2
2
  import { LanguageEngine } from '../language-engine';
3
3
  export declare class MjmlEngine extends LanguageEngine {
4
- static engineName: TemplateLanguageEnum;
5
4
  private readonly options;
6
- constructor(options?: any);
5
+ static engineName: TemplateLanguageEnum;
6
+ static displayName: string;
7
+ static peerPackage: string;
8
+ constructor(options?: Record<string, any>);
7
9
  render(content: string): Promise<string>;
8
10
  validate(content: string): Promise<boolean>;
9
11
  }