@atlaskit/editor-plugin-annotation 2.2.2 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.4.0
+
+### Minor Changes
+
+- [#137860](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/137860)
+  [`04e753d1ba0f4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/04e753d1ba0f4) -
+  Created a new Annotation manager implementation and interface and updated CCFE to create and share
+  this instance around
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.3.0
+
+### Minor Changes
+
+- [#138416](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/138416)
+  [`8cfce6829f775`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8cfce6829f775) -
+  Fix to have focussedCommentId render the standalone inlinecomment
+
 ## 2.2.2
 
 ### Patch Changes

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

@@ -178,10 +178,23 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
         var pluginState = (0, _utils.getPluginState)(editorView.state);
-        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks')) {
-          (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
+        if ((0, _platformFeatureFlags.fg)('platform_editor_listen_for_focussed_query_param')) {
+          // When feature flag is true, only close if no annotationId
+          if (!annotationId) {
+            (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
+          } else {
+            (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
+          }
         } else {
-          (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
+          // When feature flag is false, close if:
+          // 1. No annotationId OR
+          // 2. View is closed and annotation clicks are enabled
+          var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && (0, _platformFeatureFlags.fg)('platform_editor_listen_for_annotation_clicks');
+          if (shouldClose) {
+            (0, _editorCommands.closeComponent)()(editorView.state, editorView.dispatch);
+          } else {
+            (0, _editorCommands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
+          }
         }
       };
       var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {

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

@@ -110,10 +110,23 @@ export const inlineCommentPlugin = options => {
       const setVisibility = isVisible => onSetVisibility(editorView)(isVisible);
       const setSelectedAnnotationFn = annotationId => {
         const pluginState = getPluginState(editorView.state);
-        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
-          closeComponent()(editorView.state, editorView.dispatch);
+        if (fg('platform_editor_listen_for_focussed_query_param')) {
+          // When feature flag is true, only close if no annotationId
+          if (!annotationId) {
+            closeComponent()(editorView.state, editorView.dispatch);
+          } else {
+            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          }
         } else {
-          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          // When feature flag is false, close if:
+          // 1. No annotationId OR
+          // 2. View is closed and annotation clicks are enabled
+          const shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
+          if (shouldClose) {
+            closeComponent()(editorView.state, editorView.dispatch);
+          } else {
+            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          }
         }
       };
       const setHoveredAnnotationFn = annotationId => {

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

@@ -171,10 +171,23 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
       };
       var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
         var pluginState = getPluginState(editorView.state);
-        if (!annotationId || pluginState !== null && pluginState !== void 0 && pluginState.isInlineCommentViewClosed && fg('platform_editor_listen_for_annotation_clicks')) {
-          closeComponent()(editorView.state, editorView.dispatch);
+        if (fg('platform_editor_listen_for_focussed_query_param')) {
+          // When feature flag is true, only close if no annotationId
+          if (!annotationId) {
+            closeComponent()(editorView.state, editorView.dispatch);
+          } else {
+            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          }
         } else {
-          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          // When feature flag is false, close if:
+          // 1. No annotationId OR
+          // 2. View is closed and annotation clicks are enabled
+          var shouldClose = !annotationId || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.isInlineCommentViewClosed) && fg('platform_editor_listen_for_annotation_clicks');
+          if (shouldClose) {
+            closeComponent()(editorView.state, editorView.dispatch);
+          } else {
+            setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+          }
         }
       };
       var setHoveredAnnotationFn = function setHoveredAnnotationFn(annotationId) {

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

@@ -1,7 +1,7 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
  * type of target that annotation apply to.
  * This is used to apply correct decoration to a draft comment
@@ -121,6 +121,7 @@ export interface AnnotationProviders {
             start: () => void;
         };
     };
+    annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
     INVALID = "invalid",// Annotation should not be created, toolbar should not be shown

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

@@ -1,7 +1,7 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
  * type of target that annotation apply to.
  * This is used to apply correct decoration to a draft comment
@@ -121,6 +121,7 @@ export interface AnnotationProviders {
             start: () => void;
         };
     };
+    annotationManager?: AnnotationManager;
 }
 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.2.2",
+	"version": "2.4.0",
 	"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": "^103.1.0",
+		"@atlaskit/editor-common": "^103.3.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -110,6 +110,9 @@
 		},
 		"platform_editor_annotation_selected_annotation": {
 			"type": "boolean"
+		},
+		"platform_editor_listen_for_focussed_query_param": {
+			"type": "boolean"
 		}
 	}
 }