@upstash/workflow 0.2.10 → 0.2.12

package/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-CYhDXnf8.js';
-export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-CYhDXnf8.js';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-D1W0VOpy.js';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-D1W0VOpy.js';
 import { HTTPMethods, State, FlowControl, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -154,7 +154,11 @@ type WaitEventGroup = {
 type AsOptional<TType> = TType | {
     [P in keyof TType]?: never;
 };
-type StepLog = BaseStepLog & AsOptional<CallUrlGroup> & AsOptional<CallResponseStatusGroup> & AsOptional<InvokedWorkflowGroup> & AsOptional<WaitEventGroup>;
+type StepLog = BaseStepLog & AsOptional<CallUrlGroup> & AsOptional<CallResponseStatusGroup> & AsOptional<InvokedWorkflowGroup> & AsOptional<{
+    sleepFor: number;
+}> & AsOptional<{
+    sleepUntil: number;
+}> & AsOptional<WaitEventGroup>;
 type StepLogGroup = {
     /**
      * Log which belongs to a single step
@@ -179,7 +183,7 @@ type StepLogGroup = {
      */
     steps: {
         messageId: string;
-        state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED";
+        state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED" | "STEP_CANCELED";
     }[];
     /**
      * Log which belongs to the next step
@@ -251,6 +255,32 @@ type WorkflowRunLog = {
      *
      */
     steps: StepLogGroup[];
+    /**
+     * If the workflow returned a response, the stringified state of this
+     * response will be available in the workflowRunResponse field.
+     *
+     * To restore it to its original format, use JSON.parse.
+     */
+    workflowRunResponse?: string;
+    /**
+     * Information on the invoker workflow run, if any
+     */
+    invoker?: {
+        /**
+         * run id of the invoker workflow
+         */
+        workflowRunId: string;
+        /**
+         * URL of the invoker workflow
+         */
+        workflowUrl: string;
+        /**
+         * Time when the invoker workflow run was created
+         *
+         * in unix milliseconds format
+         */
+        workflowRunCreatedAt: number;
+    };
 };
 type WorkflowRunLogs = {
     cursor: string;

package/index.js

@@ -146,7 +146,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)}'`
   };
 };
 
@@ -163,22 +163,21 @@ function getWorkflowRunId(id) {
   return `wfr_${id ?? nanoid()}`;
 }
 function decodeBase64(base64) {
+  const binString = atob(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);
+    return binString;
   }
 }
 
 // src/context/steps.ts
-var BaseLazyStep = class {
+var BaseLazyStep = class _BaseLazyStep {
   stepName;
-  // will be set in the subclasses
   constructor(stepName) {
     if (!stepName) {
       throw new WorkflowError(
@@ -187,10 +186,58 @@ var BaseLazyStep = class {
     }
     this.stepName = stepName;
   }
+  /**
+   * 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) {
+    if (out === void 0) {
+      if (this.allowUndefinedOut) {
+        return void 0;
+      } else {
+        throw new WorkflowError(
+          `Error while parsing output of ${this.stepType} step. Expected a string, but got: undefined`
+        );
+      }
+    }
+    if (typeof out === "object") {
+      if (this.stepType !== "Wait") {
+        console.warn(
+          `Error while parsing ${this.stepType} step output. Expected a string, but got object. Please reach out to Upstash Support.`
+        );
+        return out;
+      }
+      return {
+        ...out,
+        eventData: _BaseLazyStep.tryParsing(out.eventData)
+      };
+    }
+    if (typeof out !== "string") {
+      throw new WorkflowError(
+        `Error while parsing output of ${this.stepType} step. Expected a string or undefined, but got: ${typeof out}`
+      );
+    }
+    return this.safeParseOut(out);
+  }
+  safeParseOut(out) {
+    return _BaseLazyStep.tryParsing(out);
+  }
+  static tryParsing(stepOut) {
+    try {
+      return JSON.parse(stepOut);
+    } catch {
+      return stepOut;
+    }
+  }
 };
 var LazyFunctionStep = class extends BaseLazyStep {
   stepFunction;
   stepType = "Run";
+  allowUndefinedOut = true;
   constructor(stepName, stepFunction) {
     super(stepName);
     this.stepFunction = stepFunction;
@@ -221,6 +268,7 @@ var LazyFunctionStep = class extends BaseLazyStep {
 var LazySleepStep = class extends BaseLazyStep {
   sleep;
   stepType = "SleepFor";
+  allowUndefinedOut = true;
   constructor(stepName, sleep) {
     super(stepName);
     this.sleep = sleep;
@@ -248,6 +296,7 @@ var LazySleepStep = class extends BaseLazyStep {
 var LazySleepUntilStep = class extends BaseLazyStep {
   sleepUntil;
   stepType = "SleepUntil";
+  allowUndefinedOut = true;
   constructor(stepName, sleepUntil) {
     super(stepName);
     this.sleepUntil = sleepUntil;
@@ -271,8 +320,11 @@ var LazySleepUntilStep = class extends BaseLazyStep {
       concurrent
     });
   }
+  safeParseOut() {
+    return void 0;
+  }
 };
-var LazyCallStep = class extends BaseLazyStep {
+var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
   url;
   method;
   body;
@@ -281,6 +333,7 @@ var LazyCallStep = class extends BaseLazyStep {
   timeout;
   flowControl;
   stepType = "Call";
+  allowUndefinedOut = false;
   constructor(stepName, url, method, body, headers, retries, timeout, flowControl) {
     super(stepName);
     this.url = url;
@@ -312,11 +365,53 @@ var LazyCallStep = class extends BaseLazyStep {
       callHeaders: this.headers
     });
   }
+  safeParseOut(out) {
+    const { header, status, body } = JSON.parse(out);
+    const responseHeaders = new Headers(header);
+    if (_LazyCallStep.isText(responseHeaders.get("content-type"))) {
+      const bytes = new Uint8Array(out.length);
+      for (let i = 0; i < out.length; i++) {
+        bytes[i] = out.charCodeAt(i);
+      }
+      const processedResult = new TextDecoder().decode(bytes);
+      const newBody = JSON.parse(processedResult).body;
+      return {
+        status,
+        header,
+        body: BaseLazyStep.tryParsing(newBody)
+      };
+    } else {
+      return { header, status, body };
+    }
+  }
+  static applicationHeaders = /* @__PURE__ */ new Set([
+    "application/json",
+    "application/xml",
+    "application/javascript",
+    "application/x-www-form-urlencoded",
+    "application/xhtml+xml",
+    "application/ld+json",
+    "application/rss+xml",
+    "application/atom+xml"
+  ]);
+  static isText = (contentTypeHeader) => {
+    if (!contentTypeHeader) {
+      return false;
+    }
+    if (_LazyCallStep.applicationHeaders.has(contentTypeHeader)) {
+      return true;
+    }
+    if (contentTypeHeader.startsWith("text/")) {
+      return true;
+    }
+    return false;
+  };
 };
 var LazyWaitForEventStep = class extends BaseLazyStep {
   eventId;
   timeout;
   stepType = "Wait";
+  allowUndefinedOut = false;
   constructor(stepName, eventId, timeout) {
     super(stepName);
     this.eventId = eventId;
@@ -343,6 +438,13 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
       concurrent
     });
   }
+  safeParseOut(out) {
+    const result = JSON.parse(out);
+    return {
+      ...result,
+      eventData: BaseLazyStep.tryParsing(result.eventData)
+    };
+  }
 };
 var LazyNotifyStep = class extends LazyFunctionStep {
   stepType = "Notify";
@@ -356,10 +458,18 @@ var LazyNotifyStep = class extends LazyFunctionStep {
       };
     });
   }
