akm-cli 0.7.4 → 0.8.0-rc.3

package/dist/output/shapes.js

@@ -6,6 +6,70 @@
  * `Record<string, unknown>` shapes, which makes them trivial to unit test.
  */
 const NORMAL_DESCRIPTION_LIMIT = 250;
+const PASSTHROUGH_COMMANDS = new Set([
+    "add",
+    "agent-result",
+    "clone",
+    "config",
+    "consolidate",
+    "curate",
+    "disable",
+    "enable",
+    "feedback",
+    "graph-entities",
+    "graph-export",
+    "graph-related",
+    "graph-relations",
+    "graph-summary",
+    "health",
+    "import",
+    "improve",
+    "index",
+    "info",
+    "init",
+    "lint",
+    "list",
+    "registry-add",
+    "registry-build-index",
+    "registry-list",
+    "registry-remove",
+    "remember",
+    "remove",
+    "save",
+    "setup",
+    "tasks-add",
+    "tasks-disable",
+    "tasks-doctor",
+    "tasks-enable",
+    "tasks-history",
+    "tasks-list",
+    "tasks-remove",
+    "tasks-run",
+    "tasks-show",
+    "tasks-sync",
+    "update",
+    "upgrade",
+    "vault-create",
+    "vault-set",
+    "vault-unset",
+    "wiki-create",
+    "wiki-ingest",
+    "wiki-lint",
+    "wiki-list",
+    "wiki-pages",
+    "wiki-register",
+    "wiki-remove",
+    "wiki-show",
+    "wiki-stash",
+    "workflow-complete",
+    "workflow-create",
+    "workflow-list",
+    "workflow-next",
+    "workflow-resume",
+    "workflow-start",
+    "workflow-status",
+    "workflow-validate",
+]);
 export function shapeForCommand(command, result, detail, forAgent = false) {
     switch (command) {
         case "search":
@@ -45,66 +109,31 @@ export function shapeForCommand(command, result, detail, forAgent = false) {
         case "reflect":
         case "propose":
             return shapeProposalProducerOutput(result, detail);
-        // Output shape registration for `akm distill <ref>` (#228). The shape is
-        // simple — outcome + ids + optional payload — so `brief` strips the full
-        // proposal blob, `normal` keeps the headline fields, and `full` projects
-        // everything for downstream automation.
         case "distill":
             return shapeDistillOutput(result, detail);
-        // Identity-passthrough commands — registered here so the registry stays
-        // exhaustive (v1 spec §9). Each result object is already shaped at the
-        // command boundary; the registry just confirms there's no surprise
-        // command name slipping through.
-        case "add":
-        case "clone":
-        case "config":
-        case "curate":
-        case "disable":
-        case "enable":
-        case "feedback":
-        case "import":
-        case "index":
-        case "info":
-        case "init":
-        case "list":
-        case "registry-add":
-        case "registry-build-index":
-        case "registry-list":
-        case "registry-remove":
-        case "remember":
-        case "remove":
-        case "save":
-        case "update":
-        case "upgrade":
-        case "vault-create":
-        case "vault-list":
-        case "vault-set":
-        case "vault-unset":
-        case "wiki-create":
-        case "wiki-ingest":
-        case "wiki-lint":
-        case "wiki-list":
-        case "wiki-pages":
-        case "wiki-register":
-        case "wiki-remove":
-        case "wiki-show":
-        case "wiki-stash":
-        case "workflow-complete":
-        case "workflow-create":
-        case "workflow-list":
-        case "workflow-next":
-        case "workflow-resume":
-        case "workflow-start":
-        case "workflow-status":
-        case "workflow-validate":
-            return result;
+        case "vault-list": {
+            const r = result;
+            const vaults = Array.isArray(r.vaults) ? r.vaults : [];
+            return {
+                ...r,
+                vaults: vaults.map((v) => {
+                    const { path: _path, ...rest } = v;
+                    return rest;
+                }),
+            };
+        }
         default:
-            // v1 spec §9 (output-shape registry exhaustive): no silent JSON.stringify
-            // fallback. A missing case here is a registration bug — fail loudly so
-            // the caller (or its tests) sees the missing command name.
+            // v1 spec §9 (output-shape registry exhaustive): identity-passthrough
+            // commands are listed in PASSTHROUGH_COMMANDS; anything not in that set
+            // is a registration bug — fail loudly.
+            if (PASSTHROUGH_COMMANDS.has(command))
+                return result;
             throw new Error(`output shape not registered for command: ${command}`);
     }
 }
+function maybeAddSchema(base, detail, version) {
+    return detail === "full" ? { schemaVersion: version ?? 1, ...base } : base;
+}
 /**
  * Shape the result of `akm reflect` / `akm propose`. On success we surface
  * the queued proposal entry (using the standard proposal-entry shaper so
@@ -141,10 +170,7 @@ export function shapeProposalProducerOutput(result, detail) {
         ...(typeof result.durationMs === "number" ? { durationMs: result.durationMs } : {}),
         proposal: shapeProposalEntry(proposal, detail === "brief" ? "normal" : detail),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeProposalEntry(entry, detail) {
     if (detail === "brief") {
@@ -173,10 +199,7 @@ export function shapeProposalListOutput(result, detail) {
         totalCount: result.totalCount ?? shaped.length,
         proposals: shaped,
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeProposalShowOutput(result, detail) {
     const proposal = result.proposal ?? {};
@@ -185,10 +208,7 @@ export function shapeProposalShowOutput(result, detail) {
         proposal: shapeProposalEntry(proposal, detail === "brief" ? "normal" : detail),
         ...(validation ? { validation } : {}),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeProposalAcceptOutput(result, detail) {
     const proposal = result.proposal ?? {};
@@ -199,10 +219,7 @@ export function shapeProposalAcceptOutput(result, detail) {
         assetPath: result.assetPath,
         proposal: shapeProposalEntry(proposal, detail === "brief" ? "normal" : detail),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeProposalRejectOutput(result, detail) {
     const proposal = result.proposal ?? {};
@@ -213,10 +230,7 @@ export function shapeProposalRejectOutput(result, detail) {
         ...(result.reason !== undefined ? { reason: result.reason } : {}),
         proposal: shapeProposalEntry(proposal, detail === "brief" ? "normal" : detail),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeDistillOutput(result, detail) {
     const proposal = result.proposal;
@@ -233,10 +247,7 @@ export function shapeDistillOutput(result, detail) {
         ...(Array.isArray(result.findings) && result.findings.length > 0 ? { findings: result.findings } : {}),
         ...(proposal ? { proposal: shapeProposalEntry(proposal, detail === "summary" ? "normal" : detail) } : {}),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeProposalDiffOutput(result, detail) {
     const base = {
@@ -246,10 +257,7 @@ export function shapeProposalDiffOutput(result, detail) {
         unified: result.unified,
         ...(result.targetPath !== undefined ? { targetPath: result.targetPath } : {}),
     };
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeEventsOutput(result, detail) {
     const events = Array.isArray(result.events) ? result.events : [];
@@ -268,16 +276,10 @@ export function shapeEventsOutput(result, detail) {
     if (typeof result.reason === "string") {
         base.reason = result.reason;
     }
-    if (detail === "full") {
-        return { schemaVersion: result.schemaVersion ?? 1, ...base };
-    }
-    return base;
+    return maybeAddSchema(base, detail, result.schemaVersion);
 }
 export function shapeEventEntry(entry, detail) {
-    if (detail === "brief") {
-        return pickFields(entry, ["eventType", "ref", "ts"]);
-    }
-    if (detail === "normal" || detail === "summary") {
+    if (detail === "brief" || detail === "normal" || detail === "summary") {
         return pickFields(entry, ["eventType", "ref", "ts"]);
     }
     // full / agent: project everything the reader emits.
@@ -407,19 +409,22 @@ export function shapeSearchHit(hit, detail) {
     // `ref` is included at `brief` so agents can run `akm show <ref>` without
     // needing --detail full or --for-agent (REC-03).
     if (detail === "brief")
-        return pickFields(hit, ["type", "name", "ref", "action", "estimatedTokens"]);
+        return pickFields(hit, ["type", "name", "ref", "action", "estimatedTokens", "keys"]);
     if (detail === "normal") {
         // `warnings` is projected at `normal` so non-fatal hit-level issues are
         // visible without forcing callers up to `--detail full`. Optional
         // `quality` (v1 spec §4.2) is also surfaced when present so callers
         // can see why a `proposed` entry showed up under `--include-proposed`.
-        return capDescription(pickFields(hit, ["type", "name", "description", "action", "score", "estimatedTokens", "warnings", "quality"]), NORMAL_DESCRIPTION_LIMIT);
+        const shaped = capDescription(pickFields(hit, ["type", "name", "description", "action", "score", "estimatedTokens", "warnings", "quality"]), NORMAL_DESCRIPTION_LIMIT);
+        if (Array.isArray(hit.keys) && hit.keys.length > 0)
+            shaped.keys = hit.keys;
+        return shaped;
     }
     return hit;
 }
 /** Agent-optimized search hit: only fields an LLM agent needs to decide and act */
 export function shapeSearchHitForAgent(hit) {
-    const picked = pickFields(hit, ["name", "ref", "type", "description", "action", "score", "estimatedTokens"]);
+    const picked = pickFields(hit, ["name", "ref", "type", "description", "action", "score", "estimatedTokens", "keys"]);
     return capDescription(picked, NORMAL_DESCRIPTION_LIMIT);
 }
 export function capDescription(hit, limit) {
@@ -449,6 +454,7 @@ export function shapeShowOutput(result, detail, forAgent = false) {
             "run",
             "setup",
             "cwd",
+            "activeRun",
             "toolPolicy",
             "modelHint",
             "agent",
@@ -458,6 +464,7 @@ export function shapeShowOutput(result, detail, forAgent = false) {
             "steps",
             "keys",
             "comments",
+            "related",
         ]);
     }
     if (detail === "summary") {
@@ -473,9 +480,10 @@ export function shapeShowOutput(result, detail, forAgent = false) {
             "origin",
             "keys",
             "comments",
+            "related",
         ]);
     }
-    const base = pickFields(result, [
+    const baseFields = [
         "type",
         "name",
         "origin",
@@ -495,13 +503,18 @@ export function shapeShowOutput(result, detail, forAgent = false) {
         "run",
         "setup",
         "cwd",
+        "activeRun",
         "keys",
         "comments",
+        "related",
         // path and editable are always projected so JSON consumers can locate and
         // edit the asset without needing --detail full (QA #7).
-        "path",
+        // Exception: vault assets omit path to avoid leaking absolute disk paths
+        // into structured JSON output (security fix M3).
+        ...(result.type === "vault" ? [] : ["path"]),
         "editable",
-    ]);
+    ];
+    const base = pickFields(result, baseFields);
     if (detail !== "full") {
         return base;
     }