2.0.1

.gitlab-ci.yml

@@ -12,30 +12,35 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
-audit:
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +55,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +66,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +86,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -109,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.gitlab/.gitlab-webide.yml

@@ -1,8 +0,0 @@
-terminal:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:stable
-  before_script:
-    - npm install -g npm-check
-  variables:
-    RAILS_ENV: "test"
-    NODE_ENV: "test"
-

.snyk

@@ -1,4 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.5
-ignore: {}
-patch: {}

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "mojoio",
       "gitrepo": "mailgun",
-      "shortDescription": "an api abstraction package for mailgun",
+      "description": "an api abstraction package for mailgun",
       "npmPackagename": "@mojoio/mailgun",
       "license": "MIT",
       "projectDomain": "mojo.io"

package.json

@@ -1,31 +1,32 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.26",
+  "version": "2.0.1",
   "private": false,
   "description": "an api abstraction package for mailgun",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "format": "(gitzone format)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^13.13.4",
-    "tslint": "^6.1.1",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/qenv": "^5.0.2",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.4"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.12",
-    "@pushrocks/smartmail": "^1.0.11",
-    "@pushrocks/smartrequest": "^1.1.47",
-    "@pushrocks/smartstring": "^3.0.18"
+    "@pushrocks/smartfile": "^10.0.4",
+    "@pushrocks/smartmail": "^1.0.22",
+    "@pushrocks/smartrequest": "^2.0.10",
+    "@pushrocks/smartsmtp": "^3.0.3",
+    "@pushrocks/smartstring": "^4.0.2"
   },
   "files": [
     "ts/**/*",
@@ -38,5 +39,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

qenv.yml

@@ -1,2 +1,3 @@
 required:
-  - MAILGUN_API_TOKEN
+  - MAILGUN_API_TOKEN
+  - MAILGUN_SMTP_CREDENTIALS

test/test.ts

@@ -4,35 +4,56 @@ import * as smartmail from '@pushrocks/smartmail';
 
 const testQenv = new Qenv('./', './.nogit');
 
-import * as mailgun from '../ts/index';
-import { IMailgunMessage } from '../ts/index';
+import * as mailgun from '../ts/index.js';
+import { IMailgunMessage } from '../ts/index.js';
 
 let testMailgunAccount: mailgun.MailgunAccount;
 let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
 
 tap.test('should create a mailgun account', async () => {
-  testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'));
-  expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount);
+  testMailgunAccount = new mailgun.MailgunAccount({
+    apiToken: testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'),
+    region: 'eu',
+  });
+  await testMailgunAccount.addSmtpCredentials(
+    testQenv.getEnvVarOnDemand('MAILGUN_SMTP_CREDENTIALS')
+  );
+  expect(testMailgunAccount).toBeInstanceOf(mailgun.MailgunAccount);
 });
 
 tap.test('should create a smartmail', async () => {
   testSmartmail = new smartmail.Smartmail({
     body: 'hi there. This is the body.',
     from: 'Lossless GmbH <noreply@mail.lossless.com>',
-    subject: 'TestMessage from @mojoio/mailgun test'
+    subject: 'TestMessage from @mojoio/mailgun test',
   });
-  return testSmartmail;
+  expect(testSmartmail).toBeInstanceOf(smartmail.Smartmail);
 });
 
 tap.test('should send a smartmail', async () => {
   await testMailgunAccount.sendSmartMail(testSmartmail, 'Sandbox Team <sandbox@mail.git.zone>');
 });
 
