factorix 0.5.0

data/sig/factorix/http/retry_strategy.rbs

@@ -0,0 +1,42 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module HTTP
+    # Class that manages retry strategy with exponential backoff and randomization
+    class RetryStrategy
+      attr_reader logger: Dry::Logger::Dispatcher
+
+      type retry_callback = ^(StandardError exception, Integer try, Float elapsed_time, Float next_interval) -> void
+
+      type retry_options = {
+        tries: Integer,
+        base_interval: Float,
+        multiplier: Float,
+        rand_factor: Float,
+        on: Array[Class],
+        on_retry: retry_callback
+      }
+
+      # Initialize a new retry strategy with customizable options
+      #
+      # @param options [Hash] Options for retry behavior
+      # @option options [Integer] :tries Number of attempts (including the initial try)
+      # @option options [Float] :base_interval Initial interval between retries (seconds)
+      # @option options [Float] :multiplier Exponential backoff multiplier
+      # @option options [Float] :rand_factor Randomization factor
+      # @option options [Array<Class>] :on Exception classes to retry on
+      # @option options [Proc] :on_retry Callback called on each retry
+      def initialize: (?logger: Dry::Logger::Dispatcher?, **untyped options) -> void
+
+      # Execute the block with automatic retry on specified exceptions.
+      # Uses exponential backoff with randomization for retry intervals
+      #
+      # @yield Block to execute
+      # @return [Object] Return value of the block
+      # @raise [StandardError] If the block fails after all retries
+      def with_retry: [T] () { () -> T } -> T
+    end
+  end
+end

data/sig/factorix/info_json.rbs

@@ -0,0 +1,19 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class InfoJSON < Data
+    attr_reader name: String
+    attr_reader version: MODVersion
+    attr_reader title: String
+    attr_reader author: String
+    attr_reader description: String
+    attr_reader factorio_version: String?
+    attr_reader dependencies: Array[Factorix::Dependency::Entry]
+
+    def self.from_json: (String json_string) -> InfoJSON
+    def self.from_hash: (Hash[String, untyped] data) -> InfoJSON
+    def self.from_zip: (Pathname | String zip_path) -> InfoJSON
+  end
+end

data/sig/factorix/installed_mod.rbs

@@ -0,0 +1,34 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class InstalledMOD
+    include Comparable
+
+    ZIP_FORM: Symbol
+
+    DIRECTORY_FORM: Symbol
+
+    def self.from_zip: (Pathname path) -> InstalledMOD
+
+    def self.from_directory: (Pathname path) -> InstalledMOD
+
+    # Enumerable class methods
+    def self.all: () -> Array[InstalledMOD]
+    def self.each: () { (InstalledMOD) -> void } -> Array[InstalledMOD]
+                 | () -> Enumerator[InstalledMOD, Array[InstalledMOD]]
+
+    attr_reader mod: MOD
+    attr_reader version: MODVersion
+    attr_reader form: Symbol
+    attr_reader path: Pathname
+    attr_reader info: InfoJSON
+
+    def <=>: (InstalledMOD other) -> Integer?
+
+    def base?: () -> bool
+
+    def expansion?: () -> bool
+  end
+end

data/sig/factorix/mod.rbs

@@ -0,0 +1,20 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  # Represents a local MOD
+  class MOD < Data
+    include Comparable
+
+    attr_reader name: String
+
+    def base?: () -> bool
+
+    def expansion?: () -> bool
+
+    def to_s: () -> String
+
+    def <=>: (untyped other) -> Integer?
+  end
+end

data/sig/factorix/mod_list.rbs

