@flusys/nestjs-email 1.1.0-beta

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

@@ -0,0 +1,172 @@
+/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
+    {
+        schemaName: 'EmailConfigResponseDto',
+        properties: [
+            'companyId'
+        ]
+    },
+    {
+        schemaName: 'EmailTemplateResponseDto',
+        properties: [
+            'companyId'
+        ]
+    }
+];
+/**
+ * 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
+
+## 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/fesm/docs/index.js

@@ -0,0 +1 @@
+export { emailSwaggerConfig } from './email-swagger.config';

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

@@ -0,0 +1,223 @@
+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 } 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 {
+    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([
+    ApiProperty({
+        example: 'Production SMTP'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], CreateEmailConfigDto.prototype, "name", void 0);
+_ts_decorate([
+    ApiProperty({
+        enum: EmailProviderTypeEnum,
+        example: EmailProviderTypeEnum.SMTP,
+        description: 'Email provider type'
+    }),
+    IsEnum(EmailProviderTypeEnum),
+    IsNotEmpty(),
+    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
+], CreateEmailConfigDto.prototype, "provider", void 0);
+_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'
+    }),
+    IsObject(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], CreateEmailConfigDto.prototype, "config", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'noreply@example.com'
+    }),
+    IsEmail(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], CreateEmailConfigDto.prototype, "fromEmail", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'FLUSYS'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], CreateEmailConfigDto.prototype, "fromName", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: true
+    }),
+    IsBoolean(),
+    IsOptional(),
+    _ts_metadata("design:type", Boolean)
+], CreateEmailConfigDto.prototype, "isActive", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: false,
+        description: 'Set as default email configuration'
+    }),
+    IsBoolean(),
+    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);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: '123e4567-e89b-12d3-a456-426614174000'
+    }),
+    IsString(),
+    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 {
+    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);
+    }
+}