@magic-marker/prosemirror-suggest-changes 0.2.1-wrap-unwrap.2 → 0.3.0

package/dist/schema.js

@@ -43,6 +43,35 @@ export const deletion = {
         }
     ]
 };
+export const hiddenDeletion = {
+    ...deletion,
+    toDOM (mark, inline) {
+        const isAnchor = mark.attrs["type"] === "anchor";
+        const blockStyle = `display: block;`;
+        const inlineStyle = `display: inline;`;
+        const hiddenStyle = `display: inline; font-size: 1px; line-height: 0px; color: transparent; letter-spacing: -1px;`;
+        return [
+            "del",
+            {
+                "aria-hidden": "true",
+                "data-id": JSON.stringify(mark.attrs["id"]),
+                "data-inline": String(inline),
+                ...!inline && {
+                    style: blockStyle
+                },
+                ...inline && isAnchor && {
+                    style: inlineStyle
+                },
+                ...inline && !isAnchor && {
+                    style: hiddenStyle
+                },
+                "data-type": JSON.stringify(mark.attrs["type"]),
+                "data-data": JSON.stringify(mark.attrs["data"])
+            },
+            0
+        ];
+    }
+};
 export const insertion = {
     inclusive: false,
     excludes: "deletion modification insertion",
@@ -137,50 +166,14 @@ export const modification = {
         }
     ]
 };
-export const structure = {
-    inclusive: false,
-    excludes: "deletion insertion modification",
-    attrs: {
-        id: {
-            validate: suggestionIdValidate
-        },
-        data: {
-            default: null
-        }
-    },
-    toDOM (mark) {
-        return [
-            "div",
-            {
-                "data-type": "structure",
-                "data-id": JSON.stringify(mark.attrs["id"]),
-                "data-data": JSON.stringify(mark.attrs["data"])
-            },
-            0
-        ];
-    },
-    parseDOM: [
-        {
-            tag: "div[data-type='structure']",
-            getAttrs (node) {
-                if (!node.dataset["id"]) return false;
-                return {
-                    id: JSON.parse(node.dataset["id"]),
-                    data: JSON.parse(node.dataset["data"] ?? "null")
-                };
-            }
-        }
-    ]
-};
 /**
  * Add the deletion, insertion, and modification marks to
  * the provided MarkSpec map.
- */ export function addSuggestionMarks(marks) {
+ */ export function addSuggestionMarks(marks, opts) {
     return {
         ...marks,
-        deletion,
+        deletion: opts?.experimental_deletions === "hidden" ? hiddenDeletion : deletion,
         insertion,
-        modification,
-        structure
+        modification
     };
 }

package/dist/testing/testBuilders.d.ts

@@ -1,6 +1,6 @@
 import { Schema, type Node } from "prosemirror-model";
 import { type MarkBuilder, type NodeBuilder } from "prosemirror-test-builder";
-export declare const schema: Schema<"blockquote" | "text" | "doc" | "paragraph" | "image" | "orderedList" | "bulletList" | "listItem" | "horizontal_rule" | "heading" | "code_block" | "hard_break", "insertion" | "deletion" | "modification" | "structure" | "code" | "em" | "link" | "strong" | "difficulty">;
+declare const schema: Schema<"blockquote" | "text" | "doc" | "paragraph" | "image" | "orderedList" | "bulletList" | "listItem" | "horizontal_rule" | "heading" | "code_block" | "hard_break", "insertion" | "deletion" | "modification" | "code" | "em" | "link" | "strong" | "difficulty">;
 export declare const testBuilders: { [NodeTypeName in keyof (typeof schema)["nodes"]]: NodeBuilder; } & { [MarkTypeName in keyof (typeof schema)["marks"]]: MarkBuilder; } & {
     schema: typeof schema;
 };
@@ -8,3 +8,4 @@ export type TaggedNode = Node & {
     flat: Node;
     tag: Record<string, number>;
 };
+export {};

package/dist/utils.d.ts

@@ -3,7 +3,6 @@ export interface SuggestionMarks {
     insertion: MarkType;
     deletion: MarkType;
     modification: MarkType;
-    structure: MarkType;
 }
 /**
  * Get the suggestion mark types from a schema, with proper error handling.

package/dist/utils.js

@@ -2,7 +2,7 @@
  * Get the suggestion mark types from a schema, with proper error handling.
  * Throws an error if any of the required marks are not found.
  */ export function getSuggestionMarks(schema) {
-    const { insertion, deletion, modification, structure } = schema.marks;
+    const { insertion, deletion, modification } = schema.marks;
     if (!insertion) {
         throw new Error("Failed to find insertion mark in schema. Did you forget to add it?");
     }
@@ -12,13 +12,9 @@
     if (!modification) {
         throw new Error("Failed to find modification mark in schema. Did you forget to add it?");
     }
-    if (!structure) {
-        throw new Error("Failed to find structure mark in schema. Did you forget to add it?");
-    }
     return {
         insertion,
         deletion,
-        modification,
-        structure
+        modification
     };
 }

package/dist/withSuggestChanges.js

@@ -9,6 +9,7 @@ import { suggestReplaceStep } from "./replaceStep.js";
 import { isSuggestChangesEnabled, suggestChangesKey } from "./plugin.js";
 import { generateNextNumberId } from "./generateId.js";
 import { getSuggestionMarks } from "./utils.js";
+import { prependDeletionsWithZWSP } from "./prependDeletionsWithZWSP.js";
 function getStepHandler(step) {
     if (step instanceof ReplaceStep) {
         return suggestReplaceStep;
@@ -109,6 +110,9 @@ function getStepHandler(step) {
     return function dispatchTransaction(tr) {
         const ySyncMeta = tr.getMeta("y-sync$") ?? {};
         const transaction = isSuggestChangesEnabled(this.state) && !tr.getMeta("history$") && !tr.getMeta("collab$") && !ySyncMeta.isUndoRedoOperation && !ySyncMeta.isChangeOrigin && !("skip" in (tr.getMeta(suggestChangesKey) ?? {})) ? transformToSuggestionTransaction(tr, this.state, generateId) : tr;
+        if (transaction.docChanged) {
+            prependDeletionsWithZWSP(transaction);
+        }
         dispatch.call(this, transaction);
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic-marker/prosemirror-suggest-changes",
-  "version": "0.2.1-wrap-unwrap.2",
+  "version": "0.3.0",
   "license": "MIT",
   "type": "module",
   "module": "dist/index.js",

package/dist/contentBetween.d.ts

@@ -1,2 +0,0 @@
-import { type Node } from "prosemirror-model";
-export declare function contentBetween(doc: Node, from: number, to: number): boolean;

package/dist/contentBetween.js

@@ -1,33 +0,0 @@
-/*
-    This function is used by ProseMirror to verify structure steps
-    https://github.com/ProseMirror/prosemirror-transform/blob/1.11.0/src/replace_step.ts#L163
-    https://github.com/ProseMirror/prosemirror-transform/blob/1.11.0/src/replace_step.ts#L110
-
-    If step is a structure step (structure: true), 
-    it means the range it covers does not contain any content 
-    except for closing and opening tokens (see https://prosemirror.net/docs/ref/#transform.ReplaceStep)
-    
-    ProseMirror throws an error if this function returns true for a structure step
-    https://github.com/ProseMirror/prosemirror-transform/blob/1.11.0/src/replace_step.ts#L30
-    
-    We can use this function to do the opposite - 
-    if some step has structure: false, 
-    but this function return false,
-    then we can treat the step as a structure step
- */ export function contentBetween(doc, from, to) {
-    // eslint-disable-next-line prefer-const
-    let $from = doc.resolve(from), dist = to - from, depth = $from.depth;
-    while(dist > 0 && depth > 0 && $from.indexAfter(depth) == $from.node(depth).childCount){
-        depth--;
-        dist--;
-    }
-    if (dist > 0) {
-        let next = $from.node(depth).maybeChild($from.indexAfter(depth));
-        while(dist > 0){
-            if (!next || next.isLeaf) return true;
-            next = next.firstChild;
-            dist--;
-        }
-    }
-    return false;
-}

package/dist/features/wrapUnwrap/__tests__/blockquoteUnwrapAllNodes.data.d.ts

@@ -1,38 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-    };
-    structure: boolean;
-}[];

package/dist/features/wrapUnwrap/__tests__/blockquoteUnwrapOneNode.data.d.ts

@@ -1,45 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-        openStart: number;
-    };
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-        openStart: number;
-    };
-    structure: boolean;
-}[];

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

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

package/dist/features/wrapUnwrap/__tests__/blockquoteUnwrapSingleNode.data.d.ts

@@ -1,38 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-    };
-    structure: boolean;
-}[];

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

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

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

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

package/dist/features/wrapUnwrap/__tests__/blockquoteWrapAllNodes.data.d.ts

@@ -1,38 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-    };
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    structure: boolean;
-}[];

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

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

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

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

package/dist/features/wrapUnwrap/__tests__/blockquoteWrapSingleNode.data.d.ts

@@ -1,38 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-    };
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    structure: boolean;
-}[];

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

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

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

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

package/dist/features/wrapUnwrap/__tests__/listItemLiftLast.data.d.ts

@@ -1,54 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-            attrs: {
-                order: number;
-            };
-        }[];
-        openStart: number;
-    };
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-            attrs: {
-                order: number;
-            };
-            content: {
-                type: string;
-            }[];
-        }[];
-        openStart: number;
-    };
-    structure: boolean;
-}[];

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

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

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

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

package/dist/features/wrapUnwrap/__tests__/listItemLiftMiddle.data.d.ts

@@ -1,48 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-            attrs: {
-                order: number;
-            };
-        }[];
-        openStart: number;
-        openEnd: number;
-    };
-    structure: boolean;
-}[];
-export declare const inverseSteps: {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-    };
-    structure: boolean;
-}[];

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

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

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

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

package/dist/features/wrapUnwrap/__tests__/listItemLiftMultipleToTheTop.data.d.ts

@@ -1,74 +0,0 @@
-export declare const initialDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDoc: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const finalDocWithMarks: import("prosemirror-model").Node & {
-    tag: {
-        [tag: string]: number;
-    };
-};
-export declare const steps: ({
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom?: never;
-    gapTo?: never;
-    insert?: never;
-    slice?: never;
-    structure?: never;
-} | {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-            attrs: {
-                order: number;
-            };
-        }[];
-        openStart: number;
-        openEnd: number;
-    };
-    structure: boolean;
-})[];
-export declare const inverseSteps: ({
-    stepType: string;
-    from: number;
-    to: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-        openStart: number;
-        openEnd: number;
-    };
-    gapFrom?: never;
-    gapTo?: never;
-    insert?: never;
-    structure?: never;
-} | {
-    stepType: string;
-    from: number;
-    to: number;
-    gapFrom: number;
-    gapTo: number;
-    insert: number;
-    slice: {
-        content: {
-            type: string;
-        }[];
-        openStart?: never;
-        openEnd?: never;
-    };
-    structure: boolean;
-})[];

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

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

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

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