@portone/docx-editor 0.6.0 → 0.6.2

package/dist/editor/notes/noteSurface.js

@@ -0,0 +1,246 @@
+// src/editor/notes/noteSurface.ts
+import { keymap } from "prosemirror-keymap";
+import {
+  DOMSerializer,
+  Mark
+} from "prosemirror-model";
+import { Plugin, TextSelection } from "prosemirror-state";
+import { NOTE_NUMBER_ELEMENTS } from "../../docx/notes/newNote.js";
+import { docxSchema } from "../../schema/index.js";
+import { editShut, transactionAllowed } from "../../schema/guards.js";
+import { editsShut } from "../../schema/protectionState.js";
+import { noteKeyOf } from "../../schema/stories.js";
+import { editorClassNames } from "../../styles/classNames.js";
+import {
+  detachAnchors,
+  dropSourceIdentity,
+  mapSliceNodes,
+  rederiveDisplay,
+  rekeyNumbering
+} from "../clipboard/normalizers.js";
+import { redo, undo } from "../commands/historyCommands.js";
+import { noteBodyCommand } from "../commands/noteCommands.js";
+import { onMac } from "../plugins/keymap.js";
+import { noteReferenceAt } from "../plugins/noteNavigation.js";
+import {
+  NO_CAPABILITY
+} from "../stories/storyView.js";
+function isOwnMark(node) {
+  const element = node.attrs.element;
+  return node.type === docxSchema.nodes.rawRunContent && typeof element === "string" && NOTE_NUMBER_ELEMENTS.includes(element);
+}
+function drawnBySchema(node) {
+  return docxSchema.nodes.rawRunContent.spec.toDOM?.(node) ?? ["span"];
+}
+function markSpec(node, labelOf) {
+  return isOwnMark(node) ? ["sup", { class: editorClassNames.noteMark }, labelOf()] : drawnBySchema(node);
+}
+function noteNodeSpecs(labelOf) {
+  return { rawRunContent: (node) => markSpec(node, labelOf) };
+}
+function noteMarkView(labelOf, back) {
+  return (node) => {
+    const { dom } = DOMSerializer.renderSpec(document, markSpec(node, labelOf));
+    if (isOwnMark(node) && dom instanceof HTMLElement) {
+      dom.addEventListener("mousedown", (event) => {
+        event.preventDefault();
+        back();
+      });
+    }
+    return { dom };
+  };
+}
+var dropUnwritableContent = (slice) => mapSliceNodes(slice, (node) => {
+  if (node.type === docxSchema.nodes.image) return null;
+  const marks = node.marks.filter(
+    (mark) => mark.type !== docxSchema.marks.link
+  );
+  return Mark.sameSet(marks, node.marks) ? node : node.mark(marks);
+});
+var dropNoteReferences = (slice, { move }) => move ? slice : mapSliceNodes(
+  slice,
+  (node) => node.type === docxSchema.nodes.noteReference ? null : node
+);
+var NOTE_TAKES = NO_CAPABILITY;
+var NOTE_NORMALIZERS = [
+  dropSourceIdentity,
+  detachAnchors,
+  dropNoteReferences,
+  dropUnwritableContent,
+  rekeyNumbering,
+  rederiveDisplay
+];
+function runOn(main, command) {
+  return command(main.state, (tr) => main.dispatch(tr), main);
+}
+function referenceOf(main, key) {
+  const note = noteKeyOf(key);
+  return note === null ? null : noteReferenceAt(main.state.doc, note.kind, note.id);
+}
+function returnToReference(main, key) {
+  const found = referenceOf(main, key);
+  if (found !== null) {
+    const after = found.pos + found.node.nodeSize;
+    main.dispatch(
+      main.state.tr.setSelection(TextSelection.near(main.state.doc.resolve(after))).scrollIntoView()
+    );
+  }
+  main.focus();
+}
+function leadingChipSize(story) {
+  const first = story.firstChild?.firstChild ?? null;
+  return first !== null && isOwnMark(first) ? first.nodeSize : 0;
+}
+function ownMarkIn(story) {
+  let found = null;
+  story.descendants((node, pos) => {
+    if (found === null && isOwnMark(node)) found = { pos, node };
+    return found === null;
+  });
+  return found;
+}
+function caretFloor(story) {
+  const held = ownMarkIn(story);
+  return held === null || held.pos !== markHome(story) ? null : held.pos + held.node.nodeSize;
+}
+function markHome(story) {
+  const type = docxSchema.nodes.rawRunContent;
+  let at = null;
+  story.descendants((node, pos) => {
+    if (at !== null) return false;
+    if (!node.isTextblock) return true;
+    if (node.type.contentMatch.matchType(type) !== null) at = pos + 1;
+    return false;
+  });
+  return at;
+}
+function pressesTowardsTheNumber() {
+  return [
+    "ArrowLeft",
+    "ArrowUp",
+    "Home",
+    "PageUp",
+    "Mod-ArrowLeft",
+    "Mod-ArrowUp",
+    "Mod-Home",
+    ...onMac() ? ["Ctrl-a"] : []
+  ];
+}
+function holdAtTheNumber(extend) {
+  return (state, dispatch) => {
+    const floor = caretFloor(state.doc);
+    const home = markHome(state.doc);
+    if (floor === null || home === null) return false;
+    const { selection } = state;
+    if (extend ? selection.head > home : selection.from > floor) return false;
+    if (dispatch && !extend) {
+      dispatch(state.tr.setSelection(TextSelection.create(state.doc, floor)));
+    }
+    return true;
+  };
+}
+function keysOffTheNumber() {
+  return Object.fromEntries(
+    pressesTowardsTheNumber().flatMap((press) => [
+      [press, holdAtTheNumber(false)],
+      [`Shift-${press}`, holdAtTheNumber(true)]
+    ])
+  );
+}
+function ownMarkFirst() {
+  return new Plugin({
+    appendTransaction(transactions, oldState, newState) {
+      const tr = newState.tr;
+      const home = markHome(newState.doc);
+      if (transactions.some((changed) => changed.docChanged) && home !== null) {
+        const held = ownMarkIn(newState.doc);
+        const lost = ownMarkIn(oldState.doc);
+        if (held === null) {
+          if (lost !== null) tr.insert(home, lost.node);
+        } else if (held.pos !== home) {
+          tr.delete(held.pos, held.pos + held.node.nodeSize).insert(
+            home,
+            held.node
+          );
+        }
+      }
+      const floor = caretFloor(tr.doc);
+      if (floor !== null && tr.selection.empty && tr.selection.from < floor) {
+        tr.setSelection(
+          TextSelection.create(tr.doc, Math.min(floor, tr.doc.content.size))
+        );
+      }
+      return tr.docChanged || tr.selectionSet ? tr : null;
+    }
+  });
+}
+function holdsNothing(story) {
+  const only = story.childCount === 1 ? story.firstChild : null;
+  return only !== null && only.type === docxSchema.nodes.paragraph && only.content.size === leadingChipSize(story);
+}
+function deleteEmptyNote(main, key) {
+  return (state, dispatch) => {
+    if (!state.selection.empty) return false;
+    if (!holdsNothing(state.doc)) return false;
+    const $at = state.selection.$from;
+    if ($at.index(0) !== 0 || $at.parentOffset > leadingChipSize(state.doc)) {
+      return false;
+    }
+    const found = referenceOf(main, key);
+    if (found === null) return false;
+    const tr = main.state.tr.delete(found.pos, found.pos + found.node.nodeSize);
+    if (!transactionAllowed(tr, main.state)) return false;
+    if (dispatch) {
+      main.dispatch(
+        tr.setSelection(TextSelection.near(tr.doc.resolve(found.pos))).scrollIntoView()
+      );
+      main.focus();
+    }
+    return true;
+  };
+}
+function noteHost(main, activate) {
+  return {
+    state: () => main.state,
+    write(key, story) {
+      const note = noteKeyOf(key);
+      return note !== null && runOn(main, noteBodyCommand(note.kind, note.id, story));
+    },
+    undo: () => runOn(main, undo),
+    redo: () => runOn(main, redo),
+    leave: (key) => returnToReference(main, key),
+    shut(key) {
+      if (editsShut(main.state)) return true;
+      const found = referenceOf(main, key);
+      if (found === null) return true;
+      return editShut(main.state, {
+        kind: "replace",
+        from: found.pos,
+        to: found.pos + found.node.nodeSize
+      });
+    },
+    activate
+  };
+}
+function noteExtensions(main, key, labelOf) {
+  return {
+    plugins: [
+      ownMarkFirst(),
+      keymap(keysOffTheNumber()),
+      keymap({ Backspace: deleteEmptyNote(main, key) })
+    ],
+    nodeViews: {
+      rawRunContent: noteMarkView(labelOf, () => returnToReference(main, key))
+    },
+    normalizers: NOTE_NORMALIZERS,
+    takes: NOTE_TAKES
+  };
+}
+export {
+  dropNoteReferences,
+  dropUnwritableContent,
+  noteExtensions,
+  noteHost,
+  noteNodeSpecs,
+  returnToReference
+};

