@portabletext/editor 1.1.5 → 1.1.7

package/lib/index.esm.js

@@ -5,18 +5,18 @@ import { useRef, useState, useMemo, useEffect, useCallback, createContext, useCo
 import { Editor, Element as Element$1, Range, Point, Text, Path, Transforms, Node, Operation, createEditor } from "slate";
 import { useSlateStatic, ReactEditor, useSelected, withReact, Slate, useSlate, Editable } from "slate-react";
 import debug$m from "debug";
-import { isKeySegment, isPortableTextSpan as isPortableTextSpan$1, isPortableTextTextBlock, isPortableTextListBlock } from "@sanity/types";
+import { isKeySegment, isPortableTextTextBlock, isPortableTextSpan, isPortableTextListBlock } from "@sanity/types";
 import { styled } from "styled-components";
 import uniq from "lodash/uniq.js";
 import { Subject } from "rxjs";
-import { fromCallback, setup, emit, assertEvent, assign, enqueueActions, createActor } from "xstate";
+import { fromCallback, setup, assertEvent, assign, emit, enqueueActions, createActor } from "xstate";
 import { Schema } from "@sanity/schema";
+import { isHotkey } from "is-hotkey-esm";
 import { diffMatchPatch as diffMatchPatch$1, set, insert, setIfMissing, unset, applyAll } from "@portabletext/patches";
 import get from "lodash/get.js";
 import isUndefined from "lodash/isUndefined.js";
 import omitBy from "lodash/omitBy.js";
 import flatten from "lodash/flatten.js";
-import { isHotkey } from "is-hotkey-esm";
 import { htmlToBlocks, normalizeBlock } from "@sanity/block-tools";
 import isPlainObject from "lodash/isPlainObject.js";
 import throttle from "lodash/throttle.js";
@@ -808,7 +808,28 @@ function compileType(rawType) {
     types: [rawType]
   }).get(rawType.name);
 }
-const debug$k = debugWithName("operationToPatches");
+function getFocusBlock(context) {
+  const key = context.selection && isKeySegment(context.selection.focus.path[0]) ? context.selection.focus.path[0]._key : void 0, node = key ? context.value.find((block) => block._key === key) : void 0;
+  return node && key ? { node, path: [{ _key: key }] } : void 0;
+}
+function getFocusBlockObject(context) {
+  const focusBlock = getFocusBlock(context);
+  return focusBlock && !isPortableTextTextBlock(focusBlock.node) ? { node: focusBlock.node, path: focusBlock.path } : void 0;
+}
+const overwriteSoftReturn = {
+  on: "key down",
+  guard: ({ event }) => isHotkey("shift+enter", event.nativeEvent),
+  actions: [
+    ({ event }) => (event.nativeEvent.preventDefault(), { type: "insert text", text: `
+` })
+  ]
+}, enterOnVoidBlock = {
+  on: "key down",
+  guard: ({ context, event }) => isHotkey("enter", event.nativeEvent) ? !!getFocusBlockObject(context) : !1,
+  actions: [
+    ({ event }) => (event.nativeEvent.preventDefault(), { type: "insert text block", decorators: [] })
+  ]
+}, coreBehaviors = [overwriteSoftReturn, enterOnVoidBlock], debug$k = debugWithName("operationToPatches");
 function createOperationToPatches(types) {
   const textBlockName = types.block.name;
   function insertTextPatch(editor, operation, beforeValue) {
@@ -1329,14 +1350,14 @@ function createWithEditableAPI(editorActor, portableTextEditor, types) {
             })
           ];
           if (spans.length === 0 || spans.some(
-            ([span]) => !isPortableTextSpan$1(span) || !span.marks || span.marks?.length === 0
+            ([span]) => !isPortableTextSpan(span) || !span.marks || span.marks?.length === 0
           ))
             return !1;
           const selectionMarkDefs = spans.reduce((accMarkDefs, [, path]) => {
             const [block] = Editor.node(editor, path, { depth: 1 });
             return editor.isTextBlock(block) && block.markDefs ? [...accMarkDefs, ...block.markDefs] : accMarkDefs;
           }, []);
