@portabletext/editor 1.14.0 → 1.14.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.14.0",
+  "version": "1.14.2",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -64,27 +64,27 @@
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.16",
-    "@sanity/block-tools": "^3.66.0",
+    "@sanity/block-tools": "^3.66.1",
     "@sanity/diff-match-patch": "^3.1.1",
     "@sanity/pkg-utils": "^6.11.14",
-    "@sanity/schema": "^3.66.0",
-    "@sanity/types": "^3.66.0",
+    "@sanity/schema": "^3.66.1",
+    "@sanity/types": "^3.66.1",
     "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.0.1",
+    "@testing-library/react": "^16.1.0",
     "@types/debug": "^4.1.5",
     "@types/lodash": "^4.17.13",
     "@types/lodash.startcase": "^4.4.9",
     "@types/react": "^18.3.14",
     "@types/react-dom": "^18.3.2",
-    "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "@typescript-eslint/parser": "^8.16.0",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
     "@vitejs/plugin-react": "^4.3.4",
-    "@vitest/browser": "^2.1.5",
+    "@vitest/browser": "^2.1.8",
     "@vitest/coverage-istanbul": "^2.1.8",
     "babel-plugin-react-compiler": "19.0.0-beta-df7b47d-20241124",
     "eslint": "8.57.1",
     "eslint-plugin-react-compiler": "19.0.0-beta-df7b47d-20241124",
-    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
     "jsdom": "^25.0.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -92,14 +92,14 @@
     "styled-components": "^6.1.13",
     "typescript": "5.7.2",
     "vite": "^5.4.11",
-    "vitest": "^2.1.5",
+    "vitest": "^2.1.8",
     "vitest-browser-react": "^0.0.4",
     "racejar": "1.1.0"
   },
   "peerDependencies": {
-    "@sanity/block-tools": "^3.66.0",
-    "@sanity/schema": "^3.66.0",
-    "@sanity/types": "^3.66.0",
+    "@sanity/block-tools": "^3.66.1",
+    "@sanity/schema": "^3.66.1",
+    "@sanity/types": "^3.66.1",
     "react": "^16.9 || ^17 || ^18",
     "rxjs": "^7.8.1",
     "styled-components": "^6.1.13"

package/src/editor/behavior/behavior.actions.ts

@@ -45,8 +45,8 @@ import {textBlockSetActionImplementation} from './behavior.action.text-block.set
 import {textBlockUnsetActionImplementation} from './behavior.action.text-block.unset'
 import type {
   BehaviorAction,
-  BehaviorEvent,
   PickFromUnion,
+  SyntheticBehaviorEvent,
 } from './behavior.types'
 
 export type BehaviorActionImplementationContext = Pick<
@@ -82,7 +82,6 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
   'focus': ({action}) => {
     ReactEditor.focus(action.editor)
   },
-  'copy': () => {},
   'delete.backward': ({action}) => {
     deleteBackward(action.editor, action.unit)
   },
@@ -186,8 +185,6 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
   'effect': ({action}) => {
     action.effect()
   },
-  'key.down': () => {},
-  'key.up': () => {},
   'list item.add': addListItemActionImplementation,
   'list item.remove': removeListItemActionImplementation,
   'list item.toggle': toggleListItemActionImplementation,
@@ -227,7 +224,6 @@ const behaviorActionImplementations: BehaviorActionImplementations = {
     })
   },
   'noop': () => {},
