@upstash/workflow 0.2.8-rc-invoke → 0.2.8

package/{chunk-IWAW7GIG.mjs → chunk-BPUSHNSD.mjs}

@@ -41,7 +41,7 @@ var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
 var NO_CONCURRENCY = 1;
 var DEFAULT_RETRIES = 3;
-var VERSION = "v0.2.7";
+var VERSION = "v0.2.3";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -96,10 +96,133 @@ var StepTypes = [
   "SleepUntil",
   "Call",
   "Wait",
-  "Notify",
-  "Invoke"
+  "Notify"
 ];
 
+// src/agents/adapters.ts
+import { createOpenAI } from "@ai-sdk/openai";
+import { tool } from "ai";
+
+// src/agents/constants.ts
+var AGENT_NAME_HEADER = "upstash-agent-name";
+var MANAGER_AGENT_PROMPT = `You are an agent orchestrating other AI Agents.
+
+These other agents have tools available to them.
+
+Given a prompt, utilize these agents to address requests.
+
+Don't always call all the agents provided to you at the same time. You can call one and use it's response to call another.
+
+Avoid calling the same agent twice in one turn. Instead, prefer to call it once but provide everything
+you need from that agent.
+`;
+
+// src/agents/adapters.ts
+var createWorkflowOpenAI = (context, config) => {
+  const { baseURL, apiKey } = config ?? {};
+  return 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 wrapTools = ({
+  context,
+  tools
+}) => {
+  return Object.fromEntries(
+    Object.entries(tools).map((toolInfo) => {
+      const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
+      const aiSDKTool = convertToAISDKTool(tool3);
+      const execute = aiSDKTool.execute;
+      if (execute && executeAsStep) {
+        const wrappedExecute = (...params) => {
+          return context.run(`Run tool ${toolName}`, () => execute(...params));
+        };
+        aiSDKTool.execute = wrappedExecute;
+      }
+      return [toolName, aiSDKTool];
+    })
+  );
+};
+var convertToAISDKTool = (tool3) => {
+  const isLangchainTool = "invoke" in tool3;
+  return isLangchainTool ? convertLangchainTool(tool3) : tool3;
+};
+var convertLangchainTool = (langchainTool) => {
+  return tool({
+    description: langchainTool.description,
+    parameters: langchainTool.schema,
+    execute: async (...param) => langchainTool.invoke(...param)
+  });
+};
+var WorkflowTool = class {
+  /**
+   * description of the tool
+   */
+  description;
+  /**
+   * schema of the tool
+   */
+  schema;
+  /**
+   * function to invoke the tool
+   */
+  invoke;
+  /**
+   * whether the invoke method of the tool is to be wrapped with `context.run`
+   */
+  executeAsStep;
+  /**
+   * 
+   * @param description description of the tool
+   * @param schema schema of the tool
+   * @param invoke function to invoke the tool
+   * @param executeAsStep whether the invoke method of the tool is to be wrapped with `context.run`
+   */
+  constructor(params) {
+    this.description = params.description;
+    this.schema = params.schema;
+    this.invoke = params.invoke;
+    this.executeAsStep = params.executeAsStep ?? true;
+  }
+};
+
 // src/client/utils.ts
 import { QstashError as QstashError2 } from "@upstash/qstash";
 var makeNotifyRequest = async (requester, eventId, eventData) => {
@@ -160,31 +283,6 @@ var getSteps = async (requester, workflowRunId, messageId, debug) => {
   }
 };
 
-// src/utils.ts
-var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
-var NANOID_LENGTH = 21;
-function getRandomInt() {
-  return Math.floor(Math.random() * NANOID_CHARS.length);
-}
-function nanoid() {
-  return Array.from({ length: NANOID_LENGTH }).map(() => NANOID_CHARS[getRandomInt()]).join("");
-}
-function getWorkflowRunId(id) {
-  return `wfr_${id ?? nanoid()}`;
-}
-function decodeBase64(base64) {
-  try {
-    const binString = atob(base64);
-    const intArray = Uint8Array.from(binString, (m) => m.codePointAt(0));
-    return new TextDecoder().decode(intArray);
-  } catch (error) {
-    console.warn(
-      `Upstash Qstash: Failed while decoding base64 "${base64}". Decoding with atob and returning it instead. ${error}`
-    );
-    return atob(base64);
-  }
-}
-
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -365,41 +463,6 @@ var LazyNotifyStep = class extends LazyFunctionStep {
     });
   }
 };
