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

package/dist/features/wrapUnwrap/uniqueNodeIdsPlugin.js

@@ -1,106 +0,0 @@
-import { Plugin, PluginKey } from "prosemirror-state";
-import { getNodeId } from "./getNodeId.js";
-import { Transform } from "prosemirror-transform";
-// unique ids plugin
-// https://discuss.prosemirror.net/t/how-to-avoid-copying-attributes-to-new-paragraph/4568/2
-// (also checks and fix duplicates that inevitably appear)
-export const uniqueNodeIdsPluginKey = new PluginKey("@handlewithcare/prosemirror-suggest-changes-unique-node-ids");
-export const UNIQUE_NODE_IDS_PLUGIN_META = "unique-node-ids-plugin";
-const TRACE_ENABLED = false;
-function trace(...args) {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!TRACE_ENABLED) return;
-    console.log("[uniqueNodeIdsPlugin]", ...args);
-}
-export function uniqueNodeIdsPlugin({ attributeName, generateID }) {
-    return new Plugin({
-        key: uniqueNodeIdsPluginKey,
-        appendTransaction (transactions, oldState, newState) {
-            trace("appendTransaction");
-            const pluginState = uniqueNodeIdsPluginKey.getState(newState);
-            // do nothing if doc hasn't changed (but make sure it runs initially)
-            const docChanged = transactions.some((transaction)=>transaction.docChanged);
-            if (!docChanged && pluginState?.completedInitialRun) {
-                trace("doc not changed, skipping", [
-                    ...transactions
-                ]);
-                return;
-            }
-            trace("appendTransaction", [
-                ...transactions
-            ]);
-            const tr = newState.tr;
-            const transform = ensureUniqueNodeIds(transactions, oldState.doc, newState.doc, {
-                attributeName,
-                generateID
-            });
-            transform.steps.forEach((step)=>{
-                tr.step(step);
-            });
-            trace("tr steps", tr.steps);
-            if (!tr.steps.length) return;
-            tr.setMeta(uniqueNodeIdsPluginKey, UNIQUE_NODE_IDS_PLUGIN_META);
-            return tr;
-        },
-        state: {
-            init () {
-                return {
-                    completedInitialRun: false
-                };
-            },
-            apply (tr, value) {
-                const meta = tr.getMeta(uniqueNodeIdsPluginKey);
-                if (meta === UNIQUE_NODE_IDS_PLUGIN_META && !value.completedInitialRun) {
-                    return {
-                        completedInitialRun: true
-                    };
-                }
-                return value;
-            }
-        }
-    });
-}
-export function ensureUniqueNodeIds(_transactions, _oldDoc, newDoc, options) {
-    const tr = new Transform(newDoc);
-    const nodeIds = new Set();
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (TRACE_ENABLED) console.groupCollapsed("ensureUniqueNodeIds");
-    tr.doc.descendants((node, pos)=>{
-        if (node.isText) return false;
-        const nodeId = getNodeId(node);
-        // nodeId is set and is not duplicated
-        if (nodeId != null && !nodeIds.has(nodeId)) {
-            nodeIds.add(nodeId);
-            return true;
-        }
-        // nodeId is set and it is duplicated
-        if (nodeId != null && nodeIds.has(nodeId)) {
-            const id = options.generateID();
-            nodeIds.add(id);
-            tr.setNodeMarkup(pos, node.type, {
-                ...node.attrs,
-                [options.attributeName]: id
-            }, node.marks);
-            trace("fixed duplicate id", id, "for node", node.type.name, "at pos", pos, {
-                was: nodeId,
-                is: id
-            });
-            return true;
-        }
-        // node id is not set
-        if (nodeId == null) {
-            const id = options.generateID();
-            nodeIds.add(id);
-            tr.setNodeMarkup(pos, node.type, {
-                ...node.attrs,
-                [options.attributeName]: id
-            }, node.marks);
-            trace("set unique id", id, "for node", node.type.name, "at pos", pos);
-            return true;
-        }
-        return true;
-    });
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (TRACE_ENABLED) console.groupEnd();
-    return tr;
-}

package/dist/listInputRules.d.ts

@@ -1,2 +0,0 @@
-import { type NodeType } from "prosemirror-model";
-export declare function listInputRules(bulletListNodeType: NodeType, orderedListNodeType: NodeType): import("prosemirror-inputrules").InputRule[];

package/dist/listInputRules.js

@@ -1,14 +0,0 @@
-import { wrappingInputRule } from "./wrappingInputRule.js";
-import { ZWSP } from "./constants.js";
-export function listInputRules(bulletListNodeType, orderedListNodeType) {
-    const bulletListInputRule = wrappingInputRule(// ^ string start, [${ZWSP}\\s]* zero or more ZWSP or whitespace, ([-+*]) one of -+* , \\s one whitespace, $ end of string
-    // "u" flag treats \u as unicode code points instead of literal "u"
-    new RegExp(`^[${ZWSP}\\s]*([-+*])\\s$`, "u"), bulletListNodeType);
-    // ^ string start, [${ZWSP}\\s]* zero or more ZWSP or whitespace, ([0-9]+\\.) digit followed by dot, \\s one whitespace, $ end of string
-    // "u" flag treats \u as unicode code points instead of literal "u"
-    const orderedListInputRule = wrappingInputRule(new RegExp(`^[${ZWSP}\\s]*([0-9]+\\.)\\s$`, "u"), orderedListNodeType);
-    return [
-        bulletListInputRule,
-        orderedListInputRule
-    ];
-}

