@upstash/workflow 0.2.23 → 0.3.0-rc1

package/index.mjs

@@ -5,17 +5,17 @@ import {
   WorkflowAbort,
   WorkflowContext,
   WorkflowError,
-  WorkflowLogger,
+  WorkflowMiddleware,
   WorkflowNonRetryableError,
   WorkflowRetryAfterError,
-  WorkflowTool,
   getWorkflowRunId,
+  loggingMiddleware,
   makeGetWaitersRequest,
   makeNotifyRequest,
   prepareFlowControl,
   serve,
   triggerFirstInvocation
-} from "./chunk-GZRDB6Z5.mjs";
+} from "./chunk-2Z32SOYM.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
@@ -28,15 +28,19 @@ var DLQ = class _DLQ {
   /**
    * list the items in the DLQ
    *
-   * @param cursor - Optional cursor for pagination.
-   * @param count - Optional number of items to return.
-   * @param filter - Optional filter options to apply to the DLQ items.
+   * @param parameters - Optional parameters object
+   * @param parameters.cursor - Optional cursor for pagination
+   * @param parameters.count - Optional number of items to return
+   * @param parameters.filter - Optional filter options to apply to the DLQ items.
    *    The available filter options are:
    *    - `fromDate`: Filter items which entered the DLQ after this date.
    *    - `toDate`: Filter items which entered the DLQ before this date.
    *    - `url`: Filter items by the URL they were sent to.
    *    - `responseStatus`: Filter items by the response status code.
-   * @returns
+   *    - `workflowRunId`: Filter items by workflow run ID.
+   *    - `workflowCreatedAt`: Filter items by workflow creation time.
+   *    - `failureFunctionState`: Filter items by failure callback state.
+   *    - `label`: Filter items by label.
    */
   async list(parameters) {
     const { cursor, count, filter } = parameters || {};
@@ -79,8 +83,8 @@ var DLQ = class _DLQ {
    * Retry the failure callback of a workflow run whose failureUrl/failureFunction
    * request has failed.
    *
-   * @param dlqId - The ID of the DLQ message to retry.
-   * @returns
+   * @param dlqId - The ID of the DLQ message to retry
+   * @returns response with workflow run information
    */
   async retryFailureFunction({ dlqId }) {
     const response = await this.client.http.request({
@@ -89,6 +93,11 @@ var DLQ = class _DLQ {
     });
     return response;
   }
+  /**
+   * Handles DLQ options and prepares headers and query parameters.
+   *
+   * @param options - DLQ resume/restart options
+   */
   static handleDLQOptions(options) {
     const { dlqId, flowControl, retries } = options;
     const headers = {};
@@ -105,6 +114,11 @@ var DLQ = class _DLQ {
       headers
     };
   }
+  /**
+   * Converts DLQ ID(s) to query parameter string.
+   *
+   * @param dlqId - Single DLQ ID or array of DLQ IDs
+   */
   static getDlqIdQueryParameter(dlqId) {
     const dlqIds = Array.isArray(dlqId) ? dlqId : [dlqId];
     const paramsArray = dlqIds.map((id) => ["dlqIds", id]);
@@ -116,11 +130,6 @@ var DLQ = class _DLQ {
 var Client = class {
   client;
   constructor(clientConfig) {
-    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   });"
-      );
-    }
     this.client = new QStashClient(clientConfig);
   }
   /**
@@ -243,11 +252,10 @@ var Client = class {
     const isBatchInput = Array.isArray(params);
     const options = isBatchInput ? params : [params];
     const invocations = options.map((option) => {
-      const failureUrl = option.useFailureFunction ? option.url : option.failureUrl;
+      const failureUrl = option.failureUrl ?? option.url;
       const finalWorkflowRunId = getWorkflowRunId(option.workflowRunId);
       const context = new WorkflowContext({
         qstashClient: this.client,
-        // @ts-expect-error header type mismatch because of bun
         headers: new Headers({
           ...option.headers ?? {},
           ...option.label ? { [WORKFLOW_LABEL_HEADER]: option.label } : {}
@@ -256,11 +264,7 @@ var Client = class {
         steps: [],
         url: option.url,
         workflowRunId: finalWorkflowRunId,
-        retries: option.retries,
-        retryDelay: option.retryDelay,
         telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
-        flowControl: option.flowControl,
-        failureUrl,
         label: option.label
       });
       return {
@@ -268,7 +272,10 @@ var Client = class {
         telemetry: option.disableTelemetry ? void 0 : { sdk: SDK_TELEMETRY },
         delay: option.delay,
         notBefore: option.notBefore,
-        keepTriggerConfig: option.keepTriggerConfig
+        failureUrl,
+        retries: option.retries,
+        retryDelay: option.retryDelay,
+        flowControl: option.flowControl
       };
     });
     const result = await triggerFirstInvocation(invocations);
@@ -347,9 +354,9 @@ export {
   WorkflowAbort,
   WorkflowContext,
   WorkflowError,
-  WorkflowLogger,
+  WorkflowMiddleware,
   WorkflowNonRetryableError,
   WorkflowRetryAfterError,
-  WorkflowTool,
+  loggingMiddleware,
   serve
 };

package/nextjs.d.mts

@@ -1,10 +1,8 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-BD06btU6.mjs';
-import { s as serveManyBase } from './serve-many-B5Vbacm6.mjs';
+import { c as RouteFunction, d as WorkflowServeOptions, x as InvokableWorkflow } from './types-pEje3VEB.mjs';
+import { s as serveManyBase } from './serve-many-DhB8-zPD.mjs';
 import '@upstash/qstash';
 import 'zod';
-import 'ai';
-import '@ai-sdk/openai';
 
 /**
  * Serve method to serve a Upstash Workflow in a Nextjs project
@@ -15,17 +13,17 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflow: <TInitialPayload, TResult>(...params: Parameters<typeof serve<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (request: Request) => Promise<any>;
 };
-declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => {
     handler: NextApiHandler;
 };
-declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(...params: Parameters<typeof servePagesRouter<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
 };

package/nextjs.d.ts

@@ -1,10 +1,8 @@
 import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
-import { R as RouteFunction, o as PublicServeOptions, z as InvokableWorkflow } from './types-BD06btU6.js';
-import { s as serveManyBase } from './serve-many-BCV7INWe.js';
+import { c as RouteFunction, d as WorkflowServeOptions, x as InvokableWorkflow } from './types-pEje3VEB.js';
+import { s as serveManyBase } from './serve-many-qnfynN1x.js';
 import '@upstash/qstash';
 import 'zod';
-import 'ai';
-import '@ai-sdk/openai';
 
 /**
  * Serve method to serve a Upstash Workflow in a Nextjs project
@@ -15,17 +13,17 @@ import '@ai-sdk/openai';
  * @param options workflow options
  * @returns
  */
-declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const serve: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => {
     POST: (request: Request) => Promise<Response>;
 };
-declare const createWorkflow: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflow: <TInitialPayload, TResult>(...params: Parameters<typeof serve<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveMany: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     POST: (request: Request) => Promise<any>;
 };
-declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload>) => {
+declare const servePagesRouter: <TInitialPayload = unknown, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: WorkflowServeOptions<TInitialPayload, TResult>) => {
     handler: NextApiHandler;
 };
-declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: PublicServeOptions<TInitialPayload> | undefined) => InvokableWorkflow<TInitialPayload, TResult>;
+declare const createWorkflowPagesRouter: <TInitialPayload, TResult>(...params: Parameters<typeof servePagesRouter<TInitialPayload, TResult>>) => InvokableWorkflow<TInitialPayload, TResult>;
 declare const serveManyPagesRouter: (workflows: Parameters<typeof serveManyBase>[0]["workflows"], options?: Parameters<typeof serveManyBase>[0]["options"]) => {
     handler: (req: NextApiRequest, res: NextApiResponse<any>) => Promise<any>;
 };