@atlaskit/editor-plugin-annotation 3.3.9 → 3.3.10

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-annotation
 
+## 3.3.10
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 3.3.9
 
 ### Patch Changes

package/dist/types/annotationPluginType.d.ts

@@ -24,11 +24,8 @@ export type AnnotationPluginDependencies = [
 ];
 export type AnnotationPluginOptions = AnnotationProviders;
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
-    pluginConfiguration: AnnotationPluginOptions | undefined;
-    sharedState: InlineCommentPluginState | undefined;
-    dependencies: AnnotationPluginDependencies;
     actions: {
-        stripNonExistingAnnotations: StripNonExistingAnnotations;
+        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         setInlineCommentDraftState: SetInlineCommentDraftState;
         /**
          * This function attempts to display the inline comment popup for a given node.
@@ -36,8 +33,11 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
-        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
+        stripNonExistingAnnotations: StripNonExistingAnnotations;
     };
+    dependencies: AnnotationPluginDependencies;
+    pluginConfiguration: AnnotationPluginOptions | undefined;
+    sharedState: InlineCommentPluginState | undefined;
 }>;
 export type AnnotationPluginInjectionAPI = ExtractInjectionAPI<AnnotationPlugin> | undefined;
 export {};

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

@@ -8,21 +8,21 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import { type AnnotationProviders } from '../types';
 interface BuildToolbarOptions {
-    state: EditorState;
-    intl: IntlShape;
-    isToolbarAbove?: boolean;
-    isCommentOnMediaOn?: boolean;
     _supportedNodes?: string[];
+    annotationManager?: AnnotationProviders['annotationManager'];
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    contentType?: string;
     createCommentExperience?: AnnotationProviders['createCommentExperience'];
-    annotationManager?: AnnotationProviders['annotationManager'];
-    onCommentButtonMount?: () => void;
     getCanAddComments?: () => boolean;
-    contentType?: string;
+    intl: IntlShape;
+    isCommentOnMediaOn?: boolean;
+    isToolbarAbove?: boolean;
+    onCommentButtonMount?: () => void;
+    state: EditorState;
 }
 type ShouldSuppressFloatingToolbarOptions = {
-    state: EditorState;
     bookmark?: SelectionBookmark;
+    state: EditorState;
 };
 /**
  * Should suppress toolbars when the user is creating an inline comment
@@ -42,9 +42,9 @@ export declare const buildSuppressedToolbar: (state: EditorState) => {
     __suppressAllToolbars: boolean;
 };
 export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, createCommentExperience, annotationManager, onCommentButtonMount, getCanAddComments, contentType, }: BuildToolbarOptions) => {
-    title: string;
-    nodeType: NodeType[];
     items: FloatingToolbarButton<Command>[];
+    nodeType: NodeType[];
     onPositionCalculated: (editorView: EditorView, nextPos: PopupPosition) => PopupPosition;
+    title: string;
 } | undefined;
 export {};

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

@@ -20,14 +20,14 @@ export declare enum ACTIONS {
     SET_PENDING_SELECTIONS = 10
 }
 export interface InlineCommentPluginOptions {
+    annotationManager?: AnnotationManager;
+    api?: AnnotationPluginInjectionAPI;
     dispatch: Dispatch;
-    provider: InlineCommentAnnotationProvider;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     featureFlagsPluginState?: FeatureFlags;
+    provider: InlineCommentAnnotationProvider;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
     viewInlineCommentTraceUFOPress?: AnnotationProviders['viewInlineCommentTraceUFOPress'];
-    annotationManager?: AnnotationManager;
-    api?: AnnotationPluginInjectionAPI;
 }
 export interface InlineCommentMouseData {
     isSelecting: boolean;
@@ -36,63 +36,63 @@ export type InlineCommentMap = {
     [key: string]: boolean;
 };
 export type InlineCommentAction = {
-    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
     data: InlineCommentMap;
+    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
 } | {
-    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
     data: {
         drafting: boolean;
         editorState: EditorState;
-        targetType?: TargetType;
+        isOpeningMediaCommentFromToolbar?: boolean;
         supportedBlockNodes?: string[];
         targetNodeId?: string;
-        isOpeningMediaCommentFromToolbar?: boolean;
+        targetType?: TargetType;
     };
+    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
 } | {
-    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
     data: {
         mouseData: InlineCommentMouseData;
     };
+    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
 } | {
     type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK;
 } | {
     type: ACTIONS.CLOSE_COMPONENT;
 } | {
-    type: ACTIONS.ADD_INLINE_COMMENT;
     data: {
         drafting: boolean;
-        inlineComments: InlineCommentMap;
         editorState: EditorState;
+        inlineComments: InlineCommentMap;
         selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.ADD_INLINE_COMMENT;
 } | {
-    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
     data: {
         isVisible: boolean;
     };
+    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
 } | {
-    type: ACTIONS.SET_SELECTED_ANNOTATION;
     data: {
-        selectedAnnotations: AnnotationInfo[];
-        selectAnnotationMethod?: VIEW_METHOD;
         isOpeningMediaCommentFromToolbar?: boolean;
+        selectAnnotationMethod?: VIEW_METHOD;
+        selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
 } | {
-    type: ACTIONS.SET_HOVERED_ANNOTATION;
     data: {
         hoveredAnnotations: AnnotationInfo[];
         selectAnnotationMethod?: VIEW_METHOD;
     };
+    type: ACTIONS.SET_HOVERED_ANNOTATION;
 } | {
-    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
     data: {
         canSetAsSelectedAnnotations: boolean;
     };
+    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
 } | {
-    type: ACTIONS.SET_PENDING_SELECTIONS;
     data: {
         selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.SET_PENDING_SELECTIONS;
 };
 export type InlineCommentPluginState = {
     /**
@@ -116,22 +116,16 @@ export type InlineCommentPluginState = {
      * ```
      */
     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[];
+    bookmark?: SelectionBookmark;
     /**
      * 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;
+    disallowOnWhitespace: boolean;
     draftDecorationSet?: DecorationSet;
-    bookmark?: SelectionBookmark;
+    featureFlagsPluginState?: FeatureFlags;
     /**
      * 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
@@ -140,16 +134,15 @@ export type InlineCommentPluginState = {
      * a "hovered" state on the annotation, while the comment is hovered in the sidebar.
      */
     hoveredAnnotations?: AnnotationInfo[];
-    disallowOnWhitespace: boolean;
-    isInlineCommentViewClosed: boolean;
-    isVisible: boolean;
-    skipSelectionHandling: boolean;
-    featureFlagsPluginState?: FeatureFlags;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
     isDrafting: boolean;
-    targetNodeId?: string;
-    selectAnnotationMethod?: VIEW_METHOD;
+    isInlineCommentViewClosed: boolean;
     isOpeningMediaCommentFromToolbar?: boolean;
-    selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    isVisible: boolean;
+    mouseData: InlineCommentMouseData;
     /**
      * This is a list of annotations which are to be selected. This is updated all the time when the selection changes, and
      * are periodically flushed to selectedAnnotations. This flush event results in the annotations being selected in the editor.
@@ -163,8 +156,15 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    selectAnnotationMethod?: VIEW_METHOD;
+    selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
     /**
-     * A simple toggle to indicate if the annotation manager is enabled.
+     * 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.
      */
-    isAnnotationManagerEnabled: boolean;
+    selectedAnnotations: AnnotationInfo[];
+    skipSelectionHandling: boolean;
+    targetNodeId?: string;
 };

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