package/dist/rebaseStep.d.ts

@@ -1,9 +0,0 @@
-import { type Step } from "prosemirror-transform";
-/**
- * Rebase a step onto a new lineage of steps
- *
- * @param step The step to rebase
- * @param back The old steps to undo, in the order they were originally applied
- * @param forth The new steps to map through
- */
-export declare function rebaseStep(step: Step, back: Step[], forth: Step[]): Step | null;

package/dist/rebaseStep.js

@@ -1,11 +0,0 @@
-/**
- * Rebase a step onto a new lineage of steps
- *
- * @param step The step to rebase
- * @param back The old steps to undo, in the order they were originally applied
- * @param forth The new steps to map through
- */ export function rebaseStep(step, back, forth) {
-    const reset = back.slice().reverse().reduce((acc, step)=>acc?.map(step.getMap().invert()) ?? null, step);
-    const rebased = forth.reduce((acc, step)=>acc?.map(step.getMap()) ?? null, reset);
-    return rebased;
-}

package/dist/testing/e2eTestSchema.d.ts

@@ -1,2 +0,0 @@
-import { Schema } from "prosemirror-model";
-export declare function createSchema(deletionMarksVisibility?: "hidden" | "visible"): Schema<"blockquote" | "text" | "doc" | "paragraph" | "horizontal_rule" | "heading" | "code_block" | "image" | "hard_break" | "orderedList" | "bulletList" | "listItem" | "hardBreak", "insertion" | "deletion" | "modification" | "structure" | "code" | "em" | "link" | "strong">;

package/dist/transformToSuggestionTransaction.d.ts

@@ -1,22 +0,0 @@
-import { type Node, type Schema } from "prosemirror-model";
-import { type EditorState, type Transaction } from "prosemirror-state";
-import { type SuggestionId } from "./generateId.js";
-interface PreserveTransactionDataOptions {
-    selection?: "mapFromOriginalTransaction" | "currentDocument" | false;
-    preserveScroll?: boolean;
-    preserveStoredMarks?: boolean;
-    preserveMeta?: boolean;
-}
-export declare function preserveTransactionData(transaction: Transaction, originalTransaction: Transaction, options?: PreserveTransactionDataOptions): void;
-/**
- * Given a standard transaction from ProseMirror, produce
- * a new transaction that tracks the changes from the original,
- * rather than applying them.
- *
- * For each type of step, we implement custom behavior to prevent
- * deletions from being removed from the document, instead adding
- * deletion marks, and ensuring that all insertions have insertion
- * marks.
- */
-export declare function transformToSuggestionTransaction(originalTransaction: Transaction, state: EditorState, generateId?: (schema: Schema, doc?: Node) => SuggestionId): Transaction;
-export {};

package/dist/transformToSuggestionTransaction.js

