@gearbox-protocol/cli-utils 5.68.3 → 5.69.1

package/dist/Zommand.d.ts

@@ -13,6 +13,10 @@ export interface ZommandOptions<T extends z4.$ZodTypes> {
      * If value is string, it's used as default value for config file
      */
     configFile?: boolean | string;
+    /**
+     * If true, allows to pass config zlib compressed config as --inline-config=... or INLINE_CONFIG env var
+     */
+    inlineConfig?: boolean;
 }
 export declare class Zommand<T extends z4.$ZodTypes, Args extends any[] = []> extends Command<Args, z4.output<T>> {
     #private;

package/dist/Zommand.js

@@ -1,5 +1,6 @@
 import { Command, Option } from "@commander-js/extra-typings";
 import * as z4 from "zod/v4/core";
+import { decompressObject } from "./compressedConfig.js";
 import { resolveYamlFiles } from "./resolveYamlFiles.js";
 export const zommandRegistry = z4.registry();
 export class Zommand extends Command {
@@ -8,7 +9,7 @@ export class Zommand extends Command {
     #envToObjectKeys = {};
     constructor(name, opts) {
         super(name);
-        const { schema, templateData, configFile = true } = opts;
+        const { schema, templateData, configFile = true, inlineConfig = true, } = opts;
         this.#schema = schema;
         this.#templatedData = templateData;
         const def = this.#schema._zod.def;
@@ -33,6 +34,9 @@ export class Zommand extends Command {
             }
             this.addOption(opt);
         }
+        if (inlineConfig) {
+            this.addOption(new Option("--inline-config [config]", "inline config"));
+        }
     }
     #addOptionsFromObject(def) {
         const shape = def.shape;
@@ -59,7 +63,7 @@ export class Zommand extends Command {
         return super.action(async (...args) => {
             const argz = args;
             const _cmd = argz.splice(-1);
-            const [{ config, ...opts }] = argz.splice(-1);
+            const [{ config, inlineConfig, ...opts }] = argz.splice(-1);
             let fromYaml = {};
             if (config) {
                 fromYaml = await resolveYamlFiles(config, {
@@ -67,6 +71,13 @@ export class Zommand extends Command {
                     ...this.#templatedData,
                 });
             }
+            let fromInlineConfig = {};
+            if (inlineConfig) {
+                fromInlineConfig = await decompressObject(inlineConfig, this.#templatedData);
+            }
+            else if (process.env.INLINE_CONFIG) {
+                fromInlineConfig = await decompressObject(process.env.INLINE_CONFIG, this.#templatedData);
+            }
             const schemaFromEnv = {};
             for (const [env, key] of Object.entries(this.#envToObjectKeys)) {
                 if (process.env[env]) {
@@ -77,6 +88,7 @@ export class Zommand extends Command {
             const combined = {
                 ...schemaFromEnv,
                 ...fromYaml,
+                ...fromInlineConfig,
                 ...opts,
             };
             const data = z4.parse(this.#schema, combined);

package/dist/compressedConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Compress a plain JS object into a base64url string
+ * suitable for env vars.
+ */
+export declare function compressObject(obj: unknown): string;
+/**
+ * Decompress a base64url string back into a JS object
+ * Allows to pass template data to resolve promises/env
+ */
+export declare function decompressObject<T = unknown>(value: string, templateData?: Record<string, unknown>): Promise<T>;

package/dist/compressedConfig.js

@@ -0,0 +1,22 @@
+import { deflateSync, inflateSync } from "node:zlib";
+import { resolveFromObject } from "./resolveYamlFiles.js";
+/**
+ * Compress a plain JS object into a base64url string
+ * suitable for env vars.
+ */
+export function compressObject(obj) {
+    const json = JSON.stringify(obj);
+    const compressed = deflateSync(Buffer.from(json, "utf8"));
+    return compressed.toString("base64url");
+}
+/**
+ * Decompress a base64url string back into a JS object
+ * Allows to pass template data to resolve promises/env
+ */
+export async function decompressObject(value, templateData) {
+    const compressed = Buffer.from(value, "base64url");
+    const str = inflateSync(compressed).toString("utf8");
+    const json = JSON.parse(str);
+    const result = await resolveFromObject(json, templateData);
+    return result;
+}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./CensoredString.js";
 export * from "./CensoredURL.js";
+export * from "./compressedConfig.js";
 export * from "./createRevolverTransport.js";
 export * from "./notifications/index.js";
 export * from "./providers.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./CensoredString.js";
 export * from "./CensoredURL.js";
+export * from "./compressedConfig.js";
 export * from "./createRevolverTransport.js";
 export * from "./notifications/index.js";
 export * from "./providers.js";

package/dist/resolveYamlFiles.d.ts

@@ -23,6 +23,14 @@ export declare function resolveYamlFiles(file: string, templateData?: TemplateDa
  * @returns
  */
 export declare function resolveYamlDoc(file: string, templateData?: TemplateData): Promise<YAML.Document>;
+/**
+ * Helper function that gets object with templated values
+ * Just because async ast already exists in yaml, but not in json reviver
+ * @param json
+ * @param templateData
+ * @returns
+ */
+export declare function resolveFromObject(json: object, templateData?: TemplateData): Promise<object>;
 /**
  * Given file and a relative file path, returns full path of the relative file
  * Supports s3 links for base file

package/dist/resolveYamlFiles.js

@@ -80,6 +80,34 @@ export async function resolveYamlDoc(file, templateData) {
     });
     return cfgRaw;
 }
+/**
+ * Helper function that gets object with templated values
+ * Just because async ast already exists in yaml, but not in json reviver
+ * @param json
+ * @param templateData
+ * @returns
+ */
+export async function resolveFromObject(json, templateData) {
+    const content = YAML.stringify(json);
+    const cfgRaw = YAML.parseDocument(content, { merge: true });
+    await YAML.visitAsync(cfgRaw, {
+        Scalar: async (_, node) => {
+            if (typeof node.value === "string") {
+                let val = node.value;
+                const matches = val.matchAll(templateKeyRegex);
+                for (const match of matches) {
+                    const templateKey = match[0].slice(2, -1);
+                    const templateValue = await getPromisePath(templateData, templateKey);
+                    if (templateValue) {
+                        val = val.replace(match[0], templateValue);
+                    }
+                }
+                node.value = val;
+            }
+        },
+    });
+    return cfgRaw.toJSON();
+}
 function getNodesPath(nodes) {
     return nodes
         .map(n => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "5.68.3",
+  "version": "5.69.1",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"