@portabletext/editor 1.45.4 → 1.46.0

package/src/behaviors/behavior.markdown.ts

@@ -3,7 +3,7 @@ import type {EditorSchema} from '../editor/define-schema'
 import * as selectors from '../selectors'
 import {spanSelectionPointToBlockOffset} from '../utils/util.block-offset'
 import {getTextBlockText} from '../utils/util.get-text-block-text'
-import {raise} from './behavior.types.action'
+import {execute} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
 /**
@@ -120,23 +120,23 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
     },
     actions: [
       () => [
-        {
+        execute({
           type: 'insert.text',
           text: ' ',
-        },
+        }),
       ],
       (_, {focusTextBlock, style}) => [
-        {
+        execute({
           type: 'block.unset',
           props: ['listItem', 'level'],
           at: focusTextBlock.path,
-        },
-        {
+        }),
+        execute({
           type: 'block.set',
           props: {style},
           at: focusTextBlock.path,
-        },
-        raise({
+        }),
+        execute({
           type: 'delete.text',
           at: {
             anchor: {
@@ -200,21 +200,21 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
     },
     actions: [
       (_, {hrCharacter}) => [
-        {
+        execute({
           type: 'insert.text',
           text: hrCharacter,
-        },
+        }),
       ],
       (_, {hrObject, hrBlockOffsets}) => [
-        {
+        execute({
           type: 'insert.block',
           placement: 'before',
           block: {
             _type: hrObject.name,
             ...(hrObject.value ?? {}),
           },
-        },
-        raise({
+        }),
+        execute({
           type: 'delete.text',
           at: hrBlockOffsets,
         }),
@@ -238,41 +238,44 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
     },
     actions: [
       (_, {hrCharacters}) => [
-        {
+        execute({
           type: 'insert.text',
           text: hrCharacters,
-        },
+        }),
       ],
       ({snapshot}, {hrObject, focusBlock}) =>
         isPortableTextTextBlock(focusBlock.node)
           ? [
-              {
+              execute({
                 type: 'insert.block',
                 block: {
                   _type: snapshot.context.schema.block.name,
                   children: focusBlock.node.children,
                 },
                 placement: 'after',
-              },
-              {
+              }),
+              execute({
                 type: 'insert.block',
                 block: {
                   _type: hrObject.name,
                   ...(hrObject.value ?? {}),
                 },
                 placement: 'after',
-              },
-              {type: 'delete.block', at: focusBlock.path},
+              }),
+              execute({
+                type: 'delete.block',
+                at: focusBlock.path,
+              }),
             ]
           : [
-              {
+              execute({
                 type: 'insert.block',
                 block: {
                   _type: hrObject.name,
                   ...(hrObject.value ?? {}),
                 },
                 placement: 'after',
-              },
+              }),
             ],
     ],
   })
@@ -337,19 +340,19 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({event}) => [event],
+      ({event}) => [execute(event)],
       (_, {focusTextBlock, style, level}) => [
-        {
+        execute({
           type: 'block.unset',
           props: ['listItem', 'level'],
           at: focusTextBlock.path,
-        },
-        {
+        }),
+        execute({
           type: 'block.set',
           props: {style},
           at: focusTextBlock.path,
-        },
-        raise({
+        }),
+        execute({
           type: 'delete.text',
           at: {
             anchor: {
@@ -394,11 +397,11 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
     },
     actions: [
       (_, {defaultStyle, focusTextBlock}) => [
-        {
+        execute({
           type: 'block.set',
           props: {style: defaultStyle},
           at: focusTextBlock.path,
-        },
+        }),
       ],
     ],
   })
@@ -477,9 +480,9 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({event}) => [event],
+      ({event}) => [execute(event)],
       (_, {focusTextBlock, style, listItem, listItemLength}) => [
-        {
+        execute({
           type: 'block.set',
           props: {
             listItem,
@@ -487,8 +490,8 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
             style,
           },
           at: focusTextBlock.path,
-        },
-        raise({
+        }),
+        execute({
           type: 'delete.text',
           at: {
             anchor: {

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

@@ -8,6 +8,7 @@ import {
 } from '../editor/with-applying-behavior-actions'
 import {debugWithName} from '../internal-utils/debug'
 import type {PortableTextSlateEditor} from '../types/editor'
+import {defaultBehaviors} from './behavior.default'
 import type {InternalBehaviorAction} from './behavior.types.action'
 import {
   isAbstractBehaviorEvent,
@@ -28,6 +29,7 @@ function eventCategory(event: BehaviorEvent) {
 }
 
 export function performEvent({
+  mode,
   behaviors,
   event,
   editor,
@@ -37,6 +39,7 @@ export function performEvent({
   nativeEvent,
   defaultActionCallback,
 }: {
+  mode: 'raise' | 'execute'
   behaviors: Array<Behavior>
   event: BehaviorEvent
   editor: PortableTextSlateEditor
@@ -62,7 +65,9 @@ export function performEvent({
           editor,
         } satisfies InternalBehaviorAction)
 
-  const eventBehaviors = behaviors.filter((behavior) => {
+  const eventBehaviors = (
+    mode === 'raise' ? [...behaviors, ...defaultBehaviors] : behaviors
+  ).filter((behavior) => {
     // Catches all events
     if (behavior.on === '*') {
       return true
@@ -179,7 +184,13 @@ export function performEvent({
         for (const action of actions) {
           if (action.type === 'raise') {
             performEvent({
-              behaviors,
+              mode,
+              behaviors:
+                mode === 'execute'
+                  ? isCustomBehaviorEvent(action.event)
+                    ? [...behaviors, ...defaultBehaviors]
+                    : defaultBehaviors
+                  : [...behaviors, ...defaultBehaviors],
               event: action.event,
               editor,
               keyGenerator,
@@ -192,6 +203,46 @@ export function performEvent({
             continue
           }
 
+          if (action.type === 'execute') {
+            if (
+              isAbstractBehaviorEvent(action.event) ||
+              isCustomBehaviorEvent(action.event)
+            ) {
+              performEvent({
+                mode: 'execute',
+                behaviors: isCustomBehaviorEvent(action.event)
+                  ? [...behaviors, ...defaultBehaviors]
+                  : defaultBehaviors,
+                event: action.event,
+                editor,
+                keyGenerator,
+                schema,
+                getSnapshot,
+                defaultActionCallback: undefined,
+                nativeEvent: undefined,
+              })
+            } else {
+              try {
+                performAction({
+                  context: {
+                    keyGenerator,
+                    schema,
+                  },
+                  action: {...action.event, editor},
+                })
+              } catch (error) {
+                console.error(
+                  new Error(
+                    `Performing action "${action.event.type}" as a result of "${event.type}" failed due to: ${error.message}`,
+                  ),
+                )
+                break
+              }
+            }
+
+            continue
+          }
+
           const internalAction = {
             ...action,
             editor,

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

@@ -1,5 +1,5 @@
 import type {EditorSnapshot} from '../editor/editor-snapshot'
-import type {OmitFromUnion, PickFromUnion} from '../type-utils'
+import type {PickFromUnion} from '../type-utils'
 import type {PortableTextSlateEditor} from '../types/editor'
 import type {
   AbstractBehaviorEvent,
@@ -11,7 +11,13 @@ import type {
  * @beta
  */
 export type BehaviorAction =
-  | SyntheticBehaviorEvent
+  | {
+      type: 'execute'
+      event:
+        | AbstractBehaviorEvent
+        | SyntheticBehaviorEvent
+        | CustomBehaviorEvent
+    }
   | {
       type: 'raise'
       event:
@@ -27,6 +33,15 @@ export type BehaviorAction =
       effect: () => void
     }
 
+/**
+ * @beta
+ */
+export function execute(
+  event: AbstractBehaviorEvent | SyntheticBehaviorEvent | CustomBehaviorEvent,
+): PickFromUnion<BehaviorAction, 'type', 'execute'> {
+  return {type: 'execute', event}
+}
+
 /**
  * @beta
  */
@@ -36,6 +51,22 @@ export function raise(
   return {type: 'raise', event}
 }
 
+/**
+ * @beta
+ */
+export function effect(
+  effect: () => void,
+): PickFromUnion<BehaviorAction, 'type', 'effect'> {
+  return {type: 'effect', effect}
+}
+
+/**
+ * @beta
+ */
+export function noop(): PickFromUnion<BehaviorAction, 'type', 'noop'> {
+  return {type: 'noop'}
+}
+
 /**
  * @beta
  */
@@ -47,10 +78,10 @@ export type BehaviorActionSet<TBehaviorEvent, TGuardResponse> = (
   guardResponse: TGuardResponse,
 ) => Array<BehaviorAction>
 
