BREAKING CHANGE(core): updated to esm

.gitignore

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

.gitlab-ci.yml

@@ -4,13 +4,16 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -19,57 +22,72 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - 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 --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
-  - notpriv
+  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
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
 
 testBuild:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -79,11 +97,14 @@ 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
     - priv
 
@@ -94,20 +115,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   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:

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,10 +1,11 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartguard",
-      "shortDescription": "smart guards for validations",
+      "description": "smart guards for validations",
       "npmPackagename": "@pushrocks/smartguard",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -3,8 +3,9 @@
   "version": "1.0.5",
   "private": false,
   "description": "smart guards for validations",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -13,27 +14,31 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.60",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.69",
-    "@pushrocks/smartexpress": "^3.0.35",
+    "@pushrocks/smartexpress": "^3.0.110",
-    "@pushrocks/tapbundle": "^3.0.11",
+    "@pushrocks/tapbundle": "^5.0.2",
-    "@types/node": "^12.7.0",
+    "@types/node": "^17.0.22",
-    "tslint": "^5.18.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
     "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.16"
+    "@pushrocks/smartrequest": "^1.1.56"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "dist_ts_web/*",
+    "dist_ts/**/*",
-    "assets/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,19 +8,31 @@ smart guards for validations
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartguard/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartguard/badges/master/build.svg)](https://gitlab.com/pushrocks/smartguard/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartguard/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartguard/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartguard.svg)](https://www.npmjs.com/package/@pushrocks/smartguard)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartguard/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartguard)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartguard/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartguard/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartguard)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartguard)](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/smartguard)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartguard)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartguard)](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
 
+
+## 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.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.node.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
-import * as smartguard from '../ts/index';
+import * as smartguard from '../ts/index.js';
 import * as smartexpress from '@pushrocks/smartexpress';
 import * as smartrequest from '@pushrocks/smartrequest';
 
@@ -10,7 +10,7 @@ tap.test('should create a demo smartexpress instance', async () => {
     cors: true,
     forceSsl: false,
     defaultAnswer: async () => 'hi there',
-    port: 3211
+    port: 3211,
   });
 });
 
@@ -19,7 +19,7 @@ tap.test('should be able to create smartguards for a request', async () => {
     req: smartexpress.Request;
     res: smartexpress.Response;
   }
-  const ipGuard = new smartguard.Guard<IRequestGuardData>(async dataArg => {
+  const ipGuard = new smartguard.Guard<IRequestGuardData>(async (dataArg) => {
     console.log('executing ip guard');
     if (dataArg) {
       console.log('ip guard succeeded');
@@ -36,7 +36,7 @@ tap.test('should be able to create smartguards for a request', async () => {
       await smartguard.passGuards(
         {
           req,
-          res
+          res,
         },
         [ipGuard]
       );
@@ -54,7 +54,7 @@ tap.test('should start server with guards in place', async () => {
 
 tap.test('should execute a request', async () => {
   const response = await smartrequest.request('http://localhost:3211/testroute', {
-    method: 'GET'
+    method: 'GET',
   });
 });
 

ts/index.ts

@@ -1,7 +1,7 @@
-import * as plugins from './smartguard.plugins';
+import * as plugins from './smartguard.plugins.js';
-import { Guard } from './smartguard.classes.guard';
+import { Guard } from './smartguard.classes.guard.js';
-import { GuardSet } from './smartguard.classes.guardset';
+import { GuardSet } from './smartguard.classes.guardset.js';
-export * from './smartguard.classes.guard';
+export * from './smartguard.classes.guard.js';
 
 export const passGuards = async <T>(dataArg: T, guards: Array<Guard<T>>) => {
   const done = plugins.smartpromise.defer();

ts/smartguard.classes.blockhandler.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smartguard.plugins';
+import * as plugins from './smartguard.plugins.js';
 
 /**
  * a block handler is used

ts/smartguard.classes.guard.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smartguard.plugins';
+import * as plugins from './smartguard.plugins.js';
 
 export type TGuardFunction<T> = (dataArg: T) => Promise<boolean>;
 

ts/smartguard.classes.guardset.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartguard.plugins';
+import * as plugins from './smartguard.plugins.js';
-import { Guard } from './smartguard.classes.guard';
+import { Guard } from './smartguard.classes.guard.js';
 
 /**
  * a guardSet is a set of guards that need to be fulfilled

tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

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"
-}