@atlaskit/editor-plugin-annotation 1.9.0 → 1.9.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.9.1
+
+### Patch Changes
+
+-   [#97803](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/97803)
+    [`4c1023ffb3d8`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4c1023ffb3d8) -
+    [ED-23094] Ignore annotations on mediaInline node, including highlight styling,
+    event(onMouseEnter, onClick) listeners, update active annotations when the node is selected or
+    the cursor is right after the node
+
 ## 1.9.0
 
 ### Minor Changes

package/dist/cjs/pm-plugins/inline-comment.js

@@ -220,11 +220,18 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           annotations = _ref5.annotations,
           selectedAnnotations = _ref5.selectedAnnotations,
           isVisible = _ref5.isVisible,
-          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed;
+          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed,
+          featureFlagsPluginState = _ref5.featureFlagsPluginState;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : _view.DecorationSet.empty;
         var focusDecorations = [];
+        var isCommentsOnMediaMediaInlineBugFixEnabled = featureFlagsPluginState === null || featureFlagsPluginState === void 0 ? void 0 : featureFlagsPluginState.commentsOnMediaMediaInlineBugFix;
         state.doc.descendants(function (node, pos) {
           var _provider$supportedBl;
+          // Inline comment on mediaInline is not supported as part of comments on media project
+          // Thus, we skip the decoration for mediaInline node
+          if (isCommentsOnMediaMediaInlineBugFixEnabled && node.type.name === 'mediaInline') {
+            return false;
+          }
           var isSupportedBlockNode = node.isBlock && ((_provider$supportedBl = provider.supportedBlockNodes) === null || _provider$supportedBl === void 0 ? void 0 : _provider$supportedBl.includes(node.type.name));
           node.marks.filter(function (mark) {
             return mark.type === state.schema.marks.annotation;

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

@@ -22,7 +22,7 @@ var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
 };
 var getSelectionChangedHandler = function getSelectionChangedHandler(reopenCommentView) {
   return function (tr, pluginState) {
-    var _pluginState$featureF;
+    var _pluginState$featureF, _pluginState$featureF2;
     if (pluginState.skipSelectionHandling) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {
         skipSelectionHandling: false
@@ -38,7 +38,7 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
         isInlineCommentViewClosed: false
       });
     }
-    var selectedAnnotations = (0, _utils2.findAnnotationsInSelection)(tr.selection, tr.doc);
+    var selectedAnnotations = (0, _utils2.findAnnotationsInSelection)(tr.selection, tr.doc, (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaMediaInlineBugFix);
     if (selectedAnnotations.length === 0) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {
         selectedAnnotations: selectedAnnotations,

package/dist/cjs/utils.js

@@ -167,7 +167,7 @@ var isCurrentBlockNodeSelected = exports.isCurrentBlockNodeSelected = function i
   }
   return false;
 };
-var findAnnotationsInSelection = exports.findAnnotationsInSelection = function findAnnotationsInSelection(selection, doc) {
+var findAnnotationsInSelection = exports.findAnnotationsInSelection = function findAnnotationsInSelection(selection, doc, isCommentsOnMediaMediaInlineBugFixEnabled) {
   var empty = selection.empty,
     $anchor = selection.$anchor,
     anchor = selection.anchor;
@@ -176,11 +176,19 @@ var findAnnotationsInSelection = exports.findAnnotationsInSelection = function f
     return [];
   }
   var node = doc.nodeAt(anchor);
-  if (!node && !$anchor.nodeBefore) {
+  var nodeBefore = $anchor.nodeBefore;
+  if (!node && !nodeBefore) {
+    return [];
+  }
+
+  // Inline comment on mediaInline is not supported as part of comments on media project
+  // Hence, we ignore annotations associated with the node when the cursor is right after/before the node
+  if (isCommentsOnMediaMediaInlineBugFixEnabled && [nodeBefore, node].some(function (node) {
+    return (node === null || node === void 0 ? void 0 : node.type.name) === 'mediaInline';
+  })) {
     return [];
   }
   var annotationMark = doc.type.schema.marks.annotation;
-  var nodeBefore = $anchor.nodeBefore;
   var anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   var marks = [];
   if (annotationMark.isInSet(anchorAnnotationMarks)) {

package/dist/es2019/pm-plugins/inline-comment.js

@@ -159,12 +159,19 @@ export const inlineCommentPlugin = options => {
           annotations,
           selectedAnnotations,
           isVisible,
-          isInlineCommentViewClosed
+          isInlineCommentViewClosed,
+          featureFlagsPluginState
         } = getPluginState(state) || {};
         let decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : DecorationSet.empty;
         const focusDecorations = [];
+        const isCommentsOnMediaMediaInlineBugFixEnabled = featureFlagsPluginState === null || featureFlagsPluginState === void 0 ? void 0 : featureFlagsPluginState.commentsOnMediaMediaInlineBugFix;
         state.doc.descendants((node, pos) => {
           var _provider$supportedBl;
+          // Inline comment on mediaInline is not supported as part of comments on media project
+          // Thus, we skip the decoration for mediaInline node
+          if (isCommentsOnMediaMediaInlineBugFixEnabled && node.type.name === 'mediaInline') {
+            return false;
+          }
           const isSupportedBlockNode = node.isBlock && ((_provider$supportedBl = provider.supportedBlockNodes) === null || _provider$supportedBl === void 0 ? void 0 : _provider$supportedBl.includes(node.type.name));
           node.marks.filter(mark => mark.type === state.schema.marks.annotation).forEach(mark => {
             if (isVisible) {

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

@@ -12,7 +12,7 @@ const handleDocChanged = (tr, prevPluginState) => {
   };
 };
 const getSelectionChangedHandler = reopenCommentView => (tr, pluginState) => {
-  var _pluginState$featureF;
+  var _pluginState$featureF, _pluginState$featureF2;
   if (pluginState.skipSelectionHandling) {
     return {
       ...pluginState,
@@ -33,7 +33,7 @@ const getSelectionChangedHandler = reopenCommentView => (tr, pluginState) => {
       })
     };
   }
-  const selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc);
+  const selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc, (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaMediaInlineBugFix);
   if (selectedAnnotations.length === 0) {
     return {
       ...pluginState,

package/dist/es2019/utils.js

@@ -128,7 +128,7 @@ export const isCurrentBlockNodeSelected = (state, node) => {
   }
   return false;
 };
-export const findAnnotationsInSelection = (selection, doc) => {
+export const findAnnotationsInSelection = (selection, doc, isCommentsOnMediaMediaInlineBugFixEnabled) => {
   const {
     empty,
     $anchor,
@@ -139,11 +139,17 @@ export const findAnnotationsInSelection = (selection, doc) => {
     return [];
   }
   const node = doc.nodeAt(anchor);
-  if (!node && !$anchor.nodeBefore) {
+  const nodeBefore = $anchor.nodeBefore;
+  if (!node && !nodeBefore) {
+    return [];
+  }
+
+  // Inline comment on mediaInline is not supported as part of comments on media project
+  // Hence, we ignore annotations associated with the node when the cursor is right after/before the node
+  if (isCommentsOnMediaMediaInlineBugFixEnabled && [nodeBefore, node].some(node => (node === null || node === void 0 ? void 0 : node.type.name) === 'mediaInline')) {
     return [];
   }
   const annotationMark = doc.type.schema.marks.annotation;
-  const nodeBefore = $anchor.nodeBefore;
   const anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   let marks = [];
   if (annotationMark.isInSet(anchorAnnotationMarks)) {

package/dist/esm/pm-plugins/inline-comment.js

@@ -213,11 +213,18 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           annotations = _ref5.annotations,
           selectedAnnotations = _ref5.selectedAnnotations,
           isVisible = _ref5.isVisible,
-          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed;
+          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed,
+          featureFlagsPluginState = _ref5.featureFlagsPluginState;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : DecorationSet.empty;
         var focusDecorations = [];
+        var isCommentsOnMediaMediaInlineBugFixEnabled = featureFlagsPluginState === null || featureFlagsPluginState === void 0 ? void 0 : featureFlagsPluginState.commentsOnMediaMediaInlineBugFix;
         state.doc.descendants(function (node, pos) {
           var _provider$supportedBl;
+          // Inline comment on mediaInline is not supported as part of comments on media project
+          // Thus, we skip the decoration for mediaInline node
+          if (isCommentsOnMediaMediaInlineBugFixEnabled && node.type.name === 'mediaInline') {
+            return false;
+          }
           var isSupportedBlockNode = node.isBlock && ((_provider$supportedBl = provider.supportedBlockNodes) === null || _provider$supportedBl === void 0 ? void 0 : _provider$supportedBl.includes(node.type.name));
           node.marks.filter(function (mark) {
             return mark.type === state.schema.marks.annotation;

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

@@ -15,7 +15,7 @@ var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
 };
 var getSelectionChangedHandler = function getSelectionChangedHandler(reopenCommentView) {
   return function (tr, pluginState) {
-    var _pluginState$featureF;
+    var _pluginState$featureF, _pluginState$featureF2;
     if (pluginState.skipSelectionHandling) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {
         skipSelectionHandling: false
@@ -31,7 +31,7 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
         isInlineCommentViewClosed: false
       });
     }
-    var selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc);
+    var selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc, (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaMediaInlineBugFix);
     if (selectedAnnotations.length === 0) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {
         selectedAnnotations: selectedAnnotations,

package/dist/esm/utils.js

@@ -140,7 +140,7 @@ export var isCurrentBlockNodeSelected = function isCurrentBlockNodeSelected(stat
   }
   return false;
 };
-export var findAnnotationsInSelection = function findAnnotationsInSelection(selection, doc) {
+export var findAnnotationsInSelection = function findAnnotationsInSelection(selection, doc, isCommentsOnMediaMediaInlineBugFixEnabled) {
   var empty = selection.empty,
     $anchor = selection.$anchor,
     anchor = selection.anchor;
@@ -149,11 +149,19 @@ export var findAnnotationsInSelection = function findAnnotationsInSelection(sele
     return [];
   }
   var node = doc.nodeAt(anchor);
-  if (!node && !$anchor.nodeBefore) {
+  var nodeBefore = $anchor.nodeBefore;
+  if (!node && !nodeBefore) {
+    return [];
+  }
+
+  // Inline comment on mediaInline is not supported as part of comments on media project
+  // Hence, we ignore annotations associated with the node when the cursor is right after/before the node
+  if (isCommentsOnMediaMediaInlineBugFixEnabled && [nodeBefore, node].some(function (node) {
+    return (node === null || node === void 0 ? void 0 : node.type.name) === 'mediaInline';
+  })) {
     return [];
   }
   var annotationMark = doc.type.schema.marks.annotation;
-  var nodeBefore = $anchor.nodeBefore;
   var anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   var marks = [];
   if (annotationMark.isInSet(anchorAnnotationMarks)) {

package/dist/types/utils.d.ts

@@ -21,7 +21,7 @@ export declare const decorationKey: {
 export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const isCurrentBlockNodeSelected: (state: EditorState, node: Node) => boolean;
-export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+export declare const findAnnotationsInSelection: (selection: Selection, doc: Node, isCommentsOnMediaMediaInlineBugFixEnabled?: boolean) => AnnotationInfo[];
 export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?: SelectionBookmark, supportedBlockNodes?: string[]) => DraftBookmark;
 /**
  * get selection from position to apply new comment for

package/dist/types-ts4.5/utils.d.ts

@@ -21,7 +21,7 @@ export declare const decorationKey: {
 export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const isCurrentBlockNodeSelected: (state: EditorState, node: Node) => boolean;
-export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+export declare const findAnnotationsInSelection: (selection: Selection, doc: Node, isCommentsOnMediaMediaInlineBugFixEnabled?: boolean) => AnnotationInfo[];
 export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?: SelectionBookmark, supportedBlockNodes?: string[]) => DraftBookmark;
 /**
  * get selection from position to apply new comment for

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "1.9.0",
+  "version": "1.9.1",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",