discorb 0.17.1 → 0.19.0

data/sig/discorb/app_command/base.rbs

@@ -0,0 +1,288 @@
+module Discorb
+  #
+  # Handles application commands.
+  module ApplicationCommand
+    VALID_LOCALES: untyped
+    type option =
+      {
+        name_localizations: Hash[(Symbol | String), String]?,
+        description: localizable?,
+        required: bool?,
+        optional: bool?,
+        default: untyped?,
+        type: (singleton(String)
+        | :string
+        | :str
+        | singleton(Integer)
+        | :integer
+        | :int
+        | singleton(TrueClass)
+        | singleton(FalseClass)
+        | :boolean
+        | :bool
+        | singleton(Discorb::User)
+        | singleton(Discorb::Member)
+        | :user
+        | :member
+        | singleton(Discorb::Channel)
+        | :channel
+        | singleton(Discorb::Role)
+        | :role
+        | :mentionable
+        | singleton(Float)
+        | :float
+        | :attachment)?,
+        choices: Hash[String, (String | Integer | Float)]?,
+        choices_localizations: Hash[String, Hash[(Symbol | String), String]]?,
+        channel_types: Array[Class]?,
+        autocomplete: (^(Discorb::CommandInteraction) -> Hash[String, String])?,
+        range: Range[(Integer | Float)]?
+      }
+    type options = ::Hash[String, option]
+    type localizable = String | Hash[Symbol | String, String]
+    type guild_ids = Array[_ToS] | false | nil
+
+    def self?.modify_localization_hash: (
+      Hash[Symbol | String, String] hash
+    ) -> Hash[String, String]
+
+    #
+    # Represents a application command.
+    # @abstract
+    class Command < Discorb::DiscordModel
+      TYPES: Hash[Integer, Symbol]
+
+      #
+      # Initialize a new command.
+      # @private
+      #
+      # @param [String, Hash{Symbol => String}] name The name of the command.
+      # @param [Array<#to_s>, false, nil] guild_ids The guild ids that the command is enabled in.
+      # @param [Proc] block The block of the command.
+      # @param [Integer] type The type of the command.
+      # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      def initialize: (
+        Discorb::ApplicationCommand::localizable name,
+        Discorb::ApplicationCommand::guild_ids guild_ids,
+        ^(Discorb::Interaction, *untyped) -> untyped block,
+        Integer `type`,
+        ?bool? dm_permission,
+        ?Discorb::Permission? default_permission
+      ) -> void
+
+      #
+      # Changes the self pointer of block to the given object.
+      # @private
+      #
+      # @param [Object] instance The object to change the self pointer to.
+      def replace_block: (Object `instance`) -> untyped
+
+      #
+      # Converts the object to a hash.
+      # @private
+      #
+      # @return [Hash] The hash represents the object.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
+      # @return [Hash{String => String}] The name of the command.
+      attr_reader name: ::Hash[String, String]
+
+      # @return [Array<#to_s>] The guild ids that the command is enabled in.
+      attr_reader guild_ids: Discorb::ApplicationCommand::guild_ids
+
+      # @return [Proc] The block of the command.
+      attr_reader block: ^(Discorb::Interaction, *untyped) -> untyped
+
+      # @return [:chat_input, :user, :message] The type of the command.
+      attr_reader type: Symbol
+
+      # @return [Integer] The raw type of the command.
+      attr_reader type_raw: Integer
+
+      # @return [Discorb::Permission] The default permissions for this command.
+      attr_reader default_permission: Discorb::Permission?
+
+      # @return [Boolean] Whether the command is enabled in DMs.
+      attr_reader dm_permission: bool?
+
+      #
+      # Represents the slash command.
+      class ChatInputCommand < Discorb::ApplicationCommand::Command
+        #
+        # Initialize a new slash command.
+        # @private
+        #
+        # @param [String, Hash{Symbol => String}] name The name of the command.
+        #   The hash should have `default`, and language keys.
+        # @param [String, Hash{Symbol => String}] description The description of the command.
+        #   The hash should have `default`, and language keys.
+        # @param [Hash{String => Hash}] options The options of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Proc] block The block of the command.
+        # @param [Integer] type The type of the command.
+        # @param [Discorb::ApplicationCommand::Command, nil] parent The parent command.
+        # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+        # @param [Discorb::Permission] default_permission The default permission of the command.
+        def initialize: (
+          Discorb::ApplicationCommand::localizable name,
+          Discorb::ApplicationCommand::localizable description,
+          Discorb::ApplicationCommand::options options,
+          Discorb::ApplicationCommand::guild_ids guild_ids,
+          ^(
+            Discorb::CommandInteraction::ChatInputCommand,
+            *untyped
+          ) -> untyped block,
+          Integer `type`,
+          Discorb::ApplicationCommand::Command? parent,
+          bool? dm_permission,
+          Discorb::Permission? default_permission
+        ) -> void
+
+        #
+        # Returns the commands name.
+        #
+        # @return [String] The name of the command.
+        %a{pure}
+        def to_s: -> String
+
+        #
+        # Converts the object to a hash.
+        # @private
+        #
+        # @return [Hash] The hash represents the object.
+        %a{pure}
+        def to_hash: -> Discorb::json
+
+        # @return [Hash{String => String}] The description of the command.
+        attr_reader description: ::Hash[String, String]
+
+        # @return [Hash{String => Hash}] The options of the command.
+        attr_reader options: ::Hash[String, ::Hash[untyped, untyped]]
+      end
+
+      #
+      # Represents the command with subcommands.
+      class GroupCommand < Discorb::ApplicationCommand::Command
+        #
+        # Initialize a new group command.
+        # @private
+        #
+        # @param [String, Hash{Symbol => String}] name The name of the command.
+        # @param [String, Hash{Symbol => String}] description The description of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Discorb::Client] client The client of the command.
+        # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+        # @param [Discorb::Permission] default_permission The default permission of the command.
+        def initialize: (
+          Discorb::ApplicationCommand::localizable name,
+          Discorb::ApplicationCommand::localizable description,
+          Discorb::ApplicationCommand::guild_ids guild_ids,
+          Discorb::Client client,
+          bool? dm_permission,
+          Discorb::Permission? default_permission
+        ) -> void
+
+        #
+        # Add new subcommand.
+        #
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] The added subcommand.
+        def slash: (
+          String | ::Hash[Symbol, String] command_name,
+          String | ::Hash[Symbol, String] description,
+          ?Discorb::ApplicationCommand::options options,
+          ?dm_permission: bool,
+          ?default_permission: Discorb::Permission?
+        ) {
+          (Discorb::CommandInteraction::ChatInputCommand, *untyped) -> void
+        } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+        #
+        # Add new subcommand group.
+        #
+        # @param [String] command_name Group name.
+        # @param [String] description Group description.
+        #
+        # @yield Block to yield with the command.
+        # @yieldparam [Discorb::ApplicationCommand::Command::SubcommandGroup] group Group command.
+        #
+        # @return [Discorb::ApplicationCommand::Command::SubcommandGroup] Command object.
+        #
+        # @see file:docs/application_command.md Application Commands
+        def group: (
+          String command_name,
+          String description
+        ) ?{
+          (Discorb::ApplicationCommand::Command::SubcommandGroup group) -> void
+        } -> Discorb::ApplicationCommand::Command::SubcommandGroup
+
+        #
+        # Returns the command name.
+        #
+        # @return [String] The command name.
+        %a{pure}
+        def to_s: -> String
+
+        #
+        # Changes the self pointer to the given object.
+        # @private
+        #
+        # @param [Object] instance The object to change to.
+        def block_replace: (Object `instance`) -> untyped
+
+        #
+        # Converts the object to a hash.
+        # @private
+        #
+        # @return [Hash] The hash represents the object.
+        %a{pure}
+        def to_hash: -> Discorb::json
+
+        # @return [Array<Discorb::ApplicationCommand::Command>] The subcommands of the command.
+        attr_reader commands: ::Array[Discorb::ApplicationCommand::Command]
+
+        # @return [String] The description of the command.
+        attr_reader description: ::Hash[String, String]
+      end
+
+      #
+      # Represents the subcommand group.
+      class SubcommandGroup < Discorb::ApplicationCommand::Command::GroupCommand
+        #
+        # Initialize a new subcommand group.
+        # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Discorb::ApplicationCommand::Command::GroupCommand] parent The parent command.
+        # @param [Discorb::Client] client The client.
+        def initialize: (
+          String name,
+          String description,
+          Discorb::ApplicationCommand::Command::GroupCommand parent,
+          Discorb::Client client
+        ) -> void
+
+        %a{pure}
+        def to_s: -> untyped
+
+        #
+        # Add new subcommand.
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] The added subcommand.
+        def slash: (
+          Discorb::ApplicationCommand::localizable command_name,
+          Discorb::ApplicationCommand::localizable description,
+          ?Discorb::ApplicationCommand::options options
+        ) {
+          (Discorb::CommandInteraction::ChatInputCommand, *untyped) -> void
+        } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+        # @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand>] The subcommands of the command.
+        attr_reader commands: ::Array[Discorb::ApplicationCommand::Command]
+      end
+    end
+  end
+end

