@atlaskit/editor-plugin-annotation 2.1.5 → 2.1.7

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.1.7
+
+### Patch Changes
+
+- [#128761](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/128761)
+  [`917104463449c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/917104463449c) -
+  Ensure the selected annotation state accounts for selections that are in between two annotations.
+- Updated dependencies
+
+## 2.1.6
+
+### Patch Changes
+
+- [#127441](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/127441)
+  [`f2f4b5971e0b2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2f4b5971e0b2) -
+  [ux] Updates Text Formatting toolbar separators, active option style and removes range selection
+  when the toolbar is docked to top.
+- Updated dependencies
+
 ## 2.1.5
 
 ### Patch Changes

package/dist/cjs/annotationPlugin.js

@@ -32,6 +32,7 @@ var annotationPlugin = exports.annotationPlugin = function annotationPlugin(_ref
       }];
     },
     actions: {
+      hasAnyUnResolvedAnnotationInPage: _utils.hasAnyUnResolvedAnnotationInPage,
       stripNonExistingAnnotations: _utils.stripNonExistingAnnotations,
       setInlineCommentDraftState: (0, _editorCommands.setInlineCommentDraftState)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
       showCommentForBlockNode: (0, _editorCommands.showInlineCommentForBlockNode)(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)

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

@@ -107,7 +107,8 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
       title: toolbarTitle,
       nodeType: validNodes,
       items: [createComment],
-      onPositionCalculated: onPositionCalculated
+      onPositionCalculated: onPositionCalculated,
+      pluginName: 'annotation'
     };
   };
 };

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

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -7,13 +8,14 @@ exports.addDraftDecoration = void 0;
 exports.annotationExists = annotationExists;
 exports.getPluginState = exports.getDraftCommandAnalyticsPayload = exports.getAnnotationViewKey = exports.getAllAnnotations = exports.findAnnotationsInSelection = exports.decorationKey = void 0;
 exports.getSelectionPositions = getSelectionPositions;
-exports.hasInvalidNodes = void 0;
+exports.hasInvalidNodes = exports.hasAnyUnResolvedAnnotationInPage = void 0;
 exports.hasInvalidWhitespaceNode = hasInvalidWhitespaceNode;
 exports.isCurrentBlockNodeSelected = exports.isBlockNodeAnnotationsSelected = exports.inlineCommentPluginKey = void 0;
 exports.isSelectedAnnotationsChanged = isSelectedAnnotationsChanged;
 exports.resolveDraftBookmark = exports.isSupportedBlockNode = exports.isSelectionValid = void 0;
 exports.stripNonExistingAnnotations = stripNonExistingAnnotations;
 exports.surroundingMarks = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _adfSchema = require("@atlaskit/adf-schema");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _mediaSingle = require("@atlaskit/editor-common/media-single");
@@ -187,10 +189,25 @@ var findAnnotationsInSelection = exports.findAnnotationsInSelection = function f
   var annotationMark = doc.type.schema.marks.annotation;
   var anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   var marks = [];
-  if (annotationMark.isInSet(anchorAnnotationMarks)) {
-    marks = anchorAnnotationMarks;
-  } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
-    marks = nodeBefore.marks;
+  if ((0, _platformFeatureFlags.fg)('platform_editor_fix_missing_selected_annotations')) {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    }
+    if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      var _marks;
+      var existingMarkIds = marks.map(function (m) {
+        return m.attrs.id;
+      });
+      marks = (_marks = marks).concat.apply(_marks, (0, _toConsumableArray2.default)(nodeBefore.marks.filter(function (m) {
+        return !existingMarkIds.includes(m.attrs.id);
+      })));
+    }
+  } else {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      marks = nodeBefore.marks;
+    }
   }
   var annotations = marks.filter(function (mark) {
     return mark.type.name === 'annotation';
@@ -490,4 +507,23 @@ var isBlockNodeAnnotationsSelected = exports.isBlockNodeAnnotationsSelected = fu
     });
   }
   return false;
+};
+var hasAnyUnResolvedAnnotationInPage = exports.hasAnyUnResolvedAnnotationInPage = function hasAnyUnResolvedAnnotationInPage(state) {
+  var _getPluginState;
+  var annotations = (_getPluginState = getPluginState(state)) === null || _getPluginState === void 0 ? void 0 : _getPluginState.annotations;
+  if (annotations) {
+    /**
+     * annotations type is { [key: string]: boolean };
+     * Here, key represents mark.attr.id and it is used to find where annotation to be presented in the document.
+     * When value is false, it means it is unresolved annotation.
+     *
+     * But sometimes annotation map has entry with key undefined somehow.
+     * And it is not valid mark attribute id, so it won't be presented anywhere in the document.
+     */
+    var unresolvedAnnotationKeys = Object.keys(annotations).filter(function (key) {
+      return key !== 'undefined' && annotations[key] === false;
+    });
+    return unresolvedAnnotationKeys.length > 0;
+  }
+  return false;
 };

package/dist/es2019/annotationPlugin.js

