@portabletext/editor 1.7.1 → 1.9.0

package/lib/index.mjs

@@ -317,6 +317,21 @@ const breakingBlockObject = {
   blockObjects: coreBlockObjectBehaviors,
   lists: coreListBehaviors
 };
+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
+    // allowed child types and marks, one might name them differently
+    typeof node._type == "string" && // Toolkit-types like nested spans are @-prefixed
+    node._type[0] !== "@" && // `markDefs` isn't _required_ per say, but if it's there, it needs to be an array
+    (!("markDefs" in node) || !node.markDefs || Array.isArray(node.markDefs) && // Every mark definition needs to have an `_key` to be mappable in child spans
+    node.markDefs.every((def) => typeof def._key == "string")) && // `children` is required and needs to be an array
+    "children" in node && Array.isArray(node.children) && // All children are objects with `_type` (usually spans, but can contain other stuff)
+    node.children.every((child) => typeof child == "object" && "_type" in child)
+  );
+}
 function createMarkdownBehaviors(config) {
   const automaticBlockquoteOnSpace = {
     on: "insert text",
@@ -329,7 +344,7 @@ function createMarkdownBehaviors(config) {
       const selectionCollapsed = selectionIsCollapsed(context), focusTextBlock = getFocusTextBlock(context), focusSpan = getFocusSpan(context);
       if (!selectionCollapsed || !focusTextBlock || !focusSpan)
         return !1;
-      const caretAtTheEndOfQuote = context.selection.focus.offset === 1, looksLikeMarkdownQuote = /^>/.test(focusSpan.node.text), blockquoteStyle = config.mapBlockquoteStyle(context.schema);
+      const caretAtTheEndOfQuote = context.selection.focus.offset === 1, looksLikeMarkdownQuote = /^>/.test(focusSpan.node.text), blockquoteStyle = config.mapBlockquoteStyle?.(context.schema);
       return caretAtTheEndOfQuote && looksLikeMarkdownQuote && blockquoteStyle !== void 0 ? {
         focusTextBlock,
         focusSpan,
@@ -364,6 +379,48 @@ function createMarkdownBehaviors(config) {
         }
       }
     }]]
