@workglow/task-graph 0.0.52

package/dist/task/JobQueueTask.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Job, JobConstructorParam, JobQueue } from "@workglow/job-queue";
+import { ArrayTask } from "./ArrayTask";
+import { IExecuteContext } from "./ITask";
+import { TaskEventListeners } from "./TaskEvents";
+import { TaskConfig, TaskInput, TaskOutput } from "./TaskTypes";
+/**
+ * Configuration interface for JobQueueTask.
+ * Extends the base TaskConfig with job queue specific properties.
+ */
+export interface JobQueueTaskConfig extends TaskConfig {
+    /**
+     * Queue selection for the task
+     * - `true` (default): create/use the task's default queue
+     * - `false`: run directly without queueing (requires `canRunDirectly`)
+     * - `string`: use an explicitly registered queue name
+     */
+    queue?: boolean | string;
+}
+/**
+ * Extended event listeners for JobQueueTask.
+ * Adds progress event handling to base task event listeners.
+ */
+export type JobQueueTaskEventListeners = Omit<TaskEventListeners, "progress"> & {
+    progress: (progress: number, message?: string, details?: Record<string, any> | null) => void;
+};
+/**
+ * Abstract base class for tasks that operate within a job queue.
+ * Provides functionality for managing job execution, progress tracking, and queue integration.
+ *
+ * @template Input - Type of input data for the task
+ * @template Output - Type of output data produced by the task
+ * @template Config - Type of configuration object for the task
+ */
+export declare abstract class JobQueueTask<Input extends TaskInput = TaskInput, Output extends TaskOutput = TaskOutput, Config extends JobQueueTaskConfig = JobQueueTaskConfig> extends ArrayTask<Input, Output, Config> {
+    static readonly type: string;
+    static canRunDirectly: boolean;
+    /** Name of the queue currently processing the task */
+    currentQueueName?: string;
+    /** ID of the current job being processed */
+    currentJobId?: string | unknown;
+    /** ID of the current runner being used */
+    currentRunnerId?: string;
+    jobClass: new (config: JobConstructorParam<Input, Output>) => Job<Input, Output>;
+    constructor(input?: Input, config?: Config);
+    execute(input: Input, executeContext: IExecuteContext): Promise<Output | undefined>;
+    /**
+     * Override this method to create the right job class for the queue for this task
+     * @returns Promise<Job> - The created job
+     */
+    createJob(input: Input, queue?: JobQueue<any, any>): Promise<Job<any, any>>;
+    protected resolveQueue(input: Input): Promise<JobQueue<Input, Output> | undefined>;
+    protected getDefaultQueueName(_input: Input): Promise<string | undefined>;
+    protected createAndRegisterQueue(queueName: string, input: Input): Promise<JobQueue<Input, Output>>;
+    /**
+     * Aborts the task
+     * @returns A promise that resolves when the task is aborted
+     */
+    abort(): Promise<void>;
+}
+//# sourceMappingURL=JobQueueTask.d.ts.map

package/dist/task/JobQueueTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobQueueTask.d.ts","sourceRoot":"","sources":["../../src/task/JobQueueTask.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,GAAG,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,GAAG;IAC9E,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;CAC9F,CAAC;AAEF;;;;;;;GAOG;AACH,8BAAsB,YAAY,CAChC,KAAK,SAAS,SAAS,GAAG,SAAS,EACnC,MAAM,SAAS,UAAU,GAAG,UAAU,EACtC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB,CACtD,SAAQ,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IACxC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAkB;IAC9C,MAAM,CAAC,cAAc,UAAQ;IAE7B,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,KAAK,MAAM,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBAE5E,KAAK,GAAE,KAAmB,EAAE,MAAM,GAAE,MAAqB;IAQ/D,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAyDzF;;;OAGG;IACG,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;cASjE,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;cAmCxE,mBAAmB,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;cAI/D,sBAAsB,CACpC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IA4BnC;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAU7B"}

package/dist/task/Task.d.ts

@@ -0,0 +1,334 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { EventEmitter, SchemaNode, type DataPortSchema } from "@workglow/util";
+import { TaskGraph } from "../task-graph/TaskGraph";
+import type { IExecuteContext, IExecuteReactiveContext, ITask } from "./ITask";
+import { TaskError } from "./TaskError";
+import { type TaskEventListener, type TaskEventListeners, type TaskEventParameters, type TaskEvents } from "./TaskEvents";
+import type { JsonTaskItem, TaskGraphItemJson } from "./TaskJSON";
+import { TaskRunner } from "./TaskRunner";
+import { TaskStatus, type Provenance, type TaskConfig, type TaskInput, type TaskOutput, type TaskTypeName } from "./TaskTypes";
+/**
+ * Base class for all tasks that implements the ITask interface.
+ * This abstract class provides common functionality for both simple and compound tasks.
+ *
+ * The Task class is responsible for:
+ * 1. Defining what a task is (inputs, outputs, configuration)
+ * 2. Providing the execution logic (via execute and executeReactive)
+ * 3. Delegating the running logic to a TaskRunner
+ */
+export declare class Task<Input extends TaskInput = TaskInput, Output extends TaskOutput = TaskOutput, Config extends TaskConfig = TaskConfig> implements ITask<Input, Output, Config> {
+    /**
+     * The type identifier for this task class
+     */
+    static type: TaskTypeName;
+    /**
+     * The category this task belongs to
+     */
+    static category: string;
+    /**
+     * The title of this task
+     */
+    static title: string;
+    /**
+     * Whether this task has side effects
+     */
+    static cacheable: boolean;
+    /**
+     * Whether this task has dynamic input/output schemas that can change at runtime.
+     * Tasks with dynamic schemas should override instance methods for inputSchema() and/or outputSchema()
+     * and emit 'schemaChange' events when their schemas change.
+     */
+    static hasDynamicSchemas: boolean;
+    /**
+     * Input schema for this task
+     */
+    static inputSchema(): DataPortSchema;
+    /**
+     * Output schema for this task
+     */
+    static outputSchema(): DataPortSchema;
+    /**
+     * The actual task execution logic for subclasses to override
+     *
+     * @param input The input to the task
+     * @param config The configuration for the task
+     * @throws TaskError if the task fails
+     * @returns The output of the task or undefined if no changes
+     */
+    execute(input: Input, context: IExecuteContext): Promise<Output | undefined>;
+    /**
+     * Default implementation of executeReactive that does nothing.
+     * Subclasses should override this to provide actual reactive functionality.
+     *
+     * This is generally for UI updating, and should be lightweight.
+     * @param input The input to the task
+     * @param output The current output of the task
+     * @returns The updated output of the task or undefined if no changes
+     */
+    executeReactive(input: Input, output: Output, context: IExecuteReactiveContext): Promise<Output | undefined>;
+    /**
+     * Task runner for handling the task execution
+     */
+    protected _runner: TaskRunner<Input, Output, Config> | undefined;
+    /**
+     * Gets the task runner instance
+     * Creates a new one if it doesn't exist
+     */
+    get runner(): TaskRunner<Input, Output, Config>;
+    /**
+     * Runs the task and returns the output
+     * Delegates to the task runner
+     *
+     * @param overrides Optional input overrides
+     * @throws TaskError if the task fails
+     * @returns The task output
+     */
+    run(overrides?: Partial<Input>): Promise<Output>;
+    /**
+     * Runs the task in reactive mode
+     * Delegates to the task runner
+     *
+     * @param overrides Optional input overrides
+     * @returns The task output
+     */
+    runReactive(overrides?: Partial<Input>): Promise<Output>;
+    /**
+     * Aborts task execution
+     * Delegates to the task runner
+     */
+    abort(): void;
+    /**
+     * Disables task execution
+     * Delegates to the task runner
+     */
+    disable(): Promise<void>;
+    /**
+     * Gets input schema for this task
+     */
+    inputSchema(): DataPortSchema;
+    /**
+     * Gets output schema for this task
+     */
+    outputSchema(): DataPortSchema;
+    get type(): TaskTypeName;
+    get category(): string;
+    get title(): string;
+    get cacheable(): boolean;
+    /**
+     * Default input values for this task.
+     * If no overrides at run time, then this would be equal to the input.
+     * resetInputData() will reset inputs to these defaults.
+     */
+    defaults: Record<string, any>;
+    /**
+     * The input to the task at the time of the task run.
+     * This takes defaults from construction time and overrides from run time.
+     * It is the input that created the output.
+     */
+    runInputData: Record<string, any>;
+    /**
+     * The output of the task at the time of the task run.
+     * This is the result of the task execution.
+     */
+    runOutputData: Record<string, any>;
+    /**
+     * The configuration of the task
+     */
+    config: Config;
+    /**
+     * Current status of the task
+     */
+    status: TaskStatus;
+    /**
+     * Progress of the task (0-100)
+     */
+    progress: number;
+    /**
+     * When the task was created
+     */
+    createdAt: Date;
+    /**
+     * When the task started execution
+     */
+    startedAt?: Date;
+    /**
+     * When the task completed execution
+     */
+    completedAt?: Date;
+    /**
+     * Error that occurred during task execution, if any
+     */
+    error?: TaskError;
+    /**
+     * Event emitter for task lifecycle events
+     */
+    get events(): EventEmitter<TaskEventListeners>;
+    protected _events: EventEmitter<TaskEventListeners> | undefined;
+    /**
+     * Provenance information for the task
+     */
+    protected nodeProvenance: Provenance;
+    /**
+     * Creates a new task instance
+     *
+     * @param callerDefaultInputs Default input values provided by the caller
+     * @param config Configuration for the task
+     */
+    constructor(callerDefaultInputs?: Partial<Input>, config?: Partial<Config>);
+    /**
+     * Gets default input values from input schema
+     */
+    getDefaultInputsFromStaticInputDefinitions(): Partial<Input>;
+    /**
+     * Resets input data to defaults
+     */
+    resetInputData(): void;
+    /**
+     * Sets the default input values for the task
+     *
+     * @param defaults The default input values to set
+     */
+    setDefaults(defaults: Record<string, any>): void;
+    /**
+     * Sets input values for the task
+     *
+     * @param input Input values to set
+     */
+    setInput(input: Record<string, any>): void;
+    /**
+     * Adds/merges input data during graph execution.
+     * Unlike {@link setInput}, this method:
+     * - Detects changes using deep equality
+     * - Accumulates array values (appends rather than replaces)
+     * - Handles DATAFLOW_ALL_PORTS for pass-through
+     * - Handles additionalProperties for dynamic schemas
+     *
+     * @param overrides The input data to merge
+     * @returns true if any input data was changed, false otherwise
+     */
+    addInput(overrides: Partial<Input> | undefined): boolean;
+    /**
+     * Stub for narrowing input. Override in subclasses for custom logic.
+     * @param input The input to narrow
+     * @returns The (possibly narrowed) input
+     */
+    narrowInput(input: Record<string, any>): Promise<Record<string, any>>;
+    /**
+     * Subscribes to an event
+     */
+    subscribe<Event extends TaskEvents>(name: Event, fn: TaskEventListener<Event>): () => void;
+    /**
+     * Registers an event listener
+     */
+    on<Event extends TaskEvents>(name: Event, fn: TaskEventListener<Event>): void;
+    /**
+     * Removes an event listener
+     */
+    off<Event extends TaskEvents>(name: Event, fn: TaskEventListener<Event>): void;
+    /**
+     * Registers a one-time event listener
+     */
+    once<Event extends TaskEvents>(name: Event, fn: TaskEventListener<Event>): void;
+    /**
+     * Returns a promise that resolves when the specified event is emitted
+     */
+    waitOn<Event extends TaskEvents>(name: Event): Promise<TaskEventParameters<Event>>;
+    /**
+     * Emits an event
+     */
+    emit<Event extends TaskEvents>(name: Event, ...args: TaskEventParameters<Event>): void;
+    /**
+     * Emits a schemaChange event when the task's input or output schema changes.
+     * This should be called by tasks with dynamic schemas when their configuration
+     * changes in a way that affects their schemas.
+     *
+     * @param inputSchema - The new input schema (optional, will use current schema if not provided)
+     * @param outputSchema - The new output schema (optional, will use current schema if not provided)
+     */
+    protected emitSchemaChange(inputSchema?: DataPortSchema, outputSchema?: DataPortSchema): void;
+    /**
+     * The compiled input schema
+     */
+    private static _inputSchemaNode;
+    protected static generateInputSchemaNode(schema: DataPortSchema): SchemaNode;
+    /**
+     * Gets the compiled input schema
+     */
+    protected static getInputSchemaNode(type: TaskTypeName): SchemaNode;
+    protected getInputSchemaNode(type: TaskTypeName): SchemaNode;
+    /**
+     * Validates an input data object against the task's input schema
+     */
+    validateInput(input: Partial<Input>): Promise<boolean>;
+    /**
+     * Gets the task ID from the config
+     */
+    id(): unknown;
+    /**
+     * Gets provenance information for the task
+     */
+    getProvenance(): Provenance;
+    /**
+     * Strips symbol properties from an object to make it serializable
+     * @param obj The object to strip symbols from
+     * @returns A new object without symbol properties
+     */
+    private stripSymbols;
+    /**
+     * Serializes the task and its subtasks into a format that can be stored
+     * @returns The serialized task and subtasks
+     */
+    toJSON(): TaskGraphItemJson;
+    /**
+     * Converts the task to a JSON format suitable for dependency tracking
+     * @returns The task and subtasks in JSON thats easier for humans to read
+     */
+    toDependencyJSON(): JsonTaskItem;
+    /**
+     * Checks if the task has children. Useful to gate to use of the internal subGraph
+     * as this will return without creating a new graph if graph is non-existent .
+     *
+     * @returns True if the task has children, otherwise false
+     */
+    hasChildren(): boolean;
+    private _taskAddedListener;
+    /**
+     * The internal task graph containing subtasks
+     *
+     * In the base case, these may just be incidental tasks that are not part of the task graph
+     * but are used to manage the task's state as part of task execution. Therefore, the graph
+     * is not used by the default runner.
+     */
+    protected _subGraph: TaskGraph | undefined;
+    /**
+     * Sets the subtask graph for the compound task
+     * @param subGraph The subtask graph to set
+     */
+    set subGraph(subGraph: TaskGraph);
+    /**
+     * The internal task graph containing subtasks
+     *
+     * In the base case, these may just be incidental tasks that are not part of the task graph
+     * but are used to manage the task's state as part of task execution. Therefore, the graph
+     * is not used by the default runner.
+     *
+     * Creates a new graph if one doesn't exist.
+     *
+     * @returns The task graph
+     */
+    get subGraph(): TaskGraph;
+    /**
+     * Regenerates the task graph, which is internal state to execute() with config.own()
+     *
+     * This is a destructive operation that removes all dataflows and tasks from the graph.
+     * It is used to reset the graph to a clean state.
+     *
+     * GraphAsTask and others override this and do not call super
+     */
+    regenerateGraph(): void;
+}
+//# sourceMappingURL=Task.d.ts.map