+tap.test('should send a smartmail with empty body', async () => {
+  const emptyBodySmartmail = new smartmail.Smartmail<IMailgunMessage>({
+    body: '',
+    from: 'Lossless GmbH <noreply@mail.lossless.one>',
+    subject: 'A message with no body from @mojoio/mailgun test',
+  });
+  await testMailgunAccount.sendSmartMail(
+    emptyBodySmartmail,
+    'Sandbox Team <sandbox@mail.git.zone>'
+  );
+});
+
 tap.test('should retrieve a mail using a retrieval url', async () => {
   const result = await testMailgunAccount.retrieveSmartMailFromMessageUrl(
     'https://sw.api.mailgun.net/v3/domains/mail.lossless.one/messages/AgMFnnnAKC8xp_dDa79LyoxhloxtaVmnRA=='
   );
-  if (result) {
+  console.log(result);
+
+  // TODO handle empty body
+  if (false) {
     result.options.subject = 'hi there. This is a testmail with attachment';
     result.options.from = 'noreply@mail.lossless.com';
     await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@mojoio/mailgun',
+  version: '2.0.1',
+  description: 'an api abstraction package for mailgun'
+}

ts/index.ts

@@ -1,2 +1,2 @@
-export * from './mailgun.classes.account';
-export * from './interfaces';
+export * from './mailgun.classes.account.js';
+export * from './interfaces/index.js';

ts/interfaces/index.ts

@@ -1,2 +1,2 @@
-export * from './message';
-export * from './notification';
+export * from './message.js';
+export * from './notification.js';

ts/mailgun.classes.account.ts

@@ -1,25 +1,57 @@
-import * as plugins from './mailgun.plugins';
-import * as interfaces from './interfaces';
+import * as plugins from './mailgun.plugins.js';
+import * as interfaces from './interfaces/index.js';
+
+export interface IMailgunAccountContructorOptions {
+  apiToken: string;
+  region: 'eu' | 'us';
+}
 
 export class MailgunAccount {
-  public baseUrl = 'https://api.mailgun.net/v3';
-  public apiToken: string;
+  public apiBaseUrl: string;
 
-  constructor(apiTokenArg: string) {
-    this.apiToken = apiTokenArg;
+  public options: IMailgunAccountContructorOptions;
+
+  public smartSmtps: { [domain: string]: plugins.smartsmtp.Smartsmtp } = {};
+
+  constructor(optionsArg: IMailgunAccountContructorOptions) {
+    this.options = optionsArg;
+    this.apiBaseUrl =
+      this.options.region === 'eu'
+        ? 'https://api.eu.mailgun.net/v3'
+        : 'https://api..mailgun.net/v3';
+  }
+
+  /**
+   * allows adding smtp credentials
+   * Format: [domain]|[username]|[password]
+   */
+  public async addSmtpCredentials(credentials: string) {
+    const credentialArray = credentials.split('|');
+    if (credentialArray.length !== 3) {
+      throw new Error('credentials are in the wrong format');
+    }
+    this.smartSmtps[credentialArray[0]] =
+      await plugins.smartsmtp.Smartsmtp.createSmartsmtpWithRelay({
+        smtpServer: 'smtp.eu.mailgun.org',
+        smtpUser: credentialArray[1],
+        smtpPassword: credentialArray[2],
+      });
   }
 
   public async getRequest(routeArg: string, binaryArg: boolean = false) {
     let requestUrl = routeArg;
     const needsBaseUrlPrefix = !routeArg.startsWith('https://');
-    needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null;
+    if (needsBaseUrlPrefix) {
+      requestUrl = `${this.apiBaseUrl}${routeArg}`;
+    }
     console.log(requestUrl);
     const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
       method: 'GET',
       headers: {
-        Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
-        'Content-Type': 'application/json'
-      }
+        Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.options.apiToken}`)}`,
+        'Content-Type': 'application/json',
+      },
+      keepAlive: false,
     };
     let response: plugins.smartrequest.IExtendedIncomingMessage;
     if (!binaryArg) {
@@ -31,13 +63,17 @@ export class MailgunAccount {
   }
 
   public async postFormData(routeArg: string, formFields: plugins.smartrequest.IFormField[]) {
-    const requestUrl = `${this.baseUrl}${routeArg}`; // TODO;
+    const requestUrl = `${this.apiBaseUrl}${routeArg}`;
+    console.log(requestUrl);
     const response = await plugins.smartrequest.postFormData(
       requestUrl,
       {
         headers: {
-          Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`
-        }
+          Authorization: `Basic ${plugins.smartstring.base64.encode(
+            `api:${this.options.apiToken}`
+          )}`,
+        },
+        keepAlive: false,
       },
       formFields
     );
@@ -57,23 +93,23 @@ export class MailgunAccount {
       {
         name: 'from',
         type: 'string',
-        payload: smartmailArg.options.from
+        payload: smartmailArg.options.from,
       },
       {
         name: 'to',
         type: 'string',
-        payload: toArg
+        payload: toArg,
       },
       {
         name: 'subject',
         type: 'string',
-        payload: smartmailArg.getSubject(dataArg)
+        payload: smartmailArg.getSubject(dataArg),
       },
       {
         name: 'html',
         type: 'string',
-        payload: smartmailArg.getBody(dataArg)
-      }
+        payload: smartmailArg.getBody(dataArg),
+      },
     ];
 
     console.log(smartmailArg.attachments);
@@ -83,20 +119,44 @@ export class MailgunAccount {
         name: 'attachment',
         type: 'Buffer',
         payload: attachment.contentBuffer,
-        fileName: attachment.parsedPath.base
+        fileName: attachment.parsedPath.base,
       });
     }
 
-    const response = await this.postFormData(`/${domain}/messages`, formFields);
-    if (response.statusCode === 200) {
-      return response.body;
+    if (smartmailArg.getBody(dataArg)) {
+      console.log('All requirements for API met');
+      const response = await this.postFormData(`/${domain}/messages`, formFields);
+      if (response.statusCode === 200) {
+        console.log(
+          `Sent mail with subject ${smartmailArg.getSubject(
+            dataArg
+          )} to ${toArg} using the mailgun API`
+        );
+        return response.body;
+      } else {
+        console.log(response.body);
+        throw new Error('could not send email');
+      }
     } else {
-      console.log(response.body);
-      throw new Error('could not send email');
+      console.log(
+        'An empty body was provided. This does not work via the API, but using SMTP instead.'
+      );
+      const wantedSmartsmtp = this.smartSmtps[domain];
+      if (!wantedSmartsmtp) {
+        console.log('did not find appropriate smtp credentials');
+        return;
+      }
+      await wantedSmartsmtp.sendSmartMail(smartmailArg, toArg);
+      console.log(
+        `Sent mail with subject "${smartmailArg.getSubject(
+          dataArg
+        )}" to "${toArg}" using an smtp transport over Mailgun.`
+      );
     }
   }
 
   public async retrieveSmartMailFromMessageUrl(messageUrlArg: string) {
+    console.log(`retrieving message for ${messageUrlArg}`);
     const response = await this.getRequest(messageUrlArg);
     if (response.statusCode === 404) {
       console.log(response.body.message);
@@ -107,7 +167,7 @@ export class MailgunAccount {
       from: responseBody.From,
       body: responseBody['body-html'],
       subject: responseBody.Subject,
-      creationObjectRef: responseBody
+      creationObjectRef: responseBody,
     });
 
     // lets care about attachments
@@ -119,7 +179,7 @@ export class MailgunAccount {
           new plugins.smartfile.Smartfile({
             path: `./${attachmentName}`,
             base: `./${attachmentName}`,
-            contentBuffer: attachmentContents.body
+            contentBuffer: attachmentContents.body,
           })
         );
       }

ts/mailgun.plugins.ts

@@ -2,6 +2,7 @@
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartmail from '@pushrocks/smartmail';
 import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartsmtp from '@pushrocks/smartsmtp';
 import * as smartstring from '@pushrocks/smartstring';
 
-export { smartfile, smartmail, smartrequest, smartstring };
+export { smartfile, smartmail, smartrequest, smartsmtp, smartstring };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}