slackblock 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/types-DhAVIy-s.d.cts

@@ -0,0 +1,261 @@
+import { KnownBlock, Block as Block$1, MessageAttachment } from '@slack/types';
+
+type TextType$1 = {
+    type: 'plain_text' | 'mrkdwn';
+    text: string;
+    emoji?: boolean;
+    verbatim?: boolean;
+};
+
+type TextType = {
+    type: 'plain_text_input';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_value?: string;
+    multiline?: boolean;
+    min_length?: number;
+    max_length?: number;
+    focus_on_load?: boolean;
+    dispatch_action_config?: {
+        trigger_actions_on: Array<'on_enter_pressed' | 'on_character_entered'>;
+    };
+};
+
+type ConfirmationType = {
+    title: TextType$1;
+    text: TextType$1;
+    confirm: TextType$1;
+    deny: TextType$1;
+};
+
+type DatePickerType = {
+    type: 'datepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_date?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OptionType = {
+    text: TextType$1;
+    value: string;
+    description?: TextType$1;
+    url?: string;
+};
+
+type OptionGroupType = {
+    label: TextType$1;
+    options: OptionType[];
+};
+
+type ValidSelectType = 'static_select' | 'multi_static_select' | 'external_select' | 'multi_external_select' | 'users_select' | 'multi_users_select' | 'conversations_select' | 'multi_conversations_select' | 'channels_select' | 'multi_channels_select';
+type SelectType = {
+    type: ValidSelectType;
+    placeholder: TextType$1;
+    action_id: string;
+    options?: OptionType[];
+    option_groups?: OptionGroupType[];
+    initial_option?: OptionType;
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    max_selected_items?: number;
+    min_query_length?: number;
+    focus_on_load?: boolean;
+    initial_user?: string;
+    initial_users?: string[];
+    initial_conversation?: string;
+    initial_conversations?: string[];
+    initial_channel?: string;
+    initial_channels?: string[];
+    default_to_current_conversation?: boolean;
+    response_url_enabled?: boolean;
+    filter?: {
+        include?: Array<'im' | 'mpim' | 'private' | 'public'>;
+        exclude_external_shared_channels?: boolean;
+        exclude_bot_users?: boolean;
+    };
+};
+
+type CheckboxesType = {
+    type: 'checkboxes';
+    action_id: string;
+    options: OptionType[];
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type TimePickerType = {
+    type: 'timepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_time?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type DateTimePickerType = {
+    type: 'datetimepicker';
+    action_id: string;
+    initial_date_time?: number;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OverflowType = {
+    type: 'overflow';
+    action_id: string;
+    options: OptionType[];
+    confirm?: ConfirmationType;
+};
+
+type RadioGroupType = {
+    type: 'radio_buttons';
+    action_id: string;
+    options: OptionType[];
+    initial_option?: OptionType;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type ImageType$1 = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+};
+
+type ButtonType = {
+    type: 'button';
+    text: TextType$1;
+    action_id: string;
+    url?: string;
+    value?: string;
+    style?: 'primary' | 'danger';
+    confirm?: ConfirmationType;
+    accessibility_label?: string;
+};
+
+type ActionType = {
+    type: 'actions';
+    elements: SerializedInteractiveBlockElement[];
+    block_id?: string;
+};
+
+type ImageOrText = ImageType$1 | TextType$1;
+type ContextType = {
+    type: 'context';
+    elements: ImageOrText | ImageOrText[];
+    block_id?: string;
+};
+
+type DividerType = {
+    type: 'divider';
+    block_id?: string;
+};
+
+type FileType = {
+    type: 'file';
+    source: 'remote';
+    external_id: string;
+    block_id?: string;
+};
+
+type HeaderType = {
+    type: 'header';
+    text: TextType$1;
+    block_id?: string;
+};
+
+type ImageType = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+    title?: TextType$1;
+    block_id?: string;
+};
+
+type InputType = {
+    type: 'input';
+    label: TextType$1;
+    element: SerializedInputBlockElement;
+    hint?: TextType$1;
+    optional?: boolean;
+    block_id?: string;
+};
+
+type RichTextType = {
+    type: 'rich_text';
+    elements: Array<Record<string, unknown>>;
+    block_id?: string;
+};
+
+type SectionType = {
+    type: 'section';
+    text: TextType$1;
+    block_id?: string;
+    fields?: TextType$1[];
+    accessory?: SerializedBlockElement;
+};
+
+type VideoType = {
+    type: 'video';
+    title: TextType$1;
+    video_url: string;
+    thumbnail_url: string;
+    alt_text: string;
+    title_url?: string;
+    description?: TextType$1;
+    author_name?: string;
+    provider_name?: string;
+    provider_icon_url?: string;
+    block_id?: string;
+};
+
+type ImageBlockType = ImageType$1 | ImageType;
+type SerializedOption = OptionType | OptionGroupType;
+type SerializedInputBlockElement = TextType | DatePickerType | DateTimePickerType | TimePickerType | CheckboxesType | SelectType | OverflowType | RadioGroupType;
+type SerializedInteractiveBlockElement = ButtonType | SerializedInputBlockElement;
+type SerializedBlockElement = TextType$1 | ImageBlockType | ConfirmationType | SerializedInteractiveBlockElement;
+type SerializedBlock = SectionType | ActionType | ContextType | DividerType | FileType | HeaderType | ImageBlockType | InputType | RichTextType | VideoType;
+type SerializedElement = SerializedBlock | SerializedBlockElement | SerializedInputBlockElement | SerializedOption;
+type Block = KnownBlock | Block$1;
+type Attachment = MessageAttachment;
+type InteractiveBlockElement = JSX.Element;
+type InputBlockElement = JSX.Element;
+type BlockElement = JSX.Element;
+type SlackMessageDraft = {
+    text: string;
+    blocks?: Block[];
+    attachments?: Attachment[];
+    channel?: string;
+    user?: string;
+    thread_ts?: string;
+    mrkdwn?: boolean;
+    icon_emoji?: string;
+    icon_url?: string;
+    parse?: 'full' | 'none';
+    username?: string;
+    as_user?: boolean;
+    reply_broadcast?: boolean;
+    unfurl_links?: boolean;
+    unfurl_media?: boolean;
+};
+type BoltCompatiblePayload = Omit<SlackMessageDraft, 'icon_emoji' | 'icon_url' | 'username' | 'as_user' | 'reply_broadcast' | 'channel' | 'user'>;
+type SlackPostMessagePayload = BoltCompatiblePayload & {
+    channel: string;
+};
+type SlackPostEphemeralPayload = BoltCompatiblePayload & {
+    channel: string;
+    user: string;
+};
+type AnyFunction = (...parameters: unknown[]) => unknown;
+type AnyConstructor = new (...parameters: unknown[]) => unknown;
+type WithType = {
+    type?: string | AnyFunction | AnyConstructor;
+};
+type BElement = JSX.Element & WithType;
+type Element = BElement;
+type Child = string | Element | Child[] | boolean | undefined | null;
+
+export type { BoltCompatiblePayload as B, Child as C, Element as E, InteractiveBlockElement as I, SlackPostEphemeralPayload as S, SlackPostMessagePayload as a, Block as b, SerializedBlock as c, SerializedElement as d, SerializedOption as e, SlackMessageDraft as f, InputBlockElement as g, BlockElement as h };

package/dist/types-DhAVIy-s.d.ts

@@ -0,0 +1,261 @@
+import { KnownBlock, Block as Block$1, MessageAttachment } from '@slack/types';
+
+type TextType$1 = {
+    type: 'plain_text' | 'mrkdwn';
+    text: string;
+    emoji?: boolean;
+    verbatim?: boolean;
+};
+
+type TextType = {
+    type: 'plain_text_input';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_value?: string;
+    multiline?: boolean;
+    min_length?: number;
+    max_length?: number;
+    focus_on_load?: boolean;
+    dispatch_action_config?: {
+        trigger_actions_on: Array<'on_enter_pressed' | 'on_character_entered'>;
+    };
+};
+
+type ConfirmationType = {
+    title: TextType$1;
+    text: TextType$1;
+    confirm: TextType$1;
+    deny: TextType$1;
+};
+
+type DatePickerType = {
+    type: 'datepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_date?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OptionType = {
+    text: TextType$1;
+    value: string;
+    description?: TextType$1;
+    url?: string;
+};
+
+type OptionGroupType = {
+    label: TextType$1;
+    options: OptionType[];
+};
+
+type ValidSelectType = 'static_select' | 'multi_static_select' | 'external_select' | 'multi_external_select' | 'users_select' | 'multi_users_select' | 'conversations_select' | 'multi_conversations_select' | 'channels_select' | 'multi_channels_select';
+type SelectType = {
+    type: ValidSelectType;
+    placeholder: TextType$1;
+    action_id: string;
+    options?: OptionType[];
+    option_groups?: OptionGroupType[];
+    initial_option?: OptionType;
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    max_selected_items?: number;
+    min_query_length?: number;
+    focus_on_load?: boolean;
+    initial_user?: string;
+    initial_users?: string[];
+    initial_conversation?: string;
+    initial_conversations?: string[];
+    initial_channel?: string;
+    initial_channels?: string[];
+    default_to_current_conversation?: boolean;
+    response_url_enabled?: boolean;
+    filter?: {
+        include?: Array<'im' | 'mpim' | 'private' | 'public'>;
+        exclude_external_shared_channels?: boolean;
+        exclude_bot_users?: boolean;
+    };
+};
+
+type CheckboxesType = {
+    type: 'checkboxes';
+    action_id: string;
+    options: OptionType[];
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type TimePickerType = {
+    type: 'timepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_time?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type DateTimePickerType = {
+    type: 'datetimepicker';
+    action_id: string;
+    initial_date_time?: number;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OverflowType = {
+    type: 'overflow';
+    action_id: string;
+    options: OptionType[];
+    confirm?: ConfirmationType;
+};
+
+type RadioGroupType = {
+    type: 'radio_buttons';
+    action_id: string;
+    options: OptionType[];
+    initial_option?: OptionType;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type ImageType$1 = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+};
+
+type ButtonType = {
+    type: 'button';
+    text: TextType$1;
+    action_id: string;
+    url?: string;
+    value?: string;
+    style?: 'primary' | 'danger';
+    confirm?: ConfirmationType;
+    accessibility_label?: string;
+};
+
+type ActionType = {
+    type: 'actions';
+    elements: SerializedInteractiveBlockElement[];
+    block_id?: string;
+};
+
+type ImageOrText = ImageType$1 | TextType$1;
+type ContextType = {
+    type: 'context';
+    elements: ImageOrText | ImageOrText[];
+    block_id?: string;
+};
+
+type DividerType = {
+    type: 'divider';
+    block_id?: string;
+};
+
+type FileType = {
+    type: 'file';
+    source: 'remote';
+    external_id: string;
+    block_id?: string;
+};
+
+type HeaderType = {
+    type: 'header';
+    text: TextType$1;
+    block_id?: string;
+};
+
+type ImageType = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+    title?: TextType$1;
+    block_id?: string;
+};
+
+type InputType = {
+    type: 'input';
+    label: TextType$1;
+    element: SerializedInputBlockElement;
+    hint?: TextType$1;
+    optional?: boolean;
+    block_id?: string;
+};
+
+type RichTextType = {
+    type: 'rich_text';
+    elements: Array<Record<string, unknown>>;
+    block_id?: string;
+};
+
+type SectionType = {
+    type: 'section';
+    text: TextType$1;
+    block_id?: string;
+    fields?: TextType$1[];
+    accessory?: SerializedBlockElement;
+};
+
+type VideoType = {
+    type: 'video';
+    title: TextType$1;
+    video_url: string;
+    thumbnail_url: string;
+    alt_text: string;
+    title_url?: string;
+    description?: TextType$1;
+    author_name?: string;
+    provider_name?: string;
+    provider_icon_url?: string;
+    block_id?: string;
+};
+
+type ImageBlockType = ImageType$1 | ImageType;
+type SerializedOption = OptionType | OptionGroupType;
+type SerializedInputBlockElement = TextType | DatePickerType | DateTimePickerType | TimePickerType | CheckboxesType | SelectType | OverflowType | RadioGroupType;
+type SerializedInteractiveBlockElement = ButtonType | SerializedInputBlockElement;
+type SerializedBlockElement = TextType$1 | ImageBlockType | ConfirmationType | SerializedInteractiveBlockElement;
+type SerializedBlock = SectionType | ActionType | ContextType | DividerType | FileType | HeaderType | ImageBlockType | InputType | RichTextType | VideoType;
+type SerializedElement = SerializedBlock | SerializedBlockElement | SerializedInputBlockElement | SerializedOption;
+type Block = KnownBlock | Block$1;
+type Attachment = MessageAttachment;
+type InteractiveBlockElement = JSX.Element;
+type InputBlockElement = JSX.Element;
+type BlockElement = JSX.Element;
+type SlackMessageDraft = {
+    text: string;
+    blocks?: Block[];
+    attachments?: Attachment[];
+    channel?: string;
+    user?: string;
+    thread_ts?: string;
+    mrkdwn?: boolean;
+    icon_emoji?: string;
+    icon_url?: string;
+    parse?: 'full' | 'none';
+    username?: string;
+    as_user?: boolean;
+    reply_broadcast?: boolean;
+    unfurl_links?: boolean;
+    unfurl_media?: boolean;
+};
+type BoltCompatiblePayload = Omit<SlackMessageDraft, 'icon_emoji' | 'icon_url' | 'username' | 'as_user' | 'reply_broadcast' | 'channel' | 'user'>;
+type SlackPostMessagePayload = BoltCompatiblePayload & {
+    channel: string;
+};
+type SlackPostEphemeralPayload = BoltCompatiblePayload & {
+    channel: string;
+    user: string;
+};
+type AnyFunction = (...parameters: unknown[]) => unknown;
+type AnyConstructor = new (...parameters: unknown[]) => unknown;
+type WithType = {
+    type?: string | AnyFunction | AnyConstructor;
+};
+type BElement = JSX.Element & WithType;
+type Element = BElement;
+type Child = string | Element | Child[] | boolean | undefined | null;
+
+export type { BoltCompatiblePayload as B, Child as C, Element as E, InteractiveBlockElement as I, SlackPostEphemeralPayload as S, SlackPostMessagePayload as a, Block as b, SerializedBlock as c, SerializedElement as d, SerializedOption as e, SlackMessageDraft as f, InputBlockElement as g, BlockElement as h };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slackblock",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "JSX-based Slack message renderer",
   "engines": {
     "node": ">=20"

package/dist/types.d-BHoTwZUO.d.cts

@@ -1,124 +0,0 @@
-import { KnownBlock, Block as Block$1, MessageAttachment, MessageMetadata, EntityMetadata } from '@slack/types';
-
-type Channel = {
-    channel: string;
-};
-type Text = {
-    text: string;
-};
-type MarkdownText = {
-    markdown_text: string;
-};
-type ChannelAndText = Channel & Text;
-type ChannelAndBlocks = Channel & Partial<Text> & {
-    blocks: Array<KnownBlock | Block$1>;
-};
-type ChannelAndAttachments = Channel & Partial<Text> & {
-    attachments: MessageAttachment[];
-};
-type ChannelAndMarkdownText = Channel & MarkdownText;
-type LinkNames = {
-    link_names?: boolean;
-};
-type Parse = {
-    parse?: 'full' | 'none';
-};
-type Unfurls = {
-    unfurl_links?: boolean;
-    unfurl_media?: boolean;
-};
-type IconEmoji = {
-    as_user?: false;
-    icon_url?: never;
-    icon_emoji?: string;
-};
-type IconURL = {
-    as_user?: false;
-    icon_emoji?: never;
-    icon_url?: string;
-};
-type Username = {
-    as_user?: false;
-    username?: string;
-};
-type WithinThreadReply = {
-    thread_ts?: string;
-    reply_broadcast?: false;
-};
-type BroadcastedThreadReply = {
-    thread_ts: string;
-    reply_broadcast: boolean;
-};
-type ChatPostMessageMetadata = {
-    metadata?: Partial<MessageMetadata> & {
-        entities?: EntityMetadata[];
-    };
-};
-type MessageContents = ChannelAndText | ChannelAndBlocks | ChannelAndAttachments | ChannelAndMarkdownText;
-type ReplyInThread = WithinThreadReply | BroadcastedThreadReply;
-type Authorship = ((IconEmoji | IconURL) & Username) | {
-    as_user: true;
-    icon_emoji?: never;
-    icon_url?: never;
-    username?: never;
-};
-type ChatPostMessageArguments = {
-    token?: string;
-} & MessageContents & ReplyInThread & Authorship & Parse & LinkNames & ChatPostMessageMetadata & Unfurls & {
-    mrkdwn?: boolean;
-};
-
-type Block = KnownBlock | Block$1;
-
-type InteractiveBlockElement = JSX.Element;
-
-type InputBlockElement = JSX.Element;
-type BlockElement = JSX.Element;
-
-type SlackMessageContents =
-  | Omit<ChannelAndText, 'channel'>
-  | Omit<ChannelAndBlocks, 'channel'>
-  | Omit<ChannelAndAttachments, 'channel'>
-  | Omit<ChannelAndMarkdownText, 'channel'>;
-
-type SlackAuthorship =
-  | ((IconEmoji | IconURL) & Username)
-  | {
-    as_user: true;
-    icon_emoji?: never;
-    icon_url?: never;
-    username?: never;
-  };
-
-type SlackThreadReply = WithinThreadReply | BroadcastedThreadReply;
-
-type SlackMessageBase = SlackMessageContents
-  & SlackThreadReply
-  & SlackAuthorship
-  & Parse
-  & LinkNames
-  & Unfurls
-  & ChatPostMessageMetadata
-  & {mrkdwn?: boolean};
-
-type SlackMessage = SlackMessageBase & Omit<ChatPostMessageArguments, 'channel' | 'token'>;
-
-type AnyFunction = (...parameters: unknown[]) => unknown;
-
-type AnyConstructor = new (...parameters: unknown[]) => unknown;
-
-type WithType = {
-  type?: string | AnyFunction | AnyConstructor;
-};
-type BElement = JSX.Element & WithType;
-type Element = BElement;
-type Child =
-  | string
-  | Element
-  | Child[]
-  | boolean
-  | undefined
-  // eslint-disable-next-line @typescript-eslint/no-restricted-types -- React children can be null.
-  | null;
-
-export type { Block as B, Child as C, Element as E, InteractiveBlockElement as I, SlackMessage as S, InputBlockElement as a, BlockElement as b };