@atlaskit/editor-plugin-annotation 2.9.2 → 2.9.4

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

@@ -86,6 +86,7 @@ var fetchState = /*#__PURE__*/function () {
 var initialState = function initialState() {
   var disallowOnWhitespace = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var featureFlagsPluginState = arguments.length > 1 ? arguments[1] : undefined;
+  var isAnnotationManagerEnabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   return {
     annotations: {},
     selectedAnnotations: [],
@@ -100,7 +101,8 @@ var initialState = function initialState() {
     featureFlagsPluginState: featureFlagsPluginState,
     isDrafting: false,
     pendingSelectedAnnotations: [],
-    pendingSelectedAnnotationsUpdateCount: 0
+    pendingSelectedAnnotationsUpdateCount: 0,
+    isAnnotationManagerEnabled: isAnnotationManagerEnabled
   };
 };
 var hideToolbar = function hideToolbar(state, dispatch) {
@@ -157,7 +159,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
     annotationManager = options.annotationManager;
   return new SafePlugin({
     key: inlineCommentPluginKey,
-    state: createPluginState(options.dispatch, initialState(provider.disallowOnWhitespace, featureFlagsPluginState)),
+    state: createPluginState(options.dispatch, initialState(provider.disallowOnWhitespace, featureFlagsPluginState, !!annotationManager)),
     view: function view(editorView) {
       var allowAnnotationFn;
       var startDraftFn;
@@ -167,25 +169,23 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
       var setIsAnnotationSelectedFn;
       var setIsAnnotationHoveredFn;
       var clearAnnotationFn;
-      if (annotationManager && fg('platform_editor_comments_api_manager')) {
+      if (annotationManager) {
         allowAnnotationFn = allowAnnotation(editorView, options);
         startDraftFn = startDraft(editorView, options);
         clearDraftFn = clearDraft(editorView, options);
         applyDraftFn = applyDraft(editorView, options);
         getDraftFn = getDraft(editorView, options);
+        setIsAnnotationSelectedFn = setIsAnnotationSelected(editorView, options);
+        setIsAnnotationHoveredFn = setIsAnnotationHovered(editorView, options);
+        clearAnnotationFn = clearAnnotation(editorView, options);
         annotationManager.hook('allowAnnotation', allowAnnotationFn);
         annotationManager.hook('startDraft', startDraftFn);
         annotationManager.hook('clearDraft', clearDraftFn);
         annotationManager.hook('applyDraft', applyDraftFn);
         annotationManager.hook('getDraft', getDraftFn);
-        if (fg('platform_editor_comments_api_manager_select')) {
-          setIsAnnotationSelectedFn = setIsAnnotationSelected(editorView, options);
-          setIsAnnotationHoveredFn = setIsAnnotationHovered(editorView, options);
-          clearAnnotationFn = clearAnnotation(editorView, options);
-          annotationManager.hook('setIsAnnotationSelected', setIsAnnotationSelectedFn);
-          annotationManager.hook('setIsAnnotationHovered', setIsAnnotationHoveredFn);
-          annotationManager.hook('clearAnnotation', clearAnnotationFn);
-        }
+        annotationManager.hook('setIsAnnotationSelected', setIsAnnotationSelectedFn);
+        annotationManager.hook('setIsAnnotationHovered', setIsAnnotationHoveredFn);
+        annotationManager.hook('clearAnnotation', clearAnnotationFn);
       }
       // Get initial state
       // Need to pass `editorView` to mitigate editor state going stale
@@ -259,18 +259,25 @@ 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 (fg('platform_editor_comments_api_manager_select')) {
+          if (annotationManager) {
             // In the Editor, Annotations can be selected in three ways:
             // 1. By clicking on the annotation in the editor
             // 2. By using the annotation manager to select the annotation
@@ -288,7 +295,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
               // Need to set a lock to avoid calling gate multiple times. The lock will be released
               // when the preemptive gate is complete.
               isPreemptiveGateActive = true;
-              annotationManager === null || annotationManager === void 0 || annotationManager.checkPreemptiveGate().then(function (canSelectAnnotation) {
+              annotationManager.checkPreemptiveGate().then(function (canSelectAnnotation) {
                 var _ref8 = getPluginState(view.state) || {},
                   isDrafting = _ref8.isDrafting,
                   latestPendingSelectedAnnotations = _ref8.pendingSelectedAnnotations,
@@ -307,8 +314,8 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
                       return pendingAnnotation.id === annotation.id;
                     })) === -1;
                   }).forEach(function (annotation) {
-                    var _options$annotationMa, _getAnnotationInlineN;
-                    (_options$annotationMa = options.annotationManager) === null || _options$annotationMa === void 0 || _options$annotationMa.emit({
+                    var _getAnnotationInlineN;
+                    annotationManager.emit({
                       name: 'annotationSelectionChanged',
                       data: {
                         annotationId: annotation.id,
@@ -320,9 +327,9 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
 
                   // Notify the annotation manager that the pending selection has changed.
                   latestPendingSelectedAnnotations === null || latestPendingSelectedAnnotations === void 0 || latestPendingSelectedAnnotations.forEach(function (_ref9) {
-                    var _options$annotationMa2, _getAnnotationInlineN2;
+                    var _getAnnotationInlineN2;
                     var id = _ref9.id;
-                    (_options$annotationMa2 = options.annotationManager) === null || _options$annotationMa2 === void 0 || _options$annotationMa2.emit({
+                    annotationManager.emit({
                       name: 'annotationSelectionChanged',
                       data: {
                         annotationId: id,
@@ -345,8 +352,8 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
               });
             }
           }
-          var _ref10 = getPluginState(view.state) || {},
-            dirtyAnnotations = _ref10.dirtyAnnotations;
+          var _ref0 = getPluginState(view.state) || {},
+            dirtyAnnotations = _ref0.dirtyAnnotations;
           if (!dirtyAnnotations) {
             return;
           }
@@ -359,7 +366,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           if (updateSubscriber) {
             updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility).off('setselectedannotation', setSelectedAnnotationFn).off('sethoveredannotation', setHoveredAnnotationFn).off('removehoveredannotation', removeHoveredannotationFn).off('closeinlinecomment', closeInlineCommentFn);
           }
-          if (annotationManager && fg('platform_editor_comments_api_manager')) {
+          if (annotationManager) {
             annotationManager.unhook('allowAnnotation', allowAnnotationFn);
             annotationManager.unhook('startDraft', startDraftFn);
             annotationManager.unhook('clearDraft', clearDraftFn);
@@ -409,13 +416,13 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           if (isSelected && !(pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed)) {
             return false;
           }
-          var _ref11 = pluginState || {},
-            annotations = _ref11.annotations;
+          var _ref1 = pluginState || {},
+            annotations = _ref1.annotations;
           var isUnresolved = annotations && annotations[annotationId] === false;
           if (!isUnresolved) {
             return false;
           }
-          if (fg('platform_editor_comments_api_manager_select')) {
+          if (annotationManager) {
             var _pluginState$pendingS;
             // The manager disable setting the selected annotation on click because in the editor this is already
             // handled by the selection update handler. When the manager is enabled, and a selection changes it's pushed into
@@ -438,13 +445,13 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
       },
       decorations: function decorations(state) {
         // highlight comments, depending on state
-        var _ref12 = getPluginState(state) || {},
-          draftDecorationSet = _ref12.draftDecorationSet,
-          annotations = _ref12.annotations,
-          selectedAnnotations = _ref12.selectedAnnotations,
-          isVisible = _ref12.isVisible,
-          isInlineCommentViewClosed = _ref12.isInlineCommentViewClosed,
-          hoveredAnnotations = _ref12.hoveredAnnotations;
+        var _ref10 = getPluginState(state) || {},
+          draftDecorationSet = _ref10.draftDecorationSet,
+          annotations = _ref10.annotations,
+          selectedAnnotations = _ref10.selectedAnnotations,
+          isVisible = _ref10.isVisible,
+          isInlineCommentViewClosed = _ref10.isInlineCommentViewClosed,
+          hoveredAnnotations = _ref10.hoveredAnnotations;
         var decorations = draftDecorationSet !== null && draftDecorationSet !== void 0 ? draftDecorationSet : DecorationSet.empty;
         var focusDecorations = [];
 

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

@@ -4,7 +4,6 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { pluginFactory } from '@atlaskit/editor-common/utils';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { fg } from '@atlaskit/platform-feature-flags';
 import reducer from './reducer';
 import { decorationKey, findAnnotationsInSelection, inlineCommentPluginKey, isBlockNodeAnnotationsSelected, isSelectedAnnotationsChanged } from './utils';
 var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
@@ -104,7 +103,6 @@ var getSelectionChangeHandlerNew = function getSelectionChangeHandlerNew(reopenC
 
     // NOTE: I've left this commented code here as a reference that the previous old code would reset the selected annotations
     // if the selection is empty. If this is no longer needed, we can remove this code.
-    // clean up with platform_editor_comments_api_manager_select
     // if (selectedAnnotations.length === 0) {
     // 	return {
     // 		...pluginState,
@@ -133,7 +131,11 @@ var getSelectionChangeHandlerNew = function getSelectionChangeHandlerNew(reopenC
 };
 var getSelectionChangedHandler = function getSelectionChangedHandler(reopenCommentView) {
   return function (tr, pluginState) {
-    return fg('platform_editor_comments_api_manager_select') ? getSelectionChangeHandlerNew(reopenCommentView)(tr, pluginState) : getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
+    return pluginState.isAnnotationManagerEnabled ?
+    // if platform_editor_comments_api_manager == true
+    getSelectionChangeHandlerNew(reopenCommentView)(tr, pluginState) :
+    // else if platform_editor_comments_api_manager == false
+    getSelectionChangeHandlerOld(reopenCommentView)(tr, pluginState);
   };
 };
 var _pluginFactory = pluginFactory(inlineCommentPluginKey, reducer, {

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

@@ -31,7 +31,7 @@ export default (function (pluginState, action) {
         isOpeningMediaCommentFromToolbar: false
       }, fg('platform_editor_annotation_selected_annotation') && {
         selectedAnnotations: []
-      }), fg('platform_editor_comments_api_manager_select') && {
+      }), pluginState.isAnnotationManagerEnabled && {
         selectedAnnotations: []
       });
     case ACTIONS.ADD_INLINE_COMMENT:
@@ -41,7 +41,7 @@ export default (function (pluginState, action) {
         annotations: _objectSpread(_objectSpread({}, pluginState.annotations), action.data.inlineComments),
         isInlineCommentViewClosed: false,
         selectAnnotationMethod: undefined
-      }, fg('platform_editor_comments_api_manager_select') && {
+      }, pluginState.isAnnotationManagerEnabled && {
         skipSelectionHandling: true
       });
     case ACTIONS.INLINE_COMMENT_SET_VISIBLE:

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

@@ -126,7 +126,7 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
             pageMode: 'edit'
           }
         });
-        if (annotationManager && fg('platform_editor_comments_api_manager')) {
+        if (annotationManager) {
           annotationManager.checkPreemptiveGate().then(function (canStartDraft) {
             if (canStartDraft) {
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({

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/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;
 }
@@ -162,4 +163,8 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
 };

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;
 }
@@ -162,4 +163,8 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
 };

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 {};