@openclaw/firecrawl-plugin 2026.9.8 → 2026.10.1-beta.2

package/dist/.setup/{firecrawl-client-S2gdb9zo.mjs → firecrawl-client-Bqyr6x90.mjs}

@@ -5,8 +5,7 @@ import { DEFAULT_CACHE_TTL_MINUTES, markdownToText, normalizeCacheKey, readCache
 import { normalizeSecretInput } from "openclaw/plugin-sdk/secret-input";
 import { truncateSanitizedExternalContent, wrapExternalContent, wrapWebContent } from "openclaw/plugin-sdk/security-runtime";
 import { SsrFBlockedError, isBlockedHostnameOrIp, isPrivateIpAddress, resolvePinnedHostnameWithPolicy } from "openclaw/plugin-sdk/ssrf-runtime";
-import { asOptionalObjectRecord, asOptionalRecord, asRecord, normalizeOptionalString } from "openclaw/plugin-sdk/string-coerce-runtime";
-import { z } from "zod";
+import { asBoolean, asOptionalObjectRecord, asOptionalRecord, asRecord, normalizeOptionalString, readStringField } from "openclaw/plugin-sdk/string-coerce-runtime";
 import { resolveReadOnlyEnvSecretRef } from "openclaw/plugin-sdk/secret-ref-readonly";
 //#region \0rolldown/runtime.js
 var __defProp = Object.defineProperty;
@@ -62,13 +61,10 @@ function resolveFirecrawlApiKey(cfg) {
 function resolveFirecrawlBaseUrl(cfg) {
 	const search = resolveFirecrawlSearchConfig(cfg);
 	const fetch = resolveFirecrawlFetchConfig(cfg);
-	return (typeof search?.baseUrl === "string" ? search.baseUrl.trim() : "") || (typeof fetch?.baseUrl === "string" ? fetch.baseUrl.trim() : "") || normalizeSecretInput(process.env.FIRECRAWL_BASE_URL) || "https://api.firecrawl.dev";
+	return normalizeOptionalString(search?.baseUrl) || normalizeOptionalString(fetch?.baseUrl) || normalizeSecretInput(process.env.FIRECRAWL_BASE_URL) || "https://api.firecrawl.dev";
 }
 function resolveFirecrawlOnlyMainContent(cfg, override) {
-	if (typeof override === "boolean") return override;
-	const fetch = resolveFirecrawlFetchConfig(cfg);
-	if (typeof fetch?.onlyMainContent === "boolean") return fetch.onlyMainContent;
-	return true;
+	return asBoolean(override) ?? asBoolean(resolveFirecrawlFetchConfig(cfg)?.onlyMainContent) ?? true;
 }
 function resolveFirecrawlMaxAgeMs(cfg, override) {
 	return Math.floor(asNonNegativeFiniteNumber(override) ?? asNonNegativeFiniteNumber(resolveFirecrawlFetchConfig(cfg)?.maxAgeMs) ?? DEFAULT_FIRECRAWL_MAX_AGE_MS);
@@ -153,7 +149,7 @@ async function resolveEndpoint(baseUrl, pathname, lookupFn) {
 }
 async function postFirecrawlJson(params, parse) {
 	const apiKey = normalizeSecretInput(params.apiKey);
-	const result = await ((params.mode ?? await validateFirecrawlBaseUrl(params.url)) === "selfHosted" ? withSelfHostedWebToolsEndpoint : withStrictWebToolsEndpoint)({
+	const result = await (params.mode === "selfHosted" ? withSelfHostedWebToolsEndpoint : withStrictWebToolsEndpoint)({
 		url: params.url,
 		timeoutSeconds: params.timeoutSeconds,
 		...params.signal ? { signal: params.signal } : {},
@@ -168,23 +164,13 @@ async function postFirecrawlJson(params, parse) {
 	}, async ({ response }) => {
 		if (!response.ok) {
 			let detail = typeof response.statusText === "string" && response.statusText.trim() ? response.statusText.trim() : "request failed";
-			const readJsonPayload = async () => {
-				const candidate = response;
-				const jsonResponse = typeof candidate.clone === "function" ? candidate.clone() : response;
-				try {
-					const body = await readResponseText(jsonResponse, { maxBytes: 64e3 });
-					const payload = JSON.parse(body.text);
-					return asOptionalRecord(payload) ?? null;
-				} catch {
-					return null;
-				}
-			};
-			const payload = await readJsonPayload();
+			const errorBody = await readResponseText(response, { maxBytes: 64e3 });
+			let payload;
+			try {
+				payload = asOptionalRecord(JSON.parse(errorBody.text));
+			} catch {}
 			if (payload) detail = typeof payload.error === "string" ? payload.error : typeof payload.message === "string" ? payload.message : detail;
-			else {
-				const errorBody = await readResponseText(response, { maxBytes: 64e3 });
-				if (errorBody.text) detail = errorBody.text;
-			}
+			else if (errorBody.text) detail = errorBody.text;
 			const safeDetail = wrapWebContent(truncateSanitizedExternalContent(detail, 1e3).text, "web_fetch");
 			throw new ProviderHttpError(`${params.errorLabel} API error (${response.status}): ${safeDetail}`, { status: response.status });
 		}
@@ -209,28 +195,6 @@ function isValidFirecrawlPublishedDate(value) {
 	const timestamp = parseDateStringTimestampMs(calendarDate);
 	return timestamp !== void 0 && new Date(timestamp).toISOString().startsWith(calendarDate);
 }
-const optionalFirecrawlStringSchema = z.string().optional().catch(void 0);
-const firecrawlSearchMetadataSchema = z.object({
-	sourceURL: optionalFirecrawlStringSchema,
-	title: optionalFirecrawlStringSchema,
-	publishedTime: optionalFirecrawlStringSchema,
-	publishedDate: optionalFirecrawlStringSchema
-}).optional().catch(void 0);
-const firecrawlSearchItemSchema = z.object({
-	url: optionalFirecrawlStringSchema,
-	sourceURL: optionalFirecrawlStringSchema,
-	sourceUrl: optionalFirecrawlStringSchema,
-	title: optionalFirecrawlStringSchema,
-	description: optionalFirecrawlStringSchema,
-	snippet: optionalFirecrawlStringSchema,
-	summary: optionalFirecrawlStringSchema,
-	markdown: optionalFirecrawlStringSchema,
-	content: optionalFirecrawlStringSchema,
-	text: optionalFirecrawlStringSchema,
-	publishedDate: optionalFirecrawlStringSchema,
-	published: optionalFirecrawlStringSchema,
-	metadata: firecrawlSearchMetadataSchema
-});
 function resolveSearchItems(payload, count) {
 	const nestedData = asOptionalRecord(payload.data);
 	const rawItems = [
@@ -246,17 +210,16 @@ function resolveSearchItems(payload, count) {
 	let inspectedObjects = 0;
 	for (const rawItem of rawItems) {
 		if (inspectedObjects >= FIRECRAWL_SEARCH_MAX_RESULTS || items.length >= count) break;
-		const record = asOptionalRecord(rawItem);
-		if (!record) continue;
+		const entry = asOptionalRecord(rawItem);
+		if (!entry) continue;
 		inspectedObjects += 1;
-		const entry = firecrawlSearchItemSchema.parse(record);
-		const metadata = entry.metadata;
-		const url = normalizeFirecrawlResultUrl(entry.url || entry.sourceURL || entry.sourceUrl || metadata?.sourceURL || "");
+		const metadata = asOptionalRecord(entry.metadata);
+		const url = normalizeFirecrawlResultUrl(readStringField(entry, "url") || readStringField(entry, "sourceURL") || readStringField(entry, "sourceUrl") || readStringField(metadata, "sourceURL") || "");
 		if (!url) continue;
-		const title = entry.title || metadata?.title || "";
-		const description = entry.description || entry.snippet || entry.summary || void 0;
-		const content = entry.markdown || entry.content || entry.text || void 0;
-		const rawPublished = entry.publishedDate || entry.published || metadata?.publishedTime || metadata?.publishedDate || void 0;
+		const title = readStringField(entry, "title") || readStringField(metadata, "title") || "";
+		const description = readStringField(entry, "description") || readStringField(entry, "snippet") || readStringField(entry, "summary") || void 0;
+		const content = readStringField(entry, "markdown") || readStringField(entry, "content") || readStringField(entry, "text") || void 0;
+		const rawPublished = readStringField(entry, "publishedDate") || readStringField(entry, "published") || readStringField(metadata, "publishedTime") || readStringField(metadata, "publishedDate") || void 0;
 		const published = rawPublished && isValidFirecrawlPublishedDate(rawPublished) ? rawPublished : void 0;
 		items.push({
 			title,
@@ -269,38 +232,6 @@ function resolveSearchItems(payload, count) {
 	}
 	return items;
 }
-function buildSearchPayload(params) {
-	let remainingContentChars = FIRECRAWL_SEARCH_MAX_CONTENT_CHARS;
-	let truncated = false;
-	const wrapBoundedContent = (value) => {
-		const bounded = truncateSanitizedExternalContent(value, remainingContentChars);
-		truncated ||= bounded.truncated;
-		remainingContentChars -= bounded.text.length;
-		return wrapWebContent(bounded.text, "web_search");
-	};
-	const results = params.items.map((entry) => ({
-		title: entry.title ? wrapBoundedContent(entry.title) : "",
-		url: entry.url,
-		description: entry.description ? wrapBoundedContent(entry.description) : "",
-		...entry.published ? { published: entry.published } : {},
-		...entry.siteName ? { siteName: entry.siteName } : {},
-		...params.scrapeResults && entry.content ? { content: wrapBoundedContent(entry.content) } : {}
-	}));
-	return {
-		query: params.query,
-		provider: params.provider,
-		count: params.items.length,
-		tookMs: params.tookMs,
-		externalContent: {
-			untrusted: true,
-			source: "web_search",
-			provider: params.provider,
-			wrapped: true
-		},
-		results,
-		...truncated ? { truncated: true } : {}
-	};
-}
 async function runFirecrawlSearch(params) {
 	params.signal?.throwIfAborted();
 	const keyless = params.access === "keyless";
@@ -345,19 +276,19 @@ async function runFirecrawlSearch(params) {
 	};
 	const body = {
 		query: params.query,
-		limit: count
+		limit: count,
+		...sources.length > 0 ? { sources } : {},
+		...categories.length > 0 ? { categories } : {},
+		...includeDomains.length > 0 ? { includeDomains } : {},
+		...excludeDomains.length > 0 ? { excludeDomains } : {},
+		...tbs ? { tbs } : {},
+		...location ? { location } : {},
+		...country ? { country } : {},
+		...scrapeResults ? { scrapeOptions: { formats: ["markdown"] } } : {}
 	};
-	if (sources.length > 0) body.sources = sources;
-	if (categories.length > 0) body.categories = categories;
-	if (includeDomains.length > 0) body.includeDomains = includeDomains;
-	if (excludeDomains.length > 0) body.excludeDomains = excludeDomains;
-	if (tbs) body.tbs = tbs;
-	if (location) body.location = location;
-	if (country) body.country = country;
-	if (scrapeResults) body.scrapeOptions = { formats: ["markdown"] };
 	const start = Date.now();
 	const endpoint = await resolveEndpoint(baseUrl, "/v2/search");
-	const payload = await postFirecrawlJson({
+	const items = resolveSearchItems(await postFirecrawlJson({
 		url: endpoint.url,
 		mode: endpoint.mode,
 		timeoutSeconds,
@@ -373,14 +304,38 @@ async function runFirecrawlSearch(params) {
 			throw new Error(`Firecrawl Search API error: ${safeError}`);
 		}
 		return payloadValue;
-	});
-	const result = buildSearchPayload({
+	}), count);
+	const tookMs = Date.now() - start;
+	let remainingContentChars = FIRECRAWL_SEARCH_MAX_CONTENT_CHARS;
+	let truncated = false;
+	const wrapBoundedContent = (value) => {
+		const bounded = truncateSanitizedExternalContent(value, remainingContentChars);
+		truncated ||= bounded.truncated;
+		remainingContentChars -= bounded.text.length;
+		return wrapWebContent(bounded.text, "web_search");
+	};
+	const results = items.map((entry) => ({
+		title: entry.title ? wrapBoundedContent(entry.title) : "",
+		url: entry.url,
+		description: entry.description ? wrapBoundedContent(entry.description) : "",
+		...entry.published ? { published: entry.published } : {},
+		...entry.siteName ? { siteName: entry.siteName } : {},
+		...scrapeResults && entry.content ? { content: wrapBoundedContent(entry.content) } : {}
+	}));
+	const result = {
 		query: params.query,
 		provider: providerId,
-		items: resolveSearchItems(payload, count),
-		tookMs: Date.now() - start,
-		scrapeResults
-	});
+		count: items.length,
+		tookMs,
+		externalContent: {
+			untrusted: true,
+			source: "web_search",
+			provider: providerId,
+			wrapped: true
+		},
+		results,
+		...truncated ? { truncated: true } : {}
+	};
 	writeCache(SEARCH_CACHE, cacheKey, result, cacheTtlMs);
 	return result;
 }
@@ -476,7 +431,6 @@ async function runFirecrawlScrape(params) {
 const testing = {
 	assertFirecrawlScrapeTargetAllowed,
 	parseFirecrawlScrapePayload,
-	postFirecrawlJson,
 	resolveEndpoint,
 	resolveSearchItems
 };

package/dist/.setup/{firecrawl-fetch-provider-Cq_h8okw.mjs → firecrawl-fetch-provider-CcYAp_u6.mjs}

@@ -51,7 +51,7 @@ const FIRECRAWL_WEB_FETCH_PROVIDER_SHARED = {
 };
 //#endregion
 //#region extensions/firecrawl/src/firecrawl-fetch-provider.ts
-const loadFirecrawlClientModule = createLazyRuntimeModule(() => import("./firecrawl-client-S2gdb9zo.mjs").then((n) => n.t));
+const loadFirecrawlClientModule = createLazyRuntimeModule(() => import("./firecrawl-client-Bqyr6x90.mjs").then((n) => n.t));
 function createFirecrawlWebFetchProvider() {
 	return {
 		...FIRECRAWL_WEB_FETCH_PROVIDER_SHARED,

package/dist/.setup/{firecrawl-search-provider-DzEHIoq7.mjs → firecrawl-search-provider-lAiZ3IJ5.mjs}

@@ -4,7 +4,7 @@ import { asOptionalRecord } from "openclaw/plugin-sdk/string-coerce-runtime";
 import { createWebSearchProviderContractFields, enablePluginInConfig } from "openclaw/plugin-sdk/provider-web-search-contract";
 //#region extensions/firecrawl/src/firecrawl-search-provider.ts
 const FIRECRAWL_CREDENTIAL_PATH = "plugins.entries.firecrawl.config.webSearch.apiKey";
-const loadFirecrawlClientModule = createLazyRuntimeModule(() => import("./firecrawl-client-S2gdb9zo.mjs").then((n) => n.t));
+const loadFirecrawlClientModule = createLazyRuntimeModule(() => import("./firecrawl-client-Bqyr6x90.mjs").then((n) => n.t));
 const GenericFirecrawlSearchSchema = {
 	type: "object",
 	properties: {

package/dist/api.js

@@ -1,4 +1,4 @@
-import { n as runFirecrawlScrape } from "./.setup/firecrawl-client-S2gdb9zo.mjs";
+import { n as runFirecrawlScrape } from "./.setup/firecrawl-client-Bqyr6x90.mjs";
 import { readStringValue } from "openclaw/plugin-sdk/string-coerce-runtime";
 //#region extensions/firecrawl/api.ts
 async function fetchFirecrawlContent(params) {

package/dist/index.js

@@ -1,6 +1,6 @@
-import { n as runFirecrawlScrape, r as runFirecrawlSearch } from "./.setup/firecrawl-client-S2gdb9zo.mjs";
-import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-Cq_h8okw.mjs";
-import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-DzEHIoq7.mjs";
+import { n as runFirecrawlScrape, r as runFirecrawlSearch } from "./.setup/firecrawl-client-Bqyr6x90.mjs";
+import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-CcYAp_u6.mjs";
+import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-lAiZ3IJ5.mjs";
 import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
 import { optionalStringEnum } from "openclaw/plugin-sdk/channel-actions";
 import { jsonResult, readNonNegativeIntegerParam, readPositiveIntegerParam, readStringArrayParam, readStringParam } from "openclaw/plugin-sdk/provider-web-search";
@@ -93,33 +93,22 @@ function createFirecrawlSearchTool(api) {
 		parameters: FirecrawlSearchToolSchema,
 		execute: async (_toolCallId, rawParams, signal) => {
 			signal?.throwIfAborted();
-			const query = readStringParam(rawParams, "query", { required: true });
-			const count = readPositiveIntegerParam(rawParams, "count", {
-				max: 100,
-				message: "count must be an integer from 1 to 100"
-			});
-			const timeoutSeconds = readPositiveIntegerParam(rawParams, "timeoutSeconds");
-			const sources = readStringArrayParam(rawParams, "sources");
-			const categories = readStringArrayParam(rawParams, "categories");
-			const includeDomains = readStringArrayParam(rawParams, "includeDomains");
-			const excludeDomains = readStringArrayParam(rawParams, "excludeDomains");
-			const tbs = readStringParam(rawParams, "tbs");
-			const location = readStringParam(rawParams, "location");
-			const country = readStringParam(rawParams, "country");
-			const scrapeResults = rawParams.scrapeResults === true;
 			return jsonResult(await runFirecrawlSearch({
+				query: readStringParam(rawParams, "query", { required: true }),
+				count: readPositiveIntegerParam(rawParams, "count", {
+					max: 100,
+					message: "count must be an integer from 1 to 100"
+				}),
+				timeoutSeconds: readPositiveIntegerParam(rawParams, "timeoutSeconds"),
+				sources: readStringArrayParam(rawParams, "sources"),
+				categories: readStringArrayParam(rawParams, "categories"),
+				includeDomains: readStringArrayParam(rawParams, "includeDomains"),
+				excludeDomains: readStringArrayParam(rawParams, "excludeDomains"),
+				tbs: readStringParam(rawParams, "tbs"),
+				location: readStringParam(rawParams, "location"),
+				country: readStringParam(rawParams, "country"),
+				scrapeResults: rawParams.scrapeResults === true,
 				cfg: api.config,
-				query,
-				count,
-				timeoutSeconds,
-				sources,
-				categories,
-				includeDomains,
-				excludeDomains,
-				tbs,
-				location,
-				country,
-				scrapeResults,
 				...signal ? { signal } : {}
 			}));
 		}

package/dist/web-fetch-contract-api.js

@@ -1,3 +1,3 @@
-import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-Cq_h8okw.mjs";
+import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-CcYAp_u6.mjs";
 import "./web-fetch-provider.js";
 export { createFirecrawlWebFetchProvider };

package/dist/web-fetch-provider.js

@@ -1,2 +1,2 @@
-import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-Cq_h8okw.mjs";
+import { t as createFirecrawlWebFetchProvider } from "./.setup/firecrawl-fetch-provider-CcYAp_u6.mjs";
 export { createFirecrawlWebFetchProvider };

package/dist/web-search-contract-api.js

@@ -1,3 +1,3 @@
-import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-DzEHIoq7.mjs";
+import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-lAiZ3IJ5.mjs";
 import "./web-search-provider.js";
 export { createFirecrawlFreeWebSearchProvider, createFirecrawlWebSearchProvider };

package/dist/web-search-provider.js

@@ -1,2 +1,2 @@
-import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-DzEHIoq7.mjs";
+import { n as createFirecrawlWebSearchProvider, t as createFirecrawlFreeWebSearchProvider } from "./.setup/firecrawl-search-provider-lAiZ3IJ5.mjs";
 export { createFirecrawlFreeWebSearchProvider, createFirecrawlWebSearchProvider };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openclaw/firecrawl-plugin",
-  "version": "2026.9.8",
+  "version": "2026.10.1-beta.2",
   "description": "OpenClaw Firecrawl plugin.",
   "repository": {
     "type": "git",
@@ -8,8 +8,7 @@
   },
   "type": "module",
   "dependencies": {
-    "typebox": "1.3.34",
-    "zod": "4.6.5"
+    "typebox": "1.3.34"
   },
   "openclaw": {
     "extensions": [
@@ -22,10 +21,10 @@
       "minHostVersion": ">=2026.6.8"
     },
     "compat": {
-      "pluginApi": ">=2026.9.8"
+      "pluginApi": ">=2026.10.1-beta.2"
     },
     "build": {
-      "openclawVersion": "2026.9.8",
+      "openclawVersion": "2026.10.1-beta.2",
       "bundledDist": false
     },
     "release": {
@@ -44,7 +43,7 @@
     "assets/activity.svg"
   ],
   "peerDependencies": {
-    "openclaw": ">=2026.9.8"
+    "openclaw": ">=2026.10.1-beta.2"
   },
   "peerDependenciesMeta": {
     "openclaw": {
@@ -52,7 +51,6 @@
     }
   },
   "bundledDependencies": [
-    "typebox",
-    "zod"
+    "typebox"
   ]
 }

package/node_modules/zod/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Colin McDonnell
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/node_modules/zod/README.md

@@ -1,218 +0,0 @@
-<p align="center">
-  <img src="logo.svg" width="200px" align="center" alt="Zod logo" />
-  <h1 align="center">Zod</h1>
-  <p align="center">
-    TypeScript-first schema validation with static type inference
-    <br/>
-    by <a href="https://x.com/colinhacks">@colinhacks</a>
-  </p>
-</p>
-<br/>
-
-<p align="center">
-<a href="https://github.com/colinhacks/zod/actions?query=branch%3Amain"><img src="https://github.com/colinhacks/zod/actions/workflows/test.yml/badge.svg?event=push&branch=main" alt="Zod CI status" /></a>
-<a href="https://opensource.org/licenses/MIT" rel="nofollow"><img src="https://img.shields.io/github/license/colinhacks/zod" alt="License"></a>
-<a href="https://www.npmjs.com/package/zod" rel="nofollow"><img src="https://img.shields.io/npm/dw/zod.svg" alt="npm"></a>
-<a href="https://discord.gg/KaSRdyX2vc" rel="nofollow"><img src="https://img.shields.io/discord/893487829802418277?label=Discord&logo=discord&logoColor=white" alt="discord server"></a>
-<a href="https://github.com/colinhacks/zod" rel="nofollow"><img src="https://img.shields.io/github/stars/colinhacks/zod" alt="stars"></a>
-</p>
-
-<div align="center">
-  <a href="https://zod.dev/api">Docs</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://discord.gg/RcG33DQJdf">Discord</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://twitter.com/colinhacks">𝕏</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://bsky.app/profile/zod.dev">Bluesky</a>
-  <br />
-</div>
-
-<br/>
-<br/>
-
-### [Read the docs →](https://zod.dev/api)
-
-<br/>
-<br/>
-
-## What is Zod?
-
-Zod is a TypeScript-first validation library. Define a schema and parse some data with it. You'll get back a strongly typed, validated result.
-
-```ts
-import * as z from "zod";
-
-const User = z.object({
-  name: z.string(),
-});
-
-// some untrusted data...
-const input = {
-  /* stuff */
-};
-
-// the parsed result is validated and type safe!
-const data = User.parse(input);
-
-// so you can use it with confidence :)
-console.log(data.name);
-```
-
-<br/>
-
-## Features
-
-- Zero external dependencies
-- Works in Node.js and all modern browsers
-- Tiny: `2kb` core bundle (gzipped)
-- Immutable API: methods return a new instance
-- Concise interface
-- Works with TypeScript and plain JS
-- Built-in JSON Schema conversion
-- Extensive ecosystem
-
-<br/>
-
-## Installation
-
-```sh
-npm install zod
-```
-
-<br/>
-
-## Basic usage
-
-Before you can do anything else, you need to define a schema. For the purposes of this guide, we'll use a simple object schema.
-
-```ts
-import * as z from "zod";
-
-const Player = z.object({
-  username: z.string(),
-  xp: z.number(),
-});
-```
-
-### Parsing data
-
-Given any Zod schema, use `.parse` to validate an input. If it's valid, Zod returns a strongly-typed _deep clone_ of the input.
-
-```ts
-Player.parse({ username: "billie", xp: 100 });
-// => returns { username: "billie", xp: 100 }
-```
-
-**Note** — If your schema uses certain asynchronous APIs like `async` [refinements](https://zod.dev/api#refinements) or [transforms](https://zod.dev/api#transforms), you'll need to use the `.parseAsync()` method instead.
-
-```ts
-const schema = z.string().refine(async (val) => val.length <= 8);
-
-await schema.parseAsync("hello");
-// => "hello"
-```
-
-### AOT compilation
-
-For hot validation paths, `z.compile(schema)` returns a schema clone with an ahead-of-time compiled fast path. Valid inputs take the compiled path; invalid inputs fall back to the regular parser so error reporting stays identical.
-
-Across a 55-schema benchmark the median speedup is **2.4x**, and it scales with how much work the schema does per parse: a large array of objects is ~9x, a 20-key object ~9x, a nested object ~4.5x, while a bare `z.string()` gains nothing — compilation removes per-node dispatch and allocation, and a single `typeof` has none to remove.
-
-```ts
-const CompiledPlayer = z.compile(Player);
-
-CompiledPlayer.parse({ username: "billie", xp: 100 });
-```
-
-To enable compilation globally for schemas constructed after import:
-
-```ts
-import "zod/compile"; // place before modules that define schemas
-```
-
-Things to know:
-
-- Compilation uses `new Function`. Global mode is automatically disabled when `z.config({ jitless: true })` is set (e.g. CSP environments); calling `z.compile()` directly is an explicit opt-in.
-- Schemas with async refinements or transforms can't be compiled, and neither can a few other constructs. That is not an error: `z.compile()` hands the schema back unchanged and it keeps using the regular parser, exactly as global mode leaves it. Pass `{ strict: true }` to throw `ZodCompileAsyncError` / `ZodCompileUnsupportedError` instead.
-- On invalid input, refinements and transforms may run twice (fast path, then fallback).
-- Deriving a new schema from a compiled one (`.refine()`, `.extend()`, etc.) returns an uncompiled schema — compile the final schema.
-
-See [`compile` docs](https://zod.dev/compile) for details.
-
-### Handling errors
-
-When validation fails, the `.parse()` method will throw a `ZodError` instance with granular information about the validation issues.
-
-```ts
-try {
-  Player.parse({ username: 42, xp: "100" });
-} catch (err) {
-  if (err instanceof z.ZodError) {
-    err.issues;
-    /* [
-      {
-        expected: 'string',
-        code: 'invalid_type',
-        path: [ 'username' ],
-        message: 'Invalid input: expected string, received number'
-      },
-      {
-        expected: 'number',
-        code: 'invalid_type',
-        path: [ 'xp' ],
-        message: 'Invalid input: expected number, received string'
-      }
-    ] */
-  }
-}
-```
-
-To avoid a `try/catch` block, you can use the `.safeParse()` method to get back a plain result object containing either the successfully parsed data or a `ZodError`. The result type is a [discriminated union](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions), so you can handle both cases conveniently.
-
-```ts
-const result = Player.safeParse({ username: 42, xp: "100" });
-if (!result.success) {
-  result.error; // ZodError instance
-} else {
-  result.data; // { username: string; xp: number }
-}
-```
-
-**Note** — If your schema uses certain asynchronous APIs like `async` [refinements](https://zod.dev/api#refinements) or [transforms](https://zod.dev/api#transforms), you'll need to use the `.safeParseAsync()` method instead.
-
-```ts
-const schema = z.string().refine(async (val) => val.length <= 8);
-
-await schema.safeParseAsync("hello");
-// => { success: true; data: "hello" }
-```
-
-### Inferring types
-
-Zod infers a static type from your schema definitions. You can extract this type with the `z.infer<>` utility and use it however you like.
-
-```ts
-const Player = z.object({
-  username: z.string(),
-  xp: z.number(),
-});
-
-// extract the inferred type
-type Player = z.infer<typeof Player>;
-
-// use it in your code
-const player: Player = { username: "billie", xp: 100 };
-```
-
-In some cases, the input & output types of a schema can diverge. For instance, the `.transform()` API can convert the input from one type to another. In these cases, you can extract the input and output types independently:
-
-```ts
-const mySchema = z.string().transform((val) => val.length);
-
-type MySchemaIn = z.input<typeof mySchema>;
-// => string
-
-type MySchemaOut = z.output<typeof mySchema>; // equivalent to z.infer<typeof mySchema>
-// number
-```