@portabletext/editor 1.48.13 → 1.48.14

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/behavior-actions/behavior.action.delete.backward.ts

@@ -1,7 +0,0 @@
-import type {BehaviorActionImplementation} from './behavior.actions'
-
-export const deleteBackwardActionImplementation: BehaviorActionImplementation<
-  'delete.backward'
-> = ({action}) => {
-  action.editor.deleteBackward(action.unit)
-}

package/src/behavior-actions/behavior.action.delete.block.ts

@@ -1,24 +0,0 @@
-import {Transforms} from 'slate'
-import {toSlateRange} from '../internal-utils/ranges'
-import type {BehaviorActionImplementation} from './behavior.actions'
-
-export const deleteBlockActionImplementation: BehaviorActionImplementation<
-  'delete.block'
-> = ({action}) => {
-  const range = toSlateRange(
-    {
-      anchor: {path: action.at, offset: 0},
-      focus: {path: action.at, offset: 0},
-    },
-    action.editor,
-  )
-
-  if (!range) {
-    console.error('Unable to find Slate range from selection points')
-    return
-  }
-
-  Transforms.removeNodes(action.editor, {
-    at: range,
-  })
-}

package/src/behavior-actions/behavior.action.delete.forward.ts

@@ -1,7 +0,0 @@
-import type {BehaviorActionImplementation} from './behavior.actions'
-
-export const deleteForwardActionImplementation: BehaviorActionImplementation<
-  'delete.forward'
-> = ({action}) => {
-  action.editor.deleteForward(action.unit)
-}

package/src/behavior-actions/behavior.action.insert.text.ts

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

package/src/behavior-actions/behavior.action.move.backward.ts

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

package/src/behavior-actions/behavior.action.move.block.ts

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

package/src/behavior-actions/behavior.action.move.forward.ts

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

package/src/behavior-actions/behavior.action.select.ts

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

package/src/behavior-actions/behavior.actions.ts

@@ -1,219 +0,0 @@
-import type {InternalBehaviorAction} from '../behaviors/behavior.types.action'
-import type {EditorContext} from '../editor/editor-snapshot'
-import {removeDecoratorActionImplementation} from '../editor/plugins/createWithPortableTextMarkModel'
-import {
-  historyRedoActionImplementation,
-  historyUndoActionImplementation,
-} from '../editor/plugins/createWithUndoRedo'
-import type {PickFromUnion} from '../type-utils'
-import {addAnnotationActionImplementation} from './behavior.action.annotation.add'
-import {removeAnnotationActionImplementation} from './behavior.action.annotation.remove'
-import {blockSetBehaviorActionImplementation} from './behavior.action.block.set'
-import {blockUnsetBehaviorActionImplementation} from './behavior.action.block.unset'
-import {decoratorAddActionImplementation} from './behavior.action.decorator.add'
-import {deleteActionImplementation} from './behavior.action.delete'
-import {deleteBackwardActionImplementation} from './behavior.action.delete.backward'
-import {deleteBlockActionImplementation} from './behavior.action.delete.block'
-import {deleteForwardActionImplementation} from './behavior.action.delete.forward'
-import {insertInlineObjectActionImplementation} from './behavior.action.insert-inline-object'
-import {insertSpanActionImplementation} from './behavior.action.insert-span'
-import {insertBlockActionImplementation} from './behavior.action.insert.block'
-import {insertTextActionImplementation} from './behavior.action.insert.text'
-import {moveBackwardActionImplementation} from './behavior.action.move.backward'
-import {moveBlockActionImplementation} from './behavior.action.move.block'
-import {moveForwardActionImplementation} from './behavior.action.move.forward'
-import {selectActionImplementation} from './behavior.action.select'
-
-export type BehaviorActionImplementationContext = Pick<
-  EditorContext,
-  'keyGenerator' | 'schema'
->
-
-export type BehaviorActionImplementation<
-  TBehaviorActionType extends InternalBehaviorAction['type'],
-  TReturnType = void,
-> = ({
-  context,
-  action,
-}: {
-  context: BehaviorActionImplementationContext
-  action: PickFromUnion<InternalBehaviorAction, 'type', TBehaviorActionType>
-}) => TReturnType
-
-type BehaviorActionImplementations = {
-  [TBehaviorActionType in InternalBehaviorAction['type']]: BehaviorActionImplementation<TBehaviorActionType>
-}
-
-const behaviorActionImplementations: BehaviorActionImplementations = {
-  'annotation.add': addAnnotationActionImplementation,
-  'annotation.remove': removeAnnotationActionImplementation,
-  'block.set': blockSetBehaviorActionImplementation,
-  'block.unset': blockUnsetBehaviorActionImplementation,
-  'decorator.add': decoratorAddActionImplementation,
-  'decorator.remove': removeDecoratorActionImplementation,
-  'delete': deleteActionImplementation,
-  'delete.backward': deleteBackwardActionImplementation,
-  'delete.forward': deleteForwardActionImplementation,
-  'delete.block': deleteBlockActionImplementation,
-  'history.redo': historyRedoActionImplementation,
-  'history.undo': historyUndoActionImplementation,
-  'insert.block': insertBlockActionImplementation,
-  'insert.inline object': insertInlineObjectActionImplementation,
-  'insert.span': insertSpanActionImplementation,
-  'insert.text': insertTextActionImplementation,
-  'move.backward': moveBackwardActionImplementation,
-  'move.block': moveBlockActionImplementation,
-  'move.forward': moveForwardActionImplementation,
-  'select': selectActionImplementation,
-}
-
-export function performAction({
-  context,
-  action,
-}: {
-  context: BehaviorActionImplementationContext
-  action: InternalBehaviorAction
-}) {
-  switch (action.type) {
-    case 'annotation.add': {
-      behaviorActionImplementations['annotation.add']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'annotation.remove': {
-      behaviorActionImplementations['annotation.remove']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'block.set': {
-      behaviorActionImplementations['block.set']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'block.unset': {
-      behaviorActionImplementations['block.unset']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'decorator.add': {
-      behaviorActionImplementations['decorator.add']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'decorator.remove': {
-      behaviorActionImplementations['decorator.remove']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'delete': {
-      behaviorActionImplementations.delete({
-        context,
-        action,
-      })
-      break
-    }
-    case 'delete.backward': {
-      behaviorActionImplementations['delete.backward']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'delete.block': {
-      behaviorActionImplementations['delete.block']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'delete.forward': {
-      behaviorActionImplementations['delete.forward']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'history.redo': {
-      behaviorActionImplementations['history.redo']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'history.undo': {
-      behaviorActionImplementations['history.undo']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'insert.block': {
-      behaviorActionImplementations['insert.block']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'insert.inline object': {
-      behaviorActionImplementations['insert.inline object']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'insert.span': {
-      behaviorActionImplementations['insert.span']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'insert.text': {
-      behaviorActionImplementations['insert.text']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'move.backward': {
-      behaviorActionImplementations['move.backward']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'move.block': {
-      behaviorActionImplementations['move.block']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'move.forward': {
-      behaviorActionImplementations['move.forward']({
-        context,
-        action,
-      })
-      break
-    }
-    default: {
-      behaviorActionImplementations.select({
-        context,
-        action,
-      })
-      break
-    }
-  }
-}

package/src/behaviors/behavior.default.raise-soft-break.ts

@@ -1,14 +0,0 @@
-import {keyIs} from '../internal-utils/key-is'
-import {raise} from './behavior.types.action'
-import {defineBehavior} from './behavior.types.behavior'
-
-/**
- * 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.
- */
-export const raiseInsertSoftBreak = defineBehavior({
-  on: 'keyboard.keydown',
-  guard: ({event}) => keyIs.lineBreak(event.originEvent),
-  actions: [() => [raise({type: 'insert.soft break'})]],
-})

package/src/plugins/plugin.core.tsx

@@ -1,9 +0,0 @@
-import {coreBehaviors} from '../behaviors/behavior.core'
-import {BehaviorPlugin} from './plugin.behavior'
-
-/**
- * @beta
- */
-export function CoreBehaviorsPlugin() {
-  return <BehaviorPlugin behaviors={coreBehaviors} />
-}