@flusys/nestjs-email 7.1.0 → 8.0.0

package/cjs/modules/email.module.spec.js

@@ -1,142 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _emailmodule = require("./email.module");
-const _emailconstants = require("../config/email.constants");
-const _controllers = require("../controllers");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function providerTokens(providers) {
-    return providers.map((p)=>typeof p === 'function' ? p : p.provide);
-}
-describe('EmailModule', ()=>{
-    describe('forRoot', ()=>{
-        it('should default to a non-global module with all controllers registered', ()=>{
-            const dynamicModule = _emailmodule.EmailModule.forRoot({});
-            expect(dynamicModule.module).toBe(_emailmodule.EmailModule);
-            expect(dynamicModule.global).toBe(false);
-            expect(dynamicModule.controllers).toEqual([
-                _controllers.EmailConfigController,
-                _controllers.EmailTemplateController,
-                _controllers.EmailSendController
-            ]);
-        });
-        it('should respect global: true', ()=>{
-            expect(_emailmodule.EmailModule.forRoot({
-                global: true
-            }).global).toBe(true);
-        });
-        it('should register no controllers when includeController is false', ()=>{
-            expect(_emailmodule.EmailModule.forRoot({
-                includeController: false
-            }).controllers).toEqual([]);
-        });
-        it('should register a EMAIL_MODULE_OPTIONS provider carrying the given options', ()=>{
-            const options = {
-                bootstrapAppConfig: {
-                    enableCompanyFeature: true
-                }
-            };
-            const dynamicModule = _emailmodule.EmailModule.forRoot(options);
-            const provider = dynamicModule.providers.find((p)=>p.provide === _emailconstants.EMAIL_MODULE_OPTIONS);
-            expect(provider.useValue).toBe(options);
-        });
-        it('should always export the same fixed set of services', ()=>{
-            expect(_emailmodule.EmailModule.forRoot({}).exports).toHaveLength(6);
-        });
-    });
-    describe('forRootAsync', ()=>{
-        it('should forward external imports alongside CacheModule/UtilsModule', ()=>{
-            let FakeImportedModule = class FakeImportedModule {
-            };
-            const dynamicModule = _emailmodule.EmailModule.forRootAsync({
-                bootstrapAppConfig: {},
-                imports: [
-                    FakeImportedModule
-                ]
-            });
-            expect(dynamicModule.imports).toEqual(expect.arrayContaining([
-                FakeImportedModule
-            ]));
-        });
-        it('useFactory: builds an EMAIL_MODULE_OPTIONS provider that merges resolved config into the static options', async ()=>{
-            const useFactory = jest.fn().mockResolvedValue({
-                defaultFrom: 'noreply@flusys.io'
-            });
-            const dynamicModule = _emailmodule.EmailModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useFactory,
-                inject: [
-                    'SOME_TOKEN'
-                ]
-            });
-            const provider = dynamicModule.providers.find((p)=>p.provide === _emailconstants.EMAIL_MODULE_OPTIONS);
-            expect(provider.inject).toEqual([
-                'SOME_TOKEN'
-            ]);
-            const resolved = await provider.useFactory('injected');
-            expect(useFactory).toHaveBeenCalledWith('injected');
-            expect(resolved.config).toEqual({
-                defaultFrom: 'noreply@flusys.io'
-            });
-        });
-        it('useClass: registers both the class provider and an options provider calling createEmailOptions()', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createEmailOptions", jest.fn().mockResolvedValue({
-                        defaultFrom: 'from-class@flusys.io'
-                    }));
-                }
-            };
-            const dynamicModule = _emailmodule.EmailModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useClass: MyOptionsFactory
-            });
-            const classProvider = dynamicModule.providers.find((p)=>p.provide === MyOptionsFactory);
-            expect(classProvider.useClass).toBe(MyOptionsFactory);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === _emailconstants.EMAIL_MODULE_OPTIONS);
-            const instance = new MyOptionsFactory();
-            const resolved = await optionsProvider.useFactory(instance);
-            expect(instance.createEmailOptions).toHaveBeenCalled();
-            expect(resolved.config).toEqual({
-                defaultFrom: 'from-class@flusys.io'
-            });
-        });
-        it('useExisting: registers a single options provider without a duplicate class registration', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createEmailOptions", jest.fn().mockResolvedValue({
-                        defaultFrom: 'from-existing@flusys.io'
-                    }));
-                }
-            };
-            const dynamicModule = _emailmodule.EmailModule.forRootAsync({
-                bootstrapAppConfig: {},
-                useExisting: MyOptionsFactory
-            });
-            expect(dynamicModule.providers.filter((p)=>p.provide === MyOptionsFactory)).toHaveLength(0);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === _emailconstants.EMAIL_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                MyOptionsFactory
-            ]);
-        });
-        it('should register no EMAIL_MODULE_OPTIONS provider when neither useFactory, useClass, nor useExisting is given', ()=>{
-            const dynamicModule = _emailmodule.EmailModule.forRootAsync({
-                bootstrapAppConfig: {}
-            });
-            expect(providerTokens(dynamicModule.providers)).not.toContain(_emailconstants.EMAIL_MODULE_OPTIONS);
-        });
-    });
-});

package/cjs/modules/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./email.module"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}

package/cjs/providers/email-factory.service.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "EmailFactoryService", {
-    enumerable: true,
-    get: function() {
-        return EmailFactoryService;
-    }
-});
-const _nestjsshared = require("@flusys/nestjs-shared");
-const _common = require("@nestjs/common");
-const _crypto = require("crypto");
-const _config = require("../config");
-const _interfaces = require("../interfaces");
-const _emailproviderregistry = require("./email-provider.registry");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    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;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-let EmailFactoryService = class EmailFactoryService {
-    // ─── Public API ─────────────────────────────────────────────────────────────
-    async createProvider(config) {
-        const cacheKey = this.generateCacheKey(config);
-        const cached = this.providerCache.get(cacheKey);
-        if (cached) return cached;
-        const ProviderClass = _emailproviderregistry.EmailProviderRegistry.get(config.provider);
-        if (!ProviderClass) {
-            throw new _common.NotFoundException({
-                message: `Email provider '${config.provider}' is not registered`,
-                messageKey: _config.EMAIL_SEND_MESSAGES.CONFIG_NOT_FOUND,
-                messageVariables: {
-                    provider: config.provider,
-                    available: _emailproviderregistry.EmailProviderRegistry.getAll().join(', ')
-                }
-            });
-        }
-        try {
-            const instance = new ProviderClass();
-            await instance.initialize?.(config.config);
-            this.providerCache.set(cacheKey, instance);
-            return instance;
-        } catch (error) {
-            throw new _common.InternalServerErrorException({
-                message: `Email provider '${config.provider}' not initialized successfully: ${this.extractErrorMessage(error)}`,
-                messageKey: _nestjsshared.SYSTEM_MESSAGES.SERVICE_NOT_AVAILABLE,
-                messageVariables: {
-                    provider: config.provider,
-                    available: _emailproviderregistry.EmailProviderRegistry.getAll().join(', ')
-                }
-            });
-        }
-    }
-    // ─── Lifecycle ──────────────────────────────────────────────────────────────
-    async onModuleDestroy() {
-        const closePromises = Array.from(this.providerCache.entries()).map(([, provider])=>this.closeProvider(provider));
-        await Promise.allSettled(closePromises);
-        this.providerCache.clear();
-    }
-    // ─── Private Helpers ────────────────────────────────────────────────────────
-    generateCacheKey(config) {
-        const sortedKeys = Object.keys(config.config || {}).sort();
-        const configString = JSON.stringify(config.config, sortedKeys);
-        const hash = (0, _crypto.createHash)('sha256').update(configString).digest('hex').substring(0, 16);
-        return `${config.provider}-${hash}`;
-    }
-    async closeProvider(provider) {
-        if (!provider.close) return;
-        try {
-            await provider.close();
-        } catch  {
-        // Silent failure
-        }
-    }
-    extractErrorMessage(error) {
-        return error instanceof Error ? error.message : 'Unknown error';
-    }
-    constructor(){
-        _define_property(this, "providerCache", new Map());
-    }
-};
-_ts_decorate([
-    (0, _nestjsshared.LogAction)({
-        action: 'email.createProvider',
-        module: 'email'
-    }),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _interfaces.IEmailProviderConfig === "undefined" ? Object : _interfaces.IEmailProviderConfig
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], EmailFactoryService.prototype, "createProvider", null);
-EmailFactoryService = _ts_decorate([
-    (0, _common.Injectable)()
-], EmailFactoryService);

package/cjs/providers/email-factory.service.spec.js

