@atlaskit/editor-plugin-type-ahead 2.4.2 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-type-ahead
 
+## 2.5.0
+
+### Minor Changes
+
+- [#139089](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/139089)
+  [`69dcdc0c4a543`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/69dcdc0c4a543) -
+  ED-26588 Start activity session and persist active session when type ahead and element broswer is
+  open
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.4.2
 
 ### Patch Changes

package/dist/cjs/pm-plugins/decorations.js

@@ -150,6 +150,10 @@ var factoryDecorations = exports.factoryDecorations = function factoryDecoration
       }
       nodeViewPortalProviderAPI.remove(spec.key);
     });
+    if ((0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.startActiveSessionTimer());
+    }
     return true;
   };
   return {

package/dist/cjs/pm-plugins/main.js

@@ -8,6 +8,7 @@ var _steps = require("@atlaskit/adf-schema/steps");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _view = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _actions = require("./actions");
 var _constants = require("./constants");
 var _decorations = require("./decorations");
@@ -79,6 +80,12 @@ function createPlugin(_ref) {
       if (insertItemCallback) {
         var tr = insertItemCallback(newState);
         if (tr) {
+          if ((0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
+            var _api$metrics;
+            api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 || _api$metrics.commands.startActiveSessionTimer()({
+              tr: tr
+            });
+          }
           return tr;
         }
       }

package/dist/cjs/typeAheadPlugin.js

@@ -11,6 +11,7 @@ var _analytics = require("@atlaskit/editor-common/analytics");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _typeAhead = require("@atlaskit/editor-common/type-ahead");
 var _view2 = require("@atlaskit/editor-prosemirror/view");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _closeTypeAhead = require("./pm-plugins/commands/close-type-ahead");
 var _insertTypeAheadItem = require("./pm-plugins/commands/insert-type-ahead-item");
 var _openTypeaheadAtCursor = require("./pm-plugins/commands/open-typeahead-at-cursor");
@@ -283,8 +284,17 @@ var typeAheadPlugin = exports.typeAheadPlugin = function typeAheadPlugin(_ref) {
         });
       }
       if (newTriggerHandler !== null && newTriggerHandler !== void 0 && newTriggerHandler.onOpen && isANewHandler) {
+        if ((0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
+          var _api$metrics;
+          api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 || _api$metrics.commands.handleIntentToStartEdit({
+            shouldStartTimer: false,
+            shouldPersistActiveSession: true
+          });
+        }
         newTriggerHandler.onOpen(newEditorState);
       }
+      var oldIsOpen = (0, _utils.isTypeAheadOpen)(oldEditorState);
+      var newIsOpen = (0, _utils.isTypeAheadOpen)(newEditorState);
       if (newTriggerHandler && isANewHandler) {
         // if the typeahead opens another typeahead via the quickInsert we do NOT want to fire this analytic event (mentions and emojis) as it is already being fired from editor-plugin-analytics
         var isDuplicateInvokedEvent = newPluginState.inputMethod === _analytics.INPUT_METHOD.QUICK_INSERT && Object.values(_typeAhead.TypeAheadAvailableNodes).includes(newTriggerHandler.id);
@@ -300,6 +310,9 @@ var typeAheadPlugin = exports.typeAheadPlugin = function typeAheadPlugin(_ref) {
             eventType: _analytics.EVENT_TYPE.UI
           });
         }
+      } else if (oldIsOpen && !newIsOpen && (0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
+        var _api$metrics2;
+        api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics2 = api.metrics) === null || _api$metrics2 === void 0 ? void 0 : _api$metrics2.commands.startActiveSessionTimer());
       }
     }
   };

package/dist/cjs/ui/WrapperTypeAhead.js

@@ -49,6 +49,15 @@ var WrapperTypeAhead = exports.WrapperTypeAhead = /*#__PURE__*/_react.default.me
   var queryRef = (0, _react.useRef)(query);
   var editorViewRef = (0, _react.useRef)(editorView);
   var items = (0, _useLoadItems.useLoadItems)(triggerHandler, editorView, query, showViewMore);
+  (0, _react.useEffect)(function () {
+    if (!closed && (0, _platformFeatureFlags.fg)('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.handleIntentToStartEdit({
+        shouldStartTimer: false,
+        shouldPersistActiveSession: true
+      }));
+    }
+  }, [closed, api]);
   (0, _react.useLayoutEffect)(function () {
     queryRef.current = query;
   }, [query]);

package/dist/es2019/pm-plugins/decorations.js

@@ -150,6 +150,10 @@ export const factoryDecorations = ({
       }
       nodeViewPortalProviderAPI.remove(spec.key);
     });
+    if (fg('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.startActiveSessionTimer());
+    }
     return true;
   };
   return {

package/dist/es2019/pm-plugins/main.js

@@ -2,6 +2,7 @@ import { InsertTypeAheadStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { closest } from '@atlaskit/editor-common/utils';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTIONS } from './actions';
 import { TYPE_AHEAD_DECORATION_DATA_ATTRIBUTE } from './constants';
 import { factoryDecorations } from './decorations';
@@ -73,6 +74,12 @@ export function createPlugin({
       if (insertItemCallback) {
         const tr = insertItemCallback(newState);
         if (tr) {
+          if (fg('platform_editor_ease_of_use_metrics')) {
+            var _api$metrics;
+            api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.startActiveSessionTimer()({
+              tr
+            });
+          }
           return tr;
         }
       }

package/dist/es2019/typeAheadPlugin.js

@@ -12,6 +12,7 @@ import { ACTION, ACTION_SUBJECT, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/edit
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { SelectItemMode, TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { closeTypeAhead } from './pm-plugins/commands/close-type-ahead';
 import { insertTypeAheadItem } from './pm-plugins/commands/insert-type-ahead-item';
 import { openTypeAheadAtCursor } from './pm-plugins/commands/open-typeahead-at-cursor';
@@ -283,8 +284,17 @@ export const typeAheadPlugin = ({
         });
       }
       if (newTriggerHandler !== null && newTriggerHandler !== void 0 && newTriggerHandler.onOpen && isANewHandler) {
+        if (fg('platform_editor_ease_of_use_metrics')) {
+          var _api$metrics;
+          api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.handleIntentToStartEdit({
+            shouldStartTimer: false,
+            shouldPersistActiveSession: true
+          });
+        }
         newTriggerHandler.onOpen(newEditorState);
       }
+      const oldIsOpen = isTypeAheadOpen(oldEditorState);
+      const newIsOpen = isTypeAheadOpen(newEditorState);
       if (newTriggerHandler && isANewHandler) {
         // if the typeahead opens another typeahead via the quickInsert we do NOT want to fire this analytic event (mentions and emojis) as it is already being fired from editor-plugin-analytics
         const isDuplicateInvokedEvent = newPluginState.inputMethod === INPUT_METHOD.QUICK_INSERT && Object.values(TypeAheadAvailableNodes).includes(newTriggerHandler.id);
@@ -300,6 +310,9 @@ export const typeAheadPlugin = ({
             eventType: EVENT_TYPE.UI
           });
         }
+      } else if (oldIsOpen && !newIsOpen && fg('platform_editor_ease_of_use_metrics')) {
+        var _api$metrics2;
+        api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$metrics2 = api.metrics) === null || _api$metrics2 === void 0 ? void 0 : _api$metrics2.commands.startActiveSessionTimer());
       }
     }
   };

package/dist/es2019/ui/WrapperTypeAhead.js

@@ -33,6 +33,15 @@ export const WrapperTypeAhead = /*#__PURE__*/React.memo(({
   const queryRef = useRef(query);
   const editorViewRef = useRef(editorView);
   const items = useLoadItems(triggerHandler, editorView, query, showViewMore);
+  useEffect(() => {
+    if (!closed && fg('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.handleIntentToStartEdit({
+        shouldStartTimer: false,
+        shouldPersistActiveSession: true
+      }));
+    }
+  }, [closed, api]);
   useLayoutEffect(() => {
     queryRef.current = query;
   }, [query]);

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

@@ -143,6 +143,10 @@ export var factoryDecorations = function factoryDecorations(_ref) {
       }
       nodeViewPortalProviderAPI.remove(spec.key);
     });
+    if (fg('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.startActiveSessionTimer());
+    }
     return true;
   };
   return {

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

@@ -2,6 +2,7 @@ import { InsertTypeAheadStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { closest } from '@atlaskit/editor-common/utils';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTIONS } from './actions';
 import { TYPE_AHEAD_DECORATION_DATA_ATTRIBUTE } from './constants';
 import { factoryDecorations } from './decorations';
@@ -73,6 +74,12 @@ export function createPlugin(_ref) {
       if (insertItemCallback) {
         var tr = insertItemCallback(newState);
         if (tr) {
+          if (fg('platform_editor_ease_of_use_metrics')) {
+            var _api$metrics;
+            api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 || _api$metrics.commands.startActiveSessionTimer()({
+              tr: tr
+            });
+          }
           return tr;
         }
       }

package/dist/esm/typeAheadPlugin.js

@@ -12,6 +12,7 @@ import { ACTION, ACTION_SUBJECT, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/edit
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { SelectItemMode, TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { closeTypeAhead } from './pm-plugins/commands/close-type-ahead';
 import { insertTypeAheadItem } from './pm-plugins/commands/insert-type-ahead-item';
 import { openTypeAheadAtCursor } from './pm-plugins/commands/open-typeahead-at-cursor';
@@ -275,8 +276,17 @@ export var typeAheadPlugin = function typeAheadPlugin(_ref) {
         });
       }
       if (newTriggerHandler !== null && newTriggerHandler !== void 0 && newTriggerHandler.onOpen && isANewHandler) {
+        if (fg('platform_editor_ease_of_use_metrics')) {
+          var _api$metrics;
+          api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 || _api$metrics.commands.handleIntentToStartEdit({
+            shouldStartTimer: false,
+            shouldPersistActiveSession: true
+          });
+        }
         newTriggerHandler.onOpen(newEditorState);
       }
+      var oldIsOpen = isTypeAheadOpen(oldEditorState);
+      var newIsOpen = isTypeAheadOpen(newEditorState);
       if (newTriggerHandler && isANewHandler) {
         // if the typeahead opens another typeahead via the quickInsert we do NOT want to fire this analytic event (mentions and emojis) as it is already being fired from editor-plugin-analytics
         var isDuplicateInvokedEvent = newPluginState.inputMethod === INPUT_METHOD.QUICK_INSERT && Object.values(TypeAheadAvailableNodes).includes(newTriggerHandler.id);
@@ -292,6 +302,9 @@ export var typeAheadPlugin = function typeAheadPlugin(_ref) {
             eventType: EVENT_TYPE.UI
           });
         }
+      } else if (oldIsOpen && !newIsOpen && fg('platform_editor_ease_of_use_metrics')) {
+        var _api$metrics2;
+        api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics2 = api.metrics) === null || _api$metrics2 === void 0 ? void 0 : _api$metrics2.commands.startActiveSessionTimer());
       }
     }
   };

