@atlaskit/smart-user-picker 8.2.1 → 8.3.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlassian/smart-user-picker
 
+## 8.3.1
+
+### Patch Changes
+
+- [`56ac0cf74b37d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/56ac0cf74b37d) -
+  Migrated teams assets to new service
+
+## 8.3.0
+
+### Minor Changes
+
+- [`be2f98085fa9f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/be2f98085fa9f) -
+  [ux] Introduce additional email props to smart user picker (displayEmailInByline,
+  enableEmailSearch, allowEmailSelectionWhenEmailMatched) and one type adjustment to user picker
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.2.1
 
 ### Patch Changes

package/dist/cjs/analytics.js

@@ -11,7 +11,7 @@ var _uuid = require("uuid");
 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/smart-user-picker";
-var packageVersion = "0.0.0-development";
+var packageVersion = "8.3.0";
 var startSession = exports.startSession = function startSession() {
   return {
     id: (0, _uuid.v4)(),

package/dist/cjs/components/SmartUserPicker.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.SmartUserPickerWithoutAnalytics = exports.SmartUserPicker = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _toArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
@@ -28,8 +29,10 @@ var _userPicker = _interopRequireWildcard(require("@atlaskit/user-picker"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _analytics = require("../analytics");
 var _MessagesIntlProvider = _interopRequireDefault(require("./MessagesIntlProvider"));
+var _types = require("../types");
 var _service = require("../service");
 var _ufoExperiences = require("../ufoExperiences");
+var _excluded = ["allowEmail", "enableEmailSearch", "allowEmailSelectionWhenEmailMatched"];
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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; }
@@ -71,6 +74,9 @@ var getUsersForAnalytics = function getUsersForAnalytics(users) {
 var checkIf500Event = function checkIf500Event(statusCode) {
   return 500 <= statusCode && statusCode < 600;
 };
+var isEmailQuery = function isEmailQuery(query) {
+  return (0, _userPicker.isValidEmail)(query.trim()) === 'VALID';
+};
 var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Component) {
   function SmartUserPickerWithoutAnalytics(props) {
     var _this$props$debounceT;
@@ -85,6 +91,8 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
       defaultValue: [],
       bootstrapOptions: []
     });
+    // Track if the last search was an email search that found matches
+    (0, _defineProperty2.default)(_this, "lastEmailSearchFoundMatches", false);
     (0, _defineProperty2.default)(_this, "abortOptionsShownUfoExperience", function () {
       if (_this.optionsShownUfoExperienceInstance.state.id === _ufo.UFOExperienceState.STARTED.id) {
         // There may be an existing UFO timing running from previous key entry or focus,
@@ -110,14 +118,15 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
     });
     (0, _defineProperty2.default)(_this, "memoizedFilterOptions", (0, _memoizeOne.default)(_this.filterOptions));
     (0, _defineProperty2.default)(_this, "getUsers", (0, _debounce.default)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-      var _this$state, query, sessionId, closed, _this$props, baseUrl, childObjectId, containerId, fieldId, includeGroups, includeTeams, includeUsers, includeNonLicensedUsers, intl, maxOptions, objectId, onEmpty, onError, overrideByline, orgId, principalId, productAttributes, productKey, searchQueryFilter, siteId, transformOptions, userResolvers, maxNumberOfResults, startTime, recommendationsRequest, _yield$onEmpty, _query, recommendedUsers, userRecommendationsPromise, userResolversPromises, _yield$Promise$all, _yield$Promise$all2, mainRecommendations, userResolverResults, _iterator, _step, option, elapsedTimeMilli, transformedOptions, displayedUsers, is5xxEvent, onErrorProducedError, defaultUsers, _elapsedTimeMilli;
+      var _this$state, query, sessionId, closed, _this$props, baseUrl, childObjectId, containerId, fieldId, includeGroups, includeTeams, includeUsers, includeNonLicensedUsers, intl, maxOptions, objectId, onEmpty, onError, overrideByline, displayEmailInByline, orgId, principalId, productAttributes, productKey, searchQueryFilter, siteId, transformOptions, userResolvers, enableEmailSearch, maxNumberOfResults, startTime, isEmail, recommendationsRequest, _yield$onEmpty, _query, recommendedUsers, userRecommendationsPromise, userResolversPromises, _yield$Promise$all, _yield$Promise$all2, mainRecommendations, userResolverResults, _iterator, _step, option, _iterator2, _step2, _option, elapsedTimeMilli, transformedOptions, displayedUsers, is5xxEvent, onErrorProducedError, defaultUsers, _elapsedTimeMilli;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _this$state = _this.state, query = _this$state.query, sessionId = _this$state.sessionId, closed = _this$state.closed;
-            _this$props = _this.props, baseUrl = _this$props.baseUrl, childObjectId = _this$props.childObjectId, containerId = _this$props.containerId, fieldId = _this$props.fieldId, includeGroups = _this$props.includeGroups, includeTeams = _this$props.includeTeams, includeUsers = _this$props.includeUsers, includeNonLicensedUsers = _this$props.includeNonLicensedUsers, intl = _this$props.intl, maxOptions = _this$props.maxOptions, objectId = _this$props.objectId, onEmpty = _this$props.onEmpty, onError = _this$props.onError, overrideByline = _this$props.overrideByline, orgId = _this$props.orgId, principalId = _this$props.principalId, productAttributes = _this$props.productAttributes, productKey = _this$props.productKey, searchQueryFilter = _this$props.searchQueryFilter, siteId = _this$props.siteId, transformOptions = _this$props.transformOptions, userResolvers = _this$props.userResolvers;
+            _this$props = _this.props, baseUrl = _this$props.baseUrl, childObjectId = _this$props.childObjectId, containerId = _this$props.containerId, fieldId = _this$props.fieldId, includeGroups = _this$props.includeGroups, includeTeams = _this$props.includeTeams, includeUsers = _this$props.includeUsers, includeNonLicensedUsers = _this$props.includeNonLicensedUsers, intl = _this$props.intl, maxOptions = _this$props.maxOptions, objectId = _this$props.objectId, onEmpty = _this$props.onEmpty, onError = _this$props.onError, overrideByline = _this$props.overrideByline, displayEmailInByline = _this$props.displayEmailInByline, orgId = _this$props.orgId, principalId = _this$props.principalId, productAttributes = _this$props.productAttributes, productKey = _this$props.productKey, searchQueryFilter = _this$props.searchQueryFilter, siteId = _this$props.siteId, transformOptions = _this$props.transformOptions, userResolvers = _this$props.userResolvers, enableEmailSearch = _this$props.enableEmailSearch;
             maxNumberOfResults = maxOptions || 100;
-            startTime = window.performance.now();
+            startTime = window.performance.now(); // Check if this is an email search
+            isEmail = enableEmailSearch && isEmailQuery(query);
             recommendationsRequest = {
               baseUrl: baseUrl,
               context: {
@@ -133,18 +142,27 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
                 productAttributes: productAttributes
               },
               includeUsers: includeUsers,
-              includeGroups: includeGroups,
-              includeTeams: includeTeams,
+              // For email searches, disable groups and teams
+              includeGroups: isEmail ? false : includeGroups,
+              includeTeams: isEmail ? false : includeTeams,
               includeNonLicensedUsers: includeNonLicensedUsers,
               maxNumberOfResults: maxNumberOfResults,
-              query: query,
-              searchQueryFilter: searchQueryFilter
+              // For email searches, leverage customQuery instead of queryString
+              query: isEmail ? '' : query,
+              customQuery: isEmail ? "(email:\"".concat(query.trim(), "\")") : '',
+              /*
+              	For email-based searches, we have decided to filter out apps.
+              	Also - because the other 2 filters ((NOT not_mentionable:true) AND (account_status:active)) are included
+              	when filter is empty, they have been added here to maintain consistency.
+              		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
+               */
+              searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter
             };
-            _context.prev = 5;
+            _context.prev = 6;
             _query = _this.state.query;
             _this.fireEvent(_analytics.requestUsersEvent);
             if (!(0, _platformFeatureFlags.fg)('twcg-444-invite-usd-improvements-m2-gate')) {
-              _context.next = 20;
+              _context.next = 21;
               break;
             }
             userRecommendationsPromise = (0, _service.getUserRecommendations)(recommendationsRequest, intl);
@@ -157,22 +175,22 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
                 return [];
               });
             });
-            _context.next = 13;
+            _context.next = 14;
             return Promise.all([userRecommendationsPromise].concat((0, _toConsumableArray2.default)(userResolversPromises)));
-          case 13:
+          case 14:
             _yield$Promise$all = _context.sent;
             _yield$Promise$all2 = (0, _toArray2.default)(_yield$Promise$all);
             mainRecommendations = _yield$Promise$all2[0];
             userResolverResults = _yield$Promise$all2.slice(1);
             recommendedUsers = [mainRecommendations].concat((0, _toConsumableArray2.default)(userResolverResults)).flat();
-            _context.next = 23;
+            _context.next = 24;
             break;
-          case 20:
-            _context.next = 22;
+          case 21:
+            _context.next = 23;
             return (0, _service.getUserRecommendations)(recommendationsRequest, intl);
-          case 22:
-            recommendedUsers = _context.sent;
           case 23:
+            recommendedUsers = _context.sent;
+          case 24:
             if (overrideByline) {
               _iterator = _createForOfIteratorHelper(recommendedUsers);
               try {
@@ -188,52 +206,79 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
                 _iterator.f();
               }
             }
+            if (displayEmailInByline) {
+              _iterator2 = _createForOfIteratorHelper(recommendedUsers);
+              try {
+                for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                  _option = _step2.value;
+                  if ((0, _userPicker.isUser)(_option) || (0, _userPicker.isExternalUser)(_option)) {
+                    if (_option.userType === _types.UserEntityType.DEFAULT || _option.userType === _types.UserEntityType.CUSTOMER) {
+                      // Respect existing byline if present
+                      if (_option.email && !_option.byline) {
+                        _option.byline = _option.email;
+                      }
+                    }
+                  }
+                }
+              } catch (err) {
+                _iterator2.e(err);
+              } finally {
+                _iterator2.f();
+              }
+            }
+
+            // Track if email search found matches for conditional allowEmail logic
+            if (isEmail) {
+              _this.lastEmailSearchFoundMatches = recommendedUsers.length > 0;
+            } else {
+              _this.lastEmailSearchFoundMatches = false;
+            }
             elapsedTimeMilli = window.performance.now() - startTime;
             if (!transformOptions) {
-              _context.next = 31;
+              _context.next = 34;
               break;
             }
