@atlaskit/editor-plugin-annotation 2.7.2 → 2.7.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-annotation
 
+## 2.7.4
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.7.3
+
+### Patch Changes
+
+- [#146979](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/146979)
+  [`5cea1d6e69c56`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5cea1d6e69c56) -
+  ED-27655: Moving annotation plugin options from confluence's full page editor preset to the
+  confluence-presets.
+- Updated dependencies
+
 ## 2.7.2
 
 ### Patch Changes

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

@@ -244,6 +244,7 @@ var inlineCommentPlugin = exports.inlineCommentPlugin = function inlineCommentPl
             // This ensures that the selected annotation is unresolved
             annotations && annotations[selectedAnnotationId] === false) {
               var _options$selectCommen;
+              // Under the confluence_comments_select_comment_experience feature flag, the selectComponentExperience is using a simplified object, which is why it's type asserted.
               (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
             }
           }

package/dist/cjs/types/index.js

@@ -26,4 +26,9 @@ var AnnotationTestIds = exports.AnnotationTestIds = {
   floatingToolbarCreateButton: "".concat(prefix, "-toolbar-create-button"),
   componentSave: "".concat(prefix, "-dummy-save-button"),
   componentClose: "".concat(prefix, "-dummy-close-button")
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

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

@@ -180,6 +180,7 @@ export const inlineCommentPlugin = options => {
             // This ensures that the selected annotation is unresolved
             annotations && annotations[selectedAnnotationId] === false) {
               var _options$selectCommen;
+              // Under the confluence_comments_select_comment_experience feature flag, the selectComponentExperience is using a simplified object, which is why it's type asserted.
               (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 ? void 0 : _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
             }
           }

package/dist/es2019/types/index.js

@@ -22,4 +22,9 @@ export const AnnotationTestIds = {
   floatingToolbarCreateButton: `${prefix}-toolbar-create-button`,
   componentSave: `${prefix}-dummy-save-button`,
   componentClose: `${prefix}-dummy-close-button`
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

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

@@ -237,6 +237,7 @@ export var inlineCommentPlugin = function inlineCommentPlugin(options) {
             // This ensures that the selected annotation is unresolved
             annotations && annotations[selectedAnnotationId] === false) {
               var _options$selectCommen;
+              // Under the confluence_comments_select_comment_experience feature flag, the selectComponentExperience is using a simplified object, which is why it's type asserted.
               (_options$selectCommen = options.selectCommentExperience) === null || _options$selectCommen === void 0 || _options$selectCommen.selectAnnotation.complete(selectedAnnotationId);
             }
           }

package/dist/esm/types/index.js

@@ -22,4 +22,9 @@ export var AnnotationTestIds = {
   floatingToolbarCreateButton: "".concat(prefix, "-toolbar-create-button"),
   componentSave: "".concat(prefix, "-dummy-save-button"),
   componentClose: "".concat(prefix, "-dummy-close-button")
-};
+};
+
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { annotationPlugin } from './annotationPlugin';
 export type { AnnotationPlugin, AnnotationPluginOptions } from './annotationPluginType';
-export type { AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, TargetType, InlineCommentInputMethod, } from './types';
+export type { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCompoundExperience, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, SelectInlineCommentCompoundExperience, SelectInlineCommentCompoundExperienceEntryPoint, SimpleSelectInlineCommentCompoundExperience, StartAttributes, TargetType, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -1,5 +1,6 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -104,28 +105,8 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: {
-        start: (_: {
-            attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
-                annotationId?: undefined;
-            } | {
-                pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
-                annotationId?: undefined;
-            };
-        }) => void;
-        initExperience: {
-            start: () => void;
-        };
-    };
-    selectCommentExperience?: {
-        selectAnnotation: {
-            complete: (annotationId: string) => void;
-        };
-    };
+    createCommentExperience?: InlineCommentCompoundExperience;
+    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -152,4 +133,135 @@ export type DraftBookmark = {
     head: number;
     isBlockNode?: boolean;
 };
