@workglow/task-graph 0.0.52

package/dist/task-graph/Workflow.d.ts

@@ -0,0 +1,155 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { EventEmitter, type EventParameters } from "@workglow/util";
+import { TaskOutputRepository } from "../storage/TaskOutputRepository";
+import { GraphAsTask } from "../task/GraphAsTask";
+import type { ITask, ITaskConstructor } from "../task/ITask";
+import { Task } from "../task/Task";
+import type { JsonTaskItem, TaskGraphJson } from "../task/TaskJSON";
+import { DataPorts, TaskConfig } from "../task/TaskTypes";
+import { PipeFunction, Taskish } from "./Conversions";
+import { IWorkflow } from "./IWorkflow";
+import { TaskGraph } from "./TaskGraph";
+import { CompoundMergeStrategy, type PropertyArrayGraphResult } from "./TaskGraphRunner";
+export type CreateWorkflow<I extends DataPorts, _O extends DataPorts, C extends TaskConfig> = (input?: Partial<I>, config?: Partial<C>) => Workflow;
+export type WorkflowEventListeners = {
+    changed: (id: unknown) => void;
+    reset: () => void;
+    error: (error: string) => void;
+    start: () => void;
+    complete: () => void;
+    abort: (error: string) => void;
+};
+export type WorkflowEvents = keyof WorkflowEventListeners;
+export type WorkflowEventListener<Event extends WorkflowEvents> = WorkflowEventListeners[Event];
+export type WorkflowEventParameters<Event extends WorkflowEvents> = EventParameters<WorkflowEventListeners, Event>;
+/**
+ * Class for building and managing a task graph
+ * Provides methods for adding tasks, connecting outputs to inputs, and running the task graph
+ */
+export declare class Workflow<Input extends DataPorts = DataPorts, Output extends DataPorts = DataPorts> implements IWorkflow<Input, Output> {
+    /**
+     * Creates a new Workflow
+     *
+     * @param repository - Optional repository for task outputs
+     */
+    constructor(repository?: TaskOutputRepository);
+    private _graph;
+    private _dataFlows;
+    private _error;
+    private _repository?;
+    private _abortController?;
+    /**
+     * Event emitter for task graph events
+     */
+    readonly events: EventEmitter<WorkflowEventListeners>;
+    /**
+     * Creates a helper function for adding specific task types to a Workflow
+     *
+     * @param taskClass - The task class to create a helper for
+     * @returns A function that adds the specified task type to a Workflow
+     */
+    static createWorkflow<I extends DataPorts, O extends DataPorts, C extends TaskConfig = TaskConfig>(taskClass: ITaskConstructor<I, O, C>): CreateWorkflow<I, O, C>;
+    /**
+     * Gets the current task graph
+     */
+    get graph(): TaskGraph;
+    /**
+     * Sets a new task graph
+     */
+    set graph(value: TaskGraph);
+    /**
+     * Gets the current error message
+     */
+    get error(): string;
+    /**
+     * Event subscription methods
+     */
+    on<Event extends WorkflowEvents>(name: Event, fn: WorkflowEventListener<Event>): void;
+    off<Event extends WorkflowEvents>(name: Event, fn: WorkflowEventListener<Event>): void;
+    once<Event extends WorkflowEvents>(name: Event, fn: WorkflowEventListener<Event>): void;
+    waitOn<Event extends WorkflowEvents>(name: Event): Promise<WorkflowEventParameters<Event>>;
+    /**
+     * Runs the task graph
+     *
+     * @param input - The input to the task graph
+     * @returns The output of the task graph
+     */
+    run(input?: Input): Promise<PropertyArrayGraphResult<Output>>;
+    /**
+     * Aborts the running task graph
+     */
+    abort(): Promise<void>;
+    /**
+     * Removes the last task from the task graph
+     *
+     * @returns The current task graph workflow
+     */
+    pop(): Workflow;
+    /**
+     * Converts the task graph to JSON
+     *
+     * @returns The task graph as JSON
+     */
+    toJSON(): TaskGraphJson;
+    /**
+     * Converts the task graph to dependency JSON
+     *
+     * @returns The task graph as dependency JSON
+     */
+    toDependencyJSON(): JsonTaskItem[];
+    pipe<A extends DataPorts, B extends DataPorts>(fn1: Taskish<A, B>): IWorkflow<A, B>;
+    pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts>(fn1: Taskish<A, B>, fn2: Taskish<B, C>): IWorkflow<A, C>;
+    pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts>(fn1: Taskish<A, B>, fn2: Taskish<B, C>, fn3: Taskish<C, D>): IWorkflow<A, D>;
+    pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts, E extends DataPorts>(fn1: Taskish<A, B>, fn2: Taskish<B, C>, fn3: Taskish<C, D>, fn4: Taskish<D, E>): IWorkflow<A, E>;
+    pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts, E extends DataPorts, F extends DataPorts>(fn1: Taskish<A, B>, fn2: Taskish<B, C>, fn3: Taskish<C, D>, fn4: Taskish<D, E>, fn5: Taskish<E, F>): IWorkflow<A, F>;
+    static pipe<A extends DataPorts, B extends DataPorts>(fn1: PipeFunction<A, B> | ITask<A, B>): IWorkflow;
+    static pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts>(fn1: PipeFunction<A, B> | ITask<A, B>, fn2: PipeFunction<B, C> | ITask<B, C>): IWorkflow;
+    static pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts>(fn1: PipeFunction<A, B> | ITask<A, B>, fn2: PipeFunction<B, C> | ITask<B, C>, fn3: PipeFunction<C, D> | ITask<C, D>): IWorkflow;
+    static pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts, E extends DataPorts>(fn1: PipeFunction<A, B> | ITask<A, B>, fn2: PipeFunction<B, C> | ITask<B, C>, fn3: PipeFunction<C, D> | ITask<C, D>, fn4: PipeFunction<D, E> | ITask<D, E>): IWorkflow;
+    static pipe<A extends DataPorts, B extends DataPorts, C extends DataPorts, D extends DataPorts, E extends DataPorts, F extends DataPorts>(fn1: PipeFunction<A, B> | ITask<A, B>, fn2: PipeFunction<B, C> | ITask<B, C>, fn3: PipeFunction<C, D> | ITask<C, D>, fn4: PipeFunction<D, E> | ITask<D, E>, fn5: PipeFunction<E, F> | ITask<E, F>): IWorkflow;
+    parallel(args: (PipeFunction<any, any> | Task)[], mergeFn?: CompoundMergeStrategy): IWorkflow;
+    static parallel(args: (PipeFunction<any, any> | ITask)[], mergeFn?: CompoundMergeStrategy): IWorkflow;
+    /**
+     * Renames an output of a task to a new target input
+     *
+     * @param source - The id of the output to rename
+     * @param target - The id of the input to rename to
+     * @param index - The index of the task to rename the output of, defaults to the last task
+     * @returns The current task graph workflow
+     */
+    rename(source: string, target: string, index?: number): Workflow;
+    toTaskGraph(): TaskGraph;
+    toTask(): GraphAsTask;
+    /**
+     * Resets the task graph workflow to its initial state
+     *
+     * @returns The current task graph workflow
+     */
+    reset(): Workflow;
+    /**
+     * Sets up event listeners for the task graph
+     */
+    private setupEvents;
+    /**
+     * Clears event listeners for the task graph
+     */
+    private clearEvents;
+    /**
+     * Handles changes to the task graph
+     */
+    private _onChanged;
+    /**
+     * Connects outputs to inputs between tasks
+     */
+    connect(sourceTaskId: unknown, sourceTaskPortId: string, targetTaskId: unknown, targetTaskPortId: string): Workflow;
+    addTask<I extends DataPorts, O extends DataPorts, C extends TaskConfig = TaskConfig>(taskClass: ITaskConstructor<I, O, C>, input: I, config: C): ITask<I, O, C>;
+}
+/**
+ * Helper function for backward compatibility
+ */
+export declare function CreateWorkflow<I extends DataPorts, O extends DataPorts, C extends TaskConfig = TaskConfig>(taskClass: any): CreateWorkflow<I, O, C>;
+//# sourceMappingURL=Workflow.d.ts.map