-            _context.next = 28;
+            _context.next = 31;
             return transformOptions(recommendedUsers, _query);
-          case 28:
+          case 31:
             _context.t0 = _context.sent;
-            _context.next = 32;
+            _context.next = 35;
             break;
-          case 31:
+          case 34:
             _context.t0 = recommendedUsers;
-          case 32:
+          case 35:
             transformedOptions = _context.t0;
             if (!(transformedOptions.length === 0 && onEmpty)) {
-              _context.next = 48;
+              _context.next = 51;
               break;
             }
-            _context.next = 36;
+            _context.next = 39;
             return onEmpty(_query);
-          case 36:
+          case 39:
             _context.t3 = _yield$onEmpty = _context.sent;
             _context.t2 = _context.t3 !== null;
             if (!_context.t2) {
-              _context.next = 40;
+              _context.next = 43;
               break;
             }
             _context.t2 = _yield$onEmpty !== void 0;
-          case 40:
+          case 43:
             if (!_context.t2) {
-              _context.next = 44;
+              _context.next = 47;
               break;
             }
             _context.t4 = _yield$onEmpty;
-            _context.next = 45;
+            _context.next = 48;
             break;
-          case 44:
+          case 47:
             _context.t4 = [];
-          case 45:
+          case 48:
             _context.t1 = _context.t4;
-            _context.next = 49;
+            _context.next = 52;
             break;
-          case 48:
+          case 51:
             _context.t1 = transformedOptions;
-          case 49:
+          case 52:
             displayedUsers = _context.t1;
             _this.setState(function (state) {
               var applicable = state.query === _query;
@@ -255,11 +300,11 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
                 loading: loading
               };
             });
-            _context.next = 82;
+            _context.next = 85;
             break;
-          case 53:
-            _context.prev = 53;
-            _context.t5 = _context["catch"](5);
+          case 56:
+            _context.prev = 56;
+            _context.t5 = _context["catch"](6);
             is5xxEvent = checkIf500Event(_context.t5.statusCode);
             if (!closed && !onError && is5xxEvent) {
               // If the user lookup fails while the menu is open, and the consumer is not providing a
@@ -271,35 +316,35 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
             });
             onErrorProducedError = false;
             defaultUsers = [];
-            _context.prev = 60;
+            _context.prev = 63;
             if (!onError) {
-              _context.next = 70;
+              _context.next = 73;
               break;
             }
-            _context.next = 64;
+            _context.next = 67;
             return onError(_context.t5, recommendationsRequest);
-          case 64:
+          case 67:
             _context.t7 = _context.sent;
             if (_context.t7) {
-              _context.next = 67;
+              _context.next = 70;
               break;
             }
             _context.t7 = [];
