@upstash/workflow 0.2.11 → 0.2.13

package/svelte.mjs

@@ -2,7 +2,7 @@ import {
   SDK_TELEMETRY,
   serveBase,
   serveManyBase
-} from "./chunk-WQAJ2RSZ.mjs";
+} from "./chunk-XVNSBBDC.mjs";
 
 // platforms/svelte.ts
 var telemetry = {

package/{types-DS9q8FyV.d.ts → types-C1WIgVLA.d.mts}

@@ -2,8 +2,47 @@ import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMetho
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
-import * as _ai_sdk_openai from '@ai-sdk/openai';
+import { createOpenAI } from '@ai-sdk/openai';
 
+declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
+type LogLevel = (typeof LOG_LEVELS)[number];
+type ChatLogEntry = {
+    timestamp: number;
+    workflowRunId: string;
+    logLevel: LogLevel;
+    eventType: "ENDPOINT_START" | "SUBMIT_THIRD_PARTY_RESULT" | "CREATE_CONTEXT" | "SUBMIT_FIRST_INVOCATION" | "RUN_SINGLE" | "RUN_PARALLEL" | "SUBMIT_STEP" | "SUBMIT_CLEANUP" | "RESPONSE_WORKFLOW" | "RESPONSE_DEFAULT" | "ERROR";
+    details: unknown;
+};
+type WorkflowLoggerOptions = {
+    logLevel: LogLevel;
+    logOutput: "console";
+};
+declare class WorkflowLogger {
+    private logs;
+    private options;
+    private workflowRunId?;
+    constructor(options: WorkflowLoggerOptions);
+    log(level: LogLevel, eventType: ChatLogEntry["eventType"], details?: unknown): Promise<void>;
+    setWorkflowRunId(workflowRunId: string): void;
+    private writeToConsole;
+    private shouldLog;
+    static getLogger(verbose?: boolean | WorkflowLogger): WorkflowLogger | undefined;
+}
+
+type HeadersResponse = {
+    headers: Record<string, string>;
+    contentType: string;
+};
+
+type StepParams = {
+    context: WorkflowContext;
+} & Pick<HeaderParams, "telemetry"> & Required<Pick<HeaderParams, "step" | "invokeCount">>;
+type GetHeaderParams = StepParams;
+type GetBodyParams = StepParams & Omit<HeadersResponse, "contentType">;
+type SubmitStepParams = StepParams & Pick<HeadersResponse, "headers"> & {
+    body: string;
+    isParallel: boolean;
+};
 /**
  * Base class outlining steps. Basically, each step kind (run/sleep/sleepUntil)
  * should have two methods: getPlanStep & getResultStep.
@@ -44,31 +83,11 @@ declare abstract class BaseLazyStep<TResult = unknown> {
     parseOut(out: unknown): TResult;
     protected safeParseOut(out: string): TResult;
     protected static tryParsing(stepOut: unknown): any;
-}
-
-declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
-type LogLevel = (typeof LOG_LEVELS)[number];
-type ChatLogEntry = {
-    timestamp: number;
-    workflowRunId: string;
-    logLevel: LogLevel;
-    eventType: "ENDPOINT_START" | "SUBMIT_THIRD_PARTY_RESULT" | "CREATE_CONTEXT" | "SUBMIT_FIRST_INVOCATION" | "RUN_SINGLE" | "RUN_PARALLEL" | "SUBMIT_STEP" | "SUBMIT_CLEANUP" | "RESPONSE_WORKFLOW" | "RESPONSE_DEFAULT" | "ERROR";
-    details: unknown;
-};
-type WorkflowLoggerOptions = {
-    logLevel: LogLevel;
-    logOutput: "console";
-};
-declare class WorkflowLogger {
-    private logs;
-    private options;
-    private workflowRunId?;
-    constructor(options: WorkflowLoggerOptions);
-    log(level: LogLevel, eventType: ChatLogEntry["eventType"], details?: unknown): Promise<void>;
-    setWorkflowRunId(workflowRunId: string): void;
-    private writeToConsole;
-    private shouldLog;
-    static getLogger(verbose?: boolean | WorkflowLogger): WorkflowLogger | undefined;
+    getBody({ step }: GetBodyParams): string;
+    getHeaders({ context, telemetry, invokeCount, step }: GetHeaderParams): HeadersResponse;
+    submitStep({ context, body, headers }: SubmitStepParams): Promise<{
+        messageId: string;
+    }[]>;
 }
 
 declare class AutoExecutor {
@@ -156,12 +175,6 @@ declare class AutoExecutor {
      * @returns parallel call state
      */
     protected getParallelCallState(parallelStepCount: number, initialStepCount: number): ParallelCallState;
-    /**
-     * sends the steps to QStash as batch
-     *
-     * @param steps steps to send
-     */
-    private submitStepsToQStash;
     /**
      * Get the promise by executing the lazt steps list. If there is a single
      * step, we call `runSingle`. Otherwise `runParallel` is called.
@@ -406,16 +419,46 @@ declare class WorkflowApi extends BaseWorkflowApi {
 }
 
 /**
- * creates an AI SDK openai client with a custom
- * fetch implementation which uses context.call.
+ * An Agent which utilizes the model and tools available to it
+ * to achieve a given task
  *
- * @param context workflow context
- * @returns ai sdk openai
+ * @param name Name of the agent
+ * @param background Background of the agent
+ * @param model LLM model to use
+ * @param tools tools available to the agent
+ * @param maxSteps number of times the agent can call the LLM at most. If
+ *   the agent abruptly stops execution after calling tools, you may need
+ *   to increase maxSteps
+ * @param temparature temparature used when calling the LLM
  */
-declare const createWorkflowOpenAI: (context: WorkflowContext, config?: {
-    baseURL?: string;
-    apiKey?: string;
-}) => _ai_sdk_openai.OpenAIProvider;
+declare class Agent {
+    readonly name: AgentParameters["name"];
+    readonly tools: AgentParameters["tools"];
+    readonly maxSteps: AgentParameters["maxSteps"];
+    readonly background: AgentParameters["background"];
+    readonly model: AgentParameters["model"];
+    readonly temparature: AgentParameters["temparature"];
+    private readonly context;
+    constructor({ tools, maxSteps, background, name, model, temparature }: AgentParameters, context: WorkflowContext);
+    /**
+     * Trigger the agent by passing a prompt
+     *
+     * @param prompt task to assign to the agent
+     * @returns Response as `{ text: string }`
+     */
+    call({ prompt }: {
+        prompt: string;
+    }): Promise<{
+        text: string;
+    }>;
+    /**
+     * Convert the agent to a tool which can be used by other agents.
+     *
+     * @returns the agent as a tool
+     */
+    asTool(): AISDKTool;
+}
+
 declare class WorkflowTool<TSchema extends ZodType = ZodType> implements LangchainTool {
     /**
      * description of the tool
@@ -541,53 +584,18 @@ type MultiAgentTaskParams = TaskParams & {
      */
     background?: string;
 };
-type ModelParams = Parameters<ReturnType<typeof createWorkflowOpenAI>>;
+type ModelParams = Parameters<ReturnType<typeof createOpenAI>>;
+type AgentCallParams = Pick<CallSettings, "flowControl" | "retries" | "timeout">;
 type CustomModelSettings = ModelParams["1"] & {
     baseURL?: string;
     apiKey?: string;
+} & {
+    callSettings: AgentCallParams;
 };
 type CustomModelParams = [ModelParams[0], CustomModelSettings?];
-
-/**
- * An Agent which utilizes the model and tools available to it
- * to achieve a given task
- *
- * @param name Name of the agent
- * @param background Background of the agent
- * @param model LLM model to use
- * @param tools tools available to the agent
- * @param maxSteps number of times the agent can call the LLM at most. If
- *   the agent abruptly stops execution after calling tools, you may need
- *   to increase maxSteps
- * @param temparature temparature used when calling the LLM
- */
-declare class Agent {
-    readonly name: AgentParameters["name"];
-    readonly tools: AgentParameters["tools"];
-    readonly maxSteps: AgentParameters["maxSteps"];
-    readonly background: AgentParameters["background"];
-    readonly model: AgentParameters["model"];
-    readonly temparature: AgentParameters["temparature"];
-    private readonly context;
-    constructor({ tools, maxSteps, background, name, model, temparature }: AgentParameters, context: WorkflowContext);
-    /**
-     * Trigger the agent by passing a prompt
-     *
-     * @param prompt task to assign to the agent
-     * @returns Response as `{ text: string }`
-     */
-    call({ prompt }: {
-        prompt: string;
-    }): Promise<{
-        text: string;
-    }>;
-    /**
-     * Convert the agent to a tool which can be used by other agents.
-     *
-     * @returns the agent as a tool
-     */
-    asTool(): AISDKTool;
-}
+type ProviderFunction = (params: {
+    fetch: typeof fetch;
+}) => any;
 
 /**
  * An Agent Task
@@ -700,6 +708,14 @@ declare class WorkflowAgents {
      * creates an openai model for agents
      */
     openai(...params: CustomModelParams): ai.LanguageModelV1;
+    AISDKModel: <TProvider extends ProviderFunction>({ context, provider, providerParams, agentCallParams, }: {
+        context: WorkflowContext;
+        provider: TProvider;
+        providerParams?: Omit<Required<Parameters<TProvider>>[0], "fetch">;
+        agentCallParams? /**
+         * creates an openai model for agents
+         */: AgentCallParams;
+    }) => ReturnType<TProvider>;
 }
 
 /**
@@ -934,6 +950,11 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      *   }
      */
     call<TResult = unknown, TBody = unknown>(stepName: string, settings: CallSettings<TBody>): Promise<CallResponse<TResult>>;