package/dist/editor/plugins/compositionSelection.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Takes the selected text away before a composition opens over it.
+ *
+ * A composition normally replaces what is selected because the browser does the replacing and
+ * ProseMirror reads the result back. Chrome will not touch a selection that begins at an element
+ * it may not edit - the number a note is drawn by, a note reference - and does not say so: the
+ * composition lands beside the words it was meant to replace, or nothing happens at all. A note
+ * meets it every time, since its first paragraph opens with its number and selecting the whole of
+ * a note to write it again is an ordinary thing to do.
+ *
+ * So the selection is deleted here, in the frame the composition opens in and before ProseMirror
+ * marks the view as composing, which leaves the composition starting from a caret with nothing
+ * for the browser to refuse. ProseMirror does the same for a selection spanning whole blocks
+ * (`endComposition`).
+ *
+ * The deletion is an edit like any other, so the guards judge it: across a bookmark marker it is
+ * refused, and the composition is left to the browser where it stood.
+ */
+import { Plugin } from "prosemirror-state";
+export declare function compositionSelection(): Plugin;

package/dist/editor/plugins/compositionSelection.js

@@ -0,0 +1,19 @@
+// src/editor/plugins/compositionSelection.ts
+import { deleteSelection } from "prosemirror-commands";
+import { Plugin } from "prosemirror-state";
+function compositionSelection() {
+  return new Plugin({
+    props: {
+      handleDOMEvents: {
+        compositionstart(view) {
+          if (view.state.selection.empty) return false;
+          deleteSelection(view.state, (tr) => view.dispatch(tr));
+          return false;
+        }
+      }
+    }
+  });
+}
+export {
+  compositionSelection
+};

