@portabletext/editor 1.48.13 → 1.48.15

package/src/{behavior-actions/behavior.action.insert-span.ts → operations/behavior.operation.insert-span.ts}

@@ -1,29 +1,29 @@
 import {Editor, Transforms} from 'slate'
-import type {BehaviorActionImplementation} from './behavior.actions'
+import type {BehaviorOperationImplementation} from './behavior.operations'
 
-export const insertSpanActionImplementation: BehaviorActionImplementation<
+export const insertSpanOperationImplementation: BehaviorOperationImplementation<
   'insert.span'
-> = ({context, action}) => {
-  if (!action.editor.selection) {
-    console.error('Unable to perform action without selection', action)
+> = ({context, operation}) => {
+  if (!operation.editor.selection) {
+    console.error('Unable to perform action without selection', operation)
     return
   }
 
   const [focusBlock, focusBlockPath] = Array.from(
-    Editor.nodes(action.editor, {
-      at: action.editor.selection.focus.path,
-      match: (node) => action.editor.isTextBlock(node),
+    Editor.nodes(operation.editor, {
+      at: operation.editor.selection.focus.path,
+      match: (node) => operation.editor.isTextBlock(node),
     }),
   )[0] ?? [undefined, undefined]
 
   if (!focusBlock || !focusBlockPath) {
-    console.error('Unable to perform action without focus block', action)
+    console.error('Unable to perform action without focus block', operation)
     return
   }
 
   const markDefs = focusBlock.markDefs ?? []
-  const annotations = action.annotations
-    ? action.annotations.map((annotation) => ({
+  const annotations = operation.annotations
+    ? operation.annotations.map((annotation) => ({
         _type: annotation.name,
         _key: context.keyGenerator(),
         ...annotation.value,
@@ -31,18 +31,18 @@ export const insertSpanActionImplementation: BehaviorActionImplementation<
     : undefined
 
   if (annotations && annotations.length > 0) {
-    Transforms.setNodes(action.editor, {
+    Transforms.setNodes(operation.editor, {
       markDefs: [...markDefs, ...annotations],
     })
   }
 
-  Transforms.insertNodes(action.editor, {
+  Transforms.insertNodes(operation.editor, {
     _type: 'span',
     _key: context.keyGenerator(),
-    text: action.text,
+    text: operation.text,
     marks: [
       ...(annotations?.map((annotation) => annotation._key) ?? []),
-      ...(action.decorators ?? []),
+      ...(operation.decorators ?? []),
     ],
   })
 }

package/src/{behavior-actions/behavior.action.insert.block.ts → operations/behavior.operation.insert.block.ts}

@@ -11,19 +11,19 @@ import {
 } from '../internal-utils/slate-utils'
 import {isEqualToEmptyEditor, toSlateValue} from '../internal-utils/values'
 import type {PortableTextSlateEditor} from '../types/editor'
-import type {BehaviorActionImplementation} from './behavior.actions'
+import type {BehaviorOperationImplementation} from './behavior.operations'
 
-export const insertBlockActionImplementation: BehaviorActionImplementation<
+export const insertBlockOperationImplementation: BehaviorOperationImplementation<
   'insert.block'
-> = ({context, action}) => {
+> = ({context, operation}) => {
   const parsedBlock = parseBlock({
-    block: action.block,
+    block: operation.block,
     context,
     options: {refreshKeys: false},
   })
 
   if (!parsedBlock) {
-    throw new Error(`Failed to parse block ${JSON.stringify(action.block)}`)
+    throw new Error(`Failed to parse block ${JSON.stringify(operation.block)}`)
   }
 
   const fragment = toSlateValue([parsedBlock], {schemaTypes: context.schema})[0]
@@ -36,9 +36,9 @@ export const insertBlockActionImplementation: BehaviorActionImplementation<
 
   insertBlock({
     block: fragment,
-    placement: action.placement,
-    select: action.select ?? 'start',
-    editor: action.editor,
+    placement: operation.placement,
+    select: operation.select ?? 'start',
+    editor: operation.editor,
     schema: context.schema,
   })
 }

package/src/operations/behavior.operation.insert.text.ts

@@ -0,0 +1,17 @@
+import {Transforms} from 'slate'
+import type {BehaviorOperationImplementation} from './behavior.operations'
+
+export const insertTextOperationImplementation: BehaviorOperationImplementation<
+  'insert.text'
+> = ({operation}) => {
+  if (operation.editor.marks) {
+    Transforms.insertNodes(operation.editor, {
+      text: operation.text,
+      ...operation.editor.marks,
+    })
+  } else {
+    Transforms.insertText(operation.editor, operation.text)
+  }
+
+  operation.editor.marks = null
+}

package/src/operations/behavior.operation.move.backward.ts

@@ -0,0 +1,12 @@
+import {Transforms} from 'slate'
+import type {BehaviorOperationImplementation} from './behavior.operations'
+
+export const moveBackwardOperationImplementation: BehaviorOperationImplementation<
+  'move.backward'
+> = ({operation}) => {
+  Transforms.move(operation.editor, {
+    unit: 'character',
+    distance: operation.distance,
+    reverse: true,
+  })
+}

package/src/operations/behavior.operation.move.block.ts

@@ -0,0 +1,16 @@
+import {Transforms} from 'slate'
+import {toSlatePath} from '../internal-utils/paths'
+import type {BehaviorOperationImplementation} from './behavior.operations'
+
+export const moveBlockOperationImplementation: BehaviorOperationImplementation<
+  'move.block'
+> = ({operation}) => {
+  const at = [toSlatePath(operation.at, operation.editor)[0]]
+  const to = [toSlatePath(operation.to, operation.editor)[0]]
+
+  Transforms.moveNodes(operation.editor, {
+    at,
+    to,
+    mode: 'highest',
+  })
+}

package/src/operations/behavior.operation.move.forward.ts

@@ -0,0 +1,11 @@
+import {Transforms} from 'slate'
+import type {BehaviorOperationImplementation} from './behavior.operations'
+
+export const moveForwardOperationImplementation: BehaviorOperationImplementation<
+  'move.forward'
+> = ({operation}) => {
+  Transforms.move(operation.editor, {
+    unit: 'character',
+    distance: operation.distance,
+  })
+}

package/src/operations/behavior.operation.select.ts

@@ -0,0 +1,15 @@
+import {Transforms} from 'slate'
+import {toSlateRange} from '../internal-utils/ranges'
+import type {BehaviorOperationImplementation} from './behavior.operations'
+
+export const selectOperationImplementation: BehaviorOperationImplementation<
+  'select'
+> = ({operation}) => {
+  const newSelection = toSlateRange(operation.at, operation.editor)
+
+  if (newSelection) {
+    Transforms.select(operation.editor, newSelection)
+  } else {
+    Transforms.deselect(operation.editor)
+  }
+}

package/src/operations/behavior.operations.ts

@@ -0,0 +1,239 @@
+import type {
+  AbstractBehaviorEventType,
+  SyntheticBehaviorEvent,
+} from '../behaviors/behavior.types.event'
+import type {EditorContext} from '../editor/editor-snapshot'
+import {removeDecoratorOperationImplementation} from '../editor/plugins/createWithPortableTextMarkModel'
+import {
+  historyRedoOperationImplementation,
+  historyUndoOperationImplementation,
+} from '../editor/plugins/createWithUndoRedo'
+import type {OmitFromUnion, PickFromUnion} from '../type-utils'
+import type {PortableTextSlateEditor} from '../types/editor'
+import {addAnnotationOperationImplementation} from './behavior.operation.annotation.add'
+import {removeAnnotationOperationImplementation} from './behavior.operation.annotation.remove'
+import {blockSetOperationImplementation} from './behavior.operation.block.set'
+import {blockUnsetOperationImplementation} from './behavior.operation.block.unset'
+import {decoratorAddOperationImplementation} from './behavior.operation.decorator.add'
+import {deleteOperationImplementation} from './behavior.operation.delete'
+import {deleteBackwardOperationImplementation} from './behavior.operation.delete.backward'
+import {deleteBlockOperationImplementation} from './behavior.operation.delete.block'
+import {deleteForwardOperationImplementation} from './behavior.operation.delete.forward'
+import {insertInlineObjectOperationImplementation} from './behavior.operation.insert-inline-object'
+import {insertSpanOperationImplementation} from './behavior.operation.insert-span'
+import {insertBlockOperationImplementation} from './behavior.operation.insert.block'
+import {insertTextOperationImplementation} from './behavior.operation.insert.text'
+import {moveBackwardOperationImplementation} from './behavior.operation.move.backward'
+import {moveBlockOperationImplementation} from './behavior.operation.move.block'
+import {moveForwardOperationImplementation} from './behavior.operation.move.forward'
+import {selectOperationImplementation} from './behavior.operation.select'
+
+export type BehaviorOperationImplementationContext = Pick<
+  EditorContext,
+  'keyGenerator' | 'schema'
+>
+
+export type BehaviorOperationImplementation<
+  TBehaviorOperationType extends BehaviorOperation['type'],
+  TReturnType = void,
+> = ({
+  context,
+  operation,
+}: {
+  context: BehaviorOperationImplementationContext
+  operation: PickFromUnion<BehaviorOperation, 'type', TBehaviorOperationType>
+}) => TReturnType
+
+type BehaviorOperation = OmitFromUnion<
+  SyntheticBehaviorEvent,
+  'type',
+  AbstractBehaviorEventType
+> & {
+  editor: PortableTextSlateEditor
+}
+
+type BehaviorOperationImplementations = {
+  [TBehaviorOperationType in BehaviorOperation['type']]: BehaviorOperationImplementation<TBehaviorOperationType>
+}
+
+const behaviorOperationImplementations: BehaviorOperationImplementations = {
+  'annotation.add': addAnnotationOperationImplementation,
+  'annotation.remove': removeAnnotationOperationImplementation,
+  'block.set': blockSetOperationImplementation,
+  'block.unset': blockUnsetOperationImplementation,
+  'decorator.add': decoratorAddOperationImplementation,
+  'decorator.remove': removeDecoratorOperationImplementation,
+  'delete': deleteOperationImplementation,
+  'delete.backward': deleteBackwardOperationImplementation,
+  'delete.forward': deleteForwardOperationImplementation,
+  'delete.block': deleteBlockOperationImplementation,
+  'history.redo': historyRedoOperationImplementation,
+  'history.undo': historyUndoOperationImplementation,
+  'insert.block': insertBlockOperationImplementation,
+  'insert.inline object': insertInlineObjectOperationImplementation,
+  'insert.span': insertSpanOperationImplementation,
+  'insert.text': insertTextOperationImplementation,
+  'move.backward': moveBackwardOperationImplementation,
+  'move.block': moveBlockOperationImplementation,
+  'move.forward': moveForwardOperationImplementation,
+  'select': selectOperationImplementation,
+}
+
+export function performOperation({
+  context,
+  operation,
+}: {
+  context: BehaviorOperationImplementationContext
+  operation: BehaviorOperation
+}) {
+  try {
+    switch (operation.type) {
+      case 'annotation.add': {
+        behaviorOperationImplementations['annotation.add']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'annotation.remove': {
+        behaviorOperationImplementations['annotation.remove']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'block.set': {
+        behaviorOperationImplementations['block.set']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'block.unset': {
+        behaviorOperationImplementations['block.unset']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'decorator.add': {
+        behaviorOperationImplementations['decorator.add']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'decorator.remove': {
+        behaviorOperationImplementations['decorator.remove']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'delete': {
+        behaviorOperationImplementations.delete({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'delete.backward': {
+        behaviorOperationImplementations['delete.backward']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'delete.block': {
+        behaviorOperationImplementations['delete.block']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'delete.forward': {
+        behaviorOperationImplementations['delete.forward']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'history.redo': {
+        behaviorOperationImplementations['history.redo']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'history.undo': {
+        behaviorOperationImplementations['history.undo']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'insert.block': {
+        behaviorOperationImplementations['insert.block']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'insert.inline object': {
+        behaviorOperationImplementations['insert.inline object']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'insert.span': {
+        behaviorOperationImplementations['insert.span']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'insert.text': {
+        behaviorOperationImplementations['insert.text']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'move.backward': {
+        behaviorOperationImplementations['move.backward']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'move.block': {
+        behaviorOperationImplementations['move.block']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      case 'move.forward': {
+        behaviorOperationImplementations['move.forward']({
+          context,
+          operation: operation,
+        })
+        break
+      }
+      default: {
+        behaviorOperationImplementations.select({
+          context,
+          operation: operation,
+        })
+        break
+      }
+    }
+  } catch (error) {
+    console.error(
+      new Error(
+        `Executing "${operation.type}" failed due to: ${error.message}`,
+      ),
+    )
+  }
+}

package/src/plugins/index.ts

@@ -1,5 +1,4 @@
 export {BehaviorPlugin} from './plugin.behavior'
-export {CoreBehaviorsPlugin} from './plugin.core'
 export {DecoratorShortcutPlugin} from './plugin.decorator-shortcut'
 export {EditorRefPlugin} from './plugin.editor-ref'
 export {EventListenerPlugin} from './plugin.event-listener'

package/src/priority/priority.core.ts

@@ -0,0 +1,3 @@
+import {createEditorPriority} from './priority.types'
+
+export const corePriority = createEditorPriority({name: 'core'})