Add support for Nodemailer

.github/workflows/test-nodemailer.yml

@@ -0,0 +1,20 @@
+name: Test @notifire/nodemailer
+on:
+  push:
+    paths:
+      - "providers/nodemailer/**"
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14"
+      - run: rm -rf build
+      - run: yarn install
+      - run: yarn bootstrap
+      - run: yarn build
+      - name: Test
+        working-directory: "providers/nodemailer"
+        run: yarn test

providers/nodemailer/.cspell.json

@@ -0,0 +1,36 @@
+{
+  "version": "0.1",
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json",
+  "language": "en",
+  "words": [
+    "bitjson",
+    "bitauth",
+    "cimg",
+    "circleci",
+    "codecov",
+    "commitlint",
+    "dependabot",
+    "editorconfig",
+    "esnext",
+    "execa",
+    "exponentiate",
+    "globby",
+    "libauth",
+    "mkdir",
+    "prettierignore",
+    "sandboxed",
+    "transpiled",
+    "typedoc",
+    "untracked",
+    "Sendgrid",
+    "notifire"
+  ],
+  "flagWords": [],
+  "ignorePaths": [
+    "package.json",
+    "package-lock.json",
+    "yarn.lock",
+    "tsconfig.json",
+    "node_modules/**"
+  ]
+}

providers/nodemailer/.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false

providers/nodemailer/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.eslintrc.json"
+}

providers/nodemailer/.gitignore

@@ -0,0 +1,9 @@
+.idea/*
+.nyc_output
+build
+node_modules
+test
+src/**.js
+coverage
+*.log
+package-lock.json

providers/nodemailer/.prettierignore

@@ -0,0 +1,2 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json

providers/nodemailer/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.1.4](https://github.com/notifirehq/nodemailer/compare/v0.1.5...v0.1.4) (2021-10-08)

providers/nodemailer/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Dima Grossman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

providers/nodemailer/README.md

@@ -0,0 +1,18 @@
+# Nodejs Nodemailer Provider
+
+A nodemailer email provider library for [@notifire/core](https://github.com/notifirehq/notifire)
+
+## Usage
+
+```javascript
+import { NodemailerProvider } from '@notifire/nodemailer';
+
+const provider = new NodemailerProvider({
+  from: process.env.NODEMAILER_FROM_EMAIL,
+  host: process.env.NODEMAILER_HOST,
+  user: process.env.NODEMAILER_USERNAME,
+  password: process.env.NODEMAILER_PASSWORD,
+  port: process.env.NODEMAILER_PORT,
+  secure: process.env.NODEMAILER_SECURE,
+});
+```

providers/nodemailer/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

providers/nodemailer/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@notifire/nodemailer",
+  "version": "0.1.4",
+  "description": "A nodemailer wrapper for notifire",
+  "main": "build/main/index.js",
+  "typings": "build/main/index.d.ts",
+  "module": "build/module/index.js",
+  "private": false,
+  "repository": "https://github.com/notifirehq/nodemailer",
+  "license": "MIT",
+  "keywords": [],
+  "scripts": {
+    "build": "run-p build:*",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:lint": "eslint src --ext .ts --fix",
+    "test": "run-s build test:*",
+    "test:lint": "eslint src --ext .ts",
+    "test:prettier": "prettier \"src/**/*.ts\" --list-different",
+    "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
+    "test:unit": "jest src",
+    "check-cli": "run-s test diff-integration-tests check-integration-tests",
+    "check-integration-tests": "run-s check-integration-test:*",
+    "diff-integration-tests": "mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'",
+    "watch:build": "tsc -p tsconfig.json -w",
+    "watch:test": "jest src --watch",
+    "cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
+    "cov:html": "nyc report --reporter=html",
+    "cov:lcov": "nyc report --reporter=lcov",
+    "cov:send": "run-s cov:lcov && codecov",
+    "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
+    "doc": "run-s doc:html && open-cli build/docs/index.html",
+    "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
+    "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
+    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+    "version": "standard-version",
+    "reset-hard": "git clean -dfx && git reset --hard && yarn",
+    "prepare-release": "run-s reset-hard test version"
+  },
+  "engines": {
+    "node": ">=10"
+  },
+  "dependencies": {
+    "@notifire/core": "^0.1.4",
+    "nodemailer": "^6.6.5"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@types/jest": "^27.0.1",
+    "@types/nodemailer": "^6.4.4",
+    "codecov": "^3.5.0",
+    "cspell": "^4.1.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "gh-pages": "^3.1.0",
+    "jest": "^27.1.0",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0",
+    "open-cli": "^6.0.1",
+    "prettier": "^2.1.1",
+    "standard-version": "^9.0.0",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^9.0.0",
+    "typedoc": "^0.19.0"
+  },
+  "files": [
+    "build/main",
+    "build/module",
+    "!**/*.spec.*",
+    "!**/*.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "ava": {
+    "failFast": true,
+    "timeout": "60s",
+    "typescript": {
+      "rewritePaths": {
+        "src/": "build/main/"
+      }
+    },
+    "files": [
+      "!build/module/**"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "exclude": [
+      "**/*.spec.js"
+    ]
+  }
+}

