@atlaskit/editor-plugin-annotation 1.10.4 → 1.11.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.11.0
+
+### Minor Changes
+
+- [#112275](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/112275)
+  [`6f3058e0347a3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6f3058e0347a3) -
+  ED-23734 - add `getInlineNodeTypes` function to `InlineCommentViewComponentProps`
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.10.4
 
 ### Patch Changes

package/dist/cjs/ui/InlineCommentView.js

@@ -79,16 +79,16 @@ function InlineCommentView(_ref) {
   if (!dom) {
     return null;
   }
-  var inlineNodeTypes = (0, _utils.getRangeInlineNodeNames)({
-    doc: state.doc,
-    pos: selection
-  });
 
   // Create Component
   if (bookmark) {
     if (!CreateComponent) {
       return null;
     }
+    var inlineNodeTypes = (0, _utils.getRangeInlineNodeNames)({
+      doc: state.doc,
+      pos: selection
+    });
 
     //getting all text between bookmarked positions
     var textSelection = state.doc.textBetween(selection.from, selection.to);
@@ -145,6 +145,13 @@ function InlineCommentView(_ref) {
   if (isInlineCommentViewClosed || !selectedAnnotations) {
     return null;
   }
+
+  // For view mode, the finding of inline node types is a bit more complex,
+  // that's why we will not provide it as a `inlineNodeTypes` props to the view component,
+  // to speed up the rendering process.
+  var getInlineNodeTypes = function getInlineNodeTypes(annotationId) {
+    return (0, _utils.getAnnotationInlineNodeTypes)(editorView.state, annotationId);
+  };
   return /*#__PURE__*/_react.default.createElement(_AnnotationViewWrapper.AnnotationViewWrapper, {
     "data-editor-popup": "true",
     "data-testid": _types.AnnotationTestIds.floatingComponent,
@@ -153,7 +160,7 @@ function InlineCommentView(_ref) {
   }, /*#__PURE__*/_react.default.createElement(ViewComponent, {
     annotationsList: annotationsList,
     annotations: activeAnnotations,
-    inlineNodeTypes: inlineNodeTypes,
+    getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
     onDelete: function onDelete(id) {
       return (0, _commands.removeInlineCommentNearSelection)(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);

package/dist/es2019/ui/InlineCommentView.js

@@ -1,7 +1,7 @@
 import React 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 { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
+import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../commands';
 import { AnnotationTestIds } from '../types';
@@ -77,16 +77,16 @@ export function InlineCommentView({
   if (!dom) {
     return null;
   }
-  const inlineNodeTypes = getRangeInlineNodeNames({
-    doc: state.doc,
-    pos: selection
-  });
 
   // Create Component
   if (bookmark) {
     if (!CreateComponent) {
       return null;
     }
+    const inlineNodeTypes = getRangeInlineNodeNames({
+      doc: state.doc,
+      pos: selection
+    });
 
     //getting all text between bookmarked positions
     const textSelection = state.doc.textBetween(selection.from, selection.to);
@@ -143,6 +143,11 @@ export function InlineCommentView({
   if (isInlineCommentViewClosed || !selectedAnnotations) {
     return null;
   }
+
+  // For view mode, the finding of inline node types is a bit more complex,
+  // that's why we will not provide it as a `inlineNodeTypes` props to the view component,
+  // to speed up the rendering process.
+  const getInlineNodeTypes = annotationId => getAnnotationInlineNodeTypes(editorView.state, annotationId);
   return /*#__PURE__*/React.createElement(AnnotationViewWrapper, {
     "data-editor-popup": "true",
     "data-testid": AnnotationTestIds.floatingComponent,
@@ -151,7 +156,7 @@ export function InlineCommentView({
   }, /*#__PURE__*/React.createElement(ViewComponent, {
     annotationsList: annotationsList,
     annotations: activeAnnotations,
-    inlineNodeTypes: inlineNodeTypes,
+    getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
     onDelete: id => removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch),
     onResolve: id => updateInlineCommentResolvedState(editorAnalyticsAPI)({

package/dist/esm/ui/InlineCommentView.js

@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import React 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 { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
+import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../commands';
 import { AnnotationTestIds } from '../types';
@@ -72,16 +72,16 @@ export function InlineCommentView(_ref) {
   if (!dom) {
     return null;
   }
-  var inlineNodeTypes = getRangeInlineNodeNames({
-    doc: state.doc,
-    pos: selection
-  });
 
   // Create Component
   if (bookmark) {
     if (!CreateComponent) {
       return null;
     }
+    var inlineNodeTypes = getRangeInlineNodeNames({
+      doc: state.doc,
+      pos: selection
+    });
 
     //getting all text between bookmarked positions
     var textSelection = state.doc.textBetween(selection.from, selection.to);
@@ -138,6 +138,13 @@ export function InlineCommentView(_ref) {
   if (isInlineCommentViewClosed || !selectedAnnotations) {
     return null;
   }
+
+  // For view mode, the finding of inline node types is a bit more complex,
+  // that's why we will not provide it as a `inlineNodeTypes` props to the view component,
+  // to speed up the rendering process.
+  var getInlineNodeTypes = function getInlineNodeTypes(annotationId) {
+    return getAnnotationInlineNodeTypes(editorView.state, annotationId);
+  };
   return /*#__PURE__*/React.createElement(AnnotationViewWrapper, {
     "data-editor-popup": "true",
     "data-testid": AnnotationTestIds.floatingComponent,
@@ -146,7 +153,7 @@ export function InlineCommentView(_ref) {
   }, /*#__PURE__*/React.createElement(ViewComponent, {
     annotationsList: annotationsList,
     annotations: activeAnnotations,
-    inlineNodeTypes: inlineNodeTypes,
+    getInlineNodeTypes: getInlineNodeTypes,
     dom: dom,
     onDelete: function onDelete(id) {
       return removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);

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

@@ -36,7 +36,18 @@ declare const _default: {
                         sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
                     }, import("@atlaskit/editor-common/types").FeatureFlags>>];
                     actions: EditorAnalyticsAPI;
-                }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>];
+                }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>, import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
+                    sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
+                    dependencies: [];
+                    pluginConfiguration?: {
+                        mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                    } | undefined;
+                    commands: {
+                        updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
+                    };
+                }, {
+                    mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                } | undefined>>];
                 sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
                 actions: {
                     getAvatarColor: (str: string) => {
@@ -108,7 +119,18 @@ declare const _default: {
                     sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
                 }, import("@atlaskit/editor-common/types").FeatureFlags>>];
                 actions: EditorAnalyticsAPI;
-            }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>];
+            }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>, import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
+                sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
+                dependencies: [];
+                pluginConfiguration?: {
+                    mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                } | undefined;
+                commands: {
+                    updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
+                };
+            }, {
+                mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+            } | undefined>>];
             sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
             actions: {
                 getAvatarColor: (str: string) => {

package/dist/types/types.d.ts

@@ -61,14 +61,14 @@ type AnnotationComponentProps = {
      * Indicates that a draft comment was discarded/cancelled
      */
     onClose?: () => void;
-    /** List of inline node types, which are wrapped by the annotation. */
-    inlineNodeTypes: string[] | undefined;
 };
 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;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**
@@ -88,6 +88,16 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Ordered list of annotation ids as shown in the document
      */
     annotationsList?: string[];
+    /**
+     * Return a list of inline node types, which are wrapped by the annotation,
+     * for annotation with given ID.
+     *
+     * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+     *
+     * @todo: Do not forget to remove `undefined` when the
+     *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+     */
+    getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;

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

@@ -46,7 +46,20 @@ declare const _default: {
                                         }, import("@atlaskit/editor-common/types").FeatureFlags>>
                                     ];
                                     actions: EditorAnalyticsAPI;
-                                }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>
+                                }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>,
+                                import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
+                                    sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
+                                    dependencies: [
+                                    ];
+                                    pluginConfiguration?: {
+                                        mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                                    } | undefined;
+                                    commands: {
+                                        updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
+                                    };
+                                }, {
+                                    mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                                } | undefined>>
                             ];
                             sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
                             actions: {
@@ -133,7 +146,20 @@ declare const _default: {
                                 }, import("@atlaskit/editor-common/types").FeatureFlags>>
                             ];
                             actions: EditorAnalyticsAPI;
-                        }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>
+                        }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>,
+                        import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
+                            sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
+                            dependencies: [
+                            ];
+                            pluginConfiguration?: {
+                                mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                            } | undefined;
+                            commands: {
+                                updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
+                            };
+                        }, {
+                            mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
+                        } | undefined>>
                     ];
                     sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
                     actions: {

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

@@ -61,14 +61,14 @@ type AnnotationComponentProps = {
      * Indicates that a draft comment was discarded/cancelled
      */
     onClose?: () => void;
-    /** List of inline node types, which are wrapped by the annotation. */
-    inlineNodeTypes: string[] | undefined;
 };
 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;
 };
 export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     /**
@@ -88,6 +88,16 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Ordered list of annotation ids as shown in the document
      */
     annotationsList?: string[];
+    /**
+     * Return a list of inline node types, which are wrapped by the annotation,
+     * for annotation with given ID.
+     *
+     * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+     *
+     * @todo: Do not forget to remove `undefined` when the
+     *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+     */
+    getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "1.10.4",
+	"version": "1.11.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^36.10.7",
-		"@atlaskit/editor-common": "^82.9.0",
+		"@atlaskit/editor-common": "^82.11.0",
 		"@atlaskit/editor-plugin-analytics": "^1.2.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^1.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.1.0",