@atlaskit/editor-plugin-annotation 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.5.0
+
+### Minor Changes
+
+- [#82581](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/82581) [`c1be75ae15b6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c1be75ae15b6) - ED-22606 add toggle inline comment action
+
+### Patch Changes
+
+- [#81777](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/81777) [`c6d7a5378751`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c6d7a5378751) - Bump adf-schema to 35.7.0
+
+## 1.4.1
+
+### Patch Changes
+
+- [#83116](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83116) [`8d4e99057fe0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8d4e99057fe0) - Upgrade Typescript from `4.9.5` to `5.4.2`
+
 ## 1.4.0
 
 ### Minor Changes

package/dist/cjs/commands/index.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.setSelectedAnnotation = exports.setInlineCommentsVisibility = exports.setInlineCommentDraftState = exports.removeInlineCommentNearSelection = exports.createAnnotation = exports.closeComponent = exports.clearDirtyMark = exports.addInlineComment = void 0;
+exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.showInlineCommentForBlockNode = exports.setSelectedAnnotation = exports.setInlineCommentsVisibility = exports.setInlineCommentDraftState = exports.removeInlineCommentNearSelection = exports.createAnnotation = exports.closeComponent = exports.clearDirtyMark = exports.addInlineComment = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
@@ -118,6 +118,29 @@ var getDraftCommandAction = function getDraftCommandAction(drafting, targetType,
     };
   };
 };
+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
+          }
+        });
+      }
+    }
+  };
+};
 var setInlineCommentDraftState = exports.setInlineCommentDraftState = function setInlineCommentDraftState(editorAnalyticsAPI) {
   var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (drafting) {

package/dist/cjs/plugin.js

@@ -37,7 +37,8 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
     },
     actions: {
       stripNonExistingAnnotations: _utils.stripNonExistingAnnotations,
-      setInlineCommentDraftState: (0, _commands.setInlineCommentDraftState)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
+      setInlineCommentDraftState: (0, _commands.setInlineCommentDraftState)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
+      showCommentForBlockNode: (0, _commands.showInlineCommentForBlockNode)(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {

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

@@ -231,18 +231,17 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
           }).forEach(function (mark) {
             if (isVisible) {
               var isUnresolved = !!annotations && annotations[mark.attrs.id] === false;
+              var isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(function (selectedAnnotation) {
+                return selectedAnnotation.id === mark.attrs.id;
+              }));
               if (isSupportedBlockNode) {
-                var isBlockNodeSelected = (0, _utils.isCurrentBlockNodeSelected)(state, node);
                 var attrs = isUnresolved ? {
-                  class: isBlockNodeSelected ? "".concat(_styles.BlockAnnotationSharedClassNames.focus) : "".concat(_styles.BlockAnnotationSharedClassNames.blur)
+                  class: isSelected ? "".concat(_styles.BlockAnnotationSharedClassNames.focus) : "".concat(_styles.BlockAnnotationSharedClassNames.blur)
                 } : {};
                 focusDecorations.push(_view.Decoration.node(pos, pos + node.nodeSize, attrs, {
                   key: _utils.decorationKey.block
                 }));
               } else {
-                var isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(function (selectedAnnotation) {
-                  return selectedAnnotation.id === mark.attrs.id;
-                }));
                 focusDecorations.push(_view.Decoration.inline(pos, pos + node.nodeSize, {
                   class: "".concat((0, _nodeviews.getAnnotationViewClassname)(isUnresolved, isSelected), " ").concat(isUnresolved),
                   nodeName: 'span'

package/dist/cjs/pm-plugins/plugin-factory.js

@@ -29,6 +29,11 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
         isInlineCommentViewClosed: false
       });
     }
+
+    /**
+     * Default we only handle caret selections.
+     * Node selection will be handled separately.
+     */
     var selectedAnnotations = (0, _utils2.findAnnotationsInSelection)(tr.selection, tr.doc);
     if (selectedAnnotations.length === 0) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {

package/dist/cjs/toolbar.js

@@ -50,6 +50,8 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
             eventType: _analytics.EVENT_TYPE.UI,
             attributes: {
               source: 'highlightActionsMenu',
+              // @ts-expect-error - Object literal may only specify known properties, and 'pageMode' does not exist in type
+              // This error was introduced after upgrading to TypeScript 5
               pageMode: 'edit'
             }
           });

package/dist/es2019/commands/index.js

@@ -104,6 +104,22 @@ const getDraftCommandAction = (drafting, targetType, isCommentOnMediaOn, support
     };
   };
 };
+export const showInlineCommentForBlockNode = (supportedBlockNodes = []) => node => {
+  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 => ({
+      id: mark.attrs.id,
+      type: mark.attrs.annotationType
+    }));
+    if (annotationMarks.length) {
+      return createCommand({
+        type: ACTIONS.SET_SELECTED_ANNOTATION,
+        data: {
+          selectedAnnotations: annotationMarks
+        }
+      });
+    }
+  }
+};
 export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNodes = []) => (drafting, inputMethod = INPUT_METHOD.TOOLBAR, targetType = 'inline', isCommentOnMediaOn = false) => {
   const commandAction = getDraftCommandAction(drafting, targetType, isCommentOnMediaOn, supportedBlockNodes);
   return createCommand(commandAction, transform.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));

