@atlaskit/teams-client 4.0.0

package/dist/types-ts4.5/mocks/team-link.d.ts

@@ -0,0 +1,7 @@
+import type FakerType from 'faker';
+import { type TeamLink } from '../types';
+type MockConfig = {
+    faker: typeof FakerType;
+};
+export declare const randomTeamLinks: ({ faker }: MockConfig) => (n?: number, customProps?: {}) => TeamLink[];
+export {};

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

@@ -0,0 +1,14 @@
+import type FakerType from 'faker';
+import { type TeamMembership, type TeamWithMemberships } from '../types/membership';
+import { type Team, type TeamAvatarImage, type TeamWithImageUrls } from '../types/team';
+type MockConfig = {
+    faker: typeof FakerType;
+};
+export declare const randomTeamMembership: ({ faker }: MockConfig) => (customProps?: {}) => TeamMembership;
+export declare const randomTeamMemberships: (config: MockConfig) => (n?: number, customProps?: {}) => TeamMembership[];
+export declare const randomHeaderImage: ({ faker }: MockConfig) => () => string;
+export declare const randomTeamImages: ({ faker }: MockConfig) => (customImage?: string) => TeamAvatarImage;
+export declare const randomBasicTeam: ({ faker }: MockConfig) => (customProps?: {}) => Team;
+export declare const randomFullTeam: ({ faker }: MockConfig) => (customProps?: {}) => TeamWithImageUrls;
+export declare const randomTeamWithMemberships: ({ faker }: MockConfig) => (team: TeamWithImageUrls, customProps?: {}) => TeamWithMemberships;
+export {};

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

@@ -0,0 +1,15 @@
+import type FakerType from 'faker';
+import { type TeamsClientUser as User } from '../types/user';
+type MockConfig = {
+    faker: typeof FakerType;
+};
+export declare const createUser: (id: string, customProps?: {}) => User;
+export declare const randomUser: ({ faker }: MockConfig, customProps?: {}) => User;
+export declare const randomUsers: (n: number | undefined, config: MockConfig) => User[];
+export declare const fixedUsers: (n?: number) => User[];
+export declare const JohnWick: User;
+export declare const DenzelWashington: User;
+export declare const ClosedUser: User;
+export declare const InactiveUser: User;
+export declare const AgentUser: User;
+export {};

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

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

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

@@ -0,0 +1,12 @@
+import { type MembershipState, type TeamMembership } from '../../types';
+import { type ClientConfig } from '../base-client';
+import { BaseGraphQlClient } from '../graphql-client';
+import { type AGGPageInfoVariables, type ResultWithPageInfo } from './types';
+import { type TeamsUserQueryResponse } from './utils/queries/user-query';
+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>;
+}
+export declare const aggClient: AGGClient;

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

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,13 @@
+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/queries/team-membership-query.d.ts

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,31 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,37 @@
+import { RestClient } from '../rest-client';
+export type UserContainerArgs = {
+    userId: string;
+    principalId: string;
+    siteId: string;
+    sessionId: string;
+    maxNumberOfResults: number;
+};
+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[];
+};
+export declare class CollaborationGraphClient extends RestClient {
+    getUserContainers({ userId, principalId, siteId, sessionId, maxNumberOfResults, }: UserContainerArgs): Promise<UserContainerResponse>;
+}
+declare const _default: CollaborationGraphClient;
+export default _default;

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

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

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

@@ -0,0 +1,53 @@
+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

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

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

@@ -0,0 +1,8 @@
+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;
+    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

