@atlaskit/editor-plugin-mentions 13.3.15 → 14.1.0

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

@@ -19,6 +19,8 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { expVal } from '@atlaskit/tmp-editor-statsig/expVal';
 import { createSingleMentionFragment } from '../../editor-commands';
+import { mentionPluginKey } from '../../pm-plugins/key';
+import { ACTIONS } from '../../pm-plugins/main';
 import { mentionPlaceholderPluginKey, MENTION_PLACEHOLDER_ACTIONS } from '../../pm-plugins/mentionPlaceholder';
 import { getMentionPluginState } from '../../pm-plugins/utils';
 import InviteItem, { INVITE_ITEM_DESCRIPTION } from '../InviteItem';
@@ -31,6 +33,9 @@ var isAgentUserType = function isAgentUserType(userType) {
 var isAgentMention = function isAgentMention(mention) {
   return isAgentUserType(mention.userType) || mention.appType === 'agent';
 };
+var isAgentTypeAheadItem = function isAgentTypeAheadItem(item) {
+  return item.mention ? isAgentMention(item.mention) : false;
+};
 var createInviteItem = function createInviteItem(_ref) {
   var mentionProvider = _ref.mentionProvider,
     onInviteItemMount = _ref.onInviteItemMount,
@@ -317,23 +322,31 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
     },
     getSections: function getSections(_ref9) {
       var intl = _ref9.intl;
-      return [{
+      return [_objectSpread({
         id: 'people',
         title: intl.formatMessage(mentionMessages.typeAheadSectionPeople),
         filter: function filter(item) {
-          var _item$mention;
-          return !isAgentUserType(((_item$mention = item.mention) === null || _item$mention === void 0 ? void 0 : _item$mention.userType) || '');
+          return !isAgentTypeAheadItem(item);
         },
         limit: expVal('platform_editor_agent_mentions', 'isEnabled', false) ? 5 : 6
-      }, {
+      }, expVal('platform_editor_agent_mentions', 'isEnabled', false) ? {
+        sectionTitleDisplay: {
+          showWhenQueryPresent: false,
+          showWhenOnlySection: true
+        }
+      } : {}), _objectSpread({
         id: 'agents',
         title: intl.formatMessage(mentionMessages.typeAheadSectionAgents),
         filter: function filter(item) {
-          var _item$mention2;
-          return isAgentUserType(((_item$mention2 = item.mention) === null || _item$mention2 === void 0 ? void 0 : _item$mention2.userType) || '');
+          return isAgentTypeAheadItem(item);
         },
         limit: expVal('platform_editor_agent_mentions', 'isEnabled', false) ? 5 : undefined
-      }];
+      }, expVal('platform_editor_agent_mentions', 'isEnabled', false) ? {
+        sectionTitleDisplay: {
+          showWhenQueryPresent: false,
+          showWhenOnlySection: true
+        }
+      } : {})];
     },
     onOpen: function onOpen() {
       firstQueryWithoutResults = null;
@@ -347,23 +360,23 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
       var schema = state.schema;
       var pluginState = getMentionPluginState(state);
       var mentionProvider = pluginState.mentionProvider;
-      var _item$mention3 = item.mention,
-        id = _item$mention3.id,
-        name = _item$mention3.name,
-        nickname = _item$mention3.nickname,
-        accessLevel = _item$mention3.accessLevel,
-        userType = _item$mention3.userType,
-        isXProductUser = _item$mention3.isXProductUser;
+      var _item$mention = item.mention,
+        id = _item$mention.id,
+        name = _item$mention.name,
+        nickname = _item$mention.nickname,
+        accessLevel = _item$mention.accessLevel,
+        userType = _item$mention.userType,
+        isXProductUser = _item$mention.isXProductUser;
       var _ref1 = (_api$contextIdentifie3 = api === null || api === void 0 || (_api$contextIdentifie4 = api.contextIdentifier) === null || _api$contextIdentifie4 === void 0 ? void 0 : _api$contextIdentifie4.sharedState.currentState()) !== null && _api$contextIdentifie3 !== void 0 ? _api$contextIdentifie3 : {},
         contextIdentifierProvider = _ref1.contextIdentifierProvider;
       var mentionContext = _objectSpread(_objectSpread({}, contextIdentifierProvider), {}, {
         sessionId: sessionId
       });
       var isAgentMentionsExperimentEnabled = expVal('platform_editor_agent_mentions', 'isEnabled', false);
-      var shouldSuppressInviteForAgentMention = isAgentMentionsExperimentEnabled && isAgentMention(item.mention);
+      var isAgentMentionInsertion = isAgentMentionsExperimentEnabled && isAgentMention(item.mention);
       // userType can be missing for provider-only agent mentions. Copy/paste cannot
       // see appType, so persist APP only when there is no explicit userType.
-      var persistedUserType = isAgentMentionsExperimentEnabled && isAgentMention(item.mention) && userType == null ? 'APP' : userType;
+      var persistedUserType = isAgentMentionInsertion && userType == null ? 'APP' : userType;
       if (mentionProvider && !isInviteItem(item.mention)) {
         mentionProvider.recordMentionSelection(item.mention, mentionContext);
       }
@@ -388,12 +401,12 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
             // If query already includes @, use it as is
             if (email && mentionProvider.showInlineInviteRecaptcha) {
               mentionProvider.showInlineInviteRecaptcha(email);
-              var tr = state.tr;
-              tr.setMeta(mentionPlaceholderPluginKey, {
+              var _tr = state.tr;
+              _tr.setMeta(mentionPlaceholderPluginKey, {
                 action: MENTION_PLACEHOLDER_ACTIONS.SHOW_PLACEHOLDER,
                 placeholder: "@".concat(query)
               });
-              return tr;
+              return _tr;
             }
           } else if (mentionProvider.onInviteItemClick) {
             // Fallback to old behavior for backward compatibility
@@ -420,7 +433,7 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
           localId: mentionLocalId,
           method: 'typed',
           type: 'added'
-        }, shouldSuppressInviteForAgentMention ? {
+        }, isAgentMentionInsertion ? {
           shouldSuppressMentionNotification: true
         } : {});
         if (taskItemId) {
@@ -433,22 +446,22 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
       }
       fireEvent(buildTypeAheadInsertedPayload(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, item.mention, mentionLocalId, sourceListItem.map(function (x) {
         return x.mention;
-      }), query, contextIdentifierProvider, taskListId, taskItemId));
+      }), query, contextIdentifierProvider, taskListId, taskItemId, isAgentMentionInsertion));
 
       // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
       sessionId = uuid();
       if (mentionProvider && isTeamType(userType)) {
         return insert(buildNodesForTeamMention(schema, item.mention, mentionProvider, sanitizePrivateContent));
       }
