@atlaskit/editor-plugin-annotation 1.2.1 → 1.3.0

package/dist/es2019/utils.js

@@ -1,9 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
-import { AnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
+import { AnnotationSharedClassNames, BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
 import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
-import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { AllSelection, NodeSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
@@ -87,7 +87,10 @@ const validateAnnotationMark = annotationMark => {
     return allowedTypes.includes(type);
   }
 };
-
+export const decorationKey = {
+  block: 'blockCommentDecoration',
+  inline: 'inlineCommentDecoration'
+};
 /*
  * add decoration for the comment selection in draft state
  * (when creating new comment)
@@ -95,11 +98,15 @@ const validateAnnotationMark = annotationMark => {
 export const addDraftDecoration = (start, end, targetType = 'inline') => {
   if (targetType === 'block') {
     return Decoration.node(start, end, {
-      class: `${AnnotationSharedClassNames.draft}`
+      class: `${BlockAnnotationSharedClassNames.draft}`
+    }, {
+      key: decorationKey.block
     });
   }
   return Decoration.inline(start, end, {
     class: `${AnnotationSharedClassNames.draft}`
+  }, {
+    key: decorationKey.inline
   });
 };
 export const getAnnotationViewKey = annotations => {
@@ -136,7 +143,44 @@ export const findAnnotationsInSelection = (selection, doc) => {
   reorderAnnotations(annotations, $anchor);
   return annotations;
 };
-
+export const resolveDraftBookmark = (editorState, bookmark, supportedBlockNodes = []) => {
+  const {
+    doc
+  } = editorState;
+  const resolvedBookmark = bookmark.resolve(doc);
+  const {
+    from,
+    to,
+    head
+  } = resolvedBookmark;
+  let draftBookmark = {
+    from,
+    to,
+    head
+  };
+  if (resolvedBookmark instanceof NodeSelection) {
+    // It's possible that annotation is only allowed in child node instead parent (e.g. mediaSingle vs media),
+    // thus, we traverse the node to find the first node that supports annotation and return its position
+    let nodeFound = false;
+    doc.nodesBetween(from, to, (node, pos) => {
+      // if we find the node, breakout the traversal to make sure we always record the first supported node
+      if (nodeFound) {
+        return false;
+      }
+      const nodeEndsAt = pos + node.nodeSize;
+      if (supportedBlockNodes.includes(node.type.name)) {
+        draftBookmark = {
+          from: pos,
+          to: nodeEndsAt,
+          head: nodeEndsAt
+        };
+        nodeFound = true;
+        return false;
+      }
+    });
+  }
+  return draftBookmark;
+};
 /**
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
@@ -263,6 +307,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,11 +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] : [];
+  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;
@@ -55,7 +93,7 @@ export var removeInlineCommentNearSelection = function removeInlineCommentNearSe
     return true;
   };
 };
-var getDraftCommandAction = function getDraftCommandAction(drafting, targetType, isCommentOnMediaOn) {
+var getDraftCommandAction = function getDraftCommandAction(drafting, targetType, isCommentOnMediaOn, supportedBlockNodes) {
   return function (editorState) {
     // validate selection only when entering draft mode
     if (drafting && isSelectionValid(editorState, isCommentOnMediaOn) !== AnnotationSelectionType.VALID) {
@@ -66,17 +104,20 @@ var getDraftCommandAction = function getDraftCommandAction(drafting, targetType,
       data: {
         drafting: drafting,
         editorState: editorState,
-        targetType: targetType
+        targetType: targetType,
+        isCommentOnMediaOn: isCommentOnMediaOn,
+        supportedBlockNodes: supportedBlockNodes
       }
     };
   };
 };
 export var setInlineCommentDraftState = function setInlineCommentDraftState(editorAnalyticsAPI) {
+  var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (drafting) {
     var inputMethod = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : INPUT_METHOD.TOOLBAR;
     var targetType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'inline';
     var isCommentOnMediaOn = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
-    var commandAction = getDraftCommandAction(drafting, targetType, isCommentOnMediaOn);
+    var commandAction = getDraftCommandAction(drafting, targetType, isCommentOnMediaOn, supportedBlockNodes);
     return createCommand(commandAction, transform.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
   };
 };

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/plugin.js

@@ -24,13 +24,16 @@ 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)
+      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)
     },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {
         return undefined;
       }
-      return getPluginState(editorState) || undefined;
+      var pluginState = getPluginState(editorState) || undefined;
+      var clonedPluginState = Object.assign({}, pluginState);
+      clonedPluginState === null || clonedPluginState === void 0 || delete clonedPluginState.featureFlagsPluginState;
+      return clonedPluginState;
     },
     pmPlugins: function pmPlugins() {
       return [{
@@ -46,7 +49,8 @@ export var annotationPlugin = function annotationPlugin(_ref) {
               portalProviderAPI: portalProviderAPI,
               eventDispatcher: eventDispatcher,
               provider: annotationProviders.inlineComment,
-              editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions
+              editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions,
+              featureFlagsPluginState: featureFlags
             });
           }
           return;

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

@@ -70,6 +70,7 @@ var fetchState = /*#__PURE__*/function () {
 }();
 var initialState = function initialState() {
   var disallowOnWhitespace = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+  var featureFlagsPluginState = arguments.length > 1 ? arguments[1] : undefined;
   return {
     annotations: {},
     selectedAnnotations: [],
@@ -79,7 +80,8 @@ var initialState = function initialState() {
     disallowOnWhitespace: disallowOnWhitespace,
     isInlineCommentViewClosed: false,
     isVisible: true,
-    skipSelectionHandling: false
+    skipSelectionHandling: false,
+    featureFlagsPluginState: featureFlagsPluginState
   };
 };
 var hideToolbar = function hideToolbar(state, dispatch) {
@@ -133,10 +135,11 @@ var onSetVisibility = function onSetVisibility(view) {
 export var inlineCommentPlugin = function inlineCommentPlugin(options) {
   var provider = options.provider,
     portalProviderAPI = options.portalProviderAPI,
-    eventDispatcher = options.eventDispatcher;
+    eventDispatcher = options.eventDispatcher,
+    featureFlagsPluginState = options.featureFlagsPluginState;
   return new SafePlugin({
     key: inlineCommentPluginKey,
-    state: createPluginState(options.dispatch, initialState(provider.disallowOnWhitespace)),
+    state: createPluginState(options.dispatch, initialState(provider.disallowOnWhitespace, featureFlagsPluginState)),
     view: function view(editorView) {
       // Get initial state
       // Need to pass `editorView` to mitigate editor state going stale

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

@@ -2,7 +2,8 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { pluginFactory } from '@atlaskit/editor-common/utils';
-import { findAnnotationsInSelection, inlineCommentPluginKey, isSelectedAnnotationsChanged } from '../utils';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { decorationKey, findAnnotationsInSelection, inlineCommentPluginKey, isSelectedAnnotationsChanged } from '../utils';
 import reducer from './reducer';
 var handleDocChanged = function handleDocChanged(tr, prevPluginState) {
   if (!tr.getMeta('replaceDocument')) {
@@ -43,13 +44,30 @@ var getSelectionChangedHandler = function getSelectionChangedHandler(reopenComme
 var _pluginFactory = pluginFactory(inlineCommentPluginKey, reducer, {
     onSelectionChanged: getSelectionChangedHandler(true),
     onDocChanged: handleDocChanged,
-    mapping: function mapping(tr, pluginState) {
+    mapping: function mapping(tr, pluginState, editorState) {
       var draftDecorationSet = pluginState.draftDecorationSet,
-        bookmark = pluginState.bookmark;
-      var mappedDecorationSet, mappedBookmark;
+        bookmark = pluginState.bookmark,
+        featureFlagsPluginState = pluginState.featureFlagsPluginState;
+      var mappedDecorationSet = DecorationSet.empty,
+        mappedBookmark;
+      var hasMappedDecorations = false;
       if (draftDecorationSet) {
         mappedDecorationSet = draftDecorationSet.map(tr.mapping, tr.doc);
       }
+      if (featureFlagsPluginState !== null && featureFlagsPluginState !== void 0 && featureFlagsPluginState.commentsOnMedia) {
+        hasMappedDecorations = mappedDecorationSet.find(undefined, undefined, function (spec) {
+          return Object.values(decorationKey).includes(spec.key);
+        }).length > 0;
+
+        // When changes to decoration target make decoration invalid (e.g. delete text, add mark to node),
+        // we need to reset bookmark to hide create component and to avoid invalid draft being published
+        if (!hasMappedDecorations) {
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            draftDecorationSet: mappedDecorationSet,
+            bookmark: undefined
+          });
+        }
+      }
       if (bookmark) {
         mappedBookmark = bookmark.map(tr.mapping);
       }

package/dist/esm/pm-plugins/reducer.js

@@ -3,7 +3,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { addDraftDecoration } from '../utils';
+import { addDraftDecoration, resolveDraftBookmark } from '../utils';
 import { ACTIONS } from './types';
 export default (function (pluginState, action) {
   switch (action.type) {
@@ -17,7 +17,7 @@ export default (function (pluginState, action) {
         mouseData: mouseData
       });
     case ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE:
-      return getNewDraftState(pluginState, action.data.drafting, action.data.editorState, action.data.targetType);
+      return getNewDraftState(pluginState, action.data.drafting, action.data.editorState, action.data.targetType, action.data.isCommentOnMediaOn, action.data.supportedBlockNodes);
     case ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK:
       return _objectSpread(_objectSpread({}, pluginState), {}, {
         dirtyAnnotations: false,
@@ -52,7 +52,7 @@ export default (function (pluginState, action) {
       return pluginState;
   }
 });
-function getNewDraftState(pluginState, drafting, editorState, targetType) {
+function getNewDraftState(pluginState, drafting, editorState, targetType, isCommentOnMediaOn, supportedBlockNodes) {
   var draftDecorationSet = pluginState.draftDecorationSet;
   if (!draftDecorationSet || !drafting) {
     draftDecorationSet = DecorationSet.empty;
@@ -63,8 +63,10 @@ function getNewDraftState(pluginState, drafting, editorState, targetType) {
   newState.bookmark = undefined;
   if (drafting && editorState) {
     newState.bookmark = editorState.selection.getBookmark();
-    var resolvedBookmark = newState.bookmark.resolve(editorState.doc);
-    var draftDecoration = addDraftDecoration(resolvedBookmark.from, resolvedBookmark.to, targetType);
+    var _ref = isCommentOnMediaOn ? resolveDraftBookmark(editorState, newState.bookmark, supportedBlockNodes) : newState.bookmark.resolve(editorState.doc),
+      from = _ref.from,
+      to = _ref.to;
+    var draftDecoration = addDraftDecoration(from, to, targetType);
     newState.draftDecorationSet = draftDecorationSet.add(editorState.doc, [draftDecoration]);
   }
   return newState;

package/dist/esm/toolbar.js

@@ -51,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/utils.js

@@ -1,9 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
-import { AnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
+import { AnnotationSharedClassNames, BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
 import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
-import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { AllSelection, NodeSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
@@ -98,7 +98,10 @@ var validateAnnotationMark = function validateAnnotationMark(annotationMark) {
     return allowedTypes.includes(type);
   }
 };
-
+export var decorationKey = {
+  block: 'blockCommentDecoration',
+  inline: 'inlineCommentDecoration'
+};
 /*
  * add decoration for the comment selection in draft state
  * (when creating new comment)
@@ -107,11 +110,15 @@ export var addDraftDecoration = function addDraftDecoration(start, end) {
   var targetType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'inline';
   if (targetType === 'block') {
     return Decoration.node(start, end, {
-      class: "".concat(AnnotationSharedClassNames.draft)
+      class: "".concat(BlockAnnotationSharedClassNames.draft)
+    }, {
+      key: decorationKey.block
     });
   }
   return Decoration.inline(start, end, {
     class: "".concat(AnnotationSharedClassNames.draft)
+  }, {
+    key: decorationKey.inline
   });
 };
 export var getAnnotationViewKey = function getAnnotationViewKey(annotations) {
@@ -152,7 +159,41 @@ export var findAnnotationsInSelection = function findAnnotationsInSelection(sele
   reorderAnnotations(annotations, $anchor);
   return annotations;
 };
-
+export var resolveDraftBookmark = function resolveDraftBookmark(editorState, bookmark) {
+  var supportedBlockNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+  var doc = editorState.doc;
+  var resolvedBookmark = bookmark.resolve(doc);
+  var from = resolvedBookmark.from,
+    to = resolvedBookmark.to,
+    head = resolvedBookmark.head;
+  var draftBookmark = {
+    from: from,
+    to: to,
+    head: head
+  };
+  if (resolvedBookmark instanceof NodeSelection) {
+    // It's possible that annotation is only allowed in child node instead parent (e.g. mediaSingle vs media),
+    // thus, we traverse the node to find the first node that supports annotation and return its position
+    var nodeFound = false;
+    doc.nodesBetween(from, to, function (node, pos) {
+      // if we find the node, breakout the traversal to make sure we always record the first supported node
+      if (nodeFound) {
+        return false;
+      }
+      var nodeEndsAt = pos + node.nodeSize;
+      if (supportedBlockNodes.includes(node.type.name)) {
+        draftBookmark = {
+          from: pos,
+          to: nodeEndsAt,
+          head: nodeEndsAt
+        };
+        nodeFound = true;
+        return false;
+      }
+    });
+  }
+  return draftBookmark;
+};
 /**
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
@@ -272,6 +313,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,8 +6,8 @@ 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, _supportedNodes?: string[]) => Command;
-export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => 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) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;

package/dist/types/pm-plugins/types.d.ts

@@ -1,6 +1,7 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { Dispatch, EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { PortalProviderAPI } from '@atlaskit/editor-common/portal-provider';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
 import type { EditorState, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationInfo, InlineCommentAnnotationProvider, TargetType } from '../types';
@@ -20,6 +21,7 @@ export interface InlineCommentPluginOptions {
     portalProviderAPI: PortalProviderAPI;
     provider: InlineCommentAnnotationProvider;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    featureFlagsPluginState?: FeatureFlags;
 }
 export interface InlineCommentMouseData {
     isSelecting: boolean;
@@ -36,6 +38,8 @@ export type InlineCommentAction = {
         drafting: boolean;
         editorState: EditorState;
         targetType?: TargetType;
+        isCommentOnMediaOn?: boolean;
+        supportedBlockNodes?: string[];
     };
 } | {
     type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
@@ -76,4 +80,5 @@ export type InlineCommentPluginState = {
     isInlineCommentViewClosed: boolean;
     isVisible: boolean;
     skipSelectionHandling: boolean;
+    featureFlagsPluginState?: FeatureFlags;
 };

package/dist/types/types.d.ts

@@ -129,4 +129,9 @@ export type CoordsAtPos = {
     left: number;
     right: number;
 };
+export type DraftBookmark = {
+    from: number;
+    to: number;
+    head: number;
+};
 export {};

package/dist/types/utils.d.ts

@@ -1,11 +1,11 @@
 import type { AnalyticsEventPayloadCallback } from '@atlaskit/editor-common/analytics';
 import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
 import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState, Selection, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginState } from './pm-plugins/types';
-import type { AnnotationInfo, InlineCommentInputMethod, TargetType } from './types';
+import type { AnnotationInfo, DraftBookmark, InlineCommentInputMethod, TargetType } from './types';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
 /**
@@ -14,9 +14,14 @@ export { hasAnnotationMark, containsAnyAnnotations };
  */
 export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
 export declare const getAllAnnotations: (doc: Node) => string[];
+export declare const decorationKey: {
+    block: string;
+    inline: string;
+};
 export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+export declare const resolveDraftBookmark: (editorState: EditorState, bookmark: SelectionBookmark, supportedBlockNodes?: string[]) => DraftBookmark;
 /**
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
@@ -30,6 +35,7 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
 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,8 +6,8 @@ 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, _supportedNodes?: string[]) => Command;
-export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => 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) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;

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

@@ -1,6 +1,7 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { Dispatch, EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { PortalProviderAPI } from '@atlaskit/editor-common/portal-provider';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
 import type { EditorState, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { AnnotationInfo, InlineCommentAnnotationProvider, TargetType } from '../types';
@@ -20,6 +21,7 @@ export interface InlineCommentPluginOptions {
     portalProviderAPI: PortalProviderAPI;
     provider: InlineCommentAnnotationProvider;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    featureFlagsPluginState?: FeatureFlags;
 }
 export interface InlineCommentMouseData {
     isSelecting: boolean;
@@ -36,6 +38,8 @@ export type InlineCommentAction = {
         drafting: boolean;
         editorState: EditorState;
         targetType?: TargetType;
+        isCommentOnMediaOn?: boolean;
+        supportedBlockNodes?: string[];
     };
 } | {
     type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
@@ -76,4 +80,5 @@ export type InlineCommentPluginState = {
     isInlineCommentViewClosed: boolean;
     isVisible: boolean;
     skipSelectionHandling: boolean;
+    featureFlagsPluginState?: FeatureFlags;
 };

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

@@ -129,4 +129,9 @@ export type CoordsAtPos = {
     left: number;
     right: number;
 };
+export type DraftBookmark = {
+    from: number;
+    to: number;
+    head: number;
+};
 export {};

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

@@ -1,11 +1,11 @@
 import type { AnalyticsEventPayloadCallback } from '@atlaskit/editor-common/analytics';
 import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
 import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState, Selection, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginState } from './pm-plugins/types';
-import type { AnnotationInfo, InlineCommentInputMethod, TargetType } from './types';
+import type { AnnotationInfo, DraftBookmark, InlineCommentInputMethod, TargetType } from './types';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
 /**
@@ -14,9 +14,14 @@ export { hasAnnotationMark, containsAnyAnnotations };
  */
 export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
 export declare const getAllAnnotations: (doc: Node) => string[];
+export declare const decorationKey: {
+    block: string;
+    inline: string;
+};
 export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+export declare const resolveDraftBookmark: (editorState: EditorState, bookmark: SelectionBookmark, supportedBlockNodes?: string[]) => DraftBookmark;
 /**
  * get selection from position to apply new comment for
  * @return bookmarked positions if they exists, otherwise current selection positions
@@ -30,6 +35,7 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
 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