@tarhnama/core 0.1.0

package/dist/ops.js

@@ -0,0 +1,333 @@
+import { BODY, MAX_LEVEL, } from './types.js';
+import { ancestors, buildIndex, isLocked, prevHeading, subtreeRange } from './tree.js';
+/**
+ * Structural operations. All are pure: they take a flat list and return a new one,
+ * sharing unchanged blocks by reference so downstream memoization works.
+ *
+ * The defining rule of this module: an operation on a heading applies to its whole
+ * SUBTREE. Indenting a heading and leaving its children behind — the bug in the
+ * earlier Tiptap scaffold — produces an orphaned document.
+ */
+/**
+ * Can `i` be indented?
+ *
+ * The rule prevents skipped levels: a heading may go one deeper than the nearest
+ * preceding heading, never more. Without this you can indent from level 1 straight
+ * to level 3 and create a block with no representable parent.
+ *
+ * Body text has no level, so indenting it is meaningless — use `setLevel` to promote
+ * body text into a heading instead.
+ */
+export function canIndent(blocks, i) {
+    const block = blocks[i];
+    if (!block || block.level === BODY)
+        return false;
+    // A locked block's position is fixed. Checked here rather than in `indent` so the UI
+    // can grey the control out instead of offering an action that silently does nothing.
+    if (isLocked(blocks, buildIndex(blocks), i))
+        return false;
+    const prev = prevHeading(blocks, i);
+    if (prev === -1)
+        return false; // first heading in the document: nothing to nest under
+    if (block.level > blocks[prev].level)
+        return false; // already a child of prev
+    // The deepest descendant must still fit within MAX_LEVEL after the shift.
+    const index = buildIndex(blocks);
+    const end = index.subtreeEnd[i];
+    for (let j = i; j < end; j++) {
+        const l = blocks[j].level;
+        if (l !== BODY && l + 1 > MAX_LEVEL)
+            return false;
+    }
+    return true;
+}
+export function indent(blocks, i) {
+    if (!canIndent(blocks, i))
+        return blocks;
+    return shiftSubtree(blocks, i, +1);
+}
+/** Level 1 cannot outdent — there is nothing above it. Body text has no level. */
+export function canOutdent(blocks, i) {
+    const block = blocks[i];
+    if (!block || block.level < 2)
+        return false;
+    return !isLocked(blocks, buildIndex(blocks), i);
+}
+/**
+ * Outdent a heading and its subtree.
+ *
+ * Pleasant property of the flat model: the following siblings that were at the
+ * outdented block's old level automatically become its children, which is exactly
+ * what Workflowy and Word's outline view do — no extra code needed.
+ */
+export function outdent(blocks, i) {
+    if (!canOutdent(blocks, i))
+        return blocks;
+    return shiftSubtree(blocks, i, -1);
+}
+function shiftSubtree(blocks, i, delta) {
+    const index = buildIndex(blocks);
+    const end = index.subtreeEnd[i];
+    const next = blocks.slice();
+    for (let j = i; j < end; j++) {
+        const b = blocks[j];
+        if (b.level === BODY)
+            continue; // body text has no level to shift
+        next[j] = { ...b, level: (b.level + delta) };
+    }
+    return next;
+}
+/** Set a block's level directly — used to promote body text to a heading and back. */
+export function canSetLevel(blocks, i) {
+    return !!blocks[i] && !isLocked(blocks, buildIndex(blocks), i);
+}
+export function setLevel(blocks, i, level) {
+    if (!canSetLevel(blocks, i))
+        return blocks;
+    const block = blocks[i];
+    if (!block || block.level === level)
+        return blocks;
+    const next = blocks.slice();
+    next[i] = { ...block, level };
+    return next;
+}
+export function toggleCollapse(blocks, i) {
+    const block = blocks[i];
+    if (!block)
+        return blocks;
+    const next = blocks.slice();
+    next[i] = { ...block, collapsed: !block.collapsed };
+    return next;
+}
+/**
+ * Expand every collapsed ancestor of a block, so it can actually be reached.
+ *
+ * Needed wherever the app navigates to a block the user did not click: a search result, a
+ * cross-document link, a backlink. A collapsed subtree is ABSENT from the DOM, not hidden,
+ * so scrolling to it finds nothing and the jump silently does nothing at all — which reads
+ * as a broken feature rather than as "that match is folded away".
+ *
+ * Only ancestors are touched. The block's own collapse state is left alone: revealing a
+ * heading should not also unfold everything beneath it.
+ *
+ * Returns the SAME list when nothing was collapsed.
+ */
+export function expandAncestors(blocks, blockId) {
+    const at = blocks.findIndex((block) => block.id === blockId);
+    if (at === -1)
+        return blocks;
+    const index = buildIndex(blocks);
+    const toOpen = new Set(ancestors(index, at).filter((i) => blocks[i]?.collapsed === true));
+    if (toOpen.size === 0)
+        return blocks;
+    return blocks.map((block, i) => (toOpen.has(i) ? { ...block, collapsed: false } : block));
+}
+export function setDirection(blocks, i, dir) {
+    const block = blocks[i];
+    if (!block || block.dir === dir)
+        return blocks;
+    const next = blocks.slice();
+    next[i] = { ...block, dir };
+    return next;
+}
+/**
+ * Move the subtree rooted at `from` so it begins at document position `to`.
+ *
+ * `to` is interpreted against the ORIGINAL list. Moving a subtree into itself is a
+ * no-op rather than an error, because drag-and-drop will attempt it constantly.
+ */
+/**
+ * Can the subtree at `from` be moved to `to`?
+ *
+ * Both ends matter: a locked subtree cannot be dragged away, and nothing may be dropped
+ * INTO a locked one. Checking only the source is the easy mistake — it lets a reader
+ * append into a chapter they are not allowed to change.
+ */
+export function canMoveSubtree(blocks, from, to) {
+    const index = buildIndex(blocks);
+    if (!blocks[from])
+        return false;
+    if (isLocked(blocks, index, from))
+        return false;
+    // A drop lands BETWEEN blocks, so the block before the insertion point is checked as
+    // well: landing just after a locked heading would place the block inside its subtree.
+    const before = to - 1;
+    if (before >= 0 && before < blocks.length && isLocked(blocks, index, before)) {
+        const [, end] = subtreeRange(index, before);
+        if (to < end)
+            return false;
+    }
+    if (to < blocks.length && isLocked(blocks, index, to))
+        return false;
+    return true;
+}
+export function moveSubtree(blocks, from, to) {
+    const index = buildIndex(blocks);
+    const end = index.subtreeEnd[from];
+    if (to >= from && to <= end)
+        return blocks; // dropping inside itself
+    if (!canMoveSubtree(blocks, from, to))
+        return blocks;
+    const slice = blocks.slice(from, end);
+    const rest = [...blocks.slice(0, from), ...blocks.slice(end)];
+    const insertAt = to > from ? to - (end - from) : to;
+    return [...rest.slice(0, insertAt), ...slice, ...rest.slice(insertAt)];
+}
+/**
+ * Repair skipped levels — the import path for real Word documents, which jump from
+ * H1 to H3 constantly.
+ *
+ * Each heading is clamped to at most one deeper than the preceding heading, and the
+ * first heading is clamped to 1. Body text is untouched.
+ */
+export function normalizeLevels(blocks) {
+    let changed = false;
+    const next = blocks.slice();
+    let prevLevel = 0;
+    for (let i = 0; i < blocks.length; i++) {
+        const b = blocks[i];
+        if (b.level === BODY)
+            continue;
+        const max = (prevLevel + 1);
+        const level = b.level > max ? max : b.level;
+        if (level !== b.level) {
+            next[i] = { ...b, level };
+            changed = true;
+        }
+        prevLevel = level;
+    }
+    return changed ? next : blocks;
+}
+/** True when no heading is more than one level deeper than the one before it. */
+export function isNormalized(blocks) {
+    let prevLevel = 0;
+    for (const b of blocks) {
+        if (b.level === BODY)
+            continue;
+        if (b.level > prevLevel + 1)
+            return false;
+        prevLevel = b.level;
+    }
+    return true;
+}
+/**
+ * Lock or unlock a block. Locking a heading makes its whole subtree read-only by
+ * derivation — only the heading itself carries the flag.
+ */
+export function setLocked(blocks, i, locked) {
+    const block = blocks[i];
+    if (!block || (block.locked ?? false) === locked)
+        return blocks;
+    const out = [...blocks];
+    // Unlocking REMOVES the flag rather than setting it to `false`, so a document that
+    // never used locking serializes exactly as it did before the feature existed.
+    out[i] = locked ? { ...block, locked: true } : stripLocked(block);
+    return out;
+}
+function stripLocked(block) {
+    const { locked: _locked, ...rest } = block;
+    return rest;
+}
+/**
+ * The previous sibling of the block at `i`, or -1.
+ *
+ * A sibling is the nearest preceding block at the SAME level that shares a parent — which
+ * for this model means: walking backwards, the first block at that level, stopping if a
+ * shallower one appears first, because that is the parent and the run has ended.
+ */
+function previousSibling(blocks, i) {
+    const level = blocks[i]?.level;
+    if (level === undefined)
+        return -1;
+    for (let j = i - 1; j >= 0; j--) {
+        const other = blocks[j]?.level;
+        if (other === undefined)
+            continue;
+        if (other === level)
+            return j;
+        // Body text (level 0) sits under headings and never terminates a heading's run, but a
+        // heading shallower than us IS our parent and there is no earlier sibling under it.
+        if (other !== BODY && other < level)
+            return -1;
+        if (level === BODY && other !== BODY)
+            return -1;
+    }
+    return -1;
+}
+/**
+ * Move a node before its previous sibling, subtree and all.
+ *
+ * "Up" is **a sibling**, not a row. A heading with forty blocks under it must jump the
+ * whole of its neighbour's subtree; swapping single rows would tear both apart, and the
+ * design's درخت menu calls this "move node" for that reason.
+ *
+ * A first sibling does not move. The tempting alternative — promote it above its parent —
+ * changes the node's LEVEL as a side effect of a move, and a command that quietly does two
+ * things is one users stop trusting. Indent and outdent are how a level changes.
+ */
+export function moveBlockUp(blocks, blockId) {
+    const at = blocks.findIndex((block) => block.id === blockId);
+    if (at === -1)
+        return blocks;
+    const target = previousSibling(blocks, at);
+    if (target === -1)
+        return blocks;
+    return moveSubtree(blocks, at, target);
+}
+/**
+ * Move a node after its next sibling, subtree and all.
+ *
+ * The target is the END of the sibling's subtree, in ORIGINAL indices — `moveSubtree`
+ * interprets `to` against the list it was given and does the shift arithmetic itself.
+ * Pre-adjusting by the moved subtree's size (the obvious defensive move) lands the target
+ * back inside the node being moved, where `moveSubtree`'s "dropping inside itself" guard
+ * correctly refuses it and the command silently does nothing.
+ */
+export function moveBlockDown(blocks, blockId) {
+    const at = blocks.findIndex((block) => block.id === blockId);
+    if (at === -1)
+        return blocks;
+    const index = buildIndex(blocks);
+    const [, end] = subtreeRange(index, at);
+    if (end >= blocks.length)
+        return blocks;
+    const level = blocks[at]?.level;
+    const nextLevel = blocks[end]?.level;
+    if (level === undefined || nextLevel === undefined)
+        return blocks;
+    // The block after our subtree is only a SIBLING if it is at our level; anything
+    // shallower is the end of our parent's run and there is nothing left to swap with.
+    if (nextLevel !== level)
+        return blocks;
+    const [, siblingEnd] = subtreeRange(index, end);
+    return moveSubtree(blocks, at, siblingEnd);
+}
+/**
+ * The level this heading skipped over, or `null`.
+ *
+ * `isNormalized` answers "does this document skip anywhere", which is enough to enable a
+ * repair command and useless for showing the reader WHERE. Frame 1a puts an amber
+ * «سطح ۳ جا افتاده» chip on the offending heading, so the question has to be asked of a
+ * single block.
+ *
+ * Returns the FIRST missing level, not the deepest. When 2 → 4 skips only 3 that is the
+ * same answer either way, but 1 → 4 skips both 2 and 3, and 2 is the one to add first —
+ * naming 3 would send someone to fix the wrong end of the gap.
+ *
+ * Body text is never an answer and never breaks the chain: level 0 is not a hierarchy
+ * level, it belongs to the nearest preceding heading, and a paragraph between two headings
+ * does not make the second one a skip.
+ */
+export function skippedLevelAt(blocks, i) {
+    const block = blocks[i];
+    if (!block || block.level === BODY)
+        return null;
+    const prev = prevHeading(blocks, i);
+    // A document that opens below level 1 has no representable parent for its first heading.
+    const parentLevel = prev === -1 ? 0 : (blocks[prev]?.level ?? 0);
+    // Going back up, or one step down, is never a skip.
+    if (block.level <= parentLevel + 1)
+        return null;
+    return (parentLevel + 1);
+}
+//# sourceMappingURL=ops.js.map

package/dist/ops.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ops.js","sourceRoot":"","sources":["../src/ops.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,IAAI,EACJ,SAAS,GACV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEvF;;;;;;;GAOG;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,CAAS;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACjD,qFAAqF;IACrF,qFAAqF;IACrF,IAAI,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAE1D,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC,CAAC,uDAAuD;IACtF,IAAI,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAE,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC,CAAC,0BAA0B;IAE/E,0EAA0E;IAC1E,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS;YAAE,OAAO,KAAK,CAAC;IACpD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,MAAM,CAAI,MAAiB,EAAE,CAAS;IACpD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IACzC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,CAAS;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAI,MAAiB,EAAE,CAAS;IACrD,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAC1C,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,YAAY,CAAI,MAAiB,EAAE,CAAS,EAAE,KAAa;IAClE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC;IACjC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACrB,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI;YAAE,SAAS,CAAC,kCAAkC;QAClE,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,CAAiB,EAAE,CAAC;IAC/D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,CAAS;IACnD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAI,MAAiB,EAAE,CAAS,EAAE,KAAmB;IAC3E,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;QAAE,OAAO,MAAM,CAAC;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC;IAC9B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,cAAc,CAAI,MAAiB,EAAE,CAAS;IAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACpD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAAI,MAAiB,EAAE,OAAe;IACnE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;IAC7D,IAAI,EAAE,KAAK,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAE7B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,IAAI,GAAG,CACpB,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC,CAClE,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAErC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAiB,EACjB,CAAS,EACT,GAAiB;IAEjB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,GAAG;QAAE,OAAO,MAAM,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,CAAC;IAC5B,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,IAAY,EAAE,EAAU;IACrE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAChD,qFAAqF;IACrF,sFAAsF;IACtF,MAAM,MAAM,GAAG,EAAE,GAAG,CAAC,CAAC;IACtB,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,EAAE,GAAG,GAAG;YAAE,OAAO,KAAK,CAAC;IAC7B,CAAC;IACD,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAAE,OAAO,KAAK,CAAC;IACpE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,WAAW,CAAI,MAAiB,EAAE,IAAY,EAAE,EAAU;IACxE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAE,CAAC;IACpC,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,IAAI,GAAG;QAAE,OAAO,MAAM,CAAC,CAAC,yBAAyB;IACrE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC;QAAE,OAAO,MAAM,CAAC;IAErD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpD,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAI,MAAiB;IAClD,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACrB,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI;YAAE,SAAS;QAE/B,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,CAAC,CAAiB,CAAC;QAC5C,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAC5C,IAAI,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;YAC1B,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QACD,SAAS,GAAG,KAAK,CAAC;IACpB,CAAC;IAED,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;AACjC,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI;YAAE,SAAS;QAC/B,IAAI,CAAC,CAAC,KAAK,GAAG,SAAS,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC1C,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAGD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAI,MAAiB,EAAE,CAAS,EAAE,MAAe;IACxE,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAChE,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;IACxB,mFAAmF;IACnF,8EAA8E;IAC9E,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAClE,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,WAAW,CAAI,KAAe;IACrC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAC3C,OAAO,IAAgB,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAc,EAAE,CAAS;IAChD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAC/B,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,CAAC,CAAC,CAAC;IACnC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,KAAK,KAAK,KAAK;YAAE,OAAO,CAAC,CAAC;QAC9B,sFAAsF;QACtF,oFAAoF;QACpF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,GAAG,KAAK;YAAE,OAAO,CAAC,CAAC,CAAC;QAC/C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAI,MAAiB,EAAE,OAAe;IAC/D,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;IAC7D,IAAI,EAAE,KAAK,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAC7B,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3C,IAAI,MAAM,KAAK,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IACjC,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAI,MAAiB,EAAE,OAAe;IACjE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;IAC7D,IAAI,EAAE,KAAK,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAE7B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACxC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC;IAExC,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;IAChC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAClE,gFAAgF;IAChF,mFAAmF;IACnF,IAAI,SAAS,KAAK,KAAK;QAAE,OAAO,MAAM,CAAC;IAEvC,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChD,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,CAAS;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEhD,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACpC,yFAAyF;IACzF,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC;IAEjE,oDAAoD;IACpD,IAAI,KAAK,CAAC,KAAK,IAAI,WAAW,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAChD,OAAO,CAAC,WAAW,GAAG,CAAC,CAAiB,CAAC;AAC3C,CAAC"}

