1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//! # Input Block //! //! [slack api docs 🔗] //! //! A block that collects information from users - //! //! Read [slack's guide to using modals 🔗] //! to learn how input blocks pass information to your app. //! //! [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#input //! [slack's guide to using modals 🔗]: https://api.slack.com/surfaces/modals/using#gathering_input use std::borrow::Cow; use serde::{Deserialize, Serialize}; use validator::Validate; use crate::{compose::text, convert, elems, elems::{select, BlockElement}, val_helpr::ValidationResult}; /// # Input Block /// /// [slack api docs 🔗] /// /// A block that collects information from users - /// /// Read [slack's guide to using modals 🔗] /// to learn how input blocks pass information to your app. /// /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#input /// [slack's guide to using modals 🔗]: https://api.slack.com/surfaces/modals/using#gathering_input #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct Input<'a> { #[validate(custom = "validate::label")] label: text::Text, element: SupportedElement<'a>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "super::validate_block_id")] block_id: Option<Cow<'a, str>>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "validate::hint")] hint: Option<text::Text>, #[serde(skip_serializing_if = "Option::is_none")] dispatch_action: Option<bool>, #[serde(skip_serializing_if = "Option::is_none")] optional: Option<bool>, } impl<'a> Input<'a> { /// Build a new input block /// /// For example, see `blocks::input::build::InputBuilder`. pub fn builder() -> build::InputBuilderInit<'a> { build::InputBuilderInit::new() } /// Create an Input Block from a text Label and interactive element. /// /// # Arguments /// /// - `label` - A label that appears above an input element in the form of /// a [text object 🔗] that must have type of `plain_text`. /// Maximum length for the text in this field is 2000 characters. /// /// - `element` - An interactive `block_element` that will be used to gather /// the input for this block. /// For the kinds of Elements supported by /// Input blocks, see the `SupportedElement` enum. /// For info about Block Elements in general, /// see the `elems` module. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Example /// ``` /// use slack_blocks::elems::Select; /// use slack_blocks::blocks; /// /// let label = "On a scale from 1 - 5, how angsty are you?"; /// let input = Select::from_placeholder_and_action_id("Pick a channel...", "ABC123") /// .choose_from_public_channels(); /// /// let block = blocks::Input::from_label_and_element(label, input); /// /// // < send to slack API > /// ``` pub fn from_label_and_element(label: impl Into<text::Plain>, element: impl Into<SupportedElement<'a>>) -> Self { Input { label: label.into().into(), element: element.into(), block_id: None, hint: None, dispatch_action: None, optional: None } } /// Set a unique `block_id` to identify this instance of an Input Block. /// /// # Arguments /// /// - `block_id` - A string acting as a unique identifier for a block. /// You can use this `block_id` when you receive an interaction /// payload to [identify the source of the action 🔗]. /// If not specified, one will be generated. /// Maximum length for this field is 255 characters. /// `block_id` should be unique for each message and each iteration of a message. /// If a message is updated, use a new `block_id`. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads /// /// # Example /// ``` /// use slack_blocks::elems::Select; /// use slack_blocks::blocks; /// /// let label = "On a scale from 1 - 5, how angsty are you?"; /// let input = Select::from_placeholder_and_action_id("Pick a channel...", "ABC123") /// .choose_from_public_channels(); /// /// let block = blocks::Input /// ::from_label_and_element(label, input) /// .with_block_id("angst_rating_12345"); /// /// // < send to slack API > /// ``` pub fn with_block_id(mut self, block_id: impl Into<Cow<'a, str>>) -> Self { self.block_id = Some(block_id.into()); self } /// Set the `hint` on this Input Block that appears below /// an input element in a lighter grey. /// /// # Arguments /// /// - `hint` - An optional hint that appears below an input element /// in a lighter grey. /// It must be a a [text object 🔗] with a `type` of `plain_text`. /// Maximum length for the `text` in this field is 2000 characters. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Example /// ``` /// use slack_blocks::elems::Select; /// use slack_blocks::blocks; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// let label = "On a scale from 1 - 5, how angsty are you?"; /// let input = Select::from_placeholder_and_action_id("Pick a channel...", "ABC123") /// .choose_from_public_channels(); /// /// let block = blocks::Input /// ::from_label_and_element(label, input) /// .with_hint("PSST hey! Don't let them know how angsty you are!"); /// /// // < send to slack API > /// # Ok(()) /// # } /// ``` pub fn with_hint(mut self, hint: impl Into<text::Plain>) -> Self { self.hint = Some(hint.into().into()); self } /// Set whether or not this input is Optional. /// /// # Arguments /// - `optionality` - A boolean that indicates whether the input /// element may be empty when a user submits the modal. /// Defaults to false. /// /// # Example /// ``` /// use slack_blocks::elems::Select; /// use slack_blocks::blocks; /// /// let label = "On a scale from 1 - 5, how angsty are you?"; /// let input = Select::from_placeholder_and_action_id("Pick a channel...", "ABC123") /// .choose_from_public_channels(); /// /// let block = blocks::Input /// ::from_label_and_element(label, input) /// .with_hint("PSST hey! Don't even answer that!") /// .with_optional(true); /// /// // < send to slack API > /// ``` pub fn with_optional(mut self, optionality: bool) -> Self { self.optional = Some(optionality); self } /// Will allow the elements in this block to dispatch block_actions payloads. Defaults to false. pub fn dispatch_block_actions(mut self) -> Self { self.dispatch_action = Some(true); self } /// Validate that this Input block agrees with Slack's model requirements /// /// # Errors /// - If `from_label_and_element` was passed a Text object longer /// than 2000 chars /// - If `with_hint` was called with a block id longer /// than 2000 chars /// - If `with_block_id` was called with a block id longer /// than 256 chars /// /// # Example /// ``` /// use slack_blocks::elems::Select; /// use slack_blocks::blocks; /// /// let label = "On a scale from 1 - 5, how angsty are you?"; /// let input = Select::from_placeholder_and_action_id("Pick a channel...", "ABC123") /// .choose_from_public_channels(); /// let long_string = std::iter::repeat(' ').take(2001).collect::<String>(); /// /// let block = blocks::Input /// ::from_label_and_element(label, input) /// .with_block_id(long_string); /// /// assert_eq!(true, matches!(block.validate(), Err(_))); /// /// // < send to slack API > /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } /// Input block builder pub mod build { use std::marker::PhantomData; use super::*; use crate::build::*; /// Compile-time markers for builder methods #[allow(non_camel_case_types)] pub mod method { /// InputBuilder.element #[derive(Clone, Copy, Debug)] pub struct element; /// InputBuilder.label #[derive(Clone, Copy, Debug)] pub struct label; } /// Initial state for `InputBuilder` pub type InputBuilderInit<'a> = InputBuilder<'a, RequiredMethodNotCalled<method::element>, RequiredMethodNotCalled<method::label>>; /// Build an Input block /// /// Allows you to construct safely, with compile-time checks /// on required setter methods. /// /// # Required Methods /// `InputBuilder::build()` is only available if these methods have been called: /// - `element` /// /// # Example /// ``` /// use slack_blocks::{blocks::Input, /// compose::text::ToSlackPlaintext, /// elems::TextInput}; /// /// let block = /// Input::builder().label("foo".plaintext()) /// .element(TextInput::builder().action_id("foo").build()) /// .build(); /// ``` #[derive(Debug)] pub struct InputBuilder<'a, Element, Label> { label: Option<text::Text>, element: Option<SupportedElement<'a>>, hint: Option<text::Text>, block_id: Option<Cow<'a, str>>, optional: Option<bool>, dispatch_action: Option<bool>, state: PhantomData<(Element, Label)>, } impl<'a, E, L> InputBuilder<'a, E, L> { /// Create a new InputBuilder pub fn new() -> Self { Self { label: None, element: None, hint: None, block_id: None, optional: None, dispatch_action: None, state: PhantomData::<_> } } /// Set `element` (**Required**) /// /// An interactive `block_element` that will be used to gather /// the input for this block. /// /// For the kinds of Elements supported by /// Input blocks, see the `SupportedElement` enum. pub fn element<El>(self, element: El) -> InputBuilder<'a, Set<method::element>, L> where El: Into<SupportedElement<'a>> { InputBuilder { label: self.label, element: Some(element.into()), hint: self.hint, block_id: self.block_id, optional: self.optional, dispatch_action: self.dispatch_action, state: PhantomData::<_> } } /// Set `label` (**Required**) /// /// A label that appears above an input element in the form of /// a [text object 🔗] that must have type of `plain_text`. /// /// Maximum length for the text in this field is 2000 characters. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text pub fn label<T>(self, label: T) -> InputBuilder<'a, E, Set<method::label>> where T: Into<text::Plain> { InputBuilder { label: Some(label.into().into()), element: self.element, hint: self.hint, block_id: self.block_id, optional: self.optional, dispatch_action: self.dispatch_action, state: PhantomData::<_> } } /// Set `block_id` (Optional) /// /// A string acting as a unique identifier for a block. /// /// You can use this `block_id` when you receive an interaction payload /// to [identify the source of the action 🔗]. /// /// If not specified, a `block_id` will be generated. /// /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads pub fn block_id<S>(mut self, block_id: S) -> Self where S: Into<Cow<'a, str>> { self.block_id = Some(block_id.into()); self } } impl<'a> InputBuilder<'a, Set<method::element>, Set<method::label>> { /// All done building, now give me a darn actions block! /// /// > `no method name 'build' found for struct 'InputBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `InputBuilder`. /// /// ```compile_fail /// use slack_blocks::blocks::Input; /// /// let foo = Input::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::{blocks::Input, /// compose::text::ToSlackPlaintext, /// elems::TextInput}; /// /// let block = /// Input::builder().label("foo".plaintext()) /// .element(TextInput::builder().action_id("foo").build()) /// .build(); /// ``` pub fn build(self) -> Input<'a> { Input { element: self.element.unwrap(), label: self.label.unwrap(), hint: self.hint, dispatch_action: self.dispatch_action, optional: self.optional, block_id: self.block_id } } } } /// The Block Elements supported in an Input Block. /// /// Supports: /// - Radio Buttons /// - Text Input /// - Checkboxes /// - Date Picker /// - All Select Menus /// - All Multi-Select Menus #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)] pub struct SupportedElement<'a>(BlockElement<'a>); convert!(impl<'a> From<elems::Radio<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<elems::TextInput<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<elems::Checkboxes<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<elems::DatePicker<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::Static<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::External<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::User<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::Conversation<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::PublicChannel<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::multi::Static<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::multi::External<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::multi::User<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::multi::Conversation<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); convert!(impl<'a> From<select::multi::PublicChannel<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r))); mod validate { use crate::{compose::text, val_helpr::{below_len, ValidatorResult}}; pub(super) fn label(text: &text::Text) -> ValidatorResult { below_len("Input Label", 2000, text.as_ref()) } pub(super) fn hint(text: &text::Text) -> ValidatorResult { below_len("Input Hint", 2000, text.as_ref()) } }