@atlaskit/editor-plugin-annotation 0.2.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-annotation
 
+## 0.3.1
+
+### Patch Changes
+
+- [#70084](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/70084) [`4d651eb93ab5`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4d651eb93ab5) - Add editor-plugin-annotation pr and create shared utils for it in editor-test-helpers
+- Updated dependencies
+
+## 0.3.0
+
+### Minor Changes
+
+- [#69617](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69617) [`93f297b73c6f`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/93f297b73c6f) - [ux] When in editor view mode, creating new comment with annotations plugin will send step to NCS provider
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/cjs/commands/index.js

@@ -8,11 +8,12 @@ exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.se
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
+var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _pluginFactory = require("../pm-plugins/plugin-factory");
 var _types = require("../pm-plugins/types");
 var _types2 = require("../types");
 var _utils = require("../utils");
-var _transform = _interopRequireDefault(require("./transform"));
+var _transform2 = _interopRequireDefault(require("./transform"));
 var updateInlineCommentResolvedState = exports.updateInlineCommentResolvedState = function updateInlineCommentResolvedState(editorAnalyticsAPI) {
   return function (partialNewState, resolveMethod) {
     var command = {
@@ -23,7 +24,7 @@ var updateInlineCommentResolvedState = exports.updateInlineCommentResolvedState
       return state;
     });
     if (resolveMethod && allResolved) {
-      return (0, _pluginFactory.createCommand)(command, _transform.default.addResolveAnalytics(editorAnalyticsAPI)(resolveMethod));
+      return (0, _pluginFactory.createCommand)(command, _transform2.default.addResolveAnalytics(editorAnalyticsAPI)(resolveMethod));
     }
     return (0, _pluginFactory.createCommand)(command);
   };
@@ -80,7 +81,7 @@ var setInlineCommentDraftState = exports.setInlineCommentDraftState = function s
   return function (drafting) {
     var inputMethod = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _analytics.INPUT_METHOD.TOOLBAR;
     var commandAction = getDraftCommandAction(drafting);
-    return (0, _pluginFactory.createCommand)(commandAction, _transform.default.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
+    return (0, _pluginFactory.createCommand)(commandAction, _transform2.default.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
   };
 };
 var addInlineComment = exports.addInlineComment = function addInlineComment(editorAnalyticsAPI) {
@@ -101,7 +102,7 @@ var addInlineComment = exports.addInlineComment = function addInlineComment(edit
         }
       };
     };
-    return (0, _pluginFactory.createCommand)(commandAction, _transform.default.addInlineComment(editorAnalyticsAPI)(id));
+    return (0, _pluginFactory.createCommand)(commandAction, _transform2.default.addInlineComment(editorAnalyticsAPI)(id));
   };
 };
 var updateMouseState = exports.updateMouseState = function updateMouseState(mouseData) {
@@ -123,16 +124,40 @@ var setSelectedAnnotation = exports.setSelectedAnnotation = function setSelected
     }
   });
 };
-var createAnnotation = exports.createAnnotation = function createAnnotation(editorAnalyticsAPI) {
+var getAddAnnotationMarkStep = function getAddAnnotationMarkStep(id) {
+  return function (state) {
+    var inlineCommentState = (0, _utils.getPluginState)(state);
+    var _getSelectionPosition = (0, _utils.getSelectionPositions)(state, inlineCommentState),
+      from = _getSelectionPosition.from,
+      to = _getSelectionPosition.to;
+    return new _transform.AddMarkStep(Math.min(from, to), Math.max(from, to), state.schema.marks.annotation.create({
+      id: id,
+      annotationType: _adfSchema.AnnotationTypes.INLINE_COMMENT
+    }));
+  };
+};
+var createAnnotation = exports.createAnnotation = function createAnnotation(editorAnalyticsAPI, editorAPI) {
   return function (id) {
     var annotationType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _adfSchema.AnnotationTypes.INLINE_COMMENT;
     return function (state, dispatch) {
+      var _editorAPI$editorView;
       // don't try to add if there are is no temp highlight bookmarked
       var _ref = (0, _utils.getPluginState)(state) || {},
         bookmark = _ref.bookmark;
       if (!bookmark || !dispatch) {
         return false;
       }
+
+      // TODO MODES-3951 Refactor this to send new ViewModeStep
+      // When in view mode, user is not able to add comments through normal way when communicating with NCS.
+      // Therefore we make an explicit API call to NCS with the appropriate step that adds their new inline comment into the ADF.
+      if ((editorAPI === null || editorAPI === void 0 || (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 || (_editorAPI$editorView = _editorAPI$editorView.sharedState) === null || _editorAPI$editorView === void 0 || (_editorAPI$editorView = _editorAPI$editorView.currentState()) === null || _editorAPI$editorView === void 0 ? void 0 : _editorAPI$editorView.mode) === 'view') {
+        var _provider$api;
+        var commentMark = getAddAnnotationMarkStep(id)(state);
+        // @ts-ignore
+        var provider = state === null || state === void 0 ? void 0 : state.nativeCollabProviderPlugin$;
+        provider === null || provider === void 0 || (_provider$api = provider.api) === null || _provider$api === void 0 || _provider$api.addComment([commentMark]);
+      }
       if (annotationType === _adfSchema.AnnotationTypes.INLINE_COMMENT) {
         return addInlineComment(editorAnalyticsAPI)(id)(state, dispatch);
       }

package/dist/cjs/plugin.js

@@ -127,6 +127,7 @@ function AnnotationContentComponent(_ref4) {
     providers: annotationProviders,
     editorView: editorView,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions
+    editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions,
+    editorAPI: api
   }));
 }

package/dist/cjs/toolbar.js

@@ -36,8 +36,10 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
       title: createCommentMessage,
       onClick: function onClick(state, dispatch) {
         return (0, _commands.setInlineCommentDraftState)(editorAnalyticsAPI)(true)(state, dispatch);
-      }
+      },
+      supportsViewMode: true // TODO: MODES-3950 Clean up this floating toolbar view mode logic
     };
