@flusys/nestjs-email 7.1.0 → 8.0.0-beta.1

package/fesm/services/email-template.service.js

@@ -1,134 +0,0 @@
-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);
-}
-function _ts_param(paramIndex, decorator) {
-    return function(target, key) {
-        decorator(target, key, paramIndex);
-    };
-}
-import { HybridCache, ApiService } from '@flusys/nestjs-shared/classes';
-import { UtilsService } from '@flusys/nestjs-shared/modules';
-import { applyCompanyFilter, buildCompanyWhereCondition } from '@flusys/nestjs-shared/utils';
-import { Inject, Injectable, Scope } from '@nestjs/common';
-import { EMAIL_EVENT_ENTITIES, EMAIL_EVENT_MODULE } from '../config';
-import { EmailTemplate, EmailTemplateWithCompany } from '../entities';
-import { EmailConfigService } from './email-config.service';
-import { EmailDataSourceProvider } from './email-datasource.provider';
-const DEFAULT_SELECT_FIELDS = [
-    'id',
-    'name',
-    'slug',
-    'description',
-    'subject',
-    'schema',
-    'htmlContent',
-    'textContent',
-    'schemaVersion',
-    'isActive',
-    'isHtml',
-    'createdAt',
-    'updatedAt'
-];
-export class EmailTemplateService extends ApiService {
-    async convertSingleDtoToEntity(dto, user) {
-        const entity = await super.convertSingleDtoToEntity(dto, user);
-        await this.incrementSchemaVersionIfChanged(dto, entity);
-        if (this.emailConfig.isCompanyFeatureEnabled()) {
-            entity.companyId = user?.companyId ?? null;
-        }
-        return entity;
-    }
-    async getSelectQuery(query, _user, select) {
-        if (!select?.length) {
-            select = [
-                ...DEFAULT_SELECT_FIELDS
-            ];
-            if (this.emailConfig.isCompanyFeatureEnabled()) select.push('companyId');
-        }
-        query.select(select.map((field)=>`${this.entityName}.${field}`));
-        return {
-            query,
-            isRaw: false
-        };
-    }
-    async getExtraManipulateQuery(query, filterDto, user) {
-        const result = await super.getExtraManipulateQuery(query, filterDto, user);
-        applyCompanyFilter(query, {
-            isCompanyFeatureEnabled: this.emailConfig.isCompanyFeatureEnabled(),
-            entityAlias: 'emailTemplate'
-        }, user);
-        query.orderBy(`${this.entityName}.createdAt`, 'DESC');
-        return result;
-    }
-    // ─── Public Query Methods ───────────────────────────────────────────────────
-    async findByIdDirect(id) {
-        await this.ensureDataSourceRepository();
-        return this.repository.findOne({
-            where: {
-                id
-            }
-        });
-    }
-    async findBySlug(slug, user) {
-        await this.ensureDataSourceRepository();
-        const where = buildCompanyWhereCondition({
-            slug,
-            isActive: true
-        }, this.emailConfig.isCompanyFeatureEnabled(), user);
-        return this.repository.findOne({
-            where
-        });
-    }
-    // ─── Private Helpers ────────────────────────────────────────────────────────
-    async incrementSchemaVersionIfChanged(dto, entity) {
-        const updateDto = dto;
-        if (!updateDto.id || !dto.schema) return;
-        await this.ensureDataSourceRepository();
-        const existing = await this.repository.findOne({
-            where: {
-                id: updateDto.id
-            }
-        });
-        if (existing && JSON.stringify(dto.schema) !== JSON.stringify(existing.schema)) {
-            entity.schemaVersion = existing.schemaVersion + 1;
-        }
-    }
-    constructor(cacheManager, utilsService, emailConfig, dataSourceProvider){
-        super(EMAIL_EVENT_ENTITIES.TEMPLATE, cacheManager, utilsService, EmailTemplateService.name, true, EMAIL_EVENT_MODULE, dataSourceProvider, emailConfig.isCompanyFeatureEnabled() ? EmailTemplateWithCompany : EmailTemplate), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), _define_property(this, "emailConfig", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService, this.emailConfig = emailConfig;
-    }
-}
-EmailTemplateService = _ts_decorate([
-    Injectable({
-        scope: Scope.REQUEST
-    }),
-    _ts_param(0, Inject('CACHE_INSTANCE')),
-    _ts_param(1, Inject(UtilsService)),
-    _ts_param(2, Inject(EmailConfigService)),
-    _ts_param(3, Inject(EmailDataSourceProvider)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof HybridCache === "undefined" ? Object : HybridCache,
-        typeof UtilsService === "undefined" ? Object : UtilsService,
-        typeof EmailConfigService === "undefined" ? Object : EmailConfigService,
-        typeof EmailDataSourceProvider === "undefined" ? Object : EmailDataSourceProvider
-    ])
-], EmailTemplateService);

package/fesm/services/email-template.service.spec.js

@@ -1,257 +0,0 @@
-import { Test } from '@nestjs/testing';
-import { UtilsService } from '@flusys/nestjs-shared/modules';
-import { createMockDataSourceProvider, createMockRepository } from '@test-utils/mocks/repository.mock';
-import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
-import { EmailTemplate, EmailTemplateWithCompany } from '../entities';
-import { EmailConfigService } from './email-config.service';
-import { EmailDataSourceProvider } from './email-datasource.provider';
-import { EmailTemplateService } from './email-template.service';
-function buildTemplate(overrides = {}) {
-    return {
-        id: 'template-uuid-1',
-        name: 'Welcome Email',
-        slug: 'welcome-email',
-        description: null,
-        subject: 'Welcome {{firstName}}!',
-        schema: {
-            fields: []
-        },
-        htmlContent: '<h1>Welcome {{firstName}}!</h1>',
-        textContent: 'Welcome {{firstName}}!',
-        schemaVersion: 1,
-        isActive: true,
-        isHtml: true,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        deletedAt: null,
-        createdById: null,
-        updatedById: null,
-        deletedById: null,
-        ...overrides
-    };
-}
-function buildQuery() {
-    return {
-        select: jest.fn().mockReturnThis(),
-        andWhere: jest.fn().mockReturnThis(),
-        orderBy: jest.fn().mockReturnThis()
-    };
-}
-describe('EmailTemplateService', ()=>{
-    let service;
-    let module;
-    let mockRepo;
-    let mockEmailConfig;
-    beforeEach(async ()=>{
-        mockRepo = createMockRepository();
-        const mockDataSourceProvider = createMockDataSourceProvider(mockRepo);
-        mockEmailConfig = {
-            isCompanyFeatureEnabled: jest.fn().mockReturnValue(false)
-        };
-        module = await Test.createTestingModule({
-            providers: [
-                EmailTemplateService,
-                {
-                    provide: 'CACHE_INSTANCE',
-                    useValue: {}
-                },
-                {
-                    provide: UtilsService,
-                    useValue: {}
-                },
-                {
-                    provide: EmailConfigService,
-                    useValue: mockEmailConfig
-                },
-                {
-                    provide: EmailDataSourceProvider,
-                    useValue: mockDataSourceProvider
-                }
-            ]
-        }).compile();
-        service = await module.resolve(EmailTemplateService);
-        // convertSingleDtoToEntity accesses `this.repository` directly; normally it is
-        // lazily initialized by insert()/update() via ensureDataSourceRepository() first.
-        await service.ensureDataSourceRepository();
-    });
-    describe('entity selection', ()=>{
-        it('uses EmailTemplate when the company feature is disabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(false);
-            const built = await module.resolve(EmailTemplateService);
-            expect(built['_entity']).toBe(EmailTemplate);
-        });
-        it('uses EmailTemplateWithCompany when the company feature is enabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
-            const built = await module.resolve(EmailTemplateService);
-            expect(built['_entity']).toBe(EmailTemplateWithCompany);
-        });
-    });
-    describe('convertSingleDtoToEntity', ()=>{
-        it('creates a new entity (no schema-version bump) for an insert without id', async ()=>{
-            mockRepo.create.mockReturnValue({});
-            const entity = await service.convertSingleDtoToEntity({
-                name: 'Welcome',
-                slug: 'welcome',
-                subject: 'Hi {{name}}',
-                schema: {
-                    fields: []
-                },
-                htmlContent: '<p>Hi {{name}}</p>'
-            }, buildMockUser());
-            expect(entity.schemaVersion).toBeUndefined();
-            expect(mockRepo.findOne).not.toHaveBeenCalled();
-        });
-        it('increments schemaVersion on update when the schema payload changed', async ()=>{
-            // convertSingleDtoToEntity (ApiService base) mutates the fetched row in place via
-            // Object.assign, and incrementSchemaVersionIfChanged re-fetches by id afterwards —
-            // so the mock must return a fresh clone per call, like a real repository would.
-            mockRepo.findOne.mockImplementation(async ()=>buildTemplate({
-                    schema: {
-                        fields: []
-                    },
-                    schemaVersion: 3
-                }));
-            const entity = await service.convertSingleDtoToEntity({
-                id: 'template-uuid-1',
-                schema: {
-                    fields: [
-                        {
-                            name: 'x'
-                        }
-                    ]
-                }
-            }, buildMockUser());
-            expect(entity.schemaVersion).toBe(4);
-        });
-        it('does not increment schemaVersion on update when the schema payload is unchanged', async ()=>{
-            mockRepo.findOne.mockImplementation(async ()=>buildTemplate({
-                    schema: {
-                        fields: []
-                    },
-                    schemaVersion: 3
-                }));
-            const entity = await service.convertSingleDtoToEntity({
-                id: 'template-uuid-1',
-                schema: {
-                    fields: []
-                }
-            }, buildMockUser());
-            expect(entity.schemaVersion).toBe(3);
-        });
-        it('does not touch schemaVersion when the update payload has no schema field', async ()=>{
-            const existing = buildTemplate({
-                schema: {
-                    fields: []
-                },
-                schemaVersion: 3
-            });
-            mockRepo.findOne.mockResolvedValue(existing);
-            const entity = await service.convertSingleDtoToEntity({
-                id: 'template-uuid-1',
-                name: 'Renamed'
-            }, buildMockUser());
-            expect(entity.schemaVersion).toBe(3);
-            // ensureDataSourceRepository/findOne should only be hit once — by the base
-            // convertSingleDtoToEntity — not a second time by incrementSchemaVersionIfChanged.
-            expect(mockRepo.findOne).toHaveBeenCalledTimes(1);
-        });
-        it('attaches the current user companyId when the company feature is enabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
-            mockRepo.create.mockReturnValue({});
-            const entity = await service.convertSingleDtoToEntity({
-                name: 'Welcome',
-                slug: 'welcome',
-                subject: 'Hi',
-                schema: {},
-                htmlContent: '<p/>'
-            }, buildMockUser({
-                companyId: 'company-uuid-7'
-            }));
-            expect(entity.companyId).toBe('company-uuid-7');
-        });
-    });
-    describe('getSelectQuery', ()=>{
-        it('selects the default whitelisted fields (without companyId) when company feature is disabled', async ()=>{
-            const query = buildQuery();
-            await service.getSelectQuery(query, buildMockUser());
-            const [selected] = query.select.mock.calls[0];
-            expect(selected).toEqual(expect.arrayContaining([
-                'emailTemplate.id',
-                'emailTemplate.name',
-                'emailTemplate.slug',
-                'emailTemplate.subject',
-                'emailTemplate.htmlContent',
-                'emailTemplate.textContent',
-                'emailTemplate.schemaVersion',
-                'emailTemplate.isActive',
-                'emailTemplate.isHtml'
-            ]));
-            expect(selected).not.toContain('emailTemplate.companyId');
-        });
-        it('appends companyId to the default field list when company feature is enabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
-            const query = buildQuery();
-            await service.getSelectQuery(query, buildMockUser());
-            const [selected] = query.select.mock.calls[0];
-            expect(selected).toContain('emailTemplate.companyId');
-        });
-    });
-    describe('getExtraManipulateQuery', ()=>{
-        it('applies the company filter and orders by createdAt DESC when company feature is enabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
-            const query = buildQuery();
-            await service.getExtraManipulateQuery(query, {}, buildMockUser({
-                companyId: 'c-1'
-            }));
-            expect(query.andWhere).toHaveBeenCalledWith('emailTemplate.companyId = :companyId', {
-                companyId: 'c-1'
-            });
-            expect(query.orderBy).toHaveBeenCalledWith('emailTemplate.createdAt', 'DESC');
-        });
-    });
-    describe('findByIdDirect', ()=>{
-        it('returns the matching template', async ()=>{
-            const template = buildTemplate();
-            mockRepo.findOne.mockResolvedValue(template);
-            const result = await service.findByIdDirect('template-uuid-1');
-            expect(result).toBe(template);
-            expect(mockRepo.findOne).toHaveBeenCalledWith({
-                where: {
-                    id: 'template-uuid-1'
-                }
-            });
-        });
-    });
-    describe('findBySlug', ()=>{
-        it('finds an active template by slug', async ()=>{
-            const template = buildTemplate();
-            mockRepo.findOne.mockResolvedValue(template);
-            const result = await service.findBySlug('welcome-email', buildMockUser());
-            expect(result).toBe(template);
-            expect(mockRepo.findOne).toHaveBeenCalledWith({
-                where: {
-                    slug: 'welcome-email',
-                    isActive: true
-                }
-            });
-        });
-        it('scopes the slug lookup to the current company when the company feature is enabled', async ()=>{
-            mockEmailConfig.isCompanyFeatureEnabled.mockReturnValue(true);
-            mockRepo.findOne.mockResolvedValue(null);
-            await service.findBySlug('welcome-email', buildMockUser({
-                companyId: 'company-uuid-3'
-            }));
-            expect(mockRepo.findOne).toHaveBeenCalledWith({
-                where: {
-                    slug: 'welcome-email',
-                    isActive: true,
-                    companyId: 'company-uuid-3'
-                }
-            });
-        });
-        it('returns null when no template matches the slug', async ()=>{
-            mockRepo.findOne.mockResolvedValue(null);
-            await expect(service.findBySlug('missing-slug', buildMockUser())).resolves.toBeNull();
-        });
-    });
-});

