@tightknitai/block-kitchen 0.10.23 → 0.10.25

package/dist/{palette-DFTL0Han.d.cts → palette-DTE9U5si.d.cts}

@@ -99,6 +99,30 @@ interface PaletteVariant {
      * mode, and unnecessary for a variant whose label already stands alone.
      */
     basicLabel?: string;
+    /**
+     * A short tag shown beside the label, e.g. the plan a block belongs to
+     * ("Enterprise"). Shown whether or not the variant is `locked`.
+     */
+    badge?: PaletteVariantBadge;
+    /**
+     * Shows the variant without letting anyone add it: it can't be dragged,
+     * and it has no add button. Use it to show a block the user's plan doesn't
+     * include, alongside a `badge` saying which one does. Picking it calls
+     * `onLockedSelect`.
+     */
+    locked?: boolean;
+    /**
+     * Called when the user picks a `locked` variant, e.g. to open an upgrade
+     * prompt. Without it a locked variant is inert.
+     */
+    onLockedSelect?: () => void;
+}
+/** A tag shown beside a palette variant's label. See {@link PaletteVariant.badge}. */
+interface PaletteVariantBadge {
+    /** Visible text, e.g. `'Enterprise'`. */
+    label: string;
+    /** Optional icon shown before the text, e.g. a Lucide icon component. */
+    icon?: ComponentType<SVGProps<SVGSVGElement>>;
 }
 /**
  * One section in the palette. Sections group related variants under a
@@ -757,6 +781,36 @@ interface BlockAction {
     /** Called with the block's position when the button is clicked. */
     onSelect: (position: BlockPosition) => void;
 }
+/** What a {@link CustomBlockEditor}'s component is rendered with. */
+interface CustomBlockEditorProps {
+    /** The block being edited. */
+    block: SupportedBlock;
+    /**
+     * Replaces the block. The result must still be ordinary Block Kit: it is
+     * previewed, validated and sent like any other block.
+     */
+    onChange: (next: SupportedBlock) => void;
+}
+/**
+ * A host-owned form for blocks your app gives a meaning of its own, e.g. a
+ * "Share on LinkedIn" button whose URL is built from the post text. It
+ * replaces the built-in form in the block's edit popover. The block itself
+ * stays ordinary Block Kit, so preview, validation and sending don't change.
+ */
+interface CustomBlockEditor {
+    /** Stable identifier. */
+    id: string;
+    /** Names the block in the editor's heading, e.g. "Edit Share on LinkedIn". */
+    label: string;
+    /**
+     * Whether this editor handles a block; the first match wins. Match on what
+     * the block itself holds (a URL, an `action_id`): a message loaded back
+     * from Slack carries nothing else.
+     */
+    match: (block: SupportedBlock) => boolean;
+    /** The form. Rendered as a component, so it can use hooks. */
+    component: ComponentType<CustomBlockEditorProps>;
+}
 /**
  * A host-owned primary action for compose-only mode, rendered in the
  * toolbar slot where the built-in "Review & send" button normally sits.
@@ -1161,6 +1215,19 @@ interface BlockKitchenBaseProps {
      * host can find a block on the canvas to scroll to or highlight it.
      */
     blockActions?: readonly BlockAction[];
+    /**
+     * Opt-in host content shown beside every block, at its right edge, all the
+     * time (unlike `blockActions`, which show on hover): e.g. a count of
+     * comments on the block. Called with the block's position (see
+     * {@link BlockPosition}); return `null` for a block with nothing to show.
+     */
+    renderBlockAdornment?: (position: BlockPosition) => ReactNode;
+    /**
+     * Opt-in host forms that replace the built-in editor for the blocks they
+     * match. See {@link CustomBlockEditor}. Expected to be referentially
+     * stable across renders (define at module scope or wrap in `useMemo`).
+     */
+    blockEditors?: readonly CustomBlockEditor[];
     /**
      * Workspace custom emoji (`emoji.list`) the preview should resolve. Entries
      * with a non-null `url` render as the workspace image; alias entries fall
@@ -1311,6 +1378,14 @@ interface BlockKitchenBaseProps {
         href?: string;
         label?: string;
     };
+    /**
+     * Whether Ctrl/Cmd+Z undoes and Ctrl/Cmd+Shift+Z (or Ctrl+Y) redoes, like
+     * the toolbar's Undo / Redo buttons. Defaults to `true`. They act while
+     * focus is in the builder, or while nothing on the page has focus and the
+     * last click landed in the builder, and never in a text field. Pass `false`
+     * to leave those keys entirely to the host.
+     */
+    undoRedoShortcuts?: boolean;
     /**
      * Initial preview theme (uncontrolled). Defaults to `'light'`. Pass the
      * host app's current theme (e.g. from `next-themes` or your own theme
@@ -1461,4 +1536,4 @@ interface BlockKitchenComposeOnlyProps {
  */
 type BlockKitchenProps = BlockKitchenBaseProps & (BlockKitchenSendProps | BlockKitchenComposeOnlyProps);
 
