5.0.0

.gitignore

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

.gitlab-ci.yml

@@ -1,18 +1,16 @@
 # gitzone ci_default
 image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-variables:
-  GIT_STRATEGY: clone
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -21,57 +19,71 @@ 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
+
+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
-  - priv
 
 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
 
@@ -81,11 +93,15 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   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
 
@@ -96,20 +112,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

@@ -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", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,28 +0,0 @@
-# @pushrocks/smartenv
-store things about your environment and let them travel across modules
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartenv)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartenv)
-* [github.com (source mirror)](https://github.com/pushrocks/smartenv)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartenv/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartenv/badges/master/build.svg)](https://gitlab.com/pushrocks/smartenv/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartenv/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartenv/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartenv.svg)](https://www.npmjs.com/package/@pushrocks/smartenv)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartenv/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartenv)
-[![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
-
-Use TypeScript for best in class instellisense.
-
-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)

npmextra.json

@@ -4,11 +4,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartenv",
-      "shortDescription": "store things about your environment and let them travel across modules",
+      "description": "store things about your environment and let them travel across modules",
       "npmPackagename": "@pushrocks/smartenv",
       "license": "MIT"
     }

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@pushrocks/smartenv",
-  "version": "4.0.8",
+  "version": "5.0.0",
   "description": "store things about your environment and let them travel across modules",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
     "testbrowser": "(npm test) && (node testbrowser.js)"
   },
   "repository": {
@@ -23,30 +24,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartenv",
   "dependencies": {
-    "@pushrocks/smartparam": "^1.0.4",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@types/node": "^17.0.21"
-    "@types/node": "^12.12.7",
-    "is-wsl": "^2.1.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.56",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsbundle": "^1.0.98",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tsrun": "^1.2.31",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@gitzone/tstest": "^1.0.68",
-    "@types/npm": "^2.0.31",
+    "@pushrocks/tapbundle": "^5.0.2",
-    "tslint": "^5.20.1",
+    "@types/npm": "^7.19.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "private": false,
   "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

@@ -0,0 +1,39 @@
+# @pushrocks/smartenv
+store things about your environment and let them travel across modules
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartenv)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartenv)
+* [github.com (source mirror)](https://github.com/pushrocks/smartenv)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartenv/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartenv/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartenv/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartenv)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartenv)](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/smartenv)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartenv)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartenv)](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 instellisense.
+
+## 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,5 +1,5 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartenv from '../ts/index';
+import * as smartenv from '../ts/index.js';
 
 let testEnv: smartenv.Smartenv;
 
@@ -17,20 +17,20 @@ tap.test('should get os', async () => {
   const resultWindows = await testEnv.isWindowsAsync();
   const osModule = await import('os');
   if (resultMac) {
-    expect(osModule.platform()).to.equal('darwin');
+    expect(osModule.platform()).toEqual('darwin');
     console.log('platform is Mac!');
   } else if (resultLinux) {
-    expect(osModule.platform()).to.equal('linux');
+    expect(osModule.platform()).toEqual('linux');
     console.log('platform is Linux!');
   } else {
-    expect(osModule.platform()).to.equal('win32');
+    expect(osModule.platform()).toEqual('win32');
     console.log('platform is Windows!');
   }
 });
 
 tap.test('should state wether we are in CI', async () => {
   if (process.env.CI) {
-    expect(testEnv.isCI).to.be.true;
+    expect(testEnv.isCI).toBeTrue();
   }
 });
 

ts/index.ts

@@ -1 +1 @@
-export * from './smartenv.classes.smartenv';
+export * from './smartenv.classes.smartenv.js';

ts/smartenv.classes.smartenv.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartenv.plugins';
+import * as plugins from './smartenv.plugins.js';
-import * as interfaces from './interfaces';
+import * as interfaces from './interfaces/index.js';
 
 // interfaces
 export interface IEnvObject {
@@ -11,6 +11,59 @@ export interface IEnvObject {
  * Smartenv class that makes it easy
  */
 export class Smartenv {
+  public async getEnvAwareModule(optionsArg: {
+    nodeModuleName: string;
+    webUrlArg: string;
+    getFunction: () => any;
+  }) {
+    if (this.isNode) {
+      const moduleResult = await  this.getSafeNodeModule(optionsArg.nodeModuleName);
+      return moduleResult;
+    } else if (this.isBrowser) {
+      const moduleResult = await this.getSafeWebModule(optionsArg.webUrlArg, optionsArg.getFunction);
+    } else {
+      console.error('platform for loading not supported by smartenv');
+    }
+  }
+
+  public async getSafeNodeModule<T = any>(moduleNameArg: string): Promise<T> {
+    if (!this.isNode) {
+      console.error('You tried to load a node module in a wrong context');
+      return;
+    }
+    // tslint:disable-next-line: function-constructor
+    return (new Function(`return import('${moduleNameArg}')`))() as Promise<T>;
+  }
+
+  public loadedScripts: string[] = [];
+  public async getSafeWebModule(urlArg: string, getFunctionArg: () => any) {
+    if (!this.isBrowser) {
+      console.error('You tried to load a web module in a wrong context');
+      return;
+    }
+    
+    if (this.loadedScripts.includes(urlArg)) {
+      return getFunctionArg();
+    } else {
+      this.loadedScripts.push(urlArg);
+    }
+    
+    const done = plugins.smartpromise.defer();
+    if (globalThis.importScripts) {
+      globalThis.importScripts(urlArg);
+      done.resolve();
+    } else {
+      const script = document.createElement('script');
+      script.onload = () => {
+        done.resolve();
+      };
+      script.src = urlArg;
+      document.head.appendChild(script);
+    }
+    await done.promise;
+    return getFunctionArg();
+  }
+
   public get runtimeEnv() {
     if (typeof window !== 'undefined') {
       return 'browser';
@@ -36,10 +89,6 @@ export class Smartenv {
     return this.runtimeEnv === 'node';
   }
 
-  public get isWsl(): boolean {
-    return plugins.isWsl;
-  }
-
   public get nodeVersion(): string {
     return process.version;
   }
@@ -58,7 +107,7 @@ export class Smartenv {
 
   public async isMacAsync(): Promise<boolean> {
     if (this.isNode) {
-      const os = await import('os');
+      const os = await this.getSafeNodeModule('os');
       return os.platform() === 'darwin';
     } else {
       return false;
@@ -67,7 +116,7 @@ export class Smartenv {
 
   public async isWindowsAsync(): Promise<boolean> {
     if (this.isNode) {
-      const os = await import('os');
+      const os = await this.getSafeNodeModule('os');
       return os.platform() === 'win32';
     } else {
       return false;
@@ -76,30 +125,21 @@ export class Smartenv {
 
   public async isLinuxAsync(): Promise<boolean> {
     if (this.isNode) {
-      const os = await import('os');
+      const os = await this.getSafeNodeModule('os');
       return os.platform() === 'linux';
     } else {
       return false;
     }
   }
 
-  /**
-   * get environment variables that fit the description
-   */
-  // get envVars (regexArg: RegExp) {
-  //   let EnvironmentArray = []
-  //   // TODO: plugins.smartparam.forEachMinimatch()
-  // }
-
   /**
    * prints the environment to console
    */
   public async printEnv() {
     if (this.isNode) {
       console.log('running on NODE');
-      const smartenvVersion = require('../package.json').version;
       console.log(
-        'node version is ' + this.nodeVersion + ' and smartenv version is ' + smartenvVersion
+        'node version is ' + this.nodeVersion
       );
     } else {
       console.log('running on BROWSER');

ts/smartenv.plugins.ts

@@ -1,12 +1,3 @@
-import * as smartparam from '@pushrocks/smartparam';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { smartparam, smartpromise };
+export { smartpromise };
-
-// third party scope
-
-import isWsl from 'is-wsl';
-
-export {
-  isWsl
-};