@atlaskit/profilecard 19.6.0 → 19.6.1

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

@@ -1,358 +0,0 @@
-import React from 'react';
-import { IntlShape } from 'react-intl-next';
-import { AnalyticsEventPayload, CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import TeamCentralCardClient from './client/TeamCentralCardClient';
-import TeamProfileCardClient from './client/TeamProfileCardClient';
-import UserProfileCardClient from './client/UserProfileCardClient';
-export interface ApiClientResponse {
-    User: {
-        id: string;
-        isBot: boolean;
-        isCurrentUser: 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;
-    };
-}
-export interface Team {
-    largeAvatarImageUrl?: string;
-    smallAvatarImageUrl?: string;
-    largeHeaderImageUrl?: string;
-    smallHeaderImageUrl?: string;
-    id: string;
-    displayName: string;
-    description: string;
-    organizationId?: string;
-    members?: {
-        id: string;
-        fullName: string;
-        avatarUrl: string;
-    }[];
-}
-export interface ProfileCardClientData {
-    isBot: boolean;
-    isCurrentUser: boolean;
-    avatarUrl?: string;
-    email?: string;
-    fullName?: string;
-    location?: string;
-    meta?: string;
-    nickname?: string;
-    companyName?: string;
-    timestring?: string;
-    status: StatusType;
-    statusModifiedDate?: number | null;
-    customLozenges?: LozengeProps[];
-}
-export interface ReportingLinesUserPII {
-    name: string;
-    picture?: string;
-}
-export interface ReportingLinesUser {
-    accountIdentifier: string;
-    identifierType: 'ATLASSIAN_ID' | 'BASE64_HASH' | 'UNKNOWN';
-    pii?: ReportingLinesUserPII;
-}
-export interface TeamCentralReportingLinesData {
-    managers?: ReportingLinesUser[];
-    reports?: ReportingLinesUser[];
-}
-export interface ProfileCardResourcedProps {
-    userId: string;
-    cloudId: string;
-    resourceClient: ProfileClient;
-    actions?: ProfileCardAction[];
-    reportingLinesProfileUrl?: string;
-    onReportingLinesClick?: (user: ReportingLinesUser) => void;
-    position?: ProfilecardTriggerPosition;
-    trigger?: TriggerType;
-    children?: React.ReactNode;
-    addFlag?: (flag: any) => void;
-}
-export interface ProfileCardResourcedState {
-    visible?: boolean;
-    isLoading?: boolean;
-    hasError: boolean;
-    error?: ProfileCardErrorType;
-    data: ProfileCardClientData | null;
-    reportingLinesData?: TeamCentralReportingLinesData;
-    isKudosEnabled?: boolean;
-    kudosDrawerOpen: boolean;
-}
-export interface ProfileCardTriggerProps {
-    userId: string;
-    /**
-      A cloudId can be provided, and we'll verify that the target userId is an
-      actual user in the specified site.
-  
-      Instead you can omit the cloudId and we won't do such a check.
-  
-      If you have a cloudId and only want to show users who are in that site
-      then please provide it. If you're a site-less product or don't care about
-      verifying that the shown user is in a particular site, don't provide a
-      cloudId.
-     */
-    cloudId?: string;
-    resourceClient: ProfileClient;
-    actions?: ProfileCardAction[];
-    reportingLinesProfileUrl?: string;
-    onReportingLinesClick?: (user: ReportingLinesUser) => void;
-    position?: ProfilecardTriggerPosition;
-    trigger?: TriggerType;
-    children?: React.ReactNode;
-    testId?: string;
-    addFlag?: (flag: any) => void;
-}
-export interface ProfileCardTriggerState {
-    visible?: boolean;
-    isLoading?: boolean;
-    hasError: boolean;
-    error?: ProfileCardErrorType;
-    data: ProfileCardClientData | null;
-    reportingLinesData?: TeamCentralReportingLinesData;
-    shouldShowGiveKudos?: boolean;
-    teamCentralBaseUrl?: string;
-    kudosDrawerOpen: boolean;
-}
-export interface TeamProfileCardTriggerState {
-    visible?: boolean;
-    isLoading?: boolean;
-    hasError: boolean;
-    error?: any;
-    data: Team | null;
-    renderError?: boolean;
-    shouldShowGiveKudos?: boolean;
-    teamCentralBaseUrl?: string;
-    kudosDrawerOpen: boolean;
-}
-export interface TeamProfilecardCoreProps {
-    /**
-      The id of the user viewing the profile card.
-  
-      This is used to determine whether to say that the member count is
-      "including you" or not.
-     */
-    viewingUserId?: string;
-    /**
-      A list of extra buttons to be displayed at the bottom of the card.
-      View Profile is always included by default.
-     */
-    actions?: ProfileCardAction[];
-    /**
-      A function allowing products to provide an href for the user avatars in the
-      profilecard, e.g. so they can link to user's profile pages.
-     */
-    generateUserLink?: (userId: string) => string;
-    /**
-      A function allowing products to provide an onClick handler for when the
-      user clicks on a user's avatar or avatar group item.
-     */
-    onUserClick?: (userId: string, event: React.MouseEvent<Element>) => void;
-    /**
-      This should be a link to the team's profile page. This will be used for:
-  
-      - Wrapping the trigger in a link to the team profile page (unless
-        triggerLinkType is `none`).
-  
-      - Providing the link for the View Profile action button on the card.
-     */
-    viewProfileLink: string;
-    /**
-      An onClick action that navigates to the team's profile page. Something you
-      may want, e.g. for an SPA site or tracking analytics of navigation. This
-      is optional, just the viewProfileLink will suffice. Will be used for:
-  
-      - Adding an onClick to the trigger if the triggerLinkType is
-        `clickable-link`.
-  
-      - Providing an onClick for the View Profile action button on the card.
-     */
-    viewProfileOnClick?: (event?: React.MouseEvent<Element>) => void;
-}
-export interface TeamProfileCardTriggerProps extends TeamProfilecardCoreProps {
-    /** The id of the team. */
-    teamId: string;
-    /**
-      The id of the organization that the team belongs to.
-      Currently this is unused, but will become necessary in the future.
-     */
-    orgId: string;
-    /** An instance of ProfileClient. */
-    resourceClient: ProfileClient;
-    /**
-      The position relative to the trigger that the card should be displayed in.
-     */
-    position?: ProfilecardTriggerPosition;
-    /**
-      The interaction method used to trigger the team profile card to appear.
-  
-      - Click is generally recommended, but your needs may vary.
-  
-      - Hover works for mouse users, but does not support those who use a
-        keyboard or screen reader, avoid using this if it's possible or makes
-        sense.
-  
-      - Hover-click is usable for scenarios like inline-edits, where mouse users
-        cannot click on the trigger without causing side effects, but keyboard
-        users are still able to navigate into and trigger the profile card.
-  
-      Look at the "Team Profilecard Trigger" or "Trigger Link Types" examples to
-      see how they behave, or ask in #help-people-and-teams-xpc on Slack for our
-      recommendations.
-     */
-    trigger?: 'hover' | 'click' | 'hover-click';
-    /**
-      We generally prefer to wrap the trigger in a link to the team profile
-      page. This prop determines how that link behaves.
-  
-      - Link is generally the recommended prop (especially in combination with
-        click or hover-click for the trigger prop above). It wraps the trigger in
-        an anchor tag with the team profile link (that users can interact with
-        via middle-click, etc.), but left clicking on the link is suppressed.
-  
-      - None does not wrap the trigger in a link at all. This makes it difficult
-        for keyboard or screen reader users to know how to trigger the profile
-        card. Generally avoid this.
-  
-      - Clickable-link wraps the trigger in a link with no special behaviour.
-        This is suitable for places where you want the trigger to serve primarily
-        as a link, and optionally allow hovering to preview the team first.
-  
-      Look at the example on "Trigger Link Types" for more in-depth analysis, or
-      ask in #help-people-and-teams-xpc on Slack for our recommendations.
-     */
-    triggerLinkType?: 'none' | 'link' | 'clickable-link';
-    /**
-      This is the component that will cause a team profile card to appear when
-      interacted with according to the method specified by the trigger prop.
-     */
-    children?: React.ReactNode;
-    /**
-     * Used by the card to show Flags.
-     */
-    addFlag?: (flag: any) => void;
-    /**
-     * Optional cloudId. Pass this if rendering card within a sited context.
-     */
-    cloudId?: string;
-}
-export type StatusType = 'active' | 'inactive' | 'closed';
-export type TriggerType = 'hover' | 'click';
-export type StatusModifiedDateType = 'noDate' | 'thisWeek' | 'thisMonth' | 'lastMonth' | 'aFewMonths' | 'severalMonths' | 'moreThanAYear';
-export interface ProfileCardAction {
-    callback?: (...args: any[]) => any;
-    shouldRender?: (data: any) => boolean;
-    id?: string;
-    label: React.ReactNode;
-    link?: string;
-}
-export type LozengeColor = 'default' | 'success' | 'removed' | 'inprogress' | 'new' | 'moved';
-export interface LozengeProps {
-    text: React.ReactNode;
-    appearance?: LozengeColor;
-    isBold?: boolean;
-}
-export interface ProfilecardProps {
-    isLoading?: boolean;
-    hasError?: boolean;
-    errorType?: ProfileCardErrorType;
-    status?: StatusType;
-    isBot?: boolean;
-    avatarUrl?: string;
-    fullName?: string;
-    meta?: string;
-    userId?: string;
-    isCurrentUser?: boolean;
-    nickname?: string;
-    email?: string;
-    location?: string;
-    companyName?: string;
-    timestring?: string;
-    actions?: ProfileCardAction[];
-    clientFetchProfile?: () => void;
-    statusModifiedDate?: number | null;
-    withoutElevation?: boolean;
-    /** Show manager and direct reports section on profile hover card, if available */
-    reportingLines?: TeamCentralReportingLinesData;
-    /** Base URL to populate href value for manager's and direct reports' user avatar  */
-    reportingLinesProfileUrl?: string;
-    /** Click handler when user clicks on manager's and direct reports' user avatar, un-clickable otherwise */
-    onReportingLinesClick?: (user: ReportingLinesUser) => void;
-    isKudosEnabled?: boolean;
-    teamCentralBaseUrl?: string;
-    addFlag?: (flag: any) => void;
-    cloudId?: string;
-    disabledAccountMessage?: React.ReactNode;
-    hasDisabledAccountLozenge?: boolean;
-    customLozenges?: LozengeProps[];
-    openKudosDrawer?: () => void;
-}
-export type AnalyticsFromDuration = (duration: number) => AnalyticsEventPayload;
-export type AnalyticsFunction = (generator: AnalyticsFromDuration) => void;
-export interface AnalyticsProps {
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-}
-export interface AnalyticsWithDurationProps {
-    fireAnalyticsWithDuration: AnalyticsFunction;
-}
-export interface TeamProfilecardProps extends TeamProfilecardCoreProps {
-    /** Indicates whether the team's details are still loading. */
-    isLoading?: boolean;
-    /** Indicates whether an error occurred whilst fetching team details. */
-    hasError?: boolean;
-    /** Describes the type of error that occurred, if any. */
-    errorType?: TeamProfileCardErrorType;
-    /** The details of the team to be shown. */
-    team?: Team;
-    /** A callback that will try to re-fetch data in case an error occurred. */
-    clientFetchProfile?: () => void;
-    /** Details relevant to passing around analytics. */
-    analytics: AnalyticsFunction;
-}
-export interface MessageIntlProviderProps {
-    children: React.ReactNode;
-    intl: IntlShape;
-}
-export type RelativeDateKeyType = 'ThisWeek' | 'ThisMonth' | 'LastMonth' | 'AFewMonths' | 'SeveralMonths' | 'MoreThanAYear' | null;
-export interface ProfileClient {
-    flushCache: () => void;
-    getProfile: (cloudId: string, userId: string, analytics?: (event: AnalyticsEventPayload) => void) => Promise<ProfileCardClientData>;
-    getTeamProfile: (teamId: string, orgId?: string, fireAnalytics?: (event: AnalyticsEventPayload) => void) => Promise<Team>;
-    getReportingLines: (userId: string) => Promise<TeamCentralReportingLinesData>;
-    shouldShowGiveKudos: () => Promise<boolean>;
-    getTeamCentralBaseUrl: () => string | undefined;
-}
-export type ProfilecardTriggerPosition = 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end' | 'top-end' | 'top' | 'top-start' | 'right-end' | 'right' | 'right-start';
-export type ProfileCardErrorType = {
-    reason: 'default' | 'NotFound';
-} | null;
-export type TeamProfileCardErrorType = {
-    reason: 'default' | 'NotFound' | 'TEAMS_FORBIDDEN';
-} | null;
-export interface ProfileClientOptions {
-    url: string;
-    gatewayGraphqlUrl?: string;
-    cacheSize?: number;
-    cacheMaxAge?: number;
-    /** Enables Team Central functionality if enabled e.g. /gateway/api/watermelon/graphql*/
-    teamCentralUrl?: string;
-    /** URL to the Team Central app e.g. team.atlassian.com */
-    teamCentralBaseUrl?: string;
-    /** Name of integrating product e.g. jira, atlas, confluence **/
-    productIdentifier?: string;
-    cloudId?: string;
-}
-export interface ClientOverrides {
-    userClient?: UserProfileCardClient;
-    teamClient?: TeamProfileCardClient;
-    teamCentralClient?: TeamCentralCardClient;
-}

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

@@ -1,59 +0,0 @@
-import { AnalyticsEventPayload } from '@atlaskit/analytics-next';
-import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
-import { ErrorAttributes } from '../client/types';
-type GenericAttributes = Record<string, string | number | boolean | undefined | string[]> | ErrorAttributes;
-interface AnalyticsEvent {
-    action?: string;
-    actionSubject?: string;
-    actionSubjectId?: string;
-    attributes?: GenericAttributes;
-    name?: string;
-    source?: string;
-}
-export declare const fireEvent: (createAnalyticsEvent: CreateUIAnalyticsEvent | undefined, body: AnalyticsEvent) => void;
-export declare const cardTriggered: (type: 'user' | 'team', method: 'hover' | 'click') => AnalyticsEventPayload;
-export declare const teamRequestAnalytics: (action: 'triggered' | 'succeeded' | 'failed', attributes?: {
-    duration: number;
-} & GenericAttributes) => AnalyticsEventPayload;
-export declare const userRequestAnalytics: (action: 'triggered' | 'succeeded' | 'failed', attributes?: {
-    duration: number;
-} & GenericAttributes) => AnalyticsEventPayload;
-export declare const profileCardRendered: (type: 'user' | 'team', actionSubjectId: 'spinner' | 'content' | 'error' | 'errorBoundary', attributes?: {
-    duration?: number;
-    errorType?: 'default' | 'NotFound';
-    hasRetry?: boolean;
-    numActions?: number;
-    memberCount?: number;
-    includingYou?: boolean;
-    descriptionLength?: number;
-    titleLength?: number;
-}) => AnalyticsEventPayload;
-export declare const actionClicked: (type: 'user' | 'team', attributes: {
-    duration: number;
-    hasHref: boolean;
-    hasOnClick: boolean;
-    index: number;
-    actionId: string;
-}) => AnalyticsEventPayload;
-export declare const reportingLinesClicked: (attributes: {
-    userType: 'manager' | 'direct-report';
-    duration: number;
-}) => AnalyticsEventPayload;
-export declare const moreActionsClicked: (type: 'user' | 'team', attributes: {
-    duration: number;
-    numActions: number;
-}) => AnalyticsEventPayload;
-export declare const teamAvatarClicked: (attributes: {
-    duration: number;
-    hasHref: boolean;
-    hasOnClick: boolean;
-    index: number;
-}) => AnalyticsEventPayload;
-export declare const moreMembersClicked: (attributes: {
-    duration: number;
-    memberCount: number;
-}) => AnalyticsEventPayload;
-export declare const errorRetryClicked: (attributes: {
-    duration: number;
-}) => AnalyticsEventPayload;
-export {};

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

@@ -1,4 +0,0 @@
-import React from 'react';
-type Event = React.MouseEvent | React.KeyboardEvent;
-export declare const isBasicClick: (event: Event) => boolean;
-export {};

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

@@ -1,2 +0,0 @@
-export declare const DELAY_MS_SHOW = 800;
-export declare const DELAY_MS_HIDE = 200;

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

@@ -1,43 +0,0 @@
-export declare class HttpError extends Error {
-    code: number;
-    traceId?: string | null;
-    constructor(code: number, reason: string, traceId?: string | null);
-}
-type KnownErrorExtensions = {
-    errorNumber?: number;
-};
-type ErrorExtensions = KnownErrorExtensions & Record<string, any>;
-type ErrorCategory = 'NotFound' | 'NotPermitted' | 'MalformedInput' | 'Internal' | 'Gone';
-export declare class DirectoryGraphQLError extends Error {
-    category: ErrorCategory;
-    type: string;
-    path: string;
-    errorNumber?: number;
-    extensions: Record<string, any>;
-    constructor(message: string, category: ErrorCategory, type: string, extensions?: ErrorExtensions, path?: (string | number)[]);
-}
-export declare class DirectoryGraphQLErrors extends Error {
-    errors: DirectoryGraphQLError[];
-    traceId?: string | null;
-    constructor(errors: unknown, traceId: string | null);
-}
-type KnownAggErrorExtensions = {
-    statusCode?: number;
-    errorType?: string;
-    classification?: string;
-};
-type AggErrorExtensions = KnownAggErrorExtensions & Record<string, any>;
-export declare class AGGError extends Error {
-    path: string;
-    extensions: Record<string, any>;
-    statusCode?: number;
-    errorType?: string;
-    classification?: string;
-    constructor(message: string, extensions: AggErrorExtensions, path?: (string | number)[]);
-}
-export declare class AGGErrors extends Error {
-    errors: AGGError[];
-    traceId?: string | null;
-    constructor(errors: unknown, traceId: string | null);
-}
-export {};

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

@@ -1 +0,0 @@
-export declare const getPageTime: () => number;

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

@@ -1,6 +0,0 @@
-import React, { ComponentType } from 'react';
-export interface WithOuterListenersProps {
-    handleClickOutside?: () => void;
-    handleEscapeKeydown?: () => void;
-}
-export default function withOuterListeners<P>(Component: ComponentType<P>): React.ComponentClass<P & WithOuterListenersProps>;