@flusys/nestjs-email 6.0.2 → 6.1.1

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 (37) hide show
  1. package/cjs/controllers/email-config.controller.spec.js +85 -0
  2. package/cjs/controllers/email-send.controller.spec.js +139 -0
  3. package/cjs/controllers/email-template.controller.spec.js +89 -0
  4. package/cjs/docs/email-swagger.config.spec.js +62 -0
  5. package/cjs/entities/index.spec.js +18 -0
  6. package/cjs/modules/email.module.spec.js +142 -0
  7. package/cjs/providers/email-factory.service.spec.js +242 -0
  8. package/cjs/providers/email-provider.registry.spec.js +58 -0
  9. package/cjs/providers/mailgun-provider.spec.js +244 -0
  10. package/cjs/providers/sendgrid-provider.spec.js +346 -0
  11. package/cjs/providers/smtp-provider.js +12 -5
  12. package/cjs/providers/smtp-provider.spec.js +327 -0
  13. package/cjs/services/email-config.service.spec.js +69 -0
  14. package/cjs/services/email-datasource.provider.spec.js +135 -0
  15. package/cjs/services/email-provider-config.service.spec.js +247 -0
  16. package/cjs/services/email-send.service.spec.js +546 -0
  17. package/cjs/services/email-template.service.spec.js +257 -0
  18. package/cjs/utils/email-templates.util.spec.js +61 -0
  19. package/fesm/controllers/email-config.controller.spec.js +81 -0
  20. package/fesm/controllers/email-send.controller.spec.js +135 -0
  21. package/fesm/controllers/email-template.controller.spec.js +85 -0
  22. package/fesm/docs/email-swagger.config.spec.js +58 -0
  23. package/fesm/entities/index.spec.js +14 -0
  24. package/fesm/modules/email.module.spec.js +138 -0
  25. package/fesm/providers/email-factory.service.spec.js +238 -0
  26. package/fesm/providers/email-provider.registry.spec.js +54 -0
  27. package/fesm/providers/mailgun-provider.spec.js +240 -0
  28. package/fesm/providers/sendgrid-provider.spec.js +342 -0
  29. package/fesm/providers/smtp-provider.js +12 -5
  30. package/fesm/providers/smtp-provider.spec.js +282 -0
  31. package/fesm/services/email-config.service.spec.js +65 -0
  32. package/fesm/services/email-datasource.provider.spec.js +131 -0
  33. package/fesm/services/email-provider-config.service.spec.js +243 -0
  34. package/fesm/services/email-send.service.spec.js +542 -0
  35. package/fesm/services/email-template.service.spec.js +253 -0
  36. package/fesm/utils/email-templates.util.spec.js +57 -0
  37. package/package.json +3 -3
