@upstash/workflow 0.2.8 → 0.2.10-hono-generics

package/hono.mjs

@@ -1,30 +1,48 @@
 import {
   SDK_TELEMETRY,
-  serveBase
-} from "./chunk-BPUSHNSD.mjs";
+  serveBase,
+  serveManyBase
+} from "./chunk-IPXJZU3K.mjs";
 
 // platforms/hono.ts
+var telemetry = {
+  sdk: SDK_TELEMETRY,
+  framework: "hono"
+};
 var serve = (routeFunction, options) => {
   const handler = async (context) => {
     const environment = context.env;
     const request = context.req.raw;
-    const { handler: serveHandler } = serveBase(
-      routeFunction,
-      {
-        sdk: SDK_TELEMETRY,
-        framework: "hono"
-      },
-      {
-        // when hono is used without cf workers, it sends a DebugHTTPServer
-        // object in `context.env`. don't pass env if this is the case:
-        env: "QSTASH_TOKEN" in environment ? environment : void 0,
-        ...options
-      }
-    );
+    const { handler: serveHandler } = serveBase(routeFunction, telemetry, {
+      // when hono is used without cf workers, it sends a DebugHTTPServer
+      // object in `context.env`. don't pass env if this is the case:
+      env: "QSTASH_TOKEN" in environment ? environment : void 0,
+      ...options
+    });
     return await serveHandler(request);
   };
   return handler;
 };
+var createWorkflow = (...params) => {
+  const [routeFunction, options = {}] = params;
+  return {
+    routeFunction,
+    options,
+    workflowId: void 0
+  };
+};
+var serveMany = (workflows, options) => {
+  return serveManyBase({
+    workflows,
+    getUrl(params) {
+      return params.req.url;
+    },
+    serveMethod: (...params) => serve(...params),
+    options
+  }).handler;
+};
 export {
-  serve
+  createWorkflow,
+  serve,
+  serveMany
 };

package/index.d.mts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-B62AnIU3.mjs';
-export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, T as Telemetry, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, t as WorkflowLogger, s as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-B62AnIU3.mjs';
-import { HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-CYhDXnf8.mjs';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-CYhDXnf8.mjs';
+import { HTTPMethods, State, FlowControl, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -9,13 +9,26 @@ import '@ai-sdk/openai';
  * Creates an async method that handles incoming requests and runs the provided
  * route function as a workflow.
  *
+ * Not exported in the package. Instead, used in framework specific serve implementations.
+ *
+ * Only difference from regular serve is the `useJSONContent` parameter.
+ *
  * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
  * @param options - Options including the client, onFinish callback, and initialPayloadParser.
  * @returns An async method that consumes incoming requests and runs the workflow.
  */
-declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => {
+declare const serveBase: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, telemetry?: Telemetry, options?: WorkflowServeOptions<TResponse, TInitialPayload>) => {
     handler: (request: TRequest) => Promise<TResponse>;
 };
+/**
+ * Creates an async method that handles incoming requests and runs the provided
+ * route function as a workflow.
+ *
+ * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
+ * @param options - Options including the client, onFinish callback, and initialPayloadParser.
+ * @returns An async method that consumes incoming requests and runs the workflow.
+ */
+declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => ReturnType<typeof serveBase<TInitialPayload, TRequest, TResponse, TResult>>;
 
 type BaseStepLog = {
     /**
@@ -81,7 +94,7 @@ type CallUrlGroup = {
     callHeaders: Record<string, string[]>;
     /**
      * Body sent in context.call
-    */
+     */
     callBody: unknown;
 };
 type CallResponseStatusGroup = {
@@ -382,42 +395,43 @@ declare class Client {
      *   the workflow, `retries` option of the `serve` will be used.
      * @returns workflow run id
      */
-    trigger({ url, body, headers, workflowRunId, retries, }: {
+    trigger({ url, body, headers, workflowRunId, retries, flowControl, }: {
         url: string;
         body?: unknown;
         headers?: Record<string, string>;
         workflowRunId?: string;
         retries?: number;
+        flowControl?: FlowControl;
     }): Promise<{
         workflowRunId: string;
     }>;
     /**
-      * Fetches logs for workflow runs.
-      *
-      * @param workflowRunId - The ID of the workflow run to fetch logs for.
-      * @param cursor - The cursor for pagination.
-      * @param count - Number of runs to fetch. Default value is 10.
-      * @param state - The state of the workflow run.
-      * @param workflowUrl - The URL of the workflow. Should be an exact match.
-      * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
-      * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
-      *
-      * @example
-      * Fetch logs for a specific workflow run:
-      * ```typescript
-      * const { runs } = await client.logs({ workflowRunId: '12345' });
-      * const steps = runs[0].steps; // access steps
-      * ```
-      *
-      * @example
-      * Fetch logs with pagination:
-      * ```typescript
-      * const { runs, cursor } = await client.logs();
-      * const steps = runs[0].steps // access steps
-      *
-      * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
-      * ```
-      */
+     * Fetches logs for workflow runs.
+     *
+     * @param workflowRunId - The ID of the workflow run to fetch logs for.
+     * @param cursor - The cursor for pagination.
+     * @param count - Number of runs to fetch. Default value is 10.
+     * @param state - The state of the workflow run.
+     * @param workflowUrl - The URL of the workflow. Should be an exact match.
+     * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+     * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+     *
+     * @example
+     * Fetch logs for a specific workflow run:
+     * ```typescript
+     * const { runs } = await client.logs({ workflowRunId: '12345' });
+     * const steps = runs[0].steps; // access steps
+     * ```
+     *
+     * @example
+     * Fetch logs with pagination:
+     * ```typescript
+     * const { runs, cursor } = await client.logs();
+     * const steps = runs[0].steps // access steps
+     *
+     * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+     * ```
+     */
     logs(params?: {
         workflowRunId?: WorkflowRunLog["workflowRunId"];
         cursor?: string;
@@ -454,4 +468,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };

package/index.d.ts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-B62AnIU3.js';
-export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, T as Telemetry, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, t as WorkflowLogger, s as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-B62AnIU3.js';
-import { HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, T as Telemetry, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-CYhDXnf8.js';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, t as InvokableWorkflow, s as InvokeStepResponse, I as InvokeWorkflowRequest, L as LazyInvokeStepParams, u as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, w as WorkflowLogger, v as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-CYhDXnf8.js';
+import { HTTPMethods, State, FlowControl, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -9,13 +9,26 @@ import '@ai-sdk/openai';
  * Creates an async method that handles incoming requests and runs the provided
  * route function as a workflow.
  *
+ * Not exported in the package. Instead, used in framework specific serve implementations.
+ *
+ * Only difference from regular serve is the `useJSONContent` parameter.
+ *
  * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
  * @param options - Options including the client, onFinish callback, and initialPayloadParser.
  * @returns An async method that consumes incoming requests and runs the workflow.
  */
-declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response>(routeFunction: RouteFunction<TInitialPayload>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => {
+declare const serveBase: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, telemetry?: Telemetry, options?: WorkflowServeOptions<TResponse, TInitialPayload>) => {
     handler: (request: TRequest) => Promise<TResponse>;
 };
+/**
+ * Creates an async method that handles incoming requests and runs the provided
+ * route function as a workflow.
+ *
+ * @param routeFunction - A function that uses WorkflowContext as a parameter and runs a workflow.
+ * @param options - Options including the client, onFinish callback, and initialPayloadParser.
+ * @returns An async method that consumes incoming requests and runs the workflow.
+ */
+declare const serve: <TInitialPayload = unknown, TRequest extends Request = Request, TResponse extends Response = Response, TResult = unknown>(routeFunction: RouteFunction<TInitialPayload, TResult>, options?: Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "useJSONContent" | "schema" | "initialPayloadParser"> & ExclusiveValidationOptions<TInitialPayload>) => ReturnType<typeof serveBase<TInitialPayload, TRequest, TResponse, TResult>>;
 
 type BaseStepLog = {
     /**
@@ -81,7 +94,7 @@ type CallUrlGroup = {
     callHeaders: Record<string, string[]>;
     /**
      * Body sent in context.call
-    */
+     */
     callBody: unknown;
 };
 type CallResponseStatusGroup = {
@@ -382,42 +395,43 @@ declare class Client {
      *   the workflow, `retries` option of the `serve` will be used.
      * @returns workflow run id
      */
-    trigger({ url, body, headers, workflowRunId, retries, }: {
+    trigger({ url, body, headers, workflowRunId, retries, flowControl, }: {
         url: string;
         body?: unknown;
         headers?: Record<string, string>;
         workflowRunId?: string;
         retries?: number;
+        flowControl?: FlowControl;
     }): Promise<{
         workflowRunId: string;
     }>;
     /**
-      * Fetches logs for workflow runs.
-      *
-      * @param workflowRunId - The ID of the workflow run to fetch logs for.
-      * @param cursor - The cursor for pagination.
-      * @param count - Number of runs to fetch. Default value is 10.
-      * @param state - The state of the workflow run.
-      * @param workflowUrl - The URL of the workflow. Should be an exact match.
-      * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
-      * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
-      *
-      * @example
-      * Fetch logs for a specific workflow run:
-      * ```typescript
-      * const { runs } = await client.logs({ workflowRunId: '12345' });
-      * const steps = runs[0].steps; // access steps
-      * ```
-      *
-      * @example
-      * Fetch logs with pagination:
-      * ```typescript
-      * const { runs, cursor } = await client.logs();
-      * const steps = runs[0].steps // access steps
-      *
-      * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
-      * ```
-      */
+     * Fetches logs for workflow runs.
+     *
+     * @param workflowRunId - The ID of the workflow run to fetch logs for.
+     * @param cursor - The cursor for pagination.
+     * @param count - Number of runs to fetch. Default value is 10.
+     * @param state - The state of the workflow run.
+     * @param workflowUrl - The URL of the workflow. Should be an exact match.
+     * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+     * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+     *
+     * @example
+     * Fetch logs for a specific workflow run:
+     * ```typescript
+     * const { runs } = await client.logs({ workflowRunId: '12345' });
+     * const steps = runs[0].steps; // access steps
+     * ```
+     *
+     * @example
+     * Fetch logs with pagination:
+     * ```typescript
+     * const { runs, cursor } = await client.logs();
+     * const steps = runs[0].steps // access steps
+     *
+     * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+     * ```
+     */
     logs(params?: {
         workflowRunId?: WorkflowRunLog["workflowRunId"];
         cursor?: string;
@@ -454,4 +468,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Telemetry, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };