@portabletext/editor 2.18.1 → 2.19.0

package/README.md

@@ -435,6 +435,13 @@ This monorepo also contains additional libraries that can be used with the Porta
 - 💻 [./packages/keyboard-shortcuts](./packages/keyboard-shortcuts/)
 - 📦 [@portabletext/keyboard-shortcuts](https://www.npmjs.com/package/@portabletext/keyboard-shortcuts)
 
+### `@portabletext/test`
+
+> Testing utilities for the Portable Text Editor
+
+- 💻 [./packages/test](./packages/test/)
+- 📦 [@portabletext/test](https://www.npmjs.com/package/@portabletext/test)
+
 ### `@portabletext/toolbar`
 
 > Powered by [Behaviors](https://www.portabletext.org/concepts/behavior/) and [State Machines](https://stately.ai/docs/xstate), `@portabletext/toolbar` is a collection of robust React hooks for building toolbars and related UI components

package/lib/_chunks-dts/index.d.ts

@@ -1,17 +1,17 @@
 import * as _sanity_types5 from "@sanity/types";
 import { ArrayDefinition, ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, Path, PortableTextBlock, PortableTextBlock as PortableTextBlock$1, PortableTextChild, PortableTextChild as PortableTextChild$1, PortableTextListBlock, PortableTextObject, PortableTextObject as PortableTextObject$2, PortableTextSpan, PortableTextSpan as PortableTextSpan$2, PortableTextTextBlock, PortableTextTextBlock as PortableTextTextBlock$2, TypedObject } from "@sanity/types";
 import { BaseRange, Descendant, Operation } from "slate";
-import * as xstate243 from "xstate";
+import * as xstate229 from "xstate";
 import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
-import * as react11 from "react";
+import * as react20 from "react";
 import React$1, { BaseSyntheticEvent, ClipboardEvent, Component, FocusEvent, JSX, KeyboardEvent as KeyboardEvent$1, MutableRefObject, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
 import { Patch, Patch as Patch$1 } from "@portabletext/patches";
-import * as _portabletext_schema6 from "@portabletext/schema";
+import * as _portabletext_schema5 from "@portabletext/schema";
 import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObjectDefinition, BlockObjectSchemaType, DecoratorDefinition, DecoratorSchemaType, FieldDefinition, InlineObjectDefinition, InlineObjectSchemaType, ListDefinition, ListSchemaType, PortableTextObject as PortableTextObject$1, PortableTextSpan as PortableTextSpan$1, PortableTextTextBlock as PortableTextTextBlock$1, Schema, SchemaDefinition, SchemaDefinition as SchemaDefinition$1, StyleDefinition, StyleSchemaType, defineSchema } from "@portabletext/schema";
 import { Observable, Subject } from "rxjs";
 import { DOMNode } from "slate-dom";
 import { ReactEditor } from "slate-react";
-import * as xstate_guards14 from "xstate/guards";
+import * as xstate_guards12 from "xstate/guards";
 type MIMEType = `${string}/${string}`;
 /**
  * @internal
@@ -219,7 +219,7 @@ declare class PortableTextEditor extends Component<PortableTextEditorProps<Inter
   componentDidUpdate(prevProps: PortableTextEditorProps): void;
   componentWillUnmount(): void;
   setEditable: (editable: EditableAPI) => void;
-  render(): react11.JSX.Element;
+  render(): react20.JSX.Element;
   /**
    * @deprecated
    * Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
@@ -614,7 +614,7 @@ type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'o
  * ```
  * @group Components
  */
-declare const PortableTextEditable: react11.ForwardRefExoticComponent<Omit<PortableTextEditableProps, "ref"> & react11.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
+declare const PortableTextEditable: react20.ForwardRefExoticComponent<Omit<PortableTextEditableProps, "ref"> & react20.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
 type DecoratedRange = BaseRange & {
   rangeDecoration: RangeDecoration;
 };
@@ -1360,7 +1360,7 @@ type EditorActor = ActorRefFrom<typeof editorMachine>;
 /**
  * @internal
  */
-declare const editorMachine: xstate243.StateMachine<{
+declare const editorMachine: xstate229.StateMachine<{
   behaviors: Set<BehaviorConfig>;
   behaviorsSorted: boolean;
   converters: Set<Converter>;
@@ -1424,62 +1424,62 @@ declare const editorMachine: xstate243.StateMachine<{
 } | {
   type: "add slate editor";
   editor: PortableTextSlateEditor;
-}, {}, never, xstate243.Values<{
+}, {}, never, xstate229.Values<{
   "add behavior to context": {
     type: "add behavior to context";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "remove behavior from context": {
     type: "remove behavior from context";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "add slate editor to context": {
     type: "add slate editor to context";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit patch event": {
     type: "emit patch event";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit mutation event": {
     type: "emit mutation event";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit read only": {
     type: "emit read only";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit editable": {
     type: "emit editable";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "defer event": {
     type: "defer event";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit pending events": {
     type: "emit pending events";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit ready": {
     type: "emit ready";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "clear pending events": {
     type: "clear pending events";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "defer incoming patches": {
     type: "defer incoming patches";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "emit pending incoming patches": {
     type: "emit pending incoming patches";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "clear pending incoming patches": {
     type: "clear pending incoming patches";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
   "handle blur": {
     type: "handle blur";
@@ -1495,9 +1495,9 @@ declare const editorMachine: xstate243.StateMachine<{
   };
   "sort behaviors": {
     type: "sort behaviors";
-    params: xstate243.NonReducibleUnknown;
+    params: xstate229.NonReducibleUnknown;
   };
-}>, xstate243.Values<{
+}>, xstate229.Values<{
   "slate is busy": {
     type: "slate is busy";
     params: unknown;
@@ -1530,9 +1530,9 @@ declare const editorMachine: xstate243.StateMachine<{
   readOnly?: boolean;
   schema: EditorSchema;
   initialValue?: Array<PortableTextBlock>;
-}, xstate243.NonReducibleUnknown, InternalPatchEvent | MutationEvent | PatchesEvent | {
+}, xstate229.NonReducibleUnknown, InternalPatchEvent | MutationEvent | PatchesEvent | {
   type: "blurred";
-  event: react11.FocusEvent<HTMLDivElement, Element>;
+  event: react20.FocusEvent<HTMLDivElement, Element>;
 } | {
   type: "done loading";
 } | {
@@ -1544,7 +1544,7 @@ declare const editorMachine: xstate243.StateMachine<{
   data: unknown;
 } | {
   type: "focused";
-  event: react11.FocusEvent<HTMLDivElement, Element>;
+  event: react20.FocusEvent<HTMLDivElement, Element>;
 } | {
   type: "invalid value";
   resolution: InvalidValueResolution | null;
@@ -1561,19 +1561,19 @@ declare const editorMachine: xstate243.StateMachine<{
 } | {
   type: "value changed";
   value: Array<PortableTextBlock> | undefined;
-}, xstate243.MetaObject, {
+}, xstate229.MetaObject, {
   readonly id: "editor";
   readonly context: ({
     input
   }: {
     spawn: {
-      <TSrc extends never>(logic: TSrc, ...[options]: never): xstate243.ActorRefFromLogic<never>;
-      <TLogic extends xstate243.AnyActorLogic>(src: TLogic, ...[options]: xstate243.ConditionalRequired<[options?: ({
+      <TSrc extends never>(logic: TSrc, ...[options]: never): xstate229.ActorRefFromLogic<never>;
+      <TLogic extends xstate229.AnyActorLogic>(src: TLogic, ...[options]: xstate229.ConditionalRequired<[options?: ({
         id?: never;
         systemId?: string;
-        input?: xstate243.InputFrom<TLogic> | undefined;
+        input?: xstate229.InputFrom<TLogic> | undefined;
         syncSnapshot?: boolean;
-      } & { [K in xstate243.RequiredLogicInput<TLogic>]: unknown }) | undefined], xstate243.IsNotNever<xstate243.RequiredLogicInput<TLogic>>>): xstate243.ActorRefFromLogic<TLogic>;
+      } & { [K in xstate229.RequiredLogicInput<TLogic>]: unknown }) | undefined], xstate229.IsNotNever<xstate229.RequiredLogicInput<TLogic>>>): xstate229.ActorRefFromLogic<TLogic>;
     };
     input: {
       converters?: Array<Converter>;
@@ -1584,7 +1584,7 @@ declare const editorMachine: xstate243.StateMachine<{
       schema: EditorSchema;
       initialValue?: Array<PortableTextBlock>;
     };
-    self: xstate243.ActorRef<xstate243.MachineSnapshot<{
+    self: xstate229.ActorRef<xstate229.MachineSnapshot<{
       behaviors: Set<BehaviorConfig>;
       behaviorsSorted: boolean;
       converters: Set<Converter>;
@@ -1648,7 +1648,7 @@ declare const editorMachine: xstate243.StateMachine<{
     } | {
       type: "add slate editor";
       editor: PortableTextSlateEditor;
-    }, Record<string, xstate243.AnyActorRef | undefined>, xstate243.StateValue, string, unknown, any, any>, InternalPatchEvent | MutationEvent | PatchesEvent | {
+    }, Record<string, xstate229.AnyActorRef | undefined>, xstate229.StateValue, string, unknown, any, any>, InternalPatchEvent | MutationEvent | PatchesEvent | {
       type: "update readOnly";
       readOnly: boolean;
     } | {
@@ -1694,13 +1694,14 @@ declare const editorMachine: xstate243.StateMachine<{
     } | {
       type: "add slate editor";
       editor: PortableTextSlateEditor;
-    }, xstate243.AnyEventObject>;
+    }, xstate229.AnyEventObject>;
   }) => {
     behaviors: Set<{
-      behavior: Behavior<"*" | "split" | `custom.${string}` | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.block" | "insert.child" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.inline object" | "insert.soft break" | "insert.span" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.block" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle" | "clipboard.copy" | "clipboard.cut" | "clipboard.paste" | "drag.dragstart" | "drag.drag" | "drag.dragend" | "drag.dragenter" | "drag.dragover" | "drag.dragleave" | "drag.drop" | "input.*" | "keyboard.keydown" | "keyboard.keyup" | "mouse.click" | "history.*" | "split.*" | "delete.*" | "select.*" | "deserialize.*" | "serialize.*" | "annotation.*" | "block.*" | "child.*" | "decorator.*" | "insert.*" | "move.*" | "deserialization.*" | "list item.*" | "serialization.*" | "style.*" | "clipboard.*" | "drag.*" | "keyboard.*" | "mouse.*", true, {
+      behavior: Behavior<"*" | "split" | `custom.${string}` | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.block" | "insert.child" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.inline object" | "insert.soft break" | "insert.span" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.block" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle" | "clipboard.copy" | "clipboard.cut" | "clipboard.paste" | "drag.dragstart" | "drag.drag" | "drag.dragend" | "drag.dragenter" | "drag.dragover" | "drag.dragleave" | "drag.drop" | "input.*" | "keyboard.keydown" | "keyboard.keyup" | "mouse.click" | "style.*" | "history.*" | "split.*" | "delete.*" | "select.*" | "deserialize.*" | "serialize.*" | "annotation.*" | "block.*" | "child.*" | "decorator.*" | "insert.*" | "move.*" | "deserialization.*" | "list item.*" | "serialization.*" | "clipboard.*" | "drag.*" | "keyboard.*" | "mouse.*", true, {
         type: StrictExtract<"split" | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.block" | "insert.child" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.inline object" | "insert.soft break" | "insert.span" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.block" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle", "annotation.add">;
         annotation: {
           name: string;
+          _key?: string;
           value: {
             [prop: string]: unknown;
           };
@@ -1982,7 +1983,7 @@ declare const editorMachine: xstate243.StateMachine<{
     keyGenerator: () => string;
     pendingEvents: never[];
     pendingIncomingPatchesEvents: never[];
-    schema: _portabletext_schema6.Schema;
+    schema: _portabletext_schema5.Schema;
     selection: null;
     initialReadOnly: boolean;
     maxBlocks: number | undefined;
@@ -1996,7 +1997,7 @@ declare const editorMachine: xstate243.StateMachine<{
       readonly actions: "remove behavior from context";
     };
     readonly 'update maxBlocks': {
-      readonly actions: xstate243.ActionFunction<{
+      readonly actions: xstate229.ActionFunction<{
         behaviors: Set<BehaviorConfig>;
         behaviorsSorted: boolean;
         converters: Set<Converter>;
@@ -2069,7 +2070,7 @@ declare const editorMachine: xstate243.StateMachine<{
       readonly actions: "add slate editor to context";
     };
     readonly 'update selection': {
-      readonly actions: readonly [xstate243.ActionFunction<{
+      readonly actions: readonly [xstate229.ActionFunction<{
         behaviors: Set<BehaviorConfig>;
         behaviorsSorted: boolean;
         converters: Set<Converter>;
@@ -2136,7 +2137,7 @@ declare const editorMachine: xstate243.StateMachine<{
       } | {
         type: "add slate editor";
         editor: PortableTextSlateEditor;
-      }, undefined, never, never, never, never, never>, xstate243.ActionFunction<{
+      }, undefined, never, never, never, never, never>, xstate229.ActionFunction<{
         behaviors: Set<BehaviorConfig>;
         behaviorsSorted: boolean;
         converters: Set<Converter>;
@@ -2205,7 +2206,7 @@ declare const editorMachine: xstate243.StateMachine<{
         editor: PortableTextSlateEditor;
       }, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
         type: "blurred";
-        event: react11.FocusEvent<HTMLDivElement, Element>;
+        event: react20.FocusEvent<HTMLDivElement, Element>;
       } | {
         type: "done loading";
       } | {
@@ -2217,7 +2218,7 @@ declare const editorMachine: xstate243.StateMachine<{
         data: unknown;
       } | {
         type: "focused";
-        event: react11.FocusEvent<HTMLDivElement, Element>;
+        event: react20.FocusEvent<HTMLDivElement, Element>;
       } | {
         type: "invalid value";
         resolution: InvalidValueResolution | null;
@@ -2237,7 +2238,7 @@ declare const editorMachine: xstate243.StateMachine<{
       }>];
     };
     readonly 'set drag ghost': {
-      readonly actions: xstate243.ActionFunction<{
+      readonly actions: xstate229.ActionFunction<{
         behaviors: Set<BehaviorConfig>;
         behaviorsSorted: boolean;
         converters: Set<Converter>;
@@ -2319,7 +2320,7 @@ declare const editorMachine: xstate243.StateMachine<{
               readonly actions: readonly ["sort behaviors", "handle behavior event"];
               readonly guard: ({
                 event
-              }: xstate_guards14.GuardArgs<{
+              }: xstate_guards12.GuardArgs<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -2356,7 +2357,7 @@ declare const editorMachine: xstate243.StateMachine<{
                   readonly target: "#editor.edit mode.read only.read only";
                   readonly guard: ({
                     context
-                  }: xstate_guards14.GuardArgs<{
+                  }: xstate_guards12.GuardArgs<{
                     behaviors: Set<BehaviorConfig>;
                     behaviorsSorted: boolean;
                     converters: Set<Converter>;
@@ -2389,7 +2390,7 @@ declare const editorMachine: xstate243.StateMachine<{
                 readonly 'update readOnly': {
                   readonly guard: ({
                     event
-                  }: xstate_guards14.GuardArgs<{
+                  }: xstate_guards12.GuardArgs<{
                     behaviors: Set<BehaviorConfig>;
                     behaviorsSorted: boolean;
                     converters: Set<Converter>;
@@ -2423,7 +2424,7 @@ declare const editorMachine: xstate243.StateMachine<{
             readonly 'update readOnly': {
               readonly guard: ({
                 event
-              }: xstate_guards14.GuardArgs<{
+              }: xstate_guards12.GuardArgs<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -2456,7 +2457,7 @@ declare const editorMachine: xstate243.StateMachine<{
             };
             readonly focus: {
               readonly target: ".focusing";
-              readonly actions: readonly [xstate243.ActionFunction<{
+              readonly actions: readonly [xstate229.ActionFunction<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -2533,7 +2534,7 @@ declare const editorMachine: xstate243.StateMachine<{
               readonly exit: readonly [() => void];
               readonly on: {
                 readonly dragstart: {
-                  readonly actions: readonly [xstate243.ActionFunction<{
+                  readonly actions: readonly [xstate229.ActionFunction<{
                     behaviors: Set<BehaviorConfig>;
                     behaviorsSorted: boolean;
                     converters: Set<Converter>;
@@ -2635,7 +2636,7 @@ declare const editorMachine: xstate243.StateMachine<{
               readonly entry: readonly [() => void];
               readonly exit: readonly [() => void, ({
                 context
-              }: xstate243.ActionArgs<{
+              }: xstate229.ActionArgs<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -2745,7 +2746,7 @@ declare const editorMachine: xstate243.StateMachine<{
               } | {
                 type: "add slate editor";
                 editor: PortableTextSlateEditor;
-              }>) => void, xstate243.ActionFunction<{
+              }>) => void, xstate229.ActionFunction<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -2855,7 +2856,7 @@ declare const editorMachine: xstate243.StateMachine<{
               } | {
                 type: "add slate editor";
                 editor: PortableTextSlateEditor;
-              }, undefined, never, never, never, never, never>, xstate243.ActionFunction<{
+              }, undefined, never, never, never, never, never>, xstate229.ActionFunction<{
                 behaviors: Set<BehaviorConfig>;
                 behaviorsSorted: boolean;
                 converters: Set<Converter>;
@@ -3012,7 +3013,7 @@ declare const editorMachine: xstate243.StateMachine<{
                   readonly exit: readonly [() => void];
                   readonly on: {
                     readonly patches: {
-                      readonly actions: readonly [xstate243.ActionFunction<{
+                      readonly actions: readonly [xstate229.ActionFunction<{
                         behaviors: Set<BehaviorConfig>;
                         behaviorsSorted: boolean;
                         converters: Set<Converter>;
@@ -3078,7 +3079,7 @@ declare const editorMachine: xstate243.StateMachine<{
                         editor: PortableTextSlateEditor;
                       }, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
                         type: "blurred";
-                        event: react11.FocusEvent<HTMLDivElement, Element>;
+                        event: react20.FocusEvent<HTMLDivElement, Element>;
                       } | {
                         type: "done loading";
                       } | {
@@ -3090,7 +3091,7 @@ declare const editorMachine: xstate243.StateMachine<{
                         data: unknown;
                       } | {
                         type: "focused";
-                        event: react11.FocusEvent<HTMLDivElement, Element>;
+                        event: react20.FocusEvent<HTMLDivElement, Element>;
                       } | {
                         type: "invalid value";
                         resolution: InvalidValueResolution | null;
@@ -3222,6 +3223,7 @@ type SyntheticBehaviorEvent = {
   type: StrictExtract<SyntheticBehaviorEventType, 'annotation.add'>;
   annotation: {
     name: string;
+    _key?: string;
     value: {
       [prop: string]: unknown;
     };

package/lib/index.js

@@ -4135,6 +4135,7 @@ const addAnnotationOperationImplementation = ({
   const parsedAnnotation = parseAnnotation({
     annotation: {
       _type: operation.annotation.name,
+      _key: operation.annotation._key,
       ...operation.annotation.value
     },
     context,