feat: support zod v4 & v3 (#2186)

Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>

Author: thucpn

.changeset/green-gorillas-hunt.md

@@ -0,0 +1,10 @@
+---
+"@llamaindex/core": patch
+"@llamaindex/tools": patch
+"@llamaindex/workflow": patch
+"@llamaindex/ollama": patch
+"@llamaindex/openai": patch
+"@llamaindex/vercel": patch
+---
+
+feat: support zod v4 & v3

.github/workflows/test.yml

@@ -105,6 +105,7 @@ jobs:
         run: |
           pnpm pack --pack-destination ${{ runner.temp }} -C packages/llamaindex
           pnpm pack --pack-destination ${{ runner.temp }} -C packages/workflow
+          pnpm pack --pack-destination ${{ runner.temp }} -C packages/core
       - name: Install packed packages
         run: npm add ${{ runner.temp }}/*.tgz
         working-directory: e2e/npm
@@ -162,7 +163,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           directory: e2e/examples/vite-import-llamaindex
           skip_step: "install"
-          build_script: build
+          build_script: ci-build
           package_manager: pnpm
 
   typecheck-examples:
@@ -203,7 +204,7 @@ jobs:
             fi
           done
       - name: Install
-        run: npm add ${{ runner.temp }}/*.tgz
+        run: npm add ${{ runner.temp }}/*.tgz --legacy-peer-deps
         working-directory: ${{ runner.temp }}/examples
       - name: Run Type Check
         run: npx tsc --project ./tsconfig.json

e2e/node/fixtures/tools.ts

@@ -44,9 +44,7 @@ export const getWeatherTool = FunctionTool.from(
     name: "getWeather",
     description: "Get the weather for a city",
     parameters: z.object({
-      city: z.string({
-        description: "The city to get the weather for",
-      }),
+      city: z.string().describe("The city to get the weather for"),
     }),
   },
 );

examples/agents/agent/blog-writer.ts

@@ -20,9 +20,7 @@ const saveFileTool = tool({
   description:
     "Save the written content into a file that can be downloaded by the user",
   parameters: z.object({
-    content: z.string({
-      description: "The content to save into a file",
-    }),
+    content: z.string().describe("The content to save into a file"),
   }),
   execute: ({ content }: { content: string }) => {
     const filePath = os.tmpdir() + "/report.md";

examples/agents/agent/large-toolcall.ts

@@ -17,9 +17,7 @@ const userQuestion = "which are the best comedies after 2010?";
     description:
       "Execute python code in a Jupyter notebook cell and return any result, stdout, stderr, display_data, and error.",
     parameters: z.object({
-      code: z.string({
-        description: "The python code to execute in a single cell.",
-      }),
+      code: z.string().describe("The python code to execute in a single cell."),
     }),
     execute: ({ code }) => {
       console.log(

examples/agents/agent/multiple-agents.ts

@@ -26,9 +26,7 @@ const temperatureConverterTool = tool({
   description: "Convert a temperature from Fahrenheit to Celsius",
   name: "fahrenheitToCelsius",
   parameters: z.object({
-    temperature: z.number({
-      description: "The temperature in Fahrenheit",
-    }),
+    temperature: z.number().describe("The temperature in Fahrenheit"),
   }),
   execute: ({ temperature }) => {
     return ((temperature - 32) * 5) / 9;
@@ -39,9 +37,7 @@ const temperatureFetcherTool = tool({
   description: "Fetch the temperature (in Fahrenheit) for a city",
   name: "fetchTemperature",
   parameters: z.object({
-    city: z.string({
-      description: "The city to fetch the temperature for",
-    }),
+    city: z.string().describe("The city to fetch the temperature for"),
   }),
   execute: ({ city }) => {
     const temperature = Math.floor(Math.random() * 58) + 32;

examples/agents/agent/with-anthropic.ts

@@ -14,9 +14,7 @@ const weatherTool = tool({
   name: "weather",
   description: "Get the weather",
   parameters: z.object({
-    location: z.string({
-      description: "The location to get the weather for",
-    }),
+    location: z.string().describe("The location to get the weather for"),
   }),
   execute: ({ location }) => {
     return `The weather in ${location} is sunny`;
@@ -27,9 +25,7 @@ const inflationTool = tool({
   name: "inflation",
   description: "Get the inflation",
   parameters: z.object({
-    location: z.string({
-      description: "The location to get the inflation for",
-    }),
+    location: z.string().describe("The location to get the inflation for"),
   }),
   execute: ({ location }) => {
     return `The inflation in ${location} is 2%`;
@@ -41,9 +37,7 @@ const saveFileTool = tool({
   description:
     "Save the written content into a file that can be downloaded by the user",
   parameters: z.object({
-    content: z.string({
-      description: "The content to save into a file",
-    }),
+    content: z.string().describe("The content to save into a file"),
   }),
   execute: ({ content }) => {
     const filePath = "./report.md";

examples/agents/natural/joke.ts

@@ -14,11 +14,8 @@ const writeJokeSchema = z.object({
     .describe("The topic to write a joke or describe the joke to improve."),
   writtenJoke: z.optional(z.string()).describe("The written joke."),
   retriedTimes: z
-    .number()
-    .default(0)
-    .describe(
-      "The retried times for writing the joke. Always increase this from the input retriedTimes.",
-    ),
+    .optional(z.number().default(0))
+    .describe("The retried times for writing the joke."),
 });
 
 const critiqueSchema = z.object({

examples/deprecated/agents/large_toolcall_with_gpt4o.ts

@@ -29,9 +29,9 @@ async function callLLM(init: { model: string }) {
       description:
         "Execute python code in a Jupyter notebook cell and return any result, stdout, stderr, display_data, and error.",
       parameters: z.object({
-        code: z.string({
-          description: "The python code to execute in a single cell.",
-        }),
+        code: z
+          .string()
+          .describe("The python code to execute in a single cell."),
       }),
     },
   );

examples/models/gemini/live/tool-call.ts

@@ -8,9 +8,7 @@ const weatherTool = tool({
   name: "weather",
   description: "Get the weather",
   parameters: z.object({
-    location: z.string({
-      description: "The location to get the weather for",
-    }),
+    location: z.string().describe("The location to get the weather for"),
   }),
   execute: ({ location }) => {
     return `The weather in ${location} is rainy`;