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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
//! # Select menu with external data source //! [slack api docs 🔗] //! //! This select menu will load its options from an external data source, //! allowing for a dynamic list of options. //! //! ## Setup //! [Slack API doc guide for setting up an external data source 🔗](https://api.slack.com/reference/block-kit/block-elements#external_select__setup) //! //! [slack api docs 🔗]: https://api.slack.com/reference/block-kit/block-elements#external_select use std::borrow::Cow; use serde::{Deserialize, Serialize}; use validator::Validate; use crate::{compose, compose::{opt::NoUrl, Confirm}, text, val_helpr::ValidationResult}; type Opt<'a> = compose::Opt<'a, text::Plain, NoUrl>; type OptGroup<'a> = compose::OptGroup<'a, text::Plain, NoUrl>; type OptOrOptGroup<'a> = compose::OptOrOptGroup<'a, text::Plain, NoUrl>; /// # Select menu with external data source /// [slack api docs 🔗] /// /// This select menu will load its options from an external data source, /// allowing for a dynamic list of options. /// /// ## Setup /// [Slack API doc guide for setting up an external data source 🔗](https://api.slack.com/reference/block-kit/block-elements#external_select__setup) /// /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/block-elements#external_select #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct External<'a> { #[validate(custom = "super::validate::placeholder")] placeholder: text::Text, #[validate(length(max = 255))] action_id: Cow<'a, str>, initial_option: Option<OptOrOptGroup<'a>>, min_query_length: Option<u64>, #[serde(skip_serializing_if = "Option::is_none")] #[validate] confirm: Option<Confirm>, } impl<'a> External<'a> { /// Build a new external select element /// /// # Examples /// ``` /// use std::convert::TryFrom; /// /// use slack_blocks::{blocks::{Actions, Block}, /// compose::Opt, /// elems::{select, BlockElement}, /// text}; /// /// let select: BlockElement = /// select::External::builder().placeholder("Choose your favorite city!") /// .action_id("fave_city") /// .build() /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// ``` pub fn builder() -> build::ExternalBuilderInit<'a> { build::ExternalBuilderInit::new() } /// Construct an External Select element, letting users choose an option from an external data source. /// /// # Arguments /// - `placeholder` - A [`plain_text` only text object 🔗] that defines /// the placeholder text shown on the menu. /// Maximum length for the `text` in this field is 150 characters. /// /// - `action_id` - An identifier for the action triggered when a menu option is selected. /// You can use this when you receive an interaction payload to [identify the source of the action 🔗]. /// Should be unique among all other `action_id`s used elsewhere by your app. /// Maximum length for this field is 255 characters. /// /// [`plain_text` only text object 🔗]: https://api.slack.comhttps://api.slack.com/reference/block-kit/composition-objects#text /// [identify the source of the action 🔗]: https://api.slack.comhttps://api.slack.com/interactivity/handling#payloads /// /// # Example /// ``` /// use std::convert::TryFrom; /// use std::iter; /// /// use slack_blocks::elems::{BlockElement, select}; /// use slack_blocks::blocks; /// use slack_blocks::text; /// use text::ToSlackPlaintext; /// /// let select: BlockElement = select::External /// ::from_placeholder_and_action_id("Channel", "ABC123") /// .into(); /// /// let title = "Pick a user to ban...".plaintext(); /// /// let blocks: Vec<blocks::Block> = vec![ /// blocks::Section::from_text(title).into(), /// blocks::Actions::try_from(vec![select]).unwrap().into(), /// ]; /// /// // <send `blocks` to slack's API> /// ``` #[deprecated(since = "0.16.7", note = "Use External::builder instead")] pub fn from_placeholder_and_action_id(placeholder: impl Into<text::Plain>, action_id: impl Into<Cow<'a, str>>) -> Self { Self { placeholder: placeholder.into().into(), action_id: action_id.into(), confirm: None, initial_option: None, min_query_length: None } } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `confirm` - A [confirm object 🔗] that defines an /// optional confirmation dialog that appears after /// a menu item is selected. /// /// [confirm object 🔗]: https://api.slack.comhttps://api.slack.com/reference/block-kit/composition-objects#confirm /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Actions}, /// elems::{BlockElement, select::Select}, /// compose::{text, Confirm, text::ToSlackPlaintext}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let confirm = Confirm::from_parts( /// "Are you sure?", /// "Think hard about this.".plaintext(), /// "Yes", /// "No", /// ); /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick a user to ban!", "ban_hammer") /// .with_confirm(confirm) /// .choose_from_users() /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` #[deprecated(since = "0.16.7", note = "Use External::builder instead")] pub fn with_confirm(mut self, confirm: Confirm) -> Self { self.confirm = Some(confirm); self } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `min_query_length` - When the typeahead field is used, a request will be sent on every character change. /// If you prefer fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number of typed characters required before dispatch. /// The default value is `3`. /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Actions}, /// elems::{BlockElement, select::Select}, /// compose::{text, text::ToSlackPlaintext}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick your favorite cheese!", "cheese_chosen") /// .choose_from_external() /// // we want a responsive typeahead because some cheese names are short! /// .with_min_query_length(1) /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` #[deprecated(since = "0.16.7", note = "Use External::builder instead")] pub fn with_min_query_length(mut self, min_query_length: u64) -> Self { self.min_query_length = Some(min_query_length); self } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `min_query_length` - When the typeahead field is used, a request will be sent on every character change. /// If you prefer fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number of typed characters required before dispatch. /// The default value is `3`. /// /// # Example /// ``` /// use std::{convert::TryFrom, iter}; /// /// use slack_blocks::{blocks::{Actions, Block}, /// compose::{opt::Opt, text, text::ToSlackPlaintext}, /// elems::{select::Select, BlockElement}}; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let brie = Opt::from_plain_text_and_value("Brie", "cheese_brie"); /// /// let select: BlockElement = Select::from_placeholder_and_action_id( /// "Pick your favorite cheese!", /// "cheese_chosen", /// ) /// .choose_from_external() /// .with_initial_option(brie) /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` #[deprecated(since = "0.16.7", note = "Use External::builder instead")] pub fn with_initial_option(mut self, option: impl Into<OptOrOptGroup<'a>>) -> Self { self.initial_option = Some(option.into()); self } /// Validate that this user select agrees with Slack's model requirements /// /// # Errors /// - If `from_placeholder_and_action_id` was called with /// `placeholder` longer than 150 chars /// - If `from_placeholder_and_action_id` was called with /// `action_id` longer than 255 chars /// /// # Example /// ``` /// use slack_blocks::elems::select; /// /// let select = select::External::from_placeholder_and_action_id( /// r#"Hey I really would appreciate it if you chose /// a channel relatively soon, so that we can figure out /// where we need to send this poll, ok? it's kind of /// important that you specify where this poll should be /// sent, in case we haven't made that super clear. /// If you understand, could you pick a channel, already??"#, /// "ABC123" /// ); /// /// assert!(matches!(select.validate(), Err(_))) /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } /// External Select Builder pub mod build { use std::marker::PhantomData; use super::*; use crate::{build::*, elems::select::{multi, select_kind}}; /// Required builder methods #[allow(non_camel_case_types)] pub mod method { /// PublicChannelBuilder.placeholder #[derive(Copy, Clone, Debug)] pub struct placeholder; /// PublicChannelBuilder.initial_option(s) or initial_option_group(s) #[derive(Copy, Clone, Debug)] pub struct initial_option; /// PublicChannelBuilder.action_id #[derive(Copy, Clone, Debug)] pub struct action_id; } /// External Select builder /// /// Allows you to construct a External Select safely, with compile-time checks /// on required setter methods. /// /// # Required Methods /// `ExternalBuilder::build()` is only available if these methods have been called: /// - `placeholder` /// - `action_id` /// - `options` or `option_groups` /// /// NOTE: I'm experimenting with an API that deviates from the `from_foo_and_bar`. /// If you're a user of this library, please give me feedback in the repository /// as to which pattern you like more. This will most likely be the new builder pattern /// for every structure in this crate. /// /// # Example /// ``` /// use std::convert::TryFrom; /// /// use slack_blocks::{elems::{select::External, BlockElement}, /// blocks::{Actions, Block}, /// compose::Opt}; /// /// let select: BlockElement = /// External::builder().placeholder("Choose your favorite programming language!") /// .action_id("lang_chosen") /// .build() /// .into(); /// /// let block: Block = /// Actions::try_from(select).expect("actions supports select elements") /// .into(); /// /// // <send block to API> /// ``` #[derive(Debug)] pub struct ExternalBuilder<'a, Multi, Placeholder, ActionId, Options> { placeholder: Option<text::Text>, action_id: Option<Cow<'a, str>>, confirm: Option<Confirm>, initial_option: Option<OptOrOptGroup<'a>>, initial_options: Option<Cow<'a, [OptOrOptGroup<'a>]>>, max_selected_items: Option<u32>, min_query_length: Option<u64>, state: PhantomData<(Multi, Placeholder, ActionId, Options)>, } /// Initial state for ExternalBuilder. /// /// Users will be able to choose one of the options. /// /// To allow choosing many, use `slack_blocks::elems::select::multi::External::builder`. pub type ExternalBuilderInit<'a> = ExternalBuilder<'a, select_kind::Single, RequiredMethodNotCalled<method::placeholder>, RequiredMethodNotCalled<method::action_id>, OptionalMethodNotCalled<method::initial_option>>; /// Initial state for ExternalBuilder. /// /// Users will be able to choose many options. pub type MultiExternalBuilderInit<'a> = ExternalBuilder<'a, select_kind::Multi, RequiredMethodNotCalled<method::placeholder>, RequiredMethodNotCalled<method::action_id>, OptionalMethodNotCalled<method::initial_option>>; // Methods that are always available impl<'a, M, P, A, O> ExternalBuilder<'a, M, P, A, O> { /// Construct a new ExternalBuilder pub fn new() -> Self { Self { placeholder: None, action_id: None, initial_option: None, initial_options: None, max_selected_items: None, confirm: None, min_query_length: None, state: PhantomData::<_> } } /// Change the marker type params to some other arbitrary marker type params fn cast_state<P2, A2, O2>(self) -> ExternalBuilder<'a, M, P2, A2, O2> { ExternalBuilder { placeholder: self.placeholder, action_id: self.action_id, confirm: self.confirm, initial_option: self.initial_option, initial_options: self.initial_options, max_selected_items: self.max_selected_items, min_query_length: self.min_query_length, state: PhantomData::<_> } } /// Set `placeholder` (**Required**) /// /// A [`plain_text` only text object 🔗] that defines /// the placeholder text shown on the menu. /// Maximum length for the `text` in this field is 150 characters. /// /// [`plain_text` only text object 🔗]: https://api.slack.comhttps://api.slack.com/reference/block-kit/composition-objects#text pub fn placeholder( mut self, text: impl Into<text::Plain>) -> ExternalBuilder<'a, M, Set<method::placeholder>, A, O> { self.placeholder = Some(text.into().into()); self.cast_state() } /// Set `action_id` (**Required**) /// /// An identifier for the action triggered when a menu option is selected. /// You can use this when you receive an interaction payload to [identify the source of the action 🔗]. /// Should be unique among all other `action_id`s used elsewhere by your app. /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.comhttps://api.slack.com/interactivity/handling#payloads pub fn action_id( mut self, text: impl Into<Cow<'a, str>>) -> ExternalBuilder<'a, M, P, Set<method::action_id>, O> { self.action_id = Some(text.into()); self.cast_state() } /// Set `confirm` (Optional) /// /// A [confirm object 🔗] that defines an /// optional confirmation dialog that appears after /// a menu item is selected. /// /// [confirm object 🔗]: https://api.slack.comhttps://api.slack.com/reference/block-kit/composition-objects#confirm pub fn confirm(mut self, confirm: Confirm) -> Self { self.confirm = Some(confirm); self } /// Set `min_query_length` (Optional) /// /// When the typeahead field is used, a request will be sent on every character change. /// /// If you prefer fewer requests or more fully ideated queries, /// use the `min_query_length` attribute to tell Slack the fewest number /// of typed characters required before dispatch. /// /// The default value is `3`. pub fn min_query_length(mut self, min: u64) -> Self { self.min_query_length = Some(min); self } } impl<'a, P, A, O> ExternalBuilder<'a, select_kind::Multi, P, A, O> { /// Set `max_selected_items` (Optional) /// /// Specifies the maximum number of items that can be selected in the menu. /// /// Minimum number is 1. pub fn max_selected_items(mut self, max: u32) -> Self { self.max_selected_items = Some(max); self } } impl<'a, P, A> ExternalBuilder<'a, select_kind::Multi, P, A, OptionalMethodNotCalled<method::initial_option>> { /// Set `initial_options` (Optional) /// /// An array of [option objects 🔗] that exactly match one or more of the options loaded from the external data source. /// /// These options will be selected when the menu initially loads. /// /// [option objects 🔗]: https://api.slack.com/reference/messaging/composition-objects#option pub fn initial_options<I>( mut self, options: I) -> ExternalBuilder<'a, select_kind::Multi, P, A, Set<method::initial_option>> where I: IntoIterator<Item = Opt<'a>> { self.initial_options = Some(options.into_iter() .map(|o| OptOrOptGroup::<'a>::Opt(o)) .collect()); self.cast_state() } /// Set `initial_options` (Optional) /// /// An array of [option objects 🔗] that exactly match one or more of the options loaded from the external data source. /// /// These options will be selected when the menu initially loads. /// /// [option objects 🔗]: https://api.slack.com/reference/messaging/composition-objects#option pub fn initial_option_groups<I>( mut self, option_groups: I) -> ExternalBuilder<'a, select_kind::Multi, P, A, Set<method::initial_option>> where I: IntoIterator<Item = OptGroup<'a>> { self.initial_options = Some(option_groups.into_iter() .map(|o| OptOrOptGroup::<'a>::OptGroup(o)) .collect()); self.cast_state() } } impl<'a, P, A> ExternalBuilder<'a, select_kind::Single, P, A, OptionalMethodNotCalled<method::initial_option>> { /// Set `initial_option` (Optional) /// /// A single option that exactly matches one of the options /// loaded from the external data source. /// /// This option will be selected when the menu initially loads. pub fn initial_option( mut self, option: Opt<'a>) -> ExternalBuilder<'a, select_kind::Single, P, A, Set<method::initial_option>> { self.initial_option = Some(OptOrOptGroup::<'a>::Opt(option)); self.cast_state() } /// Set `initial_option` (Optional) /// /// A single option group that exactly matches one of the option groups /// loaded from the external data source. /// /// This option will be selected when the menu initially loads. pub fn initial_option_group( mut self, option_group: OptGroup<'a>) -> ExternalBuilder<'a, select_kind::Single, P, A, Set<method::initial_option>> { self.initial_option = Some(OptOrOptGroup::<'a>::OptGroup(option_group)); self.cast_state() } } impl<'a, O> ExternalBuilder<'a, select_kind::Single, Set<method::placeholder>, Set<method::action_id>, O> { /// All done building, now give me a darn select element! /// /// > `no method name 'build' found for struct 'select::static_::build::ExternalBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `ExternalBuilder`. /// /// ```compile_fail /// use slack_blocks::elems::select::External; /// /// let sel = External::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::elems::select::External; /// /// let sel = External::builder().placeholder("foo") /// .action_id("bar") /// .build(); /// ``` pub fn build(self) -> External<'a> { External { placeholder: self.placeholder.unwrap(), action_id: self.action_id.unwrap(), confirm: self.confirm, initial_option: self.initial_option, min_query_length: self.min_query_length } } } impl<'a, O> ExternalBuilder<'a, select_kind::Multi, Set<method::placeholder>, Set<method::action_id>, O> { /// All done building, now give me a darn select element! /// /// > `no method name 'build' found for struct 'select::static_::build::ExternalBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `ExternalBuilder`. /// /// ```compile_fail /// use slack_blocks::elems::select::External; /// /// let sel = External::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::elems::select::External; /// /// let sel = External::builder().placeholder("foo") /// .action_id("bar") /// .build(); /// ``` pub fn build(self) -> multi::External<'a> { multi::External { placeholder: self.placeholder.unwrap(), action_id: self.action_id.unwrap(), confirm: self.confirm, initial_options: self.initial_options, min_query_length: self.min_query_length, max_selected_items: self.max_selected_items } } } }