@portabletext/editor 1.44.0 → 1.44.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.44.0",
+  "version": "1.44.2",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -85,7 +85,7 @@
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",
     "@sanity/diff-match-patch": "^3.2.0",
-    "@sanity/pkg-utils": "^7.2.0",
+    "@sanity/pkg-utils": "^7.2.1",
     "@sanity/schema": "^3.81.0",
     "@sanity/types": "^3.81.0",
     "@testing-library/jest-dom": "^6.6.3",

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

@@ -4,12 +4,8 @@ import type {EditorContext} from '../editor/editor-snapshot'
 import {
   addAnnotationActionImplementation,
   removeAnnotationActionImplementation,
-  toggleAnnotationActionImplementation,
 } from '../editor/plugins/createWithEditableAPI'
-import {
-  removeDecoratorActionImplementation,
-  toggleDecoratorActionImplementation,
-} from '../editor/plugins/createWithPortableTextMarkModel'
+import {removeDecoratorActionImplementation} from '../editor/plugins/createWithPortableTextMarkModel'
 import {
   historyRedoActionImplementation,
   historyUndoActionImplementation,
@@ -36,8 +32,6 @@ import {insertSpanActionImplementation} from './behavior.action.insert-span'
 import {insertBlockActionImplementation} from './behavior.action.insert.block'
 import {insertTextActionImplementation} from './behavior.action.insert.text'
 import {moveBlockActionImplementation} from './behavior.action.move.block'
-import {moveBlockDownActionImplementation} from './behavior.action.move.block-down'
-import {moveBlockUpActionImplementation} from './behavior.action.move.block-up'
 import {noopActionImplementation} from './behavior.action.noop'
 import {selectActionImplementation} from './behavior.action.select'
 
@@ -66,13 +60,11 @@ type BehaviorActionImplementations = {
 const behaviorActionImplementations: BehaviorActionImplementations = {
   'annotation.add': addAnnotationActionImplementation,
   'annotation.remove': removeAnnotationActionImplementation,
-  'annotation.toggle': toggleAnnotationActionImplementation,
   'block.set': blockSetBehaviorActionImplementation,
   'block.unset': blockUnsetBehaviorActionImplementation,
   'blur': blurActionImplementation,
   'decorator.add': decoratorAddActionImplementation,
   'decorator.remove': removeDecoratorActionImplementation,
-  'decorator.toggle': toggleDecoratorActionImplementation,
   'focus': focusActionImplementation,
   'delete': deleteActionImplementation,
   'delete.backward': deleteBackwardActionImplementation,
@@ -89,8 +81,6 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
   'insert.text': insertTextActionImplementation,
   'effect': effectActionImplementation,
   'move.block': moveBlockActionImplementation,
-  'move.block down': moveBlockDownActionImplementation,
-  'move.block up': moveBlockUpActionImplementation,
   'noop': noopActionImplementation,
   'select': selectActionImplementation,
 }
@@ -119,13 +109,6 @@ export function performAction({
       })
       break
     }
-    case 'annotation.toggle': {
-      behaviorActionImplementations['annotation.toggle']({
-        context,
-        action,
-      })
-      break
-    }
     case 'block.set': {
       behaviorActionImplementations['block.set']({
         context,
@@ -161,13 +144,6 @@ export function performAction({
       })
       break
     }
-    case 'decorator.toggle': {
-      behaviorActionImplementations['decorator.toggle']({
-        context,
-        action,
-      })
-      break
-    }
     case 'delete': {
       behaviorActionImplementations.delete({
         context,
@@ -280,20 +256,6 @@ export function performAction({
       })
       break
     }
-    case 'move.block down': {
-      behaviorActionImplementations['move.block down']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'move.block up': {
-      behaviorActionImplementations['move.block up']({
-        context,
-        action,
-      })
-      break
-    }
     case 'noop': {
       behaviorActionImplementations.noop({
         context,

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

@@ -0,0 +1,26 @@
+import {isActiveAnnotation} from '../selectors'
+import {raise} from './behavior.types.action'
+import {defineBehavior} from './behavior.types.behavior'
+
+export const abstractAnnotationBehaviors = [
+  defineBehavior({
+    on: 'annotation.toggle',
+    guard: ({snapshot, event}) =>
+      isActiveAnnotation(event.annotation.name)(snapshot),
+    actions: [
+      ({event}) => [
+        raise({type: 'annotation.remove', annotation: event.annotation}),
+      ],
+    ],
+  }),
+  defineBehavior({
+    on: 'annotation.toggle',
+    guard: ({snapshot, event}) =>
+      !isActiveAnnotation(event.annotation.name)(snapshot),
+    actions: [
+      ({event}) => [
+        raise({type: 'annotation.add', annotation: event.annotation}),
+      ],
+    ],
+  }),
+]

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

@@ -0,0 +1,47 @@
+import {isActiveDecorator} from '../selectors'
+import {blockOffsetsToSelection} from '../utils'
+import {raise} from './behavior.types.action'
+import {defineBehavior} from './behavior.types.behavior'
+
+export const abstractDecoratorBehaviors = [
+  defineBehavior({
+    on: 'decorator.toggle',
+    guard: ({snapshot, event}) => isActiveDecorator(event.decorator)(snapshot),
+    actions: [
+      ({event}) => [
+        raise({type: 'decorator.remove', decorator: event.decorator}),
+      ],
+    ],
+  }),
+  defineBehavior({
+    on: 'decorator.toggle',
+    guard: ({snapshot, event}) => {
+      const manualSelection = event.offsets
+        ? blockOffsetsToSelection({
+            value: snapshot.context.value,
+            offsets: event.offsets,
+          })
+        : null
+
+      if (manualSelection) {
+        return !isActiveDecorator(event.decorator)({
+          ...snapshot,
+          context: {
+            ...snapshot.context,
+            selection: manualSelection,
+          },
+        })
+      }
+
+      return !isActiveDecorator(event.decorator)(snapshot)
+    },
+    actions: [
+      ({event}) => [
+        raise({
+          ...event,
+          type: 'decorator.add',
+        }),
+      ],
+    ],
+  }),
+]

package/src/behaviors/{behavior.internal.insert.ts → behavior.abstract.insert.ts}

@@ -2,7 +2,7 @@ import {getFocusTextBlock} from '../selectors'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
-export const internalInsertBehaviors = [
+export const abstractInsertBehaviors = [
   defineBehavior({
     on: 'insert.blocks',
     guard: ({event}) => event.placement === 'before',

package/src/behaviors/{behavior.internal.list-item.ts → behavior.abstract.list-item.ts}

@@ -2,7 +2,7 @@ import {getSelectedTextBlocks, isActiveListItem} from '../selectors'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
-export const internalListItemBehaviors = [
+export const abstractListItemBehaviors = [
   defineBehavior({
     on: 'list item.add',
     guard: ({snapshot}) => {

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

@@ -0,0 +1,78 @@
+import {getNextBlock, getPreviousBlock} from '../selectors'
+import {raise} from './behavior.types.action'
+import {defineBehavior} from './behavior.types.behavior'
+
+export const abstractMoveBehaviors = [
+  defineBehavior({
+    on: 'move.block up',
+    guard: ({snapshot, event}) => {
+      const previousBlock = getPreviousBlock({
+        ...snapshot,
+        context: {
+          ...snapshot.context,
+          selection: {
+            anchor: {
+              path: event.at,
+              offset: 0,
+            },
+            focus: {
+              path: event.at,
+              offset: 0,
+            },
+          },
+        },
+      })
+
+      if (previousBlock) {
+        return {previousBlock}
+      }
+
+      return false
+    },
+    actions: [
+      ({event}, {previousBlock}) => [
+        raise({
+          type: 'move.block',
+          at: event.at,
+          to: previousBlock.path,
+        }),
+      ],
+    ],
+  }),
+  defineBehavior({
+    on: 'move.block down',
+    guard: ({snapshot, event}) => {
+      const nextBlock = getNextBlock({
+        ...snapshot,
+        context: {
+          ...snapshot.context,
+          selection: {
+            anchor: {
+              path: event.at,
+              offset: 0,
+            },
+            focus: {
+              path: event.at,
+              offset: 0,
+            },
+          },
+        },
+      })
+
+      if (nextBlock) {
+        return {nextBlock}
+      }
+
+      return false
+    },
+    actions: [
+      ({event}, {nextBlock}) => [
+        raise({
+          type: 'move.block',
+          at: event.at,
+          to: nextBlock.path,
+        }),
+      ],
+    ],
+  }),
+]

package/src/behaviors/{behavior.internal.select.ts → behavior.abstract.select.ts}

@@ -3,7 +3,7 @@ import {getBlockEndPoint, getBlockStartPoint} from '../utils'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
-export const internalSelectBehaviors = [
+export const abstractSelectBehaviors = [
   defineBehavior({
     on: 'select.previous block',
     guard: ({snapshot, event}) => {

package/src/behaviors/{behavior.internal.style.ts → behavior.abstract.style.ts}

@@ -2,7 +2,7 @@ import {getSelectedTextBlocks, isActiveStyle} from '../selectors'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
-export const internalStyleBehaviors = [
+export const abstractStyleBehaviors = [
   defineBehavior({
     on: 'style.add',
     guard: ({snapshot}) => {

package/src/behaviors/behavior.code-editor.ts

@@ -1,5 +1,6 @@
 import {isHotkey} from '../internal-utils/is-hotkey'
 import * as selectors from '../selectors'
+import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
 /**
@@ -35,10 +36,12 @@ export function createCodeEditorBehaviors(config: CodeEditorBehaviorsConfig) {
       },
       actions: [
         (_, {paths}) =>
-          paths.map((at) => ({
-            type: 'move.block up',
-            at,
-          })),
+          paths.map((at) =>
+            raise({
+              type: 'move.block up',
+              at,
+            }),
+          ),
       ],
     }),
     defineBehavior({
@@ -62,10 +65,12 @@ export function createCodeEditorBehaviors(config: CodeEditorBehaviorsConfig) {
       },
       actions: [
         (_, {paths}) =>
-          paths.map((at) => ({
-            type: 'move.block down',
-            at,
-          })),
+          paths.map((at) =>
+            raise({
+              type: 'move.block down',
+              at,
+            }),
+          ),
       ],
     }),
   ]

package/src/behaviors/behavior.default.ts

@@ -1,79 +1,17 @@
 import {isTextBlock} from '../internal-utils/parse-blocks'
 import * as selectors from '../selectors'
-import {blockOffsetsToSelection, getTextBlockText} from '../utils'
+import {getTextBlockText} from '../utils'
+import {abstractAnnotationBehaviors} from './behavior.abstract.annotation'
+import {abstractDecoratorBehaviors} from './behavior.abstract.decorator'
+import {abstractInsertBehaviors} from './behavior.abstract.insert'
+import {abstractListItemBehaviors} from './behavior.abstract.list-item'
+import {abstractMoveBehaviors} from './behavior.abstract.move'
+import {abstractSelectBehaviors} from './behavior.abstract.select'
+import {abstractStyleBehaviors} from './behavior.abstract.style'
 import {raiseInsertSoftBreak} from './behavior.default.raise-soft-break'
-import {internalInsertBehaviors} from './behavior.internal.insert'
-import {internalListItemBehaviors} from './behavior.internal.list-item'
-import {internalSelectBehaviors} from './behavior.internal.select'
-import {internalStyleBehaviors} from './behavior.internal.style'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
-const toggleAnnotationOff = defineBehavior({
-  on: 'annotation.toggle',
-  guard: ({snapshot, event}) =>
-    selectors.isActiveAnnotation(event.annotation.name)(snapshot),
-  actions: [
-    ({event}) => [
-      raise({type: 'annotation.remove', annotation: event.annotation}),
-    ],
-  ],
-})
-
-const toggleAnnotationOn = defineBehavior({
-  on: 'annotation.toggle',
-  guard: ({snapshot, event}) =>
-    !selectors.isActiveAnnotation(event.annotation.name)(snapshot),
-  actions: [
-    ({event}) => [
-      raise({type: 'annotation.add', annotation: event.annotation}),
-    ],
-  ],
-})
-
-const toggleDecoratorOff = defineBehavior({
-  on: 'decorator.toggle',
-  guard: ({snapshot, event}) =>
-    selectors.isActiveDecorator(event.decorator)(snapshot),
-  actions: [
-    ({event}) => [
-      raise({type: 'decorator.remove', decorator: event.decorator}),
-    ],
-  ],
-})
-
-const toggleDecoratorOn = defineBehavior({
-  on: 'decorator.toggle',
-  guard: ({snapshot, event}) => {
-    const manualSelection = event.offsets
-      ? blockOffsetsToSelection({
-          value: snapshot.context.value,
-          offsets: event.offsets,
-        })
-      : null
-
-    if (manualSelection) {
-      return !selectors.isActiveDecorator(event.decorator)({
-        ...snapshot,
-        context: {
-          ...snapshot.context,
-          selection: manualSelection,
-        },
-      })
-    }
-
-    return !selectors.isActiveDecorator(event.decorator)(snapshot)
-  },
-  actions: [
-    ({event}) => [
-      raise({
-        ...event,
-        type: 'decorator.add',
-      }),
-    ],
-  ],
-})
-
 const raiseDeserializationSuccessOrFailure = defineBehavior({
   on: 'deserialize',
   guard: ({snapshot, event}) => {
@@ -505,14 +443,13 @@ export const defaultBehaviors = [
       ],
     ],
   }),
-  ...internalInsertBehaviors,
-  ...internalListItemBehaviors,
-  ...internalStyleBehaviors,
-  ...internalSelectBehaviors,
-  toggleAnnotationOff,
-  toggleAnnotationOn,
-  toggleDecoratorOff,
-  toggleDecoratorOn,
+  ...abstractAnnotationBehaviors,
+  ...abstractDecoratorBehaviors,
+  ...abstractInsertBehaviors,
+  ...abstractListItemBehaviors,
+  ...abstractMoveBehaviors,
+  ...abstractStyleBehaviors,
+  ...abstractSelectBehaviors,
   raiseDeserializationSuccessOrFailure,
   raiseSerializationSuccessOrFailure,
   raiseInsertSoftBreak,

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

@@ -10,8 +10,8 @@ import {debugWithName} from '../internal-utils/debug'
 import type {PortableTextSlateEditor} from '../types/editor'
 import type {InternalBehaviorAction} from './behavior.types.action'
 import {
+  isAbstractBehaviorEvent,
   isCustomBehaviorEvent,
-  isInternalBehaviorEvent,
   isNativeBehaviorEvent,
 } from './behavior.types.event'
 
@@ -20,8 +20,8 @@ const debug = debugWithName('behaviors:event')
 function eventCategory(event: BehaviorEvent) {
   return isNativeBehaviorEvent(event)
     ? 'native'
-    : isInternalBehaviorEvent(event)
-      ? 'internal'
+    : isAbstractBehaviorEvent(event)
+      ? 'abstract'
       : isCustomBehaviorEvent(event)
         ? 'custom'
         : 'synthetic'
@@ -55,7 +55,7 @@ export function performEvent({
   const defaultAction =
     isCustomBehaviorEvent(event) ||
     isNativeBehaviorEvent(event) ||
-    isInternalBehaviorEvent(event)
+    isAbstractBehaviorEvent(event)
       ? undefined
       : ({
           ...event,

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

@@ -2,8 +2,8 @@ import type {EditorContext, EditorSnapshot} from '../editor/editor-snapshot'
 import type {OmitFromUnion, PickFromUnion} from '../type-utils'
 import type {PortableTextSlateEditor} from '../types/editor'
 import type {
+  AbstractBehaviorEvent,
   CustomBehaviorEvent,
-  InternalBehaviorEvent,
   SyntheticBehaviorEvent,
 } from './behavior.types.event'
 
@@ -15,7 +15,7 @@ export type BehaviorAction =
   | {
       type: 'raise'
       event:
-        | InternalBehaviorEvent
+        | AbstractBehaviorEvent
         | SyntheticBehaviorEvent
         | CustomBehaviorEvent
     }
@@ -31,7 +31,7 @@ export type BehaviorAction =
  * @beta
  */
 export function raise(
-  event: InternalBehaviorEvent | SyntheticBehaviorEvent | CustomBehaviorEvent,
+  event: AbstractBehaviorEvent | SyntheticBehaviorEvent | CustomBehaviorEvent,
 ): PickFromUnion<BehaviorAction, 'type', 'raise'> {
   return {type: 'raise', event}
 }

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

@@ -23,17 +23,18 @@ export type Behavior<
     ResolveBehaviorEvent<TBehaviorEventType> = ResolveBehaviorEvent<TBehaviorEventType>,
 > = {
   /**
-   * The internal editor event that triggers this behavior.
+   * Editor Event that triggers this Behavior.
    */
   on: TBehaviorEventType
   /**
-   * Predicate function that determines if the behavior should be executed.
+   * Predicate function that determines if the Behavior should be executed.
    * Returning a non-nullable value from the guard will pass the value to the
    * actions and execute them.
    */
   guard?: BehaviorGuard<TBehaviorEvent, TGuardResponse>
   /**
-   * Array of behavior action sets.
+   * Array of Behavior Action sets.
+   * Each set represents a step in the history stack.
    */
   actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }