5.0.13

.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

@@ -8,12 +8,13 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
+.rpt2_cache
+
+# builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -1,125 +0,0 @@
-# gitzone standard
-image: 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:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  image: docker:stable
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g typedoc typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.snyk

@@ -1,4 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.12.0
-ignore: {}
-patch: {}

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

README.md

@@ -1,61 +0,0 @@
-# @pushrocks/npmextra
-do more with npm
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/npmextra)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/npmextra)
-* [github.com (source mirror)](https://github.com/pushrocks/npmextra)
-* [docs (typedoc)](https://pushrocks.gitlab.io/npmextra/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/npmextra/badges/master/build.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/npmextra/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/npmextra.svg)](https://www.npmjs.com/package/@pushrocks/npmextra)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/npmextra/badge.svg)](https://snyk.io/test/npm/@pushrocks/npmextra)
-[![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.
-
-## Using npmextra for managing toolconfigs
-
-The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.
-
-npmextra.json
-
-```json
-{
-  "sometool": {
-    "defaultKey1": "awesomeValueFromConfig"
-  }
-}
-```
-
-```typescript
-import { Npmextra } from 'npmextra';
-
-let myNpmExtra = new Npmextra('my/path/to/cwd'); // cwd argument is optional
-mergedData = myNpmExtra.dataFor('sometool', {
-  // gets merged with whatever is in the configfile
-  defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
-  defaultKey2: 'defaultValue2' // this one will pass through unaltered
-});
-```
-
-### Tools that already use the config feature of npmextra
-
-- [npmts](https://www.npmjs.com/package/npmts)
-- [npmci](https://www.npmjs.com/package/npmci)
-- [npmdocker](https://www.npmjs.com/package/npmdocker)
-
-## Using the KeyValueStore
-
-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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -9,13 +9,29 @@
     }
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "npmextra",
-      "shortDescription": "do more with npm",
-      "npmPackagename": "@pushrocks/npmextra",
-      "license": "MIT"
+      "description": "Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.",
+      "npmPackagename": "@push.rocks/npmextra",
+      "license": "MIT",
+      "keywords": [
+        "npm",
+        "configuration management",
+        "tool management",
+        "key-value store",
+        "project setup",
+        "npm scripts",
+        "typescript",
+        "environment setup",
+        "dependencies management",
+        "npm package enhancement"
+      ]
     }
+  },
+  "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,13 +1,14 @@
 {
-  "name": "@pushrocks/npmextra",
-  "version": "3.0.3",
+  "name": "@push.rocks/npmextra",
+  "version": "5.0.13",
   "private": false,
-  "description": "do more with npm",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "description": "Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -20,19 +21,48 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.2",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/taskbuffer": "^2.0.7"
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/smartfile": "^11.0.4",
+    "@push.rocks/smartjson": "^5.0.10",
+    "@push.rocks/smartlog": "^3.0.2",
+    "@push.rocks/smartpath": "^5.0.11",
+    "@push.rocks/smartpromise": "^4.0.2",
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/taskbuffer": "^3.1.7"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.20",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.0",
-    "tslint": "^5.16.0",
-    "tslint-config-prettier": "^1.18.0"
-  }
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.15",
+    "@types/node": "^20.11.17"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module",
+  "keywords": [
+    "npm",
+    "configuration management",
+    "tool management",
+    "key-value store",
+    "project setup",
+    "npm scripts",
+    "typescript",
+    "environment setup",
+    "dependencies management",
+    "npm package enhancement"
+  ]
 }

readme.md

@@ -0,0 +1,129 @@
+# @push.rocks/npmextra
+Enhances npm with additional configuration and tool management capabilities.
+
+## Install
+To install `@push.rocks/npmextra`, use the following npm command:
+
+```bash
+npm install @push.rocks/npmextra --save
+```
+
+This package is available on [npm](https://www.npmjs.com/package/@push.rocks/npmextra) and can be installed into your project as a dependency to enhance npm with additional configuration and tool management capabilities.
+
+## Usage
+`@push.rocks/npmextra` is designed to supplement npm functionalities with enhanced configuration and tool management. It facilitates managing project configurations and tool setups in a consolidated manner, enabling a smoother workflow and maintenance process. Below are detailed use cases and examples implemented with ESM syntax and TypeScript.
+
+### Initial Setup and Configuration
+To start using npmextra in your project, first include it in your project with an import statement:
+
+```typescript
+import { Npmextra } from '@push.rocks/npmextra';
+```
+
+Instantiate the `Npmextra` class optionally with a custom path to your project's working directory. If no path is provided, the current working directory (`process.cwd()`) is used.
+
+```typescript
+const npmExtraInstance = new Npmextra('/path/to/your/project');
+```
+
+### Managing Tool Configurations with `npmextra.json`
+`@push.rocks/npmextra` excels in unifying tool configurations through a single `npmextra.json` file. Instead of scattering configurations across multiple files, `@push.rocks/npmextra` enables you to define tool-specific settings within this centralized configuration file.
+
+#### Creating and Utilizing `npmextra.json`
+
+Create a `npmextra.json` in your project root with the following structure:
+
+```json
+{
+  "toolname": {
+    "setting1": "value1",
+    "setting2": "value2"
+  }
+}
+```
+
+For example, to configure a hypothetical tool named `toolname`, define its settings as shown above.
+
+#### Accessing Configuration in Your Project
+
+With the configuration defined, you can easily access these settings in your TypeScript code as follows:
+
+```typescript
+// import the npmextra module
+import { Npmextra } from '@push.rocks/npmextra';
+
+// create an instance pointing at the current directory
+const npmExtraInstance = new Npmextra();
+
+// retrieve the configuration for 'toolname', merging defaults with any found in npmextra.json
+const toolConfig = npmExtraInstance.dataFor('toolname', {
+  defaultKey1: 'defaultValue1',
+  defaultKey2: 'defaultValue2'
+});
+
+// toolConfig now contains the merged settings from npmextra.json and provided defaults
+console.log(toolConfig);
+```
+
+### Key-Value Store Management
+`@push.rocks/npmextra` also includes a Key-Value Store (KeyValueStore) functionality enabling persistent storage of key-value pairs between script executions.
+
+#### Setting Up KeyValueStore
+
+To utilize the KeyValueStore, create an instance specifying its scope (e.g., 'userHomeDir') and a unique identity for your application or tool:
+
+```typescript
+import { KeyValueStore } from '@push.rocks/npmextra';
+
+const kvStore = new KeyValueStore<'userHomeDir'>('userHomeDir', 'myUniqueAppName');
+```
+
+You can then use the `writeKey`, `readKey`, `writeAll`, and `readAll` methods to manage your store respectively.
+
+#### Example: Storing and Retrieving Data
+
+```typescript
+// Write a single key-value pair
+await kvStore.writeKey('username', 'johnDoe');
+
+// Read a single key
+const username = await kvStore.readKey('username');
+console.log(username); // Outputs: johnDoe
+
+// Write multiple key-value pairs
+await kvStore.writeAll({
+  email: 'john@example.com',
+  isAdmin: true
+});
+
+// Read all key-value pairs
+const allData = await kvStore.readAll();
+console.log(allData); // Outputs the entire store's contents
+```
+
+### Integrating with Tools
+`@push.rocks/npmextra` seamlessly integrates with numerous tools, enabling them to leverage `npmextra.json` for configuration purposes. Tools such as `npmts`, `npmci`, and `npmdocker` are already utilizing this feature for enhanced configuration management.
+
+For tool developers, integrating with `npmextra` requires reading the tool-specific configuration from `npmextra.json` and adjusting the tool's behavior based on these settings. This creates a unified and streamlined configuration process across different tools used within a project.
+
+### Conclusion
+By centralizing configuration management and offering a versatile key-value store, `@push.rocks/npmextra` significantly simplifies the setup and management of tools and settings in modern JavaScript and TypeScript projects. Whether you're managing project-wide configurations or need persistent storage for key-value pairs, `@push.rocks/npmextra` provides an efficient and streamlined solution.
+
+## 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/somekv.json

@@ -0,0 +1,3 @@
+{
+  "myKey": "myValue"
+}

test/test.kvstore.ts

@@ -1,25 +1,28 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
-import * as npmextra from '../ts/index';
+import * as npmextra from '../ts/index.js';
 
 let myKeyValueStore: npmextra.KeyValueStore;
 
 tap.test('should create a keyValueStore', async () => {
-  myKeyValueStore = new npmextra.KeyValueStore('custom', 'test');
-  expect(myKeyValueStore).to.be.instanceof(npmextra.KeyValueStore);
+  myKeyValueStore = new npmextra.KeyValueStore('custom', 'test', 'test/somekv.json');
+  expect(myKeyValueStore).toBeInstanceOf(npmextra.KeyValueStore);
+});
+
+tap.test('should reset the keyValueStore', async () => {
+  await myKeyValueStore.reset();
 });
 
 tap.test('expect result to be empty', async () => {
-  let result = myKeyValueStore.readAll();
-  // tslint:disable-next-line:no-unused-expression
-  expect(result).to.be.empty;
+  let result = await myKeyValueStore.readAll();
+  expect(JSON.stringify(result)).toEqual('{}');
 });
 
 tap.test('expect to add an object to the kv Store', async () => {
   await myKeyValueStore.writeAll({
-    myKey: 'myValue'
+    myKey: 'myValue',
   });
-  await expect(myKeyValueStore.readKey('myKey')).to.eventually.equal('myValue');
+  await expect(await myKeyValueStore.readKey('myKey')).toEqual('myValue');
 });
 
 tap.start();

test/test.ts

@@ -1,33 +1,33 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 import path = require('path');
 
 // module to test
-import npmExtra = require('../ts/index');
+import * as npmextra from '../ts/index.js';
 
-let testNpmextra: npmExtra.Npmextra;
+let testNpmextra: npmextra.Npmextra;
 
 tap.test('should create a new Npmtextra instance', async () => {
-  testNpmextra = new npmExtra.Npmextra('./test/');
-  expect(testNpmextra).be.instanceof(npmExtra.Npmextra);
+  testNpmextra = new npmextra.Npmextra('./test/');
+  expect(testNpmextra).toBeInstanceOf(npmextra.Npmextra);
 });
 
 tap.test('should state wether a npmextra.json exists', async () => {
   // tslint:disable-next-line:no-unused-expression
-  expect(testNpmextra.npmextraJsonExists).be.true;
+  expect(testNpmextra.npmextraJsonExists).toBeTrue();
 });
 
 tap.test('should pass through default value, if not overriden by config from file', async () => {
   let testData = testNpmextra.dataFor('testTool', { someKey2: 'someValue2' });
   console.log(testData);
-  expect(testData).have.ownProperty('someKey2');
+  expect(testData).toHaveProperty('someKey2');
 });
 
 tap.test('should read a config file', async () => {
   let testData = testNpmextra.dataFor<any>('testTool', {
-    someKey2: 'someValue2'
+    someKey2: 'someValue2',
   });
-  expect(testData).have.ownProperty('someKey2');
-  expect(testData.testValue).equal(2);
+  expect(testData).toHaveProperty('someKey2');
+  expect(testData.testValue).toEqual(2);
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/npmextra',
+  version: '5.0.13',
+  description: 'Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.'
+}

ts/index.ts

@@ -1,4 +1,3 @@
-import * as plugins from './npmextra.plugins';
-
-export * from './npmextra.classes.npmextra';
-export * from './npmextra.classes.keyvaluestore';
+export * from './npmextra.classes.appdata.js';
+export * from './npmextra.classes.keyvaluestore.js';
+export * from './npmextra.classes.npmextra.js';

ts/npmextra.classes.appdata.ts

@@ -0,0 +1,149 @@
+import * as plugins from './npmextra.plugins.js';
+import * as paths from './npmextra.paths.js';
+import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
+import { env } from 'process';
+
+export interface IAppDataOptions {
+  dirPath?: string;
+  requiredKeys?: string[];
+
+  /**
+   * kvStoreKey: 'MY_ENV_VAR'
+   */
+  envMapping?: {
+    [key: string]: string | object;
+  };
+}
+
+export class AppData<T = any> {
+  /**
+   * creates appdata. If no pathArg is given, data will be stored here:
+   * ${PWD}/.nogit/appdata
+   * @param pathArg
+   * @returns
+   */
+  public static async createAndInit<T = any>(optionsArg: IAppDataOptions = {}): Promise<AppData<T>> {
+    const appData = new AppData<T>(optionsArg);
+    await appData.readyDeferred.promise;
+    return appData;
+  }
+
+  // instance
+  public readyDeferred = plugins.smartpromise.defer();
+  public options: IAppDataOptions;
+  private kvStore: KeyValueStore<T>;
+  constructor(optionsArg: IAppDataOptions = {}) {
+    this.options = optionsArg;
+    this.init();
+  }
+
+  /**
+   * inits app data
+   * @param pathArg
+   */
+  private async init(pathArg?: string) {
+    if (this.options.dirPath) {
+      // ok, nothing to do here;
+    } else {
+      const appDataDir = '/app/data';
+      const dataDir = '/data';
+      const nogitAppData = '.nogit/appdata';
+      const appDataExists = plugins.smartfile.fs.isDirectory(appDataDir);
+      const dataExists = plugins.smartfile.fs.isDirectory(dataDir);
+      if (appDataExists) {
+        this.options.dirPath = appDataDir;
+      } else if (dataExists) {
+        this.options.dirPath = dataDir;
+      } else {
+        await plugins.smartfile.fs.ensureDir(nogitAppData);
+        this.options.dirPath = nogitAppData;
+      }
+    }
+    this.kvStore = new KeyValueStore({
+      typeArg: 'custom',
+      identityArg: 'appkv',
+      customPath: this.options.dirPath,
+      mandatoryKeys: this.options.requiredKeys
+    });
+
+    if (this.options.envMapping) {
+      const qenvInstance = new plugins.qenv.Qenv(process.cwd(), plugins.path.join(process.cwd(), '.nogit'));
+    
+      // Recursive function to handle nested objects, now includes key parameter
+      const processEnvMapping = async (key: string, mappingValue: any, parentKey: string = ''): Promise<any> => {
+        if (typeof mappingValue === 'string') {
+          let envValue: string;
+          if (mappingValue.startsWith('hard:')) {
+            envValue = mappingValue.replace('hard:', '');
+          } else {
+            envValue = await qenvInstance.getEnvVarOnDemand(mappingValue);
+          }
+          if (envValue) {
+            if (mappingValue.endsWith('_JSON')) {
+              envValue = JSON.parse(envValue);
+            }
+            if (!parentKey) {
+              await this.kvStore.writeKey(key, envValue);
+            } else {
+              return envValue;
+            }
+          } else {
+            return undefined;
+          }
+        } else if (typeof mappingValue === 'object' && mappingValue !== null) {
+          const resultObject = {};
+          for (const innerKey in mappingValue) {
+            const nestedValue = mappingValue[innerKey];
+            // For nested objects, call recursively but do not immediately write to kvStore
+            const nestedResult = await processEnvMapping(innerKey, nestedValue, key);
+            resultObject[innerKey] = nestedResult;
+          }
+          if (parentKey === '') {
+            // Only write to kvStore if at the top level
+            await this.kvStore.writeKey(key, resultObject);
+          } else {
+            // For nested objects, return the constructed object instead of writing to kvStore
+            return resultObject;
+          }
+        }
+      };
+    
+      for (const key in this.options.envMapping) {
+        await processEnvMapping(key, this.options.envMapping[key]);
+      }
+    }
+    
+    
+
+    this.readyDeferred.resolve();
+  }
+
+  /**
+   * returns a kvtore that resides in appdata
+   */
+  public async getKvStore() {
+    await this.readyDeferred.promise;
+    return this.kvStore;
+  }
+
+  public async logMissingKeys() {
+    const kvStore = await this.getKvStore();
+    const missingMandatoryKeys = await kvStore.getMissingMandatoryKeys();
+    if (missingMandatoryKeys.length > 0) {
+      console.log(
+        `The following mandatory keys are missing in the appdata:\n   -> ${missingMandatoryKeys.join(
+          ',\n   -> '
+        )}`
+      );
+    } else {
+      console.log('All mandatory keys are present in the appdata');
+    }
+    return missingMandatoryKeys;
+  }
+
+  public async waitForAndGetKey(keyArg: string) {
+    await this.readyDeferred.promise;
+    await this.kvStore.waitForKeysPresent([keyArg]);
+    return this.kvStore.readKey[keyArg];
+  }
+}

ts/npmextra.classes.keyvaluestore.ts

@@ -1,119 +1,193 @@
-import * as plugins from './npmextra.plugins';
-import * as paths from './npmextra.paths';
+import * as plugins from './npmextra.plugins.js';
+import * as paths from './npmextra.paths.js';
 
-import { Task, TaskOnce } from '@pushrocks/taskbuffer';
+import { Task } from '@push.rocks/taskbuffer';
 
-export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
+export type TKeyValueStore = 'custom' | 'userHomeDir';
+
+export interface IKvStoreConstructorOptions {
+  typeArg: TKeyValueStore;
+  identityArg: string;
+  customPath?: string;
+  mandatoryKeys?: string[];
+}
 
 /**
- * kvStore is a simple key vlaue store to store data about projects between runs
+ * kvStore is a simple key value store to store data about projects between runs
  */
-export class KeyValueStore {
-  dataObject: any;
-  deletedObject: any = {};
-  initialReadTask = new TaskOnce({
-    taskFunction: async () => {
-      this.dataObject = plugins.smartfile.fs.toObjectSync(this.filePath);
-    }
-  });
-  syncTask = new Task({
+export class KeyValueStore<T = any> {
+  private dataObject: Partial<T> = {};
+  private deletedObject: any = {};
+  private mandatoryKeys: Set<string> = new Set();
+  public changeSubject = new plugins.smartrx.rxjs.Subject();
+  
+  private storedStateString: string = '';
+  public syncTask = new Task({
+    name: 'syncTask',
     buffered: true,
-    bufferMax: 2,
-    execDelay: 500,
+    bufferMax: 1,
+    execDelay: 0,
     taskFunction: async () => {
+      
       this.dataObject = {
         ...plugins.smartfile.fs.toObjectSync(this.filePath),
-        ...this.dataObject
+        ...this.dataObject,
       };
       for (const key of Object.keys(this.deletedObject)) {
         delete this.dataObject[key];
       }
       this.deletedObject = {};
-      await plugins.smartfile.memory.toFs(JSON.stringify(this.dataObject), this.filePath);
+      await plugins.smartfile.memory.toFs(
+        plugins.smartjson.stringifyPretty(this.dataObject),
+        this.filePath
+      );
+      const newStateString = plugins.smartjson.stringify(this.dataObject);
+
+      // change detection
+      if (newStateString !== this.storedStateString) {
+        this.storedStateString = newStateString;
+        this.changeSubject.next(this.dataObject);
+      }
     },
-    name: 'syncTask'
   });
-  type: TKeyValueStore; // the type of the kvStore
-  identity: string; // the identity of the kvStore
-  filePath: string; // the filePath of the kvStore
+
+  /**
+   * computes the identity and filePath
+   */
+  private initFilePath = () => {
+    if (this.customPath) {
+      // Use custom path if provided
+      const absolutePath = plugins.smartpath.transform.makeAbsolute(this.customPath, paths.cwd);
+      this.filePath = absolutePath;
+      if (plugins.smartfile.fs.isDirectorySync(this.filePath)) {
+        this.filePath = plugins.path.join(this.filePath, this.identity + '.json');
+      }
+      plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
+      return;
+    }
+
+    let baseDir: string;
+    if (this.type === 'userHomeDir') {
+      baseDir = paths.kvUserHomeDirBase;
+    } else {
+      throw new Error('kv type not supported');
+    }
+    this.filePath = plugins.path.join(baseDir, this.identity + '.json');
+    plugins.smartfile.fs.ensureDirSync(baseDir);
+    plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
+  };
+
+  // if no custom path is provided, try to store at home directory
+  public type: TKeyValueStore;
+  public identity: string;
+  public filePath: string;
+  private customPath?: string; // Optionally allow custom path
 
   /**
    * the constructor of keyvalue store
    * @param typeArg
-   * @param customStringArg
+   * @param identityArg
+   * @param customPath Optional custom path for the keyValue store
    */
-  constructor(typeArg: TKeyValueStore, customStringArg: string) {
-    // set kvStoreType
-    this.type = typeArg;
-    this.identity = customStringArg;
+  constructor(optionsArg: IKvStoreConstructorOptions) {
+    if (optionsArg.customPath && optionsArg.typeArg !== 'custom') {
+      throw new Error('customPath can only be provided if typeArg is custom');
+    }
+    if (optionsArg.typeArg === 'custom' && !optionsArg.customPath) {
+      throw new Error('customPath must be provided if typeArg is custom');
+    }
+    this.type = optionsArg.typeArg;
+    this.identity = optionsArg.identityArg;
+    this.customPath = optionsArg.customPath; // Store custom path if provided
     this.initFilePath();
+    if (optionsArg.mandatoryKeys) {
+      this.setMandatoryKeys(optionsArg.mandatoryKeys);
+    }
   }
 
   /**
    * reads all keyValue pairs at once and returns them
    */
-  async readAll() {
-    await this.initialReadTask.trigger();
-    this.syncTask.trigger();
+  public async readAll() {
+    await this.syncTask.trigger();
     return this.dataObject;
   }
 
   /**
    * reads a keyValueFile from disk
    */
-  async readKey(keyArg: string) {
-    let data = await this.readAll();
-    return data[keyArg];
+  public async readKey(keyArg: string) {
+    await this.syncTask.trigger();
+    return this.dataObject[keyArg];
   }
 
   /**
    * writes a specific key to the keyValueStore
    */
-  async writeKey(keyArg: string, valueArg: any) {
-    let writeObject: any = {};
-    writeObject[keyArg] = valueArg;
-    this.writeAll(writeObject);
+  public async writeKey(keyArg: string, valueArg: any) {
+    await this.writeAll({
+      [keyArg]: valueArg,
+    });
+  }
+
+  public async deleteKey(keyArg: string) {
+    this.deletedObject[keyArg] = this.dataObject[keyArg];
+    await this.syncTask.trigger();
   }
 
   /**
    * writes all keyValue pairs in the object argument
    */
-  public async writeAll(keyValueObject) {
-    this.dataObject = {...this.dataObject, ...keyValueObject};
-    this.syncTask.trigger();
+  public async writeAll(keyValueObject: { [key: string]: any }) {
+    this.dataObject = { ...this.dataObject, ...keyValueObject };
+    await this.syncTask.trigger();
   }
 
   /**
    * wipes a key value store from disk
    */
   public async wipe() {
-    for (let key in this.dataObject) {
-      this.deletedObject[key] = this.dataObject[key];
-    }
+    this.dataObject = {};
+    await plugins.smartfile.fs.remove(this.filePath);
   }
 
   /**
-   * updates a value
+   * resets the KeyValueStore to the initial state by syncing first, deleting all keys, and then triggering a sync again
    */
-  async update(keyObject) {}
+  public async reset() {
+    await this.syncTask.trigger(); // Sync to get the latest state
 
-  /**
-   * computes the identity
-   */
-  private initFilePath() {
-    // determine the right base directory
-    let baseDir: string;
-    if (this.type === 'custom') {
-      baseDir = paths.kvCustomDir;
-    } else if (this.type === 'gitProject') {
-      baseDir = paths.kvGitDir;
-    } else if (this.type === 'path') {
-      baseDir = paths.kvPathDir;
+    // Delete all keys from the dataObject and add them to deletedObject
+    for (const key of Object.keys(this.dataObject)) {
+      this.deletedObject[key] = this.dataObject[key];
+      delete this.dataObject[key];
     }
-    this.filePath = plugins.path.join(baseDir, this.identity + '.json');
-    plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
-    plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
-    plugins.smartfile.fs.ensureDirSync(paths.kvPathDir);
-    plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
+
+    await this.syncTask.trigger(); // Sync again to reflect the deletion
+  }
+
+  private setMandatoryKeys(keys: string[]) {
+    keys.forEach(key => this.mandatoryKeys.add(key));
+  }
+
+  public async getMissingMandatoryKeys(): Promise<string[]> {
+    await this.readAll();
+    return Array.from(this.mandatoryKeys).filter(key => !(key in this.dataObject));
+  }
+
+  public async waitForKeysPresent(keysArg: string[]): Promise<void> {
+    const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
+    if (missingKeys.length === 0) {
+      return;
+    }
+    return new Promise((resolve, reject) => {
+      const subscription = this.changeSubject.subscribe(() => {
+        const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
+        if (missingKeys.length === 0) {
+          subscription.unsubscribe();
+          resolve();
+        }
+      });
+    });
   }
 }

ts/npmextra.classes.npmextra.ts

@@ -1,5 +1,5 @@
-import * as plugins from './npmextra.plugins';
-import * as paths from './npmextra.paths';
+import * as plugins from './npmextra.plugins.js';
+import * as paths from './npmextra.paths.js';
 
 /**
  * Npmextra class allows easy configuration of tools
@@ -36,7 +36,7 @@ export class Npmextra {
     }
     let mergedOptions = {
       ...defaultOptionsArg,
-      ...npmextraToolOptions
+      ...npmextraToolOptions,
     };
     return mergedOptions;
   }

ts/npmextra.paths.ts

@@ -1,8 +1,11 @@
-import * as plugins from './npmextra.plugins';
+import * as plugins from './npmextra.plugins.js';
 
 // directories
 export let cwd = process.cwd();
-export let packageDir = plugins.path.join(__dirname, '../');
+export let packageDir = plugins.path.join(
+  plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
+  '../'
+);
 
 // ----------------------
 // keyValueStore specific
@@ -13,22 +16,7 @@ export let home = plugins.smartpath.get.home();
 /**
  * keyValue base path
  */
-export let kvBase = plugins.path.join(home, '.npmextra/kv');
-
-/**
- * the base directory for custom string based key value store
- */
-export let kvCustomDir = plugins.path.join(kvBase, 'custom');
-
-/**
- * the subdir for git based keyValue
- */
-export let kvGitDir = plugins.path.join(kvBase, 'git');
-
-/**
- * keyValue for path based keyValue store
- */
-export let kvPathDir = plugins.path.join(kvBase, 'path');
+export let kvUserHomeDirBase = plugins.path.join(home, '.npmextra/kv');
 
 // files
 export let configFile = plugins.path.join(cwd, 'npmextra.json');

ts/npmextra.plugins.ts

@@ -1,8 +1,11 @@
-import * as beautylog from '@pushrocks/smartlog';
+import * as qenv from '@push.rocks/qenv';
+import * as smartlog from '@push.rocks/smartlog';
 import * as path from 'path';
-import * as smartfile from '@pushrocks/smartfile';
-import * as smartpath from '@pushrocks/smartpath';
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as taskbuffer from '@pushrocks/taskbuffer';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartjson from '@push.rocks/smartjson';
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as taskbuffer from '@push.rocks/taskbuffer';
 
-export { beautylog, path, smartfile, smartpath, smartpromise, taskbuffer };
+export { qenv, smartlog, path, smartfile, smartjson, smartpath, smartpromise, smartrx, taskbuffer };

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