slack-ruby-block-kit 0.11.0 → 0.15.0

data/lib/slack/block_kit/composition/option.rb

@@ -8,11 +8,16 @@ module Slack
       # https://api.slack.com/reference/messaging/composition-objects#option
       # https://api.slack.com/reference/messaging/block-elements#select
       class Option
-        def initialize(value:, text:, emoji: nil, description: nil, url: nil)
+        def initialize(value:, text:, initial: false, emoji: nil, description: nil, url: nil)
           @text = PlainText.new(text: text, emoji: emoji)
           @value = value
           @description = description && PlainText.new(text: description, emoji: emoji)
           @url = url
+          @initial = initial
+        end
+
+        def initial?
+          !!@initial
         end
 
         def as_json(*)

data/lib/slack/block_kit/composition/option_group.rb

@@ -17,8 +17,8 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(text:, value:, emoji: nil)
-          @options << Option.new(text: text, value: value, emoji: emoji)
+        def option(text:, value:, emoji: nil, initial: false)
+          @options << Option.new(text: text, value: value, emoji: emoji, initial: initial)
 
           self
         end

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

@@ -15,26 +15,16 @@ module Slack
         def initialize(action_id:)
           @action_id = action_id
           @options = []
-          @initial_options = []
 
           yield(self) if block_given?
         end
 
-        def option(value:, text:, description: nil)
+        def option(value:, text:, initial: false, 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
+            description: description,
+            initial: initial
           )
 
           self
@@ -45,10 +35,18 @@ module Slack
             type: TYPE,
             action_id: @action_id,
             options: @options.map(&:as_json),
-            initial_options: @initial_options.any? ? @initial_options.map(&:as_json) : nil,
+            initial_options: initial_options&.map(&:as_json),
             confirm: confirm&.as_json
           }.compact
         end
+
+        private
+
+        def initial_options
+          initial = @options.select(&:initial?)
+
+          initial.empty? ? nil : initial
+        end
       end
     end
   end

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

@@ -17,12 +17,7 @@ module Slack
         def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil)
           @action_id = action_id
           @initial_date = initial
-          if placeholder
-            @placeholder = Composition::PlainText.new(
-              text: placeholder,
-              emoji: emoji
-            )
-          end
+          @placeholder = placeholder_text(placeholder, emoji)
 
           yield(self) if block_given?
         end
@@ -36,6 +31,14 @@ module Slack
             confirm: confirm&.as_json
           }.compact
         end
+
+        private
+
+        def placeholder_text(text, emoji)
+          return unless text
+
+          Composition::PlainText.new(text: text, emoji: emoji)
+        end
       end
     end
   end

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

@@ -17,7 +17,7 @@ module Slack
 
         TYPE = 'multi_static_select'
 
-        attr_accessor :options, :option_groups, :initial_options
+        attr_accessor :options, :option_groups
 
         def initialize(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -26,17 +26,17 @@ module Slack
 
           @options = nil
           @option_groups = nil
-          @initial_options = nil
 
           yield(self) if block_given?
         end
 
-        def option(value:, text:, emoji: nil)
+        def option(value:, text:, initial: false, emoji: nil)
           @options ||= []
           @options << Composition::Option.new(
             value: value,
             text: text,
-            emoji: emoji
+            emoji: emoji,
+            initial: initial
           )
 
           self
@@ -53,17 +53,6 @@ module Slack
           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,
@@ -71,11 +60,21 @@ module Slack
             action_id: @action_id,
             options: @options&.map(&:as_json),
             option_groups: @option_groups&.map(&:as_json),
-            initial_options: @initial_options&.map(&:as_json),
+            initial_options: initial_options&.map(&:as_json),
             confirm: confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact
         end
+
+        private
+
+        def initial_options
+          all_options = options || option_groups&.flat_map(&:options)
+
+          initial = all_options&.select(&:initial?)
+
+          initial&.empty? ? nil : initial
+        end
       end
     end
   end

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

@@ -28,6 +28,15 @@ module Slack
           @multiline = multiline
           @min_length = min_length
           @max_length = max_length
+          @dispatch_action_config = nil
+        end
+
+        def dispatch_action_config(triggers: nil)
+          @dispatch_action_config = Composition::DispatchActionConfiguration.new(triggers: triggers)
+
+          yield(@dispatch_action_config) if block_given?
+
+          self
         end
 
         def as_json(*)
@@ -38,7 +47,8 @@ module Slack
             multiline: @multiline,
             min_length: @min_length,
             max_length: @max_length,
-            initial_value: @initial_value
+            initial_value: @initial_value,
+            dispatch_action_config: @dispatch_action_config&.as_json
           }.compact
         end
       end

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

@@ -11,10 +11,11 @@ module Slack
 
         TYPE = 'radio_buttons'
 
-        attr_accessor :options, :initial_option
+        attr_accessor :options
 
         def initialize(action_id:)
           @action_id = action_id
+          @options = []
 
           yield(self) if block_given?
         end
@@ -22,14 +23,12 @@ module Slack
         def option(value:, text:, initial: false)
           option = Composition::Option.new(
             value: value,
-            text: text
+            text: text,
+            initial: initial
           )
 
-          @options ||= []
           @options << option
 
-          @initial_option = option if initial
-
           self
         end
 
@@ -37,11 +36,17 @@ module Slack
           {
             type: TYPE,
             action_id: @action_id,
-            options: @options&.map(&:as_json),
-            initial_option: @initial_option&.as_json,
+            options: @options.map(&:as_json),
+            initial_option: initial_option&.as_json,
             confirm: confirm&.as_json
           }.compact
         end
