Release-cycle review found two hardening gaps: - The sync plugin deleted+rebuilt the WHOLE footnotesList on any reorder/orphan, replacing every definition's Yjs subtree -> a collaborator typing in a definition could lose in-flight characters on merge. Rework to targeted, minimal mutations: attr-only setNodeMarkup for collision re-ids, delete only genuine orphans, insert only genuinely-missing definitions (at the list end, not shifting existing subtrees), and consolidate multiple lists only in the abnormal paste/merge case. An unchanged (correct id, referenced) definition is left completely untouched. Numbering is decoration-only, so physical list order may drift after a reorder (accepted) while displayed numbers stay correct. Invariants preserved (reviewed + tested): one SYNC_META transaction, null when canonical (terminates), deterministic deriveFootnoteId, remote-skip -> no re-introduced freeze or divergence. - computeFootnoteNumbers ran per-NodeView-render (O(n^2)/keystroke in big docs). The numbering plugin now caches the number map in its state (computed once per docChanged); NodeViews read it O(1) via getFootnoteNumber. Tests: no-rebuild-on-reorder asserts unchanged definition node subtrees are identity-preserved; isRemoteTransaction skip; enableSync:false read-only; cache correctness. Browser re-smoke: insert (no freeze), number, persist across reload, cascade delete all pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
635 lines
28 KiB
TypeScript
635 lines
28 KiB
TypeScript
import { Plugin, PluginKey, Transaction } from "@tiptap/pm/state";
|
|
import { Node as ProseMirrorNode, Fragment, Slice } from "@tiptap/pm/model";
|
|
import {
|
|
FOOTNOTE_DEFINITION_NAME,
|
|
FOOTNOTE_REFERENCE_NAME,
|
|
FOOTNOTES_LIST_NAME,
|
|
deriveFootnoteId,
|
|
} from "./footnote-util";
|
|
|
|
export const footnoteSyncPluginKey = new PluginKey("footnoteSync");
|
|
|
|
const SYNC_META = "footnoteSyncApplied";
|
|
|
|
interface RefOccurrence {
|
|
/** Position of the reference node in the document. */
|
|
pos: number;
|
|
/** The id the reference currently carries. */
|
|
id: string;
|
|
node: ProseMirrorNode;
|
|
}
|
|
|
|
interface DefOccurrence {
|
|
/** Position of the definition node in the document. */
|
|
pos: number;
|
|
/** The id the definition currently carries. */
|
|
id: string;
|
|
node: ProseMirrorNode;
|
|
}
|
|
|
|
interface FootnoteScan {
|
|
/**
|
|
* Every reference occurrence in document order (NOT de-duplicated). Needed so
|
|
* that duplicate ids — which would otherwise be silently collapsed — can be
|
|
* detected and (together with their definitions) re-id'd instead of dropped.
|
|
*/
|
|
refOccurrences: RefOccurrence[];
|
|
/**
|
|
* Every definition occurrence in document order (NOT de-duplicated). The old
|
|
* implementation used a last-wins Map here, which is exactly what caused
|
|
* silent data loss: two definitions sharing an id collapsed to one.
|
|
*/
|
|
defOccurrences: DefOccurrence[];
|
|
/** Every top-level footnotesList node, in document order. */
|
|
lists: Array<{ pos: number; node: ProseMirrorNode }>;
|
|
}
|
|
|
|
function scan(doc: ProseMirrorNode): FootnoteScan {
|
|
const refOccurrences: RefOccurrence[] = [];
|
|
const defOccurrences: DefOccurrence[] = [];
|
|
const lists: Array<{ pos: number; node: ProseMirrorNode }> = [];
|
|
|
|
doc.descendants((node, pos) => {
|
|
if (node.type.name === FOOTNOTE_REFERENCE_NAME) {
|
|
const id = node.attrs.id;
|
|
if (id) refOccurrences.push({ pos, id, node });
|
|
}
|
|
if (node.type.name === FOOTNOTE_DEFINITION_NAME) {
|
|
const id = node.attrs.id;
|
|
if (id) defOccurrences.push({ pos, id, node });
|
|
}
|
|
if (node.type.name === FOOTNOTES_LIST_NAME) {
|
|
lists.push({ pos, node });
|
|
}
|
|
});
|
|
|
|
return { refOccurrences, defOccurrences, lists };
|
|
}
|
|
|
|
/**
|
|
* Result of resolving id collisions: a 1:1, de-duplicated pairing plan plus the
|
|
* concrete reference re-id edits that must be applied to the body so the doc no
|
|
* longer contains two footnotes sharing a single id.
|
|
*
|
|
* The overriding invariant is that NO definition is ever dropped here: every
|
|
* definition occurrence ends up with a unique id and therefore survives the
|
|
* canonical rebuild. Duplicate references are likewise re-id'd (and paired with
|
|
* a duplicate definition when one exists) so importing/pasting `[^d]` twice with
|
|
* two `[^d]:` definitions yields TWO distinct footnotes rather than one.
|
|
*/
|
|
interface CollisionPlan {
|
|
/**
|
|
* Reference ids in document order, de-duplicated AFTER re-id. This is the
|
|
* source of truth for definition order/numbering, exactly as before — only
|
|
* now collisions have been resolved so it no longer hides duplicates.
|
|
*/
|
|
referenceIds: string[];
|
|
/** id -> definition node, after duplicates were re-id'd. One entry per id. */
|
|
definitions: Map<string, ProseMirrorNode>;
|
|
/**
|
|
* Body reference re-id edits to apply (position of a reference node -> the
|
|
* fresh id it must carry). Empty when there are no colliding references.
|
|
*/
|
|
refReids: Array<{ pos: number; node: ProseMirrorNode; newId: string }>;
|
|
/** True when any collision required a re-id (refs and/or defs). */
|
|
changed: boolean;
|
|
}
|
|
|
|
/**
|
|
* Resolve duplicate-id collisions among references and definitions WITHOUT ever
|
|
* dropping a definition.
|
|
*
|
|
* Strategy:
|
|
* - Walk references in document order. The FIRST reference for an id keeps it.
|
|
* Any later reference sharing that id is a duplicate and gets a fresh unique
|
|
* id; if a still-unclaimed duplicate definition with the original id exists,
|
|
* it is re-id'd to the SAME fresh id so the (ref, def) pair stays matched.
|
|
* - Walk definitions in document order. The FIRST definition for an id keeps
|
|
* it; later duplicates that were not already claimed by a duplicate reference
|
|
* get their own fresh unique id (surviving as a distinct footnote/orphan).
|
|
*
|
|
* Re-id determinism: every fresh id is DERIVED from document state via
|
|
* deriveFootnoteId (e.g. `X__2`, `X__3`, collision-bumped against the set of ids
|
|
* already present) — NEVER random/time-based. Because the sync plugin runs
|
|
* identically on every collaborating client, a deterministic re-id is the only
|
|
* way they can converge on the SAME ids; a random id (the previous
|
|
* implementation) made two clients editing the same duplicate-id document mint
|
|
* DIFFERENT ids for the same duplicate, causing permanent Yjs divergence.
|
|
*/
|
|
function resolveCollisions(scan: FootnoteScan): CollisionPlan {
|
|
const definitions = new Map<string, ProseMirrorNode>();
|
|
const refReids: Array<{
|
|
pos: number;
|
|
node: ProseMirrorNode;
|
|
newId: string;
|
|
}> = [];
|
|
const referenceIds: string[] = [];
|
|
const seenRefIds = new Set<string>();
|
|
let changed = false;
|
|
|
|
// `taken` is the set of every id that must be avoided when minting a derived
|
|
// id: all original reference + definition ids in the document PLUS every id we
|
|
// mint during this pass. It is pure document state, so the derivation stays
|
|
// deterministic across clients. Per-original occurrence counters make the k-th
|
|
// duplicate of `X` deterministically become `X__2`, `X__3`, ...
|
|
const taken = new Set<string>();
|
|
for (const occ of scan.refOccurrences) taken.add(occ.id);
|
|
for (const occ of scan.defOccurrences) taken.add(occ.id);
|
|
const occurrenceOf = new Map<string, number>();
|
|
// Mint a deterministic unique id for a duplicate of `originalId`. The first
|
|
// duplicate is occurrence 2 (the keeper is occurrence 1), then 3, 4, ...
|
|
const mintId = (originalId: string): string => {
|
|
const next = (occurrenceOf.get(originalId) ?? 1) + 1;
|
|
occurrenceOf.set(originalId, next);
|
|
const id = deriveFootnoteId(originalId, next, taken);
|
|
taken.add(id);
|
|
return id;
|
|
};
|
|
|
|
// Bucket definition occurrences by their original id so a duplicate reference
|
|
// can claim a matching (as-yet-unclaimed) duplicate definition and re-id the
|
|
// pair together. defByOriginalId[id] is consumed front-to-back.
|
|
const defByOriginalId = new Map<string, DefOccurrence[]>();
|
|
for (const occ of scan.defOccurrences) {
|
|
const arr = defByOriginalId.get(occ.id);
|
|
if (arr) arr.push(occ);
|
|
else defByOriginalId.set(occ.id, [occ]);
|
|
}
|
|
// The FIRST definition for each id is the canonical keeper of that id.
|
|
const claimed = new Set<DefOccurrence>();
|
|
|
|
for (const ref of scan.refOccurrences) {
|
|
if (!seenRefIds.has(ref.id)) {
|
|
// First reference with this id keeps it.
|
|
seenRefIds.add(ref.id);
|
|
referenceIds.push(ref.id);
|
|
continue;
|
|
}
|
|
// Duplicate reference: assign a deterministic derived id. Pair it with the
|
|
// next unclaimed duplicate definition (NOT the first keeper) carrying the
|
|
// same original id, if one exists, so the (ref, def) pairing is preserved
|
|
// 1:1.
|
|
const newId = mintId(ref.id);
|
|
refReids.push({ pos: ref.pos, node: ref.node, newId });
|
|
seenRefIds.add(newId);
|
|
referenceIds.push(newId);
|
|
changed = true;
|
|
|
|
const candidates = defByOriginalId.get(ref.id) ?? [];
|
|
// Skip the first occurrence (it keeps the original id); pick the first
|
|
// duplicate not already claimed.
|
|
for (let i = 1; i < candidates.length; i++) {
|
|
const cand = candidates[i];
|
|
if (!claimed.has(cand)) {
|
|
claimed.add(cand);
|
|
definitions.set(newId, cand.node);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Now place every definition under a unique id. The first occurrence of each
|
|
// original id keeps it; remaining duplicates either were paired with a
|
|
// duplicate reference above (already placed) or get a fresh standalone id.
|
|
const seenDefIds = new Set<string>();
|
|
for (const occ of scan.defOccurrences) {
|
|
if (claimed.has(occ)) continue; // already placed against a duplicate ref id
|
|
if (!seenDefIds.has(occ.id)) {
|
|
seenDefIds.add(occ.id);
|
|
definitions.set(occ.id, occ.node);
|
|
} else {
|
|
// Duplicate definition with no duplicate reference to pair with: keep it
|
|
// with a deterministic derived id so it is NEVER silently dropped. (It
|
|
// becomes an orphan and is then subject to the normal orphan policy — but
|
|
// only ever because it has no matching reference, never because it
|
|
// collided.)
|
|
const newId = mintId(occ.id);
|
|
definitions.set(newId, occ.node);
|
|
changed = true;
|
|
}
|
|
}
|
|
|
|
return { referenceIds, definitions, refReids, changed };
|
|
}
|
|
|
|
/**
|
|
* Idempotent integrity pass for footnotes. Runs only on LOCAL document changes
|
|
* (skips remote/collaboration steps and — crucially — its own appended meta) so
|
|
* the plugin can never re-trigger itself, guaranteeing termination.
|
|
*
|
|
* Everything is computed against the CURRENT document in a SINGLE invocation and
|
|
* emitted as AT MOST ONE transaction, always tagged with SYNC_META (and
|
|
* addToHistory:false). The strategy is "rebuild the canonical footnotes section
|
|
* from the desired end-state" rather than running several self-triggering
|
|
* passes:
|
|
*
|
|
* 1. Collect every footnote reference id in document order (the source of
|
|
* truth for which definitions must exist and in what order).
|
|
* 2. Compute the desired list of definitions: one per referenced id, in
|
|
* reference order, reusing the existing definition node when present or
|
|
* creating an empty one when missing. Orphan definitions (no matching
|
|
* reference) are dropped.
|
|
* 3. Compare against the actual footnotesList state:
|
|
* - no references -> there must be NO list (remove any);
|
|
* - references present -> there must be exactly ONE list, holding
|
|
* exactly the desired definitions, and it
|
|
* must sit after all real body content.
|
|
* 4. If the document already matches the desired end-state, return null (no
|
|
* transaction) — this idempotence is what stops oscillation.
|
|
*
|
|
* Placement note: the list is considered correctly placed when nothing but
|
|
* EMPTY paragraphs follow it. This is deliberate so the plugin coexists with a
|
|
* trailing-node plugin (which keeps an empty paragraph at the very end of the
|
|
* doc): the footnote list does not need to be the literal last child, only the
|
|
* last block of meaningful content. Without this, the two plugins would
|
|
* ping-pong forever (list moved to end -> trailing paragraph appended -> list
|
|
* no longer last -> moved again ...).
|
|
*
|
|
* Duplicate-id collisions (two references and/or two definitions sharing one
|
|
* id — produced by importing `[^d]: a` / `[^d]: b`, or by pasting/duplicating a
|
|
* reference+definition pair) are resolved up front by resolveCollisions(): the
|
|
* duplicates are re-id'd to fresh unique ids so BOTH survive as distinct
|
|
* footnotes. This guarantees the overriding invariant — no footnoteDefinition is
|
|
* ever silently deleted by this automatic (addToHistory:false) transaction. A
|
|
* definition is only ever removed when it has NO matching reference (orphan
|
|
* policy), never because its id collided with another.
|
|
*/
|
|
export function footnoteSyncPlugin(
|
|
isRemoteTransaction?: (tr: Transaction) => boolean,
|
|
): Plugin {
|
|
return new Plugin({
|
|
key: footnoteSyncPluginKey,
|
|
appendTransaction(transactions, _oldState, newState) {
|
|
// Only react to document changes.
|
|
if (!transactions.some((t) => t.docChanged)) return null;
|
|
// Skip our OWN appended transaction. This is the guard that makes the
|
|
// plugin loop-safe: the transaction we emit carries SYNC_META, so when
|
|
// ProseMirror feeds it back to appendTransaction we bail out immediately
|
|
// and never produce a follow-up. (Termination invariant.)
|
|
if (transactions.some((t) => t.getMeta(SYNC_META))) return null;
|
|
// Skip remote/collab steps (orphan cleanup must run only on local edits).
|
|
if (
|
|
isRemoteTransaction &&
|
|
transactions.some((t) => isRemoteTransaction(t))
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
const { doc, schema } = newState;
|
|
const defType = schema.nodes[FOOTNOTE_DEFINITION_NAME];
|
|
const listType = schema.nodes[FOOTNOTES_LIST_NAME];
|
|
const paragraphType = schema.nodes.paragraph;
|
|
if (!defType || !listType || !paragraphType) return null;
|
|
|
|
const info = scan(doc);
|
|
|
|
// 0) Resolve duplicate-id collisions (two references and/or two
|
|
// definitions sharing one id) by re-id'ing duplicates to fresh unique
|
|
// ids. This is the critical defense: the old last-wins Map silently
|
|
// dropped all but the last definition for a shared id; here EVERY
|
|
// definition survives with a unique id, and duplicate references are
|
|
// paired with duplicate definitions so two same-id imports/pastes yield
|
|
// two distinct footnotes instead of one.
|
|
const plan = resolveCollisions(info);
|
|
const referenceIds = plan.referenceIds;
|
|
|
|
// The set of ids that must have a definition, in reference order (after
|
|
// collision re-id). De-duplicated already by resolveCollisions.
|
|
const referenceIdSet = new Set(referenceIds);
|
|
|
|
// 1) For each definition occurrence, compute the id it should END UP with
|
|
// (which differs from its current id only when collision resolution
|
|
// re-id'd it). plan.definitions maps a FINAL id -> the chosen node, so
|
|
// we invert it by node identity to recover each occurrence's target id.
|
|
const finalIdByNode = new Map<ProseMirrorNode, string>();
|
|
for (const [id, node] of plan.definitions) finalIdByNode.set(node, id);
|
|
|
|
const isEmptyParagraph = (node: ProseMirrorNode) =>
|
|
node.type === paragraphType && node.content.size === 0;
|
|
|
|
// 2) Classify every existing definition occurrence:
|
|
// - reId: keep the node in place, only change its id attr (collision).
|
|
// - orphan: delete it (its final id has no matching reference).
|
|
// A definition that already carries the right id and is referenced is
|
|
// left COMPLETELY untouched (its Yjs subtree is preserved). This is the
|
|
// core of the data-loss fix: a pure reference reorder produces NO
|
|
// mutation of any definition subtree.
|
|
interface DefReid {
|
|
pos: number;
|
|
node: ProseMirrorNode;
|
|
newId: string;
|
|
}
|
|
const defReids: DefReid[] = [];
|
|
const orphanDefs: DefOccurrence[] = [];
|
|
// Track which referenced ids already have a surviving (non-orphan)
|
|
// definition, so we can synthesize the genuinely missing ones.
|
|
const satisfiedIds = new Set<string>();
|
|
// Choose a "primary" list to receive inserts/migrated defs: the LAST list
|
|
// whose placement is canonical (only empty paragraphs follow it), else the
|
|
// last list, else none. New defs and consolidated defs land here.
|
|
for (const occ of info.defOccurrences) {
|
|
const finalId = finalIdByNode.get(occ.node) ?? occ.id;
|
|
if (!referenceIdSet.has(finalId)) {
|
|
orphanDefs.push(occ);
|
|
continue;
|
|
}
|
|
if (occ.id !== finalId) {
|
|
defReids.push({ pos: occ.pos, node: occ.node, newId: finalId });
|
|
}
|
|
satisfiedIds.add(finalId);
|
|
}
|
|
|
|
// 3) Referenced ids with no surviving definition need a fresh empty one.
|
|
const missingIds = referenceIds.filter((id) => !satisfiedIds.has(id));
|
|
|
|
// 4) Determine list topology.
|
|
const hasRefs = referenceIds.length > 0;
|
|
|
|
// Pick the primary list: prefer the last canonically-placed list.
|
|
const listIsTrailing = (listPos: number, listNode: ProseMirrorNode) => {
|
|
const listEnd = listPos + listNode.nodeSize;
|
|
let ok = true;
|
|
doc.nodesBetween(listEnd, doc.content.size, (child, childPos) => {
|
|
if (childPos >= listEnd && child !== listNode) {
|
|
if (!isEmptyParagraph(child)) ok = false;
|
|
}
|
|
return false; // do not descend
|
|
});
|
|
return ok;
|
|
};
|
|
let primaryList: { pos: number; node: ProseMirrorNode } | null = null;
|
|
for (let i = info.lists.length - 1; i >= 0; i--) {
|
|
if (listIsTrailing(info.lists[i].pos, info.lists[i].node)) {
|
|
primaryList = info.lists[i];
|
|
break;
|
|
}
|
|
}
|
|
if (!primaryList && info.lists.length > 0) {
|
|
primaryList = info.lists[info.lists.length - 1];
|
|
}
|
|
// Extra lists (everything except the primary) must be consolidated away.
|
|
const extraLists = info.lists.filter((l) => l !== primaryList);
|
|
const inExtraList = (pos: number) =>
|
|
extraLists.some((l) => pos > l.pos && pos < l.pos + l.node.nodeSize);
|
|
|
|
// Definitions inside an extra list are migrated (recreated with the right
|
|
// id) into the primary list, so drop their in-place re-id markups — the
|
|
// whole extra list is deleted below and the markup would be wasted.
|
|
const defReidsToApply = defReids.filter((r) => !inExtraList(r.pos));
|
|
|
|
// 5) Decide whether anything must change. The document is canonical when:
|
|
// - no collisions were resolved (refs or defs), AND
|
|
// - no orphan definitions, AND
|
|
// - no missing definitions, AND
|
|
// - exactly the right number of lists (0 when no refs, else 1) AND the
|
|
// single list is canonically placed (trailing).
|
|
const noChangeNeeded =
|
|
!plan.changed &&
|
|
defReids.length === 0 &&
|
|
orphanDefs.length === 0 &&
|
|
missingIds.length === 0 &&
|
|
extraLists.length === 0 &&
|
|
(hasRefs
|
|
? info.lists.length === 1 && primaryList !== null
|
|
: info.lists.length === 0);
|
|
|
|
if (noChangeNeeded) return null;
|
|
|
|
// 6) Apply the targeted, minimal mutations in ONE transaction. We never
|
|
// delete-and-recreate an unchanged definition subtree; we only:
|
|
// (a) re-id specific colliding references and definitions (attr-only),
|
|
// (b) delete genuine orphan definitions and extra/empty lists,
|
|
// (c) insert genuinely-missing empty definitions and migrate defs out
|
|
// of extra lists into the primary list,
|
|
// (d) create the primary list if references exist but none does yet.
|
|
const tr = newState.tr;
|
|
|
|
// 6a) Re-id colliding references (inline atoms: attr-only, size-stable).
|
|
for (const reid of plan.refReids) {
|
|
tr.setNodeMarkup(tr.mapping.map(reid.pos), undefined, {
|
|
...reid.node.attrs,
|
|
id: reid.newId,
|
|
});
|
|
}
|
|
// 6b) Re-id colliding definitions IN PLACE (attr-only). This preserves the
|
|
// definition's content subtree — never delete+recreate it.
|
|
for (const reid of defReidsToApply) {
|
|
tr.setNodeMarkup(tr.mapping.map(reid.pos), undefined, {
|
|
...reid.node.attrs,
|
|
id: reid.newId,
|
|
});
|
|
}
|
|
|
|
// 6c) Migrate non-orphan definitions out of every extra list into the
|
|
// primary list (or, if there is no primary list, into a new one we
|
|
// build), then delete the extra (now drained) lists. This is the only
|
|
// path that moves a definition subtree, and it runs ONLY in the
|
|
// abnormal multi-list case (paste/collab merge) — never on a plain
|
|
// reorder, which keeps a single list untouched.
|
|
const migrated: ProseMirrorNode[] = [];
|
|
for (const extra of extraLists) {
|
|
extra.node.forEach((defChild) => {
|
|
if (defChild.type !== defType) return;
|
|
const finalId = finalIdByNode.get(defChild) ?? defChild.attrs.id;
|
|
if (!referenceIdSet.has(finalId)) return; // orphan: drop it
|
|
migrated.push(
|
|
defChild.attrs.id === finalId
|
|
? defChild
|
|
: defType.create({ id: finalId }, defChild.content),
|
|
);
|
|
});
|
|
}
|
|
|
|
// 6c-bis) The definitions to INSERT into the primary list: migrated defs
|
|
// from extra lists + freshly synthesized empty defs for references
|
|
// that have no definition at all. Computed before deletions so we can
|
|
// decide whether the primary list would be left empty.
|
|
const toInsert: ProseMirrorNode[] = [
|
|
...migrated,
|
|
...missingIds.map((id) =>
|
|
defType.create({ id }, paragraphType.create()),
|
|
),
|
|
];
|
|
|
|
// Does the primary list keep at least one definition after we strip its
|
|
// orphans AND counting the defs we are about to insert? If it ends up
|
|
// empty (an empty footnotesList is invalid schema), delete the WHOLE list
|
|
// instead of leaving a hollow shell. Only the primary list can receive
|
|
// inserts; extra lists are always deleted wholesale.
|
|
let primarySurvivors = 0;
|
|
if (primaryList) {
|
|
primaryList.node.forEach((defChild) => {
|
|
if (defChild.type !== defType) return;
|
|
const finalId = finalIdByNode.get(defChild) ?? defChild.attrs.id;
|
|
if (referenceIdSet.has(finalId)) primarySurvivors += 1;
|
|
});
|
|
}
|
|
const primaryWillBeEmpty =
|
|
!!primaryList && primarySurvivors === 0 && toInsert.length === 0;
|
|
|
|
// 6d) Delete orphan definitions, extra lists, and any list that would be
|
|
// left empty. Sort deletions from the end so earlier positions stay
|
|
// valid; map through tr.mapping to account for the (size-stable) re-id
|
|
// markups and earlier deletions.
|
|
const deletions: Array<{ from: number; to: number }> = [];
|
|
const wholeListDeletes = new Set(extraLists);
|
|
if (primaryWillBeEmpty && primaryList) wholeListDeletes.add(primaryList);
|
|
|
|
for (const occ of orphanDefs) {
|
|
// Skip orphans inside a list that is being deleted wholesale.
|
|
const inWholeDeleted = [...wholeListDeletes].some(
|
|
(l) => occ.pos > l.pos && occ.pos < l.pos + l.node.nodeSize,
|
|
);
|
|
if (inWholeDeleted) continue;
|
|
deletions.push({ from: occ.pos, to: occ.pos + occ.node.nodeSize });
|
|
}
|
|
for (const l of wholeListDeletes) {
|
|
deletions.push({ from: l.pos, to: l.pos + l.node.nodeSize });
|
|
}
|
|
deletions
|
|
.sort((a, b) => b.from - a.from)
|
|
.forEach(({ from, to }) => {
|
|
tr.delete(tr.mapping.map(from), tr.mapping.map(to));
|
|
});
|
|
|
|
// If we deleted the primary list wholesale, it can no longer receive the
|
|
// inserts below — null it out so a fresh list is created when needed.
|
|
if (primaryWillBeEmpty) primaryList = null;
|
|
|
|
// 6e) Insert the migrated + synthesized definitions.
|
|
if (hasRefs) {
|
|
if (primaryList) {
|
|
if (toInsert.length > 0) {
|
|
// Append at the end of the (mapped) primary list, just before its
|
|
// closing token, so its existing definition subtrees are untouched.
|
|
// We only changed attrs (size-stable) and deleted OTHER nodes, so
|
|
// mapping the original list-end position forward lands at the same
|
|
// boundary; -1 puts us just inside the list's closing token.
|
|
const insertAt =
|
|
tr.mapping.map(primaryList.pos + primaryList.node.nodeSize) - 1;
|
|
tr.insert(insertAt, Fragment.fromArray(toInsert));
|
|
}
|
|
} else {
|
|
// No usable list exists yet but references do — create one holding the
|
|
// migrated + synthesized definitions, placed after the last meaningful
|
|
// (non-empty-paragraph) top-level block so it sits before any trailing
|
|
// empty paragraph the trailing-node plugin maintains.
|
|
const mappedDoc = tr.doc;
|
|
let insertPos = mappedDoc.content.size;
|
|
for (let i = mappedDoc.childCount - 1; i >= 0; i--) {
|
|
const child = mappedDoc.child(i);
|
|
if (isEmptyParagraph(child)) insertPos -= child.nodeSize;
|
|
else break;
|
|
}
|
|
const list = listType.create(null, Fragment.fromArray(toInsert));
|
|
tr.insert(insertPos, list);
|
|
}
|
|
}
|
|
|
|
if (!tr.docChanged) return null;
|
|
|
|
tr.setMeta(SYNC_META, true);
|
|
tr.setMeta("addToHistory", false);
|
|
return tr;
|
|
},
|
|
});
|
|
}
|
|
|
|
export const footnotePastePluginKey = new PluginKey("footnotePaste");
|
|
|
|
/**
|
|
* Paste id-collision guard. When pasted content carries footnote reference or
|
|
* definition ids that ALREADY EXIST in the current document, regenerate those
|
|
* ids (consistently across the pasted slice, so a pasted reference and its
|
|
* definition keep pointing at each other) BEFORE the slice is inserted.
|
|
*
|
|
* Without this, pasting a reference+definition pair copied from elsewhere — or
|
|
* duplicating one in place — would merge with (or clobber) the existing footnote
|
|
* of the same id. The schema-sync plugin already guarantees no definition is
|
|
* ever silently deleted after the fact (it re-id's collisions), but regenerating
|
|
* at paste time keeps the pasted footnote cleanly separate from the start and
|
|
* avoids any transient merge.
|
|
*
|
|
* Only COLLIDING ids are remapped: a self-paste of a lone reference whose id is
|
|
* not present elsewhere is left untouched (so it still resolves to its existing
|
|
* definition).
|
|
*/
|
|
export function footnotePastePlugin(): Plugin {
|
|
return new Plugin({
|
|
key: footnotePastePluginKey,
|
|
props: {
|
|
transformPasted(slice, view) {
|
|
// Collect ids already present in the current document.
|
|
const existing = new Set<string>();
|
|
view.state.doc.descendants((node) => {
|
|
if (
|
|
node.type.name === FOOTNOTE_REFERENCE_NAME ||
|
|
node.type.name === FOOTNOTE_DEFINITION_NAME
|
|
) {
|
|
const id = node.attrs.id;
|
|
if (id) existing.add(id);
|
|
}
|
|
});
|
|
if (existing.size === 0) return slice;
|
|
|
|
// Build a remap (old id -> fresh id) for every COLLIDING id found in the
|
|
// pasted slice, shared by references and definitions so a pasted pair
|
|
// stays matched. A paste is a distinct local user action (not a
|
|
// shared-state convergence point), so determinism is not strictly
|
|
// required here — but we derive the new id deterministically anyway
|
|
// (deriveFootnoteId against the current doc's id set) for consistency
|
|
// with the sync/import paths and to keep Math.random off this code path.
|
|
const remap = new Map<string, string>();
|
|
const collectColliding = (node: ProseMirrorNode) => {
|
|
if (
|
|
node.type.name === FOOTNOTE_REFERENCE_NAME ||
|
|
node.type.name === FOOTNOTE_DEFINITION_NAME
|
|
) {
|
|
const id = node.attrs.id;
|
|
if (id && existing.has(id) && !remap.has(id)) {
|
|
const newId = deriveFootnoteId(id, 2, existing);
|
|
remap.set(id, newId);
|
|
// Reserve it so a second colliding id deriving to the same base
|
|
// bumps instead of clashing.
|
|
existing.add(newId);
|
|
}
|
|
}
|
|
node.descendants(collectColliding);
|
|
};
|
|
slice.content.descendants(collectColliding);
|
|
if (remap.size === 0) return slice;
|
|
|
|
// Rewrite the colliding ids throughout the slice.
|
|
const rewrite = (fragment: Fragment): Fragment => {
|
|
const nodes: ProseMirrorNode[] = [];
|
|
fragment.forEach((node) => {
|
|
const isFootnote =
|
|
node.type.name === FOOTNOTE_REFERENCE_NAME ||
|
|
node.type.name === FOOTNOTE_DEFINITION_NAME;
|
|
const newId = isFootnote ? remap.get(node.attrs.id) : undefined;
|
|
const newContent = node.content.size
|
|
? rewrite(node.content)
|
|
: node.content;
|
|
if (newId) {
|
|
nodes.push(
|
|
node.type.create(
|
|
{ ...node.attrs, id: newId },
|
|
newContent,
|
|
node.marks,
|
|
),
|
|
);
|
|
} else if (newContent !== node.content) {
|
|
nodes.push(node.copy(newContent));
|
|
} else {
|
|
nodes.push(node);
|
|
}
|
|
});
|
|
return Fragment.fromArray(nodes);
|
|
};
|
|
|
|
return new Slice(rewrite(slice.content), slice.openStart, slice.openEnd);
|
|
},
|
|
},
|
|
});
|
|
}
|