1.0.13

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+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
 
 # ====================
 # security stage
@@ -18,114 +18,103 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - 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
-  - notpriv
+    - lossless
+    - docker
+    - priv
 
-testSTABLE:
+testBuild:
   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 command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 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
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint 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:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -133,15 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
+      - public
   allow_failure: true

npmextra.json

@@ -3,6 +3,17 @@
     "npmGlobalTools": [
       "@gitzone/npmts",
       "ts-node"
-    ]
+    ],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartmail",
+      "shortDescription": "a unified format for representing and dealing with mails",
+      "npmPackagename": "@pushrocks/smartmail",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "smartmail",
-  "version": "1.0.2",
+  "name": "@pushrocks/smartmail",
+  "version": "1.0.13",
   "private": false,
   "description": "a unified format for representing and dealing with mails",
   "main": "dist/index.js",
@@ -13,11 +13,28 @@
     "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.3"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.1.6",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@pushrocks/smartdns": "^4.0.3",
+    "@pushrocks/smartfile": "^7.0.6",
+    "@pushrocks/smartmustache": "^2.0.9"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,35 @@
+# @pushrocks/smartmail
+a unified format for representing and dealing with mails
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartmail)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartmail)
+* [github.com (source mirror)](https://github.com/pushrocks/smartmail)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartmail/)
+
+## Status for master
+[![pipeline status](https://gitlab.com/pushrocks/smartmail/badges/master/pipeline.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/)
+
+## Usage
+
+## 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). :)
+
+
+## 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)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,23 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartmail from '../ts/index';
 
+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('first test', async () => {
-  const testSmartmail = new smartmail.Smartmail();
+  const testSmartmail = new smartmail.Smartmail({
+    body: 'hi there',
+    from: 'noreply@mail.lossless.com',
+    subject: 'hi from here'
+  });
   expect(testSmartmail).to.be.instanceof(smartmail.Smartmail);
 });
 

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,11 +1,38 @@
 import * as plugins from './smartmail.plugins';
 
+export interface ISmartmailOptions<T> {
+  from: string;
+  subject: string;
+  body: string;
+  creationObjectRef?: T;
+}
+
 /**
  * a standard representation for mails
  */
-export class Smartmail {
-  from: string;
-  to: string;
-  body: string;
-  attachments: any[];
+export class Smartmail<T> {
+  public options: ISmartmailOptions<T>;
+  public attachments: plugins.smartfile.Smartfile[] = [];
+
+  constructor(optionsArg: ISmartmailOptions<T>) {
+    this.options = optionsArg;
+  }
+
+  public addAttachment(smartfileArg: plugins.smartfile.Smartfile) {
+    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);
+  }
+
+  public getBody(dataArg: any = {}) {
+    const smartmustache = new plugins.smartmustache.SmartMustache(this.options.body);
+    return smartmustache.applyData(dataArg);
+  }
 }

ts/smartmail.plugins.ts

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

tslint.json

@@ -1,7 +1,17 @@
 {
-    "extends": ["tslint:latest", "tslint-config-prettier"],
-    "rules": {
-      "semicolon": [true, "always"]
+  "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"
+}