package/dist/task-graph/Workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../src/task-graph/Workflow.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAc,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAA+B,YAAY,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAEnF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,qBAAqB,EAErB,KAAK,wBAAwB,EAC9B,MAAM,mBAAmB,CAAC;AAG3B,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,SAAS,EAAE,CAAC,SAAS,UAAU,IAAI,CAC5F,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAClB,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAChB,QAAQ,CAAC;AAGd,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,CAAC,EAAE,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,sBAAsB,CAAC;AAC1D,MAAM,MAAM,qBAAqB,CAAC,KAAK,SAAS,cAAc,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;AAChG,MAAM,MAAM,uBAAuB,CAAC,KAAK,SAAS,cAAc,IAAI,eAAe,CACjF,sBAAsB,EACtB,KAAK,CACN,CAAC;AAUF;;;GAGG;AACH,qBAAa,QAAQ,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS,EAAE,MAAM,SAAS,SAAS,GAAG,SAAS,CAC7F,YAAW,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;gBACS,UAAU,CAAC,EAAE,oBAAoB;IAS7C,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,WAAW,CAAC,CAAuB;IAG3C,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAE3C;;OAEG;IACH,SAAgB,MAAM,uCAA8C;IAEpE;;;;;OAKG;WACW,cAAc,CAC1B,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,SAAS,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IA2IhE;;OAEG;IACH,IAAW,KAAK,IAAI,SAAS,CAE5B;IAED;;OAEG;IACH,IAAW,KAAK,CAAC,KAAK,EAAE,SAAS,EAOhC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;IACI,EAAE,CAAC,KAAK,SAAS,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI;IAIrF,GAAG,CAAC,KAAK,SAAS,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI;IAItF,IAAI,CAAC,KAAK,SAAS,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI;IAIvF,MAAM,CAAC,KAAK,SAAS,cAAc,EACxC,IAAI,EAAE,KAAK,GACV,OAAO,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAI1C;;;;;OAKG;IACU,GAAG,CAAC,KAAK,GAAE,KAAmB,GAAG,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAwBvF;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACI,GAAG,IAAI,QAAQ;IAetB;;;;OAIG;IACI,MAAM,IAAI,aAAa;IAI9B;;;;OAIG;IACI,gBAAgB,IAAI,YAAY,EAAE;IAMlC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EACvE,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACjB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IACX,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAC5F,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACjB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IACX,IAAI,CACT,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EAEnB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACjB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IACX,IAAI,CACT,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EAEnB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAClB,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACjB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;WAMJ,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EACzD,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,SAAS;WACE,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAC9E,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,SAAS;WACE,IAAI,CAChB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EAEnB,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,SAAS;WACE,IAAI,CAChB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EAEnB,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,SAAS;WACE,IAAI,CAChB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EAEnB,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC,SAAS;IAKL,QAAQ,CACb,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,EACvC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,SAAS;WAIE,QAAQ,CACpB,IAAI,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,EAAE,EACxC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,SAAS;IAIZ;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,QAAQ;IAkC3E,WAAW,IAAI,SAAS;IAIxB,MAAM,IAAI,WAAW;IAMrB;;;;OAIG;IACI,KAAK,IAAI,QAAQ;IAcxB;;OAEG;IACH,OAAO,CAAC,WAAW;IASnB;;OAEG;IACH,OAAO,CAAC,WAAW;IASnB;;OAEG;IACH,OAAO,CAAC,UAAU;IAIlB;;OAEG;IACI,OAAO,CACZ,YAAY,EAAE,OAAO,EACrB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,OAAO,EACrB,gBAAgB,EAAE,MAAM,GACvB,QAAQ;IAmCJ,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,UAAU,GAAG,UAAU,EACxF,SAAS,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,CAAC,GACR,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CAMlB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,SAAS,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEzC"}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./common";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,UAAU,CAAC"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@workglow/task-graph",
+  "type": "module",
+  "version": "0.0.52",
+  "description": "Task graph management for Workglow, providing DAG construction, execution planning, and workflow orchestration.",
+  "scripts": {
+    "watch": "concurrently -c 'auto' 'bun:watch-*'",
+    "watch-browser": "bun build --watch --no-clear-screen --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/browser.ts",
+    "watch-node": "bun build --watch --no-clear-screen --target=node --sourcemap=external --packages=external --outdir ./dist ./src/node.ts",
+    "watch-bun": "bun build --watch --no-clear-screen --target=bun --sourcemap=external --packages=external --outdir ./dist ./src/bun.ts",
+    "watch-types": "tsc --watch --preserveWatchOutput",
+    "build-package": "bun run build-clean && concurrently -c 'auto' -n 'browser,node,bun,types' 'bun run build-browser' 'bun run build-node' 'bun run build-bun' 'bun run build-types'",
+    "build-clean": "rm -fr dist/* tsconfig.tsbuildinfo",
+    "build-browser": "bun build --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/browser.ts",
+    "build-node": "bun build --target=node --sourcemap=external --packages=external --outdir ./dist ./src/node.ts",
+    "build-bun": "bun build --target=bun --sourcemap=external --packages=external --outdir ./dist ./src/bun.ts",
+    "build-types": "rm -f tsconfig.tsbuildinfo && tsc",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "test": "bun test",
+    "prepare": "node -e \"const pkg=require('./package.json');pkg.exports['.'].bun='./dist/bun.js';pkg.exports['.'].types='./dist/types.d.ts';require('fs').writeFileSync('package.json',JSON.stringify(pkg,null,2))\""
+  },
+  "exports": {
+    ".": {
+      "react-native": "./dist/browser.js",
+      "browser": "./dist/browser.js",
+      "bun": "./dist/bun.js",
+      "types": "./dist/types.d.ts",
+      "node": "./dist/node.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@workglow/job-queue": "0.0.52",
+    "@workglow/storage": "0.0.52",
+    "@workglow/util": "0.0.52"
+  },
+  "peerDependenciesMeta": {
+    "@workglow/job-queue": {
+      "optional": false
+    },
+    "@workglow/storage": {
+      "optional": false
+    },
+    "@workglow/util": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "@workglow/job-queue": "0.0.52",
+    "@workglow/storage": "0.0.52",
+    "@workglow/util": "0.0.52"
+  }
+}

