firecrawl 4.28.1 → 4.28.3

package/README.md

@@ -70,6 +70,18 @@ const doc = await app.scrape('https://example.com/product/123', {
 console.log(doc.product);
 ```
 
+### Menu extraction
+
+Use the `menu` format to deterministically pull a merchant's menu (sections, items, prices, availability) from menu pages — the deterministic counterpart to the LLM-based `json` format.
+
+```js
+const doc = await app.scrape('https://example.com/restaurant/menu', {
+  formats: ['menu'],
+});
+
+console.log(doc.menu);
+```
+
 ### 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.

package/dist/{chunk-626CN3G5.js → chunk-LUZZZPH3.js}

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

package/dist/index.cjs

@@ -39,7 +39,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.28.1",
+      version: "4.28.3",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -1226,6 +1226,7 @@ function prepareExtractPayload(args) {
   if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
   if (args.origin) body.origin = args.origin;
   if (args.agent) body.agent = args.agent;
+  if (args.webhook != null) body.webhook = args.webhook;
   if (args.scrapeOptions) {
     ensureValidScrapeOptions(args.scrapeOptions);
     body.scrapeOptions = args.scrapeOptions;

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" | "product" | "audio" | "video";
+type FormatString = "markdown" | "html" | "rawHtml" | "links" | "images" | "screenshot" | "summary" | "changeTracking" | "json" | "attributes" | "branding" | "product" | "menu" | "audio" | "video";
 interface Viewport {
     width: number;
     height: number;
@@ -346,6 +346,55 @@ interface ProductProfile {
     description?: string;
     variants: ProductVariant[];
 }
+interface MenuPrice {
+    amount: number;
+    currency?: string;
+    formatted?: string;
+}
+interface MenuAvailability {
+    inStock: boolean;
+    text?: string;
+}
+interface MenuImage {
+    url: string;
+    alt?: string;
+}
+interface MenuItemIdentifiers {
+    merchantItemId?: string;
+}
+interface MenuItem {
+    id: string;
+    name: string;
+    description?: string;
+    images: MenuImage[];
+    price?: MenuPrice;
+    availability: MenuAvailability;
+    dietary: string[];
+    calories?: number;
+    optionGroups: unknown[];
+    identifiers: MenuItemIdentifiers;
+    url?: string;
+    sourceUrl: string;
+}
+interface MenuSection {
+    id: string;
+    name: string;
+    description?: string;
+    items: MenuItem[];
+}
+interface MenuMerchant {
+    name: string;
+    type?: string | null;
+    location?: unknown;
+}
+interface MenuProfile {
+    isMenu: boolean;
+    confidence: number;
+    merchant: MenuMerchant;
+    currency?: string | null;
+    sections: MenuSection[];
+    sourceUrl: string;
+}
 interface DocumentMetadata {
     title?: string;
     description?: string;
@@ -417,6 +466,7 @@ interface Document {
     changeTracking?: Record<string, unknown>;
     branding?: BrandingProfile;
     product?: ProductProfile;
+    menu?: MenuProfile;
 }
 interface PaginationConfig {
     /** When true (default), automatically follow `next` links and aggregate all documents. */
@@ -655,7 +705,16 @@ interface MonitorCrawlTarget {
     crawlOptions?: CrawlOptions;
     scrapeOptions?: ScrapeOptions;
 }
-type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget;
+interface MonitorSearchTarget {
+    id?: string;
+    type: "search";
+    queries: string[];
+    searchWindow?: "5m" | "15m" | "1h" | "6h" | "24h" | "7d";
+    includeDomains?: string[];
+    excludeDomains?: string[];
+    maxResults?: number;
+}
+type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget | MonitorSearchTarget;
 interface CreateMonitorRequest {
     name: string;
     schedule: MonitorSchedule;
@@ -722,10 +781,34 @@ interface MonitorPageJudgment {
         reason: string;
     }>;
 }
+interface MonitorScrapeTargetResult {
+    targetId: string;
+    type: "scrape";
+    expectedJobs?: string[];
+}
+interface MonitorCrawlTargetResult {
+    targetId: string;
+    type: "crawl";
+    crawlId?: string;
+}
+interface MonitorSearchTargetResult {
+    targetId: string;
+    type: "search";
+    searchCompleted?: boolean;
+    resultCount?: number;
+    matches?: number;
+    summary?: string;
+    judgeDegraded?: boolean;
+    degradedReason?: string | null;
+    searchCredits?: number;
+    judgeCredits?: number;
+    resultsJudged?: number;
+}
+type MonitorTargetResult = MonitorScrapeTargetResult | MonitorCrawlTargetResult | MonitorSearchTargetResult;
 interface MonitorCheck {
     id: string;
     monitorId: string;
-    status: "queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap";
+    status: "queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap" | "skipped_no_credits";
     trigger: "scheduled" | "manual";
     scheduledFor?: string | null;
     startedAt?: string | null;
@@ -735,7 +818,7 @@ interface MonitorCheck {
     actualCredits?: number | null;
     billingStatus: "not_applicable" | "reserved" | "confirmed" | "released" | "failed";
     summary: MonitorSummary;
-    targetResults?: unknown;
+    targetResults?: MonitorTargetResult[];
     notificationStatus?: unknown;
     error?: string | null;
     createdAt: string;
@@ -1159,6 +1242,7 @@ declare function prepareExtractPayload(args: {
     integration?: string;
     origin?: string;
     agent?: AgentOptions$1;
+    webhook?: string | WebhookConfig | null;
 }): Record<string, unknown>;
 /**
  * @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
@@ -2538,4 +2622,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorSummary, type MonitorTarget, type MonitorWebhookConfig, type PDFAction, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };

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" | "product" | "audio" | "video";
+type FormatString = "markdown" | "html" | "rawHtml" | "links" | "images" | "screenshot" | "summary" | "changeTracking" | "json" | "attributes" | "branding" | "product" | "menu" | "audio" | "video";
 interface Viewport {
     width: number;
     height: number;
@@ -346,6 +346,55 @@ interface ProductProfile {
     description?: string;
     variants: ProductVariant[];
 }
+interface MenuPrice {
+    amount: number;
+    currency?: string;
+    formatted?: string;
+}
+interface MenuAvailability {
+    inStock: boolean;
+    text?: string;
+}
+interface MenuImage {
+    url: string;
+    alt?: string;
+}
+interface MenuItemIdentifiers {
+    merchantItemId?: string;
+}
+interface MenuItem {
+    id: string;
+    name: string;
+    description?: string;
+    images: MenuImage[];
+    price?: MenuPrice;
+    availability: MenuAvailability;
+    dietary: string[];
+    calories?: number;
+    optionGroups: unknown[];
+    identifiers: MenuItemIdentifiers;
+    url?: string;
+    sourceUrl: string;
+}
+interface MenuSection {
+    id: string;
+    name: string;
+    description?: string;
+    items: MenuItem[];
+}
+interface MenuMerchant {
+    name: string;
+    type?: string | null;
+    location?: unknown;
+}
+interface MenuProfile {
+    isMenu: boolean;
+    confidence: number;
+    merchant: MenuMerchant;
+    currency?: string | null;
+    sections: MenuSection[];
+    sourceUrl: string;
+}
 interface DocumentMetadata {
     title?: string;
     description?: string;
@@ -417,6 +466,7 @@ interface Document {
     changeTracking?: Record<string, unknown>;
     branding?: BrandingProfile;
     product?: ProductProfile;
+    menu?: MenuProfile;
 }
 interface PaginationConfig {
     /** When true (default), automatically follow `next` links and aggregate all documents. */
@@ -655,7 +705,16 @@ interface MonitorCrawlTarget {
     crawlOptions?: CrawlOptions;
     scrapeOptions?: ScrapeOptions;
 }
-type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget;
+interface MonitorSearchTarget {
+    id?: string;
+    type: "search";
+    queries: string[];
+    searchWindow?: "5m" | "15m" | "1h" | "6h" | "24h" | "7d";
+    includeDomains?: string[];
+    excludeDomains?: string[];
+    maxResults?: number;
+}
+type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget | MonitorSearchTarget;
 interface CreateMonitorRequest {
     name: string;
     schedule: MonitorSchedule;
@@ -722,10 +781,34 @@ interface MonitorPageJudgment {
         reason: string;
     }>;
 }
+interface MonitorScrapeTargetResult {
+    targetId: string;
+    type: "scrape";
+    expectedJobs?: string[];
+}
+interface MonitorCrawlTargetResult {
+    targetId: string;
+    type: "crawl";
+    crawlId?: string;
+}
+interface MonitorSearchTargetResult {
+    targetId: string;
+    type: "search";
+    searchCompleted?: boolean;
+    resultCount?: number;
+    matches?: number;
+    summary?: string;
+    judgeDegraded?: boolean;
+    degradedReason?: string | null;
+    searchCredits?: number;
+    judgeCredits?: number;
+    resultsJudged?: number;
+}
+type MonitorTargetResult = MonitorScrapeTargetResult | MonitorCrawlTargetResult | MonitorSearchTargetResult;
 interface MonitorCheck {
     id: string;
     monitorId: string;
-    status: "queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap";
+    status: "queued" | "running" | "completed" | "failed" | "partial" | "skipped_overlap" | "skipped_no_credits";
     trigger: "scheduled" | "manual";
     scheduledFor?: string | null;
     startedAt?: string | null;
@@ -735,7 +818,7 @@ interface MonitorCheck {
     actualCredits?: number | null;
     billingStatus: "not_applicable" | "reserved" | "confirmed" | "released" | "failed";
     summary: MonitorSummary;
-    targetResults?: unknown;
+    targetResults?: MonitorTargetResult[];
     notificationStatus?: unknown;
     error?: string | null;
     createdAt: string;
@@ -1159,6 +1242,7 @@ declare function prepareExtractPayload(args: {
     integration?: string;
     origin?: string;
     agent?: AgentOptions$1;
+    webhook?: string | WebhookConfig | null;
 }): Record<string, unknown>;
 /**
  * @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
@@ -2538,4 +2622,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorSummary, type MonitorTarget, type MonitorWebhookConfig, type PDFAction, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type EndpointFeedbackEndpoint, type EndpointFeedbackRequest, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, type FeedbackMissingContent, type FeedbackRating, type FeedbackResponse, type FeedbackValuableSource, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientInput, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type GetPaperOptions, type GitHubScoreBreakdown, type GitHubSearchItem, type GitHubSearchResponse, type HighlightsFormat, type IdMap, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type MenuAvailability, type MenuImage, type MenuItem, type MenuItemIdentifiers, type MenuMerchant, type MenuPrice, type MenuProfile, type MenuSection, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorCrawlTargetResult, type MonitorEmailNotification, type MonitorEmailRecipientSubscription, type MonitorJsonFieldDiff, type MonitorNotification, type MonitorPageDiff, type MonitorPageJudgment, type MonitorPageSnapshot, type MonitorSchedule, type MonitorScrapeTarget, type MonitorScrapeTargetResult, type MonitorSearchTarget, type MonitorSearchTargetResult, type MonitorSummary, type MonitorTarget, type MonitorTargetResult, type MonitorWebhookConfig, type PDFAction, type PaginationConfig, type PaperMetadata, type PaperMetadataResponse, type PaperResult, type PaperSignals, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type Passage, type PressAction, type ProductAvailability, type ProductImage, type ProductPrice, type ProductProfile, type ProductSale, type ProductVariant, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ReadPaperResponse, type RedactPIIEntity, type RedactPIIOptions, ResearchClient, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchFeedbackRequest, type SearchGithubOptions, type SearchPapersOptions, type SearchPapersResponse, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type SimilarPapersOptions, type SimilarPapersResponse, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-626CN3G5.js";
+} from "./chunk-LUZZZPH3.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -1094,6 +1094,7 @@ function prepareExtractPayload(args) {
   if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
   if (args.origin) body.origin = args.origin;
   if (args.agent) body.agent = args.agent;
+  if (args.webhook != null) body.webhook = args.webhook;
   if (args.scrapeOptions) {
     ensureValidScrapeOptions(args.scrapeOptions);
     body.scrapeOptions = args.scrapeOptions;
@@ -2300,7 +2301,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-FMOR3ELU.js");
+      const packageJson = await import("./package-GHWNEIJD.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-FMOR3ELU.js → package-GHWNEIJD.js}

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

package/package.json

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

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

@@ -0,0 +1,47 @@
+import { describe, expect, test } from "@jest/globals";
+import { startExtract } from "../../../v2/methods/extract";
+import type { WebhookConfig } from "../../../v2/types";
+
+describe("v2.extract unit", () => {
+  test("startExtract forwards string webhook in request payload", async () => {
+    const post = jest.fn().mockResolvedValue({
+      status: 200,
+      data: { id: "extract-job" },
+    });
+
+    await startExtract({ post } as any, {
+      urls: ["https://example.com"],
+      prompt: "Extract title",
+      webhook: "https://example.com/webhook",
+    });
+
+    expect(post).toHaveBeenCalledWith("/v2/extract", {
+      urls: ["https://example.com"],
+      prompt: "Extract title",
+      webhook: "https://example.com/webhook",
+    });
+  });
+
+  test("startExtract forwards object webhook in request payload", async () => {
+    const post = jest.fn().mockResolvedValue({
+      status: 200,
+      data: { id: "extract-job" },
+    });
+    const webhook: WebhookConfig = {
+      url: "https://example.com/webhook",
+      headers: { "x-signature": "secret" },
+    };
+
+    await startExtract({ post } as any, {
+      urls: ["https://example.com"],
+      prompt: "Extract title",
+      webhook,
+    });
+
+    expect(post).toHaveBeenCalledWith("/v2/extract", {
+      urls: ["https://example.com"],
+      prompt: "Extract title",
+      webhook,
+    });
+  });
+});

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

@@ -0,0 +1,213 @@
+import { describe, test, expect, jest } from "@jest/globals";
+import { scrape } from "../../../v2/methods/scrape";
+
+describe("JS SDK v2 menu format", () => {
+  function makeHttp(postImpl: (url: string, data: any) => any) {
+    return { post: jest.fn(async (u: string, d: any) => postImpl(u, d)) } as any;
+  }
+
+  test("scrape with menu format returns menu data", async () => {
+    const mockResponse = {
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: "# Example Menu",
+          menu: {
+            isMenu: true,
+            confidence: 0.95,
+            currency: "USD",
+            sourceUrl: "https://example.com/menu",
+            merchant: { name: "Acme Diner", type: "restaurant" },
+            sections: [
+              {
+                id: "mains",
+                name: "Mains",
+                description: "Hearty plates",
+                items: [
+                  {
+                    id: "burger",
+                    name: "Classic Burger",
+                    description: "Beef patty with cheese",
+                    images: [{ url: "https://example.com/burger.jpg", alt: "Burger" }],
+                    price: { amount: 12.5, currency: "USD", formatted: "$12.50" },
+                    availability: { inStock: true, text: "Available" },
+                    dietary: ["contains-gluten"],
+                    calories: 800,
+                    optionGroups: [],
+                    identifiers: { merchantItemId: "ITEM-1" },
+                    url: "https://example.com/menu#burger",
+                    sourceUrl: "https://example.com/menu"
+                  }
+                ]
+              }
+            ]
+          }
+        }
+      }
+    };
+
+    const http = makeHttp(() => mockResponse);
+    const result = await scrape(http, "https://example.com", { formats: ["menu"] });
+
+    expect(result.menu).toBeDefined();
+    expect(result.menu?.isMenu).toBe(true);
+    expect(result.menu?.confidence).toBe(0.95);
+    expect(result.menu?.currency).toBe("USD");
+    expect(result.menu?.merchant?.name).toBe("Acme Diner");
+    expect(result.menu?.merchant?.type).toBe("restaurant");
+    expect(result.menu?.sections?.[0]?.name).toBe("Mains");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.name).toBe("Classic Burger");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.price?.amount).toBe(12.5);
+    expect(result.menu?.sections?.[0]?.items?.[0]?.price?.currency).toBe("USD");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.availability?.inStock).toBe(true);
+    expect(result.menu?.sections?.[0]?.items?.[0]?.images?.[0]?.url).toBe("https://example.com/burger.jpg");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.dietary?.[0]).toBe("contains-gluten");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.identifiers?.merchantItemId).toBe("ITEM-1");
+  });
+
+  test("scrape with menu and markdown formats returns both", async () => {
+    const mockResponse = {
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: "# Example Content",
+          menu: {
+            isMenu: true,
+            confidence: 0.8,
+            sourceUrl: "https://example.com/cafe",
+            merchant: { name: "Cafe Acme" },
+            sections: [
+              {
+                id: "drinks",
+                name: "Drinks",
+                items: [
+                  {
+                    id: "coffee",
+                    name: "Coffee",
+                    images: [],
+                    price: { amount: 3.5, currency: "USD" },
+                    availability: { inStock: true },
+                    dietary: [],
+                    optionGroups: [],
+                    identifiers: {},
+                    sourceUrl: "https://example.com/cafe"
+                  }
+                ]
+              }
+            ]
+          }
+        }
+      }
+    };
+
+    const http = makeHttp(() => mockResponse);
+    const result = await scrape(http, "https://example.com", { formats: ["markdown", "menu"] });
+
+    expect(result.markdown).toBe("# Example Content");
+    expect(result.menu).toBeDefined();
+    expect(result.menu?.merchant?.name).toBe("Cafe Acme");
+    expect(result.menu?.sections?.[0]?.items?.[0]?.price?.amount).toBe(3.5);
+  });
+
+  test("scrape without menu format does not return menu", async () => {
+    const mockResponse = {
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: "# Example"
+        }
+      }
+    };
+
+    const http = makeHttp(() => mockResponse);
+    const result = await scrape(http, "https://example.com", { formats: ["markdown"] });
+
+    expect(result.markdown).toBe("# Example");
+    expect(result.menu).toBeUndefined();
+  });
+
+  test("non-menu page scraped with menu format yields a warning and no menu", async () => {
+    const mockResponse = {
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: "# Blog Post",
+          warning: "No menu found on this page."
+        }
+      }
+    };
+
+    const http = makeHttp(() => mockResponse);
+    const result = await scrape(http, "https://example.com", { formats: ["menu"] });
+
+    expect(result.menu).toBeUndefined();
+    expect(result.warning).toContain("No menu found");
+  });
+
+  test("menu format with multiple sections and items", async () => {
+    const mockResponse = {
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          menu: {
+            isMenu: true,
+            confidence: 0.9,
+            sourceUrl: "https://example.com/menu",
+            merchant: { name: "Acme Bistro", type: "restaurant", location: { city: "Springfield" } },
+            sections: [
+              {
+                id: "starters",
+                name: "Starters",
+                items: [
+                  {
+                    id: "soup",
+                    name: "Tomato Soup",
+                    images: [],
+                    price: { amount: 6.0, currency: "USD" },
+                    availability: { inStock: true },
+                    dietary: ["vegetarian"],
+                    optionGroups: [],
+                    identifiers: {},
+                    sourceUrl: "https://example.com/menu"
+                  }
+                ]
+              },
+              {
+                id: "desserts",
+                name: "Desserts",
+                items: [
+                  {
+                    id: "cake",
+                    name: "Chocolate Cake",
+                    images: [{ url: "https://example.com/cake.jpg" }],
+                    availability: { inStock: false, text: "Sold out" },
+                    dietary: [],
+                    optionGroups: [],
+                    identifiers: {},
+                    sourceUrl: "https://example.com/menu"
+                  }
+                ]
+              }
+            ]
+          }
+        }
+      }
+    };
+
+    const http = makeHttp(() => mockResponse);
+    const result = await scrape(http, "https://example.com", { formats: ["menu"] });
+
+    expect(result.menu).toBeDefined();
+    expect(result.menu?.sections).toHaveLength(2);
+    expect(result.menu?.sections?.[0]?.items?.[0]?.dietary?.[0]).toBe("vegetarian");
+    expect(result.menu?.sections?.[1]?.name).toBe("Desserts");
+    expect(result.menu?.sections?.[1]?.items?.[0]?.images?.[0]?.url).toBe("https://example.com/cake.jpg");
+    expect(result.menu?.sections?.[1]?.items?.[0]?.availability?.inStock).toBe(false);
+    expect(result.menu?.sections?.[1]?.items?.[0]?.availability?.text).toBe("Sold out");
+  });
+});

package/src/__tests__/unit/v2/monitor-search-target.test.ts

@@ -0,0 +1,40 @@
+/**
+ * Unit test: a search-target monitor request is forwarded intact to the API.
+ */
+import { createMonitor } from "../../../v2/methods/monitor";
+import type { CreateMonitorRequest, MonitorSearchTarget } from "../../../v2/types";
+
+describe("v2 monitor search target", () => {
+  test("createMonitor forwards a search target with its camelCase fields", async () => {
+    let captured: any;
+    const http: any = {
+      post: async (_path: string, body: any) => {
+        captured = body;
+        return { status: 200, data: { success: true, data: { id: "mon_1", ...body } } };
+      },
+    };
+
+    const searchTarget: MonitorSearchTarget = {
+      type: "search",
+      queries: ["firecrawl launch"],
+      searchWindow: "24h",
+      includeDomains: ["firecrawl.dev"],
+      excludeDomains: ["spam.com"],
+      maxResults: 20,
+    };
+
+    const request: CreateMonitorRequest = {
+      name: "Search monitor",
+      schedule: { text: "every 30 minutes" },
+      goal: "Alert when Firecrawl launches a product",
+      targets: [searchTarget],
+    };
+
+    await createMonitor(http, request);
+
+    expect(captured.targets[0]).toEqual(searchTarget);
+    expect(captured.targets[0].type).toBe("search");
+    expect(captured.targets[0].searchWindow).toBe("24h");
+    expect(captured.targets[0].maxResults).toBe(20);
+  });
+});

package/src/v2/methods/extract.ts

@@ -1,4 +1,4 @@
-import { type ExtractResponse, type ScrapeOptions, type AgentOptions } from "../types";
+import { type ExtractResponse, type ScrapeOptions, type AgentOptions, type WebhookConfig } from "../types";
 import { HttpClient } from "../utils/httpClient";
 import { ensureValidScrapeOptions } from "../utils/validation";
 import { normalizeAxiosError, throwForBadResponse } from "../utils/errorHandler";
@@ -18,6 +18,7 @@ function prepareExtractPayload(args: {
   integration?: string;
   origin?: string;
   agent?: AgentOptions;
+  webhook?: string | WebhookConfig | null;
 }): Record<string, unknown> {
   const body: Record<string, unknown> = {};
   if (args.urls) body.urls = args.urls;
@@ -33,6 +34,7 @@ function prepareExtractPayload(args: {
   if (args.integration && args.integration.trim()) body.integration = args.integration.trim();
   if (args.origin) body.origin = args.origin;
   if (args.agent) body.agent = args.agent;
+  if (args.webhook != null) body.webhook = args.webhook;
   if (args.scrapeOptions) {
     ensureValidScrapeOptions(args.scrapeOptions);
     body.scrapeOptions = args.scrapeOptions;

package/src/v2/types.ts

@@ -14,6 +14,7 @@ export type FormatString =
   | "attributes"
   | "branding"
   | "product"
+  | "menu"
   | "audio"
   | "video";
 
@@ -468,6 +469,63 @@ export interface ProductProfile {
   variants: ProductVariant[];
 }
 
+export interface MenuPrice {
+  amount: number;
+  currency?: string;
+  formatted?: string;
+}
+
+export interface MenuAvailability {
+  inStock: boolean;
+  text?: string;
+}
+
+export interface MenuImage {
+  url: string;
+  alt?: string;
+}
+
+export interface MenuItemIdentifiers {
+  merchantItemId?: string;
+}
+
+export interface MenuItem {
+  id: string;
+  name: string;
+  description?: string;
+  images: MenuImage[];
+  price?: MenuPrice;
+  availability: MenuAvailability;
+  dietary: string[];
+  calories?: number;
+  optionGroups: unknown[];
+  identifiers: MenuItemIdentifiers;
+  url?: string;
+  sourceUrl: string;
+}
+
+export interface MenuSection {
+  id: string;
+  name: string;
+  description?: string;
+  items: MenuItem[];
+}
+
+export interface MenuMerchant {
+  name: string;
+  type?: string | null;
+  location?: unknown;
+}
+
+export interface MenuProfile {
+  isMenu: boolean;
+  confidence: number;
+  merchant: MenuMerchant;
+  currency?: string | null;
+  sections: MenuSection[];
+  sourceUrl: string;
+}
+
 export interface DocumentMetadata {
   // Common metadata fields
   title?: string;
@@ -551,6 +609,7 @@ export interface Document {
   changeTracking?: Record<string, unknown>;
   branding?: BrandingProfile;
   product?: ProductProfile;
+  menu?: MenuProfile;
 }
 
 // Pagination configuration for auto-fetching pages from v2 endpoints that return a `next` URL
@@ -819,7 +878,20 @@ export interface MonitorCrawlTarget {
   scrapeOptions?: ScrapeOptions;
 }
 
-export type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget;
+export interface MonitorSearchTarget {
+  id?: string;
+  type: "search";
+  queries: string[];
+  searchWindow?: "5m" | "15m" | "1h" | "6h" | "24h" | "7d";
+  includeDomains?: string[];
+  excludeDomains?: string[];
+  maxResults?: number;
+}
+
+export type MonitorTarget =
+  | MonitorScrapeTarget
+  | MonitorCrawlTarget
+  | MonitorSearchTarget;
 
 export interface CreateMonitorRequest {
   name: string;
@@ -892,6 +964,37 @@ export interface MonitorPageJudgment {
   }>;
 }
 
+export interface MonitorScrapeTargetResult {
+  targetId: string;
+  type: "scrape";
+  expectedJobs?: string[];
+}
+
+export interface MonitorCrawlTargetResult {
+  targetId: string;
+  type: "crawl";
+  crawlId?: string;
+}
+
+export interface MonitorSearchTargetResult {
+  targetId: string;
+  type: "search";
+  searchCompleted?: boolean;
+  resultCount?: number;
+  matches?: number;
+  summary?: string;
+  judgeDegraded?: boolean;
+  degradedReason?: string | null;
+  searchCredits?: number;
+  judgeCredits?: number;
+  resultsJudged?: number;
+}
+
+export type MonitorTargetResult =
+  | MonitorScrapeTargetResult
+  | MonitorCrawlTargetResult
+  | MonitorSearchTargetResult;
+
 export interface MonitorCheck {
   id: string;
   monitorId: string;
@@ -901,7 +1004,8 @@ export interface MonitorCheck {
     | "completed"
     | "failed"
     | "partial"
-    | "skipped_overlap";
+    | "skipped_overlap"
+    | "skipped_no_credits";
   trigger: "scheduled" | "manual";
   scheduledFor?: string | null;
   startedAt?: string | null;
@@ -916,7 +1020,7 @@ export interface MonitorCheck {
     | "released"
     | "failed";
   summary: MonitorSummary;
-  targetResults?: unknown;
+  targetResults?: MonitorTargetResult[];
   notificationStatus?: unknown;
   error?: string | null;
   createdAt: string;