@upstash/workflow 0.2.8-rc-invoke → 0.2.8

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

@@ -1,5 +1,5 @@
 import { PublishRequest, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
-import { z } from 'zod';
+import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
 import * as _ai_sdk_openai from '@ai-sdk/openai';
@@ -33,11 +33,6 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      */
     abstract getResultStep(concurrent: number, stepId: number): Promise<Step<TResult>>;
 }
-type LazyInvokeStepParams<TInitiaPayload, TResult> = {
-    workflow: Pick<InvokableWorkflow<TInitiaPayload, TResult, unknown[]>, "callback" | "workflowId">;
-    body: TInitiaPayload;
-    workflowRunId?: string;
-} & Pick<CallSettings, "retries" | "headers">;
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -408,6 +403,60 @@ declare const createWorkflowOpenAI: (context: WorkflowContext, config?: {
     baseURL?: string;
     apiKey?: string;
 }) => _ai_sdk_openai.OpenAIProvider;
+declare class WorkflowTool<TSchema extends ZodType = ZodType> implements LangchainTool {
+    /**
+     * description of the tool
+     */
+    readonly description: string;
+    /**
+     * schema of the tool
+     */
+    readonly schema: TSchema;
+    /**
+     * function to invoke the tool
+     */
+    readonly invoke: (params: z.infer<TSchema>) => any;
+    /**
+     * whether the invoke method of the tool is to be wrapped with `context.run`
+     */
+    readonly executeAsStep: boolean;
+    /**
+     *
+     * @param description description of the tool
+     * @param schema schema of the tool
+     * @param invoke function to invoke the tool
+     * @param executeAsStep whether the invoke method of the tool is to be wrapped with `context.run`
+     */
+    constructor(params: {
+        /**
+         * description of the tool
+         */
+        description: string;
+        /**
+         * schema of the tool
+         */
+        schema: TSchema;
+        /**
+         * invoke function to invoke the tool
+         */
+        invoke: (params: z.infer<TSchema>) => any;
+        /**
+         * whether the invoke method is to be wrapped with `context.run`.
+         *
+         * When you pass a LangChain, AI SDK tool or a WorkflowTool to your agent,
+         * the execute/invoke method of the tool is wrapped with `context.run` by default.
+         *
+         * This option allows you to disable this behavior.
+         *
+         * You may want to disable wrapping with context.run if you want to run context.run,
+         * context.call or any other workflow step yourself in the execute/invoke method
+         * of the tool.
+         *
+         * @default true
+         */
+        executeAsStep?: boolean;
+    });
+}
 
 type AISDKTool = CoreTool;
 type LangchainTool = {
@@ -417,7 +466,7 @@ type LangchainTool = {
 };
 type GenerateTextParams = Parameters<typeof generateText>[0];
 type Model = GenerateTextParams["model"];
-type AgentParameters<TTool extends AISDKTool | LangchainTool = AISDKTool> = {
+type AgentParameters<TTool extends AISDKTool | LangchainTool | WorkflowTool = AISDKTool> = {
     /**
      * number of times the agent can call the LLM at most. If
      * the agent abruptly stops execution after calling tools, you may need
@@ -922,11 +971,6 @@ 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: any;
-        isCanceled?: boolean;
-        isFailed?: boolean;
-    }>;
     /**
      * Cancel the current workflow run
      *
@@ -962,7 +1006,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1045,7 +1089,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, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
+type RouteFunction<TInitialPayload> = (context: WorkflowContext<TInitialPayload>) => Promise<void>;
 type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
@@ -1322,23 +1366,5 @@ type HeaderParams = {
      */
     callTimeout?: never;
 });
-type InvokeWorkflowRequest = {
-    workflowUrl: string;
-    workflowRunId: string;
-    headers: Record<string, string[]>;
-    step: Step;
-    body: string;
-};
-type InvokeStepResponse<TBody> = {
-    body: TBody;
-    isCanceled?: boolean;
-    isFailed?: boolean;
-};
-type InvokeCallback<TInitiaPayload, TResult> = (settings: LazyInvokeStepParams<TInitiaPayload, TResult>, invokeStep: Step, context: WorkflowContext) => Promise<TResult>;
-type InvokableWorkflow<TInitialPayload, TResult, THandlerParams extends unknown[]> = {
-    handler: (...args: THandlerParams) => any;
-    callback: InvokeCallback<TInitialPayload, TResult>;
-    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 InvokeWorkflowRequest as I, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type Telemetry as T, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type InvokeStepResponse as r, type InvokeCallback as s, type InvokableWorkflow as t, type WorkflowLoggerOptions as u, WorkflowLogger as v };
+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 };

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

@@ -1,5 +1,5 @@
 import { PublishRequest, Client, Receiver, HTTPMethods as HTTPMethods$1 } from '@upstash/qstash';
-import { z } from 'zod';
+import { ZodType, z } from 'zod';
 import * as ai from 'ai';
 import { CoreTool, generateText } from 'ai';
 import * as _ai_sdk_openai from '@ai-sdk/openai';
@@ -33,11 +33,6 @@ declare abstract class BaseLazyStep<TResult = unknown> {
      */
     abstract getResultStep(concurrent: number, stepId: number): Promise<Step<TResult>>;
 }
-type LazyInvokeStepParams<TInitiaPayload, TResult> = {
-    workflow: Pick<InvokableWorkflow<TInitiaPayload, TResult, unknown[]>, "callback" | "workflowId">;
-    body: TInitiaPayload;
-    workflowRunId?: string;
-} & Pick<CallSettings, "retries" | "headers">;
 
 declare const LOG_LEVELS: readonly ["DEBUG", "INFO", "SUBMIT", "WARN", "ERROR"];
 type LogLevel = (typeof LOG_LEVELS)[number];
@@ -408,6 +403,60 @@ declare const createWorkflowOpenAI: (context: WorkflowContext, config?: {
     baseURL?: string;
     apiKey?: string;
 }) => _ai_sdk_openai.OpenAIProvider;
+declare class WorkflowTool<TSchema extends ZodType = ZodType> implements LangchainTool {
+    /**
+     * description of the tool
+     */
+    readonly description: string;
+    /**
+     * schema of the tool
+     */
+    readonly schema: TSchema;
+    /**
+     * function to invoke the tool
+     */
+    readonly invoke: (params: z.infer<TSchema>) => any;
+    /**
+     * whether the invoke method of the tool is to be wrapped with `context.run`
+     */
+    readonly executeAsStep: boolean;
+    /**
+     *
+     * @param description description of the tool
+     * @param schema schema of the tool
+     * @param invoke function to invoke the tool
+     * @param executeAsStep whether the invoke method of the tool is to be wrapped with `context.run`
+     */
+    constructor(params: {
+        /**
+         * description of the tool
+         */
+        description: string;
+        /**
+         * schema of the tool
+         */
+        schema: TSchema;
+        /**
+         * invoke function to invoke the tool
+         */
+        invoke: (params: z.infer<TSchema>) => any;
+        /**
+         * whether the invoke method is to be wrapped with `context.run`.
+         *
+         * When you pass a LangChain, AI SDK tool or a WorkflowTool to your agent,
+         * the execute/invoke method of the tool is wrapped with `context.run` by default.
+         *
+         * This option allows you to disable this behavior.
+         *
+         * You may want to disable wrapping with context.run if you want to run context.run,
+         * context.call or any other workflow step yourself in the execute/invoke method
+         * of the tool.
+         *
+         * @default true
+         */
+        executeAsStep?: boolean;
+    });
+}
 
 type AISDKTool = CoreTool;
 type LangchainTool = {
@@ -417,7 +466,7 @@ type LangchainTool = {
 };
 type GenerateTextParams = Parameters<typeof generateText>[0];
 type Model = GenerateTextParams["model"];
-type AgentParameters<TTool extends AISDKTool | LangchainTool = AISDKTool> = {
+type AgentParameters<TTool extends AISDKTool | LangchainTool | WorkflowTool = AISDKTool> = {
     /**
      * number of times the agent can call the LLM at most. If
      * the agent abruptly stops execution after calling tools, you may need
@@ -922,11 +971,6 @@ 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: any;
-        isCanceled?: boolean;
-        isFailed?: boolean;
-    }>;
     /**
      * Cancel the current workflow run
      *
@@ -962,7 +1006,7 @@ type WorkflowClient = {
 type WorkflowReceiver = {
     verify: InstanceType<typeof Receiver>["verify"];
 };
-declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify", "Invoke"];
+declare const StepTypes: readonly ["Initial", "Run", "SleepFor", "SleepUntil", "Call", "Wait", "Notify"];
 type StepType = (typeof StepTypes)[number];
 type ThirdPartyCallFields<TBody = unknown> = {
     /**
@@ -1045,7 +1089,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, TResult = unknown> = (context: WorkflowContext<TInitialPayload>) => Promise<TResult>;
+type RouteFunction<TInitialPayload> = (context: WorkflowContext<TInitialPayload>) => Promise<void>;
 type FinishCondition = "success" | "duplicate-step" | "fromCallback" | "auth-fail" | "failure-callback" | "workflow-already-ended";
 type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload = unknown> = ValidationOptions<TInitialPayload> & {
     /**
@@ -1322,23 +1366,5 @@ type HeaderParams = {
      */
     callTimeout?: never;
 });
-type InvokeWorkflowRequest = {
-    workflowUrl: string;
-    workflowRunId: string;
-    headers: Record<string, string[]>;
-    step: Step;
-    body: string;
-};
-type InvokeStepResponse<TBody> = {
-    body: TBody;
-    isCanceled?: boolean;
-    isFailed?: boolean;
-};
-type InvokeCallback<TInitiaPayload, TResult> = (settings: LazyInvokeStepParams<TInitiaPayload, TResult>, invokeStep: Step, context: WorkflowContext) => Promise<TResult>;
-type InvokableWorkflow<TInitialPayload, TResult, THandlerParams extends unknown[]> = {
-    handler: (...args: THandlerParams) => any;
-    callback: InvokeCallback<TInitialPayload, TResult>;
-    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 InvokeWorkflowRequest as I, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type Telemetry as T, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type InvokeStepResponse as r, type InvokeCallback as s, type InvokableWorkflow as t, type WorkflowLoggerOptions as u, WorkflowLogger as v };
+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 };

