@atlaskit/editor-plugin-annotation 1.5.2 → 1.5.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.5.3
+
+### Patch Changes
+
+- [#84432](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/84432) [`19324d1894bb`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/19324d1894bb) - [ED-22643] Update showInlineCommentForBlockNode so that it can dispatch action to show comment view component when there are no active comments associated with the give node
+
 ## 1.5.2
 
 ### Patch Changes

package/dist/cjs/commands/index.js

@@ -118,27 +118,43 @@ var getDraftCommandAction = function getDraftCommandAction(drafting, targetType,
     };
   };
 };
+
+/**
+ * Show active inline comments for a given block node, otherwise,
+ * return false if the node has no comments or no unresolved comments.
+ */
 var showInlineCommentForBlockNode = exports.showInlineCommentForBlockNode = function showInlineCommentForBlockNode() {
   var supportedBlockNodes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   return function (node) {
-    if (node && node.isBlock && supportedBlockNodes.includes(node.type.name)) {
-      var annotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(function (mark) {
-        return mark.type.name === 'annotation';
-      }).map(function (mark) {
-        return {
-          id: mark.attrs.id,
-          type: mark.attrs.annotationType
-        };
-      });
-      if (annotationMarks.length) {
-        return (0, _pluginFactory.createCommand)({
-          type: _types.ACTIONS.SET_SELECTED_ANNOTATION,
-          data: {
-            selectedAnnotations: annotationMarks
-          }
+    return function (state, dispatch) {
+      var pluginState = (0, _utils.getPluginState)(state);
+      var annotation = state.schema.marks.annotation;
+      if (node && node.isBlock && supportedBlockNodes.includes(node.type.name)) {
+        var unresolvedAnnotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(function (mark) {
+          return mark.type === annotation && !(pluginState !== null && pluginState !== void 0 && pluginState.annotations[mark.attrs.id]);
+        }).map(function (mark) {
+          return {
+            id: mark.attrs.id,
+            type: mark.attrs.annotationType
+          };
         });
+        if (unresolvedAnnotationMarks.length) {
+          if (dispatch) {
+            // bypass createCommand with setMeta
+            // so that external plugins can be aware of if there are active(unresolved) comments associated with the node
+            // i.e. media plugin can use the return result (true/false) to show toggle create comment component
+            dispatch(state.tr.setMeta(_utils.inlineCommentPluginKey, {
+              type: _types.ACTIONS.SET_SELECTED_ANNOTATION,
+              data: {
+                selectedAnnotations: unresolvedAnnotationMarks
+              }
+            }));
+            return true;
+          }
+        }
       }
-    }
+      return false;
+    };
   };
 };
 var setInlineCommentDraftState = exports.setInlineCommentDraftState = function setInlineCommentDraftState(editorAnalyticsAPI) {

package/dist/cjs/utils.js

@@ -463,7 +463,11 @@ var isBlockNodeAnnotationsSelected = exports.isBlockNodeAnnotationsSelected = fu
         type: mark.attrs.annotationType
       };
     })) || [];
-    return !isSelectedAnnotationsChanged(selectedAnnotations, annotationMarks);
+    return !selectedAnnotations.some(function (annotation) {
+      return !annotationMarks.find(function (existingAnnotation) {
+        return existingAnnotation.id === annotation.id && existingAnnotation.type === annotation.type;
+      });
+    });
   }
   return false;
 };

package/dist/es2019/commands/index.js

@@ -4,7 +4,7 @@ import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { AnnotationSelectionType } from '../types';
-import { getPluginState, isSelectionValid, isSupportedBlockNode } from '../utils';
+import { getPluginState, inlineCommentPluginKey, isSelectionValid, isSupportedBlockNode } from '../utils';
 import transform from './transform';
 export const updateInlineCommentResolvedState = editorAnalyticsAPI => (partialNewState, resolveMethod) => {
   const command = {
@@ -104,21 +104,37 @@ const getDraftCommandAction = (drafting, targetType, isCommentOnMediaOn, support
     };
   };
 };
