@atlaskit/teams-client 4.33.5 → 5.0.0

package/dist/types-ts4.5/mocks/with-faker.d.ts

@@ -1,12 +0,0 @@
-import type FakerType from 'faker';
-import type { Team, TeamWithImageUrls, TeamWithMemberships, TeamLink } from '../types';
-type MockConfig = {
-    faker: typeof FakerType;
-};
-export declare const teamsClientMocks: (config: MockConfig) => {
-    randomBasicTeam: (customProps?: {}) => Team;
-    randomFullTeam: (customProps?: {}) => TeamWithImageUrls;
-    randomTeamWithMemberships: (team: TeamWithImageUrls, customProps?: {}) => TeamWithMemberships;
-    randomTeamLinks: (n?: number, customProps?: {}) => TeamLink[];
-};
-export {};

package/dist/types-ts4.5/services/agg-client/index.d.ts

@@ -1,36 +0,0 @@
-import { type MembershipState, type TeamAgentAssociation, type TeamMembership, type TeamWithMemberships } from '../../types';
-import { type ClientConfig } from '../base-client';
-import { BaseGraphQlClient } from '../graphql-client';
-import { type AGGPageInfoVariables, type ResultWithPageInfo } from './types';
-import { type UnlinkContainerMutationResponse } from './utils/mutations/unlink-container-mutation';
-import { type TeamsUserQueryResponse } from './utils/queries/user-query';
-type ContainerTypes = 'ConfluenceSpace' | 'JiraProject' | 'LoomSpace' | 'WebLink';
-type ContainerSubTypes = string;
-type TeamContainer = {
-    id: string;
-    type: ContainerTypes;
-    name: string;
-    icon?: string | null;
-    createdDate?: Date;
-    link?: string | null;
-    containerTypeProperties?: {
-        subType?: ContainerSubTypes;
-        name?: string;
-    };
-};
-export type TeamContainers = Array<TeamContainer>;
-export declare class AGGClient extends BaseGraphQlClient {
-    constructor(baseUrl: string, config: ClientConfig);
-    setBaseUrl(baseUrl: string): void;
-    queryTeamMemberships(teamId: string, membershipState?: MembershipState[], pageInfo?: AGGPageInfoVariables): Promise<ResultWithPageInfo<TeamMembership>>;
-    queryAGGUser(userId: string): Promise<TeamsUserQueryResponse>;
-    queryTeamHasAgents(teamId: string): Promise<TeamAgentAssociation[]>;
-    private processTeamHasAgentsResponse;
-    getTeamContainers(teamId: string): Promise<TeamContainers>;
-    private processV2Response;
-    unlinkTeamContainer(teamId: string, containerId: string): Promise<UnlinkContainerMutationResponse>;
-    queryNumberOfTeamConnectedToContainer(containerId: string): Promise<number>;
-    queryTeamsConnectedToContainer(containerId: string): Promise<TeamWithMemberships[]>;
-}
-export declare const aggClient: AGGClient;
-export {};

package/dist/types-ts4.5/services/agg-client/mocks/index.d.ts

@@ -1,49 +0,0 @@
-export declare const MOCK_TEAM: {
-    team: {
-        teamV2: {
-            members: {
-                edges: {
-                    node: {
-                        member: {
-                            id: string;
-                            name: string;
-                            picture: string;
-                            accountStatus: string;
-                            extendedProfile: {
-                                jobTitle: string;
-                            };
-                        };
-                        state: string;
-                        role: string;
-                    };
-                }[];
-                pageInfo: {
-                    hasNextPage: boolean;
-                    endCursor: string;
-                };
-            };
-        };
-    };
-};
-export declare const MOCK_USER: {
-    user: {
-        name: string;
-        picture: string;
-        accountStatus: string;
-        __typename: string;
-        email: string;
-        nickname: string;
-        locale: string;
-        zoneinfo: string;
-        extendedProfile: {
-            jobTitle: string;
-            organization: string;
-            department: string;
-            location: string;
-            phoneNumbers: string;
-            closedDate: Date;
-            inactiveDate: Date;
-        };
-        id: string;
-    };
-};

package/dist/types-ts4.5/services/agg-client/types.d.ts

@@ -1,13 +0,0 @@
-export type AGGPageInfo = {
-    endCursor: string | null;
-    hasNextPage: boolean;
-};
-export type ResultWithPageInfo<T> = {
-    edges: T[];
-    pageInfo: AGGPageInfo;
-};
-export type AGGPageInfoVariables = {
-    first: number;
-    after?: string;
-};
-export declare function isResultWithPageInfo<T>(result: T[] | ResultWithPageInfo<T>): result is ResultWithPageInfo<T>;

