@tangle-network/ui 11.33.0 → 11.35.0

package/src/editor/source-markdown-editor.test.tsx

@@ -0,0 +1,156 @@
+import { act, render, waitFor } from "@testing-library/react";
+import type { Editor } from "@tiptap/react";
+import { describe, expect, it, vi } from "vitest";
+import { MarkdownDocumentEditor } from "./markdown-document-editor";
+import { CALL_SHEET, KITCHEN_SINK } from "./source-markdown.fixtures";
+
+// The first render imports tiptap for real; a cold import on a busy runner
+// takes several seconds.
+const PEERS_LOADED = { timeout: 15_000 };
+const LOADS_PEERS = 30_000;
+
+async function openEditor(value: string) {
+  const onChange = vi.fn<(markdown: string) => void>();
+  let editor: Editor | null = null;
+  const view = render(
+    <MarkdownDocumentEditor
+      value={value}
+      onChange={(markdown) => onChange(markdown)}
+      onReady={(ready) => {
+        editor = ready;
+      }}
+    />,
+  );
+  // The first mount after the peers load can replace its editor instance, so
+  // wait for a live one and hand back the latest.
+  await waitFor(() => {
+    expect(editor).not.toBeNull();
+    expect((editor as Editor | null)?.isDestroyed).toBe(false);
+  }, PEERS_LOADED);
+  return {
+    view,
+    get editor() {
+      return editor! as Editor;
+    },
+    onChange,
+    /** The Markdown the editor last reported, or the value it opened. */
+    saved: () => onChange.mock.calls.at(-1)?.[0] ?? value,
+  };
+}
+
+/** Document position at the start or end of the first text node containing `needle`. */
+function textPosition(editor: Editor, needle: string, edge: "start" | "end" = "end"): number {
+  let found = -1;
+  editor.state.doc.descendants((node, pos) => {
+    if (found >= 0) return false;
+    const index = node.isText ? (node.text ?? "").indexOf(needle) : -1;
+    if (index >= 0) found = pos + index + (edge === "end" ? needle.length : 0);
+    return true;
+  });
+  if (found < 0) throw new Error(`Not in the document: ${needle}`);
+  return found;
+}
+
+function insertAfter(editor: Editor, needle: string, text: string) {
+  act(() => {
+    editor.commands.insertContentAt(textPosition(editor, needle), text);
+  });
+}
+
+function tableRows(markdown: string) {
+  return markdown.split("\n").filter((line) => line.startsWith("|"));
+}
+
+describe("MarkdownDocumentEditor source preservation", () => {
+  it("opens every Markdown construct without reporting a change", async () => {
+    const { editor, onChange, view } = await openEditor(KITCHEN_SINK);
+    act(() => {
+      editor.commands.setTextSelection(1);
+      editor.setEditable(false);
+      editor.setEditable(true);
+    });
+    expect(onChange).not.toHaveBeenCalled();
+    // The table is shown as a table, read-only, instead of a run-on paragraph.
+    const table = view.container.querySelector('[data-md-kind="table"] table');
+    expect(table?.querySelectorAll("tbody tr")).toHaveLength(1);
+    expect(table?.textContent).toContain("Center");
+  }, LOADS_PEERS);
+
+  it.each([
+    ["a paragraph with escapes", "snake_case_name", " (edited)"],
+    ["a star bullet", "star bullet two", "!"],
+    ["a nested bullet", "nested four-space", " item"],
+    ["a paren-ordered item", "paren ordered", " list"],
+    ["a setext heading", "Setext heading", " again"],
+    ["a fenced code block", "const x = 1", "0"],
+    ["a tilde fence", "tilde fence", "d"],
+    ["a nested quote", "nested quote", "d"],
+    ["the last paragraph", "next line", "."],
+  ])("changes only the edited span when typing into %s", async (_name, needle, text) => {
+    const { editor, saved } = await openEditor(KITCHEN_SINK);
+    insertAfter(editor, needle, text);
+    expect(saved()).toBe(KITCHEN_SINK.replace(needle, needle + text));
+  }, LOADS_PEERS);
+
+  it("keeps every table row when the title is edited, the failure founders hit", async () => {
+    const { editor, saved } = await openEditor(CALL_SHEET);
+    act(() => {
+      editor.commands.insertContentAt(textPosition(editor, "Plausible Analytics:", "start"), "Draft: ");
+    });
+    expect(saved()).toBe(CALL_SHEET.replace("# Plausible", "# Draft: Plausible"));
+    expect(tableRows(saved())).toEqual(tableRows(CALL_SHEET));
+    expect(tableRows(saved())).toHaveLength(5);
+  }, LOADS_PEERS);
+
+  it("separates a paragraph added with Enter by a blank line", async () => {
+    const { editor, saved } = await openEditor(CALL_SHEET);
+    act(() => {
+      editor.chain().setTextSelection(textPosition(editor, "positioning Plausible.")).splitBlock().run();
+      editor.commands.insertContent("A new line of notes.");
+    });
+    expect(saved()).toBe(
+      CALL_SHEET.replace("positioning Plausible.\n", "positioning Plausible.\n\nA new line of notes.\n"),
+    );
+  }, LOADS_PEERS);
+
+  it("adds only the delimiters when a word is bolded", async () => {
+    const { editor, saved } = await openEditor(CALL_SHEET);
+    const end = textPosition(editor, "Who signs off");
+    act(() => {
+      editor.chain().setTextSelection({ from: end - "signs off".length, to: end }).toggleBold().run();
+    });
+    expect(saved()).toBe(CALL_SHEET.replace("Who signs off", "Who **signs off**"));
+  }, LOADS_PEERS);
+
+  it("adds an item in the list's own marker style", async () => {
+    const { editor, saved } = await openEditor(CALL_SHEET);
+    act(() => {
+      editor.chain().setTextSelection(textPosition(editor, "after the call")).splitListItem("listItem").run();
+      editor.commands.insertContent("Log the objections");
+    });
+    expect(saved()).toBe(CALL_SHEET.replace("after the call\n", "after the call\n* Log the objections\n"));
+  }, LOADS_PEERS);
+
+  it("removes only the table when its block is deleted", async () => {
+    const { editor, saved } = await openEditor(CALL_SHEET);
+    let tablePos = -1;
+    editor.state.doc.forEach((node, offset) => {
+      if (node.type.name === "markdownSource") tablePos = offset;
+    });
+    act(() => {
+      editor.chain().setNodeSelection(tablePos).deleteSelection().run();
+    });
+    const start = CALL_SHEET.indexOf("| Competitor");
+    const end = CALL_SHEET.indexOf("## Qualifying");
+    expect(saved()).toBe(CALL_SHEET.slice(0, start) + CALL_SHEET.slice(end));
+  }, LOADS_PEERS);
+
+  it("reports the original bytes again once an edit is undone", async () => {
+    const { editor, saved } = await openEditor(KITCHEN_SINK);
+    insertAfter(editor, "star bullet one", "?");
+    act(() => {
+      editor.commands.undo();
+    });
+    expect(saved()).toBe(KITCHEN_SINK);
+  }, LOADS_PEERS);
+});

