@portabletext/editor 1.30.1 → 1.30.2

package/lib/behaviors/index.js

@@ -1,5 +1,5 @@
 import { defineBehavior, isHotkey } from "../_chunks-es/behavior.core.js";
-import { coreBehavior, coreBehaviors, raise } from "../_chunks-es/behavior.core.js";
+import { coreBehaviors, raise } from "../_chunks-es/behavior.core.js";
 import { getFirstBlock, getSelectedBlocks, getLastBlock, getFocusTextBlock, isSelectionCollapsed, getFocusSpan } from "../_chunks-es/selector.is-at-the-start-of-block.js";
 import { createActor, setup, assign, assertEvent } from "xstate";
 import { getBlockTextBefore } from "../_chunks-es/selector.get-text-before.js";
@@ -421,7 +421,6 @@ function createLinkBehaviors(config) {
   return [pasteLinkOnSelection, pasteLinkAtCaret];
 }
 export {
-  coreBehavior,
   coreBehaviors,
   createCodeEditorBehaviors,
   createEmojiPickerBehaviors,

package/lib/index.d.cts

@@ -65,10 +65,12 @@ import {
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
 import {
+  BehaviorEvent as BehaviorEvent_2,
   BlockOffset as BlockOffset_2,
   PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2,
 } from '..'
 import {MIMEType as MIMEType_2} from '../internal-utils/mime-type'
+import {PickFromUnion as PickFromUnion_2} from '../type-utils'
 
 /**
  * @public
@@ -2109,7 +2111,115 @@ declare const editorMachine: StateMachine<
         AnyEventObject
       >
     }) => {
-      behaviors: Set<Behavior>
+      behaviors: Set<
+        Behavior<
+          | 'focus'
+          | 'delete'
+          | 'select'
+          | 'serialize'
+          | 'copy'
+          | 'serialization.failure'
+          | 'serialization.success'
+          | 'deserialize'
+          | 'deserialization.failure'
+          | 'deserialization.success'
+          | 'annotation.add'
+          | 'annotation.remove'
+          | 'annotation.toggle'
+          | 'block.set'
+          | 'block.unset'
+          | 'blur'
+          | 'data transfer.set'
+          | 'decorator.add'
+          | 'decorator.remove'
+          | 'decorator.toggle'
+          | 'delete.backward'
+          | 'delete.block'
+          | 'delete.forward'
+          | 'delete.text'
+          | 'insert.blocks'
+          | 'insert.block object'
+          | 'insert.inline object'
+          | 'insert.break'
+          | 'insert.soft break'
+          | 'insert.block'
+          | 'insert.span'
+          | 'insert.text'
+          | 'insert.text block'
+          | 'list item.add'
+          | 'list item.remove'
+          | 'list item.toggle'
+          | 'move.block'
+          | 'move.block down'
+          | 'move.block up'
+          | 'select.previous block'
+          | 'select.next block'
+          | 'style.add'
+          | 'style.remove'
+          | 'style.toggle'
+          | 'text block.set'
+          | 'text block.unset'
+          | 'key.down'
+          | 'key.up'
+          | 'paste'
+          | `custom.${string}`,
+          true,
+          PickFromUnion_2<
+            BehaviorEvent_2,
+            'type',
+            | 'focus'
+            | 'delete'
+            | 'select'
+            | 'serialize'
+            | 'copy'
+            | 'serialization.failure'
+            | 'serialization.success'
+            | 'deserialize'
+            | 'deserialization.failure'
+            | 'deserialization.success'
+            | 'annotation.add'
+            | 'annotation.remove'
+            | 'annotation.toggle'
+            | 'block.set'
+            | 'block.unset'
+            | 'blur'
+            | 'data transfer.set'
+            | 'decorator.add'
+            | 'decorator.remove'
+            | 'decorator.toggle'
+            | 'delete.backward'
+            | 'delete.block'
+            | 'delete.forward'
+            | 'delete.text'
+            | 'insert.blocks'
+            | 'insert.block object'
+            | 'insert.inline object'
+            | 'insert.break'
+            | 'insert.soft break'
+            | 'insert.block'
+            | 'insert.span'
+            | 'insert.text'
+            | 'insert.text block'
+            | 'list item.add'
+            | 'list item.remove'
+            | 'list item.toggle'
+            | 'move.block'
+            | 'move.block down'
+            | 'move.block up'
+            | 'select.previous block'
+            | 'select.next block'
+            | 'style.add'
+            | 'style.remove'
+            | 'style.toggle'
+            | 'text block.set'
+            | 'text block.unset'
+            | 'key.down'
+            | 'key.up'
+            | 'paste'
+            | `custom.${string}`
+          >
+        >
+      >
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]

package/lib/index.d.ts

@@ -65,10 +65,12 @@ import {
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
 import {
+  BehaviorEvent as BehaviorEvent_2,
   BlockOffset as BlockOffset_2,
   PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2,
 } from '..'
 import {MIMEType as MIMEType_2} from '../internal-utils/mime-type'
+import {PickFromUnion as PickFromUnion_2} from '../type-utils'
 
 /**
  * @public
@@ -2109,7 +2111,115 @@ declare const editorMachine: StateMachine<
         AnyEventObject
       >
     }) => {
-      behaviors: Set<Behavior>
+      behaviors: Set<
+        Behavior<
+          | 'focus'
+          | 'delete'
+          | 'select'
+          | 'serialize'
+          | 'copy'
+          | 'serialization.failure'
+          | 'serialization.success'
+          | 'deserialize'
+          | 'deserialization.failure'
+          | 'deserialization.success'
+          | 'annotation.add'
+          | 'annotation.remove'
+          | 'annotation.toggle'
+          | 'block.set'
+          | 'block.unset'
+          | 'blur'
+          | 'data transfer.set'
+          | 'decorator.add'
+          | 'decorator.remove'
+          | 'decorator.toggle'
+          | 'delete.backward'
+          | 'delete.block'
+          | 'delete.forward'
+          | 'delete.text'
+          | 'insert.blocks'
+          | 'insert.block object'
+          | 'insert.inline object'
+          | 'insert.break'
+          | 'insert.soft break'
+          | 'insert.block'
+          | 'insert.span'
+          | 'insert.text'
+          | 'insert.text block'
+          | 'list item.add'
+          | 'list item.remove'
+          | 'list item.toggle'
+          | 'move.block'
+          | 'move.block down'
+          | 'move.block up'
+          | 'select.previous block'
+          | 'select.next block'
+          | 'style.add'
+          | 'style.remove'
+          | 'style.toggle'
+          | 'text block.set'
+          | 'text block.unset'
+          | 'key.down'
+          | 'key.up'
+          | 'paste'
+          | `custom.${string}`,
+          true,
+          PickFromUnion_2<
+            BehaviorEvent_2,
+            'type',
+            | 'focus'
+            | 'delete'
+            | 'select'
+            | 'serialize'
+            | 'copy'
+            | 'serialization.failure'
+            | 'serialization.success'
+            | 'deserialize'
+            | 'deserialization.failure'
+            | 'deserialization.success'
+            | 'annotation.add'
+            | 'annotation.remove'
+            | 'annotation.toggle'
+            | 'block.set'
+            | 'block.unset'
+            | 'blur'
+            | 'data transfer.set'
+            | 'decorator.add'
+            | 'decorator.remove'
+            | 'decorator.toggle'
+            | 'delete.backward'
+            | 'delete.block'
+            | 'delete.forward'
+            | 'delete.text'
+            | 'insert.blocks'
+            | 'insert.block object'
+            | 'insert.inline object'
+            | 'insert.break'
+            | 'insert.soft break'
+            | 'insert.block'
+            | 'insert.span'
+            | 'insert.text'
+            | 'insert.text block'
+            | 'list item.add'
+            | 'list item.remove'
+            | 'list item.toggle'
+            | 'move.block'
+            | 'move.block down'
+            | 'move.block up'
+            | 'select.previous block'
+            | 'select.next block'
+            | 'style.add'
+            | 'style.remove'
+            | 'style.toggle'
+            | 'text block.set'
+            | 'text block.unset'
+            | 'key.down'
+            | 'key.up'
+            | 'paste'
+            | `custom.${string}`
+          >
+        >
+      >
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]

package/lib/plugins/index.d.cts

@@ -46,10 +46,12 @@ import {
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
 import {
+  BehaviorEvent as BehaviorEvent_2,
   BlockOffset as BlockOffset_2,
   PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2,
 } from '..'
 import {MIMEType as MIMEType_2} from '../internal-utils/mime-type'
+import {PickFromUnion as PickFromUnion_2} from '../type-utils'
 
 /**
  * @beta
@@ -1842,7 +1844,115 @@ declare const editorMachine: StateMachine<
         AnyEventObject
       >
     }) => {
-      behaviors: Set<Behavior>
+      behaviors: Set<
+        Behavior<
+          | 'focus'
+          | 'delete'
+          | 'select'
+          | 'serialize'
+          | 'copy'
+          | 'serialization.failure'
+          | 'serialization.success'
+          | 'deserialize'
+          | 'deserialization.failure'
+          | 'deserialization.success'
+          | 'annotation.add'
+          | 'annotation.remove'
+          | 'annotation.toggle'
+          | 'block.set'
+          | 'block.unset'
+          | 'blur'
+          | 'data transfer.set'
+          | 'decorator.add'
+          | 'decorator.remove'
+          | 'decorator.toggle'
+          | 'delete.backward'
+          | 'delete.block'
+          | 'delete.forward'
+          | 'delete.text'
+          | 'insert.blocks'
+          | 'insert.block object'
+          | 'insert.inline object'
+          | 'insert.break'
+          | 'insert.soft break'
+          | 'insert.block'
+          | 'insert.span'
+          | 'insert.text'
+          | 'insert.text block'
+          | 'list item.add'
+          | 'list item.remove'
+          | 'list item.toggle'
+          | 'move.block'
+          | 'move.block down'
+          | 'move.block up'
+          | 'select.previous block'
+          | 'select.next block'
+          | 'style.add'
+          | 'style.remove'
+          | 'style.toggle'
+          | 'text block.set'
+          | 'text block.unset'
+          | 'key.down'
+          | 'key.up'
+          | 'paste'
+          | `custom.${string}`,
+          true,
+          PickFromUnion_2<
+            BehaviorEvent_2,
+            'type',
+            | 'focus'
+            | 'delete'
+            | 'select'
+            | 'serialize'
+            | 'copy'
+            | 'serialization.failure'
+            | 'serialization.success'
+            | 'deserialize'
+            | 'deserialization.failure'
+            | 'deserialization.success'
+            | 'annotation.add'
+            | 'annotation.remove'
+            | 'annotation.toggle'
+            | 'block.set'
+            | 'block.unset'
+            | 'blur'
+            | 'data transfer.set'
+            | 'decorator.add'
+            | 'decorator.remove'
+            | 'decorator.toggle'
+            | 'delete.backward'
+            | 'delete.block'
+            | 'delete.forward'
+            | 'delete.text'
+            | 'insert.blocks'
+            | 'insert.block object'
+            | 'insert.inline object'
+            | 'insert.break'
+            | 'insert.soft break'
+            | 'insert.block'
+            | 'insert.span'
+            | 'insert.text'
+            | 'insert.text block'
+            | 'list item.add'
+            | 'list item.remove'
+            | 'list item.toggle'
+            | 'move.block'
+            | 'move.block down'
+            | 'move.block up'
+            | 'select.previous block'
+            | 'select.next block'
+            | 'style.add'
+            | 'style.remove'
+            | 'style.toggle'
+            | 'text block.set'
+            | 'text block.unset'
+            | 'key.down'
+            | 'key.up'
+            | 'paste'
+            | `custom.${string}`
+          >
+        >
+      >
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]

package/lib/plugins/index.d.ts

@@ -46,10 +46,12 @@ import {
 } from 'xstate'
 import {GuardArgs} from 'xstate/guards'
 import {
+  BehaviorEvent as BehaviorEvent_2,
   BlockOffset as BlockOffset_2,
   PortableTextMemberSchemaTypes as PortableTextMemberSchemaTypes_2,
 } from '..'
 import {MIMEType as MIMEType_2} from '../internal-utils/mime-type'
+import {PickFromUnion as PickFromUnion_2} from '../type-utils'
 
 /**
  * @beta
@@ -1842,7 +1844,115 @@ declare const editorMachine: StateMachine<
         AnyEventObject
       >
     }) => {
-      behaviors: Set<Behavior>
+      behaviors: Set<
+        Behavior<
+          | 'focus'
+          | 'delete'
+          | 'select'
+          | 'serialize'
+          | 'copy'
+          | 'serialization.failure'
+          | 'serialization.success'
+          | 'deserialize'
+          | 'deserialization.failure'
+          | 'deserialization.success'
+          | 'annotation.add'
+          | 'annotation.remove'
+          | 'annotation.toggle'
+          | 'block.set'
+          | 'block.unset'
+          | 'blur'
+          | 'data transfer.set'
+          | 'decorator.add'
+          | 'decorator.remove'
+          | 'decorator.toggle'
+          | 'delete.backward'
+          | 'delete.block'
+          | 'delete.forward'
+          | 'delete.text'
+          | 'insert.blocks'
+          | 'insert.block object'
+          | 'insert.inline object'
+          | 'insert.break'
+          | 'insert.soft break'
+          | 'insert.block'
+          | 'insert.span'
+          | 'insert.text'
+          | 'insert.text block'
+          | 'list item.add'
+          | 'list item.remove'
+          | 'list item.toggle'
+          | 'move.block'
+          | 'move.block down'
+          | 'move.block up'
+          | 'select.previous block'
+          | 'select.next block'
+          | 'style.add'
+          | 'style.remove'
+          | 'style.toggle'
+          | 'text block.set'
+          | 'text block.unset'
+          | 'key.down'
+          | 'key.up'
+          | 'paste'
+          | `custom.${string}`,
+          true,
+          PickFromUnion_2<
+            BehaviorEvent_2,
+            'type',
+            | 'focus'
+            | 'delete'
+            | 'select'
+            | 'serialize'
+            | 'copy'
+            | 'serialization.failure'
+            | 'serialization.success'
+            | 'deserialize'
+            | 'deserialization.failure'
+            | 'deserialization.success'
+            | 'annotation.add'
+            | 'annotation.remove'
+            | 'annotation.toggle'
+            | 'block.set'
+            | 'block.unset'
+            | 'blur'
+            | 'data transfer.set'
+            | 'decorator.add'
+            | 'decorator.remove'
+            | 'decorator.toggle'
+            | 'delete.backward'
+            | 'delete.block'
+            | 'delete.forward'
+            | 'delete.text'
+            | 'insert.blocks'
+            | 'insert.block object'
+            | 'insert.inline object'
+            | 'insert.break'
+            | 'insert.soft break'
+            | 'insert.block'
+            | 'insert.span'
+            | 'insert.text'
+            | 'insert.text block'
+            | 'list item.add'
+            | 'list item.remove'
+            | 'list item.toggle'
+            | 'move.block'
+            | 'move.block down'
+            | 'move.block up'
+            | 'select.previous block'
+            | 'select.next block'
+            | 'style.add'
+            | 'style.remove'
+            | 'style.toggle'
+            | 'text block.set'
+            | 'text block.unset'
+            | 'key.down'
+            | 'key.up'
+            | 'paste'
+            | `custom.${string}`
+          >
+        >
+      >
       converters: Set<Converter>
       keyGenerator: () => string
       pendingEvents: never[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.30.1",
+  "version": "1.30.2",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -79,8 +79,8 @@
     "slate-react": "0.112.1",
     "use-effect-event": "^1.0.2",
     "xstate": "^5.19.2",
-    "@portabletext/block-tools": "1.1.4",
-    "@portabletext/patches": "1.1.2"
+    "@portabletext/patches": "1.1.2",
+    "@portabletext/block-tools": "1.1.4"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.16",
@@ -98,8 +98,8 @@
     "@typescript-eslint/eslint-plugin": "^8.18.1",
     "@typescript-eslint/parser": "^8.18.1",
     "@vitejs/plugin-react": "^4.3.4",
-    "@vitest/browser": "^3.0.4",
-    "@vitest/coverage-istanbul": "^3.0.4",
+    "@vitest/browser": "^3.0.5",
+    "@vitest/coverage-istanbul": "^3.0.5",
     "babel-plugin-react-compiler": "19.0.0-beta-714736e-20250131",
     "eslint": "8.57.1",
     "eslint-plugin-react-compiler": "19.0.0-beta-714736e-20250131",
@@ -110,7 +110,7 @@
     "rxjs": "^7.8.1",
     "typescript": "5.7.3",
     "vite": "^6.0.11",
-    "vitest": "^3.0.4",
+    "vitest": "^3.0.5",
     "vitest-browser-react": "^0.0.4",
     "racejar": "1.1.2"
   },

package/src/behaviors/behavior.core.ts

@@ -40,17 +40,3 @@ export const coreBehaviors = [
   coreStyleBehaviors.toggleStyleOff,
   coreStyleBehaviors.toggleStyleOn,
 ]
-
-/**
- * @beta
- */
-export const coreBehavior = {
-  annotation: coreAnnotationBehaviors,
-  decorators: coreDecoratorBehaviors,
-  deserialize: coreDeserializeBehaviors,
-  blockObjects: coreBlockObjectBehaviors,
-  insertBreak: coreInsertBreakBehaviors,
-  lists: coreListBehaviors,
-  ...coreSerializeBehaviors,
-  style: coreSerializeBehaviors,
-}

package/src/behaviors/behavior.foundational.ts

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

package/src/behaviors/index.ts

@@ -10,7 +10,7 @@ export {
   createCodeEditorBehaviors,
   type CodeEditorBehaviorsConfig,
 } from './behavior.code-editor'
-export {coreBehavior, coreBehaviors} from './behavior.core'
+export {coreBehaviors} from './behavior.core'
 export {
   type EmojiPickerBehaviorsConfig,
   createEmojiPickerBehaviors,

package/src/editor/editor-machine.ts

@@ -12,6 +12,7 @@ import {
 } from 'xstate'
 import {performAction} from '../behavior-actions/behavior.actions'
 import {coreBehaviors} from '../behaviors/behavior.core'
+import {foundationalBehaviors} from '../behaviors/behavior.foundational'
 import {
   isCustomBehaviorEvent,
   type Behavior,
@@ -252,7 +253,7 @@ export const editorMachine = setup({
     'assign behaviors': assign({
       behaviors: ({event}) => {
         assertEvent(event, 'update behaviors')
-        return new Set(event.behaviors)
+        return new Set([...foundationalBehaviors, ...event.behaviors])
       },
     }),
     'assign schema': assign({
@@ -481,7 +482,10 @@ export const editorMachine = setup({
 }).createMachine({
   id: 'editor',
   context: ({input}) => ({
-    behaviors: new Set(input.behaviors ?? coreBehaviors),
+    behaviors: new Set([
+      ...foundationalBehaviors,
+      ...(input.behaviors ?? coreBehaviors),
+    ]),
     converters: new Set(input.converters ?? []),
     keyGenerator: input.keyGenerator,
     pendingEvents: [],

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

@@ -1,4 +1,5 @@
 import {Editor} from 'slate'
+import {insertSoftBreakActionImplementation} from '../../behavior-actions/behavior.action.insert-break'
 import {toPortableTextRange} from '../../internal-utils/ranges'
 import {fromSlateValue} from '../../internal-utils/values'
 import {KEY_TO_VALUE_ELEMENT} from '../../internal-utils/weakMaps'
@@ -63,7 +64,6 @@ export function createWithEventListeners(
       deleteForward,
       insertBreak,
       insertData,
-      insertSoftBreak,
       insertText,
       select,
       setFragmentData,
@@ -138,7 +138,13 @@ export function createWithEventListeners(
 
     editor.insertSoftBreak = () => {
       if (isApplyingBehaviorActions(editor)) {
-        insertSoftBreak()
+        insertSoftBreakActionImplementation({
+          context: {
+            keyGenerator: editorActor.getSnapshot().context.keyGenerator,
+            schema: editorActor.getSnapshot().context.schema,
+          },
+          action: {type: 'insert.soft break', editor},
+        })
         return
       }
 

package/src/internal-utils/key-is.ts

@@ -0,0 +1,10 @@
+export const keyIs = {
+  lineBreak: (event) => event.key === 'Enter' && event.shiftKey,
+} satisfies Record<string, KeyboardEventPredicate>
+
+type KeyboardEventPredicate = (
+  event: Pick<
+    KeyboardEvent,
+    'key' | 'code' | 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey'
+  >,
+) => boolean