package/dist/types-ts4.5/services/agg-client/utils/mutations/unlink-container-mutation.d.ts

@@ -1,18 +0,0 @@
-export declare const UnlinkContainerMutation: string;
-export interface UnlinkContainerMutationError extends Error {
-    message: string;
-    extensions?: {
-        statusCode: string;
-        errorType: string;
-    };
-}
-export type UnlinkContainerMutationVariables = {
-    teamId: string;
-    containerId: string;
-};
-export type UnlinkContainerMutationResponse = {
-    deleteTeamConnectedToContainer: {
-        errors: Array<UnlinkContainerMutationError>;
-        success: boolean;
-    };
-};

package/dist/types-ts4.5/services/agg-client/utils/queries/number-of-team-connected-to-container-query.d.ts

@@ -1,11 +0,0 @@
-export declare const NumberOfTeamConnectedToContainerQuery: string;
-export type NumberOfTeamConnectedToContainerQueryVariables = {
-    containerId: string;
-};
-export type NumberOfTeamConnectedToContainerQueryResponse = {
-    teamConnectedToContainerInverse: {
-        edges: {
-            id: string;
-        }[];
-    };
-};

package/dist/types-ts4.5/services/agg-client/utils/queries/team-connected-to-container-query.d.ts

@@ -1,47 +0,0 @@
-import type { UserARI } from '../../../../common/types';
-import type { MembershipRole, MembershipState } from '../../../../types/membership';
-import type { TeamMembershipSettings, TeamState } from '../../../../types/team';
-import type { AGGPageInfo } from '../../types';
-export declare const TeamConnectedToContainerQuery: string;
-export type TeamConnectedToContainerQueryVariables = {
-    containerId: string;
-};
-export type TeamConnectedToContainerQueryResponse = {
-    teamConnectedToContainerInverse: {
-        edges: {
-            node: {
-                id: string;
-                description: string;
-                displayName: string;
-                creator: {
-                    id: string;
-                };
-                smallAvatarImageUrl: string;
-                smallHeaderImageUrl: string;
-                largeAvatarImageUrl: string;
-                largeHeaderImageUrl: string;
-                members?: {
-                    nodes: {
-                        role: MembershipRole;
-                        state: MembershipState;
-                        member?: {
-                            name: string;
-                            picture: string;
-                            id: UserARI;
-                            accountStatus: 'active' | 'inactive' | 'closed';
-                            extendedProfile: {
-                                jobTitle: string | null;
-                            } | null;
-                            appType?: string | null;
-                        };
-                    }[];
-                    pageInfo: AGGPageInfo;
-                };
-                organizationId?: string;
-                membershipSettings: TeamMembershipSettings;
-                isVerified?: boolean;
-                state: TeamState;
-            };
-        }[];
-    };
-};

package/dist/types-ts4.5/services/agg-client/utils/queries/team-containers-query.d.ts

@@ -1,52 +0,0 @@
-export declare const TeamContainersQueryV2: string;
-export type TeamContainersQueryV2Variables = {
-    cypherQuery: string;
-    params: Record<string, any>;
-};
-export type TeamContainersQueryV2Response = {
-    cypherQueryV2: {
-        edges: Array<{
-            node: {
-                columns: Array<{
-                    key: string;
-                    value: {
-                        data?: JiraProject | ConfluenceSpace | LoomSpace;
-                    };
-                }>;
-            };
-        }>;
-    };
-};
-type JiraProject = {
-    __typename: 'JiraProject';
-    id: string;
-    jiraProjectName: string;
-    webUrl: string;
-    created: string;
-    avatar: {
-        medium: string;
-    };
-    projectType: string;
-    projectTypeName: string;
-};
-type ConfluenceSpace = {
-    __typename: 'ConfluenceSpace';
-    id: string;
-    confluenceSpaceName?: string;
-    type: string;
-    createdDate: string;
-    links: {
-        base: string;
-        webUi: string;
-    };
-    icon: {
-        path: string;
-    };
-};
-type LoomSpace = {
-    __typename: 'LoomSpace';
-    id: string;
-    loomSpaceName: string;
-    url: string;
-};
-export {};

package/dist/types-ts4.5/services/agg-client/utils/queries/team-has-agents-query.d.ts

