@atlaskit/editor-plugin-annotation 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/editor-plugin-annotation
 
+## 5.4.0
+
+### Minor Changes
+
+- [`08569ab338048`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/08569ab338048) -
+  Removed feature gates for cleanup
+
+## 5.3.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 5.3.1
+
+### Patch Changes
+
+- [`b85694a21dec9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b85694a21dec9) -
+  [ux] [ED-29271] don't show Comment button if a draft comment is in progress
+- Updated dependencies
+
 ## 5.3.0
 
 ### Minor Changes

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

@@ -29,7 +29,7 @@ var fetchProviderStates = /*#__PURE__*/function () {
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          if (!((!provider || !provider.getState) && (0, _platformFeatureFlags.fg)('use_comments_data_annotation_updater'))) {
+          if (!(!provider || !provider.getState)) {
             _context.next = 2;
             break;
           }
@@ -65,26 +65,20 @@ var fetchState = /*#__PURE__*/function () {
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          if (!((!annotationIds || !annotationIds.length) && !(0, _platformFeatureFlags.fg)('use_comments_data_annotation_updater'))) {
-            _context2.next = 2;
-            break;
-          }
-          return _context2.abrupt("return");
-        case 2:
-          _context2.next = 4;
+          _context2.next = 2;
           return fetchProviderStates(provider, annotationIds);
-        case 4:
+        case 2:
           inlineCommentStates = _context2.sent;
-          if (!(Object.keys(inlineCommentStates).length === 0 && (0, _platformFeatureFlags.fg)('use_comments_data_annotation_updater'))) {
-            _context2.next = 7;
+          if (!(Object.keys(inlineCommentStates).length === 0)) {
+            _context2.next = 5;
             break;
           }
           return _context2.abrupt("return");
-        case 7:
+        case 5:
           if (editorView.dispatch) {
             (0, _editorCommands.updateInlineCommentResolvedState)(editorAnalyticsAPI)(inlineCommentStates)(editorView.state, editorView.dispatch);
           }
-        case 8:
+        case 6:
         case "end":
           return _context2.stop();
       }
@@ -214,24 +208,10 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
         return onSetVisibility(editorView)(isVisible);
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
-        var pluginState = (0, _utils3.getPluginState)(editorView.state);
-        if ((0, _platformFeatureFlags.fg)('platform_editor_listen_for_focussed_query_param')) {
-          // When feature flag is true, only close if no annotationId
-          if (!annotationId) {
-            (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
-          } else {
-            (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
-          }
+        if (!annotationId) {
+          (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
         } else {
-          // When feature flag is false, close if:
-          // 1. No annotationId OR
-          // 2. View is closed and annotation clicks are enabled
-          var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks');
-          if (shouldClose) {
-            (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
-          } else {
-            (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
-          }
+          (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
         }
       };
       var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {
@@ -280,15 +260,13 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           selectedAnnotationId && selectedAnnotationId !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 || (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id) &&
           // This ensures that the selected annotation is unresolved
           annotations && annotations[selectedAnnotationId] === false) {
-            var _options$selectCommen;
+            var _options$selectCommen, _options$viewInlineCo;
             // ...we mark the select annotation experience as complete.
             // The selectComponentExperience is using a simplified object, which is why it's type asserted.
             (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
-            if ((0, _platformFeatureFlags.fg)('cc_comments_track_view_inline_comment_action')) {
-              var _options$viewInlineCo;
-              // ...and start a new UFO press trace since the selected comment is changing
-              (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 || _options$viewInlineCo.call(options);
-            }
+
+            // ...and start a new UFO press trace since the selected comment is changing
+            (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 || _options$viewInlineCo.call(options);
           }
           var api = options.api;
           if (isDrafting && !view.state.selection.eq(_prevState.selection) && (0, _experiments.editorExperiment)('platform_editor_toolbar_aifc', true) && (0, _expValEquals.expValEquals)('platform_editor_toolbar_aifc_patch_2', 'isEnabled', true)) {

package/dist/cjs/ui/CommentButton/utils.js

@@ -9,6 +9,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _mediaSingle = require("@atlaskit/editor-common/media-single");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _editorCommands = require("../../editor-commands");
 var _utils = require("../../pm-plugins/utils");
 var _types = require("../../types");
@@ -27,9 +28,14 @@ var shouldShowCommentButton = exports.shouldShowCommentButton = function shouldS
     isVisible = _ref2.isVisible,
     annotationSelectionType = _ref2.annotationSelectionType;
   var isMediaSelected = state ? (0, _mediaSingle.currentMediaNodeWithPos)(state) : false;
+  var isDrafting = false;
+  if ((0, _expValEquals.expValEquals)('platform_editor_toolbar_aifc_patch_4', 'isEnabled', true) && state) {
+    var _inlineCommentPluginK;
+    isDrafting = ((_inlineCommentPluginK = _utils.inlineCommentPluginKey.getState(state)) === null || _inlineCommentPluginK === void 0 ? void 0 : _inlineCommentPluginK.isDrafting) || false;
+  }
 
   // comments on media can only be added via media floating toolbar
-  if (isMediaSelected || annotationSelectionType === _types.AnnotationSelectionType.INVALID || !isVisible) {
+  if (isDrafting || isMediaSelected || annotationSelectionType === _types.AnnotationSelectionType.INVALID || !isVisible) {
     return false;
   }
   return true;

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

@@ -14,7 +14,7 @@ import { createPluginState } from './plugin-factory';
 import { shouldSuppressFloatingToolbar } from './toolbar';
 import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey } from './utils';
 const fetchProviderStates = async (provider, annotationIds) => {
-  if ((!provider || !provider.getState) && fg('use_comments_data_annotation_updater')) {
+  if (!provider || !provider.getState) {
     return {};
   }
   const data = await provider.getState(annotationIds);
@@ -30,11 +30,8 @@ const fetchProviderStates = async (provider, annotationIds) => {
 // fetchState is unable to return a command as it's runs async and may dispatch at a later time
 // Requires `editorView` instead of the decomposition as the async means state may end up stale
 const fetchState = async (provider, annotationIds, editorView, editorAnalyticsAPI) => {
-  if ((!annotationIds || !annotationIds.length) && !fg('use_comments_data_annotation_updater')) {
-    return;
-  }
   const inlineCommentStates = await fetchProviderStates(provider, annotationIds);
-  if (Object.keys(inlineCommentStates).length === 0 && fg('use_comments_data_annotation_updater')) {
+  if (Object.keys(inlineCommentStates).length === 0) {
     return;
   }
   if (editorView.dispatch) {
@@ -145,24 +142,10 @@ export const inlineCommentPlugin = options => {
       const mouseUp = event => onMouseUp(editorView.state, editorView.dispatch)(event);
       const setVisibility = isVisible => onSetVisibility(editorView)(isVisible);
       const setSelectedAnnotationFn = annotationId => {
-        const pluginState = getPluginState(editorView.state);
-        if (fg('platform_editor_listen_for_focussed_query_param')) {
-          // When feature flag is true, only close if no annotationId
-          if (!annotationId) {
-            closeComponent()(editorView.state, editorView.dispatch);
-          } else {
-            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
-          }
+        if (!annotationId) {
+          closeComponent()(editorView.state, editorView.dispatch);
         } else {
-          // When feature flag is false, close if:
-          // 1. No annotationId OR
-          // 2. View is closed and annotation clicks are enabled
-          const shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
-          if (shouldClose) {
-            closeComponent()(editorView.state, editorView.dispatch);
-          } else {
-            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
-          }
+          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
         }
       };
       const setHoveredAnnotationFn = annotationId => {
@@ -215,15 +198,13 @@ export const inlineCommentPlugin = options => {
           selectedAnnotationId && selectedAnnotationId !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 ? void 0 : (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id) &&
           // This ensures that the selected annotation is unresolved
           annotations && annotations[selectedAnnotationId] === false) {
-            var _options$selectCommen;
+            var _options$selectCommen, _options$viewInlineCo;
             // ...we mark the select annotation experience as complete.
             // The selectComponentExperience is using a simplified object, which is why it's type asserted.
             (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 ? void 0 : _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
-            if (fg('cc_comments_track_view_inline_comment_action')) {
-              var _options$viewInlineCo;
-              // ...and start a new UFO press trace since the selected comment is changing
-              (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 ? void 0 : _options$viewInlineCo.call(options);
-            }
+
+            // ...and start a new UFO press trace since the selected comment is changing
+            (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 ? void 0 : _options$viewInlineCo.call(options);
           }
           const {
             api

package/dist/es2019/ui/CommentButton/utils.js

@@ -1,8 +1,9 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD, MODE } from '@atlaskit/editor-common/analytics';
 import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { setInlineCommentDraftState } from '../../editor-commands';
-import { isSelectionValid } from '../../pm-plugins/utils';
+import { inlineCommentPluginKey, isSelectionValid } from '../../pm-plugins/utils';
 import { AnnotationSelectionType } from '../../types';
 export const isButtonDisabled = ({
   state,
@@ -19,9 +20,14 @@ export const shouldShowCommentButton = ({
   annotationSelectionType
 }) => {
   const isMediaSelected = state ? currentMediaNodeWithPos(state) : false;
+  let isDrafting = false;
+  if (expValEquals('platform_editor_toolbar_aifc_patch_4', 'isEnabled', true) && state) {
+    var _inlineCommentPluginK;
+    isDrafting = ((_inlineCommentPluginK = inlineCommentPluginKey.getState(state)) === null || _inlineCommentPluginK === void 0 ? void 0 : _inlineCommentPluginK.isDrafting) || false;
+  }
 
   // comments on media can only be added via media floating toolbar
-  if (isMediaSelected || annotationSelectionType === AnnotationSelectionType.INVALID || !isVisible) {
+  if (isDrafting || isMediaSelected || annotationSelectionType === AnnotationSelectionType.INVALID || !isVisible) {
     return false;
   }
   return true;

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

@@ -22,7 +22,7 @@ var fetchProviderStates = /*#__PURE__*/function () {
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          if (!((!provider || !provider.getState) && fg('use_comments_data_annotation_updater'))) {
+          if (!(!provider || !provider.getState)) {
             _context.next = 2;
             break;
           }
@@ -58,26 +58,20 @@ var fetchState = /*#__PURE__*/function () {
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          if (!((!annotationIds || !annotationIds.length) && !fg('use_comments_data_annotation_updater'))) {
-            _context2.next = 2;
-            break;
-          }
-          return _context2.abrupt("return");
-        case 2:
-          _context2.next = 4;
+          _context2.next = 2;
           return fetchProviderStates(provider, annotationIds);
-        case 4:
+        case 2:
           inlineCommentStates = _context2.sent;
-          if (!(Object.keys(inlineCommentStates).length === 0 && fg('use_comments_data_annotation_updater'))) {
-            _context2.next = 7;
+          if (!(Object.keys(inlineCommentStates).length === 0)) {
+            _context2.next = 5;
             break;
           }
           return _context2.abrupt("return");
-        case 7:
+        case 5:
           if (editorView.dispatch) {
             updateInlineCommentResolvedState(editorAnalyticsAPI)(inlineCommentStates)(editorView.state, editorView.dispatch);
           }
-        case 8:
+        case 6:
         case "end":
           return _context2.stop();
       }
@@ -207,24 +201,10 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
         return onSetVisibility(editorView)(isVisible);
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
-        var pluginState = getPluginState(editorView.state);
-        if (fg('platform_editor_listen_for_focussed_query_param')) {
-          // When feature flag is true, only close if no annotationId
-          if (!annotationId) {
-            closeComponent()(editorView.state, editorView.dispatch);
-          } else {
-            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
-          }
+        if (!annotationId) {
+          closeComponent()(editorView.state, editorView.dispatch);
         } else {
-          // When feature flag is false, close if:
-          // 1. No annotationId OR
-          // 2. View is closed and annotation clicks are enabled
-          var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
-          if (shouldClose) {
-            closeComponent()(editorView.state, editorView.dispatch);
-          } else {
-            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
-          }
+          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
         }
       };
       var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {
@@ -273,15 +253,13 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           selectedAnnotationId && selectedAnnotationId !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 || (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id) &&
           // This ensures that the selected annotation is unresolved
           annotations && annotations[selectedAnnotationId] === false) {
-            var _options$selectCommen;
+            var _options$selectCommen, _options$viewInlineCo;
             // ...we mark the select annotation experience as complete.
             // The selectComponentExperience is using a simplified object, which is why it's type asserted.
             (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
-            if (fg('cc_comments_track_view_inline_comment_action')) {
-              var _options$viewInlineCo;
-              // ...and start a new UFO press trace since the selected comment is changing
-              (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 || _options$viewInlineCo.call(options);
-            }
+
+            // ...and start a new UFO press trace since the selected comment is changing
+            (_options$viewInlineCo = options.viewInlineCommentTraceUFOPress) === null || _options$viewInlineCo === void 0 || _options$viewInlineCo.call(options);
           }
           var api = options.api;
           if (isDrafting && !view.state.selection.eq(_prevState.selection) && editorExperiment('platform_editor_toolbar_aifc', true) && expValEquals('platform_editor_toolbar_aifc_patch_2', 'isEnabled', true)) {

package/dist/esm/ui/CommentButton/utils.js

@@ -4,8 +4,9 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD, MODE } from '@atlaskit/editor-common/analytics';
 import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { setInlineCommentDraftState } from '../../editor-commands';
-import { isSelectionValid } from '../../pm-plugins/utils';
+import { inlineCommentPluginKey, isSelectionValid } from '../../pm-plugins/utils';
 import { AnnotationSelectionType } from '../../types';
 export var isButtonDisabled = function isButtonDisabled(_ref) {
   var _api$connectivity;
@@ -20,9 +21,14 @@ export var shouldShowCommentButton = function shouldShowCommentButton(_ref2) {
     isVisible = _ref2.isVisible,
     annotationSelectionType = _ref2.annotationSelectionType;
   var isMediaSelected = state ? currentMediaNodeWithPos(state) : false;
+  var isDrafting = false;
+  if (expValEquals('platform_editor_toolbar_aifc_patch_4', 'isEnabled', true) && state) {
+    var _inlineCommentPluginK;
+    isDrafting = ((_inlineCommentPluginK = inlineCommentPluginKey.getState(state)) === null || _inlineCommentPluginK === void 0 ? void 0 : _inlineCommentPluginK.isDrafting) || false;
+  }
 
   // comments on media can only be added via media floating toolbar
-  if (isMediaSelected || annotationSelectionType === AnnotationSelectionType.INVALID || !isVisible) {
+  if (isDrafting || isMediaSelected || annotationSelectionType === AnnotationSelectionType.INVALID || !isVisible) {
     return false;
   }
   return true;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "5.3.0",
+	"version": "5.4.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,17 +36,17 @@
 		"@atlaskit/editor-plugin-toolbar": "^2.1.0",
 		"@atlaskit/editor-plugin-user-intent": "^3.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/editor-toolbar": "^0.8.0",
+		"@atlaskit/editor-toolbar": "^0.9.0",
 		"@atlaskit/editor-toolbar-model": "^0.2.0",
-		"@atlaskit/icon": "^28.1.0",
+		"@atlaskit/icon": "^28.2.0",
 		"@atlaskit/onboarding": "^14.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^12.18.0",
+		"@atlaskit/tmp-editor-statsig": "^12.27.0",
 		"@babel/runtime": "^7.0.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^109.5.0",
+		"@atlaskit/editor-common": "^109.11.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
@@ -100,21 +100,12 @@
 		"editor_inline_comments_on_inline_nodes": {
 			"type": "boolean"
 		},
-		"use_comments_data_annotation_updater": {
-			"type": "boolean"
-		},
 		"platform_editor_listen_for_annotation_clicks": {
 			"type": "boolean"
 		},
 		"platform_editor_annotation_selected_annotation": {
 			"type": "boolean"
 		},
-		"platform_editor_listen_for_focussed_query_param": {
-			"type": "boolean"
-		},
-		"cc_comments_track_view_inline_comment_action": {
-			"type": "boolean"
-		},
 		"confluence_frontend_preload_inline_comment_editor": {
 			"type": "boolean"
 		},