data/sig/discorb/app_command/handler.rbs

@@ -0,0 +1,171 @@
+module Discorb
+  module ApplicationCommand
+    #
+    # Module to handle application commands.
+    module Handler
+      #
+      # Add new top-level command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      #  If hash is passed, it must be a pair of Language code and Command name, and `:default` key is required.
+      #  You can use `_` instead of `-` in language code.
+      # @param [String, Hash{Symbol => String}] description Command description.
+      #   If hash is passed, it must be a pair of Language code and Command description, and `:default` key is required.
+      #  You can use `_` instead of `-` in language code.
+      # @param [Hash{String => Hash{:description => String, :optional => Boolean, :type => Object}}] options
+      #  Command options.
+      #   The key is the option name, the value is a hash with the following keys:
+      #
+      #   | Key | Type | Description |
+      #   | --- | --- | --- |
+      #   | `:name_localizations` | Hash{Symbol => String} | Localizations of option name. |
+      #   | `:description` | `String` \| `Hash{Symbol => String}` |
+      #     Description of the option. If hash is passed, it must be a pair of Language code and description,
+      #     and `:default` key is required. You can use `_` instead of `-` in language code. |
+      #   | `:required` | Boolean(true | false) |
+      #     Whether the argument is required. `optional` will be used if not specified. |
+      #   | `:optional` | Boolean(true | false) |
+      #     Whether the argument is optional. `required` will be used if not specified. |
+      #   | `:type` | `Object` | Type of the option. |
+      #   | `:choices` | `Hash{String => String, Integer, Float}` | Type of the option. |
+      #   | `:choices_localizations` | `Hash{String => Hash{Symbol => String}}` |
+      #      Localization of the choice. Key must be the name of a choice. |
+      #   | `:default` | `Object` | Default value of the option. |
+      #   | `:channel_types` | `Array<Class<Discorb::Channel>>` | Type of the channel option. |
+      #   | `:autocomplete` | `Proc` | Autocomplete function. |
+      #   | `:range` | `Range` | Range of the option. Only valid for numeric options. (`:int`, `:float`) |
+      #
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      #
+      # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] Command object.
+      #
+      # @see file:docs/application_command.md#register-slash-command Application Comamnds: Register Slash Command
+      # @see file:docs/cli/setup.md CLI: setup
+      def slash: (
+        Discorb::ApplicationCommand::localizable command_name,
+        Discorb::ApplicationCommand::localizable description,
+        ?Discorb::ApplicationCommand::options options,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) {
+        (
+          Discorb::CommandInteraction::ChatInputCommand interaction,
+          *untyped
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+      #
+      # Add new command with group.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [String, Hash{Symbol => String}] description Command description.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      #
+      # @yield Block to yield with the command.
+      # @yieldparam [Discorb::ApplicationCommand::Command::GroupCommand] group Group command.
+      #
+      # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
+      #
+      # @see file:docs/application_command.md Application Commands
+      # @see file:docs/cli/setup.md CLI: setup
+      def slash_group: (
+        Discorb::ApplicationCommand::localizable command_name,
+        Discorb::ApplicationCommand::localizable description,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) ?{
+        (Discorb::ApplicationCommand::Command::GroupCommand group) -> void
+      } -> Discorb::ApplicationCommand::Command::GroupCommand
+
+      #
+      # Add message context menu command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      # @yield [interaction, message] Block to execute.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::Message] message Message object.
+      #
+      # @return [Discorb::ApplicationCommand::Command] Command object.
+      def message_command: (
+        Discorb::ApplicationCommand::localizable command_name,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) {
+        (
+          Discorb::CommandInteraction::UserMenuCommand interaction,
+          Discorb::Message message
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command
+
+      #
+      # Add user context menu command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      # @yield [interaction, user] Block to execute.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::User] user User object.
+      #
+      # @return [Discorb::ApplicationCommand::Command] Command object.
+      def user_command: (
+        Discorb::ApplicationCommand::localizable command_name,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) ?{
+        (
+          Discorb::CommandInteraction::UserMenuCommand interaction,
+          Discorb::User user
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command
+
+      #
+      # Setup commands.
+      # @async
+      # @see Client#initialize
+      #
+      # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to use as default. If `false` is given, it will be global command.
+      #
+      # @note `token` parameter only required if you don't run client.
+      def setup_commands: (
+        ?String? token,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?
+      ) -> untyped
+
+      #
+      # Claer commands in specified guilds.
+      # @async
+      # @see Client#initialize
+      #
+      # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to clear.
+      #
+      # @note `token` parameter only required if you don't run client.
+      def clear_commands: (
+        String token,
+        Discorb::ApplicationCommand::guild_ids guild_ids
+      ) -> untyped
+    end
+  end
+end

data/sig/discorb/application.rbs

@@ -0,0 +1,146 @@
+module Discorb
+  #
+  # Represents a Discord application.
+  class Application < Discorb::DiscordModel
+    #
+    # Initializes a new instance of the Application class.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    %a{pure}
+    def inspect: -> String
+
+    # @return [Discorb::Snowflake] The application's ID.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The application's name.
+    attr_reader name: String
+
+    # @return [Discorb::Asset] The application's icon.
+    attr_reader icon: Discorb::Asset
+
+    # @return [String] The application's description.
+    attr_reader description: String
+
+    # @return [String] The application's summary.
+    attr_reader summary: String
+
+    # @return [String] The application's public key.
+    attr_reader verify_key: String
+
+    # @return [Discorb::User] The application's owner.
+    attr_reader owner: Discorb::User
+
+    # @return [Discorb::Application::Team] The application's team.
+    attr_reader team: Discorb::Application::Team
+
+    # @return [Boolean] Whether the application's bot is public.
+    attr_reader bot_public: bool
+
+    # @return [Boolean] Whether the application's bot requires a code grant.
+    attr_reader bot_require_code_grant: bool
+
+    # @return [Discorb::Application::Flag] The application's flags.
+    attr_reader flags: Discorb::Application::Flag
+
+    #
+    # Represents a flag for an application.
+    # ## Flag fields
+    #
+    # | Field|Value|
+    # |---|---|
+    # | `1 << 12` | `:gateway_presence` |
+    # | `1 << 13` | `:gateway_presence_limited` |
+    # | `1 << 14` | `:gateway_guild_members` |
+    # | `1 << 15` | `:gateway_guild_members_limited` |
+    # | `1 << 16` | `:verification_pending_guild_limit` |
+    # | `1 << 17` | `:embedded` |
+    # | `1 << 18` | `:gateway_message_content` |
+    # | `1 << 19` | `:gateway_message_content_limited` |
+    class Flag < Discorb::Flag
+      attr_accessor gateway_presence: bool
+      attr_accessor gateway_presence_limited: bool
+      attr_accessor gateway_guild_members: bool
+      attr_accessor gateway_guild_members_limited: bool
+      attr_accessor verification_pending_guild_limit: bool
+      attr_accessor embedded: bool
+      attr_accessor gateway_message_content: bool
+      attr_accessor gateway_message_content_limited: bool
+    end
+
+    #
+    # Represents a team for an application.
+    class Team < Discorb::DiscordModel
+      #
+      # Initializes a new instance of the Team class.
+      # @private
+      #
+      # @param [Discorb::Client] client The client that instantiated the object.
+      # @param [Hash] data The data of the object.
+      def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+      #
+      # The team's owner.
+      #
+      # @return [Discorb::Application::Team::Member] The team's owner.
+      %a{pure}
+      def owner: -> Discorb::Application::Team::Member
+
+      %a{pure}
+      def inspect: -> String
+
+      # @return [Discorb::Snowflake] The team's ID.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [Discorb::Asset] The team's icon.
+      attr_reader icon: Discorb::Asset
+
+      # @return [String] The team's name.
+      attr_reader name: String
+
+      # @return [Discorb::Snowflake] The team's owner's ID.
+      attr_reader owner_user_id: Discorb::Snowflake
+
+      # @return [Discorb::Application::Team::Member] The team's member.
+      attr_reader members: Discorb::Application::Team::Member
+
+      #
+      # Represents a member of team.
+      class Member < Discorb::DiscordModel
+        MEMBERSHIP_STATE: untyped
+
+        def initialize: (untyped client, untyped team, untyped data) -> void
+
+        %a{pure}
+        def inspect: -> String
+
+        def ==: (untyped other) -> untyped
+
+        # @return [Discorb::User] The user.
+        attr_reader user: Discorb::User
+
+        # @return [Snowflake] The ID of member's team.
+        attr_reader team_id: Snowflake
+
+        # @return [:invited, :accepted] The member's membership state.
+        attr_reader membership_state: Symbol
+
+        # @return [Array<Symbol>] The permissions of the member.
+        # @note This always return `:*`.
+        attr_reader permissions: ::Array[Symbol]
+
+        # @return [Boolean] Whether the member is not joined to the team.
+        attr_reader pending?: bool
+
+        # @return [Boolean] Whether the member accepted joining the team.
+        attr_reader accepted?: bool
+
+        # @return [Boolean] Whether the member is the team's owner.
+        attr_reader owner?: bool
+      end
+    end
+  end
+end

data/sig/discorb/asset.rbs

@@ -0,0 +1,34 @@
+module Discorb
+  #
+  # Represents a single asset.
+  class Asset < Discorb::DiscordModel
+    #
+    # Initialize a new instance of the Asset class.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    def initialize: (untyped target, untyped hash, ?path: untyped) -> void
+
+    #
+    # URL of the asset.
+    #
+    # @param [String] image_format The image format.
+    # @param [Integer] size The size of the image.
+    #
+    # @return [String] URL of the asset.
+    def url: (?image_format: String?, ?size: Integer) -> String
+
+    %a{pure}
+    def inspect: -> String
+
+    %a{pure}
+    def endpoint: -> untyped
+
+    # @return [String] The hash of asset.
+    attr_reader hash: String
+
+    # @return [Boolean] Whether the asset is animated.
+    attr_reader animated?: bool
+  end
+end