-export type InternalBehaviorAction = OmitFromUnion<
-  BehaviorAction,
-  'type',
-  'raise'
-> & {
+export type InternalBehaviorAction = (
+  | SyntheticBehaviorEvent
+  | {type: 'noop'}
+  | {type: 'effect'; effect: () => void}
+) & {
   editor: PortableTextSlateEditor
 }

package/src/behaviors/index.ts

@@ -14,7 +14,10 @@ export {
 } from './behavior.markdown'
 
 export {
+  execute,
+  noop,
   raise,
+  effect,
   type BehaviorAction,
   type BehaviorActionSet,
 } from './behavior.types.action'

package/src/editor/editor-machine.ts

@@ -10,7 +10,6 @@ import {
   type ActorRefFrom,
 } from 'xstate'
 import {coreBehaviors} from '../behaviors/behavior.core'
-import {defaultBehaviors} from '../behaviors/behavior.default'
 import {performEvent} from '../behaviors/behavior.perform-event'
 import type {Behavior} from '../behaviors/behavior.types.behavior'
 import type {BehaviorEvent} from '../behaviors/behavior.types.event'
@@ -297,7 +296,8 @@ export const editorMachine = setup({
       assertEvent(event, ['behavior event'])
 
       performEvent({
-        behaviors: [...context.behaviors.values(), ...defaultBehaviors],
+        mode: 'raise',
+        behaviors: [...context.behaviors.values()],
         event: event.behaviorEvent,
         editor: event.editor,
         keyGenerator: context.keyGenerator,

package/src/plugins/plugin.decorator-shortcut.ts

@@ -8,6 +8,7 @@ import {
   type CallbackLogicFunction,
 } from 'xstate'
 import {createDecoratorPairBehavior} from '../behaviors/behavior.decorator-pair'
+import {effect, execute} from '../behaviors/behavior.types.action'
 import {defineBehavior} from '../behaviors/behavior.types.behavior'
 import type {Editor} from '../editor/create-editor'
 import type {EditorSchema} from '../editor/define-schema'
@@ -132,15 +133,12 @@ const deleteBackwardListenerCallback: CallbackLogicFunction<
       on: 'delete.backward',
       actions: [
         () => [
-          {
+          execute({
             type: 'history.undo',
-          },
-          {
-            type: 'effect',
-            effect: () => {
-              sendBack({type: 'delete.backward'})
-            },
-          },
+          }),
+          effect(() => {
+            sendBack({type: 'delete.backward'})
+          }),
         ],
       ],
     }),

package/src/plugins/plugin.one-line.tsx

@@ -1,4 +1,4 @@
-import {defineBehavior, raise} from '../behaviors'
+import {defineBehavior, execute, raise} from '../behaviors'
 import * as selectors from '../selectors'
 import * as utils from '../utils'
 import {BehaviorPlugin} from './plugin.behavior'
@@ -14,7 +14,7 @@ const oneLineBehaviors = [
       snapshot.context.selection && selectors.isSelectionExpanded(snapshot)
         ? {selection: snapshot.context.selection}
         : false,
-    actions: [(_, {selection}) => [{type: 'delete', at: selection}]],
+    actions: [(_, {selection}) => [execute({type: 'delete', at: selection})]],
   }),
   /**
    * All other cases of `insert.break` should be aborted.
@@ -59,12 +59,12 @@ const oneLineBehaviors = [
     },
     actions: [
       ({event}) => [
-        {
+        execute({
           type: 'insert.block',
           block: event.block,
           placement: 'auto',
           select: 'end',
-        },
+        }),
       ],
     ],
   }),