@nemphi/sdk 0.1.0 → 0.2.4556

package/dist/block-kit.d.ts

@@ -0,0 +1,889 @@
+/**
+ * Block Kit — the message vocabulary.
+ *
+ * A chat message (an assistant turn, a message in a workspace thread) is a
+ * list of blocks in the shape Slack's Block Kit documents at
+ * https://docs.slack.dev/reference/block-kit: the same block types, block
+ * elements, rich-text elements and composition objects, with the same field
+ * names, so a payload written for Slack renders here unchanged and the
+ * models already know the format. The API validates a message against these
+ * shapes (with Slack's limits) before it is stored or shown.
+ *
+ * Interaction flows the other way in Slack's `block_actions` shape too: a
+ * click or a change produces a {@link BlockAction} whose `state` carries the
+ * values of every input block in the message, the way a view submission does.
+ */
+/** Plain text. `emoji` asks for `:name:` codes to render as emoji. */
+export interface PlainTextObject {
+    type: "plain_text";
+    text: string;
+    emoji?: boolean;
+}
+/**
+ * Slack's mrkdwn: `*bold*`, `_italic_`, `~strike~`, `` `code` ``, ```` ```pre``` ````,
+ * `> quote`, `<url|label>`, `<@user>`, `<#channel|name>`, `<!here>`,
+ * `<!date^ts^{format}|fallback>` and `:emoji:`.
+ */
+export interface MrkdwnTextObject {
+    type: "mrkdwn";
+    text: string;
+    /** When true, URLs and mentions in the text are left as written. */
+    verbatim?: boolean;
+}
+export type TextObject = PlainTextObject | MrkdwnTextObject;
+/** A confirmation step before an interactive element's action goes through. */
+export interface ConfirmationDialogObject {
+    title: PlainTextObject;
+    text: TextObject;
+    confirm: PlainTextObject;
+    deny: PlainTextObject;
+    style?: "primary" | "danger";
+}
+/** One selectable item of a menu, checkbox group, radio group or overflow. */
+export interface OptionObject {
+    text: TextObject;
+    value: string;
+    description?: TextObject;
+    /** Overflow menus only: open this URL instead of dispatching the action. */
+    url?: string;
+}
+export interface OptionGroupObject {
+    label: PlainTextObject;
+    options: OptionObject[];
+}
+export type ConversationType = "im" | "mpim" | "private" | "public";
+export interface ConversationFilterObject {
+    include?: ConversationType[];
+    exclude_external_shared_channels?: boolean;
+    exclude_bot_users?: boolean;
+}
+export type DispatchActionTrigger = "on_enter_pressed" | "on_character_entered";
+export interface DispatchActionConfigurationObject {
+    trigger_actions_on?: DispatchActionTrigger[];
+}
+/** An image held by the platform, referenced by URL or id. */
+export interface SlackFileObject {
+    url?: string;
+    id?: string;
+}
+export declare const SlackIconNames: readonly ["archive", "book", "bookmark", "bot", "bug", "calendar", "call", "caret-left", "caret-right", "check", "clipboard", "code", "comment", "compass", "copy", "cube", "download", "edit", "email", "eye-closed", "eye-open", "file", "flag", "folder", "gear", "globe", "heart", "help", "image", "info", "key", "lightbulb", "link", "map", "mobile", "new-window", "pin", "plus", "refine", "refresh", "rocket", "save", "screen", "share", "sparkle", "star", "star-filled", "tag", "thumbs-down", "thumbs-up", "trash", "upload", "user", "warning"];
+export type SlackIconName = (typeof SlackIconNames)[number];
+export interface SlackIconObject {
+    type: "icon";
+    name: SlackIconName;
+}
+export interface TriggerInputParameter {
+    name: string;
+    value: string;
+}
+export interface TriggerObject {
+    url: string;
+    customizable_input_parameters?: TriggerInputParameter[];
+}
+export interface WorkflowObject {
+    trigger: TriggerObject;
+}
+export type ButtonStyle = "primary" | "danger";
+export interface ButtonElement {
+    type: "button";
+    text: PlainTextObject;
+    action_id?: string;
+    url?: string;
+    value?: string;
+    style?: ButtonStyle;
+    confirm?: ConfirmationDialogObject;
+    accessibility_label?: string;
+    /** Hands this prompt to the assistant instead of dispatching an action. */
+    agent_prompt?: string;
+}
+export interface WorkflowButtonElement {
+    type: "workflow_button";
+    text: PlainTextObject;
+    workflow: WorkflowObject;
+    action_id: string;
+    style?: ButtonStyle;
+    accessibility_label?: string;
+}
+export interface CheckboxesElement {
+    type: "checkboxes";
+    action_id?: string;
+    options: OptionObject[];
+    initial_options?: OptionObject[];
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+}
+export interface RadioButtonsElement {
+    type: "radio_buttons";
+    action_id?: string;
+    options: OptionObject[];
+    initial_option?: OptionObject;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+}
+export interface DatePickerElement {
+    type: "datepicker";
+    action_id?: string;
+    /** YYYY-MM-DD */
+    initial_date?: string;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface DateTimePickerElement {
+    type: "datetimepicker";
+    action_id?: string;
+    /** Unix seconds. */
+    initial_date_time?: number;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+}
+export interface TimePickerElement {
+    type: "timepicker";
+    action_id?: string;
+    /** HH:mm, 24-hour. */
+    initial_time?: string;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+    /** IANA zone shown under the picker. */
+    timezone?: string;
+}
+export interface EmailInputElement {
+    type: "email_text_input";
+    action_id?: string;
+    initial_value?: string;
+    dispatch_action_config?: DispatchActionConfigurationObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface UrlInputElement {
+    type: "url_text_input";
+    action_id?: string;
+    initial_value?: string;
+    dispatch_action_config?: DispatchActionConfigurationObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface NumberInputElement {
+    type: "number_input";
+    is_decimal_allowed: boolean;
+    action_id?: string;
+    initial_value?: string;
+    min_value?: string;
+    max_value?: string;
+    dispatch_action_config?: DispatchActionConfigurationObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface PlainTextInputElement {
+    type: "plain_text_input";
+    action_id?: string;
+    initial_value?: string;
+    multiline?: boolean;
+    min_length?: number;
+    max_length?: number;
+    dispatch_action_config?: DispatchActionConfigurationObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface RichTextInputElement {
+    type: "rich_text_input";
+    action_id: string;
+    initial_value?: RichTextBlock;
+    dispatch_action_config?: DispatchActionConfigurationObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+    min_lines?: number;
+    max_lines?: number;
+}
+export interface FileInputElement {
+    type: "file_input";
+    action_id?: string;
+    filetypes?: string[];
+    max_files?: number;
+}
+export interface ImageElement {
+    type: "image";
+    alt_text: string;
+    image_url?: string;
+    slack_file?: SlackFileObject;
+}
+export interface OverflowElement {
+    type: "overflow";
+    action_id?: string;
+    options: OptionObject[];
+    confirm?: ConfirmationDialogObject;
+}
+export interface StaticSelectElement {
+    type: "static_select";
+    action_id?: string;
+    options?: OptionObject[];
+    option_groups?: OptionGroupObject[];
+    initial_option?: OptionObject;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface ExternalSelectElement {
+    type: "external_select";
+    action_id?: string;
+    initial_option?: OptionObject;
+    min_query_length?: number;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface UsersSelectElement {
+    type: "users_select";
+    action_id?: string;
+    initial_user?: string;
+    confirm?: ConfirmationDialogObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface ConversationsSelectElement {
+    type: "conversations_select";
+    action_id?: string;
+    initial_conversation?: string;
+    default_to_current_conversation?: boolean;
+    confirm?: ConfirmationDialogObject;
+    response_url_enabled?: boolean;
+    filter?: ConversationFilterObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface ChannelsSelectElement {
+    type: "channels_select";
+    action_id?: string;
+    initial_channel?: string;
+    confirm?: ConfirmationDialogObject;
+    response_url_enabled?: boolean;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface MultiStaticSelectElement {
+    type: "multi_static_select";
+    action_id?: string;
+    options?: OptionObject[];
+    option_groups?: OptionGroupObject[];
+    initial_options?: OptionObject[];
+    confirm?: ConfirmationDialogObject;
+    max_selected_items?: number;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface MultiExternalSelectElement {
+    type: "multi_external_select";
+    action_id?: string;
+    min_query_length?: number;
+    initial_options?: OptionObject[];
+    confirm?: ConfirmationDialogObject;
+    max_selected_items?: number;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface MultiUsersSelectElement {
+    type: "multi_users_select";
+    action_id?: string;
+    initial_users?: string[];
+    confirm?: ConfirmationDialogObject;
+    max_selected_items?: number;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface MultiConversationsSelectElement {
+    type: "multi_conversations_select";
+    action_id?: string;
+    initial_conversations?: string[];
+    default_to_current_conversation?: boolean;
+    confirm?: ConfirmationDialogObject;
+    max_selected_items?: number;
+    filter?: ConversationFilterObject;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface MultiChannelsSelectElement {
+    type: "multi_channels_select";
+    action_id?: string;
+    initial_channels?: string[];
+    confirm?: ConfirmationDialogObject;
+    max_selected_items?: number;
+    focus_on_load?: boolean;
+    placeholder?: PlainTextObject;
+}
+export interface FeedbackButton {
+    text: PlainTextObject;
+    value: string;
+    accessibility_label?: string;
+}
+export interface FeedbackButtonsElement {
+    type: "feedback_buttons";
+    positive_button: FeedbackButton;
+    negative_button: FeedbackButton;
+    action_id?: string;
+}
+export interface IconButtonElement {
+    type: "icon_button";
+    icon: "trash";
+    text: PlainTextObject;
+    action_id?: string;
+    value?: string;
+    confirm?: ConfirmationDialogObject;
+    accessibility_label?: string;
+    visible_to_user_ids?: string[];
+}
+/** A clickable source reference on a task card. */
+export interface UrlSourceElement {
+    type: "url";
+    url: string;
+    text: string;
+}
+export type SelectElement = StaticSelectElement | ExternalSelectElement | UsersSelectElement | ConversationsSelectElement | ChannelsSelectElement;
+export type MultiSelectElement = MultiStaticSelectElement | MultiExternalSelectElement | MultiUsersSelectElement | MultiConversationsSelectElement | MultiChannelsSelectElement;
+/** What an `actions` block holds. */
+export type ActionsElement = ButtonElement | WorkflowButtonElement | CheckboxesElement | RadioButtonsElement | DatePickerElement | DateTimePickerElement | TimePickerElement | OverflowElement | SelectElement | MultiSelectElement | RichTextInputElement;
+/** What an `input` block holds. */
+export type InputElement = CheckboxesElement | RadioButtonsElement | DatePickerElement | DateTimePickerElement | TimePickerElement | EmailInputElement | UrlInputElement | NumberInputElement | PlainTextInputElement | RichTextInputElement | FileInputElement | SelectElement | MultiSelectElement;
+/** What a `section` block's `accessory` holds. */
+export type SectionAccessory = ButtonElement | WorkflowButtonElement | CheckboxesElement | RadioButtonsElement | DatePickerElement | TimePickerElement | ImageElement | OverflowElement | SelectElement | MultiSelectElement;
+export type ContextElement = ImageElement | TextObject;
+export type ContextActionsElement = FeedbackButtonsElement | IconButtonElement;
+export type BlockElement = ActionsElement | InputElement | SectionAccessory | ContextActionsElement | UrlSourceElement;
+export interface RichTextStyle {
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    highlight?: boolean;
+    client_highlight?: boolean;
+    underline?: boolean;
+    unlink?: boolean;
+    /** Inline code; what the composer emits for backticked text. */
+    code?: boolean;
+}
+export interface RichTextTextElement {
+    type: "text";
+    text: string;
+    style?: RichTextStyle;
+}
+export interface RichTextLinkElement {
+    type: "link";
+    url: string;
+    text?: string;
+    unsafe?: boolean;
+    from_llm?: boolean;
+    is_slack_url?: boolean;
+    truncated?: boolean;
+    style?: RichTextStyle;
+}
+export interface RichTextEmojiElement {
+    type: "emoji";
+    name: string;
+    /** Code points as lowercase hex, e.g. "1f44b" or "1f44b-1f3fb". */
+    unicode?: string;
+}
+export interface RichTextUserElement {
+    type: "user";
+    user_id: string;
+    style?: RichTextStyle;
+    from_llm?: boolean;
+}
+export interface RichTextUsergroupElement {
+    type: "usergroup";
+    usergroup_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextChannelElement {
+    type: "channel";
+    channel_id: string;
+    tab_id?: string;
+    style?: RichTextStyle;
+    from_llm?: boolean;
+}
+export interface RichTextBroadcastElement {
+    type: "broadcast";
+    range: "here" | "channel" | "everyone";
+    style?: RichTextStyle;
+}
+export interface RichTextDateElement {
+    type: "date";
+    /** Unix seconds. */
+    timestamp: number;
+    /** Template with `{date_short}`-style tokens. */
+    format: string;
+    timezone?: string;
+    url?: string;
+    fallback?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextColorElement {
+    type: "color";
+    /** Hex, e.g. "#F405B3". */
+    value: string;
+    style?: RichTextStyle;
+}
+export type TagColor = "gray" | "brown" | "purple" | "indigo" | "blue" | "green" | "yellow" | "orange" | "red";
+export interface RichTextTagElement {
+    type: "tag";
+    text: string;
+    color?: TagColor;
+    style?: RichTextStyle;
+}
+export type CitationDetails = {
+    citation_type: "file";
+    descriptor?: string;
+    file_id?: string;
+} | {
+    citation_type: "external";
+    app_name?: string;
+    app_icon_url?: string;
+} | {
+    citation_type: "web";
+    display_name?: string;
+    title?: string;
+    snippet?: string;
+} | {
+    citation_type: "message";
+    channel?: string;
+    message_ts?: string;
+} | {
+    citation_type: "memory";
+    memory_id?: string;
+};
+export interface RichTextCitationElement {
+    type: "citation";
+    url: string;
+    text: string;
+    index: number;
+    details: CitationDetails;
+    from_llm?: boolean;
+    is_slack_url?: boolean;
+}
+export interface RichTextFileElement {
+    type: "file";
+    file_id: string;
+    style?: RichTextStyle;
+    text?: string;
+    url?: string;
+    is_skill_invocation?: boolean;
+}
+export interface RichTextCanvasElement {
+    type: "canvas";
+    file_id: string;
+    label?: string;
+    hide_title?: boolean;
+    section_id?: string;
+    style?: RichTextStyle;
+    text?: string;
+    url?: string;
+    is_skill_invocation?: boolean;
+}
+export interface RichTextCanvasUserMentionElement {
+    type: "canvas_user_mention";
+    user_id: string;
+    thread_id?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextCanvasMessageUnfurlElement {
+    type: "canvas_message_unfurl";
+    root_message_ts: string;
+    root_message_channel: string;
+    style?: RichTextStyle;
+}
+export interface RichTextListRecordElement {
+    type: "list_record";
+    file_id: string;
+    record_id?: string;
+    view_id?: string;
+    style?: RichTextStyle;
+    text?: string;
+    url?: string;
+}
+export interface RichTextMessageMentionElement {
+    type: "message_mention";
+    channel_id: string;
+    message_ts: string;
+    author_id?: string;
+    thread_ts?: string;
+    style?: RichTextStyle;
+    text?: string;
+    url?: string;
+}
+export interface RichTextAttachmentMentionElement {
+    type: "attachment_mention";
+    url: string;
+    text?: string;
+    app_id?: string;
+    entity_id?: string;
+    icon_url?: string;
+    channel_id?: string;
+    ts?: string;
+    full_size_preview_enabled?: boolean;
+    icon_name?: string;
+    reference_object_type?: string;
+    product_name?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextSalesforceDataFieldElement {
+    type: "salesforce_data_field";
+    salesforce_record_id: string;
+    salesforce_field_label?: string;
+    salesforce_field_api_name?: string;
+    salesforce_include_field_label?: boolean;
+    style?: RichTextStyle;
+}
+export interface RichTextTeamElement {
+    type: "team";
+    team_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextWorkObjectMentionElement {
+    type: "work_object_mention";
+    entity_id: string;
+    app_id: string;
+    text: string;
+    url: string;
+    icon_url?: string;
+    full_size_preview_enabled?: boolean;
+    product_name?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextWorkflowMentionElement {
+    type: "workflow_mention";
+    workflow_id: string;
+    function_trigger_id: string;
+    text: string;
+    url?: string;
+    channel_id?: string;
+    ts?: string;
+    style?: RichTextStyle;
+}
+/** An inline run inside a section, list item, quote or preformatted block. */
+export type RichTextElement = RichTextTextElement | RichTextLinkElement | RichTextEmojiElement | RichTextUserElement | RichTextUsergroupElement | RichTextChannelElement | RichTextBroadcastElement | RichTextDateElement | RichTextColorElement | RichTextTagElement | RichTextCitationElement | RichTextFileElement | RichTextCanvasElement | RichTextCanvasUserMentionElement | RichTextCanvasMessageUnfurlElement | RichTextListRecordElement | RichTextMessageMentionElement | RichTextAttachmentMentionElement | RichTextSalesforceDataFieldElement | RichTextTeamElement | RichTextWorkObjectMentionElement | RichTextWorkflowMentionElement;
+export interface RichTextSection {
+    type: "rich_text_section";
+    elements: RichTextElement[];
+}
+export interface RichTextList {
+    type: "rich_text_list";
+    style: "bullet" | "ordered";
+    elements: RichTextSection[];
+    indent?: number;
+    offset?: number;
+    border?: number;
+}
+export interface RichTextPreformatted {
+    type: "rich_text_preformatted";
+    elements: RichTextElement[];
+    border?: number;
+    language?: string;
+}
+export interface RichTextQuote {
+    type: "rich_text_quote";
+    elements: RichTextElement[];
+    border?: number;
+}
+export type RichTextPart = RichTextSection | RichTextList | RichTextPreformatted | RichTextQuote;
+export interface ActionsBlock {
+    type: "actions";
+    elements: ActionsElement[];
+    block_id?: string;
+}
+export type AlertLevel = "default" | "info" | "warning" | "error" | "success";
+export interface AlertBlock {
+    type: "alert";
+    text: TextObject;
+    level?: AlertLevel;
+    block_id?: string;
+}
+export type MetricTrend = "up" | "down" | "flat";
+/** Whether a figure's move is good news: costs going up are negative. */
+export type MetricTone = "positive" | "negative" | "neutral";
+export interface MetricItem {
+    label: string;
+    /** Already formatted for display ("$12,4 M"). */
+    value: string;
+    change?: string;
+    trend?: MetricTrend;
+    tone?: MetricTone;
+    caption?: string;
+}
+/** Headline figures the answer already holds; live ones are canvas stats. */
+export interface MetricsBlock {
+    type: "metrics";
+    title?: string;
+    items: MetricItem[];
+    block_id?: string;
+}
+export interface CardBlock {
+    type: "card";
+    block_id?: string;
+    hero_image?: ImageElement;
+    icon?: ImageElement;
+    title?: TextObject;
+    subtitle?: TextObject;
+    body?: TextObject;
+    actions?: ButtonElement[];
+    slack_icon?: SlackIconObject;
+    subtext?: TextObject;
+}
+export interface CarouselBlock {
+    type: "carousel";
+    elements: CardBlock[];
+    block_id?: string;
+}
+export type ContainerWidth = "narrow" | "standard" | "wide" | "full";
+/** The blocks a container may hold. */
+export type ContainerChildBlock = ActionsBlock | ContextBlock | DividerBlock | FileBlock | HeaderBlock | ImageBlock | InputBlock | RichTextBlock | SectionBlock | TableBlock | VideoBlock;
+export interface ContainerBlock {
+    type: "container";
+    title?: PlainTextObject;
+    rich_text_title?: RichTextBlock;
+    subtitle?: TextObject;
+    child_blocks: ContainerChildBlock[];
+    block_id?: string;
+    width?: ContainerWidth;
+    icon?: ImageElement;
+    is_collapsible?: boolean;
+    default_collapsed?: boolean;
+    has_header_divider?: boolean;
+}
+export interface ContextBlock {
+    type: "context";
+    elements: ContextElement[];
+    block_id?: string;
+}
+export interface ContextActionsBlock {
+    type: "context_actions";
+    elements: ContextActionsElement[];
+    block_id?: string;
+}
+export interface RawTextCell {
+    type: "raw_text";
+    text: string;
+}
+export interface RawNumberCell {
+    type: "raw_number";
+    value: number;
+    text: string;
+}
+export type TableCell = RawTextCell | RawNumberCell | RichTextBlock;
+export interface DataTableBlock {
+    type: "data_table";
+    /** The first row is the header. */
+    rows: TableCell[][];
+    block_id?: string;
+    page_size?: number;
+    caption: string;
+    row_header_column_index?: number;
+}
+export interface PieSegment {
+    label: string;
+    value: number;
+}
+export interface DataPoint {
+    label: string;
+    value: number;
+}
+export interface DataSeries {
+    name: string;
+    data: DataPoint[];
+}
+export interface AxisConfig {
+    categories: string[];
+    x_label?: string;
+    y_label?: string;
+}
+export interface PieChartSpec {
+    type: "pie";
+    segments: PieSegment[];
+}
+export interface BarChartSpec {
+    type: "bar";
+    series: DataSeries[];
+    axis_config: AxisConfig;
+}
+export interface AreaChartSpec {
+    type: "area";
+    series: DataSeries[];
+    axis_config: AxisConfig;
+}
+export interface LineChartSpec {
+    type: "line";
+    series: DataSeries[];
+    axis_config: AxisConfig;
+}
+export type ChartSpec = PieChartSpec | BarChartSpec | AreaChartSpec | LineChartSpec;
+export interface DataVisualizationBlock {
+    type: "data_visualization";
+    title: string;
+    chart: ChartSpec;
+    block_id?: string;
+}
+export interface DividerBlock {
+    type: "divider";
+    block_id?: string;
+}
+export interface FileBlock {
+    type: "file";
+    external_id: string;
+    source: "remote";
+    block_id?: string;
+}
+export interface HeaderBlock {
+    type: "header";
+    text: PlainTextObject;
+    block_id?: string;
+    level?: 1 | 2 | 3 | 4;
+}
+export interface ImageBlock {
+    type: "image";
+    alt_text: string;
+    image_url?: string;
+    slack_file?: SlackFileObject;
+    title?: PlainTextObject;
+    block_id?: string;
+}
+export interface InputBlock {
+    type: "input";
+    label: PlainTextObject;
+    element: InputElement;
+    dispatch_action?: boolean;
+    block_id?: string;
+    hint?: PlainTextObject;
+    optional?: boolean;
+}
+/** Standard markdown (headers, lists, tables, task lists, code). */
+export interface MarkdownBlock {
+    type: "markdown";
+    text: string;
+    block_id?: string;
+}
+export type TaskStatus = "pending" | "in_progress" | "complete" | "error";
+/** A task inside a plan: a task card without its `type`. */
+export interface PlanTask {
+    task_id: string;
+    title: string;
+    status: TaskStatus;
+    details?: RichTextBlock;
+    output?: RichTextBlock;
+    sources?: UrlSourceElement[];
+    icon?: SlackIconObject;
+    hide_title?: boolean;
+}
+export interface PlanBlock {
+    type: "plan";
+    title: string;
+    tasks: PlanTask[];
+    block_id?: string;
+}
+export interface RichTextBlock {
+    type: "rich_text";
+    elements: RichTextPart[];
+    block_id?: string;
+}
+export interface SectionBlock {
+    type: "section";
+    text?: TextObject;
+    block_id?: string;
+    /** Up to ten text objects in two columns. */
+    fields?: TextObject[];
+    accessory?: SectionAccessory;
+    /** Always show the full text instead of folding it behind "see more". */
+    expand?: boolean;
+}
+export interface TableColumnSetting {
+    align?: "left" | "center" | "right";
+    is_wrapped?: boolean;
+}
+export interface TableBlock {
+    type: "table";
+    block_id?: string;
+    /** The first row is the header. */
+    rows: TableCell[][];
+    column_settings?: Array<TableColumnSetting | null>;
+}
+export interface TaskCardBlock extends PlanTask {
+    type: "task_card";
+    block_id?: string;
+}
+export interface VideoBlock {
+    type: "video";
+    alt_text: string;
+    author_name?: string;
+    block_id?: string;
+    description?: PlainTextObject;
+    provider_icon_url?: string;
+    provider_name?: string;
+    title: PlainTextObject;
+    title_url?: string;
+    thumbnail_url: string;
+    video_url: string;
+}
+/** Every block a message may carry. */
+export type MessageBlock = ActionsBlock | AlertBlock | CardBlock | CarouselBlock | ContainerBlock | ContextBlock | ContextActionsBlock | DataTableBlock | DataVisualizationBlock | DividerBlock | FileBlock | HeaderBlock | ImageBlock | InputBlock | MarkdownBlock | MetricsBlock | PlanBlock | RichTextBlock | SectionBlock | TableBlock | TaskCardBlock | VideoBlock;
+export type MessageBlockType = MessageBlock["type"];
+export declare const MessageBlockTypes: readonly ["actions", "alert", "card", "carousel", "container", "context", "context_actions", "data_table", "data_visualization", "divider", "file", "header", "image", "input", "markdown", "metrics", "plan", "rich_text", "section", "table", "task_card", "video"];
+/** A message holds at most this many blocks. */
+export declare const MaxMessageBlocks = 50;
+/**
+ * The value one element holds — the entry `state.values[block_id][action_id]`
+ * carries in a `block_actions` payload, and what a submitted form reports for
+ * every input in the message.
+ */
+export interface BlockValue {
+    type: BlockElement["type"];
+    /** Buttons, text inputs, number inputs. */
+    value?: string;
+    selected_option?: OptionObject | null;
+    selected_options?: OptionObject[];
+    /** YYYY-MM-DD */
+    selected_date?: string | null;
+    /** HH:mm */
+    selected_time?: string | null;
+    /** Unix seconds. */
+    selected_date_time?: number | null;
+    selected_user?: string | null;
+    selected_users?: string[];
+    selected_conversation?: string | null;
+    selected_conversations?: string[];
+    selected_channel?: string | null;
+    selected_channels?: string[];
+    rich_text_value?: RichTextBlock;
+    files?: Array<{
+        name: string;
+        size: number;
+        type: string;
+    }>;
+    /** The URL a button or overflow option opened, when it did. */
+    url?: string;
+}
+/** Every input's value in a message, keyed by block id then action id. */
+export interface BlockState {
+    values: Record<string, Record<string, BlockValue>>;
+}
+/**
+ * One interaction with a message: the element that fired, its value, and
+ * the state of every input block in the message at that moment.
+ */
+export interface BlockAction extends BlockValue {
+    block_id: string;
+    action_id: string;
+    /** The label the person saw: a button's text, an option's text. */
+    label?: string;
+    /** A button's `agent_prompt`: what to hand the assistant instead of an action. */
+    agent_prompt?: string;
+    state?: BlockState;
+}
+/** A rich text block as one string, lines between its parts. */
+export declare const richTextText: (block: RichTextBlock) => string;
+/**
+ * A message's blocks as plain text: what a surface without the renderer
+ * shows, and what the model reads back when a conversation replays.
+ */
+export declare const blockKitText: (blocks: ReadonlyArray<MessageBlock>) => string;
+/**
+ * One line a person would read for an interaction: the button they clicked,
+ * the option they picked, the value they entered.
+ */
+export declare const blockActionText: (action: BlockAction) => string;
+//# sourceMappingURL=block-kit.d.ts.map