package/dist/editor/plugins/keymap.d.ts

@@ -2,6 +2,7 @@
  * Keys not handled here are taken by ProseMirror's base keymap.
  */
 import { type Command, Plugin } from "prosemirror-state";
+import type { NoteKind } from "../../schema/stories";
 /**
  * Keeps undo and redo on their keys where the keymap above cannot reach them.
  *
@@ -12,4 +13,17 @@ import { type Command, Plugin } from "prosemirror-state";
  * second time.
  */
 export declare function historyKeys(): Plugin;
+/**
+ * Whether the editor is running on a Mac, which decides the Mod key and what the system takes
+ * before a page sees it.
+ */
+export declare function onMac(): boolean;
+/**
+ * The key each kind of note is put in on.
+ *
+ * They are Word's own, except that Word for Windows' endnote key is the system's on a Mac:
+ * Cmd+Option+D hides the Dock, so the editor is never asked about it, and Word for Mac puts an
+ * endnote on Cmd+Option+E. The footnote key is the same on both, which is Google Docs' as well.
+ */
+export declare const NOTE_KEYS: Readonly<Record<NoteKind, string>>;
 export declare const docxKeymap: Record<string, Command>;

package/dist/editor/plugins/keymap.js

@@ -22,6 +22,7 @@ import {
   increaseListLevel,
   leaveEmptyListItem
 } from "../commands/listCommands.js";
+import { insertEndnote, insertFootnote } from "../commands/noteCommands.js";
 import { insertTab, moveAcrossTab } from "../commands/tabCommands.js";
 import { openLinkPanel } from "./linkPanel.js";
 var insertTabFromKeyboard = (state, dispatch, view) => {
@@ -91,6 +92,13 @@ function historyKeys() {
     }
   });
 }