package/dist/task/Task.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../src/task/Task.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAGL,YAAY,EACZ,UAAU,EAEV,KAAK,cAAc,EACpB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAoB,SAAS,EAAyB,MAAM,aAAa,CAAC;AACjF,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EAChB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACL,UAAU,EACV,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AAErB;;;;;;;;GAQG;AACH,qBAAa,IAAI,CACf,KAAK,SAAS,SAAS,GAAG,SAAS,EACnC,MAAM,SAAS,UAAU,GAAG,UAAU,EACtC,MAAM,SAAS,UAAU,GAAG,UAAU,CACtC,YAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IAMvC;;OAEG;IACH,OAAc,IAAI,EAAE,YAAY,CAAU;IAE1C;;OAEG;IACH,OAAc,QAAQ,EAAE,MAAM,CAAY;IAE1C;;OAEG;IACH,OAAc,KAAK,EAAE,MAAM,CAAM;IAEjC;;OAEG;IACH,OAAc,SAAS,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IACH,OAAc,iBAAiB,EAAE,OAAO,CAAS;IAEjD;;OAEG;WACW,WAAW,IAAI,cAAc;IAQ3C;;OAEG;WACW,YAAY,IAAI,cAAc;IAY5C;;;;;;;OAOG;IACU,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOzF;;;;;;;;OAQG;IACU,eAAe,CAC1B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAQ9B;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEjE;;;OAGG;IACH,IAAW,MAAM,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAKrD;IAED;;;;;;;OAOG;IACG,GAAG,CAAC,SAAS,GAAE,OAAO,CAAC,KAAK,CAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D;;;;;;OAMG;IACU,WAAW,CAAC,SAAS,GAAE,OAAO,CAAC,KAAK,CAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzE;;;OAGG;IACI,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrC;;OAEG;IACI,WAAW,IAAI,cAAc;IAIpC;;OAEG;IACI,YAAY,IAAI,cAAc;IAIrC,IAAW,IAAI,IAAI,YAAY,CAE9B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,SAAS,IAAI,OAAO,CAK9B;IAMD;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAEvC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAMxC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,UAAU,CAAsB;IAExC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;IAErB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAc;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAKpD;IACD,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,UAAU,CAAM;IAE1C;;;;;OAKG;gBACS,mBAAmB,GAAE,OAAO,CAAC,KAAK,CAAM,EAAE,MAAM,GAAE,OAAO,CAAC,MAAM,CAAM;IAuBlF;;OAEG;IACH,0CAA0C,IAAI,OAAO,CAAC,KAAK,CAAC;IAgC5D;;OAEG;IACI,cAAc,IAAI,IAAI;IAS7B;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAKvD;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAiCjD;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,OAAO;IAuE/D;;;;OAIG;IACU,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAQlF;;OAEG;IACI,SAAS,CAAC,KAAK,SAAS,UAAU,EACvC,IAAI,EAAE,KAAK,EACX,EAAE,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAC3B,MAAM,IAAI;IAIb;;OAEG;IACI,EAAE,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,IAAI;IAIpF;;OAEG;IACI,GAAG,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,IAAI;IAIrF;;OAEG;IACI,IAAI,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,IAAI;IAItF;;OAEG;IACI,MAAM,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAIzF;;OAEG;IACI,IAAI,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,GAAG,IAAI;IAM7F;;;;;;;OAOG;IACH,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc,GAAG,IAAI;IAU7F;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAsC;IAErE,SAAS,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,cAAc;IAU/D;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU;IAmBnE,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU;IAI5D;;OAEG;IACU,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBnE;;OAEG;IACI,EAAE,IAAI,OAAO;IAIpB;;OAEG;IACI,aAAa,IAAI,UAAU;IAQlC;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAmBpB;;;OAGG;IACI,MAAM,IAAI,iBAAiB;IAalC;;;OAGG;IACI,gBAAgB,IAAI,YAAY;IASvC;;;;;OAKG;IACI,WAAW,IAAI,OAAO;IAQ7B,OAAO,CAAC,kBAAkB,CAExB;IAEF;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAa;IAEvD;;;OAGG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAM/B;IAED;;;;;;;;;;OAUG;IACH,IAAI,QAAQ,IAAI,SAAS,CAMxB;IAED;;;;;;;OAOG;IACI,eAAe,IAAI,IAAI;CAW/B"}

