@atlaskit/mention 24.4.11 → 24.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/mention
 
+## 24.5.0
+
+### Minor Changes
+
+- [`7c31932dc85c7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7c31932dc85c7) -
+  Adds ability to send custom headers to API requests and adds atl-attribution header to
+  PresenceResource API requests
+
 ## 24.4.11
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,7 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__mention",
 		"rootDir": "../",

package/afm-jira/tsconfig.json

@@ -1,7 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../jira/tsDist/@atlaskit__mention/app",
 		"rootDir": "../",

package/afm-products/tsconfig.json

@@ -1,7 +1,6 @@
 {
 	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
-		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../tsDist/@atlaskit__mention/app",
 		"rootDir": "../",

package/dist/cjs/api/MentionResource.js

@@ -13,6 +13,7 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _utilServiceSupport = require("@atlaskit/util-service-support");
 var _types = require("../types");
 var _logger = _interopRequireDefault(require("../util/logger"));
@@ -28,6 +29,14 @@ var MAX_NOTIFIED_ITEMS = 20;
 // Re-exporting types to prevent breaking change
 // Re-exporting types to prevent breaking change
 
+/**
+ * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
+ * to support fetching team mentions from a separate team search service endpoint.
+ *
+ * Used as the second argument when constructing a {@link TeamMentionResource}, alongside
+ * a standard `MentionResourceConfig` for user mentions.
+ */
+
 /**
  * Support
  */
@@ -364,32 +373,37 @@ var MentionResource = exports.MentionResource = /*#__PURE__*/function (_Abstract
     key: "remoteInitialState",
     value: (function () {
       var _remoteInitialState = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(contextIdentifier) {
-        var queryParams, options, result;
+        var queryParams, configHeaders, options, result;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               queryParams = this.getQueryParams(contextIdentifier);
-              options = {
+              configHeaders = (0, _platformFeatureFlags.fg)('mentions_custom_headers') ? this.config.headers : undefined;
+              options = _objectSpread({
                 path: 'bootstrap',
                 queryParams: queryParams
-              };
-              _context2.prev = 2;
-              _context2.next = 5;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context2.prev = 3;
+              _context2.next = 6;
               return _utilServiceSupport.utils.requestService(this.config, options);
-            case 5:
+            case 6:
               result = _context2.sent;
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.INITIAL_STATE, _types.Actions.SUCCEEDED);
               return _context2.abrupt("return", this.transformServiceResponse(result, ''));
-            case 10:
-              _context2.prev = 10;
-              _context2.t0 = _context2["catch"](2);
+            case 11:
+              _context2.prev = 11;
+              _context2.t0 = _context2["catch"](3);
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.INITIAL_STATE, _types.Actions.FAILED);
               throw _context2.t0;
-            case 14:
+            case 15:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[2, 10]]);
+        }, _callee2, this, [[3, 11]]);
       }));
       function remoteInitialState(_x3) {
         return _remoteInitialState.apply(this, arguments);
@@ -407,34 +421,39 @@ var MentionResource = exports.MentionResource = /*#__PURE__*/function (_Abstract
     key: "remoteSearch",
     value: function () {
       var _remoteSearch = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(query, contextIdentifier) {
-        var options, result;
+        var configHeaders, options, result;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              options = {
+              configHeaders = (0, _platformFeatureFlags.fg)('mentions_custom_headers') ? this.config.headers : undefined;
+              options = _objectSpread({
                 path: 'search',
                 queryParams: _objectSpread({
                   query: query,
                   limit: MAX_QUERY_ITEMS
                 }, this.getQueryParams(contextIdentifier))
-              };
-              _context3.prev = 1;
-              _context3.next = 4;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context3.prev = 2;
+              _context3.next = 5;
               return _utilServiceSupport.utils.requestService(this.config, options);
-            case 4:
+            case 5:
               result = _context3.sent;
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.SEARCH, _types.Actions.SUCCEEDED);
               return _context3.abrupt("return", this.transformServiceResponse(result, query));
-            case 9:
-              _context3.prev = 9;
-              _context3.t0 = _context3["catch"](1);
+            case 10:
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](2);
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.SEARCH, _types.Actions.FAILED);
               throw _context3.t0;
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[1, 9]]);
+        }, _callee3, this, [[2, 10]]);
       }));
       function remoteSearch(_x4, _x5) {
         return _remoteSearch.apply(this, arguments);

package/dist/cjs/api/PresenceResource.js

@@ -11,13 +11,22 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _atlAttribution = require("../util/atl-attribution");
 var _logger = _interopRequireDefault(require("../util/logger"));
 var _MentionResource = require("./MentionResource");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+/**
+ * Configuration for the PresenceResource, which manages real-time user
+ * presence (online/offline/busy/focus status) by querying a GraphQL-based
+ * presence service.
+ */
 var CacheEntry = /*#__PURE__*/function () {
   function CacheEntry(pres, timeout) {
     (0, _classCallCheck2.default)(this, CacheEntry);
@@ -108,11 +117,17 @@ var PresenceResource = /*#__PURE__*/function (_AbstractPresenceReso) {
       if (this.config.productId) {
         query.variables['productId'] = this.config.productId;
       }
+      var configHeaders = (0, _platformFeatureFlags.fg)('mentions_custom_headers') ? this.config.headers : undefined;
+      var atlAttributionHeader = (0, _atlAttribution.buildAtlAttributionHeaderValue)({
+        cloudId: this.config.cloudId,
+        productId: this.config.productId,
+        activationId: this.config.activationId
+      });
       var options = {
         method: 'POST',
-        headers: {
+        headers: _objectSpread(_objectSpread({
           'Content-Type': 'application/json'
-        },
+        }, atlAttributionHeader), configHeaders),
         credentials: 'include',
         body: JSON.stringify(query)
       };

package/dist/cjs/api/TeamMentionResource.js

@@ -16,6 +16,7 @@ var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _analytics = require("./../util/analytics");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _utilServiceSupport = require("@atlaskit/util-service-support");
 var _types = require("../types");
 var _MentionResource2 = _interopRequireDefault(require("./MentionResource"));
@@ -68,20 +69,25 @@ var TeamMentionResource = exports.default = /*#__PURE__*/function (_MentionResou
     key: "remoteInitialStateTeamAndUsers",
     value: (function () {
       var _remoteInitialStateTeamAndUsers = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(contextIdentifier) {
-        var emptyQuery, getUserPromise, queryParams, options, getTeamsPromise;
+        var emptyQuery, getUserPromise, queryParams, configHeaders, options, getTeamsPromise;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               emptyQuery = '';
               getUserPromise = _superPropGet(TeamMentionResource, "remoteInitialState", this, 3)([contextIdentifier]);
               queryParams = this.getQueryParamsOfTeamMentionConfig(contextIdentifier);
-              options = {
+              configHeaders = (0, _platformFeatureFlags.fg)('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
+              options = _objectSpread({
                 path: 'bootstrap',
                 queryParams: queryParams
-              };
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
               getTeamsPromise = _utilServiceSupport.utils.requestService(this.teamMentionConfig, options);
               this.handleBothRequests(emptyQuery, getUserPromise, getTeamsPromise);
-            case 6:
+            case 7:
             case "end":
               return _context.stop();
           }
@@ -214,34 +220,39 @@ var TeamMentionResource = exports.default = /*#__PURE__*/function (_MentionResou
     key: "remoteTeamSearch",
     value: function () {
       var _remoteTeamSearch = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(query, contextIdentifier) {
-        var options, teamResult;
+        var configHeaders, options, teamResult;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              options = {
+              configHeaders = (0, _platformFeatureFlags.fg)('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
+              options = _objectSpread({
                 path: 'search',
                 queryParams: _objectSpread({
                   query: query,
                   limit: MAX_QUERY_TEAMS
                 }, this.getQueryParamsOfTeamMentionConfig(contextIdentifier))
-              };
-              _context3.prev = 1;
-              _context3.next = 4;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context3.prev = 2;
+              _context3.next = 5;
               return _utilServiceSupport.utils.requestService(this.teamMentionConfig, options);
-            case 4:
+            case 5:
               teamResult = _context3.sent;
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.SEARCH_TEAM, _types.Actions.SUCCEEDED);
               return _context3.abrupt("return", this.convertTeamResultToMentionResult(teamResult, query));
-            case 9:
-              _context3.prev = 9;
-              _context3.t0 = _context3["catch"](1);
+            case 10:
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](2);
               this._notifyAnalyticsListeners(_analytics.SLI_EVENT_TYPE, _types.SliNames.SEARCH_TEAM, _types.Actions.FAILED);
               throw _context3.t0;
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[1, 9]]);
+        }, _callee3, this, [[2, 10]]);
       }));
       function remoteTeamSearch(_x5, _x6) {
         return _remoteTeamSearch.apply(this, arguments);

package/dist/cjs/types.js

@@ -10,6 +10,13 @@ exports.isRestricted = isRestricted;
 exports.isSpecialMention = isSpecialMention;
 exports.isSpecialMentionText = isSpecialMentionText;
 exports.isTeamMention = isTeamMention;
+/**
+ * Configuration for the MentionResource, which provides a JavaScript API
+ * for fetching and searching user mentions from a remote service.
+ *
+ * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
+ * and `refreshedSecurityProvider` fields.
+ */
 // data is returned from team search service
 var MentionType = exports.MentionType = /*#__PURE__*/function (MentionType) {
   MentionType[MentionType["SELF"] = 0] = "SELF";

package/dist/cjs/util/analytics.js

@@ -12,7 +12,7 @@ var _types = require("../types");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var packageName = "@atlaskit/mention";
-var packageVersion = "24.4.10";
+var packageVersion = "0.0.0-development";
 var SLI_EVENT_TYPE = exports.SLI_EVENT_TYPE = 'sli';
 var SMART_EVENT_TYPE = exports.SMART_EVENT_TYPE = 'smart';
 var fireAnalyticsMentionTypeaheadEvent = exports.fireAnalyticsMentionTypeaheadEvent = function fireAnalyticsMentionTypeaheadEvent(props) {

package/dist/cjs/util/atl-attribution.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildAtlAttributionHeaderValue = buildAtlAttributionHeaderValue;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+function buildAtlAttributionHeaderValue(config) {
+  if (!(0, _platformFeatureFlags.fg)('mentions_custom_headers')) {
+    return undefined;
+  }
+  var cloudId = config.cloudId,
+    activationId = config.activationId,
+    _config$productId = config.productId,
+    productId = _config$productId === void 0 ? 'platform' : _config$productId;
+  var value = {
+    tenantId: cloudId,
+    product: productId
+  };
+  if (activationId) {
+    value.atlWorkspaceId = "ari:cloud:".concat(productId, ":").concat(cloudId, ":workspace/").concat(activationId);
+  }
+  return {
+    'atl-attribution': JSON.stringify(value)
+  };
+}

package/dist/es2019/api/MentionResource.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { utils as serviceUtils } from '@atlaskit/util-service-support';
 import { isAppMention, isTeamMention, MentionNameStatus, SliNames, Actions } from '../types';
 import debug from '../util/logger';
@@ -9,6 +10,14 @@ const MAX_NOTIFIED_ITEMS = 20;
 import { SLI_EVENT_TYPE } from '../util/analytics';
 import debounce from 'lodash/debounce';
 
+/**
+ * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
+ * to support fetching team mentions from a separate team search service endpoint.
+ *
+ * Used as the second argument when constructing a {@link TeamMentionResource}, alongside
+ * a standard `MentionResourceConfig` for user mentions.
+ */
+
 /**
  * Support
  */
@@ -257,9 +266,15 @@ export class MentionResource extends AbstractMentionResource {
    */
   async remoteInitialState(contextIdentifier) {
     const queryParams = this.getQueryParams(contextIdentifier);
+    const configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
     const options = {
       path: 'bootstrap',
-      queryParams
+      queryParams,
+      ...(configHeaders && {
+        requestInit: {
+          headers: configHeaders
+        }
+      })
     };
     try {
       const result = await serviceUtils.requestService(this.config, options);
@@ -276,13 +291,19 @@ export class MentionResource extends AbstractMentionResource {
     };
   }
   async remoteSearch(query, contextIdentifier) {
+    const configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
     const options = {
       path: 'search',
       queryParams: {
         query,
         limit: MAX_QUERY_ITEMS,
         ...this.getQueryParams(contextIdentifier)
-      }
+      },
+      ...(configHeaders && {
+        requestInit: {
+          headers: configHeaders
+        }
+      })
     };
     try {
       const result = await serviceUtils.requestService(this.config, options);

package/dist/es2019/api/PresenceResource.js

@@ -1,6 +1,15 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
+import { buildAtlAttributionHeaderValue } from '../util/atl-attribution';
 import debug from '../util/logger';
 import { AbstractResource } from './MentionResource';
+
+/**
+ * Configuration for the PresenceResource, which manages real-time user
+ * presence (online/offline/busy/focus status) by querying a GraphQL-based
+ * presence service.
+ */
+
 class CacheEntry {
   constructor(pres, timeout) {
     this.presence = pres;
@@ -70,10 +79,18 @@ class PresenceResource extends AbstractPresenceResource {
     if (this.config.productId) {
       query.variables['productId'] = this.config.productId;
     }
+    const configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
+    const atlAttributionHeader = buildAtlAttributionHeaderValue({
+      cloudId: this.config.cloudId,
+      productId: this.config.productId,
+      activationId: this.config.activationId
+    });
     const options = {
       method: 'POST',
       headers: {
-        'Content-Type': 'application/json'
+        'Content-Type': 'application/json',
+        ...atlAttributionHeader,
+        ...configHeaders
       },
       credentials: 'include',
       body: JSON.stringify(query)

package/dist/es2019/api/TeamMentionResource.js

@@ -1,5 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { SLI_EVENT_TYPE } from './../util/analytics';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { utils as serviceUtils } from '@atlaskit/util-service-support';
 import { UserType, UserAccessLevel, SliNames, Actions } from '../types';
 import MentionResource from './MentionResource';
@@ -41,9 +42,15 @@ export default class TeamMentionResource extends MentionResource {
     const emptyQuery = '';
     const getUserPromise = super.remoteInitialState(contextIdentifier);
     const queryParams = this.getQueryParamsOfTeamMentionConfig(contextIdentifier);
+    const configHeaders = fg('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
     const options = {
       path: 'bootstrap',
-      queryParams
+      queryParams,
+      ...(configHeaders && {
+        requestInit: {
+          headers: configHeaders
+        }
+      })
     };
     const getTeamsPromise = serviceUtils.requestService(this.teamMentionConfig, options);
     this.handleBothRequests(emptyQuery, getUserPromise, getTeamsPromise);
@@ -137,13 +144,19 @@ export default class TeamMentionResource extends MentionResource {
     return super.remoteSearch(query, contextIdentifier);
   }
   async remoteTeamSearch(query, contextIdentifier) {
+    const configHeaders = fg('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
     const options = {
       path: 'search',
       queryParams: {
         query,
         limit: MAX_QUERY_TEAMS,
         ...this.getQueryParamsOfTeamMentionConfig(contextIdentifier)
-      }
+      },
+      ...(configHeaders && {
+        requestInit: {
+          headers: configHeaders
+        }
+      })
     };
     try {
       const teamResult = await serviceUtils.requestService(this.teamMentionConfig, options);

package/dist/es2019/types.js

@@ -1,3 +1,11 @@
+/**
+ * Configuration for the MentionResource, which provides a JavaScript API
+ * for fetching and searching user mentions from a remote service.
+ *
+ * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
+ * and `refreshedSecurityProvider` fields.
+ */
+
 // data is returned from team search service
 
 export let MentionType = /*#__PURE__*/function (MentionType) {

package/dist/es2019/util/analytics.js

@@ -2,7 +2,7 @@ import { OPERATIONAL_EVENT_TYPE, UI_EVENT_TYPE } from '@atlaskit/analytics-gas-t
 import { ELEMENTS_CHANNEL } from '../_constants';
 import { ComponentNames, isSpecialMentionText } from '../types';
 const packageName = "@atlaskit/mention";
-const packageVersion = "24.4.10";
+const packageVersion = "0.0.0-development";
 export const SLI_EVENT_TYPE = 'sli';
 export const SMART_EVENT_TYPE = 'smart';
 export const fireAnalyticsMentionTypeaheadEvent = props => (action, duration, userIds = [], query) => {

package/dist/es2019/util/atl-attribution.js

@@ -0,0 +1,21 @@
+import { fg } from '@atlaskit/platform-feature-flags';
+export function buildAtlAttributionHeaderValue(config) {
+  if (!fg('mentions_custom_headers')) {
+    return undefined;
+  }
+  const {
+    cloudId,
+    activationId,
+    productId = 'platform'
+  } = config;
+  const value = {
+    tenantId: cloudId,
+    product: productId
+  };
+  if (activationId) {
+    value.atlWorkspaceId = `ari:cloud:${productId}:${cloudId}:workspace/${activationId}`;
+  }
+  return {
+    'atl-attribution': JSON.stringify(value)
+  };
+}

package/dist/esm/api/MentionResource.js

@@ -10,6 +10,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import { fg } from '@atlaskit/platform-feature-flags';
 import { utils as serviceUtils } from '@atlaskit/util-service-support';
 import { isAppMention, isTeamMention, MentionNameStatus, SliNames, Actions } from '../types';
 import debug from '../util/logger';
@@ -21,6 +22,14 @@ var MAX_NOTIFIED_ITEMS = 20;
 import { SLI_EVENT_TYPE } from '../util/analytics';
 import debounce from 'lodash/debounce';
 
+/**
+ * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
+ * to support fetching team mentions from a separate team search service endpoint.
+ *
+ * Used as the second argument when constructing a {@link TeamMentionResource}, alongside
+ * a standard `MentionResourceConfig` for user mentions.
+ */
+
 /**
  * Support
  */
@@ -357,32 +366,37 @@ export var MentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
     key: "remoteInitialState",
     value: (function () {
       var _remoteInitialState = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(contextIdentifier) {
-        var queryParams, options, result;
+        var queryParams, configHeaders, options, result;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               queryParams = this.getQueryParams(contextIdentifier);
-              options = {
+              configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
+              options = _objectSpread({
                 path: 'bootstrap',
                 queryParams: queryParams
-              };
-              _context2.prev = 2;
-              _context2.next = 5;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context2.prev = 3;
+              _context2.next = 6;
               return serviceUtils.requestService(this.config, options);
-            case 5:
+            case 6:
               result = _context2.sent;
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.INITIAL_STATE, Actions.SUCCEEDED);
               return _context2.abrupt("return", this.transformServiceResponse(result, ''));
-            case 10:
-              _context2.prev = 10;
-              _context2.t0 = _context2["catch"](2);
+            case 11:
+              _context2.prev = 11;
+              _context2.t0 = _context2["catch"](3);
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.INITIAL_STATE, Actions.FAILED);
               throw _context2.t0;
-            case 14:
+            case 15:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[2, 10]]);
+        }, _callee2, this, [[3, 11]]);
       }));
       function remoteInitialState(_x3) {
         return _remoteInitialState.apply(this, arguments);
@@ -400,34 +414,39 @@ export var MentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
     key: "remoteSearch",
     value: function () {
       var _remoteSearch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(query, contextIdentifier) {
-        var options, result;
+        var configHeaders, options, result;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              options = {
+              configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
+              options = _objectSpread({
                 path: 'search',
                 queryParams: _objectSpread({
                   query: query,
                   limit: MAX_QUERY_ITEMS
                 }, this.getQueryParams(contextIdentifier))
-              };
-              _context3.prev = 1;
-              _context3.next = 4;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context3.prev = 2;
+              _context3.next = 5;
               return serviceUtils.requestService(this.config, options);
-            case 4:
+            case 5:
               result = _context3.sent;
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.SEARCH, Actions.SUCCEEDED);
               return _context3.abrupt("return", this.transformServiceResponse(result, query));
-            case 9:
-              _context3.prev = 9;
-              _context3.t0 = _context3["catch"](1);
+            case 10:
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](2);
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.SEARCH, Actions.FAILED);
               throw _context3.t0;
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[1, 9]]);
+        }, _callee3, this, [[2, 10]]);
       }));
       function remoteSearch(_x4, _x5) {
         return _remoteSearch.apply(this, arguments);

package/dist/esm/api/PresenceResource.js

@@ -7,10 +7,20 @@ import _createClass from "@babel/runtime/helpers/createClass";
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import { fg } from '@atlaskit/platform-feature-flags';
+import { buildAtlAttributionHeaderValue } from '../util/atl-attribution';
 import debug from '../util/logger';
 import { AbstractResource } from './MentionResource';
+
+/**
+ * Configuration for the PresenceResource, which manages real-time user
+ * presence (online/offline/busy/focus status) by querying a GraphQL-based
+ * presence service.
+ */
 var CacheEntry = /*#__PURE__*/function () {
   function CacheEntry(pres, timeout) {
     _classCallCheck(this, CacheEntry);
@@ -101,11 +111,17 @@ var PresenceResource = /*#__PURE__*/function (_AbstractPresenceReso) {
       if (this.config.productId) {
         query.variables['productId'] = this.config.productId;
       }
+      var configHeaders = fg('mentions_custom_headers') ? this.config.headers : undefined;
+      var atlAttributionHeader = buildAtlAttributionHeaderValue({
+        cloudId: this.config.cloudId,
+        productId: this.config.productId,
+        activationId: this.config.activationId
+      });
       var options = {
         method: 'POST',
-        headers: {
+        headers: _objectSpread(_objectSpread({
           'Content-Type': 'application/json'
-        },
+        }, atlAttributionHeader), configHeaders),
         credentials: 'include',
         body: JSON.stringify(query)
       };

package/dist/esm/api/TeamMentionResource.js

@@ -7,13 +7,14 @@ import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _get from "@babel/runtime/helpers/get";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 import { SLI_EVENT_TYPE } from './../util/analytics';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { utils as serviceUtils } from '@atlaskit/util-service-support';
 import { UserType, UserAccessLevel, SliNames, Actions } from '../types';
 import MentionResource from './MentionResource';
@@ -61,20 +62,25 @@ var TeamMentionResource = /*#__PURE__*/function (_MentionResource) {
     key: "remoteInitialStateTeamAndUsers",
     value: (function () {
       var _remoteInitialStateTeamAndUsers = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(contextIdentifier) {
-        var emptyQuery, getUserPromise, queryParams, options, getTeamsPromise;
+        var emptyQuery, getUserPromise, queryParams, configHeaders, options, getTeamsPromise;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               emptyQuery = '';
               getUserPromise = _superPropGet(TeamMentionResource, "remoteInitialState", this, 3)([contextIdentifier]);
               queryParams = this.getQueryParamsOfTeamMentionConfig(contextIdentifier);
-              options = {
+              configHeaders = fg('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
+              options = _objectSpread({
                 path: 'bootstrap',
                 queryParams: queryParams
-              };
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
               getTeamsPromise = serviceUtils.requestService(this.teamMentionConfig, options);
               this.handleBothRequests(emptyQuery, getUserPromise, getTeamsPromise);
-            case 6:
+            case 7:
             case "end":
               return _context.stop();
           }
@@ -207,34 +213,39 @@ var TeamMentionResource = /*#__PURE__*/function (_MentionResource) {
     key: "remoteTeamSearch",
     value: function () {
       var _remoteTeamSearch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(query, contextIdentifier) {
-        var options, teamResult;
+        var configHeaders, options, teamResult;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              options = {
+              configHeaders = fg('mentions_custom_headers') ? this.teamMentionConfig.headers : undefined;
+              options = _objectSpread({
                 path: 'search',
                 queryParams: _objectSpread({
                   query: query,
                   limit: MAX_QUERY_TEAMS
                 }, this.getQueryParamsOfTeamMentionConfig(contextIdentifier))
-              };
-              _context3.prev = 1;
-              _context3.next = 4;
+              }, configHeaders && {
+                requestInit: {
+                  headers: configHeaders
+                }
+              });
+              _context3.prev = 2;
+              _context3.next = 5;
               return serviceUtils.requestService(this.teamMentionConfig, options);
-            case 4:
+            case 5:
               teamResult = _context3.sent;
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.SEARCH_TEAM, Actions.SUCCEEDED);
               return _context3.abrupt("return", this.convertTeamResultToMentionResult(teamResult, query));
-            case 9:
-              _context3.prev = 9;
-              _context3.t0 = _context3["catch"](1);
+            case 10:
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](2);
               this._notifyAnalyticsListeners(SLI_EVENT_TYPE, SliNames.SEARCH_TEAM, Actions.FAILED);
               throw _context3.t0;
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[1, 9]]);
+        }, _callee3, this, [[2, 10]]);
       }));
       function remoteTeamSearch(_x5, _x6) {
         return _remoteTeamSearch.apply(this, arguments);

package/dist/esm/types.js

@@ -1,3 +1,11 @@
+/**
+ * Configuration for the MentionResource, which provides a JavaScript API
+ * for fetching and searching user mentions from a remote service.
+ *
+ * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
+ * and `refreshedSecurityProvider` fields.
+ */
+
 // data is returned from team search service
 
 export var MentionType = /*#__PURE__*/function (MentionType) {

package/dist/esm/util/analytics.js

@@ -5,7 +5,7 @@ import { OPERATIONAL_EVENT_TYPE, UI_EVENT_TYPE } from '@atlaskit/analytics-gas-t
 import { ELEMENTS_CHANNEL } from '../_constants';
 import { ComponentNames, isSpecialMentionText } from '../types';
 var packageName = "@atlaskit/mention";
-var packageVersion = "24.4.10";
+var packageVersion = "0.0.0-development";
 export var SLI_EVENT_TYPE = 'sli';
 export var SMART_EVENT_TYPE = 'smart';
 export var fireAnalyticsMentionTypeaheadEvent = function fireAnalyticsMentionTypeaheadEvent(props) {

package/dist/esm/util/atl-attribution.js

@@ -0,0 +1,20 @@
+import { fg } from '@atlaskit/platform-feature-flags';
+export function buildAtlAttributionHeaderValue(config) {
+  if (!fg('mentions_custom_headers')) {
+    return undefined;
+  }
+  var cloudId = config.cloudId,
+    activationId = config.activationId,
+    _config$productId = config.productId,
+    productId = _config$productId === void 0 ? 'platform' : _config$productId;
+  var value = {
+    tenantId: cloudId,
+    product: productId
+  };
+  if (activationId) {
+    value.atlWorkspaceId = "ari:cloud:".concat(productId, ":").concat(cloudId, ":workspace/").concat(activationId);
+  }
+  return {
+    'atl-attribution': JSON.stringify(value)
+  };
+}

package/dist/types/api/MentionResource.d.ts

@@ -1,6 +1,20 @@
 import { type AnalyticsCallback, type ErrorCallback, type InfoCallback, type InviteFlow, type MentionContextIdentifier, type MentionDescription, type MentionNameDetails, type MentionProvider, type MentionResourceConfig, type MentionsResult, type MentionStats, type ResourceProvider, type ResultCallback, type UserRole } from '../types';
 export type { MentionStats, ResultCallback, ErrorCallback, InfoCallback, MentionResourceConfig, ResourceProvider, MentionContextIdentifier, MentionProvider, } from '../types';
+/**
+ * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
+ * to support fetching team mentions from a separate team search service endpoint.
+ *
+ * Used as the second argument when constructing a {@link TeamMentionResource}, alongside
+ * a standard `MentionResourceConfig` for user mentions.
+ */
 export interface TeamMentionResourceConfig extends MentionResourceConfig {
+    /**
+     * A custom resolver function to generate the URL for a team's profile page.
+     * If not provided, a default link of `{window.location.origin}/people/team/{teamId}` is used.
+     *
+     * @param teamId - The ID of the team (with any ARI prefix already trimmed).
+     * @returns The full URL to the team's profile page.
+     */
     teamLinkResolver?: (teamId: string) => string;
 }
 /**

package/dist/types/api/PresenceResource.d.ts

@@ -3,12 +3,52 @@ import { AbstractResource, type ResourceProvider } from './MentionResource';
 export interface PresenceMap {
     [userId: string]: Presence;
 }
+/**
+ * Configuration for the PresenceResource, which manages real-time user
+ * presence (online/offline/busy/focus status) by querying a GraphQL-based
+ * presence service.
+ */
 export interface PresenceResourceConfig {
+    /**
+     * The activation ID for the current product instance, used to build
+     * the `atl-attribution` header for presence service requests.
+     */
+    activationId?: string;
+    /**
+     * A custom cache implementation for storing presence data. If not provided,
+     * a {@link DefaultPresenceCache} is used with the specified `cacheExpiry`.
+     */
     cache?: PresenceCache;
+    /**
+     * The expiry time in milliseconds for cached presence entries.
+     * Defaults to 20,000ms (20 seconds) when using the default cache.
+     */
     cacheExpiry?: number;
+    /**
+     * The cloud ID (organization ID) of the Atlassian site. Required.
+     * Used as the `organizationId` variable in the presence GraphQL query.
+     */
     cloudId: string;
+    /**
+     * Custom HTTP headers to include in presence service requests.
+     * Only applied when the `mentions_custom_headers` feature flag is enabled.
+     */
+    headers?: Record<string, string>;
+    /**
+     * A custom parser for transforming raw presence service responses into
+     * a {@link PresenceMap}. If not provided, a {@link DefaultPresenceParser} is used,
+     * which maps `'available'` → `'online'` and `'unavailable'` → `'offline'`.
+     */
     parser?: PresenceParser;
+    /**
+     * The product identifier (e.g. `'confluence'`, `'jira'`) passed as the
+     * `product` variable in the presence GraphQL query to scope results.
+     */
     productId?: string;
+    /**
+     * The base URL of the presence service endpoint. Required.
+     * A trailing slash will be appended automatically if not present.
+     */
     url: string;
 }
 export interface PresenceCache {

package/dist/types/types.d.ts

@@ -21,16 +21,78 @@ export interface AnalyticsCallback {
         [key: string]: any;
     }): void;
 }
+/**
+ * Configuration for the MentionResource, which provides a JavaScript API
+ * for fetching and searching user mentions from a remote service.
+ *
+ * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
+ * and `refreshedSecurityProvider` fields.
+ */
 export interface MentionResourceConfig extends ServiceConfig {
+    /**
+     * The ID of the container (e.g. a Confluence space or Jira project) used to scope
+     * mention search results. Can be overridden by `MentionContextIdentifier.containerId`.
+     */
     containerId?: string;
+    /**
+     * Debounce time in milliseconds for the `filter` method. When set, rapid successive
+     * calls to `filter` will be debounced to reduce the number of network requests.
+     */
     debounceTime?: number;
+    /**
+     * Custom HTTP headers to include in mention service requests.
+     * Only applied when the `mentions_custom_headers` feature flag is enabled.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Callback to invite a cross-product user. Invoked when a user from another
+     * Atlassian product is selected for mention and needs to be invited.
+     *
+     * @param userId - The ID of the user to invite.
+     * @param mentionName - The display name of the user being invited.
+     * @returns A promise that resolves when the invitation is complete.
+     */
     inviteXProductUser?: (userId: string, mentionName: string) => Promise<void>;
+    /**
+     * A resolver for looking up and caching mention display names by user ID.
+     * Used by `ResolvingMentionProvider` to resolve names for mentions that
+     * only have an ID (e.g. when rendering stored mention nodes).
+     */
     mentionNameResolver?: MentionNameResolver;
+    /**
+     * Callback invoked when the inline invite item is clicked in the mention picker.
+     *
+     * @param flow - The type of invite flow, either `'mention'` or `'assign'`.
+     */
     onInviteItemClick?: (flow: InviteFlow) => void;
+    /**
+     * The product identifier (e.g. `'confluence'`, `'jira'`) sent as a query parameter
+     * (`productIdentifier`) to the mention service for product-scoped results.
+     */
     productId?: string;
+    /**
+     * The display name of the product, exposed on the `MentionProvider` for use
+     * by invite-related UI components.
+     */
     productName?: string;
+    /**
+     * Whether to enable the inline invite functionality in the mention picker,
+     * allowing users to invite people who are not yet part of the site.
+     */
     shouldEnableInvite?: boolean;
+    /**
+     * A function to determine whether a given mention should be visually highlighted
+     * (e.g. as a self-mention). When provided, it is called for each mention to decide
+     * if the `MentionType.SELF` styling should be applied.
+     *
+     * @param mention - The mention to evaluate.
+     * @returns `true` if the mention should be highlighted.
+     */
     shouldHighlightMention?: (mention: MentionDescription) => boolean;
+    /**
+     * The role of the current user, used to determine invite permissions
+     * in the mention picker. Defaults to `'basic'` if not provided.
+     */
     userRole?: UserRole;
 }
 export interface ResourceProvider<Result> {

package/dist/types/util/atl-attribution.d.ts

@@ -0,0 +1,8 @@
+export interface AtlAttributionConfig {
+    activationId?: string;
+    cloudId: string;
+    productId?: string;
+}
+export declare function buildAtlAttributionHeaderValue(config: AtlAttributionConfig): {
+    'atl-attribution': string;
+} | undefined;

package/dist/types-ts4.5/api/MentionResource.d.ts

@@ -1,6 +1,20 @@
 import { type AnalyticsCallback, type ErrorCallback, type InfoCallback, type InviteFlow, type MentionContextIdentifier, type MentionDescription, type MentionNameDetails, type MentionProvider, type MentionResourceConfig, type MentionsResult, type MentionStats, type ResourceProvider, type ResultCallback, type UserRole } from '../types';
 export type { MentionStats, ResultCallback, ErrorCallback, InfoCallback, MentionResourceConfig, ResourceProvider, MentionContextIdentifier, MentionProvider, } from '../types';
+/**
+ * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
+ * to support fetching team mentions from a separate team search service endpoint.
+ *
+ * Used as the second argument when constructing a {@link TeamMentionResource}, alongside
+ * a standard `MentionResourceConfig` for user mentions.
+ */
 export interface TeamMentionResourceConfig extends MentionResourceConfig {
+    /**
+     * A custom resolver function to generate the URL for a team's profile page.
+     * If not provided, a default link of `{window.location.origin}/people/team/{teamId}` is used.
+     *
+     * @param teamId - The ID of the team (with any ARI prefix already trimmed).
+     * @returns The full URL to the team's profile page.
+     */
     teamLinkResolver?: (teamId: string) => string;
 }
 /**

package/dist/types-ts4.5/api/PresenceResource.d.ts

@@ -3,12 +3,52 @@ import { AbstractResource, type ResourceProvider } from './MentionResource';
 export interface PresenceMap {
     [userId: string]: Presence;
 }
+/**
+ * Configuration for the PresenceResource, which manages real-time user
+ * presence (online/offline/busy/focus status) by querying a GraphQL-based
+ * presence service.
+ */
 export interface PresenceResourceConfig {
+    /**
+     * The activation ID for the current product instance, used to build
+     * the `atl-attribution` header for presence service requests.
+     */
+    activationId?: string;
+    /**
+     * A custom cache implementation for storing presence data. If not provided,
+     * a {@link DefaultPresenceCache} is used with the specified `cacheExpiry`.
+     */
     cache?: PresenceCache;
+    /**
+     * The expiry time in milliseconds for cached presence entries.
+     * Defaults to 20,000ms (20 seconds) when using the default cache.
+     */
     cacheExpiry?: number;
+    /**
+     * The cloud ID (organization ID) of the Atlassian site. Required.
+     * Used as the `organizationId` variable in the presence GraphQL query.
+     */
     cloudId: string;
+    /**
+     * Custom HTTP headers to include in presence service requests.
+     * Only applied when the `mentions_custom_headers` feature flag is enabled.
+     */
+    headers?: Record<string, string>;
+    /**
+     * A custom parser for transforming raw presence service responses into
+     * a {@link PresenceMap}. If not provided, a {@link DefaultPresenceParser} is used,
+     * which maps `'available'` → `'online'` and `'unavailable'` → `'offline'`.
+     */
     parser?: PresenceParser;
+    /**
+     * The product identifier (e.g. `'confluence'`, `'jira'`) passed as the
+     * `product` variable in the presence GraphQL query to scope results.
+     */
     productId?: string;
+    /**
+     * The base URL of the presence service endpoint. Required.
+     * A trailing slash will be appended automatically if not present.
+     */
     url: string;
 }
 export interface PresenceCache {

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

@@ -21,16 +21,78 @@ export interface AnalyticsCallback {
         [key: string]: any;
     }): void;
 }
+/**
+ * Configuration for the MentionResource, which provides a JavaScript API
+ * for fetching and searching user mentions from a remote service.
+ *
+ * Extends {@link ServiceConfig} which provides the base `url`, `securityProvider`,
+ * and `refreshedSecurityProvider` fields.
+ */
 export interface MentionResourceConfig extends ServiceConfig {
+    /**
+     * The ID of the container (e.g. a Confluence space or Jira project) used to scope
+     * mention search results. Can be overridden by `MentionContextIdentifier.containerId`.
+     */
     containerId?: string;
+    /**
+     * Debounce time in milliseconds for the `filter` method. When set, rapid successive
+     * calls to `filter` will be debounced to reduce the number of network requests.
+     */
     debounceTime?: number;
+    /**
+     * Custom HTTP headers to include in mention service requests.
+     * Only applied when the `mentions_custom_headers` feature flag is enabled.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Callback to invite a cross-product user. Invoked when a user from another
+     * Atlassian product is selected for mention and needs to be invited.
+     *
+     * @param userId - The ID of the user to invite.
+     * @param mentionName - The display name of the user being invited.
+     * @returns A promise that resolves when the invitation is complete.
+     */
     inviteXProductUser?: (userId: string, mentionName: string) => Promise<void>;
+    /**
+     * A resolver for looking up and caching mention display names by user ID.
+     * Used by `ResolvingMentionProvider` to resolve names for mentions that
+     * only have an ID (e.g. when rendering stored mention nodes).
+     */
     mentionNameResolver?: MentionNameResolver;
+    /**
+     * Callback invoked when the inline invite item is clicked in the mention picker.
+     *
+     * @param flow - The type of invite flow, either `'mention'` or `'assign'`.
+     */
     onInviteItemClick?: (flow: InviteFlow) => void;
+    /**
+     * The product identifier (e.g. `'confluence'`, `'jira'`) sent as a query parameter
+     * (`productIdentifier`) to the mention service for product-scoped results.
+     */
     productId?: string;
+    /**
+     * The display name of the product, exposed on the `MentionProvider` for use
+     * by invite-related UI components.
+     */
     productName?: string;
+    /**
+     * Whether to enable the inline invite functionality in the mention picker,
+     * allowing users to invite people who are not yet part of the site.
+     */
     shouldEnableInvite?: boolean;
+    /**
+     * A function to determine whether a given mention should be visually highlighted
+     * (e.g. as a self-mention). When provided, it is called for each mention to decide
+     * if the `MentionType.SELF` styling should be applied.
+     *
+     * @param mention - The mention to evaluate.
+     * @returns `true` if the mention should be highlighted.
+     */
     shouldHighlightMention?: (mention: MentionDescription) => boolean;
+    /**
+     * The role of the current user, used to determine invite permissions
+     * in the mention picker. Defaults to `'basic'` if not provided.
+     */
     userRole?: UserRole;
 }
 export interface ResourceProvider<Result> {

package/dist/types-ts4.5/util/atl-attribution.d.ts

@@ -0,0 +1,8 @@
+export interface AtlAttributionConfig {
+    activationId?: string;
+    cloudId: string;
+    productId?: string;
+}
+export declare function buildAtlAttributionHeaderValue(config: AtlAttributionConfig): {
+    'atl-attribution': string;
+} | undefined;

package/package.json

@@ -22,7 +22,7 @@
 		"@atlaskit/afm-i18n-platform-elements-mention": "2.7.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-next": "^11.1.0",
-		"@atlaskit/avatar": "^25.7.0",
+		"@atlaskit/avatar": "^25.8.0",
 		"@atlaskit/focus-ring": "^3.0.0",
 		"@atlaskit/heading": "^5.3.0",
 		"@atlaskit/icon": "^31.0.0",
@@ -83,6 +83,9 @@
 		"jira_ai_agent_avatar_issue_view_comment_mentions": {
 			"type": "boolean"
 		},
+		"mentions_custom_headers": {
+			"type": "boolean"
+		},
 		"team-avatar-in-mention-picker": {
 			"type": "boolean"
 		}
@@ -112,5 +115,5 @@
 			]
 		}
 	},
-	"version": "24.4.11"
+	"version": "24.5.0"
 }

package/tsconfig.json

@@ -13,6 +13,5 @@
     "**/stories/*.tsx",
     "**/stories/**/*.ts",
     "**/stories/**/*.tsx"
-  ],
-  "compilerOptions": {}
+  ]
 }