@atlaskit/editor-plugin-annotation 2.9.1 → 2.9.3

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

@@ -31,7 +31,7 @@ export default (function (pluginState, action) {
         isOpeningMediaCommentFromToolbar: false
       }, fg('platform_editor_annotation_selected_annotation') && {
         selectedAnnotations: []
-      }), fg('platform_editor_comments_api_manager_select') && {
+      }), pluginState.isAnnotationManagerEnabled && {
         selectedAnnotations: []
       });
     case ACTIONS.ADD_INLINE_COMMENT:
@@ -41,7 +41,7 @@ export default (function (pluginState, action) {
         annotations: _objectSpread(_objectSpread({}, pluginState.annotations), action.data.inlineComments),
         isInlineCommentViewClosed: false,
         selectAnnotationMethod: undefined
-      }, fg('platform_editor_comments_api_manager_select') && {
+      }, pluginState.isAnnotationManagerEnabled && {
         skipSelectionHandling: true
       });
     case ACTIONS.INLINE_COMMENT_SET_VISIBLE:

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

@@ -116,25 +116,17 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
         }
       },
       onClick: function onClick(state, dispatch) {
-        if (editorAnalyticsAPI) {
-          editorAnalyticsAPI.fireAnalyticsEvent({
-            action: ACTION.CLICKED,
-            actionSubject: ACTION_SUBJECT.BUTTON,
-            actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
-            eventType: EVENT_TYPE.UI,
-            attributes: {
-              source: 'highlightActionsMenu',
-              pageMode: 'edit'
-            }
-          });
-        }
-        if (fg('platform_editor_comments_api_manager')) {
-          if (!annotationManager) {
-            // TODO: EDITOR-595 - If we've reached here and the manager is not initialized, we should
-            // dispatch an analytics event to indicate that the user has clicked the button but
-            // the action was not completed.
-            return false;
+        editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+          action: ACTION.CLICKED,
+          actionSubject: ACTION_SUBJECT.BUTTON,
+          actionSubjectId: ACTION_SUBJECT_ID.CREATE_INLINE_COMMENT_FROM_HIGHLIGHT_ACTIONS_MENU,
+          eventType: EVENT_TYPE.UI,
+          attributes: {
+            source: 'highlightActionsMenu',
+            pageMode: 'edit'
           }
+        });
+        if (annotationManager) {
           annotationManager.checkPreemptiveGate().then(function (canStartDraft) {
             if (canStartDraft) {
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.start({
@@ -145,18 +137,30 @@ export var buildToolbar = function buildToolbar(editorAnalyticsAPI) {
               });
               createCommentExperience === null || createCommentExperience === void 0 || createCommentExperience.initExperience.start();
               var result = annotationManager.startDraft();
-              if (result.success) {
-                // TODO: EDITOR-595 - Ensure and anlytic is fired to indicate that the user has started a draft.
-              } else {
-                // TODO: EDITOR-595 - Fire an analytics event to indicate that the user has clicked the button
+              if (!result.success) {
+                // Fire an analytics event to indicate that the user has clicked the button
                 // but the action was not completed, the result should contain a reason.
+                editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+                  action: ACTION.ERROR,
+                  actionSubject: ACTION_SUBJECT.ANNOTATION,
+                  actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+                  eventType: EVENT_TYPE.OPERATIONAL,
+                  attributes: {
+                    errorReason: "toolbar-start-draft-failed/".concat(result.reason)
+                  }
+                });
               }
-            } else {
-              // TODO: EDITOR-595 - Track the toolbar comment button was clicked but the preemptive gate
-              // check returned false and the draft cannot be started.
             }
           }).catch(function () {
-            // TODO: EDITOR-595 - Handle preemptive gate check error. Something went very wrong in the gate.
+            editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.fireAnalyticsEvent({
+              action: ACTION.ERROR,
+              actionSubject: ACTION_SUBJECT.ANNOTATION,
+              actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
+              eventType: EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                errorReason: "toolbar-start-draft-preemptive-gate-error"
+              }
+            });
           });
           return true;
         } else {

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

@@ -9,10 +9,10 @@ import type { 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;
-export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const flushPendingSelections: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (canSetAsSelectedAnnotations: boolean, errorReason?: string) => Command;
 export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.

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

@@ -18,5 +18,7 @@ declare const _default: {
     addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
     addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addPreemptiveGateErrorAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (errorReason?: string | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addDeleteAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
 };
 export default _default;

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

@@ -162,4 +162,8 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
 };

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

@@ -9,10 +9,10 @@ import type { 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;
-export declare const flushPendingSelections: (canSetAsSelectedAnnotations: boolean) => Command;
+export declare const flushPendingSelections: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (canSetAsSelectedAnnotations: boolean, errorReason?: string) => Command;
 export declare const setPendingSelectedAnnotation: (id: string) => Command;
 export declare const removeInlineCommentNearSelection: (id: string, supportedNodes?: string[]) => Command;
-export declare const removeInlineCommentFromDoc: (id: string, supportedNodes?: string[]) => Command;
+export declare const removeInlineCommentFromDoc: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, supportedNodes?: string[]) => Command;
 /**
  * Show active inline comments for a given block node, otherwise,
  * return false if the node has no comments or no unresolved comments.

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

@@ -18,5 +18,7 @@ declare const _default: {
     addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
     addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addPreemptiveGateErrorAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (errorReason?: string | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addDeleteAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
 };
 export default _default;

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

@@ -162,4 +162,8 @@ export type InlineCommentPluginState = {
      * if the pendingSelectedAnnotations has been updated since the last time it was flushed to selectedAnnotations.
      */
     pendingSelectedAnnotationsUpdateCount: number;
+    /**
+     * A simple toggle to indicate if the annotation manager is enabled.
+     */
+    isAnnotationManagerEnabled: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-annotation",
-	"version": "2.9.1",
+	"version": "2.9.3",
 	"description": "Annotation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlaskit/analytics-next": "^11.0.0",
-		"@atlaskit/editor-common": "^106.0.0",
+		"@atlaskit/editor-common": "^106.1.0",
 		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode-effects": "^2.0.0",
@@ -42,7 +42,7 @@
 		"@atlaskit/icon": "^26.4.0",
 		"@atlaskit/onboarding": "^14.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^5.2.0",
+		"@atlaskit/tmp-editor-statsig": "^5.7.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -97,9 +97,6 @@
 		"platform_editor_comments_api_manager": {
 			"type": "boolean"
 		},
-		"platform_editor_comments_api_manager_select": {
-			"type": "boolean"
-		},
 		"editor_inline_comments_on_inline_nodes": {
 			"type": "boolean"
 		},