@flusys/nestjs-email 1.1.0-beta → 2.0.0

package/providers/sendgrid-provider.d.ts

@@ -1,11 +1,15 @@
 import { IEmailProvider, IEmailSendOptions, IEmailSendResult, ISendGridConfig } from '../interfaces';
 export declare class SendGridProvider implements IEmailProvider {
-    private logger;
+    private readonly logger;
     private sgMail;
-    private config;
+    private apiKey;
     initialize(config: ISendGridConfig): Promise<void>;
     sendEmail(options: IEmailSendOptions): Promise<IEmailSendResult>;
     sendBulkEmails(options: IEmailSendOptions[]): Promise<IEmailSendResult[]>;
     healthCheck(): Promise<boolean>;
     close(): Promise<void>;
+    private buildMessage;
+    private toArray;
+    private extractError;
+    private handleError;
 }

package/providers/smtp-provider.d.ts

@@ -1,11 +1,16 @@
 import { IEmailProvider, IEmailSendOptions, IEmailSendResult, ISmtpConfig } from '../interfaces';
 export declare class SmtpProvider implements IEmailProvider {
-    private logger;
+    private readonly logger;
     private transporter;
-    private config;
     initialize(config: ISmtpConfig): Promise<void>;
     sendEmail(options: IEmailSendOptions): Promise<IEmailSendResult>;
     sendBulkEmails(options: IEmailSendOptions[]): Promise<IEmailSendResult[]>;
     healthCheck(): Promise<boolean>;
     close(): Promise<void>;
+    private verifyConnection;
+    private formatFrom;
+    private joinAddresses;
+    private withTimeout;
+    private extractError;
+    private handleError;
 }

package/services/email-config.service.d.ts

@@ -0,0 +1,12 @@
+import { DatabaseMode } from '@flusys/nestjs-core';
+import { IModuleConfigService } from '@flusys/nestjs-shared/interfaces';
+import { EmailModuleOptions } from '../interfaces';
+export declare class EmailConfigService implements IModuleConfigService {
+    private readonly options;
+    constructor(options: EmailModuleOptions);
+    isCompanyFeatureEnabled(): boolean;
+    getDatabaseMode(): DatabaseMode;
+    isMultiTenant(): boolean;
+    getDefaultFromName(): string;
+    getOptions(): EmailModuleOptions;
+}

package/services/email-datasource.provider.d.ts

@@ -3,9 +3,9 @@ import { IDatabaseConfig, ITenantDatabaseConfig } from '@flusys/nestjs-core';
 import { Logger } from '@nestjs/common';
 import { Request } from 'express';
 import { DataSource } from 'typeorm';
-import { EmailModuleOptions } from '../interfaces';
+import { EmailConfigService } from './email-config.service';
 export declare class EmailDataSourceProvider extends MultiTenantDataSourceService {
-    private readonly emailOptions;
+    private readonly configService;
     protected readonly logger: Logger;
     protected static readonly tenantConnections: Map<string, DataSource>;
     protected static singleDataSource: DataSource | null;
@@ -13,12 +13,9 @@ export declare class EmailDataSourceProvider extends MultiTenantDataSourceServic
     protected static initialized: boolean;
     protected static readonly connectionLocks: Map<string, Promise<DataSource>>;
     protected static singleConnectionLock: Promise<DataSource> | null;
-    constructor(emailOptions: EmailModuleOptions, request?: Request);
+    constructor(configService: EmailConfigService, request?: Request);
     private static buildParentOptions;
-    getEnableCompanyFeature(): boolean;
     getEnableCompanyFeatureForTenant(tenant?: ITenantDatabaseConfig): boolean;
-    getEnableCompanyFeatureForCurrentTenant(): boolean;
-    getEmailEntities(enableCompanyFeature?: boolean): Promise<any[]>;
     protected createDataSourceFromConfig(config: IDatabaseConfig): Promise<DataSource>;
     protected getSingleDataSource(): Promise<DataSource>;
     protected getOrCreateTenantConnection(tenant: ITenantDatabaseConfig): Promise<DataSource>;

package/services/email-provider-config.service.d.ts

@@ -3,9 +3,9 @@ import { FilterAndPaginationDto } from '@flusys/nestjs-shared/dtos';
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { EntityTarget, Repository, SelectQueryBuilder } from 'typeorm';
-import { EmailConfigService } from '../config';
+import { EmailConfigService } from './email-config.service';
 import { CreateEmailConfigDto, UpdateEmailConfigDto } from '../dtos';
-import { EmailConfigBase } from '../entities';
+import { EmailConfig, EmailConfigBase } from '../entities';
 import { EmailProviderTypeEnum } from '../enums';
 import { IEmailConfig } from '../interfaces';
 import { EmailDataSourceProvider } from './email-datasource.provider';
@@ -19,7 +19,7 @@ export declare class EmailProviderConfigService extends RequestScopedApiService<
     protected getDataSourceProvider(): EmailDataSourceProvider;
     convertSingleDtoToEntity(dto: CreateEmailConfigDto | UpdateEmailConfigDto, user: ILoggedUserInfo | null): Promise<EmailConfigBase>;
     getSelectQuery(query: SelectQueryBuilder<EmailConfigBase>, _user: ILoggedUserInfo | null, select?: string[]): Promise<{
-        query: SelectQueryBuilder<EmailConfigBase>;
+        query: SelectQueryBuilder<EmailConfig>;
         isRaw: boolean;
     }>;
     protected getExtraManipulateQuery(query: SelectQueryBuilder<EmailConfigBase>, filterDto: FilterAndPaginationDto, user: ILoggedUserInfo | null): Promise<{

package/services/email-send.service.d.ts

@@ -1,5 +1,5 @@
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
-import { EmailConfigService } from '../config';
+import { EmailConfigService } from './email-config.service';
 import { SendEmailDto, SendTemplateEmailDto } from '../dtos';
 import { IEmailSendResult } from '../interfaces';
 import { EmailFactoryService } from '../providers';
@@ -12,9 +12,17 @@ export declare class EmailSendService {
     private readonly emailTemplateService;
     private readonly logger;
     constructor(emailFactory: EmailFactoryService, emailConfigService: EmailConfigService, emailProviderConfigService: EmailProviderConfigService, emailTemplateService: EmailTemplateService);
-    private getEmailProviderWithConfig;
-    private interpolateVariables;
     sendEmail(dto: SendEmailDto, user?: ILoggedUserInfo): Promise<IEmailSendResult>;
     sendTemplateEmail(dto: SendTemplateEmailDto, user?: ILoggedUserInfo): Promise<IEmailSendResult>;
     sendTestEmail(emailConfigId: string, recipient: string, user?: ILoggedUserInfo): Promise<IEmailSendResult>;
+    private getEmailProviderWithConfig;
+    private resolveConfigById;
+    private resolveDefaultConfig;
+    private resolveTemplate;
+    private buildTemplateContent;
+    private resolveSender;
+    private buildAttachments;
+    private interpolateVariables;
+    private logResult;
+    private buildTestEmailHtml;
 }

package/services/email-template.service.d.ts

@@ -3,9 +3,9 @@ import { FilterAndPaginationDto } from '@flusys/nestjs-shared/dtos';
 import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { EntityTarget, Repository, SelectQueryBuilder } from 'typeorm';
-import { EmailConfigService } from '../config';
+import { EmailConfigService } from './email-config.service';
 import { CreateEmailTemplateDto, UpdateEmailTemplateDto } from '../dtos';
-import { EmailTemplateBase } from '../entities';
+import { EmailTemplate, EmailTemplateBase } from '../entities';
 import { IEmailTemplate } from '../interfaces';
 import { EmailDataSourceProvider } from './email-datasource.provider';
 export declare class EmailTemplateService extends RequestScopedApiService<CreateEmailTemplateDto, UpdateEmailTemplateDto, IEmailTemplate, EmailTemplateBase, Repository<EmailTemplateBase>> {
@@ -18,14 +18,15 @@ export declare class EmailTemplateService extends RequestScopedApiService<Create
     protected getDataSourceProvider(): EmailDataSourceProvider;
     convertSingleDtoToEntity(dto: CreateEmailTemplateDto | UpdateEmailTemplateDto, user: ILoggedUserInfo | null): Promise<EmailTemplateBase>;
     getSelectQuery(query: SelectQueryBuilder<EmailTemplateBase>, _user: ILoggedUserInfo | null, select?: string[]): Promise<{
-        query: SelectQueryBuilder<EmailTemplateBase>;
+        query: SelectQueryBuilder<EmailTemplate>;
         isRaw: boolean;
     }>;
     protected getExtraManipulateQuery(query: SelectQueryBuilder<EmailTemplateBase>, filterDto: FilterAndPaginationDto, user: ILoggedUserInfo | null): Promise<{
-        query: SelectQueryBuilder<EmailTemplateBase>;
+        query: SelectQueryBuilder<EmailTemplate>;
         isRaw: boolean;
     }>;
     findByIdDirect(id: string): Promise<EmailTemplateBase | null>;
     findBySlug(slug: string, user?: ILoggedUserInfo): Promise<EmailTemplateBase | null>;
     getActiveTemplates(user?: ILoggedUserInfo): Promise<EmailTemplateBase[]>;
+    private incrementSchemaVersionIfChanged;
 }

package/services/index.d.ts

@@ -1,4 +1,5 @@
+export * from './email-config.service';
 export * from './email-datasource.provider';
 export * from './email-provider-config.service';
-export * from './email-template.service';
 export * from './email-send.service';
+export * from './email-template.service';

package/utils/email-templates.util.d.ts

@@ -0,0 +1,2 @@
+export declare function getOtpEmailFormat(otp: number, userName?: string | null): string;
+export declare function getResetPasswordEmailFormat(resetLink: string, userName?: string | null): string;

package/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './email-templates.util';

package/cjs/entities/email-config-base.entity.js

@@ -1,111 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "EmailConfigBase", {
-    enumerable: true,
-    get: function() {
-        return EmailConfigBase;
-    }
-});
-const _entities = require("@flusys/nestjs-shared/entities");
-const _typeorm = require("typeorm");
-const _enums = require("../enums");
-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);
-}
-let EmailConfigBase = class EmailConfigBase extends _entities.Identity {
-    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);
-    }
-};
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 255,
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], EmailConfigBase.prototype, "name", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'enum',
-        enum: _enums.EmailProviderTypeEnum,
-        nullable: false
-    }),
-    _ts_metadata("design:type", typeof _enums.EmailProviderTypeEnum === "undefined" ? Object : _enums.EmailProviderTypeEnum)
-], EmailConfigBase.prototype, "provider", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'json',
-        nullable: false
-    }),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], EmailConfigBase.prototype, "config", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 255,
-        nullable: true,
-        name: 'from_email'
-    }),
-    _ts_metadata("design:type", Object)
-], EmailConfigBase.prototype, "fromEmail", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 255,
-        nullable: true,
-        name: 'from_name'
-    }),
-    _ts_metadata("design:type", Object)
-], EmailConfigBase.prototype, "fromName", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'boolean',
-        default: true,
-        name: 'is_active'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigBase.prototype, "isActive", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'boolean',
-        default: false,
-        name: 'is_default'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigBase.prototype, "isDefault", void 0);
-EmailConfigBase = _ts_decorate([
-    (0, _typeorm.Index)([
-        'name'
-    ]),
-    (0, _typeorm.Index)([
-        'provider'
-    ]),
-    (0, _typeorm.Index)([
-        'isActive'
-    ]),
-    (0, _typeorm.Index)([
-        'isDefault'
-    ])
-], EmailConfigBase);