@@ -1,242 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _common = require("@nestjs/common");
-const _emailfactoryservice = require("./email-factory.service");
-const _emailproviderregistry = require("./email-provider.registry");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-let FakeSuccessProvider = class FakeSuccessProvider {
-    async initialize(_config) {
-        FakeSuccessProvider.initializeCalls += 1;
-    }
-    async sendEmail(_options) {
-        return {
-            success: true
-        };
-    }
-    async sendBulkEmails(_options) {
-        return [];
-    }
-    async healthCheck() {
-        return true;
-    }
-    async close() {
-        this.closeCalled = true;
-    }
-    constructor(){
-        _define_property(this, "closeCalled", false);
-        FakeSuccessProvider.instances.push(this);
-    }
-};
-_define_property(FakeSuccessProvider, "initializeCalls", 0);
-_define_property(FakeSuccessProvider, "instances", []);
-let FakeFailingInitProvider = class FakeFailingInitProvider {
-    async initialize(_config) {
-        throw new Error('boom during init');
-    }
-    async sendEmail(_options) {
-        return {
-            success: true
-        };
-    }
-    async sendBulkEmails(_options) {
-        return [];
-    }
-    async healthCheck() {
-        return true;
-    }
-};
-let FakeNoInitializeProvider = class FakeNoInitializeProvider {
-    async sendEmail(_options) {
-        return {
-            success: true
-        };
-    }
-    async sendBulkEmails(_options) {
-        return [];
-    }
-    async healthCheck() {
-        return true;
-    }
-};
-describe('EmailFactoryService', ()=>{
-    let service;
-    beforeEach(()=>{
-        service = new _emailfactoryservice.EmailFactoryService();
-        _emailproviderregistry.EmailProviderRegistry.clear();
-        FakeSuccessProvider.initializeCalls = 0;
-        FakeSuccessProvider.instances = [];
-    });
-    afterEach(()=>{
-        _emailproviderregistry.EmailProviderRegistry.clear();
-    });
-    describe('createProvider', ()=>{
-        it('throws NotFoundException when the provider is not registered', async ()=>{
-            const config = {
-                provider: 'unknown',
-                config: {}
-            };
-            await expect(service.createProvider(config)).rejects.toThrow(_common.NotFoundException);
-        });
-        it('throws NotFoundException with the config-not-found messageKey and available list', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const config = {
-                provider: 'unknown',
-                config: {}
-            };
-            try {
-                await service.createProvider(config);
-                fail('expected createProvider to throw');
-            } catch (error) {
-                expect(error).toBeInstanceOf(_common.NotFoundException);
-                expect(error.getResponse()).toEqual(expect.objectContaining({
-                    messageKey: 'email.send.config.not.found'
-                }));
-            }
-        });
-        it('instantiates and initializes the provider on cache miss', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const config = {
-                provider: 'smtp',
-                config: {
-                    host: 'localhost'
-                }
-            };
-            const provider = await service.createProvider(config);
-            expect(provider).toBeInstanceOf(FakeSuccessProvider);
-            expect(FakeSuccessProvider.initializeCalls).toBe(1);
-        });
-        it('returns the cached provider instance for an identical config (no re-initialization)', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const config = {
-                provider: 'smtp',
-                config: {
-                    host: 'localhost'
-                }
-            };
-            const first = await service.createProvider(config);
-            const second = await service.createProvider(config);
-            expect(second).toBe(first);
-            expect(FakeSuccessProvider.initializeCalls).toBe(1);
-        });
-        it('creates a distinct cached instance for a different config on the same provider', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const first = await service.createProvider({
-                provider: 'smtp',
-                config: {
-                    host: 'a'
-                }
-            });
-            const second = await service.createProvider({
-                provider: 'smtp',
-                config: {
-                    host: 'b'
-                }
-            });
-            expect(second).not.toBe(first);
-            expect(FakeSuccessProvider.initializeCalls).toBe(2);
-        });
-        it('is insensitive to key ordering when hashing the config for the cache key', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const first = await service.createProvider({
-                provider: 'smtp',
-                config: {
-                    a: 1,
-                    b: 2
-                }
-            });
-            const second = await service.createProvider({
-                provider: 'smtp',
-                config: {
-                    b: 2,
-                    a: 1
-                }
-            });
-            expect(second).toBe(first);
-            expect(FakeSuccessProvider.initializeCalls).toBe(1);
-        });
-        it('does not call initialize when the provider class has no initialize method', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeNoInitializeProvider);
-            const config = {
-                provider: 'smtp',
-                config: {}
-            };
-            const provider = await service.createProvider(config);
-            expect(provider).toBeInstanceOf(FakeNoInitializeProvider);
-        });
-        it('wraps initialize() failures in InternalServerErrorException with SDK_NOT_INSTALLED messageKey', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('mailgun', FakeFailingInitProvider);
-            const config = {
-                provider: 'mailgun',
-                config: {}
-            };
-            try {
-                await service.createProvider(config);
-                fail('expected createProvider to throw');
-            } catch (error) {
-                expect(error).toBeInstanceOf(_common.InternalServerErrorException);
-                expect(error.getResponse()).toEqual(expect.objectContaining({
-                    messageKey: 'system.service.not.available'
-                }));
-                expect(error.getResponse().message).toContain('boom during init');
-            }
-        });
-        it('does not cache a provider that failed to initialize', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('mailgun', FakeFailingInitProvider);
-            const config = {
-                provider: 'mailgun',
-                config: {}
-            };
-            await expect(service.createProvider(config)).rejects.toThrow();
-            // second attempt should also go through the (still failing) initialization path
-            await expect(service.createProvider(config)).rejects.toThrow();
-        });
-    });
-    describe('onModuleDestroy', ()=>{
-        it('closes every cached provider and clears the cache', async ()=>{
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            const provider = await service.createProvider({
-                provider: 'smtp',
-                config: {}
-            });
-            await service.onModuleDestroy();
-            expect(provider.closeCalled).toBe(true);
-            // cache cleared -> a subsequent createProvider call re-initializes
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeSuccessProvider);
-            await service.createProvider({
-                provider: 'smtp',
-                config: {}
-            });
-            expect(FakeSuccessProvider.initializeCalls).toBe(2);
-        });
-        it('does not throw when a provider close() call rejects', async ()=>{
-            let FakeThrowingCloseProvider = class FakeThrowingCloseProvider extends FakeSuccessProvider {
-                async close() {
-                    throw new Error('close failed');
-                }
-            };
-            _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeThrowingCloseProvider);
-            await service.createProvider({
-                provider: 'smtp',
-                config: {}
-            });
-            await expect(service.onModuleDestroy()).resolves.toBeUndefined();
-        });
-        it('is a no-op when nothing has been cached', async ()=>{
-            await expect(service.onModuleDestroy()).resolves.toBeUndefined();
-        });
-    });
-});

