brand.dev 0.25.0 → 0.27.0

data/rbi/brand_dev/models/brand_web_scrape_sitemap_response.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandWebScrapeSitemapResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # The normalized domain that was crawled
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Metadata about the sitemap crawl operation
+      sig { returns(BrandDev::Models::BrandWebScrapeSitemapResponse::Meta) }
+      attr_reader :meta
+
+      sig do
+        params(
+          meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta::OrHash
+        ).void
+      end
+      attr_writer :meta
+
+      # Indicates success
+      sig do
+        returns(
+          BrandDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      # Array of discovered page URLs from the sitemap (max 500)
+      sig { returns(T::Array[String]) }
+      attr_accessor :urls
+
+      sig do
+        params(
+          domain: String,
+          meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta::OrHash,
+          success:
+            BrandDev::Models::BrandWebScrapeSitemapResponse::Success::OrBoolean,
+          urls: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The normalized domain that was crawled
+        domain:,
+        # Metadata about the sitemap crawl operation
+        meta:,
+        # Indicates success
+        success:,
+        # Array of discovered page URLs from the sitemap (max 500)
+        urls:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            domain: String,
+            meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta,
+            success:
+              BrandDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean,
+            urls: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Meta < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::Models::BrandWebScrapeSitemapResponse::Meta,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Number of errors encountered during crawling
+        sig { returns(Integer) }
+        attr_accessor :errors
+
+        # Total number of sitemap files discovered
+        sig { returns(Integer) }
+        attr_accessor :sitemaps_discovered
+
+        # Number of sitemap files successfully fetched and parsed
+        sig { returns(Integer) }
+        attr_accessor :sitemaps_fetched
+
+        # Number of sitemap files skipped (due to errors, timeouts, or limits)
+        sig { returns(Integer) }
+        attr_accessor :sitemaps_skipped
+
+        # Metadata about the sitemap crawl operation
+        sig do
+          params(
+            errors: Integer,
+            sitemaps_discovered: Integer,
+            sitemaps_fetched: Integer,
+            sitemaps_skipped: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of errors encountered during crawling
+          errors:,
+          # Total number of sitemap files discovered
+          sitemaps_discovered:,
+          # Number of sitemap files successfully fetched and parsed
+          sitemaps_fetched:,
+          # Number of sitemap files skipped (due to errors, timeouts, or limits)
+          sitemaps_skipped:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              errors: Integer,
+              sitemaps_discovered: Integer,
+              sitemaps_fetched: Integer,
+              sitemaps_skipped: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # Indicates success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              BrandDev::Models::BrandWebScrapeSitemapResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            BrandDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models.rbi

@@ -34,4 +34,12 @@ module BrandDev
   BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
 
   BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
+
+  BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams
+
+  BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams
+
+  BrandWebScrapeMdParams = BrandDev::Models::BrandWebScrapeMdParams
+
+  BrandWebScrapeSitemapParams = BrandDev::Models::BrandWebScrapeSitemapParams
 end

data/rbi/brand_dev/resources/brand.rbi

@@ -437,8 +437,11 @@ module BrandDev
 
       # Automatically extract comprehensive design system information from a brand's
       # website including colors, typography, spacing, shadows, and UI components.
+      # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
+      # both.
       sig do
         params(
+          direct_url: String,
           domain: String,
           prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
           timeout_ms: Integer,
@@ -446,9 +449,12 @@ module BrandDev
         ).returns(BrandDev::Models::BrandStyleguideResponse)
       end
       def styleguide(
+        # A specific URL to fetch the styleguide from directly, bypassing domain
+        # resolution (e.g., 'https://example.com/design-system').
+        direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
         # optimizes for higher quality with longer wait times. Defaults to 'quality' if
@@ -462,6 +468,77 @@ module BrandDev
       )
       end
 
+      # Scrapes the given URL and returns the raw HTML content of the page. Uses
+      # automatic proxy escalation to handle blocked sites.
+      sig do
+        params(
+          url: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse)
+      end
+      def web_scrape_html(
+        # Full URL to scrape (must include http:// or https:// protocol)
+        url:,
+        request_options: {}
+      )
+      end
+
+      # Scrapes all images from the given URL. Extracts images from img, svg,
+      # picture/source, link, and video elements including inline SVGs, base64 data
+      # URIs, and standard URLs.
+      sig do
+        params(
+          url: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandWebScrapeImagesResponse)
+      end
+      def web_scrape_images(
+        # Full URL to scrape images from (must include http:// or https:// protocol)
+        url:,
+        request_options: {}
+      )
+      end
+
+      # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown
+      # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
+      # sites.
+      sig do
+        params(
+          url: String,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandWebScrapeMdResponse)
+      end
+      def web_scrape_md(
+        # Full URL to scrape and convert to markdown (must include http:// or https://
+        # protocol)
+        url:,
+        # Include image references in Markdown output
+        include_images: nil,
+        # Preserve hyperlinks in Markdown output
+        include_links: nil,
+        request_options: {}
+      )
+      end
+
+      # Crawls the sitemap of the given domain and returns all discovered page URLs.
+      # Supports sitemap index files (recursive), parallel fetching with concurrency
+      # control, deduplication, and filters out non-page resources (images, PDFs, etc.).
+      sig do
+        params(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandWebScrapeSitemapResponse)
+      end
+      def web_scrape_sitemap(
+        # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
+        # automatically normalized and validated.
+        domain:,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: BrandDev::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/brand_dev/models/brand_styleguide_params.rbs

@@ -2,6 +2,7 @@ module BrandDev
   module Models
     type brand_styleguide_params =
       {
+        direct_url: String,
         domain: String,
         prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         timeout_ms: Integer
@@ -12,7 +13,13 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
-      attr_accessor domain: String
+      attr_reader direct_url: String?
+
+      def direct_url=: (String) -> String
+
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
 
       attr_reader prioritize: BrandDev::Models::BrandStyleguideParams::prioritize?
 
@@ -25,13 +32,15 @@ module BrandDev
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
+        direct_url: String,
         domain: String,
         prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         timeout_ms: Integer,

data/sig/brand_dev/models/brand_web_scrape_html_params.rbs

@@ -0,0 +1,20 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_html_params =
+      { url: String } & BrandDev::Internal::Type::request_parameters
+
+    class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor url: String
+
+      def initialize: (
+        url: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> { url: String, request_options: BrandDev::RequestOptions }
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_html_response.rbs

@@ -0,0 +1,40 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_html_response =
+      {
+        html: String,
+        success: BrandDev::Models::BrandWebScrapeHTMLResponse::success,
+        url: String
+      }
+
+    class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel
+      attr_accessor html: String
+
+      attr_accessor success: BrandDev::Models::BrandWebScrapeHTMLResponse::success
+
+      attr_accessor url: String
+
+      def initialize: (
+        html: String,
+        success: BrandDev::Models::BrandWebScrapeHTMLResponse::success,
+        url: String
+      ) -> void
+
+      def to_hash: -> {
+        html: String,
+        success: BrandDev::Models::BrandWebScrapeHTMLResponse::success,
+        url: String
+      }
+
+      type success = true
+
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::success]
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_images_params.rbs

@@ -0,0 +1,20 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_images_params =
+      { url: String } & BrandDev::Internal::Type::request_parameters
+
+    class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor url: String
+
+      def initialize: (
+        url: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> { url: String, request_options: BrandDev::RequestOptions }
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_images_response.rbs

@@ -0,0 +1,98 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_images_response =
+      {
+        images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image],
+        success: BrandDev::Models::BrandWebScrapeImagesResponse::success,
+        url: String
+      }
+
+    class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel
+      attr_accessor images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image]
+
+      attr_accessor success: BrandDev::Models::BrandWebScrapeImagesResponse::success
+
+      attr_accessor url: String
+
+      def initialize: (
+        images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image],
+        success: BrandDev::Models::BrandWebScrapeImagesResponse::success,
+        url: String
+      ) -> void
+
+      def to_hash: -> {
+        images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image],
+        success: BrandDev::Models::BrandWebScrapeImagesResponse::success,
+        url: String
+      }
+
+      type image =
+        {
+          alt: String?,
+          element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element,
+          src: String,
+          type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_
+        }
+
+      class Image < BrandDev::Internal::Type::BaseModel
+        attr_accessor alt: String?
+
+        attr_accessor element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element
+
+        attr_accessor src: String
+
+        attr_accessor type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_
+
+        def initialize: (
+          alt: String?,
+          element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element,
+          src: String,
+          type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_
+        ) -> void
+
+        def to_hash: -> {
+          alt: String?,
+          element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element,
+          src: String,
+          type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_
+        }
+
+        type element = :img | :svg | :link | :source | :video
+
+        module Element
+          extend BrandDev::Internal::Type::Enum
+
+          IMG: :img
+          SVG: :svg
+          LINK: :link
+          SOURCE: :source
+          VIDEO: :video
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image::element]
+        end
+
+        type type_ = :url | :html | :base64
+
+        module Type
+          extend BrandDev::Internal::Type::Enum
+
+          URL: :url
+          HTML: :html
+          BASE64: :base64
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_]
+        end
+      end
+
+      type success = true
+
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::success]
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_md_params.rbs

