update description

.gitignore

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

.gitlab-ci.yml

@@ -1,77 +1,82 @@
 # 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
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
-  stage: security
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
   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
-  - 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 +86,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
 
@@ -96,20 +104,19 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   stage: metadata
   script:
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

docs/index.md

@@ -1,69 +0,0 @@
----
-name: smartsystem
-description: simplifies lazy loading with TypeScript
----
-
-# smartsystem
-
-simplifies lazy loading with TypeScript
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartsystem)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartsystem)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartsystem)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartsystem/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartsystem/badges/master/build.svg)](https://GitLab.com/pushrocks/smartsystem/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartsystem/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartsystem/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartsystem.svg)](https://www.npmjs.com/package/smartsystem)
-[![Dependency Status](https://david-dm.org/pushrocks/smartsystem.svg)](https://david-dm.org/pushrocks/smartsystem)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartsystem/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartsystem/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartsystem/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartsystem)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-We recommend the use of TypeScript for best Intellisense
-
-smartsystem supports both npm and SystemJs as module loader.
-
-```javascript
-import { LazyModule } from 'smartsystem';
-
-// plugin does not get loaded here at runtime
-import * as _myPlugin from 'myPlugin';
-
-// define the lazy module
-let myLazyModule = new LazyModule() < typeof _myPlugin > ('myPlugin', __dirname);
-
-// another plugin
-import * as _anotherPlugin from 'anotherPlugin'; // plugin does not get loaded here at runtime
-
-// define lazy module
-let anotherLazyModule = new LazyModule() < typeof _anotherPlugin > ('anotherPlugin', __dirname);
-
-myLazyModule.whenLoaded.then(myPlugin => {
-  /* do something with myPlugin. 
-       myPlugin receives the typings flow from LazyModule class
-       This does NOT load the module during runtime
-       The promise whenLoaded will be resolved whenever load() is called for the first time */
-});
-
-myLazyModule.load().then(myPlugin => {
-  /* do something with myPlugin. 
-       myPlugin receives the typings flow from LazyModule class
-       This DOES LOAD the module */
-});
-```
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -1,17 +1,31 @@
 {
   "npmci": {
-    "globalNpmTools": [
+    "npmGlobalTools": [],
-      "npmts"
+    "npmAccessLevel": "public"
-    ]
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartsystem",
-      "shortDescription": "interact with the system you are running on",
+      "description": "A TypeScript library for interacting with the system it's running on, including environment, network, and hardware information.",
-      "npmPackagename": "@pushrocks/smartsystem",
+      "npmPackagename": "@push.rocks/smartsystem",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "TypeScript",
+        "system information",
+        "environment variables",
+        "network",
+        "hardware info",
+        "OS interaction",
+        "module loading",
+        "async",
+        "cross-platform"
+      ]
     }
+  },
+  "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,50 +1,64 @@
 {
-  "name": "smartsystem",
+  "name": "@push.rocks/smartsystem",
-  "version": "2.0.3",
+  "version": "3.0.1",
-  "description": "interact with the system you are running on",
+  "description": "A TypeScript library for interacting with the system it's running on, including environment, network, and hardware information.",
-  "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/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartsystem.git"
+    "url": "https://code.foss.global/push.rocks/smartsystem.git"
   },
   "keywords": [
     "TypeScript",
-    "lazy",
+    "system information",
-    "module loader"
+    "environment variables",
+    "network",
+    "hardware info",
+    "OS interaction",
+    "module loading",
+    "async",
+    "cross-platform"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
     "url": "https://gitlab.com/pushrocks/smartsystem/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartsystem#README",
+  "homepage": "https://code.foss.global/push.rocks/smartsystem",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.10",
+    "@pushrocks/lik": "^6.0.0",
-    "@pushrocks/smartenv": "^4.0.7",
+    "@pushrocks/smartenv": "^5.0.2",
-    "@pushrocks/smartpromise": "^3.0.2"
+    "@pushrocks/smartnetwork": "^3.0.0",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "systeminformation": "^5.12.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.72",
-    "@pushrocks/tapbundle": "^3.0.11",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "tslint": "^5.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.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,35 +1,127 @@
-# @pushrocks/smartsystem
+# @push.rocks/smartsystem
 interact with the system you are running on
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsystem)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsystem)
-* [github.com (source mirror)](https://github.com/pushrocks/smartsystem)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartsystem/)
 
-## Status for master
+To incorporate @push.rocks/smartsystem into your project, you'll need to install the package via npm. You can do this by running the following command in your project's root directory:
-[![build status](https://gitlab.com/pushrocks/smartsystem/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsystem/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartsystem/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartsystem/commits/master)
+```bash
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartsystem.svg)](https://www.npmjs.com/package/@pushrocks/smartsystem)
+npm install @push.rocks/smartsystem --save
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartsystem/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartsystem)
+```
-[![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/)
+This command will download @push.rocks/smartsystem and add it to your project's `package.json` file as a dependency.
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
-We recommend the use of TypeScript for best Intellisense
+The `@push.rocks/smartsystem` module offers a convenient way to interact with the system your application is running on. Below are detailed examples that demonstrate how to utilize its full potential. These examples are written in TypeScript and showcase different cases and features of the module.
 
-For further information read the linked docs at the top of this README.
+### Getting Started
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+First, ensure that you are importing the module correctly in your TypeScript file:
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+```typescript
+import { Smartsystem } from '@push.rocks/smartsystem';
+```
 
-For further information read the linked docs at the top of this readme.
+### Creating an Instance of Smartsystem
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+To use the functionalities provided by `@push.rocks/smartsystem`, you need to create a new instance of the `Smartsystem` class.
-| 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)
+```typescript
+const mySystem = new Smartsystem();
+```
+
+### Accessing Environment Variables
+
+`@push.rocks/smartsystem` integrates with `@pushrocks/smartenv` to provide an easy way to handle environment variables.
+
+```typescript
+console.log(mySystem.env.getEnvVars());
+```
+
+### Getting CPU Information
+
+You can retrieve information about the CPUs of the system:
+
+```typescript
+console.log(mySystem.cpus[0]); // Logs details about the first CPU
+```
+
+### Working with Network Interfaces
+
+The module allows you to work with network interfaces, making use of `@pushrocks/smartnetwork`:
+
+```typescript
+(async () => {
+  console.log(await mySystem.network.getNetworkInfo());
+})();
+```
+
+### System Information
+
+For more detailed system information such as hardware specs or software versions, `@push.rocks/smartsystem` relies on the `systeminformation` library:
+
+```typescript
+(async () => {
+  console.log(await mySystem.information.system());
+  // Output detailed information about the system like manufacturer, model, etc.
+
+  console.log(await mySystem.information.osInfo());
+  // Output detailed information about the operating system
+})();
+```
+
+### Real-World Scenarios
+
+Now that we've covered the basics let's dive into some real-world applications:
+
+#### Monitoring System Load
+
+You can monitor the current load on the system to make decisions or trigger actions when the system is under heavy use:
+
+```typescript
+(async () => {
+  const systemLoad = await mySystem.information.currentLoad();
+  if (systemLoad.currentLoad > 80) {
+    console.log("High system load detected. Consider scaling or optimizing your applications.");
+  }
+})();
+```
+
+#### Network Monitoring
+
+It's often useful to keep an eye on network interfaces, especially when diagnosing connectivity issues or monitoring network traffic:
+
+```typescript
+(async () => {
+  const defaultInterface = await mySystem.information.networkInterfaceDefault();
+  const interfaceStats = await mySystem.information.networkStats(defaultInterface);
+  console.log(interfaceStats);
+  // Use this information to alert on unusual traffic patterns or drops in speed.
+})();
+```
+
+### Conclusion
+
+`@push.rocks/smartsystem` offers a comprehensive toolkit for interacting with the underlying system your Node.js application runs on. From retrieving environment variables and CPU information to monitoring network interfaces and system load, this module provides everything you need to ensure your application can intelligently respond to its operating environment.
+
+Remember, the examples above only scratch the surface of what's possible with `@push.rocks/smartsystem`. For more detailed documentation on all available methods and their capabilities, refer to the [official documentation](https://pushrocks.gitlab.io/smartsystem/).
+
+## 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/test.ts

@@ -1,15 +1,20 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartsystem from '../ts/index';
+import * as smartsystem from '../ts/index.js';
+import { systeminformation } from '../ts/smartsystem.plugins.js';
 
 let smartsystemInstance: smartsystem.Smartsystem;
 
-tap.test('should create a smartsystem instance', async tools => {
+tap.test('should create a smartsystem instance', async (tools) => {
   smartsystemInstance = new smartsystem.Smartsystem();
-  expect(smartsystemInstance).to.be.instanceOf(smartsystem.Smartsystem);
+  expect(smartsystemInstance).toBeInstanceOf(smartsystem.Smartsystem);
 });
 
 tap.test('should state the operating system', async () => {
-  expect(smartsystemInstance.cpuCount);
+  expect(smartsystemInstance.cpus.length).toBeGreaterThan(0);
+});
+
+tap.test('should get systeminformation', async () => {
+  console.log(await smartsystemInstance.information.networkInterfaceDefault());
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartsystem',
+  version: '3.0.1',
+  description: 'interact with the system you are running on'
+}

ts/index.ts

@@ -1,7 +1,10 @@
-import * as plugins from './smartsystem.plugins';
+import * as plugins from './smartsystem.plugins.js';
 
 export class Smartsystem {
-  public env = new plugins.smartenv.Smartenv()
+  public env = new plugins.smartenv.Smartenv();
-
+  public cpus = plugins.os.cpus();
-  public cpuCount = plugins.os.cpus().length;
+  public network = new plugins.smartnetwork.SmartNetwork();
+  public get information() {
+    return plugins.systeminformation;
+  }
 }

ts/smartsystem.plugins.ts

@@ -1,16 +1,16 @@
 // node native
-import os from 'os'
+import os from 'os';
 
-export {
+export { os };
-  os
-}
 
 import * as lik from '@pushrocks/lik';
 import * as smartenv from '@pushrocks/smartenv';
+import * as smartnetwork from '@pushrocks/smartnetwork';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export {
+export { lik, smartenv, smartnetwork, smartpromise };
-  lik,
+
-  smartenv,
+// third party
-  smartpromise
+import * as systeminformation from 'systeminformation';
-}
+
+export { systeminformation };

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

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