slack-blocks-to-jsx 0.1.7 → 0.1.9

package/dist/index.d.mts

@@ -1,4 +1,6 @@
-type Element = ButtonElement | CheckboxesElement | DatePickerElement | DateTimePickerElement | EmailInputElement | ImageElement | MultiStaticSelectElement | MultiExternalSelectElement | MultiUsersSelectElement | MultiConversationsSelectElement | MultiChannelsSelectElement | NumberInputElement | OverflowMenuElement | PlainTextInputElement | RadioButtonsElement | StaticSelectElement | ExternalSelectElement | UsersSelectElement | ConversationsSelectElement | ChannelsSelectElement | TimePickerElement | UrlTextInputElement;
+import { ReactNode } from 'react';
+
+type Element = ButtonElement | CheckboxesElement | DatePickerElement | DateTimePickerElement | EmailInputElement | ImageElement | MultiStaticSelectElement | MultiExternalSelectElement | MultiUsersSelectElement | MultiConversationsSelectElement | MultiChannelsSelectElement | NumberInputElement | OverflowMenuElement | PlainTextInputElement | RadioButtonsElement | StaticSelectElement | ExternalSelectElement | UsersSelectElement | ConversationsSelectElement | ChannelsSelectElement | TimePickerElement | UrlTextInputElement | RichTextBlockElement;
 type ButtonElement = {
     type: "button";
     /**
@@ -697,102 +699,6 @@ type FilterObject = {
     exclude_bot_users?: boolean;
 };
 
-type RichTextList = {
-    type: "rich_text_list";
-    style: "bullet" | "ordered";
-    /**
-     * The number of spaces to indent this block. It must be a number between 0 and 8.
-     */
-    indent?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
-    offset?: number;
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-    elements: RichTextSection[];
-};
-type RichTextPreformatted = {
-    type: "rich_text_preformatted";
-    elements: AnyRichTextSectionElement[];
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-};
-type RichTextQuote = {
-    type: "rich_text_quote";
-    elements: AnyRichTextSectionElement[];
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-};
-type RichTextSection = {
-    type: "rich_text_section";
-    elements: AnyRichTextSectionElement[];
-};
-type AnyRichTextBlockElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
-type AnyRichTextSectionElement = RichTextSectionText | RichTextSectionChannel | RichTextSectionUser | RichTextSectionEmoji | RichTextSectionLink | RichTextSectionTeam | RichTextSectionUsergroup | RichTextSectionDate | RichTextSectionBroadcast | RichTextSectionColor;
-interface RichTextSectionElement {
-    type: "text" | "channel" | "user" | "emoji" | "link" | "team" | "usergroup" | "date" | "broadcast" | "color";
-    style?: RichTextSectionElementStyle;
-}
-interface RichTextSectionText extends RichTextSectionElement {
-    type: "text";
-    text: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionChannel extends RichTextSectionElement {
-    type: "channel";
-    channel_id: string;
-}
-interface RichTextSectionUser extends RichTextSectionElement {
-    type: "user";
-    user_id: string;
-}
-interface RichTextSectionEmoji extends RichTextSectionElement {
-    type: "emoji";
-    name: string;
-    skin_tone?: number;
-    unicode?: string;
-}
-interface RichTextSectionLink extends RichTextSectionElement {
-    type: "link";
-    url: string;
-    text: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionTeam extends RichTextSectionElement {
-    type: "team";
-    team_id: string;
-}
-interface RichTextSectionUsergroup extends RichTextSectionElement {
-    type: "usergroup";
-    usergroup_id: string;
-}
-interface RichTextSectionDate extends RichTextSectionElement {
-    type: "date";
-    timestamp: number;
-    format: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionBroadcast extends RichTextSectionElement {
-    type: "broadcast";
-    range: "channel" | "here" | "everyone";
-}
-interface RichTextSectionColor extends RichTextSectionElement {
-    type: "color";
-    value: string;
-}
-interface RichTextSectionElementStyle {
-    bold?: boolean;
-    italic?: boolean;
-    strike?: boolean;
-}
-interface RichTextSectionElementStyleWithCode extends RichTextSectionElementStyle {
-    code?: boolean;
-}
-
 type Block = ActionsBlock | ContextBlock | DividerBlock | FileBlock | HeaderBlock | ImageBlock | InputBlock | SectionBlock | VideoBlock | RichTextBlock;
 type ActionsBlock = {
     /**
@@ -1077,7 +983,94 @@ type RichTextBlock = {
     /**
      * An array of rich text objects - rich_text_section, rich_text_list, rich_text_preformatted, and rich_text_quote. See your specific desired element below for more details.
      */
-    elements: AnyRichTextBlockElement[];
+    elements: RichTextBlockElement[];
+};
+
+type RichTextBlockSubElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
+type RichTextList = {
+    type: "rich_text_list";
+    style: "bullet" | "ordered";
+    /**
+     * The number of spaces to indent this block. It must be a number between 0 and 8.
+     */
+    indent?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+    offset?: number;
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+    elements: RichTextSection[];
+};
+type RichTextPreformatted = {
+    type: "rich_text_preformatted";
+    elements: RichTextSectionElement[];
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+};
+type RichTextQuote = {
+    type: "rich_text_quote";
+    elements: RichTextSectionElement[];
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+};
+type RichTextSection = {
+    type: "rich_text_section";
+    elements: RichTextSectionElement[];
+};
+type RichTextBlockElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
+type RichTextSectionElement = RichTextSectionText | RichTextSectionChannel | RichTextSectionUser | RichTextSectionEmoji | RichTextSectionLink | RichTextSectionUsergroup | RichTextSectionBroadcast;
+type RichTextSectionText = {
+    type: "text";
+    text: string;
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionChannel = {
+    type: "channel";
+    channel_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionUser = {
+    type: "user";
+    user_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionEmoji = {
+    type: "emoji";
+    name: string;
+};
+type RichTextSectionLink = {
+    type: "link";
+    url: string;
+    text: string;
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionUsergroup = {
+    type: "usergroup";
+    usergroup_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionBroadcast = {
+    type: "broadcast";
+    range: "channel" | "here" | "everyone";
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionElementStyle = {
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    highlight?: boolean;
+    client_highlight?: boolean;
+    unlink?: boolean;
+};
+type RichTextSectionElementStyleCode = {
+    code?: boolean;
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
 };
 
 type User = {
@@ -1089,28 +1082,24 @@ type Channel = {
     name: string;
 };
 type Hooks = {
-    user?: (data: User) => string;
-    channel?: (data: Channel) => string;
-    atChannel?: (data: {
-        name: string;
-    }) => string;
-    usergroup?: (data: Channel) => string;
-    atEveryone?: (data: {
-        name: string;
-    }) => string;
-    atHere?: (data: {
-        name: string;
-    }) => string;
+    user?: (data: User) => ReactNode;
+    channel?: (data: Channel) => ReactNode;
+    atChannel?: () => ReactNode;
+    atEveryone?: () => ReactNode;
+    atHere?: () => ReactNode;
+    usergroup?: (id: string) => ReactNode;
+    emoji?: (emoji_text: string) => ReactNode;
     date?: (data: {
         timestamp: string;
         format: string;
         link?: string | undefined;
         fallback: string;
-    }) => string;
+    }) => ReactNode;
 };
 type Data = {
     users: User[];
     channels: Channel[];
+    user_groups: Channel[];
     hooks: Hooks;
     setUsers: (users: User[]) => void;
     setChannels: (channels: Channel[]) => void;
@@ -1137,9 +1126,10 @@ type Props = {
     data?: {
         users?: GlobalStore["users"];
         channels?: GlobalStore["channels"];
+        user_groups?: GlobalStore["user_groups"];
     };
     hooks?: GlobalStore["hooks"];
 };
 declare const Message: (props: Props) => JSX.Element;
 
-export { ActionsBlock, Block, ButtonElement, ChannelsSelectElement, CheckboxesElement, ConfirmDialogObject, ContextBlock, ConversationsSelectElement, DatePickerElement, DateTimePickerElement, DispatchActionConfigObject, DividerBlock, Element, EmailInputElement, ExternalSelectElement, FileBlock, FilterObject, HeaderBlock, ImageBlock, ImageElement, InputBlock, Message, MultiChannelsSelectElement, MultiConversationsSelectElement, MultiExternalSelectElement, MultiStaticSelectElement, MultiUsersSelectElement, NumberInputElement, OptionGroupObject, OptionObject, OptionObjectWithoutUrl, OverflowMenuElement, PlainTextInputElement, RadioButtonsElement, RichTextBlock, SectionBlock, StaticSelectElement, Style, TextObject, TextObjectTextType, TimePickerElement, UrlTextInputElement, UsersSelectElement, VideoBlock };
+export { ActionsBlock, Block, ButtonElement, ChannelsSelectElement, CheckboxesElement, ConfirmDialogObject, ContextBlock, ConversationsSelectElement, DatePickerElement, DateTimePickerElement, DispatchActionConfigObject, DividerBlock, Element, EmailInputElement, ExternalSelectElement, FileBlock, FilterObject, HeaderBlock, ImageBlock, ImageElement, InputBlock, Message, MultiChannelsSelectElement, MultiConversationsSelectElement, MultiExternalSelectElement, MultiStaticSelectElement, MultiUsersSelectElement, NumberInputElement, OptionGroupObject, OptionObject, OptionObjectWithoutUrl, OverflowMenuElement, PlainTextInputElement, RadioButtonsElement, RichTextBlock, RichTextBlockElement, RichTextBlockSubElement, RichTextList, RichTextPreformatted, RichTextQuote, RichTextSection, RichTextSectionBroadcast, RichTextSectionChannel, RichTextSectionElement, RichTextSectionElementStyle, RichTextSectionElementStyleCode, RichTextSectionEmoji, RichTextSectionLink, RichTextSectionText, RichTextSectionUser, RichTextSectionUsergroup, SectionBlock, StaticSelectElement, Style, TextObject, TextObjectTextType, TimePickerElement, UrlTextInputElement, UsersSelectElement, VideoBlock };

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-type Element = ButtonElement | CheckboxesElement | DatePickerElement | DateTimePickerElement | EmailInputElement | ImageElement | MultiStaticSelectElement | MultiExternalSelectElement | MultiUsersSelectElement | MultiConversationsSelectElement | MultiChannelsSelectElement | NumberInputElement | OverflowMenuElement | PlainTextInputElement | RadioButtonsElement | StaticSelectElement | ExternalSelectElement | UsersSelectElement | ConversationsSelectElement | ChannelsSelectElement | TimePickerElement | UrlTextInputElement;
+import { ReactNode } from 'react';
+
+type Element = ButtonElement | CheckboxesElement | DatePickerElement | DateTimePickerElement | EmailInputElement | ImageElement | MultiStaticSelectElement | MultiExternalSelectElement | MultiUsersSelectElement | MultiConversationsSelectElement | MultiChannelsSelectElement | NumberInputElement | OverflowMenuElement | PlainTextInputElement | RadioButtonsElement | StaticSelectElement | ExternalSelectElement | UsersSelectElement | ConversationsSelectElement | ChannelsSelectElement | TimePickerElement | UrlTextInputElement | RichTextBlockElement;
 type ButtonElement = {
     type: "button";
     /**
@@ -697,102 +699,6 @@ type FilterObject = {
     exclude_bot_users?: boolean;
 };
 
-type RichTextList = {
-    type: "rich_text_list";
-    style: "bullet" | "ordered";
-    /**
-     * The number of spaces to indent this block. It must be a number between 0 and 8.
-     */
-    indent?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
-    offset?: number;
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-    elements: RichTextSection[];
-};
-type RichTextPreformatted = {
-    type: "rich_text_preformatted";
-    elements: AnyRichTextSectionElement[];
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-};
-type RichTextQuote = {
-    type: "rich_text_quote";
-    elements: AnyRichTextSectionElement[];
-    /**
-     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
-     */
-    border?: 0 | 1;
-};
-type RichTextSection = {
-    type: "rich_text_section";
-    elements: AnyRichTextSectionElement[];
-};
-type AnyRichTextBlockElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
-type AnyRichTextSectionElement = RichTextSectionText | RichTextSectionChannel | RichTextSectionUser | RichTextSectionEmoji | RichTextSectionLink | RichTextSectionTeam | RichTextSectionUsergroup | RichTextSectionDate | RichTextSectionBroadcast | RichTextSectionColor;
-interface RichTextSectionElement {
-    type: "text" | "channel" | "user" | "emoji" | "link" | "team" | "usergroup" | "date" | "broadcast" | "color";
-    style?: RichTextSectionElementStyle;
-}
-interface RichTextSectionText extends RichTextSectionElement {
-    type: "text";
-    text: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionChannel extends RichTextSectionElement {
-    type: "channel";
-    channel_id: string;
-}
-interface RichTextSectionUser extends RichTextSectionElement {
-    type: "user";
-    user_id: string;
-}
-interface RichTextSectionEmoji extends RichTextSectionElement {
-    type: "emoji";
-    name: string;
-    skin_tone?: number;
-    unicode?: string;
-}
-interface RichTextSectionLink extends RichTextSectionElement {
-    type: "link";
-    url: string;
-    text: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionTeam extends RichTextSectionElement {
-    type: "team";
-    team_id: string;
-}
-interface RichTextSectionUsergroup extends RichTextSectionElement {
-    type: "usergroup";
-    usergroup_id: string;
-}
-interface RichTextSectionDate extends RichTextSectionElement {
-    type: "date";
-    timestamp: number;
-    format: string;
-    style?: RichTextSectionElementStyleWithCode;
-}
-interface RichTextSectionBroadcast extends RichTextSectionElement {
-    type: "broadcast";
-    range: "channel" | "here" | "everyone";
-}
-interface RichTextSectionColor extends RichTextSectionElement {
-    type: "color";
-    value: string;
-}
-interface RichTextSectionElementStyle {
-    bold?: boolean;
-    italic?: boolean;
-    strike?: boolean;
-}
-interface RichTextSectionElementStyleWithCode extends RichTextSectionElementStyle {
-    code?: boolean;
-}
-
 type Block = ActionsBlock | ContextBlock | DividerBlock | FileBlock | HeaderBlock | ImageBlock | InputBlock | SectionBlock | VideoBlock | RichTextBlock;
 type ActionsBlock = {
     /**
@@ -1077,7 +983,94 @@ type RichTextBlock = {
     /**
      * An array of rich text objects - rich_text_section, rich_text_list, rich_text_preformatted, and rich_text_quote. See your specific desired element below for more details.
      */
-    elements: AnyRichTextBlockElement[];
+    elements: RichTextBlockElement[];
+};
+
+type RichTextBlockSubElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
+type RichTextList = {
+    type: "rich_text_list";
+    style: "bullet" | "ordered";
+    /**
+     * The number of spaces to indent this block. It must be a number between 0 and 8.
+     */
+    indent?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+    offset?: number;
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+    elements: RichTextSection[];
+};
+type RichTextPreformatted = {
+    type: "rich_text_preformatted";
+    elements: RichTextSectionElement[];
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+};
+type RichTextQuote = {
+    type: "rich_text_quote";
+    elements: RichTextSectionElement[];
+    /**
+     * 0 or 1 (default 0) - if 1, a border is drawn on the left side of the block.
+     */
+    border?: 0 | 1;
+};
+type RichTextSection = {
+    type: "rich_text_section";
+    elements: RichTextSectionElement[];
+};
+type RichTextBlockElement = RichTextList | RichTextPreformatted | RichTextQuote | RichTextSection;
+type RichTextSectionElement = RichTextSectionText | RichTextSectionChannel | RichTextSectionUser | RichTextSectionEmoji | RichTextSectionLink | RichTextSectionUsergroup | RichTextSectionBroadcast;
+type RichTextSectionText = {
+    type: "text";
+    text: string;
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionChannel = {
+    type: "channel";
+    channel_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionUser = {
+    type: "user";
+    user_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionEmoji = {
+    type: "emoji";
+    name: string;
+};
+type RichTextSectionLink = {
+    type: "link";
+    url: string;
+    text: string;
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionUsergroup = {
+    type: "usergroup";
+    usergroup_id: string;
+    style?: RichTextSectionElementStyle;
+};
+type RichTextSectionBroadcast = {
+    type: "broadcast";
+    range: "channel" | "here" | "everyone";
+    style?: RichTextSectionElementStyleCode;
+};
+type RichTextSectionElementStyle = {
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    highlight?: boolean;
+    client_highlight?: boolean;
+    unlink?: boolean;
+};
+type RichTextSectionElementStyleCode = {
+    code?: boolean;
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
 };
 
 type User = {
@@ -1089,28 +1082,24 @@ type Channel = {
     name: string;
 };
 type Hooks = {
-    user?: (data: User) => string;
-    channel?: (data: Channel) => string;
-    atChannel?: (data: {
-        name: string;
-    }) => string;
-    usergroup?: (data: Channel) => string;
-    atEveryone?: (data: {
-        name: string;
-    }) => string;
-    atHere?: (data: {
-        name: string;
-    }) => string;
+    user?: (data: User) => ReactNode;
+    channel?: (data: Channel) => ReactNode;
+    atChannel?: () => ReactNode;
+    atEveryone?: () => ReactNode;
+    atHere?: () => ReactNode;
+    usergroup?: (id: string) => ReactNode;
+    emoji?: (emoji_text: string) => ReactNode;
     date?: (data: {
         timestamp: string;
         format: string;
         link?: string | undefined;
         fallback: string;
-    }) => string;
+    }) => ReactNode;
 };
 type Data = {
     users: User[];
     channels: Channel[];
+    user_groups: Channel[];
     hooks: Hooks;
     setUsers: (users: User[]) => void;
     setChannels: (channels: Channel[]) => void;
@@ -1137,9 +1126,10 @@ type Props = {
     data?: {
         users?: GlobalStore["users"];
         channels?: GlobalStore["channels"];
+        user_groups?: GlobalStore["user_groups"];
     };
     hooks?: GlobalStore["hooks"];
 };
 declare const Message: (props: Props) => JSX.Element;
 
-export { ActionsBlock, Block, ButtonElement, ChannelsSelectElement, CheckboxesElement, ConfirmDialogObject, ContextBlock, ConversationsSelectElement, DatePickerElement, DateTimePickerElement, DispatchActionConfigObject, DividerBlock, Element, EmailInputElement, ExternalSelectElement, FileBlock, FilterObject, HeaderBlock, ImageBlock, ImageElement, InputBlock, Message, MultiChannelsSelectElement, MultiConversationsSelectElement, MultiExternalSelectElement, MultiStaticSelectElement, MultiUsersSelectElement, NumberInputElement, OptionGroupObject, OptionObject, OptionObjectWithoutUrl, OverflowMenuElement, PlainTextInputElement, RadioButtonsElement, RichTextBlock, SectionBlock, StaticSelectElement, Style, TextObject, TextObjectTextType, TimePickerElement, UrlTextInputElement, UsersSelectElement, VideoBlock };
+export { ActionsBlock, Block, ButtonElement, ChannelsSelectElement, CheckboxesElement, ConfirmDialogObject, ContextBlock, ConversationsSelectElement, DatePickerElement, DateTimePickerElement, DispatchActionConfigObject, DividerBlock, Element, EmailInputElement, ExternalSelectElement, FileBlock, FilterObject, HeaderBlock, ImageBlock, ImageElement, InputBlock, Message, MultiChannelsSelectElement, MultiConversationsSelectElement, MultiExternalSelectElement, MultiStaticSelectElement, MultiUsersSelectElement, NumberInputElement, OptionGroupObject, OptionObject, OptionObjectWithoutUrl, OverflowMenuElement, PlainTextInputElement, RadioButtonsElement, RichTextBlock, RichTextBlockElement, RichTextBlockSubElement, RichTextList, RichTextPreformatted, RichTextQuote, RichTextSection, RichTextSectionBroadcast, RichTextSectionChannel, RichTextSectionElement, RichTextSectionElementStyle, RichTextSectionElementStyleCode, RichTextSectionEmoji, RichTextSectionLink, RichTextSectionText, RichTextSectionUser, RichTextSectionUsergroup, SectionBlock, StaticSelectElement, Style, TextObject, TextObjectTextType, TimePickerElement, UrlTextInputElement, UsersSelectElement, VideoBlock };