-export { type PaletteMode as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type CustomEmoji as D, type DataTableActionCell as E, type DataTableBlock as F, type DataTableCell as G, type DataTableRawNumberCell as H, type DataVisualizationBlock as I, type EditableVia as J, type FeedbackButtonSubobject as K, type FeedbackButtonsElement as L, type HeaderLevel as M, type IconButtonElement as N, type IconButtonIcon as O, type PreviewSurface as P, type InputBlock as Q, type LoadMessageInput as R, type SupportedBlock as S, type Template as T, type LoadResult as U, type LoadedMessage as V, type LoadingConfig as W, type MarkdownBlock as X, type MentionChannel as Y, type MentionUser as Z, type MentionsConfig as _, type SendAsUserStatus as a, type PaletteSection as a0, type PaletteVariant as a1, type PieChart as a2, type PieChartSegment as a3, type PlanBlock as a4, type PreviewHooks as a5, type PrimaryActionConfig as a6, type PrimaryActionContext as a7, type RecentMessage as a8, type SendResult as a9, type SupportedBlockType as aa, type SupportedHeaderBlock as ab, type TableBlock as ac, type TableCell as ad, type TableColumnSetting as ae, type TableRawTextCell as af, type TaskCardBlock as ag, type TaskCardStatus as ah, type UpdatePayload as ai, type UpdateResult as aj, type UrlSourceElement as ak, type ValidationSummary as al, type VideoBlock as am, defaultPalette as an, extraAlertVariant as ao, legacyInputVariants as ap, buildVariantById as aq, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockAction as f, type BlockKitchenBaseProps as g, type BlockKitchenComposeOnlyProps as h, type BlockKitchenSendProps as i, type BlockPosition as j, type BrandPreset as k, type BrandTheme as l, type BrandTokens as m, type BuilderBlock as n, type CardBlock as o, type CarouselBlock as p, type CartesianChart as q, type Chart as r, type ChartAxisConfig as s, type ChartDataPoint as t, type ChartSeries as u, type ChartType as v, type ContainerBlock as w, type ContainerChildBlock as x, type ContextActionsBlock as y, type ContextActionsElement as z };
+export { type MentionUser as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type CustomBlockEditor as D, type CustomBlockEditorProps as E, type CustomEmoji as F, type DataTableActionCell as G, type DataTableBlock as H, type DataTableCell as I, type DataTableRawNumberCell as J, type DataVisualizationBlock as K, type EditableVia as L, type FeedbackButtonSubobject as M, type FeedbackButtonsElement as N, type HeaderLevel as O, type PreviewSurface as P, type IconButtonElement as Q, type IconButtonIcon as R, type SupportedBlock as S, type Template as T, type InputBlock as U, type LoadMessageInput as V, type LoadResult as W, type LoadedMessage as X, type LoadingConfig as Y, type MarkdownBlock as Z, type MentionChannel as _, type SendAsUserStatus as a, type MentionsConfig as a0, type PaletteMode as a1, type PaletteSection as a2, type PaletteVariant as a3, type PaletteVariantBadge as a4, type PieChart as a5, type PieChartSegment as a6, type PlanBlock as a7, type PreviewHooks as a8, type PrimaryActionConfig as a9, type PrimaryActionContext as aa, type RecentMessage as ab, type SendResult as ac, type SupportedBlockType as ad, type SupportedHeaderBlock as ae, type TableBlock as af, type TableCell as ag, type TableColumnSetting as ah, type TableRawTextCell as ai, type TaskCardBlock as aj, type TaskCardStatus as ak, type UpdatePayload as al, type UpdateResult as am, type UrlSourceElement as an, type ValidationSummary as ao, type VideoBlock as ap, defaultPalette as aq, extraAlertVariant as ar, legacyInputVariants as as, buildVariantById as at, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockAction as f, type BlockKitchenBaseProps as g, type BlockKitchenComposeOnlyProps as h, type BlockKitchenSendProps as i, type BlockPosition as j, type BrandPreset as k, type BrandTheme as l, type BrandTokens as m, type BuilderBlock as n, type CardBlock as o, type CarouselBlock as p, type CartesianChart as q, type Chart as r, type ChartAxisConfig as s, type ChartDataPoint as t, type ChartSeries as u, type ChartType as v, type ContainerBlock as w, type ContainerChildBlock as x, type ContextActionsBlock as y, type ContextActionsElement as z };

package/dist/{palette-DFTL0Han.d.ts → palette-DTE9U5si.d.ts}

@@ -99,6 +99,30 @@ interface PaletteVariant {
      * mode, and unnecessary for a variant whose label already stands alone.
      */
     basicLabel?: string;
+    /**
+     * A short tag shown beside the label, e.g. the plan a block belongs to
+     * ("Enterprise"). Shown whether or not the variant is `locked`.
+     */
+    badge?: PaletteVariantBadge;
+    /**
+     * Shows the variant without letting anyone add it: it can't be dragged,
+     * and it has no add button. Use it to show a block the user's plan doesn't
+     * include, alongside a `badge` saying which one does. Picking it calls
+     * `onLockedSelect`.
+     */
+    locked?: boolean;
+    /**
+     * Called when the user picks a `locked` variant, e.g. to open an upgrade
+     * prompt. Without it a locked variant is inert.
+     */
+    onLockedSelect?: () => void;
+}
+/** A tag shown beside a palette variant's label. See {@link PaletteVariant.badge}. */
+interface PaletteVariantBadge {
+    /** Visible text, e.g. `'Enterprise'`. */
+    label: string;
+    /** Optional icon shown before the text, e.g. a Lucide icon component. */
+    icon?: ComponentType<SVGProps<SVGSVGElement>>;
 }
 /**
  * One section in the palette. Sections group related variants under a
@@ -757,6 +781,36 @@ interface BlockAction {
     /** Called with the block's position when the button is clicked. */
     onSelect: (position: BlockPosition) => void;
 }
+/** What a {@link CustomBlockEditor}'s component is rendered with. */
+interface CustomBlockEditorProps {
+    /** The block being edited. */
+    block: SupportedBlock;
+    /**
+     * Replaces the block. The result must still be ordinary Block Kit: it is
+     * previewed, validated and sent like any other block.
+     */
+    onChange: (next: SupportedBlock) => void;
+}
+/**
+ * A host-owned form for blocks your app gives a meaning of its own, e.g. a
+ * "Share on LinkedIn" button whose URL is built from the post text. It
+ * replaces the built-in form in the block's edit popover. The block itself
+ * stays ordinary Block Kit, so preview, validation and sending don't change.
+ */
+interface CustomBlockEditor {
+    /** Stable identifier. */
+    id: string;
+    /** Names the block in the editor's heading, e.g. "Edit Share on LinkedIn". */
+    label: string;
+    /**
+     * Whether this editor handles a block; the first match wins. Match on what
+     * the block itself holds (a URL, an `action_id`): a message loaded back
+     * from Slack carries nothing else.
+     */
+    match: (block: SupportedBlock) => boolean;
+    /** The form. Rendered as a component, so it can use hooks. */
+    component: ComponentType<CustomBlockEditorProps>;
+}
 /**
  * A host-owned primary action for compose-only mode, rendered in the
  * toolbar slot where the built-in "Review & send" button normally sits.
@@ -1161,6 +1215,19 @@ interface BlockKitchenBaseProps {
      * host can find a block on the canvas to scroll to or highlight it.
      */
     blockActions?: readonly BlockAction[];
+    /**
+     * Opt-in host content shown beside every block, at its right edge, all the
+     * time (unlike `blockActions`, which show on hover): e.g. a count of
+     * comments on the block. Called with the block's position (see
+     * {@link BlockPosition}); return `null` for a block with nothing to show.
+     */
+    renderBlockAdornment?: (position: BlockPosition) => ReactNode;
+    /**
+     * Opt-in host forms that replace the built-in editor for the blocks they
+     * match. See {@link CustomBlockEditor}. Expected to be referentially
+     * stable across renders (define at module scope or wrap in `useMemo`).
+     */
+    blockEditors?: readonly CustomBlockEditor[];
     /**
      * Workspace custom emoji (`emoji.list`) the preview should resolve. Entries
      * with a non-null `url` render as the workspace image; alias entries fall
@@ -1311,6 +1378,14 @@ interface BlockKitchenBaseProps {
         href?: string;
         label?: string;
     };
+    /**
+     * Whether Ctrl/Cmd+Z undoes and Ctrl/Cmd+Shift+Z (or Ctrl+Y) redoes, like
+     * the toolbar's Undo / Redo buttons. Defaults to `true`. They act while
+     * focus is in the builder, or while nothing on the page has focus and the
+     * last click landed in the builder, and never in a text field. Pass `false`
+     * to leave those keys entirely to the host.
+     */
+    undoRedoShortcuts?: boolean;
     /**
      * Initial preview theme (uncontrolled). Defaults to `'light'`. Pass the
      * host app's current theme (e.g. from `next-themes` or your own theme
@@ -1461,4 +1536,4 @@ interface BlockKitchenComposeOnlyProps {
  */
 type BlockKitchenProps = BlockKitchenBaseProps & (BlockKitchenSendProps | BlockKitchenComposeOnlyProps);
 
-export { type PaletteMode as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type CustomEmoji as D, type DataTableActionCell as E, type DataTableBlock as F, type DataTableCell as G, type DataTableRawNumberCell as H, type DataVisualizationBlock as I, type EditableVia as J, type FeedbackButtonSubobject as K, type FeedbackButtonsElement as L, type HeaderLevel as M, type IconButtonElement as N, type IconButtonIcon as O, type PreviewSurface as P, type InputBlock as Q, type LoadMessageInput as R, type SupportedBlock as S, type Template as T, type LoadResult as U, type LoadedMessage as V, type LoadingConfig as W, type MarkdownBlock as X, type MentionChannel as Y, type MentionUser as Z, type MentionsConfig as _, type SendAsUserStatus as a, type PaletteSection as a0, type PaletteVariant as a1, type PieChart as a2, type PieChartSegment as a3, type PlanBlock as a4, type PreviewHooks as a5, type PrimaryActionConfig as a6, type PrimaryActionContext as a7, type RecentMessage as a8, type SendResult as a9, type SupportedBlockType as aa, type SupportedHeaderBlock as ab, type TableBlock as ac, type TableCell as ad, type TableColumnSetting as ae, type TableRawTextCell as af, type TaskCardBlock as ag, type TaskCardStatus as ah, type UpdatePayload as ai, type UpdateResult as aj, type UrlSourceElement as ak, type ValidationSummary as al, type VideoBlock as am, defaultPalette as an, extraAlertVariant as ao, legacyInputVariants as ap, buildVariantById as aq, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockAction as f, type BlockKitchenBaseProps as g, type BlockKitchenComposeOnlyProps as h, type BlockKitchenSendProps as i, type BlockPosition as j, type BrandPreset as k, type BrandTheme as l, type BrandTokens as m, type BuilderBlock as n, type CardBlock as o, type CarouselBlock as p, type CartesianChart as q, type Chart as r, type ChartAxisConfig as s, type ChartDataPoint as t, type ChartSeries as u, type ChartType as v, type ContainerBlock as w, type ContainerChildBlock as x, type ContextActionsBlock as y, type ContextActionsElement as z };
+export { type MentionUser as $, type AlertBlock as A, type BlockKitchenProps as B, type ChannelOption as C, type CustomBlockEditor as D, type CustomBlockEditorProps as E, type CustomEmoji as F, type DataTableActionCell as G, type DataTableBlock as H, type DataTableCell as I, type DataTableRawNumberCell as J, type DataVisualizationBlock as K, type EditableVia as L, type FeedbackButtonSubobject as M, type FeedbackButtonsElement as N, type HeaderLevel as O, type PreviewSurface as P, type IconButtonElement as Q, type IconButtonIcon as R, type SupportedBlock as S, type Template as T, type InputBlock as U, type LoadMessageInput as V, type LoadResult as W, type LoadedMessage as X, type LoadingConfig as Y, type MarkdownBlock as Z, type MentionChannel as _, type SendAsUserStatus as a, type MentionsConfig as a0, type PaletteMode as a1, type PaletteSection as a2, type PaletteVariant as a3, type PaletteVariantBadge as a4, type PieChart as a5, type PieChartSegment as a6, type PlanBlock as a7, type PreviewHooks as a8, type PrimaryActionConfig as a9, type PrimaryActionContext as aa, type RecentMessage as ab, type SendResult as ac, type SupportedBlockType as ad, type SupportedHeaderBlock as ae, type TableBlock as af, type TableCell as ag, type TableColumnSetting as ah, type TableRawTextCell as ai, type TaskCardBlock as aj, type TaskCardStatus as ak, type UpdatePayload as al, type UpdateResult as am, type UrlSourceElement as an, type ValidationSummary as ao, type VideoBlock as ap, defaultPalette as aq, extraAlertVariant as ar, legacyInputVariants as as, buildVariantById as at, type SendPayload as b, type SendExtrasContext as c, type PreviewTheme as d, type AlertLevel as e, type BlockAction as f, type BlockKitchenBaseProps as g, type BlockKitchenComposeOnlyProps as h, type BlockKitchenSendProps as i, type BlockPosition as j, type BrandPreset as k, type BrandTheme as l, type BrandTokens as m, type BuilderBlock as n, type CardBlock as o, type CarouselBlock as p, type CartesianChart as q, type Chart as r, type ChartAxisConfig as s, type ChartDataPoint as t, type ChartSeries as u, type ChartType as v, type ContainerBlock as w, type ContainerChildBlock as x, type ContextActionsBlock as y, type ContextActionsElement as z };