package/dist/es2019/plugin.js

@@ -3,7 +3,7 @@ import { annotation } from '@atlaskit/adf-schema';
 import { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
-import { setInlineCommentDraftState } from './commands';
+import { setInlineCommentDraftState, showInlineCommentForBlockNode } from './commands';
 import { inlineCommentPlugin } from './pm-plugins/inline-comment';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { buildToolbar } from './toolbar';
@@ -25,7 +25,8 @@ export const annotationPlugin = ({
     },
     actions: {
       stripNonExistingAnnotations,
-      setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
+      setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
+      showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
     },
     getSharedState(editorState) {
       if (!editorState) {

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

@@ -5,7 +5,7 @@ import { BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles'
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { clearDirtyMark, closeComponent, setInlineCommentsVisibility, setSelectedAnnotation, updateInlineCommentResolvedState, updateMouseState } from '../commands';
 import { AnnotationNodeView, getAnnotationViewClassname } from '../nodeviews';
-import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey, isCurrentBlockNodeSelected } from '../utils';
+import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey } from '../utils';
 import { createPluginState } from './plugin-factory';
 const fetchProviderStates = async (provider, annotationIds) => {
   const data = await provider.getState(annotationIds);
@@ -169,16 +169,15 @@ export const inlineCommentPlugin = options => {
           node.marks.filter(mark => mark.type === state.schema.marks.annotation).forEach(mark => {
             if (isVisible) {
               const isUnresolved = !!annotations && annotations[mark.attrs.id] === false;
+              const isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(selectedAnnotation => selectedAnnotation.id === mark.attrs.id));
               if (isSupportedBlockNode) {
-                const isBlockNodeSelected = isCurrentBlockNodeSelected(state, node);
                 const attrs = isUnresolved ? {
-                  class: isBlockNodeSelected ? `${BlockAnnotationSharedClassNames.focus}` : `${BlockAnnotationSharedClassNames.blur}`
+                  class: isSelected ? `${BlockAnnotationSharedClassNames.focus}` : `${BlockAnnotationSharedClassNames.blur}`
                 } : {};
                 focusDecorations.push(Decoration.node(pos, pos + node.nodeSize, attrs, {
                   key: decorationKey.block
                 }));
               } else {
-                const isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(selectedAnnotation => selectedAnnotation.id === mark.attrs.id));
                 focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
                   class: `${getAnnotationViewClassname(isUnresolved, isSelected)} ${isUnresolved}`,
                   nodeName: 'span'

package/dist/es2019/pm-plugins/plugin-factory.js

@@ -21,6 +21,11 @@ const getSelectionChangedHandler = reopenCommentView => (tr, pluginState) => {
       })
     };
   }
+
+  /**
+   * Default we only handle caret selections.
+   * Node selection will be handled separately.
+   */
   const selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc);
   if (selectedAnnotations.length === 0) {
     return {

package/dist/es2019/toolbar.js

@@ -41,6 +41,8 @@ export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove =
           eventType: EVENT_TYPE.UI,
           attributes: {
             source: 'highlightActionsMenu',
+            // @ts-expect-error - Object literal may only specify known properties, and 'pageMode' does not exist in type
+            // This error was introduced after upgrading to TypeScript 5
             pageMode: 'edit'
           }
         });

package/dist/esm/commands/index.js

@@ -111,6 +111,29 @@ var getDraftCommandAction = function getDraftCommandAction(drafting, targetType,
     };
   };
 };
+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
+          }
+        });
+      }
+    }
+  };
+};
 export var setInlineCommentDraftState = function setInlineCommentDraftState(editorAnalyticsAPI) {
   var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (drafting) {

package/dist/esm/plugin.js

@@ -3,7 +3,7 @@ import { annotation } from '@atlaskit/adf-schema';
 import { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
-import { setInlineCommentDraftState } from './commands';
+import { setInlineCommentDraftState, showInlineCommentForBlockNode } from './commands';
 import { inlineCommentPlugin } from './pm-plugins/inline-comment';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { buildToolbar } from './toolbar';
@@ -24,7 +24,8 @@ export var annotationPlugin = function annotationPlugin(_ref) {
     },
     actions: {
       stripNonExistingAnnotations: stripNonExistingAnnotations,
-      setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
+      setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
+      showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {

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

@@ -8,7 +8,7 @@ import { BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles'
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { clearDirtyMark, closeComponent, setInlineCommentsVisibility, setSelectedAnnotation, updateInlineCommentResolvedState, updateMouseState } from '../commands';
 import { AnnotationNodeView, getAnnotationViewClassname } from '../nodeviews';
-import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey, isCurrentBlockNodeSelected } from '../utils';
+import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey } from '../utils';
 import { createPluginState } from './plugin-factory';
 var fetchProviderStates = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(provider, annotationIds) {
@@ -224,18 +224,17 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
           }).forEach(function (mark) {
             if (isVisible) {
               var isUnresolved = !!annotations && annotations[mark.attrs.id] === false;
+              var isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(function (selectedAnnotation) {
+                return selectedAnnotation.id === mark.attrs.id;
+              }));
               if (isSupportedBlockNode) {
-                var isBlockNodeSelected = isCurrentBlockNodeSelected(state, node);
                 var attrs = isUnresolved ? {
-                  class: isBlockNodeSelected ? "".concat(BlockAnnotationSharedClassNames.focus) : "".concat(BlockAnnotationSharedClassNames.blur)
+                  class: isSelected ? "".concat(BlockAnnotationSharedClassNames.focus) : "".concat(BlockAnnotationSharedClassNames.blur)
                 } : {};
                 focusDecorations.push(Decoration.node(pos, pos + node.nodeSize, attrs, {
                   key: decorationKey.block
                 }));
               } else {
-                var isSelected = !isInlineCommentViewClosed && !!(selectedAnnotations !== null && selectedAnnotations !== void 0 && selectedAnnotations.some(function (selectedAnnotation) {
-                  return selectedAnnotation.id === mark.attrs.id;
-                }));
                 focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
                   class: "".concat(getAnnotationViewClassname(isUnresolved, isSelected), " ").concat(isUnresolved),
                   nodeName: 'span'

package/dist/esm/pm-plugins/plugin-factory.js

@@ -22,6 +22,11 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
         isInlineCommentViewClosed: false
       });
     }
+
+    /**
+     * Default we only handle caret selections.
+     * Node selection will be handled separately.
+     */
     var selectedAnnotations = findAnnotationsInSelection(tr.selection, tr.doc);
     if (selectedAnnotations.length === 0) {
       return _objectSpread(_objectSpread({}, pluginState), {}, {

package/dist/esm/toolbar.js

@@ -43,6 +43,8 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
             eventType: EVENT_TYPE.UI,
             attributes: {
               source: 'highlightActionsMenu',
+              // @ts-expect-error - Object literal may only specify known properties, and 'pageMode' does not exist in type
+              // This error was introduced after upgrading to TypeScript 5
               pageMode: 'edit'
             }
           });

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

@@ -1,12 +1,14 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import type { Command, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
 import type { AnnotationPlugin, 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 removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
+export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command | undefined;
 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) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

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

@@ -69,6 +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;
         };
     }, 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/pm-plugins/plugin-factory.d.ts

@@ -1,2 +1,2 @@
 import type { InlineCommentPluginState } from './types';
-export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch<any>, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

package/dist/types/types.d.ts

@@ -8,6 +8,7 @@ import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmo
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { showInlineCommentForBlockNode } from './commands';
 import type { InlineCommentPluginState } from './pm-plugins/types';
 type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
 /**
@@ -35,6 +36,12 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;
         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.
+         */
+        showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
     };
 }>;
 export type AnnotationInfo = {
@@ -112,8 +119,8 @@ export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
 }
 export declare enum AnnotationSelectionType {
-    INVALID = "invalid",
-    DISABLED = "disabled",
+    INVALID = "invalid",// Annotation should not be created, toolbar should not be shown
+    DISABLED = "disabled",// Annotation should not be created, toolbar should be shown, but disabled
     VALID = "valid"
 }
 export declare const AnnotationTestIds: {

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

@@ -1,12 +1,14 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import type { Command, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
 import type { AnnotationPlugin, 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 removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
+export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[]) => (node: PMNode | null) => Command | undefined;
 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) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

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

@@ -83,6 +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;
             };
         }, import("../types").AnnotationProviders | undefined>,
         import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {

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

@@ -1,2 +1,2 @@
 import type { InlineCommentPluginState } from './types';
-export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch<any>, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

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

@@ -8,6 +8,7 @@ import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmo
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { showInlineCommentForBlockNode } from './commands';
 import type { InlineCommentPluginState } from './pm-plugins/types';
 type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
 /**
@@ -35,6 +36,12 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;
         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.
+         */
+        showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
     };
 }>;
 export type AnnotationInfo = {
@@ -112,8 +119,8 @@ export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
 }
 export declare enum AnnotationSelectionType {
-    INVALID = "invalid",
-    DISABLED = "disabled",
+    INVALID = "invalid",// Annotation should not be created, toolbar should not be shown
+    DISABLED = "disabled",// Annotation should not be created, toolbar should be shown, but disabled
     VALID = "valid"
 }
 export declare const AnnotationTestIds: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -32,8 +32,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^35.6.0",
-    "@atlaskit/editor-common": "^78.14.0",
+    "@atlaskit/adf-schema": "^35.7.0",
+    "@atlaskit/editor-common": "^78.18.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-plugin-editor-viewmode": "^1.0.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
@@ -54,7 +54,7 @@
     "@atlassian/feature-flags-test-utils": "^0.2.0",
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",
-    "typescript": "~4.9.5",
+    "typescript": "~5.4.2",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {