@nerd-bible/wordgard 0.5.3-beta7 → 0.6.2-beta10

package/dist/collab.js

@@ -37,6 +37,7 @@ class CollabState {
     }
 }
 const collabConfig = /*@__PURE__*/GardState.Facet.define({
+    name: "collabConfig",
     combine(configs) {
         let combined = GardState.Facet.combineConfig(configs, {
             startVersion: 0,
@@ -52,12 +53,14 @@ const collabConfig = /*@__PURE__*/GardState.Facet.define({
     }
 });
 const collabReceive = /*@__PURE__*/Transaction.Effect.define({
+    name: "collabReceive",
     map(state, changes) {
         return changes.empty ? state
             : new CollabState(state.version, state.syncedDoc, state.nextUpdate, addUpdate(state.openUpdate, changes));
     }
 });
 const collabField = /*@__PURE__*/GardState.Field.define({
+    name: "collab",
     create(state) {
         return new CollabState(state.facet(collabConfig).startVersion, state.doc, null, null);
     },

package/dist/command.d.ts

@@ -518,10 +518,10 @@ declare const enter: Command.Pure;
 /**
 Delete the selection, or the unit after or before the selection.
 If that unit is the start or end of a textblock, this will try to
-join that textblock to the next one. Otherwise, if it is a
-character or leaf node, that is deleted. If none of that is
-possible and the cursor is in an empty textblock, this will delete
-the textblock.
+join that textblock to the next one. Otherwise, if the cursor is
+in an empty textblock, this will delete the textblock. Finally, if
+there is a character or leaf node in the given direction, that is
+deleted.
 
 When deleting backward at the start of a list item that has a
 sibling before it, this command will try to join those list items.
@@ -709,9 +709,17 @@ declare const redo: Command;
 
 /**
 If the cursor is in an empty textblock that can be lifted out of a
-parent, return a transaction that does this.
+parent, return a transaction that does this. Unless
+`splitListItem` is set to false, if the block is part of a
+continued list item, this function will split the item above the
+block before it lifts it.
 */
-declare function liftEmptyBlock(state: GardState): Transaction.Spec | false;
+declare function liftEmptyBlock(state: GardState, splitListItem?: boolean): Transaction.Spec | false;
+/**
+Lift the textblock that the cursor is at the start of out of its
+innermost parent, if possible.
+*/
+declare function liftTextblock(state: GardState): Transaction.Spec | false;
 /**
 If the selection is in a {@link Plot.Spec.preserveWhitespace
 `preserveWhitespace`} textblock, replace the selected content with
@@ -823,4 +831,4 @@ updated to perform those joins.
 */
 declare function autoJoinBlocks(state: GardState, tr: Transaction.Spec): Transaction.Spec;
 
-export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, killToLineEnd, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange, yankKilled };
+export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, killToLineEnd, liftEmptyBlock, liftTextblock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange, yankKilled };

package/dist/command.js

@@ -5,6 +5,7 @@ import { findClusterBreak } from '@marijn/find-cluster-break';
 import { Alignment, Direction, Emphasis, Strong, Underline } from 'wordgard/types';
 
 const commandHandler = /*@__PURE__*/GardState.Facet.define({
+    name: "commandHandler",
     combine(handlers) {
         let map = new Map();
         for (let [cmd, handler] of handlers) {
@@ -45,12 +46,27 @@ const Command = /*@__PURE__*/(function (Command) {
     Command.dispatch = dispatch;
 ;return Command})({});
 
-function liftEmptyBlock(state) {
+function liftEmptyBlock(state, splitListItem = true) {
     if (!state.selection.isCursor)
         return false;
     let sel = state.sel, block = sel.head.textblockParent;
     if (!block || !sel.head.isAtStart(block) || !sel.head.isAtEnd(block))
         return false;
+    if (splitListItem && block.parent?.parent && block.index && block.parent.parent.node.type.hasRole(Node.Role.List))
+        return {
+            changes: { from: block.before, insert: [Plot.End, block.parent.node.tag] },
+            scrollIntoView: true,
+            userEvent: "split.list"
+        };
+    return liftBlock(state, block);
+}
+function liftTextblock(state) {
+    if (!state.selection.isCursor)
+        return false;
+    let { head } = state.sel, block = head.textblockParent;
+    return !block || !head.isAtStart(block) ? false : liftBlock(state, block);
+}
+function liftBlock(state, block) {
     let start = block.before, end = block.after, before = [], after = [];
     for (let level = block.parent, index = block.index, atStart = true, atEnd = true, first = true; level; first = false, index = level.index, level = level.parent) {
         if (!first && state.schema.canContain(level.node.type, block.node.type))
@@ -60,7 +76,7 @@ function liftEmptyBlock(state) {
                     { from: block.after, to: end, insert: after }
                 ],
                 scrollIntoView: true,
-                userEvent: "unwrap.empty"
+                userEvent: "unwrap"
             };
         if (level.node.isInline || level.node.type.isolating)
             break;
@@ -111,7 +127,7 @@ function enterInCode(state) {
 function splitTextblock(state, splitListItem = true) {
     let { from, to } = state.sel.replacementRange, { schema } = state.doc;
     let before = from.textblockParent;
-    if (!before || !before.parent)
+    if (!before || !before.parent || before.node.type.isolating)
         return false;
     let tokens = [];
     for (let p = from.parent;; p = p.parent) {
@@ -196,7 +212,7 @@ function joinBackward(state) {
     if (!state.selection.isCursor)
         return false;
     let { head } = state.sel, block = head.textblockParent;
-    if (!block || !head.isAtStart(block))
+    if (!block || !head.isAtStart(block) || block.node.type.isolating)
         return false;
     let scan = block, target = scan.node;
     while (!scan.index) {
@@ -264,7 +280,7 @@ function joinForward(state) {
     if (!state.selection.isCursor)
         return false;
     let { head } = state.sel, block = head.textblockParent;
-    if (!block || !head.isAtEnd(block))
+    if (!block || !head.isAtEnd(block) || block.node.type.isolating)
         return false;
     let scan = block, target = scan.node;
     for (;;) {
@@ -740,7 +756,7 @@ const insertText = ({ state }, { from, to, insert, userEvent }) => {
     let marks = (from == selection.from && to == selection.to && state.sel.activeMarks) ||
         state.doc.resolve(from).marks(state.doc.resolve(to));
     return {
-        changes: { from, to, insert: [Leaf.Text.of(insert, marks)], fit: true },
+        changes: { from, to, insert: insert ? [Leaf.text(insert, marks)] : undefined, fit: true },
         scrollIntoView: true,
         selection: (cx, changes) => GardSelection.near(cx, changes.mapPos(to, 1), -1),
         userEvent
@@ -792,8 +808,8 @@ const deleteUnit = ({ state }, dir) => {
     if (state.readOnly)
         return false;
     return deleteSelection(state) || (dir == "forward"
-        ? joinForward(state) || deleteForward(state) || deleteEmptyPlot(state, 1)
-        : joinListItems(state) || joinBackward(state) || deleteBackward(state) || deleteEmptyPlot(state, -1));
+        ? joinForward(state) || deleteEmptyPlot(state, 1) || deleteForward(state)
+        : joinListItems(state) || liftTextblock(state) || joinBackward(state) || deleteEmptyPlot(state, -1) || deleteBackward(state));
 };
 const deleteWord = ({ state }, dir) => {
     if (state.readOnly)
@@ -819,8 +835,9 @@ const deleteToLineEnd = (wg, dir) => {
         userEvent: "delete." + dir
     };
 };
-const addToKillBuffer = /*@__PURE__*/Transaction.Effect.define();
+const addToKillBuffer = /*@__PURE__*/Transaction.Effect.define({ name: "addToKillBuffer" });
 const killBuffer = /*@__PURE__*/GardState.Field.define({
+    name: "killBuffer",
     create() { return { content: [], active: false }; },
     update(value, tr) {
         let add = tr.effects.find(e => e.is(addToKillBuffer));
@@ -831,7 +848,7 @@ const killBuffer = /*@__PURE__*/GardState.Field.define({
     }
 });
 function killText(state, from, to) {
-    let add = addToKillBuffer.of(state.doc.slice(from, to).content);
+    let add = addToKillBuffer.of(state.doc.slice(from, to));
     return state.field(killBuffer, false) ? [add] : [GardState.appendConfig.of(killBuffer), add];
 }
 const killToLineEnd = wg => {
@@ -1181,7 +1198,7 @@ function isForward(dir, state) {
 }
 function asTextSel(sel, forward) {
     if (sel instanceof GardSelection.Text)
-        return sel;
+        return sel.directional ? sel : forward ? GardSelection.range(sel.from, sel.to) : GardSelection.range(sel.to, sel.from);
     let { from, to } = sel.replacementRange;
     return forward ? GardSelection.range(from, to) : GardSelection.range(to, from);
 }
@@ -1246,13 +1263,13 @@ function pageHeight(wg) {
     return Math.max(10, Math.min(wg.scrollDOM.clientHeight - marginTop - marginBottom, (wg.dom.ownerDocument.defaultView || window).innerHeight) - 10);
 }
 const moveByPage = (wg, { dir, extend }) => {
-    let { state } = wg, { selection } = state, forward = dir == "down";
+    let { state } = wg, forward = dir == "down", selection = asTextSel(state.selection, forward);
     let moved = selection.empty || extend ? nextVertical(wg, selection, forward, pageHeight(wg), !extend)
         : forward ? GardSelection.cursor(selection.to, -1) : GardSelection.cursor(selection.from, 1);
     return moved ? setSelection(extend ? extendSel(selection, moved) : moved) : false;
 };
 const moveToLineSide = (wg, { dir, extend }) => {
-    let forward = isForward(dir, wg.state), { selection } = wg.state;
+    let forward = isForward(dir, wg.state), selection = asTextSel(wg.state.selection, forward);
     let pos = wg.moveToLineBoundary(selection, forward);
     return pos ? setSelection(extend ? extendSel(selection, pos) : pos)
         : extend || selection.empty ? false
@@ -1262,15 +1279,16 @@ const moveToTextblockSide = (wg, { dir, extend }) => {
     let { state } = wg, block = state.sel.head.textblockParent;
     if (!block)
         return false;
-    let pos = isForward(dir, wg.state) ? GardSelection.atEnd(state, block) : GardSelection.atStart(state, block);
-    return setSelection(extend ? extendSel(wg.state.selection, pos) : pos);
+    let forward = isForward(dir, wg.state);
+    let pos = forward ? GardSelection.atEnd(state, block) : GardSelection.atStart(state, block);
+    return setSelection(extend ? extendSel(asTextSel(wg.state.selection, forward), pos) : pos);
 };
 const moveToDocSide = (target, { side, extend }) => {
     let { state } = target;
     let pos = side == "start" ? GardSelection.atStart(state) : GardSelection.atEnd(state);
     if (state.selection.empty && pos.head == state.selection.head)
         return false;
-    return setSelection(extend ? extendSel(state.selection, pos) : pos);
+    return setSelection(extend ? extendSel(asTextSel(state.selection, side == "end"), pos) : pos);
 };
 const selectAll = ({ state }) => {
     return {
@@ -1302,9 +1320,10 @@ const Menu = /*@__PURE__*/(function (Menu) {
                 let src = Menu.Item.source.of(this);
                 this.extension = this.parent ? [src, this.parent] : src;
             }
+            toString() { return "Menu.Item"; }
         }
         Item.Base = Base;
-        Item.source = GardState.Facet.define();
+        Item.source = GardState.Facet.define({ name: "menuItem" });
     })(Item = Menu.Item || (Menu.Item = {}));
     class Button extends Item.Base {
         spec;
@@ -1379,6 +1398,7 @@ const Menu = /*@__PURE__*/(function (Menu) {
         template(...content) {
             return Template.new(this, content.length ? content : ["..."]);
         }
+        toString() { return "Menu.Group"; }
     }
     Menu.Group = Group;
     (function (Group) {
@@ -1540,4 +1560,4 @@ const Menu = /*@__PURE__*/(function (Menu) {
     Menu.resolve = resolve;
 ;return Menu})({});
 
-export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, killToLineEnd, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange, yankKilled };
+export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, killToLineEnd, liftEmptyBlock, liftTextblock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange, yankKilled };

package/dist/doc.d.ts

@@ -32,10 +32,7 @@ declare namespace parse {
     /**
     Parse the given DOM structure as a slice.
     */
-    function slice(schema: Schema, doc: Element | DocumentFragment, options?: parse.Options): {
-        slice: Slice;
-        context: Plot.Tag<unknown>[];
-    };
+    function slice(schema: Schema, doc: Element | DocumentFragment, options?: parse.Options): Slice;
     /**
     Parse rules describe how DOM constructs should map to Wordgard
     document nodes. Many can be automatically derived from node and
@@ -779,15 +776,38 @@ declare namespace Token {
         Close = 1,
         Node = 2
     }
+    /**
+    A token's JSON representation.
+    */
+    type JSON = Node.JSON | ".";
+    /**
+    Read a token from its JSON representation.
+    */
+    function fromJSON(schema: Schema, value: JSON): Leaf<unknown> | Plot | Plot.Tag<unknown> | {
+        tokenType: Token.Type.Close;
+        toJSON(): any;
+    };
 }
 /**
-A slice represents a part of a document. It is used to represent
-inserted content in {@link ChangeSet change sets}, or things like
-clipboard content.
+A slice represents a part of a document, as an array of tokens
+plus a context. It is used to represent things like clipboard
+content and insertions given when building a {@link ChangeSet
+change set}.
 */
 declare class Slice {
+    /**
+    The tokens contained in this slice.
+    */
     readonly content: readonly Token[];
     /**
+    This slice's context, an array of tags that can be used as a
+    hint when the slice's content needs to be wrapped in
+    additional content to fit somewhere, ordered with the
+    innermost nodes in front. May be empty when there
+    is no context available.
+    */
+    readonly context: readonly Plot.Tag[];
+    /**
     The length of the slice's content.
     */
     readonly length: number;
@@ -795,15 +815,7 @@ declare class Slice {
     /**
     Create a slice.
     */
-    static of(content: readonly Token[]): Slice;
-    /**
-    Compare a slice to another one.
-    */
-    eq(other: Slice): boolean;
-    /**
-    Create a sub-slice of this slice.
-    */
-    slice(from: number, to?: number): Slice;
+    static of(content: readonly Token[], context?: readonly Plot.Tag[]): Slice;
     /**
     Concatenate this slice to another slice.
     */
@@ -820,19 +832,10 @@ declare class Slice {
     */
     static empty: Slice;
     /**
-    Convert this slice to a JSON-serializeable representation.
-    */
-    toJSON(): Slice.JSON;
-    /**
-    Build a slice from its JSON representation.
-    */
-    static fromJSON(schema: Schema, json: Slice.JSON): Slice;
-}
-declare namespace Slice {
-    /**
-    A slice's JSON representation.
+    Create a slice (with context) from the given range of document
+    content. `to` defaults to the end of the document.
     */
-    type JSON = readonly (Node.JSON | ".")[];
+    static get(doc: Plot.Doc, from: number, to?: number): Slice;
 }
 
 type _Node = Node;
@@ -1017,11 +1020,11 @@ declare namespace Pos {
         /**
         The node before this one, if any.
         */
-        get nextSibling(): Node | null;
+        get nextSibling(): _Node | null;
         /**
         The node after this node, if any.
         */
-        get previousSibling(): Node | null;
+        get previousSibling(): _Node | null;
     }
     /**
     Subclass of {@link Pos.Node} that points at a plot node.
@@ -1307,12 +1310,19 @@ declare namespace Node {
         implies membership of its parent groups.
         */
         readonly parent: Group | undefined;
+        /**
+        This group's debug name.
+        */
+        readonly name: string | null;
         private tag;
         private constructor();
         /**
         Define a custom node group.
         */
-        static define(parent?: Group): Group;
+        static define(spec?: {
+            parent?: Group;
+            name?: string;
+        }): Group;
         /**
         A group that contains every node type.
         */
@@ -1371,11 +1381,15 @@ declare namespace Node {
     whether a given node has the role attached.
     */
     class Role {
+        /**
+        This role's name.
+        */
+        readonly name: string | null;
         private constructor();
         /**
         Define a new role.
         */
-        static define(): Role;
+        static define(name?: string): Role;
         /**
         This role indicates that a plot contains code, and makes some
         commands behave differently inside such a plot.
@@ -1623,6 +1637,7 @@ declare namespace Plot {
     */
     const End: {
         tokenType: Token.Type.Close;
+        toJSON(): any;
     };
     /**
     A plot tag holds the type of the plot, its parameter (if any),
@@ -1867,9 +1882,9 @@ declare namespace Plot {
         */
         contextAt(pos: number, maxDepth?: number): readonly Plot.Tag[];
         /**
-        Create a slice of the content between `from` and `to`.
+        Create a token slice of the content between `from` and `to`.
         */
-        slice(from: number, to?: number): Slice;
+        slice(from: number, to?: number): readonly Token[];
     }
 }
 
@@ -2013,7 +2028,7 @@ declare class ChangeSet {
     that are either preserved as-is (when `modifications` is null)
     or only have marks modified.
     */
-    iterChanges(replaced: (fromA: number, toA: number, fromB: number, toB: number, inserted: Slice) => void, preserved?: (fromA: number, toA: number, fromB: number, toB: number, modifications: readonly Modification[] | null) => void): void;
+    iterChanges(replaced: (fromA: number, toA: number, fromB: number, toB: number, inserted: readonly Token[]) => void, preserved?: (fromA: number, toA: number, fromB: number, toB: number, modifications: readonly Modification[] | null) => void): void;
     /**
     Iterate over the sections of the document this change leaves
     unchanged or which have only mark changes. `posA` provides the
@@ -2083,18 +2098,16 @@ declare namespace ChangeSet {
         */
         to?: number;
         /**
-        Replace the given range with this slice.
+        Replace the given range with this slice. If `fit` is `true`
+        and a {@link Slice} is given here, its context will be used to
+        do the fitting.
         */
         insert?: Slice | readonly Token[];
         /**
         For deletions or insertions where it isn't obvious that the
-        replacement will produce a valid document, set this to `true`
-        or a stack of context tags to make the library process the
-        replacement to make sure it fits. Context tags (passed with
-        the innermost tag first, as in {@link Plot.Doc.contextAt} may
-        be used as wrappers when fitting the slice.
+        replacement will produce a valid document, set this to `true`.
         */
-        fit?: boolean | readonly Plot.Tag[];
+        fit?: boolean;
         /**
         Add the given mark to this change's range. Cannot be combined
         with `insert`.
@@ -2150,7 +2163,7 @@ declare namespace ChangeSet {
     /**
     The JSON representation of a change set.
     */
-    type JSON = readonly (number | [number, Slice.JSON | readonly ModificationJSON[]])[];
+    type JSON = readonly (number | [number, readonly Token.JSON[] | readonly ModificationJSON[]])[];
     /**
     Modes available in {@link ChangeSet.mapPos} to control whether
     `null` is returned on nearby deletions.
@@ -2193,11 +2206,11 @@ declare namespace serialize {
     /**
     Serialize a single node.
     */
-    function node(node: Node, options: serialize.Options): Elt | string;
+    function node(node: Node, options?: serialize.Options): Elt | string;
     /**
     Serialize a slice.
     */
-    function slice(slice: Slice, options: slice.Options): Elt.Fragment;
+    function slice(slice: Slice, options?: slice.Options): Elt.Fragment;
     namespace slice {
         /**
         Options passed to {@link serialize.slice}.
@@ -2210,11 +2223,6 @@ declare namespace serialize {
             */
             openAttr?: string;
             /**
-            The slice's context. Will be used to determine the type of
-            open nodes at the start of the slice.
-            */
-            context?: readonly Plot.Tag[];
-            /**
             The amount of context nodes to include in the output.
             Defaults to 0, meaning only use those that are open at the
             start of the slice.