@flusys/nestjs-email 1.1.0-beta → 1.1.0

package/cjs/controllers/email-send.controller.js

@@ -8,8 +8,8 @@ Object.defineProperty(exports, "EmailSendController", {
         return EmailSendController;
     }
 });
-const _guards = require("@flusys/nestjs-shared/guards");
 const _decorators = require("@flusys/nestjs-shared/decorators");
+const _guards = require("@flusys/nestjs-shared/guards");
 const _interfaces = require("@flusys/nestjs-shared/interfaces");
 const _common = require("@nestjs/common");
 const _swagger = require("@nestjs/swagger");
@@ -43,38 +43,22 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 let EmailSendController = class EmailSendController {
-    /**
-   * Send email directly (without template)
-   */ async sendEmail(dto, user) {
+    async sendEmail(dto, user) {
         const result = await this.emailSendService.sendEmail(dto, user);
-        return {
-            success: result.success,
-            data: {
-                success: result.success,
-                messageId: result.messageId,
-                error: result.error
-            }
-        };
+        return this.toResponse(result, 'Email');
     }
-    /**
-   * Send email using template
-   */ async sendTemplateEmail(dto, user) {
+    async sendTemplateEmail(dto, user) {
         const result = await this.emailSendService.sendTemplateEmail(dto, user);
-        return {
-            success: result.success,
-            data: {
-                success: result.success,
-                messageId: result.messageId,
-                error: result.error
-            }
-        };
+        return this.toResponse(result, 'Template email');
     }
-    /**
-   * Send test email (for testing configuration)
-   */ async sendTestEmail(dto, user) {
+    async sendTestEmail(dto, user) {
         const result = await this.emailSendService.sendTestEmail(dto.emailConfigId, dto.recipient, user);
+        return this.toResponse(result, 'Test email');
+    }
+    toResponse(result, label) {
         return {
             success: result.success,
+            message: result.success ? `${label} sent successfully` : `Failed to send ${label.toLowerCase()}`,
             data: {
                 success: result.success,
                 messageId: result.messageId,
@@ -89,6 +73,7 @@ let EmailSendController = class EmailSendController {
 };
 _ts_decorate([
     (0, _common.Post)('direct'),
+    (0, _decorators.RequirePermission)('email.send'),
     (0, _swagger.ApiOperation)({
         summary: 'Send email directly with custom content'
     }),
@@ -103,6 +88,7 @@ _ts_decorate([
 ], EmailSendController.prototype, "sendEmail", null);
 _ts_decorate([
     (0, _common.Post)('template'),
+    (0, _decorators.RequirePermission)('email.send'),
     (0, _swagger.ApiOperation)({
         summary: 'Send email using a template with variable interpolation'
     }),
@@ -117,6 +103,7 @@ _ts_decorate([
 ], EmailSendController.prototype, "sendTemplateEmail", null);
 _ts_decorate([
     (0, _common.Post)('test'),
+    (0, _decorators.RequirePermission)('email.send'),
     (0, _swagger.ApiOperation)({
         summary: 'Send a test email to verify configuration'
     }),

package/cjs/controllers/email-template.controller.js

@@ -8,12 +8,12 @@ Object.defineProperty(exports, "EmailTemplateController", {
         return EmailTemplateController;
     }
 });
-const _guards = require("@flusys/nestjs-shared/guards");
 const _classes = require("@flusys/nestjs-shared/classes");
-const _common = require("@nestjs/common");
-const _swagger = require("@nestjs/swagger");
 const _decorators = require("@flusys/nestjs-shared/decorators");
+const _guards = require("@flusys/nestjs-shared/guards");
 const _interfaces = require("@flusys/nestjs-shared/interfaces");
+const _common = require("@nestjs/common");
+const _swagger = require("@nestjs/swagger");
 const _dtos = require("../dtos");
 const _services = require("../services");
 function _define_property(obj, key, value) {
@@ -43,14 +43,58 @@ function _ts_param(paramIndex, decorator) {
         decorator(target, key, paramIndex);
     };
 }
-let EmailTemplateController = class EmailTemplateController extends (0, _classes.createApiController)(_dtos.CreateEmailTemplateDto, _dtos.UpdateEmailTemplateDto, _dtos.EmailTemplateResponseDto) {
-    /**
-   * Get template by slug (POST-only RPC pattern)
-   */ async getBySlug(body, user) {
-        const template = await this.emailTemplateService.findBySlug(body.slug, user);
+let EmailTemplateController = class EmailTemplateController extends (0, _classes.createApiController)(_dtos.CreateEmailTemplateDto, _dtos.UpdateEmailTemplateDto, _dtos.EmailTemplateResponseDto, {
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_TEMPLATE_PERMISSIONS.DELETE
+            ]
+        }
+    }
+}) {
+    async getBySlug(body, user) {
+        const data = await this.emailTemplateService.findBySlug(body.slug, user);
         return {
             success: true,
-            data: template
+            message: 'Template retrieved',
+            data: data ?? undefined
         };
     }
     constructor(emailTemplateService){
@@ -59,9 +103,16 @@ let EmailTemplateController = class EmailTemplateController extends (0, _classes
 };
 _ts_decorate([
     (0, _common.Post)('get-by-slug'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _decorators.RequirePermission)(_classes.EMAIL_TEMPLATE_PERMISSIONS.READ),
     (0, _swagger.ApiOperation)({
         summary: 'Get email template by slug'
     }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: _dtos.EmailTemplateResponseDto
+    }),
     _ts_param(0, (0, _common.Body)()),
     _ts_param(1, (0, _decorators.CurrentUser)()),
     _ts_metadata("design:type", Function),
@@ -73,9 +124,7 @@ _ts_decorate([
 ], EmailTemplateController.prototype, "getBySlug", null);
 EmailTemplateController = _ts_decorate([
     (0, _swagger.ApiTags)('Email Template'),
-    (0, _swagger.ApiBearerAuth)(),
     (0, _common.Controller)('email/email-template'),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard),
     _ts_param(0, (0, _common.Inject)(_services.EmailTemplateService)),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [

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

@@ -22,102 +22,34 @@ Object.defineProperty(exports, "emailSwaggerConfig", {
         ]
     }
 ];
-function emailSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    return {
-        title: 'Email API',
-        description: enableCompanyFeature ? `
-# Email Management API
-
-Complete email management system with multi-tenant and company support.
-
-## Features
-
-### 📧 Email Configuration
-- Multiple email providers (SMTP, SendGrid, Mailgun)
-- Provider-specific configurations
-- Default sender settings
-- **Company-level email configs**
-
-### 📝 Email Templates
-- Visual template builder
-- Variable interpolation ({{variable}})
-- HTML and plain text support
-- Template versioning
-- **Company isolation**
-
-### ✉️ Email Sending
-- Direct email sending
-- Template-based sending
-- Attachments support
-- CC/BCC recipients
-
-### 🔒 Security
-- JWT authentication required
-- **Company isolation**
-- 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
-
+function buildDescription(enableCompanyFeature) {
+    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.
-
-## 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
-      ` : `
+` : '';
+    return `
 # Email Management API
 
-Complete email management system.
+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
+- Default sender settings${companyConfigs}
 
 ### 📝 Email Templates
 - Visual template builder
 - Variable interpolation ({{variable}})
 - HTML and plain text support
-- Template versioning
+- Template versioning${companyIsolation}
 
 ### ✉️ Email Sending
 - Direct email sending
@@ -126,7 +58,7 @@ Complete email management system.
 - CC/BCC recipients
 
 ### 🔒 Security
-- JWT authentication required
+- JWT authentication required${companyIsolation}
 - Secure credential storage
 
 ## Supported Providers
@@ -152,7 +84,7 @@ 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\`:
@@ -166,7 +98,13 @@ All email endpoints are prefixed with \`/email\`:
 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;
+    return {
+        title: 'Email API',
+        description: buildDescription(enableCompanyFeature),
         version: '1.0',
         path: 'api/docs/email',
         bearerAuth: true,

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

@@ -68,8 +68,7 @@ _ts_decorate([
 _ts_decorate([
     (0, _swagger.ApiProperty)({
         enum: _enums.EmailProviderTypeEnum,
-        example: _enums.EmailProviderTypeEnum.SMTP,
-        description: 'Email provider type'
+        example: _enums.EmailProviderTypeEnum.SMTP
     }),
     (0, _classvalidator.IsEnum)(_enums.EmailProviderTypeEnum),
     (0, _classvalidator.IsNotEmpty)(),
@@ -78,38 +77,8 @@ _ts_decorate([
 _ts_decorate([
     (0, _swagger.ApiProperty)({
         type: 'object',
-        properties: {
-            host: {
-                type: 'string',
-                example: 'smtp.gmail.com',
-                description: 'SMTP host'
-            },
-            port: {
-                type: 'number',
-                example: 587,
-                description: 'SMTP port'
-            },
-            secure: {
-                type: 'boolean',
-                example: false,
-                description: 'Use TLS'
-            },
-            auth: {
-                type: 'object',
-                properties: {
-                    user: {
-                        type: 'string',
-                        example: 'user@gmail.com'
-                    },
-                    pass: {
-                        type: 'string',
-                        example: 'app-password'
-                    }
-                }
-            }
-        },
-        additionalProperties: true,
-        description: 'Provider-specific configuration'
+        description: 'Provider-specific configuration (SMTP: host, port, secure, auth)',
+        additionalProperties: true
     }),
     (0, _classvalidator.IsObject)(),
     (0, _classvalidator.IsNotEmpty)(),
@@ -149,16 +118,9 @@ _ts_decorate([
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", Boolean)
 ], CreateEmailConfigDto.prototype, "isDefault", void 0);
-let UpdateEmailConfigDto = class UpdateEmailConfigDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _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);
+let UpdateEmailConfigDto = class UpdateEmailConfigDto extends (0, _swagger.PartialType)(CreateEmailConfigDto) {
+    constructor(...args){
+        super(...args), _define_property(this, "id", void 0);
     }
 };
 _ts_decorate([
@@ -169,68 +131,6 @@ _ts_decorate([
     (0, _classvalidator.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], UpdateEmailConfigDto.prototype, "id", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: 'Production SMTP'
-    }),
-    (0, _classvalidator.IsString)(),
-    (0, _classvalidator.IsOptional)(),
-    (0, _classvalidator.MaxLength)(255),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "name", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        enum: _enums.EmailProviderTypeEnum,
-        example: _enums.EmailProviderTypeEnum.SMTP
-    }),
-    (0, _classvalidator.IsEnum)(_enums.EmailProviderTypeEnum),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", typeof _enums.EmailProviderTypeEnum === "undefined" ? Object : _enums.EmailProviderTypeEnum)
-], UpdateEmailConfigDto.prototype, "provider", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        type: 'object',
-        additionalProperties: true,
-        description: 'Provider-specific configuration'
-    }),
-    (0, _classvalidator.IsObject)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], UpdateEmailConfigDto.prototype, "config", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: 'noreply@example.com'
-    }),
-    (0, _classvalidator.IsEmail)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "fromEmail", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: 'FLUSYS'
-    }),
-    (0, _classvalidator.IsString)(),
-    (0, _classvalidator.IsOptional)(),
-    (0, _classvalidator.MaxLength)(255),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "fromName", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: true
-    }),
-    (0, _classvalidator.IsBoolean)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", Boolean)
-], UpdateEmailConfigDto.prototype, "isActive", void 0);
-_ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        example: false,
-        description: 'Set as default email configuration'
-    }),
-    (0, _classvalidator.IsBoolean)(),
-    (0, _classvalidator.IsOptional)(),
-    _ts_metadata("design:type", Boolean)
-], UpdateEmailConfigDto.prototype, "isDefault", 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);