package/src/storage/README.md

@@ -0,0 +1,61 @@
+# Task Graph Storage Module
+
+This module provides persistent storage solutions for task graphs and task outputs using various storage backends. The implementation follows a repository pattern with multiple concrete implementations for different storage technologies.
+
+- [Task Output Repositories](#task-output-repositories)
+- [Task Graph Repositories](#task-graph-repositories)
+- [Testing](#testing)
+- [Architecture Notes](#architecture-notes)
+- [License](#license)
+
+## Task Output Repositories
+
+TaskOutputRepository is a repository for task caching. If a task has the same input it is assumed to return the same output. The task graph runner does not resume, but you can quickly get to the aborted state by using the output repository and re-running the task graph.
+
+```typescript
+// Example usage
+import { SqliteTaskOutputRepository } from "@workglow/test"; // pre-bound implementation for sqlite
+const outputRepo = new SqliteTaskOutputRepository(":memory:");
+await outputRepo.saveOutput("MyTaskType", { param: "value" }, { result: "data" });
+```
+
+## Task Graph Repositories
+
+TaskGraphRepository is a repository for task graphs themselves. It is used to save and load task graphs.
+
+The `TaskGraphRepository` class provides:
+
+- CRUD operations for task graphs
+- Event emitters for storage operations
+- Serialization/deserialization of task graphs with data flows
+
+```typescript
+// Example usage
+import { SqliteTaskGraphRepository } from "@workglow/test"; // pre-bound implementation for sqlite
+const fsRepo = new FsFolderTaskGraphRepository("./storage");
+const memoryRepo = new InMemoryTaskGraphRepository();
+```
+
+## Testing
+
+Tests are written using Bun test runner. To run tests:
+
+```bash
+bun test
+```
+
+Tests include:
+
+- Generic repository tests that run against all implementations
+- Storage-specific test suites
+
+## Architecture Notes
+
+- All repositories use a TabularRepository pattern internally
+- Schema definitions are centralized in `TaskGraphSchema`/`TaskOutputSchema`
+- Primary key configurations are managed through `PrimaryKeyNames` constants
+- Event emitters provide hooks for monitoring repository operations
+
+## License
+
+Apache 2.0 - See LICENSE file for details

package/src/task/ConditionalTask.README.md

@@ -0,0 +1,268 @@
+# ConditionalTask
+
+A task that implements conditional branching within a task graph, similar to if/then/else or switch/case statements.
+
+## Overview
+
+`ConditionalTask` evaluates configured conditions against its input and selectively enables output ports for active branches. Inactive branches result in `DISABLED` status for their downstream dataflows, which cascades to disable unreachable downstream tasks.
+
+## Key Features
+
+- **Condition-based routing**: Route data to different downstream tasks based on input values
+- **Exclusive mode (default)**: Act as a switch/case where only the first matching branch activates
+- **Multi-path mode**: Enable multiple branches simultaneously when conditions match
+- **Default branch**: Specify a fallback branch when no conditions match
+- **Disabled propagation**: Inactive branches result in DISABLED status for downstream tasks
+
+## Basic Usage
+
+### Simple If/Else
+
+```typescript
+import { ConditionalTask, TaskGraph, Dataflow } from "@workglow/task-graph";
+
+const conditional = new ConditionalTask(
+  {},
+  {
+    branches: [
+      { id: "high", condition: (i) => i.value > 100, outputPort: "highPath" },
+      { id: "low", condition: (i) => i.value <= 100, outputPort: "lowPath" },
+    ],
+  }
+);
+
+const highHandler = new SomeTask({}, { id: "highHandler" });
+const lowHandler = new SomeTask({}, { id: "lowHandler" });
+
+const graph = new TaskGraph();
+graph.addTasks([conditional, highHandler, lowHandler]);
+graph.addDataflow(new Dataflow(conditional.config.id, "highPath", highHandler.config.id, "*"));
+graph.addDataflow(new Dataflow(conditional.config.id, "lowPath", lowHandler.config.id, "*"));
+
+// When value > 100, highHandler runs and lowHandler is DISABLED
+// When value <= 100, lowHandler runs and highHandler is DISABLED
+await graph.run({ value: 150 });
+```
+
+### Switch/Case Pattern
+
+```typescript
+const statusRouter = new ConditionalTask(
+  {},
+  {
+    branches: [
+      { id: "active", condition: (i) => i.status === "active", outputPort: "active" },
+      { id: "pending", condition: (i) => i.status === "pending", outputPort: "pending" },
+      { id: "inactive", condition: (i) => i.status === "inactive", outputPort: "inactive" },
+    ],
+    defaultBranch: "inactive", // Fallback if no match
+    exclusive: true, // Only first match activates (default)
+  }
+);
+```
+
+### Multi-Path Fan-Out
+
+```typescript
+const fanOut = new ConditionalTask(
+  {},
+  {
+    branches: [
+      { id: "log", condition: () => true, outputPort: "logger" },
+      { id: "process", condition: () => true, outputPort: "processor" },
+      { id: "archive", condition: (i) => i.shouldArchive, outputPort: "archiver" },
+    ],
+    exclusive: false, // All matching branches activate
+  }
+);
+```
+
+## Configuration
+
+### BranchConfig
+
+Each branch in the `branches` array has the following properties:
+
+| Property     | Type                 | Description                      |
+| ------------ | -------------------- | -------------------------------- |
+| `id`         | `string`             | Unique identifier for the branch |
+| `condition`  | `(input) => boolean` | Predicate function to evaluate   |
+| `outputPort` | `string`             | Output port name for this branch |
+
+### ConditionalTaskConfig
+
+| Property        | Type             | Default     | Description                                   |
+| --------------- | ---------------- | ----------- | --------------------------------------------- |
+| `branches`      | `BranchConfig[]` | Required    | Array of branch configurations                |
+| `defaultBranch` | `string`         | `undefined` | Branch ID to use if no conditions match       |
+| `exclusive`     | `boolean`        | `true`      | If true, only first matching branch activates |
+
+## Execution Modes
+
+### Exclusive Mode (Default)
+
+In exclusive mode (`exclusive: true`), branches are evaluated in order and only the first matching branch becomes active. This is similar to a switch/case statement or if/else-if chain.
+
+```typescript
+const router = new ConditionalTask(
+  {},
+  {
+    branches: [
+      { id: "tier1", condition: (i) => i.value > 1000, outputPort: "tier1" },
+      { id: "tier2", condition: (i) => i.value > 100, outputPort: "tier2" },
+      { id: "tier3", condition: (i) => i.value > 0, outputPort: "tier3" },
+    ],
+    exclusive: true,
+  }
+);
+
+// With value = 500:
+// - tier1 condition: 500 > 1000 = false
+// - tier2 condition: 500 > 100 = true ← ACTIVATES, stops here
+// - tier3 is NOT evaluated (exclusive mode)
+```
+
+### Multi-Path Mode
+
+In multi-path mode (`exclusive: false`), all branches whose conditions evaluate to true become active simultaneously. This enables fan-out patterns.
+
+```typescript
+const multiRouter = new ConditionalTask(
+  {},
+  {
+    branches: [
+      { id: "even", condition: (i) => i.value % 2 === 0, outputPort: "evenPath" },
+      { id: "div3", condition: (i) => i.value % 3 === 0, outputPort: "div3Path" },
+      { id: "div5", condition: (i) => i.value % 5 === 0, outputPort: "div5Path" },
+    ],
+    exclusive: false,
+  }
+);
+
+// With value = 30:
+// - even: 30 % 2 === 0 = true ← ACTIVATES
+// - div3: 30 % 3 === 0 = true ← ACTIVATES
+// - div5: 30 % 5 === 0 = true ← ACTIVATES
+// All three downstream tasks will run!
+```
+
+## Output Behavior
+
+For each active branch, the task passes through its entire input to that branch's output port:
+
+```typescript
+// Input: { value: 150, metadata: { source: "api" } }
+
+// Output when "high" branch is active:
+{
+  _activeBranches: ["high"],
+  highPath: { value: 150, metadata: { source: "api" } }
+}
+```
+
+The `_activeBranches` property is always present and contains the IDs of all active branches.
+
+## Dataflow Wiring
+
+When wiring ConditionalTask outputs to downstream tasks, use `"*"` (DATAFLOW_ALL_PORTS) as the target port to pass all properties from the branch output:
+
+```typescript
+// Pass all properties from the branch output to the downstream task
+graph.addDataflow(
+  new Dataflow(
+    conditional.config.id,
+    "highPath", // Source port (branch output)
+    handler.config.id,
+    "*" // Target: all ports (passes { value, metadata, ... })
+  )
+);
+```
+
+## Disabled Status Propagation
+
+When a branch is inactive, its outgoing dataflow is set to `DISABLED` status. The graph runner then propagates this status:
+
+1. If ALL incoming dataflows to a task are `DISABLED`, that task becomes `DISABLED`
+2. The disabled task's outgoing dataflows are also set to `DISABLED`
+3. This cascades through the graph until no more tasks can be disabled
+
+This ensures that tasks which cannot receive data (because all paths to them are disabled) don't run unnecessarily.
+
+## Inspecting Branch Status
+
+After execution, you can inspect which branches were activated:
+
+```typescript
+await conditionalTask.run({ value: 150 });
+
+// Check individual branch
+if (conditionalTask.isBranchActive("high")) {
+  console.log("High value path was taken");
+}
+
+// Get all active branches
+const active = conditionalTask.getActiveBranches();
+console.log("Active branches:", Array.from(active));
+
+// Get port status map
+const portStatus = conditionalTask.getPortActiveStatus();
+for (const [port, isActive] of portStatus) {
+  console.log(`Port ${port}: ${isActive ? "active" : "inactive"}`);
+}
+```
+
+## Events
+
+ConditionalTask emits a custom event after branch evaluation:
+
+```typescript
+conditionalTask.on("branches_evaluated", (activeBranches: Set<string>) => {
+  console.log("Active branches:", Array.from(activeBranches));
+});
+```
+
+## Error Handling
+
+If a condition function throws an error, the branch is treated as if the condition returned `false`:
+
+```typescript
+const router = new ConditionalTask(
+  {},
+  {
+    branches: [
+      {
+        id: "risky",
+        condition: (i) => {
+          if (!i.data) throw new Error("No data!");
+          return i.data.value > 100;
+        },
+        outputPort: "risky",
+      },
+      { id: "safe", condition: () => true, outputPort: "safe" },
+    ],
+  }
+);
+
+// If input.data is undefined:
+// - "risky" condition throws, treated as false
+// - "safe" condition returns true, becomes active
+// Console warning: Condition evaluation failed for branch "risky": Error: No data!
+```
+
+## Integration with Task Graph
+
+ConditionalTask integrates seamlessly with TaskGraph and its scheduler:
+
+1. ConditionalTask executes and determines active branches
+2. Graph runner sets dataflow status based on branch activation
+3. Scheduler respects DISABLED status when determining ready tasks
+4. Downstream tasks on disabled branches never execute
+
+This makes ConditionalTask ideal for implementing:
+
+- Feature flags
+- A/B testing
+- Error handling and retry logic
+- Priority-based routing
+- Validation pipelines
+- Any workflow that requires conditional execution paths