firecrawl-sdk 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616551a9caf1736bbc849f0058ce52dca94728cf024cb91319393e5bf192cfe1
-  data.tar.gz: ffe33e36c76d4a69319940e148ccce30bc50b3e44b81915698c76f7e4a1cb99b
+  metadata.gz: fc48fdfecc01e4811b2634c740ffab0787e03f99001a401014a3e98b0e63f627
+  data.tar.gz: ad7b3330c7e5f0934c58747ad2748b737783b90d4ccbf732d6f60924543bf45d
 SHA512:
-  metadata.gz: fbbe64a2fd02c6a8214cbb77f7dfc64791e392d2192f4c9d657ed6cb9bab3c820ed6ff9a430b0fb1abfdd11076b6a64600a4f8df0f9232bda02b8c3bf27d1385
-  data.tar.gz: f2a722b6f10ac0254d3d8f7dda69f653751539056cce8690b703e023f35b021b9ac451a798800bcb2293a9f414014d9eb22bb54fea779971e79cde106dde4b5c
+  metadata.gz: 75d9dde872641f95f313555ee32c842295c1a4afd150e1158b256821cf5a61f21078c80003b96ef86bce189c8909de1053bbad00a53907b5c191368b1af94444
+  data.tar.gz: 87b0802113b459ead84ea99a1b3a3aa989c26bf1c55b98dd567e7a2e669a38f52a9205a0924b5c1824e8078f61ab472d2f12a471dabfd7a86b445892914c061e

data/README.md

