firecrawl-sdk 1.9.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 027be403af5ba321ba2d4dbeaa774433666ece0a98cca4ac03ffbce52ac6cae2
-  data.tar.gz: d0ee19ba03f949234d00482c6e0c451986de84c4e4dfde7860c970845a23e3b4
+  metadata.gz: f17ef4d354c427ea550adb739310cd6b7d03a148c72febb6c69133f0f39a10c0
+  data.tar.gz: e1907bd8120fc8bb893233d85ec9f63cae511e65ce8db7dfee848ed0592de1d5
 SHA512:
-  metadata.gz: fb9869b378f9d8252cd45ad2b5be1d7f5e9c30f3c67d4752177e3d205a689b75f3da972f389e5d70260bbde576e1677068c4b538ea82c92c25643a239debd879
-  data.tar.gz: f8ad0a882856666ef4662d6356608759513305babc5392100c1cba5ddcaffb89392c67c447aa181cb3ab97230cd0bec4f7f957c11e4585068ef58a2eadcbacda
+  metadata.gz: 93523ad1fe6bae7e66a9dc51b0c40d1cd580cdb6c9310a6709baa52142bf52bbed036c7c1b1f0361041d6672b2ac74cd45e974e3a0d251b27add73cae5176d34
+  data.tar.gz: ca1db36ccabd4060775c2e91f4284e3cf0f2ac393ee2b983a5437a66aa01b74fc477a7bce79fbb9468c51ca696d744e38893bb98729343b8c7c58fd0de6f318c

data/README.md

@@ -74,11 +74,40 @@ doc = client.scrape("https://www.youtube.com/watch?v=dQw4w9WgXcQ",
 puts doc.video
 ```
 
+### Product Extraction
+
+Use the `product` format on product pages to get structured product data
+(title, brand, category, and per-variant price, availability, and images).
+It is the deterministic counterpart to the LLM-based `json` format. The
+returned `product` field contains the extracted fields.
+
+```ruby
+doc = client.scrape("https://example.com/products/widget",
+  Firecrawl::Models::ScrapeOptions.new(formats: ["product"]))
+
+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
 parse it synchronously. Parse options intentionally exclude browser-only
-features such as change tracking, screenshot, branding, audio, video, actions,
+features such as change tracking, screenshot, branding, audio, video, product, actions,
 wait_for, location, and mobile. The `proxy` option only accepts `"auto"` or `"basic"`.
 
 ```ruby

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
+                  :warning, :change_tracking, :branding, :product, :menu
 
       def initialize(data)
         @markdown = data["markdown"]
@@ -28,6 +28,8 @@ module Firecrawl
         @warning = data["warning"]
         @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/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/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 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/product_profile.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # Structured product information extracted from a product page via the
+    # `product` scrape format.
+    class ProductProfile
+      # An image associated with a product or variant.
+      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 variant. Always present.
+      class Availability
+        attr_reader :in_stock, :text
+
+        def initialize(data)
+          data ||= {}
+          @in_stock = data["inStock"] || false
+          @text = data["text"]
+        end
+      end
+
+      # Sale pricing for a variant, carrying the pre-sale original price.
+      class Sale
+        attr_reader :original_price
+
+        def initialize(data)
+          @original_price = data["originalPrice"] && Price.new(data["originalPrice"])
+        end
+      end
+
+      # A purchasable variant of a product. Pricing, availability, and images
+      # live here rather than on the top-level product.
+      class Variant
+        attr_reader :id, :sku, :title, :values, :price, :sale,
+                    :availability, :images
+
+        def initialize(data)
+          @id = data["id"]
+          @sku = data["sku"]
+          @title = data["title"]
+          @values = data["values"]
+          @price = data["price"] && Price.new(data["price"])
+          @sale = data["sale"] && Sale.new(data["sale"])
+          @availability = Availability.new(data["availability"])
+          @images = (data["images"] || []).map { |img| Image.new(img) }
+        end
+      end
+
+      attr_reader :title, :brand, :category, :url, :description, :variants
+
+      def initialize(data)
+        @title = data["title"]
+        @brand = data["brand"]
+        @category = data["category"]
+        @url = data["url"]
+        @description = data["description"]
+        @variants = (data["variants"] || []).map { |variant| Variant.new(variant) }
+      end
+
+      def to_s
+        "ProductProfile{title=#{title || 'untitled'}, url=#{url || 'unknown'}}"
+      end
+    end
+  end
+end

data/lib/firecrawl/version.rb

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

data/lib/firecrawl.rb

@@ -4,6 +4,8 @@ require_relative "firecrawl/version"
 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.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-16 00:00:00.000000000 Z
+date: 2026-06-19 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,9 +38,11 @@ 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
+- lib/firecrawl/models/product_profile.rb
 - lib/firecrawl/models/query_format.rb
 - lib/firecrawl/models/scrape_options.rb
 - lib/firecrawl/models/search_data.rb