@atlaskit/editor-plugin-mentions 14.5.8 → 14.5.9

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-mentions
 
+## 14.5.9
+
+### Patch Changes
+
+- [`25b1301af566b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/25b1301af566b) -
+  [ux] Make Labs lozenge text capitalised
+- [`d2f1039e54388`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2f1039e54388) -
+  Defer typed agent mention nudges while focus remains in the active document but outside the
+  editor, such as when typeahead, date, or status picker UI is open.
+- Updated dependencies
+
 ## 14.5.8
 
 ### Patch Changes

package/compass.yml

@@ -24,6 +24,9 @@ customFields:
   - name: Department
     type: text
     value: Eng - Editor AI
+  - name: Trusted Reviewer Teams
+    type: text
+    value: ari:cloud:identity::team/cf6a670b-5252-4c68-a769-9207de366beb
   - name: Technical Owner
     type: user
     value: ari:cloud:identity::user/612646c53fe26c00694fbe6a # Chris Kimber

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

@@ -49,8 +49,9 @@ var getAgentMentionName = function getAgentMentionName(text, fallbackName) {
 };
 var AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 var AGENT_MENTION_INACTIVITY_MS = 3000;
+var MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "14.5.7";
+var PACKAGE_VERSION = "14.5.8";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {
@@ -624,14 +625,47 @@ function createMentionPlugin(_ref2) {
       var isAgentMentionsEnabled = (0, _experiments.editorExperiment)('platform_editor_agent_mentions', true);
       var pendingTypedAgentMentionTimer;
       var pendingTypedAgentMentionTimerKey = null;
+      var pendingTypedAgentMentionFocusDeferCount = 0;
+
+      /**
+       * Clears the currently scheduled pending typed-agent-mention timer.
+       *
+       * By default this also resets the focus defer count because a new pending mention,
+       * local edit reset, or cleanup should start a fresh escape-hatch window. Focus-based
+       * retries pass `preserveFocusDeferCount` so repeated defers for the same pending
+       * mention are counted toward the bounded retry cap.
+       */
       var clearPendingTypedAgentMentionTimer = function clearPendingTypedAgentMentionTimer() {
+        var _ref4 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+          _ref4$preserveFocusDe = _ref4.preserveFocusDeferCount,
+          preserveFocusDeferCount = _ref4$preserveFocusDe === void 0 ? false : _ref4$preserveFocusDe;
         if (pendingTypedAgentMentionTimer) {
           clearTimeout(pendingTypedAgentMentionTimer);
           pendingTypedAgentMentionTimer = undefined;
         }
         pendingTypedAgentMentionTimerKey = null;
+        if (!preserveFocusDeferCount) {
+          pendingTypedAgentMentionFocusDeferCount = 0;
+        }
+      };
+
+      /**
+       * Typed agent mentions intentionally wait before invoking the agent so content the
+       * user adds next can become context. That context can be authored through
+       * editor-adjacent UI, such as mention typeahead, date picker, or status picker,
+       * where focus leaves the ProseMirror editor but remains in the active document.
+       * Treat that as continued authoring activity by restarting the inactivity window.
+       * This only defers the inactivity timer path: existing selection-change handling can
+       * still publish or clear the pending mention sooner. After 20 focus defers (~1 minute),
+       * publish anyway so pathological focus states cannot keep the mention pending indefinitely.
+       */
+      var shouldDeferPendingTypedAgentMention = function shouldDeferPendingTypedAgentMention() {
+        return typeof document !== 'undefined' && document.hasFocus() && !editorView.hasFocus();
       };
-      var schedulePendingTypedAgentMentionTimer = function schedulePendingTypedAgentMentionTimer(mentionPluginState) {
+      var _schedulePendingTypedAgentMentionTimer = function schedulePendingTypedAgentMentionTimer(mentionPluginState) {
+        var _ref5 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          _ref5$preserveFocusDe = _ref5.preserveFocusDeferCount,
+          preserveFocusDeferCount = _ref5$preserveFocusDe === void 0 ? false : _ref5$preserveFocusDe;
         if (!isAgentMentionsEnabled) {
           clearPendingTypedAgentMentionTimer();
           return;
@@ -645,7 +679,9 @@ function createMentionPlugin(_ref2) {
         if (timerKey === pendingTypedAgentMentionTimerKey) {
           return;
         }
-        clearPendingTypedAgentMentionTimer();
+        clearPendingTypedAgentMentionTimer({
+          preserveFocusDeferCount: preserveFocusDeferCount
+        });
         pendingTypedAgentMentionTimerKey = timerKey;
         pendingTypedAgentMentionTimer = setTimeout(function () {
           var _mentionPluginKey$get;
@@ -653,6 +689,15 @@ function createMentionPlugin(_ref2) {
           if (!latestPendingTypedAgentMention || latestPendingTypedAgentMention.localId !== pendingTypedAgentMention.localId || latestPendingTypedAgentMention.resetCount !== pendingTypedAgentMention.resetCount) {
             return;
           }
+          if (shouldDeferPendingTypedAgentMention() && pendingTypedAgentMentionFocusDeferCount < MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS) {
+            pendingTypedAgentMentionFocusDeferCount++;
+            pendingTypedAgentMentionTimerKey = null;
+            _schedulePendingTypedAgentMentionTimer(_key.mentionPluginKey.getState(editorView.state), {
+              preserveFocusDeferCount: true
+            });
+            return;
+          }
+          pendingTypedAgentMentionFocusDeferCount = 0;
           editorView.dispatch(editorView.state.tr.setMeta(_key.mentionPluginKey, {
             action: ACTIONS.COMMIT_PENDING_TYPED_AGENT_MENTION,
             params: {
@@ -712,7 +757,7 @@ function createMentionPlugin(_ref2) {
           if (mentionPluginState === _key.mentionPluginKey.getState(prevState)) {
             return;
           }
-          schedulePendingTypedAgentMentionTimer(mentionPluginState);
+          _schedulePendingTypedAgentMentionTimer(mentionPluginState);
         },
         destroy: function destroy() {
           clearPendingTypedAgentMentionTimer();

package/dist/cjs/ui/type-ahead/index.js

@@ -399,7 +399,7 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
       } : {}), (0, _expVal.expVal)('platform_editor_agent_mentions', 'isEnabled', false) ? {
         lozenge: /*#__PURE__*/_react.default.createElement(_lozenge.default, {
           appearance: "new"
-        }, intl.formatMessage(_messages.mentionMessages.typeAheadSectionAgentsLabs))
+        }, intl.formatMessage(_messages.mentionMessages.typeAheadSectionAgentsLabsLozengeLabel))
       } : {})];
     },
     onOpen: function onOpen() {

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

@@ -34,8 +34,9 @@ const getAgentMentionName = (text, fallbackName) => {
 };
 const AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 const AGENT_MENTION_INACTIVITY_MS = 3000;
+const MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 const PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-const PACKAGE_VERSION = "14.5.7";
+const PACKAGE_VERSION = "14.5.8";
 const setProvider = provider => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(mentionPluginKey, {
@@ -583,14 +584,43 @@ export function createMentionPlugin({
       const isAgentMentionsEnabled = editorExperiment('platform_editor_agent_mentions', true);
       let pendingTypedAgentMentionTimer;
       let pendingTypedAgentMentionTimerKey = null;
-      const clearPendingTypedAgentMentionTimer = () => {
+      let pendingTypedAgentMentionFocusDeferCount = 0;
+
+      /**
+       * Clears the currently scheduled pending typed-agent-mention timer.
+       *
+       * By default this also resets the focus defer count because a new pending mention,
+       * local edit reset, or cleanup should start a fresh escape-hatch window. Focus-based
+       * retries pass `preserveFocusDeferCount` so repeated defers for the same pending
+       * mention are counted toward the bounded retry cap.
+       */
+      const clearPendingTypedAgentMentionTimer = ({
+        preserveFocusDeferCount = false
+      } = {}) => {
         if (pendingTypedAgentMentionTimer) {
           clearTimeout(pendingTypedAgentMentionTimer);
           pendingTypedAgentMentionTimer = undefined;
         }
         pendingTypedAgentMentionTimerKey = null;
+        if (!preserveFocusDeferCount) {
+          pendingTypedAgentMentionFocusDeferCount = 0;
+        }
       };
-      const schedulePendingTypedAgentMentionTimer = mentionPluginState => {
+
+      /**
+       * Typed agent mentions intentionally wait before invoking the agent so content the
+       * user adds next can become context. That context can be authored through
+       * editor-adjacent UI, such as mention typeahead, date picker, or status picker,
+       * where focus leaves the ProseMirror editor but remains in the active document.
+       * Treat that as continued authoring activity by restarting the inactivity window.
+       * This only defers the inactivity timer path: existing selection-change handling can
+       * still publish or clear the pending mention sooner. After 20 focus defers (~1 minute),
+       * publish anyway so pathological focus states cannot keep the mention pending indefinitely.
+       */
+      const shouldDeferPendingTypedAgentMention = () => typeof document !== 'undefined' && document.hasFocus() && !editorView.hasFocus();
+      const schedulePendingTypedAgentMentionTimer = (mentionPluginState, {
+        preserveFocusDeferCount = false
+      } = {}) => {
         if (!isAgentMentionsEnabled) {
           clearPendingTypedAgentMentionTimer();
           return;
@@ -604,7 +634,9 @@ export function createMentionPlugin({
         if (timerKey === pendingTypedAgentMentionTimerKey) {
           return;
         }
-        clearPendingTypedAgentMentionTimer();
+        clearPendingTypedAgentMentionTimer({
+          preserveFocusDeferCount
+        });
         pendingTypedAgentMentionTimerKey = timerKey;
         pendingTypedAgentMentionTimer = setTimeout(() => {
           var _mentionPluginKey$get;
@@ -612,6 +644,15 @@ export function createMentionPlugin({
           if (!latestPendingTypedAgentMention || latestPendingTypedAgentMention.localId !== pendingTypedAgentMention.localId || latestPendingTypedAgentMention.resetCount !== pendingTypedAgentMention.resetCount) {
             return;
           }
+          if (shouldDeferPendingTypedAgentMention() && pendingTypedAgentMentionFocusDeferCount < MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS) {
+            pendingTypedAgentMentionFocusDeferCount++;
+            pendingTypedAgentMentionTimerKey = null;
+            schedulePendingTypedAgentMentionTimer(mentionPluginKey.getState(editorView.state), {
+              preserveFocusDeferCount: true
+            });
+            return;
+          }
+          pendingTypedAgentMentionFocusDeferCount = 0;
           editorView.dispatch(editorView.state.tr.setMeta(mentionPluginKey, {
             action: ACTIONS.COMMIT_PENDING_TYPED_AGENT_MENTION,
             params: {

package/dist/es2019/ui/type-ahead/index.js

@@ -373,7 +373,7 @@ export const createTypeAheadConfig = ({
         ...(expVal('platform_editor_agent_mentions', 'isEnabled', false) ? {
           lozenge: /*#__PURE__*/React.createElement(Lozenge, {
             appearance: "new"
-          }, intl.formatMessage(mentionMessages.typeAheadSectionAgentsLabs))
+          }, intl.formatMessage(mentionMessages.typeAheadSectionAgentsLabsLozengeLabel))
         } : {})
       }];
     },

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

@@ -41,8 +41,9 @@ var getAgentMentionName = function getAgentMentionName(text, fallbackName) {
 };
 var AI_STREAMING_TRANSFORMATION_META_KEY = 'isAIStreamingTransformation';
 var AGENT_MENTION_INACTIVITY_MS = 3000;
+var MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS = 20;
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "14.5.7";
+var PACKAGE_VERSION = "14.5.8";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {
@@ -616,14 +617,47 @@ export function createMentionPlugin(_ref2) {
       var isAgentMentionsEnabled = editorExperiment('platform_editor_agent_mentions', true);
       var pendingTypedAgentMentionTimer;
       var pendingTypedAgentMentionTimerKey = null;
+      var pendingTypedAgentMentionFocusDeferCount = 0;
+
+      /**
+       * Clears the currently scheduled pending typed-agent-mention timer.
+       *
+       * By default this also resets the focus defer count because a new pending mention,
+       * local edit reset, or cleanup should start a fresh escape-hatch window. Focus-based
+       * retries pass `preserveFocusDeferCount` so repeated defers for the same pending
+       * mention are counted toward the bounded retry cap.
+       */
       var clearPendingTypedAgentMentionTimer = function clearPendingTypedAgentMentionTimer() {
+        var _ref4 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+          _ref4$preserveFocusDe = _ref4.preserveFocusDeferCount,
+          preserveFocusDeferCount = _ref4$preserveFocusDe === void 0 ? false : _ref4$preserveFocusDe;
         if (pendingTypedAgentMentionTimer) {
           clearTimeout(pendingTypedAgentMentionTimer);
           pendingTypedAgentMentionTimer = undefined;
         }
         pendingTypedAgentMentionTimerKey = null;
+        if (!preserveFocusDeferCount) {
+          pendingTypedAgentMentionFocusDeferCount = 0;
+        }
+      };
+
+      /**
+       * Typed agent mentions intentionally wait before invoking the agent so content the
+       * user adds next can become context. That context can be authored through
+       * editor-adjacent UI, such as mention typeahead, date picker, or status picker,
+       * where focus leaves the ProseMirror editor but remains in the active document.
+       * Treat that as continued authoring activity by restarting the inactivity window.
+       * This only defers the inactivity timer path: existing selection-change handling can
+       * still publish or clear the pending mention sooner. After 20 focus defers (~1 minute),
+       * publish anyway so pathological focus states cannot keep the mention pending indefinitely.
+       */
+      var shouldDeferPendingTypedAgentMention = function shouldDeferPendingTypedAgentMention() {
+        return typeof document !== 'undefined' && document.hasFocus() && !editorView.hasFocus();
       };
-      var schedulePendingTypedAgentMentionTimer = function schedulePendingTypedAgentMentionTimer(mentionPluginState) {
+      var _schedulePendingTypedAgentMentionTimer = function schedulePendingTypedAgentMentionTimer(mentionPluginState) {
+        var _ref5 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          _ref5$preserveFocusDe = _ref5.preserveFocusDeferCount,
+          preserveFocusDeferCount = _ref5$preserveFocusDe === void 0 ? false : _ref5$preserveFocusDe;
         if (!isAgentMentionsEnabled) {
           clearPendingTypedAgentMentionTimer();
           return;
@@ -637,7 +671,9 @@ export function createMentionPlugin(_ref2) {
         if (timerKey === pendingTypedAgentMentionTimerKey) {
           return;
         }
-        clearPendingTypedAgentMentionTimer();
+        clearPendingTypedAgentMentionTimer({
+          preserveFocusDeferCount: preserveFocusDeferCount
+        });
         pendingTypedAgentMentionTimerKey = timerKey;
         pendingTypedAgentMentionTimer = setTimeout(function () {
           var _mentionPluginKey$get;
@@ -645,6 +681,15 @@ export function createMentionPlugin(_ref2) {
           if (!latestPendingTypedAgentMention || latestPendingTypedAgentMention.localId !== pendingTypedAgentMention.localId || latestPendingTypedAgentMention.resetCount !== pendingTypedAgentMention.resetCount) {
             return;
           }
+          if (shouldDeferPendingTypedAgentMention() && pendingTypedAgentMentionFocusDeferCount < MAX_PENDING_TYPED_AGENT_MENTION_FOCUS_DEFERS) {
+            pendingTypedAgentMentionFocusDeferCount++;
+            pendingTypedAgentMentionTimerKey = null;
+            _schedulePendingTypedAgentMentionTimer(mentionPluginKey.getState(editorView.state), {
+              preserveFocusDeferCount: true
+            });
+            return;
+          }
+          pendingTypedAgentMentionFocusDeferCount = 0;
           editorView.dispatch(editorView.state.tr.setMeta(mentionPluginKey, {
             action: ACTIONS.COMMIT_PENDING_TYPED_AGENT_MENTION,
             params: {
@@ -704,7 +749,7 @@ export function createMentionPlugin(_ref2) {
           if (mentionPluginState === mentionPluginKey.getState(prevState)) {
             return;
           }
-          schedulePendingTypedAgentMentionTimer(mentionPluginState);
+          _schedulePendingTypedAgentMentionTimer(mentionPluginState);
         },
         destroy: function destroy() {
           clearPendingTypedAgentMentionTimer();

package/dist/esm/ui/type-ahead/index.js

@@ -390,7 +390,7 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref8) {
       } : {}), expVal('platform_editor_agent_mentions', 'isEnabled', false) ? {
         lozenge: /*#__PURE__*/React.createElement(Lozenge, {
           appearance: "new"
-        }, intl.formatMessage(mentionMessages.typeAheadSectionAgentsLabs))
+        }, intl.formatMessage(mentionMessages.typeAheadSectionAgentsLabsLozengeLabel))
       } : {})];
     },
     onOpen: function onOpen() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "14.5.8",
+	"version": "14.5.9",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -41,7 +41,7 @@
 		"@atlaskit/profilecard": "^26.5.0",
 		"@atlaskit/teams-app-config": "^2.1.0",
 		"@atlaskit/theme": "^26.1.0",
-		"@atlaskit/tmp-editor-statsig": "^119.0.0",
+		"@atlaskit/tmp-editor-statsig": "^119.2.0",
 		"@atlaskit/tokens": "^15.3.0",
 		"@atlaskit/tooltip": "^23.1.0",
 		"@atlaskit/user-picker": "^13.4.0",