@gearbox-protocol/cli-utils 5.65.4 → 5.67.0

package/dist/Zommand.js

@@ -27,7 +27,7 @@ export class Zommand extends Command {
             throw new Error(`expected object schema, got ${this.#schema._zod.def.type}`);
         }
         if (configFile) {
-            let opt = new Option("--config [file]", "config file");
+            let opt = new Option("--config [file]", "config file (or s3 link");
             if (typeof configFile === "string") {
                 opt = opt.default(configFile);
             }

package/dist/resolveYamlFiles.d.ts

@@ -16,9 +16,17 @@ export declare function resolveYamlFiles(file: string, templateData?: TemplateDa
  * Merges yaml documents, respecting .extends references.
  * Optionally, performs env-style variable substitution on the config.
  * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ * Supports s3 links for file
  *
  * @param file
  * @param templateData
  * @returns
  */
 export declare function resolveYamlDoc(file: string, templateData?: TemplateData): Promise<YAML.Document>;
+/**
+ * Given file and a relative file path, returns full path of the relative file
+ * Supports s3 links for base file
+ * @param file
+ * @param relativeFile
+ */
+export declare function getRelativePath(baseFile: string, relativeFile: string): string;

package/dist/resolveYamlFiles.js

@@ -1,5 +1,6 @@
 import { readFile } from "node:fs/promises";
 import { dirname, resolve as pathResolve } from "node:path";
+import { GetObjectCommand, S3Client } from "@aws-sdk/client-s3";
 import YAML, { isPair, isScalar, isSeq } from "yaml";
 import getPromisePath from "./getPromisePath.js";
 /**
@@ -29,13 +30,14 @@ export async function resolveYamlFiles(file, templateData) {
  * Merges yaml documents, respecting .extends references.
  * Optionally, performs env-style variable substitution on the config.
  * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ * Supports s3 links for file
  *
  * @param file
  * @param templateData
  * @returns
  */
 export async function resolveYamlDoc(file, templateData) {
-    const content = await readFile(file, "utf-8");
+    const content = await loadFile(file);
     // if (templateData) {
     //   const compiled = template(content);
     //   content = compiled(templateData);
@@ -46,7 +48,7 @@ export async function resolveYamlDoc(file, templateData) {
         const baseFile = cfgRaw.get("extends");
         const extended = cfgRaw;
         // extends is a relative path to the base file
-        cfgRaw = await resolveYamlDoc(pathResolve(dirname(file), baseFile), templateData);
+        cfgRaw = await resolveYamlDoc(getRelativePath(file, baseFile), templateData);
         YAML.visit(extended, {
             Pair(_, pair, rawPath) {
                 const path = getNodesPath(rawPath);
@@ -88,3 +90,48 @@ function getNodesPath(nodes) {
     })
         .filter(Boolean);
 }
+/**
+ * Loads file from s3 or local file system
+ * @param file - s3 link or local file path
+ * @returns file content
+ */
+async function loadFile(file) {
+    if (file.startsWith("s3://")) {
+        return await loadS3File(file);
+    }
+    return await readFile(file, "utf-8");
+}
+/**
+ * Loads file from s3
+ * @param file - s3 link like s3://bucket/path/to/file.yaml
+ * @returns file content
+ */
+async function loadS3File(file) {
+    const url = new URL(file);
+    const bucket = url.hostname;
+    const key = url.pathname.slice(1);
+    const s3 = new S3Client({});
+    const response = await s3.send(new GetObjectCommand({
+        Bucket: bucket,
+        Key: key,
+    }));
+    if (!response.Body) {
+        throw new Error(`file ${file} not found`);
+    }
+    return response.Body.transformToString("utf-8");
+}
+/**
+ * Given file and a relative file path, returns full path of the relative file
+ * Supports s3 links for base file
+ * @param file
+ * @param relativeFile
+ */
+export function getRelativePath(baseFile, relativeFile) {
+    if (baseFile.startsWith("s3://")) {
+        const url = new URL(baseFile);
+        const relPathname = pathResolve(dirname(url.pathname), relativeFile);
+        url.pathname = relPathname;
+        return url.toString();
+    }
+    return pathResolve(dirname(baseFile), relativeFile);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "5.65.4",
+  "version": "5.67.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"
@@ -29,19 +29,20 @@
     "package:version": "yarn version"
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.964.0",
-    "@aws-sdk/client-ssm": "^3.964.0",
-    "@gearbox-protocol/sdk": ">=12.3.13",
+    "@aws-sdk/client-s3": "^3.968.0",
+    "@aws-sdk/client-secrets-manager": "^3.968.0",
+    "@aws-sdk/client-ssm": "^3.968.0",
+    "@gearbox-protocol/sdk": ">=12.3.16",
     "abitype": "^1.2.3",
     "commander": "^14.0.2",
     "lodash-es": "^4.17.22",
-    "viem": "^2.43.5",
+    "viem": "^2.44.2",
     "yaml": "^2.8.2",
     "zod": "^4.3.5"
   },
   "devDependencies": {
     "@commander-js/extra-typings": "^14.0.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^25.0.3"
+    "@types/node": "^25.0.8"
   }
 }