akm-cli 0.5.0 → 0.6.0-rc2

package/dist/output/shapes.js

@@ -0,0 +1,212 @@
+/**
+ * Pure shaping functions that select and trim fields from command result
+ * objects according to the active detail level / agent mode.
+ *
+ * Every function in this module is side-effect free and operates on plain
+ * `Record<string, unknown>` shapes, which makes them trivial to unit test.
+ */
+const NORMAL_DESCRIPTION_LIMIT = 250;
+export function shapeForCommand(command, result, detail, forAgent = false) {
+    switch (command) {
+        case "search":
+            return shapeSearchOutput(result, detail, forAgent);
+        case "registry-search":
+            return shapeRegistrySearchOutput(result, detail);
+        case "show":
+            return shapeShowOutput(result, detail, forAgent);
+        default:
+            return result;
+    }
+}
+export function shapeSearchOutput(result, detail, forAgent = false) {
+    const hits = Array.isArray(result.hits) ? result.hits : [];
+    const registryHits = Array.isArray(result.registryHits) ? result.registryHits : [];
+    const shapedHits = forAgent
+        ? hits.map((hit) => shapeSearchHitForAgent(hit))
+        : hits.map((hit) => shapeSearchHit(hit, detail));
+    const shapedRegistryHits = forAgent
+        ? registryHits.map((hit) => shapeSearchHitForAgent(hit))
+        : registryHits.map((hit) => shapeSearchHit(hit, detail));
+    if (forAgent) {
+        return {
+            hits: shapedHits,
+            ...(shapedRegistryHits.length > 0 ? { registryHits: shapedRegistryHits } : {}),
+            ...(result.tip ? { tip: result.tip } : {}),
+        };
+    }
+    if (detail === "full") {
+        return {
+            schemaVersion: result.schemaVersion,
+            stashDir: result.stashDir,
+            source: result.source,
+            hits: shapedHits,
+            ...(shapedRegistryHits.length > 0 ? { registryHits: shapedRegistryHits } : {}),
+            ...(result.semanticSearch ? { semanticSearch: result.semanticSearch } : {}),
+            ...(result.tip ? { tip: result.tip } : {}),
+            ...(result.warnings ? { warnings: result.warnings } : {}),
+            ...(result.timing ? { timing: result.timing } : {}),
+        };
+    }
+    return {
+        hits: shapedHits,
+        ...(shapedRegistryHits.length > 0 ? { registryHits: shapedRegistryHits } : {}),
+        ...(Array.isArray(result.warnings) && result.warnings.length > 0 ? { warnings: result.warnings } : {}),
+        ...(result.tip ? { tip: result.tip } : {}),
+    };
+}
+export function shapeRegistrySearchOutput(result, detail) {
+    const hits = Array.isArray(result.hits) ? result.hits : [];
+    const assetHits = Array.isArray(result.assetHits) ? result.assetHits : [];
+    // Shape stash hits as registry type
+    const shapedKitHits = hits.map((hit) => shapeSearchHit({ ...hit, type: "registry" }, detail));
+    // Shape asset hits by detail level
+    const shapedAssetHits = assetHits.map((hit) => shapeAssetHit(hit, detail));
+    const shaped = {
+        hits: shapedKitHits,
+        ...(shapedAssetHits.length > 0 ? { assetHits: shapedAssetHits } : {}),
+        ...(Array.isArray(result.warnings) && result.warnings.length > 0 ? { warnings: result.warnings } : {}),
+    };
+    if (detail === "full") {
+        shaped.query = result.query;
+    }
+    return shaped;
+}
+export function shapeAssetHit(hit, detail) {
+    if (detail === "brief")
+        return pickFields(hit, ["assetName", "assetType", "action", "estimatedTokens"]);
+    if (detail === "normal") {
+        return capDescription(pickFields(hit, ["assetName", "assetType", "description", "stash", "action", "estimatedTokens"]), NORMAL_DESCRIPTION_LIMIT);
+    }
+    return hit;
+}
+export function shapeSearchHit(hit, detail) {
+    if (hit.type === "registry") {
+        if (detail === "brief") {
+            // RegistrySearchHit uses `title` (not `name`); always project installRef
+            // and score so callers can use the result without --detail full (QA #28).
+            const out = pickFields(hit, ["title", "name", "installRef", "score"]);
+            // Normalise: if only title exists, expose it as `name` for consistency
+            if (out.title && !out.name)
+                out.name = out.title;
+            return out;
+        }
+        if (detail === "normal") {
+            const out = capDescription(pickFields(hit, ["title", "name", "description", "action", "installRef", "score", "curated"]), NORMAL_DESCRIPTION_LIMIT);
+            if (out.title && !out.name)
+                out.name = out.title;
+            return out;
+        }
+        return hit;
+    }
+    // Stash hit (local or remote)
+    if (detail === "brief")
+        return pickFields(hit, ["type", "name", "action", "estimatedTokens"]);
+    if (detail === "normal") {
+        return capDescription(pickFields(hit, ["type", "name", "description", "action", "score", "estimatedTokens"]), NORMAL_DESCRIPTION_LIMIT);
+    }
+    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"]);
+    return capDescription(picked, NORMAL_DESCRIPTION_LIMIT);
+}
+export function capDescription(hit, limit) {
+    if (typeof hit.description !== "string")
+        return hit;
+    return { ...hit, description: truncateDescription(hit.description, limit) };
+}
+export function truncateDescription(description, limit) {
+    const normalized = description.replace(/\s+/g, " ").trim();
+    if (normalized.length <= limit)
+        return normalized;
+    const truncated = normalized.slice(0, limit - 1);
+    const lastSpace = truncated.lastIndexOf(" ");
+    const safe = lastSpace >= Math.floor(limit * 0.6) ? truncated.slice(0, lastSpace) : truncated;
+    return `${safe.trimEnd()}...`;
+}
+export function shapeShowOutput(result, detail, forAgent = false) {
+    if (forAgent) {
+        return pickFields(result, [
+            "type",
+            "name",
+            "description",
+            "action",
+            "content",
+            "template",
+            "prompt",
+            "run",
+            "setup",
+            "cwd",
+            "toolPolicy",
+            "modelHint",
+            "agent",
+            "parameters",
+            "workflowTitle",
+            "workflowParameters",
+            "steps",
+            "keys",
+            "comments",
+        ]);
+    }
+    if (detail === "summary") {
+        return pickFields(result, [
+            "type",
+            "name",
+            "description",
+            "tags",
+            "parameters",
+            "workflowTitle",
+            "action",
+            "run",
+            "origin",
+            "keys",
+            "comments",
+        ]);
+    }
+    const base = pickFields(result, [
+        "type",
+        "name",
+        "origin",
+        "action",
+        "description",
+        "tags",
+        "content",
+        "template",
+        "prompt",
+        "toolPolicy",
+        "modelHint",
+        "agent",
+        "parameters",
+        "workflowTitle",
+        "workflowParameters",
+        "steps",
+        "run",
+        "setup",
+        "cwd",
+        "keys",
+        "comments",
+        // path and editable are always projected so JSON consumers can locate and
+        // edit the asset without needing --detail full (QA #7).
+        "path",
+        "editable",
+    ]);
+    if (detail !== "full") {
+        return base;
+    }
+    return {
+        schemaVersion: 1,
+        ...base,
+        ...pickFields(result, ["editHint"]),
+    };
+}
+export function pickFields(source, fields) {
+    const result = {};
+    for (const field of fields) {
+        if (source[field] !== undefined) {
+            result[field] = source[field];
+        }
+    }
+    return result;
+}
+export { NORMAL_DESCRIPTION_LIMIT };