@portabletext/editor 2.3.1 → 2.3.2

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

@@ -1,10 +1,7 @@
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
 import {describe, expect, it, vi} from 'vitest'
-import {
-  PortableTextEditorTester,
-  schemaType,
-} from '../../__tests__/PortableTextEditorTester'
+import {PortableTextEditorTester} from '../../__tests__/PortableTextEditorTester'
 import {createTestKeyGenerator} from '../../../internal-utils/test-key-generator'
 import type {EditorSelection} from '../../../types/editor'
 import {PortableTextEditor} from '../../PortableTextEditor'
@@ -16,7 +13,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: 'a',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'a1',
@@ -47,7 +44,6 @@ describe('plugin:withPortableTextMarksModel', () => {
         <PortableTextEditorTester
           onChange={onChange}
           ref={editorRef}
-          schemaType={schemaType}
           value={initialValue}
           keyGenerator={createTestKeyGenerator()}
         />,
@@ -79,7 +75,7 @@ describe('plugin:withPortableTextMarksModel', () => {
           expect(PortableTextEditor.getValue(editorRef.current)).toEqual([
             {
               _key: 'a',
-              _type: 'myTestBlockType',
+              _type: 'block',
               children: [
                 {
                   _key: 'a1',
@@ -113,7 +109,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: '5fc57af23597',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'be1c67c6971a',
@@ -139,7 +135,7 @@ describe('plugin:withPortableTextMarksModel', () => {
         },
         {
           _key: '7cd53af36712',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: '576c748e0cd2',
@@ -181,7 +177,6 @@ describe('plugin:withPortableTextMarksModel', () => {
             keyGenerator={createTestKeyGenerator()}
             onChange={onChange}
             ref={editorRef}
-            schemaType={schemaType}
             value={initialValue}
           />,
         )
@@ -194,7 +189,7 @@ describe('plugin:withPortableTextMarksModel', () => {
         expect(PortableTextEditor.getValue(editor)).toEqual([
           {
             _key: '5fc57af23597',
-            _type: 'myTestBlockType',
+            _type: 'block',
             children: [
               {
                 _key: 'be1c67c6971a',
@@ -244,7 +239,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: 'ba',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'sa',
@@ -258,7 +253,7 @@ describe('plugin:withPortableTextMarksModel', () => {
         },
         {
           _key: 'bb',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'sb',
@@ -287,7 +282,6 @@ describe('plugin:withPortableTextMarksModel', () => {
         <PortableTextEditorTester
           onChange={onChange}
           ref={editorRef}
-          schemaType={schemaType}
           value={initialValue}
           keyGenerator={createTestKeyGenerator()}
         />,
@@ -315,7 +309,7 @@ describe('plugin:withPortableTextMarksModel', () => {
           expect(PortableTextEditor.getValue(editorRef.current)).toEqual([
             {
               _key: 'ba',
-              _type: 'myTestBlockType',
+              _type: 'block',
               children: [
                 {
                   _key: 'sa',
@@ -329,7 +323,7 @@ describe('plugin:withPortableTextMarksModel', () => {
             },
             {
               _key: 'k2',
-              _type: 'myTestBlockType',
+              _type: 'block',
               children: [
                 {
                   _key: 'k3',
@@ -343,7 +337,7 @@ describe('plugin:withPortableTextMarksModel', () => {
             },
             {
               _key: 'bb',
-              _type: 'myTestBlockType',
+              _type: 'block',
               children: [
                 {
                   _key: 'sb',
@@ -372,7 +366,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: 'ba',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'sa',
@@ -391,7 +385,6 @@ describe('plugin:withPortableTextMarksModel', () => {
         <PortableTextEditorTester
           onChange={onChange}
           ref={editorRef}
-          schemaType={schemaType}
           value={initialValue}
           keyGenerator={createTestKeyGenerator()}
         />,
@@ -437,7 +430,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: 'a',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'a1',
@@ -462,7 +455,6 @@ describe('plugin:withPortableTextMarksModel', () => {
           <PortableTextEditorTester
             onChange={onChange}
             ref={editorRef}
-            schemaType={schemaType}
             value={initialValue}
             keyGenerator={createTestKeyGenerator()}
           />,
@@ -487,7 +479,7 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: 'a',
-          _type: 'myTestBlockType',
+          _type: 'block',
           children: [
             {
               _key: 'a1',
@@ -518,7 +510,6 @@ describe('plugin:withPortableTextMarksModel', () => {
           <PortableTextEditorTester
             onChange={onChange}
             ref={editorRef}
-            schemaType={schemaType}
             value={initialValue}
             keyGenerator={createTestKeyGenerator()}
           />,
@@ -545,10 +536,10 @@ describe('plugin:withPortableTextMarksModel', () => {
       const initialValue = [
         {
           _key: '5fc57af23597',
-          _type: 'someObject',
+          _type: 'custom image',
         },
         {
-          _type: 'myTestBlockType',
+          _type: 'block',
           _key: 'existingBlock',
           style: 'normal',
           markDefs: [],
@@ -569,7 +560,6 @@ describe('plugin:withPortableTextMarksModel', () => {
             keyGenerator={createTestKeyGenerator()}
             onChange={onChange}
             ref={editorRef}
-            schemaType={schemaType}
             value={initialValue}
           />,
         )
@@ -601,7 +591,7 @@ describe('plugin:withPortableTextMarksModel', () => {
           const value = PortableTextEditor.getValue(editorRef.current)
           expect(value).toEqual([
             {
-              _type: 'myTestBlockType',
+              _type: 'block',
               _key: 'existingBlock',
               style: 'normal',
               markDefs: [],

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

@@ -1,17 +1,14 @@
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
 import {describe, expect, it, vi} from 'vitest'
-import {
-  PortableTextEditorTester,
-  schemaType,
-} from '../../__tests__/PortableTextEditorTester'
+import {PortableTextEditorTester} from '../../__tests__/PortableTextEditorTester'
 import {createTestKeyGenerator} from '../../../internal-utils/test-key-generator'
 import {PortableTextEditor} from '../../PortableTextEditor'
 
 const initialValue = [
   {
     _key: 'a',
-    _type: 'myTestBlockType',
+    _type: 'block',
     children: [
       {
         _key: 'a1',
@@ -25,7 +22,7 @@ const initialValue = [
   },
   {
     _key: 'b',
-    _type: 'myTestBlockType',
+    _type: 'block',
     children: [
       {
         _key: 'b1',
@@ -48,7 +45,6 @@ describe('plugin:withPortableTextSelections', () => {
         keyGenerator={createTestKeyGenerator()}
         onChange={onChange}
         ref={editorRef}
-        schemaType={schemaType}
         value={initialValue}
       />,
     )

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

@@ -1,17 +1,14 @@
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
 import {describe, expect, it, vi} from 'vitest'
-import {
-  PortableTextEditorTester,
-  schemaType,
-} from '../../__tests__/PortableTextEditorTester'
+import {PortableTextEditorTester} from '../../__tests__/PortableTextEditorTester'
 import {createTestKeyGenerator} from '../../../internal-utils/test-key-generator'
 import {PortableTextEditor} from '../../PortableTextEditor'
 
 const initialValue = [
   {
     _key: 'a',
-    _type: 'myTestBlockType',
+    _type: 'block',
     children: [
       {
         _key: 'a1',
@@ -25,7 +22,7 @@ const initialValue = [
   },
   {
     _key: 'b',
-    _type: 'myTestBlockType',
+    _type: 'block',
     children: [
       {
         _key: 'b1',
@@ -53,7 +50,6 @@ describe('plugin:withUndoRedo', () => {
         keyGenerator={createTestKeyGenerator()}
         onChange={onChange}
         ref={editorRef}
-        schemaType={schemaType}
         value={initialValue}
       />,
     )
@@ -82,7 +78,7 @@ describe('plugin:withUndoRedo', () => {
           [
             {
               "_key": "a",
-              "_type": "myTestBlockType",
+              "_type": "block",
               "children": [
                 {
                   "_key": "a1",
@@ -112,7 +108,6 @@ describe('plugin:withUndoRedo', () => {
         keyGenerator={createTestKeyGenerator()}
         onChange={onChange}
         ref={editorRef}
-        schemaType={schemaType}
         value={initialValue}
       />,
     )

package/src/internal-utils/__tests__/valueNormalization.test.tsx

@@ -1,10 +1,7 @@
 import {render, waitFor} from '@testing-library/react'
 import {createRef, type RefObject} from 'react'
 import {describe, expect, it, vi} from 'vitest'
-import {
-  PortableTextEditorTester,
-  schemaType,
-} from '../../editor/__tests__/PortableTextEditorTester'
+import {PortableTextEditorTester} from '../../editor/__tests__/PortableTextEditorTester'
 import {PortableTextEditor} from '../../editor/PortableTextEditor'
 import {createTestKeyGenerator} from '../test-key-generator'
 
@@ -14,7 +11,7 @@ describe('values: normalization', () => {
     const initialValue = [
       {
         _key: '5fc57af23597',
-        _type: 'myTestBlockType',
+        _type: 'block',
         children: [
           {
             _key: 'be1c67c6971a',
@@ -32,7 +29,6 @@ describe('values: normalization', () => {
         keyGenerator={createTestKeyGenerator()}
         onChange={onChange}
         ref={editorRef}
-        schemaType={schemaType}
         value={initialValue}
       />,
     )
@@ -64,7 +60,7 @@ describe('values: normalization', () => {
         expect(PortableTextEditor.getValue(editorRef.current)).toEqual([
           {
             _key: '5fc57af23597',
-            _type: 'myTestBlockType',
+            _type: 'block',
             children: [
               {
                 _key: 'be1c67c6971a',

package/src/internal-utils/__tests__/values.test.ts

@@ -1,10 +1,9 @@
 import {describe, expect, it} from 'vitest'
-import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
-import {legacySchemaToEditorSchema} from '../../editor/editor-schema'
-import {createLegacySchema} from '../../editor/legacy-schema'
+import {compileSchemaDefinition} from '../../editor/editor-schema'
+import {defineSchema} from '../../editor/editor-schema-definition'
 import {fromSlateValue, toSlateValue} from '../values'
 
-const schemaTypes = legacySchemaToEditorSchema(createLegacySchema(schemaType))
+const schemaTypes = compileSchemaDefinition(defineSchema({}))
 
 describe('toSlateValue', () => {
   it('checks undefined', () => {
@@ -63,7 +62,7 @@ describe('toSlateValue', () => {
 [
   {
     "_key": "123",
-    "_type": "myTestBlockType",
+    "_type": "block",
     "children": [
       {
         "_key": "1231",
@@ -106,7 +105,7 @@ describe('toSlateValue', () => {
 [
   {
     "_key": "123",
-    "_type": "myTestBlockType",
+    "_type": "block",
     "children": [
       {
         "_key": "1231",

package/src/internal-utils/operation-to-patches.test.ts

@@ -2,11 +2,13 @@ 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 {
+  compileSchemaDefinition,
+  compileSchemaDefinitionToLegacySchema,
+} from '../editor/editor-schema'
+import {defineSchema} from '../editor/editor-schema-definition'
 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 {
@@ -18,11 +20,14 @@ import {
   splitNodePatch,
 } from './operation-to-patches'
 
-const legacySchema = createLegacySchema(schemaType)
-const schemaTypes = legacySchemaToEditorSchema(legacySchema)
+const schemaDefinition = defineSchema({
+  inlineObjects: [{name: 'someObject'}],
+})
+const schema = compileSchemaDefinition(schemaDefinition)
+const legacySchema = compileSchemaDefinitionToLegacySchema(schemaDefinition)
 const editorActor = createActor(editorMachine, {
   input: {
-    schema: schemaTypes,
+    schema,
     keyGenerator: defaultKeyGenerator,
     getLegacySchema: () => legacySchema,
   },
@@ -38,7 +43,7 @@ const editor = withPlugins(createEditor(), {
 const createDefaultValue = () =>
   [
     {
-      _type: 'myTestBlockType',
+      _type: 'block',
       _key: '1f2e64b47787',
       style: 'normal',
       markDefs: [],
@@ -65,7 +70,7 @@ describe('operationToPatches', () => {
   it('translates void items correctly when splitting spans', () => {
     expect(
       splitNodePatch(
-        schemaTypes,
+        schema,
         editor.children,
         {
           type: 'split_node',
@@ -119,7 +124,7 @@ describe('operationToPatches', () => {
   it('produce correct insert block patch', () => {
     expect(
       insertNodePatch(
-        schemaTypes,
+        schema,
         editor.children,
         {
           type: 'insert_node',
@@ -161,7 +166,7 @@ describe('operationToPatches', () => {
     editor.onChange()
     expect(
       insertNodePatch(
-        schemaTypes,
+        schema,
         editor.children,
         {
           type: 'insert_node',
@@ -204,7 +209,7 @@ describe('operationToPatches', () => {
   it('produce correct insert child patch', () => {
     expect(
       insertNodePatch(
-        schemaTypes,
+        schema,
         editor.children,
         {
           type: 'insert_node',
@@ -392,7 +397,7 @@ describe('operationToPatches', () => {
     editor.onChange()
     expect(
       mergeNodePatch(
-        schemaTypes,
+        schema,
         editor.children,
         {
           type: 'merge_node',

package/src/plugins/plugin.internal.portable-text-editor-ref.tsx

@@ -0,0 +1,16 @@
+import React from 'react'
+import {usePortableTextEditor} from '../editor/hooks/usePortableTextEditor'
+import type {PortableTextEditor} from '../editor/PortableTextEditor'
+
+export const InternalPortableTextEditorRefPlugin =
+  React.forwardRef<PortableTextEditor | null>((_, ref) => {
+    const portableTextEditor = usePortableTextEditor()
+
+    const portableTextEditorRef = React.useRef(portableTextEditor)
+
+    React.useImperativeHandle(ref, () => portableTextEditorRef.current, [])
+
+    return null
+  })
+InternalPortableTextEditorRefPlugin.displayName =
+  'InternalPortableTextEditorRefPlugin'

package/src/editor/__tests__/sync-value.test.tsx

@@ -1,154 +0,0 @@
-import {render, waitFor} from '@testing-library/react'
-import {createRef, type RefObject} from 'react'
-import {describe, expect, it, vi} from 'vitest'
-import {createTestKeyGenerator} from '../../internal-utils/test-key-generator'
-import {PortableTextEditor} from '../PortableTextEditor'
-import {PortableTextEditorTester, schemaType} from './PortableTextEditorTester'
-
-const initialValue = [
-  {
-    _key: '77071c3af231',
-    _type: 'myTestBlockType',
-    children: [
-      {
-        _key: 'c001f0e92c1f0',
-        _type: 'span',
-        marks: [],
-        text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ',
-      },
-    ],
-    markDefs: [],
-    style: 'normal',
-  },
-]
-
-describe('useSyncValue', () => {
-  it('updates span text', async () => {
-    const editorRef: RefObject<PortableTextEditor | null> = createRef()
-    const onChange = vi.fn()
-    const syncedValue = [
-      {
-        _key: '77071c3af231',
-        _type: 'myTestBlockType',
-        children: [
-          {
-            _key: 'c001f0e92c1f0',
-            _type: 'span',
-            marks: [],
-            text: 'Lorem my ipsum!',
-          },
-        ],
-        markDefs: [],
-        style: 'normal',
-      },
-    ]
-    const {rerender} = render(
-      <PortableTextEditorTester
-        keyGenerator={createTestKeyGenerator()}
-        onChange={onChange}
-        ref={editorRef}
-        schemaType={schemaType}
-        value={initialValue}
-      />,
-    )
-
-    await waitFor(() => {
-      if (editorRef.current) {
-        expect(onChange).toHaveBeenCalledWith({
-          type: 'value',
-          value: initialValue,
-        })
-        expect(onChange).toHaveBeenCalledWith({type: 'ready'})
-      }
-    })
-
-    rerender(
-      <PortableTextEditorTester
-        keyGenerator={createTestKeyGenerator()}
-        onChange={onChange}
-        ref={editorRef}
-        schemaType={schemaType}
-        value={syncedValue}
-      />,
-    )
-
-    await waitFor(() => {
-      if (editorRef.current) {
-        expect(PortableTextEditor.getValue(editorRef.current)).toEqual(
-          syncedValue,
-        )
-      }
-    })
-  })
-
-  it('replaces span nodes with different keys inside the same children array', async () => {
-    const editorRef: RefObject<PortableTextEditor | null> = createRef()
-    const onChange = vi.fn()
-    const syncedValue = [
-      {
-        _key: '77071c3af231',
-        _type: 'myTestBlockType',
-        children: [
-          {
-            _key: 'c001f0e92c1f0__NEW_KEY_YA!',
-            _type: 'span',
-            marks: [],
-            text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ',
-          },
-        ],
-        markDefs: [],
-        style: 'normal',
-      },
-    ]
-    const {rerender} = render(
-      <PortableTextEditorTester
-        keyGenerator={createTestKeyGenerator()}
-        onChange={onChange}
-        ref={editorRef}
-        schemaType={schemaType}
-        value={initialValue}
-      />,
-    )
-
-    await waitFor(() => {
-      if (editorRef.current) {
-        expect(onChange).toHaveBeenCalledWith({
-          type: 'value',
-          value: initialValue,
-        })
-        expect(onChange).toHaveBeenCalledWith({type: 'ready'})
-      }
-    })
-
-    rerender(
-      <PortableTextEditorTester
-        keyGenerator={createTestKeyGenerator()}
-        onChange={onChange}
-        ref={editorRef}
-        schemaType={schemaType}
-        value={syncedValue}
-      />,
-    )
-
-    await waitFor(() => {
-      if (editorRef.current) {
-        expect(PortableTextEditor.getValue(editorRef.current)).toEqual([
-          {
-            _key: '77071c3af231',
-            _type: 'myTestBlockType',
-            children: [
-              {
-                _key: 'c001f0e92c1f0__NEW_KEY_YA!',
-                _type: 'span',
-                marks: [],
-                text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ',
-              },
-            ],
-            markDefs: [],
-            style: 'normal',
-          },
-        ])
-      }
-    })
-  })
-})