@portabletext/editor 4.2.4 → 4.3.0

package/lib/index.js

@@ -951,7 +951,7 @@ function performHotkey({
           const possibleMark = hotkeys[cat];
           if (possibleMark) {
             const mark = possibleMark[hotkey];
-            editorActor.send({
+            mark && editorActor.send({
               type: "behavior event",
               behaviorEvent: {
                 type: "decorator.toggle",
@@ -970,7 +970,7 @@ function performHotkey({
           const possibleCommand = hotkeys[cat];
           if (possibleCommand) {
             const command = possibleCommand[hotkey];
-            command(event, portableTextEditor);
+            command && command(event, portableTextEditor);
           }
         }
       }
@@ -1249,10 +1249,10 @@ const slateOperationCallback = ({
 });
 function createDecorate(schema, slateEditor) {
   return function([node, path]) {
-    const defaultStyle = schema.styles.at(0)?.name;
-    if (slateEditor.value.length === 1 && isEmptyTextBlock({
+    const defaultStyle = schema.styles.at(0)?.name, firstBlock = slateEditor.value[0];
+    if (slateEditor.value.length === 1 && firstBlock && isEmptyTextBlock({
       schema
-    }, slateEditor.value[0]) && (!slateEditor.value[0].style || slateEditor.value[0].style === defaultStyle) && !slateEditor.value[0].listItem)
+    }, firstBlock) && (!firstBlock.style || firstBlock.style === defaultStyle) && !firstBlock.listItem)
       return [{
         anchor: {
           path: [0, 0],
@@ -3082,7 +3082,7 @@ const entityMap = {
   "=": "="
 };
 function escapeHtml(str) {
-  return String(str).replace(/[&<>"'`=/]/g, (s) => entityMap[s]);
+  return String(str).replace(/[&<>"'`=/]/g, (s) => entityMap[s] ?? s);
 }
 function createCoreConverters(legacySchema) {
   return [converterJson, converterPortableText, converterTextMarkdown, createConverterTextHtml(legacySchema), createConverterTextPlain(legacySchema)];
@@ -3284,7 +3284,7 @@ function createEditableAPI(editor, editorActor) {
           at: [],
           match: (n) => n._key === element._key
         }) || [])[0] || [void 0];
-        node = ReactEditor.toDOMNode(editor, item);
+        item && (node = ReactEditor.toDOMNode(editor, item));
       } catch {
       }
       return node;
@@ -3475,7 +3475,7 @@ function createPlaceholderBlock(context) {
   return {
     _type: context.schema.block.name,
     _key: context.keyGenerator(),
-    style: context.schema.styles[0].name ?? "normal",
+    style: context.schema.styles[0]?.name ?? "normal",
     markDefs: [],
     children: [{
       _type: context.schema.span.name,
@@ -5129,7 +5129,10 @@ function splitNodePatch(schema, children, operation, beforeValue) {
     if (isTextBlock({
       schema
     }, oldBlock)) {
-      const targetValue = fromSlateBlock(children[operation.path[0] + 1], schema.block.name);
+      const nextBlock = children[operation.path[0] + 1];
+      if (!nextBlock)
+        return patches;
+      const targetValue = fromSlateBlock(nextBlock, schema.block.name);
       targetValue && (patches.push(insert([targetValue], "after", [{
         _key: splitBlock._key
       }])), oldBlock.children.slice(operation.position).forEach((span) => {
@@ -5190,7 +5193,10 @@ function mergeNodePatch(schema, children, operation, beforeValue) {
   const patches = [], block = beforeValue[operation.path[0]], updatedBlock = children[operation.path[0]];
   if (operation.path.length === 1)
     if (block?._key) {
-      const newBlock = fromSlateBlock(children[operation.path[0] - 1], schema.block.name);
+      const prevBlock = children[operation.path[0] - 1];
+      if (!prevBlock)
+        throw new Error("Previous block not found!");
+      const newBlock = fromSlateBlock(prevBlock, schema.block.name);
       patches.push(set(newBlock, [{
         _key: newBlock._key
       }])), patches.push(unset([{
@@ -5222,7 +5228,7 @@ function mergeNodePatch(schema, children, operation, beforeValue) {
 }
 function moveNodePatch(schema, beforeValue, operation) {
   const patches = [], block = beforeValue[operation.path[0]], targetBlock = beforeValue[operation.newPath[0]];
-  if (!targetBlock)
+  if (!targetBlock || !block)
     return patches;
   if (operation.path.length === 1) {
     const position = operation.path[0] > operation.newPath[0] ? "before" : "after";
@@ -5237,6 +5243,8 @@ function moveNodePatch(schema, beforeValue, operation) {
     schema
   }, targetBlock)) {
     const child = block.children[operation.path[1]], targetChild = targetBlock.children[operation.newPath[1]], position = operation.newPath[1] === targetBlock.children.length ? "after" : "before", childToInsert = block.children[operation.path[1]];
+    if (!child || !targetChild || !childToInsert)
+      return patches;
     patches.push(unset([{
       _key: block._key
     }, "children", {
@@ -5284,7 +5292,7 @@ function createPatchesPlugin({
                 try {
                   changed = applyPatch(editor, patch), changed ? debug.syncPatch(`(applied) ${JSON.stringify(patch, null, 2)}`) : debug.syncPatch(`(ignored) ${JSON.stringify(patch, null, 2)}`);
                 } catch (error) {
-                  console.error(`Applying patch ${JSON.stringify(patch)} failed due to: ${error.message}`);
+                  console.error(`Applying patch ${JSON.stringify(patch)} failed due to: ${error instanceof Error ? error.message : error}`);
                 }
             });
           });
@@ -6196,14 +6204,25 @@ function setDragGhost({
 const addAnnotationOnCollapsedSelection = defineBehavior({
   on: "annotation.add",
   guard: ({
-    snapshot
+    snapshot,
+    event
   }) => {
-    if (!isSelectionCollapsed$1(snapshot))
+    const at = event.at ?? snapshot.context.selection;
+    if (!at)
       return !1;
-    const caretWordSelection = getCaretWordSelection(snapshot);
-    return !caretWordSelection || !isSelectionExpanded({
+    const adjustedSnapshot = {
+      ...snapshot,
       context: {
         ...snapshot.context,
+        selection: at
+      }
+    };
+    if (!isSelectionCollapsed$1(adjustedSnapshot))
+      return !1;
+    const caretWordSelection = getCaretWordSelection(adjustedSnapshot);
+    return !caretWordSelection || !isSelectionExpanded({
+      context: {
+        ...adjustedSnapshot.context,
         selection: caretWordSelection
       }
     }) ? !1 : {
@@ -6228,15 +6247,28 @@ const addAnnotationOnCollapsedSelection = defineBehavior({
   guard: ({
     snapshot,
     event
-  }) => isActiveAnnotation(event.annotation.name, {
-    mode: "partial"
-  })(snapshot),
+  }) => {
+    const at = event.at ?? snapshot.context.selection;
+    if (!at)
+      return !1;
+    const adjustedSnapshot = {
+      ...snapshot,
+      context: {
+        ...snapshot.context,
+        selection: at
+      }
+    };
+    return isActiveAnnotation(event.annotation.name, {
+      mode: "partial"
+    })(adjustedSnapshot);
+  },
   // Then the existing annotation is removed
   actions: [({
     event
   }) => [raise({
     type: "annotation.remove",
-    annotation: event.annotation
+    annotation: event.annotation,
+    at: event.at
   }), raise(event)]]
 }), stripAnnotationsOnFullSpanDeletion = defineBehavior({
   on: "delete",
@@ -7070,7 +7102,7 @@ function isAtTheBeginningOfBlock({
   context,
   block
 }) {
-  return !isTextBlock(context, block) || !context.selection || !isSelectionCollapsed(context.selection) ? !1 : getChildKeyFromSelectionPoint(context.selection.focus) === block.children[0]._key && context.selection.focus.offset === 0;
+  return !isTextBlock(context, block) || !context.selection || !isSelectionCollapsed(context.selection) ? !1 : getChildKeyFromSelectionPoint(context.selection.focus) === block.children[0]?._key && context.selection.focus.offset === 0;
 }
 const MAX_LIST_LEVEL = 10, clearListOnBackspace = defineBehavior({
   on: "delete.backward",
@@ -7098,7 +7130,7 @@ const MAX_LIST_LEVEL = 10, clearListOnBackspace = defineBehavior({
     snapshot
   }) => {
     const selectionCollapsed = isSelectionCollapsed$1(snapshot), focusTextBlock = getFocusTextBlock(snapshot), focusSpan = getFocusSpan$1(snapshot);
-    return !selectionCollapsed || !focusTextBlock || !focusSpan ? !1 : focusTextBlock.node.children[0]._key === focusSpan.node._key && snapshot.context.selection?.focus.offset === 0 && focusTextBlock.node.level !== void 0 && focusTextBlock.node.level > 1 ? {
+    return !selectionCollapsed || !focusTextBlock || !focusSpan ? !1 : focusTextBlock.node.children[0]?._key === focusSpan.node._key && snapshot.context.selection?.focus.offset === 0 && focusTextBlock.node.level !== void 0 && focusTextBlock.node.level > 1 ? {
       focusTextBlock,
       level: focusTextBlock.node.level - 1
     } : !1;
@@ -7531,17 +7563,26 @@ const addAnnotationOperationImplementation = ({
   });
   if (!parsedAnnotation)
     throw new Error(`Failed to parse annotation ${JSON.stringify(operation.annotation)}`);
-  const editor = operation.editor;
-  if (!editor.selection || Range.isCollapsed(editor.selection))
+  const editor = operation.editor, at = operation.at ? toSlateRange({
+    context: {
+      schema: context.schema,
+      value: operation.editor.value,
+      selection: operation.at
+    },
+    blockIndexMap: operation.editor.blockIndexMap
+  }) : null, effectiveSelection = at ?? editor.selection;
+  if (!effectiveSelection || Range.isCollapsed(effectiveSelection))
     return;
-  const selectedBlocks = Editor.nodes(editor, {
-    at: editor.selection,
+  const rangeRef = at ? Editor.rangeRef(editor, at, {
+    affinity: "inward"
+  }) : null, selectedBlocks = Editor.nodes(editor, {
+    at: effectiveSelection,
     match: (node) => editor.isTextBlock(node),
-    reverse: Range.isBackward(editor.selection)
+    reverse: Range.isBackward(effectiveSelection)
   });
   let blockIndex = 0;
   for (const [block, blockPath] of selectedBlocks) {
-    if (block.children.length === 0 || block.children.length === 1 && block.children[0].text === "")
+    if (block.children.length === 0 || block.children.length === 1 && block.children[0]?.text === "")
       continue;
     const annotationKey = blockIndex === 0 ? parsedAnnotation._key : context.keyGenerator(), markDefs = block.markDefs ?? [];
     markDefs.find((markDef) => markDef._type === parsedAnnotation._type && markDef._key === annotationKey) === void 0 && Transforms.setNodes(editor, {
@@ -7551,13 +7592,17 @@ const addAnnotationOperationImplementation = ({
       }]
     }, {
       at: blockPath
-    }), Transforms.setNodes(editor, {}, {
+    }), at ? Transforms.setNodes(editor, {}, {
+      match: Text.isText,
+      split: !0,
+      at
+    }) : Transforms.setNodes(editor, {}, {
       match: Text.isText,
       split: !0
     });
-    const children = Node.children(editor, blockPath);
+    const children = Node.children(editor, blockPath), selectionRange = rangeRef?.current ?? editor.selection;
     for (const [span, path] of children) {
-      if (!editor.isTextSpan(span) || !Range.includes(editor.selection, path))
+      if (!editor.isTextSpan(span) || !selectionRange || !Range.includes(selectionRange, path))
         continue;
       const marks = span.marks ?? [];
       Transforms.setNodes(editor, {
@@ -7568,18 +7613,27 @@ const addAnnotationOperationImplementation = ({
     }
     blockIndex++;
   }
+  rangeRef?.unref();
 }, removeAnnotationOperationImplementation = ({
+  context,
   operation
 }) => {
-  const editor = operation.editor;
-  if (editor.selection)
-    if (Range.isCollapsed(editor.selection)) {
-      const [block, blockPath] = Editor.node(editor, editor.selection, {
+  const editor = operation.editor, at = operation.at ? toSlateRange({
+    context: {
+      schema: context.schema,
+      value: operation.editor.value,
+      selection: operation.at
+    },
+    blockIndexMap: operation.editor.blockIndexMap
+  }) : null, effectiveSelection = at ?? editor.selection;
+  if (effectiveSelection)
+    if (Range.isCollapsed(effectiveSelection)) {
+      const [block, blockPath] = Editor.node(editor, effectiveSelection, {
         depth: 1
       });
       if (!editor.isTextBlock(block))
         return;
-      const potentialAnnotations = (block.markDefs ?? []).filter((markDef) => markDef._type === operation.annotation.name), [selectedChild, selectedChildPath] = Editor.node(editor, editor.selection, {
+      const potentialAnnotations = (block.markDefs ?? []).filter((markDef) => markDef._type === operation.annotation.name), [selectedChild, selectedChildPath] = Editor.node(editor, effectiveSelection, {
         depth: 2
       });
       if (!editor.isTextSpan(selectedChild))
@@ -7610,19 +7664,27 @@ const addAnnotationOperationImplementation = ({
           at: childPath
         });
     } else {
-      Transforms.setNodes(editor, {}, {
+      const rangeRef = at ? Editor.rangeRef(editor, at, {
+        affinity: "inward"
+      }) : null;
+      at ? Transforms.setNodes(editor, {}, {
+        match: (node) => editor.isTextSpan(node),
+        split: !0,
+        hanging: !0,
+        at
+      }) : Transforms.setNodes(editor, {}, {
         match: (node) => editor.isTextSpan(node),
         split: !0,
         hanging: !0
       });
       const blocks = Editor.nodes(editor, {
-        at: editor.selection,
+        at: effectiveSelection,
         match: (node) => editor.isTextBlock(node)
-      });
+      }), selectionRange = rangeRef?.current ?? editor.selection;
       for (const [block, blockPath] of blocks) {
         const children = Node.children(editor, blockPath);
         for (const [child, childPath] of children) {
-          if (!editor.isTextSpan(child) || !Range.includes(editor.selection, childPath))
+          if (!editor.isTextSpan(child) || !selectionRange || !Range.includes(selectionRange, childPath))
             continue;
           const markDefs = block.markDefs ?? [], marks = child.marks ?? [], marksWithoutAnnotation = marks.filter((mark) => markDefs.find((markDef2) => markDef2._key === mark)?._type !== operation.annotation.name);
           marksWithoutAnnotation.length !== marks.length && Transforms.setNodes(editor, {
@@ -7632,6 +7694,7 @@ const addAnnotationOperationImplementation = ({
           });
         }
       }
+      rangeRef?.unref();
     }
 }, blockSetOperationImplementation = ({
   context,
@@ -8256,7 +8319,7 @@ const historyRedoOperationImplementation = ({
           });
         });
       } catch (err) {
-        console.error(`Could not perform 'history.redo' operation: ${err.message}`), editor.remotePatches.splice(0, editor.remotePatches.length), Transforms.deselect(editor), editor.history = {
+        console.error(`Could not perform 'history.redo' operation: ${err instanceof Error ? err.message : err}`), editor.remotePatches.splice(0, editor.remotePatches.length), Transforms.deselect(editor), editor.history = {
           undos: [],
           redos: []
         }, editor.withHistory = !0, editor.isRedoing = !1, editor.onChange();
@@ -8296,7 +8359,7 @@ const historyUndoOperationImplementation = ({
           });
         });
       } catch (err) {
-        console.error(`Could not perform 'history.undo' operation: ${err.message}`), editor.remotePatches.splice(0, editor.remotePatches.length), Transforms.deselect(editor), editor.history = {
+        console.error(`Could not perform 'history.undo' operation: ${err instanceof Error ? err.message : err}`), editor.remotePatches.splice(0, editor.remotePatches.length), Transforms.deselect(editor), editor.history = {
           undos: [],
           redos: []
         }, editor.withHistory = !0, editor.isUndoing = !1, editor.onChange();
@@ -9217,7 +9280,7 @@ function performOperation({
         }
       }
     } catch (error) {
-      console.error(new Error(`Performing "${operation.type}" failed due to: ${error.message}`));
+      console.error(new Error(`Performing "${operation.type}" failed due to: ${error instanceof Error ? error.message : error}`));
     }
   };
   Editor.isNormalizing(operation.editor) ? Editor.withoutNormalizing(operation.editor, perform) : perform();
@@ -9283,24 +9346,50 @@ const abstractAnnotationBehaviors = [defineBehavior({
   guard: ({
     snapshot,
     event
-  }) => isActiveAnnotation(event.annotation.name)(snapshot),
+  }) => {
+    const at = event.at ?? snapshot.context.selection;
+    if (!at)
+      return !1;
+    const adjustedSnapshot = {
+      ...snapshot,
+      context: {
+        ...snapshot.context,
+        selection: at
+      }
+    };
+    return isActiveAnnotation(event.annotation.name)(adjustedSnapshot);
+  },
   actions: [({
     event
   }) => [raise({
     type: "annotation.remove",
-    annotation: event.annotation
+    annotation: event.annotation,
+    at: event.at
   })]]
 }), defineBehavior({
   on: "annotation.toggle",
   guard: ({
     snapshot,
     event
-  }) => !isActiveAnnotation(event.annotation.name)(snapshot),
+  }) => {
+    const at = event.at ?? snapshot.context.selection;
+    if (!at)
+      return !1;
+    const adjustedSnapshot = {
+      ...snapshot,
+      context: {
+        ...snapshot.context,
+        selection: at
+      }
+    };
+    return !isActiveAnnotation(event.annotation.name)(adjustedSnapshot);
+  },
   actions: [({
     event
   }) => [raise({
     type: "annotation.add",
-    annotation: event.annotation
+    annotation: event.annotation,
+    at: event.at
   })]]
 })], abstractDecoratorBehaviors = [defineBehavior({
   on: "decorator.toggle",
@@ -11072,7 +11161,7 @@ function performEvent({
         dom: createEditorDom(sendBack, editor)
       });
     } catch (error) {
-      console.error(new Error(`Evaluating guard for "${event.type}" failed due to: ${error.message}`));
+      console.error(new Error(`Evaluating guard for "${event.type}" failed due to: ${error instanceof Error ? error.message : error}`));
     }
     if (!shouldRun)
       continue;
@@ -11095,7 +11184,7 @@ function performEvent({
           dom: createEditorDom(sendBack, editor)
         }, shouldRun);
       } catch (error) {
-        console.error(new Error(`Evaluating actions for "${event.type}" failed due to: ${error.message}`));
+        console.error(new Error(`Evaluating actions for "${event.type}" failed due to: ${error instanceof Error ? error.message : error}`));
       }
       if (actions.length === 0)
         continue;
@@ -11111,7 +11200,7 @@ function performEvent({
                 send: sendBack
               });
             } catch (error) {
-              console.error(new Error(`Executing effect as a result of "${event.type}" failed due to: ${error.message}`));
+              console.error(new Error(`Executing effect as a result of "${event.type}" failed due to: ${error instanceof Error ? error.message : error}`));
             }
             continue;
           }
@@ -11340,7 +11429,7 @@ const editorMachine = setup({
       try {
         ReactEditor.blur(event.editor);
       } catch (error) {
-        console.error(new Error(`Failed to blur editor: ${error.message}`));
+        console.error(new Error(`Failed to blur editor: ${error instanceof Error ? error.message : error}`));
       }
     },
     "handle focus": ({
@@ -11355,7 +11444,7 @@ const editorMachine = setup({
         const currentSelection = slateEditor.selection;
         ReactEditor.focus(slateEditor), currentSelection && (Transforms.select(slateEditor, currentSelection), EDITOR_TO_PENDING_SELECTION.set(slateEditor, slateEditor.selection), slateEditor.onChange());
       } catch (error) {
-        console.error(new Error(`Failed to focus editor: ${error.message}`));
+        console.error(new Error(`Failed to focus editor: ${error instanceof Error ? error.message : error}`));
       }
     },
     "handle behavior event": ({
@@ -11391,7 +11480,7 @@ const editorMachine = setup({
           }
         });
       } catch (error) {
-        console.error(new Error(`Raising "${event.behaviorEvent.type}" failed due to: ${error.message}`));
+        console.error(new Error(`Raising "${event.behaviorEvent.type}" failed due to: ${error instanceof Error ? error.message : error}`));
       }
     },
     "sort behaviors": assign({
@@ -11601,7 +11690,7 @@ const editorMachine = setup({
                   try {
                     context.dragGhost.parentNode?.removeChild(context.dragGhost);
                   } catch (error) {
-                    console.error(new Error(`Removing the drag ghost failed due to: ${error.message}`));
+                    console.error(new Error(`Removing the drag ghost failed due to: ${error instanceof Error ? error.message : error}`));
                   }
               }, assign({
                 dragGhost: void 0
@@ -11847,7 +11936,7 @@ const editorMachine = setup({
         sendBack({
           type: "emit changes"
         });
-      }, process.env.NODE_ENV === "test" ? 250 : 1e3);
+      }, 1e3);
       return () => {
         clearInterval(interval);
       };
@@ -12796,8 +12885,14 @@ function syncBlock({
       blockChanged: !1,
       blockValid: !0
     };
-  const validationValue = [value[index]], validation = validateValue(validationValue, context.schema, context.keyGenerator);
-  return !validation.valid && validation.resolution?.autoResolve && validation.resolution?.patches.length > 0 && !context.readOnly && context.previousValue && context.previousValue !== value && (console.warn(`${validation.resolution.action} for block with _key '${validationValue[0]._key}'. ${validation.resolution?.description}`), validation.resolution.patches.forEach((patch) => {
+  const blockToValidate = value[index];
+  if (!blockToValidate)
+    return {
+      blockChanged: !1,
+      blockValid: !0
+    };
+  const validation = validateValue([blockToValidate], context.schema, context.keyGenerator);
+  return !validation.valid && validation.resolution?.autoResolve && validation.resolution?.patches.length > 0 && !context.readOnly && context.previousValue && context.previousValue !== value && (console.warn(`${validation.resolution.action} for block with _key '${blockToValidate._key}'. ${validation.resolution?.description}`), validation.resolution.patches.forEach((patch) => {
     sendBack({
       type: "patch",
       patch