@whity/ui 0.0.0-stage → 1.0.0
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.
- package/README.md +106 -2
- package/package.json +219 -4
- package/src/access-denied.stories.tsx +179 -0
- package/src/access-denied.tsx +305 -0
- package/src/action-proposal.tsx +338 -0
- package/src/actor-chip.tsx +71 -0
- package/src/agent-activity.tsx +163 -0
- package/src/agent-collaboration.stories.tsx +156 -0
- package/src/agent-run-status.tsx +196 -0
- package/src/alert-dialog.stories.tsx +45 -0
- package/src/alert-dialog.tsx +147 -0
- package/src/alert.stories.tsx +91 -0
- package/src/alert.tsx +89 -0
- package/src/app-sidebar.stories.tsx +195 -0
- package/src/app-sidebar.tsx +604 -0
- package/src/approval-queue.tsx +109 -0
- package/src/audience-group-picker.stories.tsx +198 -0
- package/src/audience-group-picker.tsx +362 -0
- package/src/audience-people-picker.stories.tsx +102 -0
- package/src/audience-people-picker.tsx +279 -0
- package/src/avatar-pattern.ts +138 -0
- package/src/avatar.tsx +125 -0
- package/src/badge.stories.tsx +105 -0
- package/src/badge.tsx +68 -0
- package/src/beta-warning.stories.tsx +79 -0
- package/src/beta-warning.tsx +189 -0
- package/src/bilingual-input.stories.tsx +82 -0
- package/src/bilingual-input.tsx +188 -0
- package/src/board.tsx +216 -0
- package/src/breadcrumb.stories.tsx +51 -0
- package/src/breadcrumb.tsx +90 -0
- package/src/built-on-whity.tsx +52 -0
- package/src/button.stories.tsx +87 -0
- package/src/button.tsx +123 -0
- package/src/card.stories.tsx +423 -0
- package/src/card.tsx +180 -0
- package/src/chart.stories.tsx +66 -0
- package/src/chart.tsx +228 -0
- package/src/checkbox.stories.tsx +62 -0
- package/src/checkbox.tsx +54 -0
- package/src/collapsible.stories.tsx +48 -0
- package/src/collapsible.tsx +34 -0
- package/src/color-card.stories.tsx +61 -0
- package/src/color-card.tsx +270 -0
- package/src/color-picker.stories.tsx +65 -0
- package/src/color-picker.tsx +425 -0
- package/src/column-matcher.tsx +84 -0
- package/src/command-palette.tsx +398 -0
- package/src/confirm-action.tsx +98 -0
- package/src/copy-block.stories.tsx +38 -0
- package/src/copy-block.tsx +85 -0
- package/src/data-table.stories.tsx +200 -0
- package/src/data-table.tsx +1686 -0
- package/src/date-picker.stories.tsx +61 -0
- package/src/date-picker.tsx +456 -0
- package/src/design-cards.stories.tsx +551 -0
- package/src/dialog.stories.tsx +48 -0
- package/src/dialog.tsx +179 -0
- package/src/display-preferences.tsx +50 -0
- package/src/documents/barcode-svg.stories.tsx +72 -0
- package/src/documents/barcode-svg.tsx +79 -0
- package/src/dropdown-menu.stories.tsx +77 -0
- package/src/dropdown-menu.tsx +271 -0
- package/src/editor/agent-panel.tsx +222 -0
- package/src/editor/agents.stories.tsx +81 -0
- package/src/editor/agents.ts +55 -0
- package/src/editor/behaviour.ts +279 -0
- package/src/editor/block-ids.ts +44 -0
- package/src/editor/block-list.tsx +104 -0
- package/src/editor/block-toolbar.tsx +490 -0
- package/src/editor/bubble.tsx +119 -0
- package/src/editor/catalogue.ts +169 -0
- package/src/editor/collab-rail.tsx +746 -0
- package/src/editor/collab.stories.tsx +207 -0
- package/src/editor/collab.ts +87 -0
- package/src/editor/contract.ts +476 -0
- package/src/editor/convert.ts +414 -0
- package/src/editor/doc-editor.stories.tsx +98 -0
- package/src/editor/doc-editor.tsx +1492 -0
- package/src/editor/editor.css +636 -0
- package/src/editor/extensions.ts +86 -0
- package/src/editor/field-bar.tsx +154 -0
- package/src/editor/field-picker.tsx +109 -0
- package/src/editor/fields.ts +100 -0
- package/src/editor/gutter.tsx +443 -0
- package/src/editor/index.ts +23 -0
- package/src/editor/label-sheet.tsx +289 -0
- package/src/editor/labels.ts +394 -0
- package/src/editor/link-tools.tsx +141 -0
- package/src/editor/node-views.tsx +461 -0
- package/src/editor/page-view.tsx +372 -0
- package/src/editor/phone.tsx +310 -0
- package/src/editor/plugin-block-view.tsx +230 -0
- package/src/editor/plugin-blocks.stories.tsx +96 -0
- package/src/editor/plugin-blocks.ts +52 -0
- package/src/editor/publish-check.tsx +201 -0
- package/src/editor/rich-blocks.stories.tsx +146 -0
- package/src/editor/sample.ts +40 -0
- package/src/editor/save-block-dialog.tsx +141 -0
- package/src/editor/saved-block-view.tsx +205 -0
- package/src/editor/saved-blocks.stories.tsx +105 -0
- package/src/editor/saved-parts.ts +192 -0
- package/src/editor/schema-rich.ts +156 -0
- package/src/editor/schema.ts +368 -0
- package/src/editor/services.tsx +205 -0
- package/src/editor/slash.ts +64 -0
- package/src/editor/suggesting.ts +372 -0
- package/src/editor/suggestions.ts +763 -0
- package/src/editor/table-keys.ts +66 -0
- package/src/editor/templates.stories.tsx +324 -0
- package/src/editor/toolbar.tsx +364 -0
- package/src/empty-state.stories.tsx +51 -0
- package/src/empty-state.tsx +126 -0
- package/src/empty-state.usage-notes.md +30 -0
- package/src/form.stories.tsx +112 -0
- package/src/form.tsx +176 -0
- package/src/globals.css +20 -0
- package/src/icon-button.tsx +85 -0
- package/src/icon-map.ts +335 -0
- package/src/icon.tsx +41 -0
- package/src/index.ts +90 -0
- package/src/input.stories.tsx +157 -0
- package/src/input.tsx +768 -0
- package/src/kpi-strip.tsx +47 -0
- package/src/localized-text.ts +76 -0
- package/src/locked-screen.stories.tsx +29 -0
- package/src/locked-screen.tsx +75 -0
- package/src/lockup.tsx +42 -0
- package/src/lottie.tsx +441 -0
- package/src/mark.tsx +62 -0
- package/src/math-text.stories.tsx +33 -0
- package/src/math-text.tsx +43 -0
- package/src/menu-bar.stories.tsx +198 -0
- package/src/menu-bar.tsx +373 -0
- package/src/message-thread.tsx +181 -0
- package/src/money/currency.ts +244 -0
- package/src/money/money-input.tsx +131 -0
- package/src/money/money.tsx +33 -0
- package/src/open-on-computer.tsx +150 -0
- package/src/otp-input.tsx +161 -0
- package/src/page-header.stories.tsx +95 -0
- package/src/page-header.tsx +122 -0
- package/src/page-shell.stories.tsx +42 -0
- package/src/page-shell.tsx +32 -0
- package/src/page-states.tsx +277 -0
- package/src/pagination.stories.tsx +45 -0
- package/src/pagination.tsx +98 -0
- package/src/paper-sheet.stories.tsx +88 -0
- package/src/paper-sheet.tsx +85 -0
- package/src/phone-tab-bar.tsx +152 -0
- package/src/plugin-card.stories.tsx +208 -0
- package/src/plugin-card.tsx +931 -0
- package/src/popover.stories.tsx +48 -0
- package/src/popover.tsx +55 -0
- package/src/radio-group.stories.tsx +26 -0
- package/src/radio-group.tsx +44 -0
- package/src/route-flow/editor.tsx +1087 -0
- package/src/route-flow/model.ts +771 -0
- package/src/save-bar.tsx +94 -0
- package/src/scope-grant.tsx +139 -0
- package/src/screen-too-small.stories.tsx +61 -0
- package/src/screen-too-small.tsx +104 -0
- package/src/search-field.tsx +65 -0
- package/src/select.stories.tsx +44 -0
- package/src/select.tsx +197 -0
- package/src/separator.stories.tsx +34 -0
- package/src/separator.tsx +34 -0
- package/src/sheet.stories.tsx +49 -0
- package/src/sheet.tsx +168 -0
- package/src/skeleton.stories.tsx +28 -0
- package/src/skeleton.tsx +19 -0
- package/src/slider.stories.tsx +78 -0
- package/src/slider.tsx +300 -0
- package/src/spinner.stories.tsx +33 -0
- package/src/spinner.tsx +55 -0
- package/src/stepper.tsx +85 -0
- package/src/switch.stories.tsx +42 -0
- package/src/switch.tsx +41 -0
- package/src/switcher.stories.tsx +111 -0
- package/src/switcher.tsx +131 -0
- package/src/system-state.tsx +55 -0
- package/src/table.stories.tsx +48 -0
- package/src/table.tsx +121 -0
- package/src/tabs.stories.tsx +74 -0
- package/src/tabs.tsx +90 -0
- package/src/tag-input.stories.tsx +67 -0
- package/src/tag-input.tsx +117 -0
- package/src/tenant-logo.tsx +63 -0
- package/src/tenant-switcher.stories.tsx +38 -0
- package/src/tenant-switcher.tsx +164 -0
- package/src/textarea.stories.tsx +27 -0
- package/src/textarea.tsx +18 -0
- package/src/theme-mode.ts +52 -0
- package/src/time-grid.tsx +163 -0
- package/src/time-picker.stories.tsx +62 -0
- package/src/time-picker.tsx +615 -0
- package/src/toggle-group.tsx +138 -0
- package/src/tooltip.stories.tsx +43 -0
- package/src/tooltip.tsx +73 -0
- package/src/top-nav.stories.tsx +58 -0
- package/src/top-nav.tsx +324 -0
- package/src/undo-bar.tsx +107 -0
- package/src/utils.ts +45 -0
- package/src/view-toggle.stories.tsx +84 -0
- package/src/view-toggle.tsx +110 -0
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
import { Mark, Node, mergeAttributes } from "@tiptap/core"
|
|
2
|
+
import { Fragment, Slice, type Node as PmNode } from "@tiptap/pm/model"
|
|
3
|
+
import { Plugin, PluginKey } from "@tiptap/pm/state"
|
|
4
|
+
|
|
5
|
+
import { mintPartKey } from "./saved-parts"
|
|
6
|
+
import { richSchemaExtensions } from "./schema-rich"
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* The ProseMirror schema for the WhityDocument contract (contract.ts,
|
|
10
|
+
* handoff/editor/README.md). Every block node carries a stable `id` (BlockId)
|
|
11
|
+
* and an optional `suggestion` (E.4). Lists are flat items with a `level`
|
|
12
|
+
* (Notion style), so drag-and-drop and Turn into stay simple. Blocks the
|
|
13
|
+
* editor can't edit yet (later milestones) are kept whole in `unknownBlock`,
|
|
14
|
+
* so a document never loses data by passing through the editor.
|
|
15
|
+
*
|
|
16
|
+
* Headings 1–3 render as h2–h4: the document title is the page's h1.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
/** Attributes every block node has. */
|
|
20
|
+
const blockAttributes = {
|
|
21
|
+
id: { default: null, keepOnSplit: false },
|
|
22
|
+
suggestion: { default: null, rendered: false },
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function blockAttrs(attrs: Record<string, unknown>, extra: Record<string, unknown> = {}) {
|
|
26
|
+
return mergeAttributes({ "data-block-id": attrs.id ?? undefined, ...extra })
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export const DocumentNode = Node.create({
|
|
30
|
+
name: "doc",
|
|
31
|
+
topNode: true,
|
|
32
|
+
content: "block+",
|
|
33
|
+
})
|
|
34
|
+
|
|
35
|
+
export const TextNode = Node.create({
|
|
36
|
+
name: "text",
|
|
37
|
+
group: "inline",
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
export const Paragraph = Node.create({
|
|
41
|
+
name: "paragraph",
|
|
42
|
+
group: "block",
|
|
43
|
+
content: "inline*",
|
|
44
|
+
priority: 1000,
|
|
45
|
+
addAttributes: () => blockAttributes,
|
|
46
|
+
parseHTML: () => [{ tag: "p" }],
|
|
47
|
+
renderHTML: ({ node }) => ["p", blockAttrs(node.attrs, { "data-type": "paragraph" }), 0],
|
|
48
|
+
})
|
|
49
|
+
|
|
50
|
+
export const Heading = Node.create({
|
|
51
|
+
name: "heading",
|
|
52
|
+
group: "block",
|
|
53
|
+
content: "inline*",
|
|
54
|
+
defining: true,
|
|
55
|
+
addAttributes: () => ({ ...blockAttributes, level: { default: 1 } }),
|
|
56
|
+
parseHTML: () => [
|
|
57
|
+
{ tag: "h2", attrs: { level: 1 } },
|
|
58
|
+
{ tag: "h3", attrs: { level: 2 } },
|
|
59
|
+
{ tag: "h4", attrs: { level: 3 } },
|
|
60
|
+
],
|
|
61
|
+
renderHTML: ({ node }) => [
|
|
62
|
+
`h${Number(node.attrs.level) + 1}`,
|
|
63
|
+
blockAttrs(node.attrs, { "data-type": "heading", "data-level": node.attrs.level }),
|
|
64
|
+
0,
|
|
65
|
+
],
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
export const Quote = Node.create({
|
|
69
|
+
name: "quote",
|
|
70
|
+
group: "block",
|
|
71
|
+
content: "inline*",
|
|
72
|
+
defining: true,
|
|
73
|
+
addAttributes: () => blockAttributes,
|
|
74
|
+
parseHTML: () => [{ tag: "blockquote" }],
|
|
75
|
+
renderHTML: ({ node }) => ["blockquote", blockAttrs(node.attrs, { "data-type": "quote" }), 0],
|
|
76
|
+
})
|
|
77
|
+
|
|
78
|
+
export const CodeBlock = Node.create({
|
|
79
|
+
name: "codeBlock",
|
|
80
|
+
group: "block",
|
|
81
|
+
content: "text*",
|
|
82
|
+
marks: "",
|
|
83
|
+
code: true,
|
|
84
|
+
defining: true,
|
|
85
|
+
addAttributes: () => ({ ...blockAttributes, language: { default: null } }),
|
|
86
|
+
parseHTML: () => [{ tag: "pre", preserveWhitespace: "full" }],
|
|
87
|
+
renderHTML: ({ node }) => [
|
|
88
|
+
"pre",
|
|
89
|
+
blockAttrs(node.attrs, { "data-type": "code", "data-language": node.attrs.language ?? undefined }),
|
|
90
|
+
["code", 0],
|
|
91
|
+
],
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
/** A bulleted or numbered item; `level` 0–2. Numbering is a decoration (lists.ts). */
|
|
95
|
+
export const ListItem = Node.create({
|
|
96
|
+
name: "listItem",
|
|
97
|
+
group: "block",
|
|
98
|
+
content: "inline*",
|
|
99
|
+
defining: true,
|
|
100
|
+
addAttributes: () => ({ ...blockAttributes, kind: { default: "bullet" }, level: { default: 0 } }),
|
|
101
|
+
parseHTML: () => [{ tag: "div[data-type=list-item]" }],
|
|
102
|
+
renderHTML: ({ node }) => [
|
|
103
|
+
"div",
|
|
104
|
+
blockAttrs(node.attrs, { "data-type": "list-item", "data-kind": node.attrs.kind, "data-level": node.attrs.level }),
|
|
105
|
+
0,
|
|
106
|
+
],
|
|
107
|
+
})
|
|
108
|
+
|
|
109
|
+
/** A checklist item; `level` 0–2. The checkbox is a node view (doc-editor). */
|
|
110
|
+
export const CheckItem = Node.create({
|
|
111
|
+
name: "checkItem",
|
|
112
|
+
group: "block",
|
|
113
|
+
content: "inline*",
|
|
114
|
+
defining: true,
|
|
115
|
+
addAttributes: () => ({ ...blockAttributes, level: { default: 0 }, checked: { default: false } }),
|
|
116
|
+
parseHTML: () => [{ tag: "div[data-type=check-item]" }],
|
|
117
|
+
renderHTML: ({ node }) => [
|
|
118
|
+
"div",
|
|
119
|
+
blockAttrs(node.attrs, {
|
|
120
|
+
"data-type": "check-item",
|
|
121
|
+
"data-level": node.attrs.level,
|
|
122
|
+
"data-checked": node.attrs.checked ? "true" : "false",
|
|
123
|
+
}),
|
|
124
|
+
0,
|
|
125
|
+
],
|
|
126
|
+
})
|
|
127
|
+
|
|
128
|
+
export const Divider = Node.create({
|
|
129
|
+
name: "divider",
|
|
130
|
+
group: "block",
|
|
131
|
+
atom: true,
|
|
132
|
+
selectable: true,
|
|
133
|
+
addAttributes: () => blockAttributes,
|
|
134
|
+
parseHTML: () => [{ tag: "hr" }],
|
|
135
|
+
renderHTML: ({ node }) => ["hr", blockAttrs(node.attrs, { "data-type": "divider" })],
|
|
136
|
+
})
|
|
137
|
+
|
|
138
|
+
/** A block a later milestone edits (callout, table, record, plugin…): kept whole, shown as a placeholder. */
|
|
139
|
+
export const UnknownBlock = Node.create<{ label: (blockType: string) => string }>({
|
|
140
|
+
name: "unknownBlock",
|
|
141
|
+
group: "block",
|
|
142
|
+
atom: true,
|
|
143
|
+
selectable: true,
|
|
144
|
+
draggable: false,
|
|
145
|
+
addOptions: () => ({ label: (blockType: string) => blockType }),
|
|
146
|
+
addAttributes: () => ({ ...blockAttributes, data: { default: null, rendered: false } }),
|
|
147
|
+
parseHTML: () => [{ tag: "div[data-type=unknown-block]" }],
|
|
148
|
+
renderHTML({ node }) {
|
|
149
|
+
const blockType = String(node.attrs.data?.type ?? "")
|
|
150
|
+
return [
|
|
151
|
+
"div",
|
|
152
|
+
blockAttrs(node.attrs, {
|
|
153
|
+
"data-type": "unknown-block",
|
|
154
|
+
"data-block-type": blockType,
|
|
155
|
+
"data-label": this.options.label(blockType),
|
|
156
|
+
}),
|
|
157
|
+
]
|
|
158
|
+
},
|
|
159
|
+
})
|
|
160
|
+
|
|
161
|
+
export const HardBreak = Node.create({
|
|
162
|
+
name: "hardBreak",
|
|
163
|
+
group: "inline",
|
|
164
|
+
inline: true,
|
|
165
|
+
selectable: false,
|
|
166
|
+
parseHTML: () => [{ tag: "br" }],
|
|
167
|
+
renderHTML: () => ["br"],
|
|
168
|
+
addKeyboardShortcuts() {
|
|
169
|
+
return { "Shift-Enter": () => this.editor.commands.insertContent({ type: this.name }) }
|
|
170
|
+
},
|
|
171
|
+
})
|
|
172
|
+
|
|
173
|
+
/** E.26: a merge field, one character for the caret; node-views.tsx draws the chip. */
|
|
174
|
+
export const Field = Node.create({
|
|
175
|
+
name: "field",
|
|
176
|
+
group: "inline",
|
|
177
|
+
inline: true,
|
|
178
|
+
atom: true,
|
|
179
|
+
selectable: true,
|
|
180
|
+
addAttributes: () => ({
|
|
181
|
+
path: { default: "" },
|
|
182
|
+
label: { default: "" },
|
|
183
|
+
required: { default: null },
|
|
184
|
+
perDocument: { default: null },
|
|
185
|
+
}),
|
|
186
|
+
parseHTML: () => [{ tag: "span[data-field]" }],
|
|
187
|
+
renderHTML: ({ node }) => [
|
|
188
|
+
"span",
|
|
189
|
+
{ "data-field": node.attrs.path, title: node.attrs.path, class: "wy-mf" },
|
|
190
|
+
node.attrs.label || node.attrs.path,
|
|
191
|
+
],
|
|
192
|
+
})
|
|
193
|
+
|
|
194
|
+
/** E.42: an inline formula in TeX. KaTeX renders it in M3; until then it shows its source. */
|
|
195
|
+
export const MathInline = Node.create({
|
|
196
|
+
name: "mathInline",
|
|
197
|
+
group: "inline",
|
|
198
|
+
inline: true,
|
|
199
|
+
atom: true,
|
|
200
|
+
selectable: true,
|
|
201
|
+
addAttributes: () => ({ tex: { default: "" } }),
|
|
202
|
+
parseHTML: () => [{ tag: "span[data-math]" }],
|
|
203
|
+
renderHTML: ({ node }) => ["span", { "data-math": "", dir: "ltr", class: "wy-math" }, node.attrs.tex],
|
|
204
|
+
})
|
|
205
|
+
|
|
206
|
+
/* --------------------------------------------------------------- Marks */
|
|
207
|
+
|
|
208
|
+
const simpleMark = (name: string, tag: string, extra: Record<string, string> = {}) =>
|
|
209
|
+
Mark.create({
|
|
210
|
+
name,
|
|
211
|
+
parseHTML: () => [{ tag }],
|
|
212
|
+
renderHTML: () => [tag, extra, 0],
|
|
213
|
+
})
|
|
214
|
+
|
|
215
|
+
/** Bold renders at 600, never 700 (decision 3.6). */
|
|
216
|
+
export const Bold = Mark.create({
|
|
217
|
+
name: "bold",
|
|
218
|
+
parseHTML: () => [{ tag: "strong" }, { tag: "b" }],
|
|
219
|
+
renderHTML: () => ["strong", 0],
|
|
220
|
+
})
|
|
221
|
+
export const Italic = simpleMark("italic", "em")
|
|
222
|
+
export const Underline = simpleMark("underline", "u")
|
|
223
|
+
export const Strike = simpleMark("strike", "s")
|
|
224
|
+
// Code doesn't exclude other marks: the contract allows bold code, and the
|
|
225
|
+
// editor must not drop a mark a document already has.
|
|
226
|
+
export const Code = Mark.create({
|
|
227
|
+
name: "code",
|
|
228
|
+
code: true,
|
|
229
|
+
parseHTML: () => [{ tag: "code" }],
|
|
230
|
+
renderHTML: () => ["code", 0],
|
|
231
|
+
})
|
|
232
|
+
|
|
233
|
+
export const Link = Mark.create({
|
|
234
|
+
name: "link",
|
|
235
|
+
inclusive: false,
|
|
236
|
+
addAttributes: () => ({ href: { default: "" }, recordRef: { default: null, rendered: false } }),
|
|
237
|
+
parseHTML: () => [{ tag: "a[href]", getAttrs: (el) => ({ href: (el as HTMLElement).getAttribute("href") }) }],
|
|
238
|
+
renderHTML: ({ mark }) => ["a", { href: mark.attrs.href, rel: "noopener noreferrer", target: "_blank" }, 0],
|
|
239
|
+
})
|
|
240
|
+
|
|
241
|
+
/** E.25: one highlight colour. */
|
|
242
|
+
export const Highlight = simpleMark("highlight", "mark", { "data-type": "highlight" })
|
|
243
|
+
|
|
244
|
+
/* Marks later milestones give a UI (comments M5, suggestions M5, per-document parts M7). */
|
|
245
|
+
export const CommentMark = Mark.create({
|
|
246
|
+
name: "comment",
|
|
247
|
+
inclusive: false,
|
|
248
|
+
excludes: "",
|
|
249
|
+
addAttributes: () => ({ threadId: { default: "" } }),
|
|
250
|
+
parseHTML: () => [{ tag: "span[data-comment]" }],
|
|
251
|
+
renderHTML: ({ mark }) => ["span", { "data-comment": mark.attrs.threadId }, 0],
|
|
252
|
+
})
|
|
253
|
+
// Neither suggestion mark carries on into what is typed next to it: Suggesting
|
|
254
|
+
// mode marks new text itself, and Editing must not hide typing inside a mark the draft strips.
|
|
255
|
+
export const Insertion = Mark.create({
|
|
256
|
+
name: "insertion",
|
|
257
|
+
inclusive: false,
|
|
258
|
+
excludes: "deletion",
|
|
259
|
+
addAttributes: () => ({ suggestionId: { default: "" } }),
|
|
260
|
+
parseHTML: () => [{ tag: "ins" }],
|
|
261
|
+
renderHTML: ({ mark }) => ["ins", { "data-suggestion": mark.attrs.suggestionId }, 0],
|
|
262
|
+
})
|
|
263
|
+
export const Deletion = Mark.create({
|
|
264
|
+
name: "deletion",
|
|
265
|
+
inclusive: false,
|
|
266
|
+
excludes: "insertion",
|
|
267
|
+
addAttributes: () => ({ suggestionId: { default: "" } }),
|
|
268
|
+
parseHTML: () => [{ tag: "del" }],
|
|
269
|
+
renderHTML: ({ mark }) => ["del", { "data-suggestion": mark.attrs.suggestionId }, 0],
|
|
270
|
+
})
|
|
271
|
+
/**
|
|
272
|
+
* E.23, E.23a: text a document fills itself, in a synced saved block's
|
|
273
|
+
* original. `key` names the part for good: minted when the creator marks it
|
|
274
|
+
* (bubble.tsx), never reused. Adjacent text with different keys is two
|
|
275
|
+
* parts, so the mark doesn't merge across keys.
|
|
276
|
+
*
|
|
277
|
+
* Pasting: in the original (`keep`), a copied part gets a new key (one per
|
|
278
|
+
* key copied), so it is a second part; anywhere else the mark is dropped.
|
|
279
|
+
*/
|
|
280
|
+
export const PerDocument = Mark.create<{ keep: boolean }>({
|
|
281
|
+
name: "perDocument",
|
|
282
|
+
addOptions: () => ({ keep: false }),
|
|
283
|
+
addAttributes: () => ({
|
|
284
|
+
key: {
|
|
285
|
+
default: null,
|
|
286
|
+
parseHTML: (el) => el.getAttribute("data-per-document") || null,
|
|
287
|
+
renderHTML: (attrs) => ({ "data-per-document": (attrs.key as string | null) ?? "" }),
|
|
288
|
+
},
|
|
289
|
+
}),
|
|
290
|
+
parseHTML: () => [{ tag: "span[data-per-document]" }],
|
|
291
|
+
renderHTML: ({ HTMLAttributes }) => ["span", HTMLAttributes, 0],
|
|
292
|
+
addProseMirrorPlugins() {
|
|
293
|
+
const keep = this.options.keep
|
|
294
|
+
return [
|
|
295
|
+
new Plugin({
|
|
296
|
+
key: new PluginKey("perDocumentPaste"),
|
|
297
|
+
props: { transformPasted: (slice) => rekeyPasted(slice, keep) },
|
|
298
|
+
}),
|
|
299
|
+
]
|
|
300
|
+
},
|
|
301
|
+
})
|
|
302
|
+
|
|
303
|
+
export function rekeyPasted(slice: Slice, keep: boolean): Slice {
|
|
304
|
+
const fresh = new Map<string, string>()
|
|
305
|
+
const rekey = (old: unknown) => {
|
|
306
|
+
const name = typeof old === "string" ? old : ""
|
|
307
|
+
if (!fresh.has(name)) fresh.set(name, mintPartKey())
|
|
308
|
+
return fresh.get(name)!
|
|
309
|
+
}
|
|
310
|
+
const walk = (fragment: Fragment): Fragment => {
|
|
311
|
+
const nodes: PmNode[] = []
|
|
312
|
+
fragment.forEach((node) => {
|
|
313
|
+
let next = node
|
|
314
|
+
if (node.content.size) next = next.copy(walk(node.content))
|
|
315
|
+
const marks = node.marks.flatMap((m) => (m.type.name !== "perDocument" ? [m] : keep ? [m.type.create({ key: rekey(m.attrs.key) })] : []))
|
|
316
|
+
if (marks.length !== node.marks.length || node.marks.some((m, i) => m !== marks[i])) next = next.mark(marks)
|
|
317
|
+
if (node.type.name === "field" && node.attrs.perDocument != null) {
|
|
318
|
+
next = next.type.create({ ...next.attrs, perDocument: keep ? rekey(node.attrs.perDocument) : null }, next.content, next.marks)
|
|
319
|
+
}
|
|
320
|
+
nodes.push(next)
|
|
321
|
+
})
|
|
322
|
+
return Fragment.fromArray(nodes)
|
|
323
|
+
}
|
|
324
|
+
return new Slice(walk(slice.content), slice.openStart, slice.openEnd)
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
/** In schema order; the contract's marks come out of the editor in this order. */
|
|
328
|
+
export const MARK_ORDER = [
|
|
329
|
+
"link",
|
|
330
|
+
"bold",
|
|
331
|
+
"italic",
|
|
332
|
+
"underline",
|
|
333
|
+
"strike",
|
|
334
|
+
"code",
|
|
335
|
+
"highlight",
|
|
336
|
+
"comment",
|
|
337
|
+
"insertion",
|
|
338
|
+
"deletion",
|
|
339
|
+
"perDocument",
|
|
340
|
+
] as const
|
|
341
|
+
|
|
342
|
+
export const schemaExtensions = [
|
|
343
|
+
DocumentNode,
|
|
344
|
+
TextNode,
|
|
345
|
+
Paragraph,
|
|
346
|
+
Heading,
|
|
347
|
+
Quote,
|
|
348
|
+
CodeBlock,
|
|
349
|
+
ListItem,
|
|
350
|
+
CheckItem,
|
|
351
|
+
Divider,
|
|
352
|
+
UnknownBlock,
|
|
353
|
+
...richSchemaExtensions,
|
|
354
|
+
HardBreak,
|
|
355
|
+
Field,
|
|
356
|
+
MathInline,
|
|
357
|
+
Link,
|
|
358
|
+
Bold,
|
|
359
|
+
Italic,
|
|
360
|
+
Underline,
|
|
361
|
+
Strike,
|
|
362
|
+
Code,
|
|
363
|
+
Highlight,
|
|
364
|
+
CommentMark,
|
|
365
|
+
Insertion,
|
|
366
|
+
Deletion,
|
|
367
|
+
PerDocument,
|
|
368
|
+
]
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
"use client"
|
|
2
|
+
|
|
3
|
+
import * as React from "react"
|
|
4
|
+
|
|
5
|
+
import type { Inline, RecordRef, SavedBlock } from "./contract"
|
|
6
|
+
import { EDITOR_LABELS, type EditorLabels } from "./labels"
|
|
7
|
+
|
|
8
|
+
/** What a Record block shows (E.16): the record as the reader may see it. */
|
|
9
|
+
export interface RecordView {
|
|
10
|
+
/** The record type's name, e.g. "Invoice". */
|
|
11
|
+
typeLabel: string
|
|
12
|
+
/** "INV-1042 · Example Clinic" */
|
|
13
|
+
title: string
|
|
14
|
+
subtitle?: string
|
|
15
|
+
/** A formatted amount, e.g. "$301.60". */
|
|
16
|
+
amount?: string
|
|
17
|
+
status?: { label: string; tone: "success" | "warning" | "destructive" | "info" | "secondary" }
|
|
18
|
+
/** Where the record opens. */
|
|
19
|
+
href?: string
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** What a Chart block draws: one series of labelled values. */
|
|
23
|
+
export interface ChartData {
|
|
24
|
+
points: { label: string; value: number }[]
|
|
25
|
+
/** What the values are, for the table view and screen readers. */
|
|
26
|
+
valueLabel?: string
|
|
27
|
+
/** What the series covers, e.g. "Last 6 months". */
|
|
28
|
+
subtitle?: string
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export interface UploadedFile {
|
|
32
|
+
fileId: string
|
|
33
|
+
/** Where the file is served, for images. */
|
|
34
|
+
url: string
|
|
35
|
+
name: string
|
|
36
|
+
size: number
|
|
37
|
+
mime: string
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* How rich blocks reach live data and storage. The editor never fetches on its
|
|
42
|
+
* own: the screen passes these in, and every call is answered within the
|
|
43
|
+
* reader's permissions (E.16, E.31). `null` from a resolver means the reader
|
|
44
|
+
* may not see it.
|
|
45
|
+
*/
|
|
46
|
+
export interface EditorServices {
|
|
47
|
+
resolveRecord?: (ref: RecordRef) => Promise<RecordView | null>
|
|
48
|
+
loadChart?: (source: { query: string; params?: Record<string, string> }) => Promise<ChartData | null>
|
|
49
|
+
uploadFile?: (file: File) => Promise<UploadedFile>
|
|
50
|
+
/** The download address of a stored file. */
|
|
51
|
+
fileUrl?: (fileId: string) => string
|
|
52
|
+
/** What a Chart block can read from, for its source menu. */
|
|
53
|
+
chartSources?: { key: string; label: string }[]
|
|
54
|
+
/** What a Record block can point at, for its record picker. */
|
|
55
|
+
recordTypes?: { key: string; label: string }[]
|
|
56
|
+
/**
|
|
57
|
+
* Saved blocks (E.21–E.24): this person's own and the workspace library's.
|
|
58
|
+
* Synced ones are drawn from here wherever a document uses them.
|
|
59
|
+
*/
|
|
60
|
+
savedBlocks?: SavedBlock[]
|
|
61
|
+
/** Saves a selection as a block; without it the editor offers no Save as block. */
|
|
62
|
+
saveBlock?: (block: NewSavedBlock) => Promise<SavedBlock>
|
|
63
|
+
/** E.22: whether "Everyone in the workspace" is offered (people who manage the library). */
|
|
64
|
+
canShareSavedBlocks?: boolean
|
|
65
|
+
/** E.17–E.20: the blocks the workspace's plugins add. */
|
|
66
|
+
pluginBlocks?: PluginBlocks
|
|
67
|
+
/**
|
|
68
|
+
* Draws a plugin block's view (display blocks with its data already filled
|
|
69
|
+
* in) with Whity's own components. The editor never runs plugin code.
|
|
70
|
+
*/
|
|
71
|
+
renderPluginView?: (view: unknown[]) => React.ReactNode
|
|
72
|
+
/** Switches a workspace plugin on, from the plugin-off placeholder (E.19). */
|
|
73
|
+
enablePlugin?: (plugin: string) => Promise<void>
|
|
74
|
+
/** The reader's language, for plugins' labels. */
|
|
75
|
+
language?: "en" | "ar"
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/** Text in English and Arabic, as plugins declare it. */
|
|
79
|
+
export type Localized = { en: string; ar: string }
|
|
80
|
+
|
|
81
|
+
/** One field of a plugin block's Edit form (SDK 1.103). */
|
|
82
|
+
export interface PluginBlockField {
|
|
83
|
+
key: string
|
|
84
|
+
label: Localized
|
|
85
|
+
type: "text" | "longText" | "number" | "date" | "select"
|
|
86
|
+
required?: boolean
|
|
87
|
+
options?: { value: string; label: Localized }[]
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* A block a plugin adds (E.17–E.20): a declaration Whity draws. `view` and
|
|
92
|
+
* `print` are display blocks of the screen vocabulary, naming fields as
|
|
93
|
+
* `{{data.key}}`; without `print`, notes and wiki pages only (E.18).
|
|
94
|
+
*/
|
|
95
|
+
export interface PluginBlockDefinition {
|
|
96
|
+
name: string
|
|
97
|
+
blockType: string
|
|
98
|
+
label: Localized
|
|
99
|
+
description?: Localized | null
|
|
100
|
+
icon: string
|
|
101
|
+
keywords: string[]
|
|
102
|
+
fields: PluginBlockField[]
|
|
103
|
+
view: unknown[]
|
|
104
|
+
print: unknown[] | null
|
|
105
|
+
allowedIn: string[]
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface PluginBlockSource {
|
|
109
|
+
plugin: string
|
|
110
|
+
label: Localized
|
|
111
|
+
/** Whity's mark, from Whity's marks only (VERIFIED-PLUGINS-SECURITY.md). */
|
|
112
|
+
verified: boolean
|
|
113
|
+
firstParty: boolean
|
|
114
|
+
blocks: PluginBlockDefinition[]
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** The workspace's plugin blocks, and its plugins that are installed but off (E.19). */
|
|
118
|
+
export interface PluginBlocks {
|
|
119
|
+
plugins: PluginBlockSource[]
|
|
120
|
+
off: { plugin: string; label: Localized }[]
|
|
121
|
+
/** Whether the person may switch a plugin on from the placeholder. */
|
|
122
|
+
canEnable: boolean
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** What Save as block sends: the contract's SavedBlock without what the library assigns. */
|
|
126
|
+
export type NewSavedBlock = Pick<SavedBlock, "name" | "mode" | "sharing" | "blocks" | "perDocumentParts">
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Preview with a record (E.12): each field's value for that record, by path.
|
|
130
|
+
* `null` is a missing value, flagged on the error tint (E.27).
|
|
131
|
+
*/
|
|
132
|
+
export interface FieldPreview {
|
|
133
|
+
/** "INV-1042 · Example Clinic" */
|
|
134
|
+
label: string
|
|
135
|
+
values: Record<string, string | null>
|
|
136
|
+
/**
|
|
137
|
+
* The values are the fields' examples, not a record's: a template with no
|
|
138
|
+
* record type previews with them instead of flagging every field missing.
|
|
139
|
+
* There is no record to change.
|
|
140
|
+
*/
|
|
141
|
+
examples?: boolean
|
|
142
|
+
/** No record behind the values (examples, or values typed to issue): nothing to change. */
|
|
143
|
+
noRecord?: boolean
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
interface ServicesValue {
|
|
147
|
+
services: EditorServices
|
|
148
|
+
labels: EditorLabels
|
|
149
|
+
/** Set while previewing with a record; fields then show values, not chips. */
|
|
150
|
+
preview?: FieldPreview | null
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
const ServicesContext = React.createContext<ServicesValue>({ services: {}, labels: EDITOR_LABELS })
|
|
154
|
+
|
|
155
|
+
export function EditorServicesProvider({ services, labels, preview = null, children }: ServicesValue & { children: React.ReactNode }) {
|
|
156
|
+
const value = React.useMemo(() => ({ services, labels, preview }), [services, labels, preview])
|
|
157
|
+
return <ServicesContext.Provider value={value}>{children}</ServicesContext.Provider>
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
export function useEditorServices(): ServicesValue {
|
|
161
|
+
return React.useContext(ServicesContext)
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/** Inline content as plain text; a merge field shows as {{its label}}. */
|
|
165
|
+
export function inlineText(content: Inline[] | null | undefined): string {
|
|
166
|
+
return (content ?? [])
|
|
167
|
+
.map((run) => (run.type === "text" ? run.text : run.type === "break" ? "\n" : run.type === "math" ? run.tex : `{{${run.label || run.path}}}`))
|
|
168
|
+
.join("")
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
/** Plain text back to inline content, keeping `{{label}}` fields that were there before. */
|
|
172
|
+
export function textToInline(text: string, previous: Inline[] | null | undefined): Inline[] {
|
|
173
|
+
const fields = new Map((previous ?? []).filter((r) => r.type === "field").map((r) => [`{{${(r as { label: string; path: string }).label || (r as { path: string }).path}}}`, r]))
|
|
174
|
+
// Scans for the known tokens rather than a {{…}} regex: only fields that were
|
|
175
|
+
// there before come back, and a run of "{" stays linear (CodeQL js/polynomial-redos).
|
|
176
|
+
const out: Inline[] = []
|
|
177
|
+
let from = 0
|
|
178
|
+
let i = text.indexOf("{{")
|
|
179
|
+
while (i !== -1) {
|
|
180
|
+
let token: string | undefined
|
|
181
|
+
for (const key of fields.keys()) {
|
|
182
|
+
if (text.startsWith(key, i)) {
|
|
183
|
+
token = key
|
|
184
|
+
break
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
if (token) {
|
|
188
|
+
if (i > from) out.push({ type: "text", text: text.slice(from, i) })
|
|
189
|
+
out.push(fields.get(token)!)
|
|
190
|
+
from = i + token.length
|
|
191
|
+
i = text.indexOf("{{", from)
|
|
192
|
+
} else {
|
|
193
|
+
i = text.indexOf("{{", i + 1)
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (from < text.length) out.push({ type: "text", text: text.slice(from) })
|
|
197
|
+
return out
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
/** "482 KB", "1.2 MB" — Western digits (3.7b). */
|
|
201
|
+
export function formatSize(bytes: number): string {
|
|
202
|
+
if (bytes < 1024) return `${bytes} B`
|
|
203
|
+
if (bytes < 1024 * 1024) return `${Math.round(bytes / 1024)} KB`
|
|
204
|
+
return `${(bytes / (1024 * 1024)).toFixed(1)} MB`
|
|
205
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { Extension, type Range } from "@tiptap/core"
|
|
2
|
+
import { PluginKey } from "@tiptap/pm/state"
|
|
3
|
+
import Suggestion, { exitSuggestion, type SuggestionKeyDownProps } from "@tiptap/suggestion"
|
|
4
|
+
|
|
5
|
+
/** What the / menu shows; the React side (slash-menu.tsx) renders it. */
|
|
6
|
+
export interface SlashState {
|
|
7
|
+
open: boolean
|
|
8
|
+
query: string
|
|
9
|
+
range: Range | null
|
|
10
|
+
rect: DOMRect | null
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export interface SlashOptions {
|
|
14
|
+
onState: (state: SlashState) => void
|
|
15
|
+
/** Returns true when the menu handled the key (arrows, Enter, Esc). */
|
|
16
|
+
onKeyDown: (event: KeyboardEvent) => boolean
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export const slashKey = new PluginKey("slash")
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Typing / at the start of a line, or after a space, opens every block
|
|
23
|
+
* (EditorInsert). Esc closes it and keeps what was typed.
|
|
24
|
+
*/
|
|
25
|
+
export const SlashCommand = Extension.create<SlashOptions>({
|
|
26
|
+
name: "slashCommand",
|
|
27
|
+
addOptions: () => ({ onState: () => {}, onKeyDown: () => false }),
|
|
28
|
+
addProseMirrorPlugins() {
|
|
29
|
+
const { onState, onKeyDown } = this.options
|
|
30
|
+
const publish = (open: boolean, props?: { query: string; range: Range; clientRect?: (() => DOMRect | null) | null }) =>
|
|
31
|
+
onState({
|
|
32
|
+
open,
|
|
33
|
+
query: props?.query ?? "",
|
|
34
|
+
range: props?.range ?? null,
|
|
35
|
+
rect: props?.clientRect?.() ?? null,
|
|
36
|
+
})
|
|
37
|
+
return [
|
|
38
|
+
Suggestion({
|
|
39
|
+
editor: this.editor,
|
|
40
|
+
pluginKey: slashKey,
|
|
41
|
+
char: "/",
|
|
42
|
+
allowSpaces: false,
|
|
43
|
+
startOfLine: false,
|
|
44
|
+
allowedPrefixes: [" "],
|
|
45
|
+
// Not inside code, where / is just a character.
|
|
46
|
+
allow: ({ state, range }) => state.doc.resolve(range.from).parent.type.name !== "codeBlock",
|
|
47
|
+
items: () => [],
|
|
48
|
+
render: () => ({
|
|
49
|
+
onStart: (props) => publish(true, props),
|
|
50
|
+
onUpdate: (props) => publish(true, props),
|
|
51
|
+
onExit: () => publish(false),
|
|
52
|
+
onKeyDown: ({ event }: SuggestionKeyDownProps) => {
|
|
53
|
+
if (event.key === "Escape") {
|
|
54
|
+
exitSuggestion(this.editor.view, slashKey)
|
|
55
|
+
publish(false)
|
|
56
|
+
return true
|
|
57
|
+
}
|
|
58
|
+
return onKeyDown(event)
|
|
59
|
+
},
|
|
60
|
+
}),
|
|
61
|
+
}),
|
|
62
|
+
]
|
|
63
|
+
},
|
|
64
|
+
})
|