+
     var annotation = schema.marks.annotation;
     var validNodes = Object.keys(schema.nodes).reduce(function (acc, current) {
       var type = schema.nodes[current];

package/dist/cjs/ui/InlineCommentView.js

@@ -34,6 +34,7 @@ function InlineCommentView(_ref) {
   var providers = _ref.providers,
     editorView = _ref.editorView,
     editorAnalyticsAPI = _ref.editorAnalyticsAPI,
+    editorAPI = _ref.editorAPI,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent;
   // As inlineComment is the only annotation present, this function is not generic
   var inlineCommentProvider = providers.inlineComment;
@@ -91,7 +92,7 @@ function InlineCommentView(_ref) {
       dom: dom,
       textSelection: textSelection,
       onCreate: function onCreate(id) {
-        (0, _commands.createAnnotation)(editorAnalyticsAPI)(id)(editorView.state, editorView.dispatch);
+        (0, _commands.createAnnotation)(editorAnalyticsAPI, editorAPI)(id)(editorView.state, editorView.dispatch);
         !editorView.hasFocus() && editorView.focus();
       },
       onClose: function onClose() {

package/dist/es2019/commands/index.js

@@ -1,9 +1,10 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { AnnotationSelectionType } from '../types';
-import { getPluginState, isSelectionValid } from '../utils';
+import { getPluginState, getSelectionPositions, isSelectionValid } from '../utils';
 import transform from './transform';
 export const updateInlineCommentResolvedState = editorAnalyticsAPI => (partialNewState, resolveMethod) => {
   const command = {
@@ -100,7 +101,19 @@ export const setSelectedAnnotation = id => createCommand({
     }]
   }
 });
-export const createAnnotation = editorAnalyticsAPI => (id, annotationType = AnnotationTypes.INLINE_COMMENT) => (state, dispatch) => {
+const getAddAnnotationMarkStep = id => state => {
+  const inlineCommentState = getPluginState(state);
+  const {
+    from,
+    to
+  } = getSelectionPositions(state, inlineCommentState);
+  return new AddMarkStep(Math.min(from, to), Math.max(from, to), state.schema.marks.annotation.create({
+    id,
+    annotationType: AnnotationTypes.INLINE_COMMENT
+  }));
+};
+export const createAnnotation = (editorAnalyticsAPI, editorAPI) => (id, annotationType = AnnotationTypes.INLINE_COMMENT) => (state, dispatch) => {
+  var _editorAPI$editorView, _editorAPI$editorView2, _editorAPI$editorView3;
   // don't try to add if there are is no temp highlight bookmarked
   const {
     bookmark
@@ -108,6 +121,17 @@ export const createAnnotation = editorAnalyticsAPI => (id, annotationType = Anno
   if (!bookmark || !dispatch) {
     return false;
   }
+
+  // TODO MODES-3951 Refactor this to send new ViewModeStep
+  // When in view mode, user is not able to add comments through normal way when communicating with NCS.
+  // Therefore we make an explicit API call to NCS with the appropriate step that adds their new inline comment into the ADF.
+  if ((editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 ? void 0 : (_editorAPI$editorView2 = _editorAPI$editorView.sharedState) === null || _editorAPI$editorView2 === void 0 ? void 0 : (_editorAPI$editorView3 = _editorAPI$editorView2.currentState()) === null || _editorAPI$editorView3 === void 0 ? void 0 : _editorAPI$editorView3.mode) === 'view') {
+    var _provider$api;
+    const commentMark = getAddAnnotationMarkStep(id)(state);
+    // @ts-ignore
+    const provider = state === null || state === void 0 ? void 0 : state.nativeCollabProviderPlugin$;
+    provider === null || provider === void 0 ? void 0 : (_provider$api = provider.api) === null || _provider$api === void 0 ? void 0 : _provider$api.addComment([commentMark]);
+  }
   if (annotationType === AnnotationTypes.INLINE_COMMENT) {
     return addInlineComment(editorAnalyticsAPI)(id)(state, dispatch);
   }

package/dist/es2019/plugin.js

@@ -121,7 +121,8 @@ function AnnotationContentComponent({
     providers: annotationProviders,
     editorView: editorView,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    editorAnalyticsAPI: api === null || api === void 0 ? void 0 : (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions
+    editorAnalyticsAPI: api === null || api === void 0 ? void 0 : (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions,
+    editorAPI: api
   }));
 }
 export { AnnotationUpdateEmitter };

package/dist/es2019/toolbar.js

@@ -29,8 +29,10 @@ export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove =
     title: createCommentMessage,
     onClick: (state, dispatch) => {
       return setInlineCommentDraftState(editorAnalyticsAPI)(true)(state, dispatch);
-    }
+    },
+    supportsViewMode: true // TODO: MODES-3950 Clean up this floating toolbar view mode logic
   };
+
   const {
     annotation
   } = schema.marks;

package/dist/es2019/ui/InlineCommentView.js

@@ -26,6 +26,7 @@ export function InlineCommentView({
   providers,
   editorView,
   editorAnalyticsAPI,
+  editorAPI,
   dispatchAnalyticsEvent
 }) {
   // As inlineComment is the only annotation present, this function is not generic
@@ -91,7 +92,7 @@ export function InlineCommentView({
       dom: dom,
       textSelection: textSelection,
       onCreate: id => {
-        createAnnotation(editorAnalyticsAPI)(id)(editorView.state, editorView.dispatch);
+        createAnnotation(editorAnalyticsAPI, editorAPI)(id)(editorView.state, editorView.dispatch);
         !editorView.hasFocus() && editorView.focus();
       },
       onClose: () => {

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 { AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { createCommand } from '../pm-plugins/plugin-factory';
 import { ACTIONS } from '../pm-plugins/types';
 import { AnnotationSelectionType } from '../types';
-import { getPluginState, isSelectionValid } from '../utils';
+import { getPluginState, getSelectionPositions, isSelectionValid } from '../utils';
 import transform from './transform';
 export var updateInlineCommentResolvedState = function updateInlineCommentResolvedState(editorAnalyticsAPI) {
   return function (partialNewState, resolveMethod) {
@@ -116,16 +117,40 @@ export var setSelectedAnnotation = function setSelectedAnnotation(id) {
     }
   });
 };
-export var createAnnotation = function createAnnotation(editorAnalyticsAPI) {
+var getAddAnnotationMarkStep = function getAddAnnotationMarkStep(id) {
+  return function (state) {
+    var inlineCommentState = getPluginState(state);
+    var _getSelectionPosition = getSelectionPositions(state, inlineCommentState),
+      from = _getSelectionPosition.from,
+      to = _getSelectionPosition.to;
+    return new AddMarkStep(Math.min(from, to), Math.max(from, to), state.schema.marks.annotation.create({
+      id: id,
+      annotationType: AnnotationTypes.INLINE_COMMENT
+    }));
+  };
+};
+export var createAnnotation = function createAnnotation(editorAnalyticsAPI, editorAPI) {
   return function (id) {
     var annotationType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : AnnotationTypes.INLINE_COMMENT;
     return function (state, dispatch) {
+      var _editorAPI$editorView;
       // don't try to add if there are is no temp highlight bookmarked
       var _ref = getPluginState(state) || {},
         bookmark = _ref.bookmark;
       if (!bookmark || !dispatch) {
         return false;
       }
+
+      // TODO MODES-3951 Refactor this to send new ViewModeStep
+      // When in view mode, user is not able to add comments through normal way when communicating with NCS.
+      // Therefore we make an explicit API call to NCS with the appropriate step that adds their new inline comment into the ADF.
+      if ((editorAPI === null || editorAPI === void 0 || (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 || (_editorAPI$editorView = _editorAPI$editorView.sharedState) === null || _editorAPI$editorView === void 0 || (_editorAPI$editorView = _editorAPI$editorView.currentState()) === null || _editorAPI$editorView === void 0 ? void 0 : _editorAPI$editorView.mode) === 'view') {
+        var _provider$api;
+        var commentMark = getAddAnnotationMarkStep(id)(state);
+        // @ts-ignore
+        var provider = state === null || state === void 0 ? void 0 : state.nativeCollabProviderPlugin$;
+        provider === null || provider === void 0 || (_provider$api = provider.api) === null || _provider$api === void 0 || _provider$api.addComment([commentMark]);
+      }
       if (annotationType === AnnotationTypes.INLINE_COMMENT) {
         return addInlineComment(editorAnalyticsAPI)(id)(state, dispatch);
       }

package/dist/esm/plugin.js

@@ -114,7 +114,8 @@ function AnnotationContentComponent(_ref4) {
     providers: annotationProviders,
     editorView: editorView,
     dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions
+    editorAnalyticsAPI: api === null || api === void 0 || (_api$analytics5 = api.analytics) === null || _api$analytics5 === void 0 ? void 0 : _api$analytics5.actions,
+    editorAPI: api
   }));
 }
 export { AnnotationUpdateEmitter };

package/dist/esm/toolbar.js

@@ -29,8 +29,10 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
       title: createCommentMessage,
       onClick: function onClick(state, dispatch) {
         return setInlineCommentDraftState(editorAnalyticsAPI)(true)(state, dispatch);
-      }
+      },
+      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/InlineCommentView.js

@@ -27,6 +27,7 @@ export function InlineCommentView(_ref) {
   var providers = _ref.providers,
     editorView = _ref.editorView,
     editorAnalyticsAPI = _ref.editorAnalyticsAPI,
+    editorAPI = _ref.editorAPI,
     dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent;
   // As inlineComment is the only annotation present, this function is not generic
   var inlineCommentProvider = providers.inlineComment;
@@ -84,7 +85,7 @@ export function InlineCommentView(_ref) {
       dom: dom,
       textSelection: textSelection,
       onCreate: function onCreate(id) {
-        createAnnotation(editorAnalyticsAPI)(id)(editorView.state, editorView.dispatch);
+        createAnnotation(editorAnalyticsAPI, editorAPI)(id)(editorView.state, editorView.dispatch);
         !editorView.hasFocus() && editorView.focus();
       },
       onClose: function onClose() {

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

@@ -1,8 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command } from '@atlaskit/editor-common/types';
+import type { Command, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
+import type { AnnotationPlugin } 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;
@@ -11,5 +12,5 @@ export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnal
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;
-export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
+export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
 export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

package/dist/types/types.d.ts

@@ -3,6 +3,7 @@ import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { InlineCommentPluginState } from './pm-plugins/types';
@@ -10,7 +11,10 @@ type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     pluginConfiguration: AnnotationProviders | undefined;
     sharedState: InlineCommentPluginState | undefined;
-    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
+    ];
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;
     };

package/dist/types/ui/InlineCommentView.d.ts

@@ -1,12 +1,14 @@
 /// <reference types="react" />
 import type { DispatchAnalyticsEvent, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { AnnotationProviders } from '../types';
+import type { AnnotationPlugin, AnnotationProviders } from '../types';
 interface InlineCommentViewProps {
     providers: AnnotationProviders;
     editorView: EditorView;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    editorAPI: ExtractInjectionAPI<AnnotationPlugin> | undefined;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
 }
-export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
+export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, editorAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
 export {};

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

@@ -1,8 +1,9 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command } from '@atlaskit/editor-common/types';
+import type { Command, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
+import type { AnnotationPlugin } 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;
@@ -11,5 +12,5 @@ export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnal
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;
-export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
+export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
 export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

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

@@ -3,6 +3,7 @@ import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
 import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { InlineCommentPluginState } from './pm-plugins/types';
@@ -11,7 +12,8 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     pluginConfiguration: AnnotationProviders | undefined;
     sharedState: InlineCommentPluginState | undefined;
     dependencies: [
-        OptionalPlugin<AnalyticsPlugin>
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
     ];
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;

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

@@ -1,12 +1,14 @@
 /// <reference types="react" />
 import type { DispatchAnalyticsEvent, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { AnnotationProviders } from '../types';
+import type { AnnotationPlugin, AnnotationProviders } from '../types';
 interface InlineCommentViewProps {
     providers: AnnotationProviders;
     editorView: EditorView;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    editorAPI: ExtractInjectionAPI<AnnotationPlugin> | undefined;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
 }
-export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
+export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, editorAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -33,8 +33,9 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^35.3.0",
-    "@atlaskit/editor-common": "^77.1.0",
+    "@atlaskit/editor-common": "^77.2.0",
     "@atlaskit/editor-plugin-analytics": "^0.4.0",
+    "@atlaskit/editor-plugin-editor-viewmode": "^0.1.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/icon": "^22.0.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",