@atlaskit/editor-plugin-annotation 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-annotation
 
+## 1.2.1
+
+### Patch Changes
+
+- [#78577](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/78577) [`207fbd3685dc`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/207fbd3685dc) - ED-22111 add supported nodes option to annotation plugin
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/cjs/commands/index.js

@@ -39,6 +39,7 @@ var clearDirtyMark = exports.clearDirtyMark = function clearDirtyMark() {
   });
 };
 var removeInlineCommentNearSelection = exports.removeInlineCommentNearSelection = function removeInlineCommentNearSelection(id) {
+  var _supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (state, dispatch) {
     var tr = state.tr,
       $from = state.selection.$from;

package/dist/cjs/toolbar.js

@@ -19,6 +19,7 @@ var buildToolbar = exports.buildToolbar = function buildToolbar(editorAnalyticsA
   return function (state, intl) {
     var isToolbarAbove = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var isCommentOnMediaOn = arguments.length > 3 ? arguments[3] : undefined;
+    var _supportedNodes = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     var schema = state.schema;
     var selectionValid = (0, _utils2.isSelectionValid)(state, isCommentOnMediaOn);
     var isMediaSelected = isCommentOnMediaOn && (0, _mediaSingle.currentMediaNodeWithPos)(state);

package/dist/cjs/ui/InlineCommentView.js

@@ -137,7 +137,7 @@ function InlineCommentView(_ref) {
     annotations: activeAnnotations,
     dom: dom,
     onDelete: function onDelete(id) {
-      return (0, _commands.removeInlineCommentNearSelection)(id)(state, dispatch);
+      return (0, _commands.removeInlineCommentNearSelection)(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);
     },
     onResolve: function onResolve(id) {
       return (0, _commands.updateInlineCommentResolvedState)(editorAnalyticsAPI)((0, _defineProperty2.default)({}, id, true), _analytics.RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch);

package/dist/cjs/utils.js

@@ -237,6 +237,7 @@ var getDraftCommandAnalyticsPayload = exports.getDraftCommandAnalyticsPayload =
 };
 var isSelectionValid = exports.isSelectionValid = function isSelectionValid(state, isCommentOnMediaOn) {
   var _currentMediaNodeWith;
+  var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
   var _ref3 = getPluginState(state) || {},
     disallowOnWhitespace = _ref3.disallowOnWhitespace;

package/dist/es2019/commands/index.js

@@ -22,7 +22,7 @@ export const closeComponent = () => createCommand({
 export const clearDirtyMark = () => createCommand({
   type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK
 });
-export const removeInlineCommentNearSelection = id => (state, dispatch) => {
+export const removeInlineCommentNearSelection = (id, _supportedNodes = []) => (state, dispatch) => {
   const {
     tr,
     selection: {

package/dist/es2019/toolbar.js

@@ -8,7 +8,7 @@ import CommentIcon from '@atlaskit/icon/glyph/comment';
 import { setInlineCommentDraftState } from './commands';
 import { AnnotationSelectionType, AnnotationTestIds } from './types';
 import { isSelectionValid } from './utils';
-export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove = false, isCommentOnMediaOn) => {
+export const buildToolbar = editorAnalyticsAPI => (state, intl, isToolbarAbove = false, isCommentOnMediaOn, _supportedNodes = []) => {
   const {
     schema
   } = state;

package/dist/es2019/ui/InlineCommentView.js

@@ -134,7 +134,7 @@ export function InlineCommentView({
     annotationsList: annotationsList,
     annotations: activeAnnotations,
     dom: dom,
-    onDelete: id => removeInlineCommentNearSelection(id)(state, dispatch),
+    onDelete: id => removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch),
     onResolve: id => updateInlineCommentResolvedState(editorAnalyticsAPI)({
       [id]: true
     }, RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch),

package/dist/es2019/utils.js

@@ -194,7 +194,7 @@ export const getDraftCommandAnalyticsPayload = (drafting, inputMethod) => {
   };
   return payload;
 };
-export const isSelectionValid = (state, isCommentOnMediaOn) => {
+export const isSelectionValid = (state, isCommentOnMediaOn, _supportedNodes = []) => {
   var _currentMediaNodeWith;
   const {
     selection

package/dist/esm/commands/index.js

@@ -32,6 +32,7 @@ export var clearDirtyMark = function clearDirtyMark() {
   });
 };
 export var removeInlineCommentNearSelection = function removeInlineCommentNearSelection(id) {
+  var _supportedNodes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   return function (state, dispatch) {
     var tr = state.tr,
       $from = state.selection.$from;

package/dist/esm/toolbar.js

@@ -12,6 +12,7 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
   return function (state, intl) {
     var isToolbarAbove = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var isCommentOnMediaOn = arguments.length > 3 ? arguments[3] : undefined;
+    var _supportedNodes = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     var schema = state.schema;
     var selectionValid = isSelectionValid(state, isCommentOnMediaOn);
     var isMediaSelected = isCommentOnMediaOn && currentMediaNodeWithPos(state);

package/dist/esm/ui/InlineCommentView.js

@@ -130,7 +130,7 @@ export function InlineCommentView(_ref) {
     annotations: activeAnnotations,
     dom: dom,
     onDelete: function onDelete(id) {
-      return removeInlineCommentNearSelection(id)(state, dispatch);
+      return removeInlineCommentNearSelection(id, inlineCommentProvider.supportedBlockNodes)(state, dispatch);
     },
     onResolve: function onResolve(id) {
       return updateInlineCommentResolvedState(editorAnalyticsAPI)(_defineProperty({}, id, true), RESOLVE_METHOD.COMPONENT)(editorView.state, editorView.dispatch);

package/dist/esm/utils.js

@@ -210,6 +210,7 @@ export var getDraftCommandAnalyticsPayload = function getDraftCommandAnalyticsPa
 };
 export var isSelectionValid = function isSelectionValid(state, isCommentOnMediaOn) {
   var _currentMediaNodeWith;
+  var _supportedNodes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
   var selection = state.selection;
   var _ref3 = getPluginState(state) || {},
     disallowOnWhitespace = _ref3.disallowOnWhitespace;

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

@@ -6,7 +6,7 @@ import type { AnnotationPlugin, InlineCommentInputMethod, TargetType } from '../
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
-export declare const removeInlineCommentNearSelection: (id: string) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, _supportedNodes?: string[]) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

package/dist/types/toolbar.d.ts

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean) => FloatingToolbarConfig | undefined;
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => FloatingToolbarConfig | undefined;

package/dist/types/types.d.ts

@@ -97,6 +97,16 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
     createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
     viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
     isToolbarAbove?: boolean;
+    /**
+     * @experimental Still under development. Do not use.
+     *
+     * A list of supported editor node names for inline comment,
+     * Note 1: value is the type name of the node, e.g. media, mediaInline
+     * Invalid node names, nodes does not support annotation
+     * or nodes not supported by current ADF schema will be ignored.
+     * Note 2: text is supported by default.
+     */
+    supportedBlockNodes?: string[];
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;

package/dist/types/utils.d.ts

@@ -28,7 +28,7 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
  * get payload for the open/close analytics event
  */
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

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

@@ -6,7 +6,7 @@ import type { AnnotationPlugin, InlineCommentInputMethod, TargetType } from '../
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
-export declare const removeInlineCommentNearSelection: (id: string) => Command;
+export declare const removeInlineCommentNearSelection: (id: string, _supportedNodes?: string[]) => Command;
 export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;

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

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean) => FloatingToolbarConfig | undefined;
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => FloatingToolbarConfig | undefined;

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

@@ -97,6 +97,16 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
     createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
     viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
     isToolbarAbove?: boolean;
+    /**
+     * @experimental Still under development. Do not use.
+     *
+     * A list of supported editor node names for inline comment,
+     * Note 1: value is the type name of the node, e.g. media, mediaInline
+     * Invalid node names, nodes does not support annotation
+     * or nodes not supported by current ADF schema will be ignored.
+     * Note 2: text is supported by default.
+     */
+    supportedBlockNodes?: string[];
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;

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

@@ -28,7 +28,7 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
  * get payload for the open/close analytics event
  */
 export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean, _supportedNodes?: string[]) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

package/package.json

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