5.1.2

changelog.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## 2024-11-06 - 5.1.2 - fix(appdata)
+Fix iteration over overwriteObject in AppData class
+
+- Corrected the for loop from in to of inside the AppData class for iterating over overwriteObject keys.
+
+## 2024-11-05 - 5.1.1 - fix(AppData)
+Fix issue with overwrite object handling in AppData class
+
+- Corrected logic to handle cases when overwriteObject is undefined.
+
+## 2024-11-05 - 5.1.0 - feat(appdata)
+Add support for overwriting keys using the overwriteObject option in AppData
+
+- Introduced the overwriteObject option in IAppDataOptions to allow overwriting specific keys in the AppData class.
+
+## 2024-06-19 - 5.0.17 - 5.0.23 - Core Updates
+Routine maintenance and updates to the core components.
+
+- Multiple core updates and fixes improving stability
+
+## 2024-06-12 - 5.0.13 - 5.0.16 - Core Updates
+Maintenance focus on core systems with enhancements and problem resolutions.
+
+- Enhancements and updates in the core functionality
+
+## 2024-05-29 - 5.0.13 - Documentation Update
+Descriptive improvements aligned with current features.
+
+- Updated core description for better clarity in documentation
+
+## 2024-04-01 - 5.0.10 - Configuration Update
+Improved configuration management for build processes.
+
+- Updated `npmextra.json` to reflect changes in git repository management
+
+## 2024-02-12 - 5.0.0 - 5.0.9 - Major Core Enhancements
+A series of critical updates with resolved issues in the core components.
+
+- Introduction of new core features
+- Several core system updates
+
+## 2024-02-12 - 4.0.16 - Major Version Transition
+Migration to the new major version with impactful changes.
+
+- BREAKING CHANGE: Significant updates requiring attention for smooth transition
+
+## 2023-08-24 - 3.0.9 - 4.0.16 - Organization Updates
+Formatted updates with attention to organizational standards and practice.
+
+- SWITCH to a new organizational scheme
+
+## 2023-07-11 - 3.0.9 - Organizational Enhancement
+Shifts aligning with contemporary structuring and logistics.
+
+- Strategic realignment with organizational principles

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/npmextra",
-  "version": "5.0.18",
+  "version": "5.1.2",
   "private": false,
   "description": "A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.",
   "main": "dist_ts/index.js",
@@ -28,7 +28,8 @@
     "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartpromise": "^4.0.2",
     "@push.rocks/smartrx": "^3.0.7",