+  safeParseOut(out) {
+    const result = JSON.parse(out);
+    return {
+      ...result,
+      eventData: BaseLazyStep.tryParsing(result.eventData)
+    };
+  }
 };
 var LazyInvokeStep = class extends BaseLazyStep {
   stepType = "Invoke";
   params;
+  allowUndefinedOut = false;
   constructor(stepName, {
     workflow,
     body,
@@ -399,6 +509,13 @@ var LazyInvokeStep = class extends BaseLazyStep {
       concurrent
     });
   }
+  safeParseOut(out) {
+    const result = JSON.parse(out);
+    return {
+      ...result,
+      body: BaseLazyStep.tryParsing(result.body)
+    };
+  }
 };
 
 // node_modules/neverthrow/dist/index.es.js
@@ -1084,7 +1201,8 @@ var getHeaders = ({
   flowControl,
   callFlowControl
 }) => {
-  const contentType = (userHeaders ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
+  const callHeaders = new Headers(step?.callHeaders);
+  const contentType = (callHeaders.get("content-type") ? callHeaders.get("content-type") : userHeaders?.get("Content-Type") ? userHeaders.get("Content-Type") : void 0) ?? DEFAULT_CONTENT_TYPE;
   const baseHeaders = {
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
@@ -1434,7 +1552,7 @@ var AutoExecutor = class _AutoExecutor {
         step,
         stepCount: this.stepCount
       });
-      return step.out;
+      return lazyStep.parseOut(step.out);
     }
     const resultStep = await lazyStep.getResultStep(NO_CONCURRENCY, this.stepCount);
     await this.debug?.log("INFO", "RUN_SINGLE", {
@@ -1509,7 +1627,9 @@ var AutoExecutor = class _AutoExecutor {
       case "last": {
         const parallelResultSteps = sortedSteps.filter((step) => step.stepId >= initialStepCount).slice(0, parallelSteps.length);
         validateParallelSteps(parallelSteps, parallelResultSteps);
-        return parallelResultSteps.map((step) => step.out);
+        return parallelResultSteps.map(
+          (step, index) => parallelSteps[index].parseOut(step.out)
+        );
       }
     }
     const fillValue = void 0;
@@ -1612,7 +1732,7 @@ var AutoExecutor = class _AutoExecutor {
       });
       throw new WorkflowAbort(invokeStep.stepName, invokeStep);
     }
-    const result = await this.context.qstashClient.batchJSON(
+    const result = await this.context.qstashClient.batch(
       steps.map((singleStep, index) => {
         const lazyStep = lazySteps[index];
         const { headers } = getHeaders({
@@ -1642,7 +1762,7 @@ var AutoExecutor = class _AutoExecutor {
           {
             headers,
             method: singleStep.callMethod,
-            body: singleStep.callBody,
+            body: JSON.stringify(singleStep.callBody),
             url: singleStep.callUrl
           }
         ) : (
@@ -1652,7 +1772,7 @@ var AutoExecutor = class _AutoExecutor {
           {
             headers,
             method: "POST",
-            body: singleStep,
+            body: JSON.stringify(singleStep),
             url: this.context.url,
             notBefore: willWait ? singleStep.sleepUntil : void 0,
             delay: willWait ? singleStep.sleepFor : void 0
@@ -1660,8 +1780,9 @@ var AutoExecutor = class _AutoExecutor {
         );
       })
     );
+    const _result = result;
     await this.debug?.log("INFO", "SUBMIT_STEP", {
-      messageIds: result.map((message) => {
+      messageIds: _result.map((message) => {
         return {
           message: message.messageId
         };
@@ -1864,6 +1985,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");
@@ -1883,46 +2007,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 = ({
@@ -2193,9 +2320,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
@@ -2381,7 +2513,7 @@ var WorkflowContext = class {
    */
   async run(stepName, stepFunction) {
     const wrappedStepFunction = () => this.executor.wrapStep(stepName, stepFunction);
-    return this.addStep(new LazyFunctionStep(stepName, wrappedStepFunction));
+    return await this.addStep(new LazyFunctionStep(stepName, wrappedStepFunction));
   }
   /**
    * Stops the execution for the duration provided.
@@ -2452,43 +2584,27 @@ var WorkflowContext = class {
    *   }
    */
   async call(stepName, settings) {
-    const { url, method = "GET", body, headers = {}, retries = 0, timeout, flowControl } = settings;
-    const result = await this.addStep(
+    const {
+      url,
+      method = "GET",
+      body: requestBody,
+      headers = {},
+      retries = 0,
+      timeout,
+      flowControl
+    } = settings;
+    return await this.addStep(
       new LazyCallStep(
         stepName,
         url,
         method,
-        body,
+        requestBody,
         headers,
         retries,
         timeout,
         flowControl
       )
     );
-    if (typeof result === "string") {
-      try {
-        const body2 = JSON.parse(result);
-        return {
-          status: 200,
-          header: {},
-          body: body2
-        };
-      } catch {
-        return {
-          status: 200,
-          header: {},
-          body: result
-        };
-      }
-    }
-    try {
-      return {
-        ...result,
-        body: JSON.parse(result.body)
-      };
-    } catch {
-      return result;
-    }
   }
   /**
    * Pauses workflow execution until a specific event occurs or a timeout is reached.
@@ -2527,15 +2643,7 @@ var WorkflowContext = class {
   async waitForEvent(stepName, eventId, options = {}) {
     const { timeout = "7d" } = options;
     const timeoutStr = typeof timeout === "string" ? timeout : `${timeout}s`;
-    const result = await this.addStep(new LazyWaitForEventStep(stepName, eventId, timeoutStr));
-    try {
-      return {
-        ...result,
-        eventData: JSON.parse(result.eventData)
-      };
-    } catch {
-      return result;
-    }
+    return await this.addStep(new LazyWaitForEventStep(stepName, eventId, timeoutStr));
   }
   /**
    * Notify workflow runs waiting for an event
@@ -2559,24 +2667,12 @@ var WorkflowContext = class {
    * @returns notify response which has event id, event data and list of waiters which were notified
    */
   async notify(stepName, eventId, eventData) {
-    const result = await this.addStep(
+    return await this.addStep(
       new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
     );
-    try {
-      return {
-        ...result,
-        eventData: JSON.parse(result.eventData)
-      };
-    } catch {
-      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
-    };
+    return await this.addStep(new LazyInvokeStep(stepName, settings));
   }
   /**
    * Cancel the current workflow run
@@ -2735,10 +2831,6 @@ var processRawSteps = (rawSteps) => {
   const stepsToDecode = encodedSteps.filter((step) => step.callType === "step");
   const otherSteps = stepsToDecode.map((rawStep) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
-    try {
-      step.out = JSON.parse(step.out);
-    } catch {
-    }
     if (step.waitEventId) {
       const newOut = {
         eventData: step.out ? decodeBase64(step.out) : void 0,
@@ -2958,6 +3050,7 @@ var processOptions = (options) => {
     retries: DEFAULT_RETRIES,
     useJSONContent: false,
     disableTelemetry: false,
+    onError: console.error,
     ...options
   };
 };
@@ -3007,7 +3100,8 @@ var serveBase = (routeFunction, telemetry, options) => {
     retries,
     useJSONContent,
     disableTelemetry,
-    flowControl
+    flowControl,
+    onError
   } = processOptions(options);
   telemetry = disableTelemetry ? void 0 : telemetry;
   const debug = WorkflowLogger.getLogger(verbose);
@@ -3136,8 +3230,19 @@ var serveBase = (routeFunction, telemetry, 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/index.mjs

@@ -10,7 +10,7 @@ import {
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-GFNR743S.mjs";
+} from "./chunk-4GTHIL7S.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";

package/nextjs.d.mts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-CYhDXnf8.mjs';
-import { s as serveManyBase } from './serve-many-BVDpPsF-.mjs';
+import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-D1W0VOpy.mjs';
+import { s as serveManyBase } from './serve-many-DLguU9iR.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-CYhDXnf8.js';
-import { s as serveManyBase } from './serve-many-e4zufyXN.js';
+import { R as RouteFunction, k as PublicServeOptions, t as InvokableWorkflow } from './types-D1W0VOpy.js';
+import { s as serveManyBase } from './serve-many-BdMq5rFX.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';