package/cjs/entities/email-template-base.entity.js

@@ -1,134 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "EmailTemplateBase", {
-    enumerable: true,
-    get: function() {
-        return EmailTemplateBase;
-    }
-});
-const _entities = require("@flusys/nestjs-shared/entities");
-const _typeorm = require("typeorm");
-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);
-}
-let EmailTemplateBase = class EmailTemplateBase extends _entities.Identity {
-    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);
-    }
-};
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 255,
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], EmailTemplateBase.prototype, "name", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 255,
-        nullable: false,
-        unique: true
-    }),
-    _ts_metadata("design:type", String)
-], EmailTemplateBase.prototype, "slug", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 500,
-        nullable: true
-    }),
-    _ts_metadata("design:type", Object)
-], EmailTemplateBase.prototype, "description", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'varchar',
-        length: 500,
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], EmailTemplateBase.prototype, "subject", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'json',
-        nullable: false
-    }),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], EmailTemplateBase.prototype, "schema", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'text',
-        nullable: false,
-        name: 'html_content'
-    }),
-    _ts_metadata("design:type", String)
-], EmailTemplateBase.prototype, "htmlContent", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'text',
-        nullable: true,
-        name: 'text_content'
-    }),
-    _ts_metadata("design:type", Object)
-], EmailTemplateBase.prototype, "textContent", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'int',
-        nullable: false,
-        default: 1,
-        name: 'schema_version'
-    }),
-    _ts_metadata("design:type", Number)
-], EmailTemplateBase.prototype, "schemaVersion", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'boolean',
-        default: true,
-        name: 'is_active'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailTemplateBase.prototype, "isActive", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)({
-        type: 'boolean',
-        default: true,
-        name: 'is_html'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailTemplateBase.prototype, "isHtml", void 0);
-_ts_decorate([
-    (0, _typeorm.Column)('simple-json', {
-        nullable: true
-    }),
-    _ts_metadata("design:type", Object)
-], EmailTemplateBase.prototype, "metadata", void 0);
-EmailTemplateBase = _ts_decorate([
-    (0, _typeorm.Index)([
-        'name'
-    ]),
-    (0, _typeorm.Index)([
-        'isActive'
-    ])
-], EmailTemplateBase);

package/config/email-config.service.d.ts

@@ -1,13 +0,0 @@
-import { EmailModuleOptions } from '../interfaces';
-export declare class EmailConfigService {
-    private readonly options;
-    constructor(options: EmailModuleOptions);
-    isCompanyFeatureEnabled(): boolean;
-    getDatabaseMode(): 'single' | 'multi-tenant';
-    getRateLimitPerMinute(): number;
-    isLoggingEnabled(): boolean;
-    getDefaultProvider(): string | undefined;
-    getDefaultFromName(): string;
-    getDefaultDatabaseConfig(): import("@flusys/nestjs-core").IDatabaseConfig;
-    getOptions(): EmailModuleOptions;
-}

package/entities/email-config-base.entity.d.ts

@@ -1,11 +0,0 @@
-import { Identity } from '@flusys/nestjs-shared/entities';
-import { EmailProviderTypeEnum } from '../enums';
-export declare abstract class EmailConfigBase extends Identity {
-    name: string;
-    provider: EmailProviderTypeEnum;
-    config: Record<string, any>;
-    fromEmail: string | null;
-    fromName: string | null;
-    isActive: boolean;
-    isDefault: boolean;
-}

package/entities/email-template-base.entity.d.ts

@@ -1,14 +0,0 @@
-import { Identity } from '@flusys/nestjs-shared/entities';
-export declare abstract class EmailTemplateBase extends Identity {
-    name: string;
-    slug: string;
-    description: string | null;
-    subject: string;
-    schema: Record<string, unknown>;
-    htmlContent: string;
-    textContent: string | null;
-    schemaVersion: number;
-    isActive: boolean;
-    isHtml: boolean;
-    metadata: Record<string, unknown> | null;
-}

package/fesm/entities/email-config-base.entity.js

@@ -1,101 +0,0 @@
-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 { Identity } from '@flusys/nestjs-shared/entities';
-import { Column, Index } from 'typeorm';
-import { EmailProviderTypeEnum } from '../enums';
-export class EmailConfigBase extends Identity {
-    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);
-    }
-}
-_ts_decorate([
-    Column({
-        type: 'varchar',
-        length: 255,
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], EmailConfigBase.prototype, "name", void 0);
-_ts_decorate([
-    Column({
-        type: 'enum',
-        enum: EmailProviderTypeEnum,
-        nullable: false
-    }),
-    _ts_metadata("design:type", typeof EmailProviderTypeEnum === "undefined" ? Object : EmailProviderTypeEnum)
-], EmailConfigBase.prototype, "provider", void 0);
-_ts_decorate([
-    Column({
-        type: 'json',
-        nullable: false
-    }),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], EmailConfigBase.prototype, "config", void 0);
-_ts_decorate([
-    Column({
-        type: 'varchar',
-        length: 255,
-        nullable: true,
-        name: 'from_email'
-    }),
-    _ts_metadata("design:type", Object)
-], EmailConfigBase.prototype, "fromEmail", void 0);
-_ts_decorate([
-    Column({
-        type: 'varchar',
-        length: 255,
-        nullable: true,
-        name: 'from_name'
-    }),
-    _ts_metadata("design:type", Object)
-], EmailConfigBase.prototype, "fromName", void 0);
-_ts_decorate([
-    Column({
-        type: 'boolean',
-        default: true,
-        name: 'is_active'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigBase.prototype, "isActive", void 0);
-_ts_decorate([
-    Column({
-        type: 'boolean',
-        default: false,
-        name: 'is_default'
-    }),
-    _ts_metadata("design:type", Boolean)
-], EmailConfigBase.prototype, "isDefault", void 0);
-EmailConfigBase = _ts_decorate([
-    Index([
-        'name'
-    ]),
-    Index([
-        'provider'
-    ]),
-    Index([
-        'isActive'
-    ]),
-    Index([
-        'isDefault'
-    ])
-], EmailConfigBase);