@atlaskit/editor-plugin-annotation 2.8.2 → 2.9.0

package/dist/esm/ui/InlineCommentView.js

@@ -1,5 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import React from 'react';
+import React, { useRef } from 'react';
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, CONTENT_COMPONENT, EVENT_TYPE, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import { sharedPluginStateHookMigratorFactory } from '@atlaskit/editor-common/hooks';
@@ -72,6 +72,7 @@ export function InlineCommentView(_ref3) {
   var inlineCommentProvider = providers.inlineComment;
   var state = editorView.state,
     dispatch = editorView.dispatch;
+  var lastSelectedAnnotationId = useRef();
   var CreateComponent = inlineCommentProvider.createComponent,
     ViewComponent = inlineCommentProvider.viewComponent;
   var _useInlineCommentView = useInlineCommentViewPluginState({
@@ -124,9 +125,17 @@ export function InlineCommentView(_ref3) {
 
   // Create Component
   if (bookmark) {
+    var _selectedAnnotations$;
     if (!CreateComponent) {
       return null;
     }
+    var currentlySelectedAnnotation = selectedAnnotations === null || selectedAnnotations === void 0 || (_selectedAnnotations$ = selectedAnnotations[0]) === null || _selectedAnnotations$ === void 0 ? void 0 : _selectedAnnotations$.id;
+    var isAnnotationSelectionChanged = currentlySelectedAnnotation !== lastSelectedAnnotationId.current;
+
+    // Update the last selected annotation ID if the selection was updated
+    if (isAnnotationSelectionChanged) {
+      lastSelectedAnnotationId.current = currentlySelectedAnnotation;
+    }
     var inlineNodeTypes = getRangeInlineNodeNames({
       doc: state.doc,
       pos: selection
@@ -140,6 +149,7 @@ export function InlineCommentView(_ref3) {
     }, /*#__PURE__*/React.createElement(CreateComponent, {
       dom: dom,
       textSelection: textSelection,
+      wasNewAnnotationSelected: !!currentlySelectedAnnotation && isAnnotationSelectionChanged,
       onCreate: function onCreate(id) {
         if (!fg('platform_editor_comments_api_manager')) {
           var createAnnotationResult = createAnnotation(editorAnalyticsAPI, editorAPI)(id, AnnotationTypes.INLINE_COMMENT, inlineCommentProvider.supportedBlockNodes)(editorView.state, editorView.dispatch);

package/dist/types/editor-commands/index.d.ts

@@ -9,10 +9,15 @@ import type { InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
+export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.
+ * @param supportedBlockNodes
+ * @example
  */
 export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null, viewMethod?: VIEW_METHOD, isOpeningMediaCommentFromToolbar?: boolean) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[]) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;

package/dist/types/pm-plugins/annotation-manager-hooks.d.ts

@@ -1,5 +1,5 @@
 import { type AnnotationId } from '@atlaskit/adf-schema';
-import type { ApplyDraftResult, ClearDraftResult, GetDraftResult, StartDraftResult } from '@atlaskit/editor-common/annotation';
+import type { ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from '@atlaskit/editor-common/annotation';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginOptions } from './types';
 export declare const allowAnnotation: (editorView: EditorView, options: InlineCommentPluginOptions) => () => boolean;
@@ -7,3 +7,6 @@ export declare const startDraft: (editorView: EditorView, options: InlineComment
 export declare const clearDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => ClearDraftResult;
 export declare const applyDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId) => ApplyDraftResult;
 export declare const getDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => GetDraftResult;
+export declare const setIsAnnotationSelected: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
+export declare const setIsAnnotationHovered: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
+export declare const clearAnnotation: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId) => ClearAnnotationResult;

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

@@ -4,6 +4,10 @@ import type { InlineCommentPluginState } from './types';
  * We clear bookmark on the following conditions:
  * 1. if current selection is an empty selection, or
  * 2. if the current selection and bookmark selection are different
+ * @param tr
+ * @param editorState
+ * @param bookmark
+ * @example
  */
 export declare const shouldClearBookMarkCheck: (tr: ReadonlyTransaction | Transaction, editorState: EditorState, bookmark?: SelectionBookmark) => boolean;
 export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: InlineCommentPluginState | ((state: EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<EditorState>) => false | A), transform?: ((tr: Transaction, state: EditorState) => Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

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

@@ -15,7 +15,9 @@ export declare enum ACTIONS {
     INLINE_COMMENT_SET_VISIBLE = 5,
     CLOSE_COMPONENT = 6,
     SET_SELECTED_ANNOTATION = 7,
-    SET_HOVERED_ANNOTATION = 8
+    SET_HOVERED_ANNOTATION = 8,
+    FLUSH_PENDING_SELECTIONS = 9,
+    SET_PENDING_SELECTIONS = 10
 }
 export interface InlineCommentPluginOptions {
     dispatch: Dispatch;
@@ -80,6 +82,16 @@ export type InlineCommentAction = {
         hoveredAnnotations: AnnotationInfo[];
         selectAnnotationMethod?: VIEW_METHOD;
     };
+} | {
+    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
+    data: {
+        canSetAsSelectedAnnotations: boolean;
+    };
+} | {
+    type: ACTIONS.SET_PENDING_SELECTIONS;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
 };
 export type InlineCommentPluginState = {
     /**
@@ -137,4 +149,17 @@ export type InlineCommentPluginState = {
     selectAnnotationMethod?: VIEW_METHOD;
     isOpeningMediaCommentFromToolbar?: boolean;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    /**
+     * 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.
+     * This functionality has come about due to the fact that the editor can select annotations in 3 different ways. And the fact
+     * that we need to introduce a preemptive gate check which is async and can block annotations from being selected before they're
+     * selected.
+     */
+    pendingSelectedAnnotations: AnnotationInfo[];
+    /**
+     * This is a count of the number of times the pendingSelectedAnnotations has been updated. This can be used to determine
+     * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
+     */
+    pendingSelectedAnnotationsUpdateCount: number;
 };

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

@@ -45,6 +45,7 @@ export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    wasNewAnnotationSelected?: boolean;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**

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

@@ -9,10 +9,15 @@ import type { InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
+export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.
+ * @param supportedBlockNodes
+ * @example
  */
 export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null, viewMethod?: VIEW_METHOD, isOpeningMediaCommentFromToolbar?: boolean) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[]) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;

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

@@ -1,5 +1,5 @@
 import { type AnnotationId } from '@atlaskit/adf-schema';
-import type { ApplyDraftResult, ClearDraftResult, GetDraftResult, StartDraftResult } from '@atlaskit/editor-common/annotation';
+import type { ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from '@atlaskit/editor-common/annotation';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginOptions } from './types';
 export declare const allowAnnotation: (editorView: EditorView, options: InlineCommentPluginOptions) => () => boolean;
@@ -7,3 +7,6 @@ export declare const startDraft: (editorView: EditorView, options: InlineComment
 export declare const clearDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => ClearDraftResult;
 export declare const applyDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId) => ApplyDraftResult;
 export declare const getDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => GetDraftResult;
+export declare const setIsAnnotationSelected: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
+export declare const setIsAnnotationHovered: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
+export declare const clearAnnotation: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId) => ClearAnnotationResult;

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

@@ -4,6 +4,10 @@ import type { InlineCommentPluginState } from './types';
  * We clear bookmark on the following conditions:
  * 1. if current selection is an empty selection, or
  * 2. if the current selection and bookmark selection are different
+ * @param tr
+ * @param editorState
+ * @param bookmark
+ * @example
  */
 export declare const shouldClearBookMarkCheck: (tr: ReadonlyTransaction | Transaction, editorState: EditorState, bookmark?: SelectionBookmark) => boolean;
 export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: InlineCommentPluginState | ((state: EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<EditorState>) => false | A), transform?: ((tr: Transaction, state: EditorState) => Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

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

@@ -15,7 +15,9 @@ export declare enum ACTIONS {
     INLINE_COMMENT_SET_VISIBLE = 5,
     CLOSE_COMPONENT = 6,
     SET_SELECTED_ANNOTATION = 7,
-    SET_HOVERED_ANNOTATION = 8
+    SET_HOVERED_ANNOTATION = 8,
+    FLUSH_PENDING_SELECTIONS = 9,
+    SET_PENDING_SELECTIONS = 10
 }
 export interface InlineCommentPluginOptions {
     dispatch: Dispatch;
@@ -80,6 +82,16 @@ export type InlineCommentAction = {
         hoveredAnnotations: AnnotationInfo[];
         selectAnnotationMethod?: VIEW_METHOD;
     };
+} | {
+    type: ACTIONS.FLUSH_PENDING_SELECTIONS;
+    data: {
+        canSetAsSelectedAnnotations: boolean;
+    };
+} | {
+    type: ACTIONS.SET_PENDING_SELECTIONS;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
 };
 export type InlineCommentPluginState = {
     /**
@@ -137,4 +149,17 @@ export type InlineCommentPluginState = {
     selectAnnotationMethod?: VIEW_METHOD;
     isOpeningMediaCommentFromToolbar?: boolean;
     selectCommentExperience?: AnnotationProviders['selectCommentExperience'];
+    /**
+     * 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.
+     * This functionality has come about due to the fact that the editor can select annotations in 3 different ways. And the fact
+     * that we need to introduce a preemptive gate check which is async and can block annotations from being selected before they're
+     * selected.
+     */
+    pendingSelectedAnnotations: AnnotationInfo[];
+    /**
+     * This is a count of the number of times the pendingSelectedAnnotations has been updated. This can be used to determine
+     * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
+     */
+    pendingSelectedAnnotationsUpdateCount: number;
 };

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

@@ -45,6 +45,7 @@ export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
      * Indicates whether we're opening the media comment box from the media toolbar so we can scroll the media into view
      */
     isOpeningMediaCommentFromToolbar?: boolean;
+    wasNewAnnotationSelected?: boolean;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.8.2",
+	"version": "2.9.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,16 +33,16 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlaskit/analytics-next": "^11.0.0",
-		"@atlaskit/editor-common": "^105.8.0",
+		"@atlaskit/editor-common": "^105.11.0",
 		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.4.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/icon": "^26.1.0",
+		"@atlaskit/icon": "^26.3.0",
 		"@atlaskit/onboarding": "^14.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.24.0",
+		"@atlaskit/tmp-editor-statsig": "^5.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -97,6 +97,9 @@
 		"platform_editor_comments_api_manager": {
 			"type": "boolean"
 		},
+		"platform_editor_comments_api_manager_select": {
+			"type": "boolean"
+		},
 		"editor_inline_comments_on_inline_nodes": {
 			"type": "boolean"
 		},