@@ -0,0 +1,36 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_md_params =
+      { url: String, include_images: bool, include_links: bool }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor url: String
+
+      attr_reader include_images: bool?
+
+      def include_images=: (bool) -> bool
+
+      attr_reader include_links: bool?
+
+      def include_links=: (bool) -> bool
+
+      def initialize: (
+        url: String,
+        ?include_images: bool,
+        ?include_links: bool,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        url: String,
+        include_images: bool,
+        include_links: bool,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_md_response.rbs

@@ -0,0 +1,40 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_md_response =
+      {
+        markdown: String,
+        success: BrandDev::Models::BrandWebScrapeMdResponse::success,
+        url: String
+      }
+
+    class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel
+      attr_accessor markdown: String
+
+      attr_accessor success: BrandDev::Models::BrandWebScrapeMdResponse::success
+
+      attr_accessor url: String
+
+      def initialize: (
+        markdown: String,
+        success: BrandDev::Models::BrandWebScrapeMdResponse::success,
+        url: String
+      ) -> void
+
+      def to_hash: -> {
+        markdown: String,
+        success: BrandDev::Models::BrandWebScrapeMdResponse::success,
+        url: String
+      }
+
+      type success = true
+
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::success]
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs

@@ -0,0 +1,23 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_sitemap_params =
+      { domain: String } & BrandDev::Internal::Type::request_parameters
+
+    class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      def initialize: (
+        domain: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_web_scrape_sitemap_response.rbs

@@ -0,0 +1,77 @@
+module BrandDev
+  module Models
+    type brand_web_scrape_sitemap_response =
+      {
+        domain: String,
+        meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta,
+        success: BrandDev::Models::BrandWebScrapeSitemapResponse::success,
+        urls: ::Array[String]
+      }
+
+    class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel
+      attr_accessor domain: String
+
+      attr_accessor meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta
+
+      attr_accessor success: BrandDev::Models::BrandWebScrapeSitemapResponse::success
+
+      attr_accessor urls: ::Array[String]
+
+      def initialize: (
+        domain: String,
+        meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta,
+        success: BrandDev::Models::BrandWebScrapeSitemapResponse::success,
+        urls: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta,
+        success: BrandDev::Models::BrandWebScrapeSitemapResponse::success,
+        urls: ::Array[String]
+      }
+
+      type meta =
+        {
+          errors: Integer,
+          sitemaps_discovered: Integer,
+          sitemaps_fetched: Integer,
+          sitemaps_skipped: Integer
+        }
+
+      class Meta < BrandDev::Internal::Type::BaseModel
+        attr_accessor errors: Integer
+
+        attr_accessor sitemaps_discovered: Integer
+
+        attr_accessor sitemaps_fetched: Integer
+
+        attr_accessor sitemaps_skipped: Integer
+
+        def initialize: (
+          errors: Integer,
+          sitemaps_discovered: Integer,
+          sitemaps_fetched: Integer,
+          sitemaps_skipped: Integer
+        ) -> void
+
+        def to_hash: -> {
+          errors: Integer,
+          sitemaps_discovered: Integer,
+          sitemaps_fetched: Integer,
+          sitemaps_skipped: Integer
+        }
+      end
+
+      type success = true
+
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeSitemapResponse::success]
+      end
+    end
+  end
+end

data/sig/brand_dev/models.rbs

@@ -30,4 +30,12 @@ module BrandDev
   class BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
 
   class BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
+
+  class BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams
+
+  class BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams
+
+  class BrandWebScrapeMdParams = BrandDev::Models::BrandWebScrapeMdParams
+
+  class BrandWebScrapeSitemapParams = BrandDev::Models::BrandWebScrapeSitemapParams
 end