@upstash/workflow 0.1.1-canary → 0.1.1-canary-2

package/solidjs.d.mts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-D8FBKkto.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 /**
@@ -11,8 +11,6 @@ import '@upstash/qstash';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => {
-    POST: (event: APIEvent) => Promise<Response>;
-};
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => (event: APIEvent) => Promise<Response>;
 
 export { serve };

package/solidjs.d.ts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-D8FBKkto.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 /**
@@ -11,8 +11,6 @@ import '@upstash/qstash';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => {
-    POST: (event: APIEvent) => Promise<Response>;
-};
+declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish">) => (event: APIEvent) => Promise<Response>;
 
 export { serve };

package/solidjs.js

@@ -474,7 +474,6 @@ var WORKFLOW_ID_HEADER = "Upstash-Workflow-RunId";
 var WORKFLOW_INIT_HEADER = "Upstash-Workflow-Init";
 var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
-var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
@@ -560,13 +559,13 @@ var handleThirdPartyCallResult = async (request, requestPayload, client, workflo
   try {
     if (request.headers.get("Upstash-Workflow-Callback")) {
       const callbackMessage = JSON.parse(requestPayload);
-      if (!(callbackMessage.status >= 200 && callbackMessage.status < 300) && callbackMessage.maxRetries && callbackMessage.retried !== callbackMessage.maxRetries) {
+      if (!(callbackMessage.status >= 200 && callbackMessage.status < 300)) {
         await debug?.log("WARN", "SUBMIT_THIRD_PARTY_RESULT", {
           status: callbackMessage.status,
           body: atob(callbackMessage.body)
         });
         console.warn(
-          `Workflow Warning: "context.call" failed with status ${callbackMessage.status} and will retry (retried ${callbackMessage.retried ?? 0} out of ${callbackMessage.maxRetries} times). Error Message:
+          `Workflow Warning: "context.call" failed with status ${callbackMessage.status} and will retry (if there are retries remaining). Error Message:
 ${atob(callbackMessage.body)}`
         );
         return ok("call-will-retry");
@@ -603,11 +602,7 @@ ${atob(callbackMessage.body)}`
         stepId: Number(stepIdString),
         stepName,
         stepType,
-        out: {
-          status: callbackMessage.status,
-          body: atob(callbackMessage.body),
-          header: callbackMessage.header
-        },
+        out: atob(callbackMessage.body),
         concurrent: Number(concurrentString)
       };
       await debug?.log("SUBMIT", "SUBMIT_THIRD_PARTY_RESULT", {
@@ -642,24 +637,15 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
     [WORKFLOW_URL_HEADER]: workflowUrl,
-    [WORKFLOW_FEATURE_HEADER]: "WF_NoDelete",
-    [`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`]: WORKFLOW_PROTOCOL_VERSION
-  };
-  if (failureUrl) {
-    if (!step?.callUrl) {
-      baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
-    }
-    baseHeaders["Upstash-Failure-Callback"] = failureUrl;
-  }
-  if (step?.callUrl) {
-    baseHeaders["Upstash-Retries"] = "0";
-    if (retries) {
-      baseHeaders["Upstash-Callback-Retries"] = retries.toString();
-      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    [`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`]: WORKFLOW_PROTOCOL_VERSION,
+    ...failureUrl ? {
+      [`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`]: "true",
+      "Upstash-Failure-Callback": failureUrl
+    } : {},
+    ...retries === void 0 ? {} : {
+      "Upstash-Retries": retries.toString()
     }
-  } else if (retries !== void 0) {
-    baseHeaders["Upstash-Retries"] = retries.toString();
-  }
+  };
   if (userHeaders) {
     for (const header of userHeaders.keys()) {
       if (step?.callHeaders) {
@@ -1124,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;
@@ -1282,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 {
@@ -1518,13 +1527,48 @@ var WorkflowContext = class {
    * @returns call result (parsed as JSON if possible)
    */
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-  async call(stepName, callSettings) {
-    const { url, method = "GET", body, headers = {} } = callSettings;
+  async call(stepName, url, method, body, headers) {
     const result = await this.addStep(
-      new LazyCallStep(stepName, url, method, body, headers)
+      new LazyCallStep(stepName, url, method, body, headers ?? {})
     );
-    return result;
+    try {
+      return JSON.parse(result);
+    } catch {
+      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(
@@ -1533,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
@@ -1634,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;
@@ -1891,7 +1955,6 @@ var serve = (routeFunction, options) => {
   } = processOptions(options);
   const debug = WorkflowLogger.getLogger(verbose);
   const handler = async (request) => {
-    await debug?.log("INFO", "ENDPOINT_START");
     const { workflowUrl, workflowFailureUrl } = await determineUrls(
       request,
       url,
@@ -1935,8 +1998,7 @@ var serve = (routeFunction, options) => {
       url: workflowUrl,
       failureUrl: workflowFailureUrl,
       debug,
-      env,
-      retries
+      env
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -1979,7 +2041,7 @@ var serve = (routeFunction, options) => {
     await debug?.log("INFO", "RESPONSE_DEFAULT");
     return onStepFinish("no-workflow-id", "fromCallback");
   };
-  const safeHandler = async (request) => {
+  return async (request) => {
     try {
       return await handler(request);
     } catch (error) {
@@ -1989,7 +2051,6 @@ var serve = (routeFunction, options) => {
       });
     }
   };
-  return { handler: safeHandler };
 };
 
 // src/client/index.ts
@@ -2004,10 +2065,10 @@ var serve2 = (routeFunction, options) => {
         status: 405
       });
     }
-    const { handler: serveHandler } = serve(routeFunction, options);
+    const serveHandler = serve(routeFunction, options);
     return await serveHandler(event.request);
   };
-  return { POST: handler };
+  return handler;
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/solidjs.mjs

@@ -1,6 +1,6 @@
 import {
   serve
-} from "./chunk-YW5KUHA2.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/solidjs.ts
 var serve2 = (routeFunction, options) => {
@@ -11,10 +11,10 @@ var serve2 = (routeFunction, options) => {
         status: 405
       });
     }
-    const { handler: serveHandler } = serve(routeFunction, options);
+    const serveHandler = serve(routeFunction, options);
     return await serveHandler(event.request);
   };
-  return { POST: handler };
+  return handler;
 };
 export {
   serve2 as serve

package/svelte.d.mts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-D8FBKkto.mjs';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.mjs';
 import '@upstash/qstash';
 
 /**
@@ -13,8 +13,6 @@ import '@upstash/qstash';
  */
 declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish"> & {
     env: WorkflowServeOptions["env"];
-}) => {
-    POST: RequestHandler;
-};
+}) => RequestHandler;
 
 export { serve };

