@upstash/workflow 0.2.6 → 0.2.8-rc-invoke

package/{chunk-OLNSY3BB.mjs → chunk-IWAW7GIG.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.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";
@@ -96,7 +96,8 @@ var StepTypes = [
   "SleepUntil",
   "Call",
   "Wait",
-  "Notify"
+  "Notify",
+  "Invoke"
 ];
 
 // src/client/utils.ts
@@ -159,6 +160,31 @@ 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;
@@ -339,6 +365,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 = {
@@ -772,6 +833,9 @@ var triggerFirstInvocation = async ({
     retries: workflowContext.retries,
     telemetry
   });
+  if (workflowContext.headers.get("content-type")) {
+    headers["content-type"] = workflowContext.headers.get("content-type");
+  }
   if (useJSONContent) {
     headers["content-type"] = "application/json";
   }
@@ -813,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;
@@ -835,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",
@@ -997,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) {
@@ -1016,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";
@@ -1037,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]) => [
@@ -1087,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"]
       }
     };
   }
@@ -1383,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) => {
@@ -2300,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
    *
@@ -2377,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
 import { Client as Client2 } from "@upstash/qstash";
 var DisabledWorkflowContext = class _DisabledWorkflowContext extends WorkflowContext {
@@ -2847,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);
@@ -2899,11 +2966,12 @@ export {
   SDK_TELEMETRY,
   WorkflowError,
   WorkflowAbort,
+  getWorkflowRunId,
   StepTypes,
   triggerFirstInvocation,
+  getHeaders,
   WorkflowContext,
   WorkflowLogger,
-  getWorkflowRunId,
   serveBase,
   serve
 };

package/chunk-LCZMBGEM.mjs

@@ -0,0 +1,95 @@
+import {
+  WorkflowError,
+  getHeaders,
+  getWorkflowRunId
+} from "./chunk-IWAW7GIG.mjs";
+
+// src/serve/serve-many.ts
+var serveManyBase = ({
+  workflows,
+  getWorkflowId
+}) => {
+  const workflowIds = [];
+  const workflowMap = Object.fromEntries(
+    Object.entries(workflows).map((workflow) => {
+      const workflowId = workflow[0];
+      if (workflowIds.includes(workflowId)) {
+        throw new WorkflowError(
+          `Duplicate workflow name found: '${workflowId}'. Please set different workflow names in serveMany.`
+        );
+      }
+      if (workflowId.includes("/")) {
+        throw new WorkflowError(
+          `Invalid workflow name found: '${workflowId}'. Workflow name cannot contain '/'.`
+        );
+      }
+      workflowIds.push(workflowId);
+      workflow[1].workflowId = workflowId;
+      return [workflowId, workflow[1].handler];
+    })
+  );
+  return {
+    handler: async (...params) => {
+      const pickedWorkflowId = getWorkflowId(...params);
+      if (!pickedWorkflowId) {
+        throw new WorkflowError(`Unexpected request in serveMany. workflowId not set. Please update the URL of your request.`);
+      }
+      const workflow = workflowMap[pickedWorkflowId];
+      if (!workflow) {
+        throw new WorkflowError(`No workflows in serveMany found for '${pickedWorkflowId}'. Please update the URL of your request.`);
+      }
+      return await workflow(...params);
+    }
+  };
+};
+var createInvokeCallback = (telemetry) => {
+  const invokeCallback = async (settings, invokeStep, context) => {
+    const { body, workflow, headers = {}, workflowRunId = getWorkflowRunId(), retries } = settings;
+    const { workflowId } = workflow;
+    if (!workflowId) {
+      throw new WorkflowError("You can only invoke workflow which has a workflowId");
+    }
+    const { headers: invokerHeaders } = getHeaders({
+      initHeaderValue: "false",
+      workflowRunId: context.workflowRunId,
+      workflowUrl: context.url,
+      userHeaders: context.headers,
+      failureUrl: context.failureUrl,
+      retries: context.retries,
+      telemetry
+    });
+    invokerHeaders["Upstash-Workflow-Runid"] = context.workflowRunId;
+    const newUrl = context.url.replace(/[^/]+$/, workflowId);
+    const { headers: triggerHeaders } = getHeaders({
+      initHeaderValue: "true",
+      workflowRunId,
+      workflowUrl: newUrl,
+      userHeaders: new Headers(headers),
+      retries,
+      telemetry
+    });
+    triggerHeaders["Upstash-Workflow-Invoke"] = "true";
+    const request = {
+      body: JSON.stringify(body),
+      headers: Object.fromEntries(
+        Object.entries(invokerHeaders).map((pairs) => [pairs[0], [pairs[1]]])
+      ),
+      workflowRunId,
+      workflowUrl: context.url,
+      step: invokeStep
+    };
+    await context.qstashClient.publish({
+      headers: triggerHeaders,
+      method: "POST",
+      body: JSON.stringify(request),
+      url: newUrl
+    });
+    return void 0;
+  };
+  return invokeCallback;
+};
+
+export {
+  serveManyBase,
+  createInvokeCallback
+};

package/cloudflare.d.mts

@@ -1,4 +1,5 @@
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.mjs';
+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';
@@ -23,7 +24,7 @@ type PagesHandlerArgs = [{
  */
 type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
 /**
- * Serve method to serve a Upstash Workflow in a Nextjs project
+ * Serve method to serve a Upstash Workflow in a Cloudflare project
  *
  * See for options https://upstash.com/docs/qstash/workflows/basics/serve
  *
@@ -31,8 +32,12 @@ type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
  * @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>) => {
     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, serve };
+export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, createWorkflow, serve, serveMany };

package/cloudflare.d.ts

@@ -1,4 +1,5 @@
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.js';
+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';
@@ -23,7 +24,7 @@ type PagesHandlerArgs = [{
  */
 type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
 /**
- * Serve method to serve a Upstash Workflow in a Nextjs project
+ * Serve method to serve a Upstash Workflow in a Cloudflare project
  *
  * See for options https://upstash.com/docs/qstash/workflows/basics/serve
  *
@@ -31,8 +32,12 @@ type WorkersHandlerArgs = [Request, Record<string, string | undefined>];
  * @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>) => {
     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, serve };
+export { type PagesHandlerArgs, type WorkersHandlerArgs, type WorkflowBindings, createWorkflow, serve, serveMany };