@@ -16,34 +16,34 @@ export type AnnotationInfo = {
     type: AnnotationTypes.INLINE_COMMENT;
 };
 type AnnotationComponentProps = {
-    /**
-     * Selected text (can be used when creating a comment)
-     */
-    textSelection?: string;
     /**
      * DOM element around selected text (for positioning)
      */
     dom?: HTMLElement;
+    /**
+     * Indicates whether the comment UI is offline and should be disabled
+     */
+    isOffline?: boolean;
     /**
      * Indicates that a draft comment was discarded/cancelled
      */
     onClose?: () => void;
     /**
-     * Indicates whether the comment UI is offline and should be disabled
+     * Selected text (can be used when creating a comment)
      */
-    isOffline?: boolean;
+    textSelection?: string;
 };
 export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
-    /**
-     * Creates an annotation mark in the document with the given id.
-     */
-    onCreate: (id: string) => void;
     /** List of inline node types, which are wrapped by the annotation. */
     inlineNodeTypes: string[] | undefined;
     /**
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    /**
+     * Creates an annotation mark in the document with the given id.
+     */
+    onCreate: (id: string) => void;
     wasNewAnnotationSelected?: boolean;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
@@ -52,14 +52,6 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * These are provided in order, inner-most first.
      */
     annotations: Array<AnnotationInfo>;