package/dist/shortcuts.d.ts

@@ -0,0 +1,90 @@
+import { type OutlineFeatureName, type OutlineFeatures } from './features.js';
+/**
+ * The keyboard shortcuts, as DATA.
+ *
+ * A hard-coded `addKeyboardShortcuts` in the editor extension has three problems, and each
+ * one lands on a different person:
+ *
+ *   1. A host cannot CHANGE it. Every embedder inherits `Tab` and `Mod-.` whether those
+ *      collide with their own application or not — and `Tab` in particular is the web's
+ *      focus key, so an editor that eats it is one a keyboard user cannot leave.
+ *   2. A host cannot READ it. Rendering a shortcuts sheet means retyping the list by hand,
+ *      and the copy drifts from the bindings the moment either changes.
+ *   3. Nobody can turn it off, per binding or at all.
+ *
+ * So the table is plain serializable data — no closures, no editor reference — and the
+ * Tiptap extension is generated from it. A settings screen can render it, store it, diff
+ * it and hand back an override map.
+ */
+/** The commands a shortcut can be bound to. Names, not functions — see the note above. */
+export type ShortcutCommand = 'indent' | 'outdent' | 'setLevel1' | 'setLevel2' | 'setLevel3' | 'setLevel4' | 'setLevel5' | 'setLevel6' | 'setBodyText' | 'toggleCollapse' | 'collapseSiblings' | 'insertZwnj' | 'undo' | 'redo' | 'bold' | 'italic' | 'underline' | 'strike' | 'moveUp' | 'moveDown';
+export interface ShortcutBinding {
+    readonly command: ShortcutCommand;
+    /** ProseMirror's spelling: `Mod-` is ⌘ on Apple and Ctrl elsewhere. */
+    readonly key: string;
+    /** For grouping in a help sheet. */
+    readonly group: 'structure' | 'collapse' | 'formatting' | 'editing' | 'persian';
+    /**
+     * The feature this binding belongs to, if any.
+     *
+     * Lets `features={{ collapse: false }}` drop `Mod-.` without the host having to know
+     * which key that was. A binding with no feature is structural and always survives —
+     * indent and outdent ARE the outline, not a feature of it.
+     */
+    readonly feature?: OutlineFeatureName;
+    /** Shown in a help sheet. English; a host translates via its own label pack. */
+    readonly description: string;
+}
+/**
+ * The defaults.
+ *
+ * `Mod-1…6` rather than 1…9: levels 7–9 exist in the model because Word documents contain
+ * them, but no keyboard has a comfortable ninth digit and the ladder covers the rest.
+ */
+export declare const DEFAULT_SHORTCUTS: readonly ShortcutBinding[];
+export interface ShortcutOptions {
+    /** `false` binds nothing at all. */
+    readonly enabled?: boolean;
+    /**
+     * Rebind (`'Mod-Shift-c'`) or unbind (`null`) by command name.
+     *
+     * By command rather than by key, because the host knows what they want to move, not
+     * what it is currently bound to — and the current binding is exactly the thing they
+     * would have to keep in sync by hand.
+     */
+    readonly overrides?: Readonly<Partial<Record<ShortcutCommand, string | null>>>;
+    /** Bindings whose feature is off are dropped. */
+    readonly features?: Partial<OutlineFeatures> | readonly OutlineFeatureName[];
+}
+/**
+ * Apply a host's overrides and feature set to the default table.
+ *
+ * Collisions THROW. Letting a rebinding silently win means the losing command stops
+ * working with nothing logged, discoverable only by someone trying it and wondering what
+ * broke — and by then the override is somewhere in the host's configuration, far from the
+ * symptom.
+ */
+export declare function resolveShortcuts(options?: ShortcutOptions): readonly ShortcutBinding[];
+export interface ShortcutGroup {
+    readonly group: ShortcutBinding['group'];
+    readonly bindings: readonly ShortcutBinding[];
+}
+/**
+ * Group the live bindings for display.
+ *
+ * The order is fixed rather than derived from the data: a sheet that reshuffles between
+ * openings cannot be learned, and learning it is the only reason it exists.
+ */
+export declare function shortcutsFor(bindings: readonly ShortcutBinding[]): readonly ShortcutGroup[];
+/** Which glyph set to render. Callers pass their own platform check. */
+export type ShortcutPlatform = 'apple' | 'other';
+/**
+ * A binding as a person reads it.
+ *
+ * `Mod` is ProseMirror's platform-agnostic spelling and must never reach a user: nobody
+ * has a Mod key. Apple users read glyphs with no separator, everyone else reads words
+ * joined by `+`, and getting that backwards is one of the small things that makes software
+ * feel foreign.
+ */
+export declare function formatShortcut(key: string, platform: ShortcutPlatform): string;
+//# sourceMappingURL=shortcuts.d.ts.map

