@flusys/nestjs-email 1.1.0-beta → 1.1.0

package/fesm/controllers/email-config.controller.js

@@ -25,22 +25,64 @@ function _ts_param(paramIndex, decorator) {
         decorator(target, key, paramIndex);
     };
 }
-import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
-import { createApiController } from '@flusys/nestjs-shared/classes';
-import { Controller, Inject, UseGuards } from '@nestjs/common';
-import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
+import { createApiController, EMAIL_CONFIG_PERMISSIONS } from '@flusys/nestjs-shared/classes';
+import { Controller, Inject } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import { CreateEmailConfigDto, EmailConfigResponseDto, UpdateEmailConfigDto } from '../dtos';
 import { EmailProviderConfigService } from '../services';
-export class EmailConfigController extends createApiController(CreateEmailConfigDto, UpdateEmailConfigDto, EmailConfigResponseDto) {
+export class EmailConfigController extends createApiController(CreateEmailConfigDto, UpdateEmailConfigDto, EmailConfigResponseDto, {
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                EMAIL_CONFIG_PERMISSIONS.DELETE
+            ]
+        }
+    }
+}) {
     constructor(emailConfigService){
         super(emailConfigService), _define_property(this, "emailConfigService", void 0), this.emailConfigService = emailConfigService;
     }
 }
 EmailConfigController = _ts_decorate([
     ApiTags('Email Config'),
-    ApiBearerAuth(),
     Controller('email/email-config'),
-    UseGuards(JwtAuthGuard),
     _ts_param(0, Inject(EmailProviderConfigService)),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [

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

@@ -25,46 +25,30 @@ function _ts_param(paramIndex, decorator) {
         decorator(target, key, paramIndex);
     };
 }
+import { CurrentUser, RequirePermission } from '@flusys/nestjs-shared/decorators';
 import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
-import { CurrentUser } from '@flusys/nestjs-shared/decorators';
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { Body, Controller, Inject, Post, UseGuards } from '@nestjs/common';
 import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
 import { SendEmailDto, SendTemplateEmailDto, TestEmailDto } from '../dtos';
 import { EmailSendService } from '../services';
 export 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,
@@ -79,6 +63,7 @@ export class EmailSendController {
 }
 _ts_decorate([
     Post('direct'),
+    RequirePermission('email.send'),
     ApiOperation({
         summary: 'Send email directly with custom content'
     }),
@@ -93,6 +78,7 @@ _ts_decorate([
 ], EmailSendController.prototype, "sendEmail", null);
 _ts_decorate([
     Post('template'),
+    RequirePermission('email.send'),
     ApiOperation({
         summary: 'Send email using a template with variable interpolation'
     }),
@@ -107,6 +93,7 @@ _ts_decorate([
 ], EmailSendController.prototype, "sendTemplateEmail", null);
 _ts_decorate([
     Post('test'),
+    RequirePermission('email.send'),
     ApiOperation({
         summary: 'Send a test email to verify configuration'
     }),

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

@@ -25,22 +25,66 @@ function _ts_param(paramIndex, decorator) {
         decorator(target, key, paramIndex);
     };
 }
+import { createApiController, EMAIL_TEMPLATE_PERMISSIONS } from '@flusys/nestjs-shared/classes';
+import { CurrentUser, RequirePermission } from '@flusys/nestjs-shared/decorators';
 import { JwtAuthGuard } from '@flusys/nestjs-shared/guards';
-import { createApiController } from '@flusys/nestjs-shared/classes';
-import { Body, Controller, Inject, Post, UseGuards } from '@nestjs/common';
-import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
-import { CurrentUser } from '@flusys/nestjs-shared/decorators';
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
+import { Body, Controller, Inject, Post, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { CreateEmailTemplateDto, EmailTemplateResponseDto, UpdateEmailTemplateDto } from '../dtos';
 import { EmailTemplateService } from '../services';
-export class EmailTemplateController extends createApiController(CreateEmailTemplateDto, UpdateEmailTemplateDto, EmailTemplateResponseDto) {
-    /**
-   * Get template by slug (POST-only RPC pattern)
-   */ async getBySlug(body, user) {
-        const template = await this.emailTemplateService.findBySlug(body.slug, user);
+export class EmailTemplateController extends createApiController(CreateEmailTemplateDto, UpdateEmailTemplateDto, EmailTemplateResponseDto, {
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                EMAIL_TEMPLATE_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                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){
@@ -49,9 +93,16 @@ export class EmailTemplateController extends createApiController(CreateEmailTemp
 }
 _ts_decorate([
     Post('get-by-slug'),
+    UseGuards(JwtAuthGuard),
+    ApiBearerAuth(),
+    RequirePermission(EMAIL_TEMPLATE_PERMISSIONS.READ),
     ApiOperation({
         summary: 'Get email template by slug'
     }),
+    ApiResponse({
+        status: 200,
+        type: EmailTemplateResponseDto
+    }),
     _ts_param(0, Body()),
     _ts_param(1, CurrentUser()),
     _ts_metadata("design:type", Function),
@@ -63,9 +114,7 @@ _ts_decorate([
 ], EmailTemplateController.prototype, "getBySlug", null);
 EmailTemplateController = _ts_decorate([
     ApiTags('Email Template'),
-    ApiBearerAuth(),
     Controller('email/email-template'),
-    UseGuards(JwtAuthGuard),
     _ts_param(0, Inject(EmailTemplateService)),
     _ts_metadata("design:type", Function),
     _ts_metadata("design:paramtypes", [

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

@@ -12,108 +12,34 @@
         ]
     }
 ];
-/**
- * Email Module Swagger Configuration
- * Use this with setupSwaggerDocs() from @flusys/nestjs-core
- *
- * @param bootstrapConfig - Bootstrap configuration to determine feature visibility
- * @returns Swagger configuration with appropriate excludeSchemaProperties based on enableCompanyFeature
- */ export 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
@@ -122,7 +48,7 @@ Complete email management system.
 - CC/BCC recipients
 
 ### 🔒 Security
-- JWT authentication required
+- JWT authentication required${companyIsolation}
 - Secure credential storage
 
 ## Supported Providers
@@ -148,7 +74,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\`:
@@ -162,7 +88,16 @@ 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
-      `,
+`;
+}
+/**
+ * Email Module Swagger Configuration
+ * Use this with setupSwaggerDocs() from @flusys/nestjs-core
+ */ export 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/fesm/dtos/email-config.dto.js

@@ -21,12 +21,10 @@ 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 } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
 import { IsBoolean, IsEmail, IsEnum, IsNotEmpty, IsObject, IsOptional, IsString, MaxLength } from 'class-validator';
 import { EmailProviderTypeEnum } from '../enums';
-/**
- * DTO for creating email configuration
- */ export class CreateEmailConfigDto {
+export class CreateEmailConfigDto {
     constructor(){
         _define_property(this, "name", void 0);
         _define_property(this, "provider", void 0);
@@ -49,8 +47,7 @@ _ts_decorate([
 _ts_decorate([
     ApiProperty({
         enum: EmailProviderTypeEnum,
-        example: EmailProviderTypeEnum.SMTP,
-        description: 'Email provider type'
+        example: EmailProviderTypeEnum.SMTP
     }),
     IsEnum(EmailProviderTypeEnum),
     IsNotEmpty(),
@@ -59,38 +56,8 @@ _ts_decorate([
 _ts_decorate([
     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
     }),
     IsObject(),
     IsNotEmpty(),
@@ -130,18 +97,9 @@ _ts_decorate([
     IsOptional(),
     _ts_metadata("design:type", Boolean)
 ], CreateEmailConfigDto.prototype, "isDefault", void 0);
-/**
- * DTO for updating email configuration
- */ export 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);
+export class UpdateEmailConfigDto extends PartialType(CreateEmailConfigDto) {
+    constructor(...args){
+        super(...args), _define_property(this, "id", void 0);
     }
 }
 _ts_decorate([
@@ -152,71 +110,7 @@ _ts_decorate([
     IsNotEmpty(),
     _ts_metadata("design:type", String)
 ], UpdateEmailConfigDto.prototype, "id", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'Production SMTP'
-    }),
-    IsString(),
-    IsOptional(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "name", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        enum: EmailProviderTypeEnum,
-        example: EmailProviderTypeEnum.SMTP
-    }),
-    IsEnum(EmailProviderTypeEnum),
-    IsOptional(),
-    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
-], UpdateEmailConfigDto.prototype, "provider", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        type: 'object',
-        additionalProperties: true,
-        description: 'Provider-specific configuration'
-    }),
-    IsObject(),
-    IsOptional(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], UpdateEmailConfigDto.prototype, "config", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'noreply@example.com'
-    }),
-    IsEmail(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "fromEmail", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'FLUSYS'
-    }),
-    IsString(),
-    IsOptional(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], UpdateEmailConfigDto.prototype, "fromName", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: true
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], UpdateEmailConfigDto.prototype, "isActive", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: false,
-        description: 'Set as default email configuration'
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], UpdateEmailConfigDto.prototype, "isDefault", void 0);
-/**
- * Response DTO for email configuration
- */ export class EmailConfigResponseDto extends IdentityResponseDto {
+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);
     }