-    /**
-     * Resolves an annotation with the given ID around the selection.
-     */
-    onResolve: (id: string) => void;
-    /**
-     * Removes the annotation from the document
-     */
-    onDelete?: (id: string) => void;
     /**
      * Ordered list of annotation ids as shown in the document
      */
@@ -78,6 +70,14 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    /**
+     * Removes the annotation from the document
+     */
+    onDelete?: (id: string) => void;
+    /**
+     * Resolves an annotation with the given ID around the selection.
+     */
+    onResolve: (id: string) => void;
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;
@@ -85,17 +85,19 @@ export interface AnnotationState<Type, State> {
     state: State;
 }
 export interface AnnotationTypeProvider<Type, State> {
+    disallowOnWhitespace?: boolean;
     getState: (annotationIds: string[]) => Promise<AnnotationState<Type, State>[]>;
     updateSubscriber?: AnnotationUpdateEmitter;
-    disallowOnWhitespace?: boolean;
 }
 export type InlineCommentState = {
     resolved: boolean;
 };
 export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationTypes.INLINE_COMMENT, InlineCommentState> & {
+    contentType?: string;
     createComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentCreateComponentProps>>;
-    viewComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentViewComponentProps>>;
+    getCanAddComments?: () => boolean;
     isToolbarAbove?: boolean;
+    onCommentButtonMount?: () => void;
     /**
      * @experimental Still under development. Do not use.
      *
@@ -106,38 +108,36 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
      * Note 2: text is supported by default.
      */
     supportedBlockNodes?: string[];
-    onCommentButtonMount?: () => void;
-    getCanAddComments?: () => boolean;
-    contentType?: string;
+    viewComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentViewComponentProps>>;
 };
 export interface AnnotationProviders {
-    inlineComment: InlineCommentAnnotationProvider;
+    annotationManager?: AnnotationManager;
     createCommentExperience?: {
+        initExperience: {
+            start: () => void;
+        };
         start: (_: {
             attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
                 annotationId?: undefined;
+                commentType: 'inline';
                 entryPoint?: 'highlightActions';
-            } | {
                 pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
+            } | {
                 annotationId?: undefined;
+                blockType: 'media';
+                commentType: 'block';
                 entryPoint?: 'highlightActions';
+                pageClass: 'editor';
             };
         }) => void;
-        initExperience: {
-            start: () => void;
-        };
     };
+    inlineComment: InlineCommentAnnotationProvider;
     selectCommentExperience?: {
         selectAnnotation: {
             complete: (annotationId: string) => void;
         };
     };
     viewInlineCommentTraceUFOPress?: () => void;
-    annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
     INVALID = "invalid",// Annotation should not be created, toolbar should not be shown
