@atlaskit/user-picker 8.8.4 → 9.0.0

package/dist/esm/components/smart-user-picker/service/UsersClient.js

@@ -1,79 +0,0 @@
-import { getConfig } from '../config';
-import { UserType } from '../../../types';
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-
-var getUsersById = function getUsersById(request) {
-  var url = "".concat(getConfig().getUsersServiceUrl(request.productKey, request.baseUrl));
-  var params = new URLSearchParams();
-  request.accountIds.map(function (id) {
-    return params.append('accountId', id);
-  });
-  params.append('maxResults', '2000');
-  return fetch("".concat(url, "?").concat(params), {
-    method: 'GET',
-    credentials: 'include',
-    headers: {
-      'content-type': 'application/json'
-    }
-  }).then(function (response) {
-    if (response.status === 200) {
-      return response.json();
-    }
-
-    return Promise.reject({
-      message: "error calling users service, statusCode=".concat(response.status, ", statusText=").concat(response.statusText)
-    });
-  }).then(request.productKey === 'jira' ? transformJiraUsers : transformConfluenceUsers);
-};
-
-var transformJiraUsers = function transformJiraUsers(userResponse) {
-  return userResponse.values.map(transformJiraUser).filter(function (user) {
-    return !!user;
-  }).map(function (user) {
-    return user;
-  });
-};
-
-var transformJiraUser = function transformJiraUser(item) {
-  if (!item) {
-    return null;
-  }
-
-  return {
-    id: item.accountId,
-    type: UserType,
-    avatarUrl: item.avatarUrls ? item.avatarUrls['16x16'] : '',
-    name: item.displayName,
-    email: item.emailAddress
-  };
-};
-
-var transformConfluenceUsers = function transformConfluenceUsers(userResponse) {
-  return userResponse.results.map(transformConfluenceUser).filter(function (user) {
-    return !!user;
-  }).map(function (user) {
-    return user;
-  });
-};
-
-var transformConfluenceUser = function transformConfluenceUser(item) {
-  if (!item) {
-    return null;
-  }
-
-  return {
-    id: item.accountId,
-    type: UserType,
-    avatarUrl: item.profilePicture ? item.profilePicture.path : '',
-    name: item.publicName,
-    email: item.email
-  };
-};
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-
-
-export default getUsersById;

package/dist/esm/components/smart-user-picker/service/index.js

@@ -1 +0,0 @@
-export { default as getUserRecommendations } from './recommendationClient';

package/dist/esm/components/smart-user-picker/service/recommendationClient.js

@@ -1,64 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-import { transformUsers } from './users-transformer';
-import { getConfig } from '../config';
-
-var getUserRecommendations = function getUserRecommendations(request, intl) {
-  var _request$context, _request$context$prod;
-
-  var url = getConfig().getRecommendationServiceUrl(request.baseUrl || '');
-  return fetch(url, {
-    method: 'POST',
-    credentials: 'include',
-    headers: {
-      'content-type': 'application/json'
-    },
-    body: JSON.stringify({
-      context: request.context,
-      includeUsers: request.includeUsers,
-      includeGroups: request.includeGroups,
-      includeTeams: request.includeTeams,
-      maxNumberOfResults: request.maxNumberOfResults,
-      performSearchQueryOnly: false,
-      searchQuery: _objectSpread(_objectSpread({
-        cpusQueryHighlights: {
-          query: '',
-          field: ''
-        }
-      }, ((_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: '',
-        customerDirectoryId: '',
-        filter: request.searchQueryFilter || '',
-        minimumAccessLevel: 'APPLICATION',
-        queryString: request.query,
-        restrictTo: {
-          userIds: [],
-          groupIds: []
-        },
-        searchUserbase: false
-      })
-    })
-  }).then(function (response) {
-    if (response.status === 200) {
-      return response.json();
-    }
-
-    return Promise.reject({
-      message: "error calling smart service, statusCode=".concat(response.status, ", statusText=").concat(response.statusText)
-    });
-  }).then(function (response) {
-    return transformUsers(response, intl);
-  });
-};
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-
-
-export default getUserRecommendations;

package/dist/esm/components/smart-user-picker/service/users-transformer.js

@@ -1,87 +0,0 @@
-import { TeamType, UserType, GroupType } from '../../../types';
-import { messages } from '../../i18n';
-var EntityType;
-
-(function (EntityType) {
-  EntityType["USER"] = "USER";
-  EntityType["TEAM"] = "TEAM";
-  EntityType["GROUP"] = "GROUP";
-})(EntityType || (EntityType = {}));
-
-var getLozenzeProperties = function getLozenzeProperties(entity, intl) {
-  var _entity$attributes, _entity$attributes2;
-
-  if ((_entity$attributes = entity.attributes) !== null && _entity$attributes !== void 0 && _entity$attributes.workspaceMember) {
-    return intl.formatMessage(messages.memberLozengeText);
-  }
-
-  if ((_entity$attributes2 = entity.attributes) !== null && _entity$attributes2 !== void 0 && _entity$attributes2.isConfluenceExternalCollaborator) {
-    var lozengeTooltipMessage = entity.entityType === EntityType.GROUP ? messages.guestGroupLozengeTooltip : messages.guestUserLozengeTooltip;
-    return {
-      text: intl.formatMessage(messages.guestLozengeText),
-      tooltip: intl.formatMessage(lozengeTooltipMessage),
-      appearance: 'new'
-    };
-  }
-
-  return undefined;
-};
-
-var transformUser = function transformUser(item, intl) {
-  var type = item.entityType;
-
-  if (type === EntityType.USER) {
-    var user = item;
-    var lozenge = getLozenzeProperties(user, intl);
-    return {
-      id: user.id,
-      type: UserType,
-      avatarUrl: user.avatarUrl,
-      name: user.name,
-      email: user.email,
-      lozenge: lozenge
-    };
-  }
-
-  if (type === EntityType.TEAM) {
-    var team = item;
-    return {
-      id: team.id,
-      type: TeamType,
-      description: team.description || '',
-      name: team.displayName || '',
-      memberCount: team.memberCount,
-      includesYou: team.includesYou,
-      avatarUrl: team.largeAvatarImageUrl || team.smallAvatarImageUrl
-    };
-  }
-
-  if (type === EntityType.GROUP) {
-    var group = item;
-
-    var _lozenge = getLozenzeProperties(group, intl);
-
-    return {
-      id: group.id,
-      type: GroupType,
-      name: group.name || '',
-      lozenge: _lozenge
-    };
-  }
-
-  return;
-};
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-
-
-export var transformUsers = function transformUsers(serverResponse, intl) {
-  return (serverResponse.recommendedUsers || []).map(function (item) {
-    return transformUser(item, intl);
-  }).filter(function (user) {
-    return !!user;
-  }).map(function (user) {
-    return user;
-  });
-};

package/dist/types/components/smart-user-picker/components/index.d.ts

@@ -1,196 +0,0 @@
-import React from 'react';
-import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { DefaultValue, UserPickerProps, OptionData, OnChange, OnInputChange, User } from '../../../types';
-import { Context } from '../service/recommendationClient';
-declare type OnError = (error: any, request: RecommendationRequest) => Promise<OptionData[]> | void;
-declare type OnValueError = (error: any, defaultValue: DefaultValue) => Promise<OptionData[]> | void;
-declare type OnEmpty = (query: string) => Promise<OptionData[]>;
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare type SupportedProduct = 'jira' | 'confluence' | 'people' | 'bitbucket' | 'compass';
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare type ProductAttributes = BitbucketAttributes | ConfluenceAttributes;
-declare type FilterOptions = (options: OptionData[], query: string) => OptionData[];
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface BitbucketAttributes {
-    /**
-     * Identifies whether this is a public repository or not.
-     */
-    isPublicRepo?: boolean;
-    /**
-     * A list of bitbucket workspace Ids used within container result set and noted in analytics.
-     */
-    workspaceIds?: string[];
-    /**
-     * The users current email domain which may be used to boost the results for relevant users.
-     */
-    emailDomain?: string;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface ConfluenceAttributes {
-    /**
-     * Identifies whether this user is a confluence guest
-     */
-    isEntitledConfluenceExternalCollaborator?: boolean;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface SmartProps {
-    /**
-     * The base URL of the site eg: hello.atlassian.net
-     */
-    baseUrl?: string;
-    /**
-     * Context information for analytics in URS. Eg: if a user picker was put inside a comment, the childObjectId would be the ID of the comment
-     */
-    childObjectId?: string;
-    /**
-     * The container Id to identify context. e.g. projectId/spaceId/repositoryId.
-     */
-    containerId?: string;
-    /**
-     * Whether to include groups in the resultset. @default false
-     */
-    includeGroups?: boolean;
-    /**
-     * Whether to include teams in the resultset. @default false
-     */
-    includeTeams?: boolean;
-    /**
-     * Whether to include users in the resultset. @default true
-     */
-    includeUsers?: boolean;
-    /**
-     * An identifier of the closest context object, e.g. issueId, pageId, pullRequestId
-     */
-    objectId?: string;
-    /**
-     * Id of the user interacting with the component.
-     * If principalId is not provided, server will extract principalId from the context header, assuming that the user is logged in when making the request @default “context”
-     */
-    principalId?: string;
-    /**
-     * Product Attributes - you should pass in the attribute type that matches your current SupportedProduct.
-     * Currently we support additional attributes (BitbucketAttributes) for bitbucket and (ConfluenceAttributes) for Confluence.
-     */
-    productAttributes?: ProductAttributes;
-    /**
-     * Product identifier. Currently supports 'jira' 'confluence' 'people'
-     */
-    productKey: SupportedProduct;
-    /**
-     * Identifier for the product's tenant, also known as tenantId or cloudId
-     */
-    siteId: string;
-    /**
-     * Identifier for the organization in which to search for teams.
-     */
-    orgId?: string;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface Props extends SmartProps, UserPickerProps, WithAnalyticsEventsProps {
-    /**
-     * User options to show when the query is blank. If not provided, smart user picker will still provide a ranked list of suggestions for blank queries.
-     */
-    bootstrapOptions?: OptionData[];
-    /**
-     * Time to debounce the suggestions fetching (in milliseconds)
-     */
-    debounceTime?: number;
-    /**
-     * Identifier for informing the server on where the user picker has been mounted.
-     * Unlike User Picker, the fieldId in Smart User Picker is mandatory.
-     * The server uses the fieldId to determine which model to utilize when
-     * generating suggestions. Supported contexts: "assignee", "mentions".
-     * All other fieldId will be bucketed into a generic model.
-     */
-    fieldId: string;
-    /**
-     * Function to transform options suggested by the server before showing to the user. Can be used to filter out suggestions.
-     * The options that are passed by the filterOptions are the options that are displayed in the list.
-     */
-    filterOptions?: FilterOptions;
-    onChange?: OnChange;
-    /**
-     * Custom handler to give opportunity for caller to return list of options when server returns empty list.
-     * this is called if server returns empty list or all returned list is filtered out by the passed filter {@see filterOptions}.
-     */
-    onEmpty?: OnEmpty;
-    /**
-     * Error handler for when the server fails to suggest users and returns with an error response.
-     * `error`: the error.
-     * `RecommendationRequest`: the original recommendationRequest containing the query and other search parameters.
-     * This may be used to provide a fail over search direct to the product backend.
-     * Helper fail over clients exist under /helpers.
-     * Note that OnError results are not filtered - so you may wish to provide additional `filterOptions`.
-     */
-    onError?: OnError;
-    onInputChange?: OnInputChange;
-    /**
-     * Error handler used to provide OptionData[] values when the server fails to hydrate `defaultValue` prop `OptionIdentifier` types.
-     * error response. */
-    onValueError?: OnValueError;
-    /**
-     * Prefetch the list of suggested assignees before the user picker is focused.
-     * WARNING: please consider carefully before deciding to prefetch your suggestions
-     * as this will increase the load on the recommendations services.
-     * A heads-up on #smrt-experiences for a ballpark on the expected request volume will
-     * be greatly appreciated.
-     */
-    prefetch?: 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")`
-     *  will remove inactive users from the list of suggestions.
-     */
-    searchQueryFilter?: string;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface State {
-    users: OptionData[];
-    loading: boolean;
-    closed: boolean;
-    error: boolean;
-    query: string;
-    sessionId?: string;
-    defaultValue?: OptionData[];
-    bootstrapOptions: OptionData[];
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface RecommendationRequest {
-    baseUrl?: string;
-    context: Context;
-    maxNumberOfResults: number;
-    query?: string;
-    searchQueryFilter?: string;
-    includeUsers?: boolean;
-    includeGroups?: boolean;
-    includeTeams?: boolean;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare function hydrateDefaultValues(value: DefaultValue, productKey: SupportedProduct, baseUrl?: string): Promise<User[]>;
-/**
- * @deprecated
- */
-declare const SmartUserPickerWithIntlProvider: React.FunctionComponent<Props>;
-/**
- * Please use AK/SUP instead
- * @deprecated
- */
-export default SmartUserPickerWithIntlProvider;

package/dist/types/components/smart-user-picker/config/index.d.ts

@@ -1,17 +0,0 @@
-interface Config {
-    getRecommendationServiceUrl(baseUrl: string): string;
-    getUsersServiceUrl(productKey: string, baseUrl?: string): string;
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare const setSmartUserPickerEnv: (newEnv: 'prod' | 'local') => "prod" | "local";
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare const getConfig: () => Config;
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare const JDOG_CLOUD_ID = "49d8b9d6-ee7d-4931-a0ca-7fcae7d1c3b5";
-export {};

package/dist/types/components/smart-user-picker/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * Please use AK/SUP instead
- * @deprecated
- */
-export { default as SmartUserPicker, hydrateDefaultValues } from './components';
-export { getUserRecommendations } from './service';
-export type { SupportedProduct, RecommendationRequest, Props as SmartUserPickerProps, State as SmartUserPickerState, SmartProps, } from './components';
-export { setSmartUserPickerEnv } from './config';

package/dist/types/components/smart-user-picker/service/UsersClient.d.ts

@@ -1,14 +0,0 @@
-import { User } from '../../../types';
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface UsersRequest {
-    accountIds: string[];
-    productKey: 'jira' | 'confluence';
-    baseUrl?: string;
-}
-declare const getUsersById: (request: UsersRequest) => Promise<User[]>;
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export default getUsersById;

package/dist/types/components/smart-user-picker/service/index.d.ts

@@ -1 +0,0 @@
-export { default as getUserRecommendations } from './recommendationClient';

package/dist/types/components/smart-user-picker/service/recommendationClient.d.ts

@@ -1,23 +0,0 @@
-import { OptionData } from '../../../types';
-import { ProductAttributes, RecommendationRequest } from '../components';
-import { IntlShape } from 'react-intl-next';
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export interface Context {
-    containerId?: string;
-    contextType: string;
-    objectId?: string;
-    sessionId?: string;
-    principalId?: string;
-    childObjectId?: string;
-    productKey: 'jira' | 'confluence' | 'people' | 'bitbucket' | 'compass';
-    siteId: string;
-    orgId?: string;
-    productAttributes?: ProductAttributes;
-}
-declare const getUserRecommendations: (request: RecommendationRequest, intl: IntlShape) => Promise<OptionData[]>;
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export default getUserRecommendations;

package/dist/types/components/smart-user-picker/service/users-transformer.d.ts

@@ -1,25 +0,0 @@
-import { OptionData } from '../../../types';
-import { IntlShape } from 'react-intl-next';
-interface ServerItem {
-    id: string;
-    name?: string;
-    entityType: EntityType;
-    avatarUrl: string;
-    description?: string;
-    teamAri?: string;
-    displayName?: string;
-}
-interface ServerResponse {
-    recommendedUsers: ServerItem[];
-    intl: IntlShape;
-}
-declare enum EntityType {
-    USER = "USER",
-    TEAM = "TEAM",
-    GROUP = "GROUP"
-}
-/**
- * @deprecated Please use @atlaskit/smart-user-picker. Alternatively, @atlaskit/smart-hooks will be ready by end of FY22Q4. Contact #help-smart-experiences for further details.
- */
-export declare const transformUsers: (serverResponse: ServerResponse, intl: IntlShape) => OptionData[];
-export {};