@atlaskit/user-picker 8.7.0 → 8.7.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/user-picker
 
+## 8.7.3
+
+### Patch Changes
+
+- [`7f37f923832`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7f37f923832) - updated analytics event for org people picker in core invites
+
+## 8.7.2
+
+### Patch Changes
+
+- [`4d4d565e8ad`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4d4d565e8ad) - Skip sending UFO success if already failed
+
+## 8.7.1
+
+### Patch Changes
+
+- [`dace9a85101`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dace9a85101) - Add new attribute to analytics events
+
 ## 8.7.0
 
 ### Minor Changes

package/dist/cjs/analytics.js

@@ -59,19 +59,21 @@ var checkValidId = function checkValidId(id) {
 
 var optionData2Analytics = function optionData2Analytics(option) {
   var id = option.id,
-      type = option.type;
+      type = option.type; // id's of email types are emails which is PII
+
+  var validatedData = {
+    id: checkValidId(id) ? id : null,
+    type: type || null
+  };
 
   if ((0, _utils.isExternalUser)(option)) {
-    return {
+    return _objectSpread(_objectSpread({}, validatedData), {}, {
       type: 'external_user',
-      sources: option.sources
-    };
+      sources: option.sources,
+      externalUserType: option.externalUserType
+    });
   } else {
-    // id's of email types are emails which is PII
-    return {
-      id: checkValidId(id) ? id : null,
-      type: type || null
-    };
+    return validatedData;
   }
 };
 
@@ -152,12 +154,14 @@ var selectEvent = function selectEvent(props, state, session, journeyId) {
 exports.selectEvent = selectEvent;
 
 var searchedEvent = function searchedEvent(props, state, session, journeyId) {
+  var searchResults = results(state);
   return createEvent('operational', 'searched', 'userPicker', _objectSpread(_objectSpread({}, createDefaultPickerAttributes(props, session, journeyId)), {}, {
     sessionDuration: sessionDuration(session),
     durationSinceInputChange: durationSinceInputChange(session),
     queryLength: queryLength(state),
     isLoading: isLoading(props, state),
-    results: results(state)
+    results: searchResults,
+    numberOfResults: searchResults.length
   }));
 };
 

package/dist/cjs/components/UserPicker.js

@@ -27,6 +27,8 @@ var _analyticsNext = require("@atlaskit/analytics-next");
 
 var _select = _interopRequireWildcard(require("@atlaskit/select"));
 
+var _ufo = require("@atlaskit/ufo");
+
 var _react = _interopRequireDefault(require("react"));
 
 var _BaseUserPicker = require("./BaseUserPicker");
@@ -80,9 +82,12 @@ var UserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Component) {
   (0, _createClass2.default)(UserPickerWithoutAnalytics, [{
     key: "componentDidMount",
     value: function componentDidMount() {
-      var experienceForId = _ufoExperiences.userPickerRenderedUfoExperience.getInstance(this.ufoId);
+      var experienceForId = _ufoExperiences.userPickerRenderedUfoExperience.getInstance(this.ufoId); // Send UFO success if the experience is still in progress i.e. hasn't failed
+
 
-      experienceForId.success();
+      if ([_ufo.UFOExperienceState.IN_PROGRESS.id, _ufo.UFOExperienceState.STARTED.id].includes(experienceForId.state.id)) {
+        experienceForId.success();
+      }
     }
   }, {
     key: "render",

package/dist/cjs/index.js

@@ -63,6 +63,12 @@ Object.defineProperty(exports, "isEmail", {
     return _utils.isEmail;
   }
 });
+Object.defineProperty(exports, "isExternalUser", {
+  enumerable: true,
+  get: function get() {
+    return _utils.isExternalUser;
+  }
+});
 Object.defineProperty(exports, "isTeam", {
   enumerable: true,
   get: function get() {

package/dist/cjs/util/ufoExperiences.js

@@ -47,7 +47,11 @@ var UfoErrorBoundary = /*#__PURE__*/function (_React$Component) {
   (0, _createClass2.default)(UfoErrorBoundary, [{
     key: "componentDidCatch",
     value: function componentDidCatch() {
-      userPickerRenderedUfoExperience.getInstance(this.props.id).failure();
+      var instance = userPickerRenderedUfoExperience.getInstance(this.props.id);
+
+      if (instance.state.id !== _ufo.UFOExperienceState.FAILED.id) {
+        instance.failure();
+      }
     }
   }, {
     key: "render",

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/user-picker",
-	"version": "8.7.0",
+	"version": "8.7.3",
 	"sideEffects": false
 }

package/dist/es2019/analytics.js

@@ -34,19 +34,21 @@ const optionData2Analytics = option => {
   const {
     id,
     type
-  } = option;
+  } = option; // id's of email types are emails which is PII
+
+  const validatedData = {
+    id: checkValidId(id) ? id : null,
+    type: type || null
+  };
 
   if (isExternalUser(option)) {
-    return {
+    return { ...validatedData,
       type: 'external_user',
-      sources: option.sources
+      sources: option.sources,
+      externalUserType: option.externalUserType
     };
   } else {
-    // id's of email types are emails which is PII
-    return {
-      id: checkValidId(id) ? id : null,
-      type: type || null
-    };
+    return validatedData;
   }
 };
 
@@ -100,13 +102,17 @@ export const selectEvent = (props, state, session, journeyId, ...args) => {
     result: result(args[0])
   });
 };
-export const searchedEvent = (props, state, session, journeyId) => createEvent('operational', 'searched', 'userPicker', { ...createDefaultPickerAttributes(props, session, journeyId),
-  sessionDuration: sessionDuration(session),
-  durationSinceInputChange: durationSinceInputChange(session),
-  queryLength: queryLength(state),
-  isLoading: isLoading(props, state),
-  results: results(state)
-});
+export const searchedEvent = (props, state, session, journeyId) => {
+  const searchResults = results(state);
+  return createEvent('operational', 'searched', 'userPicker', { ...createDefaultPickerAttributes(props, session, journeyId),
+    sessionDuration: sessionDuration(session),
+    durationSinceInputChange: durationSinceInputChange(session),
+    queryLength: queryLength(state),
+    isLoading: isLoading(props, state),
+    results: searchResults,
+    numberOfResults: searchResults.length
+  });
+};
 export const failedEvent = (props, _, session, journeyId) => createEvent('operational', 'failed', 'userPicker', { ...createDefaultPickerAttributes(props, session, journeyId)
 });
 

package/dist/es2019/components/UserPicker.js

@@ -2,6 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { withAnalyticsEvents } from '@atlaskit/analytics-next';
 import Select, { CreatableSelect } from '@atlaskit/select';
+import { UFOExperienceState } from '@atlaskit/ufo';
 import React from 'react';
 import { BaseUserPickerWithoutAnalytics } from './BaseUserPicker';
 import { getStyles } from './styles';
@@ -21,8 +22,11 @@ export class UserPickerWithoutAnalytics extends React.Component {
   }
 
   componentDidMount() {
-    const experienceForId = experience.getInstance(this.ufoId);
-    experienceForId.success();
+    const experienceForId = experience.getInstance(this.ufoId); // Send UFO success if the experience is still in progress i.e. hasn't failed
+
+    if ([UFOExperienceState.IN_PROGRESS.id, UFOExperienceState.STARTED.id].includes(experienceForId.state.id)) {
+      experienceForId.success();
+    }
   }
 
   render() {

package/dist/es2019/index.js

@@ -2,6 +2,6 @@ export { isValidEmail } from './components/emailValidation';
 export { UserPicker as default } from './components/UserPicker';
 export { getUserRecommendations, hydrateDefaultValues, SmartUserPicker, setSmartUserPickerEnv } from './components/smart-user-picker/index';
 export { PopupUserPicker } from './components/PopupUserPicker';
-export { isEmail, isTeam, isUser } from './components/utils';
+export { isEmail, isExternalUser, isTeam, isUser } from './components/utils';
 export { // Constants
 EmailType, GroupType, TeamType, UserType } from './types';

package/dist/es2019/util/ufoExperiences.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ExperiencePerformanceTypes, ExperienceTypes, ConcurrentExperience } from '@atlaskit/ufo';
+import { ExperiencePerformanceTypes, ExperienceTypes, ConcurrentExperience, UFOExperienceState } from '@atlaskit/ufo';
 export const userPickerRenderedUfoExperience = new ConcurrentExperience('user-picker-rendered', {
   platform: {
     component: 'user-picker'
@@ -9,7 +9,11 @@ export const userPickerRenderedUfoExperience = new ConcurrentExperience('user-pi
 });
 export class UfoErrorBoundary extends React.Component {
   componentDidCatch() {
-    userPickerRenderedUfoExperience.getInstance(this.props.id).failure();
+    const instance = userPickerRenderedUfoExperience.getInstance(this.props.id);
+
+    if (instance.state.id !== UFOExperienceState.FAILED.id) {
+      instance.failure();
+    }
   }
 
   render() {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/user-picker",
-	"version": "8.7.0",
+	"version": "8.7.3",
 	"sideEffects": false
 }

package/dist/esm/analytics.js

@@ -42,19 +42,21 @@ var checkValidId = function checkValidId(id) {
 
 var optionData2Analytics = function optionData2Analytics(option) {
   var id = option.id,
-      type = option.type;
+      type = option.type; // id's of email types are emails which is PII
+
+  var validatedData = {
+    id: checkValidId(id) ? id : null,
+    type: type || null
+  };
 
   if (isExternalUser(option)) {
-    return {
+    return _objectSpread(_objectSpread({}, validatedData), {}, {
       type: 'external_user',
-      sources: option.sources
-    };
+      sources: option.sources,
+      externalUserType: option.externalUserType
+    });
   } else {
-    // id's of email types are emails which is PII
-    return {
-      id: checkValidId(id) ? id : null,
-      type: type || null
-    };
+    return validatedData;
   }
 };
 
@@ -120,12 +122,14 @@ export var selectEvent = function selectEvent(props, state, session, journeyId)
   }));
 };
 export var searchedEvent = function searchedEvent(props, state, session, journeyId) {
+  var searchResults = results(state);
   return createEvent('operational', 'searched', 'userPicker', _objectSpread(_objectSpread({}, createDefaultPickerAttributes(props, session, journeyId)), {}, {
     sessionDuration: sessionDuration(session),
     durationSinceInputChange: durationSinceInputChange(session),
     queryLength: queryLength(state),
     isLoading: isLoading(props, state),
-    results: results(state)
+    results: searchResults,
+    numberOfResults: searchResults.length
   }));
 };
 export var failedEvent = function failedEvent(props, _, session, journeyId) {

package/dist/esm/components/UserPicker.js

@@ -16,6 +16,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 
 import { withAnalyticsEvents } from '@atlaskit/analytics-next';
 import Select, { CreatableSelect } from '@atlaskit/select';
+import { UFOExperienceState } from '@atlaskit/ufo';
 import React from 'react';
 import { BaseUserPickerWithoutAnalytics } from './BaseUserPicker';
 import { getStyles } from './styles';
@@ -46,8 +47,11 @@ export var UserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Component)
   _createClass(UserPickerWithoutAnalytics, [{
     key: "componentDidMount",
     value: function componentDidMount() {
-      var experienceForId = experience.getInstance(this.ufoId);
-      experienceForId.success();
+      var experienceForId = experience.getInstance(this.ufoId); // Send UFO success if the experience is still in progress i.e. hasn't failed
+
+      if ([UFOExperienceState.IN_PROGRESS.id, UFOExperienceState.STARTED.id].includes(experienceForId.state.id)) {
+        experienceForId.success();
+      }
     }
   }, {
     key: "render",

package/dist/esm/index.js

@@ -2,6 +2,6 @@ export { isValidEmail } from './components/emailValidation';
 export { UserPicker as default } from './components/UserPicker';
 export { getUserRecommendations, hydrateDefaultValues, SmartUserPicker, setSmartUserPickerEnv } from './components/smart-user-picker/index';
 export { PopupUserPicker } from './components/PopupUserPicker';
-export { isEmail, isTeam, isUser } from './components/utils';
+export { isEmail, isExternalUser, isTeam, isUser } from './components/utils';
 export { // Constants
 EmailType, GroupType, TeamType, UserType } from './types';

package/dist/esm/util/ufoExperiences.js

@@ -9,7 +9,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 import React from 'react';
-import { ExperiencePerformanceTypes, ExperienceTypes, ConcurrentExperience } from '@atlaskit/ufo';
+import { ExperiencePerformanceTypes, ExperienceTypes, ConcurrentExperience, UFOExperienceState } from '@atlaskit/ufo';
 export var userPickerRenderedUfoExperience = new ConcurrentExperience('user-picker-rendered', {
   platform: {
     component: 'user-picker'
@@ -31,7 +31,11 @@ export var UfoErrorBoundary = /*#__PURE__*/function (_React$Component) {
   _createClass(UfoErrorBoundary, [{
     key: "componentDidCatch",
     value: function componentDidCatch() {
-      userPickerRenderedUfoExperience.getInstance(this.props.id).failure();
+      var instance = userPickerRenderedUfoExperience.getInstance(this.props.id);
+
+      if (instance.state.id !== UFOExperienceState.FAILED.id) {
+        instance.failure();
+      }
     }
   }, {
     key: "render",

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/user-picker",
-	"version": "8.7.0",
+	"version": "8.7.3",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -4,6 +4,6 @@ export { UserPicker as default } from './components/UserPicker';
 export { getUserRecommendations, hydrateDefaultValues, SmartUserPicker, setSmartUserPickerEnv, } from './components/smart-user-picker/index';
 export type { RecommendationRequest, SmartUserPickerProps, SupportedProduct, } from './components/smart-user-picker/index';
 export { PopupUserPicker } from './components/PopupUserPicker';
-export { isEmail, isTeam, isUser } from './components/utils';
+export { isEmail, isExternalUser, isTeam, isUser } from './components/utils';
 export { EmailType, GroupType, TeamType, UserType, } from './types';
 export type { ActionTypes, Appearance, AtlasKitSelectChange, AtlaskitSelectValue, DefaultValue, InputActionTypes, LozengeProps, OnChange, OnInputChange, OnOption, OnPicker, Option, OptionData, OptionIdentifier, PopupUserPickerProps, Promisable, Target, UserPickerProps, UserPickerState, Value, Email, Group, GroupHighlight, HighlightRange, LoadOptions, Team, TeamHighlight, User, UserHighlight, ExternalUser, UserSource, } from './types';

package/dist/types/types.d.ts

@@ -204,6 +204,7 @@ export interface OptionData {
 export declare const UserType = "user";
 export declare type UserSource = 'google' | 'slack' | 'microsoft' | 'github' | 'jira' | 'confluence' | 'other-atlassian';
 export interface ExternalUser extends User {
+    externalUserType?: 'crossSite' | 'thirdParty';
     requiresSourceHydration?: boolean;
     sources: UserSource[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/user-picker",
-  "version": "8.7.0",
+  "version": "8.7.3",
   "description": "Fabric component for display a dropdown to select a user from",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"