@ironbee-ai/cli 0.11.4 → 0.13.0

package/dist/tui/config/introspect.js

@@ -0,0 +1,93 @@
+"use strict";
+/**
+ * IronBee — Config TUI: layer introspection
+ *
+ * For a given dotted key, resolves what each of the three config layers
+ * (global / project / local) holds, what the merged effective value is, which
+ * layer that effective value comes from, and whether a live env-var override
+ * shadows the file layers. This is the read model the detail pane renders.
+ *
+ * Reads only the already-public lib surface (`loadConfig`, `getConfigLayerPaths`,
+ * `findActiveEnvOverride`) so the TUI stays decoupled from the command layer.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadLayers = loadLayers;
+exports.introspectKey = introspectKey;
+const fs_1 = require("fs");
+const config_1 = require("../../lib/config");
+const value_1 = require("./value");
+function readLayerFile(filePath) {
+    if (filePath === undefined || !(0, fs_1.existsSync)(filePath)) {
+        return {};
+    }
+    try {
+        const raw = (0, fs_1.readFileSync)(filePath, "utf-8");
+        if (raw.trim().length === 0) {
+            return {};
+        }
+        const parsed = JSON.parse(raw);
+        if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+            return {};
+        }
+        return parsed;
+    }
+    catch {
+        return {};
+    }
+}
+/** Reads all three layer files + the merged config in one pass. */
+function loadLayers(projectDir) {
+    const paths = (0, config_1.getConfigLayerPaths)(projectDir);
+    return {
+        globalPath: paths.global,
+        projectPath: paths.project,
+        localPath: paths.local,
+        global: readLayerFile(paths.global),
+        project: readLayerFile(paths.project),
+        local: readLayerFile(paths.local),
+        merged: (0, config_1.loadConfig)(projectDir),
+    };
+}
+function resolveEnvOverride(path) {
+    const override = (0, config_1.findActiveEnvOverride)(path);
+    if (override === undefined) {
+        return undefined;
+    }
+    const raw = process.env[override.envVar] ?? "";
+    const value = override.coerce ? override.coerce(raw) : raw;
+    return { envVar: override.envVar, value };
+}
+/** Builds the read model for one key from already-loaded layers. */
+function introspectKey(path, layers) {
+    const layerValues = [
+        { layer: "global", present: (0, value_1.hasAtPath)(layers.global, path), value: (0, value_1.getAtPath)(layers.global, path), filePath: layers.globalPath },
+        { layer: "project", present: (0, value_1.hasAtPath)(layers.project, path), value: (0, value_1.getAtPath)(layers.project, path), filePath: layers.projectPath },
+        { layer: "local", present: (0, value_1.hasAtPath)(layers.local, path), value: (0, value_1.getAtPath)(layers.local, path), filePath: layers.localPath },
+    ];
+    const envOverride = resolveEnvOverride(path);
+    const merged = (0, value_1.getAtPath)(layers.merged, path);
+    let effective;
+    if (envOverride !== undefined) {
+        effective = "env";
+    }
+    else {
+        // High → low precedence: local > project > global.
+        const local = layerValues[2];
+        const project = layerValues[1];
+        const global = layerValues[0];
+        if (local.present) {
+            effective = "local";
+        }
+        else if (project.present) {
+            effective = "project";
+        }
+        else if (global.present) {
+            effective = "global";
+        }
+        else {
+            effective = "none";
+        }
+    }
+    return { path, layers: layerValues, envOverride, merged, effective };
+}
+//# sourceMappingURL=introspect.js.map

package/dist/tui/config/introspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.js","sourceRoot":"","sources":["../../../src/tui/config/introspect.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;AA+EH,gCAYC;AAaD,sCA8BC;AApID,2BAA8C;AAC9C,6CAM0B;AAC1B,mCAA+C;AAiD/C,SAAS,aAAa,CAAC,QAA4B;IAC/C,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACd,CAAC;IACD,IAAI,CAAC;QACD,MAAM,GAAG,GAAW,IAAA,iBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACzE,OAAO,EAAE,CAAC;QACd,CAAC;QACD,OAAO,MAAiC,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC;AAED,mEAAmE;AACnE,SAAgB,UAAU,CAAC,UAAmB;IAC1C,MAAM,KAAK,GACP,IAAA,4BAAmB,EAAC,UAAU,CAAC,CAAC;IACpC,OAAO;QACH,UAAU,EAAE,KAAK,CAAC,MAAM;QACxB,WAAW,EAAE,KAAK,CAAC,OAAO;QAC1B,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;QACnC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;QACrC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;QACjC,MAAM,EAAE,IAAA,mBAAU,EAAC,UAAU,CAAC;KACjC,CAAC;AACN,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACpC,MAAM,QAAQ,GAA4B,IAAA,8BAAqB,EAAC,IAAI,CAAC,CAAC;IACtE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,GAAG,GAAW,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACvD,MAAM,KAAK,GAAY,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;AAC9C,CAAC;AAED,oEAAoE;AACpE,SAAgB,aAAa,CAAC,IAAY,EAAE,MAAoB;IAC5D,MAAM,WAAW,GAAiB;QAC9B,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE;QAChI,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,WAAW,EAAE;QACpI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE;KAC/H,CAAC;IAEF,MAAM,WAAW,GAAiC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAY,IAAA,iBAAS,EAAC,MAAM,CAAC,MAAiC,EAAE,IAAI,CAAC,CAAC;IAElF,IAAI,SAA0B,CAAC;IAC/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,SAAS,GAAG,KAAK,CAAC;IACtB,CAAC;SAAM,CAAC;QACJ,mDAAmD;QACnD,MAAM,KAAK,GAAe,WAAW,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,OAAO,GAAe,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAe,WAAW,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,SAAS,GAAG,OAAO,CAAC;QACxB,CAAC;aAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACzB,SAAS,GAAG,SAAS,CAAC;QAC1B,CAAC;aAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,SAAS,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,CAAC;YACJ,SAAS,GAAG,MAAM,CAAC;QACvB,CAAC;IACL,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACzE,CAAC"}

