@atlaskit/editor-plugin-annotation 22.0.9 → 23.0.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-annotation
 
+## 23.0.1
+
+### Patch Changes
+
+- [`45cf8c5ab1b31`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/45cf8c5ab1b31) -
+  Enable gated comments on MAUI charts in the Confluence editor, including the editor draft flow for
+  native-embed extension nodes. With `cc_maui_annotations_on_extensions` enabled, eligible extension
+  block selections can start a draft even when whitespace-only text comments are disallowed. The
+  extension-only DOM anchor fallback also requires this gate; existing text/media and gate-off
+  anchor behavior is preserved. The native-embed toolbar uses the same gate for its block-comment
+  opening hint.
+- Updated dependencies
+
+## 23.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 22.0.9
 
 ### Patch Changes

package/dist/cjs/annotationPlugin.js

@@ -97,11 +97,11 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
       stripNonExistingAnnotations: _utils.stripNonExistingAnnotations,
       applyInlineCommentDraft: function applyInlineCommentDraft(annotationId) {
         var _api$analytics;
-        return (0, _editorCommands.createAnnotation)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, _annotation.AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes);
+        return (0, _editorCommands.createAnnotation)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, _annotation.AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       removeInlineCommentAnnotation: function removeInlineCommentAnnotation(annotationId) {
         var _api$analytics2, _annotationProviders$;
-        return (0, _editorCommands.removeInlineCommentFromDoc)(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : []);
+        return (0, _editorCommands.removeInlineCommentFromDoc)(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       setInlineCommentDraftState: (0, _editorCommands.setInlineCommentDraftState)(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, undefined, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       showCommentForBlockNode: (0, _editorCommands.showInlineCommentForBlockNode)(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),

package/dist/cjs/pm-plugins/utils.js

@@ -331,7 +331,11 @@ var isSelectionValid = exports.isSelectionValid = function isSelectionValid(stat
   if (containsInvalidNodes) {
     return _types.AnnotationSelectionType.DISABLED;
   }
-  if (disallowOnWhitespace && hasInvalidWhitespaceNode(selection, state.schema)) {
+
+  // Extension content lives outside the editor document, so an eligible whole-block
+  // selection must not be rejected for having no commentable text descendants.
+  var isSupportedExtensionSelection = (0, _fg.fg)('cc_maui_annotations_on_extensions') && isSupportedBlockNodeSelection && selection instanceof _state.NodeSelection && selection.node.type.name === 'extension';
+  if (disallowOnWhitespace && !isSupportedExtensionSelection && hasInvalidWhitespaceNode(selection, state.schema)) {
     return _types.AnnotationSelectionType.INVALID;
   }
   if (!(selection instanceof _state.NodeSelection) && (0, _utils.isEmptyTextSelection)(selection, state.schema)) {

package/dist/cjs/ui/InlineCommentView.js

@@ -13,7 +13,9 @@ var _hooks = require("@atlaskit/editor-common/hooks");
 var _useSharedPluginStateSelector = require("@atlaskit/editor-common/use-shared-plugin-state-selector");
 var _utils = require("@atlaskit/editor-common/utils");
 var _editorPluginConnectivity = require("@atlaskit/editor-plugin-connectivity");
+var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _editorCommands = require("../editor-commands");
 var _utils3 = require("../pm-plugins/utils");
 var _types = require("../types");
@@ -69,14 +71,36 @@ function InlineCommentView(_ref) {
   var annotationsList = (0, _utils3.getAllAnnotations)(editorView.state.doc);
   var selection = (0, _utils3.getSelectionPositions)(state, bookmark);
   var position = findPosForDOM(selection);
+  var isExtensionSelection = selection instanceof _state.NodeSelection && selection.node.type.name === 'extension';
   var dom;
+  var domLookupError;
   try {
-    // Ignored via go/ees005
-    // eslint-disable-next-line @atlaskit/editor/no-as-casting
-    dom = (0, _utils2.findDomRefAtPos)(position, editorView.domAtPos.bind(editorView));
+    var domRef = (0, _utils2.findDomRefAtPos)(position, editorView.domAtPos.bind(editorView));
+    if ((0, _fg.fg)('cc_maui_annotations_on_extensions') && isExtensionSelection) {
+      if (domRef instanceof HTMLElement) {
+        dom = domRef;
+      }
+    } else {
+      // Preserve the existing text/media and gate-off anchor lookup.
+      // eslint-disable-next-line @atlaskit/editor/no-as-casting
+      dom = domRef;
+    }
   } catch (error) {
+    domLookupError = error;
+  }
+
+  // Native embed extension nodes are rendered by a node view. Depending on
+  // the wrapper, domAtPos can return no element (or throw) even though
+  // EditorView.nodeDOM can. Use that direct lookup as a block-comment anchor.
+  if ((0, _fg.fg)('cc_maui_annotations_on_extensions') && !dom && isExtensionSelection) {
+    var nodeDom = editorView.nodeDOM(selection.from);
+    if (nodeDom instanceof HTMLElement) {
+      dom = nodeDom;
+    }
+  }
+  if (!dom && domLookupError) {
     // eslint-disable-next-line no-console
-    console.warn(error);
+    console.warn(domLookupError);
     if (dispatchAnalyticsEvent) {
       var payload = {
         action: _analytics.ACTION.ERRORED,
@@ -87,7 +111,7 @@ function InlineCommentView(_ref) {
           selection: selection.toJSON(),
           position: position,
           docSize: editorView.state.doc.nodeSize,
-          error: error.toString()
+          error: domLookupError.toString()
         }
       };
       dispatchAnalyticsEvent(payload);

package/dist/es2019/annotationPlugin.js

@@ -65,11 +65,11 @@ export const annotationPlugin = ({
       stripNonExistingAnnotations,
       applyInlineCommentDraft: annotationId => {
         var _api$analytics;
-        return createAnnotation(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes);
+        return createAnnotation(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       removeInlineCommentAnnotation: annotationId => {
         var _api$analytics2, _annotationProviders$;
-        return removeInlineCommentFromDoc(api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : []);
+        return removeInlineCommentFromDoc(api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 ? void 0 : (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, undefined, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),

package/dist/es2019/pm-plugins/utils.js

@@ -295,7 +295,11 @@ export const isSelectionValid = (state, supportedBlockNodes = [], isBlockNodeSup
   if (containsInvalidNodes) {
     return AnnotationSelectionType.DISABLED;
   }
-  if (disallowOnWhitespace && hasInvalidWhitespaceNode(selection, state.schema)) {
+
+  // Extension content lives outside the editor document, so an eligible whole-block
+  // selection must not be rejected for having no commentable text descendants.
+  const isSupportedExtensionSelection = fg('cc_maui_annotations_on_extensions') && isSupportedBlockNodeSelection && selection instanceof NodeSelection && selection.node.type.name === 'extension';
+  if (disallowOnWhitespace && !isSupportedExtensionSelection && hasInvalidWhitespaceNode(selection, state.schema)) {
     return AnnotationSelectionType.INVALID;
   }
   if (!(selection instanceof NodeSelection) && isEmptyTextSelection(selection, state.schema)) {

package/dist/es2019/ui/InlineCommentView.js

@@ -5,7 +5,9 @@ import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks'
 import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../editor-commands';
 import { getAllAnnotations, getAnnotationViewKey, getSelectionPositions } from '../pm-plugins/utils';
 import { AnnotationTestIds } from '../types';
@@ -69,14 +71,36 @@ export function InlineCommentView({
   const annotationsList = getAllAnnotations(editorView.state.doc);
   const selection = getSelectionPositions(state, bookmark);
   const position = findPosForDOM(selection);
+  const isExtensionSelection = selection instanceof NodeSelection && selection.node.type.name === 'extension';
   let dom;
+  let domLookupError;
   try {
-    // Ignored via go/ees005
-    // eslint-disable-next-line @atlaskit/editor/no-as-casting
-    dom = findDomRefAtPos(position, editorView.domAtPos.bind(editorView));
+    const domRef = findDomRefAtPos(position, editorView.domAtPos.bind(editorView));
+    if (fg('cc_maui_annotations_on_extensions') && isExtensionSelection) {
+      if (domRef instanceof HTMLElement) {
+        dom = domRef;
+      }
+    } else {
+      // Preserve the existing text/media and gate-off anchor lookup.
+      // eslint-disable-next-line @atlaskit/editor/no-as-casting
+      dom = domRef;
+    }
   } catch (error) {
+    domLookupError = error;
+  }
+
+  // Native embed extension nodes are rendered by a node view. Depending on
+  // the wrapper, domAtPos can return no element (or throw) even though
+  // EditorView.nodeDOM can. Use that direct lookup as a block-comment anchor.
+  if (fg('cc_maui_annotations_on_extensions') && !dom && isExtensionSelection) {
+    const nodeDom = editorView.nodeDOM(selection.from);
+    if (nodeDom instanceof HTMLElement) {
+      dom = nodeDom;
+    }
+  }
+  if (!dom && domLookupError) {
     // eslint-disable-next-line no-console
-    console.warn(error);
+    console.warn(domLookupError);
     if (dispatchAnalyticsEvent) {
       const payload = {
         action: ACTION.ERRORED,
@@ -87,7 +111,7 @@ export function InlineCommentView({
           selection: selection.toJSON(),
           position,
           docSize: editorView.state.doc.nodeSize,
-          error: error.toString()
+          error: domLookupError.toString()
         }
       };
       dispatchAnalyticsEvent(payload);

package/dist/esm/annotationPlugin.js

@@ -90,11 +90,11 @@ export var annotationPlugin = function annotationPlugin(_ref) {
       stripNonExistingAnnotations: stripNonExistingAnnotations,
       applyInlineCommentDraft: function applyInlineCommentDraft(annotationId) {
         var _api$analytics;
-        return createAnnotation(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes);
+        return createAnnotation(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, api)(annotationId, AnnotationTypes.INLINE_COMMENT, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       removeInlineCommentAnnotation: function removeInlineCommentAnnotation(annotationId) {
         var _api$analytics2, _annotationProviders$;
-        return removeInlineCommentFromDoc(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : []);
+        return removeInlineCommentFromDoc(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$ = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$ !== void 0 ? _annotationProviders$ : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
       },
       setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, undefined, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),

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

@@ -314,7 +314,11 @@ export var isSelectionValid = function isSelectionValid(state) {
   if (containsInvalidNodes) {
     return AnnotationSelectionType.DISABLED;
   }
-  if (disallowOnWhitespace && hasInvalidWhitespaceNode(selection, state.schema)) {
+
+  // Extension content lives outside the editor document, so an eligible whole-block
+  // selection must not be rejected for having no commentable text descendants.
+  var isSupportedExtensionSelection = fg('cc_maui_annotations_on_extensions') && isSupportedBlockNodeSelection && selection instanceof NodeSelection && selection.node.type.name === 'extension';
+  if (disallowOnWhitespace && !isSupportedExtensionSelection && hasInvalidWhitespaceNode(selection, state.schema)) {
     return AnnotationSelectionType.INVALID;
   }
   if (!(selection instanceof NodeSelection) && isEmptyTextSelection(selection, state.schema)) {

package/dist/esm/ui/InlineCommentView.js

@@ -6,7 +6,9 @@ import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks'
 import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
 import { getAnnotationInlineNodeTypes, getRangeInlineNodeNames } from '@atlaskit/editor-common/utils';
 import { isOfflineMode } from '@atlaskit/editor-plugin-connectivity';
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { closeComponent, createAnnotation, removeInlineCommentNearSelection, setInlineCommentDraftState, updateInlineCommentResolvedState } from '../editor-commands';
 import { getAllAnnotations, getAnnotationViewKey, getSelectionPositions } from '../pm-plugins/utils';
 import { AnnotationTestIds } from '../types';
@@ -62,14 +64,36 @@ export function InlineCommentView(_ref) {
   var annotationsList = getAllAnnotations(editorView.state.doc);
   var selection = getSelectionPositions(state, bookmark);
   var position = findPosForDOM(selection);
+  var isExtensionSelection = selection instanceof NodeSelection && selection.node.type.name === 'extension';
   var dom;
+  var domLookupError;
   try {
-    // Ignored via go/ees005
-    // eslint-disable-next-line @atlaskit/editor/no-as-casting
-    dom = findDomRefAtPos(position, editorView.domAtPos.bind(editorView));
+    var domRef = findDomRefAtPos(position, editorView.domAtPos.bind(editorView));
+    if (fg('cc_maui_annotations_on_extensions') && isExtensionSelection) {
+      if (domRef instanceof HTMLElement) {
+        dom = domRef;
+      }
+    } else {
+      // Preserve the existing text/media and gate-off anchor lookup.
+      // eslint-disable-next-line @atlaskit/editor/no-as-casting
+      dom = domRef;
+    }
   } catch (error) {
+    domLookupError = error;
+  }
+
+  // Native embed extension nodes are rendered by a node view. Depending on
+  // the wrapper, domAtPos can return no element (or throw) even though
+  // EditorView.nodeDOM can. Use that direct lookup as a block-comment anchor.
+  if (fg('cc_maui_annotations_on_extensions') && !dom && isExtensionSelection) {
+    var nodeDom = editorView.nodeDOM(selection.from);
+    if (nodeDom instanceof HTMLElement) {
+      dom = nodeDom;
+    }
+  }
+  if (!dom && domLookupError) {
     // eslint-disable-next-line no-console
-    console.warn(error);
+    console.warn(domLookupError);
     if (dispatchAnalyticsEvent) {
       var payload = {
         action: ACTION.ERRORED,
@@ -80,7 +104,7 @@ export function InlineCommentView(_ref) {
           selection: selection.toJSON(),
           position: position,
           docSize: editorView.state.doc.nodeSize,
-          error: error.toString()
+          error: domLookupError.toString()
         }
       };
       dispatchAnalyticsEvent(payload);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "22.0.9",
+	"version": "23.0.1",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,22 +20,22 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^57.6.0",
-		"@atlaskit/editor-plugin-analytics": "^22.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^22.0.0",
-		"@atlaskit/editor-plugin-editor-viewmode-effects": "^22.0.0",
-		"@atlaskit/editor-plugin-feature-flags": "^21.0.0",
-		"@atlaskit/editor-plugin-toolbar": "^19.0.0",
-		"@atlaskit/editor-plugin-user-intent": "^20.0.0",
+		"@atlaskit/editor-plugin-analytics": "^23.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^23.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode-effects": "^23.0.0",
+		"@atlaskit/editor-plugin-feature-flags": "^22.0.0",
+		"@atlaskit/editor-plugin-toolbar": "^20.0.0",
+		"@atlaskit/editor-plugin-user-intent": "^21.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@atlaskit/editor-toolbar": "^2.8.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
 		"@atlaskit/icon": "^38.0.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
-		"@atlaskit/tmp-editor-statsig": "^218.0.0",
+		"@atlaskit/tmp-editor-statsig": "^219.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^126.4.0",
+		"@atlaskit/editor-common": "^127.1.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"