@@ -1,101 +0,0 @@
-import { AddMarkStep, AddNodeMarkStep, AttrStep, Mapping, RemoveMarkStep, RemoveNodeMarkStep, ReplaceAroundStep, ReplaceStep } from "prosemirror-transform";
-import { trackAddMarkStep } from "./addMarkStep.js";
-import { trackAddNodeMarkStep } from "./addNodeMarkStep.js";
-import { trackAttrStep } from "./attrStep.js";
-import { generateNextNumberId } from "./generateId.js";
-import { suggestRemoveMarkStep } from "./removeMarkStep.js";
-import { suggestRemoveNodeMarkStep } from "./removeNodeMarkStep.js";
-import { suggestReplaceAroundStep } from "./replaceAroundStep.js";
-import { suggestReplaceStep } from "./replaceStep.js";
-import { getSuggestionMarks } from "./utils.js";
-function getStepHandler(step) {
-    if (step instanceof ReplaceStep) {
-        return suggestReplaceStep;
-    }
-    if (step instanceof ReplaceAroundStep) {
-        return suggestReplaceAroundStep;
-    }
-    if (step instanceof AddMarkStep) {
-        return trackAddMarkStep;
-    }
-    if (step instanceof RemoveMarkStep) {
-        return suggestRemoveMarkStep;
-    }
-    if (step instanceof AddNodeMarkStep) {
-        return trackAddNodeMarkStep;
-    }
-    if (step instanceof RemoveNodeMarkStep) {
-        return suggestRemoveNodeMarkStep;
-    }
-    if (step instanceof AttrStep) {
-        return trackAttrStep;
-    }
-    // Default handler — simply rebase the step onto the
-    // tracked transaction and apply it.
-    return (trackedTransaction, _state, _doc, step, prevSteps)=>{
-        const reset = prevSteps.slice().reverse().reduce((acc, step)=>acc?.map(step.getMap().invert()) ?? null, step);
-        const rebased = trackedTransaction.steps.reduce((acc, step)=>acc?.map(step.getMap()) ?? null, reset);
-        if (rebased) {
-            trackedTransaction.step(rebased);
-        }
-        return false;
-    };
-}
-export function preserveTransactionData(transaction, originalTransaction, options = {}) {
-    const { selection = "mapFromOriginalTransaction", preserveScroll = true, preserveStoredMarks = true, preserveMeta = true } = options;
-    if (selection && originalTransaction.selectionSet && !transaction.selectionSet) {
-        if (selection === "currentDocument") {
-            transaction.setSelection(originalTransaction.selection.map(transaction.doc, new Mapping()));
-        } else {
-            const originalBaseDoc = originalTransaction.docs[0];
-            const base = originalBaseDoc ? originalTransaction.selection.map(originalBaseDoc, originalTransaction.mapping.invert()) : originalTransaction.selection;
-            transaction.setSelection(base.map(transaction.doc, transaction.mapping));
-        }
-    }
-    if (preserveScroll && originalTransaction.scrolledIntoView) {
-        transaction.scrollIntoView();
-    }
-    if (preserveStoredMarks && originalTransaction.storedMarksSet) {
-        transaction.setStoredMarks(originalTransaction.storedMarks);
-    }
-    if (preserveMeta) {
-        // @ts-expect-error Preserve original transaction meta exactly as-is
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        transaction.meta = originalTransaction.meta;
-    }
-}
-/**
- * Given a standard transaction from ProseMirror, produce
- * a new transaction that tracks the changes from the original,
- * rather than applying them.
- *
- * For each type of step, we implement custom behavior to prevent
- * deletions from being removed from the document, instead adding
- * deletion marks, and ensuring that all insertions have insertion
- * marks.
- */ export function transformToSuggestionTransaction(originalTransaction, state, generateId) {
-    getSuggestionMarks(state.schema);
-    let suggestionId = generateId ? generateId(state.schema, originalTransaction.docs[0]) : generateNextNumberId(state.schema, originalTransaction.docs[0]);
-    // Create a new transaction from scratch. The original transaction
-    // is going to be dropped in favor of this one.
-    const trackedTransaction = state.tr;
-    for(let i = 0; i < originalTransaction.steps.length; i++){
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const step = originalTransaction.steps[i];
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const doc = originalTransaction.docs[i];
-        const stepTracker = getStepHandler(step);
-        if (stepTracker(trackedTransaction, state, doc, step, originalTransaction.steps.slice(0, i), suggestionId) && i < originalTransaction.steps.length - 1) {
-            // If the suggestionId was used by one of the step handlers,
-            // increment it so that it's not reused.
-            if (generateId) {
-                suggestionId = generateId(state.schema, trackedTransaction.doc);
-            } else if (typeof suggestionId === "number") {
-                suggestionId = suggestionId + 1;
-            }
-        }
-        continue;
-    }
-    preserveTransactionData(trackedTransaction, originalTransaction);
-    return trackedTransaction;
-}

package/dist/wrappingInputRule.d.ts

@@ -1,4 +0,0 @@
-import { InputRule } from "prosemirror-inputrules";
-import { type Node } from "prosemirror-model";
-import { type Attrs, type NodeType } from "prosemirror-model";
-export declare function wrappingInputRule(regexp: RegExp, nodeType: NodeType, getAttrs?: Attrs | null | ((matches: RegExpMatchArray) => Attrs | null), joinPredicate?: (match: RegExpMatchArray, node: Node) => boolean): InputRule;

package/dist/wrappingInputRule.js

@@ -1,28 +0,0 @@
-import { InputRule } from "prosemirror-inputrules";
-import { canJoin, findWrapping } from "prosemirror-transform";
-import { getSuggestionMarks } from "./utils.js";
-import { ZWSP } from "./constants.js";
-/// return a boolean to indicate whether a join should happen.
-export function wrappingInputRule(regexp, nodeType, getAttrs = null, joinPredicate) {
-    return new InputRule(regexp, (state, match, start, end)=>{
-        const attrs = getAttrs instanceof Function ? getAttrs(match) : getAttrs;
-        const tr = state.tr;
-        // check and try to preserve zwsp
-        const { insertion } = getSuggestionMarks(state.doc.type.schema);
-        let $start = tr.doc.resolve(start);
-        if (insertion.isInSet($start.nodeAfter?.marks ?? []) && match[0].startsWith(ZWSP)) {
-            // preserve a single ZWSP at the start
-            tr.delete(start + 1, end);
-        } else {
-            tr.delete(start, end);
-        }
-        // the rest of the rule unchanged
-        $start = tr.doc.resolve(start);
-        const range = $start.blockRange(), wrapping = range && findWrapping(range, nodeType, attrs);
-        if (!wrapping) return null;
-        tr.wrap(range, wrapping);
-        const before = tr.doc.resolve(start - 1).nodeBefore;
-        if (before && before.type == nodeType && canJoin(tr.doc, start - 1) && (!joinPredicate || joinPredicate(match, before))) tr.join(start - 1);
-        return tr;
-    });
-}