+  }, automaticBreak = {
+    on: "insert text",
+    guard: ({
+      context,
+      event
+    }) => {
+      if (event.text !== "-")
+        return !1;
+      const breakObject = config.mapBreakObject?.(context.schema), focusBlock = getFocusTextBlock(context), selectionCollapsed = selectionIsCollapsed(context);
+      if (!breakObject || !focusBlock || !selectionCollapsed)
+        return !1;
+      const onlyText = focusBlock.node.children.every(isPortableTextSpan), blockText = focusBlock.node.children.map((child) => child.text ?? "").join("");
+      return onlyText && blockText === "--" ? {
+        breakObject,
+        focusBlock
+      } : !1;
+    },
+    actions: [() => [{
+      type: "insert text",
+      text: "-"
+    }], (_, {
+      breakObject,
+      focusBlock
+    }) => [{
+      type: "insert block object",
+      ...breakObject
+    }, {
+      type: "delete",
+      selection: {
+        anchor: {
+          path: focusBlock.path,
+          offset: 0
+        },
+        focus: {
+          path: focusBlock.path,
+          offset: 0
+        }
+      }
+    }, {
+      type: "insert text block",
+      decorators: []
+    }]]
   }, automaticHeadingOnSpace = {
     on: "insert text",
     guard: ({
@@ -378,7 +435,7 @@ function createMarkdownBehaviors(config) {
       const markdownHeadingSearch = /^#+/.exec(focusSpan.node.text), headingLevel = markdownHeadingSearch ? markdownHeadingSearch[0].length : void 0;
       if (context.selection.focus.offset !== headingLevel)
         return !1;
-      const headingStyle = headingLevel !== void 0 ? config.mapHeadingStyle(context.schema, headingLevel) : void 0;
+      const headingStyle = headingLevel !== void 0 ? config.mapHeadingStyle?.(context.schema, headingLevel) : void 0;
       return headingLevel !== void 0 && headingStyle !== void 0 ? {
         focusTextBlock,
         focusSpan,
@@ -423,7 +480,7 @@ function createMarkdownBehaviors(config) {
       const selectionCollapsed = selectionIsCollapsed(context), focusTextBlock = getFocusTextBlock(context), focusSpan = getFocusSpan(context);
       if (!selectionCollapsed || !focusTextBlock || !focusSpan)
         return !1;
-      const atTheBeginningOfBLock = focusTextBlock.node.children[0]._key === focusSpan.node._key && context.selection.focus.offset === 0, defaultStyle = config.mapDefaultStyle(context.schema);
+      const atTheBeginningOfBLock = focusTextBlock.node.children[0]._key === focusSpan.node._key && context.selection.focus.offset === 0, defaultStyle = config.mapDefaultStyle?.(context.schema);
       return atTheBeginningOfBLock && defaultStyle && focusTextBlock.node.style !== defaultStyle ? {
         defaultStyle,
         focusTextBlock
@@ -448,7 +505,7 @@ function createMarkdownBehaviors(config) {
       const selectionCollapsed = selectionIsCollapsed(context), focusTextBlock = getFocusTextBlock(context), focusSpan = getFocusSpan(context);
       if (!selectionCollapsed || !focusTextBlock || !focusSpan)
         return !1;
-      const defaultStyle = config.mapDefaultStyle(context.schema), looksLikeUnorderedList = /^(-|\*)/.test(focusSpan.node.text), unorderedListStyle = config.mapUnorderedListStyle(context.schema), caretAtTheEndOfUnorderedList = context.selection.focus.offset === 1;
+      const defaultStyle = config.mapDefaultStyle?.(context.schema), looksLikeUnorderedList = /^(-|\*)/.test(focusSpan.node.text), unorderedListStyle = config.mapUnorderedListStyle?.(context.schema), caretAtTheEndOfUnorderedList = context.selection.focus.offset === 1;
       if (defaultStyle && caretAtTheEndOfUnorderedList && looksLikeUnorderedList && unorderedListStyle !== void 0)
         return {
           focusTextBlock,
@@ -457,7 +514,7 @@ function createMarkdownBehaviors(config) {
           listItemLength: 1,
           style: defaultStyle
         };
-      const looksLikeOrderedList = /^1./.test(focusSpan.node.text), orderedListStyle = config.mapOrderedListStyle(context.schema), caretAtTheEndOfOrderedList = context.selection.focus.offset === 2;
+      const looksLikeOrderedList = /^1./.test(focusSpan.node.text), orderedListStyle = config.mapOrderedListStyle?.(context.schema), caretAtTheEndOfOrderedList = context.selection.focus.offset === 2;
       return defaultStyle && caretAtTheEndOfOrderedList && looksLikeOrderedList && orderedListStyle !== void 0 ? {
         focusTextBlock,
         focusSpan,
@@ -495,7 +552,66 @@ function createMarkdownBehaviors(config) {
       }
     }]]
   };
-  return [automaticBlockquoteOnSpace, automaticHeadingOnSpace, clearStyleOnBackspace, automaticListOnSpace];
+  return [automaticBlockquoteOnSpace, automaticBreak, automaticHeadingOnSpace, clearStyleOnBackspace, automaticListOnSpace];
+}
+function createLinkBehaviors(config) {
+  const pasteLinkOnSelection = {
+    on: "paste",
+    guard: ({
+      context,
+      event
+    }) => {
+      const selectionCollapsed = selectionIsCollapsed(context), text = event.clipboardData.getData("text/plain"), url = looksLikeUrl(text) ? text : void 0, annotation = url !== void 0 ? config.mapLinkAnnotation?.({
+        url,
+        schema: context.schema
+      }) : void 0;
+      return annotation && !selectionCollapsed ? {
+        annotation
+      } : !1;
+    },
+    actions: [(_, {
+      annotation
+    }) => [{
+      type: "annotation.add",
+      annotation
+    }]]
+  }, pasteLinkAtCaret = {
+    on: "paste",
+    guard: ({
+      context,
+      event
+    }) => {
+      const focusSpan = getFocusSpan(context), selectionCollapsed = selectionIsCollapsed(context);
+      if (!focusSpan || !selectionCollapsed)
+        return !1;
+      const text = event.clipboardData.getData("text/plain"), url = looksLikeUrl(text) ? text : void 0, annotation = url !== void 0 ? config.mapLinkAnnotation?.({
+        url,
+        schema: context.schema
+      }) : void 0;
+      return url && annotation && selectionCollapsed ? {
+        focusSpan,
+        annotation,
+        url
+      } : !1;
+    },
+    actions: [(_, {
+      annotation,
+      url
+    }) => [{
+      type: "insert span",
+      text: url,
+      annotations: [annotation]
+    }]]
+  };
+  return [pasteLinkOnSelection, pasteLinkAtCaret];
+}
+function looksLikeUrl(text) {
+  let looksLikeUrl2 = !1;
+  try {
+    new URL(text), looksLikeUrl2 = !0;
+  } catch {
+  }
+  return looksLikeUrl2;
 }
 function getPortableTextMemberSchemaTypes(portableTextType) {
   if (!portableTextType)
@@ -3925,21 +4041,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
-    // allowed child types and marks, one might name them differently
-    typeof node._type == "string" && // Toolkit-types like nested spans are @-prefixed
-    node._type[0] !== "@" && // `markDefs` isn't _required_ per say, but if it's there, it needs to be an array
-    (!("markDefs" in node) || !node.markDefs || Array.isArray(node.markDefs) && // Every mark definition needs to have an `_key` to be mappable in child spans
-    node.markDefs.every((def) => typeof def._key == "string")) && // `children` is required and needs to be an array
-    "children" in node && Array.isArray(node.children) && // All children are objects with `_type` (usually spans, but can contain other stuff)
-    node.children.every((child) => typeof child == "object" && "_type" in child)
-  );
-}
 function getPreviousSpan({
   editor,
   blockPath,
@@ -4426,11 +4527,11 @@ function isDecoratorActive({
 }) {
   if (!editor.selection)
     return !1;
-  const selectedNodes = Array.from(Editor.nodes(editor, {
+  const selectedTextNodes = Array.from(Editor.nodes(editor, {
     match: Text.isText,
     at: editor.selection
   }));
-  return Range.isExpanded(editor.selection) ? selectedNodes.every((n) => {
+  return selectedTextNodes.length === 0 ? !1 : Range.isExpanded(editor.selection) ? selectedTextNodes.every((n) => {
     const [node] = n;
     return node.marks?.includes(decorator);
   }) : ({
@@ -4752,32 +4853,18 @@ function createEditableAPI(editor, editorActor) {
         at: editor.selection
       }), editor.onChange(), toPortableTextRange(fromSlateValue(editor.children, types.block.name, KEY_TO_VALUE_ELEMENT.get(editor)), editor.selection, types)?.focus.path || [];
     },
-    insertBlock: (type, value) => {
-      const block = toSlateValue([{
-        _key: editorActor.getSnapshot().context.keyGenerator(),
-        _type: type.name,
-        ...value || {}
-      }], {
-        schemaTypes: editorActor.getSnapshot().context.schema
-      })[0];
-      if (!editor.selection) {
-        const lastBlock = Array.from(Editor.nodes(editor, {
-          match: (n) => !Editor.isEditor(n),
-          at: [],
-          reverse: !0
-        }))[0];
-        return Editor.insertNode(editor, block), lastBlock && isEqualToEmptyEditor([lastBlock[0]], types) && Transforms.removeNodes(editor, {
-          at: lastBlock[1]
-        }), editor.onChange(), toPortableTextRange(fromSlateValue(editor.children, types.block.name, KEY_TO_VALUE_ELEMENT.get(editor)), editor.selection, types)?.focus.path ?? [];
+    insertBlock: (type, value) => insertBlockObjectActionImplementation({
+      context: {
+        keyGenerator: editorActor.getSnapshot().context.keyGenerator,
+        schema: types
+      },
+      action: {
+        type: "insert block object",
+        name: type.name,
+        value,
+        editor
       }
-      const focusBlock = Array.from(Editor.nodes(editor, {
-        at: editor.selection.focus.path.slice(0, 1),
-        match: (n) => n._type === types.block.name
-      }))[0];
-      return Editor.insertNode(editor, block), focusBlock && isEqualToEmptyEditor([focusBlock[0]], types) && Transforms.removeNodes(editor, {
-        at: focusBlock[1]
-      }), editor.onChange(), toPortableTextRange(fromSlateValue(editor.children, types.block.name, KEY_TO_VALUE_ELEMENT.get(editor)), editor.selection, types)?.focus.path || [];
-    },
+    }),
     hasBlockStyle: (style) => {
       try {
         return editor.pteHasBlockStyle(style);
@@ -4947,6 +5034,35 @@ function createEditableAPI(editor, editorActor) {
     }
   };
 }
+const insertBlockObjectActionImplementation = ({
+  context,
+  action
+}) => {
+  const editor = action.editor, types = context.schema, block = toSlateValue([{
+    _key: context.keyGenerator(),
+    _type: action.name,
+    ...action.value ? action.value : {}
+  }], {
+    schemaTypes: context.schema
+  })[0];
+  if (!editor.selection) {
+    const lastBlock = Array.from(Editor.nodes(editor, {
+      match: (n) => !Editor.isEditor(n),
+      at: [],
+      reverse: !0
+    }))[0];
+    return Editor.insertNode(editor, block), lastBlock && isEqualToEmptyEditor([lastBlock[0]], types) && Transforms.removeNodes(editor, {
+      at: lastBlock[1]
+    }), editor.onChange(), toPortableTextRange(fromSlateValue(editor.children, types.block.name, KEY_TO_VALUE_ELEMENT.get(editor)), editor.selection, types)?.focus.path ?? [];
+  }
+  const focusBlock = Array.from(Editor.nodes(editor, {
+    at: editor.selection.focus.path.slice(0, 1),
+    match: (n) => n._type === types.block.name
+  }))[0];
+  return Editor.insertNode(editor, block), focusBlock && isEqualToEmptyEditor([focusBlock[0]], types) && Transforms.removeNodes(editor, {
+    at: focusBlock[1]
+  }), editor.onChange(), toPortableTextRange(fromSlateValue(editor.children, types.block.name, KEY_TO_VALUE_ELEMENT.get(editor)), editor.selection, types)?.focus.path || [];
+};
 function isAnnotationActive({
   editor,
   annotation
@@ -5243,6 +5359,35 @@ const addAnnotationActionImplementation = ({
       type: "insert break"
     }
   });
+}, insertSpanActionImplementation = ({
+  context,
+  action
+}) => {
+  if (!action.editor.selection) {
+    console.error("Unable to perform action without selection", action);
+    return;
+  }
+  const [focusBlock, focusBlockPath] = Array.from(Editor.nodes(action.editor, {
+    at: action.editor.selection.focus.path,
+    match: (node) => action.editor.isTextBlock(node)
+  }))[0] ?? [void 0, void 0];
+  if (!focusBlock || !focusBlockPath) {
+    console.error("Unable to perform action without focus block", action);
+    return;
+  }
+  const markDefs = focusBlock.markDefs ?? [], annotations = action.annotations ? action.annotations.map((annotation) => ({
+    _type: annotation.name,
+    _key: context.keyGenerator(),
+    ...annotation.value
+  })) : void 0;
+  annotations && annotations.length > 0 && Transforms.setNodes(action.editor, {
+    markDefs: [...markDefs, ...annotations]
+  }), Transforms.insertNodes(action.editor, {
+    _type: "span",
+    _key: context.keyGenerator(),
+    text: action.text,
+    marks: [...annotations?.map((annotation) => annotation._key) ?? [], ...action.decorators ?? []]
+  });
 }, behaviorActionImplementations = {
   "annotation.add": addAnnotationActionImplementation,
   "annotation.remove": removeAnnotationActionImplementation,
@@ -5327,8 +5472,10 @@ const addAnnotationActionImplementation = ({
       at: location
     });
   },
+  "insert block object": insertBlockObjectActionImplementation,
   "insert break": insertBreakActionImplementation,
   "insert soft break": insertSoftBreakActionImplementation,
+  "insert span": insertSpanActionImplementation,
   "insert text": ({
     action
   }) => {
@@ -5355,6 +5502,11 @@ const addAnnotationActionImplementation = ({
   }) => {
     action.effect();
   },
+  paste: ({
+    action
+  }) => {
+    action.editor.insertData(action.clipboardData);
+  },
   select: ({
     action
   }) => {
@@ -5384,6 +5536,20 @@ function performAction({
       });
       break;
     }
+    case "insert block object": {
+      behaviorActionImplementations["insert block object"]({
+        context,
+        action
+      });
+      break;
+    }
+    case "insert span": {
+      behaviorActionImplementations["insert span"]({
+        context,
+        action
+      });
+      break;
+    }
     case "insert text block": {
       behaviorActionImplementations["insert text block"]({
         context,
@@ -5515,11 +5681,18 @@ function performDefaultAction({
       });
       break;
     }
-    default:
+    case "insert text": {
       behaviorActionImplementations["insert text"]({
         context,
         action
       });
+      break;
+    }
+    default:
+      behaviorActionImplementations.paste({
+        context,
+        action
+      });
   }
 }
 const networkLogic = fromCallback(({
@@ -6585,19 +6758,13 @@ const debug = debugWithName("component:Editable"), PLACEHOLDER_STYLE = {
   const handleCopy = useCallback((event) => {
     onCopy && onCopy(event) !== void 0 && event.preventDefault();
   }, [onCopy]), handlePaste = useCallback((event_0) => {
-    if (event_0.preventDefault(), !slateEditor.selection)
-      return;
-    if (!onPaste) {
-      debug("Pasting normally"), slateEditor.insertData(event_0.clipboardData);
-      return;
-    }
-    const value_0 = PortableTextEditor.getValue(portableTextEditor), path = toPortableTextRange(value_0, slateEditor.selection, schemaTypes)?.focus.path || [], onPasteResult = onPaste({
+    const value_0 = PortableTextEditor.getValue(portableTextEditor), path = toPortableTextRange(value_0, slateEditor.selection, schemaTypes)?.focus.path || [], onPasteResult = onPaste?.({
       event: event_0,
       value: value_0,
       path,
       schemaTypes
     });
-    onPasteResult === void 0 ? (debug("No result from custom paste handler, pasting normally"), slateEditor.insertData(event_0.clipboardData)) : (editorActor.send({
+    onPasteResult || !slateEditor.selection ? (event_0.preventDefault(), editorActor.send({
       type: "loading"
     }), Promise.resolve(onPasteResult).then((result_0) => {
       debug("Custom paste function from client resolved", result_0), !result_0 || !result_0.insert ? (debug("No result from custom paste handler, pasting normally"), slateEditor.insertData(event_0.clipboardData)) : result_0.insert ? slateEditor.insertFragment(toSlateValue(result_0.insert, {
@@ -6607,7 +6774,14 @@ const debug = debugWithName("component:Editable"), PLACEHOLDER_STYLE = {
       editorActor.send({
         type: "done loading"
       });
-    }));
+    })) : event_0.nativeEvent.clipboardData && (event_0.preventDefault(), editorActor.send({
+      type: "behavior event",
+      behaviorEvent: {
+        type: "paste",
+        clipboardData: event_0.nativeEvent.clipboardData
+      },
+      editor: slateEditor
+    })), debug("No result from custom paste handler, pasting normally");
   }, [editorActor, onPaste, portableTextEditor, schemaTypes, slateEditor]), handleOnFocus = useCallback((event_1) => {
     if (onFocus && onFocus(event_1), !event_1.isDefaultPrevented()) {
       const selection = PortableTextEditor.getSelection(portableTextEditor);
@@ -6622,15 +6796,11 @@ const debug = debugWithName("component:Editable"), PLACEHOLDER_STYLE = {
       });
     }
   }, [editorActor, onFocus, portableTextEditor, slateEditor]), handleClick = useCallback((event_2) => {
-    if (onClick && onClick(event_2), slateEditor.selection && event_2.target === event_2.currentTarget) {
-      const [lastBlock, path_0] = Node.last(slateEditor, []), focusPath = slateEditor.selection.focus.path.slice(0, 1), lastPath = path_0.slice(0, 1);
-      if (Path.equals(focusPath, lastPath)) {
-        const node = Node.descendant(slateEditor, path_0.slice(0, 1));
-        lastBlock && Editor.isVoid(slateEditor, node) && (Transforms.insertNodes(slateEditor, slateEditor.pteCreateTextBlock({
-          decorators: []
-        })), slateEditor.onChange());
-      }
-    }
+    onClick && onClick(event_2);
+    const focusBlockPath = slateEditor.selection ? slateEditor.selection.focus.path.slice(0, 1) : void 0, focusBlock = focusBlockPath ? Node.descendant(slateEditor, focusBlockPath) : void 0, [_, lastNodePath] = Node.last(slateEditor, []), lastBlockPath = lastNodePath.slice(0, 1), lastNodeFocused = focusBlockPath ? Path.equals(lastBlockPath, focusBlockPath) : !1, lastBlockIsVoid = focusBlock ? !slateEditor.isTextBlock(focusBlock) : !1;
+    slateEditor.selection && Range.isCollapsed(slateEditor.selection) && lastNodeFocused && lastBlockIsVoid && (Transforms.insertNodes(slateEditor, slateEditor.pteCreateTextBlock({
+      decorators: []
+    })), slateEditor.onChange());
   }, [onClick, slateEditor]), handleOnBlur = useCallback((event_3) => {
     onBlur && onBlur(event_3), event_3.isPropagationStopped() || editorActor.send({
       type: "blur",
@@ -6678,7 +6848,7 @@ const debug = debugWithName("component:Editable"), PLACEHOLDER_STYLE = {
       return scrollSelectionIntoView === null ? noop : (_editor, domRange) => {
         scrollSelectionIntoView(portableTextEditor, domRange);
       };
-  }, [portableTextEditor, scrollSelectionIntoView]), decorate = useCallback(([, path_1]) => {
+  }, [portableTextEditor, scrollSelectionIntoView]), decorate = useCallback(([, path_0]) => {
     if (isEqualToEmptyEditor(slateEditor.children, schemaTypes))
       return [{
         anchor: {
@@ -6691,18 +6861,18 @@ const debug = debugWithName("component:Editable"), PLACEHOLDER_STYLE = {
         },
         placeholder: !0
       }];
-    if (path_1.length === 0)
+    if (path_0.length === 0)
       return [];
-    const result_1 = rangeDecorationState.filter((item) => Range.isCollapsed(item) ? path_1.length !== 2 ? !1 : Path.equals(item.focus.path, path_1) && Path.equals(item.anchor.path, path_1) : Range.intersection(item, {
+    const result_1 = rangeDecorationState.filter((item) => Range.isCollapsed(item) ? path_0.length !== 2 ? !1 : Path.equals(item.focus.path, path_0) && Path.equals(item.anchor.path, path_0) : Range.intersection(item, {
       anchor: {
-        path: path_1,
+        path: path_0,
         offset: 0
       },
       focus: {
-        path: path_1,
+        path: path_0,
         offset: 0
       }
-    }) || Range.includes(item, path_1));
+    }) || Range.includes(item, path_0));
     return result_1.length > 0 ? result_1 : [];
   }, [slateEditor, schemaTypes, rangeDecorationState]);
   return useEffect(() => {
@@ -6773,6 +6943,7 @@ export {
   PortableTextEditor,
   coreBehavior,
   coreBehaviors,
+  createLinkBehaviors,
   createMarkdownBehaviors,
   defineBehavior,
   defineSchema,