brand.dev 1.0.0 → 1.2.0

data/lib/brand_dev/models/brand_web_scrape_images_response.rb

@@ -75,6 +75,10 @@ module BrandDev
           LINK = :link
           SOURCE = :source
           VIDEO = :video
+          CSS = :css
+          OBJECT = :object
+          META = :meta
+          BACKGROUND = :background
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/brand_dev/models/brand_web_scrape_md_params.rb

@@ -32,7 +32,14 @@ module BrandDev
       #   @return [Boolean, nil]
       optional :shorten_base64_images, BrandDev::Internal::Type::Boolean
 
-      # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
+      # @!attribute use_main_content_only
+      #   Extract only the main content of the page, excluding headers, footers, sidebars,
+      #   and navigation
+      #
+      #   @return [Boolean, nil]
+      optional :use_main_content_only, BrandDev::Internal::Type::Boolean
+
+      # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandWebScrapeMdParams} for more details.
       #
@@ -44,6 +51,8 @@ module BrandDev
       #
       #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
+      #   @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
+      #
       #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/brand_dev/resources/brand.rb

@@ -503,14 +503,12 @@ module BrandDev
       # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
       # both.
       #
-      # @overload styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
+      # @overload styleguide(direct_url: nil, domain: nil, timeout_ms: nil, request_options: {})
       #
       # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
       #
       # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
-      # @param prioritize [Symbol, BrandDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I
-      #
       # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -584,7 +582,7 @@ module BrandDev
       # Scrapes the given URL, converts the HTML content to Markdown, and returns the
       # result.
       #
-      # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
+      # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {})
       #
       # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
       #
@@ -594,6 +592,8 @@ module BrandDev
       #
       # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
+      # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandWebScrapeMdResponse]
@@ -608,7 +608,8 @@ module BrandDev
           query: query.transform_keys(
             include_images: "includeImages",
             include_links: "includeLinks",
-            shorten_base64_images: "shortenBase64Images"
+            shorten_base64_images: "shortenBase64Images",
+            use_main_content_only: "useMainContentOnly"
           ),
           model: BrandDev::Models::BrandWebScrapeMdResponse,
           options: options

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/rbi/brand_dev/internal/util.rbi

@@ -148,12 +148,20 @@ module BrandDev
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)

data/rbi/brand_dev/models/brand_styleguide_params.rbi

@@ -27,24 +27,6 @@ module BrandDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # 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
-      # not provided.
-      sig do
-        returns(
-          T.nilable(BrandDev::BrandStyleguideParams::Prioritize::OrSymbol)
-        )
-      end
-      attr_reader :prioritize
-
-      sig do
-        params(
-          prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol
-        ).void
-      end
-      attr_writer :prioritize
-
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -58,7 +40,6 @@ module BrandDev
         params(
           direct_url: String,
           domain: String,
-          prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -70,11 +51,6 @@ module BrandDev
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
         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
-        # not provided.
-        prioritize: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -88,7 +64,6 @@ module BrandDev
           {
             direct_url: String,
             domain: String,
-            prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
             timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
@@ -96,39 +71,6 @@ module BrandDev
       end
       def to_hash
       end
-
-      # 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
-      # not provided.
-      module Prioritize
-        extend BrandDev::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, BrandDev::BrandStyleguideParams::Prioritize)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        SPEED =
-          T.let(
-            :speed,
-            BrandDev::BrandStyleguideParams::Prioritize::TaggedSymbol
-          )
-        QUALITY =
-          T.let(
-            :quality,
-            BrandDev::BrandStyleguideParams::Prioritize::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[BrandDev::BrandStyleguideParams::Prioritize::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end