+
+        private
+
+        def initial_option
+          @options&.find(&:initial?)
+        end
       end
     end
   end

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

@@ -17,7 +17,7 @@ module Slack
 
         TYPE = 'static_select'
 
-        attr_accessor :options, :option_groups, :initial_option
+        attr_accessor :options, :option_groups
 
         def initialize(placeholder:, action_id:, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -26,12 +26,13 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(value:, text:, emoji: nil)
+        def option(value:, text:, initial: false, emoji: nil)
           @options ||= []
           @options << Composition::Option.new(
             value: value,
             text: text,
-            emoji: emoji
+            emoji: emoji,
+            initial: initial
           )
 
           self
@@ -48,27 +49,27 @@ module Slack
           self
         end
 
-        def initial(value:, text:, emoji: nil)
-          @initial_option = 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_option: @initial_option&.as_json,
+            options: options&.map(&:as_json),
+            option_groups: option_groups&.map(&:as_json),
+            initial_option: initial_option&.as_json,
             confirm: confirm&.as_json
           }.compact
         end
+
+        private
+
+        def initial_option
+          opts = options || option_groups&.flat_map(&:options)
+
+          return unless opts
+
+          opts.find(&:initial?)
+        end
       end
     end
   end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # An element which allows selection of a time of day.
+      #
+      # On desktop clients, this time picker will take the form of a dropdown
+      # list with free-text entry for precise choices. On mobile clients, the
+      # time picker will use native time picker UIs.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#timepicker
+      class Timepicker
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'timepicker'
+
+        def initialize(action_id:)
+          @placeholder, @initial_time = nil
+          @action_id = action_id
+
+          yield(self) if block_given?
+        end
+
+        def placeholder(text:, emoji: nil)
+          @placeholder = Composition::PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def initial_time(time_str)
+          @initial_time = time_str
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            placeholder: @placeholder&.as_json,
+            initial_time: @initial_time,
+            confirm: confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/header.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A header is a plain-text block that displays in a larger, bold font.
+      # Use it to delineate between different groups of content in your app's
+      # surfaces.
+      #
+      # https://api.slack.com/reference/block-kit/blocks#header
+      class Header
+        TYPE = 'header'
+
+        def initialize(text:, block_id: nil, emoji: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
+          @block_id = block_id
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text.as_json,
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/input.rb

@@ -4,8 +4,8 @@ module Slack
   module BlockKit
     module Layout
       # A block that collects information from users - it can hold a plain-text
-      # input element, a select menu element, a multi-select menu element, or a
-      # datepicker.
+      # input element, a checkbox element, a radio button element,
+      # a select menu element, a multi-select menu element, or a datepicker.
       #
       # https://api.slack.com/reference/block-kit/blocks#input
       class Input
@@ -15,17 +15,212 @@ module Slack
 
         def initialize(
           label:,
-          element:,
+          element: nil,
           block_id: nil,
           hint: nil,
           optional: nil,
-          emoji: nil
+          emoji: nil,
+          dispatch_action: nil
         )
           @label = Composition::PlainText.new(text: label, emoji: emoji) if label
           @hint = Composition::PlainText.new(text: hint, emoji: emoji) if hint
           @block_id = block_id
           @optional = optional
           @element = element
+          @dispatch_action = dispatch_action
+        end
+
+        def conversation_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          @element = Element::ConversationsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def multi_conversations_select(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @element = Element::MultiConversationsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji,
+            max_selected_items: max_selected_items
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def channels_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          @element = Element::ChannelsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def checkboxes(action_id:)
+          @element = Element::Checkboxes.new(action_id: action_id)
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def datepicker(action_id:, placeholder: nil, initial: nil, emoji: nil)
+          @element = Element::DatePicker.new(
+            action_id: action_id,
+            placeholder: placeholder,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def multi_channels_select(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @element = Element::MultiChannelsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji,
+            max_selected_items: max_selected_items
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def static_select(placeholder:, action_id:, emoji: nil)
+          @element = Element::StaticSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def multi_static_select(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
+          @element = Element::MultiStaticSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji,
+            max_selected_items: max_selected_items
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+          @element = Element::ExternalSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            min_query_length: min_query_length,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def multi_external_select(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          min_query_length: nil,
+          emoji: nil,
+          max_selected_items: nil
+        )
+          @element = Element::MultiExternalSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            min_query_length: min_query_length,
+            emoji: emoji,
+            max_selected_items: max_selected_items
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def plain_text_input(
+          action_id:,
+          placeholder: nil,
+          emoji: nil,
+          initial_value: nil,
+          multiline: nil,
+          min_length: nil,
+          max_length: nil
+        )
+          @element = Element::PlainTextInput.new(
+            action_id: action_id,
+            placeholder: placeholder,
+            emoji: emoji,
+            initial_value: initial_value,
+            multiline: multiline,
+            min_length: min_length,
+            max_length: max_length
+          )
+
+          self
+        end
+
+        def radio_buttons(action_id:)
+          @element = Element::RadioButtons.new(action_id: action_id)
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def users_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          @element = Element::UsersSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(@element) if block_given?
+
+          self
+        end
+
+        def multi_users_select(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @element = Element::MultiUsersSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji,
+            max_selected_items: max_selected_items
+          )
+
+          yield(@element) if block_given?
+
+          self
         end
 
         def as_json(*)
@@ -35,7 +230,8 @@ module Slack
             label: @label&.as_json,
             hint: @hint&.as_json,
             block_id: @block_id,
-            optional: optional
+            optional: optional,
+            dispatch_action: @dispatch_action
           }.compact
         end
       end