@vroskus/library-email 1.0.0 → 1.0.1

package/.eslintrc

@@ -0,0 +1,76 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "project": ["tsconfig.json"]
+  },
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript",
+    "plugin:import/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:sort/recommended"
+  ],
+  "plugins": [
+    "@typescript-eslint",
+    "import",
+    "import-newlines",
+    "react",
+    "sort"
+  ],
+  "rules": {
+    "complexity": ["error", 5],
+    "@typescript-eslint/ban-ts-comment": [1],
+    "@typescript-eslint/no-unused-vars": [2],
+    "curly": ["error", "all"],
+    "import/no-cycle": [0],
+    "no-await-in-loop": 0,
+    "no-console": "error",
+    "no-duplicate-imports": [0],
+    "no-loss-of-precision": [0],
+    "no-restricted-syntax": 0,
+    "no-unreachable-loop": [0],
+    "no-useless-backreference": [0],
+    "no-unused-private-class-members": [2],
+    "padding-line-between-statements": ["error", {
+      "blankLine": "always",
+      "prev": ["const", "let"],
+      "next": "*"
+    }, {
+      "blankLine": "any",
+      "prev": ["const", "let"],
+      "next": ["const", "let"]
+    }, {
+      "blankLine": "always",
+      "prev": ["if", "function", "for"],
+      "next": "*"
+    }, {
+      "blankLine": "always",
+      "prev": "*",
+      "next": "return"
+    }],
+    "object-curly-newline": ["error", {
+      "ObjectExpression": "always",
+      "ObjectPattern": "always",
+      "ImportDeclaration": "always",
+      "ExportDeclaration": "always"
+    }],
+    "function-call-argument-newline": ["error", "always"],
+    "object-property-newline": ["error", {
+      "allowMultiplePropertiesPerLine": false
+    }],
+    "import-newlines/enforce": ["error", {
+      "items": 1,
+      "forceSingleLine": false
+    }],
+    "sort/imports": [0],
+    "sort/exports": [0]
+  },
+  "env": {
+    "node": true,
+    "jest": true,
+    "es6": true
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import type { $Config as Config } from './types';
+type $SendMailParams = {
+    bcc?: string | Array<string>;
+    from: string;
+    html: string;
+    replyTo?: string;
+    subject: string;
+    text: string;
+    to: string | Array<string>;
+};
+type $SendEmailResponse = {
+    accepted: Array<string>;
+    messageId: string;
+    pending: Array<string>;
+    rejected: Array<string>;
+    response: string;
+};
+type $Transporter = {
+    sendMail: (arg0: $SendMailParams) => Promise<$SendEmailResponse>;
+};
+export type $Config = Config;
+declare class EmailService<C extends Config> {
+    #private;
+    from: string;
+    transporter: $Transporter;
+    constructor({ email, from, host, password, port, username, }: C);
+    sendMail({ bcc, content, replyTo, subject, to, }: {
+        bcc?: string | Array<string>;
+        content: string;
+        replyTo?: string;
+        subject: string;
+        to: string | Array<string>;
+    }): Promise<string>;
+}
+export default EmailService;

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,4DAAoC;AACpC,+CAEsB;AA+BtB,MAAM,YAAY;IAKhB,YAAY,EACV,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,QAAQ,GACN;;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,MAAM,KAAK,GAAG,CAAC;QAEnC,uBAAA,IAAI,+DAAkB,MAAtB,IAAI,EAAmB;YACrB,IAAI;YACJ,QAAQ;YACR,IAAI,EAAE,IAAI,IAAI,IAAI;YAClB,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAgEK,QAAQ,CAAC,EACb,GAAG,EACH,OAAO,EACP,OAAO,EACP,OAAO,EACP,EAAE,GAOH;;YACC,MAAM,MAAM,GAAG;gBACb,GAAG;gBACH,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,OAAO;gBACb,OAAO;gBACP,OAAO;gBACP,IAAI,EAAE,IAAA,yBAAU,EAAC,OAAO,CAAC;gBACzB,EAAE;aACH,CAAC;YAEF,MAAM,IAAI,GAAuB,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAGzE,OAAO,CAAC,GAAG,CACT,MAAM,EACN,IAAI,CACL,CAAC;YAEF,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;KAAA;CACF;kHA/FmB,EAChB,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,QAAQ,GAMT;IACC,IAAI,CAAC,WAAW,GAAG;QACjB,QAAQ,EAAE,CAAO,EACf,GAAG,EACH,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,EAAE,GACH,EAAE,EAAE;YAEH,OAAO,CAAC,GAAG,CACT,UAAU,EACV,wBAAwB,EACxB,iBAAiB,EACjB,EAAE,EACF,GAAG,EACH,OAAO,EACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACrB,CAAC;YAEF,OAAO;gBACL,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,SAAS,EAAE,GAAG;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;gBACZ,QAAQ,EAAE,6BAA6B;aACxC,CAAC;QACJ,CAAC,CAAA;KACF,CAAC;IAEF,IAAI,IAAI,KAAK,EAAE,EAAE;QACf,IAAI,IAAI,CAAC;QAET,IAAI,QAAQ,IAAI,QAAQ,EAAE;YACxB,IAAI,GAAG;gBACL,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;SACH;QAED,MAAM,MAAM,GAAG;YACb,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,oBAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;KACvD;AACH,CAAC;AAqCH,kBAAe,YAAY,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+export type $Config = {
+    email: string;
+    from: string;
+    host: string;
+    password: string;
+    port: string;
+    username: string;
+};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vroskus/library-email",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Email",
   "author": "Vilius Roškus <vilius@regattas.eu>",
   "license": "MIT",
@@ -9,9 +9,6 @@
     "url": "git+https://github.com/vroskus/library-email.git"
   },
   "main": "dist/index.js",
-  "files": [
-    "dist/index.js"
-  ],
   "scripts": {
     "postinstall": "npm run build",
     "build": "tsc",
@@ -20,6 +17,8 @@
     "test:e2e": "echo 'No tests'"
   },
   "dependencies": {
+    "@types/lodash": "4.14.192",
+    "@types/nodemailer": "6.4.7",
     "html-to-text": "9.0.4",
     "lodash": "4.17.21",
     "nodemailer": "6.9.1"
@@ -39,4 +38,4 @@
     "npm-check": "6.0.1",
     "typescript": "4.9.5"
   }
-}
+}

package/src/index.ts

@@ -0,0 +1,156 @@
+// Helpers
+import nodemailer from 'nodemailer';
+import {
+  htmlToText,
+} from 'html-to-text';
+
+// Types
+import type {
+  $Config as Config,
+} from './types';
+
+type $SendMailParams = {
+  bcc?: string | Array<string>;
+  from: string;
+  html: string;
+  replyTo?: string;
+  subject: string;
+  text: string;
+  to: string | Array<string>;
+};
+
+type $SendEmailResponse = {
+  accepted: Array<string>;
+  messageId: string;
+  pending: Array<string>;
+  rejected: Array<string>;
+  response: string;
+};
+
+type $Transporter = {
+  sendMail: (arg0: $SendMailParams) => Promise<$SendEmailResponse>;
+};
+
+export type $Config = Config;
+
+class EmailService<C extends Config> {
+  from: string;
+
+  transporter: $Transporter;
+
+  constructor({
+    email,
+    from,
+    host,
+    password,
+    port,
+    username,
+  }: C) {
+    this.from = `"${from}" <${email}>`;
+
+    this.#setupTransporter({
+      host,
+      password,
+      port: port || '25',
+      username,
+    });
+  }
+
+  #setupTransporter({
+    host,
+    password,
+    port,
+    username,
+  }: {
+    host: string;
+    password?: string;
+    port: string;
+    username?: string;
+  }): void {
+    this.transporter = {
+      sendMail: async ({
+        bcc,
+        html,
+        subject,
+        text,
+        to,
+      }) => {
+        // eslint-disable-next-line no-console
+        console.log(
+          '\x1b[33m',
+          'EmailService.sendEmail',
+          '\x1b[0m\x1b[90m',
+          to,
+          bcc,
+          subject,
+          JSON.stringify(html),
+          JSON.stringify(text),
+        );
+
+        return {
+          accepted: Array.isArray(to) ? to : [to],
+          messageId: '0',
+          pending: [],
+          rejected: [],
+          response: 'Email sent by dummy service',
+        };
+      },
+    };
+
+    if (host !== '') {
+      let auth;
+
+      if (username && password) {
+        auth = {
+          pass: password,
+          user: username,
+        };
+      }
+
+      const params = {
+        auth,
+        host,
+        port,
+        secure: false,
+      };
+
+      this.transporter = nodemailer.createTransport(params);
+    }
+  }
+
+  async sendMail({
+    bcc,
+    content,
+    replyTo,
+    subject,
+    to,
+  }: {
+    bcc?: string | Array<string>;
+    content: string;
+    replyTo?: string;
+    subject: string;
+    to: string | Array<string>;
+  }): Promise<string> {
+    const params = {
+      bcc,
+      from: this.from,
+      html: content,
+      replyTo,
+      subject,
+      text: htmlToText(content),
+      to,
+    };
+
+    const info: $SendEmailResponse = await this.transporter.sendMail(params);
+
+    // eslint-disable-next-line no-console
+    console.log(
+      'info',
+      info,
+    );
+
+    return info.messageId;
+  }
+}
+
+export default EmailService;

package/src/types.ts

@@ -0,0 +1,8 @@
+export type $Config = {
+  email: string;
+  from: string;
+  host: string;
+  password: string;
+  port: string;
+  username: string;
+};

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "types": ["node", "jest"],
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "declaration": true,
+    "noImplicitAny": false,
+    "removeComments": true,
+    "noLib": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es6",
+    "sourceMap": true,
+    "lib": [
+      "es6"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "./dist/**/*"
+  ],
+   "include": [
+    "./src"
+  ]
+}