@portabletext/editor 1.1.0 → 1.1.2

package/src/editor/plugins/createWithInsertBreak.ts

@@ -1,10 +1,10 @@
 import {isEqual} from 'lodash'
 import {Editor, Node, Path, Range, Transforms} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
-import {type SlateTextBlock, type VoidElement} from '../../types/slate'
+import type {SlateTextBlock, VoidElement} from '../../types/slate'
 
 export function createWithInsertBreak(
   types: PortableTextMemberSchemaTypes,

package/src/editor/plugins/createWithInsertData.ts

@@ -1,12 +1,12 @@
 import {htmlToBlocks, normalizeBlock} from '@sanity/block-tools'
-import {type PortableTextBlock, type PortableTextChild} from '@sanity/types'
+import type {PortableTextBlock, PortableTextChild} from '@sanity/types'
 import {isEqual, uniq} from 'lodash'
 import {Editor, Range, Transforms, type Descendant, type Node} from 'slate'
 import {ReactEditor} from 'slate-react'
-import {
-  type EditorChanges,
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  EditorChanges,
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {validateValue} from '../../utils/validateValue'
@@ -15,6 +15,7 @@ import {
   isEqualToEmptyEditor,
   toSlateValue,
 } from '../../utils/values'
+import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withInsertData')
 
@@ -23,7 +24,7 @@ const debug = debugWithName('plugin:withInsertData')
  *
  */
 export function createWithInsertData(
-  change$: EditorChanges,
+  editorActor: EditorActor,
   schemaTypes: PortableTextMemberSchemaTypes,
   keyGenerator: () => string,
 ) {
@@ -158,9 +159,8 @@ export function createWithInsertData(
           // Bail out if it's not valid
           if (!validation.valid && !validation.resolution?.autoResolve) {
             const errorDescription = `${validation.resolution?.description}`
-            change$.next({
+            editorActor.send({
               type: 'error',
-              level: 'warning',
               name: 'pasteError',
               description: errorDescription,
               data: validation,
@@ -180,7 +180,6 @@ export function createWithInsertData(
         debug('No selection, not inserting')
         return false
       }
-      change$.next({type: 'loading', isLoading: true}) // This could potentially take some time
       const html = data.getData('text/html')
       const text = data.getData('text/plain')
 
@@ -188,7 +187,7 @@ export function createWithInsertData(
         debug('Inserting data', data)
         let portableText: PortableTextBlock[]
         let fragment: Node[]
-        let insertedType
+        let insertedType: string | undefined
 
         if (html) {
           portableText = htmlToBlocks(html, schemaTypes.portableText, {
@@ -232,9 +231,8 @@ export function createWithInsertData(
         // Bail out if it's not valid
         if (!validation.valid) {
           const errorDescription = `Could not validate the resulting portable text to insert.\n${validation.resolution?.description}\nTry to insert as plain text (shift-paste) instead.`
-          change$.next({
+          editorActor.send({
             type: 'error',
-            level: 'warning',
             name: 'pasteError',
             description: errorDescription,
             data: validation,
@@ -246,10 +244,8 @@ export function createWithInsertData(
           `Inserting ${insertedType} fragment at ${JSON.stringify(editor.selection)}`,
         )
         _insertFragment(editor, fragment, schemaTypes)
-        change$.next({type: 'loading', isLoading: false})
         return true
       }
-      change$.next({type: 'loading', isLoading: false})
       return false
     }
 
@@ -335,8 +331,7 @@ function _regenerateKeys(
                 ...child,
                 marks:
                   child.marks && child.marks.includes(oldKey)
-                    ? // eslint-disable-next-line max-nested-callbacks
-                      [...child.marks]
+                    ? [...child.marks]
                         .filter((mark) => mark !== oldKey)
                         .concat(newKey)
                     : child.marks,

package/src/editor/plugins/createWithMaxBlocks.ts

@@ -1,4 +1,4 @@
-import {type PortableTextSlateEditor} from '../../types/editor'
+import type {PortableTextSlateEditor} from '../../types/editor'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'
 

package/src/editor/plugins/createWithObjectKeys.ts

@@ -1,16 +1,18 @@
 import {Editor, Element, Node, Transforms} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'
+import type {EditorActor} from '../editor-machine'
 
 /**
  * This plugin makes sure that every new node in the editor get a new _key prop when created
  *
  */
 export function createWithObjectKeys(
+  editorActor: EditorActor,
   schemaTypes: PortableTextMemberSchemaTypes,
   keyGenerator: () => string,
 ) {
@@ -75,12 +77,17 @@ export function createWithObjectKeys(
       if (Element.isElement(node) && node._type === schemaTypes.block.name) {
         // Set key on block itself
         if (!node._key) {
+          editorActor.send({type: 'normalizing'})
           Transforms.setNodes(editor, {_key: keyGenerator()}, {at: path})
+          editorActor.send({type: 'done normalizing'})
+          return
         }
         // Set keys on it's children
         for (const [child, childPath] of Node.children(editor, path)) {
           if (!child._key) {
+            editorActor.send({type: 'normalizing'})
             Transforms.setNodes(editor, {_key: keyGenerator()}, {at: childPath})
+            editorActor.send({type: 'done normalizing'})
             return
           }
         }

package/src/editor/plugins/createWithPatches.ts

@@ -1,6 +1,4 @@
-/* eslint-disable max-nested-callbacks */
 import {insert, setIfMissing, unset, type Patch} from '@portabletext/patches'
-import {type Subject} from 'rxjs'
 import {
   Editor,
   type Descendant,
@@ -14,11 +12,10 @@ import {
   type SetNodeOperation,
   type SplitNodeOperation,
 } from 'slate'
-import {
-  type EditorChange,
-  type PatchObservable,
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PatchObservable,
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {createApplyPatch} from '../../utils/applyPatch'
 import {debugWithName} from '../../utils/debug'
@@ -33,6 +30,7 @@ import {
   PATCHING,
   withoutPatching,
 } from '../../utils/withoutPatching'
+import type {EditorActor} from '../editor-machine'
 import {withoutSaving} from './createWithUndoRedo'
 
 const debug = debugWithName('plugin:withPatches')
@@ -82,7 +80,7 @@ export interface PatchFunctions {
 }
 
 interface Options {
-  change$: Subject<EditorChange>
+  editorActor: EditorActor
   keyGenerator: () => string
   patches$?: PatchObservable
   patchFunctions: PatchFunctions
@@ -91,7 +89,7 @@ interface Options {
 }
 
 export function createWithPatches({
-  change$,
+  editorActor,
   patches$,
   patchFunctions,
   readOnly,
@@ -269,7 +267,6 @@ export function createWithPatches({
             ),
           ]
           break
-        case 'set_selection':
         default:
         // Do nothing
       }
@@ -283,7 +280,7 @@ export function createWithPatches({
         )
       ) {
         patches = [...patches, unset([])]
-        change$.next({
+        editorActor.send({
           type: 'unset',
           previousValue: fromSlateValue(
             previousChildren,
@@ -301,7 +298,7 @@ export function createWithPatches({
       // Emit all patches
       if (patches.length > 0) {
         patches.forEach((patch) => {
-          change$.next({
+          editorActor.send({
             type: 'patch',
             patch: {...patch, origin: 'local'},
           })

package/src/editor/plugins/createWithPlaceholderBlock.ts

@@ -1,6 +1,6 @@
 import {Editor, Path} from 'slate'
-import {type PortableTextSlateEditor} from '../../types/editor'
-import {type SlateTextBlock, type VoidElement} from '../../types/slate'
+import type {PortableTextSlateEditor} from '../../types/editor'
+import type {SlateTextBlock, VoidElement} from '../../types/slate'
 import {debugWithName} from '../../utils/debug'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'

package/src/editor/plugins/createWithPortableTextBlockStyle.ts

@@ -1,13 +1,15 @@
 import {Editor, Path, Text as SlateText, Transforms, type Node} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
+import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withPortableTextBlockStyle')
 
 export function createWithPortableTextBlockStyle(
+  editorActor: EditorActor,
   types: PortableTextMemberSchemaTypes,
 ): (editor: PortableTextSlateEditor) => PortableTextSlateEditor {
   const defaultStyle = types.styles[0].value
@@ -17,9 +19,10 @@ export function createWithPortableTextBlockStyle(
     // Extend Slate's default normalization to reset split node to normal style
     // if there is no text at the right end of the split.
     const {normalizeNode} = editor
+
     editor.normalizeNode = (nodeEntry) => {
-      normalizeNode(nodeEntry)
       const [, path] = nodeEntry
+
       for (const op of editor.operations) {
         if (
           op.type === 'split_node' &&
@@ -32,16 +35,21 @@ export function createWithPortableTextBlockStyle(
           const [child] = Editor.node(editor, [op.path[0] + 1, 0])
           if (SlateText.isText(child) && child.text === '') {
             debug(`Normalizing split node to ${defaultStyle} style`, op)
+            editorActor.send({type: 'normalizing'})
             Transforms.setNodes(
               editor,
               {style: defaultStyle},
               {at: [op.path[0] + 1], voids: false},
             )
-            break
+            editorActor.send({type: 'done normalizing'})
+            return
           }
         }
       }
+
+      normalizeNode(nodeEntry)
     }
+
     editor.pteHasBlockStyle = (style: string): boolean => {
       if (!editor.selection) {
         return false

package/src/editor/plugins/createWithPortableTextLists.ts

@@ -1,7 +1,7 @@
 import {Editor, Element, Text, Transforms, type Node} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 
@@ -38,7 +38,6 @@ export function createWithPortableTextLists(
       ]
       selectedBlocks.forEach(([node, path]) => {
         if (editor.isListBlock(node)) {
-          // eslint-disable-next-line @typescript-eslint/no-unused-vars
           const {listItem, level, ...rest} = node
           const newNode = {
             ...rest,

package/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -1,5 +1,3 @@
-/* eslint-disable max-statements */
-/* eslint-disable complexity */
 /**
  *
  * This plugin will change Slate's default marks model (every prop is a mark) with the Portable Text model (marks is an array of strings on prop .marks).
@@ -7,9 +5,8 @@
  */
 
 import {isPortableTextBlock, isPortableTextSpan} from '@portabletext/toolkit'
-import {type PortableTextObject} from '@sanity/types'
+import type {PortableTextObject} from '@sanity/types'
 import {isEqual, uniq} from 'lodash'
-import {type Subject} from 'rxjs'
 import {
   Editor,
   Element,
@@ -20,21 +17,21 @@ import {
   Transforms,
   type Descendant,
 } from 'slate'
-import {
-  type EditorChange,
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {toPortableTextRange} from '../../utils/ranges'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'
+import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withPortableTextMarkModel')
 
 export function createWithPortableTextMarkModel(
+  editorActor: EditorActor,
   types: PortableTextMemberSchemaTypes,
-  change$: Subject<EditorChange>,
   keyGenerator: () => string,
 ): (editor: PortableTextSlateEditor) => PortableTextSlateEditor {
   return function withPortableTextMarkModel(editor: PortableTextSlateEditor) {
@@ -61,7 +58,7 @@ export function createWithPortableTextMarkModel(
         editor.selection,
         types,
       )
-      change$.next({type: 'selection', selection: ptRange})
+      editorActor.send({type: 'selection', selection: ptRange})
     }
 
     // Extend Slate's default normalization. Merge spans with same set of .marks when doing merge_node operations, and clean up markDefs / marks
@@ -84,10 +81,12 @@ export function createWithPortableTextMarkModel(
               JSON.stringify(child, null, 2),
               JSON.stringify(nextNode, null, 2),
             )
+            editorActor.send({type: 'normalizing'})
             Transforms.mergeNodes(editor, {
               at: [childPath[0], childPath[1] + 1],
               voids: true,
             })
+            editorActor.send({type: 'done normalizing'})
             return
           }
         }
@@ -98,7 +97,9 @@ export function createWithPortableTextMarkModel(
        */
       if (editor.isTextBlock(node) && !Array.isArray(node.markDefs)) {
         debug('Adding .markDefs to block node')
+        editorActor.send({type: 'normalizing'})
         Transforms.setNodes(editor, {markDefs: []}, {at: path})
+        editorActor.send({type: 'done normalizing'})
         return
       }
 
@@ -107,7 +108,9 @@ export function createWithPortableTextMarkModel(
        */
       if (editor.isTextSpan(node) && !Array.isArray(node.marks)) {
         debug('Adding .marks to span node')
+        editorActor.send({type: 'normalizing'})
         Transforms.setNodes(editor, {marks: []}, {at: path})
+        editorActor.send({type: 'done normalizing'})
         return
       }
 
@@ -125,11 +128,13 @@ export function createWithPortableTextMarkModel(
         if (editor.isTextBlock(block)) {
           if (node.text === '' && annotations && annotations.length > 0) {
             debug('Removing annotations from empty span node')
+            editorActor.send({type: 'normalizing'})
             Transforms.setNodes(
               editor,
               {marks: node.marks?.filter((mark) => decorators.includes(mark))},
               {at: path},
             )
+            editorActor.send({type: 'done normalizing'})
             return
           }
         }
@@ -153,6 +158,7 @@ export function createWithPortableTextMarkModel(
 
             if (orphanedAnnotations.length > 0) {
               debug('Removing orphaned annotations from span node')
+              editorActor.send({type: 'normalizing'})
               Transforms.setNodes(
                 editor,
                 {
@@ -162,6 +168,7 @@ export function createWithPortableTextMarkModel(
                 },
                 {at: childPath},
               )
+              editorActor.send({type: 'done normalizing'})
               return
             }
           }
@@ -189,6 +196,7 @@ export function createWithPortableTextMarkModel(
 
           if (orphanedAnnotations.length > 0) {
             debug('Removing orphaned annotations from span node')
+            editorActor.send({type: 'normalizing'})
             Transforms.setNodes(
               editor,
               {
@@ -198,6 +206,7 @@ export function createWithPortableTextMarkModel(
               },
               {at: path},
             )
+            editorActor.send({type: 'done normalizing'})
             return
           }
         }
@@ -218,7 +227,10 @@ export function createWithPortableTextMarkModel(
 
         if (markDefs.length !== newMarkDefs.length) {
           debug('Removing duplicate markDefs')
+          editorActor.send({type: 'normalizing'})
           Transforms.setNodes(editor, {markDefs: newMarkDefs}, {at: path})
+          editorActor.send({type: 'done normalizing'})
+          return
         }
       }
 
@@ -243,6 +255,7 @@ export function createWithPortableTextMarkModel(
         })
         if (node.markDefs && !isEqual(newMarkDefs, node.markDefs)) {
           debug('Removing markDef not in use')
+          editorActor.send({type: 'normalizing'})
           Transforms.setNodes(
             editor,
             {
@@ -250,6 +263,7 @@ export function createWithPortableTextMarkModel(
             },
             {at: path},
           )
+          editorActor.send({type: 'done normalizing'})
           return
         }
       }

package/src/editor/plugins/createWithPortableTextSelections.ts

@@ -1,10 +1,8 @@
-import {type Subject} from 'rxjs'
-import {type BaseRange} from 'slate'
-import {
-  type EditorChange,
-  type EditorSelection,
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {BaseRange} from 'slate'
+import type {
+  EditorSelection,
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {
@@ -12,13 +10,14 @@ import {
   type ObjectWithKeyAndType,
 } from '../../utils/ranges'
 import {SLATE_TO_PORTABLE_TEXT_RANGE} from '../../utils/weakMaps'
+import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withPortableTextSelections')
 const debugVerbose = debug.enabled && false
 
 // This plugin will make sure that we emit a PT selection whenever the editor has changed.
 export function createWithPortableTextSelections(
-  change$: Subject<EditorChange>,
+  editorActor: EditorActor,
   types: PortableTextMemberSchemaTypes,
 ): (editor: PortableTextSlateEditor) => PortableTextSlateEditor {
   let prevSelection: BaseRange | null = null
@@ -46,9 +45,9 @@ export function createWithPortableTextSelections(
           )
         }
         if (ptRange) {
-          change$.next({type: 'selection', selection: ptRange})
+          editorActor.send({type: 'selection', selection: ptRange})
         } else {
-          change$.next({type: 'selection', selection: null})
+          editorActor.send({type: 'selection', selection: null})
         }
       }
       prevSelection = editor.selection

package/src/editor/plugins/createWithSchemaTypes.ts

@@ -7,11 +7,12 @@ import {
   type PortableTextTextBlock,
 } from '@sanity/types'
 import {Transforms, type Element} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
+import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withSchemaTypes')
 /**
@@ -19,9 +20,11 @@ const debug = debugWithName('plugin:withSchemaTypes')
  *
  */
 export function createWithSchemaTypes({
+  editorActor,
   schemaTypes,
   keyGenerator,
 }: {
+  editorActor: EditorActor
   schemaTypes: PortableTextMemberSchemaTypes
   keyGenerator: () => string
 }) {
@@ -34,7 +37,7 @@ export function createWithSchemaTypes({
       )
     }
     editor.isTextSpan = (value: unknown): value is PortableTextSpan => {
-      return isPortableTextSpan(value) && value._type == schemaTypes.span.name
+      return isPortableTextSpan(value) && value._type === schemaTypes.span.name
     }
     editor.isListBlock = (value: unknown): value is PortableTextListBlock => {
       return (
@@ -71,18 +74,24 @@ export function createWithSchemaTypes({
         debug('Setting span type on text node without a type')
         const span = node as PortableTextSpan
         const key = span._key || keyGenerator()
+        editorActor.send({type: 'normalizing'})
         Transforms.setNodes(
           editor,
           {...span, _type: schemaTypes.span.name, _key: key},
           {at: path},
         )
+        editorActor.send({type: 'done normalizing'})
+        return
       }
 
       // catches cases when the children are missing keys but excludes it when the normalize is running the node as the editor object
       if (node._key === undefined && (path.length === 1 || path.length === 2)) {
         debug('Setting missing key on child node without a key')
         const key = keyGenerator()
+        editorActor.send({type: 'normalizing'})
         Transforms.setNodes(editor, {_key: key}, {at: path})
+        editorActor.send({type: 'done normalizing'})
+        return
       }
 
       normalizeNode(entry)

package/src/editor/plugins/createWithUndoRedo.ts

@@ -3,14 +3,14 @@
  * The undo/redo steps are rebased against incoming patches since the step occurred.
  */
 
-import {type Patch} from '@portabletext/patches'
+import type {Patch} from '@portabletext/patches'
 import {
   DIFF_DELETE,
   DIFF_EQUAL,
   DIFF_INSERT,
   parsePatch,
 } from '@sanity/diff-match-patch'
-import {type ObjectSchemaType, type PortableTextBlock} from '@sanity/types'
+import type {ObjectSchemaType, PortableTextBlock} from '@sanity/types'
 import {flatten, isEqual} from 'lodash'
 import {
   Editor,
@@ -20,10 +20,7 @@ import {
   type Descendant,
   type SelectionOperation,
 } from 'slate'
-import {
-  type PatchObservable,
-  type PortableTextSlateEditor,
-} from '../../types/editor'
+import type {PatchObservable, PortableTextSlateEditor} from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {fromSlateValue} from '../../utils/values'
 import {
@@ -248,7 +245,6 @@ export function createWithUndoRedo(
             Editor.withoutNormalizing(editor, () => {
               withRedoing(editor, () => {
                 withoutSaving(editor, () => {
-                  // eslint-disable-next-line max-nested-callbacks
                   transformedOperations.forEach((op) => {
                     editor.apply(op)
                   })

package/src/editor/plugins/createWithUtils.ts

@@ -1,11 +1,11 @@
 import {Editor, Range, Text, Transforms} from 'slate'
-import {
-  type PortableTextMemberSchemaTypes,
-  type PortableTextSlateEditor,
+import type {
+  PortableTextMemberSchemaTypes,
+  PortableTextSlateEditor,
 } from '../../types/editor'
 import {debugWithName} from '../../utils/debug'
 import {toSlateValue} from '../../utils/values'
-import {type PortableTextEditor} from '../PortableTextEditor'
+import type {PortableTextEditor} from '../PortableTextEditor'
 
 const debug = debugWithName('plugin:withUtils')
 
@@ -59,8 +59,8 @@ export function createWithUtils({
         if (
           !(
             newStartOffset === newEndOffset ||
-            isNaN(newStartOffset) ||
-            isNaN(newEndOffset)
+            Number.isNaN(newStartOffset) ||
+            Number.isNaN(newEndOffset)
           )
         ) {
           debug('pteExpandToWord: Expanding to focused word')