@atlaskit/editor-plugin-code-bidi-warning 5.0.0 → 5.0.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-code-bidi-warning
 
+## 5.0.1
+
+### Patch Changes
+
+- [`ff72875304f9a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ff72875304f9a) -
+  Fix SSR bug in vanilla codebidi warning
+- Updated dependencies
+
 ## 5.0.0
 
 ### Patch Changes

package/dist/cjs/pm-plugins/vanilla-plugin-factory.js

@@ -33,6 +33,21 @@ var pluginFactoryCreator = exports.pluginFactoryCreator = function pluginFactory
     }
   });
 };
+function assertIsElement(node) {
+  // Using 1 instead of Node.ELEMENT_NODE just in case Node is not defined in some environments
+  if (node.nodeType !== 1) {
+    throw new Error('Code Bidi Warning DOM spec did not return an Element node');
+  }
+}
+
+/**
+ * Creates a DecorationSet containing widgets for each detected bidi character in code snippets within the document.
+ * @param props - The properties for creating the decoration set.
+ * @param props.doc - The ProseMirror document to scan for bidi characters.
+ * @param props.codeBidiWarningLabel - The label to use for the warning tooltip.
+ * @param props.tooltipEnabled - Whether tooltips are enabled for the warnings.
+ * @returns A DecorationSet with widgets at the positions of detected bidi characters.
+ */
 function createBidiWarningsDecorationSetFromDoc(_ref) {
   var doc = _ref.doc,
     codeBidiWarningLabel = _ref.codeBidiWarningLabel,
@@ -76,28 +91,25 @@ function createBidiWarningsDecorationSetFromDoc(_ref) {
   if (bidiCharactersAndTheirPositions.length === 0) {
     return _view.DecorationSet.empty;
   }
-  var newBidiWarningsDecorationSet = _view.DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(function (_ref4) {
+  return _view.DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(function (_ref4) {
     var position = _ref4.position,
       bidiCharacter = _ref4.bidiCharacter;
-    return _view.Decoration.widget(position, function (el) {
+    return _view.Decoration.widget(position, function () {
       return renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled);
     }, {
-      destroy: function destroy(el) {
-        if (!(el instanceof HTMLElement)) {
-          throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-        }
-        el.remove();
+      destroy: function destroy(node) {
+        assertIsElement(node);
+        node.remove();
       }
     });
   }));
-  return newBidiWarningsDecorationSet;
 }
 function renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled) {
   var spec = (0, _codeBidiWarningDomSpec.getCodeBidiWarningDomSpec)(bidiCharacter, codeBidiWarningLabel, tooltipEnabled);
   var _DOMSerializer$render = _model.DOMSerializer.renderSpec(document, spec),
     dom = _DOMSerializer$render.dom;
-  if (!(dom instanceof HTMLElement)) {
-    throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-  }
+  // In SSR or non-browser DOM implementations, HTMLElement may not be present or cross-realm.
+  // Accept any Element node (nodeType === Node.ELEMENT_NODE) instead of relying on instanceof checks.
+  assertIsElement(dom);
   return dom;
 }

package/dist/es2019/pm-plugins/vanilla-plugin-factory.js

@@ -21,6 +21,21 @@ export const pluginFactoryCreator = () => pluginFactory(codeBidiWarningPluginKey
     };
   }
 });
+function assertIsElement(node) {
+  // Using 1 instead of Node.ELEMENT_NODE just in case Node is not defined in some environments
+  if (node.nodeType !== 1) {
+    throw new Error('Code Bidi Warning DOM spec did not return an Element node');
+  }
+}
+
+/**
+ * Creates a DecorationSet containing widgets for each detected bidi character in code snippets within the document.
+ * @param props - The properties for creating the decoration set.
+ * @param props.doc - The ProseMirror document to scan for bidi characters.
+ * @param props.codeBidiWarningLabel - The label to use for the warning tooltip.
+ * @param props.tooltipEnabled - Whether tooltips are enabled for the warnings.
+ * @returns A DecorationSet with widgets at the positions of detected bidi characters.
+ */
 export function createBidiWarningsDecorationSetFromDoc({
   doc,
   codeBidiWarningLabel,
@@ -65,28 +80,25 @@ export function createBidiWarningsDecorationSetFromDoc({
   if (bidiCharactersAndTheirPositions.length === 0) {
     return DecorationSet.empty;
   }
-  const newBidiWarningsDecorationSet = DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(({
+  return DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(({
     position,
     bidiCharacter
   }) => {
-    return Decoration.widget(position, el => renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled), {
-      destroy: el => {
-        if (!(el instanceof HTMLElement)) {
-          throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-        }
-        el.remove();
+    return Decoration.widget(position, () => renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled), {
+      destroy: node => {
+        assertIsElement(node);
+        node.remove();
       }
     });
   }));
-  return newBidiWarningsDecorationSet;
 }
 function renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled) {
   const spec = getCodeBidiWarningDomSpec(bidiCharacter, codeBidiWarningLabel, tooltipEnabled);
   const {
     dom
   } = DOMSerializer.renderSpec(document, spec);
-  if (!(dom instanceof HTMLElement)) {
-    throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-  }
+  // In SSR or non-browser DOM implementations, HTMLElement may not be present or cross-realm.
+  // Accept any Element node (nodeType === Node.ELEMENT_NODE) instead of relying on instanceof checks.
+  assertIsElement(dom);
   return dom;
 }

package/dist/esm/pm-plugins/vanilla-plugin-factory.js

@@ -25,6 +25,21 @@ export var pluginFactoryCreator = function pluginFactoryCreator() {
     }
   });
 };
+function assertIsElement(node) {
+  // Using 1 instead of Node.ELEMENT_NODE just in case Node is not defined in some environments
+  if (node.nodeType !== 1) {
+    throw new Error('Code Bidi Warning DOM spec did not return an Element node');
+  }
+}
+
+/**
+ * Creates a DecorationSet containing widgets for each detected bidi character in code snippets within the document.
+ * @param props - The properties for creating the decoration set.
+ * @param props.doc - The ProseMirror document to scan for bidi characters.
+ * @param props.codeBidiWarningLabel - The label to use for the warning tooltip.
+ * @param props.tooltipEnabled - Whether tooltips are enabled for the warnings.
+ * @returns A DecorationSet with widgets at the positions of detected bidi characters.
+ */
 export function createBidiWarningsDecorationSetFromDoc(_ref) {
   var doc = _ref.doc,
     codeBidiWarningLabel = _ref.codeBidiWarningLabel,
@@ -68,28 +83,25 @@ export function createBidiWarningsDecorationSetFromDoc(_ref) {
   if (bidiCharactersAndTheirPositions.length === 0) {
     return DecorationSet.empty;
   }
-  var newBidiWarningsDecorationSet = DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(function (_ref4) {
+  return DecorationSet.create(doc, bidiCharactersAndTheirPositions.map(function (_ref4) {
     var position = _ref4.position,
       bidiCharacter = _ref4.bidiCharacter;
-    return Decoration.widget(position, function (el) {
+    return Decoration.widget(position, function () {
       return renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled);
     }, {
-      destroy: function destroy(el) {
-        if (!(el instanceof HTMLElement)) {
-          throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-        }
-        el.remove();
+      destroy: function destroy(node) {
+        assertIsElement(node);
+        node.remove();
       }
     });
   }));
-  return newBidiWarningsDecorationSet;
 }
 function renderDOM(bidiCharacter, codeBidiWarningLabel, tooltipEnabled) {
   var spec = getCodeBidiWarningDomSpec(bidiCharacter, codeBidiWarningLabel, tooltipEnabled);
   var _DOMSerializer$render = DOMSerializer.renderSpec(document, spec),
     dom = _DOMSerializer$render.dom;
-  if (!(dom instanceof HTMLElement)) {
-    throw new Error('Code Bidi Warning DOM spec did not return an HTMLElement');
-  }
+  // In SSR or non-browser DOM implementations, HTMLElement may not be present or cross-realm.
+  // Accept any Element node (nodeType === Node.ELEMENT_NODE) instead of relying on instanceof checks.
+  assertIsElement(dom);
   return dom;
 }

package/dist/types/pm-plugins/vanilla-plugin-factory.d.ts

@@ -5,6 +5,14 @@ export declare const pluginFactoryCreator: () => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
+/**
+ * Creates a DecorationSet containing widgets for each detected bidi character in code snippets within the document.
+ * @param props - The properties for creating the decoration set.
+ * @param props.doc - The ProseMirror document to scan for bidi characters.
+ * @param props.codeBidiWarningLabel - The label to use for the warning tooltip.
+ * @param props.tooltipEnabled - Whether tooltips are enabled for the warnings.
+ * @returns A DecorationSet with widgets at the positions of detected bidi characters.
+ */
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, }: {
     codeBidiWarningLabel: string;
     doc: PmNode;

package/dist/types-ts4.5/pm-plugins/vanilla-plugin-factory.d.ts

@@ -5,6 +5,14 @@ export declare const pluginFactoryCreator: () => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
+/**
+ * Creates a DecorationSet containing widgets for each detected bidi character in code snippets within the document.
+ * @param props - The properties for creating the decoration set.
+ * @param props.doc - The ProseMirror document to scan for bidi characters.
+ * @param props.codeBidiWarningLabel - The label to use for the warning tooltip.
+ * @param props.tooltipEnabled - Whether tooltips are enabled for the warnings.
+ * @returns A DecorationSet with widgets at the positions of detected bidi characters.
+ */
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, }: {
     codeBidiWarningLabel: string;
     doc: PmNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-code-bidi-warning",
-	"version": "5.0.0",
+	"version": "5.0.1",
 	"description": "Code bidi warning plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,7 +35,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^109.0.0",
+		"@atlaskit/editor-common": "^109.4.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},