6.0.3

.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/qenv",
-  "version": "6.0.0",
+  "version": "6.0.3",
   "private": false,
   "description": "easy promised environments",
   "main": "dist_ts/index.js",
@@ -27,15 +27,16 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.77",
-    "@push.rocks/tapbundle": "^5.0.12",
-    "@types/node": "^20.4.6"
+    "@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.8.7"
   },
   "dependencies": {
-    "@configvault.io/interfaces": "^1.0.2",
-    "@push.rocks/smartfile": "^10.0.28",
+    "@api.global/typedrequest": "^3.0.1",
+    "@configvault.io/interfaces": "^1.0.13",
+    "@push.rocks/smartfile": "^10.0.33",
     "@push.rocks/smartlog": "^3.0.3",
     "@push.rocks/smartpath": "^5.0.11"
   },

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/qenv',
-  version: '6.0.0',
+  version: '6.0.3',
   description: 'easy promised environments'
 }

ts/qenv.classes.configvaultadapter.ts

@@ -0,0 +1,30 @@
+import * as plugins from './qenv.plugins.js';
+
+export class ConfigVaultAdapter {
+  public configVaultUrl: string;
+  
+  constructor(configVaultUrl?: string) {
+    this.configVaultUrl = configVaultUrl;
+  }
+
+  public async getConfigBundle(): Promise<plugins.configvaultInterfaces.data.IConfigBundle> {
+    if (this.configVaultUrl) {
+      console.log(`ConfigVault specified through constructor`)
+    } else if (process.env['CONFIGVAULT_URL']) {
+      this.configVaultUrl = process.env['CONFIGVAULT_URL'];
+    } else {
+      return null;
+    }
+
+    const parsedUrl = new URL(this.configVaultUrl);
+
+    const tr =
+      new plugins.typedrequest.TypedRequest<plugins.configvaultInterfaces.requests.IReq_GetEnvBundle>(
+        `${parsedUrl.host}/typedrequest`,
+        'getEnvBundle'
+      );
+    const response = await tr.fire({
+      authorization: parsedUrl.pathname.replace('/', ''),
+    })
+  }
+}

ts/qenv.classes.qenv.ts

@@ -1,5 +1,8 @@
+import { ConfigVaultAdapter } from './qenv.classes.configvaultadapter.js';
 import * as plugins from './qenv.plugins.js';
 
