1.0.16

.gitignore

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

.gitlab-ci.yml

@@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -20,17 +20,20 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+audit:
+  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 config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -47,6 +50,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - priv
 
@@ -59,6 +63,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -70,6 +75,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -85,6 +91,7 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -95,6 +102,7 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -107,6 +115,7 @@ pages:
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -7,6 +7,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,35 +1,37 @@
 {
   "name": "@pushrocks/smartmail",
-  "version": "1.0.5",
+  "version": "1.0.16",
   "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",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
     "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "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",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.13",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartmustache": "^2.0.8"
+    "@pushrocks/smartdns": "^4.0.3",
+    "@pushrocks/smartfile": "^7.0.12",
+    "@pushrocks/smartmustache": "^2.0.9"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",

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,7 +1,18 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartmail from '../ts/index';
 
-tap.test('first test', async () => {
+let emailAddressValidatorInstance: smartmail.EmailAddressValidator;
+
+tap.test('should create an instance of EmailAddressValidator', async () => {
+  emailAddressValidatorInstance = new smartmail.EmailAddressValidator();
+  expect(emailAddressValidatorInstance).to.be.instanceOf(smartmail.EmailAddressValidator);
+});
+
+tap.test('should validate an email', async () => {
+  const result = await emailAddressValidatorInstance.validate('sandbox@bleu.de');
+});
+
+tap.test('should create a SmartMail', async () => {
   const testSmartmail = new smartmail.Smartmail({
     body: 'hi there',
     from: 'noreply@mail.lossless.com',

ts/index.ts

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

ts/smartmail.classes.emailaddressvalidator.ts

@@ -0,0 +1,19 @@
+import * as plugins from './smartmail.plugins';
+
+export interface IEmailValidationResult {
+  valid: boolean;
+  reason: string;
+}
+
+export class EmailAddressValidator {
+  public smartdns = new plugins.smartdns.Smartdns({});
+
+  public async validate(emailArg: string): Promise<IEmailValidationResult> {
+    const emailArray = emailArg.split('@');
+    const result = await this.smartdns.getRecord(emailArray[1], 'MX');
+    return {
+      valid: !!result,
+      reason: 'todo'
+    };
+  }
+}

ts/smartmail.classes.smartmail.ts

@@ -1,19 +1,20 @@
 import * as plugins from './smartmail.plugins';
 
-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.plugins.ts

@@ -1,7 +1,5 @@
+import * as smartdns from '@pushrocks/smartdns';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartmustache from '@pushrocks/smartmustache';
 
-export {
-  smartfile,
-  smartmustache
-};
+export { smartdns, smartfile, smartmustache };