package/fesm/utils/email-templates.util.js

@@ -1,47 +0,0 @@
-// ─── Shared Styles ───────────────────────────────────────────────────────────
-const BASE_STYLES = `
-  body { font-family: Arial, sans-serif; background-color: #f4f4f7; margin: 0; padding: 0; }
-  .email-container { max-width: 500px; margin: 40px auto; background-color: #ffffff; padding: 30px; border-radius: 8px; box-shadow: 0 2px 6px rgba(0,0,0,0.1); text-align: center; }
-  h1 { color: #333; }
-  p { font-size: 16px; color: #555; }
-  .action-box { display: inline-block; margin: 20px 0; padding: 14px 28px; background-color: #007BFF; color: #ffffff; border-radius: 8px; font-weight: bold; text-decoration: none; }
-`;
-function wrapEmailTemplate(title, extraStyles, content) {
-    return `<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-  <title>${title}</title>
-  <style>${BASE_STYLES}${extraStyles}</style>
-</head>
-<body>
-  <div class="email-container">${content}</div>
-</body>
-</html>`;
-}
-function getGreeting(userName) {
-    return `<p>Hi ${userName || 'Sir/Madam'},</p>`;
-}
-// ─── Public Templates ────────────────────────────────────────────────────────
-export function getOtpEmailFormat(otp, userName) {
-    const extraStyles = `.action-box { font-size: 24px; letter-spacing: 6px; }`;
-    const content = `
-    ${getGreeting(userName)}
-    <p>Use the code below to verify your identity:</p>
-    <div class="action-box">${otp}</div>
-    <p>This OTP is valid for a limited time. Do not share it with anyone.</p>
-    <p>If you didn't request this, please ignore this email.</p>
-  `;
-    return wrapEmailTemplate('Your OTP Code', extraStyles, content);
-}
-export function getResetPasswordEmailFormat(resetLink, userName) {
-    const extraStyles = `.action-box { font-size: 16px; }`;
-    const content = `
-    ${getGreeting(userName)}
-    <p>We received a request to reset your password. Click the button below to reset it:</p>
-    <a href="${resetLink}" class="action-box" target="_blank">Reset Password</a>
-    <p>If you didn't request a password reset, you can safely ignore this email.</p>
-  `;
-    return wrapEmailTemplate('Reset Your Password', extraStyles, content);
-}