@@ -0,0 +1,65 @@
1
+ import { DEFAULT_FROM_NAME } from '../config/email.constants';
2
+ import { EmailConfigService } from './email-config.service';
3
+ function buildOptions(overrides = {}) {
4
+ return {
5
+ bootstrapAppConfig: undefined,
6
+ config: undefined,
7
+ ...overrides
8
+ };
9
+ }
10
+ describe('EmailConfigService', ()=>{
11
+ describe('isCompanyFeatureEnabled', ()=>{
12
+ it('returns false when bootstrapAppConfig is not provided', ()=>{
13
+ const service = new EmailConfigService(buildOptions());
14
+ expect(service.isCompanyFeatureEnabled()).toBe(false);
15
+ });
16
+ it('returns false when enableCompanyFeature is explicitly false', ()=>{
17
+ const service = new EmailConfigService(buildOptions({
18
+ bootstrapAppConfig: {
19
+ enableCompanyFeature: false
20
+ }
21
+ }));
22
+ expect(service.isCompanyFeatureEnabled()).toBe(false);
23
+ });
24
+ it('returns true when enableCompanyFeature is true', ()=>{
25
+ const service = new EmailConfigService(buildOptions({
26
+ bootstrapAppConfig: {
27
+ enableCompanyFeature: true
28
+ }
29
+ }));
30
+ expect(service.isCompanyFeatureEnabled()).toBe(true);
31
+ });
32
+ });
33
+ describe('getDatabaseMode / isMultiTenant', ()=>{
34
+ it('defaults to "single" when bootstrapAppConfig is missing', ()=>{
35
+ const service = new EmailConfigService(buildOptions());
36
+ expect(service.getDatabaseMode()).toBe('single');
37
+ expect(service.isMultiTenant()).toBe(false);
38
+ });
39
+ it('reflects "multi-tenant" mode from bootstrapAppConfig', ()=>{
40
+ const service = new EmailConfigService(buildOptions({
41
+ bootstrapAppConfig: {
42
+ databaseMode: 'multi-tenant'
43
+ }
44
+ }));
45
+ expect(service.getDatabaseMode()).toBe('multi-tenant');
46
+ expect(service.isMultiTenant()).toBe(true);
47
+ });
48
+ });
49
+ describe('getDefaultFromName', ()=>{
50
+ it('always returns the module-level DEFAULT_FROM_NAME constant', ()=>{
51
+ const service = new EmailConfigService(buildOptions());
52
+ expect(service.getDefaultFromName()).toBe(DEFAULT_FROM_NAME);
53
+ expect(service.getDefaultFromName()).toBe('FLUSYS');
54
+ });
55
+ });
56
+ describe('getOptions', ()=>{
57
+ it('returns the exact options object injected via the constructor', ()=>{
58
+ const options = buildOptions({
59
+ defaultProvider: 'smtp'
60
+ });
61
+ const service = new EmailConfigService(options);
62
+ expect(service.getOptions()).toBe(options);
63
+ });
64
+ });
65
+ });
@@ -0,0 +1,131 @@
1
+ import { MultiTenantDataSourceService } from '@flusys/nestjs-shared/modules';
2
+ import { EmailCompanyEntities, EmailCoreEntities } from '../entities';
3
+ import { EmailDataSourceProvider } from './email-datasource.provider';
4
+ function buildConfigService(overrides = {}) {
5
+ const options = {
6
+ bootstrapAppConfig: {
7
+ databaseMode: 'single',
8
+ enableCompanyFeature: false
9
+ },
10
+ config: {
11
+ defaultDatabaseConfig: {
12
+ type: 'mysql',
13
+ host: 'localhost',
14
+ database: 'flusys'
15
+ },
16
+ tenants: []
17
+ },
18
+ ...overrides
19
+ };
20
+ return {
21
+ isCompanyFeatureEnabled: jest.fn().mockReturnValue(options.bootstrapAppConfig?.enableCompanyFeature ?? false),
22
+ getDatabaseMode: jest.fn().mockReturnValue(options.bootstrapAppConfig?.databaseMode ?? 'single'),
23
+ isMultiTenant: jest.fn().mockReturnValue(options.bootstrapAppConfig?.databaseMode === 'multi-tenant'),
24
+ getDefaultFromName: jest.fn().mockReturnValue('FLUSYS'),
25
+ getOptions: jest.fn().mockReturnValue(options)
26
+ };
27
+ }
28
+ describe('EmailDataSourceProvider', ()=>{
29
+ afterEach(()=>{
30
+ jest.restoreAllMocks();
31
+ // Reset static state isolated to this subclass between tests.
32
+ EmailDataSourceProvider.singleDataSource = null;
33
+ EmailDataSourceProvider.initialized = false;
34
+ EmailDataSourceProvider.tenantsRegistry.clear();
35
+ });
36
+ it('propagates bootstrapAppConfig from EmailConfigService into the base data source service', ()=>{
37
+ const configService = buildConfigService({
38
+ bootstrapAppConfig: {
39
+ databaseMode: 'multi-tenant',
40
+ enableCompanyFeature: true
41
+ }
42
+ });
43
+ const provider = new EmailDataSourceProvider(configService);
44
+ expect(provider.isMultiTenant()).toBe(true);
45
+ expect(provider.getDatabaseMode()).toBe('multi-tenant');
46
+ });
47
+ it('defaults to single-database mode when bootstrapAppConfig is absent', ()=>{
48
+ const configService = buildConfigService({
49
+ bootstrapAppConfig: undefined
50
+ });
51
+ const provider = new EmailDataSourceProvider(configService);
52
+ expect(provider.isMultiTenant()).toBe(false);
53
+ expect(provider.getDatabaseMode()).toBe('single');
54
+ });
55
+ describe('getEnableCompanyFeatureForTenant', ()=>{
56
+ it('falls back to EmailConfigService.isCompanyFeatureEnabled() when no tenant is given', ()=>{
57
+ const configService = buildConfigService({
58
+ bootstrapAppConfig: {
59
+ databaseMode: 'single',
60
+ enableCompanyFeature: true
61
+ }
62
+ });
63
+ const provider = new EmailDataSourceProvider(configService);
64
+ expect(provider.getEnableCompanyFeatureForTenant(undefined)).toBe(true);
65
+ });
66
+ it('prefers the tenant-level enableCompanyFeature flag over the module default', ()=>{
67
+ const configService = buildConfigService({
68
+ bootstrapAppConfig: {
69
+ databaseMode: 'multi-tenant',
70
+ enableCompanyFeature: true
71
+ }
72
+ });
73
+ const provider = new EmailDataSourceProvider(configService);
74
+ expect(provider.getEnableCompanyFeatureForTenant({
75
+ id: 'tenant-1',
76
+ database: 'tenant_db',
77
+ enableCompanyFeature: false
78
+ })).toBe(false);
79
+ });
80
+ it('uses the module default when the tenant does not specify enableCompanyFeature', ()=>{
81
+ const configService = buildConfigService({
82
+ bootstrapAppConfig: {
83
+ databaseMode: 'multi-tenant',
84
+ enableCompanyFeature: true
85
+ }
86
+ });
87
+ const provider = new EmailDataSourceProvider(configService);
88
+ expect(provider.getEnableCompanyFeatureForTenant({
89
+ id: 'tenant-1',
90
+ database: 'tenant_db'
91
+ })).toBe(true);
92
+ });
93
+ });
94
+ describe('createDataSourceFromConfig', ()=>{
95
+ it('resolves core (non-company) entities when the company feature is disabled', async ()=>{
96
+ const configService = buildConfigService({
97
+ bootstrapAppConfig: {
98
+ databaseMode: 'single',
99
+ enableCompanyFeature: false
100
+ }
101
+ });
102
+ const provider = new EmailDataSourceProvider(configService);
103
+ const fakeDataSource = {};
104
+ const superSpy = jest.spyOn(MultiTenantDataSourceService.prototype, 'createDataSourceFromConfig').mockResolvedValue(fakeDataSource);
105
+ const config = {
106
+ type: 'mysql',
107
+ database: 'flusys'
108
+ };
109
+ const result = await provider.createDataSourceFromConfig(config);
110
+ expect(result).toBe(fakeDataSource);
111
+ expect(superSpy).toHaveBeenCalledWith(config, EmailCoreEntities);
112
+ });
113
+ it('resolves company-aware entities when the company feature is enabled', async ()=>{
114
+ const configService = buildConfigService({
115
+ bootstrapAppConfig: {
116
+ databaseMode: 'single',
117
+ enableCompanyFeature: true
118
+ }
119
+ });
120
+ const provider = new EmailDataSourceProvider(configService);
121
+ const fakeDataSource = {};
122
+ const superSpy = jest.spyOn(MultiTenantDataSourceService.prototype, 'createDataSourceFromConfig').mockResolvedValue(fakeDataSource);
123
+ const config = {
124
+ type: 'mysql',
125
+ database: 'flusys'
126
+ };
127
+ await provider.createDataSourceFromConfig(config);
128
+ expect(superSpy).toHaveBeenCalledWith(config, EmailCompanyEntities);
129
+ });
130
+ });
131
+ });
@@ -0,0 +1,243 @@
1
+ import { Test } from '@nestjs/testing';
2
+ import { UtilsService } from '@flusys/nestjs-shared/modules';
3
+ import { createMockDataSourceProvider, createMockRepository } from '@test-utils/mocks/repository.mock';
4
+ import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
5
+ import { EmailConfig, EmailConfigWithCompany } from '../entities';
6
+ import { EmailConfigService } from './email-config.service';
7
+ import { EmailDataSourceProvider } from './email-datasource.provider';
8
+ import { EmailProviderConfigService } from './email-provider-config.service';
9
+ function buildEmailConfig(overrides = {}) {
10
+ return {
11
+ id: 'config-uuid-1',
12
+ name: 'Primary SMTP',
13
+ provider: 'smtp',
14
+ config: {
15
+ host: 'smtp.example.com'
16
+ },
17
+ fromEmail: 'noreply@example.com',
18
+ fromName: 'FLUSYS',
19
+ isActive: true,
20
+ isDefault: false,
21
+ createdAt: new Date(),
22
+ updatedAt: new Date(),
23
+ deletedAt: null,
24
+ createdById: null,
25
+ updatedById: null,
26
+ deletedById: null,
27
+ ...overrides
28
+ };
29
+ }
30
+ function buildQuery() {
31
+ return {
32
+ select: jest.fn().mockReturnThis(),
33
+ andWhere: jest.fn().mockReturnThis(),
34
+ orderBy: jest.fn().mockReturnThis()
35
+ };
36
+ }
37
+ describe('EmailProviderConfigService', ()=>{
38
+ let service;
39
+ let mockRepo;
40
+ let mockEmailConfig;
41
+ beforeEach(async ()=>{
42
+ mockRepo = createMockRepository();
43
+ const mockDataSourceProvider = createMockDataSourceProvider(mockRepo);
44
+ mockEmailConfig = {
45
+ isCompanyFeatureEnabled: jest.fn().mockReturnValue(false)
46
+ };
47
+ const module = await Test.createTestingModule({
48
+ providers: [
49
+ EmailProviderConfigService,
50
+ {
51
+ provide: 'CACHE_INSTANCE',
52
+ useValue: {}
53
+ },
54
+ {
55
+ provide: UtilsService,
56
+ useValue: {}
57
+ },
58
+ {
59
+ provide: EmailConfigService,
60
+ useValue: mockEmailConfig
61
+ },
62
+ {
63
+ provide: EmailDataSourceProvider,
64
+ useValue: mockDataSourceProvider
65
+ }
66
+ ]
67
+ }).compile();
68
+ service = await module.resolve(EmailProviderConfigService);
69
+ });
70
+ describe('resolveEntity', ()=>{
71
+ it('resolves the plain EmailConfig entity when the company feature is disabled', ()=>{
72
+ expect(service.resolveEntity()).toBe(EmailConfig);
73
+ });
74
+ it('resolves EmailConfigWithCompany when the company feature is enabled', ()=>{
75
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
76
+ expect(service.resolveEntity()).toBe(EmailConfigWithCompany);
77
+ });
78
+ });
79
+ describe('convertSingleDtoToEntity', ()=>{
80
+ it('does not attach companyId when the company feature is disabled', async ()=>{
81
+ const entity = await service.convertSingleDtoToEntity({
82
+ name: 'X',
83
+ provider: 'smtp',
84
+ config: {}
85
+ }, buildMockUser());
86
+ expect(entity.companyId).toBeUndefined();
87
+ });
88
+ it('attaches the current user companyId when the company feature is enabled', async ()=>{
89
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
90
+ const entity = await service.convertSingleDtoToEntity({
91
+ name: 'X',
92
+ provider: 'smtp',
93
+ config: {}
94
+ }, buildMockUser({
95
+ companyId: 'company-uuid-42'
96
+ }));
97
+ expect(entity.companyId).toBe('company-uuid-42');
98
+ });
99
+ it('sets companyId to null when the company feature is enabled but no user is provided', async ()=>{
100
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
101
+ const entity = await service.convertSingleDtoToEntity({
102
+ name: 'X',
103
+ provider: 'smtp',
104
+ config: {}
105
+ }, null);
106
+ expect(entity.companyId).toBeNull();
107
+ });
108
+ });
109
+ describe('getSelectQuery', ()=>{
110
+ it('selects the default whitelisted fields (without companyId) when company feature is disabled', async ()=>{
111
+ const query = buildQuery();
112
+ const { isRaw } = await service.getSelectQuery(query, buildMockUser());
113
+ expect(isRaw).toBe(false);
114
+ const [selected] = query.select.mock.calls[0];
115
+ expect(selected).toEqual(expect.arrayContaining([
116
+ 'emailConfig.id',
117
+ 'emailConfig.name',
118
+ 'emailConfig.provider',
119
+ 'emailConfig.config',
120
+ 'emailConfig.fromEmail',
121
+ 'emailConfig.fromName',
122
+ 'emailConfig.isActive',
123
+ 'emailConfig.isDefault',
124
+ 'emailConfig.createdAt',
125
+ 'emailConfig.updatedAt'
126
+ ]));
127
+ expect(selected).not.toContain('emailConfig.companyId');
128
+ });
129
+ it('appends companyId to the default field list when company feature is enabled', async ()=>{
130
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
131
+ const query = buildQuery();
132
+ await service.getSelectQuery(query, buildMockUser());
133
+ const [selected] = query.select.mock.calls[0];
134
+ expect(selected).toContain('emailConfig.companyId');
135
+ });
136
+ it('respects an explicit select list instead of the defaults', async ()=>{
137
+ const query = buildQuery();
138
+ await service.getSelectQuery(query, buildMockUser(), [
139
+ 'name'
140
+ ]);
141
+ expect(query.select).toHaveBeenCalledWith([
142
+ 'emailConfig.name'
143
+ ]);
144
+ });
145
+ });
146
+ describe('getExtraManipulateQuery', ()=>{
147
+ it('applies the company filter and orders by createdAt DESC when company feature is enabled', async ()=>{
148
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
149
+ const query = buildQuery();
150
+ await service.getExtraManipulateQuery(query, {}, buildMockUser({
151
+ companyId: 'c-1'
152
+ }));
153
+ expect(query.andWhere).toHaveBeenCalledWith('emailConfig.companyId = :companyId', {
154
+ companyId: 'c-1'
155
+ });
156
+ expect(query.orderBy).toHaveBeenCalledWith('emailConfig.createdAt', 'DESC');
157
+ });
158
+ it('skips the company filter when the company feature is disabled', async ()=>{
159
+ const query = buildQuery();
160
+ await service.getExtraManipulateQuery(query, {}, buildMockUser());
161
+ expect(query.andWhere).not.toHaveBeenCalled();
162
+ expect(query.orderBy).toHaveBeenCalledWith('emailConfig.createdAt', 'DESC');
163
+ });
164
+ });
165
+ describe('findByIdDirect', ()=>{
166
+ it('returns the matching config from the repository', async ()=>{
167
+ const config = buildEmailConfig();
168
+ mockRepo.findOne.mockResolvedValue(config);
169
+ const result = await service.findByIdDirect('config-uuid-1');
170
+ expect(result).toBe(config);
171
+ expect(mockRepo.findOne).toHaveBeenCalledWith({
172
+ where: {
173
+ id: 'config-uuid-1'
174
+ }
175
+ });
176
+ });
177
+ it('returns null when no config matches', async ()=>{
178
+ mockRepo.findOne.mockResolvedValue(null);
179
+ await expect(service.findByIdDirect('missing')).resolves.toBeNull();
180
+ });
181
+ });
182
+ describe('getDefaultConfig', ()=>{
183
+ it('returns the active default config when one is marked isDefault', async ()=>{
184
+ const defaultConfig = buildEmailConfig({
185
+ isDefault: true
186
+ });
187
+ mockRepo.findOne.mockResolvedValueOnce(defaultConfig);
188
+ const result = await service.getDefaultConfig(buildMockUser());
189
+ expect(result).toBe(defaultConfig);
190
+ expect(mockRepo.findOne).toHaveBeenCalledTimes(1);
191
+ expect(mockRepo.findOne).toHaveBeenCalledWith({
192
+ where: {
193
+ isActive: true,
194
+ isDefault: true
195
+ },
196
+ order: {
197
+ createdAt: 'ASC'
198
+ }
199
+ });
200
+ });
201
+ it('falls back to the oldest active config when no default is marked', async ()=>{
202
+ const fallbackConfig = buildEmailConfig({
203
+ isDefault: false
204
+ });
205
+ mockRepo.findOne.mockResolvedValueOnce(null).mockResolvedValueOnce(fallbackConfig);
206
+ const result = await service.getDefaultConfig(buildMockUser());
207
+ expect(result).toBe(fallbackConfig);
208
+ expect(mockRepo.findOne).toHaveBeenCalledTimes(2);
209
+ expect(mockRepo.findOne).toHaveBeenNthCalledWith(2, {
210
+ where: {
211
+ isActive: true
212
+ },
213
+ order: {
214
+ createdAt: 'ASC'
215
+ }
216
+ });
217
+ });
218
+ it('returns null when there is no active config at all', async ()=>{
219
+ mockRepo.findOne.mockResolvedValue(null);
220
+ await expect(service.getDefaultConfig(buildMockUser())).resolves.toBeNull();
221
+ });
222
+ it('scopes the lookup to the current company when the company feature is enabled', async ()=>{
223
+ mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
224
+ const defaultConfig = buildEmailConfig({
225
+ isDefault: true
226
+ });
227
+ mockRepo.findOne.mockResolvedValueOnce(defaultConfig);
228
+ await service.getDefaultConfig(buildMockUser({
229
+ companyId: 'company-uuid-9'
230
+ }));
231
+ expect(mockRepo.findOne).toHaveBeenCalledWith({
232
+ where: {
233
+ isActive: true,
234
+ companyId: 'company-uuid-9',
235
+ isDefault: true
236
+ },
237
+ order: {
238
+ createdAt: 'ASC'
239
+ }
240
+ });
241
+ });
242
+ });
243
+ });