-export const showInlineCommentForBlockNode = (supportedBlockNodes = []) => node => {
+
+/**
+ * Show active inline comments for a given block node, otherwise,
+ * return false if the node has no comments or no unresolved comments.
+ */
+export const showInlineCommentForBlockNode = (supportedBlockNodes = []) => node => (state, dispatch) => {
+  const pluginState = getPluginState(state);
+  const {
+    annotation
+  } = state.schema.marks;
   if (node && node.isBlock && supportedBlockNodes.includes(node.type.name)) {
-    const annotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(mark => mark.type.name === 'annotation').map(mark => ({
+    const unresolvedAnnotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(mark => mark.type === annotation && !(pluginState !== null && pluginState !== void 0 && pluginState.annotations[mark.attrs.id])).map(mark => ({
       id: mark.attrs.id,
       type: mark.attrs.annotationType
     }));
-    if (annotationMarks.length) {
-      return createCommand({
-        type: ACTIONS.SET_SELECTED_ANNOTATION,
-        data: {
-          selectedAnnotations: annotationMarks
-        }
-      });
+    if (unresolvedAnnotationMarks.length) {
+      if (dispatch) {
+        // bypass createCommand with setMeta
+        // so that external plugins can be aware of if there are active(unresolved) comments associated with the node
+        // i.e. media plugin can use the return result (true/false) to show toggle create comment component
+        dispatch(state.tr.setMeta(inlineCommentPluginKey, {
+          type: ACTIONS.SET_SELECTED_ANNOTATION,
+          data: {
+            selectedAnnotations: unresolvedAnnotationMarks
+          }
+        }));
+        return true;
+      }
     }
   }
+  return false;
 };
 export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNodes = []) => (drafting, inputMethod = INPUT_METHOD.TOOLBAR, targetType = 'inline', isCommentOnMediaOn = false) => {
   const commandAction = getDraftCommandAction(drafting, targetType, isCommentOnMediaOn, supportedBlockNodes);

package/dist/es2019/utils.js

@@ -422,7 +422,7 @@ export const isBlockNodeAnnotationsSelected = (selection, selectedAnnotations =
       id: mark.attrs.id,
       type: mark.attrs.annotationType
     }))) || [];
-    return !isSelectedAnnotationsChanged(selectedAnnotations, annotationMarks);
+    return !selectedAnnotations.some(annotation => !annotationMarks.find(existingAnnotation => existingAnnotation.id === annotation.id && existingAnnotation.type === annotation.type));
   }
   return false;
 };

package/dist/esm/commands/index.js

@@ -5,7 +5,7 @@ import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { AnnotationSelectionType } from '../types';
-import { getPluginState, isSelectionValid, isSupportedBlockNode } from '../utils';
+import { getPluginState, inlineCommentPluginKey, isSelectionValid, isSupportedBlockNode } from '../utils';
 import transform from './transform';
 export var updateInlineCommentResolvedState = function updateInlineCommentResolvedState(editorAnalyticsAPI) {
   return function (partialNewState, resolveMethod) {
@@ -111,27 +111,43 @@ var getDraftCommandAction = function getDraftCommandAction(drafting, targetType,
     };
   };
 };
+
+/**
+ * Show active inline comments for a given block node, otherwise,
+ * return false if the node has no comments or no unresolved comments.
+ */
 export var showInlineCommentForBlockNode = function showInlineCommentForBlockNode() {
   var supportedBlockNodes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   return function (node) {
-    if (node && node.isBlock && supportedBlockNodes.includes(node.type.name)) {
-      var annotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(function (mark) {
-        return mark.type.name === 'annotation';
-      }).map(function (mark) {
-        return {
-          id: mark.attrs.id,
-          type: mark.attrs.annotationType
-        };
-      });
-      if (annotationMarks.length) {
-        return createCommand({
-          type: ACTIONS.SET_SELECTED_ANNOTATION,
-          data: {
-            selectedAnnotations: annotationMarks
-          }
+    return function (state, dispatch) {
+      var pluginState = getPluginState(state);
+      var annotation = state.schema.marks.annotation;
+      if (node && node.isBlock && supportedBlockNodes.includes(node.type.name)) {
+        var unresolvedAnnotationMarks = ((node === null || node === void 0 ? void 0 : node.marks) || []).filter(function (mark) {
+          return mark.type === annotation && !(pluginState !== null && pluginState !== void 0 && pluginState.annotations[mark.attrs.id]);
+        }).map(function (mark) {
+          return {
+            id: mark.attrs.id,
+            type: mark.attrs.annotationType
+          };
         });
+        if (unresolvedAnnotationMarks.length) {
+          if (dispatch) {
+            // bypass createCommand with setMeta
+            // so that external plugins can be aware of if there are active(unresolved) comments associated with the node
+            // i.e. media plugin can use the return result (true/false) to show toggle create comment component
+            dispatch(state.tr.setMeta(inlineCommentPluginKey, {
+              type: ACTIONS.SET_SELECTED_ANNOTATION,
+              data: {
+                selectedAnnotations: unresolvedAnnotationMarks
+              }
+            }));
+            return true;
+          }
+        }
       }
-    }
+      return false;
+    };
   };
 };
 export var setInlineCommentDraftState = function setInlineCommentDraftState(editorAnalyticsAPI) {

package/dist/esm/utils.js

@@ -436,7 +436,11 @@ export var isBlockNodeAnnotationsSelected = function isBlockNodeAnnotationsSelec
         type: mark.attrs.annotationType
       };
     })) || [];
