@whity/ui 0.5.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. package/README.md +107 -107
  2. package/package.json +223 -192
  3. package/src/access-denied.stories.tsx +179 -179
  4. package/src/access-denied.tsx +305 -305
  5. package/src/action-proposal.tsx +338 -302
  6. package/src/actor-chip.tsx +71 -71
  7. package/src/agent-activity.tsx +163 -163
  8. package/src/agent-collaboration.stories.tsx +156 -156
  9. package/src/agent-run-status.tsx +196 -196
  10. package/src/alert-dialog.stories.tsx +45 -45
  11. package/src/alert-dialog.tsx +147 -147
  12. package/src/alert.stories.tsx +91 -91
  13. package/src/alert.tsx +89 -89
  14. package/src/app-sidebar.stories.tsx +195 -195
  15. package/src/app-sidebar.tsx +604 -500
  16. package/src/approval-queue.tsx +109 -108
  17. package/src/audience-group-picker.stories.tsx +198 -198
  18. package/src/audience-group-picker.tsx +362 -362
  19. package/src/audience-people-picker.stories.tsx +102 -102
  20. package/src/audience-people-picker.tsx +279 -279
  21. package/src/avatar-pattern.ts +138 -0
  22. package/src/avatar.tsx +125 -83
  23. package/src/badge.stories.tsx +105 -105
  24. package/src/badge.tsx +68 -68
  25. package/src/beta-warning.stories.tsx +79 -79
  26. package/src/beta-warning.tsx +189 -189
  27. package/src/bilingual-input.stories.tsx +82 -82
  28. package/src/bilingual-input.tsx +188 -183
  29. package/src/board.tsx +216 -0
  30. package/src/breadcrumb.stories.tsx +51 -51
  31. package/src/breadcrumb.tsx +90 -90
  32. package/src/built-on-whity.tsx +52 -0
  33. package/src/button.stories.tsx +87 -87
  34. package/src/button.tsx +125 -118
  35. package/src/card.stories.tsx +423 -423
  36. package/src/card.tsx +180 -180
  37. package/src/chart.stories.tsx +66 -66
  38. package/src/chart.tsx +228 -228
  39. package/src/checkbox.stories.tsx +62 -62
  40. package/src/checkbox.tsx +54 -54
  41. package/src/collapsible.stories.tsx +48 -48
  42. package/src/collapsible.tsx +34 -34
  43. package/src/color-card.stories.tsx +61 -61
  44. package/src/color-card.tsx +270 -270
  45. package/src/color-picker.stories.tsx +65 -65
  46. package/src/color-picker.tsx +425 -425
  47. package/src/column-matcher.tsx +84 -0
  48. package/src/command-palette.tsx +399 -306
  49. package/src/confirm-action.tsx +98 -0
  50. package/src/copy-block.stories.tsx +38 -38
  51. package/src/copy-block.tsx +85 -85
  52. package/src/data-table.stories.tsx +200 -200
  53. package/src/data-table.tsx +1687 -1106
  54. package/src/date-picker.stories.tsx +61 -61
  55. package/src/date-picker.tsx +457 -422
  56. package/src/design-cards.stories.tsx +551 -458
  57. package/src/dialog.stories.tsx +48 -48
  58. package/src/dialog.tsx +179 -166
  59. package/src/display-preferences.tsx +59 -0
  60. package/src/documents/barcode-svg.stories.tsx +72 -72
  61. package/src/documents/barcode-svg.tsx +79 -79
  62. package/src/dropdown-menu.stories.tsx +77 -77
  63. package/src/dropdown-menu.tsx +271 -271
  64. package/src/editor/agent-panel.tsx +222 -0
  65. package/src/editor/agents.stories.tsx +81 -0
  66. package/src/editor/agents.ts +55 -0
  67. package/src/editor/behaviour.ts +279 -279
  68. package/src/editor/block-ids.ts +44 -44
  69. package/src/editor/block-list.tsx +104 -101
  70. package/src/editor/block-toolbar.tsx +490 -477
  71. package/src/editor/bubble.tsx +119 -93
  72. package/src/editor/catalogue.ts +169 -103
  73. package/src/editor/collab-rail.tsx +746 -746
  74. package/src/editor/collab.stories.tsx +207 -207
  75. package/src/editor/collab.ts +87 -87
  76. package/src/editor/contract.ts +476 -408
  77. package/src/editor/convert.ts +414 -362
  78. package/src/editor/doc-editor.stories.tsx +98 -98
  79. package/src/editor/doc-editor.tsx +1492 -1287
  80. package/src/editor/editor.css +636 -536
  81. package/src/editor/extensions.ts +86 -86
  82. package/src/editor/field-bar.tsx +154 -0
  83. package/src/editor/field-picker.tsx +109 -107
  84. package/src/editor/fields.ts +100 -100
  85. package/src/editor/gutter.tsx +443 -367
  86. package/src/editor/index.ts +23 -22
  87. package/src/editor/label-sheet.tsx +289 -289
  88. package/src/editor/labels.ts +394 -310
  89. package/src/editor/link-tools.tsx +141 -141
  90. package/src/editor/node-views.tsx +461 -450
  91. package/src/editor/page-view.tsx +372 -353
  92. package/src/editor/phone.tsx +310 -0
  93. package/src/editor/plugin-block-view.tsx +230 -0
  94. package/src/editor/plugin-blocks.stories.tsx +96 -0
  95. package/src/editor/plugin-blocks.ts +52 -0
  96. package/src/editor/publish-check.tsx +201 -182
  97. package/src/editor/rich-blocks.stories.tsx +146 -146
  98. package/src/editor/sample.ts +40 -40
  99. package/src/editor/save-block-dialog.tsx +141 -0
  100. package/src/editor/saved-block-view.tsx +205 -0
  101. package/src/editor/saved-blocks.stories.tsx +105 -0
  102. package/src/editor/saved-parts.ts +192 -0
  103. package/src/editor/schema-rich.ts +156 -150
  104. package/src/editor/schema.ts +368 -315
  105. package/src/editor/services.tsx +205 -127
  106. package/src/editor/slash.ts +64 -64
  107. package/src/editor/suggesting.ts +372 -372
  108. package/src/editor/suggestions.ts +763 -763
  109. package/src/editor/table-keys.ts +66 -66
  110. package/src/editor/templates.stories.tsx +324 -324
  111. package/src/editor/toolbar.tsx +364 -358
  112. package/src/empty-state.stories.tsx +51 -51
  113. package/src/empty-state.tsx +126 -100
  114. package/src/empty-state.usage-notes.md +30 -30
  115. package/src/form.stories.tsx +112 -112
  116. package/src/form.tsx +176 -176
  117. package/src/globals.css +20 -20
  118. package/src/icon-button.tsx +85 -85
  119. package/src/icon-map.ts +335 -244
  120. package/src/icon.tsx +41 -41
  121. package/src/index.ts +92 -67
  122. package/src/input.stories.tsx +157 -157
  123. package/src/input.tsx +768 -759
  124. package/src/kpi-strip.tsx +47 -0
  125. package/src/localized-text.ts +76 -0
  126. package/src/locked-screen.stories.tsx +29 -29
  127. package/src/locked-screen.tsx +75 -61
  128. package/src/lockup.tsx +42 -0
  129. package/src/lottie.tsx +441 -0
  130. package/src/mark.tsx +62 -62
  131. package/src/math-text.stories.tsx +33 -33
  132. package/src/math-text.tsx +43 -43
  133. package/src/menu-bar.stories.tsx +198 -198
  134. package/src/menu-bar.tsx +373 -373
  135. package/src/message-thread.tsx +181 -0
  136. package/src/money/currency.ts +244 -230
  137. package/src/money/money-input.tsx +131 -0
  138. package/src/money/money.tsx +33 -0
  139. package/src/open-on-computer.tsx +150 -0
  140. package/src/otp-input.tsx +161 -0
  141. package/src/page-header.stories.tsx +95 -95
  142. package/src/page-header.tsx +122 -122
  143. package/src/page-shell.stories.tsx +42 -42
  144. package/src/page-shell.tsx +32 -32
  145. package/src/page-states.tsx +277 -0
  146. package/src/pagination.stories.tsx +45 -45
  147. package/src/pagination.tsx +98 -98
  148. package/src/paper-sheet.stories.tsx +88 -0
  149. package/src/paper-sheet.tsx +85 -0
  150. package/src/phone-input.tsx +252 -0
  151. package/src/phone-tab-bar.tsx +152 -0
  152. package/src/plugin-card.stories.tsx +208 -180
  153. package/src/plugin-card.tsx +931 -848
  154. package/src/popover.stories.tsx +48 -48
  155. package/src/popover.tsx +55 -55
  156. package/src/radio-group.stories.tsx +26 -26
  157. package/src/radio-group.tsx +44 -44
  158. package/src/role-summary.stories.tsx +143 -0
  159. package/src/role-summary.tsx +120 -0
  160. package/src/route-flow/editor.tsx +1087 -1014
  161. package/src/route-flow/model.ts +771 -716
  162. package/src/save-bar.tsx +94 -0
  163. package/src/scope-grant.tsx +139 -139
  164. package/src/screen-too-small.stories.tsx +61 -61
  165. package/src/screen-too-small.tsx +104 -104
  166. package/src/search-field.tsx +65 -0
  167. package/src/select.stories.tsx +44 -44
  168. package/src/select.tsx +197 -197
  169. package/src/separator.stories.tsx +34 -34
  170. package/src/separator.tsx +34 -34
  171. package/src/sheet.stories.tsx +49 -49
  172. package/src/sheet.tsx +168 -168
  173. package/src/skeleton.stories.tsx +28 -28
  174. package/src/skeleton.tsx +19 -19
  175. package/src/slider.stories.tsx +78 -78
  176. package/src/slider.tsx +300 -300
  177. package/src/spinner.stories.tsx +33 -33
  178. package/src/spinner.tsx +55 -55
  179. package/src/stepper.tsx +85 -0
  180. package/src/switch.stories.tsx +42 -42
  181. package/src/switch.tsx +41 -41
  182. package/src/switcher.stories.tsx +111 -111
  183. package/src/switcher.tsx +131 -131
  184. package/src/system-state.tsx +55 -0
  185. package/src/table.stories.tsx +48 -48
  186. package/src/table.tsx +121 -121
  187. package/src/tabs.stories.tsx +74 -74
  188. package/src/tabs.tsx +90 -90
  189. package/src/tag-input.stories.tsx +67 -67
  190. package/src/tag-input.tsx +117 -117
  191. package/src/tenant-logo.tsx +63 -63
  192. package/src/tenant-switcher.stories.tsx +38 -38
  193. package/src/tenant-switcher.tsx +185 -164
  194. package/src/textarea.stories.tsx +27 -27
  195. package/src/textarea.tsx +18 -18
  196. package/src/theme-mode.ts +74 -52
  197. package/src/time-grid.tsx +163 -0
  198. package/src/time-picker.stories.tsx +62 -62
  199. package/src/time-picker.tsx +616 -615
  200. package/src/toggle-group.tsx +139 -138
  201. package/src/tooltip.stories.tsx +43 -43
  202. package/src/tooltip.tsx +73 -73
  203. package/src/top-nav.stories.tsx +58 -58
  204. package/src/top-nav.tsx +324 -324
  205. package/src/undo-bar.tsx +107 -107
  206. package/src/utils.ts +45 -45
  207. package/src/view-toggle.stories.tsx +84 -84
  208. package/src/view-toggle.tsx +111 -110
@@ -1,93 +1,119 @@
1
- "use client"
2
-
3
- import type { Editor } from "@tiptap/core"
4
- import { isTextSelection } from "@tiptap/core"
5
- import { useEditorState } from "@tiptap/react"
6
- import { BubbleMenu } from "@tiptap/react/menus"
7
-
8
- import type { IconName } from "../icon"
9
- import { IconButton } from "../icon-button"
10
- import type { EditorLabels } from "./labels"
11
-
12
- /**
13
- * The selection bubble (EditorInline): after a short pause above a text
14
- * selection, bold, italic, underline, strikethrough, code · link, highlight.
15
- * · Comment (M5). Rewrite with an agent (M6) joins it later. Without edit
16
- * rights (Viewing) only Comment shows.
17
- */
18
- function SelectionBubble({
19
- editor,
20
- labels,
21
- onLink,
22
- onComment,
23
- }: {
24
- editor: Editor
25
- labels: EditorLabels
26
- onLink: () => void
27
- /** M5: Comment on the selection; with it the bubble shows even where nothing can be edited. */
28
- onComment?: () => void
29
- }) {
30
- const s = useEditorState({
31
- editor,
32
- selector: ({ editor: e }) => ({
33
- bold: e.isActive("bold"),
34
- italic: e.isActive("italic"),
35
- underline: e.isActive("underline"),
36
- strike: e.isActive("strike"),
37
- code: e.isActive("code"),
38
- link: e.isActive("link"),
39
- highlight: e.isActive("highlight"),
40
- editable: e.isEditable,
41
- }),
42
- })
43
- const b = (icon: IconName, label: string, on: boolean, onClick: () => void, shortcut?: string) => (
44
- <IconButton
45
- icon={icon}
46
- label={label}
47
- size="sm"
48
- shortcut={shortcut}
49
- pressed={on}
50
- onMouseDown={(e) => e.preventDefault()}
51
- onClick={onClick}
52
- />
53
- )
54
- const mark = (name: string) => () => editor.chain().focus().toggleMark(name).run()
55
- return (
56
- <BubbleMenu
57
- editor={editor}
58
- updateDelay={250}
59
- shouldShow={({ editor: e, state, from, to }) =>
60
- (e.isEditable || !!onComment) && isTextSelection(state.selection) && from !== to && !e.isActive("codeBlock")
61
- }
62
- options={{ placement: "top-start", offset: 8 }}
63
- >
64
- <div
65
- role="toolbar"
66
- aria-label={labels.selection}
67
- data-slot="selection-bubble"
68
- className="flex items-center gap-0.5 rounded-control border border-border bg-popover p-[3px] whitespace-nowrap shadow-float"
69
- >
70
- {s.editable && (
71
- <>
72
- {b("bold", labels.bold, s.bold, mark("bold"), "⌘B")}
73
- {b("italic", labels.italic, s.italic, mark("italic"), "⌘I")}
74
- {b("underline", labels.underline, s.underline, mark("underline"), "⌘U")}
75
- {b("strike", labels.strike, s.strike, mark("strike"), "⇧⌘X")}
76
- {b("code", labels.code, s.code, mark("code"), "⌘E")}
77
- <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />
78
- {b("link", labels.link, s.link, onLink, "⌘K")}
79
- {b("highlight", labels.highlight, s.highlight, mark("highlight"))}
80
- </>
81
- )}
82
- {onComment && (
83
- <>
84
- {s.editable && <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />}
85
- {b("comment-add", labels.comment, false, onComment, "⌥⌘M")}
86
- </>
87
- )}
88
- </div>
89
- </BubbleMenu>
90
- )
91
- }
92
-
93
- export { SelectionBubble }
1
+ "use client"
2
+
3
+ import type { Editor } from "@tiptap/core"
4
+ import { isTextSelection } from "@tiptap/core"
5
+ import { useEditorState } from "@tiptap/react"
6
+ import { BubbleMenu } from "@tiptap/react/menus"
7
+
8
+ import type { IconName } from "../icon"
9
+ import { IconButton } from "../icon-button"
10
+ import type { EditorLabels } from "./labels"
11
+ import { mintPartKey } from "./saved-parts"
12
+
13
+ /**
14
+ * The selection bubble (EditorInline): after a short pause above a text
15
+ * selection, bold, italic, underline, strikethrough, code · link, highlight.
16
+ * · Comment (M5) · Rewrite with an agent (M6, EditorAgents): the agent's
17
+ * version arrives as a suggestion. Without edit rights (Viewing) only Comment
18
+ * and Rewrite show.
19
+ */
20
+ function SelectionBubble({
21
+ editor,
22
+ labels,
23
+ onLink,
24
+ onComment,
25
+ onRewrite,
26
+ perDocument,
27
+ }: {
28
+ editor: Editor
29
+ labels: EditorLabels
30
+ onLink: () => void
31
+ /** M5: Comment on the selection; with it the bubble shows even where nothing can be edited. */
32
+ onComment?: () => void
33
+ /** M6: ask an agent to rewrite the selection; its version comes back as a suggestion. */
34
+ onRewrite?: () => void
35
+ /** M7, E.23: editing a saved block's original, mark text as filled per document. */
36
+ perDocument?: boolean
37
+ }) {
38
+ const s = useEditorState({
39
+ editor,
40
+ selector: ({ editor: e }) => ({
41
+ bold: e.isActive("bold"),
42
+ italic: e.isActive("italic"),
43
+ underline: e.isActive("underline"),
44
+ strike: e.isActive("strike"),
45
+ code: e.isActive("code"),
46
+ link: e.isActive("link"),
47
+ highlight: e.isActive("highlight"),
48
+ perDocument: e.isActive("perDocument"),
49
+ editable: e.isEditable,
50
+ }),
51
+ })
52
+ const b = (icon: IconName, label: string, on: boolean, onClick: () => void, shortcut?: string) => (
53
+ <IconButton
54
+ icon={icon}
55
+ label={label}
56
+ size="sm"
57
+ shortcut={shortcut}
58
+ pressed={on}
59
+ onMouseDown={(e) => e.preventDefault()}
60
+ onClick={onClick}
61
+ />
62
+ )
63
+ const mark = (name: string) => () => editor.chain().focus().toggleMark(name).run()
64
+ // E.23a: marking mints the part's key once; unmarking deletes it, and marking again mints a new one.
65
+ const togglePart = () =>
66
+ s.perDocument
67
+ ? editor.chain().focus().unsetMark("perDocument").run()
68
+ : editor.chain().focus().setMark("perDocument", { key: mintPartKey() }).run()
69
+ return (
70
+ <BubbleMenu
71
+ editor={editor}
72
+ updateDelay={250}
73
+ shouldShow={({ editor: e, state, from, to }) =>
74
+ (e.isEditable || !!onComment || !!onRewrite) && isTextSelection(state.selection) && from !== to && !e.isActive("codeBlock")
75
+ }
76
+ options={{ placement: "top-start", offset: 8 }}
77
+ >
78
+ <div
79
+ role="toolbar"
80
+ aria-label={labels.selection}
81
+ data-slot="selection-bubble"
82
+ className="flex items-center gap-0.5 rounded-control border border-border bg-popover p-[3px] whitespace-nowrap shadow-float"
83
+ >
84
+ {s.editable && (
85
+ <>
86
+ {b("bold", labels.bold, s.bold, mark("bold"), "⌘B")}
87
+ {b("italic", labels.italic, s.italic, mark("italic"), "⌘I")}
88
+ {b("underline", labels.underline, s.underline, mark("underline"), "⌘U")}
89
+ {b("strike", labels.strike, s.strike, mark("strike"), "⇧⌘X")}
90
+ {b("code", labels.code, s.code, mark("code"), "⌘E")}
91
+ <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />
92
+ {b("link", labels.link, s.link, onLink, "⌘K")}
93
+ {b("highlight", labels.highlight, s.highlight, mark("highlight"))}
94
+ {perDocument && (
95
+ <>
96
+ <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />
97
+ {b("field", labels.perDocumentMark, s.perDocument, togglePart)}
98
+ </>
99
+ )}
100
+ </>
101
+ )}
102
+ {onComment && (
103
+ <>
104
+ {s.editable && <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />}
105
+ {b("comment-add", labels.comment, false, onComment, "⌥⌘M")}
106
+ </>
107
+ )}
108
+ {onRewrite && (
109
+ <>
110
+ {(s.editable || onComment) && <span aria-hidden="true" className="mx-[3px] h-[18px] w-px bg-border" />}
111
+ {b("robot", labels.agentRewrite, false, onRewrite)}
112
+ </>
113
+ )}
114
+ </div>
115
+ </BubbleMenu>
116
+ )
117
+ }
118
+
119
+ export { SelectionBubble }
@@ -1,103 +1,169 @@
1
- import type { Editor, JSONContent } from "@tiptap/core"
2
-
3
- import type { IconName } from "../icon"
4
- import { currentBlock } from "./behaviour"
5
- import type { EditorLabels } from "./labels"
6
-
7
- /**
8
- * The blocks the editor inserts in this version, grouped as the / menu shows
9
- * them (EditorInsert, E.13). The same list feeds the + inserter, Insert ▾ and
10
- * Turn into. Media, Whity, saved and plugin blocks join in later milestones.
11
- */
12
- export interface CatalogueItem {
13
- id: string
14
- group: "groupBasic" | "groupLists" | "groupStructure" | "groupMedia" | "groupWhity"
15
- label: keyof EditorLabels
16
- hint: keyof EditorLabels
17
- icon: IconName
18
- /** The Markdown shortcut, shown beside the item. */
19
- markdown?: string
20
- keywords: string[]
21
- /** Text blocks can be a "Turn into" target. */
22
- textBlock: boolean
23
- node: { type: string; attrs?: Record<string, unknown>; content?: JSONContent[] }
24
- }
25
-
26
- const cell = (text = "") => ({ type: "tableCell", ...(text ? { content: [{ type: "text", text }] } : {}) })
27
- const row = (n: number) => ({ type: "tableRow", content: Array.from({ length: n }, () => cell()) })
28
-
29
- export const CATALOGUE: CatalogueItem[] = [
30
- { id: "text", group: "groupBasic", label: "blockText", hint: "blockTextHint", icon: "text", keywords: ["paragraph", "plain"], textBlock: true, node: { type: "paragraph" } },
31
- { id: "h1", group: "groupBasic", label: "blockH1", hint: "blockH1Hint", icon: "heading-1", markdown: "#", keywords: ["title", "h1"], textBlock: true, node: { type: "heading", attrs: { level: 1 } } },
32
- { id: "h2", group: "groupBasic", label: "blockH2", hint: "blockH2Hint", icon: "heading-2", markdown: "##", keywords: ["subtitle", "h2"], textBlock: true, node: { type: "heading", attrs: { level: 2 } } },
33
- { id: "h3", group: "groupBasic", label: "blockH3", hint: "blockH3Hint", icon: "heading-3", markdown: "###", keywords: ["h3"], textBlock: true, node: { type: "heading", attrs: { level: 3 } } },
34
- { id: "quote", group: "groupBasic", label: "blockQuote", hint: "blockQuoteHint", icon: "blockquote", markdown: ">", keywords: ["citation"], textBlock: true, node: { type: "quote" } },
35
- { id: "code", group: "groupBasic", label: "blockCode", hint: "blockCodeHint", icon: "code", markdown: "```", keywords: ["snippet", "monospace"], textBlock: true, node: { type: "codeBlock" } },
36
- { id: "bullet", group: "groupLists", label: "blockBullet", hint: "blockBulletHint", icon: "list-bullet", markdown: "-", keywords: ["unordered", "ul"], textBlock: true, node: { type: "listItem", attrs: { kind: "bullet", level: 0 } } },
37
- { id: "number", group: "groupLists", label: "blockNumber", hint: "blockNumberHint", icon: "list-numbered", markdown: "1.", keywords: ["ordered", "ol"], textBlock: true, node: { type: "listItem", attrs: { kind: "number", level: 0 } } },
38
- { id: "checklist", group: "groupLists", label: "blockChecklist", hint: "blockChecklistHint", icon: "list-todo", markdown: "[]", keywords: ["todo", "task", "check"], textBlock: true, node: { type: "checkItem", attrs: { level: 0, checked: false } } },
39
- { id: "callout", group: "groupBasic", label: "blockCallout", hint: "blockCalloutHint", icon: "info", keywords: ["note", "important", "warning", "aside"], textBlock: true, node: { type: "callout", attrs: { kind: "note" } } },
40
- { id: "math", group: "groupBasic", label: "blockMath", hint: "blockMathHint", icon: "text", keywords: ["formula", "equation", "tex", "latex", "katex"], textBlock: false, node: { type: "math", attrs: { tex: "" } } },
41
- { id: "toggle", group: "groupStructure", label: "blockToggle", hint: "blockToggleHint", icon: "chevron-right", keywords: ["collapse", "expand", "details", "faq"], textBlock: false, node: { type: "toggle", attrs: { open: true }, content: [{ type: "toggleSummary" }, { type: "paragraph" }] } },
42
- { id: "columns", group: "groupStructure", label: "blockColumns", hint: "blockColumnsHint", icon: "columns", keywords: ["layout", "side by side", "split"], textBlock: false, node: { type: "columns", content: [{ type: "column", content: [{ type: "paragraph" }] }, { type: "column", content: [{ type: "paragraph" }] }] } },
43
- { id: "divider", group: "groupStructure", label: "blockDivider", hint: "blockDividerHint", icon: "divider", markdown: "---", keywords: ["line", "separator", "hr", "rule"], textBlock: false, node: { type: "divider" } },
44
- { id: "pageBreak", group: "groupStructure", label: "blockPageBreak", hint: "blockPageBreakHint", icon: "page-break", keywords: ["new page", "print"], textBlock: false, node: { type: "pageBreak" } },
45
- { id: "table", group: "groupMedia", label: "blockTable", hint: "blockTableHint", icon: "table", keywords: ["grid", "rows", "columns"], textBlock: false, node: { type: "table", attrs: { headerRow: true, columns: [{ align: "start" }, { align: "start" }, { align: "end" }] }, content: [row(3), row(3)] } },
46
- { id: "image", group: "groupMedia", label: "blockImage", hint: "blockImageHint", icon: "image", keywords: ["picture", "photo", "logo"], textBlock: false, node: { type: "image", attrs: { src: "", alt: "", width: "full" } } },
47
- { id: "file", group: "groupMedia", label: "blockFile", hint: "blockFileHint", icon: "document", keywords: ["attachment", "pdf", "download"], textBlock: false, node: { type: "file" } },
48
- { id: "record", group: "groupWhity", label: "blockRecord", hint: "blockRecordHint", icon: "invoice", keywords: ["invoice", "customer", "live", "embed"], textBlock: false, node: { type: "record", attrs: { ref: null, view: "card" } } },
49
- { id: "chart", group: "groupWhity", label: "blockChart", hint: "blockChartHint", icon: "chart", keywords: ["graph", "bars", "line", "donut", "live"], textBlock: false, node: { type: "chart", attrs: { chart: "bar", source: null } } },
50
- { id: "signature", group: "groupWhity", label: "blockSignature", hint: "blockSignatureHint", icon: "edit", keywords: ["sign", "stamp", "signer"], textBlock: false, node: { type: "signature", attrs: { signers: [{ name: [], role: [] }], date: [], stamp: true } } },
51
- { id: "barcode", group: "groupWhity", label: "blockBarcode", hint: "blockBarcodeHint", icon: "qr", keywords: ["code128", "ean", "code39", "label"], textBlock: false, node: { type: "barcode", attrs: { symbology: "code128", value: [], showText: true } } },
52
- { id: "qr", group: "groupWhity", label: "blockQr", hint: "blockQrHint", icon: "qr", keywords: ["qrcode", "scan", "link"], textBlock: false, node: { type: "qr", attrs: { value: [] } } },
53
- ]
54
-
55
- /** Filter by the item's name, hint and keywords, in the current language and in English. */
56
- export function filterCatalogue(query: string, labels: EditorLabels, english: EditorLabels): CatalogueItem[] {
57
- const q = query.trim().toLowerCase()
58
- if (!q) return CATALOGUE
59
- return CATALOGUE.filter((item) =>
60
- [labels[item.label], labels[item.hint], english[item.label], english[item.hint], item.id, ...item.keywords]
61
- .some((word) => String(word).toLowerCase().includes(q))
62
- )
63
- }
64
-
65
- /** The catalogue item that matches the current block, for the style menu and Turn into. */
66
- export function currentItem(editor: Editor): CatalogueItem | undefined {
67
- const block = currentBlock(editor)
68
- if (!block) return undefined
69
- const { name } = block.node.type
70
- return CATALOGUE.find(
71
- (item) =>
72
- item.node.type === name &&
73
- (name !== "heading" || item.node.attrs?.level === block.node.attrs.level) &&
74
- (name !== "listItem" || item.node.attrs?.kind === block.node.attrs.kind)
75
- )
76
- }
77
-
78
- /**
79
- * Put the item where the caret is (E.13, EditorInsert): an empty text line
80
- * turns into the block; a line with text gets the block after it.
81
- */
82
- export function applyItem(editor: Editor, item: CatalogueItem, { after }: { after?: number } = {}): void {
83
- const block = currentBlock(editor)
84
- const atPos = after ?? (block ? block.pos + block.node.nodeSize : editor.state.doc.content.size)
85
- const empty = after === undefined && block && block.node.isTextblock && block.node.content.size === 0
86
- const chain = editor.chain().focus()
87
- if (empty && item.textBlock) {
88
- chain.setNode(item.node.type, { ...item.node.attrs, id: block.node.attrs.id }).run()
89
- return
90
- }
91
- const node: JSONContent = { type: item.node.type, attrs: item.node.attrs, ...(item.node.content ? { content: item.node.content } : {}) }
92
- if (empty && block) {
93
- // A block on an empty line takes its place, with a fresh line after it.
94
- chain.insertContentAt({ from: block.pos, to: block.pos + block.node.nodeSize }, [node, { type: "paragraph" }]).run()
95
- return
96
- }
97
- const content = item.textBlock ? [node] : [node, { type: "paragraph" }]
98
- // The caret lands in the new text block, or in the fresh line after a divider.
99
- chain
100
- .insertContentAt(atPos, content)
101
- .setTextSelection(atPos + (item.textBlock ? 1 : 2))
102
- .run()
103
- }
1
+ import type { Editor, JSONContent } from "@tiptap/core"
2
+
3
+ import { iconNames, type IconName } from "../icon"
4
+ import { currentBlock } from "./behaviour"
5
+ import type { SavedBlock } from "./contract"
6
+ import { freshEditorBlocks } from "./convert"
7
+ import { defaultData } from "./plugin-blocks"
8
+ import type { PluginBlocks } from "./services"
9
+ import type { EditorLabels } from "./labels"
10
+ import { localizedText } from "../localized-text"
11
+
12
+ /**
13
+ * The blocks the editor inserts in this version, grouped as the / menu shows
14
+ * them (EditorInsert, E.13). The same list feeds the + inserter, Insert ▾ and
15
+ * Turn into. Media, Whity, saved and plugin blocks join in later milestones.
16
+ */
17
+ export interface CatalogueItem {
18
+ id: string
19
+ group: "groupBasic" | "groupLists" | "groupStructure" | "groupMedia" | "groupWhity" | "groupSaved" | "groupPlugin"
20
+ /** A group heading of its own (a plugin's name, E.20), shown instead of the group's label. */
21
+ groupTitle?: string
22
+ label: keyof EditorLabels
23
+ hint: keyof EditorLabels
24
+ /** A name of its own (a saved block's), shown instead of `label`. */
25
+ title?: string
26
+ /** A one-line hint of its own (a plugin block's description), shown instead of `hint`. */
27
+ hintText?: string
28
+ /** Several blocks at once (a saved block's copy), inserted instead of `node`. */
29
+ nodes?: JSONContent[]
30
+ icon: IconName
31
+ /** The Markdown shortcut, shown beside the item. */
32
+ markdown?: string
33
+ keywords: string[]
34
+ /** Text blocks can be a "Turn into" target. */
35
+ textBlock: boolean
36
+ node: { type: string; attrs?: Record<string, unknown>; content?: JSONContent[] }
37
+ }
38
+
39
+ const cell = (text = "") => ({ type: "tableCell", ...(text ? { content: [{ type: "text", text }] } : {}) })
40
+ const row = (n: number) => ({ type: "tableRow", content: Array.from({ length: n }, () => cell()) })
41
+
42
+ export const CATALOGUE: CatalogueItem[] = [
43
+ { id: "text", group: "groupBasic", label: "blockText", hint: "blockTextHint", icon: "text", keywords: ["paragraph", "plain"], textBlock: true, node: { type: "paragraph" } },
44
+ { id: "h1", group: "groupBasic", label: "blockH1", hint: "blockH1Hint", icon: "heading-1", markdown: "#", keywords: ["title", "h1"], textBlock: true, node: { type: "heading", attrs: { level: 1 } } },
45
+ { id: "h2", group: "groupBasic", label: "blockH2", hint: "blockH2Hint", icon: "heading-2", markdown: "##", keywords: ["subtitle", "h2"], textBlock: true, node: { type: "heading", attrs: { level: 2 } } },
46
+ { id: "h3", group: "groupBasic", label: "blockH3", hint: "blockH3Hint", icon: "heading-3", markdown: "###", keywords: ["h3"], textBlock: true, node: { type: "heading", attrs: { level: 3 } } },
47
+ { id: "quote", group: "groupBasic", label: "blockQuote", hint: "blockQuoteHint", icon: "blockquote", markdown: ">", keywords: ["citation"], textBlock: true, node: { type: "quote" } },
48
+ { id: "code", group: "groupBasic", label: "blockCode", hint: "blockCodeHint", icon: "code", markdown: "```", keywords: ["snippet", "monospace"], textBlock: true, node: { type: "codeBlock" } },
49
+ { id: "bullet", group: "groupLists", label: "blockBullet", hint: "blockBulletHint", icon: "list-bullet", markdown: "-", keywords: ["unordered", "ul"], textBlock: true, node: { type: "listItem", attrs: { kind: "bullet", level: 0 } } },
50
+ { id: "number", group: "groupLists", label: "blockNumber", hint: "blockNumberHint", icon: "list-numbered", markdown: "1.", keywords: ["ordered", "ol"], textBlock: true, node: { type: "listItem", attrs: { kind: "number", level: 0 } } },
51
+ { id: "checklist", group: "groupLists", label: "blockChecklist", hint: "blockChecklistHint", icon: "list-todo", markdown: "[]", keywords: ["todo", "task", "check"], textBlock: true, node: { type: "checkItem", attrs: { level: 0, checked: false } } },
52
+ { id: "callout", group: "groupBasic", label: "blockCallout", hint: "blockCalloutHint", icon: "info", keywords: ["note", "important", "warning", "aside"], textBlock: true, node: { type: "callout", attrs: { kind: "note" } } },
53
+ { id: "math", group: "groupBasic", label: "blockMath", hint: "blockMathHint", icon: "text", keywords: ["formula", "equation", "tex", "latex", "katex"], textBlock: false, node: { type: "math", attrs: { tex: "" } } },
54
+ { id: "toggle", group: "groupStructure", label: "blockToggle", hint: "blockToggleHint", icon: "chevron-right", keywords: ["collapse", "expand", "details", "faq"], textBlock: false, node: { type: "toggle", attrs: { open: true }, content: [{ type: "toggleSummary" }, { type: "paragraph" }] } },
55
+ { id: "columns", group: "groupStructure", label: "blockColumns", hint: "blockColumnsHint", icon: "columns", keywords: ["layout", "side by side", "split"], textBlock: false, node: { type: "columns", content: [{ type: "column", content: [{ type: "paragraph" }] }, { type: "column", content: [{ type: "paragraph" }] }] } },
56
+ { id: "divider", group: "groupStructure", label: "blockDivider", hint: "blockDividerHint", icon: "divider", markdown: "---", keywords: ["line", "separator", "hr", "rule"], textBlock: false, node: { type: "divider" } },
57
+ { id: "pageBreak", group: "groupStructure", label: "blockPageBreak", hint: "blockPageBreakHint", icon: "page-break", keywords: ["new page", "print"], textBlock: false, node: { type: "pageBreak" } },
58
+ { id: "table", group: "groupMedia", label: "blockTable", hint: "blockTableHint", icon: "table", keywords: ["grid", "rows", "columns"], textBlock: false, node: { type: "table", attrs: { headerRow: true, columns: [{ align: "start" }, { align: "start" }, { align: "end" }] }, content: [row(3), row(3)] } },
59
+ { id: "image", group: "groupMedia", label: "blockImage", hint: "blockImageHint", icon: "image", keywords: ["picture", "photo", "logo"], textBlock: false, node: { type: "image", attrs: { src: "", alt: "", width: "full" } } },
60
+ { id: "file", group: "groupMedia", label: "blockFile", hint: "blockFileHint", icon: "document", keywords: ["attachment", "pdf", "download"], textBlock: false, node: { type: "file" } },
61
+ { id: "record", group: "groupWhity", label: "blockRecord", hint: "blockRecordHint", icon: "invoice", keywords: ["invoice", "customer", "live", "embed"], textBlock: false, node: { type: "record", attrs: { ref: null, view: "card" } } },
62
+ { id: "chart", group: "groupWhity", label: "blockChart", hint: "blockChartHint", icon: "chart", keywords: ["graph", "bars", "line", "donut", "live"], textBlock: false, node: { type: "chart", attrs: { chart: "bar", source: null } } },
63
+ { id: "signature", group: "groupWhity", label: "blockSignature", hint: "blockSignatureHint", icon: "edit", keywords: ["sign", "stamp", "signer"], textBlock: false, node: { type: "signature", attrs: { signers: [{ name: [], role: [] }], date: [], stamp: true } } },
64
+ { id: "barcode", group: "groupWhity", label: "blockBarcode", hint: "blockBarcodeHint", icon: "qr", keywords: ["code128", "ean", "code39", "label"], textBlock: false, node: { type: "barcode", attrs: { symbology: "code128", value: [], showText: true } } },
65
+ { id: "qr", group: "groupWhity", label: "blockQr", hint: "blockQrHint", icon: "qr", keywords: ["qrcode", "scan", "link"], textBlock: false, node: { type: "qr", attrs: { value: [] } } },
66
+ ]
67
+
68
+ /**
69
+ * The / menu's Saved blocks group (E.21): a synced block goes in as one
70
+ * savedBlock drawn from the library; a copy goes in as its ordinary blocks.
71
+ */
72
+ export function savedBlockItems(saved: SavedBlock[] | undefined): CatalogueItem[] {
73
+ return (saved ?? []).map((b) => ({
74
+ id: `saved:${b.id}`,
75
+ group: "groupSaved",
76
+ label: "groupSaved",
77
+ hint: b.mode === "synced" ? "savedBlockSyncedHint" : "savedBlockCopyHint",
78
+ title: b.name,
79
+ icon: b.mode === "synced" ? "sync" : "copy",
80
+ keywords: ["saved", b.name],
81
+ textBlock: false,
82
+ node: { type: "savedBlock", attrs: { savedBlockId: b.id, version: b.version, overrides: {} } },
83
+ ...(b.mode === "copy" ? { nodes: freshEditorBlocks(b.blocks) } : {}),
84
+ }))
85
+ }
86
+
87
+ /**
88
+ * Each plugin's blocks, in a group of its own under the plugin's name, after
89
+ * Whity's blocks (E.20); only those allowed in this kind of document (E.18).
90
+ * The `hint` label is unused: a plugin block's hint is its own description.
91
+ */
92
+ export function pluginBlockItems(blocks: PluginBlocks | undefined, kind: string, lang: "en" | "ar"): CatalogueItem[] {
93
+ return (blocks?.plugins ?? []).flatMap((source) =>
94
+ source.blocks
95
+ .filter((b) => b.allowedIn.includes(kind))
96
+ .map(
97
+ (b): CatalogueItem => ({
98
+ id: `plugin:${b.name}`,
99
+ group: "groupPlugin",
100
+ groupTitle: localizedText(source.label, lang),
101
+ label: "groupPlugin",
102
+ hint: "groupPlugin",
103
+ title: localizedText(b.label, lang),
104
+ hintText: localizedText(b.description ?? null, lang) || localizedText(source.label, lang),
105
+ icon: (iconNames as readonly string[]).includes(b.icon) ? (b.icon as IconName) : "plugin",
106
+ keywords: [...b.keywords, localizedText(source.label, "en"), localizedText(b.label, "en")],
107
+ textBlock: false,
108
+ node: { type: "plugin", attrs: { plugin: source.plugin, blockType: b.blockType, schemaVersion: 1, data: defaultData(b) } },
109
+ })
110
+ )
111
+ )
112
+ }
113
+
114
+ /** Filter by the item's name, hint and keywords, in the current language and in English. */
115
+ export function filterCatalogue(query: string, labels: EditorLabels, english: EditorLabels, extra: CatalogueItem[] = []): CatalogueItem[] {
116
+ const all = extra.length ? [...CATALOGUE, ...extra] : CATALOGUE
117
+ const q = query.trim().toLowerCase()
118
+ if (!q) return all
119
+ return all.filter((item) =>
120
+ [item.title ?? labels[item.label], item.hintText ?? labels[item.hint], english[item.label], english[item.hint], item.id, ...item.keywords]
121
+ .some((word) => String(word).toLowerCase().includes(q))
122
+ )
123
+ }
124
+
125
+ /** The catalogue item that matches the current block, for the style menu and Turn into. */
126
+ export function currentItem(editor: Editor): CatalogueItem | undefined {
127
+ const block = currentBlock(editor)
128
+ if (!block) return undefined
129
+ const { name } = block.node.type
130
+ return CATALOGUE.find(
131
+ (item) =>
132
+ item.node.type === name &&
133
+ (name !== "heading" || item.node.attrs?.level === block.node.attrs.level) &&
134
+ (name !== "listItem" || item.node.attrs?.kind === block.node.attrs.kind)
135
+ )
136
+ }
137
+
138
+ /**
139
+ * Put the item where the caret is (E.13, EditorInsert): an empty text line
140
+ * turns into the block; a line with text gets the block after it.
141
+ */
142
+ export function applyItem(editor: Editor, item: CatalogueItem, { after }: { after?: number } = {}): void {
143
+ const block = currentBlock(editor)
144
+ const atPos = after ?? (block ? block.pos + block.node.nodeSize : editor.state.doc.content.size)
145
+ const empty = after === undefined && block && block.node.isTextblock && block.node.content.size === 0
146
+ const chain = editor.chain().focus()
147
+ if (empty && item.textBlock) {
148
+ chain.setNode(item.node.type, { ...item.node.attrs, id: block.node.attrs.id }).run()
149
+ return
150
+ }
151
+ const node: JSONContent = { type: item.node.type, attrs: item.node.attrs, ...(item.node.content ? { content: item.node.content } : {}) }
152
+ if (item.nodes) {
153
+ // A saved block's copy: its blocks, then a fresh line; an empty line gives way to them.
154
+ const range = empty && block ? { from: block.pos, to: block.pos + block.node.nodeSize } : atPos
155
+ chain.insertContentAt(range, [...item.nodes, { type: "paragraph" }]).run()
156
+ return
157
+ }
158
+ if (empty && block) {
159
+ // A block on an empty line takes its place, with a fresh line after it.
160
+ chain.insertContentAt({ from: block.pos, to: block.pos + block.node.nodeSize }, [node, { type: "paragraph" }]).run()
161
+ return
162
+ }
163
+ const content = item.textBlock ? [node] : [node, { type: "paragraph" }]
164
+ // The caret lands in the new text block, or in the fresh line after a divider.
165
+ chain
166
+ .insertContentAt(atPos, content)
167
+ .setTextSelection(atPos + (item.textBlock ? 1 : 2))
168
+ .run()
169
+ }