@flusys/nestjs-email 7.1.0 → 8.0.0

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

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "emailSwaggerConfig", {
-    enumerable: true,
-    get: function() {
-        return emailSwaggerConfig;
-    }
-});
-/** 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
-`;
-}
-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/cjs/docs/email-swagger.config.spec.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _emailswaggerconfig = require("./email-swagger.config");
-describe('emailSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = (0, _emailswaggerconfig.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 = (0, _emailswaggerconfig.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 = (0, _emailswaggerconfig.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 = (0, _emailswaggerconfig.emailSwaggerConfig)({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = (0, _emailswaggerconfig.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 = (0, _emailswaggerconfig.emailSwaggerConfig)({
-            databaseMode: 'multi-tenant'
-        });
-        const single = (0, _emailswaggerconfig.emailSwaggerConfig)({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});

package/cjs/docs/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "emailSwaggerConfig", {
-    enumerable: true,
-    get: function() {
-        return _emailswaggerconfig.emailSwaggerConfig;
-    }
-});
-const _emailswaggerconfig = require("./email-swagger.config");

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

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