@@ -1,15 +0,0 @@
-export declare const TeamHasAgentsQuery: string;
-export type TeamHasAgentsQueryVariable = {
-    id: string;
-};
-export type TeamHasAgentsQueryResponse = {
-    teamHasAgents: {
-        edges: Array<{
-            node: {
-                name: string;
-                id: string;
-                picture?: string;
-            };
-        }>;
-    };
-};

package/dist/types-ts4.5/services/agg-client/utils/queries/team-membership-query.d.ts

@@ -1,33 +0,0 @@
-import { type UserARI } from '../../../../common/types';
-import { type MembershipRole, type MembershipState } from '../../../../types';
-import { type AGGPageInfo } from '../../types';
-declare const TeamMembershipQuery = "query app_user_characteristics($teamId: ID!, $siteId: String!, $membershipState: [TeamMembershipState!]!, $first: Int!, $after: String) {\n    team {\n      teamV2(\n        id: $teamId\n        siteId: $siteId\n      ) @optIn(to: \"Team-v2\") {\n        members(state: $membershipState, first: $first, after: $after) {\n          edges {\n            node {\n              member {\n                id\n                name\n                picture\n                accountStatus\n                ... on AtlassianAccountUser {\n                  extendedProfile {\n                    jobTitle\n                  }\n                }\n                ... on AppUser {\n                  appType\n                }\n              }\n              role\n              state\n            }\n          }\n          pageInfo {\n            endCursor\n            hasNextPage\n          }\n        }\n      }\n    }\n  }";
-export default TeamMembershipQuery;
-export type TeamMembershipQueryVariables = {
-    teamId: string;
-    siteId: string;
-    membershipState: MembershipState[];
-};
-export type TeamMembershipQueryResponse = {
-    teamV2: {
-        members: {
-            edges: {
-                node: {
-                    role: MembershipRole;
-                    state: MembershipState;
-                    member: {
-                        name: string;
-                        picture: string;
-                        id: UserARI;
-                        accountStatus: 'active' | 'inactive' | 'closed';
-                        extendedProfile: {
-                            jobTitle: string | null;
-                        } | null;
-                        appType?: string | null;
-                    };
-                };
-            }[];
-            pageInfo: AGGPageInfo;
-        };
-    };
-};

package/dist/types-ts4.5/services/agg-client/utils/queries/user-query.d.ts

@@ -1,31 +0,0 @@
-import { type UserStatus } from '../../../../types/user';
-export declare const TeamsUserQuery: string;
-export type TeamsUserQueryVariables = {
-    userId: string;
-};
-type PhoneNumber = {
-    type?: string;
-    value: string;
-};
-export type TeamsUserQueryResponse = {
-    id: string;
-    name: string;
-    picture: string;
-    accountStatus: UserStatus;
-    __typename: 'AppUser' | string;
-    email?: string;
-    nickname?: string;
-    locale?: string;
-    zoneinfo?: string;
-    extendedProfile?: {
-        jobTitle?: string;
-        organization?: string;
-        department?: string;
-        location?: string;
-        phoneNumbers?: PhoneNumber[];
-        closedDate?: string;
-        inactiveDate?: string;
-    };
-    appType?: string;
-};
-export {};

package/dist/types-ts4.5/services/agg-client/utils/user-type.d.ts

@@ -1,7 +0,0 @@
-import { type UserType } from '../../../types/user';
-type userTypeOptions = {
-    isBot?: boolean;
-    appType?: string | null;
-};
-export declare function toUserType({ isBot, appType }: userTypeOptions): UserType;
-export {};

package/dist/types-ts4.5/services/base-client/index.d.ts

@@ -1,37 +0,0 @@
-import { type ClientContext, type ClientContextProps } from '../types';
-type NestedContext = {
-    [key: string]: string | number | boolean | NestedContext;
-};
-export type LogExceptionFN = (ex: unknown | Error, name: string, context?: NestedContext & {
-    tags?: Record<string, string>;
-}) => void;
-export type ClientConfig = {
-    logException: LogExceptionFN;
-};
-export declare class BaseClient {
-    private config;
-    private context;
-    private cache;
-    constructor(config: ClientConfig);
-    setContext(context: ClientContextProps): void;
-    getContext(): ClientContext;
-    /**
-     *
-     * @param localValue is used for backwards compatibility
-     * @returns
-     */
-    getOrgId(localValue?: string): string;
-    /**
-     *
-     * @param localValue is used for backwards compatibility
-     * @returns
-     */
-    getCloudId(localValue?: string): string;
-    logException: (ex: unknown | Error, name: string, context?: NestedContext & {
-        tags?: Record<string, string>;
-    }) => void;
-    private keyWithContext;
-    cacheValue<T>(key: string, value: T, expiryMs?: number): void;
-    getCachedValue<T>(key: string): T | undefined;
-}
-export {};

package/dist/types-ts4.5/services/collaborationgraph-client/index.d.ts

@@ -1,70 +0,0 @@
-import { RestClient } from '../rest-client';
-export type UserContainerArgs = {
-    userId: string;
-    principalId: string;
-    siteId: string;
-    sessionId: string;
-    maxNumberOfResults: number;
-};
-export type RecommendedUsersArgs = {
-    accountId: string;
-    cloudId: string;
-    maxNumberOfResults?: number;
-    filter?: string | null;
-    expand?: 'existing' | 'all' | string;
-    requestingUserId?: string;
-    sessionId?: string;
-    modelRequestParams?: {
-        experience?: string;
-        caller?: string;
-        featureServiceModel?: string;
-    };
-};
-declare enum CONTAINER_TYPE {
-    JIRA_PROJECT = "jiraProject",
-    CONFLUENCE_SPACE = "confluenceSpace"
-}
-declare enum ENTITY_TYPE {
-    CONTAINER = "CONTAINER",
-    USER = "USER"
-}
-type CollaborationGraphContainerDetails = {
-    id: string;
-    key: string;
-    name: string;
-    url: string;
-    iconUrl: string;
-};
-type CollaborationGraphEntities = {
-    id: string;
-    containerType: CONTAINER_TYPE;
-    entityType: ENTITY_TYPE;
-    containerDetails: CollaborationGraphContainerDetails;
-};
-type UserContainerResponse = {
-    collaborationGraphEntities: CollaborationGraphEntities[];
-};
-type CollaborationGraphUser = {
-    id: string;
-    expand: {
-        name: string;
-        picture: string;
-        nickname: string;
-        account_status: string;
-        extended_profile?: {
-            job_title?: string;
-            organization?: string;
-            department?: string;
-            location?: string;
-        };
-    };
-};
-export type RecommendedUsersResponse = {
-    recommendedEntities: CollaborationGraphUser[];
-};
-export declare class CollaborationGraphClient extends RestClient {
-    getUserContainers({ userId, principalId, siteId, sessionId, maxNumberOfResults, }: UserContainerArgs): Promise<UserContainerResponse>;
-    getRecommendedUsers({ accountId, cloudId, maxNumberOfResults, filter, expand, requestingUserId, sessionId, modelRequestParams, }: RecommendedUsersArgs): Promise<RecommendedUsersResponse>;
-}
-declare const _default_1: CollaborationGraphClient;
-export default _default_1;

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

@@ -1,2 +0,0 @@
-import { type TeamsClientConfig } from '../types';
-export declare const DEFAULT_CONFIG: TeamsClientConfig;

package/dist/types-ts4.5/services/directory-client/index.d.ts

@@ -1,53 +0,0 @@
-import { type TeamMembership } from '../../types';
-import { type ClientConfig } from '../base-client';
-import { BaseGraphQlClient } from '../graphql-client';
-export declare const BROWSE_USER_SETTINGS_KEY = "internal.browse-users-allowed";
-/**
- * @type CloudUser
- * @property {string} avatarUrl
- * @property {string} id
- * @property {string} fullName
- * @property {string} title
- */
-export interface CloudUser {
-    avatarUrl: string;
-    id: string;
-    fullName: string;
-    title?: string;
-}
-export declare class DirectoryClient extends BaseGraphQlClient {
-    constructor(baseUrl: string, config: ClientConfig);
-    setBaseUrl(baseUrl: string): void;
-    queryFeatureFlags(
-    /**
-     * @private
-     * @deprecated don't need to pass param, value is taken from `this.getCloudId()` instead
-     */
-    cloudId: string | undefined, flags: string[]): Promise<Record<string, boolean>>;
-    private canRetryError;
-    /**
-     * Get user information of all members of a team
-     * @param {string} teamId
-     * @returns {Promise}
-     * @private
-     * @deprecated use AGG instead
-     */
-    queryTeamMemberships(teamId: string, membershipStatus?: string[]): Promise<TeamMembership[]>;
-    /**
-     * Get user information of all members of a team
-     * @param {string} userId
-     * @returns {Promise}
-     */
-    queryUser(userId: string, 
-    /**
-     * @private
-     * @deprecated don't need to pass param, value is taken from `this.getCloudId()` instead
-     */
-    cloudId?: string): Promise<{
-        CloudUser: CloudUser;
-    }>;
-}
-/**
- * @deprecated As part of decommisioning pf-directoy
- */
-export declare const directoryClient: DirectoryClient;

