@tomei/mailer 0.5.21 → 0.6.0

package/eslint.config.mjs

@@ -1,58 +1,58 @@
-import eslintPlugin from "@typescript-eslint/eslint-plugin";
-import parser from "@typescript-eslint/parser";
-import importPlugin from 'eslint-plugin-import'
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default [
-  {
-    languageOptions: {
-      parser: parser,
-      ecmaVersion: "latest", // Allows modern ECMAScript features
-      sourceType: "module",  // Allows for the use of imports
-      parserOptions: {
-        tsconfigRootDir: __dirname,
-        project: './tsconfig.json'
-      },
-    },
-    plugins: {
-      "@typescript-eslint": eslintPlugin,
-      import: importPlugin
-    },
-    rules: {
-      "no-console": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/no-var-requires": "off",
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "import/prefer-default-export": "off",
-      "@typescript-eslint/no-unused-vars": "warn",
-      "no-useless-catch": "off",
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/no-empty-interface": "off",
-      "@typescript-eslint/no-inferrable-types": "off",
-      "@typescript-eslint/no-namespace": "off",
-      "@typescript-eslint/no-use-before-define": "off",
-      "@typescript-eslint/no-unsafe-assignment": "off",
-      "@typescript-eslint/no-unsafe-call": "off",
-      "@typescript-eslint/no-unsafe-member-access": "off",
-      "@typescript-eslint/no-unsafe-return": "off",
-      "@typescript-eslint/restrict-template-expressions": "off",
-      "no-useless-escape": "off",
-      "import/no-relative-parent-imports": "error", // Enforce relative imports only
-      "import/no-absolute-path": "error",          // Block absolute imports outside aliases
-      "import/no-unresolved": ["error", { commonjs: true }],
-    },
-    settings: {
-      "import/resolver": {
-        typescript: {
-          alwaysTryTypes: true,
-        }
-      }
-    },
-    ignores: ["node_modules", "dist/**/*", "eslint.config.mjs"],
-  },
-];
+import eslintPlugin from "@typescript-eslint/eslint-plugin";
+import parser from "@typescript-eslint/parser";
+import importPlugin from 'eslint-plugin-import'
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default [
+  {
+    languageOptions: {
+      parser: parser,
+      ecmaVersion: "latest", // Allows modern ECMAScript features
+      sourceType: "module",  // Allows for the use of imports
+      parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: './tsconfig.json'
+      },
+    },
+    plugins: {
+      "@typescript-eslint": eslintPlugin,
+      import: importPlugin
+    },
+    rules: {
+      "no-console": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-var-requires": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "import/prefer-default-export": "off",
+      "@typescript-eslint/no-unused-vars": "warn",
+      "no-useless-catch": "off",
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-empty-interface": "off",
+      "@typescript-eslint/no-inferrable-types": "off",
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/no-use-before-define": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+      "no-useless-escape": "off",
+      "import/no-relative-parent-imports": "error", // Enforce relative imports only
+      "import/no-absolute-path": "error",          // Block absolute imports outside aliases
+      "import/no-unresolved": ["error", { commonjs: true }],
+    },
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true,
+        }
+      }
+    },
+    ignores: ["node_modules", "dist/**/*", "eslint.config.mjs"],
+  },
+];

package/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "@tomei/mailer",
-  "version": "0.5.21",
-  "description": "Tomei Mailer Package",
-  "main": "dist/index.js",
-  "scripts": {
-    "start:dev": "tsc -w",
-    "build": "node_modules/.bin/tsc",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "npx eslint . --fix",
-    "test": "jest --forceExit --detectOpenHandles"
-  },
-  "author": "Tomei",
-  "license": "ISC",
-  "devDependencies": {
-    "@commitlint/cli": "^19.6.0",
-    "@commitlint/config-conventional": "^19.6.0",
-    "@eslint/js": "^9.15.0",
-    "@tsconfig/node18": "^18.2.4",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.9.3",
-    "@types/nodemailer": "^6.4.17",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "globals": "^15.12.0",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "nodemailer-mock": "^2.0.6",
-    "prettier": "^3.3.3",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "tsc-watch": "^6.2.1",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.15.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "@tomei/config": "^0.3.21",
-    "nodemailer": "^6.9.16"
-  }
-}
+{
+  "name": "@tomei/mailer",
+  "version": "0.6.0",
+  "description": "Tomei Mailer Package",
+  "main": "dist/index.js",
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "npx eslint . --fix",
+    "test": "jest --forceExit --detectOpenHandles",
+    "prepare": "husky"
+  },
+  "author": "Tomei",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/js": "^9.35.0",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.3.1",
+    "@types/nodemailer": "^7.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.4.0",
+    "husky": "^9.1.7",
+    "jest": "^30.1.3",
+    "nodemailer-mock": "^2.0.9",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.1",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^7.1.1",
+    "typescript": "^5.9.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tomei/config": "^0.3.22",
+    "nodemailer": "^6.10.1"
+  }
+}

package/sonar-project.properties