package/svelte.d.ts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, W as WorkflowServeOptions } from './types-D8FBKkto.js';
+import { R as RouteFunction, W as WorkflowServeOptions } from './types-CoXaNrxX.js';
 import '@upstash/qstash';
 
 /**
@@ -13,8 +13,6 @@ import '@upstash/qstash';
  */
 declare const serve: <TInitialPayload = unknown>(routeFunction: RouteFunction<TInitialPayload>, options: Omit<WorkflowServeOptions<Response, TInitialPayload>, "onStepFinish"> & {
     env: WorkflowServeOptions["env"];
-}) => {
-    POST: RequestHandler;
-};
+}) => RequestHandler;
 
 export { serve };

package/svelte.js

@@ -474,7 +474,6 @@ var WORKFLOW_ID_HEADER = "Upstash-Workflow-RunId";
 var WORKFLOW_INIT_HEADER = "Upstash-Workflow-Init";
 var WORKFLOW_URL_HEADER = "Upstash-Workflow-Url";
 var WORKFLOW_FAILURE_HEADER = "Upstash-Workflow-Is-Failure";
-var WORKFLOW_FEATURE_HEADER = "Upstash-Feature-Set";
 var WORKFLOW_PROTOCOL_VERSION = "1";
 var WORKFLOW_PROTOCOL_VERSION_HEADER = "Upstash-Workflow-Sdk-Version";
 var DEFAULT_CONTENT_TYPE = "application/json";
