@atlaskit/teams-client 4.33.4 → 5.0.0

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;

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

@@ -1,85 +0,0 @@
-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;
-        about_me: string;
-        pronouns: 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;
-    aboutMe: string;
-    pronouns: 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

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

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

@@ -1,11 +0,0 @@
-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_1: InvitationsClient;
-export default _default_1;

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

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

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

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

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

@@ -1,164 +0,0 @@
-import { type InvitedUser, type LinkOrder, type NewTeamLink, type ReadMediaTokenResponse, type Team, type TeamLink, type TeamMembership, type TeamMembershipSettings, type TeamWithImageUrls, type TeamWithMemberships } from '../../types';
-import { type AlignmentPermission, type AssignedTeamsResponse, type AssignTeamsToSitesResponse, type ExternalReference, type LinkedTeamsBulkResponse, type LinkedTeamsProfileDetails, type OrgScope, type SoftDeletedTeam, type TeamEnabledSitesResponse, type TeamSiteAssignmentOrgDetailsResponse, type TeamsPermissionFromApi, type TeamsToBeClonedToJsmSitesResponse, type UnassignedTeamsResponse } from '../../types/team';
-import { type ApiTeamContainerCreationPayload, type ApiTeamContainerResponse } from '../../types/team-container';
-import { type UserInSiteUserbase } from '../../types/user';
-import { RestClient } from '../rest-client';
-import { type LegionAssociateAgentResponse, type LegionLinkResponseV3, type LegionLinkResponseV4, type LegionPaginatedResponse, type LegionTeamAndGroupDifferenceResponse, type OrgAlignmentStatus, type TeamStatesInBulkResponse } from './types';
-export interface PaginationResult<T> {
-    entities: T[];
-}
-export interface OriginQuery {
-    /**
-     * @private
-     * @deprecated use getContext().cloudId instead
-     */
-    cloudId?: string;
-    product?: string | null;
-}
-export interface SortField {
-    field: string;
-    order: 'asc' | 'desc';
-}
-/**
- * @type AllTeamsQuery
- * Query type for the getAllTeams API
- * @property {string} orgId - Organization ID
- * @property {string} cursor - Cursor to fetch the next page of results
- * @property {number} limit - Number of teams to fetch
- * @property {string} searchQuery - Search query to filter teams
- * @property {string[]} memberAccountIds - List of member account IDs to filter teams
- * @property {boolean} useDefaultSort - Whether to use the default sort order
- * @property {boolean} showEmptyTeams - Whether to return empty teams in the search
- * @property {string[]} teamTypeIdsFilter - List of team type IDs to filter teams
- * @property {boolean} enablePagination - Whether the API should paginate the response
- */
-export interface AllTeamsQuery {
-    /**
-     * @private
-     * @deprecated use getContext().orgId instead
-     */
-    orgId: string;
-    cursor?: string;
-    limit?: number;
-    searchQuery?: string;
-    memberAccountIds?: string[];
-    useDefaultSort?: boolean;
-    showEmptyTeams?: boolean;
-    sortBy?: SortField[];
-    teamTypeIdsFilter?: string[];
-    enablePagination?: boolean;
-}
-/**
- * @type AllTeamsResponse
- * Response type for the getAllTeams API
- * @property {TeamWithMemberships[]} teams - List of teams
- * @property {string} cursor - Cursor to fetch the next page of results
- * @property {Error} error - Error object if the API call fails
- */
-export interface AllTeamsResponse {
-    teams: TeamWithMemberships[];
-    cursor: string;
-    error?: Error;
-}
-/**
- * @type AllTeamsPayload
- * Payload type for the getAllTeams API
- * @property {TeamWithMemberships[]} entities - List of teams
- * @property {string} cursor - Cursor to fetch the next page of results
- */
-export interface AllTeamsPayload {
-    entities: TeamWithMemberships[];
-    cursor: string;
-}
-export interface LegionClient {
-    getTeamById(teamId: string): Promise<TeamWithImageUrls>;
-    updateTeamById(teamId: string, data: Partial<Team>): Promise<TeamWithImageUrls>;
-    getAllTeams(allTeamsQuery: AllTeamsQuery): Promise<AllTeamsResponse>;
-    inviteUsersToTeam(teamId: string, users: InvitedUser[], originQuery: OriginQuery): Promise<TeamMembership[]>;
-    getMyTeamMembership(teamId: string): Promise<TeamMembership>;
-    getTeamLinksByTeamId(teamId: string): Promise<{
-        entities: TeamLink[];
-    }>;
-    createTeamLink(teamId: string, link: NewTeamLink): Promise<TeamLink>;
-    updateTeamLink(teamId: string, linkId: string, newLink: NewTeamLink): Promise<TeamLink>;
-    deleteTeamLink(teamId: string, linkId: string): Promise<void>;
-    reorderTeamLink(teamId: string, linkId: string, newPosition: number): Promise<LinkOrder>;
-    acceptTeamInvitation(teamId: string): Promise<TeamMembership>;
-    declineTeamInvitation(teamId: string): Promise<void>;
-    selfJoinTeam(teamId: string, originQuery: OriginQuery): Promise<TeamMembership>;
-    cancelJoinRequest(teamId: string): Promise<void>;
-    acceptJoinRequest(teamId: string, memberId: string): Promise<TeamMembership>;
-    declineJoinRequest(teamId: string, memberId: string): Promise<void>;
-    deleteTeamMembership(teamId: string, memberId: string): Promise<TeamMembership>;
-    revokeTeamInvite(teamId: string, memberId: string): Promise<TeamMembership>;
-    deleteTeam(teamId: string): Promise<void>;
-    archiveTeam(teamId: string): Promise<TeamWithImageUrls>;
-    unArchiveTeam(teamId: string): Promise<TeamWithImageUrls>;
-    isSingleFullMemberTeam(teamId: string): Promise<boolean>;
-    createTeam(displayName: string, originQuery: OriginQuery, members?: string[], membershipSettings?: TeamMembershipSettings, typeId?: string): Promise<Team>;
-    createExternalTeam(description: string, externalReference: ExternalReference, teamName?: string, siteId?: string): Promise<Team>;
-    retrieveBrowseUserPermission(product: string): Promise<{
-        canSearchUsers: boolean;
-    }>;
-    getLinkedTeamsBulk(groupIds: string[]): Promise<LinkedTeamsBulkResponse>;
-    getTeamProfileDetails(teamId: string, siteId?: string): Promise<LinkedTeamsProfileDetails>;
-    getOrgScope(): Promise<OrgScope>;
-    getPermissions(): Promise<TeamsPermissionFromApi>;
-    restoreTeamToSyncedGroup(teamId: string, externalReference: ExternalReference): Promise<void>;
-    createTeamContainers(payload: ApiTeamContainerCreationPayload): Promise<ApiTeamContainerResponse>;
-    getTeamEnabledSites(teamId: string): Promise<TeamEnabledSitesResponse>;
-    assignTeamsToSites(migrations: {
-        teamId: string;
-        targetSite: string;
-    }[]): Promise<AssignTeamsToSitesResponse>;
-    getAssignedTeams(orgId: string, count: number, cursor?: string | null, displayNameContains?: string | null): Promise<AssignedTeamsResponse>;
-    setTeamSiteAssignmentPermission(orgId: string, alignmentPermission: AlignmentPermission): Promise<void>;
-    getUnassignedTeams(orgId: string, count: number, cursor?: string | null, query?: string | null): Promise<UnassignedTeamsResponse>;
-    getTeamSiteAssignmentOrgDetails(): Promise<TeamSiteAssignmentOrgDetailsResponse>;
-    checkOrgFullAlignmentStatus(orgId: string): Promise<OrgAlignmentStatus>;
-    getTeamStatesInBulk(orgId: string, teamIds: string[]): Promise<TeamStatesInBulkResponse>;
-}
-/**
- * REST Client to make calls to Legion.
- *
- * Redirects to the instance login screen when a response returns a 401.
- * It should probably redirect to Aa, but this is what the existing clients
- * do so I'm going to follow suite.
- */
-export declare class LegionClient extends RestClient implements LegionClient {
-    private serviceUrlRoot;
-    constructor(serviceUrl: string);
-    setRootUrl(url: string): void;
-    getOrgEligibilityForManagedTeams(): Promise<{
-        isEligible: boolean;
-    }>;
-    addAgentsToTeam(teamId: string, agents: string[]): Promise<LegionAssociateAgentResponse>;
-    removeAgentTeamAssociation(teamId: string, agentId: string): Promise<null>;
-    unlinkTeamFromGroup(teamId: string, membershipSettings: TeamMembershipSettings): Promise<void>;
-    getTeamAndGroupDiff(teamId: string, externalReference: ExternalReference): Promise<LegionTeamAndGroupDifferenceResponse>;
-    linkExistingTeamToGroup(teamId: string, externalReference: ExternalReference): Promise<void>;
-    getWriteMediaToken(): Promise<ReadMediaTokenResponse>;
-    getSoftDeletedTeamById(teamId: string): Promise<SoftDeletedTeam>;
-    /**
-     * Shoud only be used within Teams (P&T) packages
-     */
-    getUserInSiteUserBase(userId: string): Promise<UserInSiteUserbase>;
-    getTeamsToBeClonedToJsmSites(teamsToSiteScope: {
-        teamId: string;
-        siteId: string;
-    }[]): Promise<TeamsToBeClonedToJsmSitesResponse>;
-    trimTeamARI(teamId?: string): string;
-    private constructProductOriginParams;
-    private mapTeamResponseV4ToTeam;
-    private mapTeamCreateResponseV4ToTeam;
-    private mapTeamSearchResponseV4ToTeamWithMembership;
-    mapLegionTeamLinksResponseV3ToTeamLinkResponse(response: LegionPaginatedResponse<LegionLinkResponseV3>): {
-        entities: TeamLink[];
-    };
-    mapLegionTeamLinksResponseV4ToTeamLinkResponse(response: LegionPaginatedResponse<LegionLinkResponseV4>): {
-        entities: TeamLink[];
-    };
-    mapLegionTeamLinkResponseV3ToTeamLink(legionLinkResponseV3: LegionLinkResponseV3): TeamLink;
-    mapLegionTeamLinkResponseV4ToTeamLink(legionLinkResponseV4: LegionLinkResponseV4): TeamLink;
-}
-export declare const defaultLegionClient: LegionClient;

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

@@ -1,128 +0,0 @@
-import type { TeamMembership } from '../../types/membership';
-import type { ExternalReference, ScopeMode, TeamDiscoverability, TeamMembershipSettings, TeamPermission, TeamRestriction, TeamState } from '../../types/team';
-export interface LegionTeamImagesResponse {
-    smallHeaderImageUrl: string;
-    largeHeaderImageUrl: string;
-    smallAvatarImageUrl: string;
-    largeAvatarImageUrl: string;
-}
-export interface LegionTeamMembershipResponse {
-    membership: {
-        members: TeamMembership[];
-        errors: string[];
-    };
-}
-export interface LegionAssociateAgentResponse {
-    agents: string[];
-    errors: {
-        accountId: string;
-        code: string;
-        message: string;
-    }[];
-}
-export interface LegionTeamBaseResponseV3 {
-    id: string;
-    displayName: string;
-    description: string;
-    state: TeamState;
-    membershipSettings: TeamMembershipSettings;
-    discoverable?: TeamDiscoverability;
-    organizationId?: string;
-    restriction: TeamRestriction;
-    creatorId?: string;
-    creatorDomain?: string;
-    permission?: TeamPermission;
-}
-export type LegionTeamGetResponseV3 = LegionTeamBaseResponseV3 & LegionTeamImagesResponse;
-export type LegionTeamCreateResponseV3 = LegionTeamBaseResponseV3 & LegionTeamMembershipResponse;
-export interface LegionTeamBaseResponseV4 {
-    id: string;
-    displayName: string;
-    description: string;
-    state: TeamState;
-    membershipSettings: TeamMembershipSettings;
-    organizationId: string;
-    creatorId?: string;
-    permission?: TeamPermission;
-    scopeMode: ScopeMode;
-    isVerified?: boolean;
-    externalReference?: ExternalReference;
-}
-export type LegionTeamGetResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamImagesResponse>;
-export type LegionTeamCreateResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamMembershipResponse>;
-export type LegionTeamAndGroupDifferenceResponse = {
-    displayNameChange: {
-        from: string;
-        to: string;
-    } | null;
-    membersToAdd: {
-        count: number;
-        memberIds: string[];
-    };
-    membersToRemove: {
-        count: number;
-        memberIds: string[];
-    };
-};
-export interface LegionTeamSearchResponseV3 {
-    id: string;
-    displayName: string;
-    description: string;
-    state: TeamState;
-    membershipSettings: TeamMembershipSettings;
-    discoverable?: TeamDiscoverability;
-    organizationId?: string;
-    restriction: TeamRestriction;
-    smallHeaderImageUrl: string;
-    largeHeaderImageUrl: string;
-    smallAvatarImageUrl: string;
-    largeAvatarImageUrl: string;
-    memberCount: number;
-    includesYou: boolean;
-}
-export interface LegionTeamSearchResponseV4 {
-    id: string;
-    displayName: string;
-    description: string;
-    state: TeamState;
-    membershipSettings: TeamMembershipSettings;
-    organizationId?: string;
-    smallHeaderImageUrl: string;
-    largeHeaderImageUrl: string;
-    smallAvatarImageUrl: string;
-    largeAvatarImageUrl: string;
-    memberCount: number;
-    includesYou: boolean;
-    isVerified?: boolean;
-    enablePagination?: boolean;
-}
-export interface LegionPaginatedResponse<T> {
-    entities: T[];
-    cursor: string;
-}
-export interface LegionLinkResponseV3 {
-    contentTitle: string;
-    description: string;
-    linkUri: string;
-    creationTime?: string;
-    linkId: string;
-    teamId?: string;
-}
-export interface LegionLinkResponseV4 {
-    contentTitle: string;
-    description: string;
-    linkUri: string;
-    linkId: string;
-    teamId?: string;
-}
-export interface OrgAlignmentStatus {
-    orgId: string;
-    scopeAligned: boolean;
-}
-export interface TeamStateEntry {
-    teamId: string;
-    state: TeamState;
-}
-export interface TeamStatesInBulkResponse {
-    teamStates: TeamStateEntry[];
-}