@atlaskit/editor-plugin-annotation 2.1.9 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.2.0
+
+### Minor Changes
+
+- [#133398](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/133398)
+  [`fd3381fec1435`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fd3381fec1435) -
+  clearing the selectedAnnotations on close of inline comment
+
+## 2.1.10
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.1.9
 
 ### Patch Changes

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

@@ -177,7 +177,8 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
         return onSetVisibility(editorView)(isVisible);
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
-        if (!annotationId) {
+        var pluginState = (0, _utils.getPluginState)(editorView.state);
+        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks')) {
           (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
         } else {
           (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
@@ -232,17 +233,49 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           // Mouseup won't be triggered after dropping
           // Hence, update the mouse data to cancel selecting when drag starts
           return onMouseUp(view.state, view.dispatch)(event);
+        },
+        click: function click(view, event) {
+          var _event$target$closest, _pluginState$selected;
+          if (!(0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks')) {
+            return false;
+          }
+          if (!(event.target instanceof HTMLElement)) {
+            return false;
+          }
+
+          // Find the nearest ancestor (or self) with the data-id attribute
+          var annotationId = (_event$target$closest = event.target.closest('[data-id]')) === null || _event$target$closest === void 0 ? void 0 : _event$target$closest.getAttribute('data-id');
+          if (!annotationId) {
+            return false;
+          }
+          var pluginState = (0, _utils.getPluginState)(view.state);
+          var isSelected = pluginState === null || pluginState === void 0 || (_pluginState$selected = pluginState.selectedAnnotations) === null || _pluginState$selected === void 0 ? void 0 : _pluginState$selected.some(function (selectedAnnotation) {
+            return selectedAnnotation.id === annotationId;
+          });
+          // If the annotation is selected and the inline comment view is open, do nothing
+          // as the user is already in the comment view.
+          if (isSelected && !(pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed)) {
+            return false;
+          }
+          var _ref5 = pluginState || {},
+            annotations = _ref5.annotations;
+          var isUnresolved = annotations && annotations[annotationId] === false;
+          if (!isUnresolved) {
+            return false;
+          }
+          (0, _editorCommands.setSelectedAnnotation)(annotationId)(view.state, view.dispatch);
+          return true;
         }
       },
       decorations: function decorations(state) {
         // highlight comments, depending on state
-        var _ref5 = (0, _utils.getPluginState)(state) || {},
-          draftDecorationSet = _ref5.draftDecorationSet,
-          annotations = _ref5.annotations,
-          selectedAnnotations = _ref5.selectedAnnotations,
-          isVisible = _ref5.isVisible,
-          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed,
-          hoveredAnnotations = _ref5.hoveredAnnotations;
+        var _ref6 = (0, _utils.getPluginState)(state) || {},
+          draftDecorationSet = _ref6.draftDecorationSet,
+          annotations = _ref6.annotations,
+          selectedAnnotations = _ref6.selectedAnnotations,
+          isVisible = _ref6.isVisible,
+          isInlineCommentViewClosed = _ref6.isInlineCommentViewClosed,
+          hoveredAnnotations = _ref6.hoveredAnnotations;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : _view.DecorationSet.empty;
         var focusDecorations = [];
         state.doc.descendants(function (node, pos) {

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

@@ -8,6 +8,7 @@ exports.default = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _types = require("./types");
 var _utils = require("./utils");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -35,6 +36,8 @@ var _default = exports.default = function _default(pluginState, action) {
         isInlineCommentViewClosed: true,
         isDrafting: false,
         isOpeningMediaCommentFromToolbar: false
+      }, (0, _platformFeatureFlags.fg)('platform_editor_annotation_selected_annotation') && {
+        selectedAnnotations: []
       });
     case _types.ACTIONS.ADD_INLINE_COMMENT:
       var updatedPluginState = getNewDraftState(pluginState, action.data.drafting, action.data.editorState);

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

@@ -329,7 +329,7 @@ var isSelectionValid = exports.isSelectionValid = function isSelectionValid(stat
   var allowedInlineNodes = ['emoji', 'status', 'date', 'mention', 'inlineCard'];
   var isSelectionEmpty = selection.empty;
   var isTextOrAllSelection = selection instanceof _state.TextSelection || selection instanceof _state.AllSelection;
-  var isValidNodeSelection = selection instanceof _state.NodeSelection && allowedInlineNodes.includes(selection.node.type.name) && (0, _platformFeatureFlags.fg)('platform_inline_node_as_valid_annotation_selection');
+  var isValidNodeSelection = selection instanceof _state.NodeSelection && allowedInlineNodes.includes(selection.node.type.name);
   var isValidSelection = isTextOrAllSelection || isValidNodeSelection;
 
   // Allow media so that it can enter draft mode

package/dist/cjs/types/index.js

@@ -13,8 +13,10 @@ exports.AnnotationTestIds = exports.AnnotationSelectionType = void 0;
  */
 var AnnotationSelectionType = exports.AnnotationSelectionType = /*#__PURE__*/function (AnnotationSelectionType) {
   AnnotationSelectionType["INVALID"] = "invalid";
+  // Annotation should not be created, toolbar should not be shown
   AnnotationSelectionType["DISABLED"] = "disabled";
-  AnnotationSelectionType["VALID"] = "valid";
+  // Annotation should not be created, toolbar should be shown, but disabled
+  AnnotationSelectionType["VALID"] = "valid"; // Annotation can be created
   return AnnotationSelectionType;
 }({});
 var prefix = 'ak-editor-annotation';

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

@@ -109,7 +109,8 @@ export const inlineCommentPlugin = options => {
       const mouseUp = event => onMouseUp(editorView.state, editorView.dispatch)(event);
       const setVisibility = isVisible => onSetVisibility(editorView)(isVisible);
       const setSelectedAnnotationFn = annotationId => {
-        if (!annotationId) {
+        const pluginState = getPluginState(editorView.state);
+        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
           closeComponent()(editorView.state, editorView.dispatch);
         } else {
           setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
@@ -167,6 +168,37 @@ export const inlineCommentPlugin = options => {
           // Mouseup won't be triggered after dropping
           // Hence, update the mouse data to cancel selecting when drag starts
           return onMouseUp(view.state, view.dispatch)(event);
+        },
+        click: (view, event) => {
+          var _event$target$closest, _pluginState$selected;
+          if (!fg('platform_editor_listen_for_annotation_clicks')) {
+            return false;
+          }
+          if (!(event.target instanceof HTMLElement)) {
+            return false;
+          }
+
+          // Find the nearest ancestor (or self) with the data-id attribute
+          const annotationId = (_event$target$closest = event.target.closest('[data-id]')) === null || _event$target$closest === void 0 ? void 0 : _event$target$closest.getAttribute('data-id');
+          if (!annotationId) {
+            return false;
+          }
+          const pluginState = getPluginState(view.state);
+          const isSelected = pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$selected = pluginState.selectedAnnotations) === null || _pluginState$selected === void 0 ? void 0 : _pluginState$selected.some(selectedAnnotation => selectedAnnotation.id === annotationId);
+          // If the annotation is selected and the inline comment view is open, do nothing
+          // as the user is already in the comment view.
+          if (isSelected && !(pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed)) {
+            return false;
+          }
+          const {
+            annotations
+          } = pluginState || {};
+          const isUnresolved = annotations && annotations[annotationId] === false;
+          if (!isUnresolved) {
+            return false;
+          }
+          setSelectedAnnotation(annotationId)(view.state, view.dispatch);
+          return true;
         }
       },
       decorations(state) {

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

@@ -1,4 +1,5 @@
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTIONS } from './types';
 import { addDraftDecoration, resolveDraftBookmark } from './utils';
 export default ((pluginState, action) => {
@@ -30,7 +31,10 @@ export default ((pluginState, action) => {
         ...pluginState,
         isInlineCommentViewClosed: true,
         isDrafting: false,
-        isOpeningMediaCommentFromToolbar: false
+        isOpeningMediaCommentFromToolbar: false,
+        ...(fg('platform_editor_annotation_selected_annotation') && {
+          selectedAnnotations: []
+        })
       };
     case ACTIONS.ADD_INLINE_COMMENT:
       const updatedPluginState = getNewDraftState(pluginState, action.data.drafting, action.data.editorState);

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

@@ -298,7 +298,7 @@ export const isSelectionValid = (state, _supportedNodes = []) => {
   const allowedInlineNodes = ['emoji', 'status', 'date', 'mention', 'inlineCard'];
   const isSelectionEmpty = selection.empty;
   const isTextOrAllSelection = selection instanceof TextSelection || selection instanceof AllSelection;
-  const isValidNodeSelection = selection instanceof NodeSelection && allowedInlineNodes.includes(selection.node.type.name) && fg('platform_inline_node_as_valid_annotation_selection');
+  const isValidNodeSelection = selection instanceof NodeSelection && allowedInlineNodes.includes(selection.node.type.name);
   const isValidSelection = isTextOrAllSelection || isValidNodeSelection;
 
   // Allow media so that it can enter draft mode

package/dist/es2019/types/index.js

@@ -9,8 +9,10 @@
 
 export let AnnotationSelectionType = /*#__PURE__*/function (AnnotationSelectionType) {
   AnnotationSelectionType["INVALID"] = "invalid";
+  // Annotation should not be created, toolbar should not be shown
   AnnotationSelectionType["DISABLED"] = "disabled";
-  AnnotationSelectionType["VALID"] = "valid";
+  // Annotation should not be created, toolbar should be shown, but disabled
+  AnnotationSelectionType["VALID"] = "valid"; // Annotation can be created
   return AnnotationSelectionType;
 }({});
 const prefix = 'ak-editor-annotation';

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

@@ -170,7 +170,8 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
         return onSetVisibility(editorView)(isVisible);
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
-        if (!annotationId) {
+        var pluginState = getPluginState(editorView.state);
+        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
           closeComponent()(editorView.state, editorView.dispatch);
         } else {
           setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
@@ -225,17 +226,49 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           // Mouseup won't be triggered after dropping
           // Hence, update the mouse data to cancel selecting when drag starts
           return onMouseUp(view.state, view.dispatch)(event);
+        },
+        click: function click(view, event) {
+          var _event$target$closest, _pluginState$selected;
+          if (!fg('platform_editor_listen_for_annotation_clicks')) {
+            return false;
+          }
+          if (!(event.target instanceof HTMLElement)) {
+            return false;
+          }
+
+          // Find the nearest ancestor (or self) with the data-id attribute
+          var annotationId = (_event$target$closest = event.target.closest('[data-id]')) === null || _event$target$closest === void 0 ? void 0 : _event$target$closest.getAttribute('data-id');
+          if (!annotationId) {
+            return false;
+          }
+          var pluginState = getPluginState(view.state);
+          var isSelected = pluginState === null || pluginState === void 0 || (_pluginState$selected = pluginState.selectedAnnotations) === null || _pluginState$selected === void 0 ? void 0 : _pluginState$selected.some(function (selectedAnnotation) {
+            return selectedAnnotation.id === annotationId;
+          });
+          // If the annotation is selected and the inline comment view is open, do nothing
+          // as the user is already in the comment view.
+          if (isSelected && !(pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed)) {
+            return false;
+          }
+          var _ref5 = pluginState || {},
+            annotations = _ref5.annotations;
+          var isUnresolved = annotations && annotations[annotationId] === false;
+          if (!isUnresolved) {
+            return false;
+          }
+          setSelectedAnnotation(annotationId)(view.state, view.dispatch);
+          return true;
         }
       },
       decorations: function decorations(state) {
         // highlight comments, depending on state
-        var _ref5 = getPluginState(state) || {},
-          draftDecorationSet = _ref5.draftDecorationSet,
-          annotations = _ref5.annotations,
-          selectedAnnotations = _ref5.selectedAnnotations,
-          isVisible = _ref5.isVisible,
-          isInlineCommentViewClosed = _ref5.isInlineCommentViewClosed,
-          hoveredAnnotations = _ref5.hoveredAnnotations;
+        var _ref6 = getPluginState(state) || {},
+          draftDecorationSet = _ref6.draftDecorationSet,
+          annotations = _ref6.annotations,
+          selectedAnnotations = _ref6.selectedAnnotations,
+          isVisible = _ref6.isVisible,
+          isInlineCommentViewClosed = _ref6.isInlineCommentViewClosed,
+          hoveredAnnotations = _ref6.hoveredAnnotations;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : DecorationSet.empty;
         var focusDecorations = [];
         state.doc.descendants(function (node, pos) {

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

@@ -3,6 +3,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTIONS } from './types';
 import { addDraftDecoration, resolveDraftBookmark } from './utils';
 export default (function (pluginState, action) {
@@ -28,6 +29,8 @@ export default (function (pluginState, action) {
         isInlineCommentViewClosed: true,
         isDrafting: false,
         isOpeningMediaCommentFromToolbar: false
+      }, fg('platform_editor_annotation_selected_annotation') && {
+        selectedAnnotations: []
       });
     case ACTIONS.ADD_INLINE_COMMENT:
       var updatedPluginState = getNewDraftState(pluginState, action.data.drafting, action.data.editorState);

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

@@ -312,7 +312,7 @@ export var isSelectionValid = function isSelectionValid(state) {
   var allowedInlineNodes = ['emoji', 'status', 'date', 'mention', 'inlineCard'];
   var isSelectionEmpty = selection.empty;
   var isTextOrAllSelection = selection instanceof TextSelection || selection instanceof AllSelection;
-  var isValidNodeSelection = selection instanceof NodeSelection && allowedInlineNodes.includes(selection.node.type.name) && fg('platform_inline_node_as_valid_annotation_selection');
+  var isValidNodeSelection = selection instanceof NodeSelection && allowedInlineNodes.includes(selection.node.type.name);
   var isValidSelection = isTextOrAllSelection || isValidNodeSelection;
 
   // Allow media so that it can enter draft mode

package/dist/esm/types/index.js

@@ -9,8 +9,10 @@
 
 export var AnnotationSelectionType = /*#__PURE__*/function (AnnotationSelectionType) {
   AnnotationSelectionType["INVALID"] = "invalid";
+  // Annotation should not be created, toolbar should not be shown
   AnnotationSelectionType["DISABLED"] = "disabled";
-  AnnotationSelectionType["VALID"] = "valid";
+  // Annotation should not be created, toolbar should be shown, but disabled
+  AnnotationSelectionType["VALID"] = "valid"; // Annotation can be created
   return AnnotationSelectionType;
 }({});
 var prefix = 'ak-editor-annotation';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.1.9",
+	"version": "2.2.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,16 +32,16 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^102.13.0",
+		"@atlaskit/editor-common": "^102.15.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.3.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/icon": "^25.0.0",
-		"@atlaskit/onboarding": "^13.0.0",
+		"@atlaskit/icon": "^25.3.0",
+		"@atlaskit/onboarding": "^14.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.4.0",
+		"@atlaskit/tmp-editor-statsig": "^4.5.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -96,9 +96,6 @@
 		"editor_inline_comments_on_inline_nodes": {
 			"type": "boolean"
 		},
-		"platform_inline_node_as_valid_annotation_selection": {
-			"type": "boolean"
-		},
 		"platform_editor_fix_missing_selected_annotations": {
 			"type": "boolean"
 		},
@@ -107,6 +104,12 @@
 		},
 		"confluence_comments_create_comment_experience": {
 			"type": "boolean"
+		},
+		"platform_editor_listen_for_annotation_clicks": {
+			"type": "boolean"
+		},
+		"platform_editor_annotation_selected_annotation": {
+			"type": "boolean"
 		}
 	}
 }