@@ -6,7 +6,7 @@ import { annotationWithToDOMFix } from './nodeviews/annotationMark';
 import { inlineCommentPlugin } from './pm-plugins/inline-comment';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { buildToolbar } from './pm-plugins/toolbar';
-import { getPluginState, stripNonExistingAnnotations } from './pm-plugins/utils';
+import { getPluginState, hasAnyUnResolvedAnnotationInPage, stripNonExistingAnnotations } from './pm-plugins/utils';
 import { InlineCommentView } from './ui/InlineCommentView';
 export const annotationPlugin = ({
   config: annotationProviders,
@@ -23,6 +23,7 @@ export const annotationPlugin = ({
       }];
     },
     actions: {
+      hasAnyUnResolvedAnnotationInPage,
       stripNonExistingAnnotations,
       setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)

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

@@ -100,6 +100,7 @@ export const buildToolbar = editorAnalyticsAPI => ({
     title: toolbarTitle,
     nodeType: validNodes,
     items: [createComment],
-    onPositionCalculated
+    onPositionCalculated,
+    pluginName: 'annotation'
   };
 };

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

@@ -159,10 +159,20 @@ export const findAnnotationsInSelection = (selection, doc) => {
   const annotationMark = doc.type.schema.marks.annotation;
   const anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   let marks = [];
-  if (annotationMark.isInSet(anchorAnnotationMarks)) {
-    marks = anchorAnnotationMarks;
-  } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
-    marks = nodeBefore.marks;
+  if (fg('platform_editor_fix_missing_selected_annotations')) {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    }
+    if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      const existingMarkIds = marks.map(m => m.attrs.id);
+      marks = marks.concat(...nodeBefore.marks.filter(m => !existingMarkIds.includes(m.attrs.id)));
+    }
+  } else {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      marks = nodeBefore.marks;
+    }
   }
   const annotations = marks.filter(mark => mark.type.name === 'annotation').map(mark => ({
     id: mark.attrs.id,
@@ -454,4 +464,21 @@ export const isBlockNodeAnnotationsSelected = (selection, selectedAnnotations =
     return !selectedAnnotations.some(annotation => !annotationMarks.find(existingAnnotation => existingAnnotation.id === annotation.id && existingAnnotation.type === annotation.type));
   }
   return false;
+};
+export const hasAnyUnResolvedAnnotationInPage = state => {
+  var _getPluginState;
+  const annotations = (_getPluginState = getPluginState(state)) === null || _getPluginState === void 0 ? void 0 : _getPluginState.annotations;
+  if (annotations) {
+    /**
+     * annotations type is { [key: string]: boolean };
+     * Here, key represents mark.attr.id and it is used to find where annotation to be presented in the document.
+     * When value is false, it means it is unresolved annotation.
+     *
+     * But sometimes annotation map has entry with key undefined somehow.
+     * And it is not valid mark attribute id, so it won't be presented anywhere in the document.
+     */
+    const unresolvedAnnotationKeys = Object.keys(annotations).filter(key => key !== 'undefined' && annotations[key] === false);
+    return unresolvedAnnotationKeys.length > 0;
+  }
+  return false;
 };

package/dist/esm/annotationPlugin.js

@@ -9,7 +9,7 @@ import { annotationWithToDOMFix } from './nodeviews/annotationMark';
 import { inlineCommentPlugin } from './pm-plugins/inline-comment';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { buildToolbar } from './pm-plugins/toolbar';
-import { getPluginState, stripNonExistingAnnotations } from './pm-plugins/utils';
+import { getPluginState, hasAnyUnResolvedAnnotationInPage, stripNonExistingAnnotations } from './pm-plugins/utils';
 import { InlineCommentView } from './ui/InlineCommentView';
 export var annotationPlugin = function annotationPlugin(_ref) {
   var _api$featureFlags, _api$analytics;
@@ -25,6 +25,7 @@ export var annotationPlugin = function annotationPlugin(_ref) {
       }];
     },
     actions: {
+      hasAnyUnResolvedAnnotationInPage: hasAnyUnResolvedAnnotationInPage,
       stripNonExistingAnnotations: stripNonExistingAnnotations,
       setInlineCommentDraftState: setInlineCommentDraftState(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions, annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes),
       showCommentForBlockNode: showInlineCommentForBlockNode(annotationProviders === null || annotationProviders === void 0 ? void 0 : annotationProviders.inlineComment.supportedBlockNodes)

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

@@ -100,7 +100,8 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
       title: toolbarTitle,
       nodeType: validNodes,
       items: [createComment],
-      onPositionCalculated: onPositionCalculated
+      onPositionCalculated: onPositionCalculated,
+      pluginName: 'annotation'
     };
   };
 };

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

