@magic-marker/prosemirror-suggest-changes 0.3.3-wrap-unwrap.29 → 0.4.0

package/dist/features/transactionShaping/types.d.ts

@@ -1,20 +0,0 @@
-import { type Node, type Schema } from "prosemirror-model";
-import { type EditorState, type Transaction } from "prosemirror-state";
-import { type ReplaceStep, type Transform } from "prosemirror-transform";
-import { type SuggestionId } from "../../generateId.js";
-import { type StructuralContextPath } from "../wrapUnwrap/types.js";
-export interface TipTapParagraphIntoListJoinShape {
-    type: "tipTapParagraphIntoListJoin";
-    deleteStep: ReplaceStep;
-    insertStep: ReplaceStep;
-    joinStep: ReplaceStep;
-    movedNode: Node;
-}
-export type SpecialTransactionShape = TipTapParagraphIntoListJoinShape;
-export interface HandleSpecialTransactionShapeArgs {
-    transaction: Transaction;
-    state: EditorState;
-    generateId: ((schema: Schema, doc?: Node) => SuggestionId) | undefined;
-    structuralContextPaths: StructuralContextPath[] | null;
-    ensureUniqueNodeIds: ((transactions: Transaction[], oldDoc: Node, newDoc: Node) => Transform) | undefined;
-}

package/dist/features/transactionShaping/types.js

@@ -1 +0,0 @@
-export { };

package/dist/features/wrapUnwrap/__tests__/blockquoteStructure.playwright.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/features/wrapUnwrap/__tests__/buildMaterializedPaths.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/features/wrapUnwrap/__tests__/listStructure.playwright.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/features/wrapUnwrap/__tests__/listStructureTextEdits.playwright.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/features/wrapUnwrap/__tests__/splitDetection.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/features/wrapUnwrap/addIdAttr.d.ts

@@ -1,2 +0,0 @@
-import { type NodeSpec } from "prosemirror-model";
-export declare const addIdAttr: (nodeSpec: NodeSpec) => NodeSpec;

package/dist/features/wrapUnwrap/addIdAttr.js

@@ -1,60 +0,0 @@
-export const addIdAttr = (nodeSpec)=>{
-    const { toDOM, parseDOM } = nodeSpec;
-    if (!toDOM || !parseDOM) {
-        return nodeSpec;
-    }
-    const newNodeSpec = {
-        ...nodeSpec,
-        attrs: {
-            ...nodeSpec.attrs ?? {},
-            id: {
-                default: null
-            }
-        },
-        toDOM (node) {
-            const domOutputSpec = toDOM(node);
-            if (!Array.isArray(domOutputSpec)) {
-                console.warn("addIdAttr", "domOutputSpec is not an array, id is not added", domOutputSpec);
-                return domOutputSpec;
-            }
-            const id = typeof node.attrs["id"] === "string" ? node.attrs["id"] : null;
-            const attrs = domOutputSpec[1];
-            if (!Array.isArray(attrs) && typeof attrs === "object" && attrs !== null) {
-                const theRest = domOutputSpec.slice(2);
-                const result = [
-                    domOutputSpec[0],
-                    id ? {
-                        ...attrs,
-                        "data-id": id
-                    } : attrs,
-                    ...theRest
-                ];
-                return result;
-            }
-            const theRest = domOutputSpec.slice(1);
-            const result = [
-                domOutputSpec[0],
-                id ? {
-                    "data-id": id
-                } : {},
-                ...theRest
-            ];
-            return result;
-        },
-        parseDOM: [
-            ...parseDOM.map((tagParseRule)=>({
-                    ...tagParseRule,
-                    getAttrs (dom) {
-                        const id = dom.getAttribute("data-id");
-                        return tagParseRule.getAttrs ? {
-                            ...tagParseRule.getAttrs(dom),
-                            id
-                        } : {
-                            id
-                        };
-                    }
-                }))
-        ]
-    };
-    return newNodeSpec;
-};

package/dist/features/wrapUnwrap/apply/applyStructureSuggestions.d.ts

@@ -1,10 +0,0 @@
-import { type Node } from "prosemirror-model";
-import { type Transform } from "prosemirror-transform";
-import { type SuggestionId } from "../../../generateId.js";
-export declare function applyStructureSuggestionsInNode({ tr, node, suggestionId, from, to, }: {
-    tr: Transform;
-    node: Node;
-    suggestionId?: SuggestionId;
-    from?: number | undefined;
-    to?: number | undefined;
-}): void;

package/dist/features/wrapUnwrap/apply/applyStructureSuggestions.js

@@ -1,41 +0,0 @@
-import { getSuggestionMarks } from "../../../utils.js";
-export function applyStructureSuggestionsInNode({ tr, node, suggestionId, from, to }) {
-    const { structure } = getSuggestionMarks(node.type.schema);
-    const suggestionIds = new Set();
-    node.descendants((node, pos)=>{
-        if (from !== undefined && pos < from) {
-            return true;
-        }
-        if (to !== undefined && pos > to) {
-            return false;
-        }
-        if (node.isText) return true;
-        if (!structure.isInSet(node.marks)) return true;
-        node.marks.forEach((mark)=>{
-            if (mark.type !== structure) return;
-            const markSuggestionId = mark.attrs["id"];
-            if (suggestionId != null && markSuggestionId !== suggestionId) return;
-            suggestionIds.add(markSuggestionId);
-        });
-        return true;
-    });
-    for (const suggestionId of suggestionIds){
-        applyOneStructureSuggestion(tr, suggestionId);
-    }
-}
-function applyOneStructureSuggestion(tr, suggestionId) {
-    const { structure } = getSuggestionMarks(tr.doc.type.schema);
-    tr.doc.descendants((node, pos)=>{
-        if (node.isText) return true;
-        if (!structure.isInSet(node.marks)) return true;
-        node.marks.forEach((mark)=>{
-            if (mark.type !== structure) return;
-            if (mark.attrs["id"] !== suggestionId) return;
-            applyStructureMark(tr, mark, pos);
-        });
-        return true;
-    });
-}
-function applyStructureMark(tr, mark, pos) {
-    tr.removeNodeMark(pos, mark);
-}

package/dist/features/wrapUnwrap/apply/index.d.ts

@@ -1,5 +0,0 @@
-import { Transform } from "prosemirror-transform";
-import { type Node } from "prosemirror-model";
-import { type SuggestionId } from "../../../generateId.js";
-export declare function applyAllStructureSuggestions(node: Node, from?: number, to?: number): Transform;
-export declare function applyStructureSuggestion(node: Node, suggestionId: SuggestionId): Transform;

package/dist/features/wrapUnwrap/apply/index.js

@@ -1,21 +0,0 @@
-import { Transform } from "prosemirror-transform";
-import { applyStructureSuggestionsInNode } from "./applyStructureSuggestions.js";
-export function applyAllStructureSuggestions(node, from, to) {
-    const tr = new Transform(node);
-    applyStructureSuggestionsInNode({
-        tr,
-        node: tr.doc,
-        from,
-        to
-    });
-    return tr;
-}
-export function applyStructureSuggestion(node, suggestionId) {
-    const tr = new Transform(node);
-    applyStructureSuggestionsInNode({
-        tr,
-        node: tr.doc,
-        suggestionId
-    });
-    return tr;
-}

package/dist/features/wrapUnwrap/areEquivalentStructureMarks.d.ts

@@ -1,2 +0,0 @@
-import { type Mark } from "prosemirror-model";
-export declare function areEquivalentStructureMarks(a: Mark, b: Mark): boolean;

package/dist/features/wrapUnwrap/areEquivalentStructureMarks.js

@@ -1,17 +0,0 @@
-import { sameParentChain } from "./sameParentChain.js";
-import { guardStructureMarkAttrs } from "./types.js";
-export function areEquivalentStructureMarks(a, b) {
-    if (a.type !== b.type) return false;
-    if (!guardStructureMarkAttrs(a.attrs)) return false;
-    if (!guardStructureMarkAttrs(b.attrs)) return false;
-    const aOp = a.attrs.data.op;
-    const bOp = b.attrs.data.op;
-    if (aOp.op !== bOp.op) return false;
-    if (aOp.op === "add" && bOp.op === "add") {
-        return a.attrs.id === b.attrs.id;
-    }
-    if (aOp.op === "move" && bOp.op === "move") {
-        return sameParentChain(aOp.from, bOp.from) && sameParentChain(aOp.to, bOp.to);
-    }
-    return false;
-}

