@mendable/firecrawl 4.11.0 → 4.11.1

package/dist/{chunk-X3D7QXG6.js → chunk-SHZTLDEM.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.11.0",
+      version: "4.11.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",

package/dist/index.cjs

@@ -35,7 +35,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.11.0",
+      version: "4.11.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -251,6 +251,12 @@ var JobTimeoutError = class extends SdkError {
 
 // src/v2/utils/validation.ts
 var import_zod_to_json_schema = require("zod-to-json-schema");
+function looksLikeZodShape(obj) {
+  if (!obj || typeof obj !== "object" || Array.isArray(obj)) return false;
+  const values = Object.values(obj);
+  if (values.length === 0) return false;
+  return values.some((v) => v && typeof v === "object" && v._def && typeof v.safeParse === "function");
+}
 function ensureValidFormats(formats) {
   if (!formats) return;
   for (const fmt of formats) {
@@ -272,6 +278,10 @@ function ensureValidFormats(formats) {
           j.schema = (0, import_zod_to_json_schema.zodToJsonSchema)(maybeSchema);
         } catch {
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        throw new Error(
+          "json format schema appears to be a Zod schema's .shape property. Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }
@@ -284,6 +294,10 @@ function ensureValidFormats(formats) {
           ct.schema = (0, import_zod_to_json_schema.zodToJsonSchema)(maybeSchema);
         } catch {
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        throw new Error(
+          "changeTracking format schema appears to be a Zod schema's .shape property. Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-X3D7QXG6.js";
+} from "./chunk-SHZTLDEM.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -132,6 +132,12 @@ var JobTimeoutError = class extends SdkError {
 
 // src/v2/utils/validation.ts
 import { zodToJsonSchema } from "zod-to-json-schema";
+function looksLikeZodShape(obj) {
+  if (!obj || typeof obj !== "object" || Array.isArray(obj)) return false;
+  const values = Object.values(obj);
+  if (values.length === 0) return false;
+  return values.some((v) => v && typeof v === "object" && v._def && typeof v.safeParse === "function");
+}
 function ensureValidFormats(formats) {
   if (!formats) return;
   for (const fmt of formats) {
@@ -153,6 +159,10 @@ function ensureValidFormats(formats) {
           j.schema = zodToJsonSchema(maybeSchema);
         } catch {
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        throw new Error(
+          "json format schema appears to be a Zod schema's .shape property. Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }
@@ -165,6 +175,10 @@ function ensureValidFormats(formats) {
           ct.schema = zodToJsonSchema(maybeSchema);
         } catch {
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        throw new Error(
+          "changeTracking format schema appears to be a Zod schema's .shape property. Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }
@@ -1334,7 +1348,7 @@ var FirecrawlApp = class {
       if (typeof process !== "undefined" && process.env && process.env.npm_package_version) {
         return process.env.npm_package_version;
       }
-      const packageJson = await import("./package-A5RBY34U.js");
+      const packageJson = await import("./package-LM7L2L66.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-A5RBY34U.js → package-LM7L2L66.js}

@@ -1,4 +1,4 @@
 import {
   require_package
-} from "./chunk-X3D7QXG6.js";
+} from "./chunk-SHZTLDEM.js";
 export default require_package();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl",
-  "version": "4.11.0",
+  "version": "4.11.1",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/__tests__/unit/v2/validation.test.ts

@@ -62,5 +62,23 @@ describe("v2 utils: validation", () => {
     expect(() => ensureValidScrapeOptions(options)).not.toThrow();
     expect(options.parsers).toEqual(before);
   });
+
+  test("ensureValidFormats: detects mistaken use of zod schema.shape", () => {
+    const schema = z.object({ title: z.string(), count: z.number() });
+    // User mistakenly passes schema.shape instead of schema
+    const formats: FormatOption[] = [
+      { type: "json", prompt: "extract", schema: schema.shape } as any,
+    ];
+    expect(() => ensureValidFormats(formats)).toThrow(/\.shape property/i);
+    expect(() => ensureValidFormats(formats)).toThrow(/Pass the Zod schema directly/i);
+  });
+
+  test("ensureValidFormats: detects mistaken use of zod schema.shape in changeTracking", () => {
+    const schema = z.object({ title: z.string() });
+    const formats: FormatOption[] = [
+      { type: "changeTracking", modes: ["json"], schema: schema.shape } as any,
+    ];
+    expect(() => ensureValidFormats(formats)).toThrow(/\.shape property/i);
+  });
 });
 

package/src/v2/utils/validation.ts

@@ -1,6 +1,19 @@
 import { type FormatOption, type JsonFormat, type ScrapeOptions, type ScreenshotFormat, type ChangeTrackingFormat } from "../types";
 import { zodToJsonSchema } from "zod-to-json-schema";
 
+/**
+ * Detects if an object looks like a Zod schema's `.shape` property.
+ * When users mistakenly pass `schema.shape` instead of `schema`, the object
+ * will have Zod types as values but won't be a Zod schema itself.
+ */
+function looksLikeZodShape(obj: unknown): boolean {
+  if (!obj || typeof obj !== "object" || Array.isArray(obj)) return false;
+  const values = Object.values(obj);
+  if (values.length === 0) return false;
+  // Check if at least one value looks like a Zod type
+  return values.some((v: any) => v && typeof v === "object" && v._def && typeof v.safeParse === "function");
+}
+
 export function ensureValidFormats(formats?: FormatOption[]): void {
   if (!formats) return;
   for (const fmt of formats) {
@@ -24,6 +37,13 @@ export function ensureValidFormats(formats?: FormatOption[]): void {
         } catch {
           // If conversion fails, leave as-is; server-side may still handle, or request will fail explicitly
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        // User likely passed schema.shape instead of the schema itself
+        throw new Error(
+          "json format schema appears to be a Zod schema's .shape property. " +
+          "Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. " +
+          "The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }
@@ -37,6 +57,12 @@ export function ensureValidFormats(formats?: FormatOption[]): void {
         } catch {
           // Best-effort conversion; if it fails, leave original value
         }
+      } else if (looksLikeZodShape(maybeSchema)) {
+        throw new Error(
+          "changeTracking format schema appears to be a Zod schema's .shape property. " +
+          "Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. " +
+          "The SDK will automatically convert Zod schemas to JSON Schema format."
+        );
       }
       continue;
     }