package/dist/tui/config/schema.d.ts

@@ -0,0 +1,81 @@
+/**
+ * IronBee — Config TUI: canonical config-key schema
+ *
+ * Single source of truth for every config key the TUI knows about. Each
+ * entry carries the metadata the TUI needs to render and edit a key:
+ *   - `path`              — dotted key (e.g. `collector.url`). The list/docs
+ *                           group is DERIVED from its first segment ({@link groupOf}).
+ *   - `type`              — value shape (drives validation hints)
+ *   - `editor`            — which edit affordance the TUI offers
+ *   - `description`       — concise one-paragraph explanation (shown in detail)
+ *   - `def`              — human-readable default (display only)
+ *   - `enumValues?`       — allowed values for `enum` editor
+ *   - `artifactAffecting` — whether changing it requires re-rendering installed
+ *                           client artifacts (hooks / MCP / skill-rule md /
+ *                           permissions). Mirrors `ARTIFACT_AFFECTING_TOP_KEYS`
+ *                           in `src/commands/config.ts` — kept here so the TUI
+ *                           stays self-contained (no import from the command
+ *                           layer). A consistency test asserts the two agree.
+ *
+ * This module has ZERO runtime dependencies on the rest of the codebase so it
+ * can be unit-tested in isolation and imported from anywhere.
+ */
+/** Coarse value shape for a config key. */
+export type ConfigValueType = "boolean" | "number" | "string" | "string-array" | "json";
+/** Which edit affordance the TUI offers for a key. */
+export type ConfigEditorKind = "toggle" | "number" | "text" | "enum" | "string-list" | "json";
+/** One config key's metadata. */
+export interface ConfigSchemaEntry {
+    path: string;
+    type: ConfigValueType;
+    editor: ConfigEditorKind;
+    description: string;
+    def: string;
+    enumValues?: string[];
+    artifactAffecting: boolean;
+}
+/**
+ * Top-level keys whose change requires re-rendering installed client
+ * artifacts. Mirrors `ARTIFACT_AFFECTING_TOP_KEYS` in `src/commands/config.ts`.
+ * Duplicated (not imported) to keep this module decoupled from the command
+ * layer; `tests/unit/tui/config-schema.test.ts` asserts every schema entry's
+ * `artifactAffecting` flag matches membership here.
+ */
+export declare const ARTIFACT_AFFECTING_TOP_KEYS: ReadonlySet<string>;
+/**
+ * Display order of groups in the list pane. Group MEMBERSHIP is derived from
+ * each key's first dot-segment ({@link groupOf}) — this list only controls the
+ * ORDER they appear in (and which trailing groups are "known"). Unknown groups
+ * (a future top segment not listed here) sort after these, alphabetically.
+ */
+export declare const GROUP_ORDER: readonly string[];
+/** Human-readable section headings, keyed by group (= first path segment). */
+export declare const GROUP_TITLES: Record<string, string>;
+/** Top-level segment of a dotted path. */
+export declare function topKey(dotPath: string): string;
+/**
+ * The group a key belongs to — its first dot-segment, or `"general"` for
+ * top-level (dot-less) keys like `maxRetries` / `ignoredVerifyPatterns`. This
+ * is the single, data-driven grouping used by the TUI list and the docs table;
+ * there is no hand-maintained group field to drift.
+ */
+export declare function groupOf(path: string): string;
+/** Display title for a group, falling back to the raw group name. */
+export declare function groupTitle(group: string): string;
+/** Sort rank for a group per {@link GROUP_ORDER}; unknown groups sort last. */
+export declare function groupRank(group: string): number;
+/**
+ * The canonical config-key registry. Adding a config key to IronBee should be
+ * accompanied by an entry here — the schema test fails loudly otherwise, which
+ * is the canonical-source guarantee.
+ */
+export declare const CONFIG_SCHEMA: ConfigSchemaEntry[];
+/** Returns the schema entry for a dotted path, or undefined when unknown. */
+export declare function findSchemaEntry(path: string): ConfigSchemaEntry | undefined;
+/**
+ * Returns all schema entries sorted by group display order (per {@link groupRank},
+ * group derived via {@link groupOf}) then path. This is the canonical ordering
+ * the TUI list pane and the docs table render.
+ */
+export declare function orderedEntries(): ConfigSchemaEntry[];
+//# sourceMappingURL=schema.d.ts.map

package/dist/tui/config/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/tui/config/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,2CAA2C;AAC3C,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,MAAM,CAAC;AAExF,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;AAE9F,iCAAiC;AACjC,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,EAAE,WAAW,CAAC,MAAM,CAW1D,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS,MAAM,EAiB/B,CAAC;AAEX,8EAA8E;AAC9E,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAiB/C,CAAC;AAEF,0CAA0C;AAC1C,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAG9C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED,qEAAqE;AACrE,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,+EAA+E;AAC/E,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAG/C;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,iBAAiB,EAoZ5C,CAAC;AAEF,6EAA6E;AAC7E,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,iBAAiB,EAAE,CASpD"}