package/dist/features/wrapUnwrap/buildMaterializedPaths.d.ts

@@ -1,3 +0,0 @@
-import { type MaterializedPaths } from "./types.js";
-import { type Node } from "prosemirror-model";
-export declare function buildMaterializedPaths(doc: Node): MaterializedPaths;

package/dist/features/wrapUnwrap/buildMaterializedPaths.js

@@ -1,82 +0,0 @@
-import { getNodeId } from "./getNodeId.js";
-import { DOC_NODE_ID } from "./constants.js";
-const TRACE_ENABLED = false;
-function trace(...args) {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!TRACE_ENABLED) return;
-    console.log("[structureChanges]", ...args);
-}
-export function buildMaterializedPaths(doc) {
-    const perfPaths = performance.now();
-    const paths = new Map();
-    // add direct doc children first since they have a specific parent signature due to doc not having an ID
-    doc.children.forEach((node, index, children)=>{
-        const nodeId = getNodeId(node);
-        if (nodeId == null) return;
-        const leftSibling = children[index - 1];
-        const leftSiblingId = leftSibling ? getNodeId(leftSibling) : null;
-        const rightSibling = children[index + 1];
-        const rightSiblingId = rightSibling ? getNodeId(rightSibling) : null;
-        const parent = {
-            nodeId: DOC_NODE_ID,
-            nodeType: DOC_NODE_ID,
-            nodeAttrs: {},
-            nodeMarks: [],
-            childSiblingIds: [
-                leftSiblingId,
-                rightSiblingId
-            ],
-            childIndex: index
-        };
-        paths.set(nodeId, {
-            nodeType: node.type.name,
-            node,
-            chain: [
-                parent
-            ]
-        });
-    });
-    // now add the rest of the nodes
-    doc.descendants((node, _pos, parent, childIndex)=>{
-        if (node.isInline) return false;
-        const nodeId = getNodeId(node);
-        if (nodeId == null) return true;
-        // this is to avoid processing direct doc children twice
-        if (paths.has(nodeId)) return true;
-        if (parent == null) return true;
-        const parentId = getNodeId(parent);
-        if (parentId == null) return true;
-        // by definition, for any node it's parent chain should already exist
-        // because we go downwards
-        const parentChain = paths.get(parentId);
-        if (parentChain == null) return true;
-        const leftSibling = parent.children[childIndex - 1];
-        const leftSiblingId = leftSibling ? getNodeId(leftSibling) : null;
-        const rightSibling = parent.children[childIndex + 1];
-        const rightSiblingId = rightSibling ? getNodeId(rightSibling) : null;
-        // (this node parent chain) is (parent chain of the parent node) + (the parent node itself)
-        const parentDesc = {
-            nodeId: parentId,
-            nodeType: parent.type.name,
-            nodeAttrs: parent.attrs,
-            nodeMarks: parent.marks.map((mark)=>mark.toJSON()),
-            childSiblingIds: [
-                leftSiblingId,
-                rightSiblingId
-            ],
-            childIndex: childIndex
-        };
-        const chain = [
-            parentDesc,
-            ...parentChain.chain
-        ];
-        paths.set(nodeId, {
-            nodeType: node.type.name,
-            node,
-            chain
-        });
-        return true;
-    });
-    trace("perf", "buildMaterializedPaths", "took", Number((performance.now() - perfPaths).toFixed(2)), "ms");
-    return paths;
-}

package/dist/features/wrapUnwrap/constants.d.ts

@@ -1,3 +0,0 @@
-export declare const DOC_NODE_ID = "__doc__";
-export declare const STRUCTURE_CHANGES_ADD_MARKS = "structure-changes-add-mark-type";
-export declare const STRUCTURE_CHANGES_REVERT_MARKS = "structure-changes-revert-mark-type";

package/dist/features/wrapUnwrap/constants.js

