@sesamehr/react-design-system 3.7.0 → 3.7.1

package/dist/Forms/Inputs/RichTextEditor/commands.d.ts

@@ -13,16 +13,18 @@ import { ChainedCommands } from '@tiptap/core';
  *    undo with either would be a different control wearing the wrong sign. A
  *    code *block* has only `icon-code`, already spoken for by inline code, and
  *    a rule has only `icon-minus`. The commands themselves are all in the
- *    preset — `undoRedo` and `horizontalRule` are StarterKit extensions, and
- *    the keyboard shortcuts work — so what is missing is the buttons, not the
- *    behaviour.
+ *    preset — `history` and `horizontalRule` are StarterKit extensions on
+ *    TipTap 2 (`history` is what 3.x renamed to `undoRedo`), and the keyboard
+ *    shortcuts work — so what is missing is the buttons, not the behaviour.
  *  - **A link is not a toggle.** `toggleLink` needs an `href`, and a button
  *    whose whole API is `command` has nowhere to get one. Wiring a URL prompt
  *    in here would be deciding what that prompt looks like for everybody. The
  *    toolbar takes arbitrary children instead, so a caller puts their own
  *    control in it and calls `editor.chain().setLink(…)` — which is also how
  *    anything else outside this list gets into a toolbar. The mark is styled
