@galaxy-tool-util/cli 1.2.0 → 1.3.0

package/dist/commands/summarize.d.ts

@@ -0,0 +1,31 @@
+import { type ParsedTool } from "@galaxy-tool-util/schema";
+export interface SummarizeOptions {
+    version?: string;
+    output?: string;
+    cacheDir?: string;
+}
+export interface GalaxyToolSummaryManifest {
+    schema_version: 1;
+    tool_id: string;
+    tool_version: string | null;
+    cache_key: string;
+    source: {
+        kind: "toolshed" | "galaxy" | "local" | "orphan" | "unknown";
+        label: string;
+        url: string;
+        cached_at: string | null;
+    };
+    artifacts: {
+        parsed_tool_path: string;
+        raw_tool_source_path: string | null;
+    };
+    parsed_tool: ParsedTool;
+    input_schemas: {
+        workflow_step: unknown | null;
+        workflow_step_linked: unknown | null;
+    };
+    warnings: string[];
+}
+export declare function buildToolSummaryManifest(toolId: string, opts: SummarizeOptions): Promise<GalaxyToolSummaryManifest | null>;
+export declare function runSummarize(toolId: string, opts: SummarizeOptions): Promise<void>;
+//# sourceMappingURL=summarize.d.ts.map

package/dist/commands/summarize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarize.d.ts","sourceRoot":"","sources":["../../src/commands/summarize.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,UAAU,EAGhB,MAAM,0BAA0B,CAAC;AAIlC,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,CAAC,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACN,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;QAC7D,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B,CAAC;IACF,SAAS,EAAE;QACT,gBAAgB,EAAE,MAAM,CAAC;QACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC,CAAC;IACF,WAAW,EAAE,UAAU,CAAC;IACxB,aAAa,EAAE;QACb,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;QAC9B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;KACtC,CAAC;IACF,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AA+BD,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC,CAwC3C;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUxF"}

package/dist/commands/summarize.js

@@ -0,0 +1,85 @@
+import { join } from "node:path";
+import { writeFile } from "node:fs/promises";
+import { getCacheDir, makeNodeToolCache } from "@galaxy-tool-util/core/node";
+import { createFieldModel, } from "@galaxy-tool-util/schema";
+import * as JSONSchema from "effect/JSONSchema";
+import { isResolveError, loadCachedTool } from "./resolve-tool.js";
+function sourceKind(label) {
+    if (label === "api")
+        return "toolshed";
+    if (label === "galaxy" || label === "local" || label === "orphan")
+        return label;
+    return "unknown";
+}
+function inputSchemaFor(tool, rep, warnings) {
+    const bundle = {
+        parameters: tool.inputs,
+    };
+    const effectSchema = createFieldModel(bundle, rep);
+    if (effectSchema === undefined) {
+        warnings.push(`${rep} input schema could not be generated for this tool`);
+        return null;
+    }
+    try {
+        return JSONSchema.make(effectSchema);
+    }
+    catch (err) {
+        warnings.push(`${rep} input schema generation failed: ${err instanceof Error ? err.message : String(err)}`);
+        return null;
+    }
+}
+export async function buildToolSummaryManifest(toolId, opts) {
+    const cacheDir = getCacheDir(opts.cacheDir);
+    const cache = makeNodeToolCache({ cacheDir });
+    await cache.index.load();
+    const result = await loadCachedTool(cache, toolId, opts.version);
+    if (isResolveError(result)) {
+        if (result.kind === "no_version") {
+            console.error(`No version specified for tool: ${toolId}`);
+        }
+        else {
+            console.error(`Tool not found in cache: ${toolId}. Run 'galaxy-tool-cache add' first.`);
+        }
+        process.exitCode = 1;
+        return null;
+    }
+    const indexEntry = (await cache.index.listAll()).find((entry) => entry.cache_key === result.key);
+    const warnings = [];
+    const manifest = {
+        schema_version: 1,
+        tool_id: result.tool.id,
+        tool_version: result.tool.version,
+        cache_key: result.key,
+        source: {
+            kind: sourceKind(indexEntry?.source),
+            label: indexEntry?.source ?? "unknown",
+            url: indexEntry?.source_url ?? "",
+            cached_at: indexEntry?.cached_at ?? null,
+        },
+        artifacts: {
+            parsed_tool_path: join(cacheDir, `${result.key}.json`),
+            raw_tool_source_path: null,
+        },
+        parsed_tool: result.tool,
+        input_schemas: {
+            workflow_step: inputSchemaFor(result.tool, "workflow_step", warnings),
+            workflow_step_linked: inputSchemaFor(result.tool, "workflow_step_linked", warnings),
+        },
+        warnings,
+    };
+    return manifest;
+}
+export async function runSummarize(toolId, opts) {
+    const manifest = await buildToolSummaryManifest(toolId, opts);
+    if (manifest === null)
+        return;
+    const output = `${JSON.stringify(manifest, null, 2)}\n`;
+    if (opts.output) {
+        await writeFile(opts.output, output);
+        console.log(`Summary written to ${opts.output}`);
+    }
+    else {
+        process.stdout.write(output);
+    }
+}
+//# sourceMappingURL=summarize.js.map

package/dist/commands/summarize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarize.js","sourceRoot":"","sources":["../../src/commands/summarize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EACL,gBAAgB,GAIjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AA+BnE,SAAS,UAAU,CAAC,KAAyB;IAC3C,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,UAAU,CAAC;IACvC,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAChF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CACrB,IAAgB,EAChB,GAAwB,EACxB,QAAkB;IAElB,MAAM,MAAM,GAA6B;QACvC,UAAU,EAAE,IAAI,CAAC,MAAgD;KAClE,CAAC;IACF,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,oDAAoD,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC;QACH,OAAO,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CACX,GAAG,GAAG,oCAAoC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAC7F,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,MAAc,EACd,IAAsB;IAEtB,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9C,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACzB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CAAC,kCAAkC,MAAM,EAAE,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,4BAA4B,MAAM,sCAAsC,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAA8B;QAC1C,cAAc,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE;QACvB,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;QACjC,SAAS,EAAE,MAAM,CAAC,GAAG;QACrB,MAAM,EAAE;YACN,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC;YACpC,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,SAAS;YACtC,GAAG,EAAE,UAAU,EAAE,UAAU,IAAI,EAAE;YACjC,SAAS,EAAE,UAAU,EAAE,SAAS,IAAI,IAAI;SACzC;QACD,SAAS,EAAE;YACT,gBAAgB,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC;YACtD,oBAAoB,EAAE,IAAI;SAC3B;QACD,WAAW,EAAE,MAAM,CAAC,IAAI;QACxB,aAAa,EAAE;YACb,aAAa,EAAE,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC;YACrE,oBAAoB,EAAE,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,QAAQ,CAAC;SACpF;QACD,QAAQ;KACT,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,IAAsB;IACvE,MAAM,QAAQ,GAAG,MAAM,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO;IAC9B,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;IACxD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC"}

package/dist/programs/galaxy-tool-cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"galaxy-tool-cache.d.ts","sourceRoot":"","sources":["../../src/programs/galaxy-tool-cache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAqBzC,wBAAgB,2BAA2B,IAAI,OAAO,CAErD"}
+{"version":3,"file":"galaxy-tool-cache.d.ts","sourceRoot":"","sources":["../../src/programs/galaxy-tool-cache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAuBzC,wBAAgB,2BAA2B,IAAI,OAAO,CAErD"}

package/dist/programs/galaxy-tool-cache.js

@@ -4,6 +4,7 @@ import { runInfo } from "../commands/info.js";
 import { runClear } from "../commands/clear.js";
 import { runPopulateWorkflow } from "../commands/populate-workflow.js";
 import { runSchema } from "../commands/schema.js";
+import { runSummarize } from "../commands/summarize.js";
 import { runStructuralSchema } from "../commands/structural-schema.js";
 import { buildProgramFromSpec } from "../spec/build-program.js";
 import { galaxyToolCacheSpec } from "../meta/specs.js";
@@ -13,6 +14,7 @@ const handlers = {
     info: runInfo,
     clear: runClear,
     schema: runSchema,
+    summarize: runSummarize,
     populateWorkflow: runPopulateWorkflow,
     structuralSchema: runStructuralSchema,
 };

package/dist/programs/galaxy-tool-cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"galaxy-tool-cache.js","sourceRoot":"","sources":["../../src/programs/galaxy-tool-cache.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAwB,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,QAAQ,GAAoB;IAChC,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;IACb,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,SAAS;IACjB,gBAAgB,EAAE,mBAAmB;IACrC,gBAAgB,EAAE,mBAAmB;CACtC,CAAC;AAEF,MAAM,UAAU,2BAA2B;IACzC,OAAO,oBAAoB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AAC7D,CAAC"}
+{"version":3,"file":"galaxy-tool-cache.js","sourceRoot":"","sources":["../../src/programs/galaxy-tool-cache.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAwB,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,QAAQ,GAAoB;IAChC,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;IACb,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,SAAS;IACjB,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,gBAAgB,EAAE,mBAAmB;CACtC,CAAC;AAEF,MAAM,UAAU,2BAA2B;IACzC,OAAO,oBAAoB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AAC7D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galaxy-tool-util/cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "galaxy-tool-cache CLI — cache and inspect Galaxy tool metadata",
   "type": "module",
   "bin": {

package/spec/galaxy-tool-cache.json

@@ -111,6 +111,31 @@
         }
       ]
     },
+    {
+      "name": "summarize",
+      "description": "Emit a deterministic summary manifest for a cached Galaxy tool",
+      "handler": "summarize",
+      "args": [
+        {
+          "raw": "<tool_id>",
+          "description": "Tool ID"
+        }
+      ],
+      "options": [
+        {
+          "flags": "--version <ver>",
+          "description": "Tool version"
+        },
+        {
+          "flags": "--output <file>",
+          "description": "Output file (default: stdout)"
+        },
+        {
+          "flags": "--cache-dir <dir>",
+          "description": "Cache directory"
+        }
+      ]
+    },
     {
       "name": "populate-workflow",
       "description": "Scan a workflow and cache all referenced tools",