fix: make sure a subsequent empty action set can't trigger a default action

packages/editor/README.md

@@ -21,7 +21,7 @@ In order to provide a robust and consistent end-user experience, the editor is b
 > [!WARNING]
 > The `@portabletext/editor` is currently on the path to deprecate legacy APIs and introduce new ones. The end goals are to make the editor easier to use outside of `Sanity` (and without `@sanity/*` libraries) as well as providing a brand new API to configure the behavior of the editor.
 >
-> This means that the `defineSchema` and `useEditor` APIs showcased here are still experimental APIs tagged with `@alpha` and cannot be considered stable yet. At the same time, the examples below showcase usages of legacy static methods on the `PortableTextEditor` (for example, `PortableTextEditor.isMarkActive(...)` and `PortableTextEditor.toggleMark(...)`) that will soon be discouraged and deprecrated.
+> This means that the `defineSchema` and `EditorProvider` APIs showcased here are still experimental APIs tagged with `@alpha` and cannot be considered stable yet. At the same time, the examples below showcase usages of legacy static methods on the `PortableTextEditor` (for example, `PortableTextEditor.isMarkActive(...)` and `PortableTextEditor.toggleMark(...)`) that will soon be discouraged and deprecrated.
 
 Check [/examples/basic/src/App.tsx](/examples/basic/src/App.tsx) for a basic example of how to set up the edior. Most of the source code from this example app can also be found in the instructions below.
 
