@flusys/nestjs-email 1.1.0-beta

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

@@ -0,0 +1,360 @@
+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 { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsArray, IsEmail, IsNotEmpty, IsObject, IsOptional, IsString, IsUUID, registerDecorator, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+/**
+ * Custom validator: Requires at least one of templateId or templateSlug
+ */ function RequireTemplateIdOrSlug(validationOptions) {
+    return function(object, propertyName) {
+        registerDecorator({
+            name: 'requireTemplateIdOrSlug',
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            validator: {
+                validate (_value, args) {
+                    const obj = args.object;
+                    return !!(obj.templateId || obj.templateSlug);
+                },
+                defaultMessage () {
+                    return 'Either templateId or templateSlug must be provided';
+                }
+            }
+        });
+    };
+}
+/**
+ * Email attachment DTO
+ */ export class EmailAttachmentDto {
+    constructor(){
+        _define_property(this, "filename", void 0);
+        _define_property(this, "content", void 0);
+        _define_property(this, "contentType", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: 'document.pdf'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], EmailAttachmentDto.prototype, "filename", void 0);
+_ts_decorate([
+    ApiProperty({
+        description: 'Base64 encoded content'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], EmailAttachmentDto.prototype, "content", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'application/pdf'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], EmailAttachmentDto.prototype, "contentType", void 0);
+/**
+ * DTO for sending email directly
+ */ export class SendEmailDto {
+    constructor(){
+        _define_property(this, "to", void 0);
+        _define_property(this, "cc", void 0);
+        _define_property(this, "bcc", void 0);
+        _define_property(this, "subject", void 0);
+        _define_property(this, "html", void 0);
+        _define_property(this, "text", void 0);
+        _define_property(this, "from", void 0);
+        _define_property(this, "fromName", void 0);
+        _define_property(this, "replyTo", void 0);
+        _define_property(this, "emailConfigId", void 0);
+        _define_property(this, "attachments", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: 'user@example.com',
+        description: 'Recipient email(s)'
+    }),
+    IsNotEmpty(),
+    _ts_metadata("design:type", Object)
+], SendEmailDto.prototype, "to", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'CC recipients'
+    }),
+    IsOptional(),
+    _ts_metadata("design:type", Object)
+], SendEmailDto.prototype, "cc", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'BCC recipients'
+    }),
+    IsOptional(),
+    _ts_metadata("design:type", Object)
+], SendEmailDto.prototype, "bcc", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'Welcome to our platform!'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "subject", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: '<h1>Hello!</h1><p>Welcome to our platform.</p>'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "html", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Hello! Welcome to our platform.'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "text", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'sender@example.com'
+    }),
+    IsEmail(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "from", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'FLUSYS'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "fromName", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'reply@example.com'
+    }),
+    IsEmail(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "replyTo", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'Email configuration ID to use'
+    }),
+    IsUUID(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendEmailDto.prototype, "emailConfigId", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: [
+            EmailAttachmentDto
+        ]
+    }),
+    IsArray(),
+    ValidateNested({
+        each: true
+    }),
+    Type(()=>EmailAttachmentDto),
+    IsOptional(),
+    _ts_metadata("design:type", Array)
+], SendEmailDto.prototype, "attachments", void 0);
+/**
+ * DTO for sending email using template
+ * Requires either templateId or templateSlug (at least one must be provided)
+ */ export class SendTemplateEmailDto {
+    constructor(){
+        _define_property(this, "templateId", void 0);
+        _define_property(this, "templateSlug", void 0);
+        _define_property(this, "to", void 0);
+        _define_property(this, "cc", void 0);
+        _define_property(this, "bcc", void 0);
+        _define_property(this, "variables", void 0);
+        _define_property(this, "from", void 0);
+        _define_property(this, "fromName", void 0);
+        _define_property(this, "replyTo", void 0);
+        _define_property(this, "emailConfigId", void 0);
+        _define_property(this, "attachments", void 0);
+    }
+}
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'Template ID (required if templateSlug not provided)'
+    }),
+    IsUUID(),
+    IsOptional(),
+    RequireTemplateIdOrSlug({
+        message: 'Either templateId or templateSlug must be provided'
+    }),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "templateId", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'welcome-email',
+        description: 'Template slug (required if templateId not provided)'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "templateSlug", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'user@example.com',
+        description: 'Recipient email(s)'
+    }),
+    IsNotEmpty(),
+    _ts_metadata("design:type", Object)
+], SendTemplateEmailDto.prototype, "to", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'CC recipients'
+    }),
+    IsOptional(),
+    _ts_metadata("design:type", Object)
+], SendTemplateEmailDto.prototype, "cc", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'BCC recipients'
+    }),
+    IsOptional(),
+    _ts_metadata("design:type", Object)
+], SendTemplateEmailDto.prototype, "bcc", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: 'object',
+        additionalProperties: true,
+        example: {
+            userName: 'John',
+            activationLink: 'https://...'
+        },
+        description: 'Template variables to interpolate'
+    }),
+    IsObject(),
+    IsOptional(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], SendTemplateEmailDto.prototype, "variables", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'sender@example.com'
+    }),
+    IsEmail(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "from", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'FLUSYS'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "fromName", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'reply@example.com'
+    }),
+    IsEmail(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "replyTo", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'Email configuration ID to use'
+    }),
+    IsUUID(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], SendTemplateEmailDto.prototype, "emailConfigId", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: [
+            EmailAttachmentDto
+        ]
+    }),
+    IsArray(),
+    ValidateNested({
+        each: true
+    }),
+    Type(()=>EmailAttachmentDto),
+    IsOptional(),
+    _ts_metadata("design:type", Array)
+], SendTemplateEmailDto.prototype, "attachments", void 0);
+/**
+ * DTO for test email
+ */ export class TestEmailDto {
+    constructor(){
+        _define_property(this, "emailConfigId", void 0);
+        _define_property(this, "recipient", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        description: 'Email configuration ID'
+    }),
+    IsUUID(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], TestEmailDto.prototype, "emailConfigId", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'test@example.com',
+        description: 'Test recipient'
+    }),
+    IsEmail(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], TestEmailDto.prototype, "recipient", void 0);
+/**
+ * Response DTO for email send result
+ */ export class EmailSendResultDto {
+    constructor(){
+        _define_property(this, "success", void 0);
+        _define_property(this, "messageId", void 0);
+        _define_property(this, "error", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: true
+    }),
+    _ts_metadata("design:type", Boolean)
+], EmailSendResultDto.prototype, "success", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: '<message-id@mail.example.com>'
+    }),
+    _ts_metadata("design:type", String)
+], EmailSendResultDto.prototype, "messageId", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Connection refused'
+    }),
+    _ts_metadata("design:type", String)
+], EmailSendResultDto.prototype, "error", void 0);

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

@@ -0,0 +1,268 @@
+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, IsNotEmpty, IsObject, IsOptional, IsString, MaxLength } from 'class-validator';
+/**
+ * DTO for creating email template
+ */ export class CreateEmailTemplateDto {
+    constructor(){
+        _define_property(this, "name", void 0);
+        _define_property(this, "slug", void 0);
+        _define_property(this, "description", void 0);
+        _define_property(this, "subject", void 0);
+        _define_property(this, "schema", void 0);
+        _define_property(this, "htmlContent", void 0);
+        _define_property(this, "textContent", void 0);
+        _define_property(this, "isActive", void 0);
+        _define_property(this, "isHtml", void 0);
+        _define_property(this, "metadata", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: 'Welcome Email'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "name", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'welcome-email'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "slug", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Email sent to new users upon registration'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(500),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "description", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'Welcome to {{appName}}!'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    MaxLength(500),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "subject", void 0);
+_ts_decorate([
+    ApiProperty({
+        type: 'object',
+        additionalProperties: true,
+        description: 'Visual builder schema (sections, blocks, settings)',
+        example: {
+            id: 'template-1',
+            version: '1.0.0',
+            sections: [],
+            settings: {}
+        }
+    }),
+    IsObject(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], CreateEmailTemplateDto.prototype, "schema", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: '<h1>Welcome {{userName}}!</h1><p>Thanks for joining us.</p>',
+        description: 'Rendered HTML content with {{variable}} placeholders'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "htmlContent", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Welcome {{userName}}!\n\nThanks for joining us.',
+        description: 'Plain text fallback content'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], CreateEmailTemplateDto.prototype, "textContent", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: true
+    }),
+    IsBoolean(),
+    IsOptional(),
+    _ts_metadata("design:type", Boolean)
+], CreateEmailTemplateDto.prototype, "isActive", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: true,
+        description: 'Whether template uses HTML (true) or plain text (false)'
+    }),
+    IsBoolean(),
+    IsOptional(),
+    _ts_metadata("design:type", Boolean)
+], CreateEmailTemplateDto.prototype, "isHtml", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: 'object',
+        additionalProperties: true,
+        description: 'Additional metadata (tags, category, etc.)',
+        example: {
+            category: 'onboarding',
+            tags: [
+                'welcome',
+                'new-user'
+            ]
+        }
+    }),
+    IsObject(),
+    IsOptional(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], CreateEmailTemplateDto.prototype, "metadata", void 0);
+/**
+ * DTO for updating email template
+ */ export class UpdateEmailTemplateDto {
+    constructor(){
+        _define_property(this, "id", void 0);
+        _define_property(this, "name", void 0);
+        _define_property(this, "slug", void 0);
+        _define_property(this, "description", void 0);
+        _define_property(this, "subject", void 0);
+        _define_property(this, "schema", void 0);
+        _define_property(this, "htmlContent", void 0);
+        _define_property(this, "textContent", void 0);
+        _define_property(this, "isActive", void 0);
+        _define_property(this, "isHtml", void 0);
+        _define_property(this, "metadata", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: '123e4567-e89b-12d3-a456-426614174000'
+    }),
+    IsString(),
+    IsNotEmpty(),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "id", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Welcome Email'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "name", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'welcome-email'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(255),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "slug", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Email sent to new users upon registration'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(500),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "description", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Welcome to {{appName}}!'
+    }),
+    IsString(),
+    IsOptional(),
+    MaxLength(500),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "subject", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: 'object',
+        additionalProperties: true,
+        description: 'Visual builder schema'
+    }),
+    IsObject(),
+    IsOptional(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], UpdateEmailTemplateDto.prototype, "schema", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: '<h1>Welcome {{userName}}!</h1>',
+        description: 'Rendered HTML content'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "htmlContent", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'Welcome {{userName}}!',
+        description: 'Plain text fallback'
+    }),
+    IsString(),
+    IsOptional(),
+    _ts_metadata("design:type", String)
+], UpdateEmailTemplateDto.prototype, "textContent", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: true
+    }),
+    IsBoolean(),
+    IsOptional(),
+    _ts_metadata("design:type", Boolean)
+], UpdateEmailTemplateDto.prototype, "isActive", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: true,
+        description: 'Whether template uses HTML (true) or plain text (false)'
+    }),
+    IsBoolean(),
+    IsOptional(),
+    _ts_metadata("design:type", Boolean)
+], UpdateEmailTemplateDto.prototype, "isHtml", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        type: 'object',
+        additionalProperties: true,
+        description: 'Additional metadata'
+    }),
+    IsObject(),
+    IsOptional(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], UpdateEmailTemplateDto.prototype, "metadata", void 0);
+/**
+ * Response DTO for email template
+ */ export class EmailTemplateResponseDto extends IdentityResponseDto {
+    constructor(...args){
+        super(...args), _define_property(this, "name", void 0), _define_property(this, "slug", void 0), _define_property(this, "description", void 0), _define_property(this, "subject", void 0), _define_property(this, "schema", void 0), _define_property(this, "htmlContent", void 0), _define_property(this, "textContent", void 0), _define_property(this, "schemaVersion", void 0), _define_property(this, "isActive", void 0), _define_property(this, "isHtml", void 0), _define_property(this, "metadata", void 0);
+    }
+}

package/fesm/dtos/index.js

@@ -0,0 +1,3 @@
+export * from './email-config.dto';
+export * from './email-template.dto';
+export * from './email-send.dto';