@portabletext/editor 1.7.1 → 1.8.0

package/lib/index.d.mts

@@ -124,6 +124,13 @@ export declare type Behavior<
  */
 export declare type BehaviorActionIntend =
   | BehaviorEvent
+  | {
+      type: 'insert block object'
+      name: string
+      value?: {
+        [prop: string]: unknown
+      }
+    }
   | {
       type: 'insert text block'
       decorators: Array<string>
@@ -524,14 +531,6 @@ export declare const coreBehaviors: Behavior<
   true
 >[]
 
-/**
- * @internal
- */
-export declare type createEditorOptions = {
-  editorActor: EditorActor
-  subscriptions: Array<() => () => void>
-}
-
 /**
  * @alpha
  */
@@ -5787,18 +5786,28 @@ export declare type LoadingChange = {
  * @alpha
  */
 export declare type MarkdownBehaviorsConfig = {
-  mapDefaultStyle: (schema: PortableTextMemberSchemaTypes) => string | undefined
-  mapHeadingStyle: (
+  mapBreakObject?: (schema: PortableTextMemberSchemaTypes) =>
+    | {
+        name: string
+        value?: {
+          [prop: string]: unknown
+        }
+      }
+    | undefined
+  mapDefaultStyle?: (
+    schema: PortableTextMemberSchemaTypes,
+  ) => string | undefined
+  mapHeadingStyle?: (
     schema: PortableTextMemberSchemaTypes,
     level: number,
   ) => string | undefined
-  mapBlockquoteStyle: (
+  mapBlockquoteStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
-  mapUnorderedListStyle: (
+  mapUnorderedListStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
-  mapOrderedListStyle: (
+  mapOrderedListStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
 }
@@ -6000,9 +6009,9 @@ export declare class PortableTextEditor extends Component<
     | []
     | [
         (
-          | PortableTextSpan
+          | PortableTextTextBlock<PortableTextObject | PortableTextSpan>
           | PortableTextObject
-          | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
+          | PortableTextSpan
           | undefined
         ),
         Path | undefined,

package/lib/index.d.ts

@@ -124,6 +124,13 @@ export declare type Behavior<
  */
 export declare type BehaviorActionIntend =
   | BehaviorEvent
+  | {
+      type: 'insert block object'
+      name: string
+      value?: {
+        [prop: string]: unknown
+      }
+    }
   | {
       type: 'insert text block'
       decorators: Array<string>
@@ -524,14 +531,6 @@ export declare const coreBehaviors: Behavior<
   true
 >[]
 
-/**
- * @internal
- */
-export declare type createEditorOptions = {
-  editorActor: EditorActor
-  subscriptions: Array<() => () => void>
-}
-
 /**
  * @alpha
  */
@@ -5787,18 +5786,28 @@ export declare type LoadingChange = {
  * @alpha
  */
 export declare type MarkdownBehaviorsConfig = {
-  mapDefaultStyle: (schema: PortableTextMemberSchemaTypes) => string | undefined
-  mapHeadingStyle: (
+  mapBreakObject?: (schema: PortableTextMemberSchemaTypes) =>
+    | {
+        name: string
+        value?: {
+          [prop: string]: unknown
+        }
+      }
+    | undefined
+  mapDefaultStyle?: (
+    schema: PortableTextMemberSchemaTypes,
+  ) => string | undefined
+  mapHeadingStyle?: (
     schema: PortableTextMemberSchemaTypes,
     level: number,
   ) => string | undefined
-  mapBlockquoteStyle: (
+  mapBlockquoteStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
-  mapUnorderedListStyle: (
+  mapUnorderedListStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
-  mapOrderedListStyle: (
+  mapOrderedListStyle?: (
     schema: PortableTextMemberSchemaTypes,
   ) => string | undefined
 }
@@ -6000,9 +6009,9 @@ export declare class PortableTextEditor extends Component<
     | []
     | [
         (
-          | PortableTextSpan
+          | PortableTextTextBlock<PortableTextObject | PortableTextSpan>
           | PortableTextObject
-          | PortableTextTextBlock<PortableTextSpan | PortableTextObject>
+          | PortableTextSpan
           | undefined
         ),
         Path | undefined,

package/lib/index.esm.js

@@ -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,7 @@ function createMarkdownBehaviors(config) {
       }
     }]]
   };
-  return [automaticBlockquoteOnSpace, automaticHeadingOnSpace, clearStyleOnBackspace, automaticListOnSpace];
+  return [automaticBlockquoteOnSpace, automaticBreak, automaticHeadingOnSpace, clearStyleOnBackspace, automaticListOnSpace];
 }
 function getPortableTextMemberSchemaTypes(portableTextType) {
   if (!portableTextType)
@@ -3925,21 +3982,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,
@@ -4752,32 +4794,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 +4975,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
@@ -5327,6 +5384,7 @@ const addAnnotationActionImplementation = ({
       at: location
     });
   },
+  "insert block object": insertBlockObjectActionImplementation,
   "insert break": insertBreakActionImplementation,
   "insert soft break": insertSoftBreakActionImplementation,
   "insert text": ({
@@ -5384,6 +5442,13 @@ function performAction({
       });
       break;
     }
+    case "insert block object": {
+      behaviorActionImplementations["insert block object"]({
+        context,
+        action
+      });
+      break;
+    }
     case "insert text block": {
       behaviorActionImplementations["insert text block"]({
         context,