@portabletext/editor 1.36.2 → 1.36.4

package/lib/behaviors/index.d.cts

@@ -77,13 +77,13 @@ export declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-export declare type BehaviorActionIntend =
+export declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -100,7 +100,7 @@ export declare type BehaviorActionIntend =
 /**
  * @beta
  */
-export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+export declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -111,7 +111,7 @@ export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta
@@ -19925,7 +19925,7 @@ declare interface PortableTextSlateEditor extends ReactEditor {
  */
 export declare function raise(
   event: SyntheticBehaviorEvent | CustomBehaviorEvent,
-): PickFromUnion<BehaviorActionIntend, 'type', 'raise'>
+): PickFromUnion<BehaviorAction, 'type', 'raise'>
 
 declare type Serializer<TMIMEType extends MIMEType> = ({
   snapshot,

package/lib/behaviors/index.d.ts

@@ -77,13 +77,13 @@ export declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-export declare type BehaviorActionIntend =
+export declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -100,7 +100,7 @@ export declare type BehaviorActionIntend =
 /**
  * @beta
  */
-export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+export declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -111,7 +111,7 @@ export declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta
@@ -19925,7 +19925,7 @@ declare interface PortableTextSlateEditor extends ReactEditor {
  */
 export declare function raise(
   event: SyntheticBehaviorEvent | CustomBehaviorEvent,
-): PickFromUnion<BehaviorActionIntend, 'type', 'raise'>
+): PickFromUnion<BehaviorAction, 'type', 'raise'>
 
 declare type Serializer<TMIMEType extends MIMEType> = ({
   snapshot,

package/lib/index.d.cts

@@ -120,13 +120,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -143,7 +143,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -154,7 +154,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/index.d.ts

@@ -120,13 +120,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -143,7 +143,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -154,7 +154,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/plugins/index.d.cts

@@ -75,13 +75,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -98,7 +98,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -109,7 +109,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/plugins/index.d.ts

@@ -75,13 +75,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -98,7 +98,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -109,7 +109,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/selectors/index.d.cts

@@ -76,13 +76,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -99,7 +99,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -110,7 +110,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/selectors/index.d.ts

@@ -76,13 +76,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -99,7 +99,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -110,7 +110,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/utils/index.d.cts

@@ -77,13 +77,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -100,7 +100,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -111,7 +111,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/lib/utils/index.d.ts

@@ -77,13 +77,13 @@ declare type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
  * @beta
  */
-declare type BehaviorActionIntend =
+declare type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -100,7 +100,7 @@ declare type BehaviorActionIntend =
 /**
  * @beta
  */
-declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+declare type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -111,7 +111,7 @@ declare type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.36.2",
+  "version": "1.36.4",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",

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

@@ -1,7 +1,7 @@
 import {deleteForward, insertText, Path, Transforms} from 'slate'
 import {ReactEditor} from 'slate-react'
 import type {
-  BehaviorAction,
+  InternalBehaviorAction,
   SyntheticBehaviorEvent,
 } from '../behaviors/behavior.types'
 import type {EditorContext} from '../editor/editor-snapshot'
@@ -55,18 +55,18 @@ export type BehaviorActionImplementationContext = Pick<
 >
 
 export type BehaviorActionImplementation<
-  TBehaviorActionType extends BehaviorAction['type'],
+  TBehaviorActionType extends InternalBehaviorAction['type'],
   TReturnType = void,
 > = ({
   context,
   action,
 }: {
   context: BehaviorActionImplementationContext
-  action: PickFromUnion<BehaviorAction, 'type', TBehaviorActionType>
+  action: PickFromUnion<InternalBehaviorAction, 'type', TBehaviorActionType>
 }) => TReturnType
 
 type BehaviorActionImplementations = {
-  [TBehaviorActionType in BehaviorAction['type']]: BehaviorActionImplementation<TBehaviorActionType>
+  [TBehaviorActionType in InternalBehaviorAction['type']]: BehaviorActionImplementation<TBehaviorActionType>
 }
 
 const behaviorActionImplementations: BehaviorActionImplementations = {
@@ -271,7 +271,7 @@ export function performAction({
   action,
 }: {
   context: BehaviorActionImplementationContext
-  action: BehaviorAction
+  action: InternalBehaviorAction
 }) {
   switch (action.type) {
     case 'noop': {
@@ -299,7 +299,11 @@ function performDefaultAction({
   action,
 }: {
   context: BehaviorActionImplementationContext
-  action: PickFromUnion<BehaviorAction, 'type', SyntheticBehaviorEvent['type']>
+  action: PickFromUnion<
+    InternalBehaviorAction,
+    'type',
+    SyntheticBehaviorEvent['type']
+  >
 }) {
   switch (action.type) {
     case 'annotation.add': {

package/src/behaviors/{behavior.foundational.ts → behavior.default.raise-soft-break.ts}

@@ -6,10 +6,8 @@ import {defineBehavior, raise} from './behavior.types'
  * than an `insertLineBreak` input event. This Behavior makes sure we catch
  * that `key.down` event beforehand and raise an `insert.soft break` manually.
  */
-const raiseSoftBreak = defineBehavior({
+export const raiseInsertSoftBreak = defineBehavior({
   on: 'key.down',
   guard: ({event}) => keyIs.lineBreak(event.keyboardEvent),
   actions: [() => [raise({type: 'insert.soft break'})]],
 })
-
-export const foundationalBehaviors = [raiseSoftBreak]

package/src/behaviors/behavior.default.ts

@@ -1,4 +1,5 @@
 import * as selectors from '../selectors'
+import {raiseInsertSoftBreak} from './behavior.default.raise-soft-break'
 import {defineBehavior, raise} from './behavior.types'
 
 const toggleAnnotationOff = defineBehavior({
@@ -200,4 +201,5 @@ export const defaultBehaviors = [
   raiseInsertBlocks,
   raiseSerializationSuccessOrFailure,
   raiseDataTransferSet,
+  raiseInsertSoftBreak,
 ]

package/src/behaviors/behavior.types.ts

@@ -261,7 +261,7 @@ export function isCustomBehaviorEvent(
 /**
  * @beta
  */
-export type BehaviorActionIntend =
+export type BehaviorAction =
   | SyntheticBehaviorEvent
   | {
       type: 'raise'
@@ -275,11 +275,8 @@ export type BehaviorActionIntend =
       effect: () => void
     }
 
-/**
- * @beta
- */
-export type BehaviorAction = OmitFromUnion<
-  BehaviorActionIntend,
+export type InternalBehaviorAction = OmitFromUnion<
+  BehaviorAction,
   'type',
   'raise'
 > & {
@@ -291,7 +288,7 @@ export type BehaviorAction = OmitFromUnion<
  */
 export function raise(
   event: SyntheticBehaviorEvent | CustomBehaviorEvent,
-): PickFromUnion<BehaviorActionIntend, 'type', 'raise'> {
+): PickFromUnion<BehaviorAction, 'type', 'raise'> {
   return {type: 'raise', event}
 }
 
@@ -327,7 +324,7 @@ export type Behavior<
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse>>
+  actions: Array<BehaviorActionSet<TBehaviorEvent, TGuardResponse>>
 }
 
 /**
@@ -346,7 +343,7 @@ export type BehaviorGuard<TBehaviorEvent, TGuardResponse> = (payload: {
 /**
  * @beta
  */
-export type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
+export type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   payload: {
     /**
      * @deprecated
@@ -357,7 +354,7 @@ export type BehaviorActionIntendSet<TBehaviorEvent, TGuardResponse> = (
     event: TBehaviorEvent
   },
   guardResponse: TGuardResponse,
-) => Array<BehaviorActionIntend>
+) => Array<BehaviorAction>
 
 /**
  * @beta

package/src/behaviors/index.ts

@@ -16,8 +16,8 @@ export {
   defineBehavior,
   raise,
   type Behavior,
-  type BehaviorActionIntend,
-  type BehaviorActionIntendSet,
+  type BehaviorAction,
+  type BehaviorActionSet,
   type BehaviorEvent,
   type BehaviorGuard,
   type CustomBehaviorEvent,

package/src/editor/editor-machine.ts

@@ -12,12 +12,11 @@ import {
 import {performAction} from '../behavior-actions/behavior.actions'
 import {coreBehaviors} from '../behaviors/behavior.core'
 import {defaultBehaviors} from '../behaviors/behavior.default'
-import {foundationalBehaviors} from '../behaviors/behavior.foundational'
 import {
   isCustomBehaviorEvent,
   type Behavior,
-  type BehaviorAction,
   type CustomBehaviorEvent,
+  type InternalBehaviorAction,
   type NativeBehaviorEvent,
   type SyntheticBehaviorEvent,
 } from '../behaviors/behavior.types'
@@ -31,8 +30,8 @@ import type {
 import type {EditorSchema} from './define-schema'
 import {createEditorSnapshot} from './editor-snapshot'
 import {
-  withApplyingBehaviorActionIntendSet,
   withApplyingBehaviorActions,
+  withApplyingBehaviorActionSet,
 } from './with-applying-behavior-actions'
 
 export * from 'xstate/guards'
@@ -324,14 +323,13 @@ export const editorMachine = setup({
             : ({
                 ...event.behaviorEvent,
                 editor: event.editor,
-              } satisfies BehaviorAction)
+              } satisfies InternalBehaviorAction)
         const defaultActionCallback =
           event.type === 'behavior event'
             ? event.defaultActionCallback
             : undefined
 
         const eventBehaviors = [
-          ...foundationalBehaviors,
           ...context.behaviors.values(),
           ...defaultBehaviors,
         ].filter(
@@ -400,7 +398,7 @@ export const editorMachine = setup({
             continue
           }
 
-          const actionIntendSets = eventBehavior.actions.map((actionSet) =>
+          const actionSets = eventBehavior.actions.map((actionSet) =>
             actionSet(
               {
                 context: editorSnapshot.context,
@@ -411,44 +409,42 @@ export const editorMachine = setup({
             ),
           )
 
-          for (const actionIntends of actionIntendSets) {
+          for (const actionSet of actionSets) {
             behaviorOverwritten =
               behaviorOverwritten ||
-              (actionIntends.length > 0 &&
-                actionIntends.some(
-                  (actionIntend) => actionIntend.type !== 'effect',
-                ))
-
-            withApplyingBehaviorActionIntendSet(event.editor, () => {
-              for (const actionIntend of actionIntends) {
-                if (actionIntend.type === 'raise') {
-                  if (isCustomBehaviorEvent(actionIntend.event)) {
+              (actionSet.length > 0 &&
+                actionSet.some((action) => action.type !== 'effect'))
+
+            withApplyingBehaviorActionSet(event.editor, () => {
+              for (const action of actionSet) {
+                if (action.type === 'raise') {
+                  if (isCustomBehaviorEvent(action.event)) {
                     enqueue.raise({
                       type: 'custom behavior event',
-                      behaviorEvent: actionIntend.event as CustomBehaviorEvent,
+                      behaviorEvent: action.event as CustomBehaviorEvent,
                       editor: event.editor,
                     })
                   } else {
                     enqueue.raise({
                       type: 'behavior event',
-                      behaviorEvent: actionIntend.event,
+                      behaviorEvent: action.event,
                       editor: event.editor,
                     })
                   }
                   continue
                 }
 
-                const action = {
-                  ...actionIntend,
+                const internalAction = {
+                  ...action,
                   editor: event.editor,
                 }
 
                 try {
-                  performAction({context, action})
+                  performAction({context, action: internalAction})
                 } catch (error) {
                   console.error(
                     new Error(
-                      `Performing action "${action.type}" as a result of "${event.behaviorEvent.type}" failed due to: ${error.message}`,
+                      `Performing action "${internalAction.type}" as a result of "${event.behaviorEvent.type}" failed due to: ${error.message}`,
                     ),
                   )
                   break

package/src/editor/plugins/createWithUndoRedo.ts

@@ -80,8 +80,7 @@ export function createWithUndoRedo(
       blockSchemaType.name,
     )
     const remotePatches = getRemotePatches(editor)
-    let previousBehaviorActionIntendSetId =
-      getCurrentBehaviorActionSetId(editor)
+    let previousBehaviorActionSetId = getCurrentBehaviorActionSetId(editor)
 
     options.subscriptions.push(() => {
       debug('Subscribing to patches')
@@ -151,17 +150,15 @@ export function createWithUndoRedo(
       const overwrite = shouldOverwrite(op, lastOp)
       const save = isSaving(editor)
 
-      const currentBehaviorActionIntendSetId =
-        getCurrentBehaviorActionSetId(editor)
+      const currentBehaviorActionSetId = getCurrentBehaviorActionSetId(editor)
 
       let merge =
-        currentBehaviorActionIntendSetId !== undefined &&
-        previousBehaviorActionIntendSetId === undefined
+        currentBehaviorActionSetId !== undefined &&
+        previousBehaviorActionSetId === undefined
           ? false
-          : currentBehaviorActionIntendSetId !== undefined &&
-              previousBehaviorActionIntendSetId !== undefined
-            ? currentBehaviorActionIntendSetId ===
-              previousBehaviorActionIntendSetId
+          : currentBehaviorActionSetId !== undefined &&
+              previousBehaviorActionSetId !== undefined
+            ? currentBehaviorActionSetId === previousBehaviorActionSetId
             : true
 
       if (save) {
@@ -169,8 +166,8 @@ export function createWithUndoRedo(
           merge = false
         } else if (operations.length === 0) {
           merge =
-            currentBehaviorActionIntendSetId === undefined &&
-            previousBehaviorActionIntendSetId === undefined
+            currentBehaviorActionSetId === undefined &&
+            previousBehaviorActionSetId === undefined
               ? shouldMerge(op, lastOp) || overwrite
               : merge
         }
@@ -200,7 +197,7 @@ export function createWithUndoRedo(
         }
       }
 
-      previousBehaviorActionIntendSetId = currentBehaviorActionIntendSetId
+      previousBehaviorActionSetId = currentBehaviorActionSetId
 
       apply(op)
     }