@contentful/field-editor-rich-text 3.15.0 → 3.15.1

package/dist/esm/plugins/List/__tests__/insertListBreak.test.js

@@ -1,68 +1,72 @@
-import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
+/** @jsx jsx */ import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
 describe('insert line break', ()=>{
     const tests = [
+        // single p
         {
             title: 'at the start of a li',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("cursor", null), "p1"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("cursor", null))), jsx("hli", null, jsx("hp", null, "p1")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null), "p1"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1")))
         },
         {
             title: 'at the end of a li',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1")), jsx("hli", null, jsx("hp", null, jsx("cursor", null))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))))
         },
         {
             title: 'at the middle of a li',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "split ", jsx("cursor", null), "me"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "split ")), jsx("hli", null, jsx("hp", null, jsx("cursor", null), "me")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "split ", /*#__PURE__*/ jsx("cursor", null), "me"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "split ")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null), "me")))
         },
+        // multi p
         {
             title: 'at the start of a li with multiple p',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("cursor", null), "p1"), jsx("hp", null, "p2"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("cursor", null))), jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, "p2")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null), "p1"), /*#__PURE__*/ jsx("hp", null, "p2"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, "p2")))
         },
         {
             title: 'at the start of the second p of a li',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, jsx("cursor", null), "p2"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1")), jsx("hli", null, jsx("hp", null, jsx("cursor", null)), jsx("hp", null, "p2")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null), "p2"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hp", null, "p2")))
         },
         {
             title: 'at the end of a li with multiple p',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, "p2", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, "p2")), jsx("hli", null, jsx("hp", null, jsx("cursor", null))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, "p2")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))))
         },
         {
             title: 'at the middle of a li with multiple p',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "split ", jsx("cursor", null), "me"), jsx("hp", null, "move me"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "split ")), jsx("hli", null, jsx("hp", null, jsx("cursor", null), "me"), jsx("hp", null, "move me")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "split ", /*#__PURE__*/ jsx("cursor", null), "me"), /*#__PURE__*/ jsx("hp", null, "move me"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "split ")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null), "me"), /*#__PURE__*/ jsx("hp", null, "move me")))
         },
+        // with headings
         {
             title: 'at the start of a li with heading',
-            input: jsx("hul", null, jsx("hli", null, jsx("hh1", null, jsx("cursor", null), "p1"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("cursor", null))), jsx("hli", null, jsx("hh1", null, "p1")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, /*#__PURE__*/ jsx("cursor", null), "p1"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "p1")))
         },
         {
             title: 'at the end of a li with heading',
-            input: jsx("hul", null, jsx("hli", null, jsx("hh1", null, "p1", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hh1", null, "p1")), jsx("hli", null, jsx("hp", null, jsx("cursor", null))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "p1", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null))))
         },
         {
             title: 'at the middle of a li with heading',
-            input: jsx("hul", null, jsx("hli", null, jsx("hh1", null, "split ", jsx("cursor", null), "me"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hh1", null, "split ")), jsx("hli", null, jsx("hh1", null, jsx("cursor", null), "me")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "split ", /*#__PURE__*/ jsx("cursor", null), "me"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "split ")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, /*#__PURE__*/ jsx("cursor", null), "me")))
         },
         {
             title: 'at a li with nested list',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "item 1")), jsx("hli", null, jsx("hp", null, "item 2", jsx("cursor", null)), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub list"))))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "item 1")), jsx("hli", null, jsx("hp", null, "item 2")), jsx("hli", null, jsx("hp", null, jsx("cursor", null)), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub list")))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "item 1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "item 2", /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub list"))))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "item 1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "item 2")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub list")))))
         }
     ];
-    const render = (children)=>jsx("editor", null, children, jsx("hp", null, jsx("htext", null)));
+    const render = (children)=>/*#__PURE__*/ jsx("editor", null, children, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
     for (const t of tests){
         test(t.title, ()=>{
-            const { editor  } = createTestEditor({
+            const { editor } = createTestEditor({
                 input: render(t.input)
             });
+            // Equivalent of pressing ENTER
             editor.insertBreak();
             assertOutput({
                 editor,

package/dist/esm/plugins/List/__tests__/insertListFragment.test.js

@@ -1,53 +1,53 @@
-import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
+/** @jsx jsx */ import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
 describe('insert fragment', ()=>{
     const tests = [
         {
             title: 'text wrapped in li > p',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello ", jsx("cursor", null)))),
-            fragment: jsx("fragment", null, jsx("hli", null, jsx("hp", null, "world"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello world")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello ", /*#__PURE__*/ jsx("cursor", null)))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "world"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello world")))
         },
         {
             title: 'text wrapped in li > h*',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello ", jsx("cursor", null)))),
-            fragment: jsx("fragment", null, jsx("hli", null, jsx("hh1", null, "world"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello world")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello ", /*#__PURE__*/ jsx("cursor", null)))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hh1", null, "world"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello world")))
         },
         {
             title: 'single li with only asset card',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello", jsx("cursor", null), "world"))),
-            fragment: jsx("fragment", null, jsx("hli", null, jsx("hembed", {
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello", /*#__PURE__*/ jsx("cursor", null), "world"))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "asset-id"
             }))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello"), jsx("hembed", {
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello"), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "asset-id"
-            }), jsx("hp", null, "world")))
+            }), /*#__PURE__*/ jsx("hp", null, "world")))
         },
         {
             title: 'two paragraphs',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello ", jsx("cursor", null)))),
-            fragment: jsx("fragment", null, jsx("hp", null, "world"), jsx("hp", null, "line 2")),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello world"), jsx("hp", null, "line 2")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello ", /*#__PURE__*/ jsx("cursor", null)))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hp", null, "world"), /*#__PURE__*/ jsx("hp", null, "line 2")),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello world"), /*#__PURE__*/ jsx("hp", null, "line 2")))
         },
         {
             title: 'two headings',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello ", jsx("cursor", null)))),
-            fragment: jsx("fragment", null, jsx("hh1", null, "world"), jsx("hh1", null, "line 2")),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello world"), jsx("hh1", null, "line 2")))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello ", /*#__PURE__*/ jsx("cursor", null)))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hh1", null, "world"), /*#__PURE__*/ jsx("hh1", null, "line 2")),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello world"), /*#__PURE__*/ jsx("hh1", null, "line 2")))
         },
         {
             title: 'two paragraphs wrapped in a li',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello ", jsx("cursor", null)))),
-            fragment: jsx("fragment", null, jsx("hli", null, jsx("hp", null, "world"), jsx("hp", null, "line 2"))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "hello "), jsx("hul", null, jsx("hli", null, jsx("hp", null, "world"), jsx("hp", null, "line 2")))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello ", /*#__PURE__*/ jsx("cursor", null)))),
+            fragment: /*#__PURE__*/ jsx("fragment", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "world"), /*#__PURE__*/ jsx("hp", null, "line 2"))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "hello "), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "world"), /*#__PURE__*/ jsx("hp", null, "line 2")))))
         }
     ];