package/src/editor/source-markdown-editor.ts

@@ -0,0 +1,296 @@
+/**
+ * The tiptap half of source-preserving Markdown editing (see
+ * `source-markdown.ts`): a read-only node for blocks the editor cannot
+ * represent, a block-id attribute on every top-level node, and the session
+ * that maps an editor document back onto the file's original bytes.
+ *
+ * tiptap arrives as an argument, so this module reaches it through type-only
+ * imports, which a bundler erases (see `editor-peers.ts`).
+ */
+
+import type * as TiptapReact from "@tiptap/react";
+import { marked, type Token, type Tokens } from "marked";
+import {
+  asReadOnlyDocument,
+  BLOCK_ID_ATTRIBUTE,
+  blockHtml,
+  blockMarkdown,
+  createBlockMerger,
+  parseSourceMarkdown,
+  serializeSourceMarkdown,
+  SOURCE_KIND_ATTRIBUTE,
+  SOURCE_RAW_ATTRIBUTE,
+  withReadOnlyBlocks,
+  type SourceBlockKind,
+  type SourceMarkdown,
+  type SourceNode,
+} from "./source-markdown";
+
+type Core = typeof TiptapReact;
+type Editor = TiptapReact.Editor;
+type PMNode = Editor["state"]["doc"];
+type Schema = Editor["schema"];
+type DOMOutputSpec = unknown[] | string;
+
+/** Name of the read-only node that holds a block's raw Markdown. */
+export const SOURCE_NODE = "markdownSource";
+
+/** Top-level node types that can carry a block id. */
+const BLOCK_TYPES = [
+  "paragraph",
+  "heading",
+  "bulletList",
+  "orderedList",
+  "blockquote",
+  "codeBlock",
+  "horizontalRule",
+  SOURCE_NODE,
+];
+
+const CAPTIONS: Record<SourceBlockKind, string> = {
+  table: "Table",
+  html: "HTML",
+  image: "Image",
+  checklist: "Checklist",
+  definition: "Link definition",
+  markdown: "Markdown",
+  paragraph: "Markdown",
+  heading: "Markdown",
+  code: "Markdown",
+  blockquote: "Markdown",
+  list: "Markdown",
+  hr: "Markdown",
+};
+
+function inlineText(tokens: Token[] | undefined): string {
+  return (tokens ?? [])
+    .map((token) => {
+      switch (token.type) {
+        case "image":
+          return (token as Tokens.Image).text;
+        case "br":
+          return " ";
+        case "html":
+          return "";
+        default: {
+          const children = (token as { tokens?: Token[] }).tokens;
+          return children ? inlineText(children) : (token as { text?: string }).text ?? "";
+        }
+      }
+    })
+    .join("");
+}
+
+function tablePreview(raw: string): DOMOutputSpec | null {
+  const table = marked.lexer(raw, { gfm: true }).find((token) => token.type === "table") as
+    | Tokens.Table
+    | undefined;
+  if (!table) return null;
+  const cell = (tag: "th" | "td", value: Tokens.TableCell) => [tag, {}, inlineText(value.tokens)];
+  return [
+    "table",
+    {},
+    ["thead", {}, ["tr", {}, ...table.header.map((value) => cell("th", value))]],
+    ["tbody", {}, ...table.rows.map((row) => ["tr", {}, ...row.map((value) => cell("td", value))])],
+  ];
+}
+
+function sourcePreview(raw: string, kind: SourceBlockKind): DOMOutputSpec[] {
+  const caption: DOMOutputSpec = [
+    "p",
+    { class: "not-prose m-0 mb-2 text-sm text-muted-foreground" },
+    `${CAPTIONS[kind] ?? "Markdown"} kept exactly as written. Edit it in the Markdown source.`,
+  ];
+  const table = kind === "table" ? tablePreview(raw) : null;
+  if (table) return [caption, ["div", { class: "overflow-x-auto" }, table]];
+  return [caption, ["pre", { class: "m-0 whitespace-pre-wrap" }, ["code", {}, raw]]];
+}
+
+/** The read-only source node and the block-id attribute, built from the loaded tiptap. */
+export function createSourceMarkdownExtensions(core: Core) {
+  const SourceBlock = core.Node.create({
+    name: SOURCE_NODE,
+    group: "block",
+    atom: true,
+    selectable: true,
+    draggable: false,
+    addAttributes() {
+      return {
+        raw: {
+          default: "",
+          parseHTML: (element: HTMLElement) => element.getAttribute(SOURCE_RAW_ATTRIBUTE) ?? "",
+          renderHTML: (attributes: Record<string, unknown>) => ({ [SOURCE_RAW_ATTRIBUTE]: attributes.raw }),
+        },
+        kind: {
+          default: "markdown",
+          parseHTML: (element: HTMLElement) => element.getAttribute(SOURCE_KIND_ATTRIBUTE) ?? "markdown",
+          renderHTML: (attributes: Record<string, unknown>) => ({ [SOURCE_KIND_ATTRIBUTE]: attributes.kind }),
+        },
+      };
+    },
+    parseHTML() {
+      return [{ tag: `div[${SOURCE_RAW_ATTRIBUTE}]` }];
+    },
+    renderHTML({ node, HTMLAttributes }) {
+      return [
+        "div",
+        core.mergeAttributes(HTMLAttributes, {
+          class: "my-3 rounded-lg border border-dashed border-border bg-muted/40 p-3",
+        }),
+        ...sourcePreview(String(node.attrs.raw ?? ""), node.attrs.kind as SourceBlockKind),
+      ] as never;
+    },
+  });
+
+  const BlockIdentity = core.Extension.create({
+    name: "markdownSourceBlockId",
+    addGlobalAttributes() {
+      return [
+        {
+          types: BLOCK_TYPES,
+          attributes: {
+            mdBlock: {
+              default: null,
+              // A split's new half is new text, not a copy of the source block.
+              keepOnSplit: false,
+              parseHTML: (element: HTMLElement) => element.getAttribute(BLOCK_ID_ATTRIBUTE),
+              renderHTML: (attributes: Record<string, unknown>) =>
+                attributes.mdBlock ? { [BLOCK_ID_ATTRIBUTE]: attributes.mdBlock } : {},
+            },
+          },
+        },
+      ];
+    },
+  });
+
+  return [SourceBlock, BlockIdentity];
+}
+
+function blockIdOf(node: PMNode): string | null {
+  const id = (node.attrs as { mdBlock?: unknown }).mdBlock;
+  return typeof id === "string" && id ? id : null;
+}
+
+function isEmptyParagraph(node: PMNode) {
+  return node.type.name === "paragraph" && node.content.size === 0;
+}
+
+function withoutBlockIds(value: unknown): unknown {
+  if (Array.isArray(value)) return value.map(withoutBlockIds);
+  if (!value || typeof value !== "object") return value;
+  const out: Record<string, unknown> = {};
+  for (const [key, entry] of Object.entries(value)) {
+    if (key === "mdBlock") continue;
+    out[key] = withoutBlockIds(entry);
+  }
+  return out;
+}
+
+/**
+ * One open file in the rich editor: its source blocks, the nodes they were
+ * first parsed into, and the Markdown written back for the current document.
+ */
+export class SourceMarkdownSession {
+  source: SourceMarkdown;
+  private readonly core: Core;
+  private readonly markdown: string;
+  private readonly initial = new Map<string, PMNode>();
+  private readonly mergers = new Map<string, (edited: string) => string | null>();
+
+  constructor(core: Core, markdown: string) {
+    this.core = core;
+    this.markdown = markdown;
+    this.source = parseSourceMarkdown(markdown);
+  }
+
+  get html() {
+    return this.source.html;
+  }
+
+  /**
+   * Records the nodes the editor parsed. A block the editor document does not
+   * hold as exactly one top-level node (dropped, split, or merged by the
+   * schema) is shown read-only instead, so no source byte can be lost.
+   */
+  attach(editor: Editor) {
+    for (let attempt = 0; attempt < 3; attempt++) {
+      const unmapped = this.capture(editor.state.doc);
+      if (unmapped.size === 0) return;
+      this.source = attempt < 2 ? withReadOnlyBlocks(this.source, unmapped) : asReadOnlyDocument(this.markdown);
+      editor.commands.setContent(this.source.html, { emitUpdate: false });
+    }
+    this.capture(editor.state.doc);
+  }
+
+  private capture(doc: PMNode): Set<string> {
+    this.initial.clear();
+    this.mergers.clear();
+    const unmapped = new Set<string>();
+    let previous: string | null = null;
+    doc.forEach((node, _offset, index) => {
+      const id = blockIdOf(node);
+      if (id && this.source.byId.has(id)) {
+        if (this.initial.has(id)) unmapped.add(id);
+        else this.initial.set(id, node);
+        previous = id;
+        return;
+      }
+      if (index === doc.childCount - 1 && isEmptyParagraph(node)) return;
+      // A node with no id came out of the block before it (or the first block).
+      const owner = previous ?? this.source.blocks[0]?.id;
+      if (owner) unmapped.add(owner);
+    });
+    for (const block of this.source.blocks) {
+      if (!this.initial.has(block.id)) unmapped.add(block.id);
+    }
+    return unmapped;
+  }
+
+  private toMarkdown(node: PMNode, raw: string) {
+    const fragment = node.type.schema.topNodeType.create(null, node).content;
+    return blockMarkdown(this.core.getHTMLFromFragment(fragment, node.type.schema), raw);
+  }
+
+  private reparses(markdown: string, node: PMNode, schema: Schema) {
+    const html = blockHtml(markdown, this.source.links);
+    if (html === null) return false;
+    const parsed = this.core.createDocument(html, schema);
+    const nodes: PMNode[] = [];
+    parsed.forEach((child) => {
+      if (!isEmptyParagraph(child)) nodes.push(child);
+    });
+    return (
+      nodes.length === 1 &&
+      JSON.stringify(withoutBlockIds(nodes[0].toJSON())) === JSON.stringify(withoutBlockIds(node.toJSON()))
+    );
+  }
+
+  private mergerFor(id: string, initial: PMNode, raw: string) {
+    let merge = this.mergers.get(id);
+    if (!merge) {
+      merge = createBlockMerger(raw, this.toMarkdown(initial, raw));
+      this.mergers.set(id, merge);
+    }
+    return merge;
+  }
+
+  /** The file's Markdown for `doc`: original bytes wherever the reader changed nothing. */
+  serialize(doc: PMNode): string {
+    const nodes: SourceNode[] = [];
+    doc.forEach((node) => {
+      const id = blockIdOf(node);
+      const block = id ? this.source.byId.get(id) : undefined;
+      const initial = id ? this.initial.get(id) : undefined;
+      const raw = node.type.name === SOURCE_NODE ? String(node.attrs.raw ?? "") : null;
+      nodes.push({
+        block: initial ? block : undefined,
+        unchanged: Boolean(initial?.eq(node)),
+        sameType: initial?.type === node.type,
+        markdown: () => raw ?? this.toMarkdown(node, block?.raw ?? ""),
+        merge: (edited) => (initial && block ? this.mergerFor(block.id, initial, block.raw)(edited) : null),
+        reparses: (markdown) => this.reparses(markdown, node, node.type.schema),
+      });
+    });
+    return serializeSourceMarkdown(this.source, nodes);
+  }
+}

package/src/editor/source-markdown.fixtures.ts

@@ -0,0 +1,90 @@
+/**
+ * Markdown fixtures for the source-preserving editor tests.
+ */
+
+/**
+ * One of every block and inline construct, in the less common spellings too.
+ * Trailing spaces are written as \u0020 so an editor cannot strip them.
+ */
+export const KITCHEN_SINK = `
+
+# Title with \`code\` and **bold**
+
+Setext heading
+==============
+
+Paragraph with *star emphasis*, _underscore emphasis_, __double under__, snake_case_name, a\\_b escaped,
+a hard break here\u0020\u0020
+and a [link](https://example.com "Title"), a [ref link][ref], <https://auto.link>, and ~~strike~~.
+
+* star bullet one
+* star bullet two
+    * nested four-space
+
++ plus list
+
+1) paren ordered
+2) second
+
+3. starts at three
+4. four
+
+- [ ] task open
+- [x] task done
+
+> quote line one
+> > nested quote
+
+\`\`\`ts
+const x = 1 // fenced
+\`\`\`
+
+~~~
+tilde fence
+~~~
+
+    indented code
+
+***
+
+---
+___
+
+| Left | Center | Right |
+|:-----|:------:|------:|
+| a | **b** | [c](https://c.example) |
+
+<div align="center">raw html block</div>
+
+![image alt](images/pic.png "pic title")
+
+Text with inline <sup>html</sup> and an emoji 🚀 and trailing spaces\u0020\u0020\u0020
+
+[ref]: https://ref.example "Ref Title"
+
+Line with trailing backslash\\
+next line
+`;
+
+
+/** Shaped like an agent-written competitor call sheet: headings, prose and GFM tables. */
+export const CALL_SHEET = `# Plausible Analytics: competitor call sheet
+
+**Updated:** October 11, 2026 · **Use:** establish what the buyer is comparing before positioning Plausible.
+
+## Three deal paths
+
+| Competitor | Why a buyer may choose it | Call response |
+|---|---|---|
+| Google Analytics 4 | Standard GA4 is free of charge. ([GA4](https://example.com/ga4)) | **Acknowledge:** the no-cost offer is real. |
+| Fathom | Closest paid, cookie-free alternative. | Ask which reports they rely on today. |
+| Simple Analytics | Stricter no-identifier model. | Show the dashboard and ask what is missing. |
+
+## Qualifying questions
+
+1. Which reports do you open every week?
+2. Who signs off on analytics spend?
+
+* Keep the call to 20 minutes
+* Send the comparison after the call
+`;