@tightknitai/block-kitchen 0.10.17 → 0.10.19

package/dist/{palette-Cxh1yNzW.d.cts → palette-DNUiqoQK.d.cts}

@@ -915,6 +915,44 @@ interface CustomEmoji {
     url: string | null;
     alias: string | null;
 }
+/**
+ * A person the rich text editor's `@` picker offers, returned by
+ * {@link MentionsConfig.searchUsers}.
+ */
+interface MentionUser {
+    /** Slack user id (`U…` / `W…`), written to the rich text `user` element's `user_id`. */
+    id: string;
+    /** Name shown in the picker row and on the inserted mention. */
+    name: string;
+    /** Avatar shown in the picker row. Ignored unless a safe image URL; rows without one show an initial. */
+    avatarUrl?: string | null;
+}
+/**
+ * Opt-in `@` mentions for the rich text editor, passed as
+ * {@link BlockKitchenBaseProps.mentions}. Typing `@` (or the toolbar's
+ * mention button) opens a picker backed by the host's search; picking someone
+ * inserts a rich text `user` element (`{ type: 'user', user_id }`).
+ *
+ * Like every other I/O concern, the search is brokered by the host: the
+ * builder never looks people up itself.
+ */
+interface MentionsConfig {
+    /**
+     * Searches the people the picker offers. Called with the text typed after
+     * `@` (empty right after it). Calls are debounced, and `signal` aborts once
+     * a newer query supersedes this one. A rejection shows an empty list.
+     */
+    searchUsers: (query: string, options: {
+        signal: AbortSignal;
+    }) => Promise<MentionUser[]>;
+    /**
+     * Optional. Labels a mention in the editor by user id, including mentions
+     * that came with the draft or a loaded message. Called while rendering, so
+     * keep it synchronous. Return `undefined` to fall back to the name picked
+     * from the search, then the raw id.
+     */
+    getUserName?: (userId: string) => string | undefined;
+}
 /**
  * Hooks forwarded to `slack-blocks-to-jsx`'s `<Message>` so the consumer can
  * resolve user mentions, channel mentions, custom emojis, and links to
@@ -1032,6 +1070,13 @@ interface BlockKitchenBaseProps {
      * is never serialized into the emitted Block Kit JSON.
      */
     customEmojis?: CustomEmoji[];
+    /**
+     * Opt-in `@` mentions in the rich text editor: an `@` trigger and a toolbar
+     * button that search people through the host. See {@link MentionsConfig}.
+     * Without it, mentions already in the draft still round-trip and display by
+     * raw id, but there is no picker.
+     */
+    mentions?: MentionsConfig;
     /**
      * Opt-in: load an existing Slack message into the editor. Adds a
      * "Find message" toolbar entry — the user pastes a permalink (or picks a
@@ -1315,4 +1360,4 @@ interface BlockKitchenComposeOnlyProps {
  */
 type BlockKitchenProps = BlockKitchenBaseProps & (BlockKitchenSendProps | BlockKitchenComposeOnlyProps);
 
-export { type RecentMessage as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type DataVisualizationBlock as D, type EditableVia as E, type FeedbackButtonSubobject as F, type IconButtonIcon as G, type HeaderLevel as H, type IconButtonElement as I, type InputBlock as J, type LoadResult as K, type LoadMessageInput as L, type LoadedMessage as M, type LoadingConfig as N, type MarkdownBlock as O, type PreviewSurface as P, type PaletteMode as Q, type PaletteSection as R, type SupportedBlock as S, type Template as T, type PaletteVariant as U, type PieChart as V, type PieChartSegment as W, type PlanBlock as X, type PreviewHooks as Y, type PrimaryActionConfig as Z, type PrimaryActionContext as _, type SendAsUserStatus as a, type SendResult as a0, type SupportedBlockType as a1, type SupportedHeaderBlock as a2, type TableBlock as a3, type TableCell as a4, type TableColumnSetting as a5, type TaskCardBlock as a6, type TaskCardStatus as a7, type UpdatePayload as a8, type UpdateResult as a9, type UrlSourceElement as aa, type ValidationSummary as ab, type VideoBlock as ac, defaultPalette as ad, extraAlertVariant as ae, legacyInputVariants as af, buildVariantById as ag, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockKitchenBaseProps as f, type BlockKitchenComposeOnlyProps as g, type BlockKitchenSendProps as h, type BrandPreset as i, type BrandTheme as j, type BrandTokens as k, type BuilderBlock as l, type CardBlock as m, type CarouselBlock as n, type CartesianChart as o, type Chart as p, type ChartAxisConfig as q, type ChartDataPoint as r, type ChartSeries as s, type ChartType as t, type ContainerBlock as u, type ContainerChildBlock as v, type ContextActionsBlock as w, type ContextActionsElement as x, type CustomEmoji as y, type FeedbackButtonsElement as z };
+export { type PrimaryActionConfig as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type DataVisualizationBlock as D, type EditableVia as E, type FeedbackButtonSubobject as F, type IconButtonIcon as G, type HeaderLevel as H, type IconButtonElement as I, type InputBlock as J, type LoadResult as K, type LoadMessageInput as L, type LoadedMessage as M, type LoadingConfig as N, type MarkdownBlock as O, type PreviewSurface as P, type MentionUser as Q, type MentionsConfig as R, type SupportedBlock as S, type Template as T, type PaletteMode as U, type PaletteSection as V, type PaletteVariant as W, type PieChart as X, type PieChartSegment as Y, type PlanBlock as Z, type PreviewHooks as _, type SendAsUserStatus as a, type PrimaryActionContext as a0, type RecentMessage as a1, type SendResult as a2, type SupportedBlockType as a3, type SupportedHeaderBlock as a4, type TableBlock as a5, type TableCell as a6, type TableColumnSetting as a7, type TaskCardBlock as a8, type TaskCardStatus as a9, type UpdatePayload as aa, type UpdateResult as ab, type UrlSourceElement as ac, type ValidationSummary as ad, type VideoBlock as ae, defaultPalette as af, extraAlertVariant as ag, legacyInputVariants as ah, buildVariantById as ai, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockKitchenBaseProps as f, type BlockKitchenComposeOnlyProps as g, type BlockKitchenSendProps as h, type BrandPreset as i, type BrandTheme as j, type BrandTokens as k, type BuilderBlock as l, type CardBlock as m, type CarouselBlock as n, type CartesianChart as o, type Chart as p, type ChartAxisConfig as q, type ChartDataPoint as r, type ChartSeries as s, type ChartType as t, type ContainerBlock as u, type ContainerChildBlock as v, type ContextActionsBlock as w, type ContextActionsElement as x, type CustomEmoji as y, type FeedbackButtonsElement as z };

package/dist/{palette-Cxh1yNzW.d.ts → palette-DNUiqoQK.d.ts}

@@ -915,6 +915,44 @@ interface CustomEmoji {
     url: string | null;
     alias: string | null;
 }
+/**
+ * A person the rich text editor's `@` picker offers, returned by
+ * {@link MentionsConfig.searchUsers}.
+ */
+interface MentionUser {
+    /** Slack user id (`U…` / `W…`), written to the rich text `user` element's `user_id`. */
+    id: string;
+    /** Name shown in the picker row and on the inserted mention. */
+    name: string;
+    /** Avatar shown in the picker row. Ignored unless a safe image URL; rows without one show an initial. */
+    avatarUrl?: string | null;
+}
+/**
+ * Opt-in `@` mentions for the rich text editor, passed as
+ * {@link BlockKitchenBaseProps.mentions}. Typing `@` (or the toolbar's
+ * mention button) opens a picker backed by the host's search; picking someone
+ * inserts a rich text `user` element (`{ type: 'user', user_id }`).
+ *
+ * Like every other I/O concern, the search is brokered by the host: the
+ * builder never looks people up itself.
+ */
+interface MentionsConfig {
+    /**
+     * Searches the people the picker offers. Called with the text typed after
+     * `@` (empty right after it). Calls are debounced, and `signal` aborts once
+     * a newer query supersedes this one. A rejection shows an empty list.
+     */
+    searchUsers: (query: string, options: {
+        signal: AbortSignal;
+    }) => Promise<MentionUser[]>;
+    /**
+     * Optional. Labels a mention in the editor by user id, including mentions
+     * that came with the draft or a loaded message. Called while rendering, so
+     * keep it synchronous. Return `undefined` to fall back to the name picked
+     * from the search, then the raw id.
+     */
+    getUserName?: (userId: string) => string | undefined;
+}
 /**
  * Hooks forwarded to `slack-blocks-to-jsx`'s `<Message>` so the consumer can
  * resolve user mentions, channel mentions, custom emojis, and links to
@@ -1032,6 +1070,13 @@ interface BlockKitchenBaseProps {
      * is never serialized into the emitted Block Kit JSON.
      */
     customEmojis?: CustomEmoji[];
+    /**
+     * Opt-in `@` mentions in the rich text editor: an `@` trigger and a toolbar
+     * button that search people through the host. See {@link MentionsConfig}.
+     * Without it, mentions already in the draft still round-trip and display by
+     * raw id, but there is no picker.
+     */
+    mentions?: MentionsConfig;
     /**
      * Opt-in: load an existing Slack message into the editor. Adds a
      * "Find message" toolbar entry — the user pastes a permalink (or picks a
@@ -1315,4 +1360,4 @@ interface BlockKitchenComposeOnlyProps {
  */
 type BlockKitchenProps = BlockKitchenBaseProps & (BlockKitchenSendProps | BlockKitchenComposeOnlyProps);
 
