update description

Update to latest standards

See merge request !1

.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 @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -1,3 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
 node_modules/
-.settings/
-.idea/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.npmignore

@@ -0,0 +1,4 @@
+node_modules/
+coverage/
+test/
+ts/typings/

.travis.yml

@@ -1,16 +0,0 @@
-language: node_js
-node_js:
-- 4.2.2
-before_install:
-- npm install -g tsd
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: uNjLbNelm8nj9R/tRlwRvcXWLS1QtA0QEbDKPDTWHNo68wAHgdwXIdzkVkNcihZYVasR/LqGuSLfzoD4H8mKmCXD+v85h048VmmtWniZQRp/OVWl0uzRwDDryhiYlhY5U9oOFEQsMO96C8qPqcGchq+DA7Gi3ZnAl7pmeb54xp9H+7jmLyZTyO8Hq00anV5PopBOW23mZEnWHznzYeg83BlWmLdbyfyZKT4W5Urg1BAMgxt9PdtrQoiPy4LP6AHXG88kvY3Iz8OBG+h/06bura8MPfeupGoktodN9krb+sRE/COybATWImMh9Z5gI5TWqUR7tp7XivpgolYY41gaN93oUQ9EOTdJ5kFku1dnPrNFqXO/97slVTMR6fMMgRXwzTz6BiKI1NsAZeW7oLUONw06APZ6VBhVY6Po3Rioun8OE9Q0wXm/BvnRqVHt3sew4MIgmEBwQSQE14gLJGGgNojzmcPstc0czQp+kzV5DpGiW3IWIWZ7MsBJOOJ13RHeb6koFdBR7JZj0QzzBcWD7juJVOS45MlP7hU/sKRDO/fN3nu8TNwHvJab6XYP5/gqlbh/3h2vb7bxyDXiKGi2Ds8hZOHoyWoCrU3sbH3eKKkKo+LFI3J7PbY11T6TkSAdszLsQzcvC2QlsGQRWVywYMm32R6BVfxF3AlLX5a8JsI=
-  on:
-    tags: true
-    repo: pushrocks/smartenv
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

.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

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Push.Rocks
+Copyright (c) 2015 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,28 +0,0 @@
-# smartenv
-store things about your environment and let them travel across modules
-
-## Status
-[![Build Status](https://travis-ci.org/pushrocks/smartenv.svg?branch=release)](https://travis-ci.org/pushrocks/smartenv)
-[![Dependency Status](https://david-dm.org/pushrocks/smartenv.svg)](https://david-dm.org/pushrocks/smartenv)
-[![devDependency Status](https://david-dm.org/pushrocks/smartenv/dev-status.svg)](https://david-dm.org/pushrocks/smartenv#info=devDependencies)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartenv/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartenv/master/dependencies/npm)
-[![bitHound Overalll Score](https://www.bithound.io/github/pushrocks/smartenv/badges/score.svg)](https://www.bithound.io/github/pushrocks/smartenv)
-
-## Install
-Install the package through npm
-
-```
-npm install smartenv
-```
-
-## Usage
-
-```javascript
-var smartenv = require("smartenv");
-
-smartenv.info(); //prints an output about your current environment and registered objects
-smartenv.register({akey:"a text"},"somevalue"); // register a new object
-smartenv.makeGlobal() // make smartenv available from gobal.smartenv
-smartenv.get("somevalue").akey; // returns "a text"
-smartenv.items.somevalue.akey; // also returns "a text"
-```

index.js

@@ -1,28 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var beautylog = require("beautylog")("os");
-var addToGlobal = function (objectArg, paramName) {
-    global[paramName] = objectArg;
-};
-var smartenv = {}; //create smartenv object
-smartenv.items = {}; // create the items object to store items to.
-smartenv.makeGlobal = function () {
-    addToGlobal(smartenv, "smartenv"); //add object smartenv as global["smartenv"]
-};
-smartenv.info = function () {
-    var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
-    beautylog.log("the smartenv module currently holds the following properties:");
-    console.log(Object.getOwnPropertyNames(smartenv.items).sort());
-};
-smartenv.register = function (objectArg, paramName) {
-    if (paramName === void 0) { paramName = "undefined"; }
-    if (paramName == "undefined") {
-        beautylog.error("paramName is undefined");
-        return;
-    }
-    smartenv.items[paramName] = objectArg;
-};
-smartenv.get = function (keyName) {
-    return smartenv.items[keyName];
-};
-module.exports = smartenv;

npmextra.json

@@ -0,0 +1,32 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartenv",
+      "description": "A module for storing and accessing environment details across different platforms.",
+      "npmPackagename": "@push.rocks/smartenv",
+      "license": "MIT",
+      "keywords": [
+        "environment detection",
+        "cross-platform",
+        "node.js",
+        "browser",
+        "module loading",
+        "CI detection",
+        "OS detection",
+        "runtime environment",
+        "typescript",
+        "async"
+      ]
+    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  }
+}

package.json

@@ -1,32 +1,64 @@
 {
-  "name": "smartenv",
-  "version": "0.0.3",
-  "description": "store things about your environment and let them travel across modules",
-  "main": "index.js",
+  "name": "@push.rocks/smartenv",
+  "version": "5.0.12",
+  "description": "A module for storing and accessing environment details across different platforms.",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(cd ts/compile && node compile.js) && (node test.js)",
-    "reinstall": "(rm -r node_modules && npm install)",
-    "release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
-    "startdev": "(git checkout master && git pull origin master && npm install)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
+    "testbrowser": "(npm test) && (node testbrowser.js)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pushrocks/smartenv.git"
+    "url": "https://code.foss.global/push.rocks/smartenv.git"
   },
   "keywords": [
-    "environment"
+    "environment detection",
+    "cross-platform",
+    "node.js",
+    "browser",
+    "module loading",
+    "CI detection",
+    "OS detection",
+    "runtime environment",
+    "typescript",
+    "async"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <hello@lossless.support> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/smartenv/issues"
+    "url": "https://gitlab.com/pushrocks/smartenv/issues"
   },
-  "homepage": "https://github.com/pushrocks/smartenv",
+  "homepage": "https://code.foss.global/push.rocks/smartenv",
   "dependencies": {
-    "beautylog": "^1.0.4"
+    "@push.rocks/smartpromise": "^4.0.2"
   },
   "devDependencies": {
-    "gulp": "^3.9.0",
-    "gulp-typescript": "^2.9.2"
-  }
-}
+    "@git.zone/tsbuild": "^2.1.72",
+    "@git.zone/tsbundle": "^2.0.15",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.86",
+    "@push.rocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.11.24",
+    "@types/npm": "^7.19.3"
+  },
+  "private": false,
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
+}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -0,0 +1,123 @@
+# @push.rocks/smartenv
+
+store things about your environment and let them travel across modules
+
+## Install
+
+To install `@push.rocks/smartenv`, you need Node.js and npm installed. Then, run the following command:
+
+```bash
+npm install @push.rocks/smartenv --save
+```
+
+## Usage
+
+`@push.rocks/smartenv` is a valuable utility for managing and accessing environment-specific information within your application, enabling your code to adapt to different environments, such as development, testing, and production seamlessly. Here we delve into how to utilize `@push.rocks/smartenv` effectively within a TypeScript project. We'll cover initializing the package, checking the execution environment, loading modules conditionally based on the environment, and accessing environment variables securely. 
+
+### Getting Started
+First, ensure to import `Smartenv` from the package:
+
+```typescript
+import { Smartenv } from '@push.rocks/smartenv';
+```
+
+### Initializing Smartenv
+You can begin by creating an instance of `Smartenv`. This instance will be your gateway to accessing and managing the environment properties throughout your application.
+
+```typescript
+const smartEnv = new Smartenv();
+```
+
+### Checking Execution Environment
+`Smartenv` offers straightforward methods to determine whether your code is running in a Node.js or browser environment. This can be particularly useful for isomorphic code.
+
+```typescript
+// Check if running in a Node.js environment
+console.log(`Is Node: ${smartEnv.isNode}`);
+
+// Check if running in a browser environment
+console.log(`Is Browser: ${smartEnv.isBrowser}`);
+```
+
+### Loading Modules Conditionally 
+One of the core functionalities of `@push.rocks/smartenv` is to load modules based on the execution environment. This feature is immensely useful for isomorphic applications that need to run both in the browser and Node.js environments.
+
+```typescript
+// Node.js module and equivalent browser module URLs
+const nodeModuleName = 'example-node-module';
+const browserModuleUrl = 'https://example.com/example-browser-module.js';
+
+// Function to access the module in the browser
+const getBrowserModule = () => window.exampleBrowserModule;
+
+const module = await smartEnv.getEnvAwareModule({
+  nodeModuleName: nodeModuleName,
+  webUrlArg: browserModuleUrl,
+  getFunction: getBrowserModule
+});
+
+console.log(module);
+```
+
+### Accessing Environment Variables Securely
+For Node.js environments, accessing environment variables is a common task. `Smartenv` does not directly manipulate environment variables but encourages best practices for accessing them, ensuring your application remains secure and performs optimally.
+
+```typescript
+if(smartEnv.isNode) {
+  console.log(`Your environment variable value: ${process.env.YOUR_ENV_VAR}`);
+}
+```
+
+### Detecting CI Environments
+Detect if your application is running in a Continuous Integration (CI) environment. This can be useful for modifying behavior during testing or deployment.
+
+```typescript
+console.log(`Is CI: ${smartEnv.isCI}`);
+```
+
+### Platform-Specific Checks
+`Smartenv` enables you to perform checks for specific operating systems when running in a Node.js environment, which can be particularly useful for tasks that depend on OS-specific features or paths.
+
+```typescript
+const isMac = await smartEnv.isMacAsync();
+const isWindows = await smartEnv.isWindowsAsync();
+const isLinux = await smartEnv.isLinuxAsync();
+
+console.log(`Is Mac: ${isMac}, Is Windows: ${isWindows}, Is Linux: ${isLinux}`);
+```
+
+### Printing Environment for Debugging
+To assist with debugging, `Smartenv` offers a method to print the current environment and some relevant information to the console. This feature is particularly useful during development or when troubleshooting environment-specific issues.
+
+```typescript
+smartEnv.printEnv();
+```
+
+### Usage within Browser
+While `Smartenv` primarily facilitates handling different environments in server-side applications, it also provides functionalities to manage and load scripts dynamically in the browser. This allows for more flexible and environment-aware code sharing between server and client-side.
+
+For instance, using `getSafeWebModule` to dynamically load a script only if it hasn't been already and then utilizing a globally available function or object that the script provides.
+
+### Conclusion
+`@push.rocks/smartenv` is a comprehensive solution for managing environment-specific logic and configurations in your JavaScript and TypeScript projects. By leveraging its functionalities, developers can create more robust, flexible, and maintainable applications that seamlessly adapt to different execution contexts, whether in Node.js, the browser, or CI environments.
+
+Always refer to the official documentation and source code for the most up-to-date usage examples and features.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test.js

@@ -1,11 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartenv = require("./index.js");
-var beautylog = require("beautylog")("os");
-beautylog.info("Now testing the smartenv module");
-smartenv.info();
-smartenv.register({ key1: "Peter" }, "docit");
-smartenv.info();
-beautylog.log(smartenv.get("docit").key1);
-smartenv.makeGlobal();
-beautylog.log(global.smartenv.get("docit").key1);
-beautylog.success("Success!");

test/test.ts

@@ -0,0 +1,37 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as smartenv from '../ts/index.js';
+
+let testEnv: smartenv.Smartenv;
+
+tap.test('should print env', async () => {
+  testEnv = new smartenv.Smartenv();
+});
+
+tap.test('should print a overview to console', async () => {
+  testEnv.printEnv();
+});
+
+tap.test('should get os', async () => {
+  const resultMac = await testEnv.isMacAsync();
+  const resultLinux = await testEnv.isLinuxAsync();
+  const resultWindows = await testEnv.isWindowsAsync();
+  const osModule = await import('os');
+  if (resultMac) {
+    expect(osModule.platform()).toEqual('darwin');
+    console.log('platform is Mac!');
+  } else if (resultLinux) {
+    expect(osModule.platform()).toEqual('linux');
+    console.log('platform is Linux!');
+  } else {
+    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).toBeTrue();
+  }
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartenv',
+  version: '5.0.12',
+  description: 'store things about your environment and let them travel across modules'
+}

ts/compile/compile.js

@@ -1,28 +0,0 @@
-// import gulp
-var gulp = require("gulp");
-var gulpTypescript = require("gulp-typescript");
-var bl = require("beautylog")("os");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('compileTestTS', function() {
-	var stream = gulp.src('../test.ts')
-			.pipe(gulpTypescript({
-				out: "test.js"
-			}))
-			.pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS','compileTestTS'], function() {
-	bl.success('Typescript compiled');
-});
-
-gulp.start.apply(gulp, ['default']);

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.js

@@ -1,29 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var beautylog = require("beautylog")("os");
-var addToGlobal = function (objectArg, paramName) {
-    global[paramName] = objectArg;
-};
-var smartenv = {}; //create smartenv object
-smartenv.items = {}; // create the items object to store items to.
-smartenv.makeGlobal = function () {
-    addToGlobal(smartenv, "smartenv"); //add object smartenv as global["smartenv"]
-};
-smartenv.info = function () {
-    var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
-    beautylog.log("the smartenv module currently holds the following properties:");
-    console.log(Object.getOwnPropertyNames(smartenv.items).sort());
-};
-smartenv.register = function (objectArg, paramName) {
-    if (paramName === void 0) { paramName = "undefined"; }
-    if (paramName == "undefined") {
-        beautylog.error("paramName is undefined");
-        return;
-    }
-    smartenv.items[paramName] = objectArg;
-};
-smartenv.get = function (keyName) {
-    return smartenv.items[keyName];
-};
-module.exports = smartenv;
-//# sourceMappingURL=index.js.map

ts/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,IAAI,WAAW,GAAG,UAAS,SAAS,EAAC,SAAS;IAC1C,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAClC,CAAC,CAAC;AACF,IAAI,QAAQ,GAAO,EAAE,CAAC,CAAC,wBAAwB;AAC/C,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,6CAA6C;AAClE,QAAQ,CAAC,UAAU,GAAG;IAClB,WAAW,CAAC,QAAQ,EAAC,UAAU,CAAC,CAAC,CAAA,2CAA2C;AAChF,CAAC,CAAC;AAGF,QAAQ,CAAC,IAAI,GAAG;IACZ,IAAI,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpC,SAAS,CAAC,GAAG,CAAC,kBAAkB,GAAG,OAAO,CAAC,OAAO,GAAG,2BAA2B,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAChG,SAAS,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;IAC/E,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,QAAQ,CAAC,QAAQ,GAAG,UAAS,SAAS,EAAC,SAAuB;IAAvB,yBAAuB,GAAvB,uBAAuB;IAC1D,EAAE,CAAC,CAAC,SAAS,IAAI,WAAW,CAAC,CAAA,CAAC;QAC1B,SAAS,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1C,MAAM,CAAC;IACX,CAAC;IACD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAC1C,CAAC,CAAC;AACF,QAAQ,CAAC,GAAG,GAAG,UAAS,OAAO;IAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC,CAAA;AAED,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAC"}

ts/index.ts

@@ -1,31 +1 @@
-/// <reference path="typings/tsd.d.ts" />
-var beautylog = require("beautylog")("os");
-var addToGlobal = function(objectArg,paramName) {
-    global[paramName] = objectArg;
-};
-var smartenv:any = {}; //create smartenv object
-smartenv.items = {}; // create the items object to store items to.
-smartenv.makeGlobal = function() {
-    addToGlobal(smartenv,"smartenv");//add object smartenv as global["smartenv"]
-};
-
-
-smartenv.info = function() {
-    var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
-    beautylog.log("the smartenv module currently holds the following properties:");
-    console.log(Object.getOwnPropertyNames(smartenv.items).sort());
-};
-
-smartenv.register = function(objectArg,paramName = "undefined") {
-    if (paramName == "undefined"){
-        beautylog.error("paramName is undefined");
-        return;
-    }
-    smartenv.items[paramName] = objectArg;
-};
-smartenv.get = function(keyName) {
-    return smartenv.items[keyName];
-}
-
-module.exports = smartenv;
+export * from './smartenv.classes.smartenv.js';

ts/interfaces/index.ts

@@ -0,0 +1,9 @@
+export let defaultme = null;
+declare global {
+  namespace NodeJS {
+    interface Global {
+      window: any;
+      navigator: any;
+    }
+  }
+}

ts/smartenv.classes.smartenv.ts

@@ -0,0 +1,155 @@
+import * as plugins from './smartenv.plugins.js';
+import * as interfaces from './interfaces/index.js';
+
+// interfaces
+export interface IEnvObject {
+  name: string;
+  value: string;
+}
+
+/**
+ * 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
+      );
+      return moduleResult;
+    } else {
+      console.error('platform for loading not supported by smartenv');
+    }
+  }
+
+  public async getSafeNodeModule<T = any>(moduleNameArg: string, runAfterFunc?: (moduleArg: T) => Promise<any>): Promise<T> {
+    if (!this.isNode) {
+      console.error(`You tried to load a node module in a wrong context: ${moduleNameArg}`);
+      return;
+    }
+    // tslint:disable-next-line: function-constructor
+    const returnValue: T = await (new Function(`return import('${moduleNameArg}')`)() as Promise<T>);
+    if (runAfterFunc) {
+      await runAfterFunc(returnValue);
+    }
+    return returnValue;
+  }
+
+  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 process !== 'undefined') {
+      return 'node';
+    } else {
+      return 'browser';
+    }
+  }
+
+  public get isBrowser(): boolean {
+    return !this.isNode;
+  }
+
+  public get userAgent(): string {
+    if (this.isBrowser) {
+      // make sure we are in Browser
+      return navigator.userAgent;
+    } else {
+      return 'undefined';
+    }
+  }
+
+  public get isNode(): boolean {
+    return this.runtimeEnv === 'node';
+  }
+
+  public get nodeVersion(): string {
+    return process.version;
+  }
+
+  public get isCI(): boolean {
+    if (this.isNode) {
+      if (process.env.CI) {
+        return true;
+      } else {
+        return false;
+      }
+    } else {
+      return false;
+    }
+  }
+
+  public async isMacAsync(): Promise<boolean> {
+    if (this.isNode) {
+      const os = await this.getSafeNodeModule('os');
+      return os.platform() === 'darwin';
+    } else {
+      return false;
+    }
+  }
+
+  public async isWindowsAsync(): Promise<boolean> {
+    if (this.isNode) {
+      const os = await this.getSafeNodeModule('os');
+      return os.platform() === 'win32';
+    } else {
+      return false;
+    }
+  }
+
+  public async isLinuxAsync(): Promise<boolean> {
+    if (this.isNode) {
+      const os = await this.getSafeNodeModule('os');
+      return os.platform() === 'linux';
+    } else {
+      return false;
+    }
+  }
+
+  /**
+   * prints the environment to console
+   */
+  public async printEnv() {
+    if (this.isNode) {
+      console.log('running on NODE');
+      console.log('node version is ' + this.nodeVersion);
+    } else {
+      console.log('running on BROWSER');
+      console.log('browser is ' + this.userAgent);
+    }
+  }
+}

ts/smartenv.plugins.ts

@@ -0,0 +1,3 @@
+import * as smartpromise from '@push.rocks/smartpromise';
+
+export { smartpromise };

ts/test.js

@@ -1,13 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartenv = require("./index.js");
-var beautylog = require("beautylog")("os");
-beautylog.info("Now testing the smartenv module");
-smartenv.info();
-beautylog.info("Now testing the smartenv module");
-smartenv.register({ key1: "Peter" }, "docit");
-smartenv.info();
-beautylog.log(smartenv.get("docit").key1);
-smartenv.makeGlobal();
-beautylog.log(global.smartenv.get("docit").key1);
-beautylog.success("Success!");
-//# sourceMappingURL=test.js.map

ts/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,OAAO,EAAC,EAAC,OAAO,CAAC,CAAC;AAC1C,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAQ,CAAC,UAAU,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}

ts/test.ts

@@ -1,12 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartenv = require("./index.js");
-var beautylog = require("beautylog")("os");
-beautylog.info("Now testing the smartenv module");
-smartenv.info();
-beautylog.info("Now testing the smartenv module");
-smartenv.register({key1:"Peter"},"docit");
-smartenv.info();
-beautylog.log(smartenv.get("docit").key1);
-smartenv.makeGlobal();
-beautylog.log(global.smartenv.get("docit").key1);
-beautylog.success("Success!");

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}