-      if (!shouldSuppressInviteForAgentMention && isXProductUser && mentionProvider && mentionProvider.inviteXProductUser) {
+      if (!isAgentMentionInsertion && isXProductUser && mentionProvider && mentionProvider.inviteXProductUser) {
         mentionProvider.inviteXProductUser(id, name);
       }
-      return insert(createSingleMentionFragment({
+      var tr = insert(createSingleMentionFragment({
         mentionProvider: mentionProvider,
         mentionInsertDisplayName: mentionInsertDisplayName,
         tr: state.tr,
         sanitizePrivateContent: sanitizePrivateContent,
-        suppressInviteXProductUser: shouldSuppressInviteForAgentMention
+        suppressInviteXProductUser: isAgentMentionInsertion
       })({
         name: name,
         id: id,
@@ -458,6 +471,15 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
         accessLevel: accessLevel,
         isXProductUser: isXProductUser
       }));
+      if (isAgentMentionInsertion) {
+        tr.setMeta(mentionPluginKey, {
+          action: ACTIONS.SET_PENDING_TYPED_AGENT_MENTION,
+          params: {
+            localId: mentionLocalId
+          }
+        });
+      }
+      return tr;
     },
     dismiss: function dismiss(_ref10) {
       var editorState = _ref10.editorState,

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

@@ -3,6 +3,8 @@ import type { ExtractInjectionAPI, PMPluginFactoryParams } from '@atlaskit/edito
 import type { MentionsPlugin } from '../mentionsPluginType';
 import type { FireElementsChannelEvent, MentionPluginOptions, MentionPluginState } from '../types';
 export declare const ACTIONS: {
+    COMMIT_PENDING_TYPED_AGENT_MENTION: string;
+    SET_PENDING_TYPED_AGENT_MENTION: string;
     SET_PROVIDER: string;
 };
 interface CreateMentionPlugin {

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

@@ -43,8 +43,32 @@ export interface MentionsPluginOptions extends MentionPluginConfig {
  * @see https://product-fabric.atlassian.net/browse/ED-27496
  */
 export type MentionPluginOptions = MentionsPluginOptions;
+export type AgentMentionDetails = {
+    id: string;
+    context: string | null;
+    nodeSize: number;
+    parentNodeType: string | null;
+    pos: number;
+};
 export type MentionPluginState = {
     canInsertMention?: boolean;
+    /**
+     * @internal Tracks a typed agent mention while waiting for the platform-side
+     * ready-to-fire trigger. Consumers should continue to react only to
+     * lastInsertedAgentMention* fields.
+     */
+    pendingTypedAgentMention?: {
+        id: string;
+        localId: string;
+        nodeSize: number;
+        pos: number;
+        /**
+         * Generation value for the inactivity timer. This changes when local edits
+         * reset the pending mention window, so stale timer callbacks for the same
+         * localId cannot publish before the latest inactivity period has elapsed.
+         */
+        resetCount: number;
+    } | null;
     /**
      * Increments on each new agent mention insertion (including re-mentions of the same agent).
      * Used to trigger re-renders when the same agent is mentioned again.

package/dist/types/ui/type-ahead/analytics.d.ts

@@ -8,5 +8,5 @@ export declare const MENTION_SOURCE = "mentionInEditor";
 export declare const buildTypeAheadCancelPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, query?: string) => AnalyticsEventPayload;
 export declare const buildTypeAheadInviteItemViewedPayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole, additionalAttributes?: Record<string, unknown>) => AnalyticsEventPayload;
 export declare const buildTypeAheadInviteItemClickedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, query?: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole, additionalAttributes?: Record<string, unknown>) => AnalyticsEventPayload;
-export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionLocalId: string, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider, taskListId?: string, taskItemId?: string) => AnalyticsEventPayload;
+export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionLocalId: string, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider, taskListId?: string, taskItemId?: string, isAgent?: boolean) => AnalyticsEventPayload;
 export declare const buildTypeAheadRenderedPayload: (duration: number, userIds: Array<string> | null, query: string, teams: TeamInfoAttrAnalytics[] | null, xProductMentionsLength: number) => AnalyticsEventPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "13.3.15",
+	"version": "14.1.0",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -16,42 +16,34 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": [
 		"**/*.compiled.css"
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^54.0.0",
-		"@atlaskit/css": "^0.19.0",
-		"@atlaskit/editor-plugin-analytics": "^11.0.0",
-		"@atlaskit/editor-plugin-base": "^12.1.0",
-		"@atlaskit/editor-plugin-context-identifier": "^11.0.0",
-		"@atlaskit/editor-plugin-selection": "^11.0.0",
-		"@atlaskit/editor-plugin-type-ahead": "^11.3.0",
-		"@atlaskit/editor-prosemirror": "^7.3.0",
-		"@atlaskit/icon": "^35.4.0",
-		"@atlaskit/insm": "^0.4.0",
-		"@atlaskit/link": "^3.4.0",
-		"@atlaskit/mention": "^26.2.0",
-		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/popper": "^7.2.0",
-		"@atlaskit/portal": "^5.5.0",
-		"@atlaskit/primitives": "^19.0.0",
-		"@atlaskit/profilecard": "^25.9.0",
-		"@atlaskit/teams-app-config": "^1.12.0",
-		"@atlaskit/theme": "^25.0.0",
-		"@atlaskit/tmp-editor-statsig": "^103.0.0",
-		"@atlaskit/tokens": "^13.4.0",
-		"@atlaskit/tooltip": "^22.6.0",
-		"@atlaskit/user-picker": "^12.1.0",
+		"@atlaskit/adf-schema": "^55.0.0",
+		"@atlaskit/css": "^1.0.0",
+		"@atlaskit/editor-plugin-analytics": "^12.0.0",
+		"@atlaskit/editor-plugin-base": "^13.0.0",
+		"@atlaskit/editor-plugin-context-identifier": "^12.0.0",
+		"@atlaskit/editor-plugin-selection": "^12.0.0",
+		"@atlaskit/editor-plugin-type-ahead": "^12.0.0",
+		"@atlaskit/editor-prosemirror": "^8.0.0",
+		"@atlaskit/icon": "^36.0.0",
+		"@atlaskit/insm": "^1.0.0",
+		"@atlaskit/link": "^4.0.0",
+		"@atlaskit/mention": "^27.0.0",
+		"@atlaskit/platform-feature-flags": "^2.0.0",
+		"@atlaskit/popper": "^8.0.0",
+		"@atlaskit/portal": "^6.0.0",
+		"@atlaskit/primitives": "^20.0.0",
+		"@atlaskit/profilecard": "^26.0.0",
+		"@atlaskit/teams-app-config": "^2.0.0",
+		"@atlaskit/theme": "^26.0.0",
+		"@atlaskit/tmp-editor-statsig": "^105.0.0",
+		"@atlaskit/tokens": "^14.0.0",
+		"@atlaskit/tooltip": "^23.0.0",
+		"@atlaskit/user-picker": "^13.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"bind-event-listener": "^3.0.0",
@@ -60,7 +52,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^115.15.0",
+		"@atlaskit/editor-common": "^116.1.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"