@lovrabet/cli-framework 1.0.2 → 1.0.3

package/lib/framework/output.d.ts

@@ -10,6 +10,8 @@
  * resolved from `JQ_PATH` or the system `PATH`.
  */
 import type { CommandResult, OutputFormat, Risk } from "./types.js";
+import { type JqBinaryResolverOptions } from "../utils/apply-jq-filter.js";
+import { type CliErrorsShape } from "../errors.js";
 /** Shared options passed through every internal print function. */
 interface OutputOptions {
     /** Full command label (e.g. `"api list"`). */
@@ -23,6 +25,15 @@ interface OutputOptions {
     /** Optional jq expression for post-filtering (json/compress modes only). */
     jqFilter?: string;
 }
+/**
+ * Options for constructing a CLI-specific output formatter.
+ */
+export interface CreateFormatOutputOptions {
+    /** Error factory used when jq execution fails. */
+    cliErrors?: Pick<CliErrorsShape, "validation">;
+    /** jq binary resolution strategy for this concrete CLI. */
+    jqBinaryResolverOptions?: JqBinaryResolverOptions;
+}
 /**
  * Central formatting entry point used by the runner adapter.
  *
@@ -41,5 +52,7 @@ interface OutputOptions {
  * formatOutput({ ok: true, data: { id: 1 } }, { command: "app list", risk: "read", format: "compress" });
  * ```
  */
-export declare function formatOutput<T>(result: CommandResult<T>, options: OutputOptions): void;
+export declare function createFormatOutput(options?: CreateFormatOutputOptions): <T>(result: CommandResult<T>, outputOptions: OutputOptions) => void;
+/** Default framework formatter using `JQ_PATH` / `PATH` resolution only. */
+export declare const formatOutput: <T>(result: CommandResult<T>, outputOptions: OutputOptions) => void;
 export {};

package/lib/framework/output.js

@@ -12,12 +12,12 @@
 import chalk from "chalk";
 import { createJqFilter } from "../utils/apply-jq-filter.js";
 import { createCliErrors } from "../errors.js";
-const applyJqFilter = createJqFilter(createCliErrors({
+const DEFAULT_CLI_ERRORS = createCliErrors({
     cliBinName: "cli",
     authRequiredHint: "",
     configMissingHint: "",
     notInProjectHint: "",
-}));
+});
 /**
  * Central formatting entry point used by the runner adapter.
  *
@@ -36,20 +36,25 @@ const applyJqFilter = createJqFilter(createCliErrors({
  * formatOutput({ ok: true, data: { id: 1 } }, { command: "app list", risk: "read", format: "compress" });
  * ```
  */
-export function formatOutput(result, options) {
-    switch (options.format) {
-        case "json":
-            printJson(result, options);
-            break;
-        case "compress":
-            printCompress(result, options);
-            break;
-        case "pretty":
-        default:
-            printPretty(result, options);
-            break;
-    }
+export function createFormatOutput(options = {}) {
+    const applyJqFilter = createJqFilter(options.cliErrors ?? DEFAULT_CLI_ERRORS, options.jqBinaryResolverOptions);
+    return function formatOutput(result, outputOptions) {
+        switch (outputOptions.format) {
+            case "json":
+                printJson(result, outputOptions, applyJqFilter);
+                break;
+            case "compress":
+                printCompress(result, outputOptions, applyJqFilter);
+                break;
+            case "pretty":
+            default:
+                printPretty(result, outputOptions);
+                break;
+        }
+    };
 }
+/** Default framework formatter using `JQ_PATH` / `PATH` resolution only. */
+export const formatOutput = createFormatOutput();
 /**
  * Wraps the command result in an {@link OutputEnvelope} by merging the
  * command metadata from `options` and the result data / error.
@@ -81,8 +86,8 @@ function buildEnvelope(result, options) {
  * @param result  - The command result to serialize.
  * @param options - Output options including jq filter.
  */
-function printJson(result, options) {
-    writeJsonWithOptionalJq(`${JSON.stringify(buildEnvelope(result, options), null, 2)}\n`, options);
+function printJson(result, options, applyJqFilter) {
+    writeJsonWithOptionalJq(`${JSON.stringify(buildEnvelope(result, options), null, 2)}\n`, options, applyJqFilter);
 }
 /**
  * Formats and prints the result as single-line (compact) JSON.
@@ -91,8 +96,8 @@ function printJson(result, options) {
  * @param result  - The command result to serialize.
  * @param options - Output options including jq filter.
  */
-function printCompress(result, options) {
-    writeJsonWithOptionalJq(`${JSON.stringify(buildEnvelope(result, options))}\n`, options);
+function printCompress(result, options, applyJqFilter) {
+    writeJsonWithOptionalJq(`${JSON.stringify(buildEnvelope(result, options))}\n`, options, applyJqFilter);
 }
 /**
  * Writes a JSON string to stdout, optionally piping it through `jq`.
@@ -100,7 +105,7 @@ function printCompress(result, options) {
  * @param jsonLine - Complete JSON line (must end with `\n`).
  * @param options  - Output options carrying the jq expression.
  */
-function writeJsonWithOptionalJq(jsonLine, options) {
+function writeJsonWithOptionalJq(jsonLine, options, applyJqFilter) {
     const expr = options.jqFilter?.trim();
     if (!expr) {
         process.stdout.write(jsonLine);

package/lib/index.d.ts

@@ -205,5 +205,12 @@ Paging,
  * @description List response wrapper with records and optional paging.
  */
 ListResponse, } from "./framework/response.js";
-export { formatOutput } from "./framework/output.js";
+export { createFormatOutput, formatOutput } from "./framework/output.js";
+export type { 
+/**
+ * @see ./framework/output.ts
+ * @description Options for constructing a CLI-specific output formatter.
+ */
+CreateFormatOutputOptions, } from "./framework/output.js";
+export { resolveBundledJqPaths } from "./utils/jq-sidecar.js";
 export { createJqFilter } from "./utils/apply-jq-filter.js";

package/lib/index.js

@@ -47,6 +47,8 @@ extractList,
 /** @see ./framework/response.ts */
 extractPaging, } from "./framework/response.js";
 // ─── Output Formatting ─────────────────────────────────────────────────────────
-export { formatOutput } from "./framework/output.js";
+export { createFormatOutput, formatOutput } from "./framework/output.js";
+// ─── Bundled jq Sidecar ────────────────────────────────────────────────────────
+export { resolveBundledJqPaths } from "./utils/jq-sidecar.js";
 // ─── JQ Filter ────────────────────────────────────────────────────────────────
 export { createJqFilter } from "./utils/apply-jq-filter.js";

package/lib/utils/jq-sidecar.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Resolves bundled jq candidate paths for the current runtime platform.
+ *
+ * The result is ordered from most preferred to least preferred. Callers should
+ * test the paths in order and use the first one that exists.
+ *
+ * @param platform - Node.js platform, defaults to `process.platform`.
+ * @param arch - Node.js architecture, defaults to `process.arch`.
+ * @returns Candidate absolute paths to bundled jq executables.
+ */
+export declare function resolveBundledJqPaths(platform?: NodeJS.Platform, arch?: NodeJS.Architecture): string[];

package/lib/utils/jq-sidecar.js

@@ -0,0 +1,28 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+/** Supported bundled jq targets keyed by `platform:arch`. */
+const JQ_TARGETS = {
+    "darwin:arm64": ["darwin-arm64", "darwin-x64"],
+    "darwin:x64": ["darwin-x64"],
+    "linux:arm64": ["linux-arm64"],
+    "linux:x64": ["linux-x64"],
+    "win32:arm64": ["win32-x64"],
+    "win32:x64": ["win32-x64"],
+};
+const CURRENT_FILE = fileURLToPath(import.meta.url);
+const PACKAGE_ROOT = path.resolve(path.dirname(CURRENT_FILE), "../..");
+const SIDECAR_ROOT = path.join(PACKAGE_ROOT, "sidecar", "jq");
+/**
+ * Resolves bundled jq candidate paths for the current runtime platform.
+ *
+ * The result is ordered from most preferred to least preferred. Callers should
+ * test the paths in order and use the first one that exists.
+ *
+ * @param platform - Node.js platform, defaults to `process.platform`.
+ * @param arch - Node.js architecture, defaults to `process.arch`.
+ * @returns Candidate absolute paths to bundled jq executables.
+ */
+export function resolveBundledJqPaths(platform = process.platform, arch = process.arch) {
+    const targetDirs = JQ_TARGETS[`${platform}:${arch}`] ?? [];
+    return targetDirs.map((dir) => path.join(SIDECAR_ROOT, dir, platform === "win32" ? "jq.exe" : "jq"));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/cli-framework",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -11,13 +11,15 @@
     }
   },
   "files": [
-    "lib"
+    "lib",
+    "sidecar"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "rm -rf lib && tsc && echo 'cli-framework build done'",
+    "update:jq-sidecar": "node scripts/update-jq-sidecar.mjs",
     "beta-release": "sh scripts/update-beta-version.sh && bun run build && git push && git push origin --tag && bun publish --tag beta",
     "release": "sh scripts/update-latest-version.sh && bun run build && git push && git push origin --tag && bun publish",
     "typecheck": "tsc --noEmit",
@@ -28,7 +30,7 @@
   },
   "devDependencies": {
     "@types/node": "^24.5.2",
-    "typescript": "latest",
+    "typescript": "5.9.3",
     "vitest": "^4.1.2"
   }
 }

package/sidecar/jq/README.md

@@ -0,0 +1,24 @@
+This directory vendors jq binaries that ship with `@lovrabet/cli-framework`.
+
+Consumer CLIs such as `@lovrabet/rabetbase-cli` and `@lovrabet/lovrabet-cli`
+resolve these binaries through the framework package.
+
+- Upstream project: `jqlang/jq`
+- Version: `jq-1.8.1`
+- License: `MIT`
+- Release source: `https://github.com/jqlang/jq/releases/tag/jq-1.8.1`
+
+Bundled targets:
+
+- `darwin-arm64/jq`
+- `darwin-x64/jq`
+- `linux-arm64/jq`
+- `linux-x64/jq`
+- `win32-x64/jq.exe`
+
+Update policy:
+
+1. Download binaries only from the official jq release assets.
+2. Keep file names stable (`jq` / `jq.exe`) so runtime resolution stays simple.
+3. Refresh the sidecar with `npm run update:jq-sidecar -- jq-<version>` when the bundled jq version changes.
+4. Update this README when the bundled jq version changes.