@@ -1,3 +0,0 @@
-export const DOC_NODE_ID = "__doc__";
-export const STRUCTURE_CHANGES_ADD_MARKS = "structure-changes-add-mark-type";
-export const STRUCTURE_CHANGES_REVERT_MARKS = "structure-changes-revert-mark-type";

package/dist/features/wrapUnwrap/generateUniqueNodeId.d.ts

@@ -1 +0,0 @@
-export declare function generateUniqueNodeId(): string;

package/dist/features/wrapUnwrap/generateUniqueNodeId.js

@@ -1,6 +0,0 @@
-export function generateUniqueNodeId() {
-    if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
-        return crypto.randomUUID();
-    }
-    return `node-${Math.random().toString(36).slice(2)}`;
-}

package/dist/features/wrapUnwrap/getNodeId.d.ts

@@ -1,2 +0,0 @@
-import { type Node } from "prosemirror-model";
-export declare function getNodeId(node: Node): string | null;

package/dist/features/wrapUnwrap/getNodeId.js

@@ -1,5 +0,0 @@
-export function getNodeId(node) {
-    const nodeId = node.attrs["id"];
-    if (typeof nodeId !== "string") return null;
-    return nodeId;
-}

package/dist/features/wrapUnwrap/revert/deleteNodeUpwards.d.ts

@@ -1,3 +0,0 @@
-import { type Transform } from "prosemirror-transform";
-import { type Node } from "prosemirror-model";
-export declare function deleteNodeUpwards(transform: Transform, node: Node, pos: number): void;

package/dist/features/wrapUnwrap/revert/deleteNodeUpwards.js

@@ -1,37 +0,0 @@
-import { getNodeId } from "../getNodeId.js";
-const TRACE_ENABLED = false;
-function trace(...args) {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!TRACE_ENABLED) return;
-    console.log("[deleteNodeUpwards]", "\n", ...args);
-}
-// delete a given node, and traverse upwards deleting parent nodes if they are now empty
-export function deleteNodeUpwards(transform, node, pos) {
-    let $mappedPos = transform.doc.resolve(pos);
-    trace("attempting to delete node", node.type.name, getNodeId(node), "\n", "node subtree:\n", node.toString(), "\n", "node parent:", $mappedPos.parent.type.name, getNodeId($mappedPos.parent), "\n", {
-        node,
-        parent: $mappedPos.parent
-    });
-    let deleteFrom = $mappedPos.pos;
-    let deleteTo = $mappedPos.pos + node.nodeSize;
-    while($mappedPos.depth > 0){
-        const $nextMappedPos = transform.doc.resolve($mappedPos.before());
-        if ($nextMappedPos.nodeAfter?.childCount !== 1) {
-            trace("stopping deletion at non-empty node:", $nextMappedPos.nodeAfter?.type.name, $nextMappedPos.nodeAfter == null ? null : getNodeId($nextMappedPos.nodeAfter), "\n", "non-empty node parent:", $nextMappedPos.parent.type.name, getNodeId($nextMappedPos.parent), "\n", "non-empty node subtree:\n", $nextMappedPos.nodeAfter?.toString(), "\n", "non-empty node subtree direct children:\n", $nextMappedPos.nodeAfter?.children.map((child)=>`${child.type.name} ${getNodeId(child) ?? "null"}`).join(", "), {
-                nonEmptyNode: $nextMappedPos.nodeAfter,
-                nonEmptyNodeParent: $nextMappedPos.parent
-            });
-            break;
-        }
-        $mappedPos = $nextMappedPos;
-        deleteFrom = $nextMappedPos.pos;
-        deleteTo = $nextMappedPos.pos + $nextMappedPos.nodeAfter.nodeSize;
-    }
-    trace("deleting subtree:\n", $mappedPos.nodeAfter?.toString(), "\n", "subtree root node:", $mappedPos.nodeAfter?.type.name, $mappedPos.nodeAfter == null ? null : getNodeId($mappedPos.nodeAfter), "\n", "subtree root parent node:", $mappedPos.parent.type.name, getNodeId($mappedPos.parent), "\n", "non-empty node subtree direct children:\n", $mappedPos.nodeAfter?.children.map((child)=>`${child.type.name} (${getNodeId(child) ?? "null"}`).join(", "), "\n", {
-        node: $mappedPos.nodeAfter,
-        parent: $mappedPos.parent,
-        $deleteFrom: $mappedPos.doc.resolve(deleteFrom),
-        $deleteTo: $mappedPos.doc.resolve(deleteTo)
-    });
-    transform.delete(deleteFrom, deleteTo);
-}