+type ExperienceAttributes = {
+    [key: string]: string | number | boolean | string[] | number[];
+};
+type InlineCommentAttributes = {
+    pageClass: 'editor';
+    commentType: 'inline';
+    annotationId?: undefined;
+} | {
+    pageClass: 'editor';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId?: undefined;
+} | {
+    pageClass: 'renderer';
+    commentType: 'inline';
+    annotationId: string;
+} | {
+    pageClass: 'renderer';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId: string;
+};
+export type SelectInlineCommentCompoundExperienceEntryPoint = 'create-comment' | 'annotation-change' | 'comment-navigation' | 'keyboard-navigation' | 'sidebar' | 'unknown:RendererFocus' | 'unknown:InlineComment' | 'unknown:CommentsPanelList';
+export type StartAttributes = {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    annotationId: string;
+    entryPoint: Exclude<SelectInlineCommentCompoundExperienceEntryPoint, 'keyboard-navigation' | 'comment-navigation'>;
+    linkedCompoundTaskId?: string;
+} | {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    entryPoint: 'keyboard-navigation' | 'comment-navigation';
+    linkedCompoundTaskId?: string;
+};
+type ExperienceDebugFunction = (params: {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    error: Error;
+    extraAttributes?: ExperienceAttributes;
+}) => void;
+export type InlineCommentCompoundExperience = {
+    start: (params: {
+        attributes: InlineCommentAttributes;
+    }) => void;
+    debug: ExperienceDebugFunction;
+    addCommonAttributes: (commonAttributes: ExperienceAttributes) => void;
+    attachCommonAttributes: (experienceName: string) => void;
+    initExperience: {
+        start: () => void;
+        fail: (error: Error) => void;
+        softFail: (error: Error) => void;
+        abort: (params: {
+            abortReason: 'Draft annotation removed from document';
+        }) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+    };
+    draftToPublishExperience: {
+        start: () => void;
+        publishFailed: (error: Error) => void;
+        publishSucceeded: () => void;
+        abort: (params: {
+            abortReason: 'Create Comment UI dismissed' | 'Unable to apply annotation to document';
+        }) => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        dismissed: () => void;
+        softFail: (error: Error) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+    attachCommentExperience: {
+        start: () => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+};
+export type SelectInlineCommentCompoundExperience = {
+    _start: (startAttributes: StartAttributes) => void;
+    addCommonAttributes: (additionalCommonAttributes: {
+        [key: string]: string | number | boolean;
+    }) => void;
+    abort: (params: {
+        abortReason: 'test abort';
+    }) => void;
+    selectAnnotation: {
+        debug: ExperienceDebugFunction;
+        start: (startAttributes: StartAttributes) => void;
+        abort: (params: {
+            abortReason: 'Comment navigation when only one comment';
+        }) => void;
+        complete: (startAttributes: StartAttributes) => void;
+    };
+    showComment: {
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: {
+            [key: string]: string | number | boolean;
+        }) => void;
+        start: (startAttributes: StartAttributes & {
+            annotationId: string;
+        }) => void;
+        abort: (params: {
+            abortReason: 'Non inline comment being shown' | 'Comment sidebar dismissed';
+        }) => void;
+        fail: (error: Error, extraAttributes?: {
+            misalignedBy: number;
+        }) => void;
+        complete: () => void;
+    };
+};
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */
+export type SimpleSelectInlineCommentCompoundExperience = {
+    selectAnnotation: {
+        complete: (annotationId: string) => void;
+    };
+};
 export {};

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

@@ -1,4 +1,4 @@
 export { annotationPlugin } from './annotationPlugin';
 export type { AnnotationPlugin, AnnotationPluginOptions } from './annotationPluginType';
-export type { AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, TargetType, InlineCommentInputMethod, } from './types';
+export type { AnnotationInfo, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCompoundExperience, InlineCommentCreateComponentProps, InlineCommentInputMethod, InlineCommentState, InlineCommentViewComponentProps, SelectInlineCommentCompoundExperience, SelectInlineCommentCompoundExperienceEntryPoint, SimpleSelectInlineCommentCompoundExperience, StartAttributes, TargetType, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -1,5 +1,6 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter, AnnotationManager } from '@atlaskit/editor-common/annotation';
 /**
@@ -104,28 +105,8 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export interface AnnotationProviders {
     inlineComment: InlineCommentAnnotationProvider;
-    createCommentExperience?: {
-        start: (_: {
-            attributes: {
-                pageClass: 'editor';
-                commentType: 'inline';
-                annotationId?: undefined;
-            } | {
-                pageClass: 'editor';
-                commentType: 'block';
-                blockType: 'media';
-                annotationId?: undefined;
-            };
-        }) => void;
-        initExperience: {
-            start: () => void;
-        };
-    };
-    selectCommentExperience?: {
-        selectAnnotation: {
-            complete: (annotationId: string) => void;
-        };
-    };
+    createCommentExperience?: InlineCommentCompoundExperience;
+    selectCommentExperience?: SimpleSelectInlineCommentCompoundExperience;
     annotationManager?: AnnotationManager;
 }
 export declare enum AnnotationSelectionType {
@@ -152,4 +133,135 @@ export type DraftBookmark = {
     head: number;
     isBlockNode?: boolean;
 };
+type ExperienceAttributes = {
+    [key: string]: string | number | boolean | string[] | number[];
+};
+type InlineCommentAttributes = {
+    pageClass: 'editor';
+    commentType: 'inline';
+    annotationId?: undefined;
+} | {
+    pageClass: 'editor';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId?: undefined;
+} | {
+    pageClass: 'renderer';
+    commentType: 'inline';
+    annotationId: string;
+} | {
+    pageClass: 'renderer';
+    commentType: 'block';
+    blockType: 'media';
+    annotationId: string;
+};
+export type SelectInlineCommentCompoundExperienceEntryPoint = 'create-comment' | 'annotation-change' | 'comment-navigation' | 'keyboard-navigation' | 'sidebar' | 'unknown:RendererFocus' | 'unknown:InlineComment' | 'unknown:CommentsPanelList';
+export type StartAttributes = {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    annotationId: string;
+    entryPoint: Exclude<SelectInlineCommentCompoundExperienceEntryPoint, 'keyboard-navigation' | 'comment-navigation'>;
+    linkedCompoundTaskId?: string;
+} | {
+    pageClass: 'editor' | 'renderer';
+    /**
+     * This is optional as in some scenarios the entry point does not know
+     * what type of comment is being selected (e.g. comment navigation, sidebar).
+     **/
+    commentType?: 'block' | 'inline';
+    blockType?: 'media';
+    entryPoint: 'keyboard-navigation' | 'comment-navigation';
+    linkedCompoundTaskId?: string;
+};
+type ExperienceDebugFunction = (params: {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    error: Error;
+    extraAttributes?: ExperienceAttributes;
+}) => void;
+export type InlineCommentCompoundExperience = {
+    start: (params: {
+        attributes: InlineCommentAttributes;
+    }) => void;
+    debug: ExperienceDebugFunction;
+    addCommonAttributes: (commonAttributes: ExperienceAttributes) => void;
+    attachCommonAttributes: (experienceName: string) => void;
+    initExperience: {
+        start: () => void;
+        fail: (error: Error) => void;
+        softFail: (error: Error) => void;
+        abort: (params: {
+            abortReason: 'Draft annotation removed from document';
+        }) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+    };
+    draftToPublishExperience: {
+        start: () => void;
+        publishFailed: (error: Error) => void;
+        publishSucceeded: () => void;
+        abort: (params: {
+            abortReason: 'Create Comment UI dismissed' | 'Unable to apply annotation to document';
+        }) => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        dismissed: () => void;
+        softFail: (error: Error) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+    attachCommentExperience: {
+        start: () => void;
+        fail: (error: Error, attributes?: ExperienceAttributes) => void;
+        complete: () => void;
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: ExperienceAttributes) => void;
+    };
+};
+export type SelectInlineCommentCompoundExperience = {
+    _start: (startAttributes: StartAttributes) => void;
+    addCommonAttributes: (additionalCommonAttributes: {
+        [key: string]: string | number | boolean;
+    }) => void;
+    abort: (params: {
+        abortReason: 'test abort';
+    }) => void;
+    selectAnnotation: {
+        debug: ExperienceDebugFunction;
+        start: (startAttributes: StartAttributes) => void;
+        abort: (params: {
+            abortReason: 'Comment navigation when only one comment';
+        }) => void;
+        complete: (startAttributes: StartAttributes) => void;
+    };
+    showComment: {
+        debug: ExperienceDebugFunction;
+        debugPoint: (message: string, attributes?: {
+            [key: string]: string | number | boolean;
+        }) => void;
+        start: (startAttributes: StartAttributes & {
+            annotationId: string;
+        }) => void;
+        abort: (params: {
+            abortReason: 'Non inline comment being shown' | 'Comment sidebar dismissed';
+        }) => void;
+        fail: (error: Error, extraAttributes?: {
+            misalignedBy: number;
+        }) => void;
+        complete: () => void;
+    };
+};
+/**
+ * Alternative to SelectInlineCommentCompoundExperience, used for the annotation plugin options
+ * in the confluence editor presets. See createFullPageEditorPreset.ts or annotationPluginOptions.ts for usage.
+ */
+export type SimpleSelectInlineCommentCompoundExperience = {
+    selectAnnotation: {
+        complete: (annotationId: string) => void;
+    };
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.7.2",
+	"version": "2.7.4",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,8 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^103.18.0",
+		"@atlaskit/analytics-next": "^11.0.0",
+		"@atlaskit/editor-common": "^104.0.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 +42,7 @@
 		"@atlaskit/icon": "^25.6.0",
 		"@atlaskit/onboarding": "^14.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^4.14.0",
+		"@atlaskit/tmp-editor-statsig": "^4.16.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {