imagekitio 4.0.0 → 4.1.1

data/rbi/imagekitio/models/base_overlay.rbi

@@ -8,12 +8,45 @@ module Imagekitio
           T.any(Imagekitio::BaseOverlay, Imagekitio::Internal::AnyHash)
         end
 
+      # Controls how the layer blends with the base image or underlying content. Maps to
+      # `lm` in the URL. By default, layers completely cover the base image beneath
+      # them. Layer modes change this behavior:
+      #
+      # - `multiply`: Multiplies the pixel values of the layer with the base image. The
+      #   result is always darker than the original images. This is ideal for applying
+      #   shadows or color tints.
+      # - `displace`: Uses the layer as a displacement map to distort pixels in the base
+      #   image. The red channel controls horizontal displacement, and the green channel
+      #   controls vertical displacement. Requires `x` or `y` parameter to control
+      #   displacement magnitude.
+      # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the
+      #   base image transparent, while transparent areas leave the base image
+      #   unchanged. This mode functions like a hole-punch, effectively cutting the
+      #   shape of the layer out of the underlying image.
+      # - `cutter`: Acts as a shape mask where only the parts of the base image that
+      #   fall inside the opaque area of the layer are preserved. This mode functions
+      #   like a cookie-cutter, trimming the base image to match the specific dimensions
+      #   and shape of the layer. See
+      #   [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
+      sig { returns(T.nilable(Imagekitio::BaseOverlay::LayerMode::OrSymbol)) }
+      attr_reader :layer_mode
+
+      sig do
+        params(layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol).void
+      end
+      attr_writer :layer_mode
+
+      # Specifies the overlay's position relative to the parent asset. See
+      # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer).
       sig { returns(T.nilable(Imagekitio::OverlayPosition)) }
       attr_reader :position
 
       sig { params(position: Imagekitio::OverlayPosition::OrHash).void }
       attr_writer :position
 
+      # Specifies timing information for the overlay (only applicable if the base asset
+      # is a video). See
+      # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer).
       sig { returns(T.nilable(Imagekitio::OverlayTiming)) }
       attr_reader :timing
 
@@ -22,16 +55,47 @@ module Imagekitio
 
       sig do
         params(
+          layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol,
           position: Imagekitio::OverlayPosition::OrHash,
           timing: Imagekitio::OverlayTiming::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(position: nil, timing: nil)
+      def self.new(
+        # Controls how the layer blends with the base image or underlying content. Maps to
+        # `lm` in the URL. By default, layers completely cover the base image beneath
+        # them. Layer modes change this behavior:
+        #
+        # - `multiply`: Multiplies the pixel values of the layer with the base image. The
+        #   result is always darker than the original images. This is ideal for applying
+        #   shadows or color tints.
+        # - `displace`: Uses the layer as a displacement map to distort pixels in the base
+        #   image. The red channel controls horizontal displacement, and the green channel
+        #   controls vertical displacement. Requires `x` or `y` parameter to control
+        #   displacement magnitude.
+        # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the
+        #   base image transparent, while transparent areas leave the base image
+        #   unchanged. This mode functions like a hole-punch, effectively cutting the
+        #   shape of the layer out of the underlying image.
+        # - `cutter`: Acts as a shape mask where only the parts of the base image that
+        #   fall inside the opaque area of the layer are preserved. This mode functions
+        #   like a cookie-cutter, trimming the base image to match the specific dimensions
+        #   and shape of the layer. See
+        #   [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
+        layer_mode: nil,
+        # Specifies the overlay's position relative to the parent asset. See
+        # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer).
+        position: nil,
+        # Specifies timing information for the overlay (only applicable if the base asset
+        # is a video). See
+        # [Position of Layer](https://imagekit.io/docs/transformations#position-of-layer).
+        timing: nil
+      )
       end
 
       sig do
         override.returns(
           {
+            layer_mode: Imagekitio::BaseOverlay::LayerMode::OrSymbol,
             position: Imagekitio::OverlayPosition,
             timing: Imagekitio::OverlayTiming
           }
@@ -39,6 +103,51 @@ module Imagekitio
       end
       def to_hash
       end
+
+      # Controls how the layer blends with the base image or underlying content. Maps to
+      # `lm` in the URL. By default, layers completely cover the base image beneath
+      # them. Layer modes change this behavior:
+      #
+      # - `multiply`: Multiplies the pixel values of the layer with the base image. The
+      #   result is always darker than the original images. This is ideal for applying
+      #   shadows or color tints.
+      # - `displace`: Uses the layer as a displacement map to distort pixels in the base
+      #   image. The red channel controls horizontal displacement, and the green channel
+      #   controls vertical displacement. Requires `x` or `y` parameter to control
+      #   displacement magnitude.
+      # - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the
+      #   base image transparent, while transparent areas leave the base image
+      #   unchanged. This mode functions like a hole-punch, effectively cutting the
+      #   shape of the layer out of the underlying image.
+      # - `cutter`: Acts as a shape mask where only the parts of the base image that
+      #   fall inside the opaque area of the layer are preserved. This mode functions
+      #   like a cookie-cutter, trimming the base image to match the specific dimensions
+      #   and shape of the layer. See
+      #   [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
+      module LayerMode
+        extend Imagekitio::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Imagekitio::BaseOverlay::LayerMode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MULTIPLY =
+          T.let(:multiply, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol)
+        CUTTER =
+          T.let(:cutter, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol)
+        CUTOUT =
+          T.let(:cutout, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol)
+        DISPLACE =
+          T.let(:displace, Imagekitio::BaseOverlay::LayerMode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Imagekitio::BaseOverlay::LayerMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/imagekitio/models/beta/v2/file_upload_params.rbi

@@ -98,6 +98,8 @@ module Imagekitio
                   T.any(
                     Imagekitio::ExtensionItem::RemoveBg,
                     Imagekitio::ExtensionItem::AIAutoDescription,
+                    Imagekitio::ExtensionItem::AITasks,
+                    Imagekitio::ExtensionItem::SavedExtension,
                     Imagekitio::ExtensionItem::AutoTaggingExtension
                   )
                 ]
@@ -113,6 +115,8 @@ module Imagekitio
                   T.any(
                     Imagekitio::ExtensionItem::RemoveBg::OrHash,
                     Imagekitio::ExtensionItem::AIAutoDescription::OrHash,
+                    Imagekitio::ExtensionItem::AITasks::OrHash,
+                    Imagekitio::ExtensionItem::SavedExtension::OrHash,
                     Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash
                   )
                 ]
@@ -280,6 +284,8 @@ module Imagekitio
                   T.any(
                     Imagekitio::ExtensionItem::RemoveBg::OrHash,
                     Imagekitio::ExtensionItem::AIAutoDescription::OrHash,
+                    Imagekitio::ExtensionItem::AITasks::OrHash,
+                    Imagekitio::ExtensionItem::SavedExtension::OrHash,
                     Imagekitio::ExtensionItem::AutoTaggingExtension::OrHash
                   )
                 ],
