@atlaskit/editor-plugin-show-diff 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 3.1.0
+
+### Minor Changes
+
+- [`5167552fe1a93`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5167552fe1a93) -
+  [EDITOR-2339] Bump @atlaskit/adf-schema to 51.3.0
+
+### Patch Changes
+
+- [`38fb1054b8b7a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/38fb1054b8b7a) -
+  Recover from invalid deletion decorations
+- Updated dependencies
+
+## 3.0.2
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.0.1
 
 ### Patch Changes

package/dist/cjs/pm-plugins/NodeViewSerializer.js

@@ -74,6 +74,21 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
       this.nodeViews = (_ref = nodeViews !== null && nodeViews !== void 0 ? nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
     }
 
+    /**
+     * Appends serialized child nodes to the given contentDOM element.
+     */
+  }, {
+    key: "appendChildNodes",
+    value: function appendChildNodes(children, contentDOM) {
+      var _this = this;
+      children.forEach(function (child) {
+        var childNode = _this.tryCreateNodeView(child) || _this.serializeNode(child);
+        if (childNode) {
+          contentDOM === null || contentDOM === void 0 || contentDOM.append(childNode);
+        }
+      });
+    }
+
     /**
      * Attempts to create a node view for the given node.
      *
@@ -83,8 +98,7 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
   }, {
     key: "tryCreateNodeView",
     value: function tryCreateNodeView(targetNode) {
-      var _this$nodeViews,
-        _this = this;
+      var _this$nodeViews;
       if (!this.editorView) {
         return null;
       }
@@ -92,40 +106,40 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
       if (this.nodeViewBlocklist.has(targetNode.type.name)) {
         return null;
       }
-      if (!constructor) {
-        var _targetNode$type$spec, _targetNode$type$spec2;
-        if (targetNode.isInline) {
-          return null;
-        }
-        var toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
-        if (!toDOMResult) {
-          return null;
-        }
-        var _DOMSerializer$render = _model.DOMSerializer.renderSpec(document, toDOMResult),
-          _dom = _DOMSerializer$render.dom,
-          _contentDOM = _DOMSerializer$render.contentDOM;
-        if (_dom instanceof HTMLElement) {
-          if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
-            return this.serializeFragment(targetNode.content);
+      try {
+        if (!constructor) {
+          var _targetNode$type$spec, _targetNode$type$spec2;
+          if (targetNode.isInline) {
+            return null;
           }
+          var toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
+          if (!toDOMResult) {
+            return null;
+          }
+          var _DOMSerializer$render = _model.DOMSerializer.renderSpec(document, toDOMResult),
+            _dom = _DOMSerializer$render.dom,
+            _contentDOM = _DOMSerializer$render.contentDOM;
+          if (_dom instanceof HTMLElement) {
+            if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
+              return this.serializeFragment(targetNode.content);
+            }
 
-          // Iteratively populate children
-          targetNode.children.forEach(function (child) {
-            _contentDOM === null || _contentDOM === void 0 || _contentDOM.append(_this.tryCreateNodeView(child) || _this.serializeNode(child));
-          });
+            // Iteratively populate children
+            this.appendChildNodes(targetNode.children, _contentDOM);
+          }
+          return _dom;
         }
-        return _dom;
+        var _constructor = constructor(targetNode, this.editorView, function () {
+            return 0;
+          }, [], {}),
+          dom = _constructor.dom,
+          contentDOM = _constructor.contentDOM;
+        // Iteratively populate children
+        this.appendChildNodes(targetNode.children, contentDOM);
+        return dom;
+      } catch (e) {
+        return null;
       }
-      var _constructor = constructor(targetNode, this.editorView, function () {
-          return 0;
-        }, [], {}),
-        dom = _constructor.dom,
-        contentDOM = _constructor.contentDOM;
-      // Iteratively populate children
-      targetNode.children.forEach(function (child) {
-        contentDOM === null || contentDOM === void 0 || contentDOM.append(_this.tryCreateNodeView(child) || _this.serializeNode(child));
-      });
-      return dom;
     }
 
     /**
@@ -137,7 +151,11 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
       if (!this.serializer) {
         throw new Error('NodeViewSerializer must be initialized with init() before use');
       }
-      return this.serializer.serializeNode(node);
+      try {
+        return this.serializer.serializeNode(node);
+      } catch (e) {
+        return null;
+      }
     }
 
     /**
@@ -149,7 +167,11 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
       if (!this.serializer) {
         throw new Error('NodeViewSerializer must be initialized with init() before use');
       }
-      return this.serializer.serializeFragment(fragment);
+      try {
+        return this.serializer.serializeFragment(fragment);
+      } catch (e) {
+        return null;
+      }
     }
 
     /**

package/dist/cjs/pm-plugins/decorations.js

@@ -203,7 +203,9 @@ var createDeletedContentDecoration = exports.createDeletedContentDecoration = fu
           } else {
             // Fallback to serializing the individual child node
             var serializedChild = serializer.serializeNode(childNode);
-            dom.append(serializedChild);
+            if (serializedChild) {
+              dom.append(serializedChild);
+            }
           }
         });
         return true; // Indicates we handled multiple children
@@ -265,7 +267,10 @@ var createDeletedContentDecoration = exports.createDeletedContentDecoration = fu
       // Skip the case where the node is a paragraph or table row that way it can still be rendered and delete the entire table
       return;
     } else {
-      dom.append(fallbackSerialization());
+      var fallbackNode = fallbackSerialization();
+      if (fallbackNode) {
+        dom.append(fallbackNode);
+      }
     }
   });
   dom.setAttribute('data-testid', 'show-diff-deleted-decoration');

package/dist/es2019/pm-plugins/NodeViewSerializer.js

@@ -62,6 +62,18 @@ export class NodeViewSerializer {
     this.nodeViews = (_ref = nodeViews !== null && nodeViews !== void 0 ? nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
   }
 
+  /**
+   * Appends serialized child nodes to the given contentDOM element.
+   */
+  appendChildNodes(children, contentDOM) {
+    children.forEach(child => {
+      const childNode = this.tryCreateNodeView(child) || this.serializeNode(child);
+      if (childNode) {
+        contentDOM === null || contentDOM === void 0 ? void 0 : contentDOM.append(childNode);
+      }
+    });
+  }
+
   /**
    * Attempts to create a node view for the given node.
    *
@@ -77,40 +89,40 @@ export class NodeViewSerializer {
     if (this.nodeViewBlocklist.has(targetNode.type.name)) {
       return null;
     }
-    if (!constructor) {
-      var _targetNode$type$spec, _targetNode$type$spec2;
-      if (targetNode.isInline) {
-        return null;
-      }
-      const toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
-      if (!toDOMResult) {
-        return null;
+    try {
+      if (!constructor) {
+        var _targetNode$type$spec, _targetNode$type$spec2;
+        if (targetNode.isInline) {
+          return null;
+        }
+        const toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
+        if (!toDOMResult) {
+          return null;
+        }
+        const {
+          dom,
+          contentDOM
+        } = DOMSerializer.renderSpec(document, toDOMResult);
+        if (dom instanceof HTMLElement) {
+          if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
+            return this.serializeFragment(targetNode.content);
+          }
+
+          // Iteratively populate children
+          this.appendChildNodes(targetNode.children, contentDOM);
+        }
+        return dom;
       }
       const {
         dom,
         contentDOM
-      } = DOMSerializer.renderSpec(document, toDOMResult);
-      if (dom instanceof HTMLElement) {
-        if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
-          return this.serializeFragment(targetNode.content);
-        }
-
-        // Iteratively populate children
-        targetNode.children.forEach(child => {
-          contentDOM === null || contentDOM === void 0 ? void 0 : contentDOM.append(this.tryCreateNodeView(child) || this.serializeNode(child));
-        });
-      }
+      } = constructor(targetNode, this.editorView, () => 0, [], {});
+      // Iteratively populate children
+      this.appendChildNodes(targetNode.children, contentDOM);
       return dom;
+    } catch (e) {
+      return null;
     }
-    const {
-      dom,
-      contentDOM
-    } = constructor(targetNode, this.editorView, () => 0, [], {});
-    // Iteratively populate children
-    targetNode.children.forEach(child => {
-      contentDOM === null || contentDOM === void 0 ? void 0 : contentDOM.append(this.tryCreateNodeView(child) || this.serializeNode(child));
-    });
-    return dom;
   }
 
   /**
@@ -120,7 +132,11 @@ export class NodeViewSerializer {
     if (!this.serializer) {
       throw new Error('NodeViewSerializer must be initialized with init() before use');
     }
-    return this.serializer.serializeNode(node);
+    try {
+      return this.serializer.serializeNode(node);
+    } catch (e) {
+      return null;
+    }
   }
 
   /**
@@ -130,7 +146,11 @@ export class NodeViewSerializer {
     if (!this.serializer) {
       throw new Error('NodeViewSerializer must be initialized with init() before use');
     }
-    return this.serializer.serializeFragment(fragment);
+    try {
+      return this.serializer.serializeFragment(fragment);
+    } catch (e) {
+      return null;
+    }
   }
 
   /**

package/dist/es2019/pm-plugins/decorations.js

@@ -186,7 +186,9 @@ export const createDeletedContentDecoration = ({
           } else {
             // Fallback to serializing the individual child node
             const serializedChild = serializer.serializeNode(childNode);
-            dom.append(serializedChild);
+            if (serializedChild) {
+              dom.append(serializedChild);
+            }
           }
         });
         return true; // Indicates we handled multiple children
@@ -244,7 +246,10 @@ export const createDeletedContentDecoration = ({
       // Skip the case where the node is a paragraph or table row that way it can still be rendered and delete the entire table
       return;
     } else {
-      dom.append(fallbackSerialization());
+      const fallbackNode = fallbackSerialization();
+      if (fallbackNode) {
+        dom.append(fallbackNode);
+      }
     }
   });
   dom.setAttribute('data-testid', 'show-diff-deleted-decoration');

package/dist/esm/pm-plugins/NodeViewSerializer.js

@@ -67,6 +67,21 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
       this.nodeViews = (_ref = nodeViews !== null && nodeViews !== void 0 ? nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
     }
 
+    /**
+     * Appends serialized child nodes to the given contentDOM element.
+     */
+  }, {
+    key: "appendChildNodes",
+    value: function appendChildNodes(children, contentDOM) {
+      var _this = this;
+      children.forEach(function (child) {
+        var childNode = _this.tryCreateNodeView(child) || _this.serializeNode(child);
+        if (childNode) {
+          contentDOM === null || contentDOM === void 0 || contentDOM.append(childNode);
+        }
+      });
+    }
+
     /**
      * Attempts to create a node view for the given node.
      *
@@ -76,8 +91,7 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
   }, {
     key: "tryCreateNodeView",
     value: function tryCreateNodeView(targetNode) {
-      var _this$nodeViews,
-        _this = this;
+      var _this$nodeViews;
       if (!this.editorView) {
         return null;
       }
@@ -85,40 +99,40 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
       if (this.nodeViewBlocklist.has(targetNode.type.name)) {
         return null;
       }
-      if (!constructor) {
-        var _targetNode$type$spec, _targetNode$type$spec2;
-        if (targetNode.isInline) {
-          return null;
-        }
-        var toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
-        if (!toDOMResult) {
-          return null;
-        }
-        var _DOMSerializer$render = DOMSerializer.renderSpec(document, toDOMResult),
-          _dom = _DOMSerializer$render.dom,
-          _contentDOM = _DOMSerializer$render.contentDOM;
-        if (_dom instanceof HTMLElement) {
-          if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
-            return this.serializeFragment(targetNode.content);
+      try {
+        if (!constructor) {
+          var _targetNode$type$spec, _targetNode$type$spec2;
+          if (targetNode.isInline) {
+            return null;
           }
+          var toDOMResult = (_targetNode$type$spec = (_targetNode$type$spec2 = targetNode.type.spec).toDOM) === null || _targetNode$type$spec === void 0 ? void 0 : _targetNode$type$spec.call(_targetNode$type$spec2, targetNode);
+          if (!toDOMResult) {
+            return null;
+          }
+          var _DOMSerializer$render = DOMSerializer.renderSpec(document, toDOMResult),
+            _dom = _DOMSerializer$render.dom,
+            _contentDOM = _DOMSerializer$render.contentDOM;
+          if (_dom instanceof HTMLElement) {
+            if (targetNode.type.name === 'paragraph' && targetNode.children.length === 1) {
+              return this.serializeFragment(targetNode.content);
+            }
 
-          // Iteratively populate children
-          targetNode.children.forEach(function (child) {
-            _contentDOM === null || _contentDOM === void 0 || _contentDOM.append(_this.tryCreateNodeView(child) || _this.serializeNode(child));
-          });
+            // Iteratively populate children
+            this.appendChildNodes(targetNode.children, _contentDOM);
+          }
+          return _dom;
         }
-        return _dom;
+        var _constructor = constructor(targetNode, this.editorView, function () {
+            return 0;
+          }, [], {}),
+          dom = _constructor.dom,
+          contentDOM = _constructor.contentDOM;
+        // Iteratively populate children
+        this.appendChildNodes(targetNode.children, contentDOM);
+        return dom;
+      } catch (e) {
+        return null;
       }
-      var _constructor = constructor(targetNode, this.editorView, function () {
-          return 0;
-        }, [], {}),
-        dom = _constructor.dom,
-        contentDOM = _constructor.contentDOM;
-      // Iteratively populate children
-      targetNode.children.forEach(function (child) {
-        contentDOM === null || contentDOM === void 0 || contentDOM.append(_this.tryCreateNodeView(child) || _this.serializeNode(child));
-      });
-      return dom;
     }
 
     /**
@@ -130,7 +144,11 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
       if (!this.serializer) {
         throw new Error('NodeViewSerializer must be initialized with init() before use');
       }
-      return this.serializer.serializeNode(node);
+      try {
+        return this.serializer.serializeNode(node);
+      } catch (e) {
+        return null;
+      }
     }
 
     /**
@@ -142,7 +160,11 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
       if (!this.serializer) {
         throw new Error('NodeViewSerializer must be initialized with init() before use');
       }
-      return this.serializer.serializeFragment(fragment);
+      try {
+        return this.serializer.serializeFragment(fragment);
+      } catch (e) {
+        return null;
+      }
     }
 
     /**

package/dist/esm/pm-plugins/decorations.js

@@ -197,7 +197,9 @@ export var createDeletedContentDecoration = function createDeletedContentDecorat
           } else {
             // Fallback to serializing the individual child node
             var serializedChild = serializer.serializeNode(childNode);
-            dom.append(serializedChild);
+            if (serializedChild) {
+              dom.append(serializedChild);
+            }
           }
         });
         return true; // Indicates we handled multiple children
@@ -259,7 +261,10 @@ export var createDeletedContentDecoration = function createDeletedContentDecorat
       // Skip the case where the node is a paragraph or table row that way it can still be rendered and delete the entire table
       return;
     } else {
-      dom.append(fallbackSerialization());
+      var fallbackNode = fallbackSerialization();
+      if (fallbackNode) {
+        dom.append(fallbackNode);
+      }
     }
   });
   dom.setAttribute('data-testid', 'show-diff-deleted-decoration');

package/dist/types/pm-plugins/NodeViewSerializer.d.ts

@@ -49,6 +49,10 @@ export declare class NodeViewSerializer {
     init(params: {
         editorView: EditorView;
     }): void;
+    /**
+     * Appends serialized child nodes to the given contentDOM element.
+     */
+    private appendChildNodes;
     /**
      * Attempts to create a node view for the given node.
      *
@@ -59,11 +63,11 @@ export declare class NodeViewSerializer {
     /**
      * Serializes a node to a DOM `Node` using the schema's `DOMSerializer`.
      */
-    serializeNode(node: PMNode): Node;
+    serializeNode(node: PMNode): Node | null;
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement;
+    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement | null;
     /**
      * Returns a copy of the current node view blocklist.
      */

package/dist/types-ts4.5/pm-plugins/NodeViewSerializer.d.ts

@@ -49,6 +49,10 @@ export declare class NodeViewSerializer {
     init(params: {
         editorView: EditorView;
     }): void;
+    /**
+     * Appends serialized child nodes to the given contentDOM element.
+     */
+    private appendChildNodes;
     /**
      * Attempts to create a node view for the given node.
      *
@@ -59,11 +63,11 @@ export declare class NodeViewSerializer {
     /**
      * Serializes a node to a DOM `Node` using the schema's `DOMSerializer`.
      */
-    serializeNode(node: PMNode): Node;
+    serializeNode(node: PMNode): Node | null;
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement;
+    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement | null;
     /**
      * Returns a copy of the current node view blocklist.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "3.0.1",
+	"version": "3.1.0",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,16 +28,16 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.2.0",
+		"@atlaskit/adf-schema": "^51.3.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/tokens": "^6.5.0",
+		"@atlaskit/tokens": "^7.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21",
 		"memoize-one": "^6.0.0",
 		"prosemirror-changeset": "^2.2.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.12.0",
+		"@atlaskit/editor-common": "^110.14.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {