5.0.0

.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,6 +1,6 @@
 {
   "name": "@push.rocks/npmextra",
-  "version": "3.0.13",
+  "version": "5.0.0",
   "private": false,
   "description": "do more with npm",
   "main": "dist_ts/index.js",
@@ -21,19 +21,21 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@push.rocks/smartfile": "^10.0.30",
-    "@push.rocks/smartjson": "^5.0.8",
+    "@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/taskbuffer": "^3.1.6"
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/taskbuffer": "^3.1.7"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
+    "@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.5.3"
+    "@types/node": "^20.11.17"
   },
   "files": [
     "ts/**/*",

test/somekv.json

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

ts/00_commitinfo_data.ts

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

ts/npmextra.classes.appdata.ts

@@ -1,29 +1,84 @@
 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;
+  };
+}
 
 export class AppData {
-  public readyDeferred = plugins.smartpromise.defer();
-  public dirPathArg: string;
-  private kvStore: KeyValueStore;
-  constructor(pathArg?: string) {
-    this.init(pathArg);
+  /**
+   * creates appdata. If no pathArg is given, data will be stored here:
+   * ${PWD}/.nogit/appdata
+   * @param pathArg
+   * @returns
+   */
+  public static async createAndInit(optionsArg: IAppDataOptions = {}) {
+    const appData = new AppData(optionsArg);
+    await appData.readyDeferred.promise;
+    return appData;
   }
 
+  // instance
+  public readyDeferred = plugins.smartpromise.defer();
+  public options: IAppDataOptions;
+  private kvStore: KeyValueStore;
+  constructor(optionsArg: IAppDataOptions = {}) {
+    this.options = optionsArg;
+    this.init();
+  }
+
+  /**
+   * inits app data
+   * @param pathArg
+   */
   private async init(pathArg?: string) {
-    if (pathArg) {
-      this.dirPathArg = pathArg;
+    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.dirPathArg = appDataDir;
-        this.dirPathArg = dataDir;
+        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('custom', 'appkv', this.dirPathArg);
+    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(), '~/.cloudlyrc');
+      for (const key in this.options.envMapping) {
+        let envValue = await qenvInstance.getEnvVarOnDemand(key);
+        if (envValue) {
+          if (key.endsWith('_JSON')) {
+            envValue = JSON.parse(envValue);
+          }
+          await this.kvStore.writeKey(key, envValue);
+        }
+      }
+    }
+
     this.readyDeferred.resolve();
   }
 
@@ -34,4 +89,24 @@ export class AppData {
     await this.readyDeferred.promise;
     return this.kvStore;
   }
-}
+
+  public async logMissingKeys() {
+    const kvStore = await this.getKvStore();
+    const missingMandatoryKeys = 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');
+    }
+  }
+
+  public async waitForAndGetKey(keyArg: string) {
+    await this.readyDeferred.promise;
+    await this.kvStore.waitForKeysPresent([keyArg]);
+    return this.kvStore.readKey[keyArg];
+  }
+}

ts/npmextra.classes.keyvaluestore.ts

@@ -5,18 +5,30 @@ import { Task } from '@push.rocks/taskbuffer';
 
 export type TKeyValueStore = 'custom' | 'userHomeDir';
 
+export interface IKvStoreConstructorOptions {
+  typeArg: TKeyValueStore;
+  identityArg: string;
+  customPath?: string;
+  mandatoryKeys?: string[];
+}
+
 /**
  * kvStore is a simple key value store to store data about projects between runs
  */
-export class KeyValueStore {
-  private dataObject: any = {};
+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: 1,
     execDelay: 0,
     taskFunction: async () => {
+      
       this.dataObject = {
         ...plugins.smartfile.fs.toObjectSync(this.filePath),
         ...this.dataObject,
@@ -26,9 +38,16 @@ export class KeyValueStore {
       }
       this.deletedObject = {};
       await plugins.smartfile.memory.toFs(
-        plugins.smartjson.stringify(this.dataObject),
+        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);
+      }
     },
   });
 
@@ -70,17 +89,20 @@ export class KeyValueStore {
    * @param identityArg
    * @param customPath Optional custom path for the keyValue store
    */
-  constructor(typeArg: TKeyValueStore, identityArg: string, customPath?: string) {
-    if (customPath && typeArg !== 'custom') {
+  constructor(optionsArg: IKvStoreConstructorOptions) {
+    if (optionsArg.customPath && optionsArg.typeArg !== 'custom') {
       throw new Error('customPath can only be provided if typeArg is custom');
     }
-    if (typeArg === 'custom' && !customPath) {
+    if (optionsArg.typeArg === 'custom' && !optionsArg.customPath) {
       throw new Error('customPath must be provided if typeArg is custom');
     }
-    this.type = typeArg;
-    this.identity = identityArg;
-    this.customPath = customPath; // Store custom path if provided
+    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);
+    }
   }
 
   /**
@@ -143,4 +165,28 @@ export class KeyValueStore {
 
     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: 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.plugins.ts

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

tsconfig.json

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