fix(behavior): add context/event back in `BehaviorActionIntendSet…

…` callback
portabletext · Dec 9, 2024 · af9e9e4 · af9e9e4
1 parent 8d9d669
commit af9e9e4
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 67 deletions.
diff --git a/packages/editor/src/editor/behavior/behavior.code-editor.ts b/packages/editor/src/editor/behavior/behavior.code-editor.ts
@@ -38,7 +38,7 @@ export function createCodeEditorBehaviors(config: CodeEditorBehaviorsConfig) {
         return {paths: selectedBlocks.map((block) => block.path)}
       },
       actions: [
-        ({paths}) =>
+        (_, {paths}) =>
           paths.map((at) => ({
             type: 'move.block up',
             at,
@@ -65,7 +65,7 @@ export function createCodeEditorBehaviors(config: CodeEditorBehaviorsConfig) {
         return {paths: selectedBlocks.map((block) => block.path).reverse()}
       },
       actions: [
-        ({paths}) =>
+        (_, {paths}) =>
           paths.map((at) => ({
             type: 'move.block down',
             at,

diff --git a/packages/editor/src/editor/behavior/behavior.core.block-objects.ts b/packages/editor/src/editor/behavior/behavior.core.block-objects.ts
@@ -71,7 +71,7 @@ const deletingEmptyTextBlockAfterBlockObject = defineBehavior({
     return false
   },
   actions: [
-    ({focusTextBlock, previousBlock}) => [
+    (_, {focusTextBlock, previousBlock}) => [
       {
         type: 'delete.block',
         blockPath: focusTextBlock.path,
@@ -108,7 +108,7 @@ const deletingEmptyTextBlockBeforeBlockObject = defineBehavior({
     return false
   },
   actions: [
-    ({focusTextBlock, nextBlock}) => [
+    (_, {focusTextBlock, nextBlock}) => [
       {
         type: 'delete.block',
         blockPath: focusTextBlock.path,

diff --git a/packages/editor/src/editor/behavior/behavior.core.decorators.ts b/packages/editor/src/editor/behavior/behavior.core.decorators.ts
@@ -2,13 +2,9 @@ import {defineBehavior} from './behavior.types'
 
 const decoratorAdd = defineBehavior({
   on: 'decorator.add',
-  guard: ({event}) => ({decorator: event.decorator}),
   actions: [
-    ({decorator}) => [
-      {
-        type: 'decorator.add',
-        decorator,
-      },
+    ({event}) => [
+      event,
       {
         type: 'reselect',
       },
@@ -20,11 +16,8 @@ const decoratorRemove = defineBehavior({
   on: 'decorator.remove',
   guard: ({event}) => ({decorator: event.decorator}),
   actions: [
-    ({decorator}) => [
-      {
-        type: 'decorator.remove',
-        decorator,
-      },
+    ({event}) => [
+      event,
       {
         type: 'reselect',
       },
@@ -36,11 +29,8 @@ const decoratorToggle = defineBehavior({
   on: 'decorator.toggle',
   guard: ({event}) => ({decorator: event.decorator}),
   actions: [
-    ({decorator}) => [
-      {
-        type: 'decorator.toggle',
-        decorator,
-      },
+    ({event}) => [
+      event,
       {
         type: 'reselect',
       },

diff --git a/packages/editor/src/editor/behavior/behavior.core.lists.ts b/packages/editor/src/editor/behavior/behavior.core.lists.ts
@@ -34,7 +34,7 @@ const clearListOnBackspace = defineBehavior({
     return false
   },
   actions: [
-    ({focusTextBlock}) => [
+    (_, {focusTextBlock}) => [
       {
         type: 'text block.unset',
         props: ['listItem', 'level'],
@@ -70,7 +70,7 @@ const unindentListOnBackspace = defineBehavior({
     return false
   },
   actions: [
-    ({focusTextBlock, level}) => [
+    (_, {focusTextBlock, level}) => [
       {
         type: 'text block.set',
         level,
@@ -97,7 +97,7 @@ const clearListOnEnter = defineBehavior({
     return {focusListBlock}
   },
   actions: [
-    ({focusListBlock}) => [
+    (_, {focusListBlock}) => [
       {
         type: 'text block.unset',
         props: ['listItem', 'level'],
@@ -136,7 +136,7 @@ const indentListOnTab = defineBehavior({
     return false
   },
   actions: [
-    ({selectedListBlocks}) =>
+    (_, {selectedListBlocks}) =>
       selectedListBlocks.map((selectedListBlock) => ({
         type: 'text block.set',
         level: Math.min(
@@ -177,7 +177,7 @@ const unindentListOnShiftTab = defineBehavior({
     return false
   },
   actions: [
-    ({selectedListBlocks}) =>
+    (_, {selectedListBlocks}) =>
       selectedListBlocks.map((selectedListBlock) => ({
         type: 'text block.set',
         level: Math.min(

diff --git a/packages/editor/src/editor/behavior/behavior.links.ts b/packages/editor/src/editor/behavior/behavior.links.ts
@@ -34,7 +34,7 @@ export function createLinkBehaviors(config: LinkBehaviorsConfig) {
       return false
     },
     actions: [
-      ({annotation}) => [
+      (_, {annotation}) => [
         {
           type: 'annotation.add',
           annotation,
@@ -66,7 +66,7 @@ export function createLinkBehaviors(config: LinkBehaviorsConfig) {
       return false
     },
     actions: [
-      ({annotation, url}) => [
+      (_, {annotation, url}) => [
         {
           type: 'insert.span',
           text: url,

diff --git a/packages/editor/src/editor/behavior/behavior.markdown.ts b/packages/editor/src/editor/behavior/behavior.markdown.ts
@@ -95,7 +95,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
           text: ' ',
         },
       ],
-      ({focusTextBlock, style}) => [
+      (_, {focusTextBlock, style}) => [
         {
           type: 'text block.unset',
           props: ['listItem', 'level'],
@@ -163,13 +163,13 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({hrCharacter}) => [
+      (_, {hrCharacter}) => [
         {
           type: 'insert.text',
           text: hrCharacter,
         },
       ],
-      ({hrObject, hrBlockOffsets}) => [
+      (_, {hrObject, hrBlockOffsets}) => [
         {
           type: 'insert.block object',
           placement: 'before',
@@ -198,13 +198,13 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return {hrCharacters, hrObject, focusBlock}
     },
     actions: [
-      ({hrCharacters}) => [
+      (_, {hrCharacters}) => [
         {
           type: 'insert.text',
           text: hrCharacters,
         },
       ],
-      ({hrObject, focusBlock}) =>
+      (_, {hrObject, focusBlock}) =>
         isPortableTextTextBlock(focusBlock.node)
           ? [
               {
@@ -288,13 +288,8 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      () => [
-        {
-          type: 'insert.text',
-          text: ' ',
-        },
-      ],
-      ({focusTextBlock, style, level}) => [
+      ({event}) => [event],
+      (_, {focusTextBlock, style, level}) => [
         {
           type: 'text block.unset',
           props: ['listItem', 'level'],
@@ -347,7 +342,7 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      ({defaultStyle, focusTextBlock}) => [
+      (_, {defaultStyle, focusTextBlock}) => [
         {
           type: 'text block.set',
           style: defaultStyle,
@@ -430,13 +425,8 @@ export function createMarkdownBehaviors(config: MarkdownBehaviorsConfig) {
       return false
     },
     actions: [
-      () => [
-        {
-          type: 'insert.text',
-          text: ' ',
-        },
-      ],
-      ({focusTextBlock, style, listItem, listItemLength}) => [
+      ({event}) => [event],
+      (_, {focusTextBlock, style, listItem, listItemLength}) => [
         {
           type: 'text block.set',
           listItem,

diff --git a/packages/editor/src/editor/behavior/behavior.types.ts b/packages/editor/src/editor/behavior/behavior.types.ts
@@ -116,20 +116,6 @@ export type NativeBehaviorEvent =
       data: DataTransfer
     }
 
-/**
- * @alpha
- */
-export type BehaviorGuard<
-  TAnyBehaviorEvent extends BehaviorEvent,
-  TGuardResponse,
-> = ({
-  context,
-  event,
-}: {
-  context: EditorContext
-  event: TAnyBehaviorEvent
-}) => TGuardResponse | false
-
 /**
  * @alpha
  */
@@ -238,32 +224,56 @@ export type BehaviorEvent = SyntheticBehaviorEvent | NativeBehaviorEvent
  * @alpha
  */
 export type Behavior<
-  TAnyBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
   TGuardResponse = true,
 > = {
   /**
    * The internal editor event that triggers this behavior.
    */
-  on: TAnyBehaviorEventType
+  on: TBehaviorEventType
   /**
    * 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', TAnyBehaviorEventType>,
+    PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>,
     TGuardResponse
   >
   /**
    * Array of behavior action sets.
    */
-  actions: Array<BehaviorActionIntendSet<TGuardResponse>>
+  actions: Array<BehaviorActionIntendSet<TBehaviorEventType, TGuardResponse>>
 }
 
 /**
  * @alpha
  */
-export type BehaviorActionIntendSet<TGuardResponse = true> = (
+export type BehaviorGuard<
+  TBehaviorEvent extends BehaviorEvent,
+  TGuardResponse,
+> = ({
+  context,
+  event,
+}: {
+  context: EditorContext
+  event: TBehaviorEvent
+}) => TGuardResponse | false
+
+/**
+ * @alpha
+ */
+export type BehaviorActionIntendSet<
+  TBehaviorEventType extends BehaviorEvent['type'] = BehaviorEvent['type'],
+  TGuardResponse = true,
+> = (
+  {
+    context,
+    event,
+  }: {
+    context: EditorContext
+    event: PickFromUnion<BehaviorEvent, 'type', TBehaviorEventType>
+  },
   guardResponse: TGuardResponse,
 ) => Array<BehaviorActionIntend>
 

diff --git a/packages/editor/src/editor/editor-machine.ts b/packages/editor/src/editor/editor-machine.ts
@@ -315,7 +315,10 @@ export const editorMachine = setup({
         }
 
         const actionIntendSets = eventBehavior.actions.map((actionSet) =>
-          actionSet(shouldRun),
+          actionSet(
+            {context: editorContext, event: event.behaviorEvent},
+            shouldRun,
+          ),
         )
 
         for (const actionIntends of actionIntendSets) {