@portabletext/editor 1.1.0 → 1.1.2

package/src/editor/plugins/__tests__/withEditableAPIGetFragment.test.tsx

@@ -1,7 +1,7 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {isPortableTextTextBlock} from '@sanity/types'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -52,7 +52,7 @@ const initialValue = [
 describe('plugin:withEditableAPI: .getFragment()', () => {
   it('can get a Portable Text fragment of the current selection in a single block', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -93,7 +93,7 @@ describe('plugin:withEditableAPI: .getFragment()', () => {
 
   it('can get a Portable Text fragment of the current selection in multiple blocks', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -124,43 +124,43 @@ describe('plugin:withEditableAPI: .getFragment()', () => {
         PortableTextEditor.select(editorRef.current, initialSelection)
         const fragment = PortableTextEditor.getFragment(editorRef.current)
         expect(fragment).toMatchInlineSnapshot(`
-          Array [
-            Object {
+          [
+            {
               "_key": "a",
               "_type": "myTestBlockType",
-              "children": Array [
-                Object {
+              "children": [
+                {
                   "_key": "a1",
                   "_type": "span",
-                  "marks": Array [],
+                  "marks": [],
                   "text": "A",
                 },
               ],
-              "markDefs": Array [],
+              "markDefs": [],
               "style": "normal",
             },
-            Object {
+            {
               "_key": "b",
               "_type": "myTestBlockType",
-              "children": Array [
-                Object {
+              "children": [
+                {
                   "_key": "b1",
                   "_type": "span",
-                  "marks": Array [],
+                  "marks": [],
                   "text": "Block B ",
                 },
-                Object {
+                {
                   "_key": "b2",
                   "_type": "someObject",
                 },
-                Object {
+                {
                   "_key": "b3",
                   "_type": "span",
-                  "marks": Array [],
+                  "marks": [],
                   "text": " contains",
                 },
               ],
-              "markDefs": Array [],
+              "markDefs": [],
               "style": "normal",
             },
           ]

package/src/editor/plugins/__tests__/withEditableAPIInsert.test.tsx

@@ -1,6 +1,6 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -58,7 +58,7 @@ const emptyBlockSelection = {
 describe('plugin:withEditableAPI: .insertChild()', () => {
   it('inserts child nodes correctly', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -200,7 +200,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
         style: 'normal',
       },
     ]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -248,7 +248,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
 
   it('should not add empty blank blocks: non-empty block', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -300,7 +300,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
 
   it('should be inserted before if focus is on start of block', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -358,7 +358,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
       ...initialValue,
       {_key: 'b', _type: 'someObject', color: 'red'},
     ]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -414,7 +414,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
       ...initialValue,
       {_key: 'b', _type: 'someObject', color: 'red'},
     ]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester
@@ -465,7 +465,7 @@ describe('plugin:withEditableAPI: .insertBlock()', () => {
   it('should not add empty blank blocks: in new empty text block', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
     const value = [...initialValue, ...emptyTextBlock]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester

package/src/editor/plugins/__tests__/withEditableAPISelectionsOverlapping.test.tsx

@@ -1,7 +1,7 @@
-import {describe, expect, it, jest} from '@jest/globals'
-import {type PortableTextBlock} from '@sanity/types'
+import type {PortableTextBlock} from '@sanity/types'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -28,7 +28,7 @@ const INITIAL_VALUE: PortableTextBlock[] = [
 describe('plugin:withEditableAPI: .isSelectionsOverlapping', () => {
   it('returns true if the selections are partially overlapping', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -62,7 +62,7 @@ describe('plugin:withEditableAPI: .isSelectionsOverlapping', () => {
 
   it('returns true if the selections are fully overlapping', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -96,7 +96,7 @@ describe('plugin:withEditableAPI: .isSelectionsOverlapping', () => {
 
   it('return true if selection is fully inside another selection', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -130,7 +130,7 @@ describe('plugin:withEditableAPI: .isSelectionsOverlapping', () => {
 
   it('returns false if the selections are not overlapping', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}

package/src/editor/plugins/__tests__/withPortableTextLists.test.tsx

@@ -1,6 +1,6 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -42,7 +42,7 @@ describe('plugin:withPortableTextLists', () => {
         style: 'normal',
       },
     ]
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     await waitFor(() => {
       render(
         <PortableTextEditorTester

package/src/editor/plugins/__tests__/withPortableTextMarkModel.test.tsx

@@ -1,13 +1,12 @@
-import {describe, expect, it, jest} from '@jest/globals'
-/* eslint-disable max-nested-callbacks */
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
   schemaTypeWithColorAndLink,
 } from '../../__tests__/PortableTextEditorTester'
-import {type EditorSelection} from '../../../types/editor'
+import type {EditorSelection} from '../../../types/editor'
 import {PortableTextEditor} from '../../PortableTextEditor'
 
 describe('plugin:withPortableTextMarksModel', () => {
@@ -30,7 +29,7 @@ describe('plugin:withPortableTextMarksModel', () => {
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester
@@ -51,21 +50,21 @@ describe('plugin:withPortableTextMarksModel', () => {
         })
         PortableTextEditor.toggleMark(editor, 'strong')
         expect(PortableTextEditor.getValue(editor)).toMatchInlineSnapshot(`
-        Array [
-          Object {
+        [
+          {
             "_key": "a",
             "_type": "myTestBlockType",
-            "children": Array [
-              Object {
+            "children": [
+              {
                 "_key": "a1",
                 "_type": "span",
-                "marks": Array [
+                "marks": [
                   "strong",
                 ],
                 "text": "1234",
               },
             ],
-            "markDefs": Array [],
+            "markDefs": [],
             "style": "normal",
           },
         ]
@@ -80,35 +79,35 @@ describe('plugin:withPortableTextMarksModel', () => {
           PortableTextEditor.toggleMark(editorRef.current, 'strong')
           expect(PortableTextEditor.getValue(editorRef.current))
             .toMatchInlineSnapshot(`
-        Array [
-          Object {
+        [
+          {
             "_key": "a",
             "_type": "myTestBlockType",
-            "children": Array [
-              Object {
+            "children": [
+              {
                 "_key": "a1",
                 "_type": "span",
-                "marks": Array [
+                "marks": [
                   "strong",
                 ],
                 "text": "1",
               },
-              Object {
+              {
                 "_key": "2",
                 "_type": "span",
-                "marks": Array [],
+                "marks": [],
                 "text": "23",
               },
-              Object {
+              {
                 "_key": "1",
                 "_type": "span",
-                "marks": Array [
+                "marks": [
                   "strong",
                 ],
                 "text": "4",
               },
             ],
-            "markDefs": Array [],
+            "markDefs": [],
             "style": "normal",
           },
         ]
@@ -123,21 +122,21 @@ describe('plugin:withPortableTextMarksModel', () => {
           })
           PortableTextEditor.toggleMark(editor, 'strong')
           expect(PortableTextEditor.getValue(editor)).toMatchInlineSnapshot(`
-Array [
-  Object {
+[
+  {
     "_key": "a",
     "_type": "myTestBlockType",
-    "children": Array [
-      Object {
+    "children": [
+      {
         "_key": "a1",
         "_type": "span",
-        "marks": Array [
+        "marks": [
           "strong",
         ],
         "text": "1234",
       },
     ],
-    "markDefs": Array [],
+    "markDefs": [],
     "style": "normal",
   },
 ]
@@ -176,7 +175,7 @@ Array [
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
 
       render(
         <PortableTextEditorTester
@@ -308,7 +307,7 @@ Array [
           offset: 0,
         },
       }
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester
@@ -325,47 +324,47 @@ Array [
         PortableTextEditor.select(editor, sel)
         PortableTextEditor.delete(editor, sel)
         expect(PortableTextEditor.getValue(editor)).toMatchInlineSnapshot(`
-        Array [
-          Object {
+        [
+          {
             "_key": "5fc57af23597",
             "_type": "myTestBlockType",
-            "children": Array [
-              Object {
+            "children": [
+              {
                 "_key": "be1c67c6971a",
                 "_type": "span",
-                "marks": Array [],
+                "marks": [],
                 "text": "This is a ",
               },
-              Object {
+              {
                 "_key": "11c8c9f783a8",
                 "_type": "span",
-                "marks": Array [
+                "marks": [
                   "fde1fd54b544",
                 ],
                 "text": "link",
               },
-              Object {
+              {
                 "_key": "576c748e0cd2",
                 "_type": "span",
-                "marks": Array [],
+                "marks": [],
                 "text": "This is ",
               },
-              Object {
+              {
                 "_key": "f3d73d3833bf",
                 "_type": "span",
-                "marks": Array [
+                "marks": [
                   "7b6d3d5de30c",
                 ],
                 "text": "another",
               },
             ],
-            "markDefs": Array [
-              Object {
+            "markDefs": [
+              {
                 "_key": "fde1fd54b544",
                 "_type": "link",
                 "url": "1",
               },
-              Object {
+              {
                 "_key": "7b6d3d5de30c",
                 "_type": "link",
                 "url": "2",
@@ -420,7 +419,7 @@ Array [
         focus: {path: [{_key: 'bb'}, 'children', {_key: 'sb'}], offset: 0},
         anchor: {path: [{_key: 'bb'}, 'children', {_key: 'sb'}], offset: 0},
       }
-      const onChange = jest.fn()
+      const onChange = vi.fn()
 
       render(
         <PortableTextEditorTester
@@ -523,7 +522,7 @@ Array [
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
 
       render(
         <PortableTextEditorTester
@@ -593,7 +592,7 @@ Array [
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester
@@ -648,7 +647,7 @@ Array [
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester
@@ -704,7 +703,7 @@ Array [
           style: 'normal',
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester
@@ -739,7 +738,6 @@ Array [
             },
           })
 
-          // // eslint-disable-next-line max-nested-callbacks
           const linkType = editorRef.current.schemaTypes.annotations.find(
             (a) => a.name === 'link',
           )
@@ -861,7 +859,7 @@ Array [
           ],
         },
       ]
-      const onChange = jest.fn()
+      const onChange = vi.fn()
       await waitFor(() => {
         render(
           <PortableTextEditorTester

package/src/editor/plugins/__tests__/withPortableTextSelections.test.tsx

@@ -1,6 +1,6 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -41,7 +41,7 @@ const initialValue = [
 describe('plugin:withPortableTextSelections', () => {
   it('will report that a selection is made backward', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -54,34 +54,45 @@ describe('plugin:withPortableTextSelections', () => {
       anchor: {path: [{_key: 'b'}, 'children', {_key: 'b1'}], offset: 9},
       focus: {path: [{_key: 'a'}, 'children', {_key: 'a1'}], offset: 7},
     }
+
+    await waitFor(() => {
+      if (editorRef.current) {
+        expect(onChange).toHaveBeenCalledWith({
+          type: 'value',
+          value: initialValue,
+        })
+        expect(onChange).toHaveBeenCalledWith({type: 'ready'})
+      }
+    })
+
     await waitFor(() => {
       if (editorRef.current) {
         PortableTextEditor.focus(editorRef.current)
         PortableTextEditor.select(editorRef.current, initialSelection)
         expect(PortableTextEditor.getSelection(editorRef.current))
           .toMatchInlineSnapshot(`
-          Object {
-            "anchor": Object {
+          {
+            "anchor": {
               "offset": 9,
-              "path": Array [
-                Object {
+              "path": [
+                {
                   "_key": "b",
                 },
                 "children",
-                Object {
+                {
                   "_key": "b1",
                 },
               ],
             },
             "backward": true,
-            "focus": Object {
+            "focus": {
               "offset": 7,
-              "path": Array [
-                Object {
+              "path": [
+                {
                   "_key": "a",
                 },
                 "children",
-                Object {
+                {
                   "_key": "a1",
                 },
               ],

package/src/editor/plugins/__tests__/withUndoRedo.test.tsx

@@ -1,6 +1,6 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
+import {describe, expect, it, vi} from 'vitest'
 import {
   PortableTextEditorTester,
   schemaType,
@@ -46,7 +46,7 @@ const initialSelection = {
 describe('plugin:withUndoRedo', () => {
   it('preserves the keys when undoing ', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
     render(
       <PortableTextEditorTester
         onChange={onChange}
@@ -77,19 +77,19 @@ describe('plugin:withUndoRedo', () => {
         )
         expect(PortableTextEditor.getValue(editorRef.current))
           .toMatchInlineSnapshot(`
-          Array [
-            Object {
+          [
+            {
               "_key": "a",
               "_type": "myTestBlockType",
-              "children": Array [
-                Object {
+              "children": [
+                {
                   "_key": "a1",
                   "_type": "span",
-                  "marks": Array [],
+                  "marks": [],
                   "text": "Block A",
                 },
               ],
-              "markDefs": Array [],
+              "markDefs": [],
               "style": "normal",
             },
           ]
@@ -103,7 +103,7 @@ describe('plugin:withUndoRedo', () => {
   })
   it('preserves the keys when redoing ', async () => {
     const editorRef: RefObject<PortableTextEditor> = createRef()
-    const onChange = jest.fn()
+    const onChange = vi.fn()
 
     render(
       <PortableTextEditorTester

package/src/editor/plugins/createWithEditableAPI.ts

@@ -19,13 +19,13 @@ import {
   Transforms,
 } from 'slate'
 import {ReactEditor} from 'slate-react'
-import {type DOMNode} from 'slate-react/dist/utils/dom'
-import {
-  type EditableAPI,
-  type EditableAPIDeleteOptions,
-  type EditorSelection,
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {DOMNode} from 'slate-react/dist/utils/dom'
+import type {
+  EditableAPI,
+  EditableAPIDeleteOptions,
+  EditorSelection,
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {toPortableTextRange, toSlateRange} from '../../utils/ranges'
@@ -38,7 +38,7 @@ import {
   KEY_TO_VALUE_ELEMENT,
   SLATE_TO_PORTABLE_TEXT_RANGE,
 } from '../../utils/weakMaps'
-import {type PortableTextEditor} from '../PortableTextEditor'
+import type {PortableTextEditor} from '../PortableTextEditor'
 
 const debug = debugWithName('API:editable')
 

package/src/editor/plugins/createWithHotKeys.ts

@@ -1,18 +1,16 @@
-/* eslint-disable max-statements */
-/* eslint-disable complexity */
 import {isPortableTextSpan, isPortableTextTextBlock} from '@sanity/types'
 import {isHotkey} from 'is-hotkey-esm'
-import {type KeyboardEvent} from 'react'
+import type {KeyboardEvent} from 'react'
 import {Editor, Node, Path, Range, Transforms} from 'slate'
-import {type ReactEditor} from 'slate-react'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {ReactEditor} from 'slate-react'
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
-import {type HotkeyOptions} from '../../types/options'
-import {type SlateTextBlock, type VoidElement} from '../../types/slate'
+import type {HotkeyOptions} from '../../types/options'
+import type {SlateTextBlock, VoidElement} from '../../types/slate'
 import {debugWithName} from '../../utils/debug'
-import {type PortableTextEditor} from '../PortableTextEditor'
+import type {PortableTextEditor} from '../PortableTextEditor'
 
 const debug = debugWithName('plugin:withHotKeys')
 
@@ -42,7 +40,6 @@ export function createWithHotkeys(
       // Wire up custom marks hotkeys
       Object.keys(activeHotkeys).forEach((cat) => {
         if (cat === 'marks') {
-          // eslint-disable-next-line guard-for-in
           for (const hotkey in activeHotkeys[cat]) {
             if (reservedHotkeys.includes(hotkey)) {
               throw new Error(`The hotkey ${hotkey} is reserved!`)
@@ -59,7 +56,6 @@ export function createWithHotkeys(
           }
         }
         if (cat === 'custom') {
-          // eslint-disable-next-line guard-for-in
           for (const hotkey in activeHotkeys[cat]) {
             if (reservedHotkeys.includes(hotkey)) {
               throw new Error(`The hotkey ${hotkey} is reserved!`)