@@ -431,6 +437,8 @@ module Imagekitio
                     T.any(
                       Imagekitio::ExtensionItem::RemoveBg,
                       Imagekitio::ExtensionItem::AIAutoDescription,
+                      Imagekitio::ExtensionItem::AITasks,
+                      Imagekitio::ExtensionItem::SavedExtension,
                       Imagekitio::ExtensionItem::AutoTaggingExtension
                     )
                   ],

data/rbi/imagekitio/models/beta/v2/file_upload_response.rbi

@@ -516,6 +516,23 @@ module Imagekitio
             end
             attr_writer :ai_auto_description
 
+            sig do
+              returns(
+                T.nilable(
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :ai_tasks
+
+            sig do
+              params(
+                ai_tasks:
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol
+              ).void
+            end
+            attr_writer :ai_tasks
+
             sig do
               returns(
                 T.nilable(
@@ -580,6 +597,8 @@ module Imagekitio
               params(
                 ai_auto_description:
                   Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::OrSymbol,
+                ai_tasks:
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::OrSymbol,
                 aws_auto_tagging:
                   Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::OrSymbol,
                 google_auto_tagging:
@@ -590,6 +609,7 @@ module Imagekitio
             end
             def self.new(
               ai_auto_description: nil,
+              ai_tasks: nil,
               aws_auto_tagging: nil,
               google_auto_tagging: nil,
               remove_bg: nil
@@ -601,6 +621,8 @@ module Imagekitio
                 {
                   ai_auto_description:
                     Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AIAutoDescription::TaggedSymbol,
+                  ai_tasks:
+                    Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol,
                   aws_auto_tagging:
                     Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AwsAutoTagging::TaggedSymbol,
                   google_auto_tagging:
@@ -652,6 +674,45 @@ module Imagekitio
               end
             end
 
+            module AITasks
+              extend Imagekitio::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              SUCCESS =
+                T.let(
+                  :success,
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol
+                )
+              PENDING =
+                T.let(
+                  :pending,
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Imagekitio::Models::Beta::V2::FileUploadResponse::ExtensionStatus::AITasks::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
             module AwsAutoTagging
               extend Imagekitio::Internal::Type::Enum