providers/nodemailer/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/nodemailer.provider';

providers/nodemailer/src/lib/nodemailer.provider.spec.ts

@@ -0,0 +1,39 @@
+const sendMailMock = jest.fn().mockReturnValue(() => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return {} as any;
+});
+
+import { NodemailerProvider } from './nodemailer.provider';
+
+jest.mock('nodemailer', () => {
+  return {
+    createTransport: jest.fn().mockReturnValue({
+      sendMail: sendMailMock,
+    }),
+  };
+});
+
+test('should trigger nodemailer correctly', async () => {
+  const provider = new NodemailerProvider({
+    from: '[email protected]',
+    host: 'test.test.email',
+    user: '[email protected]',
+    password: 'test123',
+    port: 587,
+    secure: false,
+  });
+
+  await provider.sendMessage({
+    to: '[email protected]',
+    subject: 'test subject',
+    html: '<div> Mail Content </div>',
+  });
+
+  expect(sendMailMock).toHaveBeenCalled();
+  expect(sendMailMock).toHaveBeenCalledWith({
+    from: '[email protected]',
+    html: '<div> Mail Content </div>',
+    subject: 'test subject',
+    to: '[email protected]',
+  });
+});

providers/nodemailer/src/lib/nodemailer.provider.ts

@@ -0,0 +1,39 @@
+import { ChannelTypeEnum, IEmailOptions, IEmailProvider } from '@notifire/core';
+import nodemailer, { Transporter } from 'nodemailer';
+
+export class NodemailerProvider implements IEmailProvider {
+  id = 'nodemailer';
+  channelType = ChannelTypeEnum.EMAIL as ChannelTypeEnum.EMAIL;
+  private transports: Transporter;
+
+  constructor(
+    private config: {
+      from: string;
+      host: string;
+      port: number;
+      secure: boolean;
+      user: string;
+      password: string;
+    }
+  ) {
+    this.transports = nodemailer.createTransport({
+      host: this.config.host,
+      port: this.config.port,
+      secure: this.config.secure,
+      auth: {
+        user: this.config.user,
+        pass: this.config.password,
+      },
+    });
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async sendMessage(options: IEmailOptions): Promise<any> {
+    return await this.transports.sendMail({
+      from: options.from || this.config.from,
+      to: options.to,
+      subject: options.subject,
+      html: options.html,
+    });
+  }
+}

providers/nodemailer/src/types/example.d.ts

@@ -0,0 +1,20 @@
+/**
+ * If you import a dependency which does not include its own type definitions,
+ * TypeScript will try to find a definition for it by following the `typeRoots`
+ * compiler option in tsconfig.json. For this project, we've configured it to
+ * fall back to this folder if nothing is found in node_modules/@types.
+ *
+ * Often, you can install the DefinitelyTyped
+ * (https://github.com/DefinitelyTyped/DefinitelyTyped) type definition for the
+ * dependency in question. However, if no one has yet contributed definitions
+ * for the package, you may want to declare your own. (If you're using the
+ * `noImplicitAny` compiler options, you'll be required to declare it.)
+ *
+ * This is an example type definition which allows import from `module-name`,
+ * e.g.:
+ * ```ts
+ * import something from 'module-name';
+ * something();
+ * ```
+ */
+declare module 'module-name' {}

providers/nodemailer/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build/main",
+    "rootDir": "src",
+    "types": ["node", "jest"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules/**"]
+}

providers/nodemailer/tsconfig.module.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig",
+  "compilerOptions": {
+    "target": "esnext",
+    "outDir": "build/module",
+    "module": "esnext"
+  },
+  "exclude": [
+    "node_modules/**"
+  ]
+}