@@ -88,6 +88,21 @@ doc = client.scrape("https://example.com/products/widget",
 puts doc.product
 ```
 
+### Menu Extraction
+
+Use the `menu` format on restaurant/merchant menu pages to get structured
+menu data (merchant profile plus ordered sections, each holding items with
+per-item price, availability, images, and dietary information). It is the
+deterministic counterpart to the LLM-based `json` format. The returned `menu`
+field contains the extracted fields.
+
+```ruby
+doc = client.scrape("https://example.com/menu",
+  Firecrawl::Models::ScrapeOptions.new(formats: ["menu"]))
+
+puts doc.menu
+```
+
 ### Parse
 
 Upload a local file (`html`, `pdf`, `docx`, etc.) via multipart form data and

data/lib/firecrawl/models/document.rb

@@ -7,7 +7,7 @@ module Firecrawl
       attr_reader :markdown, :html, :raw_html, :json, :summary,
                   :metadata, :links, :images, :screenshot, :audio,
                   :video, :attributes, :actions, :answer, :highlights,
-                  :warning, :change_tracking, :branding, :product
+                  :warning, :change_tracking, :branding, :product, :menu
 
       def initialize(data)
         @markdown = data["markdown"]
@@ -29,6 +29,7 @@ module Firecrawl
         @change_tracking = data["changeTracking"]
         @branding = data["branding"]
         @product = data["product"] && ProductProfile.new(data["product"])
+        @menu = data["menu"] && MenuProfile.new(data["menu"])
       end
 
       def to_s

data/lib/firecrawl/models/menu_profile.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # Structured menu information extracted from a restaurant/merchant page
+    # via the `menu` scrape format.
+    class MenuProfile
+      # An image associated with a menu item.
+      class Image
+        attr_reader :url, :alt
+
+        def initialize(data)
+          @url = data["url"]
+          @alt = data["alt"]
+        end
+      end
+
+      # A monetary value with an optional currency and formatted string.
+      class Price
+        attr_reader :amount, :currency, :formatted
+
+        def initialize(data)
+          @amount = data["amount"]
+          @currency = data["currency"]
+          @formatted = data["formatted"]
+        end
+      end
+
+      # Stock availability information for a menu item. Always present.
+      class Availability
+        attr_reader :in_stock, :text
+
+        def initialize(data)
+          data ||= {}
+          @in_stock = data["inStock"] || false
+          @text = data["text"]
+        end
+      end
+
+      # Merchant (restaurant/business) profile for the menu.
+      class Merchant
+        attr_reader :name, :type, :location
+
+        def initialize(data)
+          data ||= {}
+          @name = data["name"]
+          @type = data["type"]
+          @location = data["location"]
+        end
+      end
+
+      # Identifiers carried on a menu item.
+      class Identifiers
+        attr_reader :merchant_item_id
+
+        def initialize(data)
+          data ||= {}
+          @merchant_item_id = data["merchantItemId"]
+        end
+      end
+
+      # A single item on the menu. Pricing, availability, images, and dietary
+      # information live here rather than on the section or profile.
+      class Item
+        attr_reader :id, :name, :description, :images, :price, :availability,
+                    :dietary, :calories, :option_groups, :identifiers, :url,
+                    :source_url
+
+        def initialize(data)
+          @id = data["id"]
+          @name = data["name"]
+          @description = data["description"]
+          @images = (data["images"] || []).map { |img| Image.new(img) }
+          @price = data["price"] && Price.new(data["price"])
+          @availability = Availability.new(data["availability"])
+          @dietary = data["dietary"] || []
+          @calories = data["calories"]
+          @option_groups = data["optionGroups"] || []
+          @identifiers = Identifiers.new(data["identifiers"])
+          @url = data["url"]
+          @source_url = data["sourceUrl"]
+        end
+      end
+
+      # An ordered group of menu items.
+      class Section
+        attr_reader :id, :name, :description, :items
+
+        def initialize(data)
+          @id = data["id"]
+          @name = data["name"]
+          @description = data["description"]
+          @items = (data["items"] || []).map { |item| Item.new(item) }
+        end
+      end
+
+      attr_reader :is_menu, :confidence, :merchant, :currency, :sections,
+                  :source_url
+
+      def initialize(data)
+        @is_menu = data["isMenu"] || false
+        @confidence = data["confidence"]
+        @merchant = Merchant.new(data["merchant"])
+        @currency = data["currency"]
+        @sections = (data["sections"] || []).map { |section| Section.new(section) }
+        @source_url = data["sourceUrl"]
+      end
+
+      def to_s
+        "MenuProfile{merchant=#{merchant&.name || 'unknown'}, sourceUrl=#{source_url || 'unknown'}}"
+      end
+    end
+  end
+end

data/lib/firecrawl/models/monitor.rb

@@ -2,6 +2,81 @@
 
 module Firecrawl
   module Models
+    # A scrape, crawl, or search target stored on a monitor.
+    #
+    # Targets are forwarded to the API verbatim, so callers may also pass
+    # plain Hashes with camelCase keys. This class is a convenience for
+    # building well-formed target payloads (and is what {#to_h} emits).
+    #
+    # Search targets (+type: "search"+) use the +queries+, +search_window+,
+    # +include_domains+, +exclude_domains+, and +max_results+ fields.
+    class MonitorTarget
+      attr_reader :id, :type, :urls, :url, :scrape_options, :crawl_options,
+                  :queries, :search_window, :include_domains,
+                  :exclude_domains, :max_results
+
+      def initialize(data)
+        @id = data["id"]
+        @type = data["type"]
+        @urls = data["urls"]
+        @url = data["url"]
+        @scrape_options = data["scrapeOptions"]
+        @crawl_options = data["crawlOptions"]
+        # search target fields
+        @queries = data["queries"]
+        @search_window = data["searchWindow"]
+        @include_domains = data["includeDomains"]
+        @exclude_domains = data["excludeDomains"]
+        @max_results = data["maxResults"]
+      end
+
+      def to_h
+        {
+          "id" => @id,
+          "type" => @type,
+          "urls" => @urls,
+          "url" => @url,
+          "scrapeOptions" => @scrape_options,
+          "crawlOptions" => @crawl_options,
+          "queries" => @queries,
+          "searchWindow" => @search_window,
+          "includeDomains" => @include_domains,
+          "excludeDomains" => @exclude_domains,
+          "maxResults" => @max_results,
+        }.compact
+      end
+    end
+
+    # A per-target result on a monitor check.
+    #
+    # Search targets (+type: "search"+) populate the +search_completed+,
+    # +result_count+, +matches+, +summary+, +judge_degraded+,
+    # +degraded_reason+, +search_credits+, +judge_credits+, and
+    # +results_judged+ fields.
+    class MonitorTargetResult
+      attr_reader :target_id, :type, :expected_jobs, :crawl_id,
+                  :search_completed, :result_count, :matches, :summary,
+                  :judge_degraded, :degraded_reason, :search_credits,
+                  :judge_credits, :results_judged
+
+      def initialize(data)
+        @target_id = data["targetId"]
+        @type = data["type"]
+        @expected_jobs = data["expectedJobs"]
+        @crawl_id = data["crawlId"]
+        # search target result fields
+        @search_completed = data["searchCompleted"]
+        @result_count = data["resultCount"]
+        @matches = data["matches"]
+        @summary = data["summary"]
+        @judge_degraded = data["judgeDegraded"]
+        @degraded_reason = data["degradedReason"]
+        @search_credits = data["searchCredits"]
+        @judge_credits = data["judgeCredits"]
+        @results_judged = data["resultsJudged"]
+      end
+    end
+
     class Monitor
       attr_reader :id, :name, :status, :schedule, :next_run_at, :last_run_at,
                   :current_check_id, :targets, :webhook, :notification,

data/lib/firecrawl/models/parse_options.rb

@@ -5,10 +5,10 @@ module Firecrawl
     # Options for parsing uploaded files via `/v2/parse`.
     #
     # Parse does not support browser-rendering features (actions, waitFor,
-    # location, mobile) nor screenshot/branding/product/audio/video/changeTracking formats. The
+    # location, mobile) nor screenshot/branding/product/menu/audio/video/changeTracking formats. The
     # proxy field only accepts "auto" or "basic".
     class ParseOptions
-      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding product audio video].freeze
+      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding product menu audio video].freeze
 
       FIELDS = %i[
         formats headers include_tags exclude_tags only_main_content

data/lib/firecrawl/models/search_options.rb

@@ -6,7 +6,7 @@ module Firecrawl
     class SearchOptions
       FIELDS = %i[
         sources categories include_domains exclude_domains limit tbs location
-        ignore_invalid_urls timeout scrape_options integration
+        ignore_invalid_urls timeout scrape_options integration enterprise
       ].freeze
 
       attr_reader(*FIELDS)
@@ -28,6 +28,9 @@ module Firecrawl
           "timeout" => timeout,
           "scrapeOptions" => scrape_options&.to_h,
           "integration" => integration,
+          # Enterprise search options. Use ["zdr"] for end-to-end Zero Data
+          # Retention or ["anon"] for anonymized search. Must be enabled for your team.
+          "enterprise" => enterprise,
         }.compact
       end
     end

data/lib/firecrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Firecrawl
-  VERSION = "1.9.1"
+  VERSION = "1.10.0"
 end

data/lib/firecrawl.rb

@@ -5,6 +5,7 @@ require_relative "firecrawl/errors"
 require_relative "firecrawl/http_client"
 require_relative "firecrawl/models/query_format"
 require_relative "firecrawl/models/product_profile"
+require_relative "firecrawl/models/menu_profile"
 require_relative "firecrawl/models/document"
 require_relative "firecrawl/models/scrape_options"
 require_relative "firecrawl/models/crawl_options"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firecrawl-sdk
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-17 00:00:00.000000000 Z
+date: 2026-06-30 00:00:00.000000000 Z
 dependencies: []
 description: A type-safe Ruby client for the Firecrawl v2 API. Supports scraping,
   crawling, batch scraping, URL mapping, web search, and AI agent operations.
@@ -38,6 +38,7 @@ files:
 - lib/firecrawl/models/document.rb
 - lib/firecrawl/models/map_data.rb
 - lib/firecrawl/models/map_options.rb
+- lib/firecrawl/models/menu_profile.rb
 - lib/firecrawl/models/monitor.rb
 - lib/firecrawl/models/parse_file.rb
 - lib/firecrawl/models/parse_options.rb