@tomei/mailer 0.7.1 → 0.10.0-dev.1

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.7.1",
-  "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.5.2",
-    "@types/nodemailer": "^7.0.1",
-    "@typescript-eslint/eslint-plugin": "^8.44.0",
-    "@typescript-eslint/parser": "^8.44.0",
-    "eslint": "^9.35.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-import": "^2.32.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.3",
-    "ts-node": "^10.9.2",
-    "tsc-watch": "^7.1.1",
-    "typescript": "^5.9.2"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "@tomei/config": "^0.3.22",
-    "nodemailer": "^7.0.6"
-  }
-}
+{
+  "name": "@tomei/mailer",
+  "version": "0.10.0-dev.1",
+  "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.5.2",
+    "@types/nodemailer": "^7.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.44.0",
+    "@typescript-eslint/parser": "^8.44.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.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.3",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^7.1.1",
+    "typescript": "^5.9.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tomei/config": "^0.3.22",
+    "nodemailer": "^7.0.6"
+  }
+}

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/EmailLog.ts

@@ -0,0 +1,91 @@
+export type EmailStatus = 'pending' | 'success' | 'failed';
+
+export interface EmailLogProps {
+  id: string;
+  recipient: string;
+  subject: string;
+  emailType: string;
+  bodyHtml: string;
+  bodyText: string;
+  payload: string;
+  status?: string;
+  error?: string;
+  sentAt?: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+  resentFromId?: string;
+  resendMethod?: string;
+  resentById?: string;
+}
+
+export class EmailLog {
+  public readonly id: string;
+  public readonly recipient: string;
+  public readonly subject: string;
+  public readonly emailType: string;
+  public readonly bodyHtml: string;
+  public readonly bodyText: string;
+  public readonly payload: string;
+
+  public error?: string;
+
+  public readonly sentAt: Date;
+  public readonly createdAt: Date;
+  public updatedAt?: Date;
+
+  public readonly resentFromId?: string;
+  public readonly resendMethod?: string;
+  public readonly resentById?: string;
+
+  private _status: EmailStatus;
+
+  constructor(props: EmailLogProps) {
+    this.id = props.id;
+    this.recipient = props.recipient;
+    this.subject = props.subject;
+    this.emailType = props.emailType;
+    this.bodyHtml = props.bodyHtml;
+    this.bodyText = props.bodyText;
+    this.payload = props.payload;
+
+    this.sentAt = props.sentAt || new Date();
+    this.createdAt = props.createdAt || new Date();
+    this.updatedAt = props.updatedAt;
+
+    this.resentFromId = props.resentFromId;
+    this.resendMethod = props.resendMethod;
+    this.resentById = props.resentById;
+
+    this.error = props.error;
+    this._status = this.normalizeStatus(props.status);
+  }
+
+  get status(): EmailStatus {
+    return this._status;
+  }
+
+  public updateStatus(status: EmailStatus | string): void {
+    const normalized = this.normalizeStatus(status);
+
+    if (this._status === normalized) {
+      return;
+    }
+
+    if (this._status !== 'pending') {
+      throw new Error(
+        `Invalid status transition: cannot change from '${this._status}' to '${normalized}'`,
+      );
+    }
+
+    this._status = normalized;
+    this.updatedAt = new Date();
+  }
+
+  private normalizeStatus(status?: string): EmailStatus {
+    const s = (status || 'pending').toLowerCase();
+    if (s === 'pending' || s === 'success' || s === 'failed') {
+      return s as EmailStatus;
+    }
+    throw new Error(`Invalid EmailStatus value: ${status}`);
+  }
+}

package/src/interfaces/IEmailRepository.ts

@@ -0,0 +1,18 @@
+import { EmailLog, EmailStatus } from './EmailLog';
+
+export class MailFilter {
+  status?: EmailStatus;
+  recipient?: string;
+  subject?: string;
+  fromDate?: Date;
+  toDate?: Date;
+
+  hasValue(): boolean {
+    return Object.values(this).some((value) => value);
+  }
+}
+
+export interface IEmailRepository {
+  listAll(): Promise<EmailLog[]>;
+  listWithFilter(filter: MailFilter): Promise<EmailLog[]>;
+}

package/src/interfaces/index.ts

@@ -1,3 +1,5 @@
 export { ILogTransactionOption } from './log-transaction-options.interface';
 export { IMailLog } from './mail-log.interface';
 export { ISendMailConfig } from './mail-config.interface';
+export { EmailLog } from './EmailLog';
+export { IEmailRepository, MailFilter } from './IEmailRepository';

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';