@tangle-network/ui 11.32.2 → 11.34.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/CHANGELOG.md +23 -0
- package/dist/editor/document-editor-pane.d.ts +7 -1
- package/dist/editor/document-editor-pane.js +27 -12
- package/dist/editor/markdown-document-editor.js +30 -12
- package/dist/editor/source-markdown-editor.js +256 -0
- package/dist/editor/source-markdown.js +495 -0
- package/dist/files/file-artifact-pane.d.ts +2 -0
- package/dist/files/file-artifact-pane.js +1 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -2
- package/dist/lib/control-presentation.js +2 -1
- package/dist/lib/focus.d.ts +5 -1
- package/dist/lib/focus.js +6 -1
- package/dist/lib/interaction.d.ts +41 -0
- package/dist/lib/interaction.js +42 -0
- package/dist/markdown/markdown-table.js +1 -1
- package/dist/primitives/button.js +19 -18
- package/dist/primitives/card.d.ts +14 -1
- package/dist/primitives/card.js +15 -5
- package/dist/primitives/dropdown-menu.js +7 -6
- package/dist/primitives/segmented-control.d.ts +5 -1
- package/dist/primitives/segmented-control.js +12 -5
- package/dist/primitives/select.js +4 -3
- package/dist/primitives/tabs.js +4 -3
- package/dist/run/inline-thinking-item.d.ts +7 -1
- package/dist/run/inline-thinking-item.js +6 -5
- package/dist/utils/format.d.ts +6 -0
- package/dist/utils/format.js +9 -1
- package/dist/utils.d.ts +3 -2
- package/dist/utils.js +3 -2
- package/package.json +2 -2
- package/src/editor/document-editor-pane.tsx +54 -16
- package/src/editor/markdown-document-editor.tsx +33 -18
- package/src/editor/source-markdown-editor.test.tsx +156 -0
- package/src/editor/source-markdown-editor.ts +296 -0
- package/src/editor/source-markdown.fixtures.ts +90 -0
- package/src/editor/source-markdown.test.ts +235 -0
- package/src/editor/source-markdown.ts +627 -0
- package/src/files/file-artifact-pane.test.tsx +38 -3
- package/src/files/file-artifact-pane.tsx +3 -0
- package/src/lib/control-presentation.ts +10 -4
- package/src/lib/focus.ts +7 -1
- package/src/lib/interaction.ts +64 -0
- package/src/markdown/markdown-table.test.tsx +9 -0
- package/src/markdown/markdown-table.tsx +5 -1
- package/src/primitives/button.tsx +29 -10
- package/src/primitives/card.tsx +23 -6
- package/src/primitives/control-presentation.test.tsx +6 -3
- package/src/primitives/date-picker.test.tsx +1 -1
- package/src/primitives/dropdown-menu.tsx +15 -10
- package/src/primitives/interaction-states.test.tsx +285 -0
- package/src/primitives/segmented-control.test.tsx +4 -2
- package/src/primitives/segmented-control.tsx +13 -14
- package/src/primitives/select.tsx +11 -5
- package/src/primitives/tabs.tsx +7 -3
- package/src/run/inline-thinking-item.test.tsx +29 -0
- package/src/run/inline-thinking-item.tsx +11 -4
- package/src/utils/format.test.ts +16 -1
- package/src/utils/format.ts +17 -0
- package/src/utils/index.ts +10 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
|
|
3
|
-
import { type ReactNode, useEffect, useMemo, useState } from "react";
|
|
3
|
+
import { type KeyboardEvent, type ReactNode, useEffect, useMemo, useState } from "react";
|
|
4
4
|
import type { UrlTransform } from "react-markdown";
|
|
5
5
|
import { PencilLine, Save, Users, Wifi, WifiOff } from "lucide-react";
|
|
6
6
|
import { Markdown } from "../markdown/markdown";
|
|
@@ -39,6 +39,12 @@ export interface DocumentEditorPaneProps
|
|
|
39
39
|
markdown?: string;
|
|
40
40
|
/** Persisted baseline when the host controls the current markdown draft. */
|
|
41
41
|
savedMarkdown?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Whether the draft has unsaved edits, when the host tracks that itself
|
|
44
|
+
* (for example against the file's full bytes, frontmatter included). It
|
|
45
|
+
* takes precedence over comparing the draft with `savedMarkdown`.
|
|
46
|
+
*/
|
|
47
|
+
dirty?: boolean;
|
|
42
48
|
/** Transform Markdown links and images through the shared URL policy. */
|
|
43
49
|
urlTransform?: UrlTransform;
|
|
44
50
|
mode?: DocumentEditorMode;
|
|
@@ -194,6 +200,7 @@ export function DocumentEditorPane({
|
|
|
194
200
|
toolbar,
|
|
195
201
|
markdown = "",
|
|
196
202
|
savedMarkdown,
|
|
203
|
+
dirty,
|
|
197
204
|
urlTransform,
|
|
198
205
|
mode,
|
|
199
206
|
defaultMode = "preview",
|
|
@@ -215,16 +222,32 @@ export function DocumentEditorPane({
|
|
|
215
222
|
useState<DocumentEditorMode>(defaultMode);
|
|
216
223
|
const activeMode = mode ?? uncontrolledMode;
|
|
217
224
|
const isCollaborative = backend === "collaborative" && Boolean(collaboration);
|
|
218
|
-
const isDirty = normalizeMarkdown(draft) !== normalizeMarkdown(savedMarkdown ?? markdown);
|
|
225
|
+
const isDirty = dirty ?? normalizeMarkdown(draft) !== normalizeMarkdown(savedMarkdown ?? markdown);
|
|
226
|
+
const canSave = Boolean(onSave) && !readOnly && isDirty && !saving;
|
|
219
227
|
const saveStateLabel = readOnly
|
|
220
228
|
? "Read only"
|
|
221
229
|
: isCollaborative
|
|
222
230
|
? isDirty
|
|
223
231
|
? "Snapshot pending"
|
|
224
232
|
: "Live document current"
|
|
225
|
-
:
|
|
226
|
-
? "
|
|
227
|
-
:
|
|
233
|
+
: saving
|
|
234
|
+
? "Saving…"
|
|
235
|
+
: isDirty
|
|
236
|
+
? "Unsaved changes"
|
|
237
|
+
: "Saved";
|
|
238
|
+
|
|
239
|
+
const save = () => {
|
|
240
|
+
if (canSave) void onSave?.(draft);
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
// Ctrl+S / Cmd+S saves from anywhere in the pane, the editor included.
|
|
244
|
+
const handleKeyDown = (event: KeyboardEvent<HTMLDivElement>) => {
|
|
245
|
+
if (!onSave || readOnly) return;
|
|
246
|
+
if (!(event.metaKey || event.ctrlKey) || event.altKey || event.shiftKey) return;
|
|
247
|
+
if (event.key.toLowerCase() !== "s") return;
|
|
248
|
+
event.preventDefault();
|
|
249
|
+
save();
|
|
250
|
+
};
|
|
228
251
|
|
|
229
252
|
useEffect(() => {
|
|
230
253
|
setDraft(markdown);
|
|
@@ -271,26 +294,40 @@ export function DocumentEditorPane({
|
|
|
271
294
|
</TabsTrigger>
|
|
272
295
|
</TabsList>
|
|
273
296
|
|
|
274
|
-
|
|
297
|
+
{/* One save state: the status says whether the draft is saved, and the
|
|
298
|
+
Save button exists only while there is something to save. */}
|
|
299
|
+
<div className="flex flex-wrap items-center gap-2 text-sm text-muted-foreground">
|
|
275
300
|
{toolbar}
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
301
|
+
{isCollaborative && (
|
|
302
|
+
<span className="rounded-full border border-border bg-card px-2.5 py-1 font-medium">
|
|
303
|
+
Live document
|
|
304
|
+
</span>
|
|
305
|
+
)}
|
|
306
|
+
<span
|
|
307
|
+
role="status"
|
|
308
|
+
aria-live="polite"
|
|
309
|
+
className={cn(
|
|
310
|
+
"rounded-full border px-2.5 py-1",
|
|
311
|
+
isDirty && !readOnly
|
|
312
|
+
? "border-[var(--surface-warning-border)] bg-[var(--surface-warning-bg)] text-[var(--surface-warning-text)]"
|
|
313
|
+
: "border-border bg-background",
|
|
314
|
+
)}
|
|
315
|
+
>
|
|
280
316
|
{saveStateLabel}
|
|
281
317
|
</span>
|
|
282
|
-
{onSave && !readOnly && (
|
|
318
|
+
{onSave && !readOnly && (isDirty || saving) && (
|
|
283
319
|
<button
|
|
284
320
|
type="button"
|
|
285
|
-
onClick={
|
|
286
|
-
disabled={
|
|
321
|
+
onClick={save}
|
|
322
|
+
disabled={!canSave}
|
|
323
|
+
title="Save changes (Ctrl+S)"
|
|
287
324
|
className={cn(
|
|
288
|
-
"inline-flex items-center gap-2 rounded-[var(--radius-full)] border border-
|
|
325
|
+
"inline-flex items-center gap-2 rounded-[var(--radius-full)] border border-primary bg-primary px-3 py-1.5 text-sm font-semibold text-primary-foreground transition-colors hover:bg-primary/90 disabled:cursor-not-allowed disabled:opacity-50",
|
|
289
326
|
focusRing,
|
|
290
327
|
)}
|
|
291
328
|
>
|
|
292
|
-
<Save className="h-
|
|
293
|
-
{
|
|
329
|
+
<Save className="h-4 w-4" />
|
|
330
|
+
{saveLabel}
|
|
294
331
|
</button>
|
|
295
332
|
)}
|
|
296
333
|
</div>
|
|
@@ -341,6 +378,7 @@ export function DocumentEditorPane({
|
|
|
341
378
|
<Tabs
|
|
342
379
|
value={activeMode}
|
|
343
380
|
onValueChange={(nextValue) => setMode(nextValue as DocumentEditorMode)}
|
|
381
|
+
onKeyDown={handleKeyDown}
|
|
344
382
|
className="h-full"
|
|
345
383
|
>
|
|
346
384
|
<ArtifactPane
|
|
@@ -7,11 +7,8 @@ import { retryableLazyEditor } from "./editor-lazy";
|
|
|
7
7
|
import { EditorLoadingPlaceholder } from "./editor-loading";
|
|
8
8
|
import { type DocumentEditorPeers, loadDocumentEditorPeers } from "./editor-peers";
|
|
9
9
|
import { EditorToolbar } from "./editor-toolbar";
|
|
10
|
-
import {
|
|
11
|
-
|
|
12
|
-
markdownToHtml,
|
|
13
|
-
normalizeMarkdown,
|
|
14
|
-
} from "./markdown-conversion";
|
|
10
|
+
import { normalizeMarkdown } from "./markdown-conversion";
|
|
11
|
+
import { createSourceMarkdownExtensions, SourceMarkdownSession } from "./source-markdown-editor";
|
|
15
12
|
|
|
16
13
|
export interface MarkdownDocumentEditorProps {
|
|
17
14
|
value?: string;
|
|
@@ -28,12 +25,18 @@ export interface MarkdownDocumentEditorProps {
|
|
|
28
25
|
* Builds the local markdown editor against loaded tiptap namespaces. The
|
|
29
26
|
* peers arrive as an argument so that this module reaches them through
|
|
30
27
|
* type-only imports, which a bundler erases.
|
|
28
|
+
*
|
|
29
|
+
* The editor writes back the file's own bytes wherever the reader changed
|
|
30
|
+
* nothing (see `source-markdown.ts`): opening a file and leaving it reports no
|
|
31
|
+
* change, and an edit changes only the edited span. Blocks it cannot represent,
|
|
32
|
+
* such as tables, are shown read-only and kept verbatim.
|
|
31
33
|
*/
|
|
32
34
|
export function createMarkdownDocumentEditor(
|
|
33
35
|
peers: DocumentEditorPeers,
|
|
34
36
|
): ComponentType<MarkdownDocumentEditorProps> {
|
|
35
37
|
const { EditorContent, useEditor } = peers.react;
|
|
36
38
|
const StarterKit = peers.starterKit.default;
|
|
39
|
+
const sourceExtensions = createSourceMarkdownExtensions(peers.react);
|
|
37
40
|
|
|
38
41
|
return function MarkdownDocumentEditor({
|
|
39
42
|
value = "",
|
|
@@ -45,8 +48,13 @@ export function createMarkdownDocumentEditor(
|
|
|
45
48
|
onChange,
|
|
46
49
|
onReady,
|
|
47
50
|
}: MarkdownDocumentEditorProps) {
|
|
48
|
-
const
|
|
49
|
-
|
|
51
|
+
const sessionRef = useRef<SourceMarkdownSession | null>(null);
|
|
52
|
+
if (!sessionRef.current) sessionRef.current = new SourceMarkdownSession(peers.react, value);
|
|
53
|
+
const initialHtml = useMemo(() => sessionRef.current!.html, []);
|
|
54
|
+
// The Markdown last written by this editor or applied from `value`.
|
|
55
|
+
const lastMarkdownRef = useRef(value);
|
|
56
|
+
const onChangeRef = useRef(onChange);
|
|
57
|
+
onChangeRef.current = onChange;
|
|
50
58
|
|
|
51
59
|
const editor = useEditor({
|
|
52
60
|
extensions: [
|
|
@@ -56,7 +64,10 @@ export function createMarkdownDocumentEditor(
|
|
|
56
64
|
class: "hljs",
|
|
57
65
|
},
|
|
58
66
|
},
|
|
67
|
+
// Markdown has no underline, so an underline could not be saved.
|
|
68
|
+
underline: false,
|
|
59
69
|
}),
|
|
70
|
+
...sourceExtensions,
|
|
60
71
|
],
|
|
61
72
|
content: initialHtml,
|
|
62
73
|
editable: !readOnly,
|
|
@@ -73,33 +84,37 @@ export function createMarkdownDocumentEditor(
|
|
|
73
84
|
},
|
|
74
85
|
},
|
|
75
86
|
onUpdate: ({ editor: currentEditor }) => {
|
|
76
|
-
const nextMarkdown =
|
|
77
|
-
|
|
78
|
-
|
|
87
|
+
const nextMarkdown = sessionRef.current!.serialize(currentEditor.state.doc);
|
|
88
|
+
// A transaction that changes no Markdown (a selection, a trailing empty
|
|
89
|
+
// paragraph) is not an edit.
|
|
90
|
+
if (nextMarkdown === lastMarkdownRef.current) return;
|
|
91
|
+
lastMarkdownRef.current = nextMarkdown;
|
|
92
|
+
onChangeRef.current?.(nextMarkdown, currentEditor);
|
|
79
93
|
},
|
|
80
94
|
onCreate: ({ editor: currentEditor }) => {
|
|
95
|
+
sessionRef.current!.attach(currentEditor);
|
|
81
96
|
onReady?.(currentEditor);
|
|
82
97
|
},
|
|
83
98
|
});
|
|
84
99
|
|
|
85
100
|
useEffect(() => {
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
}
|
|
101
|
+
// No update event: toggling read-only is not an edit.
|
|
102
|
+
editor?.setEditable(!readOnly, false);
|
|
89
103
|
}, [editor, readOnly]);
|
|
90
104
|
|
|
91
105
|
useEffect(() => {
|
|
92
106
|
if (!editor) {
|
|
93
107
|
return;
|
|
94
108
|
}
|
|
95
|
-
|
|
96
|
-
const normalizedValue = normalizeMarkdown(value);
|
|
97
|
-
if (normalizedValue === lastAppliedMarkdownRef.current) {
|
|
109
|
+
if (normalizeMarkdown(value) === normalizeMarkdown(lastMarkdownRef.current)) {
|
|
98
110
|
return;
|
|
99
111
|
}
|
|
100
112
|
|
|
101
|
-
|
|
102
|
-
|
|
113
|
+
const session = new SourceMarkdownSession(peers.react, value);
|
|
114
|
+
sessionRef.current = session;
|
|
115
|
+
editor.commands.setContent(session.html, { emitUpdate: false });
|
|
116
|
+
session.attach(editor);
|
|
117
|
+
lastMarkdownRef.current = value;
|
|
103
118
|
}, [editor, value]);
|
|
104
119
|
|
|
105
120
|
return (
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import { act, render, waitFor } from "@testing-library/react";
|
|
2
|
+
import type { Editor } from "@tiptap/react";
|
|
3
|
+
import { describe, expect, it, vi } from "vitest";
|
|
4
|
+
import { MarkdownDocumentEditor } from "./markdown-document-editor";
|
|
5
|
+
import { CALL_SHEET, KITCHEN_SINK } from "./source-markdown.fixtures";
|
|
6
|
+
|
|
7
|
+
// The first render imports tiptap for real; a cold import on a busy runner
|
|
8
|
+
// takes several seconds.
|
|
9
|
+
const PEERS_LOADED = { timeout: 15_000 };
|
|
10
|
+
const LOADS_PEERS = 30_000;
|
|
11
|
+
|
|
12
|
+
async function openEditor(value: string) {
|
|
13
|
+
const onChange = vi.fn<(markdown: string) => void>();
|
|
14
|
+
let editor: Editor | null = null;
|
|
15
|
+
const view = render(
|
|
16
|
+
<MarkdownDocumentEditor
|
|
17
|
+
value={value}
|
|
18
|
+
onChange={(markdown) => onChange(markdown)}
|
|
19
|
+
onReady={(ready) => {
|
|
20
|
+
editor = ready;
|
|
21
|
+
}}
|
|
22
|
+
/>,
|
|
23
|
+
);
|
|
24
|
+
// The first mount after the peers load can replace its editor instance, so
|
|
25
|
+
// wait for a live one and hand back the latest.
|
|
26
|
+
await waitFor(() => {
|
|
27
|
+
expect(editor).not.toBeNull();
|
|
28
|
+
expect((editor as Editor | null)?.isDestroyed).toBe(false);
|
|
29
|
+
}, PEERS_LOADED);
|
|
30
|
+
return {
|
|
31
|
+
view,
|
|
32
|
+
get editor() {
|
|
33
|
+
return editor! as Editor;
|
|
34
|
+
},
|
|
35
|
+
onChange,
|
|
36
|
+
/** The Markdown the editor last reported, or the value it opened. */
|
|
37
|
+
saved: () => onChange.mock.calls.at(-1)?.[0] ?? value,
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** Document position at the start or end of the first text node containing `needle`. */
|
|
42
|
+
function textPosition(editor: Editor, needle: string, edge: "start" | "end" = "end"): number {
|
|
43
|
+
let found = -1;
|
|
44
|
+
editor.state.doc.descendants((node, pos) => {
|
|
45
|
+
if (found >= 0) return false;
|
|
46
|
+
const index = node.isText ? (node.text ?? "").indexOf(needle) : -1;
|
|
47
|
+
if (index >= 0) found = pos + index + (edge === "end" ? needle.length : 0);
|
|
48
|
+
return true;
|
|
49
|
+
});
|
|
50
|
+
if (found < 0) throw new Error(`Not in the document: ${needle}`);
|
|
51
|
+
return found;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
function insertAfter(editor: Editor, needle: string, text: string) {
|
|
55
|
+
act(() => {
|
|
56
|
+
editor.commands.insertContentAt(textPosition(editor, needle), text);
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
function tableRows(markdown: string) {
|
|
61
|
+
return markdown.split("\n").filter((line) => line.startsWith("|"));
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
describe("MarkdownDocumentEditor source preservation", () => {
|
|
65
|
+
it("opens every Markdown construct without reporting a change", async () => {
|
|
66
|
+
const { editor, onChange, view } = await openEditor(KITCHEN_SINK);
|
|
67
|
+
act(() => {
|
|
68
|
+
editor.commands.setTextSelection(1);
|
|
69
|
+
editor.setEditable(false);
|
|
70
|
+
editor.setEditable(true);
|
|
71
|
+
});
|
|
72
|
+
expect(onChange).not.toHaveBeenCalled();
|
|
73
|
+
// The table is shown as a table, read-only, instead of a run-on paragraph.
|
|
74
|
+
const table = view.container.querySelector('[data-md-kind="table"] table');
|
|
75
|
+
expect(table?.querySelectorAll("tbody tr")).toHaveLength(1);
|
|
76
|
+
expect(table?.textContent).toContain("Center");
|
|
77
|
+
}, LOADS_PEERS);
|
|
78
|
+
|
|
79
|
+
it.each([
|
|
80
|
+
["a paragraph with escapes", "snake_case_name", " (edited)"],
|
|
81
|
+
["a star bullet", "star bullet two", "!"],
|
|
82
|
+
["a nested bullet", "nested four-space", " item"],
|
|
83
|
+
["a paren-ordered item", "paren ordered", " list"],
|
|
84
|
+
["a setext heading", "Setext heading", " again"],
|
|
85
|
+
["a fenced code block", "const x = 1", "0"],
|
|
86
|
+
["a tilde fence", "tilde fence", "d"],
|
|
87
|
+
["a nested quote", "nested quote", "d"],
|
|
88
|
+
["the last paragraph", "next line", "."],
|
|
89
|
+
])("changes only the edited span when typing into %s", async (_name, needle, text) => {
|
|
90
|
+
const { editor, saved } = await openEditor(KITCHEN_SINK);
|
|
91
|
+
insertAfter(editor, needle, text);
|
|
92
|
+
expect(saved()).toBe(KITCHEN_SINK.replace(needle, needle + text));
|
|
93
|
+
}, LOADS_PEERS);
|
|
94
|
+
|
|
95
|
+
it("keeps every table row when the title is edited, the failure founders hit", async () => {
|
|
96
|
+
const { editor, saved } = await openEditor(CALL_SHEET);
|
|
97
|
+
act(() => {
|
|
98
|
+
editor.commands.insertContentAt(textPosition(editor, "Plausible Analytics:", "start"), "Draft: ");
|
|
99
|
+
});
|
|
100
|
+
expect(saved()).toBe(CALL_SHEET.replace("# Plausible", "# Draft: Plausible"));
|
|
101
|
+
expect(tableRows(saved())).toEqual(tableRows(CALL_SHEET));
|
|
102
|
+
expect(tableRows(saved())).toHaveLength(5);
|
|
103
|
+
}, LOADS_PEERS);
|
|
104
|
+
|
|
105
|
+
it("separates a paragraph added with Enter by a blank line", async () => {
|
|
106
|
+
const { editor, saved } = await openEditor(CALL_SHEET);
|
|
107
|
+
act(() => {
|
|
108
|
+
editor.chain().setTextSelection(textPosition(editor, "positioning Plausible.")).splitBlock().run();
|
|
109
|
+
editor.commands.insertContent("A new line of notes.");
|
|
110
|
+
});
|
|
111
|
+
expect(saved()).toBe(
|
|
112
|
+
CALL_SHEET.replace("positioning Plausible.\n", "positioning Plausible.\n\nA new line of notes.\n"),
|
|
113
|
+
);
|
|
114
|
+
}, LOADS_PEERS);
|
|
115
|
+
|
|
116
|
+
it("adds only the delimiters when a word is bolded", async () => {
|
|
117
|
+
const { editor, saved } = await openEditor(CALL_SHEET);
|
|
118
|
+
const end = textPosition(editor, "Who signs off");
|
|
119
|
+
act(() => {
|
|
120
|
+
editor.chain().setTextSelection({ from: end - "signs off".length, to: end }).toggleBold().run();
|
|
121
|
+
});
|
|
122
|
+
expect(saved()).toBe(CALL_SHEET.replace("Who signs off", "Who **signs off**"));
|
|
123
|
+
}, LOADS_PEERS);
|
|
124
|
+
|
|
125
|
+
it("adds an item in the list's own marker style", async () => {
|
|
126
|
+
const { editor, saved } = await openEditor(CALL_SHEET);
|
|
127
|
+
act(() => {
|
|
128
|
+
editor.chain().setTextSelection(textPosition(editor, "after the call")).splitListItem("listItem").run();
|
|
129
|
+
editor.commands.insertContent("Log the objections");
|
|
130
|
+
});
|
|
131
|
+
expect(saved()).toBe(CALL_SHEET.replace("after the call\n", "after the call\n* Log the objections\n"));
|
|
132
|
+
}, LOADS_PEERS);
|
|
133
|
+
|
|
134
|
+
it("removes only the table when its block is deleted", async () => {
|
|
135
|
+
const { editor, saved } = await openEditor(CALL_SHEET);
|
|
136
|
+
let tablePos = -1;
|
|
137
|
+
editor.state.doc.forEach((node, offset) => {
|
|
138
|
+
if (node.type.name === "markdownSource") tablePos = offset;
|
|
139
|
+
});
|
|
140
|
+
act(() => {
|
|
141
|
+
editor.chain().setNodeSelection(tablePos).deleteSelection().run();
|
|
142
|
+
});
|
|
143
|
+
const start = CALL_SHEET.indexOf("| Competitor");
|
|
144
|
+
const end = CALL_SHEET.indexOf("## Qualifying");
|
|
145
|
+
expect(saved()).toBe(CALL_SHEET.slice(0, start) + CALL_SHEET.slice(end));
|
|
146
|
+
}, LOADS_PEERS);
|
|
147
|
+
|
|
148
|
+
it("reports the original bytes again once an edit is undone", async () => {
|
|
149
|
+
const { editor, saved } = await openEditor(KITCHEN_SINK);
|
|
150
|
+
insertAfter(editor, "star bullet one", "?");
|
|
151
|
+
act(() => {
|
|
152
|
+
editor.commands.undo();
|
|
153
|
+
});
|
|
154
|
+
expect(saved()).toBe(KITCHEN_SINK);
|
|
155
|
+
}, LOADS_PEERS);
|
|
156
|
+
});
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The tiptap half of source-preserving Markdown editing (see
|
|
3
|
+
* `source-markdown.ts`): a read-only node for blocks the editor cannot
|
|
4
|
+
* represent, a block-id attribute on every top-level node, and the session
|
|
5
|
+
* that maps an editor document back onto the file's original bytes.
|
|
6
|
+
*
|
|
7
|
+
* tiptap arrives as an argument, so this module reaches it through type-only
|
|
8
|
+
* imports, which a bundler erases (see `editor-peers.ts`).
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import type * as TiptapReact from "@tiptap/react";
|
|
12
|
+
import { marked, type Token, type Tokens } from "marked";
|
|
13
|
+
import {
|
|
14
|
+
asReadOnlyDocument,
|
|
15
|
+
BLOCK_ID_ATTRIBUTE,
|
|
16
|
+
blockHtml,
|
|
17
|
+
blockMarkdown,
|
|
18
|
+
createBlockMerger,
|
|
19
|
+
parseSourceMarkdown,
|
|
20
|
+
serializeSourceMarkdown,
|
|
21
|
+
SOURCE_KIND_ATTRIBUTE,
|
|
22
|
+
SOURCE_RAW_ATTRIBUTE,
|
|
23
|
+
withReadOnlyBlocks,
|
|
24
|
+
type SourceBlockKind,
|
|
25
|
+
type SourceMarkdown,
|
|
26
|
+
type SourceNode,
|
|
27
|
+
} from "./source-markdown";
|
|
28
|
+
|
|
29
|
+
type Core = typeof TiptapReact;
|
|
30
|
+
type Editor = TiptapReact.Editor;
|
|
31
|
+
type PMNode = Editor["state"]["doc"];
|
|
32
|
+
type Schema = Editor["schema"];
|
|
33
|
+
type DOMOutputSpec = unknown[] | string;
|
|
34
|
+
|
|
35
|
+
/** Name of the read-only node that holds a block's raw Markdown. */
|
|
36
|
+
export const SOURCE_NODE = "markdownSource";
|
|
37
|
+
|
|
38
|
+
/** Top-level node types that can carry a block id. */
|
|
39
|
+
const BLOCK_TYPES = [
|
|
40
|
+
"paragraph",
|
|
41
|
+
"heading",
|
|
42
|
+
"bulletList",
|
|
43
|
+
"orderedList",
|
|
44
|
+
"blockquote",
|
|
45
|
+
"codeBlock",
|
|
46
|
+
"horizontalRule",
|
|
47
|
+
SOURCE_NODE,
|
|
48
|
+
];
|
|
49
|
+
|
|
50
|
+
const CAPTIONS: Record<SourceBlockKind, string> = {
|
|
51
|
+
table: "Table",
|
|
52
|
+
html: "HTML",
|
|
53
|
+
image: "Image",
|
|
54
|
+
checklist: "Checklist",
|
|
55
|
+
definition: "Link definition",
|
|
56
|
+
markdown: "Markdown",
|
|
57
|
+
paragraph: "Markdown",
|
|
58
|
+
heading: "Markdown",
|
|
59
|
+
code: "Markdown",
|
|
60
|
+
blockquote: "Markdown",
|
|
61
|
+
list: "Markdown",
|
|
62
|
+
hr: "Markdown",
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
function inlineText(tokens: Token[] | undefined): string {
|
|
66
|
+
return (tokens ?? [])
|
|
67
|
+
.map((token) => {
|
|
68
|
+
switch (token.type) {
|
|
69
|
+
case "image":
|
|
70
|
+
return (token as Tokens.Image).text;
|
|
71
|
+
case "br":
|
|
72
|
+
return " ";
|
|
73
|
+
case "html":
|
|
74
|
+
return "";
|
|
75
|
+
default: {
|
|
76
|
+
const children = (token as { tokens?: Token[] }).tokens;
|
|
77
|
+
return children ? inlineText(children) : (token as { text?: string }).text ?? "";
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
})
|
|
81
|
+
.join("");
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function tablePreview(raw: string): DOMOutputSpec | null {
|
|
85
|
+
const table = marked.lexer(raw, { gfm: true }).find((token) => token.type === "table") as
|
|
86
|
+
| Tokens.Table
|
|
87
|
+
| undefined;
|
|
88
|
+
if (!table) return null;
|
|
89
|
+
const cell = (tag: "th" | "td", value: Tokens.TableCell) => [tag, {}, inlineText(value.tokens)];
|
|
90
|
+
return [
|
|
91
|
+
"table",
|
|
92
|
+
{},
|
|
93
|
+
["thead", {}, ["tr", {}, ...table.header.map((value) => cell("th", value))]],
|
|
94
|
+
["tbody", {}, ...table.rows.map((row) => ["tr", {}, ...row.map((value) => cell("td", value))])],
|
|
95
|
+
];
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
function sourcePreview(raw: string, kind: SourceBlockKind): DOMOutputSpec[] {
|
|
99
|
+
const caption: DOMOutputSpec = [
|
|
100
|
+
"p",
|
|
101
|
+
{ class: "not-prose m-0 mb-2 text-sm text-muted-foreground" },
|
|
102
|
+
`${CAPTIONS[kind] ?? "Markdown"} kept exactly as written. Edit it in the Markdown source.`,
|
|
103
|
+
];
|
|
104
|
+
const table = kind === "table" ? tablePreview(raw) : null;
|
|
105
|
+
if (table) return [caption, ["div", { class: "overflow-x-auto" }, table]];
|
|
106
|
+
return [caption, ["pre", { class: "m-0 whitespace-pre-wrap" }, ["code", {}, raw]]];
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/** The read-only source node and the block-id attribute, built from the loaded tiptap. */
|
|
110
|
+
export function createSourceMarkdownExtensions(core: Core) {
|
|
111
|
+
const SourceBlock = core.Node.create({
|
|
112
|
+
name: SOURCE_NODE,
|
|
113
|
+
group: "block",
|
|
114
|
+
atom: true,
|
|
115
|
+
selectable: true,
|
|
116
|
+
draggable: false,
|
|
117
|
+
addAttributes() {
|
|
118
|
+
return {
|
|
119
|
+
raw: {
|
|
120
|
+
default: "",
|
|
121
|
+
parseHTML: (element: HTMLElement) => element.getAttribute(SOURCE_RAW_ATTRIBUTE) ?? "",
|
|
122
|
+
renderHTML: (attributes: Record<string, unknown>) => ({ [SOURCE_RAW_ATTRIBUTE]: attributes.raw }),
|
|
123
|
+
},
|
|
124
|
+
kind: {
|
|
125
|
+
default: "markdown",
|
|
126
|
+
parseHTML: (element: HTMLElement) => element.getAttribute(SOURCE_KIND_ATTRIBUTE) ?? "markdown",
|
|
127
|
+
renderHTML: (attributes: Record<string, unknown>) => ({ [SOURCE_KIND_ATTRIBUTE]: attributes.kind }),
|
|
128
|
+
},
|
|
129
|
+
};
|
|
130
|
+
},
|
|
131
|
+
parseHTML() {
|
|
132
|
+
return [{ tag: `div[${SOURCE_RAW_ATTRIBUTE}]` }];
|
|
133
|
+
},
|
|
134
|
+
renderHTML({ node, HTMLAttributes }) {
|
|
135
|
+
return [
|
|
136
|
+
"div",
|
|
137
|
+
core.mergeAttributes(HTMLAttributes, {
|
|
138
|
+
class: "my-3 rounded-lg border border-dashed border-border bg-muted/40 p-3",
|
|
139
|
+
}),
|
|
140
|
+
...sourcePreview(String(node.attrs.raw ?? ""), node.attrs.kind as SourceBlockKind),
|
|
141
|
+
] as never;
|
|
142
|
+
},
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
const BlockIdentity = core.Extension.create({
|
|
146
|
+
name: "markdownSourceBlockId",
|
|
147
|
+
addGlobalAttributes() {
|
|
148
|
+
return [
|
|
149
|
+
{
|
|
150
|
+
types: BLOCK_TYPES,
|
|
151
|
+
attributes: {
|
|
152
|
+
mdBlock: {
|
|
153
|
+
default: null,
|
|
154
|
+
// A split's new half is new text, not a copy of the source block.
|
|
155
|
+
keepOnSplit: false,
|
|
156
|
+
parseHTML: (element: HTMLElement) => element.getAttribute(BLOCK_ID_ATTRIBUTE),
|
|
157
|
+
renderHTML: (attributes: Record<string, unknown>) =>
|
|
158
|
+
attributes.mdBlock ? { [BLOCK_ID_ATTRIBUTE]: attributes.mdBlock } : {},
|
|
159
|
+
},
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
];
|
|
163
|
+
},
|
|
164
|
+
});
|
|
165
|
+
|
|
166
|
+
return [SourceBlock, BlockIdentity];
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
function blockIdOf(node: PMNode): string | null {
|
|
170
|
+
const id = (node.attrs as { mdBlock?: unknown }).mdBlock;
|
|
171
|
+
return typeof id === "string" && id ? id : null;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
function isEmptyParagraph(node: PMNode) {
|
|
175
|
+
return node.type.name === "paragraph" && node.content.size === 0;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
function withoutBlockIds(value: unknown): unknown {
|
|
179
|
+
if (Array.isArray(value)) return value.map(withoutBlockIds);
|
|
180
|
+
if (!value || typeof value !== "object") return value;
|
|
181
|
+
const out: Record<string, unknown> = {};
|
|
182
|
+
for (const [key, entry] of Object.entries(value)) {
|
|
183
|
+
if (key === "mdBlock") continue;
|
|
184
|
+
out[key] = withoutBlockIds(entry);
|
|
185
|
+
}
|
|
186
|
+
return out;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* One open file in the rich editor: its source blocks, the nodes they were
|
|
191
|
+
* first parsed into, and the Markdown written back for the current document.
|
|
192
|
+
*/
|
|
193
|
+
export class SourceMarkdownSession {
|
|
194
|
+
source: SourceMarkdown;
|
|
195
|
+
private readonly core: Core;
|
|
196
|
+
private readonly markdown: string;
|
|
197
|
+
private readonly initial = new Map<string, PMNode>();
|
|
198
|
+
private readonly mergers = new Map<string, (edited: string) => string | null>();
|
|
199
|
+
|
|
200
|
+
constructor(core: Core, markdown: string) {
|
|
201
|
+
this.core = core;
|
|
202
|
+
this.markdown = markdown;
|
|
203
|
+
this.source = parseSourceMarkdown(markdown);
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
get html() {
|
|
207
|
+
return this.source.html;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Records the nodes the editor parsed. A block the editor document does not
|
|
212
|
+
* hold as exactly one top-level node (dropped, split, or merged by the
|
|
213
|
+
* schema) is shown read-only instead, so no source byte can be lost.
|
|
214
|
+
*/
|
|
215
|
+
attach(editor: Editor) {
|
|
216
|
+
for (let attempt = 0; attempt < 3; attempt++) {
|
|
217
|
+
const unmapped = this.capture(editor.state.doc);
|
|
218
|
+
if (unmapped.size === 0) return;
|
|
219
|
+
this.source = attempt < 2 ? withReadOnlyBlocks(this.source, unmapped) : asReadOnlyDocument(this.markdown);
|
|
220
|
+
editor.commands.setContent(this.source.html, { emitUpdate: false });
|
|
221
|
+
}
|
|
222
|
+
this.capture(editor.state.doc);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
private capture(doc: PMNode): Set<string> {
|
|
226
|
+
this.initial.clear();
|
|
227
|
+
this.mergers.clear();
|
|
228
|
+
const unmapped = new Set<string>();
|
|
229
|
+
let previous: string | null = null;
|
|
230
|
+
doc.forEach((node, _offset, index) => {
|
|
231
|
+
const id = blockIdOf(node);
|
|
232
|
+
if (id && this.source.byId.has(id)) {
|
|
233
|
+
if (this.initial.has(id)) unmapped.add(id);
|
|
234
|
+
else this.initial.set(id, node);
|
|
235
|
+
previous = id;
|
|
236
|
+
return;
|
|
237
|
+
}
|
|
238
|
+
if (index === doc.childCount - 1 && isEmptyParagraph(node)) return;
|
|
239
|
+
// A node with no id came out of the block before it (or the first block).
|
|
240
|
+
const owner = previous ?? this.source.blocks[0]?.id;
|
|
241
|
+
if (owner) unmapped.add(owner);
|
|
242
|
+
});
|
|
243
|
+
for (const block of this.source.blocks) {
|
|
244
|
+
if (!this.initial.has(block.id)) unmapped.add(block.id);
|
|
245
|
+
}
|
|
246
|
+
return unmapped;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
private toMarkdown(node: PMNode, raw: string) {
|
|
250
|
+
const fragment = node.type.schema.topNodeType.create(null, node).content;
|
|
251
|
+
return blockMarkdown(this.core.getHTMLFromFragment(fragment, node.type.schema), raw);
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
private reparses(markdown: string, node: PMNode, schema: Schema) {
|
|
255
|
+
const html = blockHtml(markdown, this.source.links);
|
|
256
|
+
if (html === null) return false;
|
|
257
|
+
const parsed = this.core.createDocument(html, schema);
|
|
258
|
+
const nodes: PMNode[] = [];
|
|
259
|
+
parsed.forEach((child) => {
|
|
260
|
+
if (!isEmptyParagraph(child)) nodes.push(child);
|
|
261
|
+
});
|
|
262
|
+
return (
|
|
263
|
+
nodes.length === 1 &&
|
|
264
|
+
JSON.stringify(withoutBlockIds(nodes[0].toJSON())) === JSON.stringify(withoutBlockIds(node.toJSON()))
|
|
265
|
+
);
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
private mergerFor(id: string, initial: PMNode, raw: string) {
|
|
269
|
+
let merge = this.mergers.get(id);
|
|
270
|
+
if (!merge) {
|
|
271
|
+
merge = createBlockMerger(raw, this.toMarkdown(initial, raw));
|
|
272
|
+
this.mergers.set(id, merge);
|
|
273
|
+
}
|
|
274
|
+
return merge;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/** The file's Markdown for `doc`: original bytes wherever the reader changed nothing. */
|
|
278
|
+
serialize(doc: PMNode): string {
|
|
279
|
+
const nodes: SourceNode[] = [];
|
|
280
|
+
doc.forEach((node) => {
|
|
281
|
+
const id = blockIdOf(node);
|
|
282
|
+
const block = id ? this.source.byId.get(id) : undefined;
|
|
283
|
+
const initial = id ? this.initial.get(id) : undefined;
|
|
284
|
+
const raw = node.type.name === SOURCE_NODE ? String(node.attrs.raw ?? "") : null;
|
|
285
|
+
nodes.push({
|
|
286
|
+
block: initial ? block : undefined,
|
|
287
|
+
unchanged: Boolean(initial?.eq(node)),
|
|
288
|
+
sameType: initial?.type === node.type,
|
|
289
|
+
markdown: () => raw ?? this.toMarkdown(node, block?.raw ?? ""),
|
|
290
|
+
merge: (edited) => (initial && block ? this.mergerFor(block.id, initial, block.raw)(edited) : null),
|
|
291
|
+
reparses: (markdown) => this.reparses(markdown, node, node.type.schema),
|
|
292
|
+
});
|
|
293
|
+
});
|
|
294
|
+
return serializeSourceMarkdown(this.source, nodes);
|
|
295
|
+
}
|
|
296
|
+
}
|