@@ -152,15 +152,15 @@ export declare const AnnotationTestIds: {
     componentClose: string;
 };
 export type CoordsAtPos = {
-    top: number;
     bottom: number;
     left: number;
     right: number;
+    top: number;
 };
 export type DraftBookmark = {
     from: number;
-    to: number;
     head: number;
     isBlockNode?: boolean;
+    to: number;
 };
 export {};

package/dist/types/ui/AnnotationViewWrapper.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 type AnnotationViewWrapperProps = {
+    annotationText?: string;
     children: React.ReactNode;
     onViewed?: () => void;
-    annotationText?: string;
 };
 export declare class AnnotationViewWrapper extends React.PureComponent<AnnotationViewWrapperProps> {
     componentDidMount(): void;

package/dist/types/ui/CommentButton/CommentButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AnnotationPlugin } from '../../annotationPluginType';
 import { type AnnotationProviders } from '../../types';
 type CommentButtonProps = {
-    api?: ExtractInjectionAPI<AnnotationPlugin>;
     annotationProviders?: AnnotationProviders;
+    api?: ExtractInjectionAPI<AnnotationPlugin>;
 };
 export declare const CommentButton: ({ api, annotationProviders }: CommentButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types/ui/CommentButton/hooks.d.ts

@@ -4,9 +4,9 @@ import type { AnnotationPlugin } from '../../annotationPluginType';
 import type { AnnotationSelectionType } from '../../types';
 import { type AnnotationProviders } from '../../types';
 export declare const useCommentButtonMount: ({ state, annotationProviders, api, annotationSelectionType, bookmark, }: {
-    state: EditorState | null;
     annotationProviders?: AnnotationProviders;
-    api?: ExtractInjectionAPI<AnnotationPlugin>;
     annotationSelectionType: AnnotationSelectionType;
+    api?: ExtractInjectionAPI<AnnotationPlugin>;
     bookmark?: SelectionBookmark;
+    state: EditorState | null;
 }) => void;

package/dist/types/ui/CommentButton/utils.d.ts

@@ -4,25 +4,25 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../../annotationPluginType';
 import { AnnotationSelectionType, type AnnotationProviders } from '../../types';
 export declare const isButtonDisabled: ({ state, api, }: {
-    state: EditorState | null;
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    state: EditorState | null;
 }) => boolean;
 export declare const shouldShowCommentButton: ({ state, isVisible, annotationSelectionType, }: {
-    state: EditorState | null;
-    isVisible?: boolean;
     annotationSelectionType: AnnotationSelectionType;
+    isVisible?: boolean;
+    state: EditorState | null;
 }) => boolean;
 export declare const fireOnClickAnalyticsEvent: ({ api, }: {
     api: ExtractInjectionAPI<AnnotationPlugin>;
 }) => void;
 export declare const fireCommentButtonViewedAnalyticsEvent: ({ api, isNonTextInlineNodeInludedInComment, annotationSelectionType, }: {
+    annotationSelectionType: AnnotationSelectionType;
     api?: ExtractInjectionAPI<AnnotationPlugin>;
     isNonTextInlineNodeInludedInComment: boolean;
-    annotationSelectionType: AnnotationSelectionType;
 }) => void;
 export declare const startCommentExperience: ({ annotationProviders, api, state, dispatch, }: {
     annotationProviders: AnnotationProviders;
     api: ExtractInjectionAPI<AnnotationPlugin>;
-    state: EditorState;
     dispatch: EditorView["dispatch"];
+    state: EditorState;
 }) => boolean;

package/dist/types/ui/InlineCommentView.d.ts

@@ -5,11 +5,11 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import { type AnnotationProviders } from '../types';
 interface InlineCommentViewProps {
-    providers: AnnotationProviders;
-    editorView: EditorView;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AnnotationPlugin> | undefined;
-    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    editorView: EditorView;
+    providers: AnnotationProviders;
 }
 export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, editorAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): React.JSX.Element | null;
 export {};

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