package/cjs/providers/email-provider.registry.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "EmailProviderRegistry", {
-    enumerable: true,
-    get: function() {
-        return EmailProviderRegistry;
-    }
-});
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-let EmailProviderRegistry = class EmailProviderRegistry {
-    static register(providerName, providerClass) {
-        this.providers.set(providerName.toLowerCase(), providerClass);
-    }
-    static get(providerName) {
-        return this.providers.get(providerName.toLowerCase());
-    }
-    static has(providerName) {
-        return this.providers.has(providerName.toLowerCase());
-    }
-    static getAll() {
-        return Array.from(this.providers.keys());
-    }
-    static clear() {
-        this.providers.clear();
-    }
-};
-_define_property(EmailProviderRegistry, "providers", new Map());

package/cjs/providers/email-provider.registry.spec.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _emailproviderregistry = require("./email-provider.registry");
-let FakeProvider = class FakeProvider {
-    async sendEmail(_options) {
-        return {
-            success: true
-        };
-    }
-    async sendBulkEmails(_options) {
-        return [];
-    }
-    async healthCheck() {
-        return true;
-    }
-};
-describe('EmailProviderRegistry', ()=>{
-    afterEach(()=>{
-        _emailproviderregistry.EmailProviderRegistry.clear();
-    });
-    it('registers and retrieves a provider by exact name', ()=>{
-        _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.get('smtp')).toBe(FakeProvider);
-    });
-    it('normalizes provider names to lowercase on register and lookup', ()=>{
-        _emailproviderregistry.EmailProviderRegistry.register('SendGrid', FakeProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.get('sendgrid')).toBe(FakeProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.get('SENDGRID')).toBe(FakeProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.has('sendgrid')).toBe(true);
-    });
-    it('returns undefined for an unregistered provider', ()=>{
-        expect(_emailproviderregistry.EmailProviderRegistry.get('unknown-provider')).toBeUndefined();
-        expect(_emailproviderregistry.EmailProviderRegistry.has('unknown-provider')).toBe(false);
-    });
-    it('lists all registered provider names', ()=>{
-        _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeProvider);
-        _emailproviderregistry.EmailProviderRegistry.register('mailgun', FakeProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.getAll().sort()).toEqual([
-            'mailgun',
-            'smtp'
-        ]);
-    });
-    it('clears all registered providers', ()=>{
-        _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeProvider);
-        _emailproviderregistry.EmailProviderRegistry.clear();
-        expect(_emailproviderregistry.EmailProviderRegistry.getAll()).toEqual([]);
-        expect(_emailproviderregistry.EmailProviderRegistry.has('smtp')).toBe(false);
-    });
-    it('overwrites a previously registered provider for the same name', ()=>{
-        let OtherProvider = class OtherProvider extends FakeProvider {
-        };
-        _emailproviderregistry.EmailProviderRegistry.register('smtp', FakeProvider);
-        _emailproviderregistry.EmailProviderRegistry.register('smtp', OtherProvider);
-        expect(_emailproviderregistry.EmailProviderRegistry.get('smtp')).toBe(OtherProvider);
-    });
-});

package/cjs/providers/index.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./email-provider.registry"), exports);
-_export_star(require("./email-factory.service"), exports);
-_export_star(require("./smtp-provider"), exports);
-_export_star(require("./sendgrid-provider"), exports);
-_export_star(require("./mailgun-provider"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}