@atlaskit/editor-plugin-annotation 2.1.7 → 2.1.9

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.1.9
+
+### Patch Changes
+
+- [#131690](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/131690)
+  [`4ef6e6cdd0cec`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4ef6e6cdd0cec) -
+  Fix deleting inline comment view component if it is moved
+
+## 2.1.8
+
+### Patch Changes
+
+- [#129644](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/129644)
+  [`f3daef1b37b2f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f3daef1b37b2f) -
+  Fix setting the annotation selection after adding a comment if it is no longer in the annotation.
+- Updated dependencies
+
 ## 2.1.7
 
 ### Patch Changes

package/dist/cjs/annotationPlugin.js

@@ -86,7 +86,8 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
             state: state,
             intl: intl,
             isToolbarAbove: isToolbarAbove,
-            api: api
+            api: api,
+            createCommentExperience: annotationProviders.createCommentExperience
           });
           if (!toolbarConfig) {
             return undefined;

package/dist/cjs/editor-commands/transform.js

@@ -9,8 +9,12 @@ var _analytics = require("@atlaskit/editor-common/analytics");
 var _mark = require("@atlaskit/editor-common/mark");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _utils2 = require("../pm-plugins/utils");
+var isAnnotationStep = function isAnnotationStep(step) {
+  return step instanceof _transform.AddMarkStep && step.mark.type.name === 'annotation';
+};
 var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
   return function (transaction, state) {
     var inlineCommentState = (0, _utils2.getPluginState)(state);
@@ -33,8 +37,16 @@ var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
     } else {
       // Apply the mark only to text node in the range.
       var _tr = (0, _mark.applyMarkOnRange)(from, to, false, annotationMark, transaction);
-      // set selection back to the end of annotation once annotation mark is applied
-      _tr.setSelection(_state.TextSelection.create(_tr.doc, head));
+
+      // The mark may not be applied to the current "head" of the bookmark so determine what was applied
+      // above and use that instead
+      if ((0, _platformFeatureFlags.fg)('platform_editor_fix_missing_selected_annotations')) {
+        var annotationMarkStep = _tr.steps.reverse().find(isAnnotationStep);
+        var headBasedOnMark = from === head ? annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.from : annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.to;
+        _tr.setSelection(_state.TextSelection.create(_tr.doc, headBasedOnMark !== null && headBasedOnMark !== void 0 ? headBasedOnMark : head));
+      } else {
+        _tr.setSelection(_state.TextSelection.create(_tr.doc, head));
+      }
     }
     return tr;
   };

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

@@ -26,7 +26,8 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
       isToolbarAbove = _ref$isToolbarAbove === void 0 ? false : _ref$isToolbarAbove,
       _ref$_supportedNodes = _ref._supportedNodes,
       _supportedNodes = _ref$_supportedNodes === void 0 ? [] : _ref$_supportedNodes,
-      api = _ref.api;
+      api = _ref.api,
+      createCommentExperience = _ref.createCommentExperience;
     var schema = state.schema;
     var selectionValid = (0, _utils2.isSelectionValid)(state);
     var isMediaSelected = (0, _mediaSingle.currentMediaNodeWithPos)(state);
@@ -88,6 +89,15 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
             }
           });
         }
+        if ((0, _platformFeatureFlags.fg)('confluence_comments_create_comment_experience')) {
+          createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
+            attributes: {
+              pageClass: 'editor',
+              commentType: 'inline'
+            }
+          });
+          createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
+        }
         return (0, _editorCommands.setInlineCommentDraftState)(editorAnalyticsAPI)(true)(state, dispatch);
       },
       supportsViewMode: true // TODO: MODES-3950 - Clean up this floating toolbar view mode logic,

package/dist/cjs/ui/InlineCommentView.js

@@ -162,7 +162,7 @@ function InlineCommentView(_ref) {
     getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
     onDelete: function onDelete(id) {
-      return (0, _editorCommands.removeInlineCommentNearSelection)(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);
+      return (0, _editorCommands.removeInlineCommentNearSelection)(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, dispatch);
     },
     onResolve: function onResolve(id) {
       return (0, _editorCommands.updateInlineCommentResolvedState)(editorAnalyticsAPI)((0, _defineProperty2.default)({}, id, true), _analytics.RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch);

package/dist/es2019/annotationPlugin.js

@@ -78,7 +78,8 @@ export const annotationPlugin = ({
             state,
             intl,
             isToolbarAbove,
-            api
+            api,
+            createCommentExperience: annotationProviders.createCommentExperience
           });
           if (!toolbarConfig) {
             return undefined;

package/dist/es2019/editor-commands/transform.js

@@ -3,8 +3,10 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { applyMarkOnRange } from '@atlaskit/editor-common/mark';
 import { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { getDraftCommandAnalyticsPayload, getPluginState, resolveDraftBookmark } from '../pm-plugins/utils';
+const isAnnotationStep = step => step instanceof AddMarkStep && step.mark.type.name === 'annotation';
 const addAnnotationMark = (id, supportedBlockNodes) => (transaction, state) => {
   const inlineCommentState = getPluginState(state);
   const {
@@ -28,8 +30,16 @@ const addAnnotationMark = (id, supportedBlockNodes) => (transaction, state) => {
   } else {
     // Apply the mark only to text node in the range.
     const tr = applyMarkOnRange(from, to, false, annotationMark, transaction);
-    // set selection back to the end of annotation once annotation mark is applied
-    tr.setSelection(TextSelection.create(tr.doc, head));
+
+    // The mark may not be applied to the current "head" of the bookmark so determine what was applied
+    // above and use that instead
+    if (fg('platform_editor_fix_missing_selected_annotations')) {
+      const annotationMarkStep = tr.steps.reverse().find(isAnnotationStep);
+      const headBasedOnMark = from === head ? annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.from : annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.to;
+      tr.setSelection(TextSelection.create(tr.doc, headBasedOnMark !== null && headBasedOnMark !== void 0 ? headBasedOnMark : head));
+    } else {
+      tr.setSelection(TextSelection.create(tr.doc, head));
+    }
   }
   return tr;
 };

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

@@ -15,7 +15,8 @@ export const buildToolbar = editorAnalyticsAPI => ({
   intl,
   isToolbarAbove = false,
   _supportedNodes = [],
-  api
+  api,
+  createCommentExperience
 }) => {
   var _api$connectivity, _api$connectivity$sha, _api$connectivity$sha2;
   const {
@@ -79,6 +80,15 @@ export const buildToolbar = editorAnalyticsAPI => ({
           }
         });
       }
+      if (fg('confluence_comments_create_comment_experience')) {
+        createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.start({
+          attributes: {
+            pageClass: 'editor',
+            commentType: 'inline'
+          }
+        });
+        createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.initExperience.start();
+      }
       return setInlineCommentDraftState(editorAnalyticsAPI)(true)(state, dispatch);
     },
     supportsViewMode: true // TODO: MODES-3950 - Clean up this floating toolbar view mode logic,

package/dist/es2019/ui/InlineCommentView.js

@@ -158,7 +158,7 @@ export function InlineCommentView({
     annotations: activeAnnotations,
     getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
-    onDelete: id => removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch),
+    onDelete: id => removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, dispatch),
     onResolve: id => updateInlineCommentResolvedState(editorAnalyticsAPI)({
       [id]: true
     }, RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch),

package/dist/esm/annotationPlugin.js

@@ -79,7 +79,8 @@ export var annotationPlugin = function annotationPlugin(_ref) {
             state: state,
             intl: intl,
             isToolbarAbove: isToolbarAbove,
-            api: api
+            api: api,
+            createCommentExperience: annotationProviders.createCommentExperience
           });
           if (!toolbarConfig) {
             return undefined;

package/dist/esm/editor-commands/transform.js

@@ -3,8 +3,12 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { applyMarkOnRange } from '@atlaskit/editor-common/mark';
 import { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { getDraftCommandAnalyticsPayload, getPluginState, resolveDraftBookmark } from '../pm-plugins/utils';
+var isAnnotationStep = function isAnnotationStep(step) {
+  return step instanceof AddMarkStep && step.mark.type.name === 'annotation';
+};
 var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
   return function (transaction, state) {
     var inlineCommentState = getPluginState(state);
@@ -27,8 +31,16 @@ var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
     } else {
       // Apply the mark only to text node in the range.
       var _tr = applyMarkOnRange(from, to, false, annotationMark, transaction);
-      // set selection back to the end of annotation once annotation mark is applied
-      _tr.setSelection(TextSelection.create(_tr.doc, head));
+
+      // The mark may not be applied to the current "head" of the bookmark so determine what was applied
+      // above and use that instead
+      if (fg('platform_editor_fix_missing_selected_annotations')) {
+        var annotationMarkStep = _tr.steps.reverse().find(isAnnotationStep);
+        var headBasedOnMark = from === head ? annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.from : annotationMarkStep === null || annotationMarkStep === void 0 ? void 0 : annotationMarkStep.to;
+        _tr.setSelection(TextSelection.create(_tr.doc, headBasedOnMark !== null && headBasedOnMark !== void 0 ? headBasedOnMark : head));
+      } else {
+        _tr.setSelection(TextSelection.create(_tr.doc, head));
+      }
     }
     return tr;
   };

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

@@ -19,7 +19,8 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
       isToolbarAbove = _ref$isToolbarAbove === void 0 ? false : _ref$isToolbarAbove,
       _ref$_supportedNodes = _ref._supportedNodes,
       _supportedNodes = _ref$_supportedNodes === void 0 ? [] : _ref$_supportedNodes,
-      api = _ref.api;
+      api = _ref.api,
+      createCommentExperience = _ref.createCommentExperience;
     var schema = state.schema;
     var selectionValid = isSelectionValid(state);
     var isMediaSelected = currentMediaNodeWithPos(state);
@@ -81,6 +82,15 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
             }
           });
         }
+        if (fg('confluence_comments_create_comment_experience')) {
+          createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
+            attributes: {
+              pageClass: 'editor',
+              commentType: 'inline'
+            }
+          });
+          createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
+        }
         return setInlineCommentDraftState(editorAnalyticsAPI)(true)(state, dispatch);
       },
       supportsViewMode: true // TODO: MODES-3950 - Clean up this floating toolbar view mode logic,

package/dist/esm/ui/InlineCommentView.js

@@ -155,7 +155,7 @@ export function InlineCommentView(_ref) {
     getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
     onDelete: function onDelete(id) {
-      return removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);
+      return removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(editorView.state, dispatch);
     },
     onResolve: function onResolve(id) {
       return updateInlineCommentResolvedState(editorAnalyticsAPI)(_defineProperty({}, id, true), RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch);

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

@@ -6,6 +6,7 @@ import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import { type EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
+import { AnnotationProviders } from '../types';
 interface BuildToolbarOptions {
     state: EditorState;
     intl: IntlShape;
@@ -13,8 +14,9 @@ interface BuildToolbarOptions {
     isCommentOnMediaOn?: boolean;
     _supportedNodes?: string[];
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    createCommentExperience?: AnnotationProviders['createCommentExperience'];
 }
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, }: BuildToolbarOptions) => {
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, createCommentExperience, }: BuildToolbarOptions) => {
     title: string;
     nodeType: NodeType[];
     items: FloatingToolbarButton<Command>[];

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

@@ -104,6 +104,23 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
+    createCommentExperience?: {
+        start: (_: {
+            attributes: {
+                pageClass: 'editor';
+                commentType: 'inline';
+                annotationId?: undefined;
+            } | {
+                pageClass: 'editor';
+                commentType: 'block';
+                blockType: 'media';
+                annotationId?: undefined;
+            };
+        }) => void;
+        initExperience: {
+            start: () => void;
+        };
+    };
 }
 export declare enum AnnotationSelectionType {
     INVALID = "invalid",// Annotation should not be created, toolbar should not be shown

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

@@ -6,6 +6,7 @@ import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import { type EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationPlugin } from '../annotationPluginType';
+import { AnnotationProviders } from '../types';
 interface BuildToolbarOptions {
     state: EditorState;
     intl: IntlShape;
@@ -13,8 +14,9 @@ interface BuildToolbarOptions {
     isCommentOnMediaOn?: boolean;
     _supportedNodes?: string[];
     api?: ExtractInjectionAPI<AnnotationPlugin>;
+    createCommentExperience?: AnnotationProviders['createCommentExperience'];
 }
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, }: BuildToolbarOptions) => {
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => ({ state, intl, isToolbarAbove, _supportedNodes, api, createCommentExperience, }: BuildToolbarOptions) => {
     title: string;
     nodeType: NodeType[];
     items: FloatingToolbarButton<Command>[];

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

@@ -104,6 +104,23 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
+    createCommentExperience?: {
+        start: (_: {
+            attributes: {
+                pageClass: 'editor';
+                commentType: 'inline';
+                annotationId?: undefined;
+            } | {
+                pageClass: 'editor';
+                commentType: 'block';
+                blockType: 'media';
+                annotationId?: undefined;
+            };
+        }) => void;
+        initExperience: {
+            start: () => void;
+        };
+    };
 }
 export declare enum AnnotationSelectionType {
     INVALID = "invalid",// Annotation should not be created, toolbar should not be shown

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.1.7",
+	"version": "2.1.9",
 	"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/editor-common": "^102.11.0",
+		"@atlaskit/editor-common": "^102.13.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -41,7 +41,7 @@
 		"@atlaskit/icon": "^25.0.0",
 		"@atlaskit/onboarding": "^13.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.1.0",
+		"@atlaskit/tmp-editor-statsig": "^4.4.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -104,6 +104,9 @@
 		},
 		"use_comments_data_annotation_updater": {
 			"type": "boolean"
+		},
+		"confluence_comments_create_comment_experience": {
+			"type": "boolean"
 		}
 	}
 }