discorb 0.17.1 → 0.18.0

data/sig/discorb/color.rbs

@@ -0,0 +1,142 @@
+module Discorb
+  #
+  # Represents RGB color.
+  class Color
+    #
+    # Create a color from a Integer.
+    #
+    # @param [Integer] value A color value.
+    def initialize: (Integer value) -> void
+
+    #
+    # Integerize a color.
+    #
+    # @return [Integer] A color value.
+    def to_i: -> Integer
+
+    #
+    # Convert a color to a hexadecimal value.
+    #
+    # @return [String] A hexadecimal value.
+    def to_hex: -> String
+
+    #
+    # Convert a color to RGB array.
+    #
+    # @return [Array(Integer, Integer, Integer)] A RGB array.
+    def to_rgb: -> [Integer, Integer, Integer]
+
+    alias to_a to_rgb
+    alias deconstruct to_rgb
+
+    #
+    # Convert a color to RGB hash.
+    #
+    # @return [Hash{:r, :g, :b => Integer}] A RGB hash.
+    def to_rgb_hash: -> { r: Integer, g: Integer, b: Integer }
+
+    alias deconstruct_keys to_rgb_hash
+
+    #
+    # Converts a color to a `#000000` string.
+    #
+    # @return [String] Converted string.
+    def to_s: -> String
+
+    def inspect: -> String
+
+    #
+    # Create a color from a hexadecimal string.
+    #
+    # @param [String] hex A hexadecimal string.
+    #
+    # @return [Discorb::Color] A color object.
+    def self.from_hex: (String hex) -> Discorb::Color
+
+    #
+    # Create a color from a RGB array.
+    #
+    # @param [Integer] red A red value.
+    # @param [Integer] green A green value.
+    # @param [Integer] blue A blue value.
+    #
+    # @return [Discorb::Color] A color object.
+    def self.from_rgb: (
+      Integer red,
+      Integer green,
+      Integer blue
+    ) -> Discorb::Color
+
+    #
+    # Create a color from a Discord's color.
+    # Currently these colors are supported:
+    #
+    # | Color Name | Hexadecimal |
+    # |------------|------------|
+    # | `:teal` | `#1abc9c` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
+    #
+    # @param [Symbol] color A Discord color name.
+    #
+    # @return [Discorb::Color] A color object.
+    def self.[]: (Symbol color) -> Discorb::Color
+
+    # Returns the value of attribute value.
+    attr_accessor value: untyped
+  end
+end

data/sig/discorb/component/base.rbs

@@ -0,0 +1,28 @@
+module Discorb
+  #
+  # @abstract
+  # Represents a Discord component.
+  class Component
+    def inspect: -> String
+
+    #
+    # Create a new component from hash data.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components Official Discord API documentation
+    # @param [Hash] data Hash data.
+    #
+    # @return [Component] A new component.
+    def self.from_hash: (Discorb::json data) -> Component
+
+    #
+    # Convert components to a hash.
+    #
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components Components.
+    #
+    # @return [Array<Hash>] Hash data.
+    def self.to_payload: (
+      ::Array[Discorb::Component]
+      | ::Array[::Array[Discorb::Component]] components
+    ) -> Discorb::json
+  end
+end

data/sig/discorb/component/button.rbs

@@ -0,0 +1,65 @@
+module Discorb
+  #
+  # Represents a button component.
+  class Button < Discorb::Component
+    STYLES: untyped
+
+    #
+    # Initialize a new button.
+    #
+    # @param [String] label The label of the button.
+    # @param [:primary, :secondary, :success, :danger, :link] style The style of the button.
+    # @param [Discorb::emoji] emoji The emoji of the button.
+    # @param [String] custom_id The custom ID of the button.
+    # @param [String] url The URL of the button.
+    # @param [Boolean] disabled Whether the button is disabled.
+    def initialize: (
+      String label,
+      ?Symbol style,
+      ?emoji: Discorb::emoji?,
+      ?custom_id: String?,
+      ?url: String?,
+      ?disabled: bool
+    ) -> void
+
+    #
+    # Converts the button to a hash.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components#button-object-button-structure
+    #  Official Discord API docs
+    # @return [Hash] A hash representation of the button.
+    def to_hash: -> Discorb::json
+
+    def inspect: -> String
+
+    #
+    # Creates a new button from a hash.
+    #
+    # @param [Hash] data The hash to create the button from.
+    #
+    # @return [Discorb::Button] The created button.
+    def self.from_hash: (Discorb::json data) -> Discorb::Button
+
+    # @return [String] The label of the button.
+    attr_accessor label: String
+
+    # @return [:primary, :secondary, :success, :danger, :link] The style of the button.
+    attr_accessor style: Symbol
+
+    # @return [Discorb::emoji] The emoji of the button.
+    attr_accessor emoji: Discorb::emoji?
+
+    # @return [String] The custom ID of the button.
+    #   Won't be used if the style is `:link`.
+    attr_accessor custom_id: String?
+
+    # @return [String] The URL of the button.
+    #   Only used when the style is `:link`.
+    attr_accessor url: String?
+
+    # @return [Boolean] Whether the button is disabled.
+    attr_accessor disabled: bool
+
+    alias disabled? disabled
+  end
+end

data/sig/discorb/component/select_menu.rbs

@@ -0,0 +1,107 @@
+module Discorb
+  #
+  # Represents a select menu component.
+  class SelectMenu < Discorb::Component
+    #
+    # Initialize a new select menu.
+    #
+    # @param [String, Symbol] custom_id Custom ID of the select menu.
+    # @param [Array<Discorb::SelectMenu::Option>] options The options of the select menu.
+    # @param [String] placeholder The placeholder of the select menu.
+    # @param [Integer] min_values The minimum number of values.
+    # @param [Integer] max_values The maximum number of values.
+    def initialize: (
+      String | Symbol custom_id,
+      ::Array[Discorb::SelectMenu::Option] options,
+      ?placeholder: String?,
+      ?min_values: Integer,
+      ?max_values: Integer
+    ) -> void
+
+    #
+    # Converts the select menu to a hash.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure
+    #   Official Discord API docs
+    # @return [Hash] A hash representation of the select menu.
+    def to_hash: -> Discorb::json
+
+    def inspect: -> String
+
+    #
+    # Creates a new select menu from a hash.
+    #
+    # @param [Hash] data The hash to create the select menu from.
+    #
+    # @return [Discorb::SelectMenu] The created select menu.
+    def self.from_hash: (Discorb::json data) -> Discorb::SelectMenu
+
+    # @return [String] The custom ID of the select menu.
+    attr_accessor custom_id: String | Symbol
+
+    # @return [Array<SelectMenu::Option>] The options of the select menu.
+    attr_accessor options: ::Array[SelectMenu::Option]
+
+    # @return [Integer] The minimum number of values.
+    attr_accessor min_values: Integer
+
+    # @return [Integer] The maximum number of values.
+    attr_accessor max_values: Integer
+
+    # @return [Boolean] Whether the select menu is disabled.
+    attr_accessor disabled: bool
+
+    #
+    # Represents an option of a select menu.
+    class Option
+      #
+      # Initialize a new option.
+      #
+      # @param [String] label The label of the option.
+      # @param [String] value The value of the option.
+      # @param [String] description The description of the option.
+      # @param [Discorb::emoji] emoji The emoji of the option.
+      # @param [Boolean] default Whether the option is default.
+      def initialize: (
+        String label,
+        String value,
+        ?description: String?,
+        ?emoji: Discorb::emoji?,
+        ?default: bool
+      ) -> void
+
+      #
+      # Converts the option to a hash.
+      #
+      # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure
+      #   Official Discord API docs
+      # @return [Hash] Hash representation of the option.
+      def to_hash: -> Discorb::json
+
+      def inspect: -> String
+
+      #
+      # Creates a new option from a hash.
+      #
+      # @param [Hash] data A hash representing the option.
+      #
+      # @return [Discorb::SelectMenu::Option] A new option.
+      def self.from_hash: (Discorb::json data) -> Discorb::SelectMenu::Option
+
+      # @return [String] The label of the option.
+      attr_accessor label: String
+
+      # @return [String] The value of the option.
+      attr_accessor value: String
+
+      # @return [String] The description of the option.
+      attr_accessor description: String?
+
+      # @return [Discorb::emoji] The emoji of the option.
+      attr_accessor emoji: Discorb::emoji?
+
+      # @return [Boolean] Whether the option is default.
+      attr_accessor default: bool
+    end
+  end
+end

data/sig/discorb/component/text_input.rbs

@@ -0,0 +1,69 @@
+module Discorb
+  #
+  # Represents a text input component.
+  class TextInput < Discorb::Component
+    STYLES: untyped
+
+    #
+    # Initialize a new text input component.
+    #
+    # @param [String] label The label of the text input.
+    # @param [String] custom_id The custom id of the text input.
+    # @param [:short, :paragraph] style The style of the text input.
+    # @param [Integer, nil] min_length The minimum length of the text input.
+    # @param [Integer, nil] max_length The maximum length of the text input.
+    # @param [Boolean] required Whether the text input is required.
+    # @param [String, nil] value The prefilled value of the text input.
+    # @param [String, nil] placeholder The placeholder of the text input.
+    def initialize: (
+      String label,
+      String custom_id,
+      Symbol style,
+      ?min_length: Integer?,
+      ?max_length: Integer?,
+      ?required: bool,
+      ?value: String?,
+      ?placeholder: String?
+    ) -> void
+
+    #
+    # Converts the select menu to a hash.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure
+    #   Official Discord API docs
+    # @return [Hash] A hash representation of the text input.
+    def to_hash: -> Discorb::json
+
+    #
+    # Creates a new text input from a hash.
+    #
+    # @param [Hash] data The hash to create the text input from.
+    #
+    # @return [Discorb::TextInput] The created text input.
+    def self.from_hash: (Discorb::json data) -> Discorb::TextInput
+
+    # @return [String] The label of the text input.
+    attr_accessor label: String
+
+    # @return [String] The custom id of the text input.
+    attr_accessor custom_id: String
+
+    # @return [:short, :paragraph] The style of the text input.
+    attr_accessor style: Symbol
+
+    # @return [Integer, nil] The minimum length of the text input.
+    attr_accessor min_length: Integer?
+
+    # @return [Integer, nil] The maximum length of the text input.
+    attr_accessor max_length: Integer?
+
+    # @return [Boolean] Whether the text input is required.
+    attr_accessor required: bool
+
+    # @return [String, nil] The prefilled value of the text input.
+    attr_accessor value: String?
+
+    # @return [String, nil] The placeholder of the text input.
+    attr_accessor placeholder: String?
+  end
+end

data/sig/discorb/connectable.rbs

@@ -0,0 +1,8 @@
+module Discorb
+  #
+  # Module for connecting to a voice channel.
+  # This will be discord-voice gem.
+  module Connectable
+    def connect: -> untyped
+  end
+end

data/sig/discorb/custom_emoji.rbs

@@ -0,0 +1,90 @@
+module Discorb
+  # Represents a custom emoji in discord.
+  class CustomEmoji < Discorb::Emoji
+    #
+    # Initialize a new custom emoji.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that owns this emoji.
+    # @param [Discorb::Guild] guild The guild that owns this emoji.
+    # @param [Hash] data The data of the emoji.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::Guild guild,
+      Discorb::json data
+    ) -> void
+
+    #
+    # Format the emoji for sending.
+    #
+    # @return [String] the formatted emoji.
+    def to_s: -> String
+
+    #
+    # Format the emoji for URI.
+    #
+    # @return [String] the formatted emoji.
+    def to_uri: -> String
+
+    def inspect: -> String
+
+    #
+    # Edit the emoji.
+    # @async
+    # @macro edit
+    #
+    # @param [String] name The new name of the emoji.
+    # @param [Array<Discorb::Role>] roles The new roles that can use this emoji.
+    # @param [String] reason The reason for editing the emoji.
+    #
+    # @return [Async::Task<self>] The edited emoji.
+    def edit: (
+      ?name: String,
+      ?roles: ::Array[Discorb::Role],
+      ?reason: String?
+    ) -> Async::Task[self]
+
+    #
+    # Delete the emoji.
+    # @async
+    #
+    # @param [String] reason The reason for deleting the emoji.
+    #
+    # @return [Async::Task<self>] The deleted emoji.
+    def delete!: (?reason: String?) -> Async::Task[self]
+
+    #
+    # Converts the object to a hash.
+    # @private
+    #
+    # @return [Hash] The hash represents the object.
+    def to_hash: -> Discorb::json
+
+    # @return [Discorb::Snowflake] The ID of the emoji.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the emoji.
+    attr_reader name: String
+
+    # @return [Array<Discorb::Role>] The roles that can use this emoji.
+    attr_reader roles: ::Array[Discorb::Role]
+
+    # @return [Discorb::User] The user that created this emoji.
+    attr_reader user: Discorb::User
+
+    # @return [Discorb::Guild] The guild that owns this emoji.
+    attr_reader guild: Discorb::Guild
+
+    # @return [Boolean] whether the emoji is managed by integration (ex: Twitch).
+    attr_reader managed: bool
+
+    # @return [Boolean] whether the emoji requires colons.
+    attr_reader require_colons: bool
+
+    # @return [Boolean] whether the emoji is available.
+    attr_reader available: bool
+
+    # @return [Boolean] whether or not this emoji is restricted to certain roles.
+    attr_reader roles?: bool
+  end
+end

data/sig/discorb/dictionary.rbs

@@ -0,0 +1,85 @@
+module Discorb
+  #
+  # Extended hash class. This is used for storing pair of ID and object.
+  class Dictionary[K < _ToS, V] < Array[V]
+    #
+    # Initialize a new Dictionary.
+    #
+    # @param [Hash] hash A hash of items to add to the dictionary.
+    # @param [Integer] limit The maximum number of items in the dictionary.
+    # @param [false, Proc] sort Whether to sort the items in the dictionary.
+    def initialize: (
+      ?::Hash[untyped, untyped] hash,
+      ?limit: Integer?,
+      ?sort: bool | Proc
+    ) -> void
+
+    #
+    # Registers a new item in the dictionary.
+    #
+    # @param [#to_s] id The ID of the item.
+    # @param [Object] body The item to register.
+    #
+    # @return [self] The dictionary.
+    def register: (_ToS id, Object body) -> self
+
+    alias []= register
+
+    #
+    # Merges another dictionary into this one.
+    #
+    # @param [Discorb::Dictionary] other The dictionary to merge.
+    def merge: (Discorb::Dictionary[untyped, untyped] other) -> untyped
+
+    #
+    # Removes an item from the dictionary.
+    #
+    # @param [#to_s] id The ID of the item to remove.
+    def remove: (_ToS id) -> untyped
+
+    #
+    # Get an item from the dictionary.
+    #
+    # @param [#to_s] id The ID of the item.
+    # @return [Object] The item.
+    # @return [nil] if the item was not found.
+    #
+    # @overload get(index)
+    #   @param [Integer] index The index of the item.
+    #
+    #   @return [Object] The item.
+    #   @return [nil] if the item is not found.
+    def get: (_ToS id) -> V | (Integer index) -> V
+
+    alias [] get
+
+    #
+    # Returns the values of the dictionary.
+    #
+    # @return [Array] The values of the dictionary.
+    def values: -> ::Array[V]
+
+    #
+    # Checks if the dictionary has an ID.
+    #
+    # @param [#to_s] id The ID to check.
+    #
+    # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
+    def has?: (_ToS id) -> bool
+
+    #
+    # Send a message to the array of values.
+    def method_missing: (untyped name) -> untyped
+
+    def respond_to_missing?: (
+      untyped name,
+      untyped args,
+      untyped kwargs
+    ) -> bool
+
+    def inspect: -> String
+
+    # @return [Integer] The maximum number of items in the dictionary.
+    attr_accessor limit: Integer?
+  end
+end

data/sig/discorb/discord_model.rbs

@@ -0,0 +1,15 @@
+module Discorb
+  #
+  # @abstract
+  # Represents Discord model.
+  class DiscordModel
+    def eql?: (untyped other) -> bool
+
+    def ==: (untyped other) -> untyped
+
+    def inspect: -> String
+
+    # @private
+    def hash: -> untyped
+  end
+end