-    "@push.rocks/taskbuffer": "^3.1.7"
+    "@push.rocks/taskbuffer": "^3.1.7",
+    "@tsclass/tsclass": "^4.0.59"
   },
   "devDependencies": {
     "@git.zone/tsbuild": "^2.1.80",

pnpm-lock.yaml

@@ -32,6 +32,9 @@ importers:
       '@push.rocks/taskbuffer':
         specifier: ^3.1.7
         version: 3.1.7
+      '@tsclass/tsclass':
+        specifier: ^4.0.59
+        version: 4.0.59
     devDependencies:
       '@git.zone/tsbuild':
         specifier: ^2.1.80
@@ -625,8 +628,8 @@ packages:
   '@tsclass/tsclass@3.0.48':
     resolution: {integrity: sha512-hC65UvDlp9qvsl6OcIZXz0JNiWZ0gyzsTzbXpg215sGxopgbkOLCr6E0s4qCTnweYm95gt2AdY95uP7M7kExaQ==}
 
-  '@tsclass/tsclass@4.0.55':
+  '@tsclass/tsclass@4.0.59':
-    resolution: {integrity: sha512-zg774JF90/3/rJ7xk4LyGgxcUzxdKIQcwtBVxez4LhvegESxvHiFmX42WL105iBpE53ISJ8sctLWlwG1JQZdlA==}
+    resolution: {integrity: sha512-zSdNX/qzuekfCFG81k4e1X2tj1S+rbs2tM4CFAzT+aLiu2/AqdS1iPYwH/sYpY8vm+vBfllks9rlsuRSA2xTeg==}
 
   '@tsconfig/node10@1.0.11':
     resolution: {integrity: sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==}
@@ -3060,7 +3063,7 @@ snapshots:
       '@push.rocks/taskbuffer': 3.1.7
       '@push.rocks/webrequest': 3.0.37
       '@push.rocks/webstore': 2.0.20
-      '@tsclass/tsclass': 4.0.55
+      '@tsclass/tsclass': 4.0.59
       '@types/express': 4.17.21
       body-parser: 1.20.2
       cors: 2.8.5
@@ -3565,7 +3568,7 @@ snapshots:
   '@push.rocks/smartlog-interfaces@3.0.2':
     dependencies:
       '@api.global/typedrequest-interfaces': 2.0.2
-      '@tsclass/tsclass': 4.0.55
+      '@tsclass/tsclass': 4.0.59
 
   '@push.rocks/smartlog@3.0.7':
     dependencies:
@@ -3645,7 +3648,7 @@ snapshots:
       '@push.rocks/smartpromise': 4.0.3
       '@push.rocks/smartpuppeteer': 2.0.2
       '@push.rocks/smartunique': 3.0.9
-      '@tsclass/tsclass': 4.0.55
+      '@tsclass/tsclass': 4.0.59
       '@types/express': 4.17.21
       express: 4.19.2
       pdf-lib: 1.17.1
@@ -3703,7 +3706,7 @@ snapshots:
       '@push.rocks/smartxml': 1.0.8
       '@push.rocks/smartyaml': 2.0.5
       '@push.rocks/webrequest': 3.0.37
-      '@tsclass/tsclass': 4.0.55
+      '@tsclass/tsclass': 4.0.59
 
   '@push.rocks/smartsocket@2.0.27':
     dependencies:
@@ -3837,7 +3840,7 @@ snapshots:
     dependencies:
       '@pushrocks/smartdelay': 3.0.1
       '@pushrocks/smartpromise': 4.0.2
-      '@tsclass/tsclass': 4.0.55
+      '@tsclass/tsclass': 4.0.59
 
   '@push.rocks/webstore@2.0.20':
     dependencies:
@@ -4013,7 +4016,7 @@ snapshots:
     dependencies:
       type-fest: 2.19.0
 
-  '@tsclass/tsclass@4.0.55':
+  '@tsclass/tsclass@4.0.59':
     dependencies:
       type-fest: 4.20.0
 

test/test.appdata.ts

@@ -0,0 +1,27 @@
+import { expect, tap } from '@push.rocks/tapbundle';
+import path = require('path');
+
+// module to test
+import * as npmextra from '../ts/index.js';
+
+interface ITestOptions {
+  hi: string;
+  deep: {
+    deep1: string;
+    deep2: string;
+  };
+}
+
+let testAppdata: npmextra.AppData<ITestOptions>;
+
+tap.test('should create a valid AppData', async () => {
+  testAppdata = new npmextra.AppData<ITestOptions>({
+    envMapping: {
+      deep: {
+        deep1: '',
+      },
+    },
+  });
+});
+
+export default tap.start();

ts/00_commitinfo_data.ts

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

ts/npmextra.classes.appdata.ts

@@ -1,7 +1,6 @@
 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<T = any> {
   dirPath?: string;
@@ -15,9 +14,8 @@ export interface IAppDataOptions<T = any> {
   /**
    * kvStoreKey: 'MY_ENV_VAR'
    */
-  envMapping?: {
+  envMapping?: plugins.tsclass.typeFest.PartialDeep<T>;
-    [key in keyof T]?: string | object;
+  overwriteObject?: plugins.tsclass.typeFest.PartialDeep<T>;
-  };
 }
 
 export class AppData<T = any> {
@@ -27,7 +25,9 @@ export class AppData<T = any> {
    * @param pathArg
    * @returns
    */
-  public static async createAndInit<T = any>(optionsArg: IAppDataOptions<T> = {}): Promise<AppData<T>> {
+  public static async createAndInit<T = any>(
+    optionsArg: IAppDataOptions<T> = {}
+  ): Promise<AppData<T>> {
     const appData = new AppData<T>(optionsArg);
     await appData.readyDeferred.promise;
     return appData;
@@ -70,27 +70,85 @@ export class AppData<T = any> {
       typeArg: this.options.ephermal ? 'ephemeral' : 'custom',
       identityArg: 'appkv',
       customPath: this.options.dirPath,
-      mandatoryKeys: this.options.requiredKeys as Array<keyof T>
+      mandatoryKeys: this.options.requiredKeys as Array<keyof T>,
     });
 
     if (this.options.envMapping) {
-      const qenvInstance = new plugins.qenv.Qenv(process.cwd(), plugins.path.join(process.cwd(), '.nogit'));
+      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: keyof T, mappingValue: any, parentKey: keyof T | '' = ''): Promise<any> => {
+      const processEnvMapping = async (
+        key: keyof T,
+        mappingValue: any,
+        parentKey: keyof T | '' = ''
+      ): Promise<any> => {
         if (typeof mappingValue === 'string') {
-          let envValue: string | T[keyof T];
+          let envValue: string | boolean | T[keyof T];
-          if (mappingValue.startsWith('hard:')) {
+          let convert: 'none' | 'json' | 'base64' | 'boolean' = 'none';
-            envValue = mappingValue.replace('hard:', '') as T[keyof T];
+          switch (true) {
-          } else {
+            case mappingValue.startsWith('hard:'):
-            envValue = await qenvInstance.getEnvVarOnDemand(mappingValue) as T[keyof T];
+              envValue = mappingValue.replace('hard:', '') as T[keyof T];
+              break;
+            case mappingValue.startsWith('hard_boolean:'):
+              envValue = mappingValue.replace('hard_boolean:', '') === 'true';
+              convert = 'boolean';
+              break;
+            case mappingValue.startsWith('hard_json:'):
+              envValue = JSON.parse(mappingValue.replace('hard_json:', '')) as T[keyof T];
+              convert = 'json';
+              break;
+            case mappingValue.startsWith('hard_base64:'):
+              envValue = Buffer.from(
+                mappingValue.replace('hard_base64:', ''),
+                'base64'
+              ).toString() as T[keyof T];
+              convert = 'base64';
+              break;
+            case mappingValue.startsWith('boolean:'):
+              envValue = (await qenvInstance.getEnvVarOnDemand(
+                mappingValue.replace('boolean:', '')
+              )) as T[keyof T];
+              convert = 'boolean';
+              break;
+            case mappingValue.startsWith('json:'):
+              envValue = (await qenvInstance.getEnvVarOnDemand(
+                mappingValue.replace('json:', '')
+              )) as T[keyof T];
+              convert = 'json';
+              break;
+            case mappingValue.startsWith('base64:'):
+              envValue = (await qenvInstance.getEnvVarOnDemand(
+                mappingValue.replace('base64:', '')
+              )) as T[keyof T];
+              convert = 'base64';
+              break;
+            default:
+              envValue = (await qenvInstance.getEnvVarOnDemand(mappingValue)) as T[keyof T];
+              break;
           }
+
+          // lets format the env value
           if (envValue) {
-            if (typeof envValue === 'string' && mappingValue.endsWith('_JSON')) {
+            if (typeof envValue === 'string' && convert === 'boolean') {
-              envValue = JSON.parse(envValue) as T[keyof T];
+              envValue = envValue === 'true';
+            }
+            if (
+              typeof envValue === 'string' &&
+              (mappingValue.endsWith('_JSON') || convert === 'json')
+            ) {
+              envValue = JSON.parse(envValue as string) as T[keyof T];
+            }
+            if (
+              typeof envValue === 'string' &&
+              (mappingValue.endsWith('_BASE64') || convert === 'base64')
+            ) {
+              envValue = Buffer.from(envValue as string, 'base64').toString();
             }
             if (!parentKey) {
-              await this.kvStore.writeKey(key, envValue);
+              await this.kvStore.writeKey(key, envValue as any);
             } else {
               return envValue;
             }
@@ -118,6 +176,13 @@ export class AppData<T = any> {
       for (const key in this.options.envMapping) {
         await processEnvMapping(key as keyof T, this.options.envMapping[key]);
       }
+
+      if (this.options.overwriteObject) {
+        for (const key of Object.keys(this.options.overwriteObject)) {
+          console.log(`-> heads up: overwriting key ${key} from options.overwriteObject`);
+          await this.kvStore.writeKey(key as keyof T, this.options.overwriteObject[key]);
+        }
+      }
     }
 
     this.readyDeferred.resolve();
@@ -151,4 +216,4 @@ export class AppData<T = any> {
     await this.kvStore.waitForKeysPresent([keyArg]);
     return this.kvStore.readKey(keyArg);
   }
-}
+}

ts/npmextra.plugins.ts

@@ -1,3 +1,9 @@
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass
+}
+
 import * as qenv from '@push.rocks/qenv';
 import * as smartlog from '@push.rocks/smartlog';
 import * as path from 'path';