@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.
- package/README.md +107 -107
- package/package.json +223 -192
- package/src/access-denied.stories.tsx +179 -179
- package/src/access-denied.tsx +305 -305
- package/src/action-proposal.tsx +338 -302
- package/src/actor-chip.tsx +71 -71
- package/src/agent-activity.tsx +163 -163
- package/src/agent-collaboration.stories.tsx +156 -156
- package/src/agent-run-status.tsx +196 -196
- package/src/alert-dialog.stories.tsx +45 -45
- package/src/alert-dialog.tsx +147 -147
- package/src/alert.stories.tsx +91 -91
- package/src/alert.tsx +89 -89
- package/src/app-sidebar.stories.tsx +195 -195
- package/src/app-sidebar.tsx +604 -500
- package/src/approval-queue.tsx +109 -108
- package/src/audience-group-picker.stories.tsx +198 -198
- package/src/audience-group-picker.tsx +362 -362
- package/src/audience-people-picker.stories.tsx +102 -102
- package/src/audience-people-picker.tsx +279 -279
- package/src/avatar-pattern.ts +138 -0
- package/src/avatar.tsx +125 -83
- package/src/badge.stories.tsx +105 -105
- package/src/badge.tsx +68 -68
- package/src/beta-warning.stories.tsx +79 -79
- package/src/beta-warning.tsx +189 -189
- package/src/bilingual-input.stories.tsx +82 -82
- package/src/bilingual-input.tsx +188 -183
- package/src/board.tsx +216 -0
- package/src/breadcrumb.stories.tsx +51 -51
- package/src/breadcrumb.tsx +90 -90
- package/src/built-on-whity.tsx +52 -0
- package/src/button.stories.tsx +87 -87
- package/src/button.tsx +125 -118
- package/src/card.stories.tsx +423 -423
- package/src/card.tsx +180 -180
- package/src/chart.stories.tsx +66 -66
- package/src/chart.tsx +228 -228
- package/src/checkbox.stories.tsx +62 -62
- package/src/checkbox.tsx +54 -54
- package/src/collapsible.stories.tsx +48 -48
- package/src/collapsible.tsx +34 -34
- package/src/color-card.stories.tsx +61 -61
- package/src/color-card.tsx +270 -270
- package/src/color-picker.stories.tsx +65 -65
- package/src/color-picker.tsx +425 -425
- package/src/column-matcher.tsx +84 -0
- package/src/command-palette.tsx +399 -306
- package/src/confirm-action.tsx +98 -0
- package/src/copy-block.stories.tsx +38 -38
- package/src/copy-block.tsx +85 -85
- package/src/data-table.stories.tsx +200 -200
- package/src/data-table.tsx +1687 -1106
- package/src/date-picker.stories.tsx +61 -61
- package/src/date-picker.tsx +457 -422
- package/src/design-cards.stories.tsx +551 -458
- package/src/dialog.stories.tsx +48 -48
- package/src/dialog.tsx +179 -166
- package/src/display-preferences.tsx +59 -0
- package/src/documents/barcode-svg.stories.tsx +72 -72
- package/src/documents/barcode-svg.tsx +79 -79
- package/src/dropdown-menu.stories.tsx +77 -77
- package/src/dropdown-menu.tsx +271 -271
- 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 -279
- package/src/editor/block-ids.ts +44 -44
- package/src/editor/block-list.tsx +104 -101
- package/src/editor/block-toolbar.tsx +490 -477
- package/src/editor/bubble.tsx +119 -93
- package/src/editor/catalogue.ts +169 -103
- package/src/editor/collab-rail.tsx +746 -746
- package/src/editor/collab.stories.tsx +207 -207
- package/src/editor/collab.ts +87 -87
- package/src/editor/contract.ts +476 -408
- package/src/editor/convert.ts +414 -362
- package/src/editor/doc-editor.stories.tsx +98 -98
- package/src/editor/doc-editor.tsx +1492 -1287
- package/src/editor/editor.css +636 -536
- package/src/editor/extensions.ts +86 -86
- package/src/editor/field-bar.tsx +154 -0
- package/src/editor/field-picker.tsx +109 -107
- package/src/editor/fields.ts +100 -100
- package/src/editor/gutter.tsx +443 -367
- package/src/editor/index.ts +23 -22
- package/src/editor/label-sheet.tsx +289 -289
- package/src/editor/labels.ts +394 -310
- package/src/editor/link-tools.tsx +141 -141
- package/src/editor/node-views.tsx +461 -450
- package/src/editor/page-view.tsx +372 -353
- 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 -182
- package/src/editor/rich-blocks.stories.tsx +146 -146
- package/src/editor/sample.ts +40 -40
- 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 -150
- package/src/editor/schema.ts +368 -315
- package/src/editor/services.tsx +205 -127
- package/src/editor/slash.ts +64 -64
- package/src/editor/suggesting.ts +372 -372
- package/src/editor/suggestions.ts +763 -763
- package/src/editor/table-keys.ts +66 -66
- package/src/editor/templates.stories.tsx +324 -324
- package/src/editor/toolbar.tsx +364 -358
- package/src/empty-state.stories.tsx +51 -51
- package/src/empty-state.tsx +126 -100
- package/src/empty-state.usage-notes.md +30 -30
- package/src/form.stories.tsx +112 -112
- package/src/form.tsx +176 -176
- package/src/globals.css +20 -20
- package/src/icon-button.tsx +85 -85
- package/src/icon-map.ts +335 -244
- package/src/icon.tsx +41 -41
- package/src/index.ts +92 -67
- package/src/input.stories.tsx +157 -157
- package/src/input.tsx +768 -759
- package/src/kpi-strip.tsx +47 -0
- package/src/localized-text.ts +76 -0
- package/src/locked-screen.stories.tsx +29 -29
- package/src/locked-screen.tsx +75 -61
- package/src/lockup.tsx +42 -0
- package/src/lottie.tsx +441 -0
- package/src/mark.tsx +62 -62
- package/src/math-text.stories.tsx +33 -33
- package/src/math-text.tsx +43 -43
- package/src/menu-bar.stories.tsx +198 -198
- package/src/menu-bar.tsx +373 -373
- package/src/message-thread.tsx +181 -0
- package/src/money/currency.ts +244 -230
- 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 -95
- package/src/page-header.tsx +122 -122
- package/src/page-shell.stories.tsx +42 -42
- package/src/page-shell.tsx +32 -32
- package/src/page-states.tsx +277 -0
- package/src/pagination.stories.tsx +45 -45
- package/src/pagination.tsx +98 -98
- package/src/paper-sheet.stories.tsx +88 -0
- package/src/paper-sheet.tsx +85 -0
- package/src/phone-input.tsx +252 -0
- package/src/phone-tab-bar.tsx +152 -0
- package/src/plugin-card.stories.tsx +208 -180
- package/src/plugin-card.tsx +931 -848
- package/src/popover.stories.tsx +48 -48
- package/src/popover.tsx +55 -55
- package/src/radio-group.stories.tsx +26 -26
- package/src/radio-group.tsx +44 -44
- package/src/role-summary.stories.tsx +143 -0
- package/src/role-summary.tsx +120 -0
- package/src/route-flow/editor.tsx +1087 -1014
- package/src/route-flow/model.ts +771 -716
- package/src/save-bar.tsx +94 -0
- package/src/scope-grant.tsx +139 -139
- package/src/screen-too-small.stories.tsx +61 -61
- package/src/screen-too-small.tsx +104 -104
- package/src/search-field.tsx +65 -0
- package/src/select.stories.tsx +44 -44
- package/src/select.tsx +197 -197
- package/src/separator.stories.tsx +34 -34
- package/src/separator.tsx +34 -34
- package/src/sheet.stories.tsx +49 -49
- package/src/sheet.tsx +168 -168
- package/src/skeleton.stories.tsx +28 -28
- package/src/skeleton.tsx +19 -19
- package/src/slider.stories.tsx +78 -78
- package/src/slider.tsx +300 -300
- package/src/spinner.stories.tsx +33 -33
- package/src/spinner.tsx +55 -55
- package/src/stepper.tsx +85 -0
- package/src/switch.stories.tsx +42 -42
- package/src/switch.tsx +41 -41
- package/src/switcher.stories.tsx +111 -111
- package/src/switcher.tsx +131 -131
- package/src/system-state.tsx +55 -0
- package/src/table.stories.tsx +48 -48
- package/src/table.tsx +121 -121
- package/src/tabs.stories.tsx +74 -74
- package/src/tabs.tsx +90 -90
- package/src/tag-input.stories.tsx +67 -67
- package/src/tag-input.tsx +117 -117
- package/src/tenant-logo.tsx +63 -63
- package/src/tenant-switcher.stories.tsx +38 -38
- package/src/tenant-switcher.tsx +185 -164
- package/src/textarea.stories.tsx +27 -27
- package/src/textarea.tsx +18 -18
- package/src/theme-mode.ts +74 -52
- package/src/time-grid.tsx +163 -0
- package/src/time-picker.stories.tsx +62 -62
- package/src/time-picker.tsx +616 -615
- package/src/toggle-group.tsx +139 -138
- package/src/tooltip.stories.tsx +43 -43
- package/src/tooltip.tsx +73 -73
- package/src/top-nav.stories.tsx +58 -58
- package/src/top-nav.tsx +324 -324
- package/src/undo-bar.tsx +107 -107
- package/src/utils.ts +45 -45
- package/src/view-toggle.stories.tsx +84 -84
- package/src/view-toggle.tsx +111 -110
|
@@ -1,207 +1,207 @@
|
|
|
1
|
-
import type { Meta, StoryObj } from "@storybook/react-vite"
|
|
2
|
-
import * as React from "react"
|
|
3
|
-
|
|
4
|
-
import type { EditorCollab, RailSuggestion, RailThread } from "./collab"
|
|
5
|
-
import { CollabDrawer, CollabRail, type RailActions, type RailItem } from "./collab-rail"
|
|
6
|
-
import type { Actor, EditorMode, WhityDocument } from "./contract"
|
|
7
|
-
import { DocEditor } from "./doc-editor"
|
|
8
|
-
import { EDITOR_LABELS } from "./labels"
|
|
9
|
-
import { SAMPLE_DOCUMENT } from "./sample"
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Editor M5, the EditorCollab card: the rail with comments and suggestions,
|
|
13
|
-
* Suggesting mode, resolved threads and the drawer under 1024px. Example data
|
|
14
|
-
* follows the card (Rana Haddad, Omar Khalil, the Billing assistant).
|
|
15
|
-
*/
|
|
16
|
-
const meta = {
|
|
17
|
-
title: "Editor/Comments and suggestions",
|
|
18
|
-
parameters: { layout: "fullscreen", fullBleed: true },
|
|
19
|
-
} satisfies Meta
|
|
20
|
-
|
|
21
|
-
export default meta
|
|
22
|
-
type Story = StoryObj<typeof meta>
|
|
23
|
-
|
|
24
|
-
const t = (text: string) => ({ type: "text" as const, text })
|
|
25
|
-
const RANA: Actor & { kind: "person" } = { kind: "person", id: "11", name: "Rana Haddad" }
|
|
26
|
-
const OMAR: Actor = { kind: "person", id: "12", name: "Omar Khalil" }
|
|
27
|
-
const AGENT: Actor = { kind: "agent", id: "billing-assistant", name: "Billing assistant", onBehalfOf: { id: "11", name: "Rana" }, scope: ["documents:suggest"] }
|
|
28
|
-
|
|
29
|
-
const LETTER: WhityDocument = {
|
|
30
|
-
...SAMPLE_DOCUMENT,
|
|
31
|
-
kind: "letter",
|
|
32
|
-
title: "Payment reminder",
|
|
33
|
-
blocks: [
|
|
34
|
-
{ id: "p1", type: "paragraph", content: [t("Invoice INV-1042 was due on 14 October. Please pay within 30 days of this letter.")] },
|
|
35
|
-
{ id: "p2", type: "paragraph", content: [t("Payments usually take two working days to reach us.")] },
|
|
36
|
-
{ id: "p3", type: "paragraph", content: [t("If you have already paid, thank you, and please ignore this letter.")] },
|
|
37
|
-
],
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
const SUGGESTIONS: RailSuggestion[] = [
|
|
41
|
-
{
|
|
42
|
-
id: "41",
|
|
43
|
-
by: RANA,
|
|
44
|
-
at: "2026-10-29T13:52:00",
|
|
45
|
-
kind: "text",
|
|
46
|
-
summary: "Replace “30 days” with “14 days”",
|
|
47
|
-
status: "open",
|
|
48
|
-
patch: { op: "replace-text", blockId: "p1", deleteText: "30 days", insert: [t("14 days")], occurrence: 0 },
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
id: "42",
|
|
52
|
-
by: RANA,
|
|
53
|
-
at: "2026-10-29T13:53:00",
|
|
54
|
-
kind: "text",
|
|
55
|
-
summary: "Add “, or call us on 06 555 0100”",
|
|
56
|
-
status: "open",
|
|
57
|
-
patch: { op: "replace-text", blockId: "p1", deleteText: "", insert: [t(", or call us on 06 555 0100")], before: "of this letter", occurrence: 0 },
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
id: "43",
|
|
61
|
-
by: AGENT,
|
|
62
|
-
at: "2026-10-29T13:55:00",
|
|
63
|
-
kind: "text",
|
|
64
|
-
summary: "Delete “usually ”",
|
|
65
|
-
status: "open",
|
|
66
|
-
request: "Make the payment paragraph firmer",
|
|
67
|
-
permission: "documents:suggest",
|
|
68
|
-
patch: { op: "replace-text", blockId: "p2", deleteText: "usually ", insert: [], occurrence: 0 },
|
|
69
|
-
},
|
|
70
|
-
]
|
|
71
|
-
|
|
72
|
-
const THREADS: RailThread[] = [
|
|
73
|
-
{
|
|
74
|
-
id: "7",
|
|
75
|
-
anchorBlockId: "p1",
|
|
76
|
-
quote: "Please pay within",
|
|
77
|
-
messages: [
|
|
78
|
-
{ id: "71", by: OMAR, at: "2026-10-29T13:40:00", body: [t("Should we mention the 2% late fee here?")], mentions: [] },
|
|
79
|
-
{ id: "72", by: RANA, at: "2026-10-29T13:44:00", body: [t("Yes, after the due date sentence.")], mentions: [] },
|
|
80
|
-
],
|
|
81
|
-
},
|
|
82
|
-
{
|
|
83
|
-
id: "5",
|
|
84
|
-
anchorBlockId: "p3",
|
|
85
|
-
quote: "already paid",
|
|
86
|
-
messages: [{ id: "51", by: OMAR, at: "2026-10-29T12:05:00", body: [t("Use the customer’s legal name")], mentions: [] }],
|
|
87
|
-
resolved: { by: RANA, at: "2026-10-29T12:10:00" },
|
|
88
|
-
},
|
|
89
|
-
]
|
|
90
|
-
|
|
91
|
-
const PEOPLE = [
|
|
92
|
-
{ id: "12", name: "Omar Khalil", detail: "Accounts" },
|
|
93
|
-
{ id: "13", name: "Lina Saad", detail: "HR" },
|
|
94
|
-
]
|
|
95
|
-
|
|
96
|
-
/** An in-memory server: suggestions get ids, decisions drop them, threads resolve and reopen. */
|
|
97
|
-
function useFakeCollab(canComment = true): EditorCollab {
|
|
98
|
-
const [suggestions, setSuggestions] = React.useState(SUGGESTIONS)
|
|
99
|
-
const [threads, setThreads] = React.useState(THREADS)
|
|
100
|
-
const next = React.useRef(100)
|
|
101
|
-
const now = () => new Date().toISOString()
|
|
102
|
-
return {
|
|
103
|
-
suggestions,
|
|
104
|
-
threads,
|
|
105
|
-
canSuggest: true,
|
|
106
|
-
canComment,
|
|
107
|
-
me: RANA,
|
|
108
|
-
onSuggest: async (change) => {
|
|
109
|
-
const saved: RailSuggestion = { id: String(next.current++), by: RANA, at: now(), status: "open", ...change }
|
|
110
|
-
setSuggestions((s) => [...s, saved])
|
|
111
|
-
return saved
|
|
112
|
-
},
|
|
113
|
-
onDecide: async (id) => setSuggestions((s) => s.filter((x) => x.id !== id)),
|
|
114
|
-
onDecideAll: async (_d, filter) => setSuggestions((s) => (filter?.agent ? s.filter((x) => x.by.kind !== "agent" || x.by.id !== filter.agent) : [])),
|
|
115
|
-
onComment: async (c) => {
|
|
116
|
-
const thread: RailThread = {
|
|
117
|
-
id: String(next.current++),
|
|
118
|
-
anchorBlockId: c.anchorBlockId,
|
|
119
|
-
quote: c.quote,
|
|
120
|
-
messages: [{ id: String(next.current++), by: RANA, at: now(), body: c.body, mentions: [] }],
|
|
121
|
-
}
|
|
122
|
-
setThreads((ts) => [...ts, thread])
|
|
123
|
-
return thread
|
|
124
|
-
},
|
|
125
|
-
onReply: async (threadId, body) =>
|
|
126
|
-
setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, messages: [...x.messages, { id: String(next.current++), by: RANA, at: now(), body, mentions: [] }] } : x))),
|
|
127
|
-
onResolve: async (threadId) => setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, resolved: { by: RANA, at: now() } } : x))),
|
|
128
|
-
onReopen: async (threadId) => setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, resolved: undefined } : x))),
|
|
129
|
-
searchPeople: async (q) => PEOPLE.filter((p) => p.name.toLowerCase().includes(q.toLowerCase())),
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
function Live({ canEdit = true, startMode }: { canEdit?: boolean; startMode?: EditorMode }) {
|
|
134
|
-
const [doc, setDoc] = React.useState(LETTER)
|
|
135
|
-
const [mode, setMode] = React.useState<EditorMode | undefined>(startMode)
|
|
136
|
-
const collab = useFakeCollab()
|
|
137
|
-
return (
|
|
138
|
-
<div style={{ height: "100vh" }}>
|
|
139
|
-
<DocEditor
|
|
140
|
-
document={doc}
|
|
141
|
-
onChange={setDoc}
|
|
142
|
-
canEdit={canEdit}
|
|
143
|
-
mode={mode}
|
|
144
|
-
onModeChange={setMode}
|
|
145
|
-
back={{ label: "Back to templates", onClick: () => {} }}
|
|
146
|
-
path="Templates · Letters"
|
|
147
|
-
save={{ state: "saved", at: "14:02" }}
|
|
148
|
-
collab={collab}
|
|
149
|
-
/>
|
|
150
|
-
</div>
|
|
151
|
-
)
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
/** The rail beside the sheet: a thread, Rana's two suggestions and the agent's, dashed. */
|
|
155
|
-
export const RailWithCommentsAndSuggestions: Story = { render: () => <Live /> }
|
|
156
|
-
|
|
157
|
-
/** Suggesting mode: the mode button on the tint; typing adds, deleting strikes through. */
|
|
158
|
-
export const SuggestingMode: Story = { render: () => <Live startMode="suggesting" /> }
|
|
159
|
-
|
|
160
|
-
/** Someone without edit permission: Suggesting, with Editing locked in the mode menu (E.10). */
|
|
161
|
-
export const WithoutEditPermission: Story = { render: () => <Live canEdit={false} /> }
|
|
162
|
-
|
|
163
|
-
const ACTIONS: RailActions = {
|
|
164
|
-
canEdit: true,
|
|
165
|
-
canComment: true,
|
|
166
|
-
onDecide: () => {},
|
|
167
|
-
onDecideAll: () => {},
|
|
168
|
-
onReply: async () => {},
|
|
169
|
-
onResolve: () => {},
|
|
170
|
-
onReopen: () => {},
|
|
171
|
-
searchPeople: async (q) => PEOPLE.filter((p) => p.name.toLowerCase().includes(q.toLowerCase())),
|
|
172
|
-
}
|
|
173
|
-
const ITEMS: RailItem[] = [
|
|
174
|
-
{ kind: "thread", id: "7", thread: THREADS[0] },
|
|
175
|
-
...SUGGESTIONS.map((s) => ({ kind: "suggestion" as const, id: s.id, suggestion: s })),
|
|
176
|
-
]
|
|
177
|
-
const RESOLVED: RailItem[] = [{ kind: "thread", id: "5", thread: THREADS[1] }]
|
|
178
|
-
|
|
179
|
-
/** The rail on its own, with "1 resolved" open: the resolved card and Reopen. */
|
|
180
|
-
export const ResolvedThreads: Story = {
|
|
181
|
-
render: () => (
|
|
182
|
-
<div style={{ width: 300, minHeight: 900, marginInlineStart: 24 }}>
|
|
183
|
-
<CollabRail
|
|
184
|
-
items={ITEMS}
|
|
185
|
-
resolved={RESOLVED}
|
|
186
|
-
labels={EDITOR_LABELS}
|
|
187
|
-
actions={ACTIONS}
|
|
188
|
-
active="7"
|
|
189
|
-
onActive={() => {}}
|
|
190
|
-
anchorTop={() => null}
|
|
191
|
-
layoutKey={0}
|
|
192
|
-
defaultShowResolved
|
|
193
|
-
/>
|
|
194
|
-
</div>
|
|
195
|
-
),
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
/** Under 1024px: the same cards in a drawer with All, Comments, Suggestions and Resolved (E.6). */
|
|
199
|
-
export const NarrowDrawer: Story = { render: () => <DrawerDemo /> }
|
|
200
|
-
|
|
201
|
-
function DrawerDemo() {
|
|
202
|
-
const [open, setOpen] = React.useState(true)
|
|
203
|
-
const [active, setActive] = React.useState<string | null>(null)
|
|
204
|
-
return (
|
|
205
|
-
<CollabDrawer open={open} onOpenChange={setOpen} items={ITEMS} resolved={RESOLVED} labels={EDITOR_LABELS} actions={ACTIONS} active={active} onActive={setActive} />
|
|
206
|
-
)
|
|
207
|
-
}
|
|
1
|
+
import type { Meta, StoryObj } from "@storybook/react-vite"
|
|
2
|
+
import * as React from "react"
|
|
3
|
+
|
|
4
|
+
import type { EditorCollab, RailSuggestion, RailThread } from "./collab"
|
|
5
|
+
import { CollabDrawer, CollabRail, type RailActions, type RailItem } from "./collab-rail"
|
|
6
|
+
import type { Actor, EditorMode, WhityDocument } from "./contract"
|
|
7
|
+
import { DocEditor } from "./doc-editor"
|
|
8
|
+
import { EDITOR_LABELS } from "./labels"
|
|
9
|
+
import { SAMPLE_DOCUMENT } from "./sample"
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Editor M5, the EditorCollab card: the rail with comments and suggestions,
|
|
13
|
+
* Suggesting mode, resolved threads and the drawer under 1024px. Example data
|
|
14
|
+
* follows the card (Rana Haddad, Omar Khalil, the Billing assistant).
|
|
15
|
+
*/
|
|
16
|
+
const meta = {
|
|
17
|
+
title: "Editor/Comments and suggestions",
|
|
18
|
+
parameters: { layout: "fullscreen", fullBleed: true },
|
|
19
|
+
} satisfies Meta
|
|
20
|
+
|
|
21
|
+
export default meta
|
|
22
|
+
type Story = StoryObj<typeof meta>
|
|
23
|
+
|
|
24
|
+
const t = (text: string) => ({ type: "text" as const, text })
|
|
25
|
+
const RANA: Actor & { kind: "person" } = { kind: "person", id: "11", name: "Rana Haddad" }
|
|
26
|
+
const OMAR: Actor = { kind: "person", id: "12", name: "Omar Khalil" }
|
|
27
|
+
const AGENT: Actor = { kind: "agent", id: "billing-assistant", name: "Billing assistant", onBehalfOf: { id: "11", name: "Rana" }, scope: ["documents:suggest"] }
|
|
28
|
+
|
|
29
|
+
const LETTER: WhityDocument = {
|
|
30
|
+
...SAMPLE_DOCUMENT,
|
|
31
|
+
kind: "letter",
|
|
32
|
+
title: "Payment reminder",
|
|
33
|
+
blocks: [
|
|
34
|
+
{ id: "p1", type: "paragraph", content: [t("Invoice INV-1042 was due on 14 October. Please pay within 30 days of this letter.")] },
|
|
35
|
+
{ id: "p2", type: "paragraph", content: [t("Payments usually take two working days to reach us.")] },
|
|
36
|
+
{ id: "p3", type: "paragraph", content: [t("If you have already paid, thank you, and please ignore this letter.")] },
|
|
37
|
+
],
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
const SUGGESTIONS: RailSuggestion[] = [
|
|
41
|
+
{
|
|
42
|
+
id: "41",
|
|
43
|
+
by: RANA,
|
|
44
|
+
at: "2026-10-29T13:52:00",
|
|
45
|
+
kind: "text",
|
|
46
|
+
summary: "Replace “30 days” with “14 days”",
|
|
47
|
+
status: "open",
|
|
48
|
+
patch: { op: "replace-text", blockId: "p1", deleteText: "30 days", insert: [t("14 days")], occurrence: 0 },
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
id: "42",
|
|
52
|
+
by: RANA,
|
|
53
|
+
at: "2026-10-29T13:53:00",
|
|
54
|
+
kind: "text",
|
|
55
|
+
summary: "Add “, or call us on 06 555 0100”",
|
|
56
|
+
status: "open",
|
|
57
|
+
patch: { op: "replace-text", blockId: "p1", deleteText: "", insert: [t(", or call us on 06 555 0100")], before: "of this letter", occurrence: 0 },
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
id: "43",
|
|
61
|
+
by: AGENT,
|
|
62
|
+
at: "2026-10-29T13:55:00",
|
|
63
|
+
kind: "text",
|
|
64
|
+
summary: "Delete “usually ”",
|
|
65
|
+
status: "open",
|
|
66
|
+
request: "Make the payment paragraph firmer",
|
|
67
|
+
permission: "documents:suggest",
|
|
68
|
+
patch: { op: "replace-text", blockId: "p2", deleteText: "usually ", insert: [], occurrence: 0 },
|
|
69
|
+
},
|
|
70
|
+
]
|
|
71
|
+
|
|
72
|
+
const THREADS: RailThread[] = [
|
|
73
|
+
{
|
|
74
|
+
id: "7",
|
|
75
|
+
anchorBlockId: "p1",
|
|
76
|
+
quote: "Please pay within",
|
|
77
|
+
messages: [
|
|
78
|
+
{ id: "71", by: OMAR, at: "2026-10-29T13:40:00", body: [t("Should we mention the 2% late fee here?")], mentions: [] },
|
|
79
|
+
{ id: "72", by: RANA, at: "2026-10-29T13:44:00", body: [t("Yes, after the due date sentence.")], mentions: [] },
|
|
80
|
+
],
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
id: "5",
|
|
84
|
+
anchorBlockId: "p3",
|
|
85
|
+
quote: "already paid",
|
|
86
|
+
messages: [{ id: "51", by: OMAR, at: "2026-10-29T12:05:00", body: [t("Use the customer’s legal name")], mentions: [] }],
|
|
87
|
+
resolved: { by: RANA, at: "2026-10-29T12:10:00" },
|
|
88
|
+
},
|
|
89
|
+
]
|
|
90
|
+
|
|
91
|
+
const PEOPLE = [
|
|
92
|
+
{ id: "12", name: "Omar Khalil", detail: "Accounts" },
|
|
93
|
+
{ id: "13", name: "Lina Saad", detail: "HR" },
|
|
94
|
+
]
|
|
95
|
+
|
|
96
|
+
/** An in-memory server: suggestions get ids, decisions drop them, threads resolve and reopen. */
|
|
97
|
+
function useFakeCollab(canComment = true): EditorCollab {
|
|
98
|
+
const [suggestions, setSuggestions] = React.useState(SUGGESTIONS)
|
|
99
|
+
const [threads, setThreads] = React.useState(THREADS)
|
|
100
|
+
const next = React.useRef(100)
|
|
101
|
+
const now = () => new Date().toISOString()
|
|
102
|
+
return {
|
|
103
|
+
suggestions,
|
|
104
|
+
threads,
|
|
105
|
+
canSuggest: true,
|
|
106
|
+
canComment,
|
|
107
|
+
me: RANA,
|
|
108
|
+
onSuggest: async (change) => {
|
|
109
|
+
const saved: RailSuggestion = { id: String(next.current++), by: RANA, at: now(), status: "open", ...change }
|
|
110
|
+
setSuggestions((s) => [...s, saved])
|
|
111
|
+
return saved
|
|
112
|
+
},
|
|
113
|
+
onDecide: async (id) => setSuggestions((s) => s.filter((x) => x.id !== id)),
|
|
114
|
+
onDecideAll: async (_d, filter) => setSuggestions((s) => (filter?.agent ? s.filter((x) => x.by.kind !== "agent" || x.by.id !== filter.agent) : [])),
|
|
115
|
+
onComment: async (c) => {
|
|
116
|
+
const thread: RailThread = {
|
|
117
|
+
id: String(next.current++),
|
|
118
|
+
anchorBlockId: c.anchorBlockId,
|
|
119
|
+
quote: c.quote,
|
|
120
|
+
messages: [{ id: String(next.current++), by: RANA, at: now(), body: c.body, mentions: [] }],
|
|
121
|
+
}
|
|
122
|
+
setThreads((ts) => [...ts, thread])
|
|
123
|
+
return thread
|
|
124
|
+
},
|
|
125
|
+
onReply: async (threadId, body) =>
|
|
126
|
+
setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, messages: [...x.messages, { id: String(next.current++), by: RANA, at: now(), body, mentions: [] }] } : x))),
|
|
127
|
+
onResolve: async (threadId) => setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, resolved: { by: RANA, at: now() } } : x))),
|
|
128
|
+
onReopen: async (threadId) => setThreads((ts) => ts.map((x) => (x.id === threadId ? { ...x, resolved: undefined } : x))),
|
|
129
|
+
searchPeople: async (q) => PEOPLE.filter((p) => p.name.toLowerCase().includes(q.toLowerCase())),
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
function Live({ canEdit = true, startMode }: { canEdit?: boolean; startMode?: EditorMode }) {
|
|
134
|
+
const [doc, setDoc] = React.useState(LETTER)
|
|
135
|
+
const [mode, setMode] = React.useState<EditorMode | undefined>(startMode)
|
|
136
|
+
const collab = useFakeCollab()
|
|
137
|
+
return (
|
|
138
|
+
<div style={{ height: "100vh" }}>
|
|
139
|
+
<DocEditor
|
|
140
|
+
document={doc}
|
|
141
|
+
onChange={setDoc}
|
|
142
|
+
canEdit={canEdit}
|
|
143
|
+
mode={mode}
|
|
144
|
+
onModeChange={setMode}
|
|
145
|
+
back={{ label: "Back to templates", onClick: () => {} }}
|
|
146
|
+
path="Templates · Letters"
|
|
147
|
+
save={{ state: "saved", at: "14:02" }}
|
|
148
|
+
collab={collab}
|
|
149
|
+
/>
|
|
150
|
+
</div>
|
|
151
|
+
)
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/** The rail beside the sheet: a thread, Rana's two suggestions and the agent's, dashed. */
|
|
155
|
+
export const RailWithCommentsAndSuggestions: Story = { render: () => <Live /> }
|
|
156
|
+
|
|
157
|
+
/** Suggesting mode: the mode button on the tint; typing adds, deleting strikes through. */
|
|
158
|
+
export const SuggestingMode: Story = { render: () => <Live startMode="suggesting" /> }
|
|
159
|
+
|
|
160
|
+
/** Someone without edit permission: Suggesting, with Editing locked in the mode menu (E.10). */
|
|
161
|
+
export const WithoutEditPermission: Story = { render: () => <Live canEdit={false} /> }
|
|
162
|
+
|
|
163
|
+
const ACTIONS: RailActions = {
|
|
164
|
+
canEdit: true,
|
|
165
|
+
canComment: true,
|
|
166
|
+
onDecide: () => {},
|
|
167
|
+
onDecideAll: () => {},
|
|
168
|
+
onReply: async () => {},
|
|
169
|
+
onResolve: () => {},
|
|
170
|
+
onReopen: () => {},
|
|
171
|
+
searchPeople: async (q) => PEOPLE.filter((p) => p.name.toLowerCase().includes(q.toLowerCase())),
|
|
172
|
+
}
|
|
173
|
+
const ITEMS: RailItem[] = [
|
|
174
|
+
{ kind: "thread", id: "7", thread: THREADS[0] },
|
|
175
|
+
...SUGGESTIONS.map((s) => ({ kind: "suggestion" as const, id: s.id, suggestion: s })),
|
|
176
|
+
]
|
|
177
|
+
const RESOLVED: RailItem[] = [{ kind: "thread", id: "5", thread: THREADS[1] }]
|
|
178
|
+
|
|
179
|
+
/** The rail on its own, with "1 resolved" open: the resolved card and Reopen. */
|
|
180
|
+
export const ResolvedThreads: Story = {
|
|
181
|
+
render: () => (
|
|
182
|
+
<div style={{ width: 300, minHeight: 900, marginInlineStart: 24 }}>
|
|
183
|
+
<CollabRail
|
|
184
|
+
items={ITEMS}
|
|
185
|
+
resolved={RESOLVED}
|
|
186
|
+
labels={EDITOR_LABELS}
|
|
187
|
+
actions={ACTIONS}
|
|
188
|
+
active="7"
|
|
189
|
+
onActive={() => {}}
|
|
190
|
+
anchorTop={() => null}
|
|
191
|
+
layoutKey={0}
|
|
192
|
+
defaultShowResolved
|
|
193
|
+
/>
|
|
194
|
+
</div>
|
|
195
|
+
),
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/** Under 1024px: the same cards in a drawer with All, Comments, Suggestions and Resolved (E.6). */
|
|
199
|
+
export const NarrowDrawer: Story = { render: () => <DrawerDemo /> }
|
|
200
|
+
|
|
201
|
+
function DrawerDemo() {
|
|
202
|
+
const [open, setOpen] = React.useState(true)
|
|
203
|
+
const [active, setActive] = React.useState<string | null>(null)
|
|
204
|
+
return (
|
|
205
|
+
<CollabDrawer open={open} onOpenChange={setOpen} items={ITEMS} resolved={RESOLVED} labels={EDITOR_LABELS} actions={ACTIONS} active={active} onActive={setActive} />
|
|
206
|
+
)
|
|
207
|
+
}
|
package/src/editor/collab.ts
CHANGED
|
@@ -1,87 +1,87 @@
|
|
|
1
|
-
import type { Actor, CommentThread, Inline, Suggestion } from "./contract"
|
|
2
|
-
import type { SuggestionKind, SuggestionPatch } from "./suggestions"
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Comments and suggestions as the editor takes them (editor M5): the
|
|
6
|
-
* contract's `Suggestion` and `CommentThread`, plus what the server keeps
|
|
7
|
-
* beside them (the patch, the status, the thread's anchor).
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
export type SuggestionStatus = "open" | "accepted" | "rejected" | "stale"
|
|
11
|
-
|
|
12
|
-
export interface RailSuggestion extends Suggestion {
|
|
13
|
-
patch: SuggestionPatch
|
|
14
|
-
status: SuggestionStatus
|
|
15
|
-
baseVersion?: number
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
export interface RailThread extends CommentThread {
|
|
19
|
-
/** The block the quote is in (E.39: the highlight is drawn by matching the quote there). */
|
|
20
|
-
anchorBlockId: string
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/** Someone who can be @mentioned. */
|
|
24
|
-
export interface MentionPerson {
|
|
25
|
-
id: string
|
|
26
|
-
name: string
|
|
27
|
-
/** A second line, such as a unit ("Accounts"). */
|
|
28
|
-
detail?: string
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/** What a flush sends for one local change (POST /suggestions). */
|
|
32
|
-
export interface NewSuggestion {
|
|
33
|
-
kind: SuggestionKind
|
|
34
|
-
summary: string
|
|
35
|
-
patch: SuggestionPatch
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
export interface NewComment {
|
|
39
|
-
anchorBlockId: string
|
|
40
|
-
quote: string
|
|
41
|
-
body: Inline[]
|
|
42
|
-
/** Profile ids. */
|
|
43
|
-
mentions: string[]
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/** Who decides is the server's to check (documents:write, E.29); the editor only offers it with canEdit. */
|
|
47
|
-
export type Decision = "accepted" | "rejected"
|
|
48
|
-
|
|
49
|
-
export interface DecideAllFilter {
|
|
50
|
-
/** Only these suggestions. */
|
|
51
|
-
ids?: string[]
|
|
52
|
-
/** Only those from one agent principal (its id). */
|
|
53
|
-
agent?: string
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* The editor's comments and suggestions. Without it the editor has no rail,
|
|
58
|
-
* no Suggesting mode and no Comment, as before M5.
|
|
59
|
-
*/
|
|
60
|
-
export interface EditorCollab {
|
|
61
|
-
/** Open suggestions, in the server's id order. */
|
|
62
|
-
suggestions: RailSuggestion[]
|
|
63
|
-
/** Every thread, resolved ones included. */
|
|
64
|
-
threads: RailThread[]
|
|
65
|
-
/**
|
|
66
|
-
* Bump when the draft or the open suggestions changed on the server (a
|
|
67
|
-
* decision, someone else's suggestion): the editor draws the suggestions
|
|
68
|
-
* onto the draft again, once nothing of yours is waiting to be sent.
|
|
69
|
-
*/
|
|
70
|
-
revision?: number
|
|
71
|
-
/** documents:suggest (E.10). */
|
|
72
|
-
canSuggest?: boolean
|
|
73
|
-
/** documents:comment. */
|
|
74
|
-
canComment?: boolean
|
|
75
|
-
/** The person at the keyboard: their pending suggestions and new comments show as theirs. */
|
|
76
|
-
me?: Actor & { kind: "person" }
|
|
77
|
-
/** Sends one local change; resolves to the stored suggestion (its id replaces the local one). */
|
|
78
|
-
onSuggest?: (change: NewSuggestion) => Promise<RailSuggestion>
|
|
79
|
-
onDecide?: (suggestionId: string, decision: Decision) => Promise<void>
|
|
80
|
-
onDecideAll?: (decision: Decision, filter?: DecideAllFilter) => Promise<void>
|
|
81
|
-
onComment?: (comment: NewComment) => Promise<RailThread>
|
|
82
|
-
onReply?: (threadId: string, body: Inline[], mentions: string[]) => Promise<void>
|
|
83
|
-
onResolve?: (threadId: string) => Promise<void>
|
|
84
|
-
onReopen?: (threadId: string) => Promise<void>
|
|
85
|
-
/** People to @mention: workspace people who can be notified. */
|
|
86
|
-
searchPeople?: (query: string) => Promise<MentionPerson[]>
|
|
87
|
-
}
|
|
1
|
+
import type { Actor, CommentThread, Inline, Suggestion } from "./contract"
|
|
2
|
+
import type { SuggestionKind, SuggestionPatch } from "./suggestions"
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Comments and suggestions as the editor takes them (editor M5): the
|
|
6
|
+
* contract's `Suggestion` and `CommentThread`, plus what the server keeps
|
|
7
|
+
* beside them (the patch, the status, the thread's anchor).
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
export type SuggestionStatus = "open" | "accepted" | "rejected" | "stale"
|
|
11
|
+
|
|
12
|
+
export interface RailSuggestion extends Suggestion {
|
|
13
|
+
patch: SuggestionPatch
|
|
14
|
+
status: SuggestionStatus
|
|
15
|
+
baseVersion?: number
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export interface RailThread extends CommentThread {
|
|
19
|
+
/** The block the quote is in (E.39: the highlight is drawn by matching the quote there). */
|
|
20
|
+
anchorBlockId: string
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** Someone who can be @mentioned. */
|
|
24
|
+
export interface MentionPerson {
|
|
25
|
+
id: string
|
|
26
|
+
name: string
|
|
27
|
+
/** A second line, such as a unit ("Accounts"). */
|
|
28
|
+
detail?: string
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/** What a flush sends for one local change (POST /suggestions). */
|
|
32
|
+
export interface NewSuggestion {
|
|
33
|
+
kind: SuggestionKind
|
|
34
|
+
summary: string
|
|
35
|
+
patch: SuggestionPatch
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export interface NewComment {
|
|
39
|
+
anchorBlockId: string
|
|
40
|
+
quote: string
|
|
41
|
+
body: Inline[]
|
|
42
|
+
/** Profile ids. */
|
|
43
|
+
mentions: string[]
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Who decides is the server's to check (documents:write, E.29); the editor only offers it with canEdit. */
|
|
47
|
+
export type Decision = "accepted" | "rejected"
|
|
48
|
+
|
|
49
|
+
export interface DecideAllFilter {
|
|
50
|
+
/** Only these suggestions. */
|
|
51
|
+
ids?: string[]
|
|
52
|
+
/** Only those from one agent principal (its id). */
|
|
53
|
+
agent?: string
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* The editor's comments and suggestions. Without it the editor has no rail,
|
|
58
|
+
* no Suggesting mode and no Comment, as before M5.
|
|
59
|
+
*/
|
|
60
|
+
export interface EditorCollab {
|
|
61
|
+
/** Open suggestions, in the server's id order. */
|
|
62
|
+
suggestions: RailSuggestion[]
|
|
63
|
+
/** Every thread, resolved ones included. */
|
|
64
|
+
threads: RailThread[]
|
|
65
|
+
/**
|
|
66
|
+
* Bump when the draft or the open suggestions changed on the server (a
|
|
67
|
+
* decision, someone else's suggestion): the editor draws the suggestions
|
|
68
|
+
* onto the draft again, once nothing of yours is waiting to be sent.
|
|
69
|
+
*/
|
|
70
|
+
revision?: number
|
|
71
|
+
/** documents:suggest (E.10). */
|
|
72
|
+
canSuggest?: boolean
|
|
73
|
+
/** documents:comment. */
|
|
74
|
+
canComment?: boolean
|
|
75
|
+
/** The person at the keyboard: their pending suggestions and new comments show as theirs. */
|
|
76
|
+
me?: Actor & { kind: "person" }
|
|
77
|
+
/** Sends one local change; resolves to the stored suggestion (its id replaces the local one). */
|
|
78
|
+
onSuggest?: (change: NewSuggestion) => Promise<RailSuggestion>
|
|
79
|
+
onDecide?: (suggestionId: string, decision: Decision) => Promise<void>
|
|
80
|
+
onDecideAll?: (decision: Decision, filter?: DecideAllFilter) => Promise<void>
|
|
81
|
+
onComment?: (comment: NewComment) => Promise<RailThread>
|
|
82
|
+
onReply?: (threadId: string, body: Inline[], mentions: string[]) => Promise<void>
|
|
83
|
+
onResolve?: (threadId: string) => Promise<void>
|
|
84
|
+
onReopen?: (threadId: string) => Promise<void>
|
|
85
|
+
/** People to @mention: workspace people who can be notified. */
|
|
86
|
+
searchPeople?: (query: string) => Promise<MentionPerson[]>
|
|
87
|
+
}
|