@atlaskit/profilecard 16.8.0 → 16.10.0

package/report.api.md

@@ -0,0 +1,614 @@
+## API Report File for "@atlaskit/profilecard"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { ComponentType } from 'react';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { IntlShape } from 'react-intl-next';
+import { LRUCache } from 'lru-fast';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+
+// @public (undocumented)
+export interface ApiClientResponse {
+  // (undocumented)
+  User: {
+    id: string;
+    isBot: boolean;
+    isCurrentUser: boolean;
+    isNotMentionable: boolean;
+    avatarUrl: string | null;
+    email: string | null;
+    fullName: string | null;
+    location: string | null;
+    meta: string | null;
+    nickname: string | null;
+    companyName: string | null;
+    remoteTimeString: string | null;
+    remoteWeekdayIndex: string | null;
+    remoteWeekdayString: string | null;
+    status: StatusType;
+    statusModifiedDate: number | null;
+  };
+}
+
+// @public (undocumented)
+export const DELAY_MS_HIDE = 200;
+
+// @public (undocumented)
+export const DELAY_MS_SHOW = 800;
+
+// @public (undocumented)
+export interface MessageIntlProviderProps {
+  // (undocumented)
+  children: React_2.ReactNode;
+  // (undocumented)
+  intl: IntlShape;
+}
+
+// @public
+export const modifyResponse: (
+  response: ApiClientResponse,
+) => ProfileCardClientData;
+
+// @public (undocumented)
+export class ProfileCard extends React_2.PureComponent<ProfilecardProps> {
+  constructor(props: ProfilecardProps);
+  // (undocumented)
+  callAnalytics: (id: string, options: any) => void;
+  // (undocumented)
+  callClientFetchProfile: (...args: any) => void;
+  // (undocumented)
+  clientFetchProfile: () => void;
+  // (undocumented)
+  componentDidMount(): void;
+  // (undocumented)
+  static defaultProps: ProfilecardProps;
+  // (undocumented)
+  getActions(): ProfileCardAction[];
+  // (undocumented)
+  getDisabledAccountDesc(): {};
+  // (undocumented)
+  getDisabledAccountName(): string | JSX.Element | null | undefined;
+  // (undocumented)
+  GIVE_KUDOS_ACTION_ID: string;
+  // (undocumented)
+  kudosButtonCallback: () => void;
+  // (undocumented)
+  kudosUrl: () => string;
+  // (undocumented)
+  render(): JSX.Element;
+  // (undocumented)
+  renderActionsButtons(): JSX.Element | null;
+  // (undocumented)
+  renderButton: (action: ProfileCardAction, idx: number) => ReactElement;
+  // (undocumented)
+  renderCardDetails(): JSX.Element;
+  // (undocumented)
+  renderCardDetailsApp(): JSX.Element;
+  // (undocumented)
+  renderCardDetailsDefault(): JSX.Element;
+  // (undocumented)
+  renderCardDetailsForDisabledAccount(): JSX.Element;
+  // (undocumented)
+  renderCustomLozenges(lozenges: LozengeProps[]): JSX.Element | null;
+  // (undocumented)
+  renderErrorMessage(): JSX.Element;
+}
+
+// @public (undocumented)
+export interface ProfileCardAction {
+  // (undocumented)
+  callback?: (...args: any[]) => any;
+  // (undocumented)
+  id?: string;
+  // (undocumented)
+  label: React_2.ReactNode;
+  // (undocumented)
+  link?: string;
+  // (undocumented)
+  shouldRender?: (data: any) => boolean;
+}
+
+// @public (undocumented)
+export interface ProfileCardClientData {
+  // (undocumented)
+  avatarUrl?: string;
+  // (undocumented)
+  companyName?: string;
+  // (undocumented)
+  customLozenges?: LozengeProps[];
+  // (undocumented)
+  email?: string;
+  // (undocumented)
+  fullName?: string;
+  // (undocumented)
+  isBot: boolean;
+  // (undocumented)
+  isCurrentUser: boolean;
+  // (undocumented)
+  isNotMentionable: boolean;
+  // (undocumented)
+  location?: string;
+  // (undocumented)
+  meta?: string;
+  // (undocumented)
+  nickname?: string;
+  // (undocumented)
+  status: StatusType;
+  // (undocumented)
+  statusModifiedDate?: number | null;
+  // (undocumented)
+  timestring?: string;
+}
+
+// @public (undocumented)
+export type ProfileCardErrorType = {
+  reason: 'default' | 'NotFound';
+} | null;
+
+// @public (undocumented)
+export interface ProfilecardProps {
+  // (undocumented)
+  actions?: ProfileCardAction[];
+  // (undocumented)
+  addFlag?: (flag: any) => void;
+  // (undocumented)
+  analytics?: any;
+  // (undocumented)
+  avatarUrl?: string;
+  // (undocumented)
+  clientFetchProfile?: any;
+  // (undocumented)
+  cloudId?: string;
+  // (undocumented)
+  companyName?: string;
+  // (undocumented)
+  customLozenges?: LozengeProps[];
+  // (undocumented)
+  disabledAccountMessage?: React_2.ReactNode;
+  // (undocumented)
+  email?: string;
+  // (undocumented)
+  errorType?: ProfileCardErrorType;
+  // (undocumented)
+  fullName?: string;
+  // (undocumented)
+  hasDisabledAccountLozenge?: boolean;
+  // (undocumented)
+  hasError?: boolean;
+  // (undocumented)
+  isBot?: boolean;
+  // (undocumented)
+  isCurrentUser?: boolean;
+  // (undocumented)
+  isKudosEnabled?: boolean;
+  // (undocumented)
+  isLoading?: boolean;
+  // (undocumented)
+  isNotMentionable?: boolean;
+  // (undocumented)
+  location?: string;
+  // (undocumented)
+  meta?: string;
+  // (undocumented)
+  nickname?: string;
+  onReportingLinesClick?: (user: ReportingLinesUser) => void;
+  // (undocumented)
+  openKudosDrawer?: () => void;
+  reportingLines?: TeamCentralReportingLinesData;
+  reportingLinesProfileUrl?: string;
+  // (undocumented)
+  status?: StatusType;
+  // (undocumented)
+  statusModifiedDate?: number | null;
+  // (undocumented)
+  teamCentralBaseUrl?: string;
+  // (undocumented)
+  timestring?: string;
+  // (undocumented)
+  userId?: string;
+  // (undocumented)
+  withoutElevation?: boolean;
+}
+
+// @public (undocumented)
+class ProfileCardResourced extends React_2.PureComponent<
+  ProfileCardResourcedProps,
+  ProfileCardResourcedState
+> {
+  // (undocumented)
+  clientFetchProfile: () => void;
+  // (undocumented)
+  closeKudosDrawer: () => void;
+  // (undocumented)
+  componentDidMount(): void;
+  // (undocumented)
+  componentDidUpdate(
+    prevProps: ProfileCardResourcedProps,
+    prevState: ProfileCardResourcedState,
+  ): void;
+  // (undocumented)
+  componentWillUnmount(): void;
+  // (undocumented)
+  static defaultProps: Partial<ProfileCardResourcedProps>;
+  // (undocumented)
+  filterActions: () => ProfileCardAction[];
+  // (undocumented)
+  handleClientError(err: any): void;
+  // (undocumented)
+  handleClientSuccess(
+    profileData: ProfileCardClientData,
+    reportingLinesData: TeamCentralReportingLinesData,
+    shouldShowGiveKudos: boolean,
+  ): void;
+  // (undocumented)
+  _isMounted: boolean;
+  // (undocumented)
+  openKudosDrawer: () => void;
+  // (undocumented)
+  render(): React_2.ReactNode;
+  // (undocumented)
+  state: ProfileCardResourcedState;
+}
+export default ProfileCardResourced;
+
+// @public (undocumented)
+export interface ProfileCardResourcedProps {
+  // (undocumented)
+  actions?: ProfileCardAction[];
+  // (undocumented)
+  addFlag?: (flag: any) => void;
+  // (undocumented)
+  analytics?: any;
+  // (undocumented)
+  children?: React_2.ReactNode;
+  // (undocumented)
+  cloudId: string;
+  // (undocumented)
+  onReportingLinesClick?: (user: ReportingLinesUser) => void;
+  // (undocumented)
+  position?: ProfilecardTriggerPosition;
+  // (undocumented)
+  reportingLinesProfileUrl?: string;
+  // (undocumented)
+  resourceClient: ProfileClient_2;
+  // (undocumented)
+  trigger?: TriggerType;
+  // (undocumented)
+  userId: string;
+}
+
+// @public (undocumented)
+export interface ProfileCardResourcedState {
+  // (undocumented)
+  data: ProfileCardClientData | null;
+  // (undocumented)
+  error?: ProfileCardErrorType;
+  // (undocumented)
+  hasError: boolean;
+  // (undocumented)
+  isKudosEnabled?: boolean;
+  // (undocumented)
+  isLoading?: boolean;
+  // (undocumented)
+  kudosDrawerOpen: boolean;
+  // (undocumented)
+  reportingLinesData?: TeamCentralReportingLinesData;
+  // (undocumented)
+  visible?: boolean;
+}
+
+// @public (undocumented)
+export class ProfileCardTrigger extends React_2.PureComponent<
+  ProfileCardTriggerProps,
+  ProfileCardTriggerState
+> {
+  // (undocumented)
+  clientFetchProfile: () => void;
+  // (undocumented)
+  closeKudosDrawer: () => void;
+  // (undocumented)
+  componentDidMount(): void;
+  // (undocumented)
+  componentDidUpdate(prevProps: ProfileCardTriggerProps): void;
+  // (undocumented)
+  componentWillUnmount(): void;
+  // (undocumented)
+  containerListeners:
+    | {
+        onMouseEnter: () => void;
+        onMouseLeave: () => void;
+        onClick?: undefined;
+      }
+    | {
+        onClick: (event: React_2.MouseEvent) => void;
+        onMouseEnter?: undefined;
+        onMouseLeave?: undefined;
+      };
+  // (undocumented)
+  static defaultProps: Partial<ProfileCardTriggerProps>;
+  // (undocumented)
+  filterActions(): ProfileCardAction[];
+  // (undocumented)
+  handleClientError(err: any): void;
+  // (undocumented)
+  handleClientSuccess(
+    profileData: ProfileCardClientData,
+    reportingLinesData: TeamCentralReportingLinesData,
+    shouldShowGiveKudos: boolean,
+  ): void;
+  // (undocumented)
+  hideDelay: number;
+  // (undocumented)
+  hideProfilecard: () => void;
+  // (undocumented)
+  hideTimer: number;
+  // (undocumented)
+  _isMounted: boolean;
+  // (undocumented)
+  layerListeners: {
+    handleClickOutside: () => void;
+    handleEscapeKeydown: () => void;
+  };
+  // (undocumented)
+  onClick: (event: React_2.MouseEvent) => void;
+  // (undocumented)
+  openKudosDrawer: () => void;
+  // (undocumented)
+  render(): JSX.Element;
+  // (undocumented)
+  renderCard: () => JSX.Element;
+  // (undocumented)
+  renderProfileCard(): JSX.Element;
+  // (undocumented)
+  renderWithTrigger(): JSX.Element;
+  // (undocumented)
+  showDelay: number;
+  // (undocumented)
+  showProfilecard: () => void;
+  // (undocumented)
+  showTimer: number;
+  // (undocumented)
+  state: ProfileCardTriggerState;
+}
+
+// @public (undocumented)
+export type ProfilecardTriggerPosition =
+  | 'bottom-start'
+  | 'bottom'
+  | 'bottom-end'
+  | 'left-start'
+  | 'left'
+  | 'left-end'
+  | 'top-end'
+  | 'top'
+  | 'top-start'
+  | 'right-end'
+  | 'right'
+  | 'right-start';
+
+// @public (undocumented)
+export interface ProfileCardTriggerProps {
+  // (undocumented)
+  actions?: ProfileCardAction[];
+  // (undocumented)
+  addFlag?: (flag: any) => void;
+  // (undocumented)
+  analytics?: any;
+  // (undocumented)
+  children?: React_2.ReactNode;
+  cloudId?: string;
+  // (undocumented)
+  onReportingLinesClick?: (user: ReportingLinesUser) => void;
+  // (undocumented)
+  position?: ProfilecardTriggerPosition;
+  // (undocumented)
+  reportingLinesProfileUrl?: string;
+  // (undocumented)
+  resourceClient: ProfileClient_2;
+  // (undocumented)
+  testId?: string;
+  // (undocumented)
+  trigger?: TriggerType;
+  // (undocumented)
+  userId: string;
+}
+
+// @public (undocumented)
+export interface ProfileCardTriggerState {
+  // (undocumented)
+  data: ProfileCardClientData | null;
+  // (undocumented)
+  error?: ProfileCardErrorType;
+  // (undocumented)
+  hasError: boolean;
+  // (undocumented)
+  isLoading?: boolean;
+  // (undocumented)
+  kudosDrawerOpen: boolean;
+  // (undocumented)
+  reportingLinesData?: TeamCentralReportingLinesData;
+  // (undocumented)
+  shouldShowGiveKudos?: boolean;
+  // (undocumented)
+  teamCentralBaseUrl?: string;
+  // (undocumented)
+  visible?: boolean;
+}
+
+// @public (undocumented)
+export class ProfileClient {
+  constructor(config: ProfileClientOptions, clients?: ClientOverrides);
+  // (undocumented)
+  flushCache(): void;
+  // (undocumented)
+  getProfile(cloudId: string, userId: string): Promise<any>;
+  // (undocumented)
+  getReportingLines(userId: string): Promise<TeamCentralReportingLinesData>;
+  // (undocumented)
+  getTeamCentralBaseUrl(): string | undefined;
+  // (undocumented)
+  getTeamProfile(
+    teamId: string,
+    orgId?: string,
+    analytics?: (event: Record<string, any>) => void,
+  ): Promise<Team>;
+  // (undocumented)
+  shouldShowGiveKudos(): Promise<boolean>;
+  // (undocumented)
+  tcClient?: TeamCentralCardClient;
+  // (undocumented)
+  teamClient: TeamProfileClient;
+  // (undocumented)
+  userClient: UserProfileClient;
+}
+
+// @public (undocumented)
+export interface ProfileClientOptions {
+  // (undocumented)
+  cacheMaxAge?: number;
+  // (undocumented)
+  cacheSize?: number;
+  // (undocumented)
+  gatewayGraphqlUrl?: string;
+  productIdentifier?: string;
+  teamCentralBaseUrl?: string;
+  teamCentralUrl?: string;
+  // (undocumented)
+  url: string;
+}
+
+// @public (undocumented)
+export type RelativeDateKeyType =
+  | 'ThisWeek'
+  | 'ThisMonth'
+  | 'LastMonth'
+  | 'AFewMonths'
+  | 'SeveralMonths'
+  | 'MoreThanAYear'
+  | null;
+
+// @public (undocumented)
+export type StatusModifiedDateType =
+  | 'noDate'
+  | 'thisWeek'
+  | 'thisMonth'
+  | 'lastMonth'
+  | 'aFewMonths'
+  | 'severalMonths'
+  | 'moreThanAYear';
+
+// @public (undocumented)
+export type StatusType = 'active' | 'inactive' | 'closed';
+
+// @public (undocumented)
+export interface Team {
+  // (undocumented)
+  description: string;
+  // (undocumented)
+  displayName: string;
+  // (undocumented)
+  id: string;
+  // (undocumented)
+  largeAvatarImageUrl?: string;
+  // (undocumented)
+  largeHeaderImageUrl?: string;
+  // (undocumented)
+  members?: {
+    id: string;
+    fullName: string;
+    avatarUrl: string;
+  }[];
+  // (undocumented)
+  organizationId?: string;
+  // (undocumented)
+  smallAvatarImageUrl?: string;
+  // (undocumented)
+  smallHeaderImageUrl?: string;
+}
+
+// @public (undocumented)
+export const TeamProfileCard: (
+  props: TeamProfilecardProps,
+) => JSX.Element | null;
+
+// @public (undocumented)
+export const TeamProfileCardTrigger: React_2.ForwardRefExoticComponent<
+  Pick<
+    Omit<
+      TeamProfileCardTriggerProps & {
+        createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined;
+      },
+      keyof WithAnalyticsEventsProps
+    >,
+    never
+  > &
+    Partial<
+      Pick<
+        Omit<
+          TeamProfileCardTriggerProps & {
+            createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined;
+          },
+          keyof WithAnalyticsEventsProps
+        >,
+        keyof TeamProfileCardTriggerProps
+      >
+    > &
+    Partial<Pick<Partial<TeamProfileCardTriggerProps>, never>> &
+    React_2.RefAttributes<any>
+>;
+
+// @public (undocumented)
+export class TeamProfileClient extends CachingClient<Team> {
+  constructor(options: ProfileClientOptions);
+  // (undocumented)
+  getProfile(
+    teamId: string,
+    orgId: string | undefined,
+    analytics?: (event: Record<string, any>) => void,
+  ): Promise<Team>;
+  // (undocumented)
+  makeRequest(teamId: string, orgId: string | undefined): Promise<Team>;
+  // (undocumented)
+  makeRequestViaGateway(
+    teamId: string,
+    _orgId: string | undefined,
+  ): Promise<Team>;
+  // (undocumented)
+  options: ProfileClientOptions;
+}
+
+// @public (undocumented)
+export type TriggerType = 'hover' | 'click';
+
+// @public (undocumented)
+export class UserProfileClient extends CachingClient<any> {
+  constructor(options: ProfileClientOptions);
+  // (undocumented)
+  getProfile(cloudId: string, userId: string): Promise<any>;
+  // (undocumented)
+  makeRequest(cloudId: string, userId: string): Promise<ProfileCardClientData>;
+  // (undocumented)
+  options: ProfileClientOptions;
+}
+
+// @public (undocumented)
+export function withOuterListeners<P>(
+  Component: ComponentType<P>,
+): React_2.ComponentClass<P & WithOuterListenersProps>;
+
+// @public (undocumented)
+export interface WithOuterListenersProps {
+  // (undocumented)
+  handleClickOutside?: () => void;
+  // (undocumented)
+  handleEscapeKeydown?: () => void;
+}
+
+// (No @packageDocumentation comment for this package)
+```