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

package/fesm/docs/email-swagger.config.js

@@ -1,109 +0,0 @@
-/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
-    {
-        schemaName: 'EmailConfigResponseDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'EmailTemplateResponseDto',
-        properties: [
-            'companyId'
-        ]
-    }
-];
-function buildDescription(enableCompanyFeature, isMultiTenant) {
-    const multiTenantNote = isMultiTenant ? `\n> **Multi-Tenant Mode**: Include \`x-tenant-id\` header to target a specific tenant database.\n` : '';
-    const companyConfigs = enableCompanyFeature ? '\n- **Company-level email configs**' : '';
-    const companyIsolation = enableCompanyFeature ? '\n- **Company isolation**' : '';
-    const multiTenantSection = enableCompanyFeature ? `
-## Multi-Tenant Support
-
-Emails are automatically isolated by:
-- **Company ID**: Company-level templates and configs
-
-All queries automatically filter by current user's company context.
-` : '';
-    return `
-# Email Management API
-${multiTenantNote}
-Complete email management system${enableCompanyFeature ? ' with multi-tenant and company support' : ''}.
-
-## Features
-
-### 📧 Email Configuration
-- Multiple email providers (SMTP, SendGrid, Mailgun)
-- Provider-specific configurations
-- Default sender settings${companyConfigs}
-
-### 📝 Email Templates
-- Visual template builder
-- Variable interpolation ({{variable}})
-- HTML and plain text support
-- Template versioning${companyIsolation}
-
-### ✉️ Email Sending
-- Direct email sending
-- Template-based sending
-- Attachments support
-- CC/BCC recipients
-
-### 🔒 Security
-- JWT authentication required${companyIsolation}
-- Secure credential storage
-
-## Supported Providers
-
-### SMTP
-- Universal email protocol
-- Custom server support
-- TLS/SSL encryption
-
-### SendGrid (optional)
-- Cloud email service
-- High deliverability
-- Install: \`npm install @sendgrid/mail\`
-
-### Mailgun (optional)
-- Developer-friendly API
-- Detailed analytics
-- Install: \`npm install mailgun.js\`
-
-## Template Variables
-
-Templates support Handlebars-style variables:
-- \`{{userName}}\` - Simple variable
-- \`{{user.email}}\` - Nested properties
-- Variables are replaced at send time
-${multiTenantSection}
-## API Endpoints
-
-All email endpoints are prefixed with \`/email\`:
-- \`/email/email-config/*\` - Email provider configurations
-- \`/email/email-template/*\` - Email templates
-- \`/email/email-send/*\` - Send emails
-
-## Getting Started
-
-1. **Authenticate**: Obtain JWT token from /auth/login
-2. **Configure Provider**: Create email config via /email/email-config/insert
-3. **Create Templates**: Add templates via /email/email-template/insert
-4. **Send Emails**: Send via /email/email-send/send or /email/email-send/send-template
-`;
-}
-/**
- * Email Module Swagger Configuration
- * Use this with setupSwaggerDocs() from @flusys/nestjs-core
- */ export function emailSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    const isMultiTenant = bootstrapConfig?.databaseMode === 'multi-tenant';
-    return {
-        title: 'Email API',
-        description: buildDescription(enableCompanyFeature, isMultiTenant),
-        version: '1.0',
-        path: 'api/docs/email',
-        bearerAuth: true,
-        excludeTags: [],
-        excludeSchemaProperties: enableCompanyFeature ? undefined : COMPANY_SCHEMA_EXCLUSIONS
-    };
-}

package/fesm/docs/email-swagger.config.spec.js

@@ -1,58 +0,0 @@
-import { emailSwaggerConfig } from './email-swagger.config';
-describe('emailSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = emailSwaggerConfig();
-        expect(config.title).toBe('Email API');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.excludeSchemaProperties).toBeUndefined();
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should exclude companyId schema properties when the company feature is disabled', ()=>{
-        const config = emailSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(config.excludeSchemaProperties).toEqual([
-            {
-                schemaName: 'EmailConfigResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'EmailTemplateResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            }
-        ]);
-    });
-    it('should not exclude any schema properties when the company feature is enabled', ()=>{
-        const config = emailSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        expect(config.excludeSchemaProperties).toBeUndefined();
-    });
-    it('should describe company isolation and multi-tenant support only when the company feature is enabled', ()=>{
-        const withCompany = emailSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = emailSwaggerConfig({
-            enableCompanyFeature: false
-        });
-        expect(withCompany.description).toContain('Company isolation');
-        expect(withCompany.description).toContain('## Multi-Tenant Support');
-        expect(withCompany.description).toContain('with multi-tenant and company support');
-        expect(withoutCompany.description).not.toContain('Company isolation');
-        expect(withoutCompany.description).not.toContain('## Multi-Tenant Support');
-    });
-    it('should mention multi-tenant mode in the description only for multi-tenant database mode', ()=>{
-        const multiTenant = emailSwaggerConfig({
-            databaseMode: 'multi-tenant'
-        });
-        const single = emailSwaggerConfig({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});

package/fesm/dtos/email-config.dto.js

@@ -1,191 +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);
-}
-import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
-import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Expose } from 'class-transformer';
-import { IsBoolean, IsEmail, IsEnum, IsNotEmpty, IsObject, IsOptional, IsString, MaxLength } from 'class-validator';
-import { EmailProviderTypeEnum } from '../enums';
-export class CreateEmailConfigDto {
-    constructor(){
-        _define_property(this, "name", void 0);
-        _define_property(this, "provider", void 0);
-        _define_property(this, "config", void 0);
-        _define_property(this, "fromEmail", void 0);
-        _define_property(this, "fromName", void 0);
-        _define_property(this, "isActive", void 0);
-        _define_property(this, "isDefault", void 0);
-    }
-}
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        example: 'Production SMTP'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], CreateEmailConfigDto.prototype, "name", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        enum: EmailProviderTypeEnum,
-        example: EmailProviderTypeEnum.SMTP
-    }),
-    IsEnum(EmailProviderTypeEnum),
-    IsNotEmpty(),
-    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
-], CreateEmailConfigDto.prototype, "provider", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        type: 'object',
-        description: 'Provider-specific configuration (SMTP: host, port, secure, auth)',
-        additionalProperties: true
-    }),
-    IsObject(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], CreateEmailConfigDto.prototype, "config", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        example: 'noreply@example.com'
-    }),
-    IsEmail(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], CreateEmailConfigDto.prototype, "fromEmail", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        example: 'FLUSYS'
-    }),
-    IsString(),
-    IsOptional(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], CreateEmailConfigDto.prototype, "fromName", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        example: true
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], CreateEmailConfigDto.prototype, "isActive", void 0);
-_ts_decorate([
-    Expose(),
-    ApiPropertyOptional({
-        example: false,
-        description: 'Set as default email configuration'
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], CreateEmailConfigDto.prototype, "isDefault", void 0);
-export class UpdateEmailConfigDto extends PartialType(CreateEmailConfigDto) {
-    constructor(...args){
-        super(...args), _define_property(this, "id", void 0);
-    }
-}
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "id", void 0);
-export class EmailConfigResponseDto extends IdentityResponseDto {
-    constructor(...args){
-        super(...args), _define_property(this, "name", void 0), _define_property(this, "provider", void 0), _define_property(this, "config", void 0), _define_property(this, "fromEmail", void 0), _define_property(this, "fromName", void 0), _define_property(this, "isActive", void 0), _define_property(this, "isDefault", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Human-readable name for this email configuration',
-        example: 'Primary Transactional Email'
-    }),
-    Expose(),
-    _ts_metadata("design:type", String)
-], EmailConfigResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'The email provider type used for this configuration',
-        enum: EmailProviderTypeEnum,
-        example: EmailProviderTypeEnum.SMTP
-    }),
-    Expose(),
-    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
-], EmailConfigResponseDto.prototype, "provider", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Provider-specific configuration key-value pairs',
-        type: 'object',
-        additionalProperties: true,
-        example: {
-            host: 'smtp.example.com',
-            port: 587,
-            secure: true
-        }
-    }),
-    Expose(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], EmailConfigResponseDto.prototype, "config", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'The email address used in the "From" field',
-        example: 'no-reply@example.com',
-        nullable: true
-    }),
-    Expose(),
-    _ts_metadata("design:type", Object)
-], EmailConfigResponseDto.prototype, "fromEmail", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'The display name used in the "From" field',
-        example: 'Acme Notifications',
-        nullable: true
-    }),
-    Expose(),
-    _ts_metadata("design:type", Object)
-], EmailConfigResponseDto.prototype, "fromName", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Whether this email configuration is currently active',
-        example: true
-    }),
-    Expose(),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigResponseDto.prototype, "isActive", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Whether this is the default email configuration',
-        example: false
-    }),
-    Expose(),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigResponseDto.prototype, "isDefault", void 0);

package/fesm/dtos/email-send.dto.js

@@ -1,324 +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);
-}
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { IsArray, IsEmail, IsNotEmpty, IsObject, IsOptional, IsString, IsUUID, registerDecorator, ValidateNested, ValidatorConstraint } from 'class-validator';
-import { Type } from 'class-transformer';
-export class IsEmailOrEmailArrayConstraint {
-    validate(value) {
-        if (typeof value === 'string') {
-            return this.emailRegex.test(value);
-        }
-        if (Array.isArray(value)) {
-            return value.length > 0 && value.every((email)=>typeof email === 'string' && this.emailRegex.test(email));
-        }
-        return false;
-    }
-    defaultMessage(args) {
-        const value = args.value;
-        if (Array.isArray(value)) {
-            const invalidEmails = value.filter((v)=>typeof v !== 'string' || !this.emailRegex.test(v));
-            return `Invalid email(s) in array: ${invalidEmails.join(', ')}`;
-        }
-        return `${args.property} must be a valid email address or array of email addresses`;
-    }
-    constructor(){
-        _define_property(this, "emailRegex", /^[^\s@]+@[^\s@]+\.[^\s@]+$/);
-    }
-}
-IsEmailOrEmailArrayConstraint = _ts_decorate([
-    ValidatorConstraint({
-        name: 'isEmailOrEmailArray',
-        async: false
-    })
-], IsEmailOrEmailArrayConstraint);
-function IsEmailOrEmailArray(validationOptions) {
-    return function(object, propertyName) {
-        registerDecorator({
-            name: 'isEmailOrEmailArray',
-            target: object.constructor,
-            propertyName,
-            options: validationOptions,
-            validator: IsEmailOrEmailArrayConstraint
-        });
-    };
-}
-function RequireTemplateIdOrSlug(validationOptions) {
-    return function(object, propertyName) {
-        registerDecorator({
-            name: 'requireTemplateIdOrSlug',
-            target: object.constructor,
-            propertyName,
-            options: validationOptions,
-            validator: {
-                validate (_value, args) {
-                    const obj = args.object;
-                    return !!(obj.templateId || obj.templateSlug);
-                },
-                defaultMessage () {
-                    return 'Either templateId or templateSlug must be provided';
-                }
-            }
-        });
-    };
-}
-export class EmailAttachmentDto {
-    constructor(){
-        _define_property(this, "filename", void 0);
-        _define_property(this, "content", void 0);
-        _define_property(this, "contentType", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        example: 'document.pdf'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], EmailAttachmentDto.prototype, "filename", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Base64 encoded content'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], EmailAttachmentDto.prototype, "content", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'application/pdf'
-    }),
-    IsString(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], EmailAttachmentDto.prototype, "contentType", void 0);
-/** Base class for common email fields (recipients, sender, attachments) */ let BaseEmailDto = class BaseEmailDto {
-    constructor(){
-        _define_property(this, "to", void 0);
-        _define_property(this, "cc", void 0);
-        _define_property(this, "bcc", void 0);
-        _define_property(this, "from", void 0);
-        _define_property(this, "fromName", void 0);
-        _define_property(this, "replyTo", void 0);
-        _define_property(this, "emailConfigId", void 0);
-        _define_property(this, "attachments", void 0);
-    }
-};
-_ts_decorate([
-    ApiProperty({
-        example: 'user@example.com',
-        description: 'Recipient email(s) - single email or array of emails',
-        oneOf: [
-            {
-                type: 'string'
-            },
-            {
-                type: 'array',
-                items: {
-                    type: 'string'
-                }
-            }
-        ]
-    }),
-    IsNotEmpty(),
-    IsEmailOrEmailArray(),
-    _ts_metadata("design:type", Object)
-], BaseEmailDto.prototype, "to", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'CC recipients - single email or array'
-    }),
-    IsOptional(),
-    IsEmailOrEmailArray(),
-    _ts_metadata("design:type", Object)
-], BaseEmailDto.prototype, "cc", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'BCC recipients - single email or array'
-    }),
-    IsOptional(),
-    IsEmailOrEmailArray(),
-    _ts_metadata("design:type", Object)
-], BaseEmailDto.prototype, "bcc", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'sender@example.com'
-    }),
-    IsEmail(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], BaseEmailDto.prototype, "from", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'FLUSYS'
-    }),
-    IsString(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], BaseEmailDto.prototype, "fromName", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'reply@example.com'
-    }),
-    IsEmail(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], BaseEmailDto.prototype, "replyTo", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'Email configuration ID to use'
-    }),
-    IsUUID(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], BaseEmailDto.prototype, "emailConfigId", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        type: [
-            EmailAttachmentDto
-        ]
-    }),
-    IsArray(),
-    ValidateNested({
-        each: true
-    }),
-    Type(()=>EmailAttachmentDto),
-    IsOptional(),
-    _ts_metadata("design:type", Array)
-], BaseEmailDto.prototype, "attachments", void 0);
-export class SendEmailDto extends BaseEmailDto {
-    constructor(...args){
-        super(...args), _define_property(this, "subject", void 0), _define_property(this, "html", void 0), _define_property(this, "text", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        example: 'Welcome to our platform!'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], SendEmailDto.prototype, "subject", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: '<h1>Hello!</h1><p>Welcome to our platform.</p>'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], SendEmailDto.prototype, "html", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'Hello! Welcome to our platform.'
-    }),
-    IsString(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], SendEmailDto.prototype, "text", void 0);
-export class SendTemplateEmailDto extends BaseEmailDto {
-    constructor(...args){
-        super(...args), _define_property(this, "templateId", void 0), _define_property(this, "templateSlug", void 0), _define_property(this, "variables", void 0);
-    }
-}
-_ts_decorate([
-    ApiPropertyOptional({
-        description: 'Template ID (required if templateSlug not provided)'
-    }),
-    IsUUID(),
-    IsOptional(),
-    RequireTemplateIdOrSlug({
-        message: 'Either templateId or templateSlug must be provided'
-    }),
-    _ts_metadata("design:type", String)
-], SendTemplateEmailDto.prototype, "templateId", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'welcome-email',
-        description: 'Template slug (required if templateId not provided)'
-    }),
-    IsString(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], SendTemplateEmailDto.prototype, "templateSlug", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        type: 'object',
-        additionalProperties: true,
-        example: {
-            userName: 'John',
-            activationLink: 'https://...'
-        },
-        description: 'Template variables to interpolate'
-    }),
-    IsObject(),
-    IsOptional(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], SendTemplateEmailDto.prototype, "variables", void 0);
-export class TestEmailDto {
-    constructor(){
-        _define_property(this, "emailConfigId", void 0);
-        _define_property(this, "recipient", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Email configuration ID'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], TestEmailDto.prototype, "emailConfigId", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: 'test@example.com',
-        description: 'Test recipient'
-    }),
-    IsEmail(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], TestEmailDto.prototype, "recipient", void 0);
-export class EmailSendResultDto {
-    constructor(){
-        _define_property(this, "success", void 0);
-        _define_property(this, "messageId", void 0);
-        _define_property(this, "error", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        example: true
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailSendResultDto.prototype, "success", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: '<message-id@mail.example.com>'
-    }),
-    _ts_metadata("design:type", String)
-], EmailSendResultDto.prototype, "messageId", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'Connection refused'
-    }),
-    _ts_metadata("design:type", String)
-], EmailSendResultDto.prototype, "error", void 0);