+    call<TResult extends {
+        workflowRunId: string;
+    } = {
+        workflowRunId: string;
+    }, TBody = unknown>(stepName: string, settings: LazyInvokeStepParams<TBody, unknown> & Pick<CallSettings, "timeout">): Promise<CallResponse<TResult>>;
     /**
      * Pauses workflow execution until a specific event occurs or a timeout is reached.
      *
@@ -1150,6 +1171,13 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * Url to call if QStash retries are exhausted while executing the workflow
      */
     failureUrl?: string;
+    /**
+     * Error handler called when an error occurs in the workflow. This is
+     * different from `failureFunction` in that it is called when an error
+     * occurs in the workflow, while `failureFunction` is called when QStash
+     * retries are exhausted.
+     */
+    onError?: (error: Error) => void;
     /**
      * Failure function called when QStash retries are exhausted while executing
      * the workflow. Will overwrite `failureUrl` parameter with the workflow

package/{types-DS9q8FyV.d.mts → types-C1WIgVLA.d.ts}

@@ -2,8 +2,47 @@ import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMetho
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
-import * as _ai_sdk_openai from '@ai-sdk/openai';
+import { createOpenAI } from '@ai-sdk/openai';
 
+declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
+type LogLevel = (typeof LOG_LEVELS)[number];
+type ChatLogEntry = {
+    timestamp: number;
+    workflowRunId: string;
+    logLevel: LogLevel;
+    eventType: "ENDPOINT_START" | "SUBMIT_THIRD_PARTY_RESULT" | "CREATE_CONTEXT" | "SUBMIT_FIRST_INVOCATION" | "RUN_SINGLE" | "RUN_PARALLEL" | "SUBMIT_STEP" | "SUBMIT_CLEANUP" | "RESPONSE_WORKFLOW" | "RESPONSE_DEFAULT" | "ERROR";
+    details: unknown;
+};
+type WorkflowLoggerOptions = {
+    logLevel: LogLevel;
+    logOutput: "console";
+};
+declare class WorkflowLogger {
+    private logs;
+    private options;
+    private workflowRunId?;
+    constructor(options: WorkflowLoggerOptions);
+    log(level: LogLevel, eventType: ChatLogEntry["eventType"], details?: unknown): Promise<void>;
+    setWorkflowRunId(workflowRunId: string): void;
+    private writeToConsole;
+    private shouldLog;
+    static getLogger(verbose?: boolean | WorkflowLogger): WorkflowLogger | undefined;
+}
+
+type HeadersResponse = {
+    headers: Record<string, string>;
+    contentType: string;
+};
+
+type StepParams = {
+    context: WorkflowContext;
+} & Pick<HeaderParams, "telemetry"> & Required<Pick<HeaderParams, "step" | "invokeCount">>;
+type GetHeaderParams = StepParams;
+type GetBodyParams = StepParams & Omit<HeadersResponse, "contentType">;
+type SubmitStepParams = StepParams & Pick<HeadersResponse, "headers"> & {
+    body: string;
+    isParallel: boolean;
+};
 /**
  * Base class outlining steps. Basically, each step kind (run/sleep/sleepUntil)
  * should have two methods: getPlanStep & getResultStep.
@@ -44,31 +83,11 @@ declare abstract class BaseLazyStep<TResult = unknown> {
     parseOut(out: unknown): TResult;
     protected safeParseOut(out: string): TResult;
     protected static tryParsing(stepOut: unknown): any;
-}
-
-declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
-type LogLevel = (typeof LOG_LEVELS)[number];
-type ChatLogEntry = {
-    timestamp: number;
-    workflowRunId: string;
-    logLevel: LogLevel;
-    eventType: "ENDPOINT_START" | "SUBMIT_THIRD_PARTY_RESULT" | "CREATE_CONTEXT" | "SUBMIT_FIRST_INVOCATION" | "RUN_SINGLE" | "RUN_PARALLEL" | "SUBMIT_STEP" | "SUBMIT_CLEANUP" | "RESPONSE_WORKFLOW" | "RESPONSE_DEFAULT" | "ERROR";
-    details: unknown;
-};
-type WorkflowLoggerOptions = {
-    logLevel: LogLevel;
-    logOutput: "console";
-};
-declare class WorkflowLogger {
-    private logs;
-    private options;
-    private workflowRunId?;
-    constructor(options: WorkflowLoggerOptions);
-    log(level: LogLevel, eventType: ChatLogEntry["eventType"], details?: unknown): Promise<void>;
-    setWorkflowRunId(workflowRunId: string): void;
-    private writeToConsole;
-    private shouldLog;
-    static getLogger(verbose?: boolean | WorkflowLogger): WorkflowLogger | undefined;
+    getBody({ step }: GetBodyParams): string;
+    getHeaders({ context, telemetry, invokeCount, step }: GetHeaderParams): HeadersResponse;
+    submitStep({ context, body, headers }: SubmitStepParams): Promise<{
+        messageId: string;
+    }[]>;
 }
 
 declare class AutoExecutor {
@@ -156,12 +175,6 @@ declare class AutoExecutor {
      * @returns parallel call state
      */
     protected getParallelCallState(parallelStepCount: number, initialStepCount: number): ParallelCallState;
-    /**
-     * sends the steps to QStash as batch
-     *
-     * @param steps steps to send
-     */
-    private submitStepsToQStash;
     /**
      * Get the promise by executing the lazt steps list. If there is a single
      * step, we call `runSingle`. Otherwise `runParallel` is called.
@@ -406,16 +419,46 @@ declare class WorkflowApi extends BaseWorkflowApi {
 }
 
 /**
- * creates an AI SDK openai client with a custom
- * fetch implementation which uses context.call.
+ * An Agent which utilizes the model and tools available to it
+ * to achieve a given task
  *
- * @param context workflow context
- * @returns ai sdk openai
+ * @param name Name of the agent
+ * @param background Background of the agent
+ * @param model LLM model to use
+ * @param tools tools available to the agent
+ * @param maxSteps number of times the agent can call the LLM at most. If
+ *   the agent abruptly stops execution after calling tools, you may need
+ *   to increase maxSteps
+ * @param temparature temparature used when calling the LLM
  */
-declare const createWorkflowOpenAI: (context: WorkflowContext, config?: {
-    baseURL?: string;
-    apiKey?: string;
-}) => _ai_sdk_openai.OpenAIProvider;
+declare class Agent {
+    readonly name: AgentParameters["name"];
+    readonly tools: AgentParameters["tools"];
+    readonly maxSteps: AgentParameters["maxSteps"];
+    readonly background: AgentParameters["background"];
+    readonly model: AgentParameters["model"];
+    readonly temparature: AgentParameters["temparature"];
+    private readonly context;
+    constructor({ tools, maxSteps, background, name, model, temparature }: AgentParameters, context: WorkflowContext);
+    /**
+     * Trigger the agent by passing a prompt
+     *
+     * @param prompt task to assign to the agent
+     * @returns Response as `{ text: string }`
+     */
+    call({ prompt }: {
+        prompt: string;
+    }): Promise<{
+        text: string;
+    }>;
+    /**
+     * Convert the agent to a tool which can be used by other agents.
+     *
+     * @returns the agent as a tool
+     */
+    asTool(): AISDKTool;
+}
+
 declare class WorkflowTool<TSchema extends ZodType = ZodType> implements LangchainTool {
     /**
      * description of the tool
@@ -541,53 +584,18 @@ type MultiAgentTaskParams = TaskParams & {
      */
     background?: string;
 };
-type ModelParams = Parameters<ReturnType<typeof createWorkflowOpenAI>>;
+type ModelParams = Parameters<ReturnType<typeof createOpenAI>>;
+type AgentCallParams = Pick<CallSettings, "flowControl" | "retries" | "timeout">;
 type CustomModelSettings = ModelParams["1"] & {
     baseURL?: string;
     apiKey?: string;
+} & {
+    callSettings: AgentCallParams;
 };
 type CustomModelParams = [ModelParams[0], CustomModelSettings?];
-
-/**
- * An Agent which utilizes the model and tools available to it
- * to achieve a given task
- *
- * @param name Name of the agent
- * @param background Background of the agent
- * @param model LLM model to use
- * @param tools tools available to the agent
- * @param maxSteps number of times the agent can call the LLM at most. If
- *   the agent abruptly stops execution after calling tools, you may need
- *   to increase maxSteps
- * @param temparature temparature used when calling the LLM
- */
-declare class Agent {
-    readonly name: AgentParameters["name"];
-    readonly tools: AgentParameters["tools"];
-    readonly maxSteps: AgentParameters["maxSteps"];
-    readonly background: AgentParameters["background"];
-    readonly model: AgentParameters["model"];
-    readonly temparature: AgentParameters["temparature"];
-    private readonly context;
-    constructor({ tools, maxSteps, background, name, model, temparature }: AgentParameters, context: WorkflowContext);
-    /**
-     * Trigger the agent by passing a prompt
-     *
-     * @param prompt task to assign to the agent
-     * @returns Response as `{ text: string }`
-     */
-    call({ prompt }: {
-        prompt: string;
-    }): Promise<{
-        text: string;
-    }>;
-    /**
-     * Convert the agent to a tool which can be used by other agents.
-     *
-     * @returns the agent as a tool
-     */
-    asTool(): AISDKTool;
-}
+type ProviderFunction = (params: {
+    fetch: typeof fetch;
+}) => any;
 
 /**
  * An Agent Task
@@ -700,6 +708,14 @@ declare class WorkflowAgents {
      * creates an openai model for agents
      */
     openai(...params: CustomModelParams): ai.LanguageModelV1;
