Support custom id generation (#13)

---------

Co-authored-by: VV-EE <67345012+VV-EE@users.noreply.github.com>
Co-authored-by: Shane Friedman <smoores-gpg@friedmans.us>

Author: 3 people

.yarn/versions/04b5cd81.yml

@@ -0,0 +1,2 @@
+releases:
+  "@handlewithcare/prosemirror-suggest-changes": patch

README.md

@@ -384,5 +384,10 @@ document.
 ```ts
 function withSuggestChanges(
   dispatchTransaction?: EditorView["dispatch"],
+  generateId?: (schema: Schema, doc?: Node) => SuggestionId,
 ): EditorView["dispatch"];
 ```
+
+`generateId` can be used to customize the unique ids assigned to suggestion
+marks. If undefined, the default implementation (an auto-incrementing integer)
+will be used.

src/__tests__/replaceAroundStep.test.ts

@@ -114,8 +114,6 @@ describe("ReplaceAroundStep", () => {
           {
             id: 1,
             type: "mark",
-            // we know this mark exists
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             previousValue: doc.children[0]!.marks[0]!.toJSON(),
             newValue: null,
           },

src/__tests__/withSuggestChanges.test.ts

@@ -1,4 +1,7 @@
+/* eslint-disable @typescript-eslint/restrict-template-expressions */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { eq } from "prosemirror-test-builder";
+import { type SuggestionId } from "../generateId.js";
 import { EditorState } from "prosemirror-state";
 import { Fragment, Slice } from "prosemirror-model";
 import { type ReplaceStep, replaceStep } from "prosemirror-transform";
@@ -157,4 +160,78 @@ describe("withSuggestChanges", () => {
     // Should pass without error - document should be modified
     expect(newState.doc.toJSON()).not.toEqual(doc.toJSON());
   });
+  it("should use custom generateId function when provided", () => {
+    const doc = testBuilders.doc(testBuilders.paragraph("Hello world"));
+
+    let state = EditorState.create({
+      doc,
+    });
+
+    let callCount = 0;
+    const customIds = ["custom-id-1", "custom-id-2"];
+
+    const generateId = (): SuggestionId => {
+      const id = customIds[callCount] ?? `custom-id-${callCount + 1}`;
+      callCount++;
+      return id;
+    };
+
+    // Make an insertion after "Hello"
+    const tr1 = state.tr.insertText(" there", 6);
+    const suggestedTr1 = transformToSuggestionTransaction(
+      tr1,
+      state,
+      generateId,
+    );
+    state = state.apply(suggestedTr1);
+
+    // Make another insertion at the end
+    const tr2 = state.tr.insertText("!", state.doc.content.size - 1);
+    const suggestedTr2 = transformToSuggestionTransaction(
+      tr2,
+      state,
+      generateId,
+    );
+    state = state.apply(suggestedTr2);
+
+    const expected = testBuilders.doc(
+      testBuilders.paragraph(
+        "Hello",
+        testBuilders.insertion({ id: customIds[0] }, " there"),
+        " world",
+        testBuilders.insertion({ id: customIds[1] }, "!"),
+      ),
+    );
+
+    assert(
+      eq(state.doc, expected),
+      `Expected ${state.doc} to match ${expected}`,
+    );
+  });
+
+  it("should use default numeric ID generation when generateId is not provided", () => {
+    const doc = testBuilders.doc(testBuilders.paragraph("Hello world"));
+
+    let state = EditorState.create({
+      doc,
+    });
+
+    // Make an insertion without providing generateId
+    const tr = state.tr.insertText(" there", 6);
+    const suggestedTr = transformToSuggestionTransaction(tr, state); // No generateId
+    state = state.apply(suggestedTr);
+
+    const expected = testBuilders.doc(
+      testBuilders.paragraph(
+        "Hello",
+        testBuilders.insertion({ id: 1 }, " there"),
+        " world",
+      ),
+    );
+
+    assert(
+      eq(state.doc, expected),
+      `Expected ${state.doc} to match ${expected}`,
+    );
+  });
 });

src/addMarkStep.ts

@@ -9,6 +9,7 @@ import {
 
 import { applySuggestionsToRange } from "./commands.js";
 import { suggestReplaceStep } from "./replaceStep.js";
+import { type SuggestionId } from "./generateId.js";
 
 /**
  * Transform an add mark step into its equivalent tracked steps.
@@ -23,7 +24,7 @@ export function trackAddMarkStep(
   doc: Node,
   step: AddMarkStep,
   prevSteps: Step[],
-  suggestionId: number,
+  suggestionId: SuggestionId,
 ) {
   const applied = step.apply(doc).doc;
   if (!applied) return false;

src/addNodeMarkStep.ts

@@ -4,6 +4,7 @@ import { type AddNodeMarkStep, type Step } from "prosemirror-transform";
 
 import { rebasePos } from "./rebasePos.js";
 import { getSuggestionMarks } from "./utils.js";
+import { type SuggestionId } from "./generateId.js";
 
 /**
  * Transform an add node mark step into its equivalent tracked steps.
@@ -17,7 +18,7 @@ export function trackAddNodeMarkStep(
   _doc: Node,
   step: AddNodeMarkStep,
   prevSteps: Step[],
-  suggestionId: number,
+  suggestionId: SuggestionId,
 ) {
   const { modification } = getSuggestionMarks(state.schema);
 

src/attrStep.ts

@@ -4,6 +4,7 @@ import { type AttrStep, type Step } from "prosemirror-transform";
 
 import { rebasePos } from "./rebasePos.js";
 import { getSuggestionMarks } from "./utils.js";
+import { type SuggestionId } from "./generateId.js";
 
 /**
  * Transform an attr mark step into its equivalent tracked steps.
@@ -17,7 +18,7 @@ export function trackAttrStep(
   _doc: Node,
   step: AttrStep,
   prevSteps: Step[],
-  suggestionId: number,
+  suggestionId: SuggestionId,
 ) {
   const { modification } = getSuggestionMarks(state.schema);
 

src/commands.ts

@@ -10,6 +10,7 @@ import { type EditorView } from "prosemirror-view";
 import { findSuggestionMarkEnd } from "./findSuggestionMarkEnd.js";
 import { suggestChangesKey } from "./plugin.js";
 import { getSuggestionMarks } from "./utils.js";
+import { type SuggestionId } from "./generateId.js";
 
 /**
  * Given a node and a transform, add a set of steps to the
@@ -24,7 +25,7 @@ function applySuggestionsToTransform(
   tr: Transform,
   markTypeToApply: MarkType,
   markTypeToRevert: MarkType,
-  suggestionId?: number,
+  suggestionId?: SuggestionId,
   from?: number,
   to?: number,
 ) {
@@ -144,7 +145,7 @@ function revertModifications(node: Node, pos: number, tr: Transform) {
 
 function modificationIsInSet(
   modification: MarkType,
-  id: number | undefined,
+  id: SuggestionId | undefined,
   marks: readonly Mark[],
 ) {
   const mark = modification.isInSet(marks);
@@ -159,7 +160,7 @@ function applyModificationsToTransform(
   node: Node,
   tr: Transform,
   dir: number,
-  suggestionId?: number,
+  suggestionId?: SuggestionId,
   from?: number,
   to?: number,
 ) {
@@ -243,6 +244,7 @@ export function applySuggestionsToRange(doc: Node, from: number, to: number) {
     doc,
     transform,
     1,
+    undefined,
     nodeRange.start,
     nodeRange.end,
   );
@@ -281,7 +283,7 @@ export function applySuggestions(
  * The insertion mark and modification mark will be removed, and their
  * contents left in the doc.
  */
-export function applySuggestion(suggestionId: number): Command {
+export function applySuggestion(suggestionId: SuggestionId): Command {
   return (state, dispatch) => {
     const { deletion, insertion } = getSuggestionMarks(state.schema);
 
@@ -328,7 +330,7 @@ export function revertSuggestions(
  * The deletion mark will be removed, and their contents left in the doc.
  * Modifications tracked in modification marks will be reverted.
  */
-export function revertSuggestion(suggestionId: number): Command {
+export function revertSuggestion(suggestionId: SuggestionId): Command {
   return (state, dispatch) => {
     const { deletion, insertion } = getSuggestionMarks(state.schema);
 
@@ -351,7 +353,7 @@ export function revertSuggestion(suggestionId: number): Command {
 /**
  * Command that updates the selection to cover an existing change.
  */
-export function selectSuggestion(suggestionId: number): Command {
+export function selectSuggestion(suggestionId: SuggestionId): Command {
   return (state, dispatch) => {
     const { deletion, insertion, modification } = getSuggestionMarks(
       state.schema,

src/generateId.ts

@@ -0,0 +1,35 @@
+import { type Node, type Schema } from "prosemirror-model";
+import { getSuggestionMarks } from "./utils.js";
+
+export type SuggestionId = string | number;
+
+export const suggestionIdValidate = "number|string";
+
+export function parseSuggestionId(id: string): SuggestionId {
+  const parsed = parseInt(id, 10);
+  if (isNaN(parsed)) {
+    return id;
+  }
+  return parsed;
+}
+
+export function generateNextNumberId(schema: Schema, doc?: Node) {
+  const { deletion, insertion, modification } = getSuggestionMarks(schema);
+  // Find the highest change id in the document so far,
+  // and use that as the starting point for new changes
+  let suggestionId = 0;
+  doc?.descendants((node) => {
+    const mark = node.marks.find(
+      (mark) =>
+        mark.type === insertion ||
+        mark.type === deletion ||
+        mark.type === modification,
+    );
+    if (mark) {
+      suggestionId = Math.max(suggestionId, mark.attrs["id"] as number);
+      return false;
+    }
+    return true;
+  });
+  return suggestionId + 1;
+}

src/removeMarkStep.ts

@@ -9,6 +9,7 @@ import {
 
 import { applySuggestionsToRange } from "./commands.js";
 import { suggestReplaceStep } from "./replaceStep.js";
+import { type SuggestionId } from "./generateId.js";
 
 /**
  * Transform a remove mark step into its equivalent tracked steps.
@@ -23,7 +24,7 @@ export function suggestRemoveMarkStep(
   doc: Node,
   step: RemoveMarkStep,
   prevSteps: Step[],
-  suggestionId: number,
+  suggestionId: SuggestionId,
 ) {
   const applied = step.apply(doc).doc;
   if (!applied) return false;