@portabletext/editor 1.50.2 → 1.50.3

package/lib/plugins/index.d.cts

@@ -617,6 +617,9 @@ declare type EditorEmittedEvent =
       event: FocusEvent_2<HTMLDivElement, Element>
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'done loading'
     }
   | {
@@ -633,6 +636,9 @@ declare type EditorEmittedEvent =
       value: Array<PortableTextBlock> | undefined
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'loading'
     }
   | MutationEvent

package/lib/plugins/index.d.ts

@@ -617,6 +617,9 @@ declare type EditorEmittedEvent =
       event: FocusEvent_2<HTMLDivElement, Element>
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'done loading'
     }
   | {
@@ -633,6 +636,9 @@ declare type EditorEmittedEvent =
       value: Array<PortableTextBlock> | undefined
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'loading'
     }
   | MutationEvent

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.50.2",
+  "version": "1.50.3",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -68,8 +68,8 @@
   ],
   "dependencies": {
     "@portabletext/to-html": "^2.0.14",
-    "@xstate/react": "^5.0.3",
-    "debug": "^4.4.0",
+    "@xstate/react": "^5.0.4",
+    "debug": "^4.4.1",
     "get-random-values-esm": "^1.0.2",
     "lodash": "^4.17.21",
     "lodash.startcase": "^4.4.0",
@@ -78,23 +78,23 @@
     "slate-dom": "^0.114.0",
     "slate-react": "0.114.2",
     "use-effect-event": "^1.0.2",
-    "xstate": "^5.19.2",
-    "@portabletext/block-tools": "1.1.26",
-    "@portabletext/patches": "1.1.3"
+    "xstate": "^5.19.3",
+    "@portabletext/patches": "1.1.3",
+    "@portabletext/block-tools": "1.1.27"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/pkg-utils": "^7.2.2",
-    "@sanity/schema": "^3.88.3",
-    "@sanity/types": "^3.88.3",
+    "@sanity/schema": "^3.89.0",
+    "@sanity/types": "^3.89.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@types/debug": "^4.1.12",
     "@types/lodash": "^4.17.16",
     "@types/lodash.startcase": "^4.4.9",
-    "@types/react": "^19.1.3",
-    "@types/react-dom": "^19.1.3",
+    "@types/react": "^19.1.4",
+    "@types/react-dom": "^19.1.5",
     "@typescript-eslint/eslint-plugin": "^8.32.1",
     "@typescript-eslint/parser": "^8.32.1",
     "@vitejs/plugin-react": "^4.4.1",
@@ -110,12 +110,12 @@
     "typescript": "5.8.3",
     "vite": "^6.2.5",
     "vitest": "^3.1.3",
-    "vitest-browser-react": "^0.1.1",
+    "vitest-browser-react": "^0.2.0",
     "racejar": "1.2.5"
   },
   "peerDependencies": {
-    "@sanity/schema": "^3.88.3",
-    "@sanity/types": "^3.88.3",
+    "@sanity/schema": "^3.89.0",
+    "@sanity/types": "^3.89.0",
     "react": "^16.9 || ^17 || ^18 || ^19",
     "rxjs": "^7.8.2"
   },

package/src/editor/plugins/createWithPatches.ts

@@ -1,19 +1,17 @@
 import {insert, setIfMissing, unset, type Patch} from '@portabletext/patches'
-import {
-  Editor,
-  type Descendant,
-  type InsertNodeOperation,
-  type InsertTextOperation,
-  type MergeNodeOperation,
-  type MoveNodeOperation,
-  type Operation,
-  type RemoveNodeOperation,
-  type RemoveTextOperation,
-  type SetNodeOperation,
-  type SplitNodeOperation,
-} from 'slate'
+import {Editor, type Descendant, type Operation} from 'slate'
 import {createApplyPatch} from '../../internal-utils/applyPatch'
 import {debugWithName} from '../../internal-utils/debug'
+import {
+  insertNodePatch,
+  insertTextPatch,
+  mergeNodePatch,
+  moveNodePatch,
+  removeNodePatch,
+  removeTextPatch,
+  setNodePatch,
+  splitNodePatch,
+} from '../../internal-utils/operation-to-patches'
 import {fromSlateValue, isEqualToEmptyEditor} from '../../internal-utils/values'
 import {
   IS_PROCESSING_REMOTE_CHANGES,
@@ -34,60 +32,15 @@ import {withoutSaving} from './createWithUndoRedo'
 const debug = debugWithName('plugin:withPatches')
 const debugVerbose = false
 
-export interface PatchFunctions {
-  insertNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: InsertNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  insertTextPatch: (
-    editor: PortableTextSlateEditor,
-    operation: InsertTextOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  mergeNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: MergeNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  moveNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: MoveNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  removeNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: RemoveNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  removeTextPatch: (
-    editor: PortableTextSlateEditor,
-    operation: RemoveTextOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  setNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: SetNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-  splitNodePatch: (
-    editor: PortableTextSlateEditor,
-    operation: SplitNodeOperation,
-    previousChildren: Descendant[],
-  ) => Patch[]
-}
-
 interface Options {
   editorActor: EditorActor
   relayActor: RelayActor
-  patchFunctions: PatchFunctions
   subscriptions: Array<() => () => void>
 }
 
 export function createWithPatches({
   editorActor,
   relayActor,
-  patchFunctions,
   subscriptions,
 }: Options): (editor: PortableTextSlateEditor) => PortableTextSlateEditor {
   // The previous editor children are needed to figure out the _key of deleted nodes
@@ -197,8 +150,9 @@ export function createWithPatches({
         case 'insert_text':
           patches = [
             ...patches,
-            ...patchFunctions.insertTextPatch(
-              editor,
+            ...insertTextPatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
               operation,
               previousChildren,
             ),
@@ -207,8 +161,9 @@ export function createWithPatches({
         case 'remove_text':
           patches = [
             ...patches,
-            ...patchFunctions.removeTextPatch(
-              editor,
+            ...removeTextPatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
               operation,
               previousChildren,
             ),
@@ -217,18 +172,19 @@ export function createWithPatches({
         case 'remove_node':
           patches = [
             ...patches,
-            ...patchFunctions.removeNodePatch(
-              editor,
-              operation,
+            ...removeNodePatch(
+              editorActor.getSnapshot().context.schema,
               previousChildren,
+              operation,
             ),
           ]
           break
         case 'split_node':
           patches = [
             ...patches,
-            ...patchFunctions.splitNodePatch(
-              editor,
+            ...splitNodePatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
               operation,
               previousChildren,
             ),
@@ -237,8 +193,9 @@ export function createWithPatches({
         case 'insert_node':
           patches = [
             ...patches,
-            ...patchFunctions.insertNodePatch(
-              editor,
+            ...insertNodePatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
               operation,
               previousChildren,
             ),
@@ -247,14 +204,19 @@ export function createWithPatches({
         case 'set_node':
           patches = [
             ...patches,
-            ...patchFunctions.setNodePatch(editor, operation, previousChildren),
+            ...setNodePatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
+              operation,
+            ),
           ]
           break
         case 'merge_node':
           patches = [
             ...patches,
-            ...patchFunctions.mergeNodePatch(
-              editor,
+            ...mergeNodePatch(
+              editorActor.getSnapshot().context.schema,
+              editor.children,
               operation,
               previousChildren,
             ),
@@ -263,10 +225,10 @@ export function createWithPatches({
         case 'move_node':
           patches = [
             ...patches,
-            ...patchFunctions.moveNodePatch(
-              editor,
-              operation,
+            ...moveNodePatch(
+              editorActor.getSnapshot().context.schema,
               previousChildren,
+              operation,
             ),
           ]
           break

package/src/editor/plugins/with-plugins.ts

@@ -1,5 +1,4 @@
 import type {BaseOperation, Editor, Node, NodeEntry} from 'slate'
-import {createOperationToPatches} from '../../internal-utils/operationToPatches'
 import type {PortableTextSlateEditor} from '../../types/editor'
 import type {EditorActor} from '../editor-machine'
 import type {RelayActor} from '../relay-machine'
@@ -33,7 +32,6 @@ export const withPlugins = <T extends Editor>(
 ): PortableTextSlateEditor => {
   const e = editor as T & PortableTextSlateEditor
   const {editorActor, relayActor} = options
-  const operationToPatches = createOperationToPatches(editorActor)
   const withObjectKeys = createWithObjectKeys(editorActor)
   const withSchemaTypes = createWithSchemaTypes({
     editorActor,
@@ -41,7 +39,6 @@ export const withPlugins = <T extends Editor>(
   const withPatches = createWithPatches({
     editorActor,
     relayActor,
-    patchFunctions: operationToPatches,
     subscriptions: options.subscriptions,
   })
   const withMaxBlocks = createWithMaxBlocks(editorActor)

package/src/editor/relay-machine.ts

@@ -13,6 +13,9 @@ export type EditorEmittedEvent =
       event: FocusEvent<HTMLDivElement, Element>
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'done loading'
     }
   | {
@@ -29,6 +32,9 @@ export type EditorEmittedEvent =
       value: Array<PortableTextBlock> | undefined
     }
   | {
+      /**
+       * @deprecated
+       */
       type: 'loading'
     }
   | MutationEvent
@@ -79,6 +85,9 @@ export type PatchEvent = {
 }
 
 export type UnsetEvent = {
+  /**
+   * @deprecated Use `'patch'` events instead
+   */
   type: 'unset'
   previousValue: Array<PortableTextBlock>
 }

package/src/internal-utils/{__tests__/operationToPatches.test.ts → operation-to-patches.test.ts}

@@ -2,14 +2,21 @@ import type {PortableTextTextBlock} from '@sanity/types'
 import {createEditor, type Descendant} from 'slate'
 import {beforeEach, describe, expect, it} from 'vitest'
 import {createActor} from 'xstate'
-import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
-import {editorMachine} from '../../editor/editor-machine'
-import {legacySchemaToEditorSchema} from '../../editor/editor-schema'
-import {defaultKeyGenerator} from '../../editor/key-generator'
-import {createLegacySchema} from '../../editor/legacy-schema'
-import {withPlugins} from '../../editor/plugins/with-plugins'
-import {relayMachine} from '../../editor/relay-machine'
-import {createOperationToPatches} from '../operationToPatches'
+import {schemaType} from '../editor/__tests__/PortableTextEditorTester'
+import {editorMachine} from '../editor/editor-machine'
+import {legacySchemaToEditorSchema} from '../editor/editor-schema'
+import {defaultKeyGenerator} from '../editor/key-generator'
+import {createLegacySchema} from '../editor/legacy-schema'
+import {withPlugins} from '../editor/plugins/with-plugins'
+import {relayMachine} from '../editor/relay-machine'
+import {
+  insertNodePatch,
+  insertTextPatch,
+  mergeNodePatch,
+  removeNodePatch,
+  removeTextPatch,
+  splitNodePatch,
+} from './operation-to-patches'
 
 const legacySchema = createLegacySchema(schemaType)
 const schemaTypes = legacySchemaToEditorSchema(legacySchema)
@@ -21,7 +28,6 @@ const editorActor = createActor(editorMachine, {
   },
 })
 const relayActor = createActor(relayMachine)
-const operationToPatches = createOperationToPatches(editorActor)
 
 const editor = withPlugins(createEditor(), {
   editorActor,
@@ -58,8 +64,9 @@ describe('operationToPatches', () => {
 
   it('translates void items correctly when splitting spans', () => {
     expect(
-      operationToPatches.splitNodePatch(
-        editor,
+      splitNodePatch(
+        schemaTypes,
+        editor.children,
         {
           type: 'split_node',
           path: [0, 0],
@@ -111,8 +118,9 @@ describe('operationToPatches', () => {
 
   it('produce correct insert block patch', () => {
     expect(
-      operationToPatches.insertNodePatch(
-        editor,
+      insertNodePatch(
+        schemaTypes,
+        editor.children,
         {
           type: 'insert_node',
           path: [0],
@@ -152,8 +160,9 @@ describe('operationToPatches', () => {
     editor.children = []
     editor.onChange()
     expect(
-      operationToPatches.insertNodePatch(
-        editor,
+      insertNodePatch(
+        schemaTypes,
+        editor.children,
         {
           type: 'insert_node',
           path: [0],
@@ -194,8 +203,9 @@ describe('operationToPatches', () => {
 
   it('produce correct insert child patch', () => {
     expect(
-      operationToPatches.insertNodePatch(
-        editor,
+      insertNodePatch(
+        schemaTypes,
+        editor.children,
         {
           type: 'insert_node',
           path: [0, 3],
@@ -240,15 +250,15 @@ describe('operationToPatches', () => {
     ;(editor.children[0] as PortableTextTextBlock).children[2].text = '1'
     editor.onChange()
     expect(
-      operationToPatches.insertTextPatch(
-        editor,
+      insertTextPatch(
+        editorActor.getSnapshot().context.schema,
+        editor.children,
         {
           type: 'insert_text',
           path: [0, 2],
           text: '1',
           offset: 0,
         },
-
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
@@ -277,8 +287,9 @@ describe('operationToPatches', () => {
     const before = createDefaultValue()
     ;(before[0] as PortableTextTextBlock).children[2].text = '1'
     expect(
-      operationToPatches.removeTextPatch(
-        editor,
+      removeTextPatch(
+        editorActor.getSnapshot().context.schema,
+        editor.children,
         {
           type: 'remove_text',
           path: [0, 2],
@@ -312,8 +323,9 @@ describe('operationToPatches', () => {
 
   it('produces correct remove child patch', () => {
     expect(
-      operationToPatches.removeNodePatch(
-        editor,
+      removeNodePatch(
+        editorActor.getSnapshot().context.schema,
+        createDefaultValue(),
         {
           type: 'remove_node',
           path: [0, 1],
@@ -325,8 +337,6 @@ describe('operationToPatches', () => {
             children: [{_type: 'span', _key: 'bogus', text: '', marks: []}],
           },
         },
-
-        createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
       [
@@ -349,16 +359,11 @@ describe('operationToPatches', () => {
   it('produce correct remove block patch', () => {
     const val = createDefaultValue()
     expect(
-      operationToPatches.removeNodePatch(
-        editor,
-        {
-          type: 'remove_node',
-          path: [0],
-          node: val[0],
-        },
-
-        val,
-      ),
+      removeNodePatch(editorActor.getSnapshot().context.schema, val, {
+        type: 'remove_node',
+        path: [0],
+        node: val[0],
+      }),
     ).toMatchInlineSnapshot(`
       [
         {
@@ -386,15 +391,15 @@ describe('operationToPatches', () => {
     block.children[2].text = '1234'
     editor.onChange()
     expect(
-      operationToPatches.mergeNodePatch(
-        editor,
+      mergeNodePatch(
+        schemaTypes,
+        editor.children,
         {
           type: 'merge_node',
           path: [0, 3],
           position: 2,
           properties: {text: '1234'},
         },
-
         val,
       ),
     ).toMatchInlineSnapshot(`