package/chunk-LCZMBGEM.mjs

@@ -1,95 +0,0 @@
-import {
-  WorkflowError,
-  getHeaders,
-  getWorkflowRunId
-} from "./chunk-IWAW7GIG.mjs";
-
-// src/serve/serve-many.ts
-var serveManyBase = ({
-  workflows,
-  getWorkflowId
-}) => {
-  const workflowIds = [];
-  const workflowMap = Object.fromEntries(
-    Object.entries(workflows).map((workflow) => {
-      const workflowId = workflow[0];
-      if (workflowIds.includes(workflowId)) {
-        throw new WorkflowError(
-          `Duplicate workflow name found: '${workflowId}'. Please set different workflow names in serveMany.`
-        );
-      }
-      if (workflowId.includes("/")) {
-        throw new WorkflowError(
-          `Invalid workflow name found: '${workflowId}'. Workflow name cannot contain '/'.`
-        );
-      }
-      workflowIds.push(workflowId);
-      workflow[1].workflowId = workflowId;
-      return [workflowId, workflow[1].handler];
-    })
-  );
-  return {
-    handler: async (...params) => {
-      const pickedWorkflowId = getWorkflowId(...params);
-      if (!pickedWorkflowId) {
-        throw new WorkflowError(`Unexpected request in serveMany. workflowId not set. Please update the URL of your request.`);
-      }
-      const workflow = workflowMap[pickedWorkflowId];
-      if (!workflow) {
-        throw new WorkflowError(`No workflows in serveMany found for '${pickedWorkflowId}'. Please update the URL of your request.`);
-      }
-      return await workflow(...params);
-    }
-  };
-};
-var createInvokeCallback = (telemetry) => {
-  const invokeCallback = async (settings, invokeStep, context) => {
-    const { body, workflow, headers = {}, workflowRunId = getWorkflowRunId(), retries } = settings;
-    const { workflowId } = workflow;
-    if (!workflowId) {
-      throw new WorkflowError("You can only invoke workflow which has a workflowId");
-    }
-    const { headers: invokerHeaders } = getHeaders({
-      initHeaderValue: "false",
-      workflowRunId: context.workflowRunId,
-      workflowUrl: context.url,
-      userHeaders: context.headers,
-      failureUrl: context.failureUrl,
-      retries: context.retries,
-      telemetry
-    });
-    invokerHeaders["Upstash-Workflow-Runid"] = context.workflowRunId;
-    const newUrl = context.url.replace(/[^/]+$/, workflowId);
-    const { headers: triggerHeaders } = getHeaders({
-      initHeaderValue: "true",
-      workflowRunId,
-      workflowUrl: newUrl,
-      userHeaders: new Headers(headers),
-      retries,
-      telemetry
-    });
-    triggerHeaders["Upstash-Workflow-Invoke"] = "true";
-    const request = {
-      body: JSON.stringify(body),
-      headers: Object.fromEntries(
-        Object.entries(invokerHeaders).map((pairs) => [pairs[0], [pairs[1]]])
-      ),
-      workflowRunId,
-      workflowUrl: context.url,
-      step: invokeStep
-    };
-    await context.qstashClient.publish({
-      headers: triggerHeaders,
-      method: "POST",
-      body: JSON.stringify(request),
-      url: newUrl
-    });
-    return void 0;
-  };
-  return invokeCallback;
-};
-
-export {
-  serveManyBase,
-  createInvokeCallback
-};

package/serve-many-BlBvXfBS.d.mts

@@ -1,10 +0,0 @@
-import { t as InvokableWorkflow } from './types-C7Y7WUQd.mjs';
-
-declare const serveManyBase: <TServe extends (...params: any[]) => any, THandlerParams extends Parameters<TServe> = Parameters<TServe>, TInvokableWorkflow extends InvokableWorkflow<any, any, THandlerParams> = InvokableWorkflow<any, any, THandlerParams>>({ workflows, getWorkflowId, }: {
-    workflows: Record<string, TInvokableWorkflow>;
-    getWorkflowId: (...params: THandlerParams) => string;
-}) => {
-    handler: (...params: THandlerParams) => Promise<any>;
-};
-
-export { serveManyBase as s };

package/serve-many-Dw-UUnH6.d.ts

@@ -1,10 +0,0 @@
-import { t as InvokableWorkflow } from './types-C7Y7WUQd.js';
-
-declare const serveManyBase: <TServe extends (...params: any[]) => any, THandlerParams extends Parameters<TServe> = Parameters<TServe>, TInvokableWorkflow extends InvokableWorkflow<any, any, THandlerParams> = InvokableWorkflow<any, any, THandlerParams>>({ workflows, getWorkflowId, }: {
-    workflows: Record<string, TInvokableWorkflow>;
-    getWorkflowId: (...params: THandlerParams) => string;
-}) => {
-    handler: (...params: THandlerParams) => Promise<any>;
-};
-
-export { serveManyBase as s };