@portabletext/editor 1.1.0 → 1.1.2

package/src/editor/plugins/index.ts

@@ -1,7 +1,7 @@
 import {noop} from 'lodash'
-import {type BaseOperation, type Editor, type Node, type NodeEntry} from 'slate'
-import {type PortableTextSlateEditor} from '../../types/editor'
-import {type createEditorOptions} from '../../types/options'
+import type {BaseOperation, Editor, Node, NodeEntry} from 'slate'
+import type {PortableTextSlateEditor} from '../../types/editor'
+import type {createEditorOptions} from '../../types/options'
 import {createOperationToPatches} from '../../utils/operationToPatches'
 import {createWithEditableAPI} from './createWithEditableAPI'
 import {createWithInsertBreak} from './createWithInsertBreak'
@@ -49,7 +49,7 @@ export const withPlugins = <T extends Editor>(
   const e = editor as T & PortableTextSlateEditor
   const {keyGenerator, portableTextEditor, patches$, readOnly, maxBlocks} =
     options
-  const {schemaTypes, change$} = portableTextEditor
+  const {editorActor, schemaTypes} = portableTextEditor
   e.subscriptions = []
   if (e.destroy) {
     e.destroy()
@@ -63,15 +63,23 @@ export const withPlugins = <T extends Editor>(
     })
   }
   const operationToPatches = createOperationToPatches(schemaTypes)
-  const withObjectKeys = createWithObjectKeys(schemaTypes, keyGenerator)
-  const withSchemaTypes = createWithSchemaTypes({schemaTypes, keyGenerator})
+  const withObjectKeys = createWithObjectKeys(
+    editorActor,
+    schemaTypes,
+    keyGenerator,
+  )
+  const withSchemaTypes = createWithSchemaTypes({
+    editorActor,
+    schemaTypes,
+    keyGenerator,
+  })
   const withEditableAPI = createWithEditableAPI(
     portableTextEditor,
     schemaTypes,
     keyGenerator,
   )
   const withPatches = createWithPatches({
-    change$,
+    editorActor,
     keyGenerator,
     patches$,
     patchFunctions: operationToPatches,
@@ -86,12 +94,14 @@ export const withPlugins = <T extends Editor>(
     blockSchemaType: schemaTypes.block,
   })
   const withPortableTextMarkModel = createWithPortableTextMarkModel(
+    editorActor,
     schemaTypes,
-    change$,
     keyGenerator,
   )
-  const withPortableTextBlockStyle =
-    createWithPortableTextBlockStyle(schemaTypes)
+  const withPortableTextBlockStyle = createWithPortableTextBlockStyle(
+    editorActor,
+    schemaTypes,
+  )
 
   const withPlaceholderBlock = createWithPlaceholderBlock()
 
@@ -103,7 +113,7 @@ export const withPlugins = <T extends Editor>(
     portableTextEditor,
   })
   const withPortableTextSelections = createWithPortableTextSelections(
-    change$,
+    editorActor,
     schemaTypes,
   )
 

package/src/index.ts

@@ -1,10 +1,16 @@
-export type {PortableTextEditableProps} from './editor/Editable'
+export {type Patch} from '@portabletext/patches'
 export {PortableTextEditable} from './editor/Editable'
+export type {PortableTextEditableProps} from './editor/Editable'
+export {
+  editorMachine,
+  type EditorActor,
+  type MutationEvent,
+  type PatchEvent,
+} from './editor/editor-machine'
 export {usePortableTextEditor} from './editor/hooks/usePortableTextEditor'
 export {defaultKeyGenerator as keyGenerator} from './editor/hooks/usePortableTextEditorKeyGenerator'
 export {usePortableTextEditorSelection} from './editor/hooks/usePortableTextEditorSelection'
-export type {PortableTextEditorProps} from './editor/PortableTextEditor'
 export {PortableTextEditor} from './editor/PortableTextEditor'
+export type {PortableTextEditorProps} from './editor/PortableTextEditor'
 export * from './types/editor'
 export * from './types/options'
-export {type Patch} from '@portabletext/patches'

package/src/types/editor.ts

@@ -1,39 +1,39 @@
-import {type Patch} from '@portabletext/patches'
-import {
-  type ArraySchemaType,
-  type BlockDecoratorDefinition,
-  type BlockListDefinition,
-  type BlockSchemaType,
-  type BlockStyleDefinition,
-  type ObjectSchemaType,
-  type Path,
-  type PortableTextBlock,
-  type PortableTextChild,
-  type PortableTextListBlock,
-  type PortableTextObject,
-  type PortableTextSpan,
-  type PortableTextTextBlock,
-  type SpanSchemaType,
-  type TypedObject,
+import type {Patch} from '@portabletext/patches'
+import type {
+  ArraySchemaType,
+  BlockDecoratorDefinition,
+  BlockListDefinition,
+  BlockSchemaType,
+  BlockStyleDefinition,
+  ObjectSchemaType,
+  Path,
+  PortableTextBlock,
+  PortableTextChild,
+  PortableTextListBlock,
+  PortableTextObject,
+  PortableTextSpan,
+  PortableTextTextBlock,
+  SpanSchemaType,
+  TypedObject,
 } from '@sanity/types'
-import {
-  type ClipboardEvent,
-  type FocusEvent,
-  type KeyboardEvent,
-  type PropsWithChildren,
-  type ReactElement,
-  type RefObject,
+import type {
+  ClipboardEvent,
+  FocusEvent,
+  KeyboardEvent,
+  PropsWithChildren,
+  ReactElement,
+  RefObject,
 } from 'react'
-import {type Observable, type Subject} from 'rxjs'
-import {
-  type Descendant,
-  type Node as SlateNode,
-  type Operation as SlateOperation,
+import type {Observable, Subject} from 'rxjs'
+import type {
+  Descendant,
+  Node as SlateNode,
+  Operation as SlateOperation,
 } from 'slate'
-import {type ReactEditor} from 'slate-react'
-import {type DOMNode} from 'slate-react/dist/utils/dom'
-import {type PortableTextEditableProps} from '../editor/Editable'
-import {type PortableTextEditor} from '../editor/PortableTextEditor'
+import type {ReactEditor} from 'slate-react'
+import type {DOMNode} from 'slate-react/dist/utils/dom'
+import type {PortableTextEditableProps} from '../editor/Editable'
+import type {PortableTextEditor} from '../editor/PortableTextEditor'
 
 /** @beta */
 export interface EditableAPIDeleteOptions {

package/src/types/options.ts

@@ -1,6 +1,6 @@
-import {type BaseSyntheticEvent} from 'react'
-import {type PortableTextEditor} from '../editor/PortableTextEditor'
-import {type PatchObservable} from './editor'
+import type {BaseSyntheticEvent} from 'react'
+import type {PortableTextEditor} from '../editor/PortableTextEditor'
+import type {PatchObservable} from './editor'
 
 /**
  * @internal

package/src/types/slate.ts

@@ -1,7 +1,7 @@
-import {type PortableTextSpan, type PortableTextTextBlock} from '@sanity/types'
-import {type BaseEditor, type Descendant} from 'slate'
-import {type ReactEditor} from 'slate-react'
-import {type PortableTextSlateEditor} from '..'
+import type {PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
+import type {BaseEditor, Descendant} from 'slate'
+import type {ReactEditor} from 'slate-react'
+import type {PortableTextSlateEditor} from '..'
 
 export interface VoidElement {
   _type: string

package/src/utils/__tests__/dmpToOperations.test.ts

@@ -1,5 +1,4 @@
-import {describe, expect, test} from '@jest/globals'
-import {type DiffMatchPatch} from '@portabletext/patches'
+import type {DiffMatchPatch} from '@portabletext/patches'
 import {makeDiff, makePatches, stringifyPatches} from '@sanity/diff-match-patch'
 import {
   isPortableTextSpan,
@@ -9,8 +8,9 @@ import {
   type PortableTextSpan,
   type PortableTextTextBlock,
 } from '@sanity/types'
-import {type Descendant, type Operation} from 'slate'
-import {type PortableTextSlateEditor} from '../../types/editor'
+import type {Descendant, Operation} from 'slate'
+import {describe, expect, test} from 'vitest'
+import type {PortableTextSlateEditor} from '../../types/editor'
 import {diffMatchPatch} from '../applyPatch'
 
 describe('operationToPatches: diffMatchPatch', () => {

package/src/utils/__tests__/operationToPatches.test.ts

@@ -1,6 +1,6 @@
-import {beforeEach, describe, expect, it} from '@jest/globals'
-import {type PortableTextTextBlock} from '@sanity/types'
+import type {PortableTextTextBlock} from '@sanity/types'
 import {createEditor, type Descendant} from 'slate'
+import {beforeEach, describe, expect, it} from 'vitest'
 import {PortableTextEditor, type PortableTextEditorProps} from '../..'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
 import {defaultKeyGenerator} from '../../editor/hooks/usePortableTextEditorKeyGenerator'
@@ -61,34 +61,34 @@ describe('operationToPatches', () => {
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "items": Array [
-            Object {
+      [
+        {
+          "items": [
+            {
               "_key": "773866318fa8",
               "_type": "someObject",
               "title": "The Object",
             },
           ],
-          "path": Array [
-            Object {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "c130395c640c",
             },
           ],
           "position": "after",
           "type": "insert",
         },
-        Object {
-          "path": Array [
-            Object {
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "c130395c640c",
             },
             "text",
@@ -118,17 +118,17 @@ describe('operationToPatches', () => {
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "items": Array [
-            Object {
+      [
+        {
+          "items": [
+            {
               "_key": "c130395c640c",
               "_type": "someObject",
               "title": "The Object",
             },
           ],
-          "path": Array [
-            Object {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
           ],
@@ -160,20 +160,20 @@ describe('operationToPatches', () => {
         [],
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [],
+      [
+        {
+          "path": [],
           "type": "setIfMissing",
-          "value": Array [],
+          "value": [],
         },
-        Object {
-          "items": Array [
-            Object {
+        {
+          "items": [
+            {
               "_key": "c130395c640c",
               "_type": "someObject",
             },
           ],
-          "path": Array [
+          "path": [
             0,
           ],
           "position": "before",
@@ -202,21 +202,21 @@ describe('operationToPatches', () => {
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "items": Array [
-            Object {
+      [
+        {
+          "items": [
+            {
               "_key": "c130395c640c",
               "_type": "someObject",
               "title": "The Object",
             },
           ],
-          "path": Array [
-            Object {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "fd9b4a4e6c0b",
             },
           ],
@@ -243,14 +243,14 @@ describe('operationToPatches', () => {
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [
-            Object {
+      [
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "fd9b4a4e6c0b",
             },
             "text",
@@ -280,14 +280,14 @@ describe('operationToPatches', () => {
         before,
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [
-            Object {
+      [
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "fd9b4a4e6c0b",
             },
             "text",
@@ -320,14 +320,14 @@ describe('operationToPatches', () => {
         createDefaultValue(),
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [
-            Object {
+      [
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "773866318fa8",
             },
           ],
@@ -351,10 +351,10 @@ describe('operationToPatches', () => {
         val,
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [
-            Object {
+      [
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
           ],
@@ -389,14 +389,14 @@ describe('operationToPatches', () => {
         val,
       ),
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "path": Array [
-            Object {
+      [
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "fd9b4a4e6c0b",
             },
             "text",
@@ -404,13 +404,13 @@ describe('operationToPatches', () => {
           "type": "set",
           "value": "1234",
         },
-        Object {
-          "path": Array [
-            Object {
+        {
+          "path": [
+            {
               "_key": "1f2e64b47787",
             },
             "children",
-            Object {
+            {
               "_key": "r4wr323432",
             },
           ],

package/src/utils/__tests__/patchToOperations.test.ts

@@ -1,7 +1,7 @@
-import {beforeEach, describe, expect, it} from '@jest/globals'
-import {type Patch} from '@portabletext/patches'
+import type {Patch} from '@portabletext/patches'
 import {noop} from 'lodash'
 import {createEditor, type Descendant} from 'slate'
+import {beforeEach, describe, expect, it} from 'vitest'
 import {keyGenerator, PortableTextEditor} from '../..'
 import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
 import {withPlugins} from '../../editor/plugins'
@@ -70,21 +70,21 @@ describe('operationToPatches', () => {
       patchToOperations(editor, p)
     })
     expect(editor.children).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "__inline": false,
           "_key": "c01739b0d03b",
           "_type": "image",
-          "children": Array [
-            Object {
+          "children": [
+            {
               "_key": "${VOID_CHILD_KEY}",
               "_type": "span",
-              "marks": Array [],
+              "marks": [],
               "text": "",
             },
           ],
-          "value": Object {
-            "asset": Object {
+          "value": {
+            "asset": {
               "_ref": "image-f52f71bc1df46e080dabe43a8effe8ccfb5f21de-4032x3024-png",
               "_type": "reference",
             },
@@ -93,7 +93,7 @@ describe('operationToPatches', () => {
       ]
     `)
   })
-  it('will not create operations for insertion inside object blocks', () => {
+  it('will not create operations for insertion inside blocks', () => {
     editor.children = [
       {
         _type: 'someType',
@@ -127,31 +127,31 @@ describe('operationToPatches', () => {
       patchToOperations(editor, p)
     })
     expect(editor.children).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "__inline": false,
           "_key": "c01739b0d03b",
           "_type": "someType",
-          "children": Array [
-            Object {
+          "children": [
+            {
               "_key": "${VOID_CHILD_KEY}",
               "_type": "span",
-              "marks": Array [],
+              "marks": [],
               "text": "",
             },
           ],
-          "value": Object {
-            "asset": Object {
+          "value": {
+            "asset": {
               "_ref": "image-f52f71bc1df46e080dabe43a8effe8ccfb5f21de-4032x3024-png",
               "_type": "reference",
             },
-            "nestedArray": Array [],
+            "nestedArray": [],
           },
         },
       ]
     `)
   })
-  it('will not create operations for removal inside object blocks', () => {
+  it('will not create operations for removal inside blocks', () => {
     editor.children = [
       {
         _type: 'someType',
@@ -190,26 +190,26 @@ describe('operationToPatches', () => {
       patchToOperations(editor, p)
     })
     expect(editor.children).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "__inline": false,
           "_key": "c01739b0d03b",
           "_type": "someType",
-          "children": Array [
-            Object {
+          "children": [
+            {
               "_key": "${VOID_CHILD_KEY}",
               "_type": "span",
-              "marks": Array [],
+              "marks": [],
               "text": "",
             },
           ],
-          "value": Object {
-            "asset": Object {
+          "value": {
+            "asset": {
               "_ref": "image-f52f71bc1df46e080dabe43a8effe8ccfb5f21de-4032x3024-png",
               "_type": "reference",
             },
-            "nestedArray": Array [
-              Object {
+            "nestedArray": [
+              {
                 "_key": "foo",
                 "_type": "nestedValue",
               },
@@ -219,7 +219,7 @@ describe('operationToPatches', () => {
       ]
     `)
   })
-  it('will not create operations for setting data inside object blocks', () => {
+  it('will not create operations for setting data inside blocks', () => {
     editor.children = [
       {
         _key: '1335959d4d03',
@@ -265,34 +265,34 @@ describe('operationToPatches', () => {
       patchToOperations(editor, p)
     })
     expect(editor.children).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "_key": "1335959d4d03",
           "_type": "block",
-          "children": Array [
-            Object {
+          "children": [
+            {
               "_key": "9bd868adcd6b",
               "_type": "span",
-              "marks": Array [],
+              "marks": [],
               "text": "1 ",
             },
-            Object {
+            {
               "_key": "6f75d593f3fc",
               "_type": "span",
-              "marks": Array [
+              "marks": [
                 "11de7fcea659",
               ],
               "text": "2",
             },
-            Object {
+            {
               "_key": "033618a7f081",
               "_type": "span",
-              "marks": Array [],
+              "marks": [],
               "text": " 3",
             },
           ],
-          "markDefs": Array [
-            Object {
+          "markDefs": [
+            {
               "_key": "11de7fcea659",
               "_type": "link",
             },

package/src/utils/__tests__/ranges.test.ts

@@ -1,5 +1,5 @@
-import {describe, expect, it} from '@jest/globals'
-import {type InsertTextOperation, type Range} from 'slate'
+import type {InsertTextOperation, Range} from 'slate'
+import {describe, expect, it} from 'vitest'
 import {moveRangeByOperation} from '../ranges'
 
 describe('moveRangeByOperation', () => {