@atlaskit/editor-plugin-annotation 2.7.1 → 2.7.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.7.3
+
+### Patch Changes
+
+- [#146979](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/146979)
+  [`5cea1d6e69c56`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5cea1d6e69c56) -
+  ED-27655: Moving annotation plugin options from confluence's full page editor preset to the
+  confluence-presets.
+- Updated dependencies
+
+## 2.7.2
+
+### Patch Changes
+
+- [#145138](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/145138)
+  [`0ba0ff24c0e33`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0ba0ff24c0e33) -
+  Enable useSharedPluginStateSelector in accessibility, alignment, annotation and avatar-group
+  plugins
+- Updated dependencies
+
 ## 2.7.1
 
 ### Patch Changes

package/dist/cjs/annotationPlugin.js

@@ -8,6 +8,7 @@ exports.annotationPlugin = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireDefault(require("react"));
 var _hooks = require("@atlaskit/editor-common/hooks");
+var _useSharedPluginStateSelector = require("@atlaskit/editor-common/use-shared-plugin-state-selector");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _editorCommands = require("./editor-commands");
@@ -138,9 +139,20 @@ function AnnotationContentComponent(_ref4) {
     editorView = _ref4.editorView,
     annotationProviders = _ref4.annotationProviders,
     dispatchAnalyticsEvent = _ref4.dispatchAnalyticsEvent;
-  var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['annotation']),
-    inlineCommentState = _useSharedPluginState.annotationState;
-  if (inlineCommentState && !inlineCommentState.isVisible) {
+  var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['annotation'], {
+      disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true)
+    }),
+    annotationState = _useSharedPluginState.annotationState;
+  var isVisibleSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(api, 'annotation.isVisible', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isVisible = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? isVisibleSelector : annotationState === null || annotationState === void 0 ? void 0 : annotationState.isVisible;
+  if (annotationState && !isVisible && (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)) {
+    return null;
+  }
+
+  // need to expclicitly check for false as undefined is also a valid value to continue
+  if (isVisible === false && (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true)) {
     return null;
   }
   return /*#__PURE__*/_react.default.createElement("div", {

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

@@ -231,15 +231,21 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           if ((0, _platformFeatureFlags.fg)('confluence_comments_select_comment_experience')) {
             var _prevSelectedAnnotati;
             var _ref4 = (0, _utils.getPluginState)(view.state) || {},
-              selectedAnnotations = _ref4.selectedAnnotations;
+              selectedAnnotations = _ref4.selectedAnnotations,
+              annotations = _ref4.annotations;
             var _ref5 = (0, _utils.getPluginState)(_prevState) || {},
               prevSelectedAnnotations = _ref5.selectedAnnotations;
-
-            // If the new state has a selected annotation, and it's different from the previous one
-            // then we mark the select annotation experience as complete
-            if (selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 || (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id)) {
+            var selectedAnnotationId = selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id ? selectedAnnotations[0].id : undefined;
+            // If the new state has an unresolved selected annotation, and it's different from
+            // the previous one then we mark the select annotation experience as complete.
+            if (
+            //This checks the selected annotation is different from the previous one
+            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;
-              (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotations[0].id);
+              // Under the confluence_comments_select_comment_experience feature flag, 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);
             }
           }
           var _ref6 = (0, _utils.getPluginState)(view.state) || {},

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

@@ -253,7 +253,9 @@ var resolveDraftBookmark = exports.resolveDraftBookmark = function resolveDraftB
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
  */
-function getSelectionPositions(editorState, inlineCommentState) {
+function getSelectionPositions(editorState,
+// when cleaning up platform_editor_usesharedpluginstateselector, can change this prop to bookmark
+inlineCommentState) {
   var _ref2 = inlineCommentState || {},
     bookmark = _ref2.bookmark;
   // get positions via saved bookmark if it is available

package/dist/cjs/types/index.js

@@ -26,4 +26,9 @@ var AnnotationTestIds = exports.AnnotationTestIds = {
   floatingToolbarCreateButton: "".concat(prefix, "-toolbar-create-button"),
   componentSave: "".concat(prefix, "-dummy-save-button"),
   componentClose: "".concat(prefix, "-dummy-close-button")
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

package/dist/cjs/ui/InlineCommentView.js

@@ -9,9 +9,11 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _react = _interopRequireDefault(require("react"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _useSharedPluginStateSelector = require("@atlaskit/editor-common/use-shared-plugin-state-selector");
 var _utils = require("@atlaskit/editor-common/utils");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _editorCommands = require("../editor-commands");
 var _utils3 = require("../pm-plugins/utils");
 var _types = require("../types");
@@ -45,14 +47,40 @@ function InlineCommentView(_ref) {
   var CreateComponent = inlineCommentProvider.createComponent,
     ViewComponent = inlineCommentProvider.viewComponent;
   var inlineCommentState = (0, _utils3.getPluginState)(state);
-  var _ref2 = inlineCommentState || {},
-    bookmark = _ref2.bookmark,
-    selectedAnnotations = _ref2.selectedAnnotations,
-    annotations = _ref2.annotations,
-    isInlineCommentViewClosed = _ref2.isInlineCommentViewClosed,
-    isOpeningMediaCommentFromToolbar = _ref2.isOpeningMediaCommentFromToolbar;
+
+  // bookmark
+  var bookmarkSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.bookmark', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var bookmark = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? bookmarkSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.bookmark;
+
+  // selectedAnnotations
+  var selectedAnnotationsSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.selectedAnnotations', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var selectedAnnotations = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? selectedAnnotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectedAnnotations;
+
+  // annotations
+  var annotationsSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.annotations', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var annotations = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? annotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations;
+
+  // isInlineCommentViewClosed
+  var isInlineCommentViewClosedSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.isInlineCommentViewClosed', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isInlineCommentViewClosed = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? isInlineCommentViewClosedSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed;
+
+  // isOpeningMediaCommentFromToolbar
+  var isOpeningMediaCommentFromToolbarSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.isOpeningMediaCommentFromToolbar', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isOpeningMediaCommentFromToolbar = (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? isOpeningMediaCommentFromToolbarSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar;
   var annotationsList = (0, _utils3.getAllAnnotations)(editorView.state.doc);
-  var selection = (0, _utils3.getSelectionPositions)(state, inlineCommentState);
+  var selection = (0, _utils3.getSelectionPositions)(state, (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', true) ? {
+    bookmark: bookmark
+  } : inlineCommentState);
   var position = findPosForDOM(selection);
   var dom;
   try {
@@ -78,6 +106,11 @@ function InlineCommentView(_ref) {
       dispatchAnalyticsEvent(payload);
     }
   }
+
+  // selectAnnotationMethod
+  var selectAnnotationMethodSelector = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(editorAPI, 'annotation.selectAnnotationMethod', {
+    disabled: (0, _experiments.editorExperiment)('platform_editor_usesharedpluginstateselector', false)
+  });
   if (!dom) {
     return null;
   }
@@ -132,8 +165,6 @@ function InlineCommentView(_ref) {
     if (!dispatchAnalyticsEvent) {
       return;
     }
-    var _ref3 = inlineCommentState || {},
-      selectAnnotationMethod = _ref3.selectAnnotationMethod;
 
     // fire analytics
     var payload = {
@@ -144,7 +175,7 @@ function InlineCommentView(_ref) {
       attributes: {
         overlap: activeAnnotations.length ? activeAnnotations.length - 1 : 0,
         targetNodeType: (_editorView$state$doc = editorView.state.doc.nodeAt(position)) === null || _editorView$state$doc === void 0 ? void 0 : _editorView$state$doc.type.name,
-        method: selectAnnotationMethod
+        method: (0, _experiments.editorExperiment)('platform_editor_tables_table_selector', true) ? selectAnnotationMethodSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
       }
     };
     dispatchAnalyticsEvent(payload);

package/dist/es2019/annotationPlugin.js

@@ -1,5 +1,6 @@
 import React from 'react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { setInlineCommentDraftState, showInlineCommentForBlockNode } from './editor-commands';
@@ -134,9 +135,20 @@ function AnnotationContentComponent({
 }) {
   var _api$analytics5;
   const {
-    annotationState: inlineCommentState
-  } = useSharedPluginState(api, ['annotation']);
-  if (inlineCommentState && !inlineCommentState.isVisible) {
+    annotationState
+  } = useSharedPluginState(api, ['annotation'], {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', true)
+  });
+  const isVisibleSelector = useSharedPluginStateSelector(api, 'annotation.isVisible', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const isVisible = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isVisibleSelector : annotationState === null || annotationState === void 0 ? void 0 : annotationState.isVisible;
+  if (annotationState && !isVisible && editorExperiment('platform_editor_usesharedpluginstateselector', false)) {
+    return null;
+  }
+
+  // need to expclicitly check for false as undefined is also a valid value to continue
+  if (isVisible === false && editorExperiment('platform_editor_usesharedpluginstateselector', true)) {
     return null;
   }
   return /*#__PURE__*/React.createElement("div", {

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

@@ -165,17 +165,23 @@ export const inlineCommentPlugin = options => {
           if (fg('confluence_comments_select_comment_experience')) {
             var _prevSelectedAnnotati;
             const {
-              selectedAnnotations
+              selectedAnnotations,
+              annotations
             } = getPluginState(view.state) || {};
             const {
               selectedAnnotations: prevSelectedAnnotations
             } = getPluginState(_prevState) || {};
-
-            // If the new state has a selected annotation, and it's different from the previous one
-            // then we mark the select annotation experience as complete
-            if (selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 ? void 0 : (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id)) {
+            const selectedAnnotationId = selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id ? selectedAnnotations[0].id : undefined;
+            // If the new state has an unresolved selected annotation, and it's different from
+            // the previous one then we mark the select annotation experience as complete.
+            if (
+            //This checks the selected annotation is different from the previous one
+            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;
-              (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 ? void 0 : _options$selectCommen.selectAnnotation.complete(selectedAnnotations[0].id);
+              // Under the confluence_comments_select_comment_experience feature flag, 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);
             }
           }
           const {

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

@@ -217,7 +217,9 @@ export const resolveDraftBookmark = (editorState, bookmark, supportedBlockNodes
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
  */
-export function getSelectionPositions(editorState, inlineCommentState) {
+export function getSelectionPositions(editorState,
+// when cleaning up platform_editor_usesharedpluginstateselector, can change this prop to bookmark
+inlineCommentState) {
   const {
     bookmark
   } = inlineCommentState || {};

package/dist/es2019/types/index.js

@@ -22,4 +22,9 @@ export const AnnotationTestIds = {
   floatingToolbarCreateButton: `${prefix}-toolbar-create-button`,
   componentSave: `${prefix}-dummy-save-button`,
   componentClose: `${prefix}-dummy-close-button`
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

package/dist/es2019/ui/InlineCommentView.js

@@ -1,9 +1,11 @@
 import React from 'react';
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, CONTENT_COMPONENT, EVENT_TYPE, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../editor-commands';
 import { getAllAnnotations, getAnnotationViewKey, getPluginState, getSelectionPositions } from '../pm-plugins/utils';
 import { AnnotationTestIds } from '../types';
@@ -44,15 +46,40 @@ export function InlineCommentView({
     viewComponent: ViewComponent
   } = inlineCommentProvider;
   const inlineCommentState = getPluginState(state);
-  const {
-    bookmark,
-    selectedAnnotations,
-    annotations,
-    isInlineCommentViewClosed,
-    isOpeningMediaCommentFromToolbar
-  } = inlineCommentState || {};
+
+  // bookmark
+  const bookmarkSelector = useSharedPluginStateSelector(editorAPI, 'annotation.bookmark', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const bookmark = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? bookmarkSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.bookmark;
+
+  // selectedAnnotations
+  const selectedAnnotationsSelector = useSharedPluginStateSelector(editorAPI, 'annotation.selectedAnnotations', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const selectedAnnotations = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? selectedAnnotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectedAnnotations;
+
+  // annotations
+  const annotationsSelector = useSharedPluginStateSelector(editorAPI, 'annotation.annotations', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const annotations = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? annotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations;
+
+  // isInlineCommentViewClosed
+  const isInlineCommentViewClosedSelector = useSharedPluginStateSelector(editorAPI, 'annotation.isInlineCommentViewClosed', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const isInlineCommentViewClosed = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isInlineCommentViewClosedSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed;
+
+  // isOpeningMediaCommentFromToolbar
+  const isOpeningMediaCommentFromToolbarSelector = useSharedPluginStateSelector(editorAPI, 'annotation.isOpeningMediaCommentFromToolbar', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  const isOpeningMediaCommentFromToolbar = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isOpeningMediaCommentFromToolbarSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar;
   const annotationsList = getAllAnnotations(editorView.state.doc);
-  const selection = getSelectionPositions(state, inlineCommentState);
+  const selection = getSelectionPositions(state, editorExperiment('platform_editor_usesharedpluginstateselector', true) ? {
+    bookmark
+  } : inlineCommentState);
   const position = findPosForDOM(selection);
   let dom;
   try {
@@ -78,6 +105,11 @@ export function InlineCommentView({
       dispatchAnalyticsEvent(payload);
     }
   }
+
+  // selectAnnotationMethod
+  const selectAnnotationMethodSelector = useSharedPluginStateSelector(editorAPI, 'annotation.selectAnnotationMethod', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
   if (!dom) {
     return null;
   }
@@ -130,9 +162,6 @@ export function InlineCommentView({
     if (!dispatchAnalyticsEvent) {
       return;
     }
-    const {
-      selectAnnotationMethod
-    } = inlineCommentState || {};
 
     // fire analytics
     const payload = {
@@ -143,7 +172,7 @@ export function InlineCommentView({
       attributes: {
         overlap: activeAnnotations.length ? activeAnnotations.length - 1 : 0,
         targetNodeType: (_editorView$state$doc = editorView.state.doc.nodeAt(position)) === null || _editorView$state$doc === void 0 ? void 0 : _editorView$state$doc.type.name,
-        method: selectAnnotationMethod
+        method: editorExperiment('platform_editor_tables_table_selector', true) ? selectAnnotationMethodSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
       }
     };
     dispatchAnalyticsEvent(payload);

package/dist/esm/annotationPlugin.js

@@ -3,6 +3,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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 React from 'react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { setInlineCommentDraftState, showInlineCommentForBlockNode } from './editor-commands';
@@ -131,9 +132,20 @@ function AnnotationContentComponent(_ref4) {
     editorView = _ref4.editorView,
     annotationProviders = _ref4.annotationProviders,
     dispatchAnalyticsEvent = _ref4.dispatchAnalyticsEvent;
-  var _useSharedPluginState = useSharedPluginState(api, ['annotation']),
-    inlineCommentState = _useSharedPluginState.annotationState;
-  if (inlineCommentState && !inlineCommentState.isVisible) {
+  var _useSharedPluginState = useSharedPluginState(api, ['annotation'], {
+      disabled: editorExperiment('platform_editor_usesharedpluginstateselector', true)
+    }),
+    annotationState = _useSharedPluginState.annotationState;
+  var isVisibleSelector = useSharedPluginStateSelector(api, 'annotation.isVisible', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isVisible = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isVisibleSelector : annotationState === null || annotationState === void 0 ? void 0 : annotationState.isVisible;
+  if (annotationState && !isVisible && editorExperiment('platform_editor_usesharedpluginstateselector', false)) {
+    return null;
+  }
+
+  // need to expclicitly check for false as undefined is also a valid value to continue
+  if (isVisible === false && editorExperiment('platform_editor_usesharedpluginstateselector', true)) {
     return null;
   }
   return /*#__PURE__*/React.createElement("div", {

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

@@ -224,15 +224,21 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           if (fg('confluence_comments_select_comment_experience')) {
             var _prevSelectedAnnotati;
             var _ref4 = getPluginState(view.state) || {},
-              selectedAnnotations = _ref4.selectedAnnotations;
+              selectedAnnotations = _ref4.selectedAnnotations,
+              annotations = _ref4.annotations;
             var _ref5 = getPluginState(_prevState) || {},
               prevSelectedAnnotations = _ref5.selectedAnnotations;
-
-            // If the new state has a selected annotation, and it's different from the previous one
-            // then we mark the select annotation experience as complete
-            if (selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id !== (prevSelectedAnnotations === null || prevSelectedAnnotations === void 0 || (_prevSelectedAnnotati = prevSelectedAnnotations[0]) === null || _prevSelectedAnnotati === void 0 ? void 0 : _prevSelectedAnnotati.id)) {
+            var selectedAnnotationId = selectedAnnotations && selectedAnnotations.length !== 0 && selectedAnnotations[0].id ? selectedAnnotations[0].id : undefined;
+            // If the new state has an unresolved selected annotation, and it's different from
+            // the previous one then we mark the select annotation experience as complete.
+            if (
+            //This checks the selected annotation is different from the previous one
+            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;
-              (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotations[0].id);
+              // Under the confluence_comments_select_comment_experience feature flag, 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);
             }
           }
           var _ref6 = getPluginState(view.state) || {},

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

@@ -236,7 +236,9 @@ export var resolveDraftBookmark = function resolveDraftBookmark(editorState, boo
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
  */
-export function getSelectionPositions(editorState, inlineCommentState) {
+export function getSelectionPositions(editorState,
+// when cleaning up platform_editor_usesharedpluginstateselector, can change this prop to bookmark
+inlineCommentState) {
   var _ref2 = inlineCommentState || {},
     bookmark = _ref2.bookmark;
   // get positions via saved bookmark if it is available

package/dist/esm/types/index.js

@@ -22,4 +22,9 @@ export var AnnotationTestIds = {
   floatingToolbarCreateButton: "".concat(prefix, "-toolbar-create-button"),
   componentSave: "".concat(prefix, "-dummy-save-button"),
   componentClose: "".concat(prefix, "-dummy-close-button")
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

package/dist/esm/ui/InlineCommentView.js

@@ -2,9 +2,11 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import React from 'react';
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, CONTENT_COMPONENT, EVENT_TYPE, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { fg } from '@atlaskit/platform-feature-flags';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../editor-commands';
 import { getAllAnnotations, getAnnotationViewKey, getPluginState, getSelectionPositions } from '../pm-plugins/utils';
 import { AnnotationTestIds } from '../types';
@@ -38,14 +40,40 @@ export function InlineCommentView(_ref) {
   var CreateComponent = inlineCommentProvider.createComponent,
     ViewComponent = inlineCommentProvider.viewComponent;
   var inlineCommentState = getPluginState(state);
-  var _ref2 = inlineCommentState || {},
-    bookmark = _ref2.bookmark,
-    selectedAnnotations = _ref2.selectedAnnotations,
-    annotations = _ref2.annotations,
-    isInlineCommentViewClosed = _ref2.isInlineCommentViewClosed,
-    isOpeningMediaCommentFromToolbar = _ref2.isOpeningMediaCommentFromToolbar;
+
+  // bookmark
+  var bookmarkSelector = useSharedPluginStateSelector(editorAPI, 'annotation.bookmark', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var bookmark = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? bookmarkSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.bookmark;
+
+  // selectedAnnotations
+  var selectedAnnotationsSelector = useSharedPluginStateSelector(editorAPI, 'annotation.selectedAnnotations', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var selectedAnnotations = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? selectedAnnotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectedAnnotations;
+
+  // annotations
+  var annotationsSelector = useSharedPluginStateSelector(editorAPI, 'annotation.annotations', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var annotations = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? annotationsSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations;
+
+  // isInlineCommentViewClosed
+  var isInlineCommentViewClosedSelector = useSharedPluginStateSelector(editorAPI, 'annotation.isInlineCommentViewClosed', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isInlineCommentViewClosed = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isInlineCommentViewClosedSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed;
+
+  // isOpeningMediaCommentFromToolbar
+  var isOpeningMediaCommentFromToolbarSelector = useSharedPluginStateSelector(editorAPI, 'annotation.isOpeningMediaCommentFromToolbar', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
+  var isOpeningMediaCommentFromToolbar = editorExperiment('platform_editor_usesharedpluginstateselector', true) ? isOpeningMediaCommentFromToolbarSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar;
   var annotationsList = getAllAnnotations(editorView.state.doc);
-  var selection = getSelectionPositions(state, inlineCommentState);
+  var selection = getSelectionPositions(state, editorExperiment('platform_editor_usesharedpluginstateselector', true) ? {
+    bookmark: bookmark
+  } : inlineCommentState);
   var position = findPosForDOM(selection);
   var dom;
   try {
@@ -71,6 +99,11 @@ export function InlineCommentView(_ref) {
       dispatchAnalyticsEvent(payload);
     }
   }
+
+  // selectAnnotationMethod
+  var selectAnnotationMethodSelector = useSharedPluginStateSelector(editorAPI, 'annotation.selectAnnotationMethod', {
+    disabled: editorExperiment('platform_editor_usesharedpluginstateselector', false)
+  });
   if (!dom) {
     return null;
   }
@@ -125,8 +158,6 @@ export function InlineCommentView(_ref) {
     if (!dispatchAnalyticsEvent) {
       return;
     }
-    var _ref3 = inlineCommentState || {},
-      selectAnnotationMethod = _ref3.selectAnnotationMethod;
 
     // fire analytics
     var payload = {
@@ -137,7 +168,7 @@ export function InlineCommentView(_ref) {
       attributes: {
         overlap: activeAnnotations.length ? activeAnnotations.length - 1 : 0,
         targetNodeType: (_editorView$state$doc = editorView.state.doc.nodeAt(position)) === null || _editorView$state$doc === void 0 ? void 0 : _editorView$state$doc.type.name,
-        method: selectAnnotationMethod
+        method: editorExperiment('platform_editor_tables_table_selector', true) ? selectAnnotationMethodSelector : inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
       }
     };
     dispatchAnalyticsEvent(payload);

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { annotationPlugin } from './annotationPlugin';
 export type { AnnotationPlugin, AnnotationPluginOptions } from './annotationPluginType';
-export type { AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, TargetType, InlineCommentInputMethod, } from './types';
+export type { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCompoundExperience, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, SelectInlineCommentCompoundExperience, SelectInlineCommentCompoundExperienceEntryPoint, SimpleSelectInlineCommentCompoundExperience, StartAttributes, TargetType, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -82,12 +82,50 @@ export type InlineCommentAction = {
     };
 };
 export type InlineCommentPluginState = {
+    /**
+     * The resolved state of the annotations.
+     *
+     * The keys are the annotation ids, and the values are booleans indicating whether the annotation is resolved or not.
+     *
+     * The annotation is only considered unresolved if the value is false. An undefined value is treated as resolved.
+     * This is because the editor does not know yet the resolved state of the annotation, and so it is treated as resolved until
+     * the editor receives the resolved state from the server. (see dirtyAnnotations for more details)
+     *
+     * Example value
+     * ```
+     * {
+     *   // resolved comments
+     *   'annotation-id': true,
+     *   'annotation-id-3': undefined,
+     *   // unresolved comment
+     *   'annotation-id-2': false,
+     *  }
+     * ```
+     */
     annotations: InlineCommentMap;
+    /**
+     * A list of the annotations at the current selection.
+     *
+     * While this is a list, consumers only make use of the first element, and from the
+     * user perspective, there is only one annotation selected at a time.
+     */
     selectedAnnotations: AnnotationInfo[];
+    /**
+     * Indicates the document has annotations which it does not currently know the resolved state of.
+     * This can happen when the annotations are loaded via ncs, and the editor has not received the
+     * resolved state of the annotations yet (as the resolved state comes from a separate service).
+     */
     dirtyAnnotations?: boolean;
     mouseData: InlineCommentMouseData;
     draftDecorationSet?: DecorationSet;
     bookmark?: SelectionBookmark;
+    /**
+     * Warning: This is not the state of annotations which are currently being hovered over,
+     * but rather the annotations which have been given a selected like visual state from an
+     * editor api.
+     * The Comment consumer does this when browsing comments in the sidebar, where it sets
+     * a "hovered" state on the annotation, while the comment is hovered in the sidebar.
+     */
     hoveredAnnotations?: AnnotationInfo[];
     disallowOnWhitespace: boolean;
     isInlineCommentViewClosed: boolean;

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

@@ -25,7 +25,7 @@ export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?:
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
  */
-export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: InlineCommentPluginState | null | undefined): Selection;
+export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: Partial<InlineCommentPluginState> | null | undefined): Selection;
 export declare const inlineCommentPluginKey: PluginKey<InlineCommentPluginState>;
 export declare const getPluginState: (state: EditorState) => InlineCommentPluginState | undefined;
 /**

package/dist/types/types/index.d.ts

@@ -1,5 +1,6 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -104,28 +105,8 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: {
-        start: (_: {
-            attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
-                annotationId?: undefined;
-            } | {
-                pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
-                annotationId?: undefined;
-            };
-        }) => void;
-        initExperience: {
-            start: () => void;
-        };
-    };
-    selectCommentExperience?: {
-        selectAnnotation: {
-            complete: (annotationId: string) => void;
-        };
-    };
+    createCommentExperience?: InlineCommentCompoundExperience;
+    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -152,4 +133,135 @@ export type DraftBookmark = {
     head: number;
     isBlockNode?: boolean;
 };
+type ExperienceAttributes = {
+    [key: string]: string | number | boolean | string[] | number[];
+};
+type InlineCommentAttributes = {
+    pageClass: 'editor';
+    commentType: 'inline';
+    annotationId?: undefined;
+} | {
+    pageClass: 'editor';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId?: undefined;
+} | {
+    pageClass: 'renderer';
+    commentType: 'inline';
+    annotationId: string;
+} | {
+    pageClass: 'renderer';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId: string;
+};
+export type SelectInlineCommentCompoundExperienceEntryPoint = 'create-comment' | 'annotation-change' | 'comment-navigation' | 'keyboard-navigation' | 'sidebar' | 'unknown:RendererFocus' | 'unknown:InlineComment' | 'unknown:CommentsPanelList';
+export type StartAttributes = {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    annotationId: string;
+    entryPoint: Exclude<SelectInlineCommentCompoundExperienceEntryPoint, 'keyboard-navigation' | 'comment-navigation'>;
+    linkedCompoundTaskId?: string;
+} | {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    entryPoint: 'keyboard-navigation' | 'comment-navigation';
+    linkedCompoundTaskId?: string;
+};
+type ExperienceDebugFunction = (params: {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    error: Error;
+    extraAttributes?: ExperienceAttributes;
+}) => void;
+export type InlineCommentCompoundExperience = {
+    start: (params: {
+        attributes: InlineCommentAttributes;
+    }) => void;
+    debug: ExperienceDebugFunction;
+    addCommonAttributes: (commonAttributes: ExperienceAttributes) => void;
+    attachCommonAttributes: (experienceName: string) => void;
+    initExperience: {
+        start: () => void;
+        fail: (error: Error) => void;
+        softFail: (error: Error) => void;
+        abort: (params: {
+            abortReason: 'Draft annotation removed from document';
+        }) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+    };
+    draftToPublishExperience: {
+        start: () => void;
+        publishFailed: (error: Error) => void;
+        publishSucceeded: () => void;
+        abort: (params: {
+            abortReason: 'Create Comment UI dismissed' | 'Unable to apply annotation to document';
+        }) => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        dismissed: () => void;
+        softFail: (error: Error) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+    attachCommentExperience: {
+        start: () => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+};
+export type SelectInlineCommentCompoundExperience = {
+    _start: (startAttributes: StartAttributes) => void;
+    addCommonAttributes: (additionalCommonAttributes: {
+        [key: string]: string | number | boolean;
+    }) => void;
+    abort: (params: {
+        abortReason: 'test abort';
+    }) => void;
+    selectAnnotation: {
+        debug: ExperienceDebugFunction;
+        start: (startAttributes: StartAttributes) => void;
+        abort: (params: {
+            abortReason: 'Comment navigation when only one comment';
+        }) => void;
+        complete: (startAttributes: StartAttributes) => void;
+    };
+    showComment: {
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: {
+            [key: string]: string | number | boolean;
+        }) => void;
+        start: (startAttributes: StartAttributes & {
+            annotationId: string;
+        }) => void;
+        abort: (params: {
+            abortReason: 'Non inline comment being shown' | 'Comment sidebar dismissed';
+        }) => void;
+        fail: (error: Error, extraAttributes?: {
+            misalignedBy: number;
+        }) => void;
+        complete: () => void;
+    };
+};
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */
+export type SimpleSelectInlineCommentCompoundExperience = {
+    selectAnnotation: {
+        complete: (annotationId: string) => void;
+    };
+};
 export {};

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

@@ -1,4 +1,4 @@
 export { annotationPlugin } from './annotationPlugin';
 export type { AnnotationPlugin, AnnotationPluginOptions } from './annotationPluginType';
-export type { AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, TargetType, InlineCommentInputMethod, } from './types';
+export type { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCompoundExperience, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, SelectInlineCommentCompoundExperience, SelectInlineCommentCompoundExperienceEntryPoint, SimpleSelectInlineCommentCompoundExperience, StartAttributes, TargetType, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -82,12 +82,50 @@ export type InlineCommentAction = {
     };
 };
 export type InlineCommentPluginState = {
+    /**
+     * The resolved state of the annotations.
+     *
+     * The keys are the annotation ids, and the values are booleans indicating whether the annotation is resolved or not.
+     *
+     * The annotation is only considered unresolved if the value is false. An undefined value is treated as resolved.
+     * This is because the editor does not know yet the resolved state of the annotation, and so it is treated as resolved until
+     * the editor receives the resolved state from the server. (see dirtyAnnotations for more details)
+     *
+     * Example value
+     * ```
+     * {
+     *   // resolved comments
+     *   'annotation-id': true,
+     *   'annotation-id-3': undefined,
+     *   // unresolved comment
+     *   'annotation-id-2': false,
+     *  }
+     * ```
+     */
     annotations: InlineCommentMap;
+    /**
+     * A list of the annotations at the current selection.
+     *
+     * While this is a list, consumers only make use of the first element, and from the
+     * user perspective, there is only one annotation selected at a time.
+     */
     selectedAnnotations: AnnotationInfo[];
+    /**
+     * Indicates the document has annotations which it does not currently know the resolved state of.
+     * This can happen when the annotations are loaded via ncs, and the editor has not received the
+     * resolved state of the annotations yet (as the resolved state comes from a separate service).
+     */
     dirtyAnnotations?: boolean;
     mouseData: InlineCommentMouseData;
     draftDecorationSet?: DecorationSet;
     bookmark?: SelectionBookmark;
+    /**
+     * Warning: This is not the state of annotations which are currently being hovered over,
+     * but rather the annotations which have been given a selected like visual state from an
+     * editor api.
+     * The Comment consumer does this when browsing comments in the sidebar, where it sets
+     * a "hovered" state on the annotation, while the comment is hovered in the sidebar.
+     */
     hoveredAnnotations?: AnnotationInfo[];
     disallowOnWhitespace: boolean;
     isInlineCommentViewClosed: boolean;

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

@@ -25,7 +25,7 @@ export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?:
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
  */
-export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: InlineCommentPluginState | null | undefined): Selection;
+export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: Partial<InlineCommentPluginState> | null | undefined): Selection;
 export declare const inlineCommentPluginKey: PluginKey<InlineCommentPluginState>;
 export declare const getPluginState: (state: EditorState) => InlineCommentPluginState | undefined;
 /**

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

@@ -1,5 +1,6 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -104,28 +105,8 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: {
-        start: (_: {
-            attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
-                annotationId?: undefined;
-            } | {
-                pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
-                annotationId?: undefined;
-            };
-        }) => void;
-        initExperience: {
-            start: () => void;
-        };
-    };
-    selectCommentExperience?: {
-        selectAnnotation: {
-            complete: (annotationId: string) => void;
-        };
-    };
+    createCommentExperience?: InlineCommentCompoundExperience;
+    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -152,4 +133,135 @@ export type DraftBookmark = {
     head: number;
     isBlockNode?: boolean;
 };
+type ExperienceAttributes = {
+    [key: string]: string | number | boolean | string[] | number[];
+};
+type InlineCommentAttributes = {
+    pageClass: 'editor';
+    commentType: 'inline';
+    annotationId?: undefined;
+} | {
+    pageClass: 'editor';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId?: undefined;
+} | {
+    pageClass: 'renderer';
+    commentType: 'inline';
+    annotationId: string;
+} | {
+    pageClass: 'renderer';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId: string;
+};
+export type SelectInlineCommentCompoundExperienceEntryPoint = 'create-comment' | 'annotation-change' | 'comment-navigation' | 'keyboard-navigation' | 'sidebar' | 'unknown:RendererFocus' | 'unknown:InlineComment' | 'unknown:CommentsPanelList';
+export type StartAttributes = {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    annotationId: string;
+    entryPoint: Exclude<SelectInlineCommentCompoundExperienceEntryPoint, 'keyboard-navigation' | 'comment-navigation'>;
+    linkedCompoundTaskId?: string;
+} | {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    entryPoint: 'keyboard-navigation' | 'comment-navigation';
+    linkedCompoundTaskId?: string;
+};
+type ExperienceDebugFunction = (params: {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    error: Error;
+    extraAttributes?: ExperienceAttributes;
+}) => void;
+export type InlineCommentCompoundExperience = {
+    start: (params: {
+        attributes: InlineCommentAttributes;
+    }) => void;
+    debug: ExperienceDebugFunction;
+    addCommonAttributes: (commonAttributes: ExperienceAttributes) => void;
+    attachCommonAttributes: (experienceName: string) => void;
+    initExperience: {
+        start: () => void;
+        fail: (error: Error) => void;
+        softFail: (error: Error) => void;
+        abort: (params: {
+            abortReason: 'Draft annotation removed from document';
+        }) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+    };
+    draftToPublishExperience: {
+        start: () => void;
+        publishFailed: (error: Error) => void;
+        publishSucceeded: () => void;
+        abort: (params: {
+            abortReason: 'Create Comment UI dismissed' | 'Unable to apply annotation to document';
+        }) => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        dismissed: () => void;
+        softFail: (error: Error) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+    attachCommentExperience: {
+        start: () => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+};
+export type SelectInlineCommentCompoundExperience = {
+    _start: (startAttributes: StartAttributes) => void;
+    addCommonAttributes: (additionalCommonAttributes: {
+        [key: string]: string | number | boolean;
+    }) => void;
+    abort: (params: {
+        abortReason: 'test abort';
+    }) => void;
+    selectAnnotation: {
+        debug: ExperienceDebugFunction;
+        start: (startAttributes: StartAttributes) => void;
+        abort: (params: {
+            abortReason: 'Comment navigation when only one comment';
+        }) => void;
+        complete: (startAttributes: StartAttributes) => void;
+    };
+    showComment: {
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: {
+            [key: string]: string | number | boolean;
+        }) => void;
+        start: (startAttributes: StartAttributes & {
+            annotationId: string;
+        }) => void;
+        abort: (params: {
+            abortReason: 'Non inline comment being shown' | 'Comment sidebar dismissed';
+        }) => void;
+        fail: (error: Error, extraAttributes?: {
+            misalignedBy: number;
+        }) => void;
+        complete: () => void;
+    };
+};
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */
+export type SimpleSelectInlineCommentCompoundExperience = {
+    selectAnnotation: {
+        complete: (annotationId: string) => void;
+    };
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.7.1",
+	"version": "2.7.3",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,8 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^103.11.0",
+		"@atlaskit/analytics-next": "^11.0.0",
+		"@atlaskit/editor-common": "^103.21.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -41,7 +42,7 @@
 		"@atlaskit/icon": "^25.6.0",
 		"@atlaskit/onboarding": "^14.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.12.0",
+		"@atlaskit/tmp-editor-statsig": "^4.15.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -49,10 +50,10 @@
 		"react-dom": "^18.2.0"
 	},
 	"devDependencies": {
-		"@af/integration-testing": "^0.5.0",
-		"@af/visual-regression": "^1.3.0",
-		"@atlaskit/ssr": "^0.4.0",
-		"@atlaskit/visual-regression": "^0.10.0",
+		"@af/integration-testing": "workspace:^",
+		"@af/visual-regression": "workspace:^",
+		"@atlaskit/ssr": "workspace:^",
+		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"