+    AISDKModel: <TProvider extends ProviderFunction>({ context, provider, providerParams, agentCallParams, }: {
+        context: WorkflowContext;
+        provider: TProvider;
+        providerParams?: Omit<Required<Parameters<TProvider>>[0], "fetch">;
+        agentCallParams? /**
+         * creates an openai model for agents
+         */: AgentCallParams;
+    }) => ReturnType<TProvider>;
 }
 
 /**
@@ -934,6 +950,11 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      *   }
      */
     call<TResult = unknown, TBody = unknown>(stepName: string, settings: CallSettings<TBody>): Promise<CallResponse<TResult>>;
+    call<TResult extends {
+        workflowRunId: string;
+    } = {
+        workflowRunId: string;
+    }, TBody = unknown>(stepName: string, settings: LazyInvokeStepParams<TBody, unknown> & Pick<CallSettings, "timeout">): Promise<CallResponse<TResult>>;
     /**
      * Pauses workflow execution until a specific event occurs or a timeout is reached.
      *
@@ -1150,6 +1171,13 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * Url to call if QStash retries are exhausted while executing the workflow
      */
     failureUrl?: string;
+    /**
+     * Error handler called when an error occurs in the workflow. This is
+     * different from `failureFunction` in that it is called when an error
+     * occurs in the workflow, while `failureFunction` is called when QStash
+     * retries are exhausted.
+     */
+    onError?: (error: Error) => void;
     /**
      * Failure function called when QStash retries are exhausted while executing
      * the workflow. Will overwrite `failureUrl` parameter with the workflow