- *    either way; see `RICH_TEXT_SCHEMA`.
+ *    either way; see `RICH_TEXT_SCHEMA`. On TipTap 2 `setLink` arrives with
+ *    `@tiptap/extension-link`, which StarterKit does not carry — so it only
+ *    exists for a caller who passed `Link` to `oxRichTextExtensions`.
  */
 export type RichTextCommand = 'bold' | 'italic' | 'underline' | 'strike' | 'code' | 'heading1' | 'heading2' | 'heading3' | 'bulletList' | 'orderedList' | 'blockquote';
 export interface RichTextCommandSpec {
@@ -61,6 +63,11 @@ export interface RichTextCommandSpec {
  *
  * A record and not a function, because the button resolves its own icon, label
  * and pressed state from it — the only thing a caller writes is `command`.
+ *
+ * Every entry is listed unconditionally, including `underline`, whose extension
+ * is optional on TipTap 2. What decides whether a button appears is the
+ * editor's schema at runtime rather than this record — see
+ * `RichTextAdapter.supports`.
  */
 export declare const RICH_TEXT_COMMANDS: Record<RichTextCommand, RichTextCommandSpec>;
 /** Every command, in toolbar order. */

package/dist/Forms/Inputs/RichTextEditor/extensions.d.ts

@@ -1,5 +1,45 @@
 import { Extensions } from '@tiptap/core';
+import { default as Link } from '@tiptap/extension-link';
+import { default as Underline } from '@tiptap/extension-underline';
 import { default as StarterKit } from '@tiptap/starter-kit';
+/**
+ * The two marks StarterKit does not carry, handed over the same way StarterKit
+ * itself is.
+ *
+ * **On TipTap 2, `StarterKit` contains neither `Underline` nor `Link`** —
+ * `@tiptap/starter-kit@2.27.3` does not even depend on them, where 3.x does.
+ * That difference is the reason this parameter exists rather than the preset
+ * configuring them through `starterKit.configure()`, and it is worth knowing
+ * exactly how badly that fails, because it fails quietly in both directions:
+ *
+ *  - `configure({ link: … })` on TipTap 2 is accepted and **stored**. No error,
+ *    no warning, `starterKit.options.link` reads back exactly what was passed —
+ *    and nothing anywhere consumes it, because there is no Link extension to
+ *    consume it. A test asserting on `options.link` passes. The document has no
+ *    `link` mark in it.
+ *  - `toggleUnderline` is a command an extension contributes, so with no
+ *    Underline extension the name is simply absent from the command manager.
+ *    `editor.can().chain().focus().toggleUnderline()` is a call on `undefined`.
+ *
+ * Both are optional: a caller who wants neither passes neither, and the
+ * `underline` toolbar button then does not render at all rather than render
+ * disabled or render and throw. See `useRichTextAdapter` for how that is
+ * decided — the editor's own schema, so it covers a caller who narrows
+ * StarterKit as well.
+ *
+ * The keys are capitalised to match the names TipTap's own documentation gives
+ * these imports, so the call site is `{ Underline, Link }` with no renaming.
+ */
+export interface RichTextExtras {
+    /** `@tiptap/extension-underline`. Without it there is no underline button. */
+    Underline?: typeof Underline;
+    /**
+     * `@tiptap/extension-link`. Without it a typed URL stays text, and
+     * `editor.chain().setLink(…)` — the documented way to add the one mark the
+     * toolbar deliberately has no button for — does not exist.
+     */
+    Link?: typeof Link;
+}
 /**
  * The extension list both ends of a rich text field agree on.
  *
@@ -15,40 +55,43 @@ import { default as StarterKit } from '@tiptap/starter-kit';
  *
  * ---
  *
- * **Why this takes StarterKit as an argument instead of importing it.** The
+ * **Why this takes its extensions as arguments instead of importing them.** The
  * intended design was a plain exported array. It cannot be one, and the reason
  * is worth writing down because the signature otherwise looks like ceremony:
  *
  * `oxRichTextExtensions` is published from `src/main.ts`, the barrel every
  * consumer imports — including the one who only wants `OxButton`. A static
  * `import StarterKit from '@tiptap/starter-kit'` anywhere in that graph becomes
- * a top-level import in the built `orxata-core.js`, and a bundler resolves
+ * a top-level import in the built `react-design-system.js`, and a bundler resolves
  * every import it finds before it decides what to tree-shake. For a consumer
  * who has not installed TipTap that is a module-resolution failure in their
  * build — webpack calls it an error, Rollup leaves a bare specifier that fails
  * at runtime — over a feature they never touched. "TipTap is an optional peer
  * dependency" would be false the moment anything imported it eagerly.
  *
- * An `async` factory that `import()`s it was the other option, and it is worse
- * where it matters: `useEditor` needs its extensions synchronously, so every
- * caller would need a top-level `await` and a `<Suspense>` around their own
- * component in order to use a text field.
+ * An `async` factory that `import()`s them was the other option, and it is
+ * worse where it matters: `useEditor` needs its extensions synchronously, so
+ * every caller would need a top-level `await` and a `<Suspense>` around their
+ * own component in order to use a text field.
  *
- * So the caller hands over the StarterKit they already have — one import, in a
- * file that is already importing `useEditor` from TipTap — and this package
- * contributes the part that is actually its own: the configuration. The
- * parameter's type is `typeof StarterKit`, which is erased, so this module has
- * no runtime dependency on TipTap at all.
+ * So the caller hands over the extensions they already have — three imports, in
+ * a file that is already importing `useEditor` from TipTap — and this package
+ * contributes the part that is actually its own: the configuration. Every
+ * parameter's type is erased, so this module has no runtime dependency on
+ * TipTap at all, and none of the four specifiers needs to be external in
+ * `vite.config.ts`.
  *
  * ```ts
+ * import Link from '@tiptap/extension-link';
+ * import Underline from '@tiptap/extension-underline';
  * import StarterKit from '@tiptap/starter-kit';
- * import { useEditor } from '@tiptap/vue-3';
- * import { oxRichTextExtensions } from '@sesame/orxata-core';
+ * import { useEditor } from '@tiptap/react';
+ * import { oxRichTextExtensions } from '@sesamehr/react-design-system';
  *
  * const editor = useEditor({
- *   extensions: oxRichTextExtensions(StarterKit),
+ *   extensions: oxRichTextExtensions(StarterKit, { Underline, Link }),
  *   content: '<p>…</p>',
  * });
  * ```
  */
-export declare const oxRichTextExtensions: (starterKit: typeof StarterKit) => Extensions;
+export declare const oxRichTextExtensions: (starterKit: typeof StarterKit, extras?: RichTextExtras) => Extensions;

package/dist/Forms/Inputs/RichTextEditor/index.d.ts

@@ -2,6 +2,6 @@ export { RichTextEditor } from './RichTextEditor.tsx';
 export { RichTextToolbar } from './RichTextToolbar/index.ts';
 export { RichTextToolbarButton } from './RichTextToolbarButton/index.ts';
 export { RICH_TEXT_COMMANDS, RICH_TEXT_COMMAND_NAMES, type RichTextCommand, type RichTextCommandSpec, } from './commands.ts';
-export { oxRichTextExtensions } from './extensions.ts';
+export { type RichTextExtras, oxRichTextExtensions } from './extensions.ts';
 export { type RichTextAdapter, type RichTextSource, isRichTextAdapter, useRichTextAdapter, } from './useRichTextAdapter.ts';
 export { useRichTextToolbar } from './useRichTextToolbar.ts';

package/dist/Forms/Inputs/RichTextEditor/useRichTextAdapter.d.ts

@@ -3,10 +3,10 @@ import { RichTextCommand } from './commands.ts';
 /**
  * What the toolbar talks to, and the only thing it talks to.
  *
- * Three questions, which between them are everything a toolbar button needs:
- * run this, is it on, is it available. Nothing here mentions TipTap, so a
- * second editor becomes an implementation of this interface rather than a
- * second toolbar.
+ * Four questions, which between them are everything a toolbar button needs:
+ * run this, is it on, is it available, does it exist here at all. Nothing here
+ * mentions TipTap, so a second editor becomes an implementation of this
+ * interface rather than a second toolbar.
  *
  * **What this is deliberately not is an abstraction of the document.** The
  * document stays TipTap JSON, read and written through the editor the caller
@@ -21,6 +21,26 @@ export interface RichTextAdapter {
     isActive: (command: RichTextCommand) => boolean;
     /** Whether the command can run at all — a disabled button if not. */
     can: (command: RichTextCommand) => boolean;
+    /**
+     * Whether the command exists in this editor at all — **no button** if not,
+     * which is the difference between this and `can`.
+     *
+     * `can` is "not now": a list inside a code block, an empty selection. The
+     * reader waits and tries again. This is "not here": the extension behind the
+     * command was never loaded, so there is nothing to wait for, and a disabled
+     * button that will never enable is a control that lies about what the field
+     * can do.
+     *
+     * It exists because of TipTap 2. `StarterKit` there carries neither
+     * `Underline` nor `Link`, so `oxRichTextExtensions` takes them as optional
+     * arguments — and a caller who omits `Underline` would otherwise get an
+     * underline button whose `can` probe calls `toggleUnderline` on `undefined`.
+     *
+     * Optional, and absent means supported: an adapter written against an earlier
+     * version of this interface keeps working, and so does one for an editor
+     * whose command set is fixed.
+     */
+    supports?: (command: RichTextCommand) => boolean;
 }
 /** Whatever `OxRichTextEditor` will accept as the thing the toolbar drives. */
 export type RichTextSource = Editor | RichTextAdapter;

package/dist/main.d.ts

@@ -70,6 +70,6 @@ export { Breadcrumb as OxBreadcrumb, BreadcrumbList as OxBreadcrumbList, Breadcr
 export { Counter as OxCounter, counterVariants, type CounterVariants, } from './Forms/Field/Counter/index.ts';
 export { FieldGroup as OxFieldGroup, FieldLabel as OxFieldLabel, FieldMessage as OxFieldMessage, useFieldControl, useFieldControlGroup, type FieldControlAttrs, type FieldControlGroupAttrs, type FieldGroupProps, type FieldVariant, } from './Forms/Field/index.ts';
 export { AiSearch as OxAiSearch, AiSearchAsk as OxAiSearchAsk, AiSearchPanel as OxAiSearchPanel, AiSearchSend as OxAiSearchSend, AiSearchShortcut as OxAiSearchShortcut, AiSearchSuggestion as OxAiSearchSuggestion, } from './Forms/Inputs/AiSearch/index.ts';
-export { InputGroup as OxInputGroup, InputText as OxInputText, InputNumber as OxInputNumber, InputNumberContent as OxInputNumberContent, InputNumberDecrement as OxInputNumberDecrement, InputNumberIncrement as OxInputNumberIncrement, InputNumberInput as OxInputNumberInput, InputPassword as OxInputPassword, InputPasswordInput as OxInputPasswordInput, InputPasswordToggle as OxInputPasswordToggle, useInputPassword, InputOtp as OxInputOtp, InputOtpGroup as OxInputOtpGroup, InputOtpSlot as OxInputOtpSlot, InputOtpSeparator as OxInputOtpSeparator, useInputOtp, Calendar as OxCalendar, CalendarRange as OxCalendarRange, CalendarDay as OxCalendarDay, calendarDayVariants, Combobox as OxCombobox, ComboboxCancel as OxComboboxCancel, ComboboxInput as OxComboboxInput, ComboboxChipsInput as OxComboboxChipsInput, ComboboxContent as OxComboboxContent, ComboboxItem as OxComboboxItem, ComboboxItemEdit as OxComboboxItemEdit, ComboboxEmpty as OxComboboxEmpty, ComboboxGroup as OxComboboxGroup, ComboboxSeparator as OxComboboxSeparator, ChatInput as OxChatInput, ColorPicker as OxColorPicker, ColorPickerTrigger as OxColorPickerTrigger, ColorPickerContent as OxColorPickerContent, ColorPickerSwatch as OxColorPickerSwatch, useColorPicker, IconPicker as OxIconPicker, IconPickerTrigger as OxIconPickerTrigger, IconPickerContent as OxIconPickerContent, IconPickerItem as OxIconPickerItem, useIconPicker, DatePicker as OxDatePicker, DateRangePicker as OxDateRangePicker, DatePickerTrigger as OxDatePickerTrigger, DatePickerHeader as OxDatePickerHeader, DatePickerMonthSelect as OxDatePickerMonthSelect, DatePickerYearSelect as OxDatePickerYearSelect, SearchBar as OxSearchBar, searchBarVariants, SearchPanel as OxSearchPanel, SearchPanelInput as OxSearchPanelInput, SearchPanelList as OxSearchPanelList, SearchPanelGroup as OxSearchPanelGroup, SearchPanelItem as OxSearchPanelItem, SearchPanelEmpty as OxSearchPanelEmpty, Select as OxSelect, SelectTrigger as OxSelectTrigger, SelectContent as OxSelectContent, SelectItem as OxSelectItem, SelectGroup as OxSelectGroup, SelectSeparator as OxSelectSeparator, TimePicker as OxTimePicker, TimePickerField as OxTimePickerField, TimePickerList as OxTimePickerList, TimePickerWheel as OxTimePickerWheel, TimePickerWheelColumn as OxTimePickerWheelColumn, Textarea as OxTextarea, RichTextEditor as OxRichTextEditor, RichTextToolbar as OxRichTextToolbar, RichTextToolbarButton as OxRichTextToolbarButton, RICH_TEXT_COMMANDS, RICH_TEXT_COMMAND_NAMES, isRichTextAdapter, oxRichTextExtensions, useRichTextAdapter, useRichTextToolbar, type RichTextAdapter, type RichTextCommand, type RichTextCommandSpec, type RichTextSource, Switch as OxSwitch, Checkbox as OxCheckbox, RadioButton as OxRadioButton, RadioGroup as OxRadioGroup, ToggleGroup as OxToggleGroup, ToggleLabel as OxToggleLabel, ToggleDescription as OxToggleDescription, SWITCH_SIZES, type InputNumberProps, type InputPasswordProps, type InputPasswordContext, type InputOtpProps, type InputOtpSlotProps, type InputOtpContext, type CalendarProps, type CalendarRangeProps, type CalendarDateRange, type CalendarDayProps, type CalendarDayState, type CalendarDayVariants, type CalendarConstraints, type CalendarNav, type ComboboxProps, type ChatInputActionLabels, type ChatInputState, type ColorPickerProps, type ColorPickerContext, type IconPickerProps, type IconPickerContext, type DatePickerProps, type DateRangePickerProps, type DatePickerTriggerProps, type DatePickerHeaderProps, type DatePickerMonthSelectProps, type DatePickerYearSelectProps, type SearchBarVariants, type SelectProps, type TimePickerProps, type TimeFormat, type TimePart, type TextareaCounterState, type RadioGroupProps, type ToggleGroupProps, type ToggleLabelProps, type ToggleDescriptionProps, } from './Forms/Inputs/index.ts';
+export { InputGroup as OxInputGroup, InputText as OxInputText, InputNumber as OxInputNumber, InputNumberContent as OxInputNumberContent, InputNumberDecrement as OxInputNumberDecrement, InputNumberIncrement as OxInputNumberIncrement, InputNumberInput as OxInputNumberInput, InputPassword as OxInputPassword, InputPasswordInput as OxInputPasswordInput, InputPasswordToggle as OxInputPasswordToggle, useInputPassword, InputOtp as OxInputOtp, InputOtpGroup as OxInputOtpGroup, InputOtpSlot as OxInputOtpSlot, InputOtpSeparator as OxInputOtpSeparator, useInputOtp, Calendar as OxCalendar, CalendarRange as OxCalendarRange, CalendarDay as OxCalendarDay, calendarDayVariants, Combobox as OxCombobox, ComboboxCancel as OxComboboxCancel, ComboboxInput as OxComboboxInput, ComboboxChipsInput as OxComboboxChipsInput, ComboboxContent as OxComboboxContent, ComboboxItem as OxComboboxItem, ComboboxItemEdit as OxComboboxItemEdit, ComboboxEmpty as OxComboboxEmpty, ComboboxGroup as OxComboboxGroup, ComboboxSeparator as OxComboboxSeparator, ChatInput as OxChatInput, ColorPicker as OxColorPicker, ColorPickerTrigger as OxColorPickerTrigger, ColorPickerContent as OxColorPickerContent, ColorPickerSwatch as OxColorPickerSwatch, useColorPicker, IconPicker as OxIconPicker, IconPickerTrigger as OxIconPickerTrigger, IconPickerContent as OxIconPickerContent, IconPickerItem as OxIconPickerItem, useIconPicker, DatePicker as OxDatePicker, DateRangePicker as OxDateRangePicker, DatePickerTrigger as OxDatePickerTrigger, DatePickerHeader as OxDatePickerHeader, DatePickerMonthSelect as OxDatePickerMonthSelect, DatePickerYearSelect as OxDatePickerYearSelect, SearchBar as OxSearchBar, searchBarVariants, SearchPanel as OxSearchPanel, SearchPanelInput as OxSearchPanelInput, SearchPanelList as OxSearchPanelList, SearchPanelGroup as OxSearchPanelGroup, SearchPanelItem as OxSearchPanelItem, SearchPanelEmpty as OxSearchPanelEmpty, Select as OxSelect, SelectTrigger as OxSelectTrigger, SelectContent as OxSelectContent, SelectItem as OxSelectItem, SelectGroup as OxSelectGroup, SelectSeparator as OxSelectSeparator, TimePicker as OxTimePicker, TimePickerField as OxTimePickerField, TimePickerList as OxTimePickerList, TimePickerWheel as OxTimePickerWheel, TimePickerWheelColumn as OxTimePickerWheelColumn, Textarea as OxTextarea, RichTextEditor as OxRichTextEditor, RichTextToolbar as OxRichTextToolbar, RichTextToolbarButton as OxRichTextToolbarButton, RICH_TEXT_COMMANDS, RICH_TEXT_COMMAND_NAMES, isRichTextAdapter, oxRichTextExtensions, useRichTextAdapter, useRichTextToolbar, type RichTextAdapter, type RichTextCommand, type RichTextCommandSpec, type RichTextExtras, type RichTextSource, Switch as OxSwitch, Checkbox as OxCheckbox, RadioButton as OxRadioButton, RadioGroup as OxRadioGroup, ToggleGroup as OxToggleGroup, ToggleLabel as OxToggleLabel, ToggleDescription as OxToggleDescription, SWITCH_SIZES, type InputNumberProps, type InputPasswordProps, type InputPasswordContext, type InputOtpProps, type InputOtpSlotProps, type InputOtpContext, type CalendarProps, type CalendarRangeProps, type CalendarDateRange, type CalendarDayProps, type CalendarDayState, type CalendarDayVariants, type CalendarConstraints, type CalendarNav, type ComboboxProps, type ChatInputActionLabels, type ChatInputState, type ColorPickerProps, type ColorPickerContext, type IconPickerProps, type IconPickerContext, type DatePickerProps, type DateRangePickerProps, type DatePickerTriggerProps, type DatePickerHeaderProps, type DatePickerMonthSelectProps, type DatePickerYearSelectProps, type SearchBarVariants, type SelectProps, type TimePickerProps, type TimeFormat, type TimePart, type TextareaCounterState, type RadioGroupProps, type ToggleGroupProps, type ToggleLabelProps, type ToggleDescriptionProps, } from './Forms/Inputs/index.ts';
 export { Table as OxTable, TableVirtualized as OxTableVirtualized, TableHead as OxTableHead, TableBody as OxTableBody, TableRow as OxTableRow, TableCell as OxTableCell, TableHeaderCell as OxTableHeaderCell, TableSelectCell as OxTableSelectCell, TableDragCell as OxTableDragCell, TableBulkHeader as OxTableBulkHeader, TablePagination as OxTablePagination, TableEmpty as OxTableEmpty, TableRowExpanded as OxTableRowExpanded, TableExpandCell as OxTableExpandCell, TableColumnVisibility as OxTableColumnVisibility, useTable, useTableSelection, useTableSorting, useTablePagination, useTableDetailRow, useTablePinning, useTableColumns, useScrollShadow, useDragToScroll, useFixedColumns, useTableVirtual, } from './Data/Table/index.ts';
 export type { UseTableOptions, UseTableReturn, UseTableSelectionReturn, UseTableSortingReturn, UseTablePaginationOptions, UseTablePaginationReturn, DetailRowInstance, DetailRowOptions, DetailRowPluginDef, UseTablePinningOptions, UseTablePinningReturn, CellInfo, HeaderInfo, UseTableVirtualOptions, UseTableVirtualReturn, UseTableColumnsOptions, UseTableColumnsReturn, UseScrollShadowOptions, UseScrollShadowReturn, UseDragToScrollOptions, UseDragToScrollReturn, UseFixedColumnsOptions, TableProps, TableMode, ColumnDef, ColumnAlign, CellContext, SortingState, PaginationState, PaginationChangePayload, SortingChangePayload, SelectionChangePayload, FilterChangePayload, ColumnResizeMode, ColumnVisibilityState, ColumnOrderState, ExpandedState, ColumnVisibilityChangePayload, ColumnOrderChangePayload, RowExpandChangePayload, ColumnResizePayload, ColumnPinningState, } from './Data/Table/index.ts';