package/dist/features/wrapUnwrap/revert/index.d.ts

@@ -1,5 +0,0 @@
-import { Transform } from "prosemirror-transform";
-import { type Node } from "prosemirror-model";
-import { type SuggestionId } from "../../../generateId.js";
-export declare function revertAllStructureSuggestions(doc: Node, from?: number, to?: number): Transform;
-export declare function revertStructureSuggestion(doc: Node, suggestionId: SuggestionId): Transform;

package/dist/features/wrapUnwrap/revert/index.js

@@ -1,19 +0,0 @@
-import { Transform } from "prosemirror-transform";
-import { revertStructureSuggestionsInDoc } from "./revertStructureSuggestions.js";
-export function revertAllStructureSuggestions(doc, from, to) {
-    const tr = new Transform(doc);
-    revertStructureSuggestionsInDoc({
-        tr,
-        from,
-        to
-    });
-    return tr;
-}
-export function revertStructureSuggestion(doc, suggestionId) {
-    const tr = new Transform(doc);
-    revertStructureSuggestionsInDoc({
-        tr,
-        suggestionId
-    });
-    return tr;
-}

package/dist/features/wrapUnwrap/revert/revertAddOp.d.ts

@@ -1,4 +0,0 @@
-import { type Transform } from "prosemirror-transform";
-import { type AddOp } from "../types.js";
-import { type Node } from "prosemirror-model";
-export declare function revertAddOp(_op: AddOp, tr: Transform, node: Node, pos: number): void;

package/dist/features/wrapUnwrap/revert/revertAddOp.js

@@ -1,4 +0,0 @@
-import { deleteNodeUpwards } from "./deleteNodeUpwards.js";
-export function revertAddOp(_op, tr, node, pos) {
-    deleteNodeUpwards(tr, node, pos);
-}

package/dist/features/wrapUnwrap/revert/revertMoveOp.d.ts

@@ -1,16 +0,0 @@
-import { type Transform } from "prosemirror-transform";
-import { type MoveOp } from "../types.js";
-import { type Node } from "prosemirror-model";
-import { type Parent } from "../types.js";
-export declare function revertMoveOp(op: MoveOp, tr: Transform, node: Node, pos: number): void;
-export declare function getDeepestSurvivingParent(parentChain: Parent[], doc: Node): {
-    parent: Parent;
-    node: Node;
-    pos: number | null;
-    remainingChain: Parent[];
-};
-export declare function wrapNodeInParentChain(parentChain: Parent[], node: Node): Node;
-export declare function findInsertionPos(node: Node, pos: number | null, parent: Parent, child: Node): number | {
-    from: number;
-    to: number;
-};

package/dist/features/wrapUnwrap/revert/revertMoveOp.js

