@upstash/workflow 0.2.11 → 0.2.12

package/svelte.js

@@ -134,7 +134,7 @@ var formatWorkflowError = (error) => {
     message: error.message
   } : {
     error: "Error",
-    message: "An error occured while executing workflow."
+    message: `An error occured while executing workflow: '${typeof error === "string" ? error : JSON.stringify(error)}'`
   };
 };
 
@@ -2034,6 +2034,9 @@ var WorkflowApi = class extends BaseWorkflowApi {
   }
 };
 
+// src/agents/index.ts
+var import_openai3 = require("@ai-sdk/openai");
+
 // src/agents/adapters.ts
 var import_openai2 = require("@ai-sdk/openai");
 var import_ai = require("ai");
@@ -2053,46 +2056,49 @@ you need from that agent.
 `;
 
 // src/agents/adapters.ts
-var createWorkflowOpenAI = (context, config) => {
-  const { baseURL, apiKey } = config ?? {};
-  return (0, import_openai2.createOpenAI)({
-    baseURL,
-    apiKey,
-    compatibility: "strict",
-    fetch: async (input, init) => {
-      try {
-        const headers = init?.headers ? Object.fromEntries(new Headers(init.headers).entries()) : {};
-        const body = init?.body ? JSON.parse(init.body) : void 0;
-        const agentName = headers[AGENT_NAME_HEADER];
-        const stepName = agentName ? `Call Agent ${agentName}` : "Call Agent";
-        const responseInfo = await context.call(stepName, {
-          url: input.toString(),
-          method: init?.method,
-          headers,
-          body
-        });
-        const responseHeaders = new Headers(
-          Object.entries(responseInfo.header).reduce(
-            (acc, [key, values]) => {
-              acc[key] = values.join(", ");
-              return acc;
-            },
-            {}
-          )
-        );
-        return new Response(JSON.stringify(responseInfo.body), {
-          status: responseInfo.status,
-          headers: responseHeaders
-        });
-      } catch (error) {
-        if (error instanceof Error && error.name === "WorkflowAbort") {
-          throw error;
-        } else {
-          console.error("Error in fetch implementation:", error);
-          throw error;
-        }
-      }
+var fetchWithContextCall = async (context, ...params) => {
+  const [input, init] = params;
+  try {
+    const headers = init?.headers ? Object.fromEntries(new Headers(init.headers).entries()) : {};
+    const body = init?.body ? JSON.parse(init.body) : void 0;
+    const agentName = headers[AGENT_NAME_HEADER];
+    const stepName = agentName ? `Call Agent ${agentName}` : "Call Agent";
+    const responseInfo = await context.call(stepName, {
+      url: input.toString(),
+      method: init?.method,
+      headers,
+      body
+    });
+    const responseHeaders = new Headers(
+      Object.entries(responseInfo.header).reduce(
+        (acc, [key, values]) => {
+          acc[key] = values.join(", ");
+          return acc;
+        },
+        {}
+      )
+    );
+    return new Response(JSON.stringify(responseInfo.body), {
+      status: responseInfo.status,
+      headers: responseHeaders
+    });
+  } catch (error) {
+    if (error instanceof Error && error.name === "WorkflowAbort") {
+      throw error;
+    } else {
+      console.error("Error in fetch implementation:", error);
+      throw error;
     }
+  }
+};
+var createWorkflowModel = ({
+  context,
+  provider,
+  providerParams
+}) => {
+  return provider({
+    fetch: (...params) => fetchWithContextCall(context, ...params),
+    ...providerParams
   });
 };
 var wrapTools = ({
@@ -2332,9 +2338,14 @@ var WorkflowAgents = class {
   openai(...params) {
     const [model, settings] = params;
     const { baseURL, apiKey, ...otherSettings } = settings ?? {};
-    const openai2 = createWorkflowOpenAI(this.context, { baseURL, apiKey });
-    return openai2(model, otherSettings);
+    const openaiModel = this.AISDKModel({
+      context: this.context,
+      provider: import_openai3.createOpenAI,
+      providerParams: { baseURL, apiKey, compatibility: "strict" }
+    });
+    return openaiModel(model, otherSettings);
   }
+  AISDKModel = createWorkflowModel;
 };
 
 // src/context/context.ts
@@ -3057,6 +3068,7 @@ var processOptions = (options) => {
     retries: DEFAULT_RETRIES,
     useJSONContent: false,
     disableTelemetry: false,
+    onError: console.error,
     ...options
   };
 };
@@ -3106,7 +3118,8 @@ var serveBase = (routeFunction, telemetry2, options) => {
     retries,
     useJSONContent,
     disableTelemetry,
-    flowControl
+    flowControl,
+    onError
   } = processOptions(options);
   telemetry2 = disableTelemetry ? void 0 : telemetry2;
   const debug = WorkflowLogger.getLogger(verbose);
@@ -3235,8 +3248,19 @@ var serveBase = (routeFunction, telemetry2, options) => {
     try {
       return await handler(request);
     } catch (error) {
-      console.error(error);
-      return new Response(JSON.stringify(formatWorkflowError(error)), {
+      const formattedError = formatWorkflowError(error);
+      try {
+        onError?.(error);
+      } catch (onErrorError) {
+        const formattedOnErrorError = formatWorkflowError(onErrorError);
+        const errorMessage = `Error while running onError callback: '${formattedOnErrorError.message}'.
+Original error: '${formattedError.message}'`;
+        console.error(errorMessage);
+        return new Response(errorMessage, {
+          status: 500
+        });
+      }
+      return new Response(JSON.stringify(formattedError), {
         status: 500
       });
     }

package/svelte.mjs

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

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

@@ -405,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.
@@ -547,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
@@ -700,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>;
 }
 
 /**
@@ -1150,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-DS9q8FyV.d.mts → types-D1W0VOpy.d.ts}

@@ -405,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.
@@ -547,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
@@ -700,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>;
 }
 
 /**
@@ -1150,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