+export type TEnvVarRef = string | (() => Promise<string>);
+
 export class Qenv {
   public requiredEnvVars: string[] = [];
   public availableEnvVars: string[] = [];
@@ -7,6 +10,8 @@ export class Qenv {
   public keyValueObject: { [key: string]: any } = {};
   public logger = new plugins.smartlog.ConsoleLog();
 
+  public configVaultAdapter: ConfigVaultAdapter;
+
   public qenvFilePathAbsolute: string;
   public envFilePathAbsolute: string;
 
@@ -15,6 +20,7 @@ export class Qenv {
     envFileBasePathArg: string,
     failOnMissing: boolean = true
   ) {
+    this.configVaultAdapter = new ConfigVaultAdapter();
     this.initializeFilePaths(qenvFileBasePathArg, envFileBasePathArg);
     this.loadRequiredEnvVars();
     this.loadAvailableEnvVars();
@@ -22,8 +28,14 @@ export class Qenv {
   }
 
   private initializeFilePaths(qenvFileBasePathArg: string, envFileBasePathArg: string) {
-    this.qenvFilePathAbsolute = plugins.path.join(plugins.path.resolve(qenvFileBasePathArg), 'qenv.yml');
-    this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.json');
+    this.qenvFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(qenvFileBasePathArg),
+      'qenv.yml'
+    );
+    this.envFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(envFileBasePathArg),
+      'env.json'
+    );
   }
 
   private loadRequiredEnvVars() {
@@ -48,7 +60,9 @@ export class Qenv {
   }
 
   private checkForMissingEnvVars(failOnMissing: boolean) {
-    this.missingEnvVars = this.requiredEnvVars.filter((envVar) => !this.availableEnvVars.includes(envVar));
+    this.missingEnvVars = this.requiredEnvVars.filter(
+      (envVar) => !this.availableEnvVars.includes(envVar)
+    );
 
     if (this.missingEnvVars.length > 0) {
       console.info('Required Env Vars are:', this.requiredEnvVars);
@@ -62,27 +76,40 @@ export class Qenv {
     }
   }
 
-  public async getEnvVarOnDemand(envVarName: string): Promise<string | undefined> {
-    return (
-      this.getFromEnvironmentVariable(envVarName) ||
-      this.getFromEnvJsonFile(envVarName) ||
-      this.getFromDockerSecret(envVarName) ||
-      this.getFromDockerSecretJson(envVarName)
-    );
+  public async getEnvVarOnDemand(
+    envVarNameOrNames: TEnvVarRef | TEnvVarRef[]
+  ): Promise<string | undefined> {
+    if (Array.isArray(envVarNameOrNames)) {
+      for (const envVarName of envVarNameOrNames) {
+        const value = await this.tryGetEnvVar(envVarName);
+        if (value) {
+          return value;
+        }
+      }
+      return undefined;
+    } else {
+      return await this.tryGetEnvVar(envVarNameOrNames);
+    }
   }
 
-  public async getEnvVarOnDemandSync(envVarName: string): Promise<string | undefined> {
+  public getEnvVarOnDemandSync(envVarNameOrNames: string | string[]): string | undefined {
     console.warn('requesting env var sync leaves out potentially important async env sources.');
-    return (
-      this.getFromEnvironmentVariable(envVarName) ||
-      this.getFromEnvJsonFile(envVarName) ||
-      this.getFromDockerSecret(envVarName) ||
-      this.getFromDockerSecretJson(envVarName)
-    );
+
+    if (Array.isArray(envVarNameOrNames)) {
+      for (const envVarName of envVarNameOrNames) {
+        const value = this.tryGetEnvVarSync(envVarName);
+        if (value) {
+          return value;
+        }
+      }
+      return undefined;
+    } else {
+      return this.tryGetEnvVarSync(envVarNameOrNames);
+    }
   }
 
-  public async getEnvVarOnDemandAsObject(envVarName: string): Promise<any> {
-    const rawValue = await this.getEnvVarOnDemand(envVarName);
+  public async getEnvVarOnDemandAsObject(envVarNameOrNames: string | string[]): Promise<any> {
+    const rawValue = await this.getEnvVarOnDemand(envVarNameOrNames);
     if (rawValue && rawValue.startsWith('base64Object:')) {
       const base64Part = rawValue.split('base64Object:')[1];
       return this.decodeBase64(base64Part);
@@ -90,6 +117,28 @@ export class Qenv {
     return rawValue;
   }
 
+  private async tryGetEnvVar(envVarRefArg: TEnvVarRef): Promise<string | undefined> {
+    if (typeof envVarRefArg === 'function') {
+      return await envVarRefArg();
+    }
+
+    return (
+      this.getFromEnvironmentVariable(envVarRefArg) ||
+      this.getFromEnvJsonFile(envVarRefArg) ||
+      this.getFromDockerSecret(envVarRefArg) ||
+      this.getFromDockerSecretJson(envVarRefArg)
+    );
+  }
+
+  private tryGetEnvVarSync(envVarName: string): string | undefined {
+    return (
+      this.getFromEnvironmentVariable(envVarName) ||
+      this.getFromEnvJsonFile(envVarName) ||
+      this.getFromDockerSecret(envVarName) ||
+      this.getFromDockerSecretJson(envVarName)
+    );
+  }
+
   private getFromEnvironmentVariable(envVarName: string): string | undefined {
     return process.env[envVarName];
   }

ts/qenv.plugins.ts

@@ -3,8 +3,20 @@ import * as path from 'path';
 
 export { path };
 
+// @api.global scope
+import * as typedrequest from '@api.global/typedrequest';
+
+export {
+  typedrequest,
+}
+
 // @pushrocks scope
 import * as smartfile from '@push.rocks/smartfile';
 import * as smartlog from '@push.rocks/smartlog';
 
 export { smartfile, smartlog };
+
+// @configvault.io scope
+import * as configvaultInterfaces from '@configvault.io/interfaces';
+
+export { configvaultInterfaces };