@upstash/workflow 0.2.7 → 0.2.8

package/index.js

@@ -26,6 +26,7 @@ __export(src_exports, {
   WorkflowContext: () => WorkflowContext,
   WorkflowError: () => WorkflowError,
   WorkflowLogger: () => WorkflowLogger,
+  WorkflowTool: () => WorkflowTool,
   serve: () => serve
 });
 module.exports = __toCommonJS(src_exports);
@@ -1015,6 +1016,14 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
@@ -1705,9 +1714,10 @@ var wrapTools = ({
   return Object.fromEntries(
     Object.entries(tools).map((toolInfo) => {
       const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
       const aiSDKTool = convertToAISDKTool(tool3);
       const execute = aiSDKTool.execute;
-      if (execute) {
+      if (execute && executeAsStep) {
         const wrappedExecute = (...params) => {
           return context.run(`Run tool ${toolName}`, () => execute(...params));
         };
@@ -1728,6 +1738,37 @@ var convertLangchainTool = (langchainTool) => {
     execute: async (...param) => langchainTool.invoke(...param)
   });
 };
+var WorkflowTool = class {
+  /**
+   * description of the tool
+   */
+  description;
+  /**
+   * schema of the tool
+   */
+  schema;
+  /**
+   * function to invoke the tool
+   */
+  invoke;
+  /**
+   * whether the invoke method of the tool is to be wrapped with `context.run`
+   */
+  executeAsStep;
+  /**
+   * 
+   * @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) {
+    this.description = params.description;
+    this.schema = params.schema;
+    this.invoke = params.invoke;
+    this.executeAsStep = params.executeAsStep ?? true;
+  }
+};
 
 // src/agents/agent.ts
 var import_zod = require("zod");
@@ -2898,7 +2939,7 @@ var import_qstash11 = require("@upstash/qstash");
 var Client4 = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.token) {
+    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   });"
       );
@@ -3080,6 +3121,59 @@ var Client4 = class {
       throw result.error;
     }
   }
+  /**
+    * 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 });
+    * ```
+    */
+  async logs(params) {
+    const { workflowRunId, cursor, count, state, workflowUrl, workflowCreatedAt } = params ?? {};
+    const urlParams = new URLSearchParams({ "groupBy": "workflowRunId" });
+    if (workflowRunId) {
+      urlParams.append("workflowRunId", workflowRunId);
+    }
+    if (cursor) {
+      urlParams.append("cursor", cursor);
+    }
+    if (count) {
+      urlParams.append("count", count.toString());
+    }
+    if (state) {
+      urlParams.append("state", state);
+    }
+    if (workflowUrl) {
+      urlParams.append("workflowUrl", workflowUrl);
+    }
+    if (workflowCreatedAt) {
+      urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
+    }
+    const result = await this.client.http.request({
+      path: ["v2", "workflows", `events?${urlParams.toString()}`]
+    });
+    return result;
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -3089,5 +3183,6 @@ var Client4 = class {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   serve
 });

package/index.mjs

@@ -4,19 +4,20 @@ import {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   getWorkflowRunId,
   makeGetWaitersRequest,
   makeNotifyRequest,
   serve,
   triggerFirstInvocation
-} from "./chunk-U6XFLG7W.mjs";
+} from "./chunk-BPUSHNSD.mjs";
 
 // src/client/index.ts
 import { Client as QStashClient } from "@upstash/qstash";
 var Client = class {
   client;
   constructor(clientConfig) {
-    if (!clientConfig.token) {
+    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   });"
       );
@@ -198,6 +199,59 @@ var Client = class {
       throw result.error;
     }
   }
+  /**
+    * 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 });
+    * ```
+    */
+  async logs(params) {
+    const { workflowRunId, cursor, count, state, workflowUrl, workflowCreatedAt } = params ?? {};
+    const urlParams = new URLSearchParams({ "groupBy": "workflowRunId" });
+    if (workflowRunId) {
+      urlParams.append("workflowRunId", workflowRunId);
+    }
+    if (cursor) {
+      urlParams.append("cursor", cursor);
+    }
+    if (count) {
+      urlParams.append("count", count.toString());
+    }
+    if (state) {
+      urlParams.append("state", state);
+    }
+    if (workflowUrl) {
+      urlParams.append("workflowUrl", workflowUrl);
+    }
+    if (workflowCreatedAt) {
+      urlParams.append("workflowCreatedAt", workflowCreatedAt.toString());
+    }
+    const result = await this.client.http.request({
+      path: ["v2", "workflows", `events?${urlParams.toString()}`]
+    });
+    return result;
+  }
 };
 export {
   Client,
@@ -206,5 +260,6 @@ export {
   WorkflowContext,
   WorkflowError,
   WorkflowLogger,
+  WorkflowTool,
   serve
 };

package/nextjs.d.mts

@@ -1,5 +1,5 @@
 import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.mjs';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/nextjs.d.ts

@@ -1,5 +1,5 @@
 import { NextApiHandler } from 'next';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.js';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/nextjs.js

@@ -1003,6 +1003,14 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
@@ -1693,9 +1701,10 @@ var wrapTools = ({
   return Object.fromEntries(
     Object.entries(tools).map((toolInfo) => {
       const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
       const aiSDKTool = convertToAISDKTool(tool3);
       const execute = aiSDKTool.execute;
-      if (execute) {
+      if (execute && executeAsStep) {
         const wrappedExecute = (...params) => {
           return context.run(`Run tool ${toolName}`, () => execute(...params));
         };

package/nextjs.mjs

@@ -1,7 +1,7 @@
 import {
   SDK_TELEMETRY,
   serveBase
-} from "./chunk-U6XFLG7W.mjs";
+} from "./chunk-BPUSHNSD.mjs";
 
 // platforms/nextjs.ts
 var serve = (routeFunction, options) => {

package/package.json

@@ -1 +1 @@
-{"name":"@upstash/workflow","version":"v0.2.7","description":"Durable, Reliable and Performant Serverless Functions","main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./*"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./h3":{"import":"./h3.mjs","require":"./h3.js"},"./svelte":{"import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"import":"./workflow.mjs","require":"./workflow.js"},"./hono":{"import":"./hono.mjs","require":"./hono.js"},"./cloudflare":{"import":"./cloudflare.mjs","require":"./cloudflare.js"},"./astro":{"import":"./astro.mjs","require":"./astro.js"},"./express":{"import":"./express.mjs","require":"./express.js"}},"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test src","fmt":"prettier --write .","lint":"tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\" --quiet --fix","check-exports":"bun run build && cd dist && attw -P"},"repository":{"type":"git","url":"git+https://github.com/upstash/workflow-ts.git"},"keywords":["upstash","qstash","workflow","serverless"],"author":"Cahid Arda Oz","license":"MIT","bugs":{"url":"https://github.com/upstash/workflow-ts/issues"},"homepage":"https://github.com/upstash/workflow-ts#readme","devDependencies":{"@commitlint/cli":"^19.5.0","@commitlint/config-conventional":"^19.5.0","@eslint/js":"^9.11.1","@solidjs/start":"^1.0.8","@sveltejs/kit":"^2.6.1","@types/bun":"^1.1.10","@types/express":"^5.0.0","astro":"^4.16.7","eslint":"^9.11.1","eslint-plugin-unicorn":"^55.0.0","express":"^4.21.1","globals":"^15.10.0","h3":"^1.12.0","hono":"^4.6.3","husky":"^9.1.6","next":"^14.2.14","prettier":"3.3.3","tsup":"^8.3.0","typescript":"^5.7.2","typescript-eslint":"^8.18.0"},"dependencies":{"@ai-sdk/openai":"^1.0.15","@upstash/qstash":"^2.7.20","ai":"^4.0.30","zod":"^3.24.1"},"directories":{"example":"examples"}}
+{"name":"@upstash/workflow","version":"v0.2.8","description":"Durable, Reliable and Performant Serverless Functions","main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./*"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./h3":{"import":"./h3.mjs","require":"./h3.js"},"./svelte":{"import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"import":"./workflow.mjs","require":"./workflow.js"},"./hono":{"import":"./hono.mjs","require":"./hono.js"},"./cloudflare":{"import":"./cloudflare.mjs","require":"./cloudflare.js"},"./astro":{"import":"./astro.mjs","require":"./astro.js"},"./express":{"import":"./express.mjs","require":"./express.js"}},"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test src","fmt":"prettier --write .","lint":"tsc && eslint \"{src,platforms}/**/*.{js,ts,tsx}\" --quiet --fix","check-exports":"bun run build && cd dist && attw -P"},"repository":{"type":"git","url":"git+https://github.com/upstash/workflow-ts.git"},"keywords":["upstash","qstash","workflow","serverless"],"author":"Cahid Arda Oz","license":"MIT","bugs":{"url":"https://github.com/upstash/workflow-ts/issues"},"homepage":"https://github.com/upstash/workflow-ts#readme","devDependencies":{"@commitlint/cli":"^19.5.0","@commitlint/config-conventional":"^19.5.0","@eslint/js":"^9.11.1","@solidjs/start":"^1.0.8","@sveltejs/kit":"^2.6.1","@types/bun":"^1.1.10","@types/express":"^5.0.0","astro":"^4.16.7","eslint":"^9.11.1","eslint-plugin-unicorn":"^55.0.0","express":"^4.21.1","globals":"^15.10.0","h3":"^1.12.0","hono":"^4.6.3","husky":"^9.1.6","next":"^14.2.14","prettier":"3.3.3","tsup":"^8.3.0","typescript":"^5.7.2","typescript-eslint":"^8.18.0"},"dependencies":{"@ai-sdk/openai":"^1.0.15","@upstash/qstash":"^2.7.20","ai":"^4.0.30","zod":"^3.24.1"},"directories":{"example":"examples"}}

package/solidjs.d.mts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.mjs';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/solidjs.d.ts

@@ -1,5 +1,5 @@
 import { APIEvent } from '@solidjs/start/server';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.js';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/solidjs.js

@@ -1002,6 +1002,14 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
@@ -1692,9 +1700,10 @@ var wrapTools = ({
   return Object.fromEntries(
     Object.entries(tools).map((toolInfo) => {
       const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
       const aiSDKTool = convertToAISDKTool(tool3);
       const execute = aiSDKTool.execute;
-      if (execute) {
+      if (execute && executeAsStep) {
         const wrappedExecute = (...params) => {
           return context.run(`Run tool ${toolName}`, () => execute(...params));
         };

package/solidjs.mjs

@@ -1,7 +1,7 @@
 import {
   SDK_TELEMETRY,
   serveBase
-} from "./chunk-U6XFLG7W.mjs";
+} from "./chunk-BPUSHNSD.mjs";
 
 // platforms/solidjs.ts
 var serve = (routeFunction, options) => {

package/svelte.d.mts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.mjs';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.mjs';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/svelte.d.ts

@@ -1,5 +1,5 @@
 import { RequestHandler } from '@sveltejs/kit';
-import { R as RouteFunction, j as PublicServeOptions } from './types-Cuqlx2Cr.js';
+import { R as RouteFunction, k as PublicServeOptions } from './types-B62AnIU3.js';
 import '@upstash/qstash';
 import 'zod';
 import 'ai';

package/svelte.js

@@ -1002,6 +1002,14 @@ var getHeaders = ({
   }
   if (failureUrl) {
     baseHeaders[`Upstash-Failure-Callback-Forward-${WORKFLOW_FAILURE_HEADER}`] = "true";
+    baseHeaders[`Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback`] = "true";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Runid"] = workflowRunId;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Init"] = "false";
+    baseHeaders["Upstash-Failure-Callback-Workflow-Url"] = workflowUrl;
+    baseHeaders["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall";
+    if (retries !== void 0) {
+      baseHeaders["Upstash-Failure-Callback-Retries"] = retries.toString();
+    }
     if (!step?.callUrl) {
       baseHeaders["Upstash-Failure-Callback"] = failureUrl;
     }
@@ -1692,9 +1700,10 @@ var wrapTools = ({
   return Object.fromEntries(
     Object.entries(tools).map((toolInfo) => {
       const [toolName, tool3] = toolInfo;
+      const executeAsStep = "executeAsStep" in tool3 ? tool3.executeAsStep : true;
       const aiSDKTool = convertToAISDKTool(tool3);
       const execute = aiSDKTool.execute;
-      if (execute) {
+      if (execute && executeAsStep) {
         const wrappedExecute = (...params) => {
           return context.run(`Run tool ${toolName}`, () => execute(...params));
         };

package/svelte.mjs

@@ -1,7 +1,7 @@
 import {
   SDK_TELEMETRY,
   serveBase
-} from "./chunk-U6XFLG7W.mjs";
+} from "./chunk-BPUSHNSD.mjs";
 
 // platforms/svelte.ts
 var serve = (routeFunction, options) => {

package/{types-Cuqlx2Cr.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';
@@ -403,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 = {
@@ -412,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
@@ -1313,4 +1367,4 @@ type HeaderParams = {
     callTimeout?: never;
 });
 
-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 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 WorkflowLoggerOptions as r, WorkflowLogger as s };
+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-Cuqlx2Cr.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';
@@ -403,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 = {
@@ -412,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
@@ -1313,4 +1367,4 @@ type HeaderParams = {
     callTimeout?: never;
 });
 
-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 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 WorkflowLoggerOptions as r, WorkflowLogger as s };
+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 };