@atlaskit/smart-user-picker 6.1.0 → 6.1.2

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

@@ -0,0 +1,18 @@
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+declare const _default: {
+    'fabric.elements.user-picker.external.sourced.from': string;
+    'fabric.elements.user-picker.github.provider': string;
+    'fabric.elements.user-picker.google.provider': string;
+    'fabric.elements.user-picker.guest.lozenge.text': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.group': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.user': string;
+    'fabric.elements.user-picker.member.lozenge.text': string;
+    'fabric.elements.user-picker.microsoft.provider': string;
+    'fabric.elements.user-picker.slack.provider': string;
+};
+export default _default;

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

@@ -0,0 +1,18 @@
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+declare const _default: {
+    'fabric.elements.user-picker.external.sourced.from': string;
+    'fabric.elements.user-picker.github.provider': string;
+    'fabric.elements.user-picker.google.provider': string;
+    'fabric.elements.user-picker.guest.lozenge.text': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.group': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.user': string;
+    'fabric.elements.user-picker.member.lozenge.text': string;
+    'fabric.elements.user-picker.microsoft.provider': string;
+    'fabric.elements.user-picker.slack.provider': string;
+};
+export default _default;

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

@@ -0,0 +1,18 @@
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+declare const _default: {
+    'fabric.elements.user-picker.external.sourced.from': string;
+    'fabric.elements.user-picker.github.provider': string;
+    'fabric.elements.user-picker.google.provider': string;
+    'fabric.elements.user-picker.guest.lozenge.text': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.group': string;
+    'fabric.elements.user-picker.guest.lozenge.tooltip.user': string;
+    'fabric.elements.user-picker.member.lozenge.text': string;
+    'fabric.elements.user-picker.microsoft.provider': string;
+    'fabric.elements.user-picker.slack.provider': string;
+};
+export default _default;

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

@@ -0,0 +1,47 @@
+export declare const messages: {
+    externalUserSourcesHeading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    slackProvider: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    googleProvider: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    microsoftProvider: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    gitHubProvider: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    memberLozengeText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    guestLozengeText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    guestUserLozengeTooltip: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    guestGroupLozengeTooltip: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

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

@@ -0,0 +1,5 @@
+export { default } from './components';
+export { getUserRecommendations, hydrateDefaultValues } from './service';
+export type { RecommendationRequest, Props, State } from './types';
+export { isEmail, isTeam, isUser, isValidEmail, EmailType, GroupType, TeamType, UserType, } from '@atlaskit/user-picker';
+export type { ActionTypes, Appearance, AtlasKitSelectChange, AtlaskitSelectValue, DefaultValue, EmailValidationResponse, EmailValidator, InputActionTypes, LozengeProps, OnChange, OnInputChange, OnOption, OnPicker, Option, OptionData, OptionIdentifier, PopupUserPickerProps, Promisable, Target, UserPickerProps, UserPickerState, Value, Email, Group, GroupHighlight, HighlightRange, LoadOptions, Team, TeamHighlight, TeamMember, User, UserHighlight, ExternalUser, UserSource, } from '@atlaskit/user-picker';

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

@@ -0,0 +1,4 @@
+import { Team, User } from '@atlaskit/user-picker';
+export declare const UNKNOWN = "Unknown";
+export declare const UNKNOWN_USER: User;
+export declare const UNKNOWN_TEAM: Team;

package/dist/types-ts4.5/service/default-value-hydration-client.d.ts

@@ -0,0 +1,8 @@
+import { DefaultValue } from '@atlaskit/user-picker';
+export interface UsersRequest {
+    baseUrl: string | undefined;
+    accountIds: string[];
+    productKey: 'jira' | 'confluence';
+}
+declare function hydrateDefaultValues(baseUrl: string | undefined, value: DefaultValue, productKey: string): Promise<DefaultValue>;
+export default hydrateDefaultValues;

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

@@ -0,0 +1,14 @@
+interface Query {
+    query: string;
+    variables: Record<string, string> | Record<string, string[]>;
+}
+export interface GraphQLError {
+    code?: number;
+    reason: string;
+}
+/**
+ * @param {string} serviceUrl - GraphQL service endpoint
+ * @param {Query} query - GraphQL query
+ */
+export declare function graphqlQuery<D>(serviceUrl: string, query: Query): Promise<D>;
+export {};

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

@@ -0,0 +1,2 @@
+export { default as getUserRecommendations } from './recommendation-client';
+export { default as hydrateDefaultValues } from './default-value-hydration-client';

package/dist/types-ts4.5/service/recommendation-client.d.ts

@@ -0,0 +1,9 @@
+import { OptionData } from '@atlaskit/user-picker';
+import { RecommendationRequest } from '../types';
+import { IntlShape } from 'react-intl-next';
+export interface SUPError extends Error {
+    message: string;
+    statusCode: number;
+}
+declare const getUserRecommendations: (request: RecommendationRequest, intl: IntlShape) => Promise<OptionData[]>;
+export default getUserRecommendations;

package/dist/types-ts4.5/service/teams-client.d.ts

@@ -0,0 +1,12 @@
+import { Team } from '@atlaskit/user-picker';
+type LegionRequest = {
+    baseUrl?: string;
+    id: string;
+};
+export type LegionResponse = {
+    id: string;
+    displayName: string;
+    smallAvatarImageUrl: string;
+};
+declare const hydrateTeamFromLegion: (request: LegionRequest) => Promise<Team>;
+export default hydrateTeamFromLegion;

package/dist/types-ts4.5/service/users-client.d.ts

@@ -0,0 +1,11 @@
+import { User } from '@atlaskit/user-picker';
+interface UserData {
+    accountId: string;
+    name: string;
+    picture: string;
+}
+export interface ApiClientResponse {
+    users: UserData[];
+}
+declare const getHydratedUsers: (baseUrl: string | undefined, userIds: string[]) => Promise<User[]>;
+export default getHydratedUsers;

package/dist/types-ts4.5/service/users-transformer.d.ts

@@ -0,0 +1,22 @@
+import { OptionData } from '@atlaskit/user-picker';
+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"
+}
+export declare const transformUsers: (serverResponse: ServerResponse, intl: IntlShape) => OptionData[];
+export {};

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

