@portabletext/editor 1.0.14 → 1.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -51,18 +51,18 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@playwright/test": "1.46.0",
+    "@playwright/test": "1.46.1",
     "@portabletext/toolkit": "^2.0.15",
-    "@sanity/block-tools": "^3.54.0",
+    "@sanity/block-tools": "^3.55.0",
     "@sanity/diff-match-patch": "^3.1.1",
     "@sanity/eslint-config-i18n": "^1.1.0",
     "@sanity/eslint-config-studio": "^4.0.0",
-    "@sanity/pkg-utils": "^6.10.9",
-    "@sanity/schema": "^3.54.0",
+    "@sanity/pkg-utils": "^6.10.10",
+    "@sanity/schema": "^3.55.0",
     "@sanity/test": "0.0.1-alpha.1",
-    "@sanity/types": "^3.54.0",
+    "@sanity/types": "^3.55.0",
     "@sanity/ui": "^2.8.8",
-    "@sanity/util": "^3.54.0",
+    "@sanity/util": "^3.55.0",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.0.0",
     "@types/debug": "^4.1.5",
@@ -74,8 +74,8 @@
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "@types/ws": "~8.5.12",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.2.0",
+    "@typescript-eslint/parser": "^8.2.0",
     "@vitejs/plugin-react": "^4.3.1",
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
@@ -84,14 +84,14 @@
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-react-compiler": "0.0.0-experimental-d0e920e-20240815",
+    "eslint-plugin-react-compiler": "0.0.0-experimental-eeb1b2a-20240818",
     "eslint-plugin-tsdoc": "^0.3.0",
     "eslint-plugin-unicorn": "^55.0.0",
     "eslint-plugin-unused-imports": "^4.1.3",
     "express": "^4.19.2",
     "express-ws": "^5.0.2",
     "jest": "^29.7.0",
-    "jest-dev-server": "^10.0.0",
+    "jest-dev-server": "^10.1.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-environment-node": "^29.7.0",
     "node-ipc": "npm:@node-ipc/compat@9.2.5",
@@ -101,7 +101,7 @@
     "styled-components": "^6.1.12",
     "tsx": "^4.17.0",
     "typescript": "5.5.4",
-    "vite": "^5.4.1"
+    "vite": "^5.4.2"
   },
   "peerDependencies": {
     "@sanity/block-tools": "^3.47.1",

package/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -9,7 +9,7 @@
 import {isPortableTextBlock, isPortableTextSpan} from '@portabletext/toolkit'
 import {isEqual, uniq} from 'lodash'
 import {type Subject} from 'rxjs'
-import {type Descendant, Editor, Element, Path, Range, Text, Transforms} from 'slate'
+import {type Descendant, Editor, Element, Node, Path, Range, Text, Transforms} from 'slate'
 
 import {
   type EditorChange,
@@ -54,29 +54,38 @@ export function createWithPortableTextMarkModel(
 
     // Extend Slate's default normalization. Merge spans with same set of .marks when doing merge_node operations, and clean up markDefs / marks
     editor.normalizeNode = (nodeEntry) => {
-      normalizeNode(nodeEntry)
-      if (
-        editor.operations.some((op) =>
-          [
-            'insert_node',
-            'insert_text',
-            'merge_node',
-            'remove_node',
-            'remove_text',
-            'set_node',
-          ].includes(op.type),
-        )
-      ) {
-        mergeSpans(editor)
-      }
       const [node, path] = nodeEntry
+
       const isSpan = Text.isText(node) && node._type === types.span.name
       const isTextBlock = editor.isTextBlock(node)
+
+      if (editor.isTextBlock(node)) {
+        const children = Node.children(editor, path)
+
+        for (const [child, childPath] of children) {
+          const nextNode = node.children[childPath[1] + 1]
+
+          if (
+            editor.isTextSpan(child) &&
+            editor.isTextSpan(nextNode) &&
+            isEqual(child.marks, nextNode.marks)
+          ) {
+            debug(
+              'Merging spans',
+              JSON.stringify(child, null, 2),
+              JSON.stringify(nextNode, null, 2),
+            )
+            Transforms.mergeNodes(editor, {at: [childPath[0], childPath[1] + 1], voids: true})
+            return
+          }
+        }
+      }
+
       if (isSpan || isTextBlock) {
         if (isSpan && !Array.isArray(node.marks)) {
           debug('Adding .marks to span node')
           Transforms.setNodes(editor, {marks: []}, {at: path})
-          editor.onChange()
+          return
         }
         const hasSpanMarks = isSpan && (node.marks || []).length > 0
         if (hasSpanMarks) {
@@ -100,7 +109,7 @@ export function createWithPortableTextMarkModel(
                 {marks: spanMarks.filter((mark) => !orphanedMarks.includes(mark))},
                 {at: path},
               )
-              editor.onChange()
+              return
             }
           }
         }
@@ -124,7 +133,7 @@ export function createWithPortableTextMarkModel(
               // eslint-disable-next-line max-depth
               if (!isNormalized) {
                 Transforms.setNodes(editor, {markDefs: newMarkDefs}, {at: targetPath, voids: false})
-                editor.onChange()
+                return
               }
             }
           }
@@ -148,7 +157,7 @@ export function createWithPortableTextMarkModel(
                 {markDefs: uniq([...oldDefs, ...op.properties.markDefs])},
                 {at: targetPath, voids: false},
               )
-              editor.onChange()
+              return
             }
           }
           // Make sure marks are reset, if a block is split at the end.
@@ -169,7 +178,7 @@ export function createWithPortableTextMarkModel(
               child.marks.length > 0
             ) {
               Transforms.setNodes(editor, {marks: []}, {at: childPath, voids: false})
-              editor.onChange()
+              return
             }
           }
           // Make sure markDefs are reset, if a block is split at start.
@@ -192,19 +201,10 @@ export function createWithPortableTextMarkModel(
               (!block.children[0].marks || block.children[0].marks.length === 0)
             ) {
               Transforms.setNodes(editor, {markDefs: []}, {at: blockPath})
-              editor.onChange()
+              return
             }
           }
         }
-        // Empty marks if text is empty
-        if (
-          isSpan &&
-          Array.isArray(node.marks) &&
-          (!node.marks || (node.marks.length > 0 && node.text === ''))
-        ) {
-          Transforms.setNodes(editor, {marks: []}, {at: path, voids: false})
-          editor.onChange()
-        }
       }
       // Check consistency of markDefs (unless we are merging two nodes)
       if (
@@ -229,9 +229,11 @@ export function createWithPortableTextMarkModel(
             },
             {at: path},
           )
-          editor.onChange()
+          return
         }
       }
+
+      normalizeNode(nodeEntry)
     }
 
     editor.apply = (op) => {
@@ -343,6 +345,18 @@ export function createWithPortableTextMarkModel(
             editor.onChange()
             return
           }
+
+          const nodeHasMarks = node.marks !== undefined && node.marks.length > 0
+
+          if (nodeHasMarks && deletingAllText) {
+            Editor.withoutNormalizing(editor, () => {
+              apply(op)
+              Transforms.setNodes(editor, {marks: []}, {at: op.path})
+            })
+
+            editor.onChange()
+            return
+          }
         }
       }
 
@@ -353,34 +367,35 @@ export function createWithPortableTextMarkModel(
     editor.addMark = (mark: string) => {
       if (editor.selection) {
         if (Range.isExpanded(editor.selection)) {
-          // Split if needed
-          Transforms.setNodes(editor, {}, {match: Text.isText, split: true})
-          // Use new selection
-          const splitTextNodes = [
-            ...Editor.nodes(editor, {at: editor.selection, match: Text.isText}),
-          ]
-          const shouldRemoveMark = splitTextNodes.every((node) => node[0].marks?.includes(mark))
-
-          if (shouldRemoveMark) {
-            editor.removeMark(mark)
-            return editor
-          }
           Editor.withoutNormalizing(editor, () => {
-            splitTextNodes.forEach(([node, path]) => {
-              const marks = [
-                ...(Array.isArray(node.marks) ? node.marks : []).filter(
-                  (eMark: string) => eMark !== mark,
-                ),
-                mark,
-              ]
-              Transforms.setNodes(
-                editor,
-                {marks},
-                {at: path, match: Text.isText, split: true, hanging: true},
-              )
-            })
+            // Split if needed
+            Transforms.setNodes(editor, {}, {match: Text.isText, split: true})
+            // Use new selection
+            const splitTextNodes = Range.isRange(editor.selection)
+              ? [...Editor.nodes(editor, {at: editor.selection, match: Text.isText})]
+              : []
+            const shouldRemoveMark =
+              splitTextNodes.length > 1 &&
+              splitTextNodes.every((node) => node[0].marks?.includes(mark))
+
+            if (shouldRemoveMark) {
+              editor.removeMark(mark)
+            } else {
+              splitTextNodes.forEach(([node, path]) => {
+                const marks = [
+                  ...(Array.isArray(node.marks) ? node.marks : []).filter(
+                    (eMark: string) => eMark !== mark,
+                  ),
+                  mark,
+                ]
+                Transforms.setNodes(
+                  editor,
+                  {marks},
+                  {at: path, match: Text.isText, split: true, hanging: true},
+                )
+              })
+            }
           })
-          Editor.normalize(editor)
         } else {
           const existingMarks: string[] =
             {
@@ -486,36 +501,4 @@ export function createWithPortableTextMarkModel(
     }
     return editor
   }
-
-  /**
-   * Normalize re-marked spans in selection
-   */
-  function mergeSpans(editor: PortableTextSlateEditor) {
-    const {selection} = editor
-
-    if (selection) {
-      const textNodesInSelection = Array.from(
-        Editor.nodes(editor, {
-          at: Editor.range(editor, [selection.anchor.path[0]], [selection.focus.path[0]]),
-          match: Text.isText,
-          reverse: true,
-        }),
-      )
-
-      for (const [node, path] of textNodesInSelection) {
-        const [parent] = path.length > 1 ? Editor.node(editor, Path.parent(path)) : [undefined]
-        const nextPath = [path[0], path[1] + 1]
-
-        if (editor.isTextBlock(parent)) {
-          const nextNode = parent.children[nextPath[1]]
-
-          if (Text.isText(nextNode) && isEqual(nextNode.marks, node.marks)) {
-            debug('Merging spans')
-            Transforms.mergeNodes(editor, {at: nextPath, voids: true})
-            editor.onChange()
-          }
-        }
-      }
-    }
-  }
 }