@@ -1,122 +0,0 @@
-import { deleteNodeUpwards } from "./deleteNodeUpwards.js";
-import { getNodeId } from "../getNodeId.js";
-export function revertMoveOp(op, tr, node, pos) {
-    const parent = getDeepestSurvivingParent(op.from, tr.doc);
-    const child = wrapNodeInParentChain(parent.remainingChain, node);
-    const insertTo = findInsertionPos(parent.node, parent.pos, parent.parent, child);
-    if (typeof insertTo === "number") {
-        tr.insert(insertTo, child);
-    } else {
-        tr.replaceWith(insertTo.from, insertTo.to, child);
-    }
-    const mappedPos = tr.mapping.map(pos);
-    deleteNodeUpwards(tr, node, mappedPos);
-}
-// given a chain of parent node descriptors, follow the chain from top to bottom as long as nodes exist
-// return the deepest existing parent node descriptor, along with the actual node and the pos in the current document
-// also return the remaining part of the chain
-export function getDeepestSurvivingParent(parentChain, doc) {
-    const chain = [
-        ...parentChain
-    ].reverse();
-    const root = chain.shift();
-    if (root == null) {
-        throw new Error("Parent chain is empty");
-    }
-    let result = {
-        parent: root,
-        node: doc,
-        pos: null
-    };
-    let remainingChain = [
-        ...chain
-    ];
-    // follow the chain up-down
-    // look for the node with the matching id in the children of the previously found node
-    for (const [index, item] of chain.entries()){
-        let found = false;
-        result.node.forEach((child, offset)=>{
-            if (found) return;
-            if (child.attrs["id"] !== item.nodeId) return;
-            found = true;
-            const pos = result.pos == null ? offset : result.pos + 1 + offset;
-            result = {
-                parent: item,
-                node: child,
-                pos
-            };
-            remainingChain = chain.slice(index + 1);
-        });
-        if (!found) break;
-    }
-    return {
-        parent: result.parent,
-        node: result.node,
-        pos: result.pos,
-        remainingChain: remainingChain.reverse()
-    };
-}
-// given a chain of parent node descriptors and a node
-// wrap the node in the parent chain
-export function wrapNodeInParentChain(parentChain, node) {
-    let child = node.copy(node.content);
-    for (const parent of parentChain){
-        const schema = node.type.schema;
-        const nodeType = schema.nodes[parent.nodeType];
-        if (!nodeType) {
-            throw new Error(`node type ${parent.nodeType} not found in schema`);
-        }
-        const marks = parent.nodeMarks.map((mark)=>schema.markFromJSON(mark));
-        const parentNode = nodeType.createAndFill(parent.nodeAttrs, child, marks);
-        if (parentNode == null) throw new Error(`Unable to create node ${nodeType.name} with child ${child.toString()}`);
-        child = parentNode;
-        child.check();
-    }
-    return child;
-}
-// given a node, its position, and a parent descriptor of this node in some parent chain,
-// use the info from the descriptor to find the insertion position in the node
-// first try to find siblings, fallback to end of node
-export function findInsertionPos(node, pos, parent, child) {
-    let leftSibling = null;
-    let rightSibling = null;
-    node.descendants((child, localChildPos)=>{
-        const childId = getNodeId(child);
-        if (childId == null) return false;
-        const globalChildPos = pos != null ? pos + 1 + localChildPos : localChildPos;
-        if (parent.childSiblingIds[0] === childId) {
-            leftSibling = {
-                node: child,
-                pos: globalChildPos
-            };
-        }
-        if (parent.childSiblingIds[1] === childId) {
-            rightSibling = {
-                node: child,
-                pos: globalChildPos
-            };
-        }
-        // iterate only direct children
-        return false;
-    });
-    if (rightSibling != null) {
-        // special case: we need to insert as the first child, but the existing first child is an empty node of the same type
-        // in this case, we need to replace the existing first child with the new node
-        const firstChild = node.children[0];
-        if (parent.childSiblingIds[0] == null && firstChild?.type === child.type && firstChild.textContent === "") {
-            const from = pos != null ? pos + 1 : 0;
-            return {
-                from,
-                to: from + firstChild.nodeSize
-            };
-        }
-        // insert before right sibling
-        return rightSibling.pos;
-    }
-    if (leftSibling != null) {
-        // insert after left sibling
-        return leftSibling.pos + leftSibling.node.nodeSize;
-    }
-    // insert at end of node
-    return pos != null ? pos + node.nodeSize - 1 : node.content.size;
-}

package/dist/features/wrapUnwrap/revert/revertStructureSuggestions.d.ts

@@ -1,10 +0,0 @@
-import { type Mark } from "prosemirror-model";
-import { Transform } from "prosemirror-transform";
-import { type SuggestionId } from "../../../generateId.js";
-export declare function revertStructureSuggestionsInDoc({ tr, suggestionId, from, to, }: {
-    tr: Transform;
-    suggestionId?: SuggestionId;
-    from?: number | undefined;
-    to?: number | undefined;
-}): void;
-export declare function revertStructureMark(tr: Transform, mark: Mark, pos: number): void;