@upstash/workflow 0.2.8 → 0.2.10-hono-generics

package/svelte.mjs

@@ -1,26 +1,46 @@
 import {
   SDK_TELEMETRY,
-  serveBase
-} from "./chunk-BPUSHNSD.mjs";
+  serveBase,
+  serveManyBase
+} from "./chunk-IPXJZU3K.mjs";
 
 // platforms/svelte.ts
+var telemetry = {
+  sdk: SDK_TELEMETRY,
+  framework: "svelte"
+};
 var serve = (routeFunction, options) => {
   const handler = async ({ request }) => {
-    const { handler: serveHandler } = serveBase(
-      routeFunction,
-      {
-        sdk: SDK_TELEMETRY,
-        framework: "svelte"
-      },
-      {
-        ...options,
-        useJSONContent: true
-      }
-    );
+    const { handler: serveHandler } = serveBase(routeFunction, telemetry, {
+      ...options,
+      useJSONContent: true
+    });
     return await serveHandler(request);
   };
   return { POST: handler };
 };
+var createWorkflow = (...params) => {
+  const [routeFunction, options = {}] = params;
+  return {
+    workflowId: void 0,
+    routeFunction,
+    options
+  };
+};
+var serveMany = (workflows, options) => {
+  return {
+    POST: serveManyBase({
+      workflows,
+      getUrl(params) {
+        return params.url.toString();
+      },
+      options,
+      serveMethod: (...params) => serve(...params).POST
+    }).handler
+  };
+};
 export {
-  serve
+  createWorkflow,
+  serve,
+  serveMany
 };

package/{types-B62AnIU3.d.mts → types-CYhDXnf8.d.mts}

@@ -1,4 +1,4 @@
-import { PublishRequest, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
+import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
@@ -67,11 +67,12 @@ declare class AutoExecutor {
     private readonly nonPlanStepCount;
     private readonly steps;
     private indexInCurrentList;
+    private invokeCount;
     private telemetry?;
     stepCount: number;
     planStepCount: number;
     protected executingStep: string | false;
-    constructor(context: WorkflowContext, steps: Step[], telemetry?: Telemetry, debug?: WorkflowLogger);
+    constructor(context: WorkflowContext, steps: Step[], telemetry?: Telemetry, invokeCount?: number, debug?: WorkflowLogger);
     /**
      * Adds the step function to the list of step functions to run in
      * parallel. After adding the function, defers the execution, so
@@ -815,7 +816,12 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * Number of retries
      */
     readonly retries: number;
-    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, telemetry, }: {
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    readonly flowControl?: FlowControl;
+    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, telemetry, invokeCount, flowControl, }: {
         qstashClient: WorkflowClient;
         workflowRunId: string;
         headers: Headers;
@@ -827,6 +833,8 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         env?: Record<string, string | undefined>;
         retries?: number;
         telemetry?: Telemetry;
+        invokeCount?: number;
+        flowControl?: FlowControl;
     });
     /**
      * Executes a workflow step
@@ -971,6 +979,11 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns notify response which has event id, event data and list of waiters which were notified
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
+    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<{
+        body: TResult;
+        isCanceled?: boolean;
+        isFailed?: boolean;
+    }>;
     /**
      * Cancel the current workflow run
      *
@@ -1006,7 +1019,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1089,7 +1102,7 @@ type SyncStepFunction<TResult> = () => TResult;
 type AsyncStepFunction<TResult> = () => Promise<TResult>;
 type StepFunction<TResult> = AsyncStepFunction<TResult> | SyncStepFunction<TResult>;
 type ParallelCallState = "first" | "partial" | "discard" | "last";
-type RouteFunction<TInitialPayload> = (context: WorkflowContext<TInitialPayload>) => Promise<void>;
+type RouteFunction<TInitialPayload, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
 type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
@@ -1139,7 +1152,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * @returns void
      */
     failureFunction?: (failureData: {
-        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api">;
+        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api" | "invoke" | "agents">;
         failStatus: number;
         failResponse: string;
         failHeaders: Record<string, string[]>;
@@ -1167,7 +1180,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
     /**
      * Number of retries to use in workflow requests
      *
-     * 3 by default
+     * @default 3
      */
     retries?: number;
     /**
@@ -1181,8 +1194,15 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * By default, Workflow SDK sends telemetry about SDK version, framework or runtime.
      *
      * Set `disableTelemetry` to disable this behavior.
+     *
+     * @default false
      */
     disableTelemetry?: boolean;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    flowControl?: FlowControl;
 } & ValidationOptions<TInitialPayload>;
 type ValidationOptions<TInitialPayload> = {
     schema?: z.ZodType<TInitialPayload>;
@@ -1302,6 +1322,7 @@ type CallSettings<TBody = unknown> = {
     headers?: Record<string, string>;
     retries?: number;
     timeout?: Duration | number;
+    flowControl?: FlowControl;
 };
 type HeaderParams = {
     /**
@@ -1334,6 +1355,15 @@ type HeaderParams = {
      * Only needed/used when the step is a waitForEvent step
      */
     telemetry?: Telemetry;
+    /**
+     * invoke count to include in headers
+     */
+    invokeCount?: number;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    flowControl?: FlowControl;
 } & ({
     /**
      * step to generate headers for
@@ -1347,6 +1377,13 @@ type HeaderParams = {
      * timeout duration in context.call
      */
     callTimeout?: number | Duration;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     *
+     * will be passed in context.call.
+     */
+    callFlowControl?: FlowControl;
 } | {
     /**
      * step not passed. Either first invocation or simply getting headers for
@@ -1365,6 +1402,35 @@ type HeaderParams = {
      * set to never because this is not a context.call step
      */
     callTimeout?: never;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     *
+     * will be passed in context.call.
+     */
+    callFlowControl?: never;
 });
+type InvokeWorkflowRequest = {
+    workflowUrl: string;
+    workflowRunId: string;
+    headers: Record<string, string[]>;
+    step: Step;
+    body: string;
+};
+type LazyInvokeStepParams<TInitiaPayload, TResult> = {
+    workflow: Pick<InvokableWorkflow<TInitiaPayload, TResult>, "routeFunction" | "workflowId" | "options">;
+    body: TInitiaPayload;
+    workflowRunId?: string;
+} & Pick<CallSettings, "retries" | "headers" | "flowControl">;
+type InvokeStepResponse<TBody> = {
+    body: TBody;
+    isCanceled?: boolean;
+    isFailed?: boolean;
+};
+type InvokableWorkflow<TInitialPayload, TResult> = {
+    routeFunction: RouteFunction<TInitialPayload, TResult>;
+    options: WorkflowServeOptions<Response, TInitialPayload>;
+    workflowId?: string;
+};
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type WorkflowLoggerOptions as s, WorkflowLogger as t };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type InvokeStepResponse as s, type InvokableWorkflow as t, type LogLevel as u, type WorkflowLoggerOptions as v, WorkflowLogger as w };

package/{types-B62AnIU3.d.ts → types-CYhDXnf8.d.ts}

@@ -1,4 +1,4 @@
-import { PublishRequest, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
+import { PublishRequest, FlowControl, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
 import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
@@ -67,11 +67,12 @@ declare class AutoExecutor {
     private readonly nonPlanStepCount;
     private readonly steps;
     private indexInCurrentList;
+    private invokeCount;
     private telemetry?;
     stepCount: number;
     planStepCount: number;
     protected executingStep: string | false;
-    constructor(context: WorkflowContext, steps: Step[], telemetry?: Telemetry, debug?: WorkflowLogger);
+    constructor(context: WorkflowContext, steps: Step[], telemetry?: Telemetry, invokeCount?: number, debug?: WorkflowLogger);
     /**
      * Adds the step function to the list of step functions to run in
      * parallel. After adding the function, defers the execution, so
@@ -815,7 +816,12 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * Number of retries
      */
     readonly retries: number;
-    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, telemetry, }: {
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    readonly flowControl?: FlowControl;
+    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, telemetry, invokeCount, flowControl, }: {
         qstashClient: WorkflowClient;
         workflowRunId: string;
         headers: Headers;
@@ -827,6 +833,8 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         env?: Record<string, string | undefined>;
         retries?: number;
         telemetry?: Telemetry;
+        invokeCount?: number;
+        flowControl?: FlowControl;
     });
     /**
      * Executes a workflow step
@@ -971,6 +979,11 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * @returns notify response which has event id, event data and list of waiters which were notified
      */
     notify(stepName: string, eventId: string, eventData: unknown): Promise<NotifyStepResponse>;
+    invoke<TInitialPayload, TResult>(stepName: string, settings: LazyInvokeStepParams<TInitialPayload, TResult>): Promise<{
+        body: TResult;
+        isCanceled?: boolean;
+        isFailed?: boolean;
+    }>;
     /**
      * Cancel the current workflow run
      *
@@ -1006,7 +1019,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1089,7 +1102,7 @@ type SyncStepFunction<TResult> = () => TResult;
 type AsyncStepFunction<TResult> = () => Promise<TResult>;
 type StepFunction<TResult> = AsyncStepFunction<TResult> | SyncStepFunction<TResult>;
 type ParallelCallState = "first" | "partial" | "discard" | "last";
-type RouteFunction<TInitialPayload> = (context: WorkflowContext<TInitialPayload>) => Promise<void>;
+type RouteFunction<TInitialPayload, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
 type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
@@ -1139,7 +1152,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * @returns void
      */
     failureFunction?: (failureData: {
-        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api">;
+        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api" | "invoke" | "agents">;
         failStatus: number;
         failResponse: string;
         failHeaders: Record<string, string[]>;
@@ -1167,7 +1180,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
     /**
      * Number of retries to use in workflow requests
      *
-     * 3 by default
+     * @default 3
      */
     retries?: number;
     /**
@@ -1181,8 +1194,15 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * By default, Workflow SDK sends telemetry about SDK version, framework or runtime.
      *
      * Set `disableTelemetry` to disable this behavior.
+     *
+     * @default false
      */
     disableTelemetry?: boolean;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    flowControl?: FlowControl;
 } & ValidationOptions<TInitialPayload>;
 type ValidationOptions<TInitialPayload> = {
     schema?: z.ZodType<TInitialPayload>;
@@ -1302,6 +1322,7 @@ type CallSettings<TBody = unknown> = {
     headers?: Record<string, string>;
     retries?: number;
     timeout?: Duration | number;
+    flowControl?: FlowControl;
 };
 type HeaderParams = {
     /**
@@ -1334,6 +1355,15 @@ type HeaderParams = {
      * Only needed/used when the step is a waitForEvent step
      */
     telemetry?: Telemetry;
+    /**
+     * invoke count to include in headers
+     */
+    invokeCount?: number;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     */
+    flowControl?: FlowControl;
 } & ({
     /**
      * step to generate headers for
@@ -1347,6 +1377,13 @@ type HeaderParams = {
      * timeout duration in context.call
      */
     callTimeout?: number | Duration;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     *
+     * will be passed in context.call.
+     */
+    callFlowControl?: FlowControl;
 } | {
     /**
      * step not passed. Either first invocation or simply getting headers for
@@ -1365,6 +1402,35 @@ type HeaderParams = {
      * set to never because this is not a context.call step
      */
     callTimeout?: never;
+    /**
+     * Settings for controlling the number of active requests
+     * and number of requests per second with the same key.
+     *
+     * will be passed in context.call.
+     */
+    callFlowControl?: never;
 });
+type InvokeWorkflowRequest = {
+    workflowUrl: string;
+    workflowRunId: string;
+    headers: Record<string, string[]>;
+    step: Step;
+    body: string;
+};
+type LazyInvokeStepParams<TInitiaPayload, TResult> = {
+    workflow: Pick<InvokableWorkflow<TInitiaPayload, TResult>, "routeFunction" | "workflowId" | "options">;
+    body: TInitiaPayload;
+    workflowRunId?: string;
+} & Pick<CallSettings, "retries" | "headers" | "flowControl">;
+type InvokeStepResponse<TBody> = {
+    body: TBody;
+    isCanceled?: boolean;
+    isFailed?: boolean;
+};
+type InvokableWorkflow<TInitialPayload, TResult> = {
+    routeFunction: RouteFunction<TInitialPayload, TResult>;
+    options: WorkflowServeOptions<Response, TInitialPayload>;
+    workflowId?: string;
+};
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type WorkflowLoggerOptions as s, WorkflowLogger as t };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type ExclusiveValidationOptions as E, type FinishCondition as F, type HeaderParams as H, type InvokeWorkflowRequest as I, type LazyInvokeStepParams as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type StepType as S, type Telemetry as T, type WorkflowServeOptions as W, type RawStep as a, type Waiter as b, type Step as c, WorkflowTool as d, WorkflowContext as e, type WorkflowClient as f, type WorkflowReceiver as g, StepTypes as h, type SyncStepFunction as i, type StepFunction as j, type PublicServeOptions as k, type FailureFunctionPayload as l, type RequiredExceptFields as m, type WaitRequest as n, type WaitStepResponse as o, type NotifyStepResponse as p, type WaitEventOptions as q, type CallSettings as r, type InvokeStepResponse as s, type InvokableWorkflow as t, type LogLevel as u, type WorkflowLoggerOptions as v, WorkflowLogger as w };