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

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

@@ -1,4 +1,7 @@
-import { 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 { BLOCKS } from '@contentful/rich-text-types';
 import { ELEMENT_LIC } from '@udecode/plate-list';
 import { getListItemEntry } from '@udecode/plate-list';
 import { withoutNormalizing } from '../../../internal';
@@ -10,14 +13,15 @@ const listTypes = [
     BLOCKS.UL_LIST,
     BLOCKS.OL_LIST
 ];
-export const toggleList = (editor, { type  })=>withoutNormalizing(editor, ()=>{
+export const toggleList = (editor, { type })=>withoutNormalizing(editor, ()=>{
         if (!editor.selection) {
             return;
         }
         if (isRangeCollapsed(editor.selection) || !isRangeAcrossBlocks(editor)) {
+            // selection is collapsed
             const res = getListItemEntry(editor);
             if (res) {
-                const { list  } = res;
+                const { list } = res;
                 if (list[0].type !== type) {
                     setNodes(editor, {
                         type
@@ -55,6 +59,7 @@ export const toggleList = (editor, { type  })=>withoutNormalizing(editor, ()=>{
                 }
             }
         } else {
+            // selection is a range
             const [startPoint, endPoint] = getRangeEdges(editor.selection);
             const commonEntry = getCommonNode(editor, startPoint.path, endPoint.path);
             if (listTypes.includes(commonEntry[0].type) || commonEntry[0].type === BLOCKS.LIST_ITEM) {

package/dist/esm/plugins/List/transforms/toggleList.spec.js

@@ -1,11 +1,11 @@
-import { BLOCKS } from '@contentful/rich-text-types';
+/** @jsx jsx */ import { BLOCKS } from '@contentful/rich-text-types';
 import { assertOutput, jsx, createTestEditor } from '../../../test-utils';
 import { toggleList } from './toggleList';
 describe('toggle on', ()=>{
     it('should turn a p to list', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, "1", jsx("cursor", null)));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1", jsx("cursor", null)))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "1", /*#__PURE__*/ jsx("cursor", null)));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1", /*#__PURE__*/ jsx("cursor", null)))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -17,9 +17,9 @@ describe('toggle on', ()=>{
         });
     });
     it('should turn a p with a selection to list', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, "Planetas ", jsx("anchor", null), "mori in", jsx("focus", null), " gandavum!"));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "Planetas ", jsx("anchor", null), "mori in", jsx("focus", null), " gandavum!"))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "Planetas ", /*#__PURE__*/ jsx("anchor", null), "mori in", /*#__PURE__*/ jsx("focus", null), " gandavum!"));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "Planetas ", /*#__PURE__*/ jsx("anchor", null), "mori in", /*#__PURE__*/ jsx("focus", null), " gandavum!"))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -31,9 +31,9 @@ describe('toggle on', ()=>{
         });
     });
     it('should turn multiple p to list', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, jsx("anchor", null), "1"), jsx("hp", null, "2"), jsx("hp", null, "3", jsx("focus", null)));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("anchor", null), "1")), jsx("hli", null, jsx("hp", null, "2")), jsx("hli", null, jsx("hp", null, "3", jsx("focus", null)))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1"), /*#__PURE__*/ jsx("hp", null, "2"), /*#__PURE__*/ jsx("hp", null, "3", /*#__PURE__*/ jsx("focus", null)));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "2")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "3", /*#__PURE__*/ jsx("focus", null)))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -47,9 +47,9 @@ describe('toggle on', ()=>{
 });
 describe('toggle off', ()=>{
     it('should split a simple list to two', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1")), jsx("hli", null, jsx("hp", null, "2", jsx("cursor", null))), jsx("hli", null, jsx("hp", null, "3"))));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1"))), jsx("hp", null, "2", jsx("cursor", null)), jsx("hul", null, jsx("hli", null, jsx("hp", null, "3"))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "2", /*#__PURE__*/ jsx("cursor", null))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "3"))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"))), /*#__PURE__*/ jsx("hp", null, "2", /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "3"))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -61,9 +61,9 @@ describe('toggle off', ()=>{
         });
     });
     it('should split a nested list', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "11")), jsx("hli", null, jsx("hp", null, "12", jsx("cursor", null))), jsx("hli", null, jsx("hp", null, "13"))))));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "11"))))), jsx("hp", null, "12", jsx("cursor", null)), jsx("hul", null, jsx("hli", null, jsx("hp", null, "13"))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "12", /*#__PURE__*/ jsx("cursor", null))), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "13"))))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11"))))), /*#__PURE__*/ jsx("hp", null, "12", /*#__PURE__*/ jsx("cursor", null)), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "13"))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -75,9 +75,9 @@ describe('toggle off', ()=>{
         });
     });
     it('should turn a list to multiple p', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("anchor", null), "1")), jsx("hli", null, jsx("hp", null, "2")), jsx("hli", null, jsx("hp", null, "3", jsx("focus", null)))));
-        const expected = jsx("editor", null, jsx("hp", null, jsx("anchor", null), "1"), jsx("hp", null, "2"), jsx("hp", null, "3", jsx("focus", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "2")), /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "3", /*#__PURE__*/ jsx("focus", null)))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1"), /*#__PURE__*/ jsx("hp", null, "2"), /*#__PURE__*/ jsx("hp", null, "3", /*#__PURE__*/ jsx("focus", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -91,9 +91,9 @@ describe('toggle off', ()=>{
 });
 describe('toggle over', ()=>{
     it('should toggle different list types', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1", jsx("cursor", null)))));
-        const expected = jsx("editor", null, jsx("hol", null, jsx("hli", null, jsx("hp", null, "1"))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1", /*#__PURE__*/ jsx("cursor", null)))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hol", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -105,9 +105,9 @@ describe('toggle over', ()=>{
         });
     });
     it('should only toggle the nested list', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "11", jsx("cursor", null)))))));
-        const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "1"), jsx("hol", null, jsx("hli", null, jsx("hp", null, "11", jsx("cursor", null)))))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11", /*#__PURE__*/ jsx("cursor", null)))))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "1"), /*#__PURE__*/ jsx("hol", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11", /*#__PURE__*/ jsx("cursor", null)))))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {
@@ -119,9 +119,9 @@ describe('toggle over', ()=>{
         });
     });
     it('should only toggle everything that is selected', ()=>{
-        const input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("anchor", null), "1"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "11", jsx("focus", null)))))));
-        const expected = jsx("editor", null, jsx("hol", null, jsx("hli", null, jsx("hp", null, jsx("anchor", null), "1"), jsx("hol", null, jsx("hli", null, jsx("hp", null, "11", jsx("focus", null)))))), jsx("hp", null, jsx("htext", null)));
-        const { editor  } = createTestEditor({
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11", /*#__PURE__*/ jsx("focus", null)))))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hol", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("anchor", null), "1"), /*#__PURE__*/ jsx("hol", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "11", /*#__PURE__*/ jsx("focus", null)))))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
+        const { editor } = createTestEditor({
             input
         });
         toggleList(editor, {

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

@@ -1,4 +1,7 @@
-import { 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 { BLOCKS } from '@contentful/rich-text-types';
 import { withoutNormalizing } from '../../../internal';
 import { getNodeEntries, isElement } from '../../../internal/queries';
 import { unwrapNodes, liftNodes } from '../../../internal/transforms';
@@ -8,15 +11,17 @@ function hasUnliftedListItems(editor, at) {
         match: (node, path)=>isElement(node) && node.type === BLOCKS.LIST_ITEM && path.length >= 2
     }).next().done;
 }
-export const unwrapList = (editor, { at  } = {})=>{
+export const unwrapList = (editor, { at } = {})=>{
     withoutNormalizing(editor, ()=>{
         do {
+            // lift list items to the root level
             liftNodes(editor, {
                 at,
                 match: (node)=>isElement(node) && node.type === BLOCKS.LIST_ITEM,
                 mode: 'lowest'
             });
         }while (!hasUnliftedListItems(editor, at))
+        // finally unwrap all lifted items
         unwrapNodes(editor, {
             at,
             match: {

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

@@ -16,7 +16,11 @@ const getNearestListAncestor = (editor, path)=>{
         match: isList
     }) || [];
 };
-export const normalizeOrphanedListItem = (editor, [, path])=>{
+/**
+ * Places orphaned list items in a list. If there's a list somewhere
+ * in the node's ancestors, defaults to that list type, else places
+ * the list item in an unordered list.
+ */ export const normalizeOrphanedListItem = (editor, [, path])=>{
     const [parentList] = getNearestListAncestor(editor, path);
     const parentListType = parentList?.type;
     wrapNodes(editor, {
@@ -65,7 +69,7 @@ export const replaceNodeWithListItems = (editor, entry)=>{
     });
 };
 export const isListTypeActive = (editor, type)=>{
-    const { selection  } = editor;
+    const { selection } = editor;
     if (!selection) {
         return false;
     }
@@ -76,6 +80,7 @@ export const isListTypeActive = (editor, type)=>{
             return true;
         }
     }
+    // Lists can be nested. Here, we take the list type at the lowest level
     const listNode = getBlockAbove(editor, {
         match: {
             type: [

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

@@ -1,10 +1,13 @@
-import { LIST_ITEM_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 { LIST_ITEM_BLOCKS } from '@contentful/rich-text-types';
 import { normalizeList, deleteFragmentList, deleteForwardList } from '@udecode/plate-list';
 import { insertListBreak } from './insertListBreak';
 import { insertListFragment } from './insertListFragment';
 const validLiChildrenTypes = LIST_ITEM_BLOCKS;
 export const withList = (editor)=>{
-    const { deleteForward , deleteFragment  } = editor;
+    const { deleteForward, deleteFragment } = editor;
     editor.deleteForward = (unit)=>{
         if (deleteForwardList(editor)) return;
         deleteForward(unit);
@@ -15,6 +18,7 @@ export const withList = (editor)=>{
     };
     editor.insertBreak = insertListBreak(editor);
     editor.insertFragment = insertListFragment(editor);
+    // TODO: replace with our own Normalizer rules
     editor.normalizeNode = normalizeList(editor, {
         validLiChildrenTypes
     });

package/dist/esm/plugins/Marks/Bold.js

@@ -9,7 +9,7 @@ import { buildMarkEventHandler } from './helpers';
 export const ToolbarBoldButton = createMarkToolbarButton({
     title: 'Bold',
     mark: MARKS.BOLD,
-    icon: React.createElement(FormatBoldIcon, null)
+    icon: /*#__PURE__*/ React.createElement(FormatBoldIcon, null)
 });
 const styles = {
     bold: css({
@@ -17,7 +17,7 @@ const styles = {
     })
 };
 export function Bold(props) {
-    return React.createElement("strong", {
+    return /*#__PURE__*/ React.createElement("strong", {
         ...props.attributes,
         className: styles.bold
     }, props.children);

package/dist/esm/plugins/Marks/Code.js

@@ -8,7 +8,7 @@ import { buildMarkEventHandler } from './helpers';
 export const ToolbarCodeButton = createMarkToolbarButton({
     title: 'Code',
     mark: MARKS.CODE,
-    icon: React.createElement(CodeIcon, null)
+    icon: /*#__PURE__*/ React.createElement(CodeIcon, null)
 });
 export const ToolbarDropdownCodeButton = createMarkToolbarButton({
     title: 'Code',
@@ -21,7 +21,7 @@ const styles = {
     })
 };
 export function Code(props) {
-    return React.createElement("code", {
+    return /*#__PURE__*/ React.createElement("code", {
         ...props.attributes,
         className: styles.code
     }, props.children);
@@ -30,6 +30,12 @@ export const createCodePlugin = ()=>createDefaultCodePlugin({
         type: MARKS.CODE,
         component: Code,
         options: {
+            // We need to define multiple hotkeys here,
+            // - mod+/ -> QWERTY keyboard layout
+            // - mod+shift+7 -> QWERTZ keyboard layout
+            // The workaround like in packages/rich-text/src/plugins/CommandPalette/onKeyDown.ts is sadly not working here,
+            // as `shift+7` is not interpreted as `/` with the `mod` key by the OS.
+            // TODO: there are a lot more different keyboard layouts out there
             hotkey: [
                 'mod+/',
                 'mod+shift+7'

package/dist/esm/plugins/Marks/Italic.js

@@ -9,7 +9,7 @@ import { buildMarkEventHandler } from './helpers';
 export const ToolbarItalicButton = createMarkToolbarButton({
     title: 'Italic',
     mark: MARKS.ITALIC,
-    icon: React.createElement(FormatItalicIcon, null)
+    icon: /*#__PURE__*/ React.createElement(FormatItalicIcon, null)
 });
 const styles = {
     italic: css({
@@ -17,7 +17,7 @@ const styles = {
     })
 };
 export function Italic(props) {
-    return React.createElement("em", {
+    return /*#__PURE__*/ React.createElement("em", {
         ...props.attributes,
         className: styles.italic
     }, props.children);

package/dist/esm/plugins/Marks/Subscript.js

@@ -14,7 +14,7 @@ const styles = {
 export const ToolbarSubscriptButton = createMarkToolbarButton({
     title: 'Subscript',
     mark: MARKS.SUBSCRIPT,
-    icon: React.createElement(SubscriptIcon, {
+    icon: /*#__PURE__*/ React.createElement(SubscriptIcon, {
         viewBox: "0 0 23 18"
     })
 });
@@ -23,7 +23,7 @@ export const ToolbarDropdownSubscriptButton = createMarkToolbarButton({
     mark: MARKS.SUBSCRIPT
 });
 export function Subscript(props) {
-    return React.createElement("sub", {
+    return /*#__PURE__*/ React.createElement("sub", {
         ...props.attributes,
         className: styles.subscript
     }, props.children);

package/dist/esm/plugins/Marks/Superscript.js

@@ -14,14 +14,14 @@ const styles = {
 export const ToolbarSuperscriptButton = createMarkToolbarButton({
     title: 'Superscript',
     mark: MARKS.SUPERSCRIPT,
-    icon: React.createElement(SuperscriptIcon, null)
+    icon: /*#__PURE__*/ React.createElement(SuperscriptIcon, null)
 });
 export const ToolbarDropdownSuperscriptButton = createMarkToolbarButton({
     title: 'Superscript',
     mark: MARKS.SUPERSCRIPT
 });
 export function Superscript(props) {
-    return React.createElement("sup", {
+    return /*#__PURE__*/ React.createElement("sup", {
         ...props.attributes,
         className: styles.superscript
     }, props.children);

package/dist/esm/plugins/Marks/Underline.js

@@ -8,10 +8,10 @@ import { buildMarkEventHandler } from './helpers';
 export const ToolbarUnderlineButton = createMarkToolbarButton({
     title: 'Underline',
     mark: MARKS.UNDERLINE,
-    icon: React.createElement(FormatUnderlinedIcon, null)
+    icon: /*#__PURE__*/ React.createElement(FormatUnderlinedIcon, null)
 });
 export function Underline(props) {
-    return React.createElement("u", props.attributes, props.children);
+    return /*#__PURE__*/ React.createElement("u", props.attributes, props.children);
 }
 export const createUnderlinePlugin = ()=>createDefaultUnderlinePlugin({
         type: MARKS.UNDERLINE,

package/dist/esm/plugins/Marks/components/MarkToolbarButton.js

@@ -13,8 +13,8 @@ const styles = {
         color: tokens.blue600
     })
 };
-export const createMarkToolbarButton = ({ mark , title , icon  })=>{
-    const Mark = ({ isDisabled  })=>{
+export const createMarkToolbarButton = ({ mark, title, icon })=>{
+    const Mark = ({ isDisabled })=>{
         const editor = useContentfulEditor();
         const handleClick = React.useCallback(()=>{
             if (!editor?.selection) return;
@@ -29,7 +29,7 @@ export const createMarkToolbarButton = ({ mark , title , icon  })=>{
         ]);
         if (!editor) return null;
         if (!icon) {
-            return React.createElement(Menu.Item, {
+            return /*#__PURE__*/ React.createElement(Menu.Item, {
                 onClick: handleClick,
                 disabled: isDisabled,
                 className: cx({
@@ -38,7 +38,7 @@ export const createMarkToolbarButton = ({ mark , title , icon  })=>{
                 testId: `${mark}-toolbar-button`
             }, title);
         }
-        return React.createElement(ToolbarButton, {
+        return /*#__PURE__*/ React.createElement(ToolbarButton, {
             title: title,
             testId: `${mark}-toolbar-button`,
             onClick: handleClick,

package/dist/esm/plugins/Marks/helpers.js

@@ -13,7 +13,7 @@ export const toggleMarkAndDeactivateConflictingMarks = (editor, mark)=>{
         clear
     });
 };
-export const buildMarkEventHandler = (type)=>(editor, { options: { hotkey  }  })=>(event)=>{
+export const buildMarkEventHandler = (type)=>(editor, { options: { hotkey } })=>(event)=>{
             if (editor.selection && hotkey && isHotkey(hotkey, event)) {
                 event.preventDefault();
                 const isActive = isMarkActive(editor, type);

package/dist/esm/plugins/Normalizer/baseRules.js

@@ -4,8 +4,11 @@ import { transformWrapIn } from '../../helpers/transformers';
 import { getParentNode, isText } from '../../internal/queries';
 const isInline = (node)=>INLINE_TYPES.includes(node.type);
 const isTextContainer = (node)=>TEXT_CONTAINERS.includes(node.type);
+// Base rules are rules that must be enforced at all times regardless
+// of which plugins are enabled.
 export const baseRules = [
     {
+        // Wrap orphaned text nodes in a paragraph
         match: isText,
         validNode: (editor, [, path])=>{
             const parent = getParentNode(editor, path)?.[0];
@@ -16,6 +19,7 @@ export const baseRules = [
         }
     },
     {
+        // Wrap orphaned inline nodes in a paragraph,
         match: {
             type: INLINE_TYPES
         },

package/dist/esm/plugins/Normalizer/createNormalizerPlugin.test.js

@@ -1,4 +1,4 @@
-import { BLOCKS, INLINES } from '@contentful/rich-text-types';
+/** @jsx jsx */ import { BLOCKS, INLINES } from '@contentful/rich-text-types';
 import { transformWrapIn } from '../../helpers/transformers';
 import { jsx, createTestEditor, mockPlugin, assertOutput } from '../../test-utils';
 import { createNormalizerPlugin } from './createNormalizerPlugin';
@@ -12,15 +12,15 @@ describe('Normalizer', ()=>{
     ];
     let input;
     beforeEach(()=>{
-        input = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hembed", {
+        input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hembed", {
             type: "Entry",
             id: "embedded-entry"
-        }), jsx("hp", null, "List item"))));
+        }), /*#__PURE__*/ jsx("hp", null, "List item"))));
     });
-    const expected = jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, "List item"))));
+    const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "List item"))));
     describe('rule.match', ()=>{
         it('matches elements of type "plugin.type" by default', ()=>{
-            const { editor  } = createTestEditor({
+            const { editor } = createTestEditor({
                 input,
                 plugins: [
                     mockPlugin({
@@ -50,14 +50,14 @@ describe('Normalizer', ()=>{
     });
     describe('rule.transform', ()=>{
         it('works with conditional transformation', ()=>{
-            const { editor  } = createTestEditor({
-                input: jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hembed", {
+            const { editor } = createTestEditor({
+                input: /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hembed", {
                     type: "Entry",
                     id: "embedded-entry"
-                }), jsx("hinline", {
+                }), /*#__PURE__*/ jsx("hinline", {
                     type: "Entry",
                     id: "inline-entry"
-                }), jsx("hp", null, "List item")))),
+                }), /*#__PURE__*/ jsx("hp", null, "List item")))),
                 plugins: [
                     mockPlugin({
                         isElement: true,
@@ -78,16 +78,16 @@ describe('Normalizer', ()=>{
             });
             assertOutput({
                 editor,
-                expected: jsx("editor", null, jsx("hul", null, jsx("hli", null, jsx("hp", null, jsx("hinline", {
+                expected: /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("hinline", {
                     type: "Entry",
                     id: "inline-entry"
-                })), jsx("hp", null, "List item"))))
+                })), /*#__PURE__*/ jsx("hp", null, "List item"))))
             });
         });
     });
     describe('rule.validChildren', ()=>{
         it('supports custom functions', ()=>{
-            const { editor  } = createTestEditor({
+            const { editor } = createTestEditor({
                 input,
                 plugins: [
                     mockPlugin({

package/dist/esm/plugins/Normalizer/utils.js

@@ -5,6 +5,7 @@ export const createValidatorFromTypes = (types)=>(_, [node])=>{
         return isElement(node) && types.includes(node.type);
     };
 export const createTransformerFromObject = (transforms)=>{
+    // A default transformer must always be provided
     const fallback = transforms['default'];
     if (!fallback) {
         throw new NormalizerError('A default transformer MUST be provided');

package/dist/esm/plugins/Normalizer/withNormalizer.js

@@ -6,25 +6,35 @@ import { baseRules } from './baseRules';
 import { NormalizerError, createValidatorFromTypes, createTransformerFromObject } from './utils';
 export const withNormalizer = (editor)=>{
     const rules = baseRules;
+    // Derive normalization rules from other plugin's configurations
     for (const p of editor.plugins){
-        const { normalizer: _rules  } = p;
+        const { normalizer: _rules } = p;
         if (!_rules) {
             continue;
         }
         for (const _rule of _rules){
+            // Clone to avoid mutation bugs
             const rule = {
                 ..._rule
             };
             if (!rule.match && !p.isElement) {
                 throw new NormalizerError('rule.match MUST be defined in a non-element plugin');
             }
+            // By default we filter elements with given plugin type
             if (!rule.match) {
                 rule.match = {
                     type: getPluginType(editor, p.key)
                 };
             }
+            // Conditional transformation e.g.
+            // {
+            //   [BLOCKS.EMBEDDED_ASSET]: transformLift,
+            //   default?: transformRemove
+            // }
+            //
             if (isPlainObject(rule.transform)) {
                 if ('validNode' in rule) {
+                    // I can't think of a use case. Disabled to prevent misuse
                     throw new NormalizerError('conditional transformations are not supported in validNode rules');
                 }
                 rule.transform = createTransformerFromObject({
@@ -32,33 +42,43 @@ export const withNormalizer = (editor)=>{
                     ...rule.transform
                 });
             }
+            // By default all invalid nodes are removed.
             if (!rule.transform) {
                 rule.transform = transformRemove;
             }
+            // Convert Types array syntax to a validator function
             if ('validChildren' in rule && Array.isArray(rule.validChildren)) {
                 rule.validChildren = createValidatorFromTypes(rule.validChildren);
             }
             rules.push(rule);
         }
     }
+    // Wrap transformer in a withoutNormalizing() call to avoid unnecessary
+    // normalization cycles.
     const _transform = (tr, entry)=>{
         withoutNormalizing(editor, ()=>{
             tr(editor, entry);
         });
     };
-    const { normalizeNode  } = editor;
+    const { normalizeNode } = editor;
+    // @ts-expect-error
     editor.normalizeNode = (entry)=>{
         const [node, path] = entry;
         const children = getChildren(entry);
+        // The order of validNode rules Vs validChildren doesn't matter. Slate
+        // will always perform normalization in a depth-first fashion.
         for (const rule of rules){
             if (!matchNode(node, path, rule.match)) {
                 continue;
             }
+            // Normalize node
             if ('validNode' in rule && !rule.validNode(editor, entry)) {
                 _transform(rule.transform, entry);
                 return;
             }
+            // Normalize node.children
             if ('validChildren' in rule) {
+                // It can not be an array since we enforced it earlier
                 const isValidChild = rule.validChildren;
                 const invalidChildEntry = children.find((entry)=>!isValidChild(editor, entry));
                 if (invalidChildEntry) {

package/dist/esm/plugins/Paragraph/Paragraph.js

@@ -9,7 +9,7 @@ const styles = {
   `
 };
 export function Paragraph(props) {
-    return React.createElement("div", {
+    return /*#__PURE__*/ React.createElement("div", {
         ...props.attributes,
         className: styles[BLOCKS.PARAGRAPH]
     }, props.children);