@@ -0,0 +1,44 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  # Represents a list of MODs and their enabled status
+  class MODList
+    include Enumerable[[MOD, MODState]]
+
+    # Raised when a MOD is not found in the list
+    class MODNotInListError < Factorix::MODNotFoundError
+    end
+
+    @mods: Hash[MOD, MODState]
+
+    def self.load: (?Pathname path) -> MODList
+
+    def initialize: (?Hash[MOD, MODState] mods) -> void
+
+    def save: (?Pathname path) -> void
+
+    def each: () -> Enumerator[[MOD, MODState], self]
+            | () { ([MOD, MODState]) -> void } -> self
+
+    def each_mod: () -> Enumerator[MOD, self]
+                | () { (MOD) -> void } -> self
+
+    alias each_key each_mod
+
+    def add: (MOD mod, ?enabled: bool, ?version: MODVersion?) -> void
+
+    def remove: (MOD mod) -> void
+
+    def exist?: (MOD mod) -> bool
+
+    def enabled?: (MOD mod) -> bool
+
+    def version: (MOD mod) -> MODVersion?
+
+    def enable: (MOD mod) -> void
+
+    def disable: (MOD mod) -> void
+  end
+end

data/sig/factorix/mod_settings.rbs

@@ -0,0 +1,47 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class MODSettings
+    VALID_SECTIONS: Array[String]
+
+    class Section
+      include Enumerable[[ String, untyped ]]
+
+      @name: String
+      @settings: Hash[String, untyped]
+
+      def initialize: (String name) -> void
+      def name: () -> String
+      def []=: (String key, untyped value) -> untyped
+      def []: (String key) -> untyped
+      def each: () -> Enumerator[[String, untyped], self]
+              | () { ([String, untyped]) -> void } -> self
+      def empty?: () -> bool
+      def key?: (String key) -> bool
+      def has_key?: (String key) -> bool
+      def include?: (String key) -> bool
+      def keys: () -> Array[String]
+      def values: () -> Array[untyped]
+      def size: () -> Integer
+      def length: () -> Integer
+      def fetch: (String key) -> untyped
+               | (String key, untyped default) -> untyped
+               | (String key) { (String) -> untyped } -> untyped
+      def to_h: () -> Hash[String, untyped]
+    end
+
+    @sections: Hash[String, Section]
+    @game_version: GameVersion
+
+    def self.load: (?Pathname path) -> MODSettings
+
+    def initialize: (GameVersion game_version, Hash[String, Section] sections) -> void
+    def game_version: () -> GameVersion
+    def []: (String name) -> Section
+    def each_section: () -> Enumerator[Section, self]
+                    | () { (Section) -> void } -> self
+    def save: (?Pathname path) -> void
+  end
+end

data/sig/factorix/mod_state.rbs

@@ -0,0 +1,18 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  # Represents the state of a MOD in a MOD list
+  class MODState < Data
+    attr_reader enabled: bool
+
+    attr_reader version: MODVersion?
+
+    def initialize: (enabled: bool, ?version: MODVersion?) -> void
+
+    def self.[]: (enabled: bool, ?version: MODVersion?) -> MODState
+
+    def enabled?: () -> bool
+  end
+end

data/sig/factorix/mod_version.rbs

@@ -0,0 +1,23 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class MODVersion
+    include Comparable
+
+    attr_reader major: Integer
+    attr_reader minor: Integer
+    attr_reader patch: Integer
+
+    def self.from_string: (String str) -> MODVersion
+
+    def self.from_numbers: (Integer major, Integer minor, Integer patch) -> MODVersion
+
+    def to_s: () -> String
+
+    def to_a: () -> Array[Integer]
+
+    def <=>: (MODVersion other) -> Integer?
+  end
+end

data/sig/factorix/portal.rbs

@@ -0,0 +1,37 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Portal
+    def list_mods: (
+                     *String namelist,
+                     ?hide_deprecated: bool?,
+                     ?page: Integer?,
+                     ?page_size: (Integer | String)?,
+                     ?sort: ("name" | "created_at" | "updated_at")?,
+                     ?sort_order: ("asc" | "desc")?,
+                     ?version: ("0.13" | "0.14" | "0.15" | "0.16" | "0.17" | "0.18" | "1.0" | "1.1" | "2.0")?
+                   ) -> Array[API::MODInfo]
+
+    def get_mod: (String name) -> API::MODInfo
+
+    def get_mod_full: (String name) -> API::MODInfo
+
+    def download_mod: (API::Release release, Pathname output) -> void
+
+    def upload_mod: (String mod_name, Pathname file_path, **untyped metadata) -> void
+
+    def edit_mod: (String mod_name, **untyped metadata) -> void
+
+    def add_mod_image: (String mod_name, Pathname image_file) -> API::Image
+
+    def edit_mod_images: (String mod_name, Array[String] image_ids) -> void
+
+    attr_reader mod_portal_api: API::MODPortalAPI
+
+    attr_reader mod_download_api: API::MODDownloadAPI
+
+    attr_reader mod_management_api: API::MODManagementAPI
+  end
+end

data/sig/factorix/progress/download_handler.rbs

@@ -0,0 +1,19 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class DownloadHandler
+      def initialize: (Presenter | PresenterAdapter presenter) -> void
+
+      def on_download_started: (Hash[Symbol, untyped] event) -> void
+
+      def on_download_progress: (Hash[Symbol, untyped] event) -> void
+
+      def on_download_completed: (Hash[Symbol, untyped] event) -> void
+
+      def on_cache_hit: (Hash[Symbol, untyped] event) -> void
+    end
+  end
+end

data/sig/factorix/progress/multi_presenter.rbs

@@ -0,0 +1,15 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class MultiPresenter
+      def initialize: (?title: String, ?output: IO) -> void
+
+      def register: ((String | Symbol) name, title: String) -> PresenterAdapter
+
+      def []: ((String | Symbol) name) -> PresenterAdapter?
+    end
+  end
+end

data/sig/factorix/progress/presenter.rbs

@@ -0,0 +1,17 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class Presenter
+      def initialize: (?title: String, ?output: IO) -> void
+
+      def start: (total: Integer, ?format: String?) -> void
+
+      def update: (Integer current) -> void
+
+      def finish: () -> void
+    end
+  end
+end

data/sig/factorix/progress/presenter_adapter.rbs

@@ -0,0 +1,17 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class PresenterAdapter
+      def initialize: (TTY::ProgressBar tty_bar, Mutex mutex) -> void
+
+      def start: (total: Integer, ?format: String?) -> void
+
+      def update: (Integer current) -> void
+
+      def finish: () -> void
+    end
+  end
+end

data/sig/factorix/progress/scan_handler.rbs

@@ -0,0 +1,16 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class ScanHandler
+      @presenter: Presenter | PresenterAdapter
+
+      def initialize: (Presenter | PresenterAdapter presenter) -> void
+      def on_scan_started: (Hash[Symbol, untyped] event) -> void
+      def on_scan_progress: (Hash[Symbol, untyped] event) -> void
+      def on_scan_completed: (Hash[Symbol, untyped] event) -> void
+    end
+  end
+end

data/sig/factorix/progress/upload_handler.rbs

@@ -0,0 +1,17 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module Progress
+    class UploadHandler
+      def initialize: (Presenter | PresenterAdapter presenter) -> void
+
+      def on_upload_started: (Hash[Symbol, untyped] event) -> void
+
+      def on_upload_progress: (Hash[Symbol, untyped] event) -> void
+
+      def on_upload_completed: (Hash[Symbol, untyped] event) -> void
+    end
+  end
+end

data/sig/factorix/runtime/base.rbs

@@ -0,0 +1,45 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    class Base
+      def executable_path: () -> Pathname
+
+      def user_dir: () -> Pathname
+
+      def mods_dir: () -> Pathname
+
+      def mod_list_path: () -> Pathname
+
+      def mod_settings_path: () -> Pathname
+
+      def player_data_path: () -> Pathname
+
+      def xdg_cache_home_dir: () -> Pathname
+
+      def xdg_config_home_dir: () -> Pathname
+
+      def xdg_data_home_dir: () -> Pathname
+
+      def xdg_state_home_dir: () -> Pathname
+
+      def factorix_cache_dir: () -> Pathname
+
+      def factorix_config_path: () -> Pathname
+
+      def factorix_log_path: () -> Pathname
+
+      def lock_path: () -> Pathname
+
+      def current_log_path: () -> Pathname
+
+      def previous_log_path: () -> Pathname
+
+      def running?: () -> bool
+
+      def launch: (*String, async: bool) -> void
+    end
+  end
+end

data/sig/factorix/runtime/linux.rbs

@@ -0,0 +1,15 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    class Linux < Base
+      def executable_path: () -> Pathname
+
+      def user_dir: () -> Pathname
+
+      def data_dir: () -> Pathname
+    end
+  end
+end

data/sig/factorix/runtime/mac_os.rbs

@@ -0,0 +1,15 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    class MacOS < Base
+      def executable_path: () -> Pathname
+
+      def user_dir: () -> Pathname
+
+      def data_dir: () -> Pathname
+    end
+  end
+end

data/sig/factorix/runtime/user_configurable.rbs

@@ -0,0 +1,13 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    module UserConfigurable
+      def executable_path: () -> Pathname
+
+      def user_dir: () -> Pathname
+    end
+  end
+end

data/sig/factorix/runtime/windows.rbs

@@ -0,0 +1,23 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    class Windows < Base
+      def initialize: (?path: WindowsPath) -> void
+
+      def executable_path: () -> Pathname
+
+      def user_dir: () -> Pathname
+
+      class WindowsPath
+        def program_files_x86: () -> Pathname
+
+        def app_data: () -> Pathname
+
+        def local_app_data: () -> Pathname
+      end
+    end
+  end
+end

data/sig/factorix/runtime/wsl.rbs

@@ -0,0 +1,19 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    class WSL < Windows
+      def initialize: (?path: WSLPath) -> void
+
+      class WSLPath
+        def program_files_x86: () -> Pathname
+
+        def app_data: () -> Pathname
+
+        def local_app_data: () -> Pathname
+      end
+    end
+  end
+end

data/sig/factorix/runtime.rbs

@@ -0,0 +1,9 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Runtime
+    def self.detect: () -> Base
+  end
+end

data/sig/factorix/save_file.rbs

@@ -0,0 +1,40 @@
+module Factorix
+  class SaveFile
+    attr_reader version: GameVersion
+    attr_reader mods: Hash[String, MODState]
+    attr_reader startup_settings: MODSettings::Section
+
+    def initialize: (version: GameVersion, mods: Hash[String, MODState], startup_settings: MODSettings::Section) -> void
+
+    LEVEL_FILE_NAMES: Array[String]
+
+    def self.load: (Pathname path) -> SaveFile
+
+    class Parser
+      @path: Pathname
+      @version: GameVersion
+      @mods: Hash[String, MODState]
+      @startup_settings: MODSettings::Section
+
+      def initialize: (Pathname path) -> void
+
+      def parse: () -> SaveFile
+
+      private
+
+      def open_level_file: () { (IO) -> untyped } -> untyped
+
+      def find_level_entry: (Zip::File zip_file, String file_name) -> Zip::Entry?
+
+      def decompress_if_needed: (IO stream) -> IO
+
+      def parse_save_header: (SerDes::Deserializer deserializer) -> void
+
+      def parse_mods: (SerDes::Deserializer deserializer) -> void
+
+      def skip_unknown_bytes: (SerDes::Deserializer deserializer) -> void
+
+      def parse_startup_settings: (SerDes::Deserializer deserializer) -> void
+    end
+  end
+end

data/sig/factorix/ser_des/deserializer.rbs

@@ -0,0 +1,49 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  module SerDes
+    class Deserializer
+      def initialize: (untyped stream) -> void
+
+      def read_bytes: (Integer length) -> String
+
+      def read_u8: () -> Integer
+
+      def read_u16: () -> Integer
+
+      def read_u32: () -> Integer
+
+      def read_optim_u16: () -> Integer
+
+      def read_optim_u32: () -> Integer
+
+      def read_u16_tuple: (Integer length) -> Array[Integer]
+
+      def read_bool: () -> bool
+
+      def read_str: () -> String
+
+      def read_str_property: () -> String
+
+      def read_double: () -> Float
+
+      def read_game_version: () -> GameVersion
+
+      def read_mod_version: () -> MODVersion
+
+      def read_long: () -> Integer
+
+      def read_unsigned_long: () -> Integer
+
+      def read_dictionary: () -> Hash[String, untyped]
+
+      def read_list: () -> Hash[String, untyped]
+
+      def read_property_tree: () -> (nil | bool | Float | String | Array[untyped] | Hash[String, untyped] | Integer)
+
+      def eof?: () -> bool
+    end
+  end
+end