@@ -1,3 +1,4 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { currentMediaNodeWithPos } from '@atlaskit/editor-common/media-single';
@@ -171,10 +172,25 @@ export var findAnnotationsInSelection = function findAnnotationsInSelection(sele
   var annotationMark = doc.type.schema.marks.annotation;
   var anchorAnnotationMarks = (node === null || node === void 0 ? void 0 : node.marks) || [];
   var marks = [];
-  if (annotationMark.isInSet(anchorAnnotationMarks)) {
-    marks = anchorAnnotationMarks;
-  } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
-    marks = nodeBefore.marks;
+  if (fg('platform_editor_fix_missing_selected_annotations')) {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    }
+    if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      var _marks;
+      var existingMarkIds = marks.map(function (m) {
+        return m.attrs.id;
+      });
+      marks = (_marks = marks).concat.apply(_marks, _toConsumableArray(nodeBefore.marks.filter(function (m) {
+        return !existingMarkIds.includes(m.attrs.id);
+      })));
+    }
+  } else {
+    if (annotationMark.isInSet(anchorAnnotationMarks)) {
+      marks = anchorAnnotationMarks;
+    } else if (nodeBefore && annotationMark.isInSet(nodeBefore.marks)) {
+      marks = nodeBefore.marks;
+    }
   }
   var annotations = marks.filter(function (mark) {
     return mark.type.name === 'annotation';
@@ -474,4 +490,23 @@ export var isBlockNodeAnnotationsSelected = function isBlockNodeAnnotationsSelec
     });
   }
   return false;
+};
+export var hasAnyUnResolvedAnnotationInPage = function hasAnyUnResolvedAnnotationInPage(state) {
+  var _getPluginState;
+  var annotations = (_getPluginState = getPluginState(state)) === null || _getPluginState === void 0 ? void 0 : _getPluginState.annotations;
+  if (annotations) {
+    /**
+     * annotations type is { [key: string]: boolean };
+     * Here, key represents mark.attr.id and it is used to find where annotation to be presented in the document.
+     * When value is false, it means it is unresolved annotation.
+     *
+     * But sometimes annotation map has entry with key undefined somehow.
+     * And it is not valid mark attribute id, so it won't be presented anywhere in the document.
+     */
+    var unresolvedAnnotationKeys = Object.keys(annotations).filter(function (key) {
+      return key !== 'undefined' && annotations[key] === false;
+    });
+    return unresolvedAnnotationKeys.length > 0;
+  }
+  return false;
 };

package/dist/types/annotationPluginType.d.ts

@@ -33,6 +33,7 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
+        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
     };
 }>;
 export {};

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

@@ -11,6 +11,7 @@ declare const _default: {
             stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: EditorState) => boolean | undefined;
             setInlineCommentDraftState: (drafting: boolean, inputMethod: InlineCommentInputMethod, targetType?: import("../types").TargetType | undefined, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
             showCommentForBlockNode: (node: import("prosemirror-model").Node | null, viewMethod?: import("@atlaskit/editor-common/analytics").VIEW_METHOD | undefined, isOpeningMediaCommentFromToolbar?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
+            hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         };
     }> | undefined) => (id: string, supportedBlockNodes?: string[] | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     handleDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;

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

@@ -51,3 +51,4 @@ export declare function isSelectedAnnotationsChanged(oldSelectedAnnotations: Ann
  * Checks if the selectedAnnotations are the same as the annotations on the selected block node
  */
 export declare const isBlockNodeAnnotationsSelected: (selection: Selection, selectedAnnotations?: AnnotationInfo[]) => boolean;
+export declare const hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;

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

@@ -33,6 +33,7 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * otherwise, it will return false.
          */
         showCommentForBlockNode: ReturnType<typeof showInlineCommentForBlockNode>;
+        hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
     };
 }>;
 export {};

package/dist/types-ts4.5/editor-commands/transform.d.ts

@@ -11,6 +11,7 @@ declare const _default: {
             stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: EditorState) => boolean | undefined;
             setInlineCommentDraftState: (drafting: boolean, inputMethod: InlineCommentInputMethod, targetType?: import("../types").TargetType | undefined, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
             showCommentForBlockNode: (node: import("prosemirror-model").Node | null, viewMethod?: import("@atlaskit/editor-common/analytics").VIEW_METHOD | undefined, isOpeningMediaCommentFromToolbar?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
+            hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         };
     }> | undefined) => (id: string, supportedBlockNodes?: string[] | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     handleDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;

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

@@ -51,3 +51,4 @@ export declare function isSelectedAnnotationsChanged(oldSelectedAnnotations: Ann
  * Checks if the selectedAnnotations are the same as the annotations on the selected block node
  */
 export declare const isBlockNodeAnnotationsSelected: (selection: Selection, selectedAnnotations?: AnnotationInfo[]) => boolean;
+export declare const hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.1.5",
+	"version": "2.1.7",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^102.8.0",
+		"@atlaskit/editor-common": "^102.11.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -41,7 +41,7 @@
 		"@atlaskit/icon": "^25.0.0",
 		"@atlaskit/onboarding": "^13.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.0.0",
+		"@atlaskit/tmp-editor-statsig": "^4.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -99,6 +99,9 @@
 		"platform_inline_node_as_valid_annotation_selection": {
 			"type": "boolean"
 		},
+		"platform_editor_fix_missing_selected_annotations": {
+			"type": "boolean"
+		},
 		"use_comments_data_annotation_updater": {
 			"type": "boolean"
 		}