-export { type RecentMessage as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type DataVisualizationBlock as D, type EditableVia as E, type FeedbackButtonSubobject as F, type IconButtonIcon as G, type HeaderLevel as H, type IconButtonElement as I, type InputBlock as J, type LoadResult as K, type LoadMessageInput as L, type LoadedMessage as M, type LoadingConfig as N, type MarkdownBlock as O, type PreviewSurface as P, type PaletteMode as Q, type PaletteSection as R, type SupportedBlock as S, type Template as T, type PaletteVariant as U, type PieChart as V, type PieChartSegment as W, type PlanBlock as X, type PreviewHooks as Y, type PrimaryActionConfig as Z, type PrimaryActionContext as _, type SendAsUserStatus as a, type SendResult as a0, type SupportedBlockType as a1, type SupportedHeaderBlock as a2, type TableBlock as a3, type TableCell as a4, type TableColumnSetting as a5, type TaskCardBlock as a6, type TaskCardStatus as a7, type UpdatePayload as a8, type UpdateResult as a9, type UrlSourceElement as aa, type ValidationSummary as ab, type VideoBlock as ac, defaultPalette as ad, extraAlertVariant as ae, legacyInputVariants as af, buildVariantById as ag, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockKitchenBaseProps as f, type BlockKitchenComposeOnlyProps as g, type BlockKitchenSendProps as h, type BrandPreset as i, type BrandTheme as j, type BrandTokens as k, type BuilderBlock as l, type CardBlock as m, type CarouselBlock as n, type CartesianChart as o, type Chart as p, type ChartAxisConfig as q, type ChartDataPoint as r, type ChartSeries as s, type ChartType as t, type ContainerBlock as u, type ContainerChildBlock as v, type ContextActionsBlock as w, type ContextActionsElement as x, type CustomEmoji as y, type FeedbackButtonsElement as z };
+export { type PrimaryActionConfig as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type DataVisualizationBlock as D, type EditableVia as E, type FeedbackButtonSubobject as F, type IconButtonIcon as G, type HeaderLevel as H, type IconButtonElement as I, type InputBlock as J, type LoadResult as K, type LoadMessageInput as L, type LoadedMessage as M, type LoadingConfig as N, type MarkdownBlock as O, type PreviewSurface as P, type MentionUser as Q, type MentionsConfig as R, type SupportedBlock as S, type Template as T, type PaletteMode as U, type PaletteSection as V, type PaletteVariant as W, type PieChart as X, type PieChartSegment as Y, type PlanBlock as Z, type PreviewHooks as _, type SendAsUserStatus as a, type PrimaryActionContext as a0, type RecentMessage as a1, type SendResult as a2, type SupportedBlockType as a3, type SupportedHeaderBlock as a4, type TableBlock as a5, type TableCell as a6, type TableColumnSetting as a7, type TaskCardBlock as a8, type TaskCardStatus as a9, type UpdatePayload as aa, type UpdateResult as ab, type UrlSourceElement as ac, type ValidationSummary as ad, type VideoBlock as ae, defaultPalette as af, extraAlertVariant as ag, legacyInputVariants as ah, buildVariantById as ai, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockKitchenBaseProps as f, type BlockKitchenComposeOnlyProps as g, type BlockKitchenSendProps as h, type BrandPreset as i, type BrandTheme as j, type BrandTokens as k, type BuilderBlock as l, type CardBlock as m, type CarouselBlock as n, type CartesianChart as o, type Chart as p, type ChartAxisConfig as q, type ChartDataPoint as r, type ChartSeries as s, type ChartType as t, type ContainerBlock as u, type ContainerChildBlock as v, type ContextActionsBlock as w, type ContextActionsElement as x, type CustomEmoji as y, type FeedbackButtonsElement as z };

package/dist/palette.d.cts

@@ -1,3 +1,3 @@
-export { Q as PaletteMode, R as PaletteSection, U as PaletteVariant, S as SupportedBlock, a1 as SupportedBlockType, ag as buildVariantById, ad as defaultPalette, ae as extraAlertVariant, af as legacyInputVariants } from './palette-Cxh1yNzW.cjs';
+export { U as PaletteMode, V as PaletteSection, W as PaletteVariant, S as SupportedBlock, a3 as SupportedBlockType, ai as buildVariantById, af as defaultPalette, ag as extraAlertVariant, ah as legacyInputVariants } from './palette-DNUiqoQK.cjs';
 import 'react';
 import 'slack-web-api-client';

package/dist/palette.d.ts

@@ -1,3 +1,3 @@
-export { Q as PaletteMode, R as PaletteSection, U as PaletteVariant, S as SupportedBlock, a1 as SupportedBlockType, ag as buildVariantById, ad as defaultPalette, ae as extraAlertVariant, af as legacyInputVariants } from './palette-Cxh1yNzW.js';
+export { U as PaletteMode, V as PaletteSection, W as PaletteVariant, S as SupportedBlock, a3 as SupportedBlockType, ai as buildVariantById, af as defaultPalette, ag as extraAlertVariant, ah as legacyInputVariants } from './palette-DNUiqoQK.js';
 import 'react';
 import 'slack-web-api-client';