@portabletext/editor 1.48.13 → 1.48.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.48.13",
+  "version": "1.48.14",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",

package/src/behaviors/behavior.abstract.keyboard.ts

@@ -0,0 +1,16 @@
+import {keyIs} from '../internal-utils/key-is'
+import {raise} from './behavior.types.action'
+import {defineBehavior} from './behavior.types.behavior'
+
+export const abstractKeyboardBehaviors = [
+  /**
+   * On WebKit, Shift+Enter results in an `insertParagraph` input event rather
+   * than an `insertLineBreak` input event. This Behavior makes sure we catch
+   * that `keyboard.keydown` event beforehand and raise an `insert.soft break` manually.
+   */
+  defineBehavior({
+    on: 'keyboard.keydown',
+    guard: ({event}) => keyIs.lineBreak(event.originEvent),
+    actions: [() => [raise({type: 'insert.soft break'})]],
+  }),
+]

package/src/behaviors/{behavior.default.ts → behavior.abstract.ts}

@@ -7,12 +7,12 @@ import {abstractAnnotationBehaviors} from './behavior.abstract.annotation'
 import {abstractDecoratorBehaviors} from './behavior.abstract.decorator'
 import {abstractDeleteBehaviors} from './behavior.abstract.delete'
 import {abstractInsertBehaviors} from './behavior.abstract.insert'
+import {abstractKeyboardBehaviors} from './behavior.abstract.keyboard'
 import {abstractListItemBehaviors} from './behavior.abstract.list-item'
 import {abstractMoveBehaviors} from './behavior.abstract.move'
 import {abstractSelectBehaviors} from './behavior.abstract.select'
 import {abstractSplitBehaviors} from './behavior.abstract.split'
 import {abstractStyleBehaviors} from './behavior.abstract.style'
-import {raiseInsertSoftBreak} from './behavior.default.raise-soft-break'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
@@ -102,7 +102,7 @@ const raiseSerializationSuccessOrFailure = defineBehavior({
   ],
 })
 
-export const defaultBehaviors = [
+export const abstractBehaviors = [
   defineBehavior({
     on: 'clipboard.copy',
     guard: ({snapshot}) => {
@@ -451,6 +451,7 @@ export const defaultBehaviors = [
   ...abstractDecoratorBehaviors,
   ...abstractDeleteBehaviors,
   ...abstractInsertBehaviors,
+  ...abstractKeyboardBehaviors,
   ...abstractListItemBehaviors,
   ...abstractMoveBehaviors,
   ...abstractStyleBehaviors,
@@ -458,5 +459,4 @@ export const defaultBehaviors = [
   ...abstractSplitBehaviors,
   raiseDeserializationSuccessOrFailure,
   raiseSerializationSuccessOrFailure,
-  raiseInsertSoftBreak,
 ]

package/src/behaviors/behavior.core.ts

@@ -5,9 +5,6 @@ import {coreDndBehaviors} from './behavior.core.dnd'
 import {coreInsertBreakBehaviors} from './behavior.core.insert-break'
 import {coreListBehaviors} from './behavior.core.lists'
 
-/**
- * @beta
- */
 export const coreBehaviors = [
   coreAnnotationBehaviors.addAnnotationOnCollapsedSelection,
   coreDecoratorBehaviors.strongShortcut,

package/src/behaviors/behavior.perform-event.ts

@@ -1,13 +1,11 @@
-import {performAction} from '../behavior-actions/behavior.actions'
 import type {EditorSchema} from '../editor/editor-schema'
 import type {EditorSnapshot} from '../editor/editor-snapshot'
-import {
-  withApplyingBehaviorActions,
-  withUndoStep,
-} from '../editor/with-applying-behavior-actions'
+import {withApplyingBehaviorOperations} from '../editor/with-applying-behavior-operations'
+import {withUndoStep} from '../editor/with-undo-step'
 import {debugWithName} from '../internal-utils/debug'
+import {performOperation} from '../operations/behavior.operations'
 import type {PortableTextSlateEditor} from '../types/editor'
-import {defaultBehaviors} from './behavior.default'
+import {abstractBehaviors} from './behavior.abstract'
 import type {BehaviorAction} from './behavior.types.action'
 import type {Behavior} from './behavior.types.behavior'
 import {
@@ -59,7 +57,7 @@ export function performEvent({
 
   const eventBehaviors = [
     ...remainingEventBehaviors,
-    ...defaultBehaviors,
+    ...abstractBehaviors,
   ].filter((behavior) => {
     // Catches all events
     if (behavior.on === '*') {
@@ -100,30 +98,19 @@ export function performEvent({
   if (eventBehaviors.length === 0 && isSyntheticBehaviorEvent(event)) {
     nativeEvent?.preventDefault()
 
-    withApplyingBehaviorActions(editor, () => {
-      try {
-        debug(
-          `(execute:${eventCategory(event)})`,
-          JSON.stringify(event, null, 2),
-        )
-
-        performAction({
-          context: {
-            keyGenerator,
-            schema,
-          },
-          action: {
-            ...event,
-            editor,
-          },
-        })
-      } catch (error) {
-        console.error(
-          new Error(
-            `Executing "${event.type}" failed due to: ${error.message}`,
-          ),
-        )
-      }
+    withApplyingBehaviorOperations(editor, () => {
+      debug(`(execute:${eventCategory(event)})`, JSON.stringify(event, null, 2))
+
+      performOperation({
+        context: {
+          keyGenerator,
+          schema,
+        },
+        operation: {
+          ...event,
+          editor,
+        },
+      })
     })
 
     editor.onChange()
@@ -339,27 +326,16 @@ export function performEvent({
   if (!defaultBehaviorOverwritten && isSyntheticBehaviorEvent(event)) {
     nativeEvent?.preventDefault()
 
-    withApplyingBehaviorActions(editor, () => {
-      try {
-        debug(
-          `(execute:${eventCategory(event)})`,
-          JSON.stringify(event, null, 2),
-        )
+    withApplyingBehaviorOperations(editor, () => {
+      debug(`(execute:${eventCategory(event)})`, JSON.stringify(event, null, 2))
 
-        performAction({
-          context: {keyGenerator, schema},
-          action: {
-            ...event,
-            editor,
-          },
-        })
-      } catch (error) {
-        console.error(
-          new Error(
-            `Executing "${event.type}" failed due to: ${error.message}`,
-          ),
-        )
-      }
+      performOperation({
+        context: {keyGenerator, schema},
+        operation: {
+          ...event,
+          editor,
+        },
+      })
     })
 
     editor.onChange()

package/src/behaviors/behavior.types.action.ts

@@ -1,8 +1,6 @@
 import type {EditorSnapshot} from '../editor/editor-snapshot'
-import type {OmitFromUnion, PickFromUnion} from '../type-utils'
-import type {PortableTextSlateEditor} from '../types/editor'
+import type {PickFromUnion} from '../type-utils'
 import type {
-  AbstractBehaviorEventType,
   CustomBehaviorEvent,
   NativeBehaviorEvent,
   SyntheticBehaviorEvent,
@@ -75,11 +73,3 @@ export type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorAction>
-
-export type InternalBehaviorAction = OmitFromUnion<
-  SyntheticBehaviorEvent,
-  'type',
-  AbstractBehaviorEventType
-> & {
-  editor: PortableTextSlateEditor
-}

package/src/editor/PortableTextEditor.tsx

@@ -16,10 +16,10 @@ import {Subject} from 'rxjs'
 import {Slate} from 'slate-react'
 import {useEffectEvent} from 'use-effect-event'
 import {createActor} from 'xstate'
-import type {AddedAnnotationPaths} from '../behavior-actions/behavior.action.annotation.add'
 import {createCoreConverters} from '../converters/converters.core'
 import {debugWithName} from '../internal-utils/debug'
 import {compileType} from '../internal-utils/schema'
+import type {AddedAnnotationPaths} from '../operations/behavior.operation.annotation.add'
 import type {
   EditableAPI,
   EditableAPIDeleteOptions,

package/src/editor/editor-machine.ts

@@ -140,7 +140,7 @@ type PatchEvent = {
 }
 
 type InternalPatchEvent = NamespaceEvent<PatchEvent, 'internal'> & {
-  actionId?: string
+  operationId?: string
   value: Array<PortableTextBlock>
 }
 
@@ -344,8 +344,11 @@ export const editorMachine = setup({
       try {
         performEvent({
           mode: 'raise',
-          behaviors: [...context.behaviors.values()],
-          remainingEventBehaviors: [...context.behaviors.values()],
+          behaviors: [...context.behaviors.values(), ...coreBehaviors],
+          remainingEventBehaviors: [
+            ...context.behaviors.values(),
+            ...coreBehaviors,
+          ],
           event: event.behaviorEvent,
           editor: event.editor,
           keyGenerator: context.keyGenerator,
@@ -383,7 +386,7 @@ export const editorMachine = setup({
 }).createMachine({
   id: 'editor',
   context: ({input}) => ({
-    behaviors: new Set([...coreBehaviors]),
+    behaviors: new Set([]),
     converters: new Set(input.converters ?? []),
     getLegacySchema: input.getLegacySchema,
     keyGenerator: input.keyGenerator,

package/src/editor/mutation-machine.ts

@@ -23,7 +23,7 @@ export const mutationMachine = setup({
   types: {
     context: {} as {
       pendingMutations: Array<{
-        actionId?: string
+        operationId?: string
         value: Array<PortableTextBlock> | undefined
         patches: Array<Patch>
       }>
@@ -34,7 +34,7 @@ export const mutationMachine = setup({
       | {
           type: 'patch'
           patch: Patch
-          actionId?: string
+          operationId?: string
           value: Array<PortableTextBlock>
         }
       | {
@@ -78,7 +78,7 @@ export const mutationMachine = setup({
         if (context.pendingMutations.length === 0) {
           return [
             {
-              actionId: event.actionId,
+              operationId: event.operationId,
               value: event.value,
               patches: [event.patch],
             },
@@ -87,17 +87,17 @@ export const mutationMachine = setup({
 
         const lastBulk = context.pendingMutations.at(-1)
 
-        if (lastBulk && lastBulk.actionId === event.actionId) {
+        if (lastBulk && lastBulk.operationId === event.operationId) {
           return context.pendingMutations.slice(0, -1).concat({
             value: event.value,
-            actionId: lastBulk.actionId,
+            operationId: lastBulk.operationId,
             patches: [...lastBulk.patches, event.patch],
           })
         }
 
         return context.pendingMutations.concat({
           value: event.value,
-          actionId: event.actionId,
+          operationId: event.operationId,
           patches: [event.patch],
         })
       },

package/src/editor/plugins/create-with-event-listeners.ts

@@ -1,9 +1,9 @@
 import {Editor} from 'slate'
-import {insertTextActionImplementation} from '../../behavior-actions/behavior.action.insert.text'
-import {performAction} from '../../behavior-actions/behavior.actions'
 import {slateRangeToSelection} from '../../internal-utils/slate-utils'
+import {insertTextOperationImplementation} from '../../operations/behavior.operation.insert.text'
+import {performOperation} from '../../operations/behavior.operations'
 import type {EditorActor} from '../editor-machine'
-import {isApplyingBehaviorActions} from '../with-applying-behavior-actions'
+import {isApplyingBehaviorOperations} from '../with-applying-behavior-operations'
 
 export function createWithEventListeners(editorActor: EditorActor) {
   return function withEventListeners(editor: Editor) {
@@ -11,12 +11,11 @@ export function createWithEventListeners(editorActor: EditorActor) {
       return editor
     }
 
-    const {deleteBackward, deleteForward, insertBreak, insertText, select} =
-      editor
+    const {insertText, select} = editor
 
     editor.deleteBackward = (unit) => {
-      if (isApplyingBehaviorActions(editor)) {
-        deleteBackward(unit)
+      if (isApplyingBehaviorOperations(editor)) {
+        console.error('Unexpected call to .deleteBackward(...)')
         return
       }
 
@@ -32,8 +31,8 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.deleteForward = (unit) => {
-      if (isApplyingBehaviorActions(editor)) {
-        deleteForward(unit)
+      if (isApplyingBehaviorOperations(editor)) {
+        console.error('Unexpected call to .deleteForward(...)')
         return
       }
 
@@ -49,8 +48,8 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertBreak = () => {
-      if (isApplyingBehaviorActions(editor)) {
-        insertBreak()
+      if (isApplyingBehaviorOperations(editor)) {
+        console.error('Unexpected call to .insertBreak(...)')
         return
       }
 
@@ -65,8 +64,9 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertData = (dataTransfer) => {
-      if (isApplyingBehaviorActions(editor)) {
-        throw new Error('Unexpected call to .insertData(...)')
+      if (isApplyingBehaviorOperations(editor)) {
+        console.error('Unexpected call to .insertData(...)')
+        return
       }
 
       editorActor.send({
@@ -82,13 +82,13 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertSoftBreak = () => {
-      if (isApplyingBehaviorActions(editor)) {
-        insertTextActionImplementation({
+      if (isApplyingBehaviorOperations(editor)) {
+        insertTextOperationImplementation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: editorActor.getSnapshot().context.schema,
           },
-          action: {type: 'insert.text', text: '\n', editor},
+          operation: {type: 'insert.text', text: '\n', editor},
         })
         return
       }
@@ -104,7 +104,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertText = (text, options) => {
-      if (isApplyingBehaviorActions(editor)) {
+      if (isApplyingBehaviorOperations(editor)) {
         insertText(text, options)
         return
       }
@@ -121,13 +121,13 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.redo = () => {
-      if (isApplyingBehaviorActions(editor)) {
-        performAction({
+      if (isApplyingBehaviorOperations(editor)) {
+        performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: editorActor.getSnapshot().context.schema,
           },
-          action: {
+          operation: {
             type: 'history.redo',
             editor,
           },
@@ -146,7 +146,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.select = (location) => {
-      if (isApplyingBehaviorActions(editor)) {
+      if (isApplyingBehaviorOperations(editor)) {
         select(location)
         return
       }
@@ -169,18 +169,18 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.setFragmentData = () => {
-      console.warn('Unexpected call to .setFragmentData(...)')
+      console.error('Unexpected call to .setFragmentData(...)')
       return
     }
 
     editor.undo = () => {
-      if (isApplyingBehaviorActions(editor)) {
-        performAction({
+      if (isApplyingBehaviorOperations(editor)) {
+        performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: editorActor.getSnapshot().context.schema,
           },
-          action: {
+          operation: {
             type: 'history.undo',
             editor,
           },

package/src/editor/plugins/createWithEditableAPI.ts

@@ -16,7 +16,6 @@ import {
 } from 'slate'
 import type {DOMNode} from 'slate-dom'
 import {ReactEditor} from 'slate-react'
-import {addAnnotationActionImplementation} from '../../behavior-actions/behavior.action.annotation.add'
 import {debugWithName} from '../../internal-utils/debug'
 import {toSlateRange} from '../../internal-utils/ranges'
 import {
@@ -29,6 +28,7 @@ import {
   KEY_TO_VALUE_ELEMENT,
   SLATE_TO_PORTABLE_TEXT_RANGE,
 } from '../../internal-utils/weakMaps'
+import {addAnnotationOperationImplementation} from '../../operations/behavior.operation.annotation.add'
 import type {
   EditableAPI,
   EditableAPIDeleteOptions,
@@ -400,12 +400,12 @@ export function createEditableAPI(
       let paths: ReturnType<EditableAPI['addAnnotation']> = undefined
 
       Editor.withoutNormalizing(editor, () => {
-        paths = addAnnotationActionImplementation({
+        paths = addAnnotationOperationImplementation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: types,
           },
-          action: {
+          operation: {
             type: 'annotation.add',
             annotation: {name: type.name, value: value ?? {}},
             editor,

package/src/editor/plugins/createWithPatches.ts

@@ -27,7 +27,7 @@ import {
 } from '../../internal-utils/withoutPatching'
 import type {PortableTextSlateEditor} from '../../types/editor'
 import type {EditorActor} from '../editor-machine'
-import {getCurrentActionId} from '../with-applying-behavior-actions'
+import {getCurrentOperationId} from '../with-applying-behavior-operations'
 import {withoutSaving} from './createWithUndoRedo'
 
 const debug = debugWithName('plugin:withPatches')
@@ -108,15 +108,23 @@ export function createWithPatches({
       const patches = bufferedPatches
       bufferedPatches = []
       let changed = false
+
       withRemoteChanges(editor, () => {
         Editor.withoutNormalizing(editor, () => {
           withoutPatching(editor, () => {
             withoutSaving(editor, () => {
-              patches.forEach((patch) => {
+              for (const patch of patches) {
                 if (debug.enabled)
                   debug(`Handling remote patch ${JSON.stringify(patch)}`)
-                changed = applyPatch(editor, patch)
-              })
+
+                try {
+                  changed = applyPatch(editor, patch)
+                } catch (error) {
+                  console.error(
+                    `Applying patch ${JSON.stringify(patch)} failed due to: ${error.message}`,
+                  )
+                }
+              }
             })
           })
         })
@@ -293,7 +301,7 @@ export function createWithPatches({
           editorActor.send({
             type: 'internal.patch',
             patch: {...patch, origin: 'local'},
-            actionId: getCurrentActionId(editor),
+            operationId: getCurrentOperationId(editor),
             value: fromSlateValue(
               editor.children,
               editorActor.getSnapshot().context.schema.block.name,

package/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -8,11 +8,11 @@ import {isPortableTextBlock, isPortableTextSpan} from '@portabletext/toolkit'
 import type {PortableTextObject, PortableTextSpan} from '@sanity/types'
 import {isEqual, uniq} from 'lodash'
 import {Editor, Element, Node, Path, Range, Text, Transforms} from 'slate'
-import type {BehaviorActionImplementation} from '../../behavior-actions/behavior.actions'
 import {debugWithName} from '../../internal-utils/debug'
 import {getNextSpan, getPreviousSpan} from '../../internal-utils/sibling-utils'
 import {isChangingRemotely} from '../../internal-utils/withChanges'
 import {isRedoing, isUndoing} from '../../internal-utils/withUndoRedo'
+import type {BehaviorOperationImplementation} from '../../operations/behavior.operations'
 import type {PortableTextSlateEditor} from '../../types/editor'
 import type {EditorActor} from '../editor-machine'
 
@@ -660,11 +660,11 @@ export function createWithPortableTextMarkModel(
   }
 }
 
-export const removeDecoratorActionImplementation: BehaviorActionImplementation<
+export const removeDecoratorOperationImplementation: BehaviorOperationImplementation<
   'decorator.remove'
-> = ({action}) => {
-  const editor = action.editor
-  const mark = action.decorator
+> = ({operation}) => {
+  const editor = operation.editor
+  const mark = operation.decorator
   const {selection} = editor
 
   if (selection) {

package/src/editor/plugins/createWithUndoRedo.ts

@@ -20,7 +20,6 @@ import {
   type Descendant,
   type SelectionOperation,
 } from 'slate'
-import type {BehaviorActionImplementation} from '../../behavior-actions/behavior.actions'
 import {debugWithName} from '../../internal-utils/debug'
 import {fromSlateValue} from '../../internal-utils/values'
 import {isChangingRemotely} from '../../internal-utils/withChanges'
@@ -32,9 +31,10 @@ import {
   withRedoing,
   withUndoing,
 } from '../../internal-utils/withUndoRedo'
+import type {BehaviorOperationImplementation} from '../../operations/behavior.operations'
 import type {PortableTextSlateEditor} from '../../types/editor'
 import type {EditorActor} from '../editor-machine'
-import {getCurrentUndoStepId} from '../with-applying-behavior-actions'
+import {getCurrentUndoStepId} from '../with-undo-step'
 
 const debug = debugWithName('plugin:withUndoRedo')
 const debugVerbose = debug.enabled && false
@@ -203,10 +203,10 @@ export function createWithUndoRedo(
   }
 }
 
-export const historyUndoActionImplementation: BehaviorActionImplementation<
+export const historyUndoOperationImplementation: BehaviorOperationImplementation<
   'history.undo'
-> = ({action}) => {
-  const editor = action.editor
+> = ({operation}) => {
+  const editor = operation.editor
   const {undos} = editor.history
   const remotePatches = getRemotePatches(editor)
 
@@ -261,10 +261,10 @@ export const historyUndoActionImplementation: BehaviorActionImplementation<
   }
 }
 
-export const historyRedoActionImplementation: BehaviorActionImplementation<
+export const historyRedoOperationImplementation: BehaviorOperationImplementation<
   'history.redo'
-> = ({action}) => {
-  const editor = action.editor
+> = ({operation}) => {
+  const editor = operation.editor
   const {redos} = editor.history
   const remotePatches = getRemotePatches(editor)
 

package/src/editor/with-applying-behavior-operations.ts

@@ -0,0 +1,18 @@
+import {Editor} from 'slate'
+import {defaultKeyGenerator} from './key-generator'
+
+const CURRENT_OPERATION_ID: WeakMap<Editor, string | undefined> = new WeakMap()
+
+export function withApplyingBehaviorOperations(editor: Editor, fn: () => void) {
+  CURRENT_OPERATION_ID.set(editor, defaultKeyGenerator())
+  Editor.withoutNormalizing(editor, fn)
+  CURRENT_OPERATION_ID.set(editor, undefined)
+}
+
+export function getCurrentOperationId(editor: Editor) {
+  return CURRENT_OPERATION_ID.get(editor)
+}
+
+export function isApplyingBehaviorOperations(editor: Editor) {
+  return getCurrentOperationId(editor) !== undefined
+}

package/src/editor/{with-applying-behavior-actions.ts → with-undo-step.ts}

@@ -1,24 +1,6 @@
-import {Editor} from 'slate'
+import type {Editor} from 'slate'
 import {defaultKeyGenerator} from './key-generator'
 
-const CURRENT_ACTION_ID: WeakMap<Editor, string | undefined> = new WeakMap()
-
-export function withApplyingBehaviorActions(editor: Editor, fn: () => void) {
-  CURRENT_ACTION_ID.set(editor, defaultKeyGenerator())
-  Editor.withoutNormalizing(editor, fn)
-  CURRENT_ACTION_ID.set(editor, undefined)
-}
-
-export function getCurrentActionId(editor: Editor) {
-  return CURRENT_ACTION_ID.get(editor)
-}
-
-export function isApplyingBehaviorActions(editor: Editor) {
-  return getCurrentActionId(editor) !== undefined
-}
-
-////////
-
 const CURRENT_UNDO_STEP: WeakMap<Editor, {undoStepId: string} | undefined> =
   new WeakMap()
 

package/src/index.ts

@@ -4,7 +4,7 @@ export type {
   PortableTextChild,
   PortableTextSpan,
 } from '@sanity/types'
-export type {AddedAnnotationPaths} from './behavior-actions/behavior.action.annotation.add'
+export type {AddedAnnotationPaths} from './operations/behavior.operation.annotation.add'
 export {EditorEventListener} from './editor-event-listener'
 export type {Editor, EditorConfig, EditorEvent} from './editor/create-editor'
 export {