package/dist/types-ts4.5/services/graphql-client/index.d.ts

@@ -1 +0,0 @@
-export { BaseGraphQlClient } from './main';

package/dist/types-ts4.5/services/graphql-client/main.d.ts

@@ -1,14 +0,0 @@
-import { BaseClient, type ClientConfig } from '../base-client';
-import { type Body, type Options, type ResultResponse } from './types';
-export declare class BaseGraphQlClient extends BaseClient {
-    private serviceUrl;
-    constructor(serviceUrl: string, config: ClientConfig);
-    setServiceUrl(serviceUrl: string): void;
-    /**
-     * Creates query context headers if cloudId is available and valid.
-     * Validates the cloudId before constructing the ARI, preventing invalid
-     * ARIs like `ari:cloud:platform::site/None` from being sent.
-     */
-    private createQueryContextHeaders;
-    makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;
-}

package/dist/types-ts4.5/services/graphql-client/types.d.ts

@@ -1,20 +0,0 @@
-import { type ErrorData } from '../../common/utils/error';
-export interface Options {
-    operationName?: string;
-    errorPolicy?: 'none' | 'all' | 'ignore';
-    headers?: Record<string, string>;
-}
-export type InnerResponse<T> = {
-    data: T;
-    errors?: ErrorData[];
-};
-export type ResultResponse<Key extends string, Data> = {
-    [name in Key]: Data;
-};
-export type Body<Variables> = {
-    query: string;
-    variables?: Variables;
-};
-export type GraphQLRequestDataResponse<Data> = Data | {
-    response: Response;
-};

package/dist/types-ts4.5/services/graphql-client/utils/index.d.ts

@@ -1,3 +0,0 @@
-import { type Body, type GraphQLRequestDataResponse, type Options, type ResultResponse } from '../types';
-export declare function makeGraphQLRequestWithoutRetries<Data, Variables>(serviceUrl: string, body: Body<Variables>, options?: Options): Promise<GraphQLRequestDataResponse<Data>>;
-export declare function handleGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(serviceUrl: string, body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;

package/dist/types-ts4.5/services/hooks/use-teams-client-setup.d.ts

@@ -1,14 +0,0 @@
-/**
- * @deprecated use useTeamsClientSetupNext for named parameters
- */
-export declare const useTeamsClientSetup: (stargateRoot?: string, cloudId?: string | null, orgId?: string, principalUserId?: string) => void;
-type TeamsClientSetupProps = {
-    stargateRoot?: string;
-    cloudId?: string | null;
-    orgId?: string;
-    principalUserId?: string;
-};
-export declare const useTeamsClientSetupNext: ({ stargateRoot, cloudId, orgId, principalUserId, }: TeamsClientSetupProps) => {
-    isClientReady: boolean;
-};
-export {};

package/dist/types-ts4.5/services/identity-client/index.d.ts

@@ -1,34 +0,0 @@
-import { type EditableUserFields } from '../../types';
-import { RestClient } from '../rest-client';
-import { FieldType } from './utils';
-export declare class IdentityClient extends RestClient {
-    constructor(config?: {});
-    getUserManageConfig(userId: string): Promise<{
-        mutabilityConstraints: {
-            field: FieldType;
-            reason: string | null;
-        }[];
-    }>;
-    /**
-     * @deprecated
-     * User fetchUserAvatarInfo instead
-     */
-    getMyAvatarUploadedStatus(userId: string): Promise<{
-        uploaded: boolean;
-        url: string;
-    }>;
-    deleteAvatar(userId: string): Promise<unknown>;
-    fetchUserAvatarInfo(userId: string): Promise<{
-        uploaded: boolean;
-        url: string;
-    }>;
-    updateUser({ id, ...user }: Partial<EditableUserFields> & {
-        id: string;
-    }): Promise<unknown>;
-    updateUserAvatar({ id, fileURI }: {
-        id: string;
-        fileURI: string;
-    }): Promise<string>;
-}
-declare const _default_1: IdentityClient;
-export default _default_1;