@galaxy-tool-util/schema 1.2.0 → 1.5.0

package/dist/workflow/promote-draft.js

@@ -0,0 +1,133 @@
+/**
+ * Post-extract cleanup for draft workflows.
+ *
+ * `stripPlanFields` removes the four `_plan_*` planning fields from every
+ * step (recursively into inline draft subworkflows) and from the workflow
+ * root. `promoteFullyConcreteDrafts` flips `class: GalaxyWorkflowDraft` →
+ * `class: GalaxyWorkflow` on any (sub)workflow that is now fully concrete
+ * — zero TODO sentinels, zero `_plan_*` fields anywhere — recursively.
+ *
+ * Both functions mutate the workflow dict in place (matching the
+ * `cleanWorkflow` style) and return arrays of paths describing what
+ * changed, for sidecar reporting.
+ */
+import { DRAFT_CLASS, PLAN_FIELDS, detectDraft, isDraftWorkflow, } from "./draft-checks.js";
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Strip `_plan_state` / `_plan_context` / `_plan_in` / `_plan_out` from
+ * every step and from the workflow root. Recurses into inline draft
+ * subworkflow `run:` blocks; leaves string-form `run:` and concrete
+ * `class: GalaxyWorkflow` `run:` untouched.
+ *
+ * Mutates the workflow dict in place. Pure on non-records (passes
+ * through unchanged with empty `removedPaths`).
+ */
+export function stripPlanFields(workflow) {
+    const removed = [];
+    if (!isRecord(workflow)) {
+        return { workflow, removedPaths: removed };
+    }
+    stripPlanFieldsIn(workflow, [], removed);
+    return { workflow, removedPaths: removed };
+}
+function stripPlanFieldsIn(workflow, prefix, removed) {
+    // Root-level _plan_* (only meaningful on draft workflows, but we strip
+    // unconditionally — root _plan_* on a non-draft is dead weight too).
+    for (const field of PLAN_FIELDS) {
+        if (field in workflow) {
+            delete workflow[field];
+            removed.push({ path: [...prefix], field });
+        }
+    }
+    // Step-level _plan_* + recurse into draft subworkflows.
+    for (const [label, step] of iterateStepEntries(workflow.steps)) {
+        if (!isRecord(step))
+            continue;
+        const path = [...prefix, label];
+        for (const field of PLAN_FIELDS) {
+            if (field in step) {
+                delete step[field];
+                removed.push({ path: [...path], field });
+            }
+        }
+        if (isDraftWorkflow(step.run)) {
+            stripPlanFieldsIn(step.run, path, removed);
+        }
+    }
+}
+/**
+ * Flip `class: GalaxyWorkflowDraft` → `class: GalaxyWorkflow` on any
+ * (sub)workflow that is now fully concrete: zero TODO sentinels, zero
+ * `_plan_*` fields anywhere in steps / root. Recurses into inline draft
+ * subworkflows; still-drafty inner workflows are left alone.
+ *
+ * Mutates in place. Pure on non-records.
+ */
+export function promoteFullyConcreteDrafts(workflow) {
+    const promoted = [];
+    if (!isRecord(workflow)) {
+        return { workflow, promotedPaths: promoted };
+    }
+    promoteFullyConcreteDraftsIn(workflow, [], promoted);
+    return { workflow, promotedPaths: promoted };
+}
+function promoteFullyConcreteDraftsIn(workflow, prefix, promoted) {
+    // Recurse first — flipping an outer draft before its inner drafts get
+    // a chance would mask still-drafty inner workflows under a now-concrete
+    // outer.
+    for (const [label, step] of iterateStepEntries(workflow.steps)) {
+        if (!isRecord(step))
+            continue;
+        if (isDraftWorkflow(step.run)) {
+            promoteFullyConcreteDraftsIn(step.run, [...prefix, label], promoted);
+        }
+    }
+    if (workflow.class !== DRAFT_CLASS)
+        return;
+    if (!isFullyConcrete(workflow))
+        return;
+    workflow.class = "GalaxyWorkflow";
+    promoted.push([...prefix]);
+}
+function isFullyConcrete(workflow) {
+    // detectDraft's step-walk covers TODOs + step-level _plan_*. We also
+    // check workflow root + step roots for any lingering _plan_* (detectDraft
+    // intentionally skips workflow-root _plan_*).
+    const survey = detectDraft(workflow);
+    if (survey.todos.length > 0)
+        return false;
+    if (survey.planFields.length > 0)
+        return false;
+    for (const field of PLAN_FIELDS) {
+        if (field in workflow)
+            return false;
+    }
+    // An inner draft `run:` still carrying its own work blocks promotion of
+    // the outer (we don't flip while one of our subworkflow steps is still
+    // a GalaxyWorkflowDraft).
+    for (const [, step] of iterateStepEntries(workflow.steps)) {
+        if (!isRecord(step))
+            continue;
+        if (isRecord(step.run) && step.run.class === DRAFT_CLASS)
+            return false;
+    }
+    return true;
+}
+function* iterateStepEntries(steps) {
+    if (Array.isArray(steps)) {
+        for (const step of steps) {
+            if (isRecord(step)) {
+                const label = typeof step.label === "string" ? step.label : typeof step.id === "string" ? step.id : "";
+                yield [label, step];
+            }
+        }
+    }
+    else if (isRecord(steps)) {
+        for (const [key, value] of Object.entries(steps)) {
+            yield [key, value];
+        }
+    }
+}
+//# sourceMappingURL=promote-draft.js.map

package/dist/workflow/promote-draft.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promote-draft.js","sourceRoot":"","sources":["../../src/workflow/promote-draft.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EACL,WAAW,EACX,WAAW,EACX,WAAW,EACX,eAAe,GAEhB,MAAM,mBAAmB,CAAC;AAE3B,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAkBD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,QAAiB;IAC/C,MAAM,OAAO,GAAwB,EAAE,CAAC;IACxC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;IAC7C,CAAC;IACD,iBAAiB,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,iBAAiB,CACxB,QAAiC,EACjC,MAAgB,EAChB,OAA4B;IAE5B,uEAAuE;IACvE,qEAAqE;IACrE,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,KAAK,IAAI,QAAQ,EAAE,CAAC;YACtB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,wDAAwD;IACxD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS;QAC9B,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAChC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QACD,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,iBAAiB,CAAC,IAAI,CAAC,GAA8B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;AACH,CAAC;AAQD;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CAAC,QAAiB;IAC1D,MAAM,QAAQ,GAAe,EAAE,CAAC;IAChC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;IAC/C,CAAC;IACD,4BAA4B,CAAC,QAAQ,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IACrD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,4BAA4B,CACnC,QAAiC,EACjC,MAAgB,EAChB,QAAoB;IAEpB,sEAAsE;IACtE,wEAAwE;IACxE,SAAS;IACT,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS;QAC9B,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,4BAA4B,CAC1B,IAAI,CAAC,GAA8B,EACnC,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,EAClB,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,KAAK,WAAW;QAAE,OAAO;IAC3C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;QAAE,OAAO;IAEvC,QAAQ,CAAC,KAAK,GAAG,gBAAgB,CAAC;IAClC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,eAAe,CAAC,QAAiC;IACxD,qEAAqE;IACrE,0EAA0E;IAC1E,8CAA8C;IAC9C,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,KAAK,IAAI,QAAQ;YAAE,OAAO,KAAK,CAAC;IACtC,CAAC;IACD,wEAAwE;IACxE,uEAAuE;IACvE,0BAA0B;IAC1B,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS;QAC9B,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,WAAW;YAAE,OAAO,KAAK,CAAC;IACzE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,QAAQ,CAAC,CAAC,kBAAkB,CAAC,KAAc;IACzC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,MAAM,KAAK,GACT,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3F,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC"}