1.0.24

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

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

.gitlab-ci.yml

@@ -1,126 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - lossless
-    - docker
-    - priv
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - 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

@@ -10,10 +10,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartmail",
-      "shortDescription": "a unified format for representing and dealing with mails",
-      "npmPackagename": "@pushrocks/smartmail",
+      "description": "a unified format for representing and dealing with mails",
+      "npmPackagename": "@push.rocks/smartmail",
       "license": "MIT"
     }
   }

package.json

@@ -1,40 +1,46 @@
 {
-  "name": "@pushrocks/smartmail",
-  "version": "1.0.14",
+  "name": "@push.rocks/smartmail",
+  "version": "1.0.24",
   "private": false,
   "description": "a unified format for representing and dealing with mails",
   "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 --web)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@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"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.44",
+    "@gitzone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.12",
+    "@types/node": "^20.4.5"
   },
   "dependencies": {
-    "@pushrocks/smartdns": "^4.0.3",
-    "@pushrocks/smartfile": "^7.0.12",
-    "@pushrocks/smartmustache": "^2.0.9"
+    "@push.rocks/smartdns": "^5.0.4",
+    "@push.rocks/smartfile": "^10.0.28",
+    "@push.rocks/smartmustache": "^3.0.2",
+    "@push.rocks/smartpath": "^5.0.11",
+    "@push.rocks/smartrequest": "^2.0.18"
   },
   "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

@@ -1,33 +1,37 @@
-# @pushrocks/smartmail
+# @push.rocks/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/)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartmail)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/smartmail)
+* [github.com (source mirror)](https://github.com/push.rocks/smartmail)
+* [docs (typedoc)](https://push.rocks.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/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartmail/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartmail/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartmail)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/smartmail)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartmail)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartmail)](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)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | 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,24 +1,41 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartmail from '../ts/index';
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartmail from '../ts/index.js';
 
 let emailAddressValidatorInstance: smartmail.EmailAddressValidator;
 
 tap.test('should create an instance of EmailAddressValidator', async () => {
   emailAddressValidatorInstance = new smartmail.EmailAddressValidator();
-  expect(emailAddressValidatorInstance).to.be.instanceOf(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('first test', async () => {
+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: '@push.rocks/smartmail',
+  version: '1.0.24',
+  description: 'a unified format for representing and dealing with mails'
+}

ts/index.ts

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

ts/smartmail.classes.emailaddressvalidator.ts

@@ -1,19 +1,55 @@
-import * as plugins from './smartmail.plugins';
+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');
+    const result = await this.smartdns.getRecords(emailArray[1], 'MX');
+    // console.log(emailArray);
+    // console.log(this.domainMap[emailArray[1]]);
     return {
       valid: !!result,
-      reason: 'todo'
+      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,4 +1,4 @@
-import * as plugins from './smartmail.plugins';
+import * as plugins from './smartmail.plugins.js';
 
 export interface ISmartmailOptions<T> {
   from: string;

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,5 +1,13 @@
-import * as smartdns from '@pushrocks/smartdns';
-import * as smartfile from '@pushrocks/smartfile';
-import * as smartmustache from '@pushrocks/smartmustache';
+// node native scope
+import * as path from 'path';
 
-export { smartdns, smartfile, smartmustache };
+export { path };
+
+// pushrocks scope
+import * as smartdns from '@push.rocks/smartdns';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartmustache from '@push.rocks/smartmustache';
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartrequest from '@push.rocks/smartrequest';
+
+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"
-}