@@ -0,0 +1,207 @@
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import { DefaultValue, OptionData, UserPickerProps } from '@atlaskit/user-picker';
+export interface Context {
+    containerId?: string;
+    contextType: string;
+    objectId?: string;
+    sessionId?: string;
+    principalId?: string;
+    childObjectId?: string;
+    productKey: string;
+    siteId: string;
+    organizationId?: string;
+    productAttributes?: ProductAttributes;
+}
+export interface RecommendationRequest {
+    baseUrl?: string;
+    context: Context;
+    maxNumberOfResults: number;
+    query?: string;
+    searchQueryFilter?: string;
+    includeUsers?: boolean;
+    includeGroups?: boolean;
+    includeTeams?: boolean;
+}
+type OnError = (error: any, request: RecommendationRequest) => Promise<OptionData[]> | void;
+type OnValueError = (error: any, defaultValue: DefaultValue) => Promise<OptionData[]> | void;
+type OnEmpty = (query: string) => Promise<OptionData[]>;
+export interface State {
+    users: OptionData[];
+    loading: boolean;
+    closed: boolean;
+    query: string;
+    sessionId?: string;
+    defaultValue?: DefaultValue;
+    bootstrapOptions: OptionData[];
+}
+export type ProductAttributes = BitbucketAttributes | ConfluenceAttributes;
+export type FilterOptions = (options: OptionData[], query: string) => OptionData[];
+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;
+}
+export interface ConfluenceAttributes {
+    /**
+     * Identifies whether this user is a confluence guest
+     */
+    isEntitledConfluenceExternalCollaborator?: boolean;
+}
+export declare enum EntityType {
+    USER = "USER",
+    TEAM = "TEAM",
+    GROUP = "GROUP"
+}
+export interface RecommendationItem {
+    id: string;
+    name?: string;
+    entityType: EntityType;
+    avatarUrl: string;
+    description?: string;
+    teamAri?: string;
+    displayName?: string;
+}
+export interface RecommendationResponse {
+    errors?: any[];
+    recommendedUsers: RecommendationItem[];
+}
+export interface SmartProps {
+    /**
+     * The base URL of the site eg: hello.atlassian.net
+     */
+    baseUrl?: string;
+    /**
+     * Hydrated user suggestions to show when the query is blank. If not provided, smart user picker
+     *  will still provide a smart-ranked list of suggestions for blank queries. Please refer to @atlaskit/user-picker
+     *  for OptionData type.
+     */
+    bootstrapOptions?: OptionData[];
+    /**
+     * Context information for analytics. Eg: if a user picker was put inside a comment, the childObjectId would be
+     *  the ID of the comment. Optional, but please provide if available.
+     */
+    childObjectId?: string;
+    /**
+     * The container Id to identify context.
+     *
+     * e.g. Jira: projectId. Confluence: spaceId. Bitbucket: repositoryId.
+     */
+    containerId?: string;
+    /**
+     * Time to debounce the suggestions fetching (in milliseconds). Defaults to 150ms.
+     */
+    debounceTime?: number;
+    /**
+     * Function to transform options suggested by the server before showing to the user. Can be used to filter out suggestions.
+     * The results of filterOptions are the results displayed in the suggestions UI.
+     */
+    filterOptions?: FilterOptions;
+    /**
+     * Whether to include groups in the resultset. Only supported for Confluence. @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.
+     * Used for analytics. Optional, but please include if available.
+     */
+    objectId?: string;
+    /**
+     * 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. This will NOT be called if props.filterOptions returns empty list.
+     */
+    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 filtered.
+     */
+    onError?: OnError;
+    /**
+     * Error handler used to provide OptionData[] values when the server fails to hydrate the `defaultValue` prop's values.
+     */
+    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 (has caused HOTs).
+     * Please give #help-smart-experiences a ballpark on the expected request volume.
+     */
+    prefetch?: boolean;
+    /**
+     * 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-specific 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. If you are an NPF, please ensure your product has been onboarded with
+     *  Cross-product user-search @see https://developer.atlassian.com/cloud/cross-product-user-search/
+     * If you are still waiting for CPUS, you can use the `people` productKey in the interim.
+     */
+    productKey: string;
+    /**
+     * 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;
+    /**
+     * 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;
+}
+export interface Props extends SmartProps, UserPickerProps, WithAnalyticsEventsProps {
+    /**
+     * The pre-selected values for the smart user picker. Supports only Users and Teams default value hydration.
+     * If the `DefaultValue` contains only an `id` and `type` (it conforms to an `OptionIdentifier`)
+     * then the values will be automatically hydrated.
+     * If the value has a `name` then it is considered hydrated and will be ignored.
+     * Uses Confluence and Jira if called from there, else uses Identity or Legion for teams. If a value could not be found, or there was
+     * a network failure during the hydration, the value will be rendered with the label 'Unknown'. Else, if there were any other error
+     * during default value hydration, no default values will be rendered, use `onValueError` to handle this.
+     * `defaultValue` differs from `value` in that it sets the initial value then leaves the component 'uncontrolled'
+     * whereas setting the `value` prop delegates responsibility for maintaining the value to the caller
+     * (i.e. listen to `onChange`)
+     */
+    defaultValue?: DefaultValue;
+    /**
+     * 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.
+     * All fieldId's will be bucketed into a model that provides generic smart results,
+     * except "assignee", "mentions" which are specifically trained for Jira Assignee and
+     * @Mentions. For specifically trained models, please contact #help-smart-experiences.
+     */
+    fieldId: string;
+}
+export {};

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import { ConcurrentExperience } from '@atlaskit/ufo';
+export declare const smartUserPickerRenderedUfoExperience: ConcurrentExperience;
+export declare const smartUserPickerOptionsShownUfoExperience: ConcurrentExperience;
+export declare const useUFOConcurrentExperience: (experience: ConcurrentExperience, id: string) => void;
+export declare class UfoErrorBoundary extends React.Component<{
+    id: string;
+}> {
+    componentDidCatch(): void;
+    render(): React.ReactNode;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Tries to get the most specific messages bundle for a given locale.
+ *
+ * Strategy:
+ * 1. Try to find messages with the exact string (i.e. 'fr_FR')
+ * 2. If that doesn't work, try to find messages for the country locale (i.e. 'fr')
+ * 3. If that doesn't work, return english messages as a fallback.
+ *
+ * @param locale string specifying the locale like 'en_GB', or 'fr'.
+ */
+export declare const getMessagesForLocale: (locale: string) => Promise<Record<string, string>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-user-picker",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -11,6 +11,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
@@ -50,7 +58,7 @@
     "fetch-mock": "^8.0.0",
     "graphql-tag": "^2.10.1",
     "mock-apollo-client": "^0.1.0",
-    "typescript": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }