@upstash/workflow 0.2.22 → 0.2.23-rc

package/index.js

@@ -213,8 +213,8 @@ 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 nanoid(length = NANOID_LENGTH) {
+  return Array.from({ length }).map(() => NANOID_CHARS[getRandomInt()]).join("");
 }
 function getWorkflowRunId(id) {
   return `wfr_${id ?? nanoid()}`;
@@ -231,6 +231,37 @@ function decodeBase64(base64) {
     return binString;
   }
 }
+function getUserIdFromToken(qstashClient) {
+  try {
+    const token = qstashClient.token;
+    const decodedToken = decodeBase64(token);
+    const tokenPayload = JSON.parse(decodedToken);
+    const userId = tokenPayload.UserID;
+    if (!userId) {
+      throw new WorkflowError("QStash token payload does not contain userId");
+    }
+    return userId;
+  } catch (error) {
+    throw new WorkflowError(
+      `Failed to decode QStash token while running create webhook step: ${error.message}`
+    );
+  }
+}
+function getQStashUrl(qstashClient) {
+  try {
+    const requester = qstashClient.http;
+    const baseUrl = requester.baseUrl;
+    if (!baseUrl) {
+      throw new WorkflowError("QStash client does not have a baseUrl");
+    }
+    return baseUrl;
+  } catch (error) {
+    throw new WorkflowError(`Failed to get QStash URL from client: ${error.message}`);
+  }
+}
+function getEventId() {
+  return `evt_${nanoid(15)}`;
+}
 
 // node_modules/neverthrow/dist/index.es.js
 var defaultErrorConfig = {
@@ -656,7 +687,9 @@ var StepTypes = [
   "Call",
   "Wait",
   "Notify",
-  "Invoke"
+  "Invoke",
+  "CreateWebhook",
+  "WaitForWebhook"
 ];
 
 // src/workflow-requests.ts
@@ -968,7 +1001,9 @@ If you want to disable QStash Verification, you should clear env variables QSTAS
 // src/context/steps.ts
 var BaseLazyStep = class _BaseLazyStep {
   stepName;
-  constructor(stepName) {
+  context;
+  constructor(context, stepName) {
+    this.context = context;
     if (!stepName) {
       throw new WorkflowError(
         "A workflow step name cannot be undefined or an empty string. Please provide a name for your workflow step."
@@ -986,13 +1021,14 @@ var BaseLazyStep = class _BaseLazyStep {
    *
    * will be called when returning the steps to the context from auto executor
    *
-   * @param out field of the step
+   * @param step step
    * @returns parsed out field
    */
-  parseOut(out) {
+  parseOut(step) {
+    const out = step.out;
     if (out === void 0) {
       if (this.allowUndefinedOut) {
-        return void 0;
+        return this.handleUndefinedOut(step);
       } else {
         throw new WorkflowError(
           `Error while parsing output of ${this.stepType} step. Expected a string, but got: undefined`
@@ -1000,27 +1036,26 @@ var BaseLazyStep = class _BaseLazyStep {
       }
     }
     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)
-      };
+      console.warn(
+        `Error while parsing ${this.stepType} step output. Expected a string, but got object. Please reach out to Upstash Support.`
+      );
+      return out;
     }
     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);
+    return this.safeParseOut(out, step);
   }
-  safeParseOut(out) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  safeParseOut(out, step) {
     return _BaseLazyStep.tryParsing(out);
   }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  handleUndefinedOut(step) {
+    return void 0;
+  }
   static tryParsing(stepOut) {
     try {
       return JSON.parse(stepOut);
@@ -1071,8 +1106,8 @@ var LazyFunctionStep = class extends BaseLazyStep {
   stepFunction;
   stepType = "Run";
   allowUndefinedOut = true;
-  constructor(stepName, stepFunction) {
-    super(stepName);
+  constructor(context, stepName, stepFunction) {
+    super(context, stepName);
     this.stepFunction = stepFunction;
   }
   getPlanStep(concurrent, targetStep) {
@@ -1102,8 +1137,8 @@ var LazySleepStep = class extends BaseLazyStep {
   sleep;
   stepType = "SleepFor";
   allowUndefinedOut = true;
-  constructor(stepName, sleep) {
-    super(stepName);
+  constructor(context, stepName, sleep) {
+    super(context, stepName);
     this.sleep = sleep;
   }
   getPlanStep(concurrent, targetStep) {
@@ -1144,8 +1179,8 @@ var LazySleepUntilStep = class extends BaseLazyStep {
   sleepUntil;
   stepType = "SleepUntil";
   allowUndefinedOut = true;
-  constructor(stepName, sleepUntil) {
-    super(stepName);
+  constructor(context, stepName, sleepUntil) {
+    super(context, stepName);
     this.sleepUntil = sleepUntil;
   }
   getPlanStep(concurrent, targetStep) {
@@ -1197,8 +1232,8 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
   stringifyBody;
   stepType = "Call";
   allowUndefinedOut = false;
-  constructor(stepName, url, method, body, headers, retries, retryDelay, timeout, flowControl, stringifyBody) {
-    super(stepName);
+  constructor(context, stepName, url, method, body, headers, retries, retryDelay, timeout, flowControl, stringifyBody) {
+    super(context, stepName);
     this.url = url;
     this.method = method;
     this.body = body;
@@ -1342,13 +1377,12 @@ var LazyCallStep = class _LazyCallStep extends BaseLazyStep {
     ]);
   }
 };
-var LazyWaitForEventStep = class extends BaseLazyStep {
+var LazyWaitEventStep = class extends BaseLazyStep {
   eventId;
   timeout;
-  stepType = "Wait";
   allowUndefinedOut = false;
-  constructor(stepName, eventId, timeout) {
-    super(stepName);
+  constructor(context, stepName, eventId, timeout) {
+    super(context, stepName);
     this.eventId = eventId;
     this.timeout = timeout;
   }
@@ -1373,13 +1407,6 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
       concurrent
     });
   }
-  safeParseOut(out) {
-    const result = JSON.parse(out);
-    return {
-      ...result,
-      eventData: BaseLazyStep.tryParsing(result.eventData)
-    };
-  }
   getHeaders({ context, telemetry, invokeCount, step }) {
     const headers = super.getHeaders({ context, telemetry, invokeCount, step });
     headers.headers["Upstash-Workflow-CallType"] = "step";
@@ -1413,7 +1440,7 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
       timeoutHeaders,
       step: {
         stepId: step.stepId,
-        stepType: "Wait",
+        stepType: this.stepType,
         stepName: step.stepName,
         concurrent: step.concurrent,
         targetStep: step.targetStep
@@ -1434,8 +1461,8 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
 };
 var LazyNotifyStep = class extends LazyFunctionStep {
   stepType = "Notify";
-  constructor(stepName, eventId, eventData, requester) {
-    super(stepName, async () => {
+  constructor(context, stepName, eventId, eventData, requester) {
+    super(context, stepName, async () => {
       const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
       return {
         eventId,
@@ -1460,7 +1487,7 @@ var LazyInvokeStep = class extends BaseLazyStep {
    * workflow id of the invoked workflow
    */
   workflowId;
-  constructor(stepName, {
+  constructor(context, stepName, {
     workflow,
     body,
     headers = {},
@@ -1470,7 +1497,7 @@ var LazyInvokeStep = class extends BaseLazyStep {
     flowControl,
     stringifyBody = true
   }) {
-    super(stepName);
+    super(context, stepName);
     this.params = {
       workflow,
       body,
@@ -1531,6 +1558,9 @@ var LazyInvokeStep = class extends BaseLazyStep {
       userHeaders: context.headers,
       invokeCount
     });
+    context.qstashClient.http.headers?.forEach((value, key) => {
+      invokerHeaders[key] = value;
+    });
     invokerHeaders["Upstash-Workflow-Runid"] = context.workflowRunId;
     let invokeBody;
     if (this.params.stringifyBody) {
@@ -1602,6 +1632,91 @@ var LazyInvokeStep = class extends BaseLazyStep {
     return [result];
   }
 };
+var LazyCreateWebhookStep = class extends BaseLazyStep {
+  stepType = "CreateWebhook";
+  allowUndefinedOut = false;
+  getPlanStep(concurrent, targetStep) {
+    return {
+      stepId: 0,
+      stepName: this.stepName,
+      stepType: this.stepType,
+      concurrent,
+      targetStep
+    };
+  }
+  async getResultStep(concurrent, stepId) {
+    return {
+      stepId,
+      stepName: this.stepName,
+      stepType: this.stepType,
+      out: void 0,
+      concurrent
+    };
+  }
+  getBody({ step, context }) {
+    const userId = getUserIdFromToken(context.qstashClient);
+    const out = [userId, context.workflowRunId, getEventId()].join("/");
+    return JSON.stringify({
+      ...step,
+      out
+    });
+  }
+  safeParseOut(out) {
+    const [userId, workflowRunId, eventId] = out.split("/");
+    const qstashUrl = getQStashUrl(this.context.qstashClient);
+    return {
+      webhookUrl: `${qstashUrl}/v2/workflows/hooks/${userId}/${workflowRunId}/${eventId}`,
+      eventId
+    };
+  }
+};
+var LazyWaitForWebhookStep = class extends LazyWaitEventStep {
+  stepType = "WaitForWebhook";
+  allowUndefinedOut = true;
+  constructor(context, stepName, webhook, timeout) {
+    super(context, stepName, webhook.eventId, timeout);
+  }
+  safeParseOut(out) {
+    const eventData = decodeBase64(out);
+    const parsedEventData = BaseLazyStep.tryParsing(eventData);
+    const body = parsedEventData.body;
+    const parsedBody = typeof body === "string" ? decodeBase64(body) : void 0;
+    const request = new Request(
+      `${parsedEventData.proto}://${parsedEventData.host}${parsedEventData.url}`,
+      {
+        method: parsedEventData.method,
+        headers: parsedEventData.header,
+        body: parsedBody
+      }
+    );
+    return {
+      request,
+      timeout: false
+    };
+  }
+  handleUndefinedOut() {
+    return {
+      timeout: true,
+      request: void 0
+    };
+  }
+};
+var LazyWaitForEventStep = class extends LazyWaitEventStep {
+  stepType = "Wait";
+  allowUndefinedOut = true;
+  parseWaitForEventOut(out, waitTimeout) {
+    return {
+      eventData: out ? BaseLazyStep.tryParsing(decodeBase64(out)) : void 0,
+      timeout: waitTimeout ?? false
+    };
+  }
+  safeParseOut(out, step) {
+    return this.parseWaitForEventOut(out, step.waitTimeout);
+  }
+  handleUndefinedOut(step) {
+    return this.parseWaitForEventOut(void 0, step.waitTimeout);
+  }
+};
 
 // src/agents/constants.ts
 var AGENT_NAME_HEADER = "upstash-agent-name";
@@ -2006,7 +2121,7 @@ var AutoExecutor = class _AutoExecutor {
         step,
         stepCount: this.stepCount
       });
-      return lazyStep.parseOut(step.out);
+      return lazyStep.parseOut(step);
     }
     const resultStep = await submitSingleStep({
       context: this.context,
@@ -2093,7 +2208,7 @@ var AutoExecutor = class _AutoExecutor {
         const parallelResultSteps = sortedSteps.filter((step) => step.stepId >= initialStepCount).slice(0, parallelSteps.length);
         validateParallelSteps(parallelSteps, parallelResultSteps);
         return parallelResultSteps.map(
-          (step, index) => parallelSteps[index].parseOut(step.out)
+          (step, index) => parallelSteps[index].parseOut(step)
         );
       }
     }
@@ -2149,7 +2264,6 @@ var AutoExecutor = class _AutoExecutor {
    * @param index index of the current step
    * @returns result[index] if lazyStepList > 1, otherwise result
    */
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
   static getResult(lazyStepList, result, index) {
     if (lazyStepList.length === 1) {
       return result;
@@ -2905,7 +3019,7 @@ var WorkflowContext = class {
    */
   async run(stepName, stepFunction) {
     const wrappedStepFunction = () => this.executor.wrapStep(stepName, stepFunction);
-    return await this.addStep(new LazyFunctionStep(stepName, wrappedStepFunction));
+    return await this.addStep(new LazyFunctionStep(this, stepName, wrappedStepFunction));
   }
   /**
    * Stops the execution for the duration provided.
@@ -2919,7 +3033,7 @@ var WorkflowContext = class {
    * @returns undefined
    */
   async sleep(stepName, duration) {
-    await this.addStep(new LazySleepStep(stepName, duration));
+    await this.addStep(new LazySleepStep(this, stepName, duration));
   }
   /**
    * Stops the execution until the date time provided.
@@ -2941,13 +3055,14 @@ var WorkflowContext = class {
       datetime = typeof datetime === "string" ? new Date(datetime) : datetime;
       time = Math.round(datetime.getTime() / 1e3);
     }
-    await this.addStep(new LazySleepUntilStep(stepName, time));
+    await this.addStep(new LazySleepUntilStep(this, stepName, time));
   }
   async call(stepName, settings) {
     let callStep;
     if ("workflow" in settings) {
       const url = getNewUrlFromWorkflowId(this.url, settings.workflow.workflowId);
       callStep = new LazyCallStep(
+        this,
         stepName,
         url,
         "POST",
@@ -2972,6 +3087,7 @@ var WorkflowContext = class {
         stringifyBody = true
       } = settings;
       callStep = new LazyCallStep(
+        this,
         stepName,
         url,
         method,
@@ -3023,7 +3139,9 @@ var WorkflowContext = class {
   async waitForEvent(stepName, eventId, options = {}) {
     const { timeout = "7d" } = options;
     const timeoutStr = typeof timeout === "string" ? timeout : `${timeout}s`;
-    return await this.addStep(new LazyWaitForEventStep(stepName, eventId, timeoutStr));
+    return await this.addStep(
+      new LazyWaitForEventStep(this, stepName, eventId, timeoutStr)
+    );
   }
   /**
    * Notify workflow runs waiting for an event
@@ -3048,11 +3166,19 @@ var WorkflowContext = class {
    */
   async notify(stepName, eventId, eventData) {
     return await this.addStep(
-      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+      new LazyNotifyStep(this, stepName, eventId, eventData, this.qstashClient.http)
     );
   }
   async invoke(stepName, settings) {
-    return await this.addStep(new LazyInvokeStep(stepName, settings));
+    return await this.addStep(
+      new LazyInvokeStep(this, stepName, settings)
+    );
+  }
+  async createWebhook(stepName) {
+    return await this.addStep(new LazyCreateWebhookStep(this, stepName));
+  }
+  async waitForWebhook(stepName, webhook, timeout) {
+    return await this.addStep(new LazyWaitForWebhookStep(this, stepName, webhook, timeout));
   }
   /**
    * Cancel the current workflow run
@@ -3216,13 +3342,6 @@ var processRawSteps = (rawSteps) => {
   const stepsToDecode = encodedSteps.filter((step) => step.callType === "step");
   const otherSteps = stepsToDecode.map((rawStep) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
-    if (step.waitEventId) {
-      const newOut = {
-        eventData: step.out ? decodeBase64(step.out) : void 0,
-        timeout: step.waitTimeout ?? false
-      };
-      step.out = newOut;
-    }
     return step;
   });
   const steps = [initialStep, ...otherSteps];

package/index.mjs

@@ -15,7 +15,7 @@ import {
   prepareFlowControl,
   serve,
   triggerFirstInvocation
-} from "./chunk-BON2RKOR.mjs";
+} from "./chunk-KAGTWBLF.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, o as PublicServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.mjs';
-import { s as serveManyBase } from './serve-many-CctdYIfB.mjs';
+import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-BD06btU6.mjs';
+import { s as serveManyBase } from './serve-many-B5Vbacm6.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, o as PublicServeOptions, z as InvokableWorkflow } from './types-9nCq6bRP.js';
-import { s as serveManyBase } from './serve-many-BXDr30rl.js';
+import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-BD06btU6.js';
+import { s as serveManyBase } from './serve-many-BCV7INWe.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';