4.0.7

.gitea/workflows/default_tags.yaml

@@ -119,6 +119,6 @@ jobs:
         run: |
           npmci node install stable
           npmci npm install
-          pnpm install -g @gitzone/tsdoc
+          pnpm install -g @git.zone/tsdoc
           npmci command tsdoc
         continue-on-error: true

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@push.rocks/npmextra",
-  "version": "3.0.10",
+  "version": "4.0.7",
   "private": false,
   "description": "do more with npm",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
     "buildDocs": "tsdoc"
   },
   "repository": {
@@ -21,18 +21,20 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@push.rocks/smartfile": "^10.0.26",
+    "@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/taskbuffer": "^3.0.10"
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/taskbuffer": "^3.1.7"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
+    "@git.zone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
+    "@git.zone/tstest": "^1.0.77",
-    "@push.rocks/tapbundle": "^5.0.8",
+    "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.4.6"
+    "@types/node": "^20.11.6"
   },
   "files": [
     "ts/**/*",

test/somekv.json

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

test/test.kvstore.ts

@@ -5,10 +5,14 @@ import * as npmextra from '../ts/index.js';
 let myKeyValueStore: npmextra.KeyValueStore;
 
 tap.test('should create a keyValueStore', async () => {
-  myKeyValueStore = new npmextra.KeyValueStore('custom', 'test');
+  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 = await myKeyValueStore.readAll();
   expect(JSON.stringify(result)).toEqual('{}');

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/npmextra',
-  version: '3.0.10',
+  version: '4.0.7',
   description: 'do more with npm'
 }

ts/index.ts

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

ts/npmextra.classes.appdata.ts

@@ -0,0 +1,60 @@
+import * as plugins from './npmextra.plugins.js';
+import * as paths from './npmextra.paths.js';
+import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
+
+export class AppData {
+  /**
+   * creates appdata. If no pathArg is given, data will be stored here:
+   * ${PWD}/.nogit/appdata
+   * @param pathArg
+   * @returns 
+   */
+  public static async createAndInit(pathArg?: string) {
+    const appData = new AppData(pathArg);
+    await appData.readyDeferred.promise;
+    return appData;
+  }
+
+  // instance
+  public readyDeferred = plugins.smartpromise.defer();
+  public dirPathArg: string;
+  private kvStore: KeyValueStore;
+  constructor(pathArg?: string) {
+    this.dirPathArg = pathArg;
+    this.init();
+  }
+
+  /**
+   * inits app data
+   * @param pathArg
+   */
+  private async init(pathArg?: string) {
+    if (this.dirPathArg) {
+      // 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.dirPathArg = appDataDir;
+      } else if (dataExists) {
+        this.dirPathArg = dataDir;
+      } else {
+        await plugins.smartfile.fs.ensureDir(nogitAppData);
+        this.dirPathArg = nogitAppData;
+      }
+    }
+    this.kvStore = new KeyValueStore('custom', 'appkv', this.dirPathArg);
+    this.readyDeferred.resolve();
+  }
+
+  /**
+   * returns a kvtore that resides in appdata
+   */
+  public async getKvStore() {
+    await this.readyDeferred.promise;
+    return this.kvStore;
+  }
+}

ts/npmextra.classes.keyvaluestore.ts

@@ -3,20 +3,25 @@ import * as paths from './npmextra.paths.js';
 
 import { Task } from '@push.rocks/taskbuffer';
 
-export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
+export type TKeyValueStore = 'custom' | 'userHomeDir';
 
 /**
- * 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 {
   private dataObject: any = {};
   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: 1,
     execDelay: 0,
     taskFunction: async () => {
+      
       this.dataObject = {
         ...plugins.smartfile.fs.toObjectSync(this.filePath),
         ...this.dataObject,
@@ -25,43 +30,72 @@ export class KeyValueStore {
         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);
+      }
     },
   });
+
   /**
-   * computes the identity
+   * computes the identity and filePath
    */
   private initFilePath = () => {
-    // determine the right base directory
+    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 === 'custom') {
+    if (this.type === 'userHomeDir') {
-      baseDir = paths.kvCustomDir;
+      baseDir = paths.kvUserHomeDirBase;
-    } else if (this.type === 'gitProject') {
+    } else {
-      baseDir = paths.kvGitDir;
+      throw new Error('kv type not supported');
-    } else if (this.type === 'path') {
-      baseDir = paths.kvPathDir;
     }
     this.filePath = plugins.path.join(baseDir, this.identity + '.json');
-    plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
+    plugins.smartfile.fs.ensureDirSync(baseDir);
-    plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
-    plugins.smartfile.fs.ensureDirSync(paths.kvPathDir);
     plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
   };
 
-  public type: TKeyValueStore; // the type of the kvStore
+  // if no custom path is provided, try to store at home directory
-  public identity: string; // the identity of the kvStore
+  public type: TKeyValueStore;
-  public filePath: string; // the filePath of the kvStore
+  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) {
+  constructor(typeArg: TKeyValueStore, identityArg: string, customPath?: string, mandatoryKeys?: string[]) {
-    // set kvStoreType
+    if (customPath && typeArg !== 'custom') {
+      throw new Error('customPath can only be provided if typeArg is custom');
+    }
+    if (typeArg === 'custom' && !customPath) {
+      throw new Error('customPath must be provided if typeArg is custom');
+    }
     this.type = typeArg;
-    this.identity = customStringArg;
+    this.identity = identityArg;
+    this.customPath = customPath; // Store custom path if provided
     this.initFilePath();
+    if (mandatoryKeys) {
+      this.setMandatoryKeys(mandatoryKeys);
+    }
   }
 
   /**
@@ -97,7 +131,7 @@ export class KeyValueStore {
   /**
    * writes all keyValue pairs in the object argument
    */
-  public async writeAll(keyValueObject) {
+  public async writeAll(keyValueObject: { [key: string]: any }) {
     this.dataObject = { ...this.dataObject, ...keyValueObject };
     await this.syncTask.trigger();
   }
@@ -109,4 +143,43 @@ export class KeyValueStore {
     this.dataObject = {};
     await plugins.smartfile.fs.remove(this.filePath);
   }
+
+  /**
+   * resets the KeyValueStore to the initial state by syncing first, deleting all keys, and then triggering a sync again
+   */
+  public async reset() {
+    await this.syncTask.trigger(); // Sync to get the latest state
+
+    // 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];
+    }
+
+    await this.syncTask.trigger(); // Sync again to reflect the deletion
+  }
+
+  private setMandatoryKeys(keys: string[]) {
+    keys.forEach(key => this.mandatoryKeys.add(key));
+  }
+
+  public getMissingMandatoryKeys(): string[] {
+    return Array.from(this.mandatoryKeys).filter(key => !(key in this.dataObject));
+  }
+
+  public async waitForKeysPresent(keysArg: []): 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.paths.ts

@@ -16,22 +16,7 @@ export let home = plugins.smartpath.get.home();
 /**
  * keyValue base path
  */
-export let kvBase = plugins.path.join(home, '.npmextra/kv');
+export let kvUserHomeDirBase = 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');
 
 // files
 export let configFile = plugins.path.join(cwd, 'npmextra.json');

ts/npmextra.plugins.ts

@@ -1,8 +1,10 @@
 import * as smartlog from '@push.rocks/smartlog';
 import * as path from 'path';
 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 { smartlog, path, smartfile, smartpath, smartpromise, taskbuffer };
+export { smartlog, path, smartfile, smartjson, smartpath, smartpromise, smartrx, taskbuffer };

tsconfig.json

@@ -3,9 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
+    "module": "NodeNext",
-    "moduleResolution": "nodenext",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
+    "verbatimModuleSyntax": true
-  }
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }