@atlaskit/editor-core 187.20.1 → 187.21.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-core
 
+## 187.21.0
+
+### Minor Changes
+
+- [`560ce4c7a2b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/560ce4c7a2b) - Pass annotations list to inline comment component
+
 ## 187.20.1
 
 ### Patch Changes

package/dist/cjs/plugins/annotation/commands/index.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.setInlineCommentsVisibility = exports.setInlineCommentDraftState = exports.removeInlineCommentNearSelection = exports.createAnnotation = exports.closeComponent = exports.clearDirtyMark = exports.addInlineComment = void 0;
+exports.updateMouseState = exports.updateInlineCommentResolvedState = exports.setSelectedAnnotation = exports.setInlineCommentsVisibility = exports.setInlineCommentDraftState = exports.removeInlineCommentNearSelection = exports.createAnnotation = exports.closeComponent = exports.clearDirtyMark = exports.addInlineComment = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _pluginFactory = require("../pm-plugins/plugin-factory");
@@ -113,6 +113,18 @@ var updateMouseState = function updateMouseState(mouseData) {
   });
 };
 exports.updateMouseState = updateMouseState;
+var setSelectedAnnotation = function setSelectedAnnotation(id) {
+  return (0, _pluginFactory.createCommand)({
+    type: _types.ACTIONS.SET_SELECTED_ANNOTATION,
+    data: {
+      selectedAnnotations: [{
+        id: id,
+        type: _adfSchema.AnnotationTypes.INLINE_COMMENT
+      }]
+    }
+  });
+};
+exports.setSelectedAnnotation = setSelectedAnnotation;
 var createAnnotation = function createAnnotation(id) {
   var annotationType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _adfSchema.AnnotationTypes.INLINE_COMMENT;
   return function (state, dispatch) {

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

@@ -154,9 +154,16 @@ var inlineCommentPlugin = function inlineCommentPlugin(options) {
       var setVisibility = function setVisibility(isVisible) {
         return onSetVisibility(editorView)(isVisible);
       };
+      var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
+        if (!annotationId) {
+          (0, _commands.closeComponent)()(editorView.state, editorView.dispatch);
+        } else {
+          (0, _commands.setSelectedAnnotation)(annotationId)(editorView.state, editorView.dispatch);
+        }
+      };
       var updateSubscriber = provider.updateSubscriber;
       if (updateSubscriber) {
-        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility);
+        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility).on('setselectedannotation', setSelectedAnnotationFn);
       }
       editorView.root.addEventListener('mouseup', mouseUp);
       return {
@@ -172,7 +179,7 @@ var inlineCommentPlugin = function inlineCommentPlugin(options) {
         destroy: function destroy() {
           editorView.root.removeEventListener('mouseup', mouseUp);
           if (updateSubscriber) {
-            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility);
+            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility).off('setselectedannotation', setSelectedAnnotationFn);
           }
         }
       };

package/dist/cjs/plugins/annotation/pm-plugins/reducer.js

@@ -48,6 +48,10 @@ var _default = function _default(pluginState, action) {
       return _objectSpread(_objectSpread({}, isVisible ? pluginState : getNewDraftState(pluginState, false)), {}, {
         isVisible: isVisible
       });
+    case _types.ACTIONS.SET_SELECTED_ANNOTATION:
+      return _objectSpread(_objectSpread({}, pluginState), {}, {
+        selectedAnnotations: (0, _toConsumableArray2.default)(action.data.selectedAnnotations)
+      });
     default:
       return pluginState;
   }

package/dist/cjs/plugins/annotation/pm-plugins/types.js

@@ -12,6 +12,7 @@ var ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["ADD_INLINE_COMMENT"] = 4] = "ADD_INLINE_COMMENT";
   ACTIONS[ACTIONS["INLINE_COMMENT_SET_VISIBLE"] = 5] = "INLINE_COMMENT_SET_VISIBLE";
   ACTIONS[ACTIONS["CLOSE_COMPONENT"] = 6] = "CLOSE_COMPONENT";
+  ACTIONS[ACTIONS["SET_SELECTED_ANNOTATION"] = 7] = "SET_SELECTED_ANNOTATION";
   return ACTIONS;
 }({});
 exports.ACTIONS = ACTIONS;

package/dist/cjs/plugins/annotation/ui/InlineCommentView.js

@@ -46,6 +46,7 @@ function InlineCommentView(_ref) {
     bookmark = _ref2.bookmark,
     selectedAnnotations = _ref2.selectedAnnotations,
     annotations = _ref2.annotations;
+  var annotationsList = (0, _utils2.getAllAnnotations)(editorView.state.doc);
   var selection = (0, _utils2.getSelectionPositions)(state, inlineCommentState);
   var position = findPosForDOM(selection);
   var dom;
@@ -134,6 +135,7 @@ function InlineCommentView(_ref) {
     key: (0, _utils2.getAnnotationViewKey)(activeAnnotations),
     onViewed: onAnnotationViewed
   }, /*#__PURE__*/_react.default.createElement(ViewComponent, {
+    annotationsList: annotationsList,
     annotations: activeAnnotations,
     dom: dom,
     onDelete: function onDelete(id) {

package/dist/cjs/plugins/annotation/utils.js

@@ -77,7 +77,7 @@ var getAllAnnotations = function getAllAnnotations(doc) {
     node.marks.filter(function (mark) {
       return mark.type.name === 'annotation';
     })
-    // filter out annotations with invalid attribues as they cause errors when interacting with them
+    // filter out annotations with invalid attributes as they cause errors when interacting with them
     .filter(validateAnnotationMark).forEach(function (m) {
       return allAnnotationIds.add(m.attrs.id);
     });

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/editor-core";
 exports.name = name;
-var version = "187.20.1";
+var version = "187.21.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "187.20.1",
+	"version": "187.21.0",
 	"sideEffects": false
 }

package/dist/es2019/plugins/annotation/commands/index.js

@@ -91,6 +91,15 @@ export const updateMouseState = mouseData => createCommand({
     mouseData
   }
 });
+export const setSelectedAnnotation = id => createCommand({
+  type: ACTIONS.SET_SELECTED_ANNOTATION,
+  data: {
+    selectedAnnotations: [{
+      id,
+      type: AnnotationTypes.INLINE_COMMENT
+    }]
+  }
+});
 export const createAnnotation = (id, annotationType = AnnotationTypes.INLINE_COMMENT) => (state, dispatch) => {
   // don't try to add if there are is no temp highlight bookmarked
   const {

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

@@ -3,7 +3,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { AnnotationNodeView, getAnnotationViewClassname } from '../nodeviews';
-import { updateInlineCommentResolvedState, updateMouseState, clearDirtyMark, setInlineCommentsVisibility } from '../commands';
+import { updateInlineCommentResolvedState, updateMouseState, clearDirtyMark, setInlineCommentsVisibility, setSelectedAnnotation, closeComponent } from '../commands';
 import { getAllAnnotations, inlineCommentPluginKey, getPluginState } from '../utils';
 import { createPluginState } from './plugin-factory';
 const fetchProviderStates = async (provider, annotationIds) => {
@@ -97,11 +97,18 @@ export const inlineCommentPlugin = options => {
       const unResolve = annotationId => onUnResolve(editorView.state, editorView.dispatch)(annotationId);
       const mouseUp = event => onMouseUp(editorView.state, editorView.dispatch)(event);
       const setVisibility = isVisible => onSetVisibility(editorView)(isVisible);
+      const setSelectedAnnotationFn = annotationId => {
+        if (!annotationId) {
+          closeComponent()(editorView.state, editorView.dispatch);
+        } else {
+          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+        }
+      };
       const {
         updateSubscriber
       } = provider;
       if (updateSubscriber) {
-        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility);
+        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility).on('setselectedannotation', setSelectedAnnotationFn);
       }
       editorView.root.addEventListener('mouseup', mouseUp);
       return {
@@ -118,7 +125,7 @@ export const inlineCommentPlugin = options => {
         destroy() {
           editorView.root.removeEventListener('mouseup', mouseUp);
           if (updateSubscriber) {
-            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility);
+            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility).off('setselectedannotation', setSelectedAnnotationFn);
           }
         }
       };

package/dist/es2019/plugins/annotation/pm-plugins/reducer.js

@@ -51,6 +51,11 @@ export default ((pluginState, action) => {
         ...(isVisible ? pluginState : getNewDraftState(pluginState, false)),
         isVisible
       };
+    case ACTIONS.SET_SELECTED_ANNOTATION:
+      return {
+        ...pluginState,
+        selectedAnnotations: [...action.data.selectedAnnotations]
+      };
     default:
       return pluginState;
   }

package/dist/es2019/plugins/annotation/pm-plugins/types.js

@@ -6,5 +6,6 @@ export let ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["ADD_INLINE_COMMENT"] = 4] = "ADD_INLINE_COMMENT";
   ACTIONS[ACTIONS["INLINE_COMMENT_SET_VISIBLE"] = 5] = "INLINE_COMMENT_SET_VISIBLE";
   ACTIONS[ACTIONS["CLOSE_COMPONENT"] = 6] = "CLOSE_COMPONENT";
+  ACTIONS[ACTIONS["SET_SELECTED_ANNOTATION"] = 7] = "SET_SELECTED_ANNOTATION";
   return ACTIONS;
 }({});

package/dist/es2019/plugins/annotation/ui/InlineCommentView.js

@@ -2,7 +2,7 @@ import React from 'react';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { AnnotationViewWrapper } from './AnnotationViewWrapper';
 import { AnnotationTestIds } from '../types';
-import { getAnnotationViewKey, getSelectionPositions, getPluginState } from '../utils';
+import { getAnnotationViewKey, getSelectionPositions, getPluginState, getAllAnnotations } from '../utils';
 import { removeInlineCommentNearSelection, updateInlineCommentResolvedState, setInlineCommentDraftState, createAnnotation, closeComponent } from '../commands';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '../../analytics';
 import { CONTENT_COMPONENT } from '../../analytics/types';
@@ -46,6 +46,7 @@ export function InlineCommentView({
     selectedAnnotations,
     annotations
   } = inlineCommentState || {};
+  const annotationsList = getAllAnnotations(editorView.state.doc);
   const selection = getSelectionPositions(state, inlineCommentState);
   const position = findPosForDOM(selection);
   let dom;
@@ -132,6 +133,7 @@ export function InlineCommentView({
     key: getAnnotationViewKey(activeAnnotations),
     onViewed: onAnnotationViewed
   }, /*#__PURE__*/React.createElement(ViewComponent, {
+    annotationsList: annotationsList,
     annotations: activeAnnotations,
     dom: dom,
     onDelete: id => removeInlineCommentNearSelection(id)(state, dispatch),

package/dist/es2019/plugins/annotation/utils.js

@@ -52,7 +52,7 @@ export const getAllAnnotations = doc => {
   const allAnnotationIds = new Set();
   doc.descendants(node => {
     node.marks.filter(mark => mark.type.name === 'annotation')
-    // filter out annotations with invalid attribues as they cause errors when interacting with them
+    // filter out annotations with invalid attributes as they cause errors when interacting with them
     .filter(validateAnnotationMark).forEach(m => allAnnotationIds.add(m.attrs.id));
     return true;
   });

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/editor-core";
-export const version = "187.20.1";
+export const version = "187.21.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "187.20.1",
+	"version": "187.21.0",
 	"sideEffects": false
 }

package/dist/esm/plugins/annotation/commands/index.js

@@ -99,6 +99,17 @@ export var updateMouseState = function updateMouseState(mouseData) {
     }
   });
 };
+export var setSelectedAnnotation = function setSelectedAnnotation(id) {
+  return createCommand({
+    type: ACTIONS.SET_SELECTED_ANNOTATION,
+    data: {
+      selectedAnnotations: [{
+        id: id,
+        type: AnnotationTypes.INLINE_COMMENT
+      }]
+    }
+  });
+};
 export var createAnnotation = function createAnnotation(id) {
   var annotationType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : AnnotationTypes.INLINE_COMMENT;
   return function (state, dispatch) {

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

@@ -6,7 +6,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { AnnotationNodeView, getAnnotationViewClassname } from '../nodeviews';
-import { updateInlineCommentResolvedState, updateMouseState, clearDirtyMark, setInlineCommentsVisibility } from '../commands';
+import { updateInlineCommentResolvedState, updateMouseState, clearDirtyMark, setInlineCommentsVisibility, setSelectedAnnotation, closeComponent } from '../commands';
 import { getAllAnnotations, inlineCommentPluginKey, getPluginState } from '../utils';
 import { createPluginState } from './plugin-factory';
 var fetchProviderStates = /*#__PURE__*/function () {
@@ -147,9 +147,16 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
       var setVisibility = function setVisibility(isVisible) {
         return onSetVisibility(editorView)(isVisible);
       };
+      var setSelectedAnnotationFn = function setSelectedAnnotationFn(annotationId) {
+        if (!annotationId) {
+          closeComponent()(editorView.state, editorView.dispatch);
+        } else {
+          setSelectedAnnotation(annotationId)(editorView.state, editorView.dispatch);
+        }
+      };
       var updateSubscriber = provider.updateSubscriber;
       if (updateSubscriber) {
-        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility);
+        updateSubscriber.on('resolve', resolve).on('delete', resolve).on('unresolve', unResolve).on('create', unResolve).on('setvisibility', setVisibility).on('setselectedannotation', setSelectedAnnotationFn);
       }
       editorView.root.addEventListener('mouseup', mouseUp);
       return {
@@ -165,7 +172,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
         destroy: function destroy() {
           editorView.root.removeEventListener('mouseup', mouseUp);
           if (updateSubscriber) {
-            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility);
+            updateSubscriber.off('resolve', resolve).off('delete', resolve).off('unresolve', unResolve).off('create', unResolve).off('setvisibility', setVisibility).off('setselectedannotation', setSelectedAnnotationFn);
           }
         }
       };

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

@@ -41,6 +41,10 @@ export default (function (pluginState, action) {
       return _objectSpread(_objectSpread({}, isVisible ? pluginState : getNewDraftState(pluginState, false)), {}, {
         isVisible: isVisible
       });
+    case ACTIONS.SET_SELECTED_ANNOTATION:
+      return _objectSpread(_objectSpread({}, pluginState), {}, {
+        selectedAnnotations: _toConsumableArray(action.data.selectedAnnotations)
+      });
     default:
       return pluginState;
   }

package/dist/esm/plugins/annotation/pm-plugins/types.js

@@ -6,5 +6,6 @@ export var ACTIONS = /*#__PURE__*/function (ACTIONS) {
   ACTIONS[ACTIONS["ADD_INLINE_COMMENT"] = 4] = "ADD_INLINE_COMMENT";
   ACTIONS[ACTIONS["INLINE_COMMENT_SET_VISIBLE"] = 5] = "INLINE_COMMENT_SET_VISIBLE";
   ACTIONS[ACTIONS["CLOSE_COMPONENT"] = 6] = "CLOSE_COMPONENT";
+  ACTIONS[ACTIONS["SET_SELECTED_ANNOTATION"] = 7] = "SET_SELECTED_ANNOTATION";
   return ACTIONS;
 }({});

package/dist/esm/plugins/annotation/ui/InlineCommentView.js

@@ -3,7 +3,7 @@ import React from 'react';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { AnnotationViewWrapper } from './AnnotationViewWrapper';
 import { AnnotationTestIds } from '../types';
-import { getAnnotationViewKey, getSelectionPositions, getPluginState } from '../utils';
+import { getAnnotationViewKey, getSelectionPositions, getPluginState, getAllAnnotations } from '../utils';
 import { removeInlineCommentNearSelection, updateInlineCommentResolvedState, setInlineCommentDraftState, createAnnotation, closeComponent } from '../commands';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '../../analytics';
 import { CONTENT_COMPONENT } from '../../analytics/types';
@@ -39,6 +39,7 @@ export function InlineCommentView(_ref) {
     bookmark = _ref2.bookmark,
     selectedAnnotations = _ref2.selectedAnnotations,
     annotations = _ref2.annotations;
+  var annotationsList = getAllAnnotations(editorView.state.doc);
   var selection = getSelectionPositions(state, inlineCommentState);
   var position = findPosForDOM(selection);
   var dom;
@@ -127,6 +128,7 @@ export function InlineCommentView(_ref) {
     key: getAnnotationViewKey(activeAnnotations),
     onViewed: onAnnotationViewed
   }, /*#__PURE__*/React.createElement(ViewComponent, {
+    annotationsList: annotationsList,
     annotations: activeAnnotations,
     dom: dom,
     onDelete: function onDelete(id) {

package/dist/esm/plugins/annotation/utils.js

@@ -60,7 +60,7 @@ export var getAllAnnotations = function getAllAnnotations(doc) {
     node.marks.filter(function (mark) {
       return mark.type.name === 'annotation';
     })
-    // filter out annotations with invalid attribues as they cause errors when interacting with them
+    // filter out annotations with invalid attributes as they cause errors when interacting with them
     .filter(validateAnnotationMark).forEach(function (m) {
       return allAnnotationIds.add(m.attrs.id);
     });

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/editor-core";
-export var version = "187.20.1";
+export var version = "187.21.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "187.20.1",
+	"version": "187.21.0",
 	"sideEffects": false
 }

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

@@ -10,5 +10,6 @@ export declare const removeInlineCommentNearSelection: (id: string) => Command;
 export declare const setInlineCommentDraftState: (drafting: boolean, inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => Command;
 export declare const addInlineComment: (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
+export declare const setSelectedAnnotation: (id: string) => Command;
 export declare const createAnnotation: (id: string, annotationType?: AnnotationTypes) => Command;
 export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

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

@@ -10,7 +10,8 @@ export declare enum ACTIONS {
     INLINE_COMMENT_CLEAR_DIRTY_MARK = 3,
     ADD_INLINE_COMMENT = 4,
     INLINE_COMMENT_SET_VISIBLE = 5,
-    CLOSE_COMPONENT = 6
+    CLOSE_COMPONENT = 6,
+    SET_SELECTED_ANNOTATION = 7
 }
 export interface InlineCommentPluginOptions {
     dispatch: Dispatch;
@@ -55,6 +56,11 @@ export type InlineCommentAction = {
     data: {
         isVisible: boolean;
     };
+} | {
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
 };
 export type InlineCommentPluginState = {
     annotations: InlineCommentMap;

package/dist/types/plugins/annotation/types.d.ts

@@ -39,6 +39,10 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Removes the annotation from the document
      */
     onDelete?: (id: string) => void;
+    /**
+     * Ordered list of annotation ids as shown in the document
+     */
+    annotationsList?: string[];
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;

package/dist/types/plugins/annotation/update-provider.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve';
+export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation';
 export type VisibilityEvent = 'setvisibility';
 export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: VisibilityEvent, listener: (isVisible: boolean) => void): this;

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

@@ -10,5 +10,6 @@ export declare const removeInlineCommentNearSelection: (id: string) => Command;
 export declare const setInlineCommentDraftState: (drafting: boolean, inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => Command;
 export declare const addInlineComment: (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
+export declare const setSelectedAnnotation: (id: string) => Command;
 export declare const createAnnotation: (id: string, annotationType?: AnnotationTypes) => Command;
 export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

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

@@ -10,7 +10,8 @@ export declare enum ACTIONS {
     INLINE_COMMENT_CLEAR_DIRTY_MARK = 3,
     ADD_INLINE_COMMENT = 4,
     INLINE_COMMENT_SET_VISIBLE = 5,
-    CLOSE_COMPONENT = 6
+    CLOSE_COMPONENT = 6,
+    SET_SELECTED_ANNOTATION = 7
 }
 export interface InlineCommentPluginOptions {
     dispatch: Dispatch;
@@ -55,6 +56,11 @@ export type InlineCommentAction = {
     data: {
         isVisible: boolean;
     };
+} | {
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
 };
 export type InlineCommentPluginState = {
     annotations: InlineCommentMap;

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

@@ -39,6 +39,10 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
      * Removes the annotation from the document
      */
     onDelete?: (id: string) => void;
+    /**
+     * Ordered list of annotation ids as shown in the document
+     */
+    annotationsList?: string[];
 };
 export interface AnnotationState<Type, State> {
     annotationType: Type;

package/dist/types-ts4.5/plugins/annotation/update-provider.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve';
+export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation';
 export type VisibilityEvent = 'setvisibility';
 export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: VisibilityEvent, listener: (isVisible: boolean) => void): this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "187.20.1",
+  "version": "187.21.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -147,7 +147,7 @@
     "@atlaskit/dropdown-menu": "^11.11.0",
     "@atlaskit/editor-extension-dropbox": "^0.4.0",
     "@atlaskit/editor-plugin-table": "^2.8.0",
-    "@atlaskit/editor-test-helpers": "^18.10.0",
+    "@atlaskit/editor-test-helpers": "^18.11.0",
     "@atlaskit/flag": "^15.2.0",
     "@atlaskit/icon-object": "^6.3.0",
     "@atlaskit/inline-dialog": "^13.6.0",

package/report.api.md

@@ -1113,6 +1113,7 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
   annotations: Array<AnnotationInfo>;
   onResolve: (id: string) => void;
   onDelete?: (id: string) => void;
+  annotationsList?: string[];
 };
 
 export { INPUT_METHOD };
@@ -2181,7 +2182,12 @@ interface TypeAheadStatsSerializable extends TypeAheadStats {
 }
 
 // @public (undocumented)
-export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve';
+export type UpdateEvent =
+  | 'create'
+  | 'delete'
+  | 'resolve'
+  | 'setselectedannotation'
+  | 'unresolve';
 
 // @public (undocumented)
 export const updateStatus: (status?: StatusType) => Command;

package/tmp/api-report-tmp.d.ts

@@ -1016,6 +1016,7 @@ export type InlineCommentViewComponentProps = AnnotationComponentProps & {
     annotations: Array<AnnotationInfo>;
     onResolve: (id: string) => void;
     onDelete?: (id: string) => void;
+    annotationsList?: string[];
 };
 
 export { INPUT_METHOD }
@@ -1941,7 +1942,7 @@ interface TypeAheadStatsSerializable extends TypeAheadStats {
 }
 
 // @public (undocumented)
-export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve';
+export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'setselectedannotation' | 'unresolve';
 
 // @public (undocumented)
 export const updateStatus: (status?: StatusType) => Command;