-    const render = (children)=>jsx("editor", null, children, jsx("hp", null, jsx("htext", null)));
+    const render = (children)=>/*#__PURE__*/ jsx("editor", null, children, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
     for (const t of tests){
         test(t.title, ()=>{
-            const { editor  } = createTestEditor({
+            const { editor } = createTestEditor({
                 input: render(t.input)
             });
             editor.insertFragment(t.fragment);

package/dist/esm/plugins/List/components/List.js

@@ -36,7 +36,7 @@ const styles = {
 };
 function createList(Tag, block) {
     return function List(props) {
-        return React.createElement(Tag, {
+        return /*#__PURE__*/ React.createElement(Tag, {
             ...props.attributes,
             className: cx(baseStyle, styles[block])
         }, props.children);

package/dist/esm/plugins/List/components/ListItem.js

@@ -12,7 +12,7 @@ const style = css`
   }
 `;
 export function ListItem(props) {
-    return React.createElement("li", {
+    return /*#__PURE__*/ React.createElement("li", {
         ...props.attributes,
         className: style
     }, props.children);

package/dist/esm/plugins/List/components/ToolbarListButton.js

@@ -21,17 +21,17 @@ export function ToolbarListButton(props) {
         };
     }
     if (!editor) return null;
-    return React.createElement(React.Fragment, null, isNodeTypeEnabled(sdk.field, BLOCKS.UL_LIST) && React.createElement(ToolbarButton, {
+    return /*#__PURE__*/ React.createElement(React.Fragment, null, isNodeTypeEnabled(sdk.field, BLOCKS.UL_LIST) && /*#__PURE__*/ React.createElement(ToolbarButton, {
         title: "UL",
         testId: "ul-toolbar-button",
         onClick: handleClick(BLOCKS.UL_LIST),
         isActive: isListTypeActive(editor, BLOCKS.UL_LIST),
         isDisabled: props.isDisabled
-    }, React.createElement(ListBulletedIcon, null)), isNodeTypeEnabled(sdk.field, BLOCKS.OL_LIST) && React.createElement(ToolbarButton, {
+    }, /*#__PURE__*/ React.createElement(ListBulletedIcon, null)), isNodeTypeEnabled(sdk.field, BLOCKS.OL_LIST) && /*#__PURE__*/ React.createElement(ToolbarButton, {
         title: "OL",
         testId: "ol-toolbar-button",
         onClick: handleClick(BLOCKS.OL_LIST),
         isActive: isListTypeActive(editor, BLOCKS.OL_LIST),
         isDisabled: props.isDisabled
-    }, React.createElement(ListNumberedIcon, null)));
+    }, /*#__PURE__*/ React.createElement(ListNumberedIcon, null)));
 }

package/dist/esm/plugins/List/createListPlugin.js

@@ -28,6 +28,8 @@ export const createListPlugin = ()=>createPlateListPlugin({
                 handlers: {
                     onKeyDown: onKeyDownList
                 },
+                // The withList is added on ELEMENT_UL plugin in upstream code
+                // so we need to override it here
                 withOverrides: withList
             },
             [ELEMENT_OL]: {
@@ -37,12 +39,14 @@ export const createListPlugin = ()=>createPlateListPlugin({
                     onKeyDown: onKeyDownList
                 }
             },
+            // ELEMENT_LIC is a child of li, Slate does ul > li > lic + ul
             [ELEMENT_LIC]: {
                 type: BLOCKS.PARAGRAPH
             },
             [ELEMENT_LI]: {
                 type: BLOCKS.LIST_ITEM,
                 component: ListItem,
+                // @ts-expect-error
                 normalizer: [
                     {
                         validNode: hasListAsDirectParent,

package/dist/esm/plugins/List/insertListBreak.js

@@ -1,4 +1,9 @@
-import { TEXT_CONTAINERS } from '@contentful/rich-text-types';
+/**
+ * Credit: Copied & modified version from Plate's list plugin to support
+ * list items with multiple children.
+ *
+ * See: https://github.com/udecode/plate/blob/main/packages/nodes/list
+ */ import { TEXT_CONTAINERS } from '@contentful/rich-text-types';
 import { ELEMENT_DEFAULT, getPluginType, isBlockAboveEmpty, mockPlugin } from '@udecode/plate-common';
 import { getListItemEntry, moveListItemUp, unwrapList, ELEMENT_LI } from '@udecode/plate-list';
 import { onKeyDownResetNode, SIMULATE_BACKSPACE } from '@udecode/plate-reset-node';
@@ -7,9 +12,11 @@ const listBreak = (editor)=>{
     if (!editor.selection) return false;
     const res = getListItemEntry(editor, {});
     let moved;
+    // If selection is in a li
     if (res) {
-        const { list , listItem  } = res;
+        const { list, listItem } = res;
         const childNode = listItem[0].children[0];
+        // If selected li is empty, move it up.
         if (isBlockAboveEmpty(editor) && listItem[0].children.length === 1 && TEXT_CONTAINERS.includes(childNode.type)) {
             moved = moveListItemUp(editor, {
                 list,
@@ -35,14 +42,16 @@ const listBreak = (editor)=>{
     if (didReset) {
         return true;
     }
-    if (!moved) {
+    /**
+   * If selection is in li > p, insert li.
+   */ if (!moved) {
         const inserted = insertListItem(editor);
         if (inserted) return true;
     }
     return false;
 };
 export const insertListBreak = (editor)=>{
-    const { insertBreak  } = editor;
+    const { insertBreak } = editor;
     return ()=>{
         if (listBreak(editor)) return;
         insertBreak();

package/dist/esm/plugins/List/insertListFragment.js

@@ -1,4 +1,7 @@
-import { TEXT_CONTAINERS, BLOCKS } from '@contentful/rich-text-types';
+/**
+ * Credit: Modified version of Plate's list plugin
+ * See: https://github.com/udecode/plate/blob/main/packages/nodes/list
+ */ import { TEXT_CONTAINERS, BLOCKS } from '@contentful/rich-text-types';
 import { findNode } from '@udecode/plate-common';
 import { isBlockNode, isAncestorPath, getCommonNode, getNodeTexts, getParentPath, getDescendantNodeByPath } from '../../internal/queries';
 import { insertNodes } from '../../internal/transforms';
@@ -16,19 +19,26 @@ const isListRoot = (node)=>[
         BLOCKS.UL_LIST,
         BLOCKS.OL_LIST
     ].includes(node.type);
-const trimList = (listRoot)=>{
+/**
+ * Removes the "empty" leading lis. Empty in this context means lis only with other lis as children.
+ *
+ * @returns If argument is not a list root, returns it, otherwise returns ul[] or li[].
+ */ const trimList = (listRoot)=>{
     if (!isListRoot(listRoot)) {
         return [
             listRoot
         ];
     }
     const textEntries = Array.from(getNodeTexts(listRoot));
-    const commonAncestorEntry = textEntries.reduce((commonAncestor, textEntry)=>isAncestorPath(commonAncestor[1], textEntry[1]) ? commonAncestor : getCommonNode(listRoot, textEntry[1], commonAncestor[1]), getFirstAncestorOfType(listRoot, textEntries[0]));
+    const commonAncestorEntry = textEntries.reduce((commonAncestor, textEntry)=>isAncestorPath(commonAncestor[1], textEntry[1]) ? commonAncestor : getCommonNode(listRoot, textEntry[1], commonAncestor[1]), // any list item would do, we grab the first one
+    getFirstAncestorOfType(listRoot, textEntries[0]));
     return isListRoot(commonAncestorEntry[0]) ? commonAncestorEntry[0].children : [
         commonAncestorEntry[0]
     ];
 };
-const trimLiWrapper = (nodes)=>{
+/**
+ * Removes leading li when pasting a single li with a single child.
+ */ const trimLiWrapper = (nodes)=>{
     if (nodes.length !== 1) {
         return nodes;
     }
@@ -49,7 +59,7 @@ const unwrapTextContainerAtStart = (nodes)=>{
     return nodes;
 };
 export const insertListFragment = (editor)=>{
-    const { insertFragment  } = editor;
+    const { insertFragment } = editor;
     return (fragment)=>{
         if (!editor.selection) {
             return;
@@ -68,6 +78,9 @@ export const insertListFragment = (editor)=>{
             }
             const inlines = nodes.slice(0, firstBlockIndex);
             const blocks = nodes.slice(firstBlockIndex);
+            // Two calls to insertNodes are required here. Otherwise, all blocks
+            // after a text or inline element occurrence will be unwrapped for
+            // some reason.
             insertNodes(editor, inlines, {
                 at: editor.selection,
                 select: true

package/dist/esm/plugins/List/onKeyDownList.js

@@ -1,9 +1,12 @@
-import isHotkey from 'is-hotkey';
+/**
+ * Credit: Modified version of Plate's list plugin
+ * See: https://github.com/udecode/plate/blob/main/packages/nodes/list
+ */ import isHotkey from 'is-hotkey';
 import castArray from 'lodash/castArray';
 import { getAboveNode } from '../../internal/queries';
 import { moveListItems } from './transforms/moveListItems';
 import { toggleList } from './transforms/toggleList';
-export const onKeyDownList = (editor, { type , options: { hotkey  }  })=>(e)=>{
+export const onKeyDownList = (editor, { type, options: { hotkey } })=>(e)=>{
         if (e.key === 'Tab' && editor.selection) {
             const listSelected = getAboveNode(editor, {
                 at: editor.selection,

package/dist/esm/plugins/List/transforms/insertListItem.js

@@ -2,7 +2,9 @@ import { BLOCKS, TEXT_CONTAINERS } from '@contentful/rich-text-types';
 import { withoutNormalizing } from '../../../internal';
 import { getAboveNode, getParentNode, isFirstChildPath, isSelectionAtBlockEnd, isSelectionAtBlockStart, getMarks, getNextPath } from '../../../internal/queries';
 import { select, insertNodes, moveChildren, splitNodes, collapseSelection } from '../../../internal/transforms';
-const emptyListItemNode = (editor, withChildren = false)=>{
+/**
+ * Build a new list item node while preserving marks
+ */ const emptyListItemNode = (editor, withChildren = false)=>{
     let children = [];
     if (withChildren) {
         const marks = getMarks(editor) || {};
@@ -25,10 +27,13 @@ const emptyListItemNode = (editor, withChildren = false)=>{
         children
     };
 };
-export const insertListItem = (editor)=>{
+/**
+ * Insert list item if selection is in li>p.
+ */ export const insertListItem = (editor)=>{
     if (!editor.selection) {
         return false;
     }
+    // Naming it paragraph for simplicity but can be a heading as well
     const paragraph = getAboveNode(editor, {
         match: {
             type: TEXT_CONTAINERS
@@ -46,23 +51,33 @@ export const insertListItem = (editor)=>{
     if (listItemNode.type !== BLOCKS.LIST_ITEM) {
         return false;
     }
+    // We are in a li>p (or heading)
     withoutNormalizing(editor, ()=>{
         if (!editor.selection) {
             return;
         }
+        // Check the cursor position in the current paragraph
         const isAtStart = isSelectionAtBlockStart(editor);
         const isAtEnd = isSelectionAtBlockEnd(editor);
         const isAtStartOfListItem = isAtStart && isFirstChildPath(paragraphPath);
         const shouldSplit = !isAtStart && !isAtEnd;
+        // Split the current paragraph content if necessary
         if (shouldSplit) {
             splitNodes(editor);
         }
+        // Insert the new li
         const newListItemPath = isAtStartOfListItem ? listItemPath : getNextPath(listItemPath);
-        insertNodes(editor, emptyListItemNode(editor, !shouldSplit), {
+        insertNodes(editor, // Add an empty paragraph to the new li if We will not move some
+        // paragraphs over there.
+        emptyListItemNode(editor, !shouldSplit), {
             at: newListItemPath
         });
+        // Move children *after* selection to the new li
         const fromPath = isAtStart ? paragraphPath : getNextPath(paragraphPath);
         const fromStartIndex = fromPath[fromPath.length - 1] || 0;
+        // On split we don't add paragraph to the new li so we move
+        // content to the very beginning. Otherwise, account for the empty
+        // paragraph at the beginning by moving the content after
         const toPath = newListItemPath.concat([
             shouldSplit ? 0 : 1
         ]);
@@ -73,10 +88,12 @@ export const insertListItem = (editor)=>{
                 fromStartIndex
             });
         }
+        // Move cursor to the start of the new li
         select(editor, newListItemPath);
         collapseSelection(editor, {
             edge: 'start'
         });
     });
+    // Returning True skips processing other editor.insertBreak handlers
     return true;
 };

package/dist/esm/plugins/List/transforms/moveListItemDown.js

@@ -1,8 +1,11 @@
-import { getListTypes } from '@udecode/plate-list';
+/**
+ * Credit: Modified version of Plate's list plugin
+ * See: https://github.com/udecode/plate/blob/main/packages/nodes/list
+ */ import { getListTypes } from '@udecode/plate-list';
 import { withoutNormalizing } from '../../../internal';
 import { getNodeEntry, getNodeChildren, getNextPath, getPreviousPath, getLastChildPath, match } from '../../../internal/queries';
 import { wrapNodes, moveNodes } from '../../../internal/transforms';
-export const moveListItemDown = (editor, { list , listItem  })=>{
+export const moveListItemDown = (editor, { list, listItem })=>{
     const [listNode] = list;
     const [, listItemPath] = listItem;
     let previousListItemPath;
@@ -11,6 +14,7 @@ export const moveListItemDown = (editor, { list , listItem  })=>{
     } catch (e) {
         return;
     }
+    // Previous sibling is the new parent
     const previousSiblingItem = getNodeEntry(editor, previousListItemPath);
     if (previousSiblingItem) {
         const [, previousPath] = previousSiblingItem;
@@ -20,6 +24,7 @@ export const moveListItemDown = (editor, { list , listItem  })=>{
         const newPath = getNextPath(getLastChildPath(subList ?? previousSiblingItem));
         withoutNormalizing(editor, ()=>{
             if (!subList) {
+                // Create new sub-list
                 wrapNodes(editor, {
                     type: listNode.type,
                     children: [],
@@ -28,6 +33,7 @@ export const moveListItemDown = (editor, { list , listItem  })=>{
                     at: listItemPath
                 });
             }
+            // Move the current item to the sub-list
             moveNodes(editor, {
                 at: listItemPath,
                 to: newPath

package/dist/esm/plugins/List/transforms/moveListItems.js

@@ -1,18 +1,23 @@
-import { isListNested, ELEMENT_LIC, getListItemEntry, moveListItemUp } from '@udecode/plate-list';
+/**
+ * Credit: Modified version of Plate's list plugin
+ * See: https://github.com/udecode/plate/blob/main/packages/nodes/list
+ */ import { isListNested, ELEMENT_LIC, getListItemEntry, moveListItemUp } from '@udecode/plate-list';
 import { withoutNormalizing } from '../../../internal';
 import { getNodeEntries, getPluginType, createPathRef, getParentPath, isAncestorPath } from '../../../internal/queries';
 import { moveListItemDown } from './moveListItemDown';
-export const moveListItems = (editor, { increase =true , at =editor.selection ?? undefined  } = {})=>{
+export const moveListItems = (editor, { increase = true, at = editor.selection ?? undefined } = {})=>{
     const _nodes = getNodeEntries(editor, {
         at,
         match: {
             type: getPluginType(editor, ELEMENT_LIC)
         }
     });
+    // Get the selected lic
     const lics = Array.from(_nodes);
     if (!lics.length) return;
     const highestLicPaths = [];
     const highestLicPathRefs = [];
+    // Filter out the nested lic, we just need to move the highest ones
     lics.forEach((lic)=>{
         const licPath = lic[1];
         const liPath = getParentPath(licPath);

package/dist/esm/plugins/List/transforms/moveListItems.test.js

@@ -1,12 +1,13 @@
-import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
+/** @jsx jsx */ import { jsx, assertOutput, createTestEditor } from '../../../test-utils';
 import { moveListItems } from './moveListItems';
 describe('moving list items (up/down)', ()=>{
-    const renderEditor = (children)=>jsx("editor", null, children, jsx("hp", null, jsx("htext", null)));
+    const renderEditor = (children)=>/*#__PURE__*/ jsx("editor", null, children, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
     const assertTab = (t, shift = false)=>{
         test(t.title, ()=>{
-            const { editor  } = createTestEditor({
+            const { editor } = createTestEditor({
                 input: renderEditor(t.input)
             });
+            // Equivalent of pressing (SHIFT+)TAB
             moveListItems(editor, {
                 increase: !shift
             });
@@ -19,37 +20,37 @@ describe('moving list items (up/down)', ()=>{
     const tests = [
         {
             title: 'single paragraph',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1")), jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null))))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null))))))
         },
         {
             title: 'multiple paragraphs',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, "p2")), jsx("hli", null, jsx("hp", null, "p3", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hp", null, "p2"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "p3", jsx("cursor", null))))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, "p2")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p3", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hp", null, "p2"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p3", /*#__PURE__*/ jsx("cursor", null))))))
         },
         {
             title: 'multiple elements',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "a"), jsx("hp", null, "b"), jsx("hquote", null, jsx("hp", null, "quote"))), jsx("hli", null, jsx("hp", null, "c", jsx("cursor", null)), jsx("hp", null, "d"), jsx("hembed", {
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "a"), /*#__PURE__*/ jsx("hp", null, "b"), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "quote"))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "c", /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hp", null, "d"), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "asset-id"
             }))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "a"), jsx("hp", null, "b"), jsx("hquote", null, jsx("hp", null, "quote")), jsx("hul", null, jsx("hli", null, jsx("hp", null, "c", jsx("cursor", null)), jsx("hp", null, "d"), jsx("hembed", {
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "a"), /*#__PURE__*/ jsx("hp", null, "b"), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "quote")), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "c", /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hp", null, "d"), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "asset-id"
             })))))
         },
         {
             title: 'with a sub-list',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub p1")))), jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub p1")), jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null))))))
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub p1")))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null))))))
         },
         {
             title: 'with a sub-list as non-last child',
-            input: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub p1"))), jsx("hembed", {
+            input: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub p1"))), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "entry-id"
-            })), jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null)))),
-            expected: jsx("hul", null, jsx("hli", null, jsx("hp", null, "p1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "sub p1")), jsx("hli", null, jsx("hp", null, "p2", jsx("cursor", null)))), jsx("hembed", {
+            })), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null)))),
+            expected: /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "sub p1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "p2", /*#__PURE__*/ jsx("cursor", null)))), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "entry-id"
             })))