@@ -1,13 +1,13 @@
-sonar.projectKey=all-tomei-projects_mailer
-sonar.organization=all-tomei-projects
-
-# This is the name and version displayed in the SonarCloud UI.
-#sonar.projectName=Mailer
-#sonar.projectVersion=1.0
-
-
-# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
-#sonar.sources=.
-
-# Encoding of the source code. Default is default system encoding
+sonar.projectKey=all-tomei-projects_mailer
+sonar.organization=all-tomei-projects
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=Mailer
+#sonar.projectVersion=1.0
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
 #sonar.sourceEncoding=UTF-8

package/src/enum/email-status.enum.ts

@@ -1,4 +1,4 @@
-export enum EmailStatus {
-  Sent = 'Sent',
-  Failed = 'Failed',
-}
+export enum EmailStatus {
+  Sent = 'Sent',
+  Failed = 'Failed',
+}

package/src/enum/index.ts

@@ -1 +1 @@
-export { EmailStatus } from './email-status.enum';
+export { EmailStatus } from './email-status.enum';

package/src/interfaces/log-transaction-options.interface.ts

@@ -1,18 +1,18 @@
-export interface ILogTransactionOption {
-  options: {
-    from: string;
-    to: string;
-    subject: string;
-  };
-  logData: {
-    systemCode: string;
-    apiUrl: string;
-    transactionName: string;
-    dbName: string;
-    tableName: string;
-    dataBefore: string;
-    dataAfter: string;
-    performAt: Date;
-    note: string;
-  };
-}
+export interface ILogTransactionOption {
+  options: {
+    from: string;
+    to: string;
+    subject: string;
+  };
+  logData: {
+    systemCode: string;
+    apiUrl: string;
+    transactionName: string;
+    dbName: string;
+    tableName: string;
+    dataBefore: string;
+    dataAfter: string;
+    performAt: Date;
+    note: string;
+  };
+}

package/src/interfaces/mail-config.interface.ts

@@ -1,8 +1,8 @@
-export interface ISendMailConfig {
-  from: string;
-  to: string | string[];
-  cc?: string | string[];
-  attachments?: any[];
-  subject: string;
-  html: any;
-}
+export interface ISendMailConfig {
+  from: string;
+  to: string | string[];
+  cc?: string | string[];
+  attachments?: any[];
+  subject: string;
+  html: any;
+}

package/src/interfaces/mail-log.interface.ts

@@ -1,12 +1,12 @@
-import { EmailStatus } from '../enum/email-status.enum';
-
-export interface IMailLog {
-  duration: number;
-  from: string;
-  to: string;
-  cc: string;
-  subject: string;
-  rawContent: string;
-  date: Date;
-  status: EmailStatus;
-}
+import { EmailStatus } from '../enum/email-status.enum';
+
+export interface IMailLog {
+  duration: number;
+  from: string;
+  to: string;
+  cc: string;
+  subject: string;
+  rawContent: string;
+  date: Date;
+  status: EmailStatus;
+}

package/src/mailer/index.ts

@@ -1,2 +1,2 @@
-export { MailerBase } from './mailer.base';
-export { SMTPMailer } from './smtp-mailer';
+export { MailerBase } from './mailer.base';
+export { SMTPMailer } from './smtp-mailer';

package/src/mailer/mailer.base.ts