@@ -0,0 +1,19 @@
+import { type ErrorData } from '../../common/utils/error';
+export interface Options {
+    operationName?: string;
+    errorPolicy?: 'none' | 'all' | 'ignore';
+}
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,12 @@
+/**
+ * @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) => void;
+export {};

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

@@ -0,0 +1,33 @@
+import { type EditableUserFields } from '../../types';
+import { RestClient } from '../rest-client';
+export declare class IdentityClient extends RestClient {
+    constructor(config?: {});
+    getUserManageConfig(userId: string): Promise<{
+        mutabilityConstraints: {
+            field: import("./utils").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: IdentityClient;
+export default _default;

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

@@ -0,0 +1,81 @@
+interface IdentityProfileData {
+    account_id: string;
+    name: string;
+    nickname: string;
+    locale: string;
+    picture: string;
+    email: string;
+    zoneinfo: string;
+    extended_profile: {
+        job_title: string;
+        organization: string;
+        department: string;
+        location: string;
+        phone_number: string;
+    };
+}
+interface IdentityProfileResponse {
+    account: IdentityProfileData;
+}
+export interface UserDetails {
+    id: string;
+    fullName: string;
+    nickname: string;
+    timezone: string;
+    locale: string;
+    avatarUrl: string;
+    email: string;
+    title: string;
+    companyName: string;
+    department: string;
+    location: string;
+    phoneNumber: string;
+    localTime: ({ format }: {
+        format: string;
+    }) => string | null;
+}
+export type UserDetailKey = keyof UserDetails;
+export declare const fromManageAPIResponse: (res: IdentityProfileResponse) => UserDetails | null;
+export declare enum FieldType {
+    FullName = "fullName",
+    Nickname = "nickname",// aka `Public name`
+    Title = "title",
+    Department = "department",
+    CompanyName = "companyName",
+    Location = "location",
+    Timezone = "timezone",
+    Email = "email",
+    PhoneNumber = "phoneNumber",
+    Avatar = "picture",
+    Language = "language",
+    LocalTime = "localTime",
+    RemoteWeekdayIndex = "remoteWeekdayIndex",
+    RemoteWeekdayString = "remoteWeekdayString",
+    RemoteTimeString = "remoteTimeString"
+}
+type FieldKey = 'fullName' | 'nickname' | 'timezone' | 'locale' | 'title' | 'phoneNumber' | 'companyName' | 'department' | 'location' | 'email';
+export interface SimpleConstraint {
+    allowed: boolean;
+    reason?: {
+        key: string;
+    };
+}
+export type MutabilityContraints = {
+    [key: string]: SimpleConstraint | MutabilityContraints;
+};
+export declare const MUTABILITY_DETAILS_MAP: Record<FieldKey, string>;
+export declare const CUSTOM_FIELD_PLACE: {
+    readonly email: "email.initiateChange";
+    readonly picture: "avatar";
+};
+export type CustomFieldKey = keyof typeof CUSTOM_FIELD_PLACE;
+export type AllFieldKeys = FieldKey | CustomFieldKey;
+export declare const transformUserManageConfig: (data: MutabilityContraints) => {
+    mutabilityConstraints: {
+        field: FieldType;
+        reason: string | null;
+    }[];
+};
+export declare const toManageAPIInput: (input: Partial<UserDetails>) => any;
+export declare function dataURItoFile(dataURI: string, filename?: string): Blob | File;
+export {};

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

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

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

@@ -0,0 +1,11 @@
+import { type ClientConfig } from '../base-client';
+import { RestClient } from '../rest-client';
+import { type AccessRequestBulkSimplified, type AccessResourcesResponse, type Capability, type Product, type RecommendationsResponse } from './types';
+export declare class InvitationsClient extends RestClient {
+    constructor(serviceUrl: string, config: ClientConfig);
+    private getProductRecommendationsInner;
+    getProductRecommendations(supportedProducts?: Product[], capabilities?: Capability[]): Promise<RecommendationsResponse>;
+    joinOrRequestDefaultAccessToProductsBulk(simplifiedRequest: AccessRequestBulkSimplified): Promise<AccessResourcesResponse>;
+}
+declare const _default: InvitationsClient;
+export default _default;

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

@@ -0,0 +1,67 @@
+export type ProductARI = string;
+type RoleARI = string;
+type StatusCode = string;
+export type AccessRequestBulkSimplified = Omit<AccessRequestBulk, 'resources'> & {
+    productAris: ProductARI[];
+};
+/**
+ *
+ * The following types have been copied from id-invitations-service.
+ * Last updated 2023-08-07.
+ *
+ */
+export type Product = 'confluence' | 'jira-core' | 'jira-servicedesk' | 'jira-software' | 'jira-incident-manager' | 'jira' | 'jira-product-discovery' | 'opsgenie' | 'statuspage' | 'avocado' | 'townsquare' | 'compass' | 'avp' | 'beacon' | 'mercury';
+export type Capability = 'REQUEST_ACCESS' | 'DIRECT_ACCESS';
+type UserAccessLevel = 'INTERNAL' | 'EXTERNAL' | 'INTERNAL_INACTIVE';
+export type RecommendationMode = 'DOMAIN' | 'OPEN';
+export type Recommendation = {
+    resourceId: ProductARI;
+    userAccessLevel: UserAccessLevel;
+    mode?: RecommendationMode;
+    roleAri: RoleARI;
+    url: string;
+    displayName?: string;
+    avatarUrl?: string;
+};
+export type RecommendationsResponse = {
+    capability: {
+        [K in Capability]: Recommendation[];
+    };
+};
+export type Role = 'org/admin' | 'product/member' | 'product/helpseeker' | 'product/external-collaborator-writer';
+export type Resource = {
+    ari: ProductARI;
+    continueUrl?: string;
+    role: Role;
+};
+export type AccessMode = 'REQUEST_ACCESS' | 'DIRECT_ACCESS';
+export type AccessRequestBulk = {
+    resources: Resource[];
+    note?: string;
+    accessMode?: AccessMode;
+    source?: string;
+};
+export type AccessRequestCapability = 'ACCESS_GRANTED' | 'DIRECT_ACCESS' | 'REQUEST_ACCESS' | 'ACCESS_EXISTS' | 'PENDING_REQUEST_CREATED' | 'PENDING_REQUEST_EXISTS' | 'APPROVED_REQUEST_EXISTS' | 'DENIED_REQUEST_EXISTS' | 'FORBIDDEN' | 'VERIFICATION_REQUIRED' | 'ERROR';
+type AccessRequestCapabilityWithRole = {
+    accessMode: AccessRequestCapability;
+    role: Role;
+};
+type ErrorResponse = {
+    message: string;
+    responseStatus: StatusCode;
+};
+export type AccessResourceResponse = {
+    ari: ProductARI;
+    result: AccessRequestCapability;
+    resultsV2: {
+        [K in ProductARI]: AccessRequestCapabilityWithRole[];
+    };
+    errorReason?: ErrorResponse;
+};
+export type AccessResourcesResponse = AccessResourceResponse[];
+export {};
+/**
+ *
+ * END of copied types from id-invitations-service.
+ *
+ */

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

@@ -0,0 +1,7 @@
+import { type RecommendationsResponse } from '../types';
+/**
+ * Removes duplicate recommendations with the same resource ARI.
+ * When a collision occurs, select the recommendation with the most desirable capability and mode.
+ * @returns a recommendation response with unique resource ARIs.
+ */
+export declare const removeDuplicateRecommendations: (recommendations: RecommendationsResponse) => RecommendationsResponse;

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

@@ -0,0 +1,7 @@
+import { type Capability, type ProductARI, type Recommendation } from '../types';
+export type RecommendationWithCapability = Recommendation & {
+    capability: Capability;
+};
+export type RecommendationsByProductAri = {
+    [key: ProductARI]: RecommendationWithCapability;
+};