@gearbox-protocol/cli-utils 5.34.0 → 5.35.0

package/dist/SSMManager.d.ts

@@ -0,0 +1,5 @@
+export declare class SSMManager {
+    #private;
+    parameter(name: string): Promise<string>;
+}
+export declare const ssmManagerProxy: (mgr?: SSMManager) => Record<string, Promise<string>>;

package/dist/SSMManager.js

@@ -0,0 +1,32 @@
+import { GetParameterCommand, SSMClient } from "@aws-sdk/client-ssm";
+export class SSMManager {
+    #ssmClient;
+    #parameters = new Map();
+    async parameter(name) {
+        if (this.#parameters.has(name)) {
+            return this.#parameters.get(name);
+        }
+        if (!this.#ssmClient) {
+            this.#ssmClient = new SSMClient({});
+        }
+        const response = await this.#ssmClient.send(new GetParameterCommand({
+            Name: name,
+        }));
+        const value = response.Parameter?.Value;
+        if (!value) {
+            throw new Error(`parameter ${name} value not found`);
+        }
+        this.#parameters.set(name, value);
+        return value;
+    }
+}
+export const ssmManagerProxy = (mgr) => new Proxy(mgr ?? new SSMManager(), {
+    get(target, prop) {
+        if (prop === "parameter") {
+            return undefined;
+        }
+        if (typeof prop === "string") {
+            return target.parameter(prop);
+        }
+    },
+});

package/dist/SecretsManager.d.ts

@@ -0,0 +1,6 @@
+export declare class SecretsManager {
+    #private;
+    secret(key: string): Promise<string>;
+    secretRaw(key: string): Promise<unknown>;
+}
+export declare const secretsManagerProxy: (mgr?: SecretsManager) => Record<string, Promise<string | object>>;

package/dist/SecretsManager.js

@@ -0,0 +1,54 @@
+import { GetSecretValueCommand, SecretsManagerClient, } from "@aws-sdk/client-secrets-manager";
+export class SecretsManager {
+    #smClient;
+    #secrets = new Map();
+    async secret(key) {
+        const [SecretId, ...jsonPath] = key.split(".");
+        const secretStr = await this.#getSecret(SecretId);
+        if (!jsonPath.length) {
+            return secretStr;
+        }
+        let v = JSON.parse(secretStr);
+        for (const p of jsonPath) {
+            v = v[p];
+        }
+        if (!v || typeof v !== "string") {
+            throw new Error(`cannot find secret '${key}'`);
+        }
+        return v;
+    }
+    async secretRaw(key) {
+        const val = await this.#getSecret(key);
+        try {
+            return JSON.parse(val);
+        }
+        catch {
+            return val;
+        }
+    }
+    async #getSecret(SecretId) {
+        if (this.#secrets.has(SecretId)) {
+            return this.#secrets.get(SecretId);
+        }
+        if (!this.#smClient) {
+            this.#smClient = new SecretsManagerClient({});
+        }
+        // https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/GetParameterCommand/
+        const { SecretString } = await this.#smClient.send(new GetSecretValueCommand({ SecretId }));
+        if (!SecretString) {
+            throw new Error(`secret '${SecretId}' not found`);
+        }
+        this.#secrets.set(SecretId, SecretString);
+        return SecretString;
+    }
+}
+export const secretsManagerProxy = (mgr) => new Proxy(mgr ?? new SecretsManager(), {
+    get(target, prop) {
+        if (prop === "secret" || prop === "secretRaw") {
+            return undefined;
+        }
+        if (typeof prop === "string") {
+            return target.secretRaw(prop);
+        }
+    },
+});

package/dist/getPromisePath.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Similar to lodash.get, but supports promises
+ * @param object
+ * @param keys
+ * @returns
+ */
+export default function getPromisePath<V = any>(object: any, path: string): Promise<V>;

package/dist/getPromisePath.js

@@ -0,0 +1,17 @@
+/**
+ * Similar to lodash.get, but supports promises
+ * @param object
+ * @param keys
+ * @returns
+ */
+export default async function getPromisePath(object, path) {
+    return getPromised(object, path.split("."));
+}
+function getPromised(object, keys) {
+    if (keys.length === 0) {
+        return Promise.resolve(object);
+    }
+    const [key, ...rest] = keys;
+    const value = object[key];
+    return Promise.resolve(value).then(v => getPromised(v, rest));
+}

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./CensoredString.js";
 export * from "./resolveYamlFiles.js";
 export * from "./schema-primitives.js";
+export * from "./SecretsManager.js";
+export * from "./SSMManager.js";
 export * from "./Zommand.js";

package/dist/index.js

@@ -1,4 +1,6 @@
 export * from "./CensoredString.js";
 export * from "./resolveYamlFiles.js";
 export * from "./schema-primitives.js";
+export * from "./SecretsManager.js";
+export * from "./SSMManager.js";
 export * from "./Zommand.js";

package/dist/resolveYamlFiles.d.ts

@@ -1,4 +1,5 @@
 import YAML from "yaml";
+export type TemplateData = Record<string, any>;
 /**
  * Merges yaml files, respecting .extends references.
  * Performs env variable substitution on the config.
@@ -10,7 +11,7 @@ import YAML from "yaml";
  * @param templateData
  * @returns
  */
-export declare function resolveYamlFiles(file: string, templateData?: Record<string, string>): Promise<object>;
+export declare function resolveYamlFiles(file: string, templateData?: TemplateData): Promise<object>;
 /**
  * Merges yaml documents, respecting .extends references.
  * Optionally, performs env-style variable substitution on the config.
@@ -20,4 +21,4 @@ export declare function resolveYamlFiles(file: string, templateData?: Record<str
  * @param templateData
  * @returns
  */
-export declare function resolveYamlDoc(file: string, templateData?: Record<string, string>): Promise<YAML.Document>;
+export declare function resolveYamlDoc(file: string, templateData?: TemplateData): Promise<YAML.Document>;

package/dist/resolveYamlFiles.js

@@ -1,7 +1,14 @@
 import { readFile } from "node:fs/promises";
 import { dirname, resolve as pathResolve } from "node:path";
-import { template } from "lodash-es";
 import YAML, { isPair, isScalar, isSeq } from "yaml";
+import getPromisePath from "./getPromisePath.js";
+/**
+ * Template key regexp
+ * Consists of alphanumeric+underscore parts separated by dots, all wrappped in env-style brackets
+ * e.g. ${KEY} or ${KEY.SUBKEY}
+ *
+ */
+const templateKeyRegex = /^\$\{(?:\w+(?:\.\w+)*)\}$/;
 /**
  * Merges yaml files, respecting .extends references.
  * Performs env variable substitution on the config.
@@ -29,10 +36,10 @@ export async function resolveYamlFiles(file, templateData) {
  */
 export async function resolveYamlDoc(file, templateData) {
     let content = await readFile(file, "utf-8");
-    if (templateData) {
-        const compiled = template(content);
-        content = compiled(templateData);
-    }
+    // if (templateData) {
+    //   const compiled = template(content);
+    //   content = compiled(templateData);
+    // }
     let cfgRaw = YAML.parseDocument(content, { merge: true });
     // let cfgRaw = YAML.parse(content, { merge: true });
     if (cfgRaw.has("extends")) {
@@ -53,6 +60,17 @@ export async function resolveYamlDoc(file, templateData) {
             },
         });
     }
+    await YAML.visitAsync(cfgRaw, {
+        Scalar: async (_, node) => {
+            if (typeof node.value === "string" && templateKeyRegex.test(node.value)) {
+                const templateKey = node.value.slice(2, -1);
+                const templateValue = getPromisePath(templateData, templateKey);
+                if (templateValue) {
+                    node.value = await Promise.resolve(templateValue);
+                }
+            }
+        },
+    });
     return cfgRaw;
 }
 function getNodesPath(nodes) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "5.34.0",
+  "version": "5.35.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"
@@ -33,6 +33,8 @@
     "package:version": "yarn version"
   },
   "dependencies": {
+    "@aws-sdk/client-secrets-manager": "^3.823.0",
+    "@aws-sdk/client-ssm": "^3.823.0",
     "abitype": "^1.0.8",
     "commander": "^14.0.0",
     "lodash-es": "^4.17.21",