package/dist/task/TaskError.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { JobError } from "@workglow/job-queue";
+import { BaseError } from "@workglow/util";
+export declare class TaskError extends BaseError {
+    static readonly type: string;
+    constructor(message: string);
+}
+/**
+ * A task configuration error
+ *
+ */
+export declare class TaskConfigurationError extends TaskError {
+    static readonly type: string;
+    constructor(message: string);
+}
+/**
+ * A task workflow error
+ */
+export declare class WorkflowError extends TaskError {
+    static readonly type: string;
+    constructor(message: string);
+}
+/**
+ * A task error that is caused by a task being aborted
+ *
+ * Examples: task.abort() was called, or some other reason an abort signal was received
+ */
+export declare class TaskAbortedError extends TaskError {
+    static readonly type: string;
+    constructor(message?: string);
+}
+/**
+ * A task error that is caused by a task failing
+ *
+ * Examples: task.run() threw an error
+ */
+export declare class TaskFailedError extends TaskError {
+    static readonly type: string;
+    constructor(message?: string);
+}
+export declare class JobTaskFailedError extends TaskFailedError {
+    static readonly type: string;
+    jobError: JobError;
+    constructor(err: JobError);
+}
+/**
+ * A task error that is caused by an error converting JSON to a Task
+ */
+export declare class TaskJSONError extends TaskError {
+    static readonly type: string;
+    constructor(message?: string);
+}
+/**
+ * A task error that is caused by invalid input data
+ *
+ * Examples: task.run() received invalid input data
+ */
+export declare class TaskInvalidInputError extends TaskError {
+    static readonly type: string;
+    constructor(message?: string);
+}
+//# sourceMappingURL=TaskError.d.ts.map