package/dist/esm/ui/WrapperTypeAhead.js

@@ -39,6 +39,15 @@ export var WrapperTypeAhead = /*#__PURE__*/React.memo(function (_ref) {
   var queryRef = useRef(query);
   var editorViewRef = useRef(editorView);
   var items = useLoadItems(triggerHandler, editorView, query, showViewMore);
+  useEffect(function () {
+    if (!closed && fg('platform_editor_ease_of_use_metrics')) {
+      var _api$metrics;
+      api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.handleIntentToStartEdit({
+        shouldStartTimer: false,
+        shouldPersistActiveSession: true
+      }));
+    }
+  }, [closed, api]);
   useLayoutEffect(function () {
     queryRef.current = query;
   }, [query]);

package/dist/types/typeAheadPluginType.d.ts

@@ -4,6 +4,7 @@ import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
 import type { ContextPanelPlugin } from '@atlaskit/editor-plugin-context-panel';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { MetricsPlugin } from '@atlaskit/editor-plugin-metrics';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import { type TypeAheadPluginOptions, type TypeAheadPluginSharedState, type OpenTypeAheadProps } from './types';
 type InsertTypeAheadItemProps = {
@@ -27,7 +28,8 @@ export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<FeatureFlagsPlugin>,
         OptionalPlugin<ConnectivityPlugin>,
-        OptionalPlugin<ContextPanelPlugin>
+        OptionalPlugin<ContextPanelPlugin>,
+        OptionalPlugin<MetricsPlugin>
     ];
     sharedState: TypeAheadPluginSharedState;
     actions: {

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

@@ -4,6 +4,7 @@ import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
 import type { ContextPanelPlugin } from '@atlaskit/editor-plugin-context-panel';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { MetricsPlugin } from '@atlaskit/editor-plugin-metrics';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import { type TypeAheadPluginOptions, type TypeAheadPluginSharedState, type OpenTypeAheadProps } from './types';
 type InsertTypeAheadItemProps = {
@@ -27,7 +28,8 @@ export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<FeatureFlagsPlugin>,
         OptionalPlugin<ConnectivityPlugin>,
-        OptionalPlugin<ContextPanelPlugin>
+        OptionalPlugin<ContextPanelPlugin>,
+        OptionalPlugin<MetricsPlugin>
     ];
     sharedState: TypeAheadPluginSharedState;
     actions: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-type-ahead",
-	"version": "2.4.2",
+	"version": "2.5.0",
 	"description": "Type-ahead plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,11 +34,12 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^103.8.0",
+		"@atlaskit/editor-common": "^103.9.0",
 		"@atlaskit/editor-element-browser": "^0.1.0",
 		"@atlaskit/editor-plugin-analytics": "^2.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
 		"@atlaskit/editor-plugin-context-panel": "^4.0.0",
+		"@atlaskit/editor-plugin-metrics": "^3.4.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/heading": "^5.2.0",
@@ -48,7 +49,7 @@
 		"@atlaskit/primitives": "^14.4.0",
 		"@atlaskit/prosemirror-input-rules": "^3.3.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tmp-editor-statsig": "^4.10.0",
+		"@atlaskit/tmp-editor-statsig": "^4.11.0",
 		"@atlaskit/tokens": "^4.8.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
@@ -112,6 +113,9 @@
 		},
 		"platform_editor_controls_patch_4": {
 			"type": "boolean"
+		},
+		"platform_editor_ease_of_use_metrics": {
+			"type": "boolean"
 		}
 	}
 }