context.dev 1.4.0 → 1.6.0

data/rbi/context_dev/models/web_extract_fonts_response.rbi

@@ -0,0 +1,301 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebExtractFontsResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # HTTP status code, e.g., 200
+      sig { returns(Integer) }
+      attr_accessor :code
+
+      # The normalized domain that was processed
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Array of font usage information
+      sig do
+        returns(T::Array[ContextDev::Models::WebExtractFontsResponse::Font])
+      end
+      attr_accessor :fonts
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(String) }
+      attr_accessor :status
+
+      # Font assets keyed by family name as it appears in the fonts array (non-generic
+      # names only). Clients match entries in fonts to pick a file URL from files.
+      # Omitted when no families resolve to Google or custom @font-face URLs.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              ContextDev::Models::WebExtractFontsResponse::FontLink
+            ]
+          )
+        )
+      end
+      attr_reader :font_links
+
+      sig do
+        params(
+          font_links:
+            T::Hash[
+              Symbol,
+              ContextDev::Models::WebExtractFontsResponse::FontLink::OrHash
+            ]
+        ).void
+      end
+      attr_writer :font_links
+
+      sig do
+        params(
+          code: Integer,
+          domain: String,
+          fonts:
+            T::Array[ContextDev::Models::WebExtractFontsResponse::Font::OrHash],
+          status: String,
+          font_links:
+            T::Hash[
+              Symbol,
+              ContextDev::Models::WebExtractFontsResponse::FontLink::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # HTTP status code, e.g., 200
+        code:,
+        # The normalized domain that was processed
+        domain:,
+        # Array of font usage information
+        fonts:,
+        # Status of the response, e.g., 'ok'
+        status:,
+        # Font assets keyed by family name as it appears in the fonts array (non-generic
+        # names only). Clients match entries in fonts to pick a file URL from files.
+        # Omitted when no families resolve to Google or custom @font-face URLs.
+        font_links: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: Integer,
+            domain: String,
+            fonts: T::Array[ContextDev::Models::WebExtractFontsResponse::Font],
+            status: String,
+            font_links:
+              T::Hash[
+                Symbol,
+                ContextDev::Models::WebExtractFontsResponse::FontLink
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Font < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractFontsResponse::Font,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Array of fallback font families
+        sig { returns(T::Array[String]) }
+        attr_accessor :fallbacks
+
+        # Font family name
+        sig { returns(String) }
+        attr_accessor :font
+
+        # Number of elements using this font
+        sig { returns(Float) }
+        attr_accessor :num_elements
+
+        # Number of words using this font
+        sig { returns(Float) }
+        attr_accessor :num_words
+
+        # Percentage of elements using this font
+        sig { returns(Float) }
+        attr_accessor :percent_elements
+
+        # Percentage of words using this font
+        sig { returns(Float) }
+        attr_accessor :percent_words
+
+        # Array of CSS selectors or element types where this font is used
+        sig { returns(T::Array[String]) }
+        attr_accessor :uses
+
+        sig do
+          params(
+            fallbacks: T::Array[String],
+            font: String,
+            num_elements: Float,
+            num_words: Float,
+            percent_elements: Float,
+            percent_words: Float,
+            uses: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Array of fallback font families
+          fallbacks:,
+          # Font family name
+          font:,
+          # Number of elements using this font
+          num_elements:,
+          # Number of words using this font
+          num_words:,
+          # Percentage of elements using this font
+          percent_elements:,
+          # Percentage of words using this font
+          percent_words:,
+          # Array of CSS selectors or element types where this font is used
+          uses:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              fallbacks: T::Array[String],
+              font: String,
+              num_elements: Float,
+              num_words: Float,
+              percent_elements: Float,
+              percent_words: Float,
+              uses: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class FontLink < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractFontsResponse::FontLink,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Upright font files keyed by weight string (e.g. "400" for regular, "500",
+        # "700"). Values are absolute URLs.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :files
+
+        sig do
+          returns(
+            ContextDev::Models::WebExtractFontsResponse::FontLink::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Google Fonts category when type is google (e.g. sans-serif, serif, monospace,
+        # display, handwriting). Omitted for custom fonts when unknown.
+        sig { returns(T.nilable(String)) }
+        attr_reader :category
+
+        sig { params(category: String).void }
+        attr_writer :category
+
+        # Present when type is custom: human-readable name derived from the fontLinks key
+        # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators).
+        # Google entries omit this.
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig do
+          params(
+            files: T::Hash[Symbol, String],
+            type:
+              ContextDev::Models::WebExtractFontsResponse::FontLink::Type::OrSymbol,
+            category: String,
+            display_name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Upright font files keyed by weight string (e.g. "400" for regular, "500",
+          # "700"). Values are absolute URLs.
+          files:,
+          type:,
+          # Google Fonts category when type is google (e.g. sans-serif, serif, monospace,
+          # display, handwriting). Omitted for custom fonts when unknown.
+          category: nil,
+          # Present when type is custom: human-readable name derived from the fontLinks key
+          # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators).
+          # Google entries omit this.
+          display_name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              files: T::Hash[Symbol, String],
+              type:
+                ContextDev::Models::WebExtractFontsResponse::FontLink::Type::TaggedSymbol,
+              category: String,
+              display_name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::WebExtractFontsResponse::FontLink::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GOOGLE =
+            T.let(
+              :google,
+              ContextDev::Models::WebExtractFontsResponse::FontLink::Type::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              ContextDev::Models::WebExtractFontsResponse::FontLink::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebExtractFontsResponse::FontLink::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/{style_extract_styleguide_params.rbi → web_extract_styleguide_params.rbi}

@@ -2,20 +2,22 @@
 
 module ContextDev
   module Models
-    class StyleExtractStyleguideParams < ContextDev::Internal::Type::BaseModel
+    class WebExtractStyleguideParams < ContextDev::Internal::Type::BaseModel
       extend ContextDev::Internal::Type::RequestParameters::Converter
       include ContextDev::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            ContextDev::StyleExtractStyleguideParams,
+            ContextDev::WebExtractStyleguideParams,
             ContextDev::Internal::AnyHash
           )
         end
 
       # A specific URL to fetch the styleguide from directly, bypassing domain
-      # resolution (e.g., 'https://example.com/design-system').
+      # resolution (e.g., 'https://example.com/design-system'). When provided, the
+      # styleguide is extracted from this exact URL. You must provide either 'domain' or
+      # 'directUrl', but not both.
       sig { returns(T.nilable(String)) }
       attr_reader :direct_url
 
@@ -23,7 +25,8 @@ module ContextDev
       attr_writer :direct_url
 
       # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
-      # domain will be automatically normalized and validated.
+      # domain will be automatically normalized and validated. You must provide either
+      # 'domain' or 'directUrl', but not both.
       sig { returns(T.nilable(String)) }
       attr_reader :domain
 
@@ -49,10 +52,13 @@ module ContextDev
       end
       def self.new(
         # A specific URL to fetch the styleguide from directly, bypassing domain
-        # resolution (e.g., 'https://example.com/design-system').
+        # resolution (e.g., 'https://example.com/design-system'). When provided, the
+        # styleguide is extracted from this exact URL. You must provide either 'domain' or
+        # 'directUrl', but not both.
         direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
-        # domain will be automatically normalized and validated.
+        # domain will be automatically normalized and validated. You must provide either
+        # 'domain' or 'directUrl', but not both.
         domain: 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