@upstash/workflow 0.2.7 → 0.2.8-rc-invoke

package/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-Cuqlx2Cr.js';
-export { A as AsyncStepFunction, C as CallResponse, q as CallSettings, D as Duration, k as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, o as NotifyStepResponse, P as ParallelCallState, j as PublicServeOptions, g as RawStep, l as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, T as Telemetry, p as WaitEventOptions, m as WaitRequest, n as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, s as WorkflowLogger, r as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-Cuqlx2Cr.js';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, N as NotifyResponse, a as Waiter, S as Step } from './types-C7Y7WUQd.js';
+export { A as AsyncStepFunction, C as CallResponse, q as CallSettings, D as Duration, k as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeCallback, r as InvokeStepResponse, I as InvokeWorkflowRequest, L as LogLevel, o as NotifyStepResponse, P as ParallelCallState, j as PublicServeOptions, g as RawStep, l as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, p as WaitEventOptions, m as WaitRequest, n as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, v as WorkflowLogger, u as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-C7Y7WUQd.js';
 import { Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -9,13 +9,26 @@ import '@ai-sdk/openai';
  * Creates an async method that handles incoming requests and runs the provided
  * route function as a workflow.
  *
+ * Not exported in the package. Instead, used in framework specific serve implementations.
+ *
+ * Only difference from regular serve is the `useJSONContent` parameter.
+ *
  * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
  * @param options - Options including the client, onFinish callback, and initialPayloadParser.
  * @returns An async method that consumes incoming requests and runs the workflow.
  */
-declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => {
+declare const serveBase: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, telemetry?: Telemetry, options?: WorkflowServeOptions<TResponse, TInitialPayload>) => {
     handler: (request: TRequest) => Promise<TResponse>;
 };
+/**
+ * Creates an async method that handles incoming requests and runs the provided
+ * route function as a workflow.
+ *
+ * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
+ * @param options - Options including the client, onFinish callback, and initialPayloadParser.
+ * @returns An async method that consumes incoming requests and runs the workflow.
+ */
+declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => ReturnType<typeof serveBase<TInitialPayload, TRequest, TResponse, TResult>>;
 
 type ClientConfig = ConstructorParameters<typeof Client$1>[0];
 /**
@@ -192,4 +205,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RouteFunction, Step, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RouteFunction, Step, Telemetry, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };

package/index.js

@@ -101,7 +101,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.3";
+var VERSION = "v0.2.7";
 var SDK_TELEMETRY = `@upstash/workflow@${VERSION}`;
 var TELEMETRY_HEADER_SDK = "Upstash-Telemetry-Sdk";
 var TELEMETRY_HEADER_FRAMEWORK = "Upstash-Telemetry-Framework";
@@ -148,6 +148,31 @@ var formatWorkflowError = (error) => {
   };
 };
 
+// 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;
@@ -328,6 +353,41 @@ 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 = {
@@ -752,7 +812,8 @@ var StepTypes = [
   "SleepUntil",
   "Call",
   "Wait",
-  "Notify"
+  "Notify",
+  "Invoke"
 ];
 
 // src/workflow-requests.ts
@@ -816,8 +877,8 @@ var triggerRouteFunction = async ({
   debug
 }) => {
   try {
-    await onStep();
-    await onCleanup();
+    const result = await onStep();
+    await onCleanup(result);
     return ok("workflow-finished");
   } catch (error) {
     const error_ = error;
@@ -838,14 +899,15 @@ var triggerRouteFunction = async ({
     }
   }
 };
-var triggerWorkflowDelete = async (workflowContext, debug, cancel = false) => {
+var triggerWorkflowDelete = async (workflowContext, result, 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
+    parseResponseAsJson: false,
+    body: JSON.stringify(result)
   });
   await debug?.log(
     "SUBMIT",
@@ -1000,11 +1062,14 @@ 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) {
@@ -1019,6 +1084,9 @@ var getHeaders = ({
       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";
@@ -1040,7 +1108,6 @@ 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]) => [
@@ -1090,8 +1157,7 @@ var getHeaders = ({
         "Upstash-Workflow-Runid": [workflowRunId],
         [WORKFLOW_INIT_HEADER]: ["false"],
         [WORKFLOW_URL_HEADER]: [workflowUrl],
-        "Upstash-Workflow-CallType": ["step"],
-        "Content-Type": [contentType]
+        "Upstash-Workflow-CallType": ["step"]
       }
     };
   }
@@ -1386,7 +1452,23 @@ var AutoExecutor = class _AutoExecutor {
         method: "POST",
         parseResponseAsJson: false
       });
-      throw new WorkflowAbort(steps[0].stepName, steps[0]);
+      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);
     }
     const result = await this.context.qstashClient.batchJSON(
       steps.map((singleStep, index) => {
@@ -2303,6 +2385,13 @@ 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
    *
@@ -2380,31 +2469,6 @@ 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
 var import_qstash8 = require("@upstash/qstash");
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
@@ -2850,8 +2914,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 () => {
-          await triggerWorkflowDelete(workflowContext, debug);
+        onCleanup: async (result2) => {
+          await triggerWorkflowDelete(workflowContext, result2, debug);
         },
         onCancel: async () => {
           await makeCancelRequest(workflowContext.qstashClient.http, workflowRunId);
@@ -2898,7 +2962,7 @@ var import_qstash11 = require("@upstash/qstash");
 var Client4 = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.token) {
+    if (!clientConfig?.token) {
       console.error(
         "QStash token is required for Upstash Workflow!\n\nTo fix this:\n1. Get your token from the Upstash Console (https://console.upstash.com/qstash)\n2. Initialize the workflow client with:\n\n   const client = new Client({\n     token: '<YOUR_QSTASH_TOKEN>'\n   });"
       );

package/index.mjs

@@ -9,14 +9,14 @@ import {
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-U6XFLG7W.mjs";
+} from "./chunk-IWAW7GIG.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
 var Client = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.token) {
+    if (!clientConfig?.token) {
       console.error(
         "QStash token is required for Upstash Workflow!\n\nTo fix this:\n1. Get your token from the Upstash Console (https://console.upstash.com/qstash)\n2. Initialize the workflow client with:\n\n   const client = new Client({\n     token: '<YOUR_QSTASH_TOKEN>'\n   });"
       );

package/nextjs.d.mts

@@ -1,5 +1,6 @@
-import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.mjs';
+import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
+import { R as RouteFunction, j as PublicServeOptions, t as InvokableWorkflow } from './types-C7Y7WUQd.mjs';
+import { s as serveManyBase } from './serve-many-BlBvXfBS.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -14,11 +15,19 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const servePagesRouter: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["POST"]>>;
+declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
+    POST: (request: Request) => Promise<any>;
+};
+declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
     handler: NextApiHandler;
 };
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof servePagesRouter<TInitialPayload, TResult>>["handler"]>>;
+declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
+    handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
+};
 
-export { serve, servePagesRouter };
+export { createWorkflow, createWorkflowPagesRouter, serve, serveMany, serveManyPagesRouter, servePagesRouter };

package/nextjs.d.ts

@@ -1,5 +1,6 @@
-import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.js';
+import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
+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 '@upstash/qstash';
 import 'zod';
 import 'ai';
@@ -14,11 +15,19 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const servePagesRouter: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof serve<TInitialPayload, TResult>>["POST"]>>;
+declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
+    POST: (request: Request) => Promise<any>;
+};
+declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
     handler: NextApiHandler;
 };
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult, Parameters<ReturnType<typeof servePagesRouter<TInitialPayload, TResult>>["handler"]>>;
+declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"]) => {
+    handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
+};
 
-export { serve, servePagesRouter };
+export { createWorkflow, createWorkflowPagesRouter, serve, serveMany, serveManyPagesRouter, servePagesRouter };