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

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);

package/dist/esm/plugins/Paragraph/__tests__/createParagraphPlugin.test.js

@@ -1,16 +1,16 @@
-import { assertOutput, jsx } from '../../../test-utils';
+/* eslint-disable react/no-unknown-property */ /** @jsx jsx */ import { assertOutput, jsx } from '../../../test-utils';
 describe('normalization', ()=>{
     it('can contain inline entries & hyperlinks', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, "some text before", jsx("hinline", {
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some text before", /*#__PURE__*/ jsx("hinline", {
             type: "Entry",
             id: "inline-entry"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             uri: "https://contentful.com"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             entry: "entry-id"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             resource: "resource-urn"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             asset: "asset-id"
         }), "some text after"));
         assertOutput({
@@ -19,20 +19,20 @@ describe('normalization', ()=>{
         });
     });
     it('wraps orphaned text nodes in a paragraph', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, "valid text"), jsx("hh1", null, "valid text"), jsx("htable", null, jsx("htr", null, jsx("htd", null, "invalid text"))));
-        const expected = jsx("editor", null, jsx("hp", null, "valid text"), jsx("hh1", null, "valid text"), jsx("htable", null, jsx("htr", null, jsx("htd", null, jsx("hp", null, "invalid text")))), jsx("hp", null, jsx("htext", null)));
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "valid text"), /*#__PURE__*/ jsx("hh1", null, "valid text"), /*#__PURE__*/ jsx("htable", null, /*#__PURE__*/ jsx("htr", null, /*#__PURE__*/ jsx("htd", null, "invalid text"))));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "valid text"), /*#__PURE__*/ jsx("hh1", null, "valid text"), /*#__PURE__*/ jsx("htable", null, /*#__PURE__*/ jsx("htr", null, /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "invalid text")))), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
         assertOutput({
             input,
             expected
         });
     });
     it('unwraps nested paragraphs', ()=>{
-        const input = jsx("editor", null, jsx("hp", null, "some", jsx("hp", null, jsx("htext", {
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", {
             bold: true,
             italic: true,
             underline: true
         }, "paragraph")), "text"));
-        const expected = jsx("editor", null, jsx("hp", null, "some", jsx("htext", {
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("htext", {
             bold: true,
             italic: true,
             underline: true
@@ -44,76 +44,76 @@ describe('normalization', ()=>{
     });
     describe('lifts other invalid children', ()=>{
         it('block void elements', ()=>{
-            const input = jsx("editor", null, jsx("hp", null, jsx("hembed", {
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "1"
-            }), " start"), jsx("hp", null, "end ", jsx("hembed", {
+            }), " start"), /*#__PURE__*/ jsx("hp", null, "end ", /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "2"
-            })), jsx("hp", null, "in ", jsx("hembed", {
+            })), /*#__PURE__*/ jsx("hp", null, "in ", /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "3"
-            }), " between"), jsx("hp", null, jsx("hembed", {
+            }), " between"), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "1"
-            }), " start"), jsx("hp", null, "end ", jsx("hembed", {
+            }), " start"), /*#__PURE__*/ jsx("hp", null, "end ", /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "2"
-            })), jsx("hp", null, "in ", jsx("hembed", {
+            })), /*#__PURE__*/ jsx("hp", null, "in ", /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "3"
-            }), " between"), jsx("hp", null, jsx("hhr", null), " start"), jsx("hp", null, "end ", jsx("hhr", null)), jsx("hp", null, "in ", jsx("hhr", null), " between"));
-            const expected = jsx("editor", null, jsx("hembed", {
+            }), " between"), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("hhr", null), " start"), /*#__PURE__*/ jsx("hp", null, "end ", /*#__PURE__*/ jsx("hhr", null)), /*#__PURE__*/ jsx("hp", null, "in ", /*#__PURE__*/ jsx("hhr", null), " between"));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "1"
-            }), jsx("hp", null, " start"), jsx("hp", null, "end "), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, " start"), /*#__PURE__*/ jsx("hp", null, "end "), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "2"
-            }), jsx("hp", null, "in "), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, "in "), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "3"
-            }), jsx("hp", null, " between"), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, " between"), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "1"
-            }), jsx("hp", null, " start"), jsx("hp", null, "end "), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, " start"), /*#__PURE__*/ jsx("hp", null, "end "), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "2"
-            }), jsx("hp", null, "in "), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, "in "), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "3"
-            }), jsx("hp", null, " between"), jsx("hhr", null), jsx("hp", null, " start"), jsx("hp", null, "end "), jsx("hhr", null), jsx("hp", null, "in "), jsx("hhr", null), jsx("hp", null, " between"));
+            }), /*#__PURE__*/ jsx("hp", null, " between"), /*#__PURE__*/ jsx("hhr", null), /*#__PURE__*/ jsx("hp", null, " start"), /*#__PURE__*/ jsx("hp", null, "end "), /*#__PURE__*/ jsx("hhr", null), /*#__PURE__*/ jsx("hp", null, "in "), /*#__PURE__*/ jsx("hhr", null), /*#__PURE__*/ jsx("hp", null, " between"));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles heading', ()=>{
-            const input = jsx("editor", null, jsx("hp", null, "some", jsx("hh1", null, "heading"), "text"));
-            const expected = jsx("editor", null, jsx("hp", null, "some"), jsx("hh1", null, "heading"), jsx("hp", null, "text"));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("hh1", null, "heading"), "text"));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("hh1", null, "heading"), /*#__PURE__*/ jsx("hp", null, "text"));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles quotes', ()=>{
-            const input = jsx("editor", null, jsx("hp", null, "some", jsx("hquote", null, jsx("hp", null, "quote")), "text"));
-            const expected = jsx("editor", null, jsx("hp", null, "some"), jsx("hquote", null, jsx("hp", null, "quote")), jsx("hp", null, "text"));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "quote")), "text"));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "quote")), /*#__PURE__*/ jsx("hp", null, "text"));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles lists', ()=>{
-            const input = jsx("editor", null, jsx("hp", null, "some", jsx("hul", null, jsx("hli", null, jsx("hp", null, "list item"))), "text"));
-            const expected = jsx("editor", null, jsx("hp", null, "some"), jsx("hul", null, jsx("hli", null, jsx("hp", null, "list item"))), jsx("hp", null, "text"));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "list item"))), "text"));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "list item"))), /*#__PURE__*/ jsx("hp", null, "text"));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles tables', ()=>{
-            const input = jsx("editor", null, jsx("hp", null, "some", jsx("htable", null, jsx("htr", null, jsx("htd", null, jsx("hp", null, "cell 1")), jsx("htd", null, jsx("hp", null, "cell 2")))), "text"));
-            const expected = jsx("editor", null, jsx("hp", null, "some"), jsx("htable", null, jsx("htr", null, jsx("htd", null, jsx("hp", null, "cell 1")), jsx("htd", null, jsx("hp", null, "cell 2")))), jsx("hp", null, "text"));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("htable", null, /*#__PURE__*/ jsx("htr", null, /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 1")), /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 2")))), "text"));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("htable", null, /*#__PURE__*/ jsx("htr", null, /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 1")), /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 2")))), /*#__PURE__*/ jsx("hp", null, "text"));
             assertOutput({
                 input,
                 expected

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

@@ -5,7 +5,7 @@ import { isInlineOrText, toggleElement } from '../../helpers/editor';
 import { transformUnwrap, transformLift } from '../../helpers/transformers';
 import { Paragraph } from './Paragraph';
 import { isEmbedElement, isEmptyElement } from './utils';
-const buildParagraphKeyDownHandler = (editor, { options: { hotkey  }  })=>(event)=>{
+const buildParagraphKeyDownHandler = (editor, { options: { hotkey } })=>(event)=>{
         if (editor.selection && hotkey && isHotkey(hotkey, event)) {
             toggleElement(editor, {
                 activeType: BLOCKS.PARAGRAPH,
@@ -26,6 +26,7 @@ export const createParagraphPlugin = ()=>{
             onKeyDown: buildParagraphKeyDownHandler
         },
         softBreak: [
+            // create a new line with SHIFT+Enter inside a paragraph
             {
                 hotkey: 'shift+enter',
                 query: {

package/dist/esm/plugins/PasteHTML/createPasteHTMLPlugin.js

@@ -1,12 +1,17 @@
 import { KEY_DESERIALIZE_HTML } from '@udecode/plate-common';
 import { sanitizeHTML } from './utils/sanitizeHTML';
-const catchSlateFragment = /data-slate-fragment="(.+?)"/m;
+/**
+ * Get x-slate-fragment attribute from data-slate-fragment
+ */ const catchSlateFragment = /data-slate-fragment="(.+?)"/m;
 export const getSlateFragmentAttribute = (dataTransfer)=>{
     const htmlData = dataTransfer.getData('text/html');
     const [, fragment] = htmlData.match(catchSlateFragment) || [];
     return fragment;
 };
-export const ensureXSlateFragment = (dataTransfer)=>{
+/**
+ * Get the x-slate-fragment attribute that exist in text/html data
+ * and append it to the DataTransfer object
+ */ export const ensureXSlateFragment = (dataTransfer)=>{
     if (!dataTransfer.getData('application/x-slate-fragment')) {
         const fragment = getSlateFragmentAttribute(dataTransfer);
         if (fragment) {
@@ -23,7 +28,7 @@ export const ensureXSlateFragment = (dataTransfer)=>{
 export const createPasteHTMLPlugin = ()=>({
         key: 'PasteHTMLPlugin',
         withOverrides: (editor)=>{
-            const { insertData  } = editor;
+            const { insertData } = editor;
             editor.insertData = (data)=>insertData(ensureXSlateFragment(data));
             return editor;
         },
@@ -33,6 +38,7 @@ export const createPasteHTMLPlugin = ()=>({
                     editor: {
                         insertData: {
                             format: 'text/html',
+                            // Perform custom content transformation *before* pasting
                             transformData: sanitizeHTML
                         }
                     }

package/dist/esm/plugins/PasteHTML/utils/__tests__/sanitizeHTML.test.js

@@ -2,6 +2,7 @@ import { sanitizeHTML } from '../sanitizeHTML';
 describe('HTML Sanitization', ()=>{
     it('removes unsupported elements from <a>', ()=>{
         const cases = [
+            // Supported
             {
                 input: '<h1><a href="#">Link in h1</a></h1>',
                 output: 'unchanged'
@@ -30,6 +31,7 @@ describe('HTML Sanitization', ()=>{
                 input: '<a href="#"><u>u in Link</u></a>',
                 output: 'unchanged'
             },
+            // Unsupported. Should be unwrapped
             {
                 input: '<a href="#"><h1>h1 in Link</h1><h2>this is h2</h2></a>',
                 output: '<a href="#">h1 in Link  this is h2</a>'

package/dist/esm/plugins/PasteHTML/utils/sanitizeAnchors.js

@@ -12,20 +12,46 @@ const wrapSpaceAround = (el)=>{
     }
 };
 const unwrap = (el)=>{
+    // add a spacer to avoid the content being cramped together with
+    // the element siblings after it's unwrapped. It may not always
+    // be desired but it should be easy to adjust by the end user.
     wrapSpaceAround(el);
     el.replaceWith(...Array.from(el.childNodes));
 };
-export const sanitizeAnchors = (doc)=>{
+/**
+ * In HTML it's a valid structure to have a block element inside a link
+ *
+ * e.g: <a href="..."><h1> My link </h1><h2>is fancy</h2></a>
+ *
+ * However, that's not supported in Slate. There are generally two ways to
+ * handle this:
+ *
+ * a) Unwrap inner blocks while preserving the content.
+ *    e.g. <a href="...">My link is fancy</a>
+ *
+ * b) Break the link into multiple elements with having each block
+ *    element as a wrapper for an anchor with the same URL
+ *    e.g. <h1><a href="...">My link</a></h1>
+ *         and <h2><a href="...">is fancy</a></h2>
+ *
+ * We take approach (a) in here.
+ */ export const sanitizeAnchors = (doc)=>{
     const unsupportedTagSelector = `a :not(${[
+        // Bold
         'b',
         'strong',
+        // Code
         'code',
         'pre',
+        // Italic
         'em',
         'i',
+        // Super/subscript
         'sub',
         'sup',
+        // Underline
         'u',
+        // Other
         'span'
     ].join(',')})`;
     doc.querySelectorAll(unsupportedTagSelector).forEach(unwrap);

package/dist/esm/plugins/PasteHTML/utils/sanitizeHTML.js

@@ -1,15 +1,20 @@
 import { sanitizeAnchors } from './sanitizeAnchors';
 import { sanitizeSheets } from './sanitizeSheets';
-const stripStyleTags = (doc)=>{
+/**
+ * Remove all <style> tags
+ */ const stripStyleTags = (doc)=>{
     doc.querySelectorAll('style').forEach((e)=>{
         e.remove();
     });
     return doc;
 };
-const stripMetaTags = (doc)=>{
+/**
+ * Remove all <meta /> tags
+ */ const stripMetaTags = (doc)=>{
     doc.querySelectorAll('meta').forEach((el)=>el.remove());
     return doc;
 };
+// Attention: Order is important
 const transformers = [
     stripStyleTags,
     sanitizeSheets,
@@ -24,17 +29,27 @@ function removeTableWrappers(table) {
     }
 }
 export const sanitizeHTML = (html)=>{
+    // Parse the HTML string and pipe it through our transformers
     const doc = transformers.reduce((value, cb)=>cb(value), new DOMParser().parseFromString(html, 'text/html'));
     const replacers = [
+        // remove whitespaces between some tags, as this can lead to unwanted behaviour:
+        // - table -> empty table cells
+        // - list -> leading whitespaces
         (innerHtml)=>innerHtml.replace(/<(\/)?(table|thead|tbody|tr|td|th|caption|col|colgroup|ol|ul|li)(.*)>\s+<(\/)?(table|thead|tbody|tr|td|th|caption|col|colgroup|ol|ul|li)/g, '<$1$2$3><$4$5'),
+        // remove empty elements before the ending block element tag
         (innerHtml)=>innerHtml.replace(/(?:<[^>^/]*>)\s*(?:<\/[^>]*>)<\/(div|p|table|thead|tbody|tr|td|th|caption|col|colgroup|ol|ul|li)/g, '</$1'),
+        // remove whitespaces before the ending block element tag
         (innerHTML)=>innerHTML.replace(/\s*<\/(div|p|table|thead|tbody|tr|td|th|caption|col|colgroup|ol|ul|li)/g, '</$1')
     ];
     let previous;
     do {
+        // save previous first before doing modifications
         previous = doc.body.innerHTML;
         doc.body.innerHTML = replacers.reduce((innerHTML, replacer)=>replacer(innerHTML), doc.body.innerHTML);
     }while (doc.body.innerHTML !== previous)
+    // Removing the div container wrappers from tables
+    // The div container including attributes and possible linebreaks inside wil be removed
+    // TODO: can be removed with plate >= 20
     doc.querySelectorAll('table').forEach(removeTableWrappers);
     return doc.body.innerHTML;
 };

package/dist/esm/plugins/PasteHTML/utils/sanitizeSheets.js

@@ -1,6 +1,12 @@
-export const sanitizeSheets = (doc)=>{
+/**
+ * Remove empty spreadsheets columns/rows for performance reasons.
+ */ export const sanitizeSheets = (doc)=>{
+    // Ensure we are inside a spreadsheet i.e. not pasting
+    // a table from within the editor
     const supported = [
+        // Google Sheets
         'google-sheets-html-origin',
+        // MS Excel
         'meta[content="Excel.Sheet"]',
         'meta[content*="Microsoft Excel"]'
     ];
@@ -12,17 +18,23 @@ export const sanitizeSheets = (doc)=>{
     };
     const tables = Array.from(doc.querySelectorAll('table'));
     for (const table of tables){
+        // Remove empty columns first!
         table.querySelectorAll('tr').forEach((row)=>{
             isEmptyElement(row) && row.remove();
         });
         const rows = Array.from(table.querySelectorAll('tr'));
+        // CSS :nth-of-type index starts from 1
         let colIndex = 1;
+        // eslint-disable-next-line -- TODO: explain this disable
         while(true){
             const cells = rows.map((row)=>row.querySelector(`th:nth-of-type(${colIndex}), td:nth-of-type(${colIndex})`)).filter((cell)=>!!cell);
+            // No more columns
             if (cells.length === 0) {
                 break;
             }
             const isEmpty = cells.every((cell)=>isEmptyElement(cell));
+            // Don't increment on deletion because columns will be shifted
+            // left anyway. Incrementing may result in skipping
             if (!isEmpty) {
                 colIndex += 1;
                 continue;

package/dist/esm/plugins/Quote/__test__/createQuotePlugin.test.js

@@ -1,16 +1,16 @@
-import { assertOutput, jsx } from '../../../test-utils';
+/* eslint-disable react/no-unknown-property */ /** @jsx jsx */ import { assertOutput, jsx } from '../../../test-utils';
 describe('normalization', ()=>{
     it('can contain inline entries & hyperlinks', ()=>{
-        const input = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some text before", jsx("hinline", {
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some text before", /*#__PURE__*/ jsx("hinline", {
             type: "Entry",
             id: "inline-entry"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             uri: "https://contentful.com"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             entry: "entry-id"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             resource: "resource-urn"
-        }), jsx("hlink", {
+        }), /*#__PURE__*/ jsx("hlink", {
             asset: "asset-id"
         }), "some text after")));
         assertOutput({
@@ -19,16 +19,16 @@ describe('normalization', ()=>{
         });
     });
     it('unwraps nested quotes', ()=>{
-        const input = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some"), jsx("hquote", null, jsx("hp", null, jsx("htext", {
+        const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", {
             bold: true,
             italic: true,
             underline: true
-        }, "paragraph"))), jsx("hp", null, "text")));
-        const expected = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some"), jsx("hp", null, jsx("htext", {
+        }, "paragraph"))), /*#__PURE__*/ jsx("hp", null, "text")));
+        const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some"), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", {
             bold: true,
             italic: true,
             underline: true
-        }, "paragraph")), jsx("hp", null, "text")), jsx("hp", null, jsx("htext", null)));
+        }, "paragraph")), /*#__PURE__*/ jsx("hp", null, "text")), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("htext", null)));
         assertOutput({
             input,
             expected
@@ -36,37 +36,37 @@ describe('normalization', ()=>{
     });
     describe('lifts other invalid children', ()=>{
         it('block void elements', ()=>{
-            const input = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "this"), jsx("hembed", {
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "this"), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "1"
-            }), jsx("hp", null, "is"), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, "is"), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "1"
-            }), jsx("hp", null, "a blockquote"), jsx("hhr", null), jsx("hh1", null, "Heading 1")));
-            const expected = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "this")), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hp", null, "a blockquote"), /*#__PURE__*/ jsx("hhr", null), /*#__PURE__*/ jsx("hh1", null, "Heading 1")));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "this")), /*#__PURE__*/ jsx("hembed", {
                 type: "Asset",
                 id: "1"
-            }), jsx("hquote", null, jsx("hp", null, "is")), jsx("hembed", {
+            }), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "is")), /*#__PURE__*/ jsx("hembed", {
                 type: "Entry",
                 id: "1"
-            }), jsx("hquote", null, jsx("hp", null, "a blockquote")), jsx("hhr", null), jsx("hh1", null, "Heading 1"), jsx("hp", null, jsx("text", null)));
+            }), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "a blockquote")), /*#__PURE__*/ jsx("hhr", null), /*#__PURE__*/ jsx("hh1", null, "Heading 1"), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("text", null)));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles lists', ()=>{
-            const input = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some", jsx("hul", null, jsx("hli", null, jsx("hp", null, "list item"))), "text")));
-            const expected = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some")), jsx("hul", null, jsx("hli", null, jsx("hp", null, "list item"))), jsx("hquote", null, jsx("hp", null, "text")), jsx("hp", null, jsx("text", null)));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some", /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "list item"))), "text")));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some")), /*#__PURE__*/ jsx("hul", null, /*#__PURE__*/ jsx("hli", null, /*#__PURE__*/ jsx("hp", null, "list item"))), /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "text")), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("text", null)));
             assertOutput({
                 input,
                 expected
             });
         });
         it('handles tables', ()=>{
-            const table = jsx("htable", null, jsx("htr", null, jsx("htd", null, jsx("hp", null, "cell 1")), jsx("htd", null, jsx("hp", null, "cell 2"))));
-            const input = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some", table, "text")));
-            const expected = jsx("editor", null, jsx("hquote", null, jsx("hp", null, "some")), table, jsx("hquote", null, jsx("hp", null, "text")), jsx("hp", null, jsx("text", null)));
+            const table = /*#__PURE__*/ jsx("htable", null, /*#__PURE__*/ jsx("htr", null, /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 1")), /*#__PURE__*/ jsx("htd", null, /*#__PURE__*/ jsx("hp", null, "cell 2"))));
+            const input = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some", table, "text")));
+            const expected = /*#__PURE__*/ jsx("editor", null, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "some")), table, /*#__PURE__*/ jsx("hquote", null, /*#__PURE__*/ jsx("hp", null, "text")), /*#__PURE__*/ jsx("hp", null, /*#__PURE__*/ jsx("text", null)));
             assertOutput({
                 input,
                 expected