@galaxy-tool-util/schema 0.1.0 → 0.2.0

package/dist/workflow/precheck.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Precheck native workflow steps for stateful conversion compatibility.
+ *
+ * Checks whether a step's tool_state can be walked by the schema-aware
+ * stateful converter, or whether it has issues (legacy replacement params,
+ * legacy parameter encoding) that require falling back to schema-free
+ * passthrough.
+ *
+ * Usage: called per-step by the stateful runner before conversion. A
+ * failing precheck short-circuits `convert` and pushes a structured
+ * `failureClass: "precheck"` status entry.
+ *
+ * Tool lookup is callback-shaped (`ToolInputsResolver`) matching the rest
+ * of the stateful conversion pipeline — the caller owns tool loading and
+ * version disambiguation.
+ */
+import type { NormalizedNativeWorkflow, NormalizedNativeStep } from "./normalized/native.js";
+import type { ToolInputsResolver } from "./normalized/stateful-runner.js";
+import type { ToolParameterModel } from "../schema/bundle-types.js";
+export interface StepPrecheckResult {
+    stepId: string;
+    toolId?: string;
+    canProcess: boolean;
+    skipReasons: string[];
+}
+export interface PrecheckResult {
+    canProcess: boolean;
+    skipReasons: string[];
+    stepResults: StepPrecheckResult[];
+}
+/**
+ * Precheck a single tool step's tool_state against its parameter inputs.
+ *
+ * Returns `canProcess: true` with empty reasons if the step is clean or
+ * if no inputs were provided (caller falls back at conversion time).
+ * Returns `canProcess: false` with reasons if legacy replacement params
+ * or legacy parameter encoding is detected.
+ *
+ * Non-tool steps (inputs, subworkflows) always pass — they have no
+ * tool_state to validate.
+ */
+export declare function precheckNativeStep(step: NormalizedNativeStep, inputs: ToolParameterModel[] | undefined): StepPrecheckResult;
+/**
+ * Precheck every step in a native workflow using a tool inputs resolver.
+ *
+ * For each step calls `precheckNativeStep`. Returns a workflow-level
+ * verdict (`canProcess` = all steps passed) plus per-step details, so
+ * callers can still do per-step stateful conversion for clean steps.
+ *
+ * Passing `null` as the resolver is allowed and means "no tool inputs
+ * available" — every step will pass (conversion-time fallback still runs).
+ */
+export declare function precheckNativeWorkflow(workflow: NormalizedNativeWorkflow, resolver: ToolInputsResolver | null): PrecheckResult;
+//# sourceMappingURL=precheck.d.ts.map

package/dist/workflow/precheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precheck.d.ts","sourceRoot":"","sources":["../../src/workflow/precheck.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,oBAAoB,EAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,SAAS,GACvC,kBAAkB,CA8BpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,wBAAwB,EAClC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,GAClC,cAAc,CA0BhB"}

package/dist/workflow/precheck.js

@@ -0,0 +1,91 @@
+/**
+ * Precheck native workflow steps for stateful conversion compatibility.
+ *
+ * Checks whether a step's tool_state can be walked by the schema-aware
+ * stateful converter, or whether it has issues (legacy replacement params,
+ * legacy parameter encoding) that require falling back to schema-free
+ * passthrough.
+ *
+ * Usage: called per-step by the stateful runner before conversion. A
+ * failing precheck short-circuits `convert` and pushes a structured
+ * `failureClass: "precheck"` status entry.
+ *
+ * Tool lookup is callback-shaped (`ToolInputsResolver`) matching the rest
+ * of the stateful conversion pipeline — the caller owns tool loading and
+ * version disambiguation.
+ */
+import { scanForReplacements } from "./replacement-scan.js";
+import { scanToolState } from "./legacy-encoding.js";
+/**
+ * Precheck a single tool step's tool_state against its parameter inputs.
+ *
+ * Returns `canProcess: true` with empty reasons if the step is clean or
+ * if no inputs were provided (caller falls back at conversion time).
+ * Returns `canProcess: false` with reasons if legacy replacement params
+ * or legacy parameter encoding is detected.
+ *
+ * Non-tool steps (inputs, subworkflows) always pass — they have no
+ * tool_state to validate.
+ */
+export function precheckNativeStep(step, inputs) {
+    const stepId = String(step.id ?? "");
+    const toolId = step.tool_id ?? undefined;
+    const reasons = [];
+    if (step.type !== "tool") {
+        return { stepId, toolId, canProcess: true, skipReasons: [] };
+    }
+    if (inputs == null || toolId == null) {
+        return { stepId, toolId, canProcess: true, skipReasons: [] };
+    }
+    // Legacy replacement parameters (${...}) in typed fields
+    if (scanForReplacements(inputs, step.tool_state) === "yes") {
+        reasons.push("legacy replacement parameter (${...}) in typed field");
+    }
+    // Legacy parameter encoding (string-encoded containers)
+    const encodingResult = scanToolState(inputs, step.tool_state);
+    if (encodingResult.classification === "yes") {
+        const details = encodingResult.hits.map((h) => `${h.parameterName}: ${h.detail}`).join("; ");
+        reasons.push(`legacy parameter encoding detected (${details})`);
+    }
+    return {
+        stepId,
+        toolId,
+        canProcess: reasons.length === 0,
+        skipReasons: reasons,
+    };
+}
+/**
+ * Precheck every step in a native workflow using a tool inputs resolver.
+ *
+ * For each step calls `precheckNativeStep`. Returns a workflow-level
+ * verdict (`canProcess` = all steps passed) plus per-step details, so
+ * callers can still do per-step stateful conversion for clean steps.
+ *
+ * Passing `null` as the resolver is allowed and means "no tool inputs
+ * available" — every step will pass (conversion-time fallback still runs).
+ */
+export function precheckNativeWorkflow(workflow, resolver) {
+    const stepResults = [];
+    const workflowReasons = [];
+    for (const [key, step] of Object.entries(workflow.steps)) {
+        const inputs = resolver != null && step.tool_id != null
+            ? resolver(step.tool_id, step.tool_version ?? null)
+            : undefined;
+        const stepResult = precheckNativeStep(step, inputs);
+        if (stepResult.stepId === "") {
+            stepResult.stepId = String(step.id ?? key);
+        }
+        stepResults.push(stepResult);
+        if (!stepResult.canProcess) {
+            for (const reason of stepResult.skipReasons) {
+                workflowReasons.push(`step ${stepResult.stepId}: ${reason}`);
+            }
+        }
+    }
+    return {
+        canProcess: workflowReasons.length === 0,
+        skipReasons: workflowReasons,
+        stepResults,
+    };
+}
+//# sourceMappingURL=precheck.js.map

package/dist/workflow/precheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"precheck.js","sourceRoot":"","sources":["../../src/workflow/precheck.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAKH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAerD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAA0B,EAC1B,MAAwC;IAExC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,SAAS,CAAC;IACzC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACrC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;IAC/D,CAAC;IAED,yDAAyD;IACzD,IAAI,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,KAAK,EAAE,CAAC;QAC3D,OAAO,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IACvE,CAAC;IAED,wDAAwD;IACxD,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,IAAI,cAAc,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,aAAa,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO,CAAC,IAAI,CAAC,uCAAuC,OAAO,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,OAAO;QACL,MAAM;QACN,MAAM;QACN,UAAU,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC;QAChC,WAAW,EAAE,OAAO;KACrB,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAkC,EAClC,QAAmC;IAEnC,MAAM,WAAW,GAAyB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAa,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,MAAM,GACV,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI;YACtC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC;YACnD,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpD,IAAI,UAAU,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC7B,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC;QAC7C,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;YAC3B,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;gBAC5C,eAAe,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,UAAU,EAAE,eAAe,CAAC,MAAM,KAAK,CAAC;QACxC,WAAW,EAAE,eAAe;QAC5B,WAAW;KACZ,CAAC;AACJ,CAAC"}