@atlaskit/editor-plugin-mentions 14.7.0 → 14.8.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-mentions
 
+## 14.8.0
+
+### Minor Changes
+
+- [`d6596dc895420`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d6596dc895420) -
+  Show a loading shimmer in the mention typeahead Agents section while the (slower) agent source
+  resolves. The Rovo chat mention provider now emits a non-selectable loading placeholder in the
+  agents slot until agents arrive (gated by rovo_chat_agent_selection); @atlaskit/mention renders it
+  as a skeleton row, and the editor mention plugin guards it from selection/analytics.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.7.0
 
 ### Minor Changes

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

@@ -66,7 +66,7 @@ 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.6.6";
+var PACKAGE_VERSION = "14.7.0";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

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

@@ -46,6 +46,14 @@ var isAgentMention = function isAgentMention(mention) {
 var isAgentTypeAheadItem = function isAgentTypeAheadItem(item) {
   return item.mention ? isAgentMention(item.mention) : false;
 };
+
+// A non-selectable loading placeholder injected by the provider (e.g.
+// `RovoChatMentionResource`) while the slower agent source resolves. It
+// renders as a skeleton row via `@atlaskit/mention`'s `MentionItem` and
+// must never be inserted or counted in rendered-mention analytics.
+var isLoadingPlaceholder = function isLoadingPlaceholder(mention) {
+  return !!(mention !== null && mention !== void 0 && mention.isPlaceholder);
+};
 var createInviteItem = function createInviteItem(_ref) {
   var mentionProvider = _ref.mentionProvider,
     onInviteItemMount = _ref.onInviteItemMount,
@@ -282,13 +290,24 @@ var makeTransformMentionsToTypeAheadItems = function makeTransformMentionsToType
       agentCount: agentCount,
       agentSectioningEnabled: enableAgentSectioning
     };
+
+    // The loading placeholder is a rendered-only row — keep it in
+    // `mentionItems` so the shimmer shows, but exclude it from analytics
+    // and no-results bookkeeping so it isn't counted as a real result.
+    var realMentions = mentions.filter(function (mention) {
+      return !isLoadingPlaceholder(mention);
+    });
     buildAndSendElementsTypeAheadAnalytics(fireEvent)({
       query: query,
-      mentions: mentions,
+      mentions: realMentions,
       stats: stats,
       agentAnalytics: agentAnalytics
     });
-    if (mentions.length === 0 && getFirstQueryWithoutResults() === null) {
+
+    // While a loading placeholder is present the result set isn't settled yet
+    // (e.g. agents still resolving) — don't record this query as "no results",
+    // or a later emission that arrives with results would be ignored.
+    if (realMentions.length === 0 && !mentions.some(isLoadingPlaceholder) && getFirstQueryWithoutResults() === null) {
       setFirstQueryWithoutResults(query);
     }
     if (!mentionProvider.shouldEnableInvite || mentionItems.length > 2) {
@@ -433,6 +452,12 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
         query = _ref10.query,
         sourceListItem = _ref10.sourceListItem;
       var schema = state.schema;
+
+      // Placeholder isn't selectable. Return `false` (not a transaction) so
+      // the runtime keeps the dropdown open; a transaction would close it.
+      if (isLoadingPlaceholder(item.mention)) {
+        return false;
+      }
       var pluginState = (0, _utils2.getMentionPluginState)(state);
       var mentionProvider = pluginState.mentionProvider;
       var _item$mention = item.mention,

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

@@ -50,7 +50,7 @@ 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.6.6";
+const PACKAGE_VERSION = "14.7.0";
 const setProvider = provider => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(mentionPluginKey, {

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

@@ -24,6 +24,12 @@ import { isInviteItem, isTeamStats, isTeamType, shouldKeepInviteItem } from './u
 const isAgentUserType = userType => userType === 'APP' || userType === 'AGENT';
 const isAgentMention = mention => isAgentUserType(mention.userType) || mention.appType === 'agent';
 const isAgentTypeAheadItem = item => item.mention ? isAgentMention(item.mention) : false;
+
+// A non-selectable loading placeholder injected by the provider (e.g.
+// `RovoChatMentionResource`) while the slower agent source resolves. It
+// renders as a skeleton row via `@atlaskit/mention`'s `MentionItem` and
+// must never be inserted or counted in rendered-mention analytics.
+const isLoadingPlaceholder = mention => !!(mention !== null && mention !== void 0 && mention.isPlaceholder);
 const createInviteItem = ({
   mentionProvider,
   onInviteItemMount,
@@ -251,13 +257,22 @@ const makeTransformMentionsToTypeAheadItems = ({
       agentCount,
       agentSectioningEnabled: enableAgentSectioning
     };
+
+    // The loading placeholder is a rendered-only row — keep it in
+    // `mentionItems` so the shimmer shows, but exclude it from analytics
+    // and no-results bookkeeping so it isn't counted as a real result.
+    const realMentions = mentions.filter(mention => !isLoadingPlaceholder(mention));
     buildAndSendElementsTypeAheadAnalytics(fireEvent)({
       query,
-      mentions,
+      mentions: realMentions,
       stats,
       agentAnalytics
     });
-    if (mentions.length === 0 && getFirstQueryWithoutResults() === null) {
+
+    // While a loading placeholder is present the result set isn't settled yet
+    // (e.g. agents still resolving) — don't record this query as "no results",
+    // or a later emission that arrives with results would be ignored.
+    if (realMentions.length === 0 && !mentions.some(isLoadingPlaceholder) && getFirstQueryWithoutResults() === null) {
       setFirstQueryWithoutResults(query);
     }
     if (!mentionProvider.shouldEnableInvite || mentionItems.length > 2) {
@@ -403,6 +418,12 @@ export const createTypeAheadConfig = ({
       const {
         schema
       } = state;
+
+      // Placeholder isn't selectable. Return `false` (not a transaction) so
+      // the runtime keeps the dropdown open; a transaction would close it.
+      if (isLoadingPlaceholder(item.mention)) {
+        return false;
+      }
       const pluginState = getMentionPluginState(state);
       const {
         mentionProvider

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

@@ -57,7 +57,7 @@ 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.6.6";
+var PACKAGE_VERSION = "14.7.0";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {

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

@@ -37,6 +37,14 @@ var isAgentMention = function isAgentMention(mention) {
 var isAgentTypeAheadItem = function isAgentTypeAheadItem(item) {
   return item.mention ? isAgentMention(item.mention) : false;
 };
+
+// A non-selectable loading placeholder injected by the provider (e.g.
+// `RovoChatMentionResource`) while the slower agent source resolves. It
+// renders as a skeleton row via `@atlaskit/mention`'s `MentionItem` and
+// must never be inserted or counted in rendered-mention analytics.
+var isLoadingPlaceholder = function isLoadingPlaceholder(mention) {
+  return !!(mention !== null && mention !== void 0 && mention.isPlaceholder);
+};
 var createInviteItem = function createInviteItem(_ref) {
   var mentionProvider = _ref.mentionProvider,
     onInviteItemMount = _ref.onInviteItemMount,
@@ -273,13 +281,24 @@ var makeTransformMentionsToTypeAheadItems = function makeTransformMentionsToType
       agentCount: agentCount,
       agentSectioningEnabled: enableAgentSectioning
     };
+
+    // The loading placeholder is a rendered-only row — keep it in
+    // `mentionItems` so the shimmer shows, but exclude it from analytics
+    // and no-results bookkeeping so it isn't counted as a real result.
+    var realMentions = mentions.filter(function (mention) {
+      return !isLoadingPlaceholder(mention);
+    });
     buildAndSendElementsTypeAheadAnalytics(fireEvent)({
       query: query,
-      mentions: mentions,
+      mentions: realMentions,
       stats: stats,
       agentAnalytics: agentAnalytics
     });
-    if (mentions.length === 0 && getFirstQueryWithoutResults() === null) {
+
+    // While a loading placeholder is present the result set isn't settled yet
+    // (e.g. agents still resolving) — don't record this query as "no results",
+    // or a later emission that arrives with results would be ignored.
+    if (realMentions.length === 0 && !mentions.some(isLoadingPlaceholder) && getFirstQueryWithoutResults() === null) {
       setFirstQueryWithoutResults(query);
     }
     if (!mentionProvider.shouldEnableInvite || mentionItems.length > 2) {
@@ -424,6 +443,12 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref8) {
         query = _ref10.query,
         sourceListItem = _ref10.sourceListItem;
       var schema = state.schema;
+
+      // Placeholder isn't selectable. Return `false` (not a transaction) so
+      // the runtime keeps the dropdown open; a transaction would close it.
+      if (isLoadingPlaceholder(item.mention)) {
+        return false;
+      }
       var pluginState = getMentionPluginState(state);
       var mentionProvider = pluginState.mentionProvider;
       var _item$mention = item.mention,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "14.7.0",
+	"version": "14.8.0",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 		"@atlaskit/insm": "^1.0.0",
 		"@atlaskit/link": "^4.3.0",
 		"@atlaskit/lozenge": "^14.1.0",
-		"@atlaskit/mention": "^27.6.0",
+		"@atlaskit/mention": "^27.7.0",
 		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@atlaskit/popper": "^8.3.0",
 		"@atlaskit/portal": "^6.1.0",
@@ -53,7 +53,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.31.0",
+		"@atlaskit/editor-common": "^116.32.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"