@workglow/ai 0.0.125 → 0.1.0

package/dist/task/ToolCallingTask.d.ts

@@ -1,385 +0,0 @@
-/**
- * @license
- * Copyright 2026 Steven Roussey <sroussey@gmail.com>
- * SPDX-License-Identifier: Apache-2.0
- */
-import { CreateWorkflow, JobQueueTaskConfig } from "@workglow/task-graph";
-import { DataPortSchema, FromSchema } from "@workglow/util/schema";
-import { ServiceRegistry } from "@workglow/util";
-import { StreamingAiTask } from "./base/StreamingAiTask";
-import type { ToolDefinition } from "./ToolCallingUtils";
-export interface ToolDefinitionWithTaskType extends ToolDefinition {
-    /** The task type name this definition was generated from. */
-    readonly taskType: string;
-}
-/**
- * Converts an allow-list of task type names into {@link ToolDefinitionWithTaskType} objects
- * suitable for the ToolCallingTask input. Each entry carries the originating
- * `taskType` so callers don't need to rely on index correspondence.
- *
- * Each task's `type`, `description`, `inputSchema()`, and `outputSchema()`
- * are used to build the tool definition.
- *
- * @param taskNames - Array of task type names registered in the task constructors
- * @param registry - Optional service registry for DI-based lookups
- * @returns Array of ToolDefinitionWithTaskType objects
- * @throws Error if a task name is not found in the registry
- */
-export declare function taskTypesToTools(taskNames: ReadonlyArray<string>, registry?: ServiceRegistry): ToolDefinitionWithTaskType[];
-export declare const ToolDefinitionSchema: {
-    readonly type: "object";
-    readonly properties: {
-        readonly name: {
-            readonly type: "string";
-            readonly title: "Name";
-            readonly description: "The tool name";
-        };
-        readonly description: {
-            readonly type: "string";
-            readonly title: "Description";
-            readonly description: "A description of what the tool does";
-        };
-        readonly inputSchema: {
-            readonly type: "object";
-            readonly title: "Input Schema";
-            readonly description: "JSON Schema describing the tool's input parameters";
-            readonly additionalProperties: true;
-        };
-        readonly outputSchema: {
-            readonly type: "object";
-            readonly title: "Output Schema";
-            readonly description: "JSON Schema describing what the tool returns";
-            readonly additionalProperties: true;
-        };
-        readonly configSchema: {
-            readonly type: "object";
-            readonly title: "Config Schema";
-            readonly description: "JSON Schema describing the task's configuration options (not sent to the LLM)";
-            readonly additionalProperties: true;
-        };
-        readonly config: {
-            readonly type: "object";
-            readonly title: "Config";
-            readonly description: "Concrete configuration values for the backing task (not sent to the LLM)";
-            readonly additionalProperties: true;
-        };
-    };
-    readonly required: readonly ["name", "description", "inputSchema"];
-    readonly additionalProperties: true;
-};
-export declare const ToolCallingInputSchema: {
-    readonly type: "object";
-    readonly properties: {
-        readonly model: {
-            readonly oneOf: readonly [{
-                readonly title: "Model";
-                readonly description: `The model ${string}`;
-            } & {
-                readonly format: import(".").TypeModelSemantic;
-                readonly type: "string";
-            }, {
-                readonly type: "object";
-                readonly properties: {
-                    readonly model_id: {
-                        readonly type: "string";
-                    };
-                    readonly tasks: {
-                        readonly type: "array";
-                        readonly items: {
-                            readonly type: "string";
-                        };
-                        readonly "x-ui-editor": "multiselect";
-                    };
-                    readonly title: {
-                        readonly type: "string";
-                    };
-                    readonly description: {
-                        readonly type: "string";
-                        readonly "x-ui-editor": "textarea";
-                    };
-                    readonly provider: {
-                        readonly type: "string";
-                    };
-                    readonly provider_config: {
-                        readonly type: "object";
-                        readonly properties: {
-                            readonly credential_key: {
-                                readonly type: "string";
-                                readonly format: "credential";
-                                readonly "x-ui-hidden": true;
-                            };
-                        };
-                        readonly additionalProperties: true;
-                        readonly default: {};
-                    };
-                    readonly metadata: {
-                        readonly type: "object";
-                        readonly default: {};
-                        readonly "x-ui-hidden": true;
-                    };
-                };
-                readonly required: readonly ["provider", "provider_config"];
-                readonly format: "model";
-                readonly additionalProperties: true;
-            } & {
-                readonly format: import(".").TypeModelSemantic;
-            }];
-        } & {
-            readonly format: import(".").TypeModelSemantic;
-        };
-        readonly prompt: {
-            readonly oneOf: readonly [{
-                readonly type: "string";
-                readonly title: "Prompt";
-                readonly description: "The prompt to send to the model";
-            }, {
-                readonly type: "array";
-                readonly title: "Prompt";
-                readonly description: "The prompt as an array of strings or content blocks";
-                readonly items: {
-                    readonly oneOf: readonly [{
-                        readonly type: "string";
-                    }, {
-                        readonly type: "object";
-                        readonly properties: {
-                            readonly type: {
-                                readonly type: "string";
-                                readonly enum: readonly ["text", "image", "audio"];
-                            };
-                        };
-                        readonly required: readonly ["type"];
-                        readonly additionalProperties: true;
-                    }];
-                };
-            }];
-            readonly title: "Prompt";
-            readonly description: "The prompt to send to the model";
-        };
-        readonly systemPrompt: {
-            readonly type: "string";
-            readonly title: "System Prompt";
-            readonly description: "Optional system instructions for the model";
-        };
-        readonly messages: {
-            readonly type: "array";
-            readonly title: "Messages";
-            readonly description: "Full conversation history for multi-turn interactions. When provided, used instead of prompt to construct the messages array sent to the provider.";
-            readonly items: {
-                readonly type: "object";
-                readonly properties: {
-                    readonly role: {
-                        readonly type: "string";
-                        readonly enum: readonly ["user", "assistant", "tool"];
-                    };
-                    readonly content: {};
-                };
-                readonly required: readonly ["role", "content"];
-                readonly additionalProperties: true;
-            };
-        };
-        readonly tools: {
-            readonly type: "array";
-            readonly format: "tasks";
-            readonly title: "Tools";
-            readonly description: "Tool definitions available for the model to call";
-            readonly items: {
-                readonly oneOf: readonly [{
-                    readonly type: "string";
-                    readonly format: "tasks";
-                    readonly description: "Task type name";
-                }, {
-                    readonly type: "object";
-                    readonly properties: {
-                        readonly name: {
-                            readonly type: "string";
-                            readonly title: "Name";
-                            readonly description: "The tool name";
-                        };
-                        readonly description: {
-                            readonly type: "string";
-                            readonly title: "Description";
-                            readonly description: "A description of what the tool does";
-                        };
-                        readonly inputSchema: {
-                            readonly type: "object";
-                            readonly title: "Input Schema";
-                            readonly description: "JSON Schema describing the tool's input parameters";
-                            readonly additionalProperties: true;
-                        };
-                        readonly outputSchema: {
-                            readonly type: "object";
-                            readonly title: "Output Schema";
-                            readonly description: "JSON Schema describing what the tool returns";
-                            readonly additionalProperties: true;
-                        };
-                        readonly configSchema: {
-                            readonly type: "object";
-                            readonly title: "Config Schema";
-                            readonly description: "JSON Schema describing the task's configuration options (not sent to the LLM)";
-                            readonly additionalProperties: true;
-                        };
-                        readonly config: {
-                            readonly type: "object";
-                            readonly title: "Config";
-                            readonly description: "Concrete configuration values for the backing task (not sent to the LLM)";
-                            readonly additionalProperties: true;
-                        };
-                    };
-                    readonly required: readonly ["name", "description", "inputSchema"];
-                    readonly additionalProperties: true;
-                }];
-            };
-        };
-        readonly toolChoice: {
-            readonly type: "string";
-            readonly title: "Tool Choice";
-            readonly description: "Controls tool selection: \"auto\" (model decides), \"none\" (no tools), \"required\" (must call a tool), or a specific tool name";
-            readonly "x-ui-group": "Configuration";
-        };
-        readonly maxTokens: {
-            readonly type: "number";
-            readonly title: "Max Tokens";
-            readonly description: "The maximum number of tokens to generate";
-            readonly minimum: 1;
-            readonly "x-ui-group": "Configuration";
-        };
-        readonly temperature: {
-            readonly type: "number";
-            readonly title: "Temperature";
-            readonly description: "The temperature to use for sampling";
-            readonly minimum: 0;
-            readonly maximum: 2;
-            readonly "x-ui-group": "Configuration";
-        };
-    };
-    readonly required: readonly ["model", "prompt", "tools"];
-    readonly additionalProperties: false;
-};
-export declare const ToolCallingOutputSchema: {
-    readonly type: "object";
-    readonly properties: {
-        readonly text: {
-            readonly anyOf: readonly [{
-                readonly type: "string";
-                readonly title: "Text";
-                readonly description: "Any text content generated by the model";
-                readonly "x-stream": "append";
-            }, {
-                readonly type: "array";
-                readonly items: {
-                    readonly type: "string";
-                    readonly title: "Text";
-                    readonly description: "Any text content generated by the model";
-                    readonly "x-stream": "append";
-                };
-            }];
-        };
-        readonly toolCalls: {
-            readonly anyOf: readonly [{
-                readonly type: "object";
-                readonly properties: {
-                    readonly id: {
-                        readonly type: "string";
-                        readonly title: "ID";
-                        readonly description: "Unique identifier for this tool call";
-                    };
-                    readonly name: {
-                        readonly type: "string";
-                        readonly title: "Name";
-                        readonly description: "The name of the tool to invoke";
-                    };
-                    readonly input: {
-                        readonly type: "object";
-                        readonly title: "Input";
-                        readonly description: "The input arguments for the tool call";
-                        readonly additionalProperties: true;
-                    };
-                };
-                readonly required: readonly ["id", "name", "input"];
-                readonly additionalProperties: false;
-                readonly "x-stream": "object";
-            }, {
-                readonly type: "array";
-                readonly items: {
-                    readonly type: "object";
-                    readonly properties: {
-                        readonly id: {
-                            readonly type: "string";
-                            readonly title: "ID";
-                            readonly description: "Unique identifier for this tool call";
-                        };
-                        readonly name: {
-                            readonly type: "string";
-                            readonly title: "Name";
-                            readonly description: "The name of the tool to invoke";
-                        };
-                        readonly input: {
-                            readonly type: "object";
-                            readonly title: "Input";
-                            readonly description: "The input arguments for the tool call";
-                            readonly additionalProperties: true;
-                        };
-                    };
-                    readonly required: readonly ["id", "name", "input"];
-                    readonly additionalProperties: false;
-                    readonly "x-stream": "object";
-                };
-            }];
-        };
-    };
-    readonly required: readonly ["text", "toolCalls"];
-    readonly additionalProperties: false;
-};
-/**
- * Runtime input type for ToolCallingTask.
- *
- * The schema uses `oneOf: [string, object]` so the UI can accept both task-name
- * references and inline tool definitions, but the input resolver converts all
- * strings to {@link ToolDefinition} objects before execution. The `tools` field
- * is therefore narrowed to `ToolDefinition[]` here.
- *
- * Extends the schema-derived base with the
- * `messages` field typed explicitly (the loose `content: {}` in the
- * schema prevents `FromSchema` from producing a useful type).
- */
-export type ToolCallingTaskInput = Omit<FromSchema<typeof ToolCallingInputSchema>, "tools"> & {
-    readonly tools: ToolDefinition[];
-    readonly messages?: ReadonlyArray<{
-        readonly role: "user" | "assistant" | "tool";
-        readonly content: unknown;
-    }>;
-};
-export type ToolCallingTaskOutput = FromSchema<typeof ToolCallingOutputSchema>;
-export declare class ToolCallingTask extends StreamingAiTask<ToolCallingTaskInput, ToolCallingTaskOutput, JobQueueTaskConfig> {
-    static type: string;
-    static category: string;
-    static title: string;
-    static description: string;
-    static inputSchema(): DataPortSchema;
-    static outputSchema(): DataPortSchema;
-}
-/**
- * Convenience function to run a tool calling task.
- */
-export declare const toolCalling: (input: ToolCallingTaskInput, config?: JobQueueTaskConfig | undefined) => Promise<{
-    text: string | string[];
-    toolCalls: {
-        id: string;
-        input: {
-            [x: string]: unknown;
-        };
-        name: string;
-    }[] | {
-        id: string;
-        input: {
-            [x: string]: unknown;
-        };
-        name: string;
-    };
-}>;
-declare module "@workglow/task-graph" {
-    interface Workflow {
-        toolCalling: CreateWorkflow<ToolCallingTaskInput, ToolCallingTaskOutput, JobQueueTaskConfig>;
-    }
-}
-//# sourceMappingURL=ToolCallingTask.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ToolCallingTask.d.ts","sourceRoot":"","sources":["../../src/task/ToolCallingTask.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,cAAc,EAEd,kBAAkB,EAEnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAMzD,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,EAChC,QAAQ,CAAC,EAAE,eAAe,GACzB,0BAA0B,EAAE,CAsB9B;AAMD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwCvB,CAAC;AA4BX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsFA,CAAC;AAEpC,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgBD,CAAC;AAEpC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,EAAE,OAAO,CAAC,GAAG;IAC5F,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;QAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;QAC7C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;KAC3B,CAAC,CAAC;CACJ,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAM/E,qBAAa,eAAgB,SAAQ,eAAe,CAClD,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,CACnB;IACC,OAAc,IAAI,SAAqB;IACvC,OAAc,QAAQ,SAAmB;IACzC,OAAc,KAAK,SAAkB;IACrC,OAAc,WAAW,SACkG;IAC3H,OAAc,WAAW,IAAI,cAAc,CAE1C;IACD,OAAc,YAAY,IAAI,cAAc,CAE3C;CACF;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;EAEvB,CAAC;AAEF,OAAO,QAAQ,sBAAsB,CAAC,CAAC;IACrC,UAAU,QAAQ;QAChB,WAAW,EAAE,cAAc,CAAC,oBAAoB,EAAE,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;KAC9F;CACF"}

package/dist/task/ToolCallingUtils.d.ts

@@ -1,65 +0,0 @@
-/**
- * @license
- * Copyright 2026 Steven Roussey <sroussey@gmail.com>
- * SPDX-License-Identifier: Apache-2.0
- */
-import { type JsonSchema } from "@workglow/util/worker";
-/**
- * A tool definition that can be passed to an LLM for tool calling.
- * Can be created manually or generated from TaskRegistry entries via `taskTypesToTools` in ToolCallingTask.
- *
- * The `name` is used both as the tool name presented to the LLM and as a
- * lookup key for the backing Task in the TaskRegistry. When a tool is
- * backed by a configurable task (e.g. `McpToolCallTask`, `JavaScriptTask`),
- * `configSchema` describes what configuration the task accepts and `config`
- * provides the concrete values. The LLM never sees `configSchema` or
- * `config` — they are setup-time concerns used when instantiating the task.
- */
-export interface ToolDefinition {
-    name: string;
-    description: string;
-    inputSchema: JsonSchema;
-    outputSchema?: JsonSchema;
-    /** JSON Schema describing the task's configuration options. */
-    configSchema?: JsonSchema;
-    /** Concrete configuration values matching {@link configSchema}. */
-    config?: Record<string, unknown>;
-    /**
-     * Optional custom executor function. When provided, the tool is executed
-     * by calling this function directly instead of instantiating a Task.
-     */
-    execute?: (input: Record<string, unknown>) => Promise<Record<string, unknown>>;
-}
-/**
- * A tool call returned by the LLM, requesting invocation of a specific tool.
- */
-export interface ToolCall {
-    id: string;
-    name: string;
-    input: Record<string, unknown>;
-}
-export type ToolCalls = Array<ToolCall>;
-/**
- * Controls which tools the model may call.
- * - `"auto"` — model decides whether to call tools
- * - `"none"` — model must not call any tools
- * - `"required"` — model must call at least one tool
- * - any other string — model must call the tool with that name
- */
-export type ToolChoiceOption = "auto" | "none" | "required" | (string & {});
-/**
- * Builds a tool description string for provider APIs, appending the output
- * schema when present. Shared across all provider implementations.
- */
-export declare function buildToolDescription(tool: ToolDefinition): string;
-/**
- * Validates that a tool call name returned by the LLM matches one of the
- * allowed tool definitions. Returns true if valid, false otherwise.
- */
-export declare function isAllowedToolName(name: string, allowedTools: ReadonlyArray<ToolDefinition>): boolean;
-/**
- * Filters an array of tool calls, removing any whose name does not appear
- * in the provided tools list. Returns the filtered array.
- */
-export declare function filterValidToolCalls(toolCalls: ToolCalls, allowedTools: ReadonlyArray<ToolDefinition>): ToolCalls;
-//# sourceMappingURL=ToolCallingUtils.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ToolCallingUtils.d.ts","sourceRoot":"","sources":["../../src/task/ToolCallingUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAa,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnE;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAChF;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE5E;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAMjE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,GAC1C,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,GAC1C,SAAS,CAWX"}

package/dist/types.d.ts.map

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