@@ -1,110 +1,110 @@
-import { IMailLog } from 'src/interfaces/mail-log.interface';
-import { ILogTransactionOption } from '../interfaces/log-transaction-options.interface';
-import { ISendMailConfig } from '../interfaces/mail-config.interface';
-import * as fs from 'fs';
-import * as path from 'path';
-import { EmailStatus } from '../enum/email-status.enum';
-import { ComponentConfig } from '@tomei/config';
-
-export abstract class MailerBase {
-  abstract sendMail(options: any): Promise<any>;
-
-  async send(options: ISendMailConfig): Promise<any> {
-    // start timer
-    const start = Date.now();
-    let status: EmailStatus;
-
-    // send email
-    try {
-      await this.sendMail(options);
-      status = EmailStatus.Sent;
-    } catch (error) {
-      status = EmailStatus.Failed;
-    } finally {
-      const duration = Date.now() - start;
-      const isLogEnabled = ComponentConfig.getComponentConfigValue(
-        '@tomei/mailer',
-        'isLogEnabled',
-      );
-      if (isLogEnabled) {
-        MailerBase.log({
-          duration,
-          from: options.from,
-          to:
-            typeof options.to === 'string' ? options.to : options.to.join(','),
-          cc:
-            typeof options.cc === 'string'
-              ? options.cc
-              : options.cc
-                ? options.cc.join(',')
-                : '',
-          subject: options.subject,
-          rawContent: options.html,
-          date: new Date(),
-          status: status,
-        });
-      }
-    }
-  }
-
-  async logTransaction(logOptions: ILogTransactionOption): Promise<void> {
-    const startTime = new Date().getTime();
-    let endTime: number;
-    const options: any = {
-      from: logOptions.options.from,
-      to: logOptions.options.to,
-      subject: logOptions.options.subject,
-      html: `<div>${JSON.stringify(logOptions.logData)}</div>`,
-      cc: '',
-    };
-    let result: EmailStatus;
-
-    try {
-      await this.sendMail(options);
-      result = EmailStatus.Sent;
-    } catch (error) {
-      //Retry once
-      try {
-        console.info('Retry to send mail');
-        await this.sendMail(options);
-      } catch (retryError) {
-        result = EmailStatus.Failed;
-        console.error(retryError);
-      }
-    } finally {
-      endTime = new Date().getTime();
-      const duration = endTime - startTime;
-      const mailLogOptions: IMailLog = {
-        duration,
-        from: options.from,
-        to: options.to,
-        cc: '',
-        subject: options.subject,
-        rawContent: options.html,
-        date: new Date(),
-        status: result,
-      };
-      MailerBase.log(mailLogOptions);
-    }
-  }
-
-  static log(mailLogOptions: IMailLog): void {
-    try {
-      const logFolderPath = path.join(process.cwd(), 'mail-log');
-
-      if (!fs.existsSync(logFolderPath)) {
-        fs.mkdirSync(logFolderPath);
-      }
-
-      const currentDate = new Date();
-      const formattedDate = currentDate.toISOString().slice(0, 10);
-      const logFileName = `${formattedDate}.log`;
-      const logFilePath = path.join(logFolderPath, logFileName);
-      const stringData = JSON.stringify(mailLogOptions);
-
-      fs.appendFileSync(logFilePath, '\n' + stringData);
-    } catch (error) {
-      throw new Error('Error occurred while logging mail');
-    }
-  }
-}
+import { IMailLog } from 'src/interfaces/mail-log.interface';
+import { ILogTransactionOption } from '../interfaces/log-transaction-options.interface';
+import { ISendMailConfig } from '../interfaces/mail-config.interface';
+import * as fs from 'fs';
+import * as path from 'path';
+import { EmailStatus } from '../enum/email-status.enum';
+import { ComponentConfig } from '@tomei/config';
+
+export abstract class MailerBase {
+  abstract sendMail(options: any): Promise<any>;
+
+  async send(options: ISendMailConfig): Promise<any> {
+    // start timer
+    const start = Date.now();
+    let status: EmailStatus;
+
+    // send email
+    try {
+      await this.sendMail(options);
+      status = EmailStatus.Sent;
+    } catch (error) {
+      status = EmailStatus.Failed;
+    } finally {
+      const duration = Date.now() - start;
+      const isLogEnabled = ComponentConfig.getComponentConfigValue(
+        '@tomei/mailer',
+        'isLogEnabled',
+      );
+      if (isLogEnabled) {
+        MailerBase.log({
+          duration,
+          from: options.from,
+          to:
+            typeof options.to === 'string' ? options.to : options.to.join(','),
+          cc:
+            typeof options.cc === 'string'
+              ? options.cc
+              : options.cc
+                ? options.cc.join(',')
+                : '',
+          subject: options.subject,
+          rawContent: options.html,
+          date: new Date(),
+          status: status,
+        });
+      }
+    }
+  }
+
+  async logTransaction(logOptions: ILogTransactionOption): Promise<void> {
+    const startTime = new Date().getTime();
+    let endTime: number;
+    const options: any = {
+      from: logOptions.options.from,
+      to: logOptions.options.to,
+      subject: logOptions.options.subject,
+      html: `<div>${JSON.stringify(logOptions.logData)}</div>`,
+      cc: '',
+    };
+    let result: EmailStatus;
+
+    try {
+      await this.sendMail(options);
+      result = EmailStatus.Sent;
+    } catch (error) {
+      //Retry once
+      try {
+        console.info('Retry to send mail');
+        await this.sendMail(options);
+      } catch (retryError) {
+        result = EmailStatus.Failed;
+        console.error(retryError);
+      }
+    } finally {
+      endTime = new Date().getTime();
+      const duration = endTime - startTime;
+      const mailLogOptions: IMailLog = {
+        duration,
+        from: options.from,
+        to: options.to,
+        cc: '',
+        subject: options.subject,
+        rawContent: options.html,
+        date: new Date(),
+        status: result,
+      };
+      MailerBase.log(mailLogOptions);
+    }
+  }
+
+  static log(mailLogOptions: IMailLog): void {
+    try {
+      const logFolderPath = path.join(process.cwd(), 'mail-log');
+
+      if (!fs.existsSync(logFolderPath)) {
+        fs.mkdirSync(logFolderPath);
+      }
+
+      const currentDate = new Date();
+      const formattedDate = currentDate.toISOString().slice(0, 10);
+      const logFileName = `${formattedDate}.log`;
+      const logFilePath = path.join(logFolderPath, logFileName);
+      const stringData = JSON.stringify(mailLogOptions);
+
+      fs.appendFileSync(logFilePath, '\n' + stringData);
+    } catch (error) {
+      throw new Error('Error occurred while logging mail');
+    }
+  }
+}