@upstash/workflow 0.2.10 → 0.2.12

package/{types-CYhDXnf8.d.ts → types-D1W0VOpy.d.mts}

@@ -14,6 +14,7 @@ import * as _ai_sdk_openai from '@ai-sdk/openai';
 declare abstract class BaseLazyStep<TResult = unknown> {
     readonly stepName: string;
     abstract readonly stepType: StepType;
+    protected abstract readonly allowUndefinedOut: boolean;
     constructor(stepName: string);
     /**
      * plan step to submit when step will run parallel with other
@@ -32,6 +33,17 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      * @param stepId
      */
     abstract getResultStep(concurrent: number, stepId: number): Promise<Step<TResult>>;
+    /**
+     * parse the out field of a step result.
+     *
+     * will be called when returning the steps to the context from auto executor
+     *
+     * @param out field of the step
+     * @returns parsed out field
+     */
+    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"];
@@ -393,6 +405,47 @@ declare class WorkflowApi extends BaseWorkflowApi {
     get anthropic(): AnthropicAPI;
 }
 
+/**
+ * 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;
+}
+
 /**
  * creates an AI SDK openai client with a custom
  * fetch implementation which uses context.call.
@@ -535,47 +588,9 @@ type CustomModelSettings = ModelParams["1"] & {
     apiKey?: string;
 };
 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
@@ -688,6 +703,11 @@ declare class WorkflowAgents {
      * creates an openai model for agents
      */
     openai(...params: CustomModelParams): ai.LanguageModelV1;
+    AISDKModel: <TProvider extends ProviderFunction>({ context, provider, providerParams, }: {
+        context: WorkflowContext;
+        provider: TProvider;
+        providerParams?: Omit<Required<Parameters<TProvider>>[0], "fetch">;
+    }) => ReturnType<TProvider>;
 }
 
 /**
@@ -979,11 +999,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns notify response which has event id, event data and list of waiters which were notified
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
-    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<{
-        body: TResult;
-        isCanceled?: boolean;
-        isFailed?: boolean;
-    }>;
+    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<InvokeStepResponse<TResult>>;
     /**
      * Cancel the current workflow run
      *
@@ -1006,6 +1022,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
  * Neeeded to resolve import issues
  */
 type WorkflowClient = {
+    batch: InstanceType<typeof Client>["batch"];
     batchJSON: InstanceType<typeof Client>["batchJSON"];
     publishJSON: InstanceType<typeof Client>["publishJSON"];
     publish: InstanceType<typeof Client>["publish"];
@@ -1141,6 +1158,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-CYhDXnf8.d.mts → types-D1W0VOpy.d.ts}

@@ -14,6 +14,7 @@ import * as _ai_sdk_openai from '@ai-sdk/openai';
 declare abstract class BaseLazyStep<TResult = unknown> {
     readonly stepName: string;
     abstract readonly stepType: StepType;
+    protected abstract readonly allowUndefinedOut: boolean;
     constructor(stepName: string);
     /**
      * plan step to submit when step will run parallel with other
@@ -32,6 +33,17 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      * @param stepId
      */
     abstract getResultStep(concurrent: number, stepId: number): Promise<Step<TResult>>;
+    /**
+     * parse the out field of a step result.
+     *
+     * will be called when returning the steps to the context from auto executor
+     *
+     * @param out field of the step
+     * @returns parsed out field
+     */
+    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"];
@@ -393,6 +405,47 @@ declare class WorkflowApi extends BaseWorkflowApi {
     get anthropic(): AnthropicAPI;
 }
 
+/**
+ * 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;
+}
+
 /**
  * creates an AI SDK openai client with a custom
  * fetch implementation which uses context.call.
@@ -535,47 +588,9 @@ type CustomModelSettings = ModelParams["1"] & {
     apiKey?: string;
 };
 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
@@ -688,6 +703,11 @@ declare class WorkflowAgents {
      * creates an openai model for agents
      */
     openai(...params: CustomModelParams): ai.LanguageModelV1;
+    AISDKModel: <TProvider extends ProviderFunction>({ context, provider, providerParams, }: {
+        context: WorkflowContext;
+        provider: TProvider;
+        providerParams?: Omit<Required<Parameters<TProvider>>[0], "fetch">;
+    }) => ReturnType<TProvider>;
 }
 
 /**
@@ -979,11 +999,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns notify response which has event id, event data and list of waiters which were notified
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
-    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<{
-        body: TResult;
-        isCanceled?: boolean;
-        isFailed?: boolean;
-    }>;
+    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<InvokeStepResponse<TResult>>;
     /**
      * Cancel the current workflow run
      *
@@ -1006,6 +1022,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
  * Neeeded to resolve import issues
  */
 type WorkflowClient = {
+    batch: InstanceType<typeof Client>["batch"];
     batchJSON: InstanceType<typeof Client>["batchJSON"];
     publishJSON: InstanceType<typeof Client>["publishJSON"];
     publish: InstanceType<typeof Client>["publish"];
@@ -1141,6 +1158,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