@@ -369,3 +369,12 @@ function Toolbar() {
   )
 }
 ```
+
+## Behavior API (Coming Soon)
+
+The Behavior API is a new way of interfacing with the Portable Text Editor. It allows you to think of and treat the editor as a state machine by:
+
+1. Declaratively hooking into editor **events** and defining new behaviors using `defineBehavior`. (A "Behavior" (1) listens for an **event**, (2) uses a **guard** to determine whether it should run and (3) raises a set of **actions** to be performed on the editor.)
+2. Imperatively trigger **events** using `editor.send(…)` which in turn can trigger behaviors defined using `defineBehavior`.
+3. Deriving editor **state** using **pure functions**.
+4. Subscribe to **emitted** editor **events** using `editor.on(…)`.

packages/editor/src/editor/behavior/behavior.action.insert-break.ts

@@ -1,9 +1,9 @@
 import {isEqual} from 'lodash'
 import {Editor, Node, Path, Range, Transforms} from 'slate'
 import type {SlateTextBlock, VoidElement} from '../../types/slate'
-import type {BehaviourActionImplementation} from './behavior.actions'
+import type {BehaviorActionImplementation} from './behavior.actions'
 
-export const insertBreakActionImplementation: BehaviourActionImplementation<
+export const insertBreakActionImplementation: BehaviorActionImplementation<
   'insert break'
 > = ({context, action}) => {
   const keyGenerator = context.keyGenerator
@@ -204,7 +204,7 @@ export const insertBreakActionImplementation: BehaviourActionImplementation<
   }
 }
 
-export const insertSoftBreakActionImplementation: BehaviourActionImplementation<
+export const insertSoftBreakActionImplementation: BehaviorActionImplementation<
   'insert soft break'
 > = ({context, action}) => {
   // This mimics Slate's internal which also just does a regular insert break

packages/editor/src/editor/behavior/behavior.action.insert-span.ts

@@ -1,7 +1,7 @@
 import {Editor, Transforms} from 'slate'
-import type {BehaviourActionImplementation} from './behavior.actions'
+import type {BehaviorActionImplementation} from './behavior.actions'
 
-export const insertSpanActionImplementation: BehaviourActionImplementation<
+export const insertSpanActionImplementation: BehaviorActionImplementation<
   'insert span'
 > = ({context, action}) => {
   if (!action.editor.selection) {

packages/editor/src/editor/behavior/behavior.actions.ts

@@ -35,7 +35,7 @@ export type BehaviorActionContext = {
   schema: PortableTextMemberSchemaTypes
 }
 
-export type BehaviourActionImplementation<
+export type BehaviorActionImplementation<
   TBehaviorActionType extends BehaviorAction['type'],
   TReturnType = void,
 > = ({
@@ -46,11 +46,11 @@ export type BehaviourActionImplementation<
   action: PickFromUnion<BehaviorAction, 'type', TBehaviorActionType>
 }) => TReturnType
 
-type BehaviourActionImplementations = {
-  [TBehaviorActionType in BehaviorAction['type']]: BehaviourActionImplementation<TBehaviorActionType>
+type BehaviorActionImplementations = {
+  [TBehaviorActionType in BehaviorAction['type']]: BehaviorActionImplementation<TBehaviorActionType>
 }
 
-const behaviorActionImplementations: BehaviourActionImplementations = {
+const behaviorActionImplementations: BehaviorActionImplementations = {
   'annotation.add': addAnnotationActionImplementation,
   'annotation.remove': removeAnnotationActionImplementation,
   'annotation.toggle': toggleAnnotationActionImplementation,

packages/editor/src/editor/editor-machine.ts

@@ -289,8 +289,11 @@ export const editorMachine = setup({
 
         for (const actionIntends of actionIntendSets) {
           behaviorOverwritten =
-            actionIntends.length > 0 &&
-            actionIntends.some((actionIntend) => actionIntend.type !== 'effect')
+            behaviorOverwritten ||
+            (actionIntends.length > 0 &&
+              actionIntends.some(
+                (actionIntend) => actionIntend.type !== 'effect',
+              ))
 
           enqueue.raise({
             type: 'behavior action intends',

packages/editor/src/editor/plugins/createWithEditableAPI.ts

@@ -35,7 +35,7 @@ import {
   KEY_TO_VALUE_ELEMENT,
   SLATE_TO_PORTABLE_TEXT_RANGE,
 } from '../../utils/weakMaps'
-import type {BehaviourActionImplementation} from '../behavior/behavior.actions'
+import type {BehaviorActionImplementation} from '../behavior/behavior.actions'
 import type {EditorActor} from '../editor-machine'
 import {isDecoratorActive} from './createWithPortableTextMarkModel'
 
@@ -487,7 +487,7 @@ export function createEditableAPI(
   return editableApi
 }
 
-export const insertBlockObjectActionImplementation: BehaviourActionImplementation<
+export const insertBlockObjectActionImplementation: BehaviorActionImplementation<
   'insert block object',
   Path
 > = ({context, action}) => {
@@ -640,7 +640,7 @@ export type AddedAnnotationPaths = {
   spanPath: Path
 }
 
-export const addAnnotationActionImplementation: BehaviourActionImplementation<
+export const addAnnotationActionImplementation: BehaviorActionImplementation<
   'annotation.add',
   AddedAnnotationPaths | undefined
 > = ({context, action}) => {
@@ -761,7 +761,7 @@ export const addAnnotationActionImplementation: BehaviourActionImplementation<
   return paths
 }
 
-export const removeAnnotationActionImplementation: BehaviourActionImplementation<
+export const removeAnnotationActionImplementation: BehaviorActionImplementation<
   'annotation.remove'
 > = ({action}) => {
   const editor = action.editor
@@ -910,7 +910,7 @@ export const removeAnnotationActionImplementation: BehaviourActionImplementation
   }
 }
 
-export const toggleAnnotationActionImplementation: BehaviourActionImplementation<
+export const toggleAnnotationActionImplementation: BehaviorActionImplementation<
   'annotation.toggle',
   AddedAnnotationPaths | undefined
 > = ({context, action}) => {

packages/editor/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -16,7 +16,7 @@ import {debugWithName} from '../../utils/debug'
 import {getNextSpan, getPreviousSpan} from '../../utils/sibling-utils'
 import {isChangingRemotely} from '../../utils/withChanges'
 import {isRedoing, isUndoing} from '../../utils/withUndoRedo'
-import type {BehaviourActionImplementation} from '../behavior/behavior.actions'
+import type {BehaviorActionImplementation} from '../behavior/behavior.actions'
 import type {EditorActor} from '../editor-machine'
 
 const debug = debugWithName('plugin:withPortableTextMarkModel')
@@ -654,7 +654,7 @@ export function createWithPortableTextMarkModel(
   }
 }
 
-export const addDecoratorActionImplementation: BehaviourActionImplementation<
+export const addDecoratorActionImplementation: BehaviorActionImplementation<
   'decorator.add'
 > = ({action}) => {
   const editor = action.editor
@@ -745,7 +745,7 @@ export const addDecoratorActionImplementation: BehaviourActionImplementation<
   }
 }
 
-export const removeDecoratorActionImplementation: BehaviourActionImplementation<
+export const removeDecoratorActionImplementation: BehaviorActionImplementation<
   'decorator.remove'
 > = ({action}) => {
   const editor = action.editor
@@ -860,7 +860,7 @@ export function isDecoratorActive({
   ).includes(decorator)
 }
 
-export const toggleDecoratorActionImplementation: BehaviourActionImplementation<
+export const toggleDecoratorActionImplementation: BehaviorActionImplementation<
   'decorator.toggle'
 > = ({context, action}) => {
   const isActive = isDecoratorActive({