@atlaskit/editor-plugin-annotation 27.0.6 → 28.1.0

package/dist/types/annotationPluginType.d.ts

@@ -1,3 +1,4 @@
+import type { AnnotationManager } from '@atlaskit/editor-common/annotation';
 import type { Command } from '@atlaskit/editor-common/types/command';
 import type { ExtractInjectionAPI, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types/next-editor-plugin';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics/analyticsPluginType';
@@ -26,6 +27,10 @@ export type AnnotationPluginDependencies = [
     OptionalPlugin<UserIntentPlugin>
 ];
 export type AnnotationPluginOptions = AnnotationProviders;
+/** Inline comment plugin state, plus the manager so other plugins (e.g. media) can use it. */
+export type AnnotationSharedState = InlineCommentPluginState & {
+    annotationManager?: AnnotationManager;
+};
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     actions: {
         /**
@@ -35,6 +40,15 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
          * @returns A command that returns true when the draft is applied.
          */
         applyInlineCommentDraft: (annotationId: string) => Command;
+        /**
+         * Whether the current user can add comments, from the provider's
+         * `getCanAddComments` (defaults to true), and the provider's content type
+         * for the no-permission message.
+         */
+        getAddCommentPermission: () => {
+            canAddComments: boolean;
+            contentType?: string;
+        };
         hasAnyUnResolvedAnnotationInPage: (state: EditorState) => boolean;
         /** Whether the configured provider supports block comments on this node. */
         isBlockNodeSupported: (node: Node) => boolean;
@@ -73,7 +87,7 @@ export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     };
     dependencies: AnnotationPluginDependencies;
     pluginConfiguration: AnnotationPluginOptions | undefined;
-    sharedState: InlineCommentPluginState | undefined;
+    sharedState: AnnotationSharedState | undefined;
 }>;
 export type AnnotationPluginInjectionAPI = ExtractInjectionAPI<AnnotationPlugin> | undefined;
 export {};

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

@@ -6,7 +6,7 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-edi
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { AnnotationPlugin } from '../annotationPluginType';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
-import type { InlineCommentAnnotationProvider, InlineCommentInputMethod, TargetType } from '../types';
+import type { AnnotationProviders, InlineCommentAnnotationProvider, InlineCommentInputMethod, TargetType } 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;
@@ -22,7 +22,7 @@ export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnal
  * @example
  */
 export declare const showInlineCommentForBlockNode: (supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => (node: PMNode | null, viewMethod?: VIEW_METHOD, isOpeningMediaCommentFromToolbar?: boolean) => Command;
-export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[], api?: ExtractInjectionAPI<AnnotationPlugin>, isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;
+export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, supportedBlockNodes?: string[], api?: ExtractInjectionAPI<AnnotationPlugin>, isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported'], createCommentExperience?: AnnotationProviders['createCommentExperience']) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, targetNodeId?: string | undefined, isOpeningMediaCommentFromToolbar?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string, supportedBlockNodes?: string[], isBlockNodeSupported?: InlineCommentAnnotationProvider['isBlockNodeSupported']) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;

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

@@ -3,7 +3,7 @@ import type { ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraf
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginOptions } from './types';
 export declare const allowAnnotation: (editorView: EditorView, options: InlineCommentPluginOptions) => () => boolean;
-export declare const startDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => StartDraftResult;
+export declare const startDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => (localId?: string) => StartDraftResult;
 export declare const clearDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => () => ClearDraftResult;
 export declare const applyDraft: (editorView: EditorView, options: InlineCommentPluginOptions) => (id: AnnotationId) => ApplyDraftResult;
 export declare const getDraft: (editorView: EditorView, _options: InlineCommentPluginOptions) => () => GetDraftResult;

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

@@ -138,7 +138,8 @@ export interface AnnotationProviders {
                 pageClass: 'editor';
             } | {
                 annotationId?: undefined;
-                blockType: 'media';
+                blockType: 'media' | 'extension';
+                commentTargetType?: 'remixEmbed';
                 commentType: 'block';
                 entryPoint?: 'highlightActions';
                 pageClass: 'editor';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "27.0.6",
+	"version": "28.1.0",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,12 +20,12 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^57.7.0",
-		"@atlaskit/editor-plugin-analytics": "^27.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^27.0.0",
-		"@atlaskit/editor-plugin-editor-viewmode-effects": "^27.0.0",
-		"@atlaskit/editor-plugin-feature-flags": "^26.0.0",
-		"@atlaskit/editor-plugin-toolbar": "^24.0.0",
-		"@atlaskit/editor-plugin-user-intent": "^25.0.0",
+		"@atlaskit/editor-plugin-analytics": "^28.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^28.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode-effects": "^28.0.0",
+		"@atlaskit/editor-plugin-feature-flags": "^27.0.0",
+		"@atlaskit/editor-plugin-toolbar": "^25.0.0",
+		"@atlaskit/editor-plugin-user-intent": "^26.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@atlaskit/editor-toolbar": "^2.8.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
@@ -35,7 +35,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^131.4.0",
+		"@atlaskit/editor-common": "^132.0.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"