package/dist/shortcuts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortcuts.d.ts","sourceRoot":"","sources":["../src/shortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,kBAAkB,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAE/F;;;;;;;;;;;;;;;;GAgBG;AAEH,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,MAAM,GACN,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,UAAU,CAAC;AAEf,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,uEAAuE;IACvE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;IAChF;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACtC,gFAAgF;IAChF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,eAAe,EA4EvD,CAAC;AAIF,MAAM,WAAW,eAAe;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/E,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,kBAAkB,EAAE,CAAC;CAC9E;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,eAAe,EAAE,CA6CtF;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE,SAAS,eAAe,EAAE,CAAC;CAC/C;AAWD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,eAAe,EAAE,GAAG,SAAS,aAAa,EAAE,CAK3F;AAED,wEAAwE;AACxE,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,CAAC;AAgBjD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAU9E"}

package/dist/shortcuts.js

@@ -0,0 +1,179 @@
+import { resolveFeatures } from './features.js';
+/**
+ * The defaults.
+ *
+ * `Mod-1…6` rather than 1…9: levels 7–9 exist in the model because Word documents contain
+ * them, but no keyboard has a comfortable ninth digit and the ladder covers the rest.
+ */
+export const DEFAULT_SHORTCUTS = [
+    { command: 'indent', key: 'Tab', group: 'structure', description: 'Indent block' },
+    { command: 'outdent', key: 'Shift-Tab', group: 'structure', description: 'Outdent block' },
+    { command: 'setLevel1', key: 'Mod-1', group: 'structure', description: 'Heading 1' },
+    { command: 'setLevel2', key: 'Mod-2', group: 'structure', description: 'Heading 2' },
+    { command: 'setLevel3', key: 'Mod-3', group: 'structure', description: 'Heading 3' },
+    { command: 'setLevel4', key: 'Mod-4', group: 'structure', description: 'Heading 4' },
+    { command: 'setLevel5', key: 'Mod-5', group: 'structure', description: 'Heading 5' },
+    { command: 'setLevel6', key: 'Mod-6', group: 'structure', description: 'Heading 6' },
+    { command: 'setBodyText', key: 'Mod-0', group: 'structure', description: 'Body text' },
+    { command: 'moveUp', key: 'Alt-ArrowUp', group: 'structure', description: 'Move block up' },
+    { command: 'moveDown', key: 'Alt-ArrowDown', group: 'structure', description: 'Move block down' },
+    {
+        command: 'toggleCollapse',
+        key: 'Mod-.',
+        group: 'collapse',
+        feature: 'collapse',
+        description: 'Collapse or expand this node',
+    },
+    {
+        command: 'collapseSiblings',
+        key: 'Mod-Shift-.',
+        group: 'collapse',
+        feature: 'collapse',
+        description: 'Collapse every sibling at this level',
+    },
+    {
+        command: 'bold',
+        key: 'Mod-b',
+        group: 'formatting',
+        feature: 'formatting',
+        description: 'Bold',
+    },
+    {
+        command: 'italic',
+        key: 'Mod-i',
+        group: 'formatting',
+        feature: 'formatting',
+        description: 'Italic',
+    },
+    {
+        command: 'underline',
+        key: 'Mod-u',
+        group: 'formatting',
+        feature: 'formatting',
+        description: 'Underline',
+    },
+    {
+        command: 'strike',
+        key: 'Mod-Shift-x',
+        group: 'formatting',
+        feature: 'formatting',
+        description: 'Strikethrough',
+    },
+    { command: 'undo', key: 'Mod-z', group: 'editing', feature: 'history', description: 'Undo' },
+    {
+        command: 'redo',
+        key: 'Mod-Shift-z',
+        group: 'editing',
+        feature: 'history',
+        description: 'Redo',
+    },
+    /**
+     * نیم‌فاصله. Not a convenience: this is how Persian compound words are written at all —
+     * می‌شود, نمی‌توان, دانش‌آموزان — and an editor without it cannot be used for real Persian.
+     */
+    {
+        command: 'insertZwnj',
+        key: 'Shift-Space',
+        group: 'persian',
+        description: 'Half-space (ZWNJ)',
+    },
+];
+const COMMANDS = new Set(DEFAULT_SHORTCUTS.map((b) => b.command));
+/**
+ * Apply a host's overrides and feature set to the default table.
+ *
+ * Collisions THROW. Letting a rebinding silently win means the losing command stops
+ * working with nothing logged, discoverable only by someone trying it and wondering what
+ * broke — and by then the override is somewhere in the host's configuration, far from the
+ * symptom.
+ */
+export function resolveShortcuts(options) {
+    if (options?.enabled === false)
+        return [];
+    const features = resolveFeatures(options?.features);
+    const overrides = options?.overrides ?? {};
+    for (const name of Object.keys(overrides)) {
+        if (!COMMANDS.has(name)) {
+            throw new Error(`Unknown shortcut command ${JSON.stringify(name)}. Known: ${[...COMMANDS].join(', ')}.`);
+        }
+    }
+    const resolved = [];
+    for (const binding of DEFAULT_SHORTCUTS) {
+        if (binding.feature !== undefined && !features[binding.feature])
+            continue;
+        const override = Object.hasOwn(overrides, binding.command)
+            ? overrides[binding.command]
+            : undefined;
+        // An explicit null unbinds; `undefined` means the host said nothing about it.
+        if (override === null)
+            continue;
+        resolved.push(override === undefined ? binding : { ...binding, key: override });
+    }
+    /*
+     * Collisions are checked AFTER every override is applied, not while applying them, so
+     * that swapping two commands works in a single call. Checking as we go would reject
+     * `{ indent: null, toggleCollapse: 'Tab' }` depending on table order, which is a rule
+     * nobody could predict.
+     */
+    const seen = new Map();
+    for (const binding of resolved) {
+        const previous = seen.get(binding.key);
+        if (previous !== undefined) {
+            throw new Error(`Shortcut collision on ${binding.key}: ${previous} and ${binding.command}. ` +
+                `Unbind one with { ${previous}: null }.`);
+        }
+        seen.set(binding.key, binding.command);
+    }
+    return resolved;
+}
+/** Stable group order for a help sheet — structure first, because it is the product. */
+const GROUP_ORDER = [
+    'structure',
+    'collapse',
+    'formatting',
+    'editing',
+    'persian',
+];
+/**
+ * Group the live bindings for display.
+ *
+ * The order is fixed rather than derived from the data: a sheet that reshuffles between
+ * openings cannot be learned, and learning it is the only reason it exists.
+ */
+export function shortcutsFor(bindings) {
+    return GROUP_ORDER.map((group) => ({
+        group,
+        bindings: bindings.filter((binding) => binding.group === group),
+    })).filter((entry) => entry.bindings.length > 0);
+}
+const APPLE_GLYPHS = {
+    Mod: '⌘',
+    Shift: '⇧',
+    Alt: '⌥',
+    Ctrl: '⌃',
+};
+const ARROWS = {
+    ArrowUp: '↑',
+    ArrowDown: '↓',
+    ArrowLeft: '←',
+    ArrowRight: '→',
+};
+/**
+ * A binding as a person reads it.
+ *
+ * `Mod` is ProseMirror's platform-agnostic spelling and must never reach a user: nobody
+ * has a Mod key. Apple users read glyphs with no separator, everyone else reads words
+ * joined by `+`, and getting that backwards is one of the small things that makes software
+ * feel foreign.
+ */
+export function formatShortcut(key, platform) {
+    const parts = key.split('-');
+    const last = parts.pop() ?? '';
+    // A single letter is shown capitalised — `Mod-b` is written ⌘B on every key cap.
+    const final = ARROWS[last] ?? (last.length === 1 ? last.toUpperCase() : last);
+    if (platform === 'apple') {
+        return parts.map((part) => APPLE_GLYPHS[part] ?? part).join('') + final;
+    }
+    return [...parts.map((part) => (part === 'Mod' ? 'Ctrl' : part)), final].join('+');
+}
+//# sourceMappingURL=shortcuts.js.map

