@upstash/workflow 0.1.0 → 0.1.1-canary-2

package/index.js

@@ -1116,6 +1116,23 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+var makeGetWaitersRequest = async (requester, eventId) => {
+  const result = await requester.request({
+    path: ["v2", "waiters", eventId],
+    method: "GET"
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1274,6 +1291,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1520,6 +1550,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1528,7 +1590,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1629,7 +1711,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;
@@ -1989,7 +2071,7 @@ var import_qstash5 = require("@upstash/qstash");
 var Client3 = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.baseUrl || !clientConfig.token) {
+    if (!clientConfig.token) {
       console.warn("[Upstash Workflow] url or the token is not set. client will not work.");
     }
     this.client = new import_qstash5.Client(clientConfig);
@@ -2012,18 +2094,21 @@ var Client3 = class {
    * Notify a workflow run waiting for an event
    *
    * @param eventId event id to notify
-   * @param notifyData data to provide to the workflow
+   * @param eventData data to provide to the workflow
    */
   async notify({
     eventId,
-    notifyBody
+    eventData
   }) {
-    const result = await this.client.http.request({
-      path: ["v2", "notify", eventId],
-      method: "POST",
-      body: notifyBody
-    });
-    return result;
+    return await makeNotifyRequest(this.client.http, eventId, eventData);
+  }
+  /**
+   * Check waiters of an event
+   *
+   * @param eventId event id to check
+   */
+  async getWaiters({ eventId }) {
+    return await makeGetWaitersRequest(this.client.http, eventId);
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/index.mjs

@@ -6,7 +6,7 @@ import {
   WorkflowContext,
   WorkflowLogger,
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 export {
   Client,
   QStashWorkflowAbort,

package/nextjs.d.mts

@@ -1,6 +1,6 @@
 import { NextApiHandler } from 'next';
 import { NextResponse } from 'next/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 /**

package/nextjs.d.ts

@@ -1,6 +1,6 @@
 import { NextApiHandler } from 'next';
 import { NextResponse } from 'next/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 /**

package/nextjs.js

@@ -1112,6 +1112,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1270,6 +1280,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1516,6 +1539,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1524,7 +1579,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1625,7 +1700,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/nextjs.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/nextjs.ts
 import { NextResponse } from "next/server";

package/package.json

@@ -1,99 +1 @@
-{
-  "name": "@upstash/workflow",
-  "version": "0.1.0",
-  "description": "Durable, Reliable and Performant Serverless Functions",
-  "main": "./index.js",
-  "module": "./index.mjs",
-  "types": "./index.d.ts",
-  "files": [
-    "./*"
-  ],
-  "exports": {
-    ".": {
-      "import": "./index.mjs",
-      "require": "./index.js"
-    },
-    "./dist/nextjs": {
-      "import": "./nextjs.mjs",
-      "require": "./nextjs.js"
-    },
-    "./nextjs": {
-      "import": "./nextjs.mjs",
-      "require": "./nextjs.js"
-    },
-    "./h3": {
-      "import": "./h3.mjs",
-      "require": "./h3.js"
-    },
-    "./svelte": {
-      "import": "./svelte.mjs",
-      "require": "./svelte.js"
-    },
-    "./solidjs": {
-      "import": "./solidjs.mjs",
-      "require": "./solidjs.js"
-    },
-    "./workflow": {
-      "import": "./workflow.mjs",
-      "require": "./workflow.js"
-    },
-    "./hono": {
-      "import": "./hono.mjs",
-      "require": "./hono.js"
-    },
-    "./cloudflare": {
-      "import": "./cloudflare.mjs",
-      "require": "./cloudflare.js"
-    }
-  },
-  "scripts": {
-    "build": "tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/",
-    "test": "bun test src",
-    "fmt": "prettier --write .",
-    "lint": "tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\"  --quiet --fix",
-    "check-exports": "bun run build && cd dist && attw -P",
-    "prepare": "husky"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/upstash/workflow-ts.git"
-  },
-  "keywords": [
-    "upstash",
-    "qstash",
-    "workflow",
-    "serverless"
-  ],
-  "author": "Cahid Arda Oz",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/upstash/workflow-ts/issues"
-  },
-  "homepage": "https://github.com/upstash/workflow-ts#readme",
-  "devDependencies": {
-    "@commitlint/cli": "^19.5.0",
-    "@commitlint/config-conventional": "^19.5.0",
-    "@eslint/js": "^9.11.1",
-    "@solidjs/start": "^1.0.8",
-    "@sveltejs/kit": "^2.6.1",
-    "@types/bun": "^1.1.10",
-    "eslint": "^9.11.1",
-    "eslint-plugin-unicorn": "^55.0.0",
-    "globals": "^15.10.0",
-    "h3": "^1.12.0",
-    "hono": "^4.6.3",
-    "husky": "^9.1.6",
-    "next": "^14.2.14",
-    "prettier": "3.3.3",
-    "tsc": "^2.0.4",
-    "tsup": "^8.3.0",
-    "typescript": "5.4.5",
-    "typescript-eslint": "^8.8.0"
-  },
-  "dependencies": {
-    "@upstash/qstash": "^2.7.12"
-  },
-  "directories": {
-    "example": "examples"
-  }
-}
+{"name":"@upstash/workflow","version":"v0.1.1-canary-2","description":"Durable, Reliable and Performant Serverless Functions","main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./*"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./h3":{"import":"./h3.mjs","require":"./h3.js"},"./svelte":{"import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"import":"./workflow.mjs","require":"./workflow.js"},"./hono":{"import":"./hono.mjs","require":"./hono.js"},"./cloudflare":{"import":"./cloudflare.mjs","require":"./cloudflare.js"}},"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test src","fmt":"prettier --write .","lint":"tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\" --quiet --fix","check-exports":"bun run build && cd dist && attw -P"},"repository":{"type":"git","url":"git+https://github.com/upstash/workflow-ts.git"},"keywords":["upstash","qstash","workflow","serverless"],"author":"Cahid Arda Oz","license":"MIT","bugs":{"url":"https://github.com/upstash/workflow-ts/issues"},"homepage":"https://github.com/upstash/workflow-ts#readme","devDependencies":{"@commitlint/cli":"^19.5.0","@commitlint/config-conventional":"^19.5.0","@eslint/js":"^9.11.1","@solidjs/start":"^1.0.8","@sveltejs/kit":"^2.6.1","@types/bun":"^1.1.10","eslint":"^9.11.1","eslint-plugin-unicorn":"^55.0.0","globals":"^15.10.0","h3":"^1.12.0","hono":"^4.6.3","husky":"^9.1.6","next":"^14.2.14","prettier":"3.3.3","tsc":"^2.0.4","tsup":"^8.3.0","typescript":"5.4.5","typescript-eslint":"^8.8.0"},"dependencies":{"@upstash/qstash":"^2.7.12"}}

package/solidjs.d.mts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 /**

package/solidjs.d.ts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 /**

package/solidjs.js

@@ -1110,6 +1110,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1268,6 +1278,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1514,6 +1537,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1522,7 +1577,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1623,7 +1698,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/solidjs.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/solidjs.ts
 var serve2 = (routeFunction, options) => {

package/svelte.d.mts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 /**

package/svelte.d.ts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-CfN1Epuj.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 /**

package/svelte.js

@@ -1110,6 +1110,16 @@ var sortSteps = (steps) => {
   return steps.toSorted((step, stepOther) => getStepId(step) - getStepId(stepOther));
 };
 
+// src/client/utils.ts
+var makeNotifyRequest = async (requester, eventId, eventData) => {
+  const result = await requester.request({
+    path: ["v2", "notify", eventId],
+    method: "POST",
+    body: typeof eventData === "string" ? eventData : JSON.stringify(eventData)
+  });
+  return result;
+};
+
 // src/context/steps.ts
 var BaseLazyStep = class {
   stepName;
@@ -1268,6 +1278,19 @@ var LazyWaitForEventStep = class extends BaseLazyStep {
     });
   }
 };
+var LazyNotifyStep = class extends LazyFunctionStep {
+  stepType = "Notify";
+  constructor(stepName, eventId, eventData, requester) {
+    super(stepName, async () => {
+      const notifyResponse = await makeNotifyRequest(requester, eventId, eventData);
+      return {
+        eventId,
+        eventData,
+        notifyResponse
+      };
+    });
+  }
+};
 
 // src/context/context.ts
 var WorkflowContext = class {
@@ -1514,6 +1537,38 @@ var WorkflowContext = class {
       return result;
     }
   }
+  /**
+   * Makes the workflow run wait until a notify request is sent or until the
+   * timeout ends
+   *
+   * ```ts
+   * const { eventData, timeout } = await context.waitForEvent(
+   *   "wait for event step",
+   *   "my-event-id",
+   *   100 // timeout after 100 seconds
+   * );
+   * ```
+   *
+   * To notify a waiting workflow run, you can use the notify method:
+   *
+   * ```ts
+   * import { Client } from "@upstash/workflow";
+   *
+   * const client = new Client({ token: });
+   *
+   * await client.notify({
+   *   eventId: "my-event-id",
+   *   eventData: "eventData"
+   * })
+   * ```
+   *
+   * @param stepName
+   * @param eventId event id to wake up the waiting workflow run
+   * @param timeout timeout duration in seconds
+   * @returns wait response as `{ timeout: boolean, eventData: unknown }`.
+   *   timeout is true if the wait times out, if notified it is false. eventData
+   *   is the value passed to `client.notify`.
+   */
   async waitForEvent(stepName, eventId, timeout) {
     const result = await this.addStep(
       new LazyWaitForEventStep(
@@ -1522,7 +1577,27 @@ var WorkflowContext = class {
         typeof timeout === "string" ? timeout : `${timeout}s`
       )
     );
-    return result;
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
+  }
+  async notify(stepName, eventId, eventData) {
+    const result = await this.addStep(
+      new LazyNotifyStep(stepName, eventId, eventData, this.qstashClient.http)
+    );
+    try {
+      return {
+        ...result,
+        eventData: JSON.parse(result.eventData)
+      };
+    } catch {
+      return result;
+    }
   }
   /**
    * Adds steps to the executor. Needed so that it can be overwritten in
@@ -1623,7 +1698,7 @@ var parsePayload = (rawPayload) => {
     const step = JSON.parse(decodeBase64(rawStep.body));
     if (step.waitEventId) {
       const newOut = {
-        notifyBody: step.out,
+        eventData: step.out,
         timeout: step.waitTimeout ?? false
       };
       step.out = newOut;

package/svelte.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-JDMP6KKR.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/svelte.ts
 var serve2 = (routeFunction, options) => {