-    return !isSelectedAnnotationsChanged(selectedAnnotations, annotationMarks);
+    return !selectedAnnotations.some(function (annotation) {
+      return !annotationMarks.find(function (existingAnnotation) {
+        return existingAnnotation.id === annotation.id && existingAnnotation.type === annotation.type;
+      });
+    });
   }
   return false;
 };

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

@@ -8,7 +8,11 @@ export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: Edit
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command | undefined;
+/**
+ * Show active inline comments for a given block node, otherwise,
+ * return false if the node has no comments or no unresolved comments.
+ */
+export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[]) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, supportedBlockNodes?: string[]) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

package/dist/types/commands/transform.d.ts

@@ -69,7 +69,7 @@ declare const _default: {
         actions: {
             stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: EditorState) => boolean | undefined;
             setInlineCommentDraftState: (drafting: boolean, inputMethod: InlineCommentInputMethod, targetType?: import("../types").TargetType | undefined, isCommentOnMediaOn?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
-            showCommentForBlockNode: (node: import("prosemirror-model").Node | null) => import("@atlaskit/editor-common/types").Command | undefined;
+            showCommentForBlockNode: (node: import("prosemirror-model").Node | null) => import("@atlaskit/editor-common/types").Command;
         };
     }, import("../types").AnnotationProviders | undefined>, import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
         pluginConfiguration: import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions;

package/dist/types/types.d.ts

@@ -38,8 +38,8 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
         setInlineCommentDraftState: SetInlineCommentDraftState;
         /**
          * This function attempts to display the inline comment popup for a given node.
-         * @returns A command function if the given node is supported and has an annotation mark;
-         * otherwise, it will return undefined.
+         * @returns A command function that returns true if the given node is supported and has resolved annotation mark(s);
+         * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
     };

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

@@ -8,7 +8,11 @@ export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: Edit
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command | undefined;
+/**
+ * Show active inline comments for a given block node, otherwise,
+ * return false if the node has no comments or no unresolved comments.
+ */
+export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[]) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, supportedBlockNodes?: string[]) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

package/dist/types-ts4.5/commands/transform.d.ts

@@ -83,7 +83,7 @@ declare const _default: {
             actions: {
                 stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: EditorState) => boolean | undefined;
                 setInlineCommentDraftState: (drafting: boolean, inputMethod: InlineCommentInputMethod, targetType?: import("../types").TargetType | undefined, isCommentOnMediaOn?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
-                showCommentForBlockNode: (node: import("prosemirror-model").Node | null) => import("@atlaskit/editor-common/types").Command | undefined;
+                showCommentForBlockNode: (node: import("prosemirror-model").Node | null) => import("@atlaskit/editor-common/types").Command;
             };
         }, import("../types").AnnotationProviders | undefined>,
         import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {

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

@@ -38,8 +38,8 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
         setInlineCommentDraftState: SetInlineCommentDraftState;
         /**
          * This function attempts to display the inline comment popup for a given node.
-         * @returns A command function if the given node is supported and has an annotation mark;
-         * otherwise, it will return undefined.
+         * @returns A command function that returns true if the given node is supported and has resolved annotation mark(s);
+         * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^35.7.0",
-    "@atlaskit/editor-common": "^78.20.0",
+    "@atlaskit/editor-common": "^78.21.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-plugin-editor-viewmode": "^1.0.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",