firecrawl 4.22.2 → 4.23.0

package/README.md

@@ -46,10 +46,22 @@ const url = 'https://example.com';
 const scrapedData = await app.scrape(url);
 ```
 
+### Video extraction
+
+Use the `video` format on supported video URLs, including YouTube and TikTok. The returned `video` field is a signed URL to the extracted video file.
+
+```js
+const doc = await app.scrape('https://www.youtube.com/watch?v=dQw4w9WgXcQ', {
+  formats: ['video'],
+});
+
+console.log(doc.video);
+```
+
 ### Parsing uploaded files
 
 Use `parse` to upload a file (`html`, `pdf`, `docx`, etc.) as multipart form data and process it through the same parsing pipeline.
-Parse does not support browser-only formats/options like `changeTracking`, `screenshot`, `branding`, `actions`, `waitFor`, `location`, or `mobile`.
+Parse does not support browser-only formats/options like `changeTracking`, `screenshot`, `branding`, `audio`, `video`, `actions`, `waitFor`, `location`, or `mobile`.
 
 ```js
 const parsed = await app.parse(

package/dist/{chunk-HGRZHWZU.js → chunk-ZR3KTUEQ.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.22.2",
+      version: "4.23.0",
       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.22.2",
+      version: "4.23.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -426,6 +426,9 @@ function ensureValidParseFormats(formats) {
       if (fmt === "branding") {
         throw new Error("parse does not support branding format");
       }
+      if (fmt === "audio" || fmt === "video") {
+        throw new Error(`parse does not support ${fmt} format`);
+      }
       continue;
     }
     const type = fmt.type;
@@ -438,6 +441,9 @@ function ensureValidParseFormats(formats) {
     if (type === "branding") {
       throw new Error("parse does not support branding format");
     }
+    if (type === "audio" || type === "video") {
+      throw new Error(`parse does not support ${type} format`);
+    }
     if (fmt.type === "json") {
       const j = fmt;
       if (!j.prompt && !j.schema) {

package/dist/index.d.cts

@@ -4,7 +4,7 @@ import { AxiosResponse, AxiosRequestHeaders } from 'axios';
 import { EventEmitter } from 'events';
 import { TypedEventTarget } from 'typescript-event-target';
 
-type FormatString = 'markdown' | 'html' | 'rawHtml' | 'links' | 'images' | 'screenshot' | 'summary' | 'changeTracking' | 'json' | 'attributes' | 'branding' | 'audio';
+type FormatString = 'markdown' | 'html' | 'rawHtml' | 'links' | 'images' | 'screenshot' | 'summary' | 'changeTracking' | 'json' | 'attributes' | 'branding' | 'audio' | 'video';
 interface Viewport {
     width: number;
     height: number;
@@ -55,7 +55,7 @@ interface QueryFormat {
     mode?: 'freeform' | 'directQuote';
 }
 type FormatOption = FormatString | Format | JsonFormat | ChangeTrackingFormat | ScreenshotFormat | AttributesFormat | QuestionFormat | HighlightsFormat | QueryFormat;
-type ParseFormatString = Exclude<FormatString, 'screenshot' | 'changeTracking' | 'branding'>;
+type ParseFormatString = Exclude<FormatString, 'screenshot' | 'changeTracking' | 'branding' | 'audio' | 'video'>;
 interface ParseFormat {
     type: ParseFormatString;
 }
@@ -347,6 +347,7 @@ interface Document {
     images?: string[];
     screenshot?: string;
     audio?: string;
+    video?: string;
     attributes?: Array<{
         selector: string;
         attribute: string;
@@ -958,6 +959,7 @@ declare class FirecrawlClient {
      * @param file File payload (data, filename, optional contentType).
      * @param options Optional parse options (formats, parsers, etc.).
      *                Note: parse does not support changeTracking, screenshot, branding,
+     *                audio, video,
      *                actions, waitFor, location, or mobile options.
      * @returns Parsed document with requested formats.
      */

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { AxiosResponse, AxiosRequestHeaders } from 'axios';
 import { EventEmitter } from 'events';
 import { TypedEventTarget } from 'typescript-event-target';
 
-type FormatString = 'markdown' | 'html' | 'rawHtml' | 'links' | 'images' | 'screenshot' | 'summary' | 'changeTracking' | 'json' | 'attributes' | 'branding' | 'audio';
+type FormatString = 'markdown' | 'html' | 'rawHtml' | 'links' | 'images' | 'screenshot' | 'summary' | 'changeTracking' | 'json' | 'attributes' | 'branding' | 'audio' | 'video';
 interface Viewport {
     width: number;
     height: number;
@@ -55,7 +55,7 @@ interface QueryFormat {
     mode?: 'freeform' | 'directQuote';
 }
 type FormatOption = FormatString | Format | JsonFormat | ChangeTrackingFormat | ScreenshotFormat | AttributesFormat | QuestionFormat | HighlightsFormat | QueryFormat;
-type ParseFormatString = Exclude<FormatString, 'screenshot' | 'changeTracking' | 'branding'>;
+type ParseFormatString = Exclude<FormatString, 'screenshot' | 'changeTracking' | 'branding' | 'audio' | 'video'>;
 interface ParseFormat {
     type: ParseFormatString;
 }
@@ -347,6 +347,7 @@ interface Document {
     images?: string[];
     screenshot?: string;
     audio?: string;
+    video?: string;
     attributes?: Array<{
         selector: string;
         attribute: string;
@@ -958,6 +959,7 @@ declare class FirecrawlClient {
      * @param file File payload (data, filename, optional contentType).
      * @param options Optional parse options (formats, parsers, etc.).
      *                Note: parse does not support changeTracking, screenshot, branding,
+     *                audio, video,
      *                actions, waitFor, location, or mobile options.
      * @returns Parsed document with requested formats.
      */

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-HGRZHWZU.js";
+} from "./chunk-ZR3KTUEQ.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -302,6 +302,9 @@ function ensureValidParseFormats(formats) {
       if (fmt === "branding") {
         throw new Error("parse does not support branding format");
       }
+      if (fmt === "audio" || fmt === "video") {
+        throw new Error(`parse does not support ${fmt} format`);
+      }
       continue;
     }
     const type = fmt.type;
@@ -314,6 +317,9 @@ function ensureValidParseFormats(formats) {
     if (type === "branding") {
       throw new Error("parse does not support branding format");
     }
+    if (type === "audio" || type === "video") {
+      throw new Error(`parse does not support ${type} format`);
+    }
     if (fmt.type === "json") {
       const j = fmt;
       if (!j.prompt && !j.schema) {
@@ -2036,7 +2042,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-WSP46L7M.js");
+      const packageJson = await import("./package-APBHZ5F3.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-WSP46L7M.js → package-APBHZ5F3.js}

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

package/package.json

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

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

@@ -38,6 +38,24 @@ describe("v2.parse unit", () => {
     ).rejects.toThrow("parse does not support changeTracking format");
   });
 
+  test("rejects video format before making requests", async () => {
+    const client = new FirecrawlClient({
+      apiKey: "test-key",
+      apiUrl: "https://localhost:3002",
+    });
+
+    await expect(
+      client.parse(
+        {
+          data: Buffer.from("<html></html>"),
+          filename: "upload.html",
+          contentType: "text/html",
+        },
+        { formats: ["video" as any] },
+      ),
+    ).rejects.toThrow("parse does not support video format");
+  });
+
   test("rejects lockdown option before making requests", async () => {
     const client = new FirecrawlClient({
       apiKey: "test-key",

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

@@ -9,6 +9,11 @@ describe("v2 utils: validation", () => {
     expect(() => ensureValidFormats(formats)).toThrow(/json format must be an object/i);
   });
 
+  test("ensureValidFormats: accepts video string format", () => {
+    const formats: FormatOption[] = ["markdown", "video"];
+    expect(() => ensureValidFormats(formats)).not.toThrow();
+  });
+
   test("ensureValidFormats: json format requires prompt or schema", () => {
     // Valid cases - should not throw
     const valid1: FormatOption[] = [{ type: "json", prompt: "p" } as any];

package/src/v2/client.ts

@@ -204,6 +204,7 @@ export class FirecrawlClient {
    * @param file File payload (data, filename, optional contentType).
    * @param options Optional parse options (formats, parsers, etc.).
    *                Note: parse does not support changeTracking, screenshot, branding,
+   *                audio, video,
    *                actions, waitFor, location, or mobile options.
    * @returns Parsed document with requested formats.
    */

package/src/v2/types.ts

@@ -13,7 +13,8 @@ export type FormatString =
   | 'json'
   | 'attributes'
   | 'branding'
-  | 'audio';
+  | 'audio'
+  | 'video';
 
 export interface Viewport {
   width: number;
@@ -82,7 +83,7 @@ export type FormatOption =
 
 export type ParseFormatString = Exclude<
   FormatString,
-  'screenshot' | 'changeTracking' | 'branding'
+  'screenshot' | 'changeTracking' | 'branding' | 'audio' | 'video'
 >;
 
 export interface ParseFormat {
@@ -458,6 +459,7 @@ export interface Document {
   images?: string[];
   screenshot?: string;
   audio?: string;
+  video?: string;
   attributes?: Array<{
     selector: string;
     attribute: string;

package/src/v2/utils/validation.ts

@@ -114,6 +114,9 @@ export function ensureValidParseFormats(formats?: ParseFormatOption[]): void {
       if (fmt === "branding") {
         throw new Error("parse does not support branding format");
       }
+      if (fmt === "audio" || fmt === "video") {
+        throw new Error(`parse does not support ${fmt} format`);
+      }
       continue;
     }
 
@@ -127,6 +130,9 @@ export function ensureValidParseFormats(formats?: ParseFormatOption[]): void {
     if (type === "branding") {
       throw new Error("parse does not support branding format");
     }
+    if (type === "audio" || type === "video") {
+      throw new Error(`parse does not support ${type} format`);
+    }
 
     if ((fmt as JsonFormat).type === "json") {
       const j = fmt as JsonFormat;