@flusys/nestjs-email 1.0.0-rc

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

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "EmailConfigController", {
+    enumerable: true,
+    get: function() {
+        return EmailConfigController;
+    }
+});
+const _classes = require("@flusys/nestjs-shared/classes");
+const _common = require("@nestjs/common");
+const _swagger = require("@nestjs/swagger");
+const _dtos = require("../dtos");
+const _services = require("../services");
+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);
+    };
+}
+let EmailConfigController = class EmailConfigController extends (0, _classes.createApiController)(_dtos.CreateEmailConfigDto, _dtos.UpdateEmailConfigDto, _dtos.EmailConfigResponseDto, {
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                _classes.EMAIL_CONFIG_PERMISSIONS.DELETE
+            ]
+        }
+    }
+}) {
+    constructor(emailConfigService){
+        super(emailConfigService), _define_property(this, "emailConfigService", void 0), this.emailConfigService = emailConfigService;
+    }
+};
+EmailConfigController = _ts_decorate([
+    (0, _swagger.ApiTags)('Email Config'),
+    (0, _common.Controller)('email/email-config'),
+    _ts_param(0, (0, _common.Inject)(_services.EmailProviderConfigService)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _services.EmailProviderConfigService === "undefined" ? Object : _services.EmailProviderConfigService
+    ])
+], EmailConfigController);

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

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "EmailSendController", {
+    enumerable: true,
+    get: function() {
+        return EmailSendController;
+    }
+});
+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) {
+    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);
+    };
+}
+let EmailSendController = class EmailSendController {
+    async sendEmail(dto, user) {
+        const result = await this.emailSendService.sendEmail(dto, user);
+        return {
+            success: result.success,
+            message: result.success ? 'Email sent successfully' : 'Failed to send email',
+            data: {
+                success: result.success,
+                messageId: result.messageId,
+                error: result.error
+            }
+        };
+    }
+    async sendTemplateEmail(dto, user) {
+        const result = await this.emailSendService.sendTemplateEmail(dto, user);
+        return {
+            success: result.success,
+            message: result.success ? 'Template email sent successfully' : 'Failed to send template email',
+            data: {
+                success: result.success,
+                messageId: result.messageId,
+                error: result.error
+            }
+        };
+    }
+    async sendTestEmail(dto, user) {
+        const result = await this.emailSendService.sendTestEmail(dto.emailConfigId, dto.recipient, user);
+        return {
+            success: result.success,
+            message: result.success ? 'Test email sent successfully' : 'Failed to send test email',
+            data: {
+                success: result.success,
+                messageId: result.messageId,
+                error: result.error
+            }
+        };
+    }
+    constructor(emailSendService){
+        _define_property(this, "emailSendService", void 0);
+        this.emailSendService = emailSendService;
+    }
+};
+_ts_decorate([
+    (0, _common.Post)('direct'),
+    (0, _decorators.RequirePermission)('email.send'),
+    (0, _swagger.ApiOperation)({
+        summary: 'Send email directly with custom content'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.SendEmailDto === "undefined" ? Object : _dtos.SendEmailDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], 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'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.SendTemplateEmailDto === "undefined" ? Object : _dtos.SendTemplateEmailDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], 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'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.TestEmailDto === "undefined" ? Object : _dtos.TestEmailDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], EmailSendController.prototype, "sendTestEmail", null);
+EmailSendController = _ts_decorate([
+    (0, _swagger.ApiTags)('Email Send'),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _common.Controller)('email/send'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    _ts_param(0, (0, _common.Inject)(_services.EmailSendService)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _services.EmailSendService === "undefined" ? Object : _services.EmailSendService
+    ])
+], EmailSendController);

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

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "EmailTemplateController", {
+    enumerable: true,
+    get: function() {
+        return EmailTemplateController;
+    }
+});
+const _classes = require("@flusys/nestjs-shared/classes");
+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) {
+    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);
+    };
+}
+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 template = await this.emailTemplateService.findBySlug(body.slug, user);
+        return {
+            success: true,
+            data: template
+        };
+    }
+    constructor(emailTemplateService){
+        super(emailTemplateService), _define_property(this, "emailTemplateService", void 0), this.emailTemplateService = emailTemplateService;
+    }
+};
+_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'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        Object,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], EmailTemplateController.prototype, "getBySlug", null);
+EmailTemplateController = _ts_decorate([
+    (0, _swagger.ApiTags)('Email Template'),
+    (0, _common.Controller)('email/email-template'),
+    _ts_param(0, (0, _common.Inject)(_services.EmailTemplateService)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _services.EmailTemplateService === "undefined" ? Object : _services.EmailTemplateService
+    ])
+], EmailTemplateController);

package/cjs/controllers/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./email-config.controller"), exports);
+_export_star(require("./email-template.controller"), exports);
+_export_star(require("./email-send.controller"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

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

@@ -0,0 +1,176 @@
+"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 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
+
+## 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
+      ` : `
+# Email Management API
+
+Complete email management system.
+
+## Features
+
+### 📧 Email Configuration
+- Multiple email providers (SMTP, SendGrid, Mailgun)
+- Provider-specific configurations
+- Default sender settings
+
+### 📝 Email Templates
+- Visual template builder
+- Variable interpolation ({{variable}})
+- HTML and plain text support
+- Template versioning
+
+### ✉️ Email Sending
+- Direct email sending
+- Template-based sending
+- Attachments support
+- CC/BCC recipients
+
+### 🔒 Security
+- JWT authentication required
+- 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
+
+## 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
+      `,
+        version: '1.0',
+        path: 'api/docs/email',
+        bearerAuth: true,
+        excludeTags: [],
+        excludeSchemaProperties: enableCompanyFeature ? undefined : COMPANY_SCHEMA_EXCLUSIONS
+    };
+}

package/cjs/docs/index.js

@@ -0,0 +1,11 @@
+"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");