-          return spans.every(([span]) => isPortableTextSpan$1(span) ? span.marks?.map(
+          return spans.every(([span]) => isPortableTextSpan(span) ? span.marks?.map(
             (markKey) => selectionMarkDefs.find((def) => def?._key === markKey)?._type
           )?.includes(annotationType) : !1);
         } catch {
@@ -3268,9 +3289,6 @@ function createWithPortableTextLists(types) {
     }, editor;
   };
 }
-function isPortableTextSpan(node) {
-  return node._type === "span" && "text" in node && typeof node.text == "string" && (typeof node.marks > "u" || Array.isArray(node.marks) && node.marks.every((mark) => typeof mark == "string"));
-}
 function isPortableTextBlock(node) {
   return (
     // A block doesn't _have_ to be named 'block' - to differentiate between
@@ -3283,6 +3301,34 @@ function isPortableTextBlock(node) {
     node.children.every((child) => typeof child == "object" && "_type" in child)
   );
 }
+function getPreviousSpan({
+  editor,
+  blockPath,
+  spanPath
+}) {
+  let previousSpan;
+  for (const [child, childPath] of Node.children(editor, blockPath, {
+    reverse: !0
+  }))
+    if (editor.isTextSpan(child) && Path.isBefore(childPath, spanPath)) {
+      previousSpan = child;
+      break;
+    }
+  return previousSpan;
+}
+function getNextSpan({
+  editor,
+  blockPath,
+  spanPath
+}) {
+  let nextSpan;
+  for (const [child, childPath] of Node.children(editor, blockPath))
+    if (editor.isTextSpan(child) && Path.isAfter(childPath, spanPath)) {
+      nextSpan = child;
+      break;
+    }
+  return nextSpan;
+}
 const debug$c = debugWithName("plugin:withPortableTextMarkModel");
 function createWithPortableTextMarkModel(editorActor, types) {
   return function(editor) {
@@ -3422,25 +3468,13 @@ function createWithPortableTextMarkModel(editorActor, types) {
             })
           )[0] ?? [void 0, void 0], marks = span.marks ?? [], marksWithoutAnnotations = marks.filter(
             (mark) => decorators.includes(mark)
-          ), spanHasAnnotations = marks.length > marksWithoutAnnotations.length, spanIsEmpty = span.text.length === 0, atTheBeginningOfSpan = selection.anchor.offset === 0, atTheEndOfSpan = selection.anchor.offset === span.text.length;
-          let previousSpan, nextSpan;
-          for (const [child, childPath] of Node.children(editor, blockPath, {
-            reverse: !0
-          }))
-            if (editor.isTextSpan(child) && Path.isBefore(childPath, spanPath)) {
-              previousSpan = child;
-              break;
-            }
-          for (const [child, childPath] of Node.children(editor, blockPath))
-            if (editor.isTextSpan(child) && Path.isAfter(childPath, spanPath)) {
-              nextSpan = child;
-              break;
-            }
-          const previousSpanHasSameAnnotation = previousSpan ? previousSpan.marks?.some(
-            (mark) => !decorators.includes(mark) && marks.includes(mark)
-          ) : !1, previousSpanHasSameMarks = previousSpan ? previousSpan.marks?.every((mark) => marks.includes(mark)) : !1, nextSpanHasSameAnnotation = nextSpan ? nextSpan.marks?.some(
+          ), spanHasAnnotations = marks.length > marksWithoutAnnotations.length, spanIsEmpty = span.text.length === 0, atTheBeginningOfSpan = selection.anchor.offset === 0, atTheEndOfSpan = selection.anchor.offset === span.text.length, previousSpan = getPreviousSpan({ editor, blockPath, spanPath }), nextSpan = getNextSpan({ editor, blockPath, spanPath }), nextSpanAnnotations = nextSpan?.marks?.filter((mark) => !decorators.includes(mark)) ?? [], spanAnnotations = marks.filter(
+            (mark) => !decorators.includes(mark)
+          ), previousSpanHasSameAnnotation = previousSpan ? previousSpan.marks?.some(
             (mark) => !decorators.includes(mark) && marks.includes(mark)
-          ) : !1, nextSpanHasSameMarks = nextSpan ? nextSpan.marks?.every((mark) => marks.includes(mark)) : !1;
+          ) : !1, previousSpanHasSameMarks = previousSpan ? previousSpan.marks?.every((mark) => marks.includes(mark)) : !1, nextSpanSharesSomeAnnotations = spanAnnotations.some(
+            (mark) => nextSpanAnnotations?.includes(mark)
+          );
           if (spanHasAnnotations && !spanIsEmpty) {
             if (atTheBeginningOfSpan) {
               previousSpanHasSameMarks ? Transforms.insertNodes(editor, {
@@ -3457,63 +3491,62 @@ function createWithPortableTextMarkModel(editorActor, types) {
               return;
             }
             if (atTheEndOfSpan) {
-              nextSpanHasSameMarks ? Transforms.insertNodes(editor, {
-                _type: "span",
-                _key: editorActor.getSnapshot().context.keyGenerator(),
-                text: op.text,
-                marks: nextSpan?.marks ?? []
-              }) : nextSpanHasSameAnnotation ? apply2(op) : Transforms.insertNodes(editor, {
-                _type: "span",
-                _key: editorActor.getSnapshot().context.keyGenerator(),
-                text: op.text,
-                marks: []
-              });
-              return;
+              if (nextSpan && nextSpanSharesSomeAnnotations && nextSpanAnnotations.length < spanAnnotations.length || !nextSpanSharesSomeAnnotations) {
+                Transforms.insertNodes(editor, {
+                  _type: "span",
+                  _key: editorActor.getSnapshot().context.keyGenerator(),
+                  text: op.text,
+                  marks: nextSpan?.marks ?? []
+                });
+                return;
+              }
+              if (!nextSpan) {
+                Transforms.insertNodes(editor, {
+                  _type: "span",
+                  _key: editorActor.getSnapshot().context.keyGenerator(),
+                  text: op.text,
+                  marks: []
+                });
+                return;
+              }
             }
           }
         }
       }
       if (op.type === "remove_text") {
-        const node = Array.from(
-          Editor.nodes(editor, {
-            mode: "lowest",
-            at: { path: op.path, offset: op.offset },
-            match: (n) => n._type === types.span.name,
-            voids: !1
-          })
-        )[0][0], block = Editor.node(editor, Path.parent(op.path))[0];
-        if (node && isPortableTextSpan(node) && block && isPortableTextBlock(block)) {
-          const markDefs = block.markDefs ?? [], nodeHasAnnotations = (node.marks ?? []).some(
-            (mark) => markDefs.find((markDef) => markDef._key === mark)
-          ), deletingPartOfTheNode = op.offset !== 0, deletingFromTheEnd = op.offset + op.text.length === node.text.length;
-          if (nodeHasAnnotations && deletingPartOfTheNode && deletingFromTheEnd) {
-            Editor.withoutNormalizing(editor, () => {
-              Transforms.splitNodes(editor, {
-                match: Text.isText,
-                at: { path: op.path, offset: op.offset }
-              }), Transforms.removeNodes(editor, { at: Path.next(op.path) });
-            }), editor.onChange();
-            return;
-          }
-          const deletingAllText = op.offset === 0 && deletingFromTheEnd;
-          if (nodeHasAnnotations && deletingAllText) {
-            const marksWithoutAnnotationMarks = ({
-              ...Editor.marks(editor) || {}
-            }.marks || []).filter((mark) => decorators.includes(mark));
-            Editor.withoutNormalizing(editor, () => {
-              apply2(op), Transforms.setNodes(
-                editor,
-                { marks: marksWithoutAnnotationMarks },
-                { at: op.path }
-              );
-            }), editor.onChange();
-            return;
-          }
-          if (node.marks !== void 0 && node.marks.length > 0 && deletingAllText) {
-            Editor.withoutNormalizing(editor, () => {
-              apply2(op), Transforms.setNodes(editor, { marks: [] }, { at: op.path });
-            }), editor.onChange();
-            return;
+        const { selection } = editor;
+        if (selection && Range.isExpanded(selection)) {
+          const [block, blockPath] = Editor.node(editor, selection, {
+            depth: 1
+          }), [span, spanPath] = Array.from(
+            Editor.nodes(editor, {
+              mode: "lowest",
+              at: { path: op.path, offset: op.offset },
+              match: (n) => editor.isTextSpan(n),
+              voids: !1
+            })
+          )[0] ?? [void 0, void 0];
+          if (span && block && isPortableTextBlock(block)) {
+            const markDefs = block.markDefs ?? [], marks = span.marks ?? [], spanHasAnnotations = marks.some(
+              (mark) => markDefs.find((markDef) => markDef._key === mark)
+            ), deletingFromTheEnd = op.offset + op.text.length === span.text.length, deletingAllText = op.offset === 0 && deletingFromTheEnd, previousSpan = getPreviousSpan({ editor, blockPath, spanPath }), nextSpan = getNextSpan({ editor, blockPath, spanPath }), previousSpanHasSameAnnotation = previousSpan ? previousSpan.marks?.some(
+              (mark) => !decorators.includes(mark) && marks.includes(mark)
+            ) : !1, nextSpanHasSameAnnotation = nextSpan ? nextSpan.marks?.some(
+              (mark) => !decorators.includes(mark) && marks.includes(mark)
+            ) : !1;
+            if (spanHasAnnotations && deletingAllText && !previousSpanHasSameAnnotation && !nextSpanHasSameAnnotation) {
+              const marksWithoutAnnotationMarks = ({
+                ...Editor.marks(editor) || {}
+              }.marks || []).filter((mark) => decorators.includes(mark));
+              Editor.withoutNormalizing(editor, () => {
+                apply2(op), Transforms.setNodes(
+                  editor,
+                  { marks: marksWithoutAnnotationMarks },
+                  { at: op.path }
+                );
+              }), editor.onChange();
+              return;
+            }
           }
         }
       }
@@ -3700,7 +3733,7 @@ function createWithSchemaTypes({
   schemaTypes
 }) {
   return function(editor) {
-    editor.isTextBlock = (value) => isPortableTextTextBlock(value) && value._type === schemaTypes.block.name, editor.isTextSpan = (value) => isPortableTextSpan$1(value) && value._type === schemaTypes.span.name, editor.isListBlock = (value) => isPortableTextListBlock(value) && value._type === schemaTypes.block.name, editor.isVoid = (element) => schemaTypes.block.name !== element._type && (schemaTypes.blockObjects.map((obj) => obj.name).includes(element._type) || schemaTypes.inlineObjects.map((obj) => obj.name).includes(element._type)), editor.isInline = (element) => schemaTypes.inlineObjects.map((obj) => obj.name).includes(element._type) && "__inline" in element && element.__inline === !0;
+    editor.isTextBlock = (value) => isPortableTextTextBlock(value) && value._type === schemaTypes.block.name, editor.isTextSpan = (value) => isPortableTextSpan(value) && value._type === schemaTypes.span.name, editor.isListBlock = (value) => isPortableTextListBlock(value) && value._type === schemaTypes.block.name, editor.isVoid = (element) => schemaTypes.block.name !== element._type && (schemaTypes.blockObjects.map((obj) => obj.name).includes(element._type) || schemaTypes.inlineObjects.map((obj) => obj.name).includes(element._type)), editor.isInline = (element) => schemaTypes.inlineObjects.map((obj) => obj.name).includes(element._type) && "__inline" in element && element.__inline === !0;
     const { normalizeNode } = editor;
     return editor.normalizeNode = (entry) => {
       const [node, path] = entry;
@@ -3851,10 +3884,10 @@ function createWithHotkeys(types, portableTextEditor, hotkeysFromOptions) {
       if ((isTab || isShiftTab) && editor.selection) {
         const [focusChild] = Editor.node(editor, editor.selection.focus, {
           depth: 2
-        }), [focusBlock] = isPortableTextSpan$1(focusChild) ? Editor.node(editor, editor.selection.focus, { depth: 1 }) : [], hasAnnotationFocus = focusChild && isPortableTextTextBlock(focusBlock) && isPortableTextSpan$1(focusChild) && (focusChild.marks || []).filter(
+        }), [focusBlock] = isPortableTextSpan(focusChild) ? Editor.node(editor, editor.selection.focus, { depth: 1 }) : [], hasAnnotationFocus = focusChild && isPortableTextTextBlock(focusBlock) && isPortableTextSpan(focusChild) && (focusChild.marks || []).filter(
           (m) => (focusBlock.markDefs || []).map((def) => def._key).includes(m)
         ).length > 0, [start] = Range.edges(editor.selection), atStartOfNode = Editor.isStart(editor, start, start.path);
-        focusChild && isPortableTextSpan$1(focusChild) && (!hasAnnotationFocus || atStartOfNode) && editor.pteIncrementBlockLevels(isShiftTab) && event.preventDefault();
+        focusChild && isPortableTextSpan(focusChild) && (!hasAnnotationFocus || atStartOfNode) && editor.pteIncrementBlockLevels(isShiftTab) && event.preventDefault();
       }
       if (isEnter && !isShiftEnter && editor.selection) {
         const focusBlockPath = editor.selection.focus.path.slice(0, 1), focusBlock = Node.descendant(editor, focusBlockPath);
@@ -3872,22 +3905,7 @@ function createWithHotkeys(types, portableTextEditor, hotkeysFromOptions) {
             return;
           }
         }
-        if (focusBlock && Editor.isVoid(editor, focusBlock)) {
-          Editor.insertNode(editor, editor.pteCreateTextBlock({ decorators: [] })), event.preventDefault(), editor.onChange();
-          return;
-        }
-        event.preventDefault(), editor.insertBreak(), editor.onChange();
-      }
-      if (isShiftEnter) {
-        event.preventDefault(), editor.insertText(`
-`);
-        return;
-      }
-      if (isHotkey("mod+z", event.nativeEvent)) {
-        event.preventDefault(), editor.undo();
-        return;
       }
-      (isHotkey("mod+y", event.nativeEvent) || isHotkey("mod+shift+z", event.nativeEvent)) && (event.preventDefault(), editor.redo());
     }, editor;
   };
 }
@@ -4812,6 +4830,29 @@ ${JSON.stringify(pendingPatches.current, null, 2)}`);
     debug$4("Value from props changed, syncing new value"), syncValue(value), isInitialValueFromProps.current && (editorActor.send({ type: "ready" }), isInitialValueFromProps.current = !1);
   }, [editorActor, syncValue, value]), null;
 }
+function inserText({
+  event
+}) {
+  Editor.insertText(event.editor, event.text);
+}
+function inserTextBlock({
+  context,
+  event
+}) {
+  Editor.insertNode(event.editor, {
+    _key: context.keyGenerator(),
+    _type: context.schema.block.name,
+    style: context.schema.styles[0].value ?? "normal",
+    markDefs: [],
+    children: [
+      {
+        _key: context.keyGenerator(),
+        _type: "span",
+        text: ""
+      }
+    ]
+  });
+}
 const networkLogic = fromCallback(({ sendBack }) => {
   const onlineHandler = () => {
     sendBack({ type: "online" });
@@ -4829,6 +4870,15 @@ const networkLogic = fromCallback(({ sendBack }) => {
     input: {}
   },
   actions: {
+    "apply:insert text": ({ context, event }) => {
+      assertEvent(event, "insert text"), inserText({ context, event });
+    },
+    "apply:insert text block": ({ context, event }) => {
+      assertEvent(event, "insert text block"), inserTextBlock({ context, event });
+    },
+    "assign schema": assign({
+      schema: ({ event }) => (assertEvent(event, "update schema"), event.schema)
+    }),
     "emit patch event": emit(({ event }) => (assertEvent(event, "patch"), event)),
     "emit mutation event": emit(({ event }) => (assertEvent(event, "mutation"), event)),
     "defer event": assign({
@@ -4840,6 +4890,50 @@ const networkLogic = fromCallback(({ sendBack }) => {
     }),
     "clear pending events": assign({
       pendingEvents: []
+    }),
+    "handle behavior event": enqueueActions(({ context, event, enqueue }) => {
+      assertEvent(event, ["key down"]);
+      const eventBehaviors = context.behaviors.filter(
+        (behavior) => behavior.on === event.type
+      );
+      if (eventBehaviors.length === 0)
+        return;
+      const value = fromSlateValue(
+        event.editor.children,
+        context.schema.block.name,
+        KEY_TO_VALUE_ELEMENT.get(event.editor)
+      ), selection = toPortableTextRange(
+        value,
+        event.editor.selection,
+        context.schema
+      );
+      if (!selection) {
+        console.warn(
+          `Unable to handle event ${event.type} due to missing selection`
+        );
+        return;
+      }
+      const behaviorContext = {
+        schema: context.schema,
+        value,
+        selection
+      };
+      for (const eventBehavior of eventBehaviors) {
+        const shouldRun = eventBehavior.guard?.({
+          context: behaviorContext,
+          event
+        }) ?? !0;
+        if (!shouldRun)
+          continue;
+        const actions = eventBehavior.actions.map(
+          (action) => action({ context: behaviorContext, event }, shouldRun)
+        );
+        for (const action of actions)
+          typeof action == "object" && enqueue.raise({
+            ...action,
+            editor: event.editor
+          });
+      }
     })
   },
   actors: {
@@ -4848,8 +4942,10 @@ const networkLogic = fromCallback(({ sendBack }) => {
 }).createMachine({
   id: "editor",
   context: ({ input }) => ({
+    behaviors: input.behaviors,
     keyGenerator: input.keyGenerator,
-    pendingEvents: []
+    pendingEvents: [],
+    schema: input.schema
   }),
   invoke: {
     id: "networkLogic",
@@ -4867,7 +4963,17 @@ const networkLogic = fromCallback(({ sendBack }) => {
     online: { actions: emit({ type: "online" }) },
     offline: { actions: emit({ type: "offline" }) },
     loading: { actions: emit({ type: "loading" }) },
-    "done loading": { actions: emit({ type: "done loading" }) }
+    "done loading": { actions: emit({ type: "done loading" }) },
+    "update schema": { actions: "assign schema" },
+    "key down": {
+      actions: ["handle behavior event"]
+    },
+    "insert text": {
+      actions: ["apply:insert text"]
+    },
+    "insert text block": {
+      actions: ["apply:insert text block"]
+    }
   },
   initial: "pristine",
   states: {
@@ -4962,18 +5068,23 @@ class PortableTextEditor extends Component {
       throw new Error('PortableTextEditor: missing "schemaType" property');
     props.incomingPatches$ && console.warn(
       "The prop 'incomingPatches$' is deprecated and renamed to 'patches$'"
+    ), this.schemaTypes = getPortableTextMemberSchemaTypes(
+      props.schemaType.hasOwnProperty("jsonType") ? props.schemaType : compileType(props.schemaType)
     ), this.editorActor = createActor(editorMachine, {
       input: {
-        keyGenerator: props.keyGenerator || defaultKeyGenerator
+        behaviors: coreBehaviors,
+        keyGenerator: props.keyGenerator || defaultKeyGenerator,
+        schema: this.schemaTypes
       }
-    }), this.editorActor.start(), this.schemaTypes = getPortableTextMemberSchemaTypes(
-      props.schemaType.hasOwnProperty("jsonType") ? props.schemaType : compileType(props.schemaType)
-    );
+    }), this.editorActor.start();
   }
   componentDidUpdate(prevProps) {
     this.props.schemaType !== prevProps.schemaType && (this.schemaTypes = getPortableTextMemberSchemaTypes(
       this.props.schemaType.hasOwnProperty("jsonType") ? this.props.schemaType : compileType(this.props.schemaType)
-    )), this.props.editorRef !== prevProps.editorRef && this.props.editorRef && (this.props.editorRef.current = this);
+    ), this.editorActor.send({
+      type: "update schema",
+      schema: this.schemaTypes
+    })), this.props.editorRef !== prevProps.editorRef && this.props.editorRef && (this.props.editorRef.current = this);
   }
   setEditable = (editable) => {
     this.editable = { ...this.editable, ...editable };
@@ -5530,7 +5641,11 @@ const debug$1 = debugWithName("components:Leaf"), EMPTY_MARKS = [], Leaf = (prop
   }, [validateSelection, editableElement]);
   const handleKeyDown = useCallback(
     (event) => {
-      props.onKeyDown && props.onKeyDown(event), event.isDefaultPrevented() || slateEditor.pteWithHotKeys(event);
+      props.onKeyDown && props.onKeyDown(event), event.isDefaultPrevented() || (editorActor.send({
+        type: "key down",
+        nativeEvent: event.nativeEvent,
+        editor: slateEditor
+      }), slateEditor.pteWithHotKeys(event));
     },
     [props, slateEditor]
   ), scrollSelectionIntoViewToSlate = useMemo(() => {