@flusys/nestjs-email 7.1.0 → 8.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 (159) hide show
  1. package/config/index.d.ts +3 -3
  2. package/controllers/email-config.controller.d.ts +2 -2
  3. package/controllers/email-send.controller.d.ts +3 -3
  4. package/controllers/email-template.controller.d.ts +4 -4
  5. package/controllers/index.d.ts +3 -3
  6. package/docs/email-swagger.config.d.ts +2 -2
  7. package/docs/index.d.ts +1 -1
  8. package/dtos/email-config.dto.d.ts +1 -1
  9. package/dtos/email-send.dto.d.ts +1 -1
  10. package/dtos/index.d.ts +3 -3
  11. package/entities/email-config-with-company.entity.d.ts +1 -1
  12. package/entities/email-template-with-company.entity.d.ts +1 -1
  13. package/entities/index.d.ts +10 -10
  14. package/enums/index.d.ts +1 -1
  15. package/fesm/261.js +799 -0
  16. package/fesm/493.js +1723 -0
  17. package/fesm/chunks/99.js +12 -0
  18. package/fesm/config/index.js +104 -3
  19. package/fesm/controllers/index.js +396 -3
  20. package/fesm/docs/index.js +134 -1
  21. package/fesm/dtos/index.js +22 -3
  22. package/fesm/entities/index.js +409 -13
  23. package/fesm/enums/index.js +37 -1
  24. package/fesm/index.js +762 -10
  25. package/fesm/interfaces/index.js +18 -4
  26. package/fesm/modules/index.js +541 -1
  27. package/fesm/providers/index.js +523 -5
  28. package/fesm/runtime.js +134 -0
  29. package/fesm/services/index.js +17 -5
  30. package/index.d.ts +10 -10
  31. package/interfaces/email-config.interface.d.ts +2 -2
  32. package/interfaces/email-module-options.interface.d.ts +3 -3
  33. package/interfaces/email-template.interface.d.ts +1 -1
  34. package/interfaces/index.d.ts +4 -4
  35. package/modules/email.module.d.ts +2 -2
  36. package/modules/index.d.ts +1 -1
  37. package/package.json +27 -38
  38. package/providers/email-factory.service.d.ts +2 -2
  39. package/providers/email-provider.registry.d.ts +2 -2
  40. package/providers/index.d.ts +5 -5
  41. package/providers/mailgun-provider.d.ts +1 -1
  42. package/providers/sendgrid-provider.d.ts +1 -1
  43. package/providers/smtp-provider.d.ts +1 -1
  44. package/services/email-config.service.d.ts +3 -3
  45. package/services/email-datasource.provider.d.ts +3 -3
  46. package/services/email-provider-config.service.d.ts +7 -7
  47. package/services/email-send.service.d.ts +7 -7
  48. package/services/email-template.service.d.ts +6 -6
  49. package/services/index.d.ts +5 -5
  50. package/utils/index.d.ts +1 -1
  51. package/cjs/config/email.constants.js +0 -22
  52. package/cjs/config/event-actions.js +0 -34
  53. package/cjs/config/index.js +0 -20
  54. package/cjs/config/message-keys.js +0 -39
  55. package/cjs/controllers/email-config.controller.js +0 -111
  56. package/cjs/controllers/email-config.controller.spec.js +0 -85
  57. package/cjs/controllers/email-send.controller.js +0 -128
  58. package/cjs/controllers/email-send.controller.spec.js +0 -139
  59. package/cjs/controllers/email-template.controller.js +0 -142
  60. package/cjs/controllers/email-template.controller.spec.js +0 -89
  61. package/cjs/controllers/index.js +0 -20
  62. package/cjs/docs/email-swagger.config.js +0 -116
  63. package/cjs/docs/email-swagger.config.spec.js +0 -62
  64. package/cjs/docs/index.js +0 -11
  65. package/cjs/dtos/email-config.dto.js +0 -212
  66. package/cjs/dtos/email-send.dto.js +0 -354
  67. package/cjs/dtos/email-template.dto.js +0 -252
  68. package/cjs/dtos/index.js +0 -20
  69. package/cjs/entities/email-config-with-company.entity.js +0 -63
  70. package/cjs/entities/email-config.entity.js +0 -114
  71. package/cjs/entities/email-template-with-company.entity.js +0 -65
  72. package/cjs/entities/email-template.entity.js +0 -136
  73. package/cjs/entities/index.js +0 -56
  74. package/cjs/entities/index.spec.js +0 -18
  75. package/cjs/enums/email-provider-type.enum.js +0 -18
  76. package/cjs/enums/index.js +0 -18
  77. package/cjs/index.js +0 -28
  78. package/cjs/interfaces/email-config.interface.js +0 -4
  79. package/cjs/interfaces/email-module-options.interface.js +0 -4
  80. package/cjs/interfaces/email-provider.interface.js +0 -4
  81. package/cjs/interfaces/email-template.interface.js +0 -4
  82. package/cjs/interfaces/index.js +0 -21
  83. package/cjs/modules/email.module.js +0 -122
  84. package/cjs/modules/email.module.spec.js +0 -142
  85. package/cjs/modules/index.js +0 -18
  86. package/cjs/providers/email-factory.service.js +0 -113
  87. package/cjs/providers/email-factory.service.spec.js +0 -242
  88. package/cjs/providers/email-provider.registry.js +0 -41
  89. package/cjs/providers/email-provider.registry.spec.js +0 -58
  90. package/cjs/providers/index.js +0 -22
  91. package/cjs/providers/mailgun-provider.js +0 -119
  92. package/cjs/providers/mailgun-provider.spec.js +0 -244
  93. package/cjs/providers/sendgrid-provider.js +0 -129
  94. package/cjs/providers/sendgrid-provider.spec.js +0 -346
  95. package/cjs/providers/smtp-provider.js +0 -164
  96. package/cjs/providers/smtp-provider.spec.js +0 -327
  97. package/cjs/services/email-config.service.js +0 -71
  98. package/cjs/services/email-config.service.spec.js +0 -69
  99. package/cjs/services/email-datasource.provider.js +0 -84
  100. package/cjs/services/email-datasource.provider.spec.js +0 -135
  101. package/cjs/services/email-provider-config.service.js +0 -159
  102. package/cjs/services/email-provider-config.service.spec.js +0 -269
  103. package/cjs/services/email-send.service.js +0 -315
  104. package/cjs/services/email-send.service.spec.js +0 -614
  105. package/cjs/services/email-template.service.js +0 -144
  106. package/cjs/services/email-template.service.spec.js +0 -261
  107. package/cjs/services/index.js +0 -22
  108. package/cjs/utils/email-templates.util.js +0 -64
  109. package/cjs/utils/email-templates.util.spec.js +0 -61
  110. package/cjs/utils/index.js +0 -18
  111. package/fesm/config/email.constants.js +0 -4
  112. package/fesm/config/event-actions.js +0 -13
  113. package/fesm/config/message-keys.js +0 -18
  114. package/fesm/controllers/email-config.controller.js +0 -101
  115. package/fesm/controllers/email-config.controller.spec.js +0 -81
  116. package/fesm/controllers/email-send.controller.js +0 -118
  117. package/fesm/controllers/email-send.controller.spec.js +0 -135
  118. package/fesm/controllers/email-template.controller.js +0 -132
  119. package/fesm/controllers/email-template.controller.spec.js +0 -85
  120. package/fesm/docs/email-swagger.config.js +0 -109
  121. package/fesm/docs/email-swagger.config.spec.js +0 -58
  122. package/fesm/dtos/email-config.dto.js +0 -191
  123. package/fesm/dtos/email-send.dto.js +0 -324
  124. package/fesm/dtos/email-template.dto.js +0 -231
  125. package/fesm/entities/email-config-with-company.entity.js +0 -53
  126. package/fesm/entities/email-config.entity.js +0 -104
  127. package/fesm/entities/email-template-with-company.entity.js +0 -55
  128. package/fesm/entities/email-template.entity.js +0 -126
  129. package/fesm/entities/index.spec.js +0 -14
  130. package/fesm/enums/email-provider-type.enum.js +0 -8
  131. package/fesm/interfaces/email-config.interface.js +0 -1
  132. package/fesm/interfaces/email-module-options.interface.js +0 -1
  133. package/fesm/interfaces/email-provider.interface.js +0 -1
  134. package/fesm/interfaces/email-template.interface.js +0 -1
  135. package/fesm/modules/email.module.js +0 -112
  136. package/fesm/modules/email.module.spec.js +0 -138
  137. package/fesm/providers/email-factory.service.js +0 -103
  138. package/fesm/providers/email-factory.service.spec.js +0 -238
  139. package/fesm/providers/email-provider.registry.js +0 -31
  140. package/fesm/providers/email-provider.registry.spec.js +0 -54
  141. package/fesm/providers/mailgun-provider.js +0 -109
  142. package/fesm/providers/mailgun-provider.spec.js +0 -240
  143. package/fesm/providers/sendgrid-provider.js +0 -119
  144. package/fesm/providers/sendgrid-provider.spec.js +0 -342
  145. package/fesm/providers/smtp-provider.js +0 -113
  146. package/fesm/providers/smtp-provider.spec.js +0 -282
  147. package/fesm/services/email-config.service.js +0 -61
  148. package/fesm/services/email-config.service.spec.js +0 -65
  149. package/fesm/services/email-datasource.provider.js +0 -74
  150. package/fesm/services/email-datasource.provider.spec.js +0 -131
  151. package/fesm/services/email-provider-config.service.js +0 -149
  152. package/fesm/services/email-provider-config.service.spec.js +0 -265
  153. package/fesm/services/email-send.service.js +0 -305
  154. package/fesm/services/email-send.service.spec.js +0 -610
  155. package/fesm/services/email-template.service.js +0 -134
  156. package/fesm/services/email-template.service.spec.js +0 -257
  157. package/fesm/utils/email-templates.util.js +0 -47
  158. package/fesm/utils/email-templates.util.spec.js +0 -57
  159. package/fesm/utils/index.js +0 -1
@@ -1,112 +0,0 @@
1
- function _ts_decorate(decorators, target, key, desc) {
2
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
3
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
4
- 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;
5
- return c > 3 && r && Object.defineProperty(target, key, r), r;
6
- }
7
- import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
8
- import { Module } from '@nestjs/common';
9
- import { EMAIL_MODULE_OPTIONS } from '../config/email.constants';
10
- import { EmailConfigController, EmailSendController, EmailTemplateController } from '../controllers';
11
- import { EmailProviderTypeEnum } from '../enums';
12
- import { EmailFactoryService, EmailProviderRegistry, MailgunProvider, SendGridProvider, SmtpProvider } from '../providers';
13
- import { EmailConfigService, EmailDataSourceProvider, EmailProviderConfigService, EmailSendService, EmailTemplateService } from '../services';
14
- const CONTROLLERS = [
15
- EmailConfigController,
16
- EmailTemplateController,
17
- EmailSendController
18
- ];
19
- const EXPORTED_SERVICES = [
20
- EmailConfigService,
21
- EmailDataSourceProvider,
22
- EmailProviderConfigService,
23
- EmailTemplateService,
24
- EmailSendService,
25
- EmailFactoryService
26
- ];
27
- EmailProviderRegistry.register(EmailProviderTypeEnum.SMTP, SmtpProvider);
28
- EmailProviderRegistry.register(EmailProviderTypeEnum.SENDGRID, SendGridProvider);
29
- EmailProviderRegistry.register(EmailProviderTypeEnum.MAILGUN, MailgunProvider);
30
- export class EmailModule {
31
- static forRoot(options) {
32
- return {
33
- module: EmailModule,
34
- global: options.global ?? false,
35
- imports: [
36
- CacheModule,
37
- UtilsModule
38
- ],
39
- controllers: options.includeController !== false ? CONTROLLERS : [],
40
- providers: this.buildProviders(options),
41
- exports: EXPORTED_SERVICES
42
- };
43
- }
44
- static forRootAsync(options) {
45
- return {
46
- module: EmailModule,
47
- global: options.global ?? false,
48
- imports: [
49
- ...options.imports || [],
50
- CacheModule,
51
- UtilsModule
52
- ],
53
- controllers: options.includeController !== false ? CONTROLLERS : [],
54
- providers: [
55
- ...this.createAsyncProviders(options),
56
- ...this.buildProviders()
57
- ],
58
- exports: EXPORTED_SERVICES
59
- };
60
- }
61
- static buildProviders(options) {
62
- const providers = [
63
- ...EXPORTED_SERVICES
64
- ];
65
- if (options) {
66
- providers.unshift({
67
- provide: EMAIL_MODULE_OPTIONS,
68
- useValue: options
69
- });
70
- }
71
- providers.push(createModuleEventsProvider('email', EMAIL_MODULE_OPTIONS));
72
- return providers;
73
- }
74
- static createAsyncProviders(options) {
75
- if (options.useFactory) {
76
- return [
77
- {
78
- provide: EMAIL_MODULE_OPTIONS,
79
- useFactory: async (...args)=>({
80
- ...options,
81
- config: await options.useFactory(...args)
82
- }),
83
- inject: options.inject || []
84
- }
85
- ];
86
- }
87
- const factoryClass = options.useClass || options.useExisting;
88
- if (!factoryClass) return [];
89
- const providers = [
90
- {
91
- provide: EMAIL_MODULE_OPTIONS,
92
- useFactory: async (factory)=>({
93
- ...options,
94
- config: await factory.createEmailOptions()
95
- }),
96
- inject: [
97
- factoryClass
98
- ]
99
- }
100
- ];
101
- if (options.useClass) {
102
- providers.push({
103
- provide: options.useClass,
104
- useClass: options.useClass
105
- });
106
- }
107
- return providers;
108
- }
109
- }
110
- EmailModule = _ts_decorate([
111
- Module({})
112
- ], EmailModule);
@@ -1,138 +0,0 @@
1
- function _define_property(obj, key, value) {
2
- if (key in obj) {
3
- Object.defineProperty(obj, key, {
4
- value: value,
5
- enumerable: true,
6
- configurable: true,
7
- writable: true
8
- });
9
- } else {
10
- obj[key] = value;
11
- }
12
- return obj;
13
- }
14
- import { EmailModule } from './email.module';
15
- import { EMAIL_MODULE_OPTIONS } from '../config/email.constants';
16
- import { EmailConfigController, EmailSendController, EmailTemplateController } from '../controllers';
17
- function providerTokens(providers) {
18
- return providers.map((p)=>typeof p === 'function' ? p : p.provide);
19
- }
20
- describe('EmailModule', ()=>{
21
- describe('forRoot', ()=>{
22
- it('should default to a non-global module with all controllers registered', ()=>{
23
- const dynamicModule = EmailModule.forRoot({});
24
- expect(dynamicModule.module).toBe(EmailModule);
25
- expect(dynamicModule.global).toBe(false);
26
- expect(dynamicModule.controllers).toEqual([
27
- EmailConfigController,
28
- EmailTemplateController,
29
- EmailSendController
30
- ]);
31
- });
32
- it('should respect global: true', ()=>{
33
- expect(EmailModule.forRoot({
34
- global: true
35
- }).global).toBe(true);
36
- });
37
- it('should register no controllers when includeController is false', ()=>{
38
- expect(EmailModule.forRoot({
39
- includeController: false
40
- }).controllers).toEqual([]);
41
- });
42
- it('should register a EMAIL_MODULE_OPTIONS provider carrying the given options', ()=>{
43
- const options = {
44
- bootstrapAppConfig: {
45
- enableCompanyFeature: true
46
- }
47
- };
48
- const dynamicModule = EmailModule.forRoot(options);
49
- const provider = dynamicModule.providers.find((p)=>p.provide === EMAIL_MODULE_OPTIONS);
50
- expect(provider.useValue).toBe(options);
51
- });
52
- it('should always export the same fixed set of services', ()=>{
53
- expect(EmailModule.forRoot({}).exports).toHaveLength(6);
54
- });
55
- });
56
- describe('forRootAsync', ()=>{
57
- it('should forward external imports alongside CacheModule/UtilsModule', ()=>{
58
- let FakeImportedModule = class FakeImportedModule {
59
- };
60
- const dynamicModule = EmailModule.forRootAsync({
61
- bootstrapAppConfig: {},
62
- imports: [
63
- FakeImportedModule
64
- ]
65
- });
66
- expect(dynamicModule.imports).toEqual(expect.arrayContaining([
67
- FakeImportedModule
68
- ]));
69
- });
70
- it('useFactory: builds an EMAIL_MODULE_OPTIONS provider that merges resolved config into the static options', async ()=>{
71
- const useFactory = jest.fn().mockResolvedValue({
72
- defaultFrom: 'noreply@flusys.io'
73
- });
74
- const dynamicModule = EmailModule.forRootAsync({
75
- bootstrapAppConfig: {},
76
- useFactory,
77
- inject: [
78
- 'SOME_TOKEN'
79
- ]
80
- });
81
- const provider = dynamicModule.providers.find((p)=>p.provide === EMAIL_MODULE_OPTIONS);
82
- expect(provider.inject).toEqual([
83
- 'SOME_TOKEN'
84
- ]);
85
- const resolved = await provider.useFactory('injected');
86
- expect(useFactory).toHaveBeenCalledWith('injected');
87
- expect(resolved.config).toEqual({
88
- defaultFrom: 'noreply@flusys.io'
89
- });
90
- });
91
- it('useClass: registers both the class provider and an options provider calling createEmailOptions()', async ()=>{
92
- let MyOptionsFactory = class MyOptionsFactory {
93
- constructor(){
94
- _define_property(this, "createEmailOptions", jest.fn().mockResolvedValue({
95
- defaultFrom: 'from-class@flusys.io'
96
- }));
97
- }
98
- };
99
- const dynamicModule = EmailModule.forRootAsync({
100
- bootstrapAppConfig: {},
101
- useClass: MyOptionsFactory
102
- });
103
- const classProvider = dynamicModule.providers.find((p)=>p.provide === MyOptionsFactory);
104
- expect(classProvider.useClass).toBe(MyOptionsFactory);
105
- const optionsProvider = dynamicModule.providers.find((p)=>p.provide === EMAIL_MODULE_OPTIONS);
106
- const instance = new MyOptionsFactory();
107
- const resolved = await optionsProvider.useFactory(instance);
108
- expect(instance.createEmailOptions).toHaveBeenCalled();
109
- expect(resolved.config).toEqual({
110
- defaultFrom: 'from-class@flusys.io'
111
- });
112
- });
113
- it('useExisting: registers a single options provider without a duplicate class registration', async ()=>{
114
- let MyOptionsFactory = class MyOptionsFactory {
115
- constructor(){
116
- _define_property(this, "createEmailOptions", jest.fn().mockResolvedValue({
117
- defaultFrom: 'from-existing@flusys.io'
118
- }));
119
- }
120
- };
121
- const dynamicModule = EmailModule.forRootAsync({
122
- bootstrapAppConfig: {},
123
- useExisting: MyOptionsFactory
124
- });
125
- expect(dynamicModule.providers.filter((p)=>p.provide === MyOptionsFactory)).toHaveLength(0);
126
- const optionsProvider = dynamicModule.providers.find((p)=>p.provide === EMAIL_MODULE_OPTIONS);
127
- expect(optionsProvider.inject).toEqual([
128
- MyOptionsFactory
129
- ]);
130
- });
131
- it('should register no EMAIL_MODULE_OPTIONS provider when neither useFactory, useClass, nor useExisting is given', ()=>{
132
- const dynamicModule = EmailModule.forRootAsync({
133
- bootstrapAppConfig: {}
134
- });
135
- expect(providerTokens(dynamicModule.providers)).not.toContain(EMAIL_MODULE_OPTIONS);
136
- });
137
- });
138
- });
@@ -1,103 +0,0 @@
1
- function _define_property(obj, key, value) {
2
- if (key in obj) {
3
- Object.defineProperty(obj, key, {
4
- value: value,
5
- enumerable: true,
6
- configurable: true,
7
- writable: true
8
- });
9
- } else {
10
- obj[key] = value;
11
- }
12
- return obj;
13
- }
14
- function _ts_decorate(decorators, target, key, desc) {
15
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
16
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
17
- 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;
18
- return c > 3 && r && Object.defineProperty(target, key, r), r;
19
- }
20
- function _ts_metadata(k, v) {
21
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
22
- }
23
- import { LogAction, SYSTEM_MESSAGES } from '@flusys/nestjs-shared';
24
- import { Injectable, InternalServerErrorException, NotFoundException } from '@nestjs/common';
25
- import { createHash } from 'crypto';
26
- import { EMAIL_SEND_MESSAGES } from '../config';
27
- import { IEmailProviderConfig } from '../interfaces';
28
- import { EmailProviderRegistry } from './email-provider.registry';
29
- export class EmailFactoryService {
30
- // ─── Public API ─────────────────────────────────────────────────────────────
31
- async createProvider(config) {
32
- const cacheKey = this.generateCacheKey(config);
33
- const cached = this.providerCache.get(cacheKey);
34
- if (cached) return cached;
35
- const ProviderClass = EmailProviderRegistry.get(config.provider);
36
- if (!ProviderClass) {
37
- throw new NotFoundException({
38
- message: `Email provider '${config.provider}' is not registered`,
39
- messageKey: EMAIL_SEND_MESSAGES.CONFIG_NOT_FOUND,
40
- messageVariables: {
41
- provider: config.provider,
42
- available: EmailProviderRegistry.getAll().join(', ')
43
- }
44
- });
45
- }
46
- try {
47
- const instance = new ProviderClass();
48
- await instance.initialize?.(config.config);
49
- this.providerCache.set(cacheKey, instance);
50
- return instance;
51
- } catch (error) {
52
- throw new InternalServerErrorException({
53
- message: `Email provider '${config.provider}' not initialized successfully: ${this.extractErrorMessage(error)}`,
54
- messageKey: SYSTEM_MESSAGES.SERVICE_NOT_AVAILABLE,
55
- messageVariables: {
56
- provider: config.provider,
57
- available: EmailProviderRegistry.getAll().join(', ')
58
- }
59
- });
60
- }
61
- }
62
- // ─── Lifecycle ──────────────────────────────────────────────────────────────
63
- async onModuleDestroy() {
64
- const closePromises = Array.from(this.providerCache.entries()).map(([, provider])=>this.closeProvider(provider));
65
- await Promise.allSettled(closePromises);
66
- this.providerCache.clear();
67
- }
68
- // ─── Private Helpers ────────────────────────────────────────────────────────
69
- generateCacheKey(config) {
70
- const sortedKeys = Object.keys(config.config || {}).sort();
71
- const configString = JSON.stringify(config.config, sortedKeys);
72
- const hash = createHash('sha256').update(configString).digest('hex').substring(0, 16);
73
- return `${config.provider}-${hash}`;
74
- }
75
- async closeProvider(provider) {
76
- if (!provider.close) return;
77
- try {
78
- await provider.close();
79
- } catch {
80
- // Silent failure
81
- }
82
- }
83
- extractErrorMessage(error) {
84
- return error instanceof Error ? error.message : 'Unknown error';
85
- }
86
- constructor(){
87
- _define_property(this, "providerCache", new Map());
88
- }
89
- }
90
- _ts_decorate([
91
- LogAction({
92
- action: 'email.createProvider',
93
- module: 'email'
94
- }),
95
- _ts_metadata("design:type", Function),
96
- _ts_metadata("design:paramtypes", [
97
- typeof IEmailProviderConfig === "undefined" ? Object : IEmailProviderConfig
98
- ]),
99
- _ts_metadata("design:returntype", Promise)
100
- ], EmailFactoryService.prototype, "createProvider", null);
101
- EmailFactoryService = _ts_decorate([
102
- Injectable()
103
- ], EmailFactoryService);
@@ -1,238 +0,0 @@
1
- function _define_property(obj, key, value) {
2
- if (key in obj) {
3
- Object.defineProperty(obj, key, {
4
- value: value,
5
- enumerable: true,
6
- configurable: true,
7
- writable: true
8
- });
9
- } else {
10
- obj[key] = value;
11
- }
12
- return obj;
13
- }
14
- import { InternalServerErrorException, NotFoundException } from '@nestjs/common';
15
- import { EmailFactoryService } from './email-factory.service';
16
- import { EmailProviderRegistry } from './email-provider.registry';
17
- let FakeSuccessProvider = class FakeSuccessProvider {
18
- async initialize(_config) {
19
- FakeSuccessProvider.initializeCalls += 1;
20
- }
21
- async sendEmail(_options) {
22
- return {
23
- success: true
24
- };
25
- }
26
- async sendBulkEmails(_options) {
27
- return [];
28
- }
29
- async healthCheck() {
30
- return true;
31
- }
32
- async close() {
33
- this.closeCalled = true;
34
- }
35
- constructor(){
36
- _define_property(this, "closeCalled", false);
37
- FakeSuccessProvider.instances.push(this);
38
- }
39
- };
40
- _define_property(FakeSuccessProvider, "initializeCalls", 0);
41
- _define_property(FakeSuccessProvider, "instances", []);
42
- let FakeFailingInitProvider = class FakeFailingInitProvider {
43
- async initialize(_config) {
44
- throw new Error('boom during init');
45
- }
46
- async sendEmail(_options) {
47
- return {
48
- success: true
49
- };
50
- }
51
- async sendBulkEmails(_options) {
52
- return [];
53
- }
54
- async healthCheck() {
55
- return true;
56
- }
57
- };
58
- let FakeNoInitializeProvider = class FakeNoInitializeProvider {
59
- async sendEmail(_options) {
60
- return {
61
- success: true
62
- };
63
- }
64
- async sendBulkEmails(_options) {
65
- return [];
66
- }
67
- async healthCheck() {
68
- return true;
69
- }
70
- };
71
- describe('EmailFactoryService', ()=>{
72
- let service;
73
- beforeEach(()=>{
74
- service = new EmailFactoryService();
75
- EmailProviderRegistry.clear();
76
- FakeSuccessProvider.initializeCalls = 0;
77
- FakeSuccessProvider.instances = [];
78
- });
79
- afterEach(()=>{
80
- EmailProviderRegistry.clear();
81
- });
82
- describe('createProvider', ()=>{
83
- it('throws NotFoundException when the provider is not registered', async ()=>{
84
- const config = {
85
- provider: 'unknown',
86
- config: {}
87
- };
88
- await expect(service.createProvider(config)).rejects.toThrow(NotFoundException);
89
- });
90
- it('throws NotFoundException with the config-not-found messageKey and available list', async ()=>{
91
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
92
- const config = {
93
- provider: 'unknown',
94
- config: {}
95
- };
96
- try {
97
- await service.createProvider(config);
98
- fail('expected createProvider to throw');
99
- } catch (error) {
100
- expect(error).toBeInstanceOf(NotFoundException);
101
- expect(error.getResponse()).toEqual(expect.objectContaining({
102
- messageKey: 'email.send.config.not.found'
103
- }));
104
- }
105
- });
106
- it('instantiates and initializes the provider on cache miss', async ()=>{
107
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
108
- const config = {
109
- provider: 'smtp',
110
- config: {
111
- host: 'localhost'
112
- }
113
- };
114
- const provider = await service.createProvider(config);
115
- expect(provider).toBeInstanceOf(FakeSuccessProvider);
116
- expect(FakeSuccessProvider.initializeCalls).toBe(1);
117
- });
118
- it('returns the cached provider instance for an identical config (no re-initialization)', async ()=>{
119
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
120
- const config = {
121
- provider: 'smtp',
122
- config: {
123
- host: 'localhost'
124
- }
125
- };
126
- const first = await service.createProvider(config);
127
- const second = await service.createProvider(config);
128
- expect(second).toBe(first);
129
- expect(FakeSuccessProvider.initializeCalls).toBe(1);
130
- });
131
- it('creates a distinct cached instance for a different config on the same provider', async ()=>{
132
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
133
- const first = await service.createProvider({
134
- provider: 'smtp',
135
- config: {
136
- host: 'a'
137
- }
138
- });
139
- const second = await service.createProvider({
140
- provider: 'smtp',
141
- config: {
142
- host: 'b'
143
- }
144
- });
145
- expect(second).not.toBe(first);
146
- expect(FakeSuccessProvider.initializeCalls).toBe(2);
147
- });
148
- it('is insensitive to key ordering when hashing the config for the cache key', async ()=>{
149
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
150
- const first = await service.createProvider({
151
- provider: 'smtp',
152
- config: {
153
- a: 1,
154
- b: 2
155
- }
156
- });
157
- const second = await service.createProvider({
158
- provider: 'smtp',
159
- config: {
160
- b: 2,
161
- a: 1
162
- }
163
- });
164
- expect(second).toBe(first);
165
- expect(FakeSuccessProvider.initializeCalls).toBe(1);
166
- });
167
- it('does not call initialize when the provider class has no initialize method', async ()=>{
168
- EmailProviderRegistry.register('smtp', FakeNoInitializeProvider);
169
- const config = {
170
- provider: 'smtp',
171
- config: {}
172
- };
173
- const provider = await service.createProvider(config);
174
- expect(provider).toBeInstanceOf(FakeNoInitializeProvider);
175
- });
176
- it('wraps initialize() failures in InternalServerErrorException with SDK_NOT_INSTALLED messageKey', async ()=>{
177
- EmailProviderRegistry.register('mailgun', FakeFailingInitProvider);
178
- const config = {
179
- provider: 'mailgun',
180
- config: {}
181
- };
182
- try {
183
- await service.createProvider(config);
184
- fail('expected createProvider to throw');
185
- } catch (error) {
186
- expect(error).toBeInstanceOf(InternalServerErrorException);
187
- expect(error.getResponse()).toEqual(expect.objectContaining({
188
- messageKey: 'system.service.not.available'
189
- }));
190
- expect(error.getResponse().message).toContain('boom during init');
191
- }
192
- });
193
- it('does not cache a provider that failed to initialize', async ()=>{
194
- EmailProviderRegistry.register('mailgun', FakeFailingInitProvider);
195
- const config = {
196
- provider: 'mailgun',
197
- config: {}
198
- };
199
- await expect(service.createProvider(config)).rejects.toThrow();
200
- // second attempt should also go through the (still failing) initialization path
201
- await expect(service.createProvider(config)).rejects.toThrow();
202
- });
203
- });
204
- describe('onModuleDestroy', ()=>{
205
- it('closes every cached provider and clears the cache', async ()=>{
206
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
207
- const provider = await service.createProvider({
208
- provider: 'smtp',
209
- config: {}
210
- });
211
- await service.onModuleDestroy();
212
- expect(provider.closeCalled).toBe(true);
213
- // cache cleared -> a subsequent createProvider call re-initializes
214
- EmailProviderRegistry.register('smtp', FakeSuccessProvider);
215
- await service.createProvider({
216
- provider: 'smtp',
217
- config: {}
218
- });
219
- expect(FakeSuccessProvider.initializeCalls).toBe(2);
220
- });
221
- it('does not throw when a provider close() call rejects', async ()=>{
222
- let FakeThrowingCloseProvider = class FakeThrowingCloseProvider extends FakeSuccessProvider {
223
- async close() {
224
- throw new Error('close failed');
225
- }
226
- };
227
- EmailProviderRegistry.register('smtp', FakeThrowingCloseProvider);
228
- await service.createProvider({
229
- provider: 'smtp',
230
- config: {}
231
- });
232
- await expect(service.onModuleDestroy()).resolves.toBeUndefined();
233
- });
234
- it('is a no-op when nothing has been cached', async ()=>{
235
- await expect(service.onModuleDestroy()).resolves.toBeUndefined();
236
- });
237
- });
238
- });
@@ -1,31 +0,0 @@
1
- function _define_property(obj, key, value) {
2
- if (key in obj) {
3
- Object.defineProperty(obj, key, {
4
- value: value,
5
- enumerable: true,
6
- configurable: true,
7
- writable: true
8
- });
9
- } else {
10
- obj[key] = value;
11
- }
12
- return obj;
13
- }
14
- export class EmailProviderRegistry {
15
- static register(providerName, providerClass) {
16
- this.providers.set(providerName.toLowerCase(), providerClass);
17
- }
18
- static get(providerName) {
19
- return this.providers.get(providerName.toLowerCase());
20
- }
21
- static has(providerName) {
22
- return this.providers.has(providerName.toLowerCase());
23
- }
24
- static getAll() {
25
- return Array.from(this.providers.keys());
26
- }
27
- static clear() {
28
- this.providers.clear();
29
- }
30
- }
31
- _define_property(EmailProviderRegistry, "providers", new Map());
@@ -1,54 +0,0 @@
1
- import { EmailProviderRegistry } from './email-provider.registry';
2
- let FakeProvider = class FakeProvider {
3
- async sendEmail(_options) {
4
- return {
5
- success: true
6
- };
7
- }
8
- async sendBulkEmails(_options) {
9
- return [];
10
- }
11
- async healthCheck() {
12
- return true;
13
- }
14
- };
15
- describe('EmailProviderRegistry', ()=>{
16
- afterEach(()=>{
17
- EmailProviderRegistry.clear();
18
- });
19
- it('registers and retrieves a provider by exact name', ()=>{
20
- EmailProviderRegistry.register('smtp', FakeProvider);
21
- expect(EmailProviderRegistry.get('smtp')).toBe(FakeProvider);
22
- });
23
- it('normalizes provider names to lowercase on register and lookup', ()=>{
24
- EmailProviderRegistry.register('SendGrid', FakeProvider);
25
- expect(EmailProviderRegistry.get('sendgrid')).toBe(FakeProvider);
26
- expect(EmailProviderRegistry.get('SENDGRID')).toBe(FakeProvider);
27
- expect(EmailProviderRegistry.has('sendgrid')).toBe(true);
28
- });
29
- it('returns undefined for an unregistered provider', ()=>{
30
- expect(EmailProviderRegistry.get('unknown-provider')).toBeUndefined();
31
- expect(EmailProviderRegistry.has('unknown-provider')).toBe(false);
32
- });
33
- it('lists all registered provider names', ()=>{
34
- EmailProviderRegistry.register('smtp', FakeProvider);
35
- EmailProviderRegistry.register('mailgun', FakeProvider);
36
- expect(EmailProviderRegistry.getAll().sort()).toEqual([
37
- 'mailgun',
38
- 'smtp'
39
- ]);
40
- });
41
- it('clears all registered providers', ()=>{
42
- EmailProviderRegistry.register('smtp', FakeProvider);
43
- EmailProviderRegistry.clear();
44
- expect(EmailProviderRegistry.getAll()).toEqual([]);
45
- expect(EmailProviderRegistry.has('smtp')).toBe(false);
46
- });
47
- it('overwrites a previously registered provider for the same name', ()=>{
48
- let OtherProvider = class OtherProvider extends FakeProvider {
49
- };
50
- EmailProviderRegistry.register('smtp', FakeProvider);
51
- EmailProviderRegistry.register('smtp', OtherProvider);
52
- expect(EmailProviderRegistry.get('smtp')).toBe(OtherProvider);
53
- });
54
- });