1.0.23

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,36 +3,44 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
+
+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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -41,37 +49,36 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - docker
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,34 +86,37 @@ 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:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 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
     - notpriv
   only:
@@ -114,5 +124,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Lossless GmbH
+Copyright (c) Romain SIMON
+
+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 CON

npmextra.json

@@ -7,11 +7,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartmail",
-      "shortDescription": "a unified format for representing and dealing with mails",
+      "description": "a unified format for representing and dealing with mails",
       "npmPackagename": "@pushrocks/smartmail",
       "license": "MIT"
     }

package.json

@@ -1,39 +1,46 @@
 {
   "name": "@pushrocks/smartmail",
-  "version": "1.0.5",
+  "version": "1.0.23",
   "private": false,
   "description": "a unified format for representing and dealing with mails",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
     "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.11.7",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^20.3.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartmustache": "^2.0.8"
+    "@pushrocks/smartdns": "^5.0.4",
+    "@pushrocks/smartfile": "^10.0.7",
+    "@pushrocks/smartmustache": "^3.0.2",
+    "@pushrocks/smartpath": "^5.0.5",
+    "@pushrocks/smartrequest": "^2.0.15"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,16 +8,29 @@ a unified format for representing and dealing with mails
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartmail/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartmail/badges/master/build.svg)](https://gitlab.com/pushrocks/smartmail/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartmail/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartmail/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartmail.svg)](https://www.npmjs.com/package/@pushrocks/smartmail)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartmail/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartmail)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartmail/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartmail/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartmail)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartmail)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartmail)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartmail)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartmail)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
+Use TypeScript for best in class intellisense!
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -1,13 +1,41 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartmail from '../ts/index';
+import * as smartmail from '../ts/index.js';
 
-tap.test('first test', async () => {
+let emailAddressValidatorInstance: smartmail.EmailAddressValidator;
+
+tap.test('should create an instance of EmailAddressValidator', async () => {
+  emailAddressValidatorInstance = new smartmail.EmailAddressValidator();
+  expect(emailAddressValidatorInstance).toBeInstanceOf(smartmail.EmailAddressValidator);
+});
+
+tap.test('should validate an email', async () => {
+  const result = await emailAddressValidatorInstance.validate('sandbox@bleu.de');
+  expect(result.freemail).toBeFalse();
+  expect(result.disposable).toBeFalse();
+  console.log(result);
+});
+
+tap.test('should recognize an email as freemail', async () => {
+  const result = await emailAddressValidatorInstance.validate('sandbox@gmail.com');
+  expect(result.freemail).toBeTrue();
+  expect(result.disposable).toBeFalse();
+  console.log(result);
+});
+
+tap.test('should recognize an email as disposable', async () => {
+  const result = await emailAddressValidatorInstance.validate('sandbox@gmx.de');
+  expect(result.freemail).toBeFalse();
+  expect(result.disposable).toBeTrue();
+  console.log(result);
+});
+
+tap.test('should create a SmartMail', async () => {
   const testSmartmail = new smartmail.Smartmail({
     body: 'hi there',
     from: 'noreply@mail.lossless.com',
-    subject: 'hi from here'
+    subject: 'hi from here',
   });
-  expect(testSmartmail).to.be.instanceof(smartmail.Smartmail);
+  expect(testSmartmail).toBeInstanceOf(smartmail.Smartmail);
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartmail',
+  version: '1.0.23',
+  description: 'a unified format for representing and dealing with mails'
+}

ts/index.ts

@@ -1 +1,2 @@
-export * from './smartmail.classes.smartmail';
+export * from './smartmail.classes.smartmail.js';
+export * from './smartmail.classes.emailaddressvalidator.js';

ts/smartmail.classes.emailaddressvalidator.ts

@@ -0,0 +1,55 @@
+import * as plugins from './smartmail.plugins.js';
+import * as paths from './smartmail.paths.js';
+
+export interface IEmailValidationResult {
+  valid: boolean;
+  disposable: boolean;
+  freemail: boolean;
+  reason: string;
+}
+
+export class EmailAddressValidator {
+  public domainMap: { [key: string]: 'disposable' | 'freemail' };
+
+  public smartdns = new plugins.smartdns.Smartdns({});
+
+  public async validate(emailArg: string): Promise<IEmailValidationResult> {
+    await this.fetchDomains();
+    const emailArray = emailArg.split('@');
+    const result = await this.smartdns.getRecord(emailArray[1], 'MX');
+    // console.log(emailArray);
+    // console.log(this.domainMap[emailArray[1]]);
+    return {
+      valid: !!result,
+      reason: 'todo',
+      disposable: this.domainMap[emailArray[1]] === 'disposable',
+      freemail: this.domainMap[emailArray[1]] === 'freemail',
+    };
+  }
+
+  public async fetchDomains() {
+    if (!this.domainMap) {
+      const localFileString = plugins.smartfile.fs.toStringSync(
+        plugins.path.join(paths.assetDir, 'domains.json')
+      );
+      const localFileObject = JSON.parse(localFileString);
+
+      let onlineFileObject: any;
+      try {
+        onlineFileObject = (
+          await plugins.smartrequest.getJson(
+            'https://raw.githubusercontent.com/romainsimon/emailvalid/master/domains.json'
+          )
+        ).body;
+        this.domainMap = onlineFileObject;
+        console.log(
+          'smartmail EmailAddressValidator: Using online email list for email validation'
+        );
+      } catch (e) {
+        this.domainMap = localFileObject;
+        console.log(e);
+        console.log('smartmail EmailAddressValidator: Using local email list for email validation');
+      }
+    }
+  }
+}

ts/smartmail.classes.smartmail.ts

@@ -1,19 +1,20 @@
-import * as plugins from './smartmail.plugins';
+import * as plugins from './smartmail.plugins.js';
 
-export interface ISmartmailOptions {
+export interface ISmartmailOptions<T> {
   from: string;
   subject: string;
   body: string;
+  creationObjectRef?: T;
 }
 
 /**
  * a standard representation for mails
  */
-export class Smartmail {
-  public options: ISmartmailOptions;
-  public attachments: plugins.smartfile.Smartfile[];
+export class Smartmail<T> {
+  public options: ISmartmailOptions<T>;
+  public attachments: plugins.smartfile.Smartfile[] = [];
 
-  constructor(optionsArg: ISmartmailOptions) {
+  constructor(optionsArg: ISmartmailOptions<T>) {
     this.options = optionsArg;
   }
 
@@ -21,6 +22,10 @@ export class Smartmail {
     this.attachments.push(smartfileArg);
   }
 
+  public getCreationObject(): T {
+    return this.options.creationObjectRef;
+  }
+
   public getSubject(dataArg: any = {}) {
     const smartmustache = new plugins.smartmustache.SmartMustache(this.options.subject);
     return smartmustache.applyData(dataArg);

ts/smartmail.paths.ts

@@ -0,0 +1,7 @@
+import * as plugins from './smartmail.plugins.js';
+
+export const packageDir = plugins.path.join(
+  plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
+  '../'
+);
+export const assetDir = plugins.path.join(packageDir, './assets');

ts/smartmail.plugins.ts

@@ -1,7 +1,13 @@
+// node native scope
+import * as path from 'path';
+
+export { path };
+
+// pushrocks scope
+import * as smartdns from '@pushrocks/smartdns';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartmustache from '@pushrocks/smartmustache';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartrequest from '@pushrocks/smartrequest';
 
-export {
-  smartfile,
-  smartmustache
-};
+export { smartdns, smartfile, smartmustache, smartpath, smartrequest };

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": 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"
-}