-          case 67:
+          case 70:
             _context.t6 = _context.t7;
-            _context.next = 71;
+            _context.next = 74;
             break;
-          case 70:
+          case 73:
             _context.t6 = [];
-          case 71:
+          case 74:
             defaultUsers = _context.t6;
-            _context.next = 77;
+            _context.next = 80;
             break;
-          case 74:
-            _context.prev = 74;
-            _context.t8 = _context["catch"](60);
-            onErrorProducedError = true;
           case 77:
+            _context.prev = 77;
+            _context.t8 = _context["catch"](63);
+            onErrorProducedError = true;
+          case 80:
             if (onErrorProducedError && is5xxEvent) {
               // Log error from fallback data source `onError` to UFO
               _this.optionsShownUfoExperienceInstance.failure(ufoEndStateConfig(_this.props.fieldId));
@@ -316,11 +361,11 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
               elapsedTimeMilli: _elapsedTimeMilli,
               productAttributes: productAttributes
             });
-          case 82:
+          case 85:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[5, 53], [60, 74]]);
+      }, _callee, null, [[6, 56], [63, 77]]);
     })), (_this$props$debounceT = _this.props.debounceTime) !== null && _this$props$debounceT !== void 0 ? _this$props$debounceT : 0));
     (0, _defineProperty2.default)(_this, "onInputChange", function (newQuery, sessionId) {
       var query = newQuery || '';
@@ -376,7 +421,6 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
     });
     (0, _defineProperty2.default)(_this, "onFocus", function (sessionId) {
       var state = {
-        query: '',
         closed: false
       };
       _this.startOptionsShownUfoExperience();
@@ -488,7 +532,21 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
   }, {
     key: "render",
     value: function render() {
-      return /*#__PURE__*/_react.default.createElement(_MessagesIntlProvider.default, null, /*#__PURE__*/_react.default.createElement(_userPicker.default, (0, _extends2.default)({}, this.props, {
+      var _this$props2 = this.props,
+        allowEmail = _this$props2.allowEmail,
+        enableEmailSearch = _this$props2.enableEmailSearch,
+        allowEmailSelectionWhenEmailMatched = _this$props2.allowEmailSelectionWhenEmailMatched,
+        restProps = (0, _objectWithoutProperties2.default)(_this$props2, _excluded);
+
+      // Determine whether to allow email selection based on allowEmailSelectionWhenEmailMatched, if needed
+      var shouldAllowEmail = allowEmail;
+      if (allowEmail && enableEmailSearch && !allowEmailSelectionWhenEmailMatched) {
+        // Only allow email selection if we're in an email search that found no matches
+        var isCurrentQueryEmail = isEmailQuery(this.state.query);
+        shouldAllowEmail = !isCurrentQueryEmail || !this.lastEmailSearchFoundMatches;
+      }
+      return /*#__PURE__*/_react.default.createElement(_MessagesIntlProvider.default, null, /*#__PURE__*/_react.default.createElement(_userPicker.default, (0, _extends2.default)({}, restProps, {
+        allowEmail: shouldAllowEmail,
         onInputChange: this.onInputChange,
         onBlur: this.onBlur,
         onFocus: this.onFocus,
@@ -505,9 +563,12 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
   includeGroups: false,
   includeTeams: false,
   includeNonLicensedUsers: false,
+  displayEmailInByline: false,
   prefetch: false,
   principalId: 'Context',
   debounceTime: DEFAULT_DEBOUNCE_TIME_MS,
-  userResolvers: []
+  userResolvers: [],
+  enableEmailSearch: false,
+  allowEmailSelectionWhenEmailMatched: true
 });
 var SmartUserPicker = exports.SmartUserPicker = (0, _analyticsNext.withAnalyticsEvents)()((0, _reactIntlNext.injectIntl)(SmartUserPickerWithoutAnalytics));

package/dist/cjs/service/recommendation-client.js

@@ -35,7 +35,7 @@ var getUserRecommendations = function getUserRecommendations(request, intl) {
       }, ((_request$context = request.context) === null || _request$context === void 0 || (_request$context = _request$context.productAttributes) === null || _request$context === void 0 ? void 0 : _request$context.isEntitledConfluenceExternalCollaborator) && {
         productAccessPermissionIds: ['write', 'external-collaborator-write']
       }), {}, {
-        customQuery: '',
+        customQuery: request.customQuery || '',
         customerDirectoryId: '',
         filter: request.searchQueryFilter || '',
         minimumAccessLevel: 'APPLICATION',

package/dist/cjs/service/users-transformer.js

@@ -30,6 +30,7 @@ var transformUser = function transformUser(item, intl) {
     return {
       id: user.id,
       type: user.nonLicensedUser ? _userPicker.ExternalUserType : _userPicker.UserType,
+      userType: user.userType,
       avatarUrl: user.avatarUrl,
       name: user.name,
       email: user.email,

package/dist/cjs/types.js

@@ -3,10 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EntityType = void 0;
+exports.UserEntityType = exports.EntityType = void 0;
 var EntityType = exports.EntityType = /*#__PURE__*/function (EntityType) {
   EntityType["USER"] = "USER";
   EntityType["TEAM"] = "TEAM";
   EntityType["GROUP"] = "GROUP";
   return EntityType;
+}({});
+var UserEntityType = exports.UserEntityType = /*#__PURE__*/function (UserEntityType) {
+  UserEntityType["DEFAULT"] = "DEFAULT";
+  UserEntityType["APP"] = "APP";
+  UserEntityType["CUSTOMER"] = "CUSTOMER";
+  UserEntityType["SYSTEM"] = "SYSTEM";
+  return UserEntityType;
 }({}); // Override UserPickerProps below with replacement documentation

package/dist/es2019/analytics.js

@@ -1,7 +1,7 @@
 import { createAndFireEvent } from '@atlaskit/analytics-next';
 import { v4 as uuid } from 'uuid';
 const packageName = "@atlaskit/smart-user-picker";
-const packageVersion = "0.0.0-development";
+const packageVersion = "8.3.0";
 export const startSession = () => ({
   id: uuid(),
   start: Date.now(),

package/dist/es2019/components/SmartUserPicker.js

@@ -7,10 +7,11 @@ import { withAnalyticsEvents } from '@atlaskit/analytics-next';
 import memoizeOne from 'memoize-one';
 import { injectIntl } from 'react-intl-next';
 import { UFOExperienceState } from '@atlaskit/ufo';
-import UserPicker, { isExternalUser, isTeam, isUser } from '@atlaskit/user-picker';
+import UserPicker, { isExternalUser, isTeam, isUser, isValidEmail } from '@atlaskit/user-picker';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { requestUsersEvent, filterUsersEvent, preparedUsersLoadedEvent, successfulRequestUsersEvent, failedRequestUsersEvent, mountedWithPrefetchEvent, createAndFireEventInElementsChannel, failedUserResolversEvent } from '../analytics';
 import MessagesIntlProvider from './MessagesIntlProvider';
+import { UserEntityType } from '../types';
 import { getUserRecommendations, hydrateDefaultValues } from '../service';
 import { smartUserPickerOptionsShownUfoExperience } from '../ufoExperiences';
 const DEFAULT_DEBOUNCE_TIME_MS = 150;
@@ -39,6 +40,9 @@ const getUsersForAnalytics = users => (users || []).map(({
   type
 }));
 const checkIf500Event = statusCode => 500 <= statusCode && statusCode < 600;
+const isEmailQuery = query => {
+  return isValidEmail(query.trim()) === 'VALID';
+};
 export class SmartUserPickerWithoutAnalytics extends React.Component {
   constructor(props) {
     var _this$props$debounceT;
@@ -51,6 +55,8 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
       defaultValue: [],
       bootstrapOptions: []
     });
+    // Track if the last search was an email search that found matches
+    _defineProperty(this, "lastEmailSearchFoundMatches", false);
     _defineProperty(this, "abortOptionsShownUfoExperience", () => {
       if (this.optionsShownUfoExperienceInstance.state.id === UFOExperienceState.STARTED.id) {
         // There may be an existing UFO timing running from previous key entry or focus,
@@ -93,6 +99,7 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
         onEmpty,
         onError,
         overrideByline,
+        displayEmailInByline,
         orgId,
         principalId,
         productAttributes,
@@ -100,10 +107,14 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
         searchQueryFilter,
         siteId,
         transformOptions,
-        userResolvers
+        userResolvers,
+        enableEmailSearch
       } = this.props;
       const maxNumberOfResults = maxOptions || 100;
       const startTime = window.performance.now();
+
+      // Check if this is an email search
+      const isEmail = enableEmailSearch && isEmailQuery(query);
       const recommendationsRequest = {
         baseUrl,
         context: {
@@ -119,12 +130,21 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
           productAttributes
         },
         includeUsers,
-        includeGroups,
-        includeTeams,
+        // For email searches, disable groups and teams
+        includeGroups: isEmail ? false : includeGroups,
+        includeTeams: isEmail ? false : includeTeams,
         includeNonLicensedUsers,
         maxNumberOfResults,
-        query,
-        searchQueryFilter
+        // For email searches, leverage customQuery instead of queryString
+        query: isEmail ? '' : query,
+        customQuery: isEmail ? `(email:"${query.trim()}")` : '',
+        /*
+        	For email-based searches, we have decided to filter out apps.
+        	Also - because the other 2 filters ((NOT not_mentionable:true) AND (account_status:active)) are included
+        	when filter is empty, they have been added here to maintain consistency.
+        		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
+         */
+        searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter
       };
       try {
         var _await$onEmpty;
@@ -154,6 +174,25 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
             }
           }
         }
+        if (displayEmailInByline) {
+          for (let option of recommendedUsers) {
+            if (isUser(option) || isExternalUser(option)) {
+              if (option.userType === UserEntityType.DEFAULT || option.userType === UserEntityType.CUSTOMER) {
+                // Respect existing byline if present
+                if (option.email && !option.byline) {
+                  option.byline = option.email;
+                }
+              }
+            }
+          }
+        }
+
+        // Track if email search found matches for conditional allowEmail logic
+        if (isEmail) {
+          this.lastEmailSearchFoundMatches = recommendedUsers.length > 0;
+        } else {
+          this.lastEmailSearchFoundMatches = false;
+        }
         const elapsedTimeMilli = window.performance.now() - startTime;
         const transformedOptions = transformOptions ? await transformOptions(recommendedUsers, query) : recommendedUsers;
         const displayedUsers = transformedOptions.length === 0 && onEmpty ? (_await$onEmpty = await onEmpty(query)) !== null && _await$onEmpty !== void 0 ? _await$onEmpty : [] : transformedOptions;
@@ -266,7 +305,6 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
     });
     _defineProperty(this, "onFocus", sessionId => {
       const state = {
-        query: '',
         closed: false
       };
       this.startOptionsShownUfoExperience();
@@ -348,7 +386,22 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
     }
   }
   render() {
-    return /*#__PURE__*/React.createElement(MessagesIntlProvider, null, /*#__PURE__*/React.createElement(UserPicker, _extends({}, this.props, {
+    const {
+      allowEmail,
+      enableEmailSearch,
+      allowEmailSelectionWhenEmailMatched,
+      ...restProps
+    } = this.props;
+
+    // Determine whether to allow email selection based on allowEmailSelectionWhenEmailMatched, if needed
+    let shouldAllowEmail = allowEmail;
+    if (allowEmail && enableEmailSearch && !allowEmailSelectionWhenEmailMatched) {
+      // Only allow email selection if we're in an email search that found no matches
+      const isCurrentQueryEmail = isEmailQuery(this.state.query);
+      shouldAllowEmail = !isCurrentQueryEmail || !this.lastEmailSearchFoundMatches;
+    }
+    return /*#__PURE__*/React.createElement(MessagesIntlProvider, null, /*#__PURE__*/React.createElement(UserPicker, _extends({}, restProps, {
+      allowEmail: shouldAllowEmail,
       onInputChange: this.onInputChange,
       onBlur: this.onBlur,
       onFocus: this.onFocus,
@@ -366,9 +419,12 @@ _defineProperty(SmartUserPickerWithoutAnalytics, "defaultProps", {
   includeGroups: false,
   includeTeams: false,
   includeNonLicensedUsers: false,
+  displayEmailInByline: false,
   prefetch: false,
   principalId: 'Context',
   debounceTime: DEFAULT_DEBOUNCE_TIME_MS,
-  userResolvers: []
+  userResolvers: [],
+  enableEmailSearch: false,
+  allowEmailSelectionWhenEmailMatched: true
 });
 export const SmartUserPicker = withAnalyticsEvents()(injectIntl(SmartUserPickerWithoutAnalytics));

package/dist/es2019/service/recommendation-client.js

@@ -25,7 +25,7 @@ const getUserRecommendations = (request, intl) => {
         ...(((_request$context = request.context) === null || _request$context === void 0 ? void 0 : (_request$context$prod = _request$context.productAttributes) === null || _request$context$prod === void 0 ? void 0 : _request$context$prod.isEntitledConfluenceExternalCollaborator) && {
           productAccessPermissionIds: ['write', 'external-collaborator-write']
         }),
-        customQuery: '',
+        customQuery: request.customQuery || '',
         customerDirectoryId: '',
         filter: request.searchQueryFilter || '',
         minimumAccessLevel: 'APPLICATION',

package/dist/es2019/service/users-transformer.js

@@ -24,6 +24,7 @@ const transformUser = (item, intl) => {
     return {
       id: user.id,
       type: user.nonLicensedUser ? ExternalUserType : UserType,
+      userType: user.userType,
       avatarUrl: user.avatarUrl,
       name: user.name,
       email: user.email,

package/dist/es2019/types.js

@@ -4,5 +4,12 @@ export let EntityType = /*#__PURE__*/function (EntityType) {
   EntityType["GROUP"] = "GROUP";
   return EntityType;
 }({});
+export let UserEntityType = /*#__PURE__*/function (UserEntityType) {
+  UserEntityType["DEFAULT"] = "DEFAULT";
+  UserEntityType["APP"] = "APP";
+  UserEntityType["CUSTOMER"] = "CUSTOMER";
+  UserEntityType["SYSTEM"] = "SYSTEM";
+  return UserEntityType;
+}({});
 
 // Override UserPickerProps below with replacement documentation

package/dist/esm/analytics.js

@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { createAndFireEvent } from '@atlaskit/analytics-next';
 import { v4 as uuid } from 'uuid';
 var packageName = "@atlaskit/smart-user-picker";
-var packageVersion = "0.0.0-development";
+var packageVersion = "8.3.0";
 export var startSession = function startSession() {
   return {
     id: uuid(),

package/dist/esm/components/SmartUserPicker.js

@@ -1,4 +1,5 @@
 import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _toArray from "@babel/runtime/helpers/toArray";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
@@ -8,6 +9,7 @@ import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstruct
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var _excluded = ["allowEmail", "enableEmailSearch", "allowEmailSelectionWhenEmailMatched"];
 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; }
@@ -23,10 +25,11 @@ import { withAnalyticsEvents } from '@atlaskit/analytics-next';
 import memoizeOne from 'memoize-one';
 import { injectIntl } from 'react-intl-next';
 import { UFOExperienceState } from '@atlaskit/ufo';
-import UserPicker, { isExternalUser, isTeam, isUser } from '@atlaskit/user-picker';
+import UserPicker, { isExternalUser, isTeam, isUser, isValidEmail } from '@atlaskit/user-picker';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { requestUsersEvent, filterUsersEvent, preparedUsersLoadedEvent, successfulRequestUsersEvent, failedRequestUsersEvent, mountedWithPrefetchEvent, createAndFireEventInElementsChannel, failedUserResolversEvent } from '../analytics';
 import MessagesIntlProvider from './MessagesIntlProvider';
+import { UserEntityType } from '../types';
 import { getUserRecommendations, hydrateDefaultValues } from '../service';
 import { smartUserPickerOptionsShownUfoExperience } from '../ufoExperiences';
 var DEFAULT_DEBOUNCE_TIME_MS = 150;
@@ -62,6 +65,9 @@ var getUsersForAnalytics = function getUsersForAnalytics(users) {
 var checkIf500Event = function checkIf500Event(statusCode) {
   return 500 <= statusCode && statusCode < 600;
 };
+var isEmailQuery = function isEmailQuery(query) {
+  return isValidEmail(query.trim()) === 'VALID';
+};
 export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Component) {
   function SmartUserPickerWithoutAnalytics(props) {
     var _this$props$debounceT;
@@ -76,6 +82,8 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
       defaultValue: [],
       bootstrapOptions: []
     });
+    // Track if the last search was an email search that found matches
+    _defineProperty(_this, "lastEmailSearchFoundMatches", false);
     _defineProperty(_this, "abortOptionsShownUfoExperience", function () {
       if (_this.optionsShownUfoExperienceInstance.state.id === UFOExperienceState.STARTED.id) {
         // There may be an existing UFO timing running from previous key entry or focus,
@@ -101,14 +109,15 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
     });
     _defineProperty(_this, "memoizedFilterOptions", memoizeOne(_this.filterOptions));
     _defineProperty(_this, "getUsers", debounce( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-      var _this$state, query, sessionId, closed, _this$props, baseUrl, childObjectId, containerId, fieldId, includeGroups, includeTeams, includeUsers, includeNonLicensedUsers, intl, maxOptions, objectId, onEmpty, onError, overrideByline, orgId, principalId, productAttributes, productKey, searchQueryFilter, siteId, transformOptions, userResolvers, maxNumberOfResults, startTime, recommendationsRequest, _yield$onEmpty, _query, recommendedUsers, userRecommendationsPromise, userResolversPromises, _yield$Promise$all, _yield$Promise$all2, mainRecommendations, userResolverResults, _iterator, _step, option, elapsedTimeMilli, transformedOptions, displayedUsers, is5xxEvent, onErrorProducedError, defaultUsers, _elapsedTimeMilli;
+      var _this$state, query, sessionId, closed, _this$props, baseUrl, childObjectId, containerId, fieldId, includeGroups, includeTeams, includeUsers, includeNonLicensedUsers, intl, maxOptions, objectId, onEmpty, onError, overrideByline, displayEmailInByline, orgId, principalId, productAttributes, productKey, searchQueryFilter, siteId, transformOptions, userResolvers, enableEmailSearch, maxNumberOfResults, startTime, isEmail, recommendationsRequest, _yield$onEmpty, _query, recommendedUsers, userRecommendationsPromise, userResolversPromises, _yield$Promise$all, _yield$Promise$all2, mainRecommendations, userResolverResults, _iterator, _step, option, _iterator2, _step2, _option, elapsedTimeMilli, transformedOptions, displayedUsers, is5xxEvent, onErrorProducedError, defaultUsers, _elapsedTimeMilli;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _this$state = _this.state, query = _this$state.query, sessionId = _this$state.sessionId, closed = _this$state.closed;
-            _this$props = _this.props, baseUrl = _this$props.baseUrl, childObjectId = _this$props.childObjectId, containerId = _this$props.containerId, fieldId = _this$props.fieldId, includeGroups = _this$props.includeGroups, includeTeams = _this$props.includeTeams, includeUsers = _this$props.includeUsers, includeNonLicensedUsers = _this$props.includeNonLicensedUsers, intl = _this$props.intl, maxOptions = _this$props.maxOptions, objectId = _this$props.objectId, onEmpty = _this$props.onEmpty, onError = _this$props.onError, overrideByline = _this$props.overrideByline, orgId = _this$props.orgId, principalId = _this$props.principalId, productAttributes = _this$props.productAttributes, productKey = _this$props.productKey, searchQueryFilter = _this$props.searchQueryFilter, siteId = _this$props.siteId, transformOptions = _this$props.transformOptions, userResolvers = _this$props.userResolvers;
+            _this$props = _this.props, baseUrl = _this$props.baseUrl, childObjectId = _this$props.childObjectId, containerId = _this$props.containerId, fieldId = _this$props.fieldId, includeGroups = _this$props.includeGroups, includeTeams = _this$props.includeTeams, includeUsers = _this$props.includeUsers, includeNonLicensedUsers = _this$props.includeNonLicensedUsers, intl = _this$props.intl, maxOptions = _this$props.maxOptions, objectId = _this$props.objectId, onEmpty = _this$props.onEmpty, onError = _this$props.onError, overrideByline = _this$props.overrideByline, displayEmailInByline = _this$props.displayEmailInByline, orgId = _this$props.orgId, principalId = _this$props.principalId, productAttributes = _this$props.productAttributes, productKey = _this$props.productKey, searchQueryFilter = _this$props.searchQueryFilter, siteId = _this$props.siteId, transformOptions = _this$props.transformOptions, userResolvers = _this$props.userResolvers, enableEmailSearch = _this$props.enableEmailSearch;
             maxNumberOfResults = maxOptions || 100;
-            startTime = window.performance.now();
+            startTime = window.performance.now(); // Check if this is an email search
+            isEmail = enableEmailSearch && isEmailQuery(query);
             recommendationsRequest = {
               baseUrl: baseUrl,
               context: {
@@ -124,18 +133,27 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
                 productAttributes: productAttributes
               },
               includeUsers: includeUsers,
-              includeGroups: includeGroups,
-              includeTeams: includeTeams,
+              // For email searches, disable groups and teams
+              includeGroups: isEmail ? false : includeGroups,
+              includeTeams: isEmail ? false : includeTeams,
               includeNonLicensedUsers: includeNonLicensedUsers,
               maxNumberOfResults: maxNumberOfResults,
-              query: query,
-              searchQueryFilter: searchQueryFilter
+              // For email searches, leverage customQuery instead of queryString
+              query: isEmail ? '' : query,
+              customQuery: isEmail ? "(email:\"".concat(query.trim(), "\")") : '',
+              /*
+              	For email-based searches, we have decided to filter out apps.
+              	Also - because the other 2 filters ((NOT not_mentionable:true) AND (account_status:active)) are included
+              	when filter is empty, they have been added here to maintain consistency.
+              		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
+               */
+              searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter
             };
-            _context.prev = 5;
+            _context.prev = 6;
             _query = _this.state.query;
             _this.fireEvent(requestUsersEvent);
             if (!fg('twcg-444-invite-usd-improvements-m2-gate')) {
-              _context.next = 20;
+              _context.next = 21;
               break;
             }
             userRecommendationsPromise = getUserRecommendations(recommendationsRequest, intl);
@@ -148,22 +166,22 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
                 return [];
               });
             });
-            _context.next = 13;
+            _context.next = 14;
             return Promise.all([userRecommendationsPromise].concat(_toConsumableArray(userResolversPromises)));
-          case 13:
+          case 14:
             _yield$Promise$all = _context.sent;
             _yield$Promise$all2 = _toArray(_yield$Promise$all);
             mainRecommendations = _yield$Promise$all2[0];
             userResolverResults = _yield$Promise$all2.slice(1);
             recommendedUsers = [mainRecommendations].concat(_toConsumableArray(userResolverResults)).flat();
-            _context.next = 23;
+            _context.next = 24;
             break;
-          case 20:
-            _context.next = 22;
+          case 21:
+            _context.next = 23;
             return getUserRecommendations(recommendationsRequest, intl);
-          case 22:
-            recommendedUsers = _context.sent;
           case 23:
+            recommendedUsers = _context.sent;
+          case 24:
             if (overrideByline) {
               _iterator = _createForOfIteratorHelper(recommendedUsers);
               try {
@@ -179,52 +197,79 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
                 _iterator.f();
               }
             }
+            if (displayEmailInByline) {
+              _iterator2 = _createForOfIteratorHelper(recommendedUsers);
+              try {
+                for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                  _option = _step2.value;
+                  if (isUser(_option) || isExternalUser(_option)) {
+                    if (_option.userType === UserEntityType.DEFAULT || _option.userType === UserEntityType.CUSTOMER) {
+                      // Respect existing byline if present
+                      if (_option.email && !_option.byline) {
+                        _option.byline = _option.email;
+                      }
+                    }
+                  }
+                }
+              } catch (err) {
+                _iterator2.e(err);
+              } finally {
+                _iterator2.f();
+              }
+            }
+
+            // Track if email search found matches for conditional allowEmail logic
+            if (isEmail) {
+              _this.lastEmailSearchFoundMatches = recommendedUsers.length > 0;
+            } else {
+              _this.lastEmailSearchFoundMatches = false;
+            }
             elapsedTimeMilli = window.performance.now() - startTime;
             if (!transformOptions) {
-              _context.next = 31;
+              _context.next = 34;
               break;
             }
-            _context.next = 28;
+            _context.next = 31;
             return transformOptions(recommendedUsers, _query);
-          case 28:
+          case 31:
             _context.t0 = _context.sent;
-            _context.next = 32;
+            _context.next = 35;
             break;
-          case 31:
+          case 34:
             _context.t0 = recommendedUsers;
-          case 32:
+          case 35:
             transformedOptions = _context.t0;
             if (!(transformedOptions.length === 0 && onEmpty)) {
-              _context.next = 48;
+              _context.next = 51;
               break;
             }
-            _context.next = 36;
+            _context.next = 39;
             return onEmpty(_query);
-          case 36:
+          case 39:
             _context.t3 = _yield$onEmpty = _context.sent;
             _context.t2 = _context.t3 !== null;
             if (!_context.t2) {
-              _context.next = 40;
+              _context.next = 43;
               break;
             }
             _context.t2 = _yield$onEmpty !== void 0;
-          case 40:
+          case 43:
             if (!_context.t2) {
-              _context.next = 44;
+              _context.next = 47;
               break;
             }
             _context.t4 = _yield$onEmpty;
-            _context.next = 45;
+            _context.next = 48;
             break;
-          case 44:
+          case 47:
             _context.t4 = [];
-          case 45:
+          case 48:
             _context.t1 = _context.t4;
-            _context.next = 49;
+            _context.next = 52;
             break;
-          case 48:
+          case 51:
             _context.t1 = transformedOptions;
-          case 49:
+          case 52:
             displayedUsers = _context.t1;
             _this.setState(function (state) {
               var applicable = state.query === _query;
@@ -246,11 +291,11 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
                 loading: loading
               };
             });
-            _context.next = 82;
+            _context.next = 85;
             break;
-          case 53:
-            _context.prev = 53;
-            _context.t5 = _context["catch"](5);
+          case 56:
+            _context.prev = 56;
+            _context.t5 = _context["catch"](6);
             is5xxEvent = checkIf500Event(_context.t5.statusCode);
             if (!closed && !onError && is5xxEvent) {
               // If the user lookup fails while the menu is open, and the consumer is not providing a
@@ -262,35 +307,35 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
             });
             onErrorProducedError = false;
             defaultUsers = [];
-            _context.prev = 60;
+            _context.prev = 63;
             if (!onError) {
-              _context.next = 70;
+              _context.next = 73;
               break;
             }
-            _context.next = 64;
+            _context.next = 67;
             return onError(_context.t5, recommendationsRequest);
-          case 64:
+          case 67:
             _context.t7 = _context.sent;
             if (_context.t7) {
-              _context.next = 67;
+              _context.next = 70;
               break;
             }
             _context.t7 = [];
-          case 67:
+          case 70:
             _context.t6 = _context.t7;
-            _context.next = 71;
+            _context.next = 74;
             break;
-          case 70:
+          case 73:
             _context.t6 = [];
-          case 71:
+          case 74:
             defaultUsers = _context.t6;
-            _context.next = 77;
+            _context.next = 80;
             break;
-          case 74:
-            _context.prev = 74;
-            _context.t8 = _context["catch"](60);
-            onErrorProducedError = true;
           case 77:
+            _context.prev = 77;
+            _context.t8 = _context["catch"](63);
+            onErrorProducedError = true;
+          case 80:
             if (onErrorProducedError && is5xxEvent) {
               // Log error from fallback data source `onError` to UFO
               _this.optionsShownUfoExperienceInstance.failure(ufoEndStateConfig(_this.props.fieldId));
@@ -307,11 +352,11 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
               elapsedTimeMilli: _elapsedTimeMilli,
               productAttributes: productAttributes
             });
-          case 82:
+          case 85:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[5, 53], [60, 74]]);
+      }, _callee, null, [[6, 56], [63, 77]]);
     })), (_this$props$debounceT = _this.props.debounceTime) !== null && _this$props$debounceT !== void 0 ? _this$props$debounceT : 0));
     _defineProperty(_this, "onInputChange", function (newQuery, sessionId) {
       var query = newQuery || '';
@@ -367,7 +412,6 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
     });
     _defineProperty(_this, "onFocus", function (sessionId) {
       var state = {
-        query: '',
         closed: false
       };
       _this.startOptionsShownUfoExperience();
@@ -479,7 +523,21 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
   }, {
     key: "render",
     value: function render() {
-      return /*#__PURE__*/React.createElement(MessagesIntlProvider, null, /*#__PURE__*/React.createElement(UserPicker, _extends({}, this.props, {
+      var _this$props2 = this.props,
+        allowEmail = _this$props2.allowEmail,
+        enableEmailSearch = _this$props2.enableEmailSearch,
+        allowEmailSelectionWhenEmailMatched = _this$props2.allowEmailSelectionWhenEmailMatched,
+        restProps = _objectWithoutProperties(_this$props2, _excluded);
+
+      // Determine whether to allow email selection based on allowEmailSelectionWhenEmailMatched, if needed
+      var shouldAllowEmail = allowEmail;
+      if (allowEmail && enableEmailSearch && !allowEmailSelectionWhenEmailMatched) {
+        // Only allow email selection if we're in an email search that found no matches
+        var isCurrentQueryEmail = isEmailQuery(this.state.query);
+        shouldAllowEmail = !isCurrentQueryEmail || !this.lastEmailSearchFoundMatches;
+      }
+      return /*#__PURE__*/React.createElement(MessagesIntlProvider, null, /*#__PURE__*/React.createElement(UserPicker, _extends({}, restProps, {
+        allowEmail: shouldAllowEmail,
         onInputChange: this.onInputChange,
         onBlur: this.onBlur,
         onFocus: this.onFocus,
@@ -498,9 +556,12 @@ _defineProperty(SmartUserPickerWithoutAnalytics, "defaultProps", {
   includeGroups: false,
   includeTeams: false,
   includeNonLicensedUsers: false,
+  displayEmailInByline: false,
   prefetch: false,
   principalId: 'Context',
   debounceTime: DEFAULT_DEBOUNCE_TIME_MS,
-  userResolvers: []
+  userResolvers: [],
+  enableEmailSearch: false,
+  allowEmailSelectionWhenEmailMatched: true
 });
 export var SmartUserPicker = withAnalyticsEvents()(injectIntl(SmartUserPickerWithoutAnalytics));

package/dist/esm/service/recommendation-client.js

@@ -28,7 +28,7 @@ var getUserRecommendations = function getUserRecommendations(request, intl) {
       }, ((_request$context = request.context) === null || _request$context === void 0 || (_request$context = _request$context.productAttributes) === null || _request$context === void 0 ? void 0 : _request$context.isEntitledConfluenceExternalCollaborator) && {
         productAccessPermissionIds: ['write', 'external-collaborator-write']
       }), {}, {
-        customQuery: '',
+        customQuery: request.customQuery || '',
         customerDirectoryId: '',
         filter: request.searchQueryFilter || '',
         minimumAccessLevel: 'APPLICATION',

package/dist/esm/service/users-transformer.js

@@ -24,6 +24,7 @@ var transformUser = function transformUser(item, intl) {
     return {
       id: user.id,
       type: user.nonLicensedUser ? ExternalUserType : UserType,
+      userType: user.userType,
       avatarUrl: user.avatarUrl,
       name: user.name,
       email: user.email,

package/dist/esm/types.js

@@ -4,5 +4,12 @@ export var EntityType = /*#__PURE__*/function (EntityType) {
   EntityType["GROUP"] = "GROUP";
   return EntityType;
 }({});
+export var UserEntityType = /*#__PURE__*/function (UserEntityType) {
+  UserEntityType["DEFAULT"] = "DEFAULT";
+  UserEntityType["APP"] = "APP";
+  UserEntityType["CUSTOMER"] = "CUSTOMER";
+  UserEntityType["SYSTEM"] = "SYSTEM";
+  return UserEntityType;
+}({});
 
 // Override UserPickerProps below with replacement documentation

package/dist/types/components/SmartUserPicker.d.ts

@@ -5,6 +5,7 @@ import { type OptionData } from '@atlaskit/user-picker';
 import { type Props, type State, type FilterOptions } from '../types';
 export declare class SmartUserPickerWithoutAnalytics extends React.Component<Props & WrappedComponentProps, State> {
     state: State;
+    private lastEmailSearchFoundMatches;
     optionsShownUfoExperienceInstance: UFOExperience;
     static defaultProps: {
         baseUrl: string;
@@ -12,10 +13,13 @@ export declare class SmartUserPickerWithoutAnalytics extends React.Component<Pro
         includeGroups: boolean;
         includeTeams: boolean;
         includeNonLicensedUsers: boolean;
+        displayEmailInByline: boolean;
         prefetch: boolean;
         principalId: string;
         debounceTime: number;
         userResolvers: never[];
+        enableEmailSearch: boolean;
+        allowEmailSelectionWhenEmailMatched: boolean;
     };
     constructor(props: Props & WrappedComponentProps);
     componentDidMount(): Promise<void>;

package/dist/types/types.d.ts

@@ -17,6 +17,7 @@ export interface RecommendationRequest {
     context: Context;
     maxNumberOfResults: number;
     query?: string;
+    customQuery?: string;
     searchQueryFilter?: string;
     includeUsers?: boolean;
     includeGroups?: boolean;
@@ -63,10 +64,18 @@ export declare enum EntityType {
     TEAM = "TEAM",
     GROUP = "GROUP"
 }
+export declare enum UserEntityType {
+    DEFAULT = "DEFAULT",
+    APP = "APP",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
 export interface RecommendationItem {
     id: string;
     name?: string;
+    email?: string;
     entityType: EntityType;
+    userType?: UserEntityType;
     avatarUrl: string;
     description?: string;
     teamAri?: string;
@@ -153,6 +162,13 @@ export interface SmartProps {
      * provided as an argument to the function.
      */
     overrideByline?: OverrideByline;
+    /**
+     * When enabled, displays email addresses for users in the byline of each option, if available.
+     * Note - overrideByline will take precedent over displayEmailInByline.
+     * Note - only certain user types will have their email displayed.
+     * @default false
+     */
+    displayEmailInByline?: boolean;
     /**
      * Prefetch the list of suggested assignees before the user picker is focused.
      * WARNING: please consider carefully before deciding to prefetch your suggestions
@@ -177,6 +193,19 @@ export interface SmartProps {
      * If you are still waiting for CPUS, you can use the `people` productKey in the interim.
      */
     productKey: string;
+    /**
+     * When enabled, allows searching for users by email address.
+     * Email searches will use customQuery instead of queryString and will set includeGroups and includeTeams to false.
+     * @default false
+     */
+    enableEmailSearch?: boolean;
+    /**
+     * When both allowEmail and enableEmailSearch are true, this controls whether both email entry
+     * and matched user entries can be selected simultaneously.
+     * If false, only allows email selection when no users are found.
+     * @default true
+     */
+    allowEmailSelectionWhenEmailMatched?: boolean;
     /**
      * Filter to be applied to the eventual query to CPUS for user suggestions.
      * Example:`account_status:"active" AND (NOT email_domain:"connect.atlassian.com")`

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

@@ -5,6 +5,7 @@ import { type OptionData } from '@atlaskit/user-picker';
 import { type Props, type State, type FilterOptions } from '../types';
 export declare class SmartUserPickerWithoutAnalytics extends React.Component<Props & WrappedComponentProps, State> {
     state: State;
+    private lastEmailSearchFoundMatches;
     optionsShownUfoExperienceInstance: UFOExperience;
     static defaultProps: {
         baseUrl: string;
@@ -12,10 +13,13 @@ export declare class SmartUserPickerWithoutAnalytics extends React.Component<Pro
         includeGroups: boolean;
         includeTeams: boolean;
         includeNonLicensedUsers: boolean;
+        displayEmailInByline: boolean;
         prefetch: boolean;
         principalId: string;
         debounceTime: number;
         userResolvers: never[];
+        enableEmailSearch: boolean;
+        allowEmailSelectionWhenEmailMatched: boolean;
     };
     constructor(props: Props & WrappedComponentProps);
     componentDidMount(): Promise<void>;

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

@@ -17,6 +17,7 @@ export interface RecommendationRequest {
     context: Context;
     maxNumberOfResults: number;
     query?: string;
+    customQuery?: string;
     searchQueryFilter?: string;
     includeUsers?: boolean;
     includeGroups?: boolean;
@@ -63,10 +64,18 @@ export declare enum EntityType {
     TEAM = "TEAM",
     GROUP = "GROUP"
 }
+export declare enum UserEntityType {
+    DEFAULT = "DEFAULT",
+    APP = "APP",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
 export interface RecommendationItem {
     id: string;
     name?: string;
+    email?: string;
     entityType: EntityType;
+    userType?: UserEntityType;
     avatarUrl: string;
     description?: string;
     teamAri?: string;
@@ -153,6 +162,13 @@ export interface SmartProps {
      * provided as an argument to the function.
      */
     overrideByline?: OverrideByline;
+    /**
+     * When enabled, displays email addresses for users in the byline of each option, if available.
+     * Note - overrideByline will take precedent over displayEmailInByline.
+     * Note - only certain user types will have their email displayed.
+     * @default false
+     */
+    displayEmailInByline?: boolean;
     /**
      * Prefetch the list of suggested assignees before the user picker is focused.
      * WARNING: please consider carefully before deciding to prefetch your suggestions
@@ -177,6 +193,19 @@ export interface SmartProps {
      * If you are still waiting for CPUS, you can use the `people` productKey in the interim.
      */
     productKey: string;
+    /**
+     * When enabled, allows searching for users by email address.
+     * Email searches will use customQuery instead of queryString and will set includeGroups and includeTeams to false.
+     * @default false
+     */
+    enableEmailSearch?: boolean;
+    /**
+     * When both allowEmail and enableEmailSearch are true, this controls whether both email entry
+     * and matched user entries can be selected simultaneously.
+     * If false, only allows email selection when no users are found.
+     * @default true
+     */
+    allowEmailSelectionWhenEmailMatched?: boolean;
     /**
      * Filter to be applied to the eventual query to CPUS for user suggestions.
      * Example:`account_status:"active" AND (NOT email_domain:"connect.atlassian.com")`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-user-picker",
-	"version": "8.2.1",
+	"version": "8.3.1",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -38,7 +38,7 @@
 		"@atlaskit/analytics-next": "^11.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/ufo": "^0.4.0",
-		"@atlaskit/user-picker": "^11.6.0",
+		"@atlaskit/user-picker": "^11.7.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21",
 		"memoize-one": "^6.0.0",
@@ -51,7 +51,7 @@
 	},
 	"devDependencies": {
 		"@atlaskit/select": "^21.3.0",
-		"@atlaskit/util-data-test": "^18.2.0",
+		"@atlaskit/util-data-test": "^18.3.0",
 		"@testing-library/dom": "^10.1.0",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",