@atlaskit/editor-plugin-annotation 19.1.0 → 19.2.0

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

@@ -3,7 +3,7 @@ import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-pr
 import type { EditorState, Selection, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import { AllSelection, NodeSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
-import type { AnnotationInfo, DraftBookmark, InlineCommentInputMethod, TargetType } from '../types';
+import type { AnnotationInfo, DraftBookmark, InlineCommentAnnotationProvider, InlineCommentInputMethod, TargetType } from '../types';
 import { AnnotationSelectionType } from '../types';
 import type { InlineCommentPluginState } from './types';
 /**
@@ -19,7 +19,7 @@ export declare const decorationKey: {
 export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
-export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?: SelectionBookmark, supportedBlockNodes?: string[]) => DraftBookmark;
+export declare const resolveDraftBookmark: (editorState: EditorState, bookmark?: SelectionBookmark, supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => DraftBookmark;
 /**
  * get selection from position to apply new comment for
  * @returns bookmarked positions if they exists, otherwise current selection positions
@@ -31,9 +31,9 @@ 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, _supportedNodes?: string[]) => AnnotationSelectionType;
+export declare const isSelectionValid: (state: EditorState, supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
-export declare const isSupportedBlockNode: (node: Node, supportedBlockNodes?: string[]) => boolean;
+export declare const isSupportedBlockNode: (node: Node, supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace
  * This is to conform to Confluence annotation specifications

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

@@ -2,6 +2,7 @@ import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema/annotation';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 /**
  * type of target that annotation apply to.
  * This is used to apply correct decoration to a draft comment
@@ -99,6 +100,14 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
     contentType?: string;
     createComponent?: React.ComponentType<React.PropsWithChildren<InlineCommentCreateComponentProps>>;
     getCanAddComments?: () => boolean;
+    /**
+     * @experimental Still under development. Do not use.
+     *
+     * Determines whether a specific block node supports inline comments.
+     * This is additive to `supportedBlockNodes`; a node is supported when either configuration
+     * matches it.
+     */
+    isBlockNodeSupported?: (node: PMNode) => boolean;
     isToolbarAbove?: boolean;
     onCommentButtonMount?: () => void;
     /** Checks whether the active inline comment can be safely closed. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "19.1.0",
+	"version": "19.2.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -48,6 +48,10 @@
 		"wait-for-expect": "^1.2.0"
 	},
 	"platform-feature-flags": {
+		"cc_maui_annotations_on_extensions": {
+			"type": "boolean",
+			"referenceOnly": true
+		},
 		"platform_editor_comments_api_manager": {
 			"type": "boolean",
 			"referenceOnly": true