package/dist/shortcuts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortcuts.js","sourceRoot":"","sources":["../src/shortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAiD,MAAM,eAAe,CAAC;AA6D/F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAA+B;IAC3D,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE;IAClF,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE;IAC1F,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACpF,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE;IACtF,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE;IAC3F,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE;IAEjG;QACE,OAAO,EAAE,gBAAgB;QACzB,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,UAAU;QACnB,WAAW,EAAE,8BAA8B;KAC5C;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,GAAG,EAAE,aAAa;QAClB,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,UAAU;QACnB,WAAW,EAAE,sCAAsC;KACpD;IAED;QACE,OAAO,EAAE,MAAM;QACf,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,MAAM;KACpB;IACD;QACE,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,QAAQ;KACtB;IACD;QACE,OAAO,EAAE,WAAW;QACpB,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,WAAW;KACzB;IACD;QACE,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,aAAa;QAClB,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,eAAe;KAC7B;IAED,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE;IAC5F;QACE,OAAO,EAAE,MAAM;QACf,GAAG,EAAE,aAAa;QAClB,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,SAAS;QAClB,WAAW,EAAE,MAAM;KACpB;IAED;;;OAGG;IACH;QACE,OAAO,EAAE,YAAY;QACrB,GAAG,EAAE,aAAa;QAClB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,mBAAmB;KACjC;CACF,CAAC;AAEF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAiB1E;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAyB;IACxD,IAAI,OAAO,EAAE,OAAO,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAE1C,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpD,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,EAAE,CAAC;IAE3C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;QACxC,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,SAAS;QAE1E,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC;YAC5B,CAAC,CAAC,SAAS,CAAC;QACd,8EAA8E;QAC9E,IAAI,QAAQ,KAAK,IAAI;YAAE,SAAS;QAChC,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IACH,MAAM,IAAI,GAAG,IAAI,GAAG,EAA2B,CAAC;IAChD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,yBAAyB,OAAO,CAAC,GAAG,KAAK,QAAQ,QAAQ,OAAO,CAAC,OAAO,IAAI;gBAC1E,qBAAqB,QAAQ,WAAW,CAC3C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAOD,wFAAwF;AACxF,MAAM,WAAW,GAAwC;IACvD,WAAW;IACX,UAAU;IACV,YAAY;IACZ,SAAS;IACT,SAAS;CACV,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,QAAoC;IAC/D,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjC,KAAK;QACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;KAChE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACnD,CAAC;AAKD,MAAM,YAAY,GAAqC;IACrD,GAAG,EAAE,GAAG;IACR,KAAK,EAAE,GAAG;IACV,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,GAAG;CACV,CAAC;AAEF,MAAM,MAAM,GAAqC;IAC/C,OAAO,EAAE,GAAG;IACZ,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,GAAG;IACd,UAAU,EAAE,GAAG;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,QAA0B;IACpE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAC/B,iFAAiF;IACjF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAE9E,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;IAC1E,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrF,CAAC"}