package/fesm/utils/email-templates.util.spec.js

@@ -1,57 +0,0 @@
-import { getOtpEmailFormat, getResetPasswordEmailFormat } from './email-templates.util';
-describe('email-templates.util', ()=>{
-    describe('getOtpEmailFormat', ()=>{
-        it('renders the OTP inside the generated HTML document', ()=>{
-            const html = getOtpEmailFormat(123456, 'Jane');
-            expect(html).toContain('<!DOCTYPE html>');
-            expect(html).toContain('123456');
-            expect(html).toContain('Hi Jane,');
-            expect(html).toContain('Your OTP Code');
-        });
-        it('falls back to a generic greeting when userName is not provided', ()=>{
-            const html = getOtpEmailFormat(654321);
-            expect(html).toContain('Hi Sir/Madam,');
-        });
-        it('falls back to a generic greeting when userName is null', ()=>{
-            const html = getOtpEmailFormat(111111, null);
-            expect(html).toContain('Hi Sir/Madam,');
-        });
-        it('does not escape HTML special characters in userName (XSS caveat)', ()=>{
-            const html = getOtpEmailFormat(999999, '<script>alert(1)</script>');
-            // Documents CURRENT behavior: userName is interpolated verbatim, unescaped.
-            expect(html).toContain('<script>alert(1)</script>');
-            expect(html).not.toContain('&lt;script&gt;');
-        });
-        it('includes styling for the OTP action box', ()=>{
-            const html = getOtpEmailFormat(1, 'A');
-            expect(html).toContain('letter-spacing: 6px');
-        });
-    });
-    describe('getResetPasswordEmailFormat', ()=>{
-        it('renders the reset link as the href of the action button', ()=>{
-            const html = getResetPasswordEmailFormat('https://app.example.com/reset?token=abc', 'Bob');
-            expect(html).toContain('href="https://app.example.com/reset?token=abc"');
-            expect(html).toContain('Hi Bob,');
-            expect(html).toContain('Reset Your Password');
-        });
-        it('falls back to a generic greeting when userName is omitted', ()=>{
-            const html = getResetPasswordEmailFormat('https://app.example.com/reset?token=abc');
-            expect(html).toContain('Hi Sir/Madam,');
-        });
-        it('does not escape or validate the reset link (XSS/HTML-injection caveat)', ()=>{
-            const maliciousLink = '"><script>alert(1)</script>';
-            const html = getResetPasswordEmailFormat(maliciousLink, 'Bob');
-            // Documents CURRENT behavior: resetLink is interpolated verbatim, unescaped,
-            // allowing HTML attribute breakout if the value is attacker-influenced.
-            expect(html).toContain(`href="${maliciousLink}"`);
-        });
-        it('does not escape HTML special characters in userName', ()=>{
-            const html = getResetPasswordEmailFormat('https://x.test/reset', '<img src=x onerror=alert(1)>');
-            expect(html).toContain('<img src=x onerror=alert(1)>');
-        });
-        it('produces a single-line action-box style for the reset button', ()=>{
-            const html = getResetPasswordEmailFormat('https://x.test/reset', 'A');
-            expect(html).toContain('font-size: 16px');
-        });
-    });
-});

package/fesm/utils/index.js

@@ -1 +0,0 @@
-export * from './email-templates.util';