@@ -560,13 +559,13 @@ var handleThirdPartyCallResult = async (request, requestPayload, client, workflo
   try {
     if (request.headers.get("Upstash-Workflow-Callback")) {
       const callbackMessage = JSON.parse(requestPayload);
-      if (!(callbackMessage.status >= 200 && callbackMessage.status < 300) && callbackMessage.maxRetries && callbackMessage.retried !== callbackMessage.maxRetries) {
+      if (!(callbackMessage.status >= 200 && callbackMessage.status < 300)) {
         await debug?.log("WARN", "SUBMIT_THIRD_PARTY_RESULT", {
           status: callbackMessage.status,
           body: atob(callbackMessage.body)
         });
         console.warn(
-          `Workflow Warning: "context.call" failed with status ${callbackMessage.status} and will retry (retried ${callbackMessage.retried ?? 0} out of ${callbackMessage.maxRetries} times). Error Message:
+          `Workflow Warning: "context.call" failed with status ${callbackMessage.status} and will retry (if there are retries remaining). Error Message:
 ${atob(callbackMessage.body)}`
         );
         return ok("call-will-retry");
@@ -603,11 +602,7 @@ ${atob(callbackMessage.body)}`
         stepId: Number(stepIdString),
         stepName,
         stepType,
-        out: {
-          status: callbackMessage.status,
-          body: atob(callbackMessage.body),
-          header: callbackMessage.header
-        },
+        out: atob(callbackMessage.body),
         concurrent: Number(concurrentString)
       };
       await debug?.log("SUBMIT", "SUBMIT_THIRD_PARTY_RESULT", {
@@ -642,24 +637,15 @@ var getHeaders = (initHeaderValue, workflowRunId, workflowUrl, userHeaders, step
     [WORKFLOW_INIT_HEADER]: initHeaderValue,
     [WORKFLOW_ID_HEADER]: workflowRunId,
     [WORKFLOW_URL_HEADER]: workflowUrl,
-    [WORKFLOW_FEATURE_HEADER]: "WF_NoDelete",
-    [`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`]: WORKFLOW_PROTOCOL_VERSION
-  };
-  if (failureUrl) {
-    if (!step?.callUrl) {
-      baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
-    }
-    baseHeaders["Upstash-Failure-Callback"] = failureUrl;
-  }
-  if (step?.callUrl) {
-    baseHeaders["Upstash-Retries"] = "0";
-    if (retries) {
-      baseHeaders["Upstash-Callback-Retries"] = retries.toString();
-      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    [`Upstash-Forward-${WORKFLOW_PROTOCOL_VERSION_HEADER}`]: WORKFLOW_PROTOCOL_VERSION,
+    ...failureUrl ? {
+      [`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`]: "true",
+      "Upstash-Failure-Callback": failureUrl
+    } : {},
+    ...retries === void 0 ? {} : {
+      "Upstash-Retries": retries.toString()
     }
-  } else if (retries !== void 0) {
-    baseHeaders["Upstash-Retries"] = retries.toString();
-  }
+  };
   if (userHeaders) {
     for (const header of userHeaders.keys()) {
       if (step?.callHeaders) {
@@ -1124,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;
@@ -1282,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 {
@@ -1518,13 +1527,48 @@ var WorkflowContext = class {
    * @returns call result (parsed as JSON if possible)
    */
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-  async call(stepName, callSettings) {
-    const { url, method = "GET", body, headers = {} } = callSettings;
+  async call(stepName, url, method, body, headers) {
     const result = await this.addStep(
-      new LazyCallStep(stepName, url, method, body, headers)
+      new LazyCallStep(stepName, url, method, body, headers ?? {})
     );
-    return result;
+    try {
+      return JSON.parse(result);
+    } catch {
+      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(
@@ -1533,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
@@ -1634,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;
@@ -1891,7 +1955,6 @@ var serve = (routeFunction, options) => {
   } = processOptions(options);
   const debug = WorkflowLogger.getLogger(verbose);
   const handler = async (request) => {
-    await debug?.log("INFO", "ENDPOINT_START");
     const { workflowUrl, workflowFailureUrl } = await determineUrls(
       request,
       url,
@@ -1935,8 +1998,7 @@ var serve = (routeFunction, options) => {
       url: workflowUrl,
       failureUrl: workflowFailureUrl,
       debug,
-      env,
-      retries
+      env
     });
     const authCheck = await DisabledWorkflowContext.tryAuthentication(
       routeFunction,
@@ -1979,7 +2041,7 @@ var serve = (routeFunction, options) => {
     await debug?.log("INFO", "RESPONSE_DEFAULT");
     return onStepFinish("no-workflow-id", "fromCallback");
   };
-  const safeHandler = async (request) => {
+  return async (request) => {
     try {
       return await handler(request);
     } catch (error) {
@@ -1989,7 +2051,6 @@ var serve = (routeFunction, options) => {
       });
     }
   };
-  return { handler: safeHandler };
 };
 
 // src/client/index.ts
@@ -1998,10 +2059,10 @@ var import_qstash5 = require("@upstash/qstash");
 // platforms/svelte.ts
 var serve2 = (routeFunction, options) => {
   const handler = async ({ request }) => {
-    const { handler: serveHandler } = serve(routeFunction, options);
-    return await serveHandler(request);
+    const serveMethod = serve(routeFunction, options);
+    return await serveMethod(request);
   };
-  return { POST: handler };
+  return handler;
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/svelte.mjs

@@ -1,14 +1,14 @@
 import {
   serve
-} from "./chunk-YW5KUHA2.mjs";
+} from "./chunk-BPN5JBNG.mjs";
 
 // platforms/svelte.ts
 var serve2 = (routeFunction, options) => {
   const handler = async ({ request }) => {
-    const { handler: serveHandler } = serve(routeFunction, options);
-    return await serveHandler(request);
+    const serveMethod = serve(routeFunction, options);
+    return await serveMethod(request);
   };
-  return { POST: handler };
+  return handler;
 };
 export {
   serve2 as serve