@atlaskit/editor-plugin-annotation 2.9.3 → 2.9.5

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.9.5
+
+### Patch Changes
+
+- [#165439](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/165439)
+  [`1b15e228a1e86`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1b15e228a1e86) -
+  Fixed an issue which meant the new annotation manager still realied on a FG to be enabled when in
+  fact it should be enabled if an instance of the manager is supplied. Thie removed all dependencies
+  relying on the FG.
+
+## 2.9.4
+
+### Patch Changes
+
+- [#144021](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/144021)
+  [`8357b7ad2daa6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8357b7ad2daa6) -
+  Added config option for starting viewInlineCommentTraceUFOPress for inline-comments
+  annotationPlugin
+- Updated dependencies
+
 ## 2.9.3
 
 ### Patch Changes

package/dist/cjs/annotationPlugin.js

@@ -61,6 +61,7 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
               editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions,
               featureFlagsPluginState: featureFlags,
               selectCommentExperience: annotationProviders.selectCommentExperience,
+              viewInlineCommentTraceUFOPress: annotationProviders.viewInlineCommentTraceUFOPress,
               annotationManager: annotationProviders.annotationManager,
               api: api
             });

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

@@ -266,16 +266,23 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           var _ref5 = (0, _utils2.getPluginState)(_prevState) || {},
             prevSelectedAnnotations = _ref5.selectedAnnotations;
           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.
+          // the previous one then...
           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;
+            // ...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);
+            }
           }
           if (annotationManager) {
             // In the Editor, Annotations can be selected in three ways:

package/dist/cjs/types/index.js

@@ -26,9 +26,4 @@ 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

@@ -51,13 +51,15 @@ var useInlineCommentViewPluginState = (0, _hooks.sharedPluginStateHookMigratorFa
   var isOpeningMediaCommentFromToolbar = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(api, 'annotation.isOpeningMediaCommentFromToolbar');
   // eslint-disable-next-line react-hooks/rules-of-hooks
   var selectAnnotationMethod = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(api, 'annotation.selectAnnotationMethod');
+  var isAnnotationManagerEnabled = (0, _useSharedPluginStateSelector.useSharedPluginStateSelector)(api, 'annotation.isAnnotationManagerEnabled');
   return {
     bookmark: bookmark,
     selectedAnnotations: selectedAnnotations,
     annotations: annotations,
     isInlineCommentViewClosed: isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar: isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod: selectAnnotationMethod
+    selectAnnotationMethod: selectAnnotationMethod,
+    isAnnotationManagerEnabled: isAnnotationManagerEnabled
   };
 }, function (_ref2) {
   var state = _ref2.state;
@@ -68,7 +70,8 @@ var useInlineCommentViewPluginState = (0, _hooks.sharedPluginStateHookMigratorFa
     annotations: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations,
     isInlineCommentViewClosed: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
+    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod,
+    isAnnotationManagerEnabled: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isAnnotationManagerEnabled
   };
 });
 function InlineCommentView(_ref3) {
@@ -93,7 +96,8 @@ function InlineCommentView(_ref3) {
     isInlineCommentViewClosed = _useInlineCommentView.isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar = _useInlineCommentView.isOpeningMediaCommentFromToolbar,
     selectAnnotationMethod = _useInlineCommentView.selectAnnotationMethod,
-    selectedAnnotations = _useInlineCommentView.selectedAnnotations;
+    selectedAnnotations = _useInlineCommentView.selectedAnnotations,
+    isAnnotationManagerEnabled = _useInlineCommentView.isAnnotationManagerEnabled;
   var annotationsList = (0, _utils3.getAllAnnotations)(editorView.state.doc);
   var selection = (0, _utils3.getSelectionPositions)(state, {
     bookmark: bookmark
@@ -160,7 +164,7 @@ function InlineCommentView(_ref3) {
       textSelection: textSelection,
       wasNewAnnotationSelected: !!currentlySelectedAnnotation && isAnnotationSelectionChanged,
       onCreate: function onCreate(id) {
-        if (!(0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           var createAnnotationResult = (0, _editorCommands.createAnnotation)(editorAnalyticsAPI, editorAPI)(id, _adfSchema.AnnotationTypes.INLINE_COMMENT, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
           if (!createAnnotationResult && (0, _platformFeatureFlags.fg)('confluence_frontend_handle_annotation_error')) {
@@ -169,7 +173,7 @@ function InlineCommentView(_ref3) {
         }
       },
       onClose: function onClose() {
-        if (!(0, _platformFeatureFlags.fg)('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           (0, _editorCommands.setInlineCommentDraftState)(editorAnalyticsAPI)(false)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
         }

package/dist/es2019/annotationPlugin.js

@@ -52,6 +52,7 @@ export const annotationPlugin = ({
             editorAnalyticsAPI: api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions,
             featureFlagsPluginState: featureFlags,
             selectCommentExperience: annotationProviders.selectCommentExperience,
+            viewInlineCommentTraceUFOPress: annotationProviders.viewInlineCommentTraceUFOPress,
             annotationManager: annotationProviders.annotationManager,
             api
           });

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

@@ -201,16 +201,23 @@ export const inlineCommentPlugin = options => {
             selectedAnnotations: prevSelectedAnnotations
           } = getPluginState(_prevState) || {};
           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.
+          // the previous one then...
           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;
+            // ...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);
+            }
           }
           if (annotationManager) {
             // In the Editor, Annotations can be selected in three ways:

package/dist/es2019/types/index.js

@@ -22,9 +22,4 @@ 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

@@ -42,13 +42,15 @@ const useInlineCommentViewPluginState = sharedPluginStateHookMigratorFactory(({
   const isOpeningMediaCommentFromToolbar = useSharedPluginStateSelector(api, 'annotation.isOpeningMediaCommentFromToolbar');
   // eslint-disable-next-line react-hooks/rules-of-hooks
   const selectAnnotationMethod = useSharedPluginStateSelector(api, 'annotation.selectAnnotationMethod');
+  const isAnnotationManagerEnabled = useSharedPluginStateSelector(api, 'annotation.isAnnotationManagerEnabled');
   return {
     bookmark,
     selectedAnnotations,
     annotations,
     isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod
+    selectAnnotationMethod,
+    isAnnotationManagerEnabled
   };
 }, ({
   state
@@ -60,7 +62,8 @@ const useInlineCommentViewPluginState = sharedPluginStateHookMigratorFactory(({
     annotations: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations,
     isInlineCommentViewClosed: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
+    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod,
+    isAnnotationManagerEnabled: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isAnnotationManagerEnabled
   };
 });
 export function InlineCommentView({
@@ -89,7 +92,8 @@ export function InlineCommentView({
     isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar,
     selectAnnotationMethod,
-    selectedAnnotations
+    selectedAnnotations,
+    isAnnotationManagerEnabled
   } = useInlineCommentViewPluginState({
     api: editorAPI,
     state
@@ -160,7 +164,7 @@ export function InlineCommentView({
       textSelection: textSelection,
       wasNewAnnotationSelected: !!currentlySelectedAnnotation && isAnnotationSelectionChanged,
       onCreate: id => {
-        if (!fg('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           const createAnnotationResult = createAnnotation(editorAnalyticsAPI, editorAPI)(id, AnnotationTypes.INLINE_COMMENT, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
           if (!createAnnotationResult && fg('confluence_frontend_handle_annotation_error')) {
@@ -169,7 +173,7 @@ export function InlineCommentView({
         }
       },
       onClose: () => {
-        if (!fg('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           setInlineCommentDraftState(editorAnalyticsAPI)(false)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
         }

package/dist/esm/annotationPlugin.js

@@ -54,6 +54,7 @@ export var annotationPlugin = function annotationPlugin(_ref) {
               editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions,
               featureFlagsPluginState: featureFlags,
               selectCommentExperience: annotationProviders.selectCommentExperience,
+              viewInlineCommentTraceUFOPress: annotationProviders.viewInlineCommentTraceUFOPress,
               annotationManager: annotationProviders.annotationManager,
               api: api
             });

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

@@ -259,16 +259,23 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           var _ref5 = getPluginState(_prevState) || {},
             prevSelectedAnnotations = _ref5.selectedAnnotations;
           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.
+          // the previous one then...
           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;
+            // ...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);
+            }
           }
           if (annotationManager) {
             // In the Editor, Annotations can be selected in three ways:

package/dist/esm/types/index.js

@@ -22,9 +22,4 @@ 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

@@ -42,13 +42,15 @@ var useInlineCommentViewPluginState = sharedPluginStateHookMigratorFactory(funct
   var isOpeningMediaCommentFromToolbar = useSharedPluginStateSelector(api, 'annotation.isOpeningMediaCommentFromToolbar');
   // eslint-disable-next-line react-hooks/rules-of-hooks
   var selectAnnotationMethod = useSharedPluginStateSelector(api, 'annotation.selectAnnotationMethod');
+  var isAnnotationManagerEnabled = useSharedPluginStateSelector(api, 'annotation.isAnnotationManagerEnabled');
   return {
     bookmark: bookmark,
     selectedAnnotations: selectedAnnotations,
     annotations: annotations,
     isInlineCommentViewClosed: isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar: isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod: selectAnnotationMethod
+    selectAnnotationMethod: selectAnnotationMethod,
+    isAnnotationManagerEnabled: isAnnotationManagerEnabled
   };
 }, function (_ref2) {
   var state = _ref2.state;
@@ -59,7 +61,8 @@ var useInlineCommentViewPluginState = sharedPluginStateHookMigratorFactory(funct
     annotations: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.annotations,
     isInlineCommentViewClosed: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isOpeningMediaCommentFromToolbar,
-    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod
+    selectAnnotationMethod: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.selectAnnotationMethod,
+    isAnnotationManagerEnabled: inlineCommentState === null || inlineCommentState === void 0 ? void 0 : inlineCommentState.isAnnotationManagerEnabled
   };
 });
 export function InlineCommentView(_ref3) {
@@ -84,7 +87,8 @@ export function InlineCommentView(_ref3) {
     isInlineCommentViewClosed = _useInlineCommentView.isInlineCommentViewClosed,
     isOpeningMediaCommentFromToolbar = _useInlineCommentView.isOpeningMediaCommentFromToolbar,
     selectAnnotationMethod = _useInlineCommentView.selectAnnotationMethod,
-    selectedAnnotations = _useInlineCommentView.selectedAnnotations;
+    selectedAnnotations = _useInlineCommentView.selectedAnnotations,
+    isAnnotationManagerEnabled = _useInlineCommentView.isAnnotationManagerEnabled;
   var annotationsList = getAllAnnotations(editorView.state.doc);
   var selection = getSelectionPositions(state, {
     bookmark: bookmark
@@ -151,7 +155,7 @@ export function InlineCommentView(_ref3) {
       textSelection: textSelection,
       wasNewAnnotationSelected: !!currentlySelectedAnnotation && isAnnotationSelectionChanged,
       onCreate: function onCreate(id) {
-        if (!fg('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           var createAnnotationResult = createAnnotation(editorAnalyticsAPI, editorAPI)(id, AnnotationTypes.INLINE_COMMENT, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
           if (!createAnnotationResult && fg('confluence_frontend_handle_annotation_error')) {
@@ -160,7 +164,7 @@ export function InlineCommentView(_ref3) {
         }
       },
       onClose: function onClose() {
-        if (!fg('platform_editor_comments_api_manager')) {
+        if (!isAnnotationManagerEnabled) {
           setInlineCommentDraftState(editorAnalyticsAPI)(false)(editorView.state, editorView.dispatch);
           !editorView.hasFocus() && editorView.focus();
         }

package/dist/types/index.d.ts

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

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

@@ -25,6 +25,7 @@ export interface InlineCommentPluginOptions {
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     featureFlagsPluginState?: FeatureFlags;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    viewInlineCommentTraceUFOPress?: AnnotationProviders['viewInlineCommentTraceUFOPress'];
     annotationManager?: AnnotationManager;
     api?: AnnotationPluginInjectionAPI;
 }

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

@@ -1,6 +1,5 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
-import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -111,8 +110,29 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: InlineCommentCompoundExperience;
-    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
+    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;
+        };
+    };
+    viewInlineCommentTraceUFOPress?: () => void;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -139,137 +159,4 @@ 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'>;
-} | {
-    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';
-};
-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;
-        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
-    };
-    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 SelectAbortReasons = 'test abort' | 'Comment being resolved';
-export type SelectParentAbortReasons = 'Parent experience aborting with reason: test abort' | 'Parent experience aborting with reason: Comment being resolved';
-export type SelectInlineCommentCompoundExperience = {
-    _start: (startAttributes: StartAttributes) => void;
-    addCommonAttributes: (additionalCommonAttributes: {
-        [key: string]: boolean | null | number | string | undefined | Array<number | string>;
-    }) => void;
-    abort: (params: {
-        abortReason: SelectAbortReasons;
-        abortSubexperiences?: boolean;
-    }) => void;
-    selectAnnotation: {
-        debug: ExperienceDebugFunction;
-        start: (startAttributes: StartAttributes) => void;
-        abort: (params: {
-            abortReason: 'Comment navigation when only one comment' | 'Navigating to general comment' | SelectParentAbortReasons;
-        }) => 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' | 'InlineComment component unmounted' | SelectParentAbortReasons;
-        }) => 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 { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCompoundExperience, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, SelectAbortReasons, SelectParentAbortReasons, SelectInlineCommentCompoundExperience, SelectInlineCommentCompoundExperienceEntryPoint, SimpleSelectInlineCommentCompoundExperience, StartAttributes, TargetType, } from './types';
+export type { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, TargetType, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -25,6 +25,7 @@ export interface InlineCommentPluginOptions {
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     featureFlagsPluginState?: FeatureFlags;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    viewInlineCommentTraceUFOPress?: AnnotationProviders['viewInlineCommentTraceUFOPress'];
     annotationManager?: AnnotationManager;
     api?: AnnotationPluginInjectionAPI;
 }

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

@@ -1,6 +1,5 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
-import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -111,8 +110,29 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: InlineCommentCompoundExperience;
-    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
+    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;
+        };
+    };
+    viewInlineCommentTraceUFOPress?: () => void;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -139,137 +159,4 @@ 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'>;
-} | {
-    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';
-};
-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;
-        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
-    };
-    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 SelectAbortReasons = 'test abort' | 'Comment being resolved';
-export type SelectParentAbortReasons = 'Parent experience aborting with reason: test abort' | 'Parent experience aborting with reason: Comment being resolved';
-export type SelectInlineCommentCompoundExperience = {
-    _start: (startAttributes: StartAttributes) => void;
-    addCommonAttributes: (additionalCommonAttributes: {
-        [key: string]: boolean | null | number | string | undefined | Array<number | string>;
-    }) => void;
-    abort: (params: {
-        abortReason: SelectAbortReasons;
-        abortSubexperiences?: boolean;
-    }) => void;
-    selectAnnotation: {
-        debug: ExperienceDebugFunction;
-        start: (startAttributes: StartAttributes) => void;
-        abort: (params: {
-            abortReason: 'Comment navigation when only one comment' | 'Navigating to general comment' | SelectParentAbortReasons;
-        }) => 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' | 'InlineComment component unmounted' | SelectParentAbortReasons;
-        }) => 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.9.3",
+	"version": "2.9.5",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/analytics-next": "^11.0.0",
+		"@atlaskit/analytics-next": "^11.1.0",
 		"@atlaskit/editor-common": "^106.1.0",
 		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
@@ -42,7 +42,7 @@
 		"@atlaskit/icon": "^26.4.0",
 		"@atlaskit/onboarding": "^14.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^5.7.0",
+		"@atlaskit/tmp-editor-statsig": "^5.10.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -95,7 +95,8 @@
 	},
 	"platform-feature-flags": {
 		"platform_editor_comments_api_manager": {
-			"type": "boolean"
+			"type": "boolean",
+			"referenceOnly": true
 		},
 		"editor_inline_comments_on_inline_nodes": {
 			"type": "boolean"
@@ -115,6 +116,9 @@
 		"platform_editor_listen_for_focussed_query_param": {
 			"type": "boolean"
 		},
+		"cc_comments_track_view_inline_comment_action": {
+			"type": "boolean"
+		},
 		"confluence_frontend_handle_annotation_error": {
 			"type": "boolean"
 		},