-var LazyInvokeStep = class extends BaseLazyStep {
-  stepType = "Invoke";
-  params;
-  constructor(stepName, { workflow, body, headers = {}, workflowRunId, retries }) {
-    super(stepName);
-    this.params = {
-      workflow,
-      body,
-      headers,
-      workflowRunId: getWorkflowRunId(workflowRunId),
-      retries
-    };
-  }
-  getPlanStep(concurrent, targetStep) {
-    return {
-      stepId: 0,
-      stepName: this.stepName,
-      stepType: this.stepType,
-      concurrent,
-      targetStep
-    };
-  }
-  /**
-   * won't be used as it's the server who will add the result step
-   * in Invoke step.
-   */
-  getResultStep(concurrent, stepId) {
-    return Promise.resolve({
-      stepId,
-      stepName: this.stepName,
-      stepType: this.stepType,
-      concurrent
-    });
-  }
-};
 
 // node_modules/neverthrow/dist/index.es.js
 var defaultErrorConfig = {
@@ -877,8 +940,8 @@ var triggerRouteFunction = async ({
   debug
 }) => {
   try {
-    const result = await onStep();
-    await onCleanup(result);
+    await onStep();
+    await onCleanup();
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
@@ -899,15 +962,14 @@ var triggerRouteFunction = async ({
     }
   }
 };
-var triggerWorkflowDelete = async (workflowContext, result, debug, cancel = false) => {
+var triggerWorkflowDelete = async (workflowContext, debug, cancel = false) => {
   await debug?.log("SUBMIT", "SUBMIT_CLEANUP", {
     deletedWorkflowRunId: workflowContext.workflowRunId
   });
   await workflowContext.qstashClient.http.request({
     path: ["v2", "workflows", "runs", `${workflowContext.workflowRunId}?cancel=${cancel}`],
     method: "DELETE",
-    parseResponseAsJson: false,
-    body: JSON.stringify(result)
+    parseResponseAsJson: false
   });
   await debug?.log(
     "SUBMIT",
@@ -1062,14 +1124,11 @@ var getHeaders = ({
   callTimeout,
   telemetry
 }) => {
-  const contentType = (userHeaders ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
     [WORKFLOW_URL_HEADER]: workflowUrl,
     [WORKFLOW_FEATURE_HEADER]: "LazyFetch,InitialBody",
-    [WORKFLOW_PROTOCOL_VERSION_HEADER]: WORKFLOW_PROTOCOL_VERSION,
-    "content-type": contentType,
     ...telemetry ? getTelemetryHeaders(telemetry) : {}
   };
   if (!step?.callUrl) {
@@ -1080,13 +1139,18 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
   }
-  if (step?.stepType === "Invoke") {
-    baseHeaders["upstash-workflow-invoke"] = "true";
-  }
   if (step?.callUrl) {
     baseHeaders["Upstash-Retries"] = callRetries?.toString() ?? "0";
     baseHeaders[WORKFLOW_FEATURE_HEADER] = "WF_NoDelete,InitialBody";
@@ -1108,6 +1172,7 @@ var getHeaders = ({
       baseHeaders[`Upstash-Failure-Callback-Forward-${header}`] = userHeaders.get(header);
     }
   }
+  const contentType = (userHeaders ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
   if (step?.callHeaders) {
     const forwardedHeaders = Object.fromEntries(
       Object.entries(step.callHeaders).map(([header, value]) => [
@@ -1157,7 +1222,8 @@ var getHeaders = ({
         "Upstash-Workflow-Runid": [workflowRunId],
         [WORKFLOW_INIT_HEADER]: ["false"],
         [WORKFLOW_URL_HEADER]: [workflowUrl],
-        "Upstash-Workflow-CallType": ["step"]
+        "Upstash-Workflow-CallType": ["step"],
+        "Content-Type": [contentType]
       }
     };
   }
@@ -1452,23 +1518,7 @@ var AutoExecutor = class _AutoExecutor {
         method: "POST",
         parseResponseAsJson: false
       });
-      throw new WorkflowAbort(waitStep.stepName, waitStep);
-    }
-    if (steps.length === 1 && lazySteps[0] instanceof LazyInvokeStep) {
-      const invokeStep = steps[0];
-      const lazyInvokeStep = lazySteps[0];
-      await lazyInvokeStep.params.workflow.callback(
-        {
-          body: lazyInvokeStep.params.body,
-          headers: lazyInvokeStep.params.headers,
-          workflowRunId: lazyInvokeStep.params.workflowRunId,
-          workflow: lazyInvokeStep.params.workflow,
-          retries: lazyInvokeStep.params.retries
-        },
-        invokeStep,
-        this.context
-      );
-      throw new WorkflowAbort(invokeStep.stepName, invokeStep);
+      throw new WorkflowAbort(steps[0].stepName, steps[0]);
     }
     const result = await this.context.qstashClient.batchJSON(
       steps.map((singleStep, index) => {
@@ -1719,98 +1769,6 @@ var WorkflowApi = class extends BaseWorkflowApi {
   }
 };
 
-// src/agents/adapters.ts
-import { createOpenAI } from "@ai-sdk/openai";
-import { tool } from "ai";
-
-// src/agents/constants.ts
-var AGENT_NAME_HEADER = "upstash-agent-name";
-var MANAGER_AGENT_PROMPT = `You are an agent orchestrating other AI Agents.
-
-These other agents have tools available to them.
-
-Given a prompt, utilize these agents to address requests.
-
-Don't always call all the agents provided to you at the same time. You can call one and use it's response to call another.
-
-Avoid calling the same agent twice in one turn. Instead, prefer to call it once but provide everything
-you need from that agent.
-`;
-
-// src/agents/adapters.ts
-var createWorkflowOpenAI = (context, config) => {
-  const { baseURL, apiKey } = config ?? {};
-  return 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 wrapTools = ({
-  context,
-  tools
-}) => {
-  return Object.fromEntries(
-    Object.entries(tools).map((toolInfo) => {
-      const [toolName, tool3] = toolInfo;
-      const aiSDKTool = convertToAISDKTool(tool3);
-      const execute = aiSDKTool.execute;
-      if (execute) {
-        const wrappedExecute = (...params) => {
-          return context.run(`Run tool ${toolName}`, () => execute(...params));
-        };
-        aiSDKTool.execute = wrappedExecute;
-      }
-      return [toolName, aiSDKTool];
-    })
-  );
-};
-var convertToAISDKTool = (tool3) => {
-  const isLangchainTool = "invoke" in tool3;
-  return isLangchainTool ? convertLangchainTool(tool3) : tool3;
-};
-var convertLangchainTool = (langchainTool) => {
-  return tool({
-    description: langchainTool.description,
-    parameters: langchainTool.schema,
-    execute: async (...param) => langchainTool.invoke(...param)
-  });
-};
-
 // src/agents/agent.ts
 import { z } from "zod";
 import { generateText, tool as tool2, ToolExecutionError } from "ai";
@@ -2385,13 +2343,6 @@ var WorkflowContext = class {
       return result;
     }
   }
-  async invoke(stepName, settings) {
-    const result = await this.addStep(new LazyInvokeStep(stepName, settings));
-    return {
-      ...result,
-      body: result.body ? JSON.parse(result.body) : void 0
-    };
-  }
   /**
    * Cancel the current workflow run
    *
@@ -2469,6 +2420,31 @@ var WorkflowLogger = class _WorkflowLogger {
   }
 };
 
+// src/utils.ts
+var NANOID_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
+var NANOID_LENGTH = 21;
+function getRandomInt() {
+  return Math.floor(Math.random() * NANOID_CHARS.length);
+}
+function nanoid() {
+  return Array.from({ length: NANOID_LENGTH }).map(() => NANOID_CHARS[getRandomInt()]).join("");
+}
+function getWorkflowRunId(id) {
+  return `wfr_${id ?? nanoid()}`;
+}
+function decodeBase64(base64) {
+  try {
+    const binString = atob(base64);
+    const intArray = Uint8Array.from(binString, (m) => m.codePointAt(0));
+    return new TextDecoder().decode(intArray);
+  } catch (error) {
+    console.warn(
+      `Upstash Qstash: Failed while decoding base64 "${base64}". Decoding with atob and returning it instead. ${error}`
+    );
+    return atob(base64);
+  }
+}
+
 // src/serve/authorization.ts
 import { Client as Client2 } from "@upstash/qstash";
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
@@ -2914,8 +2890,8 @@ var serveBase = (routeFunction, telemetry, options) => {
     } else if (callReturnCheck.value === "continue-workflow") {
       const result = isFirstInvocation ? await triggerFirstInvocation({ workflowContext, useJSONContent, telemetry, debug }) : await triggerRouteFunction({
         onStep: async () => routeFunction(workflowContext),
-        onCleanup: async (result2) => {
-          await triggerWorkflowDelete(workflowContext, result2, debug);
+        onCleanup: async () => {
+          await triggerWorkflowDelete(workflowContext, debug);
         },
         onCancel: async () => {
           await makeCancelRequest(workflowContext.qstashClient.http, workflowRunId);
@@ -2966,12 +2942,12 @@ export {
   SDK_TELEMETRY,
   WorkflowError,
   WorkflowAbort,
-  getWorkflowRunId,
   StepTypes,
   triggerFirstInvocation,
-  getHeaders,
+  WorkflowTool,
   WorkflowContext,
   WorkflowLogger,
+  getWorkflowRunId,
   serveBase,
   serve
 };

package/cloudflare.d.mts

@@ -1,5 +1,4 @@
-import { R as RouteFunction, j as PublicServeOptions, t as InvokableWorkflow } from './types-C7Y7WUQd.mjs';
-import { s as serveManyBase } from './serve-many-BlBvXfBS.mjs';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -24,7 +23,7 @@ type PagesHandlerArgs = [{
  */
 type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
 /**
- * Serve method to serve a Upstash Workflow in a Cloudflare project
+ * Serve method to serve a Upstash Workflow in a Nextjs project
  *
  * See for options https://upstash.com/docs/qstash/workflows/basics/serve
  *
@@ -32,12 +31,8 @@ type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     fetch: (...args: PagesHandlerArgs | WorkersHandlerArgs) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["fetch"]>>;
-declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    fetch: (...params: PagesHandlerArgs | WorkersHandlerArgs) => Promise<any>;
-};
 
-export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, createWorkflow, serve, serveMany };
+export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, serve };

package/cloudflare.d.ts

@@ -1,5 +1,4 @@
-import { R as RouteFunction, j as PublicServeOptions, t as InvokableWorkflow } from './types-C7Y7WUQd.js';
-import { s as serveManyBase } from './serve-many-Dw-UUnH6.js';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -24,7 +23,7 @@ type PagesHandlerArgs = [{
  */
 type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
 /**
- * Serve method to serve a Upstash Workflow in a Cloudflare project
+ * Serve method to serve a Upstash Workflow in a Nextjs project
  *
  * See for options https://upstash.com/docs/qstash/workflows/basics/serve
  *
@@ -32,12 +31,8 @@ type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
     fetch: (...args: PagesHandlerArgs | WorkersHandlerArgs) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["fetch"]>>;
-declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
-    fetch: (...params: PagesHandlerArgs | WorkersHandlerArgs) => Promise<any>;
-};
 
-export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, createWorkflow, serve, serveMany };
+export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, serve };