@portabletext/editor 1.11.0 → 1.11.2

package/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(…)`.

package/lib/index.esm.js

@@ -2559,8 +2559,10 @@ function createWithUndoRedo(options) {
       apply: apply2
     } = editor;
     return editor.apply = (op) => {
-      if (editorActor.getSnapshot().context.readOnly)
+      if (editorActor.getSnapshot().context.readOnly) {
+        apply2(op);
         return;
+      }
       if (isChangingRemotely(editor)) {
         apply2(op);
         return;
@@ -3419,8 +3421,10 @@ function createWithMaxBlocks(editorActor) {
       apply: apply2
     } = editor;
     return editor.apply = (operation) => {
-      if (editorActor.getSnapshot().context.readOnly)
+      if (editorActor.getSnapshot().context.readOnly) {
+        apply2(operation);
         return;
+      }
       if (isChangingRemotely(editor)) {
         apply2(operation);
         return;
@@ -3867,26 +3871,28 @@ function createWithPlaceholderBlock(editorActor) {
       apply: apply2
     } = editor;
     return editor.apply = (op) => {
-      if (!editorActor.getSnapshot().context.readOnly) {
-        if (isChangingRemotely(editor)) {
-          apply2(op);
-          return;
-        }
-        if (isUndoing(editor) || isRedoing(editor)) {
-          apply2(op);
-          return;
-        }
-        if (op.type === "remove_node") {
-          const node = op.node;
-          if (op.path[0] === 0 && Editor.isVoid(editor, node)) {
-            const nextPath = Path.next(op.path);
-            editor.children[nextPath[0]] || (debug$d("Adding placeholder block"), Editor.insertNode(editor, editor.pteCreateTextBlock({
-              decorators: []
-            })));
-          }
-        }
+      if (editorActor.getSnapshot().context.readOnly) {
         apply2(op);
+        return;
       }
+      if (isChangingRemotely(editor)) {
+        apply2(op);
+        return;
+      }
+      if (isUndoing(editor) || isRedoing(editor)) {
+        apply2(op);
+        return;
+      }
+      if (op.type === "remove_node") {
+        const node = op.node;
+        if (op.path[0] === 0 && Editor.isVoid(editor, node)) {
+          const nextPath = Path.next(op.path);
+          editor.children[nextPath[0]] || (debug$d("Adding placeholder block"), Editor.insertNode(editor, editor.pteCreateTextBlock({
+            decorators: []
+          })));
+        }
+      }
+      apply2(op);
     }, editor;
   };
 }
@@ -5738,7 +5744,7 @@ const editorMachine = setup({
           event: event.behaviorEvent
         }, shouldRun));
         for (const actionIntends of actionIntendSets)
-          behaviorOverwritten = actionIntends.length > 0 && actionIntends.some((actionIntend) => actionIntend.type !== "effect"), enqueue.raise({
+          behaviorOverwritten = behaviorOverwritten || actionIntends.length > 0 && actionIntends.some((actionIntend) => actionIntend.type !== "effect"), enqueue.raise({
             type: "behavior action intends",
             editor: event.editor,
             actionIntends