@atlaskit/editor-plugin-annotation 28.0.0 → 28.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-annotation
 
+## 28.1.0
+
+### Minor Changes
+
+- [`0dacb94545d03`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0dacb94545d03) -
+  Behind cc_maui_annotations_on_extensions: fire the cc_maui_comments_on_charts_exp exposure only
+  where the chart Comment button can show. Adds an optional viewModeEditorToolbarItems UiConfig
+  hook, used by MAUI charts to show Comment in the view-mode toolbar (live pages), and a
+  getAddCommentPermission annotation plugin action, used to disable the chart Comment button without
+  comment permission. The full-page renderer checks extension comment creation on first hover or
+  focus instead of while rendering.
+- [`98f39b65e08a9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/98f39b65e08a9) -
+  Track new Remix inline comment drafts through the configured creation experience under
+  cc_maui_annotations_on_extensions.
+
 ## 28.0.0
 
 ### Minor Changes

package/dist/cjs/annotationPlugin.js

@@ -97,6 +97,13 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
         var _annotationProviders$, _annotationProviders$2;
         return (0, _fg.fg)('cc_maui_annotations_on_extensions') && (annotationProviders === null || annotationProviders === void 0 || (_annotationProviders$ = (_annotationProviders$2 = annotationProviders.inlineComment).isBlockNodeSupported) === null || _annotationProviders$ === void 0 ? void 0 : _annotationProviders$.call(_annotationProviders$2, node)) === true;
       },
+      getAddCommentPermission: function getAddCommentPermission() {
+        var _annotationProviders$3, _annotationProviders$4, _annotationProviders$5;
+        return {
+          canAddComments: (_annotationProviders$3 = annotationProviders === null || annotationProviders === void 0 || (_annotationProviders$4 = (_annotationProviders$5 = annotationProviders.inlineComment).getCanAddComments) === null || _annotationProviders$4 === void 0 ? void 0 : _annotationProviders$4.call(_annotationProviders$5)) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : true,
+          contentType: annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.contentType
+        };
+      },
       hasAnyUnResolvedAnnotationInPage: _utils.hasAnyUnResolvedAnnotationInPage,
       requestCloseInlineComment: requestCloseInlineComment,
       stripNonExistingAnnotations: _utils.stripNonExistingAnnotations,
@@ -105,10 +112,10 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
         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$3;
-        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$3 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
+        var _api$analytics2, _annotationProviders$6;
+        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$6 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$6 !== void 0 ? _annotationProviders$6 : [], 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),
+      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, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.createCommentExperience),
       showCommentForBlockNode: (0, _editorCommands.showInlineCommentForBlockNode)(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       setSelectedAnnotation: _editorCommands.setSelectedAnnotation,
       setPendingSelectedAnnotation: _editorCommands.setPendingSelectedAnnotation
@@ -175,11 +182,11 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
         var pluginState = (0, _utils.getPluginState)(state);
         if (pluginState && pluginState.isVisible && !pluginState.bookmark && !pluginState.mouseData.isSelecting) {
           var _api$analytics5;
-          var _annotationProviders$4 = annotationProviders.inlineComment,
-            isToolbarAbove = _annotationProviders$4.isToolbarAbove,
-            onCommentButtonMount = _annotationProviders$4.onCommentButtonMount,
-            getCanAddComments = _annotationProviders$4.getCanAddComments,
-            contentType = _annotationProviders$4.contentType;
+          var _annotationProviders$7 = annotationProviders.inlineComment,
+            isToolbarAbove = _annotationProviders$7.isToolbarAbove,
+            onCommentButtonMount = _annotationProviders$7.onCommentButtonMount,
+            getCanAddComments = _annotationProviders$7.getCanAddComments,
+            contentType = _annotationProviders$7.contentType;
           var toolbarConfig = (0, _toolbar.buildToolbar)(api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions)({
             state: state,
             intl: intl,

package/dist/cjs/editor-commands/index.js

@@ -9,7 +9,9 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _annotation = require("@atlaskit/adf-schema/annotation");
 var _enums = require("@atlaskit/editor-common/analytics/types/enums");
 var _inlineCommentEvents = require("@atlaskit/editor-common/analytics/types/inline-comment-events");
+var _manifestHelpers = require("@atlaskit/editor-common/extensions/manifest-helpers");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _pluginFactory = require("../pm-plugins/plugin-factory");
 var _types = require("../pm-plugins/types");
 var _utils = require("../pm-plugins/utils");
@@ -250,16 +252,35 @@ var setInlineCommentDraftState = exports.setInlineCommentDraftState = function s
   var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   var api = arguments.length > 2 ? arguments[2] : undefined;
   var isBlockNodeSupported = arguments.length > 3 ? arguments[3] : undefined;
+  var createCommentExperience = arguments.length > 4 ? arguments[4] : undefined;
   return function (drafting) {
     var inputMethod = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _enums.INPUT_METHOD.TOOLBAR;
     var targetType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'inline';
     var targetNodeId = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : undefined;
     var isOpeningMediaCommentFromToolbar = arguments.length > 4 ? arguments[4] : undefined;
     var commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, supportedBlockNodes, isBlockNodeSupported, isOpeningMediaCommentFromToolbar);
-    if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
-      return function (state, dispatch) {
-        var tr = _transform.default.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
+    var draftCommand = !(api !== null && api !== void 0 && api.toolbar) ? (0, _pluginFactory.createCommand)(commandAction, _transform.default.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)) : undefined;
+    return function (state, dispatch, view) {
+      // Start tracking only when a valid draft is dispatched, never during dry runs.
+      var dispatchDraft = dispatch && drafting && targetType === 'block' && state.selection instanceof _state.NodeSelection && state.selection.node.type.name === 'extension' && state.selection.node.attrs.extensionKey === "".concat(_manifestHelpers.NATIVE_EMBED_EXTENSION_KEY, ":maui") && (0, _fg.fg)('cc_maui_annotations_on_extensions') ? function (tr) {
+        createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
+          attributes: {
+            pageClass: 'editor',
+            commentType: 'block',
+            blockType: 'extension',
+            commentTargetType: 'remixEmbed',
+            entryPoint: 'highlightActions'
+          }
+        });
+        createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
+        dispatch(tr);
+      } : dispatch;
+      if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
         var newPluginState = commandAction(state);
+        if (!newPluginState) {
+          return false;
+        }
+        var tr = _transform.default.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
         if (tr && newPluginState) {
           tr.setMeta(_utils.inlineCommentPluginKey, newPluginState);
           if (drafting) {
@@ -267,17 +288,16 @@ var setInlineCommentDraftState = exports.setInlineCommentDraftState = function s
           } else {
             (0, _utils2.resetUserIntent)(api, tr);
           }
-          if (dispatch) {
-            dispatch(tr);
+          if (dispatchDraft) {
+            dispatchDraft(tr);
           }
         } else {
           return false;
         }
         return true;
-      };
-    } else {
-      return (0, _pluginFactory.createCommand)(commandAction, _transform.default.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
-    }
+      }
+      return draftCommand ? draftCommand(state, dispatchDraft, view) : false;
+    };
   };
 };
 var addInlineComment = exports.addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {

package/dist/es2019/annotationPlugin.js

@@ -65,6 +65,13 @@ export const annotationPlugin = ({
         var _annotationProviders$, _annotationProviders$2;
         return fg('cc_maui_annotations_on_extensions') && (annotationProviders === null || annotationProviders === void 0 ? void 0 : (_annotationProviders$ = (_annotationProviders$2 = annotationProviders.inlineComment).isBlockNodeSupported) === null || _annotationProviders$ === void 0 ? void 0 : _annotationProviders$.call(_annotationProviders$2, node)) === true;
       },
+      getAddCommentPermission: () => {
+        var _annotationProviders$3, _annotationProviders$4, _annotationProviders$5;
+        return {
+          canAddComments: (_annotationProviders$3 = annotationProviders === null || annotationProviders === void 0 ? void 0 : (_annotationProviders$4 = (_annotationProviders$5 = annotationProviders.inlineComment).getCanAddComments) === null || _annotationProviders$4 === void 0 ? void 0 : _annotationProviders$4.call(_annotationProviders$5)) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : true,
+          contentType: annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.contentType
+        };
+      },
       hasAnyUnResolvedAnnotationInPage,
       requestCloseInlineComment,
       stripNonExistingAnnotations,
@@ -73,10 +80,10 @@ export const annotationPlugin = ({
         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$3;
-        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$3 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
+        var _api$analytics2, _annotationProviders$6;
+        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$6 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$6 !== void 0 ? _annotationProviders$6 : [], 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),
+      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, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.createCommentExperience),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       setSelectedAnnotation,
       setPendingSelectedAnnotation

package/dist/es2019/editor-commands/index.js

@@ -3,7 +3,9 @@ import { AnnotationTypes } from '@atlaskit/adf-schema/annotation';
 
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics/types/enums';
 import { RESOLVE_METHOD } from '@atlaskit/editor-common/analytics/types/inline-comment-events';
+import { NATIVE_EMBED_EXTENSION_KEY } from '@atlaskit/editor-common/extensions/manifest-helpers';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { getPluginState, inlineCommentPluginKey, isSelectionValid, isSupportedBlockNode } from '../pm-plugins/utils';
@@ -204,12 +206,30 @@ export const showInlineCommentForBlockNode = (supportedBlockNodes = [], isBlockN
   }
   return false;
 };
-export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNodes = [], api, isBlockNodeSupported) => (drafting, inputMethod = INPUT_METHOD.TOOLBAR, targetType = 'inline', targetNodeId = undefined, isOpeningMediaCommentFromToolbar) => {
+export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNodes = [], api, isBlockNodeSupported, createCommentExperience) => (drafting, inputMethod = INPUT_METHOD.TOOLBAR, targetType = 'inline', targetNodeId = undefined, isOpeningMediaCommentFromToolbar) => {
   const commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, supportedBlockNodes, isBlockNodeSupported, isOpeningMediaCommentFromToolbar);
-  if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
-    return (state, dispatch) => {
-      const tr = transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
+  const draftCommand = !(api !== null && api !== void 0 && api.toolbar) ? createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)) : undefined;
+  return (state, dispatch, view) => {
+    // Start tracking only when a valid draft is dispatched, never during dry runs.
+    const dispatchDraft = dispatch && drafting && targetType === 'block' && state.selection instanceof NodeSelection && state.selection.node.type.name === 'extension' && state.selection.node.attrs.extensionKey === `${NATIVE_EMBED_EXTENSION_KEY}:maui` && fg('cc_maui_annotations_on_extensions') ? tr => {
+      createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.start({
+        attributes: {
+          pageClass: 'editor',
+          commentType: 'block',
+          blockType: 'extension',
+          commentTargetType: 'remixEmbed',
+          entryPoint: 'highlightActions'
+        }
+      });
+      createCommentExperience === null || createCommentExperience === void 0 ? void 0 : createCommentExperience.initExperience.start();
+      dispatch(tr);
+    } : dispatch;
+    if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
       const newPluginState = commandAction(state);
+      if (!newPluginState) {
+        return false;
+      }
+      const tr = transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
       if (tr && newPluginState) {
         tr.setMeta(inlineCommentPluginKey, newPluginState);
         if (drafting) {
@@ -217,17 +237,16 @@ export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNod
         } else {
           resetUserIntent(api, tr);
         }
-        if (dispatch) {
-          dispatch(tr);
+        if (dispatchDraft) {
+          dispatchDraft(tr);
         }
       } else {
         return false;
       }
       return true;
-    };
-  } else {
-    return createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
-  }
+    }
+    return draftCommand ? draftCommand(state, dispatchDraft, view) : false;
+  };
 };
 export const addInlineComment = (editorAnalyticsAPI, editorAPI) => (id, supportedBlockNodes, isBlockNodeSupported) => {
   const commandAction = editorState => ({

package/dist/esm/annotationPlugin.js

@@ -90,6 +90,13 @@ export var annotationPlugin = function annotationPlugin(_ref) {
         var _annotationProviders$, _annotationProviders$2;
         return fg('cc_maui_annotations_on_extensions') && (annotationProviders === null || annotationProviders === void 0 || (_annotationProviders$ = (_annotationProviders$2 = annotationProviders.inlineComment).isBlockNodeSupported) === null || _annotationProviders$ === void 0 ? void 0 : _annotationProviders$.call(_annotationProviders$2, node)) === true;
       },
+      getAddCommentPermission: function getAddCommentPermission() {
+        var _annotationProviders$3, _annotationProviders$4, _annotationProviders$5;
+        return {
+          canAddComments: (_annotationProviders$3 = annotationProviders === null || annotationProviders === void 0 || (_annotationProviders$4 = (_annotationProviders$5 = annotationProviders.inlineComment).getCanAddComments) === null || _annotationProviders$4 === void 0 ? void 0 : _annotationProviders$4.call(_annotationProviders$5)) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : true,
+          contentType: annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.contentType
+        };
+      },
       hasAnyUnResolvedAnnotationInPage: hasAnyUnResolvedAnnotationInPage,
       requestCloseInlineComment: requestCloseInlineComment,
       stripNonExistingAnnotations: stripNonExistingAnnotations,
@@ -98,10 +105,10 @@ export var annotationPlugin = function annotationPlugin(_ref) {
         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$3;
-        return removeInlineCommentFromDoc(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$3 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$3 !== void 0 ? _annotationProviders$3 : [], annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported);
+        var _api$analytics2, _annotationProviders$6;
+        return removeInlineCommentFromDoc(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)(annotationId, (_annotationProviders$6 = annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes) !== null && _annotationProviders$6 !== void 0 ? _annotationProviders$6 : [], 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),
+      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, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.createCommentExperience),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.isBlockNodeSupported),
       setSelectedAnnotation: setSelectedAnnotation,
       setPendingSelectedAnnotation: setPendingSelectedAnnotation
@@ -168,11 +175,11 @@ export var annotationPlugin = function annotationPlugin(_ref) {
         var pluginState = getPluginState(state);
         if (pluginState && pluginState.isVisible && !pluginState.bookmark && !pluginState.mouseData.isSelecting) {
           var _api$analytics5;
-          var _annotationProviders$4 = annotationProviders.inlineComment,
-            isToolbarAbove = _annotationProviders$4.isToolbarAbove,
-            onCommentButtonMount = _annotationProviders$4.onCommentButtonMount,
-            getCanAddComments = _annotationProviders$4.getCanAddComments,
-            contentType = _annotationProviders$4.contentType;
+          var _annotationProviders$7 = annotationProviders.inlineComment,
+            isToolbarAbove = _annotationProviders$7.isToolbarAbove,
+            onCommentButtonMount = _annotationProviders$7.onCommentButtonMount,
+            getCanAddComments = _annotationProviders$7.getCanAddComments,
+            contentType = _annotationProviders$7.contentType;
           var toolbarConfig = buildToolbar(api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions)({
             state: state,
             intl: intl,

package/dist/esm/editor-commands/index.js

@@ -4,7 +4,9 @@ import { AnnotationTypes } from '@atlaskit/adf-schema/annotation';
 
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics/types/enums';
 import { RESOLVE_METHOD } from '@atlaskit/editor-common/analytics/types/inline-comment-events';
+import { NATIVE_EMBED_EXTENSION_KEY } from '@atlaskit/editor-common/extensions/manifest-helpers';
 import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { getPluginState, inlineCommentPluginKey, isSelectionValid, isSupportedBlockNode } from '../pm-plugins/utils';
@@ -243,16 +245,35 @@ export var setInlineCommentDraftState = function setInlineCommentDraftState(edit
   var supportedBlockNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   var api = arguments.length > 2 ? arguments[2] : undefined;
   var isBlockNodeSupported = arguments.length > 3 ? arguments[3] : undefined;
+  var createCommentExperience = arguments.length > 4 ? arguments[4] : undefined;
   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 targetNodeId = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : undefined;
     var isOpeningMediaCommentFromToolbar = arguments.length > 4 ? arguments[4] : undefined;
     var commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, supportedBlockNodes, isBlockNodeSupported, isOpeningMediaCommentFromToolbar);
-    if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
-      return function (state, dispatch) {
-        var tr = transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
+    var draftCommand = !(api !== null && api !== void 0 && api.toolbar) ? createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)) : undefined;
+    return function (state, dispatch, view) {
+      // Start tracking only when a valid draft is dispatched, never during dry runs.
+      var dispatchDraft = dispatch && drafting && targetType === 'block' && state.selection instanceof NodeSelection && state.selection.node.type.name === 'extension' && state.selection.node.attrs.extensionKey === "".concat(NATIVE_EMBED_EXTENSION_KEY, ":maui") && fg('cc_maui_annotations_on_extensions') ? function (tr) {
+        createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
+          attributes: {
+            pageClass: 'editor',
+            commentType: 'block',
+            blockType: 'extension',
+            commentTargetType: 'remixEmbed',
+            entryPoint: 'highlightActions'
+          }
+        });
+        createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
+        dispatch(tr);
+      } : dispatch;
+      if (Boolean(api === null || api === void 0 ? void 0 : api.toolbar)) {
         var newPluginState = commandAction(state);
+        if (!newPluginState) {
+          return false;
+        }
+        var tr = transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod)(state.tr, state);
         if (tr && newPluginState) {
           tr.setMeta(inlineCommentPluginKey, newPluginState);
           if (drafting) {
@@ -260,17 +281,16 @@ export var setInlineCommentDraftState = function setInlineCommentDraftState(edit
           } else {
             resetUserIntent(api, tr);
           }
-          if (dispatch) {
-            dispatch(tr);
+          if (dispatchDraft) {
+            dispatchDraft(tr);
           }
         } else {
           return false;
         }
         return true;
-      };
-    } else {
-      return createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
-    }
+      }
+      return draftCommand ? draftCommand(state, dispatchDraft, view) : false;
+    };
   };
 };
 export var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {

package/dist/types/annotationPluginType.d.ts

@@ -40,6 +40,15 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * @returns A command that returns true when the draft is applied.
          */
         applyInlineCommentDraft: (annotationId: string) => Command;
+        /**
+         * Whether the current user can add comments, from the provider's
+         * `getCanAddComments` (defaults to true), and the provider's content type
+         * for the no-permission message.
+         */
+        getAddCommentPermission: () => {
+            canAddComments: boolean;
+            contentType?: string;
+        };
         hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         /** Whether the configured provider supports block comments on this node. */
         isBlockNodeSupported: (node: Node) => boolean;

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

@@ -6,7 +6,7 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-edi
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
-import type { InlineCommentAnnotationProvider, InlineCommentInputMethod, TargetType } from '../types';
+import type { AnnotationProviders, InlineCommentAnnotationProvider, InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
@@ -22,7 +22,7 @@ export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnal
  * @example
  */
 export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => (node: PMNode | null, viewMethod?: VIEW_METHOD, isOpeningMediaCommentFromToolbar?: boolean) => Command;
-export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[], api?: ExtractInjectionAPI<AnnotationPlugin>, isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;
+export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[], api?: ExtractInjectionAPI<AnnotationPlugin>, isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported'], createCommentExperience?: AnnotationProviders['createCommentExperience']) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;

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

@@ -138,7 +138,8 @@ export interface AnnotationProviders {
                 pageClass: 'editor';
             } | {
                 annotationId?: undefined;
-                blockType: 'media';
+                blockType: 'media' | 'extension';
+                commentTargetType?: 'remixEmbed';
                 commentType: 'block';
                 entryPoint?: 'highlightActions';
                 pageClass: 'editor';

package/package.json

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