package/dist/task/TaskError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskError.d.ts","sourceRoot":"","sources":["../../src/task/TaskError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,SAAU,SAAQ,SAAS;IACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAe;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,SAAS;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAA4B;gBAC5C,OAAO,EAAE,MAAM;CAG5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAmB;gBACnC,OAAO,EAAE,MAAM;CAG5B;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAsB;gBACtC,OAAO,GAAE,MAAuB;CAG7C;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAqB;gBACrC,OAAO,GAAE,MAAsB;CAG5C;AAED,qBAAa,kBAAmB,SAAQ,eAAe;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAwB;IAC7C,QAAQ,EAAE,QAAQ,CAAC;gBACd,GAAG,EAAE,QAAQ;CAI1B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAmB;gBACnC,OAAO,GAAE,MAA0C;CAGhE;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,SAAS;IAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAA2B;gBAC3C,OAAO,GAAE,MAA6B;CAGnD"}

package/dist/task/TaskEvents.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { EventParameters, type DataPortSchema } from "@workglow/util";
+import { TaskStatus } from "../common";
+import { TaskAbortedError, TaskError } from "./TaskError";
+/**
+ * Event listeners for task lifecycle events
+ */
+export type TaskEventListeners = {
+    /** Fired when a task starts execution */
+    start: () => void;
+    /** Fired when a task completes successfully */
+    complete: () => void;
+    /** Fired when a task is aborted */
+    abort: (error: TaskAbortedError) => void;
+    /** Fired when a task encounters an error */
+    error: (error: TaskError) => void;
+    /** Fired when a task is disabled */
+    disabled: () => void;
+    /** Fired when a task reports progress */
+    progress: (progress: number, message?: string, ...args: any[]) => void;
+    /** Fired when a regenerative task regenerates its graph */
+    regenerate: () => void;
+    /** Fired when a task is reset to original state */
+    reset: () => void;
+    /** Fired when a task status is updated */
+    status: (status: TaskStatus) => void;
+    /** Fired when a task's input or output schema changes (for tasks with dynamic schemas) */
+    schemaChange: (inputSchema?: DataPortSchema, outputSchema?: DataPortSchema) => void;
+};
+/** Union type of all possible task event names */
+export type TaskEvents = keyof TaskEventListeners;
+/** Type for task event listener functions */
+export type TaskEventListener<Event extends TaskEvents> = TaskEventListeners[Event];
+/** Type for task event parameters */
+export type TaskEventParameters<Event extends TaskEvents> = EventParameters<TaskEventListeners, Event>;
+//# sourceMappingURL=TaskEvents.d.ts.map

package/dist/task/TaskEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskEvents.d.ts","sourceRoot":"","sources":["../../src/task/TaskEvents.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAK1D;;GAEG;AAEH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,IAAI,CAAC;IAErB,mCAAmC;IACnC,KAAK,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEzC,4CAA4C;IAC5C,KAAK,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAElC,oCAAoC;IACpC,QAAQ,EAAE,MAAM,IAAI,CAAC;IAErB,yCAAyC;IACzC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAEvE,2DAA2D;IAC3D,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB,mDAAmD;IACnD,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,0CAA0C;IAC1C,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IAErC,0FAA0F;IAC1F,YAAY,EAAE,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;CACrF,CAAC;AACF,kDAAkD;AAElD,MAAM,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAC;AAClD,6CAA6C;AAE7C,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,UAAU,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpF,qCAAqC;AAErC,MAAM,MAAM,mBAAmB,CAAC,KAAK,SAAS,UAAU,IAAI,eAAe,CACzE,kBAAkB,EAClB,KAAK,CACN,CAAC"}

package/dist/task/TaskJSON.d.ts

@@ -0,0 +1,82 @@
+import { TaskGraph } from "../task-graph/TaskGraph";
+import { CompoundMergeStrategy } from "../task-graph/TaskGraphRunner";
+import { DataPorts, Provenance, TaskInput } from "./TaskTypes";
+/**
+ * Represents a single task item in the JSON configuration.
+ * This structure defines how tasks should be configured in JSON format.
+ */
+export type JsonTaskItem = {
+    /** Unique identifier for the task */
+    id: unknown;
+    /** Type of task to create */
+    type: string;
+    /** Optional display name for the task */
+    name?: string;
+    /** Input configuration for the task */
+    input?: TaskInput;
+    /** Defines data flow between tasks */
+    dependencies?: {
+        /** Input parameter name mapped to source task output */
+        [x: string]: {
+            /** ID of the source task */
+            id: unknown;
+            /** Output parameter name from source task */
+            output: string;
+        } | Array<{
+            id: unknown;
+            output: string;
+        }>;
+    };
+    /** Optional user data to use for this task, not used by the task framework except it will be exported as part of the task JSON*/
+    extras?: DataPorts;
+    /** Optional metadata about task origin */
+    provenance?: Provenance;
+    /** Nested tasks for compound operations */
+    subtasks?: JsonTaskItem[];
+}; /**
+ * Represents a task graph item, which can be a task or a subgraph
+ */
+export type TaskGraphItemJson = {
+    id: unknown;
+    type: string;
+    name?: string;
+    input?: TaskInput;
+    provenance?: Provenance;
+    extras?: DataPorts;
+    subgraph?: TaskGraphJson;
+    merge?: CompoundMergeStrategy;
+};
+export type TaskGraphJson = {
+    tasks: TaskGraphItemJson[];
+    dataflows: DataflowJson[];
+};
+export type DataflowJson = {
+    sourceTaskId: unknown;
+    sourceTaskPortId: string;
+    targetTaskId: unknown;
+    targetTaskPortId: string;
+};
+/**
+ * Creates a task instance from a JSON task item configuration
+ * Validates required fields and resolves task type from registry
+ */
+export declare const createTaskFromDependencyJSON: (item: JsonTaskItem) => import("./ITask").ITask<any, any, any>;
+/**
+ * Creates a task graph from an array of JSON task items
+ * Recursively processes subtasks for compound tasks
+ */
+export declare const createGraphFromDependencyJSON: (jsonItems: JsonTaskItem[]) => TaskGraph;
+/**
+ * Creates a task instance from a task graph item JSON representation
+ * @param item The JSON representation of the task
+ * @returns A new task instance
+ * @throws Error if required fields are missing or invalid
+ */
+export declare const createTaskFromGraphJSON: (item: TaskGraphItemJson) => import("./ITask").ITask<any, any, any>;
+/**
+ * Creates a TaskGraph instance from its JSON representation
+ * @param graphJsonObj The JSON representation of the task graph
+ * @returns A new TaskGraph instance with all tasks and data flows
+ */
+export declare const createGraphFromGraphJSON: (graphJsonObj: TaskGraphJson) => TaskGraph;
+//# sourceMappingURL=TaskJSON.d.ts.map

package/dist/task/TaskJSON.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskJSON.d.ts","sourceRoot":"","sources":["../../src/task/TaskJSON.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAItE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AAK3E;;;GAGG;AAEH,MAAM,MAAM,YAAY,GAAG;IACzB,qCAAqC;IACrC,EAAE,EAAE,OAAO,CAAC;IAEZ,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,uCAAuC;IACvC,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,sCAAsC;IACtC,YAAY,CAAC,EAAE;QACb,wDAAwD;QACxD,CAAC,CAAC,EAAE,MAAM,GACN;YACE,4BAA4B;YAC5B,EAAE,EAAE,OAAO,CAAC;YAEZ,6CAA6C;YAC7C,MAAM,EAAE,MAAM,CAAC;SAChB,GACD,KAAK,CAAC;YACJ,EAAE,EAAE,OAAO,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC,CAAC;KACR,CAAC;IAEF,iIAAiI;IACjI,MAAM,CAAC,EAAE,SAAS,CAAC;IAEnB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC,CAAC;;GAEA;AAEH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAwBF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,GAAI,MAAM,YAAY,2CAS9D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,GAAI,WAAW,YAAY,EAAE,cAMtE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,MAAM,iBAAiB,2CAS9D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GAAI,cAAc,aAAa,cAgBnE,CAAC"}