@atlaskit/editor-plugin-annotation 1.10.0 → 1.10.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.10.1
+
+### Patch Changes
+
+- [#109969](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/109969)
+  [`52590a0b562ef`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/52590a0b562ef) -
+  ED-23690 Adds an attribute to annotation analytic events with the name of nodes inside the
+  annotation range
+- [#109932](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/109932)
+  [`a973fd903870a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a973fd903870a) -
+  ED-23649 fixes a variety of issues such as inline nodes not being fully interactive, and missing
+  selection visuals when inside an annotation.
+- Updated dependencies
+
 ## 1.10.0
 
 ### Minor Changes

package/dist/cjs/commands/transform.js

@@ -7,18 +7,20 @@ exports.default = void 0;
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _mark = require("@atlaskit/editor-common/mark");
+var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
-var _utils = require("../utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _utils2 = require("../utils");
 var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
   return function (transaction, state) {
-    var inlineCommentState = (0, _utils.getPluginState)(state);
+    var inlineCommentState = (0, _utils2.getPluginState)(state);
     var _ref = inlineCommentState || {},
       bookmark = _ref.bookmark;
     var annotationMark = state.schema.marks.annotation.create({
       id: id,
       type: _adfSchema.AnnotationTypes.INLINE_COMMENT
     });
-    var _resolveDraftBookmark = (0, _utils.resolveDraftBookmark)(state, bookmark, supportedBlockNodes),
+    var _resolveDraftBookmark = (0, _utils2.resolveDraftBookmark)(state, bookmark, supportedBlockNodes),
       from = _resolveDraftBookmark.from,
       to = _resolveDraftBookmark.to,
       head = _resolveDraftBookmark.head,
@@ -56,7 +58,7 @@ var addOpenCloseAnalytics = function addOpenCloseAnalytics(editorAnalyticsAPI) {
   return function (drafting) {
     var method = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _analytics.INPUT_METHOD.TOOLBAR;
     return function (transaction, state) {
-      var draftingPayload = (0, _utils.getDraftCommandAnalyticsPayload)(drafting, method)(state);
+      var draftingPayload = (0, _utils2.getDraftCommandAnalyticsPayload)(drafting, method)(state);
       editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(draftingPayload)(transaction);
       return transaction;
     };
@@ -64,13 +66,26 @@ var addOpenCloseAnalytics = function addOpenCloseAnalytics(editorAnalyticsAPI) {
 };
 var addInsertAnalytics = function addInsertAnalytics(editorAnalyticsAPI) {
   return function (transaction, state) {
-    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent({
+    var analyticsEvent = {
       action: _analytics.ACTION.INSERTED,
       actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
       eventType: _analytics.EVENT_TYPE.TRACK,
       actionSubjectId: _analytics.ACTION_SUBJECT_ID.INLINE_COMMENT,
       attributes: {}
-    })(transaction);
+    };
+    if ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+      var _ref2 = (0, _utils2.getPluginState)(state) || {},
+        bookmark = _ref2.bookmark;
+
+      // When this FF is removed we can move the analytics event creation inside of the
+      // attachAnalyticsEvent and get type inference for the attributes.
+      // @ts-ignore
+      analyticsEvent.attributes.inlineNodeNames = (0, _utils.getRangeInlineNodeNames)({
+        doc: state.doc,
+        pos: (0, _utils2.resolveDraftBookmark)(state, bookmark)
+      });
+    }
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
     return transaction;
   };
 };

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

@@ -12,6 +12,7 @@ var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _commands = require("../commands");
 var _nodeviews = require("../nodeviews");
 var _utils = require("../utils");
@@ -248,10 +249,25 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
                   key: _utils.decorationKey.block
                 }));
               } else {
-                focusDecorations.push(_view.Decoration.inline(pos, pos + node.nodeSize, {
-                  class: "".concat((0, _nodeviews.getAnnotationViewClassname)(isUnresolved, isSelected), " ").concat(isUnresolved),
-                  nodeName: 'span'
-                }));
+                if ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+                  if (node.isText) {
+                    focusDecorations.push(_view.Decoration.inline(pos, pos + node.nodeSize, {
+                      class: "".concat((0, _nodeviews.getAnnotationViewClassname)(isUnresolved, isSelected), " ").concat(isUnresolved),
+                      nodeName: 'span'
+                    }));
+                  } else {
+                    focusDecorations.push(_view.Decoration.node(pos, pos + node.nodeSize, {
+                      class: "".concat((0, _nodeviews.getAnnotationViewClassname)(isUnresolved, isSelected), " ").concat(isUnresolved)
+                    }, {
+                      key: _utils.decorationKey.block
+                    }));
+                  }
+                } else {
+                  focusDecorations.push(_view.Decoration.inline(pos, pos + node.nodeSize, {
+                    class: "".concat((0, _nodeviews.getAnnotationViewClassname)(isUnresolved, isSelected), " ").concat(isUnresolved),
+                    nodeName: 'span'
+                  }));
+                }
               }
             }
           });

package/dist/cjs/utils.js

@@ -289,6 +289,14 @@ var getDraftCommandAnalyticsPayload = exports.getDraftCommandAnalyticsPayload =
         overlap: getAnnotationsInSelectionCount(state)
       };
     }
+    if ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+      var _ref3 = getPluginState(state) || {},
+        bookmark = _ref3.bookmark;
+      attributes.inlineNodeNames = (0, _utils.getRangeInlineNodeNames)({
+        doc: state.doc,
+        pos: resolveDraftBookmark(state, bookmark)
+      });
+    }
     return {
       action: drafting ? _analytics.ACTION.OPENED : _analytics.ACTION.CLOSED,
       actionSubject: _analytics.ACTION_SUBJECT.ANNOTATION,
@@ -303,8 +311,8 @@ var isSelectionValid = exports.isSelectionValid = function isSelectionValid(stat
   var _currentMediaNodeWith;
   var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
-  var _ref3 = getPluginState(state) || {},
-    disallowOnWhitespace = _ref3.disallowOnWhitespace;
+  var _ref4 = getPluginState(state) || {},
+    disallowOnWhitespace = _ref4.disallowOnWhitespace;
 
   // Allow media so that it can enter draft mode
   if (isCommentOnMediaOn && (_currentMediaNodeWith = (0, _mediaSingle.currentMediaNodeWithPos)(state)) !== null && _currentMediaNodeWith !== void 0 && _currentMediaNodeWith.node) {

package/dist/es2019/commands/transform.js

@@ -1,7 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { applyMarkOnRange } from '@atlaskit/editor-common/mark';
+import { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { getDraftCommandAnalyticsPayload, getPluginState, resolveDraftBookmark } from '../utils';
 const addAnnotationMark = (id, supportedBlockNodes) => (transaction, state) => {
   const inlineCommentState = getPluginState(state);
@@ -48,13 +50,27 @@ const addOpenCloseAnalytics = editorAnalyticsAPI => (drafting, method = INPUT_ME
   return transaction;
 };
 const addInsertAnalytics = editorAnalyticsAPI => (transaction, state) => {
-  editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent({
+  const analyticsEvent = {
     action: ACTION.INSERTED,
     actionSubject: ACTION_SUBJECT.ANNOTATION,
     eventType: EVENT_TYPE.TRACK,
     actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
     attributes: {}
-  })(transaction);
+  };
+  if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+    const {
+      bookmark
+    } = getPluginState(state) || {};
+
+    // When this FF is removed we can move the analytics event creation inside of the
+    // attachAnalyticsEvent and get type inference for the attributes.
+    // @ts-ignore
+    analyticsEvent.attributes.inlineNodeNames = getRangeInlineNodeNames({
+      doc: state.doc,
+      pos: resolveDraftBookmark(state, bookmark)
+    });
+  }
+  editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
   return transaction;
 };
 const addResolveAnalytics = editorAnalyticsAPI => method => (transaction, state) => {

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

@@ -2,6 +2,7 @@ import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { clearDirtyMark, closeComponent, setInlineCommentsVisibility, setSelectedAnnotation, updateInlineCommentResolvedState, updateMouseState } from '../commands';
 import { AnnotationNodeView, getAnnotationViewClassname, getBlockAnnotationViewClassname } from '../nodeviews';
 import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey } from '../utils';
@@ -184,10 +185,25 @@ export const inlineCommentPlugin = options => {
                   key: decorationKey.block
                 }));
               } else {
-                focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
-                  class: `${getAnnotationViewClassname(isUnresolved, isSelected)} ${isUnresolved}`,
-                  nodeName: 'span'
-                }));
+                if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+                  if (node.isText) {
+                    focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
+                      class: `${getAnnotationViewClassname(isUnresolved, isSelected)} ${isUnresolved}`,
+                      nodeName: 'span'
+                    }));
+                  } else {
+                    focusDecorations.push(Decoration.node(pos, pos + node.nodeSize, {
+                      class: `${getAnnotationViewClassname(isUnresolved, isSelected)} ${isUnresolved}`
+                    }, {
+                      key: decorationKey.block
+                    }));
+                  }
+                } else {
+                  focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
+                    class: `${getAnnotationViewClassname(isUnresolved, isSelected)} ${isUnresolved}`,
+                    nodeName: 'span'
+                  }));
+                }
               }
             }
           });

package/dist/es2019/utils.js

@@ -2,7 +2,7 @@ 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, BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
-import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
+import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getRangeInlineNodeNames, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
 import { AllSelection, NodeSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
@@ -251,6 +251,15 @@ export const getDraftCommandAnalyticsPayload = (drafting, inputMethod) => {
         overlap: getAnnotationsInSelectionCount(state)
       };
     }
+    if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+      const {
+        bookmark
+      } = getPluginState(state) || {};
+      attributes.inlineNodeNames = getRangeInlineNodeNames({
+        doc: state.doc,
+        pos: resolveDraftBookmark(state, bookmark)
+      });
+    }
     return {
       action: drafting ? ACTION.OPENED : ACTION.CLOSED,
       actionSubject: ACTION_SUBJECT.ANNOTATION,

package/dist/esm/commands/transform.js

@@ -1,7 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { applyMarkOnRange } from '@atlaskit/editor-common/mark';
+import { getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { getDraftCommandAnalyticsPayload, getPluginState, resolveDraftBookmark } from '../utils';
 var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
   return function (transaction, state) {
@@ -58,13 +60,26 @@ var addOpenCloseAnalytics = function addOpenCloseAnalytics(editorAnalyticsAPI) {
 };
 var addInsertAnalytics = function addInsertAnalytics(editorAnalyticsAPI) {
   return function (transaction, state) {
-    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent({
+    var analyticsEvent = {
       action: ACTION.INSERTED,
       actionSubject: ACTION_SUBJECT.ANNOTATION,
       eventType: EVENT_TYPE.TRACK,
       actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
       attributes: {}
-    })(transaction);
+    };
+    if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+      var _ref2 = getPluginState(state) || {},
+        bookmark = _ref2.bookmark;
+
+      // When this FF is removed we can move the analytics event creation inside of the
+      // attachAnalyticsEvent and get type inference for the attributes.
+      // @ts-ignore
+      analyticsEvent.attributes.inlineNodeNames = getRangeInlineNodeNames({
+        doc: state.doc,
+        pos: resolveDraftBookmark(state, bookmark)
+      });
+    }
+    editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(analyticsEvent)(transaction);
     return transaction;
   };
 };

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

@@ -5,6 +5,7 @@ import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import { clearDirtyMark, closeComponent, setInlineCommentsVisibility, setSelectedAnnotation, updateInlineCommentResolvedState, updateMouseState } from '../commands';
 import { AnnotationNodeView, getAnnotationViewClassname, getBlockAnnotationViewClassname } from '../nodeviews';
 import { decorationKey, getAllAnnotations, getPluginState, inlineCommentPluginKey } from '../utils';
@@ -241,10 +242,25 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
                   key: decorationKey.block
                 }));
               } else {
-                focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
-                  class: "".concat(getAnnotationViewClassname(isUnresolved, isSelected), " ").concat(isUnresolved),
-                  nodeName: 'span'
-                }));
+                if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+                  if (node.isText) {
+                    focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
+                      class: "".concat(getAnnotationViewClassname(isUnresolved, isSelected), " ").concat(isUnresolved),
+                      nodeName: 'span'
+                    }));
+                  } else {
+                    focusDecorations.push(Decoration.node(pos, pos + node.nodeSize, {
+                      class: "".concat(getAnnotationViewClassname(isUnresolved, isSelected), " ").concat(isUnresolved)
+                    }, {
+                      key: decorationKey.block
+                    }));
+                  }
+                } else {
+                  focusDecorations.push(Decoration.inline(pos, pos + node.nodeSize, {
+                    class: "".concat(getAnnotationViewClassname(isUnresolved, isSelected), " ").concat(isUnresolved),
+                    nodeName: 'span'
+                  }));
+                }
               }
             }
           });

package/dist/esm/utils.js

@@ -2,7 +2,7 @@ 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, BlockAnnotationSharedClassNames } from '@atlaskit/editor-common/styles';
-import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
+import { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getRangeInlineNodeNames, hasAnnotationMark, isParagraph, isText } from '@atlaskit/editor-common/utils';
 import { AllSelection, NodeSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
@@ -262,6 +262,14 @@ export var getDraftCommandAnalyticsPayload = function getDraftCommandAnalyticsPa
         overlap: getAnnotationsInSelectionCount(state)
       };
     }
+    if (getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+      var _ref3 = getPluginState(state) || {},
+        bookmark = _ref3.bookmark;
+      attributes.inlineNodeNames = getRangeInlineNodeNames({
+        doc: state.doc,
+        pos: resolveDraftBookmark(state, bookmark)
+      });
+    }
     return {
       action: drafting ? ACTION.OPENED : ACTION.CLOSED,
       actionSubject: ACTION_SUBJECT.ANNOTATION,
@@ -276,8 +284,8 @@ export var isSelectionValid = function isSelectionValid(state, isCommentOnMediaO
   var _currentMediaNodeWith;
   var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
-  var _ref3 = getPluginState(state) || {},
-    disallowOnWhitespace = _ref3.disallowOnWhitespace;
+  var _ref4 = getPluginState(state) || {},
+    disallowOnWhitespace = _ref4.disallowOnWhitespace;
 
   // Allow media so that it can enter draft mode
   if (isCommentOnMediaOn && (_currentMediaNodeWith = currentMediaNodeWithPos(state)) !== null && _currentMediaNodeWith !== void 0 && _currentMediaNodeWith.node) {

package/package.json

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