-  'paste': () => {},
   'select': ({action}) => {
     const newSelection = toSlateRange(action.selection, action.editor)
 
@@ -434,7 +430,7 @@ function performDefaultAction({
   action,
 }: {
   context: BehaviorActionImplementationContext
-  action: PickFromUnion<BehaviorAction, 'type', BehaviorEvent['type']>
+  action: PickFromUnion<BehaviorAction, 'type', SyntheticBehaviorEvent['type']>
 }) {
   switch (action.type) {
     case 'annotation.add': {
@@ -465,13 +461,6 @@ function performDefaultAction({
       })
       break
     }
-    case 'copy': {
-      behaviorActionImplementations.copy({
-        context,
-        action,
-      })
-      break
-    }
     case 'decorator.add': {
       behaviorActionImplementations['decorator.add']({
         context,
@@ -549,20 +538,6 @@ function performDefaultAction({
       })
       break
     }
-    case 'key.down': {
-      behaviorActionImplementations['key.down']({
-        context,
-        action,
-      })
-      break
-    }
-    case 'key.up': {
-      behaviorActionImplementations['key.up']({
-        context,
-        action,
-      })
-      break
-    }
     case 'list item.toggle': {
       behaviorActionImplementations['list item.toggle']({
         context,
@@ -570,13 +545,6 @@ function performDefaultAction({
       })
       break
     }
-    case 'paste': {
-      behaviorActionImplementations.paste({
-        context,
-        action,
-      })
-      break
-    }
     default: {
       behaviorActionImplementations['style.toggle']({
         context,

package/src/editor/behavior/behavior.types.ts

@@ -7,7 +7,7 @@ import type {EditorContext} from '../editor-snapshot'
 /**
  * @alpha
  */
-export type BehaviorEvent =
+export type SyntheticBehaviorEvent =
   | {
       type: 'annotation.add'
       annotation: {
@@ -31,10 +31,6 @@ export type BehaviorEvent =
   | {
       type: 'blur'
     }
-  | {
-      type: 'copy'
-      data: DataTransfer
-    }
   | {
       type: 'decorator.add'
       decorator: string
@@ -85,7 +81,20 @@ export type BehaviorEvent =
       options?: TextInsertTextOptions
     }
   | {
-      type: 'paste'
+      type: 'list item.toggle'
+      listItem: string
+    }
+  | {
+      type: 'style.toggle'
+      style: string
+    }
+
+/**
+ * @alpha
+ */
+export type NativeBehaviorEvent =
+  | {
+      type: 'copy'
       data: DataTransfer
     }
   | {
@@ -103,33 +112,29 @@ export type BehaviorEvent =
       >
     }
   | {
-      type: 'list item.toggle'
-      listItem: string
-    }
-  | {
-      type: 'style.toggle'
-      style: string
+      type: 'paste'
+      data: DataTransfer
     }
 
 /**
  * @alpha
  */
 export type BehaviorGuard<
-  TBehaviorEvent extends BehaviorEvent,
+  TAnyBehaviorEvent extends BehaviorEvent,
   TGuardResponse,
 > = ({
   context,
   event,
 }: {
   context: EditorContext
-  event: TBehaviorEvent
+  event: TAnyBehaviorEvent
 }) => TGuardResponse | false
 
 /**
  * @alpha
  */
 export type BehaviorActionIntend =
-  | BehaviorEvent
+  | SyntheticBehaviorEvent
   | {
       type: 'insert.span'
       text: string
@@ -224,24 +229,29 @@ export type BehaviorAction = BehaviorActionIntend & {
   editor: PortableTextSlateEditor
 }
 
+/**
+ * @alpha
+ */
+export type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
+
 /**
  * @alpha
  */
 export type Behavior<
-  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TAnyBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
 > = {
   /**
    * The internal editor event that triggers this behavior.
    */
-  on: TBehaviorEventType
+  on: TAnyBehaviorEventType
   /**
    * 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<
-    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
+    PickFromUnion<BehaviorEvent, 'type', TAnyBehaviorEventType>,
     TGuardResponse
   >
   /**
@@ -255,21 +265,15 @@ export type Behavior<
  */
 export type BehaviorActionIntendSet<TGuardResponse = true> = (
   guardResponse: TGuardResponse,
-) => Array<
-  OmitFromUnion<
-    BehaviorActionIntend,
-    'type',
-    'copy' | 'key.down' | 'key.up' | 'paste'
-  >
->
+) => Array<BehaviorActionIntend>
 
 /**
  * @alpha
  */
 export function defineBehavior<
-  TBehaviorEventType extends BehaviorEvent['type'],
+  TAnyBehaviorEventType extends BehaviorEvent['type'],
   TGuardResponse = true,
->(behavior: Behavior<TBehaviorEventType, TGuardResponse>): Behavior {
+>(behavior: Behavior<TAnyBehaviorEventType, TGuardResponse>): Behavior {
   return behavior as unknown as Behavior
 }
 

package/src/editor/editor-machine.ts

@@ -26,9 +26,10 @@ import type {
   Behavior,
   BehaviorAction,
   BehaviorActionIntend,
-  BehaviorEvent,
+  NativeBehaviorEvent,
   OmitFromUnion,
   PickFromUnion,
+  SyntheticBehaviorEvent,
 } from './behavior/behavior.types'
 import type {EditorContext} from './editor-snapshot'
 
@@ -70,7 +71,7 @@ export type InternalEditorEvent =
   | {type: 'done normalizing'}
   | {
       type: 'behavior event'
-      behaviorEvent: BehaviorEvent
+      behaviorEvent: SyntheticBehaviorEvent | NativeBehaviorEvent
       editor: PortableTextSlateEditor
       nativeEvent?: {preventDefault: () => void}
     }
@@ -106,10 +107,10 @@ export type InternalEditorEvent =
 export type EditorEmittedEvent = PickFromUnion<
   InternalEditorEmittedEvent,
   'type',
-  | 'blur'
+  | 'blurred'
   | 'done loading'
   | 'error'
-  | 'focus'
+  | 'focused'
   | 'invalid value'
   | 'loading'
   | 'mutation'
@@ -154,7 +155,7 @@ export type InternalEditorEmittedEvent =
   | {type: 'done loading'}
   | {type: 'readOnly toggled'; readOnly: boolean}
   | PickFromUnion<
-      BehaviorEvent,
+      SyntheticBehaviorEvent,
       'type',
       | 'annotation.add'
       | 'annotation.remove'
@@ -236,16 +237,26 @@ export const editorMachine = setup({
 
       debug('Behavior event', event)
 
-      const defaultAction = {
-        ...event.behaviorEvent,
-        editor: event.editor,
-      } satisfies BehaviorAction
+      const defaultAction =
+        event.behaviorEvent.type === 'copy' ||
+        event.behaviorEvent.type === 'key.down' ||
+        event.behaviorEvent.type === 'key.up' ||
+        event.behaviorEvent.type === 'paste'
+          ? undefined
+          : ({
+              ...event.behaviorEvent,
+              editor: event.editor,
+            } satisfies BehaviorAction)
 
       const eventBehaviors = context.behaviors.filter(
         (behavior) => behavior.on === event.behaviorEvent.type,
       )
 
       if (eventBehaviors.length === 0) {
+        if (!defaultAction) {
+          return
+        }
+
         enqueue.raise({
           type: 'behavior action intends',
           editor: event.editor,
@@ -269,6 +280,11 @@ export const editorMachine = setup({
         console.warn(
           `Unable to handle event ${event.type} due to missing selection`,
         )
+
+        if (!defaultAction) {
+          return
+        }
+
         enqueue.raise({
           type: 'behavior action intends',
           editor: event.editor,
@@ -324,6 +340,10 @@ export const editorMachine = setup({
       }
 
       if (!behaviorOverwritten) {
+        if (!defaultAction) {
+          return
+        }
+
         enqueue.raise({
           type: 'behavior action intends',
           editor: event.editor,

package/src/index.ts

@@ -15,14 +15,16 @@ export {
 } from './editor/behavior/behavior.markdown'
 export {
   defineBehavior,
+  type BehaviorEvent,
   type Behavior,
   type BehaviorActionIntend,
   type BehaviorActionIntendSet,
-  type BehaviorEvent,
+  type SyntheticBehaviorEvent,
   type BehaviorGuard,
+  type BlockOffset,
+  type NativeBehaviorEvent,
   type OmitFromUnion,
   type PickFromUnion,
-  type BlockOffset,
 } from './editor/behavior/behavior.types'
 export type {Editor, EditorConfig, EditorEvent} from './editor/create-editor'
 export type {SlateEditor} from './editor/create-slate-editor'