@flusys/nestjs-email 5.1.0 → 5.1.2

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

@@ -21,6 +21,7 @@ _export(exports, {
 });
 const _dtos = require("@flusys/nestjs-shared/dtos");
 const _swagger = require("@nestjs/swagger");
+const _classtransformer = require("class-transformer");
 const _classvalidator = require("class-validator");
 const _enums = require("../enums");
 function _define_property(obj, key, value) {
@@ -57,6 +58,7 @@ let CreateEmailConfigDto = class CreateEmailConfigDto {
     }
 };
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiProperty)({
         example: 'Production SMTP'
     }),
@@ -66,6 +68,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "name", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiProperty)({
         enum: _enums.EmailProviderTypeEnum,
         example: _enums.EmailProviderTypeEnum.SMTP
@@ -75,6 +78,7 @@ _ts_decorate([
     _ts_metadata("design:type", typeof _enums.EmailProviderTypeEnum === "undefined" ? Object : _enums.EmailProviderTypeEnum)
 ], CreateEmailConfigDto.prototype, "provider", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiProperty)({
         type: 'object',
         description: 'Provider-specific configuration (SMTP: host, port, secure, auth)',
@@ -85,6 +89,7 @@ _ts_decorate([
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], CreateEmailConfigDto.prototype, "config", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiPropertyOptional)({
         example: 'noreply@example.com'
     }),
@@ -93,6 +98,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "fromEmail", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiPropertyOptional)({
         example: 'FLUSYS'
     }),
@@ -102,6 +108,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "fromName", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiPropertyOptional)({
         example: true
     }),
@@ -110,6 +117,7 @@ _ts_decorate([
     _ts_metadata("design:type", Boolean)
 ], CreateEmailConfigDto.prototype, "isActive", void 0);
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiPropertyOptional)({
         example: false,
         description: 'Set as default email configuration'
@@ -124,6 +132,7 @@ let UpdateEmailConfigDto = class UpdateEmailConfigDto extends (0, _swagger.Parti
     }
 };
 _ts_decorate([
+    (0, _classtransformer.Expose)(),
     (0, _swagger.ApiProperty)({
         example: '123e4567-e89b-12d3-a456-426614174000'
     }),
@@ -136,3 +145,68 @@ let EmailConfigResponseDto = class EmailConfigResponseDto extends _dtos.Identity
         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);
     }
 };
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Human-readable name for this email configuration',
+        example: 'Primary Transactional Email'
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", String)
+], EmailConfigResponseDto.prototype, "name", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'The email provider type used for this configuration',
+        enum: _enums.EmailProviderTypeEnum,
+        example: _enums.EmailProviderTypeEnum.SMTP
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", typeof _enums.EmailProviderTypeEnum === "undefined" ? Object : _enums.EmailProviderTypeEnum)
+], EmailConfigResponseDto.prototype, "provider", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Provider-specific configuration key-value pairs',
+        type: 'object',
+        additionalProperties: true,
+        example: {
+            host: 'smtp.example.com',
+            port: 587,
+            secure: true
+        }
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], EmailConfigResponseDto.prototype, "config", void 0);
+_ts_decorate([
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'The email address used in the "From" field',
+        example: 'no-reply@example.com',
+        nullable: true
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", Object)
+], EmailConfigResponseDto.prototype, "fromEmail", void 0);
+_ts_decorate([
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'The display name used in the "From" field',
+        example: 'Acme Notifications',
+        nullable: true
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", Object)
+], EmailConfigResponseDto.prototype, "fromName", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Whether this email configuration is currently active',
+        example: true
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", Boolean)
+], EmailConfigResponseDto.prototype, "isActive", void 0);
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Whether this is the default email configuration',
+        example: false
+    }),
+    (0, _classtransformer.Expose)(),
+    _ts_metadata("design:type", Boolean)
+], EmailConfigResponseDto.prototype, "isDefault", void 0);

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

@@ -21,6 +21,7 @@ _export(exports, {
 });
 const _dtos = require("@flusys/nestjs-shared/dtos");
 const _swagger = require("@nestjs/swagger");
+const _classtransformer = require("class-transformer");
 const _classvalidator = require("class-validator");
 function _define_property(obj, key, value) {
     if (key in obj) {
@@ -157,45 +158,95 @@ let EmailTemplateResponseDto = class EmailTemplateResponseDto extends _dtos.Iden
     }
 };
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Human-readable name of the email template',
+        example: 'Welcome Email'
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "name", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'URL-friendly unique identifier for the template',
+        example: 'welcome-email'
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "slug", void 0);
 _ts_decorate([
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Optional description of the template purpose',
+        example: 'Sent to new users upon successful registration',
+        nullable: true
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", Object)
 ], EmailTemplateResponseDto.prototype, "description", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Email subject line, supports template variables',
+        example: 'Welcome to Acme, {{firstName}}!'
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "subject", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
+        description: 'JSON schema defining the variables accepted by this template',
         type: 'object',
-        additionalProperties: true
+        additionalProperties: true,
+        example: {
+            firstName: {
+                type: 'string'
+            },
+            activationUrl: {
+                type: 'string',
+                format: 'uri'
+            }
+        }
     }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], EmailTemplateResponseDto.prototype, "schema", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'HTML body of the email template',
+        example: '<h1>Welcome, {{firstName}}!</h1><p>Click <a href="{{activationUrl}}">here</a> to activate.</p>'
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "htmlContent", void 0);
 _ts_decorate([
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Plain-text fallback body for email clients that do not render HTML',
+        example: 'Welcome, {{firstName}}! Activate your account at {{activationUrl}}',
+        nullable: true
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", Object)
 ], EmailTemplateResponseDto.prototype, "textContent", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Version number of the schema definition for this template',
+        example: 1,
+        minimum: 1
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", Number)
 ], EmailTemplateResponseDto.prototype, "schemaVersion", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Whether this template is currently active and usable',
+        example: true
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", Boolean)
 ], EmailTemplateResponseDto.prototype, "isActive", void 0);
 _ts_decorate([
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Whether this template renders as HTML; false means plain-text only',
+        example: true
+    }),
+    (0, _classtransformer.Expose)(),
     _ts_metadata("design:type", Boolean)
 ], EmailTemplateResponseDto.prototype, "isHtml", void 0);

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

@@ -22,6 +22,7 @@ function _ts_metadata(k, v) {
 }
 import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
 import { IsBoolean, IsEmail, IsEnum, IsNotEmpty, IsObject, IsOptional, IsString, MaxLength } from 'class-validator';
 import { EmailProviderTypeEnum } from '../enums';
 export class CreateEmailConfigDto {
@@ -36,6 +37,7 @@ export class CreateEmailConfigDto {
     }
 }
 _ts_decorate([
+    Expose(),
     ApiProperty({
         example: 'Production SMTP'
     }),
@@ -45,6 +47,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "name", void 0);
 _ts_decorate([
+    Expose(),
     ApiProperty({
         enum: EmailProviderTypeEnum,
         example: EmailProviderTypeEnum.SMTP
@@ -54,6 +57,7 @@ _ts_decorate([
     _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
 ], CreateEmailConfigDto.prototype, "provider", void 0);
 _ts_decorate([
+    Expose(),
     ApiProperty({
         type: 'object',
         description: 'Provider-specific configuration (SMTP: host, port, secure, auth)',
@@ -64,6 +68,7 @@ _ts_decorate([
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], CreateEmailConfigDto.prototype, "config", void 0);
 _ts_decorate([
+    Expose(),
     ApiPropertyOptional({
         example: 'noreply@example.com'
     }),
@@ -72,6 +77,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "fromEmail", void 0);
 _ts_decorate([
+    Expose(),
     ApiPropertyOptional({
         example: 'FLUSYS'
     }),
@@ -81,6 +87,7 @@ _ts_decorate([
     _ts_metadata("design:type", String)
 ], CreateEmailConfigDto.prototype, "fromName", void 0);
 _ts_decorate([
+    Expose(),
     ApiPropertyOptional({
         example: true
     }),
@@ -89,6 +96,7 @@ _ts_decorate([
     _ts_metadata("design:type", Boolean)
 ], CreateEmailConfigDto.prototype, "isActive", void 0);
 _ts_decorate([
+    Expose(),
     ApiPropertyOptional({
         example: false,
         description: 'Set as default email configuration'
@@ -103,6 +111,7 @@ export class UpdateEmailConfigDto extends PartialType(CreateEmailConfigDto) {
     }
 }
 _ts_decorate([
+    Expose(),
     ApiProperty({
         example: '123e4567-e89b-12d3-a456-426614174000'
     }),
@@ -115,3 +124,68 @@ export class EmailConfigResponseDto extends IdentityResponseDto {
         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);
     }
 }
+_ts_decorate([
+    ApiProperty({
+        description: 'Human-readable name for this email configuration',
+        example: 'Primary Transactional Email'
+    }),
+    Expose(),
+    _ts_metadata("design:type", String)
+], EmailConfigResponseDto.prototype, "name", void 0);
+_ts_decorate([
+    ApiProperty({
+        description: 'The email provider type used for this configuration',
+        enum: EmailProviderTypeEnum,
+        example: EmailProviderTypeEnum.SMTP
+    }),
+    Expose(),
+    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
+], EmailConfigResponseDto.prototype, "provider", void 0);
+_ts_decorate([
+    ApiProperty({
+        description: 'Provider-specific configuration key-value pairs',
+        type: 'object',
+        additionalProperties: true,
+        example: {
+            host: 'smtp.example.com',
+            port: 587,
+            secure: true
+        }
+    }),
+    Expose(),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], EmailConfigResponseDto.prototype, "config", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'The email address used in the "From" field',
+        example: 'no-reply@example.com',
+        nullable: true
+    }),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], EmailConfigResponseDto.prototype, "fromEmail", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        description: 'The display name used in the "From" field',
+        example: 'Acme Notifications',
+        nullable: true
+    }),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], EmailConfigResponseDto.prototype, "fromName", void 0);
+_ts_decorate([
+    ApiProperty({
+        description: 'Whether this email configuration is currently active',
+        example: true
+    }),
+    Expose(),
+    _ts_metadata("design:type", Boolean)
+], EmailConfigResponseDto.prototype, "isActive", void 0);
+_ts_decorate([
+    ApiProperty({
+        description: 'Whether this is the default email configuration',
+        example: false
+    }),
+    Expose(),
+    _ts_metadata("design:type", Boolean)
+], EmailConfigResponseDto.prototype, "isDefault", void 0);

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

@@ -22,6 +22,7 @@ function _ts_metadata(k, v) {
 }
 import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
 import { IsBoolean, IsNotEmpty, IsObject, IsOptional, IsString, MaxLength } from 'class-validator';
 export class CreateEmailTemplateDto {
     constructor(){
@@ -136,45 +137,95 @@ export class EmailTemplateResponseDto extends IdentityResponseDto {
     }
 }
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'Human-readable name of the email template',
+        example: 'Welcome Email'
+    }),
+    Expose(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "name", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'URL-friendly unique identifier for the template',
+        example: 'welcome-email'
+    }),
+    Expose(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "slug", void 0);
 _ts_decorate([
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Optional description of the template purpose',
+        example: 'Sent to new users upon successful registration',
+        nullable: true
+    }),
+    Expose(),
     _ts_metadata("design:type", Object)
 ], EmailTemplateResponseDto.prototype, "description", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'Email subject line, supports template variables',
+        example: 'Welcome to Acme, {{firstName}}!'
+    }),
+    Expose(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "subject", void 0);
 _ts_decorate([
     ApiProperty({
+        description: 'JSON schema defining the variables accepted by this template',
         type: 'object',
-        additionalProperties: true
+        additionalProperties: true,
+        example: {
+            firstName: {
+                type: 'string'
+            },
+            activationUrl: {
+                type: 'string',
+                format: 'uri'
+            }
+        }
     }),
+    Expose(),
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], EmailTemplateResponseDto.prototype, "schema", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'HTML body of the email template',
+        example: '<h1>Welcome, {{firstName}}!</h1><p>Click <a href="{{activationUrl}}">here</a> to activate.</p>'
+    }),
+    Expose(),
     _ts_metadata("design:type", String)
 ], EmailTemplateResponseDto.prototype, "htmlContent", void 0);
 _ts_decorate([
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Plain-text fallback body for email clients that do not render HTML',
+        example: 'Welcome, {{firstName}}! Activate your account at {{activationUrl}}',
+        nullable: true
+    }),
+    Expose(),
     _ts_metadata("design:type", Object)
 ], EmailTemplateResponseDto.prototype, "textContent", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'Version number of the schema definition for this template',
+        example: 1,
+        minimum: 1
+    }),
+    Expose(),
     _ts_metadata("design:type", Number)
 ], EmailTemplateResponseDto.prototype, "schemaVersion", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'Whether this template is currently active and usable',
+        example: true
+    }),
+    Expose(),
     _ts_metadata("design:type", Boolean)
 ], EmailTemplateResponseDto.prototype, "isActive", void 0);
 _ts_decorate([
-    ApiProperty(),
+    ApiProperty({
+        description: 'Whether this template renders as HTML; false means plain-text only',
+        example: true
+    }),
+    Expose(),
     _ts_metadata("design:type", Boolean)
 ], EmailTemplateResponseDto.prototype, "isHtml", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-email",
-  "version": "5.1.0",
+  "version": "5.1.2",
   "description": "Modular email package with SMTP, SendGrid, and Mailgun providers",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -105,7 +105,7 @@
     }
   },
   "dependencies": {
-    "@flusys/nestjs-core": "5.1.0",
-    "@flusys/nestjs-shared": "5.1.0"
+    "@flusys/nestjs-core": "5.1.2",
+    "@flusys/nestjs-shared": "5.1.2"
   }
 }