imagekitio 3.0.0 → 4.0.0

data/lib/imagekitio.rb

@@ -1,13 +1,181 @@
-require "imagekitio/railtie" if defined? Rails
-
-require 'base64'
-
-require_relative './imagekitio/constant'
-require_relative './imagekitio/base'
-require_relative './imagekitio/configurable'
-require_relative './imagekitio/client'
-require_relative "./imagekitio/request"
-require_relative "./imagekitio/url"
-require_relative './imagekitio/api_service/custom_metadata_field'
-require_relative './imagekitio/api_service/file'
-require_relative './imagekitio/api_service/folder'
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+require "base64"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "imagekitio/version"
+require_relative "imagekitio/internal/util"
+require_relative "imagekitio/internal/type/converter"
+require_relative "imagekitio/internal/type/unknown"
+require_relative "imagekitio/internal/type/boolean"
+require_relative "imagekitio/internal/type/file_input"
+require_relative "imagekitio/internal/type/enum"
+require_relative "imagekitio/internal/type/union"
+require_relative "imagekitio/internal/type/array_of"
+require_relative "imagekitio/internal/type/hash_of"
+require_relative "imagekitio/internal/type/base_model"
+require_relative "imagekitio/internal/type/base_page"
+require_relative "imagekitio/internal/type/request_parameters"
+require_relative "imagekitio/internal"
+require_relative "imagekitio/request_options"
+require_relative "imagekitio/file_part"
+require_relative "imagekitio/errors"
+require_relative "imagekitio/internal/transport/base_client"
+require_relative "imagekitio/internal/transport/pooled_net_requester"
+require_relative "imagekitio/client"
+require_relative "imagekitio/models/accounts/origin_request"
+require_relative "imagekitio/models/accounts/url_endpoint_request"
+require_relative "imagekitio/models/update_file_request"
+require_relative "imagekitio/models/file"
+require_relative "imagekitio/models/src_options"
+require_relative "imagekitio/models/base_overlay"
+require_relative "imagekitio/models/base_webhook_event"
+require_relative "imagekitio/models/accounts/origin_create_params"
+require_relative "imagekitio/models/accounts/origin_delete_params"
+require_relative "imagekitio/models/accounts/origin_get_params"
+require_relative "imagekitio/models/accounts/origin_list_params"
+require_relative "imagekitio/models/accounts/origin_list_response"
+require_relative "imagekitio/models/accounts/origin_response"
+require_relative "imagekitio/models/accounts/origin_update_params"
+require_relative "imagekitio/models/accounts/url_endpoint_create_params"
+require_relative "imagekitio/models/accounts/url_endpoint_delete_params"
+require_relative "imagekitio/models/accounts/url_endpoint_get_params"
+require_relative "imagekitio/models/accounts/url_endpoint_list_params"
+require_relative "imagekitio/models/accounts/url_endpoint_list_response"
+require_relative "imagekitio/models/accounts/url_endpoint_response"
+require_relative "imagekitio/models/accounts/url_endpoint_update_params"
+require_relative "imagekitio/models/accounts/usage_get_params"
+require_relative "imagekitio/models/accounts/usage_get_response"
+require_relative "imagekitio/models/asset_list_params"
+require_relative "imagekitio/models/asset_list_response"
+require_relative "imagekitio/models/beta/v2/file_upload_params"
+require_relative "imagekitio/models/beta/v2/file_upload_response"
+require_relative "imagekitio/models/cache/invalidation_create_params"
+require_relative "imagekitio/models/cache/invalidation_create_response"
+require_relative "imagekitio/models/cache/invalidation_get_params"
+require_relative "imagekitio/models/cache/invalidation_get_response"
+require_relative "imagekitio/models/custom_metadata_field"
+require_relative "imagekitio/models/custom_metadata_field_create_params"
+require_relative "imagekitio/models/custom_metadata_field_delete_params"
+require_relative "imagekitio/models/custom_metadata_field_delete_response"
+require_relative "imagekitio/models/custom_metadata_field_list_params"
+require_relative "imagekitio/models/custom_metadata_field_list_response"
+require_relative "imagekitio/models/custom_metadata_field_update_params"
+require_relative "imagekitio/models/extensions"
+require_relative "imagekitio/models/file_copy_params"
+require_relative "imagekitio/models/file_copy_response"
+require_relative "imagekitio/models/file_delete_params"
+require_relative "imagekitio/models/file_get_params"
+require_relative "imagekitio/models/file_move_params"
+require_relative "imagekitio/models/file_move_response"
+require_relative "imagekitio/models/file_rename_params"
+require_relative "imagekitio/models/file_rename_response"
+require_relative "imagekitio/models/files/bulk_add_tags_params"
+require_relative "imagekitio/models/files/bulk_add_tags_response"
+require_relative "imagekitio/models/files/bulk_delete_params"
+require_relative "imagekitio/models/files/bulk_delete_response"
+require_relative "imagekitio/models/files/bulk_remove_ai_tags_params"
+require_relative "imagekitio/models/files/bulk_remove_ai_tags_response"
+require_relative "imagekitio/models/files/bulk_remove_tags_params"
+require_relative "imagekitio/models/files/bulk_remove_tags_response"
+require_relative "imagekitio/models/files/metadata_get_from_url_params"
+require_relative "imagekitio/models/files/metadata_get_params"
+require_relative "imagekitio/models/files/version_delete_params"
+require_relative "imagekitio/models/files/version_delete_response"
+require_relative "imagekitio/models/files/version_get_params"
+require_relative "imagekitio/models/files/version_list_params"
+require_relative "imagekitio/models/files/version_list_response"
+require_relative "imagekitio/models/files/version_restore_params"
+require_relative "imagekitio/models/file_update_params"
+require_relative "imagekitio/models/file_update_response"
+require_relative "imagekitio/models/file_upload_params"
+require_relative "imagekitio/models/file_upload_response"
+require_relative "imagekitio/models/folder"
+require_relative "imagekitio/models/folder_copy_params"
+require_relative "imagekitio/models/folder_copy_response"
+require_relative "imagekitio/models/folder_create_params"
+require_relative "imagekitio/models/folder_create_response"
+require_relative "imagekitio/models/folder_delete_params"
+require_relative "imagekitio/models/folder_delete_response"
+require_relative "imagekitio/models/folder_move_params"
+require_relative "imagekitio/models/folder_move_response"
+require_relative "imagekitio/models/folder_rename_params"
+require_relative "imagekitio/models/folder_rename_response"
+require_relative "imagekitio/models/folders/job_get_params"
+require_relative "imagekitio/models/folders/job_get_response"
+require_relative "imagekitio/models/get_image_attributes_options"
+require_relative "imagekitio/models/image_overlay"
+require_relative "imagekitio/models/metadata"
+require_relative "imagekitio/models/overlay"
+require_relative "imagekitio/models/overlay_position"
+require_relative "imagekitio/models/overlay_timing"
+require_relative "imagekitio/models/responsive_image_attributes"
+require_relative "imagekitio/models/solid_color_overlay"
+require_relative "imagekitio/models/solid_color_overlay_transformation"
+require_relative "imagekitio/models/streaming_resolution"
+require_relative "imagekitio/models/subtitle_overlay"
+require_relative "imagekitio/models/subtitle_overlay_transformation"
+require_relative "imagekitio/models/text_overlay"
+require_relative "imagekitio/models/text_overlay_transformation"
+require_relative "imagekitio/models/transformation"
+require_relative "imagekitio/models/transformation_position"
+require_relative "imagekitio/models/unsafe_unwrap_webhook_event"
+require_relative "imagekitio/models/unwrap_webhook_event"
+require_relative "imagekitio/models/upload_post_transform_error_event"
+require_relative "imagekitio/models/upload_post_transform_success_event"
+require_relative "imagekitio/models/upload_pre_transform_error_event"
+require_relative "imagekitio/models/upload_pre_transform_success_event"
+require_relative "imagekitio/models/video_overlay"
+require_relative "imagekitio/models/video_transformation_accepted_event"
+require_relative "imagekitio/models/video_transformation_error_event"
+require_relative "imagekitio/models/video_transformation_ready_event"
+require_relative "imagekitio/models/webhook_unsafe_unwrap_params"
+require_relative "imagekitio/models/webhook_unwrap_params"
+require_relative "imagekitio/models"
+require_relative "imagekitio/resources/accounts"
+require_relative "imagekitio/resources/accounts/origins"
+require_relative "imagekitio/resources/accounts/url_endpoints"
+require_relative "imagekitio/resources/accounts/usage"
+require_relative "imagekitio/resources/assets"
+require_relative "imagekitio/resources/beta"
+require_relative "imagekitio/resources/beta/v2"
+require_relative "imagekitio/resources/beta/v2/files"
+require_relative "imagekitio/resources/cache"
+require_relative "imagekitio/resources/cache/invalidation"
+require_relative "imagekitio/resources/custom_metadata_fields"
+require_relative "imagekitio/resources/files"
+require_relative "imagekitio/resources/files/bulk"
+require_relative "imagekitio/resources/files/metadata"
+require_relative "imagekitio/resources/files/versions"
+require_relative "imagekitio/resources/folders"
+require_relative "imagekitio/resources/folders/job"
+require_relative "imagekitio/resources/webhooks"
+require_relative "imagekitio/helpers/helper"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/imagekitio/client.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Imagekitio
+  class Client < Imagekitio::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    # Your ImageKit private API key (starts with `private_`). You can find this in the
+    # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
+    sig { returns(String) }
+    attr_reader :private_key
+
+    # ImageKit uses your API key as username and ignores the password. The SDK sets a
+    # dummy value. You can ignore this field.
+    sig { returns(T.nilable(String)) }
+    attr_reader :password
+
+    sig { returns(Imagekitio::Resources::CustomMetadataFields) }
+    attr_reader :custom_metadata_fields
+
+    sig { returns(Imagekitio::Resources::Files) }
+    attr_reader :files
+
+    sig { returns(Imagekitio::Resources::Assets) }
+    attr_reader :assets
+
+    sig { returns(Imagekitio::Resources::Cache) }
+    attr_reader :cache
+
+    sig { returns(Imagekitio::Resources::Folders) }
+    attr_reader :folders
+
+    sig { returns(Imagekitio::Resources::Accounts) }
+    attr_reader :accounts
+
+    sig { returns(Imagekitio::Resources::Beta) }
+    attr_reader :beta
+
+    sig { returns(Imagekitio::Resources::Webhooks) }
+    attr_reader :webhooks
+
+    sig { returns(Imagekitio::Helper) }
+    attr_reader :helper
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # @api private
+    sig { returns(T::Boolean) }
+    def base_url_overridden?
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        private_key: T.nilable(String),
+        password: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Your ImageKit private API key (starts with `private_`). You can find this in the
+      # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults
+      # to `ENV["IMAGEKIT_PRIVATE_KEY"]`
+      private_key: ENV["IMAGEKIT_PRIVATE_KEY"],
+      # ImageKit uses your API key as username and ignores the password. The SDK sets a
+      # dummy value. You can ignore this field. Defaults to
+      # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
+      password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`
+      base_url: ENV["IMAGE_KIT_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Imagekitio::Client::DEFAULT_MAX_RETRIES,
+      timeout: Imagekitio::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Imagekitio::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Imagekitio::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/imagekitio/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Imagekitio
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Imagekitio::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < Imagekitio::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < Imagekitio::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < Imagekitio::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < Imagekitio::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/imagekitio/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Imagekitio
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end

data/rbi/imagekitio/helpers/helper.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Imagekitio
+  class Helper
+    sig { params(client: Imagekitio::Client).void }
+    def initialize(client:)
+    end
+
+    # Builds a URL with transformations applied
+    sig { params(options: Imagekitio::Models::SrcOptions).returns(String) }
+    def build_url(options)
+    end
+
+    # Generates transformation string from transformation objects
+    sig do
+      params(
+        transformations: T::Array[Imagekitio::Models::Transformation]
+      ).returns(String)
+    end
+    def build_transformation_string(transformations)
+    end
+
+    # Generates authentication parameters for client-side file uploads
+    sig do
+      params(token: T.nilable(String), expire: T.nilable(Integer)).returns(
+        T::Hash[Symbol, T.any(String, Integer)]
+      )
+    end
+    def get_authentication_parameters(token = nil, expire = nil)
+    end
+
+    # Generates responsive image attributes for use in HTML <img> tags
+    sig do
+      params(options: Imagekitio::Models::GetImageAttributesOptions).returns(
+        Imagekitio::Models::ResponsiveImageAttributes
+      )
+    end
+    def get_responsive_image_attributes(options)
+    end
+  end
+end