slack-ruby-block-kit 0.6.1 → 0.11.0

data/lib/slack/block_kit/element/channels_select.rb

@@ -13,9 +13,9 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#channel-select
       class ChannelsSelect
-        TYPE = 'channels_select'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'channels_select'
 
         def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -25,21 +25,13 @@ module Slack
           yield(self) if block_given?
         end
 
-        def confirmation_dialog
-          @confirm = Composition::ConfirmationDialog.new
-
-          yield(@confirm) if block_given?
-
-          self
-        end
-
         def as_json(*)
           {
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
             initial_channel: @initial_channel,
-            confirm: @confirm&.as_json
+            confirm: confirm&.as_json
           }.compact
         end
       end

data/lib/slack/block_kit/element/checkboxes.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A checkbox group that allows a user to choose multiple items from
+      # a list of possible options.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#checkboxes
+      class Checkboxes
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'checkboxes'
+
+        def initialize(action_id:)
+          @action_id = action_id
+          @options = []
+          @initial_options = []
+
+          yield(self) if block_given?
+        end
+
+        def option(value:, text:, description: nil)
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            description: description
+          )
+
+          self
+        end
+
+        def initial(value:, text:, description: nil)
+          @initial_options << Composition::Option.new(
+            value: value,
+            text: text,
+            description: description
+          )
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            options: @options.map(&:as_json),
+            initial_options: @initial_options.any? ? @initial_options.map(&:as_json) : nil,
+            confirm: confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/conversations_select.rb

@@ -14,22 +14,27 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#conversation-select
       class ConversationsSelect
-        TYPE = 'conversations_select'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'conversations_select'
 
         def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_conversation = initial
+          @filter = nil
 
           yield(self) if block_given?
         end
 
-        def confirmation_dialog
-          @confirm = Composition::ConfirmationDialog.new
-
-          yield(@confirm) if block_given?
+        def filter(only: nil,
+                   exclude_external_shared_channels: nil,
+                   exclude_bot_users: nil)
+          @filter = Composition::ConversationFilter.new(
+            only: only,
+            exclude_external_shared_channels: exclude_external_shared_channels,
+            exclude_bot_users: exclude_bot_users
+          )
 
           self
         end
@@ -40,7 +45,8 @@ module Slack
             placeholder: @placeholder.as_json,
             action_id: @action_id,
             initial_conversation: @initial_conversation,
-            confirm: @confirm&.as_json
+            confirm: confirm&.as_json,
+            filter: @filter&.as_json
           }.compact
         end
       end

data/lib/slack/block_kit/element/date_picker.rb

@@ -10,6 +10,8 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#datepicker
       class DatePicker
+        include Composition::ConfirmationDialog::Confirmable
+
         TYPE = 'datepicker'
 
         def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil)
@@ -25,21 +27,13 @@ module Slack
           yield(self) if block_given?
         end
 
-        def confirmation_dialog
-          @confirm = Composition::ConfirmationDialog.new
-
-          yield(@confirm) if block_given?
-
-          self
-        end
-
         def as_json(*)
           {
             type: TYPE,
             action_id: @action_id,
             placeholder: @placeholder&.as_json,
             initial_date: @initial_date,
-            confirm: @confirm&.as_json
+            confirm: confirm&.as_json
           }.compact
         end
       end

data/lib/slack/block_kit/element/external_select.rb

@@ -19,9 +19,9 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#external-select
       class ExternalSelect
-        TYPE = 'external_select'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'external_select'
 
         def initialize(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -32,14 +32,6 @@ module Slack
           yield(self) if block_given?
         end
 
-        def confirmation_dialog
-          @confirm = Composition::ConfirmationDialog.new
-
-          yield(@confirm) if block_given?
-
-          self
-        end
-
         def as_json(*)
           {
             type: TYPE,
@@ -47,7 +39,7 @@ module Slack
             action_id: @action_id,
             initial_option: @initial_option&.as_json,
             min_query_length: @min_query_length,
-            confirm: @confirm&.as_json
+            confirm: confirm&.as_json
           }.compact
         end
       end

data/lib/slack/block_kit/element/multi_channels_select.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of public
+      # channels visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+      class MultiChannelsSelect
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'multi_channels_select'
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_channels = initial
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_channels: @initial_channels,
+            confirm: confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/multi_conversations_select.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of public and
+      # private channels, DMs, and MPIMs visible to the current user in the
+      # active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+      class MultiConversationsSelect
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'multi_conversations_select'
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_conversations = initial
+          @max_selected_items = max_selected_items
+          @filter = nil
+
+          yield(self) if block_given?
+        end
+
+        def filter(only: nil,
+                   exclude_external_shared_channels: nil,
+                   exclude_bot_users: nil)
+          @filter = Composition::ConversationFilter.new(
+            only: only,
+            exclude_external_shared_channels: exclude_external_shared_channels,
+            exclude_bot_users: exclude_bot_users
+          )
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_conversations: @initial_conversations,
+            confirm: confirm&.as_json,
+            max_selected_items: @max_selected_items,
+            filter: @filter&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/multi_external_select.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This select menu will load its options from an external data source,
+      # allowing for a dynamic list of options.
+      #
+      # Each time a select menu of this type is opened or the user starts typing
+      # in the typeahead field, we'll send a request to your specified URL. Your
+      # app should return an HTTP 200 OK response, along with an
+      # application/json post body with an object containing either an options
+      # array, or an option_groups array.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#external_multi_select
+      class MultiExternalSelect
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'multi_external_select'
+
+        def initialize(placeholder:, action_id:,
+                       initial: nil, min_query_length: nil, emoji: nil, max_selected_items: nil)
+
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_options = initial
+          @min_query_length = min_query_length
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_options: @initial_options&.map(&:as_json),
+            min_query_length: @min_query_length,
+            confirm: confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/multi_static_select.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This is the simplest form of select menu, with a static list of options
+      # passed in when defining the element.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#static_multi_select
+      class MultiStaticSelect
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'multi_static_select'
+
+        attr_accessor :options, :option_groups, :initial_options
+
+        def initialize(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @max_selected_items = max_selected_items
+
+          @options = nil
+          @option_groups = nil
+          @initial_options = nil
+
+          yield(self) if block_given?
+        end
+
+        def option(value:, text:, emoji: nil)
+          @options ||= []
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def option_group(label:, emoji: nil)
+          option_group = Composition::OptionGroup.new(label: label, emoji: emoji)
+
+          yield(option_group) if block_given?
+
+          @option_groups ||= []
+          @option_groups << option_group
+
+          self
+        end
+
+        def initial(value:, text:, emoji: nil)
+          @initial_options ||= []
+          @initial_options << Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            options: @options&.map(&:as_json),
+            option_groups: @option_groups&.map(&:as_json),
+            initial_options: @initial_options&.map(&:as_json),
+            confirm: confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/multi_users_select.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of Slack users
+      # visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#users_multi_select
+      class MultiUsersSelect
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'multi_users_select'
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_users = initial
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_users: @initial_users,
+            confirm: confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end