@atlaskit/editor-plugin-annotation 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.2.2
+
+### Patch Changes
+
+- [#79658](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/79658) [`4b195011d7c1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4b195011d7c1) - ED-22112 support remove annotation from supported nodes
+
+## 1.2.1
+
+### Patch Changes
+
+- [#78577](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/78577) [`207fbd3685dc`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/207fbd3685dc) - ED-22111 add supported nodes option to annotation plugin
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/cjs/commands/index.js

@@ -8,6 +8,7 @@ exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.se
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _state = require("@atlaskit/editor-prosemirror/state");
 var _pluginFactory = require("../pm-plugins/plugin-factory");
 var _types = require("../pm-plugins/types");
 var _types2 = require("../types");
@@ -38,10 +39,48 @@ var clearDirtyMark = exports.clearDirtyMark = function clearDirtyMark() {
     type: _types.ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
   });
 };
+var removeInlineCommentFromNode = function removeInlineCommentFromNode(id) {
+  var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var state = arguments.length > 2 ? arguments[2] : undefined;
+  var dispatch = arguments.length > 3 ? arguments[3] : undefined;
+  var tr = state.tr,
+    selection = state.selection;
+  if (selection instanceof _state.NodeSelection && (0, _utils.isSupportedBlockNode)(selection.node, supportedBlockNodes)) {
+    var $from = selection.$from;
+    var currNode = selection.node;
+    var from = $from.start();
+
+    // for media annotation, the selection is on media Single
+    if (currNode.type === state.schema.nodes.mediaSingle && currNode.firstChild) {
+      currNode = currNode.firstChild;
+      from = from + 1;
+    }
+    var annotationMarkType = state.schema.marks.annotation;
+    var hasAnnotation = currNode.marks.some(function (mark) {
+      return mark.type === annotationMarkType;
+    });
+    if (!hasAnnotation) {
+      return false;
+    }
+    tr.removeNodeMark(from, annotationMarkType.create({
+      id: id,
+      type: _adfSchema.AnnotationTypes.INLINE_COMMENT
+    }));
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  }
+  return false;
+};
 var removeInlineCommentNearSelection = exports.removeInlineCommentNearSelection = function removeInlineCommentNearSelection(id) {
+  var supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (state, dispatch) {
     var tr = state.tr,
       $from = state.selection.$from;
+    if (removeInlineCommentFromNode(id, supportedNodes, state, dispatch)) {
+      return true;
+    }
     var annotationMarkType = state.schema.marks.annotation;
     var hasAnnotation = $from.marks().some(function (mark) {
       return mark.type === annotationMarkType;

package/dist/cjs/nodeviews/index.js

@@ -14,7 +14,7 @@ var _react = _interopRequireDefault(require("react"));
 var _reactNodeView = _interopRequireDefault(require("@atlaskit/editor-common/react-node-view"));
 var _styles = require("@atlaskit/editor-common/styles");
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var AnnotationNodeView = exports.AnnotationNodeView = /*#__PURE__*/function (_ReactNodeView) {
   (0, _inherits2.default)(AnnotationNodeView, _ReactNodeView);
   var _super = _createSuper(AnnotationNodeView);

package/dist/cjs/toolbar.js

@@ -19,6 +19,7 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
   return function (state, intl) {
     var isToolbarAbove = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var isCommentOnMediaOn = arguments.length > 3 ? arguments[3] : undefined;
+    var _supportedNodes = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     var schema = state.schema;
     var selectionValid = (0, _utils2.isSelectionValid)(state, isCommentOnMediaOn);
     var isMediaSelected = isCommentOnMediaOn && (0, _mediaSingle.currentMediaNodeWithPos)(state);
@@ -57,7 +58,6 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
       },
       supportsViewMode: true // TODO: MODES-3950 Clean up this floating toolbar view mode logic
     };
-
     var annotation = schema.marks.annotation;
     var validNodes = Object.keys(schema.nodes).reduce(function (acc, current) {
       var type = schema.nodes[current];

package/dist/cjs/ui/AnnotationViewWrapper.js

@@ -12,7 +12,7 @@ var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _react = _interopRequireDefault(require("react"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 // eslint-disable-next-line @repo/internal/react/no-class-components
 var AnnotationViewWrapper = exports.AnnotationViewWrapper = /*#__PURE__*/function (_React$PureComponent) {
   (0, _inherits2.default)(AnnotationViewWrapper, _React$PureComponent);

package/dist/cjs/ui/InlineCommentView.js

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

package/dist/cjs/utils.js

@@ -23,7 +23,7 @@ exports.hasInvalidNodes = void 0;
 exports.hasInvalidWhitespaceNode = hasInvalidWhitespaceNode;
 exports.inlineCommentPluginKey = void 0;
 exports.isSelectedAnnotationsChanged = isSelectedAnnotationsChanged;
-exports.isSelectionValid = void 0;
+exports.isSupportedBlockNode = exports.isSelectionValid = void 0;
 exports.stripNonExistingAnnotations = stripNonExistingAnnotations;
 exports.surroundingMarks = void 0;
 var _adfSchema = require("@atlaskit/adf-schema");
@@ -237,6 +237,7 @@ var getDraftCommandAnalyticsPayload = exports.getDraftCommandAnalyticsPayload =
 };
 var isSelectionValid = exports.isSelectionValid = function isSelectionValid(state, isCommentOnMediaOn) {
   var _currentMediaNodeWith;
+  var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
   var _ref3 = getPluginState(state) || {},
     disallowOnWhitespace = _ref3.disallowOnWhitespace;
@@ -298,6 +299,10 @@ function isEmptyTextSelection(selection, schema) {
   });
   return !hasContent;
 }
+var isSupportedBlockNode = exports.isSupportedBlockNode = function isSupportedBlockNode(node) {
+  var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return supportedBlockNodes.indexOf(node.type.name) >= 0 || node.type.name === 'mediaSingle' && supportedBlockNodes.indexOf('media') >= 0;
+};
 
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

package/dist/es2019/commands/index.js

@@ -1,9 +1,10 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+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 } from '../utils';
+import { getPluginState, isSelectionValid, isSupportedBlockNode } from '../utils';
 import transform from './transform';
 export const updateInlineCommentResolvedState = editorAnalyticsAPI => (partialNewState, resolveMethod) => {
   const command = {
@@ -22,13 +23,51 @@ export const closeComponent = () => createCommand({
 export const clearDirtyMark = () => createCommand({
   type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
 });
-export const removeInlineCommentNearSelection = id => (state, dispatch) => {
+const removeInlineCommentFromNode = (id, supportedBlockNodes = [], state, dispatch) => {
+  const {
+    tr,
+    selection
+  } = state;
+  if (selection instanceof NodeSelection && isSupportedBlockNode(selection.node, supportedBlockNodes)) {
+    const {
+      $from
+    } = selection;
+    let currNode = selection.node;
+    let from = $from.start();
+
+    // for media annotation, the selection is on media Single
+    if (currNode.type === state.schema.nodes.mediaSingle && currNode.firstChild) {
+      currNode = currNode.firstChild;
+      from = from + 1;
+    }
+    const {
+      annotation: annotationMarkType
+    } = state.schema.marks;
+    const hasAnnotation = currNode.marks.some(mark => mark.type === annotationMarkType);
+    if (!hasAnnotation) {
+      return false;
+    }
+    tr.removeNodeMark(from, annotationMarkType.create({
+      id,
+      type: AnnotationTypes.INLINE_COMMENT
+    }));
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  }
+  return false;
+};
+export const removeInlineCommentNearSelection = (id, supportedNodes = []) => (state, dispatch) => {
   const {
     tr,
     selection: {
       $from
     }
   } = state;
+  if (removeInlineCommentFromNode(id, supportedNodes, state, dispatch)) {
+    return true;
+  }
   const {
     annotation: annotationMarkType
   } = state.schema.marks;

package/dist/es2019/toolbar.js

@@ -8,7 +8,7 @@ import CommentIcon from '@atlaskit/icon/glyph/comment';
 import { setInlineCommentDraftState } from './commands';
 import { AnnotationSelectionType, AnnotationTestIds } from './types';
 import { isSelectionValid } from './utils';
-export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove = false, isCommentOnMediaOn) => {
+export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove = false, isCommentOnMediaOn, _supportedNodes = []) => {
   const {
     schema
   } = state;
@@ -49,7 +49,6 @@ export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove =
     },
     supportsViewMode: true // TODO: MODES-3950 Clean up this floating toolbar view mode logic
   };
-
   const {
     annotation
   } = schema.marks;

package/dist/es2019/ui/InlineCommentView.js

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

package/dist/es2019/utils.js

@@ -194,7 +194,7 @@ export const getDraftCommandAnalyticsPayload = (drafting, inputMethod) => {
   };
   return payload;
 };
-export const isSelectionValid = (state, isCommentOnMediaOn) => {
+export const isSelectionValid = (state, isCommentOnMediaOn, _supportedNodes = []) => {
   var _currentMediaNodeWith;
   const {
     selection
@@ -263,6 +263,9 @@ function isEmptyTextSelection(selection, schema) {
   });
   return !hasContent;
 }
+export const isSupportedBlockNode = (node, supportedBlockNodes = []) => {
+  return supportedBlockNodes.indexOf(node.type.name) >= 0 || node.type.name === 'mediaSingle' && supportedBlockNodes.indexOf('media') >= 0;
+};
 
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

package/dist/esm/commands/index.js

@@ -1,10 +1,11 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+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 } from '../utils';
+import { getPluginState, isSelectionValid, isSupportedBlockNode } from '../utils';
 import transform from './transform';
 export var updateInlineCommentResolvedState = function updateInlineCommentResolvedState(editorAnalyticsAPI) {
   return function (partialNewState, resolveMethod) {
@@ -31,10 +32,48 @@ export var clearDirtyMark = function clearDirtyMark() {
     type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
   });
 };
+var removeInlineCommentFromNode = function removeInlineCommentFromNode(id) {
+  var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var state = arguments.length > 2 ? arguments[2] : undefined;
+  var dispatch = arguments.length > 3 ? arguments[3] : undefined;
+  var tr = state.tr,
+    selection = state.selection;
+  if (selection instanceof NodeSelection && isSupportedBlockNode(selection.node, supportedBlockNodes)) {
+    var $from = selection.$from;
+    var currNode = selection.node;
+    var from = $from.start();
+
+    // for media annotation, the selection is on media Single
+    if (currNode.type === state.schema.nodes.mediaSingle && currNode.firstChild) {
+      currNode = currNode.firstChild;
+      from = from + 1;
+    }
+    var annotationMarkType = state.schema.marks.annotation;
+    var hasAnnotation = currNode.marks.some(function (mark) {
+      return mark.type === annotationMarkType;
+    });
+    if (!hasAnnotation) {
+      return false;
+    }
+    tr.removeNodeMark(from, annotationMarkType.create({
+      id: id,
+      type: AnnotationTypes.INLINE_COMMENT
+    }));
+    if (dispatch) {
+      dispatch(tr);
+    }
+    return true;
+  }
+  return false;
+};
 export var removeInlineCommentNearSelection = function removeInlineCommentNearSelection(id) {
+  var supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (state, dispatch) {
     var tr = state.tr,
       $from = state.selection.$from;
+    if (removeInlineCommentFromNode(id, supportedNodes, state, dispatch)) {
+      return true;
+    }
     var annotationMarkType = state.schema.marks.annotation;
     var hasAnnotation = $from.marks().some(function (mark) {
       return mark.type === annotationMarkType;

package/dist/esm/nodeviews/index.js

@@ -4,7 +4,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import React from 'react';
 import ReactNodeView from '@atlaskit/editor-common/react-node-view';
 import { AnnotationSharedClassNames } from '@atlaskit/editor-common/styles';

package/dist/esm/toolbar.js

@@ -12,6 +12,7 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
   return function (state, intl) {
     var isToolbarAbove = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var isCommentOnMediaOn = arguments.length > 3 ? arguments[3] : undefined;
+    var _supportedNodes = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     var schema = state.schema;
     var selectionValid = isSelectionValid(state, isCommentOnMediaOn);
     var isMediaSelected = isCommentOnMediaOn && currentMediaNodeWithPos(state);
@@ -50,7 +51,6 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
       },
       supportsViewMode: true // TODO: MODES-3950 Clean up this floating toolbar view mode logic
     };
-
     var annotation = schema.marks.annotation;
     var validNodes = Object.keys(schema.nodes).reduce(function (acc, current) {
       var type = schema.nodes[current];

package/dist/esm/ui/AnnotationViewWrapper.js

@@ -4,7 +4,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import React from 'react';
 // eslint-disable-next-line @repo/internal/react/no-class-components
 export var AnnotationViewWrapper = /*#__PURE__*/function (_React$PureComponent) {

package/dist/esm/ui/InlineCommentView.js

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

package/dist/esm/utils.js

@@ -210,6 +210,7 @@ export var getDraftCommandAnalyticsPayload = function getDraftCommandAnalyticsPa
 };
 export var isSelectionValid = function isSelectionValid(state, isCommentOnMediaOn) {
   var _currentMediaNodeWith;
+  var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
   var _ref3 = getPluginState(state) || {},
     disallowOnWhitespace = _ref3.disallowOnWhitespace;
@@ -271,6 +272,10 @@ function isEmptyTextSelection(selection, schema) {
   });
   return !hasContent;
 }
+export var isSupportedBlockNode = function isSupportedBlockNode(node) {
+  var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return supportedBlockNodes.indexOf(node.type.name) >= 0 || node.type.name === 'mediaSingle' && supportedBlockNodes.indexOf('media') >= 0;
+};
 
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

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

@@ -6,7 +6,7 @@ import type { AnnotationPlugin, InlineCommentInputMethod, TargetType } from '../
 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) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (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/toolbar.d.ts

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean) => FloatingToolbarConfig | undefined;
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => FloatingToolbarConfig | undefined;

package/dist/types/types.d.ts

@@ -97,6 +97,16 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
     createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
     viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
     isToolbarAbove?: boolean;
+    /**
+     * @experimental Still under development. Do not use.
+     *
+     * A list of supported editor node names for inline comment,
+     * Note 1: value is the type name of the node, e.g. media, mediaInline
+     * Invalid node names, nodes does not support annotation
+     * or nodes not supported by current ADF schema will be ignored.
+     * Note 2: text is supported by default.
+     */
+    supportedBlockNodes?: string[];
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;

package/dist/types/utils.d.ts

@@ -28,8 +28,9 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
  * get payload for the open/close analytics event
  */
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
+export declare const isSupportedBlockNode: (node: Node, supportedBlockNodes?: string[]) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace
  * This is to conform to Confluence annotation specifications

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

@@ -6,7 +6,7 @@ import type { AnnotationPlugin, InlineCommentInputMethod, TargetType } from '../
 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) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (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/toolbar.d.ts

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean) => FloatingToolbarConfig | undefined;
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => FloatingToolbarConfig | undefined;

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

@@ -97,6 +97,16 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
     createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
     viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
     isToolbarAbove?: boolean;
+    /**
+     * @experimental Still under development. Do not use.
+     *
+     * A list of supported editor node names for inline comment,
+     * Note 1: value is the type name of the node, e.g. media, mediaInline
+     * Invalid node names, nodes does not support annotation
+     * or nodes not supported by current ADF schema will be ignored.
+     * Note 2: text is supported by default.
+     */
+    supportedBlockNodes?: string[];
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;

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

@@ -28,8 +28,9 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
  * get payload for the open/close analytics event
  */
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
+export declare const isSupportedBlockNode: (node: Node, supportedBlockNodes?: string[]) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace
  * This is to conform to Confluence annotation specifications

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",