@@ -24,11 +24,8 @@ export type AnnotationPluginDependencies = [
 ];
 export type AnnotationPluginOptions = AnnotationProviders;
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
-    pluginConfiguration: AnnotationPluginOptions | undefined;
-    sharedState: InlineCommentPluginState | undefined;
-    dependencies: AnnotationPluginDependencies;
     actions: {
-        stripNonExistingAnnotations: StripNonExistingAnnotations;
+        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         setInlineCommentDraftState: SetInlineCommentDraftState;
         /**
          * This function attempts to display the inline comment popup for a given node.
@@ -36,8 +33,11 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
-        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
+        stripNonExistingAnnotations: StripNonExistingAnnotations;
     };
+    dependencies: AnnotationPluginDependencies;
+    pluginConfiguration: AnnotationPluginOptions | undefined;
+    sharedState: InlineCommentPluginState | undefined;
 }>;
 export type AnnotationPluginInjectionAPI = ExtractInjectionAPI<AnnotationPlugin> | undefined;
 export {};

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

@@ -8,21 +8,21 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import { type AnnotationProviders } from '../types';
 interface BuildToolbarOptions {
-    state: EditorState;
-    intl: IntlShape;
-    isToolbarAbove?: boolean;
-    isCommentOnMediaOn?: boolean;
     _supportedNodes?: string[];
+    annotationManager?: AnnotationProviders['annotationManager'];
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    contentType?: string;
     createCommentExperience?: AnnotationProviders['createCommentExperience'];
-    annotationManager?: AnnotationProviders['annotationManager'];
-    onCommentButtonMount?: () => void;
     getCanAddComments?: () => boolean;
-    contentType?: string;
+    intl: IntlShape;
+    isCommentOnMediaOn?: boolean;
+    isToolbarAbove?: boolean;
+    onCommentButtonMount?: () => void;
+    state: EditorState;
 }
 type ShouldSuppressFloatingToolbarOptions = {
-    state: EditorState;
     bookmark?: SelectionBookmark;
+    state: EditorState;
 };
 /**
  * Should suppress toolbars when the user is creating an inline comment
@@ -42,9 +42,9 @@ export declare const buildSuppressedToolbar: (state: EditorState) => {
     __suppressAllToolbars: boolean;
 };
 export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, createCommentExperience, annotationManager, onCommentButtonMount, getCanAddComments, contentType, }: BuildToolbarOptions) => {
-    title: string;
-    nodeType: NodeType[];
     items: FloatingToolbarButton<Command>[];
+    nodeType: NodeType[];
     onPositionCalculated: (editorView: EditorView, nextPos: PopupPosition) => PopupPosition;
+    title: string;
 } | undefined;
 export {};

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

@@ -20,14 +20,14 @@ export declare enum ACTIONS {
     SET_PENDING_SELECTIONS = 10
 }
 export interface InlineCommentPluginOptions {
+    annotationManager?: AnnotationManager;
+    api?: AnnotationPluginInjectionAPI;
     dispatch: Dispatch;
-    provider: InlineCommentAnnotationProvider;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     featureFlagsPluginState?: FeatureFlags;
+    provider: InlineCommentAnnotationProvider;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
     viewInlineCommentTraceUFOPress?: AnnotationProviders['viewInlineCommentTraceUFOPress'];
-    annotationManager?: AnnotationManager;
-    api?: AnnotationPluginInjectionAPI;
 }
 export interface InlineCommentMouseData {
     isSelecting: boolean;
@@ -36,63 +36,63 @@ export type InlineCommentMap = {
     [key: string]: boolean;
 };
 export type InlineCommentAction = {
-    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
     data: InlineCommentMap;
+    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
 } | {
-    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
     data: {
         drafting: boolean;
         editorState: EditorState;
-        targetType?: TargetType;
+        isOpeningMediaCommentFromToolbar?: boolean;
         supportedBlockNodes?: string[];
         targetNodeId?: string;
-        isOpeningMediaCommentFromToolbar?: boolean;
+        targetType?: TargetType;
     };
+    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
 } | {
-    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
     data: {
         mouseData: InlineCommentMouseData;
     };
+    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
 } | {
     type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK;
 } | {
     type: ACTIONS.CLOSE_COMPONENT;
 } | {
-    type: ACTIONS.ADD_INLINE_COMMENT;
     data: {
         drafting: boolean;
-        inlineComments: InlineCommentMap;
         editorState: EditorState;
+        inlineComments: InlineCommentMap;
         selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.ADD_INLINE_COMMENT;
 } | {
-    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
     data: {
         isVisible: boolean;
     };
+    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
 } | {
-    type: ACTIONS.SET_SELECTED_ANNOTATION;
     data: {
-        selectedAnnotations: AnnotationInfo[];
-        selectAnnotationMethod?: VIEW_METHOD;
         isOpeningMediaCommentFromToolbar?: boolean;
+        selectAnnotationMethod?: VIEW_METHOD;
+        selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
 } | {
-    type: ACTIONS.SET_HOVERED_ANNOTATION;
     data: {
         hoveredAnnotations: AnnotationInfo[];
         selectAnnotationMethod?: VIEW_METHOD;
     };
+    type: ACTIONS.SET_HOVERED_ANNOTATION;
 } | {
-    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
     data: {
         canSetAsSelectedAnnotations: boolean;
     };
+    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
 } | {
-    type: ACTIONS.SET_PENDING_SELECTIONS;
     data: {
         selectedAnnotations: AnnotationInfo[];
     };
+    type: ACTIONS.SET_PENDING_SELECTIONS;
 };
 export type InlineCommentPluginState = {
     /**
@@ -116,22 +116,16 @@ export type InlineCommentPluginState = {
      * ```
      */
     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[];
+    bookmark?: SelectionBookmark;
     /**
      * 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;
+    disallowOnWhitespace: boolean;
     draftDecorationSet?: DecorationSet;
-    bookmark?: SelectionBookmark;
+    featureFlagsPluginState?: FeatureFlags;
     /**
      * 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
@@ -140,16 +134,15 @@ export type InlineCommentPluginState = {
      * a "hovered" state on the annotation, while the comment is hovered in the sidebar.
      */
     hoveredAnnotations?: AnnotationInfo[];
-    disallowOnWhitespace: boolean;
-    isInlineCommentViewClosed: boolean;
-    isVisible: boolean;
-    skipSelectionHandling: boolean;
-    featureFlagsPluginState?: FeatureFlags;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
     isDrafting: boolean;
-    targetNodeId?: string;
-    selectAnnotationMethod?: VIEW_METHOD;
+    isInlineCommentViewClosed: boolean;
     isOpeningMediaCommentFromToolbar?: boolean;
-    selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    isVisible: boolean;
+    mouseData: InlineCommentMouseData;
     /**
      * This is a list of annotations which are to be selected. This is updated all the time when the selection changes, and
      * are periodically flushed to selectedAnnotations. This flush event results in the annotations being selected in the editor.
@@ -163,8 +156,15 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    selectAnnotationMethod?: VIEW_METHOD;
+    selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
     /**
-     * A simple toggle to indicate if the annotation manager is enabled.
+     * 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.
      */
-    isAnnotationManagerEnabled: boolean;
+    selectedAnnotations: AnnotationInfo[];
+    skipSelectionHandling: boolean;
+    targetNodeId?: string;
 };

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

@@ -16,34 +16,34 @@ export type AnnotationInfo = {
     type: AnnotationTypes.INLINE_COMMENT;
 };
 type AnnotationComponentProps = {
-    /**
-     * Selected text (can be used when creating a comment)
-     */
-    textSelection?: string;
     /**
      * DOM element around selected text (for positioning)
      */
     dom?: HTMLElement;
+    /**
+     * Indicates whether the comment UI is offline and should be disabled
+     */
+    isOffline?: boolean;
     /**
      * Indicates that a draft comment was discarded/cancelled
      */
     onClose?: () => void;
     /**
-     * Indicates whether the comment UI is offline and should be disabled
+     * Selected text (can be used when creating a comment)
      */
-    isOffline?: boolean;
+    textSelection?: string;
 };
 export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
-    /**
-     * Creates an annotation mark in the document with the given id.
-     */
-    onCreate: (id: string) => void;
     /** List of inline node types, which are wrapped by the annotation. */
     inlineNodeTypes: string[] | undefined;
     /**
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    /**
+     * Creates an annotation mark in the document with the given id.
+     */
+    onCreate: (id: string) => void;
     wasNewAnnotationSelected?: boolean;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
@@ -52,14 +52,6 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * These are provided in order, inner-most first.
      */
     annotations: Array<AnnotationInfo>;
-    /**
-     * Resolves an annotation with the given ID around the selection.
-     */
-    onResolve: (id: string) => void;
-    /**
-     * Removes the annotation from the document
-     */
-    onDelete?: (id: string) => void;
     /**
      * Ordered list of annotation ids as shown in the document
      */
@@ -78,6 +70,14 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    /**
+     * Removes the annotation from the document
+     */
+    onDelete?: (id: string) => void;
+    /**
+     * Resolves an annotation with the given ID around the selection.
+     */
+    onResolve: (id: string) => void;
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;
@@ -85,17 +85,19 @@ export interface AnnotationState<Type, State> {
     state: State;
 }
 export interface AnnotationTypeProvider<Type, State> {
+    disallowOnWhitespace?: boolean;
     getState: (annotationIds: string[]) => Promise<AnnotationState<Type, State>[]>;
     updateSubscriber?: AnnotationUpdateEmitter;
-    disallowOnWhitespace?: boolean;
 }
 export type InlineCommentState = {
     resolved: boolean;
 };
 export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationTypes.INLINE_COMMENT, InlineCommentState> & {
+    contentType?: string;
     createComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentCreateComponentProps>>;
-    viewComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentViewComponentProps>>;
+    getCanAddComments?: () => boolean;
     isToolbarAbove?: boolean;
+    onCommentButtonMount?: () => void;
     /**
      * @experimental Still under development. Do not use.
      *
@@ -106,38 +108,36 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
      * Note 2: text is supported by default.
      */
     supportedBlockNodes?: string[];
-    onCommentButtonMount?: () => void;
-    getCanAddComments?: () => boolean;
-    contentType?: string;
+    viewComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentViewComponentProps>>;
 };
 export interface AnnotationProviders {
-    inlineComment: InlineCommentAnnotationProvider;
+    annotationManager?: AnnotationManager;
     createCommentExperience?: {
+        initExperience: {
+            start: () => void;
+        };
         start: (_: {
             attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
                 annotationId?: undefined;
+                commentType: 'inline';
                 entryPoint?: 'highlightActions';
-            } | {
                 pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
+            } | {
                 annotationId?: undefined;
+                blockType: 'media';
+                commentType: 'block';
                 entryPoint?: 'highlightActions';
+                pageClass: 'editor';
             };
         }) => void;
-        initExperience: {
-            start: () => void;
-        };
     };
+    inlineComment: InlineCommentAnnotationProvider;
     selectCommentExperience?: {
         selectAnnotation: {
             complete: (annotationId: string) => void;
         };
     };
     viewInlineCommentTraceUFOPress?: () => void;
-    annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
     INVALID = "invalid",// Annotation should not be created, toolbar should not be shown
@@ -152,15 +152,15 @@ export declare const AnnotationTestIds: {
     componentClose: string;
 };
 export type CoordsAtPos = {
-    top: number;
     bottom: number;
     left: number;
     right: number;
+    top: number;
 };
 export type DraftBookmark = {
     from: number;
-    to: number;
     head: number;
     isBlockNode?: boolean;
+    to: number;
 };
 export {};

package/dist/types-ts4.5/ui/AnnotationViewWrapper.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 type AnnotationViewWrapperProps = {
+    annotationText?: string;
     children: React.ReactNode;
     onViewed?: () => void;
-    annotationText?: string;
 };
 export declare class AnnotationViewWrapper extends React.PureComponent<AnnotationViewWrapperProps> {
     componentDidMount(): void;

package/dist/types-ts4.5/ui/CommentButton/CommentButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AnnotationPlugin } from '../../annotationPluginType';
 import { type AnnotationProviders } from '../../types';
 type CommentButtonProps = {
-    api?: ExtractInjectionAPI<AnnotationPlugin>;
     annotationProviders?: AnnotationProviders;
+    api?: ExtractInjectionAPI<AnnotationPlugin>;
 };
 export declare const CommentButton: ({ api, annotationProviders }: CommentButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types-ts4.5/ui/CommentButton/hooks.d.ts

@@ -4,9 +4,9 @@ import type { AnnotationPlugin } from '../../annotationPluginType';
 import type { AnnotationSelectionType } from '../../types';
 import { type AnnotationProviders } from '../../types';
 export declare const useCommentButtonMount: ({ state, annotationProviders, api, annotationSelectionType, bookmark, }: {
-    state: EditorState | null;
     annotationProviders?: AnnotationProviders;
-    api?: ExtractInjectionAPI<AnnotationPlugin>;
     annotationSelectionType: AnnotationSelectionType;
+    api?: ExtractInjectionAPI<AnnotationPlugin>;
     bookmark?: SelectionBookmark;
+    state: EditorState | null;
 }) => void;

package/dist/types-ts4.5/ui/CommentButton/utils.d.ts

@@ -4,25 +4,25 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../../annotationPluginType';
 import { AnnotationSelectionType, type AnnotationProviders } from '../../types';
 export declare const isButtonDisabled: ({ state, api, }: {
-    state: EditorState | null;
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    state: EditorState | null;
 }) => boolean;
 export declare const shouldShowCommentButton: ({ state, isVisible, annotationSelectionType, }: {
-    state: EditorState | null;
-    isVisible?: boolean;
     annotationSelectionType: AnnotationSelectionType;
+    isVisible?: boolean;
+    state: EditorState | null;
 }) => boolean;
 export declare const fireOnClickAnalyticsEvent: ({ api, }: {
     api: ExtractInjectionAPI<AnnotationPlugin>;
 }) => void;
 export declare const fireCommentButtonViewedAnalyticsEvent: ({ api, isNonTextInlineNodeInludedInComment, annotationSelectionType, }: {
+    annotationSelectionType: AnnotationSelectionType;
     api?: ExtractInjectionAPI<AnnotationPlugin>;
     isNonTextInlineNodeInludedInComment: boolean;
-    annotationSelectionType: AnnotationSelectionType;
 }) => void;
 export declare const startCommentExperience: ({ annotationProviders, api, state, dispatch, }: {
     annotationProviders: AnnotationProviders;
     api: ExtractInjectionAPI<AnnotationPlugin>;
-    state: EditorState;
     dispatch: EditorView["dispatch"];
+    state: EditorState;
 }) => boolean;

package/dist/types-ts4.5/ui/InlineCommentView.d.ts

@@ -5,11 +5,11 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import { type AnnotationProviders } from '../types';
 interface InlineCommentViewProps {
-    providers: AnnotationProviders;
-    editorView: EditorView;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AnnotationPlugin> | undefined;
-    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    editorView: EditorView;
+    providers: AnnotationProviders;
 }
 export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, editorAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): React.JSX.Element | null;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "3.3.9",
+	"version": "3.3.10",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -56,7 +56,6 @@
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"wait-for-expect": "^1.2.0"
 	},