+function onMac() {
+  return typeof navigator !== "undefined" && navigator.platform.includes("Mac");
+}
+var NOTE_KEYS = {
+  footnote: "Mod-Alt-f",
+  endnote: onMac() ? "Mod-Alt-e" : "Mod-Alt-d"
+};
 var docxKeymap = {
   Enter: chainCommands(leaveEmptyListItem, splitParagraph),
   "Shift-Enter": insertLineBreak,
@@ -107,6 +115,8 @@ var docxKeymap = {
   // The link key Word and Google Docs share. It opens the panel over the selection, and with
   // nothing there to link it reports that it did nothing, so the browser keeps its own Cmd+K
   "Mod-k": openLinkPanel,
+  [NOTE_KEYS.footnote]: insertFootnote,
+  [NOTE_KEYS.endnote]: insertEndnote,
   // Inside a table, moving between cells comes first (Word does the same).
   // In a list paragraph outside a table it shifts the level; an ordinary paragraph gets a document tab.
   Tab: chainCommands(
@@ -124,6 +134,8 @@ var docxKeymap = {
   "Shift-ArrowRight": moveAcrossTab("right", true)
 };
 export {
+  NOTE_KEYS,
   docxKeymap,
-  historyKeys
+  historyKeys,
+  onMac
 };

package/dist/editor/plugins/noteLifecycle.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Keeps each note of an editable kind in step with the references that call it.
+ *
+ * A note is written once and called from the text by its id, so what an edit does to the text
+ * decides what becomes of the note. An edit that takes away the last reference to a note takes the
+ * note away with it. An edit that copies a reference gives the copy a new id and a copy of the
+ * note, since two references naming one id are one note drawn with one number where the reader
+ * made two. A reference moved whole keeps its id and its note. Either change goes in a transaction
+ * appended to the edit, so it lands in the edit's history event and one undo takes both back.
+ *
+ * Only what the edit did is read. An entry the file arrived with and no reference to is never
+ * reached, a reference naming no note is left naming none, and the separators a notes part lays
+ * the page out with are left as they are. The notes part writer relies on the first of these: a
+ * note disappears only together with its last reference (`docx/storyParts`).
+ */
+import { Plugin } from "prosemirror-state";
+import { type NoteKind } from "../../schema/stories";
+export declare function noteLifecycle(kinds?: readonly NoteKind[]): Plugin;

package/dist/editor/plugins/noteLifecycle.js

@@ -0,0 +1,117 @@
+// src/editor/plugins/noteLifecycle.ts
+import { Plugin } from "prosemirror-state";
+import { DocAttrStep, Mapping } from "prosemirror-transform";
+import {
+  copiedNoteStory,
+  nextNoteId,
+  takenNoteIds
+} from "../../docx/notes/newNote.js";
+import { setStory, withoutStories } from "../../docx/story.js";
+import { displayOnly } from "../../schema/displayDerivation.js";
+import { stepReaches } from "../../schema/guards.js";
+import {
+  EDITABLE_NOTE_KINDS,
+  storyKey,
+  storyNodeOf
+} from "../../schema/stories.js";
+import { documentOf } from "../editorDocument.js";
+function kindOf(node, kinds) {
+  if (node.type.name !== "noteReference") return null;
+  return kinds.find((kind) => kind === node.attrs.kind) ?? null;
+}
+function referencesIn(doc, kinds) {
+  const found = [];
+  doc.descendants((node, pos) => {
+    const kind = kindOf(node, kinds);
+    const id = node.attrs.id;
+    if (kind !== null && typeof id === "string") {
+      found.push({ kind, key: storyKey(kind, id), pos });
+    }
+    return true;
+  });
+  return found;
+}
+function countsOf(references) {
+  return references.reduce(
+    (counts, { key }) => counts.set(key, (counts.get(key) ?? 0) + 1),
+    /* @__PURE__ */ new Map()
+  );
+}
+function reachesReferences(tr, kinds) {
+  if (!tr.docChanged || tr.getMeta(displayOnly) === true) return false;
+  return tr.steps.some(
+    (step, index) => !(step instanceof DocAttrStep) && stepReaches(
+      step,
+      tr.docs[index],
+      tr.docs[index + 1] ?? tr.doc,
+      (node) => kindOf(node, kinds) !== null
+    )
+  );
+}
+function copiedReferences(transactions, before, after) {
+  const found = countsOf(before);
+  const left = countsOf(after);
+  const mapping = new Mapping(transactions.flatMap((tr) => tr.mapping.maps));
+  const carried = new Set(
+    before.flatMap(({ key, pos }) => {
+      const mapped = mapping.mapResult(pos, 1);
+      return mapped.deletedAfter ? [] : [`${key}@${mapped.pos}`];
+    })
+  );
+  const wasCarried = ({ key, pos }) => carried.has(`${key}@${pos}`);
+  return [...left].flatMap(([key, count]) => {
+    const kept = found.get(key) ?? 0;
+    if (kept === 0 || count <= kept) return [];
+    const standing = after.filter((reference) => reference.key === key);
+    return [
+      ...standing.filter(wasCarried),
+      ...standing.filter((reference) => !wasCarried(reference))
+    ].slice(kept);
+  });
+}
+function settled(transactions, oldState, newState, kinds) {
+  const document = documentOf(newState);
+  const isNote = (key) => !document.specialNotes.has(key) && storyNodeOf(newState.doc, key) !== null;
+  const before = referencesIn(oldState.doc, kinds);
+  const after = referencesIn(newState.doc, kinds);
+  const left = countsOf(after);
+  const gone = [...countsOf(before).keys()].filter(
+    (key) => !left.has(key) && isNote(key)
+  );
+  const copies = copiedReferences(transactions, before, after).filter(({ key }) => isNote(key)).sort((a, b) => a.pos - b.pos);
+  if (gone.length === 0 && copies.length === 0) return null;
+  const tr = withoutStories(newState.tr, gone);
+  const taken = /* @__PURE__ */ new Map();
+  for (const copy of copies) {
+    const story = storyNodeOf(newState.doc, copy.key);
+    if (story === null) continue;
+    const ids = taken.get(copy.kind) ?? takenNoteIds(newState.doc, copy.kind, document.reservedNoteKeys);
+    taken.set(copy.kind, ids);
+    const id = nextNoteId(ids);
+    ids.add(id);
+    tr.setNodeAttribute(copy.pos, "id", id).setNodeAttribute(
+      copy.pos,
+      "referenceXml",
+      null
+    );
+    setStory(
+      tr,
+      storyKey(copy.kind, id),
+      copiedNoteStory(story, document.session)
+    );
+  }
+  return tr;
+}
+function noteLifecycle(kinds = EDITABLE_NOTE_KINDS) {
+  return new Plugin({
+    appendTransaction(transactions, oldState, newState) {
+      if (!transactions.some((tr) => reachesReferences(tr, kinds))) {
+        return null;
+      }
+      return settled(transactions, oldState, newState, kinds);
+    }
+  });
+}
+export {
+  noteLifecycle
+};

package/dist/editor/plugins/noteNavigation.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Getting into a note and asking for one to be opened.
+ *
+ * A press on a note's number or a command asks for a note, and neither can mount anything itself,
+ * since what draws the notes is the surface around the editor; so the request is held in the state
+ * and the surface reads it back (`requestedNote`). The nonce is what makes a second request for
+ * the note already open reach the surface at all.
+ *
+ * The request moves the caret to just after the reference as it goes in, which is where Escape
+ * hands it back to (`editor/notes/noteSurface`), so leaving a note needs nothing remembered.
+ */
+import type { Node as PMNode } from "prosemirror-model";
+import { type Command, type EditorState, Plugin, type Transaction } from "prosemirror-state";
+import { type NoteKind, type StoryKey } from "../../schema/stories";
+/** Which note the reader asked for, and which asking it was */
+export interface RequestedNote {
+    readonly key: StoryKey;
+    /** Rises with every request, so asking twice for one note is two requests */
+    readonly nonce: number;
+}
+/** One reference to a note, as the document holds it */
+export interface PlacedNoteReference {
+    readonly pos: number;
+    readonly node: PMNode;
+}
+/** Where the first reference to this note stands, and null where the document holds none */
+export declare function noteReferenceAt(doc: PMNode, kind: NoteKind, id: string): PlacedNoteReference | null;
+/** The transaction with the note it opens recorded on it, which `insertFootnote` also carries */
+export declare function requestNote<T extends Transaction>(tr: T, key: StoryKey): T;
+/** The note last asked for, and null where none was. Null for a state built without the plugin */
+export declare function requestedNote(state: EditorState): RequestedNote | null;
+/**
+ * Puts the caret just after the note's reference and asks for the note to be opened. It applies
+ * under every mode, since opening a note is reading it; what a reader may do once it stands open
+ * is the story view's question (`editor/stories`).
+ */
+export declare function openNoteCommand(kind: NoteKind, id: string): Command;
+/**
+ * Holds the note last asked for, and turns a press on a note's number into that asking.
+ *
+ * One press is what opens a note, which is what Google Docs does: the number is a small
+ * superscript, and a press on one is far more often a reader going to the note than a caret being
+ * placed on the digit. A reference to a kind no writer puts back opens nothing.
+ */
+export declare function noteNavigation(kinds?: readonly NoteKind[]): Plugin<RequestedNote | null>;

package/dist/editor/plugins/noteNavigation.js

@@ -0,0 +1,86 @@
+// src/editor/plugins/noteNavigation.ts
+import {
+  Plugin,
+  PluginKey,
+  TextSelection
+} from "prosemirror-state";
+import { docxSchema } from "../../schema/index.js";
+import {
+  EDITABLE_NOTE_KINDS,
+  storyKey,
+  storyNodeOf
+} from "../../schema/stories.js";
+import { documentOf } from "../editorDocument.js";
+var navigationKey = new PluginKey(
+  "docxEditorNoteNavigation"
+);
+function noteReferenceAt(doc, kind, id) {
+  let found = null;
+  doc.descendants((node, pos) => {
+    if (found !== null) return false;
+    if (node.type === docxSchema.nodes.noteReference && node.attrs.kind === kind && node.attrs.id === id) {
+      found = { pos, node };
+    }
+    return found === null;
+  });
+  return found;
+}
+function isRequest(value) {
+  if (typeof value !== "object" || value === null) return false;
+  return typeof Reflect.get(value, "key") === "string" && typeof Reflect.get(value, "nonce") === "number";
+}
+var asked = 0;
+function requestNote(tr, key) {
+  asked += 1;
+  return tr.setMeta(navigationKey, { key, nonce: asked });
+}
+function requestedNote(state) {
+  return navigationKey.getState(state) ?? null;
+}
+function openNoteCommand(kind, id) {
+  return (state, dispatch) => {
+    const key = storyKey(kind, id);
+    if (documentOf(state).specialNotes.has(key)) return false;
+    if (storyNodeOf(state.doc, key) === null) return false;
+    const found = noteReferenceAt(state.doc, kind, id);
+    if (found === null) return false;
+    if (dispatch) {
+      const after = found.pos + found.node.nodeSize;
+      const tr = state.tr.setSelection(
+        TextSelection.near(state.doc.resolve(after))
+      );
+      dispatch(requestNote(tr, key).scrollIntoView());
+    }
+    return true;
+  };
+}
+function noteNavigation(kinds = EDITABLE_NOTE_KINDS) {
+  return new Plugin({
+    key: navigationKey,
+    state: {
+      init: () => null,
+      apply: (tr, held) => {
+        const next = tr.getMeta(navigationKey);
+        return isRequest(next) ? next : held;
+      }
+    },
+    props: {
+      handleClickOn(view, _pos, node, _nodePos, _event, direct) {
+        if (!direct || node.type !== docxSchema.nodes.noteReference) {
+          return false;
+        }
+        const kind = kinds.find((named) => named === node.attrs.kind);
+        const id = node.attrs.id;
+        if (kind === void 0 || typeof id !== "string") return false;
+        return openNoteCommand(kind, id)(view.state, view.dispatch);
+      }
+    }
+  });
+}
+export {
+  noteNavigation,
+  noteReferenceAt,
+  openNoteCommand,
+  requestNote,
+  requestedNote
+};

package/dist/editor/plugins/noteNumbering.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from "prosemirror-state";
+import { noteLabelsIn } from "../../docx/notes/numbering";
+export type NoteLabeller = typeof noteLabelsIn;
+/**
+ * Labels the note references again after a change that moves one, moves a section break, or
+ * replaces the numbering the snapshot holds.
+ *
+ * A label is a display value of an inline node, which the display derivation walk does not reach,
+ * so it is written here under the same pass: a relabel goes through a lock around the reference,
+ * and one undo takes it back with the edit that caused it. The relabel after a snapshot change
+ * follows no edit and goes to the history not at all.
+ */
+export declare function noteNumbering(labelsIn?: NoteLabeller): Plugin;