@atlaskit/teams-client 4.20.0 → 4.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist/cjs/common/utils/permissions/constants.js +52 -8
- package/dist/cjs/common/utils/permissions/has-permission.js +4 -3
- package/dist/cjs/common/utils/permissions/types.js +2 -2
- package/dist/cjs/common/utils/ufo/constants.js +1 -1
- package/dist/cjs/services/legion-client/index.js +233 -184
- package/dist/cjs/services/main.js +580 -533
- package/dist/es2019/common/utils/permissions/constants.js +53 -8
- package/dist/es2019/common/utils/permissions/has-permission.js +4 -3
- package/dist/es2019/common/utils/permissions/types.js +2 -2
- package/dist/es2019/common/utils/ufo/constants.js +1 -1
- package/dist/es2019/services/legion-client/index.js +19 -4
- package/dist/es2019/services/main.js +9 -0
- package/dist/esm/common/utils/permissions/constants.js +52 -8
- package/dist/esm/common/utils/permissions/has-permission.js +4 -3
- package/dist/esm/common/utils/permissions/types.js +2 -2
- package/dist/esm/common/utils/ufo/constants.js +1 -1
- package/dist/esm/services/legion-client/index.js +233 -184
- package/dist/esm/services/main.js +580 -533
- package/dist/types/common/utils/permissions/constants.d.ts +3 -3
- package/dist/types/common/utils/permissions/has-permission.d.ts +3 -2
- package/dist/types/common/utils/permissions/types.d.ts +1 -1
- package/dist/types/common/utils/ufo/constants.d.ts +2 -2
- package/dist/types/services/legion-client/index.d.ts +4 -2
- package/dist/types/services/legion-client/types.d.ts +7 -0
- package/dist/types/services/main.d.ts +5 -0
- package/dist/types/types/team.d.ts +1 -1
- package/dist/types-ts4.5/common/utils/permissions/constants.d.ts +3 -3
- package/dist/types-ts4.5/common/utils/permissions/has-permission.d.ts +3 -2
- package/dist/types-ts4.5/common/utils/permissions/types.d.ts +3 -1
- package/dist/types-ts4.5/common/utils/ufo/constants.d.ts +2 -1
- package/dist/types-ts4.5/services/legion-client/index.d.ts +4 -2
- package/dist/types-ts4.5/services/legion-client/types.d.ts +7 -0
- package/dist/types-ts4.5/services/main.d.ts +5 -0
- package/dist/types-ts4.5/types/team.d.ts +1 -1
- package/package.json +1 -4
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission } from '../../../types/team';
|
|
1
|
+
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission, type TeamState } from '../../../types/team';
|
|
2
2
|
import { type TeamAction } from './types';
|
|
3
3
|
export type PermissionMap = Required<Record<TeamAction, boolean>>;
|
|
4
|
-
export declare const allPermissions: (defaultPermission: boolean, isMember: boolean) => PermissionMap;
|
|
4
|
+
export declare const allPermissions: (defaultPermission: boolean, isMember: boolean, isOrgAdmin: boolean) => PermissionMap;
|
|
5
5
|
export declare const vanityActions: TeamAction[];
|
|
6
6
|
export declare const openPermissions: (permission: TeamPermission | undefined) => {
|
|
7
7
|
JOIN_TEAM: boolean;
|
|
@@ -20,4 +20,4 @@ export declare const SCIMSyncTeamPermissions: (isMember: boolean, isOrgAdmin: bo
|
|
|
20
20
|
EDIT_TEAM_LINK: boolean;
|
|
21
21
|
EDIT_TEAM_NAME: boolean;
|
|
22
22
|
};
|
|
23
|
-
export declare const getPermissionMap: (settings: TeamMembershipSettings, permission: TeamPermission | undefined, isMember: boolean, isOrgAdmin: boolean, source?: ExternalReferenceSource) => PermissionMap;
|
|
23
|
+
export declare const getPermissionMap: (settings: TeamMembershipSettings, permission: TeamPermission | undefined, isMember: boolean, isOrgAdmin: boolean, source?: ExternalReferenceSource, state?: TeamState) => PermissionMap;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type TeamMembership } from '../../../types/membership';
|
|
2
|
-
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission } from '../../../types/team';
|
|
2
|
+
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission, type TeamState } from '../../../types/team';
|
|
3
3
|
import { type TeamAction, type TeamPermissions } from './types';
|
|
4
|
-
export declare function hasPermission(action: TeamAction, settings: TeamMembershipSettings, permission: TeamPermission | undefined, isPeopleBrowseEnabled: boolean, currentUserMembership: TeamMembership | undefined, teamVisibilityPermissions?: TeamPermissions, source?: ExternalReferenceSource): boolean;
|
|
4
|
+
export declare function hasPermission(action: TeamAction, settings: TeamMembershipSettings, permission: TeamPermission | undefined, isPeopleBrowseEnabled: boolean, currentUserMembership: TeamMembership | undefined, teamVisibilityPermissions?: TeamPermissions, source?: ExternalReferenceSource, state?: TeamState): boolean;
|
|
5
5
|
type PermissionOptions = {
|
|
6
6
|
/**
|
|
7
7
|
* The teams membership settings, "OPEN" | "MEMBER_INVITE" | "EXTERNAL"
|
|
@@ -23,6 +23,7 @@ type PermissionOptions = {
|
|
|
23
23
|
* External source(if any) "ATLASSIAN_GROUP" | "HRIS"
|
|
24
24
|
*/
|
|
25
25
|
source?: ExternalReferenceSource;
|
|
26
|
+
state?: TeamState;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
29
|
* Determines if a user has permission perform a given action on a team
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const AllTeamActions: readonly ["ADD_MEMBER_TO_TEAM", "JOIN_TEAM", "REQUEST_TO_JOIN", "CANCEL_JOIN_REQUEST", "APPROVE_JOIN_REQUEST", "REJECT_JOIN_REQUEST", "REMOVE_MEMBER_FROM_TEAM", "CANCEL_INVITE", "LEAVE_TEAM", "REMOVE_AGENT_FROM_TEAM", "ADD_AGENT_TO_TEAM", "EDIT_TEAM_NAME", "EDIT_DESCRIPTION", "EDIT_PROFILE_HEADER", "EDIT_TEAM_LINK", "EDIT_TEAM_SETTINGS", "EDIT_TEAM_MEMBERSHIP", "DELETE_TEAM", "ARCHIVE_TEAM"];
|
|
1
|
+
export declare const AllTeamActions: readonly ["ADD_MEMBER_TO_TEAM", "JOIN_TEAM", "REQUEST_TO_JOIN", "CANCEL_JOIN_REQUEST", "APPROVE_JOIN_REQUEST", "REJECT_JOIN_REQUEST", "REMOVE_MEMBER_FROM_TEAM", "CANCEL_INVITE", "LEAVE_TEAM", "REMOVE_AGENT_FROM_TEAM", "ADD_AGENT_TO_TEAM", "EDIT_TEAM_NAME", "EDIT_DESCRIPTION", "EDIT_PROFILE_HEADER", "EDIT_TEAM_LINK", "EDIT_TEAM_SETTINGS", "EDIT_TEAM_MEMBERSHIP", "EDIT_TEAM_TYPE", "DELETE_TEAM", "ARCHIVE_TEAM", "UNARCHIVE_TEAM"];
|
|
2
2
|
export type TeamAction = (typeof AllTeamActions)[number];
|
|
3
3
|
export type TeamPermissions = {
|
|
4
4
|
canCreateTeams: boolean;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TeamsUFOExperience } from './index';
|
|
2
|
-
declare const TeamsClientExperienceKeyList: readonly ["getAllTeams", "getTeamById", "updateTeamById", "querySettings", "queryFeatureFlags", "queryTeamMemberships", "queryUser", "inviteUsersToTeam", "getMyTeamMembership", "getTeamLinksByTeamId", "createTeamLink", "updateTeamLink", "deleteTeamLink", "reorderTeamLink", "acceptTeamInvitation", "declineTeamInvitation", "selfJoinTeam", "cancelJoinRequest", "acceptJoinRequest", "declineJoinRequest", "deleteTeamMembership", "revokeTeamInvite", "deleteTeam", "archiveTeam", "isSingleFullMemberTeam", "createTeam", "createTeamContainers", "createExternalTeam", "getProfileWithMutability", "getIsSiteAdmin", "addUsersToTeam", "removeTeamMemberships", "getRecommendedProducts", "joinOrRequestDefaultAccessToProductsBulk", "getReadMediaToken", "getWriteUserMediaToken", "updateUserHeaderImage", "getWriteTeamMediaToken", "getSoftDeletedTeamById", "restoreTeam", "getUserInSiteUserBase", "getLinkedTeamsBulk", "getTeamProfileDetails", "getUserContainers", "getPermissions", "getUserManageConfig", "getMyAvatarUploadedStatus", "deleteUserAvatar", "getTeamLinkIcons", "getTeamInSlack", "getOrgScope", "restoreTeamToSyncedGroup", "getTeamAndGroupDiff", "linkExistingTeamToGroup", "fetchUserAvatarInfo", "getOrgEligibilityForManagedTeams", "updateUser", "updateUserAvatar", "disconnectTeamInSlack", "updateTeamInSlack", "getUserTenure", "getAriFromUrl", "getWebLinkTitle", "addAgentToTeam", "getTeamEnabledSites", "assignTeamsToSites", "removeAgentTeamAssociation", "getAssignedTeams", "setTeamSiteAssignmentPermission", "getUnassignedTeams", "getTeamSiteAssignmentOrgDetails", "getTeamsToBeClonedToJsmSites", "getReportingLines"];
|
|
2
|
+
declare const TeamsClientExperienceKeyList: readonly ["getAllTeams", "getTeamById", "updateTeamById", "querySettings", "queryFeatureFlags", "queryTeamMemberships", "queryUser", "inviteUsersToTeam", "getMyTeamMembership", "getTeamLinksByTeamId", "createTeamLink", "updateTeamLink", "deleteTeamLink", "reorderTeamLink", "acceptTeamInvitation", "declineTeamInvitation", "selfJoinTeam", "cancelJoinRequest", "acceptJoinRequest", "declineJoinRequest", "deleteTeamMembership", "revokeTeamInvite", "deleteTeam", "archiveTeam", "unarchiveTeam", "isSingleFullMemberTeam", "createTeam", "createTeamContainers", "createExternalTeam", "getProfileWithMutability", "getIsSiteAdmin", "addUsersToTeam", "removeTeamMemberships", "getRecommendedProducts", "joinOrRequestDefaultAccessToProductsBulk", "getReadMediaToken", "getWriteUserMediaToken", "updateUserHeaderImage", "getWriteTeamMediaToken", "getSoftDeletedTeamById", "restoreTeam", "getUserInSiteUserBase", "getLinkedTeamsBulk", "getTeamProfileDetails", "getUserContainers", "getPermissions", "getUserManageConfig", "getMyAvatarUploadedStatus", "deleteUserAvatar", "getTeamLinkIcons", "getTeamInSlack", "getOrgScope", "restoreTeamToSyncedGroup", "getTeamAndGroupDiff", "linkExistingTeamToGroup", "fetchUserAvatarInfo", "getOrgEligibilityForManagedTeams", "updateUser", "updateUserAvatar", "disconnectTeamInSlack", "updateTeamInSlack", "getUserTenure", "getAriFromUrl", "getWebLinkTitle", "addAgentToTeam", "getTeamEnabledSites", "assignTeamsToSites", "removeAgentTeamAssociation", "getAssignedTeams", "setTeamSiteAssignmentPermission", "getUnassignedTeams", "getTeamSiteAssignmentOrgDetails", "getTeamsToBeClonedToJsmSites", "getReportingLines"];
|
|
3
3
|
export type TeamsClientExperienceKeys = (typeof TeamsClientExperienceKeyList)[number];
|
|
4
|
-
export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "addAgentToTeam" | "removeAgentTeamAssociation" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamSiteAssignmentOrgDetails" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "archiveTeam" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
|
|
4
|
+
export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "addAgentToTeam" | "removeAgentTeamAssociation" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamSiteAssignmentOrgDetails" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "archiveTeam" | "unarchiveTeam" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
|
|
5
5
|
export {};
|
|
@@ -3,7 +3,7 @@ import { type AlignmentPermission, type AssignedTeamsResponse, type AssignTeamsT
|
|
|
3
3
|
import { type ApiTeamContainerCreationPayload, type ApiTeamContainerResponse } from '../../types/team-container';
|
|
4
4
|
import { type UserInSiteUserbase } from '../../types/user';
|
|
5
5
|
import { RestClient } from '../rest-client';
|
|
6
|
-
import { type LegionAssociateAgentResponse, type LegionLinkResponseV3, type LegionLinkResponseV4, type LegionPaginatedResponse, type LegionTeamAndGroupDifferenceResponse, type OrgAlignmentStatus } from './types';
|
|
6
|
+
import { type LegionAssociateAgentResponse, type LegionLinkResponseV3, type LegionLinkResponseV4, type LegionPaginatedResponse, type LegionTeamAndGroupDifferenceResponse, type OrgAlignmentStatus, type TeamStatesInBulkResponse } from './types';
|
|
7
7
|
export interface PaginationResult<T> {
|
|
8
8
|
entities: T[];
|
|
9
9
|
}
|
|
@@ -89,6 +89,7 @@ export interface LegionClient {
|
|
|
89
89
|
revokeTeamInvite(teamId: string, memberId: string): Promise<TeamMembership>;
|
|
90
90
|
deleteTeam(teamId: string): Promise<void>;
|
|
91
91
|
archiveTeam(teamId: string): Promise<void>;
|
|
92
|
+
unArchiveTeam(teamId: string): Promise<void>;
|
|
92
93
|
isSingleFullMemberTeam(teamId: string): Promise<boolean>;
|
|
93
94
|
createTeam(displayName: string, originQuery: OriginQuery, members?: string[], membershipSettings?: TeamMembershipSettings): Promise<Team>;
|
|
94
95
|
createExternalTeam(description: string, externalReference: ExternalReference, teamName?: string, siteId?: string): Promise<Team>;
|
|
@@ -96,7 +97,7 @@ export interface LegionClient {
|
|
|
96
97
|
canSearchUsers: boolean;
|
|
97
98
|
}>;
|
|
98
99
|
getLinkedTeamsBulk(groupIds: string[]): Promise<LinkedTeamsBulkResponse>;
|
|
99
|
-
getTeamProfileDetails(teamId: string): Promise<LinkedTeamsProfileDetails>;
|
|
100
|
+
getTeamProfileDetails(teamId: string, siteId?: string): Promise<LinkedTeamsProfileDetails>;
|
|
100
101
|
getOrgScope(): Promise<OrgScope>;
|
|
101
102
|
getPermissions(): Promise<TeamsPermissionFromApi>;
|
|
102
103
|
restoreTeamToSyncedGroup(teamId: string, externalReference: ExternalReference): Promise<void>;
|
|
@@ -111,6 +112,7 @@ export interface LegionClient {
|
|
|
111
112
|
getUnassignedTeams(orgId: string, count: number, cursor?: string | null, query?: string | null): Promise<UnassignedTeamsResponse>;
|
|
112
113
|
getTeamSiteAssignmentOrgDetails(): Promise<TeamSiteAssignmentOrgDetailsResponse>;
|
|
113
114
|
checkOrgFullAlignmentStatus(orgId: string): Promise<OrgAlignmentStatus>;
|
|
115
|
+
getTeamStatesInBulk(orgId: string, teamIds: string[]): Promise<TeamStatesInBulkResponse>;
|
|
114
116
|
}
|
|
115
117
|
/**
|
|
116
118
|
* REST Client to make calls to Legion.
|
|
@@ -118,3 +118,10 @@ export interface OrgAlignmentStatus {
|
|
|
118
118
|
orgId: string;
|
|
119
119
|
scopeAligned: boolean;
|
|
120
120
|
}
|
|
121
|
+
export interface TeamStateEntry {
|
|
122
|
+
teamId: string;
|
|
123
|
+
state: TeamState;
|
|
124
|
+
}
|
|
125
|
+
export interface TeamStatesInBulkResponse {
|
|
126
|
+
teamStates: TeamStateEntry[];
|
|
127
|
+
}
|
|
@@ -197,6 +197,10 @@ export declare class TeamsClient {
|
|
|
197
197
|
* Archive a team
|
|
198
198
|
*/
|
|
199
199
|
archiveTeam(teamId: string): Promise<void>;
|
|
200
|
+
/**
|
|
201
|
+
* Unarchive a team
|
|
202
|
+
*/
|
|
203
|
+
unarchiveTeam(teamId: string): Promise<void>;
|
|
200
204
|
/**
|
|
201
205
|
* @private
|
|
202
206
|
* @deprecated should be other means to solve this issue
|
|
@@ -396,6 +400,7 @@ export declare class TeamsClient {
|
|
|
396
400
|
deleteHelpPointer(...args: Parameters<typeof teamCentralClient.deleteHelpPointer>): Promise<AwaitedReturn<typeof teamCentralClient.deleteHelpPointer>>;
|
|
397
401
|
getUserTenure(...args: Parameters<typeof replinesClient.getUserTenure>): Promise<AwaitedReturn<typeof replinesClient.getUserTenure>>;
|
|
398
402
|
checkOrgFullAlignmentStatus(...args: Parameters<typeof defaultLegionClient.checkOrgFullAlignmentStatus>): Promise<AwaitedReturn<typeof defaultLegionClient.checkOrgFullAlignmentStatus>>;
|
|
403
|
+
getTeamStatesInBulk(...args: Parameters<typeof defaultLegionClient.getTeamStatesInBulk>): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamStatesInBulk>>;
|
|
399
404
|
getReportingLines(...args: Parameters<typeof reportingLinesClient.getReportingLines>): Promise<AwaitedReturn<typeof reportingLinesClient.getReportingLines>>;
|
|
400
405
|
}
|
|
401
406
|
export declare const teamsClient: TeamsClient;
|
|
@@ -184,7 +184,7 @@ export interface UnassignedTeam {
|
|
|
184
184
|
}
|
|
185
185
|
export interface UnassignedTeamsResponse {
|
|
186
186
|
teams: UnassignedTeam[];
|
|
187
|
-
cursor: string;
|
|
187
|
+
cursor: string | null;
|
|
188
188
|
}
|
|
189
189
|
export type AlignmentPermission = 'ALL_USERS' | 'ORG_ADMIN';
|
|
190
190
|
export interface TeamSiteAssignmentOrgDetailsResponse {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission } from '../../../types/team';
|
|
1
|
+
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission, type TeamState } from '../../../types/team';
|
|
2
2
|
import { type TeamAction } from './types';
|
|
3
3
|
export type PermissionMap = Required<Record<TeamAction, boolean>>;
|
|
4
|
-
export declare const allPermissions: (defaultPermission: boolean, isMember: boolean) => PermissionMap;
|
|
4
|
+
export declare const allPermissions: (defaultPermission: boolean, isMember: boolean, isOrgAdmin: boolean) => PermissionMap;
|
|
5
5
|
export declare const vanityActions: TeamAction[];
|
|
6
6
|
export declare const openPermissions: (permission: TeamPermission | undefined) => {
|
|
7
7
|
JOIN_TEAM: boolean;
|
|
@@ -20,4 +20,4 @@ export declare const SCIMSyncTeamPermissions: (isMember: boolean, isOrgAdmin: bo
|
|
|
20
20
|
EDIT_TEAM_LINK: boolean;
|
|
21
21
|
EDIT_TEAM_NAME: boolean;
|
|
22
22
|
};
|
|
23
|
-
export declare const getPermissionMap: (settings: TeamMembershipSettings, permission: TeamPermission | undefined, isMember: boolean, isOrgAdmin: boolean, source?: ExternalReferenceSource) => PermissionMap;
|
|
23
|
+
export declare const getPermissionMap: (settings: TeamMembershipSettings, permission: TeamPermission | undefined, isMember: boolean, isOrgAdmin: boolean, source?: ExternalReferenceSource, state?: TeamState) => PermissionMap;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type TeamMembership } from '../../../types/membership';
|
|
2
|
-
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission } from '../../../types/team';
|
|
2
|
+
import { type ExternalReferenceSource, type TeamMembershipSettings, type TeamPermission, type TeamState } from '../../../types/team';
|
|
3
3
|
import { type TeamAction, type TeamPermissions } from './types';
|
|
4
|
-
export declare function hasPermission(action: TeamAction, settings: TeamMembershipSettings, permission: TeamPermission | undefined, isPeopleBrowseEnabled: boolean, currentUserMembership: TeamMembership | undefined, teamVisibilityPermissions?: TeamPermissions, source?: ExternalReferenceSource): boolean;
|
|
4
|
+
export declare function hasPermission(action: TeamAction, settings: TeamMembershipSettings, permission: TeamPermission | undefined, isPeopleBrowseEnabled: boolean, currentUserMembership: TeamMembership | undefined, teamVisibilityPermissions?: TeamPermissions, source?: ExternalReferenceSource, state?: TeamState): boolean;
|
|
5
5
|
type PermissionOptions = {
|
|
6
6
|
/**
|
|
7
7
|
* The teams membership settings, "OPEN" | "MEMBER_INVITE" | "EXTERNAL"
|
|
@@ -23,6 +23,7 @@ type PermissionOptions = {
|
|
|
23
23
|
* External source(if any) "ATLASSIAN_GROUP" | "HRIS"
|
|
24
24
|
*/
|
|
25
25
|
source?: ExternalReferenceSource;
|
|
26
|
+
state?: TeamState;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
29
|
* Determines if a user has permission perform a given action on a team
|
|
@@ -16,8 +16,10 @@ export declare const AllTeamActions: readonly [
|
|
|
16
16
|
"EDIT_TEAM_LINK",
|
|
17
17
|
"EDIT_TEAM_SETTINGS",
|
|
18
18
|
"EDIT_TEAM_MEMBERSHIP",
|
|
19
|
+
"EDIT_TEAM_TYPE",
|
|
19
20
|
"DELETE_TEAM",
|
|
20
|
-
"ARCHIVE_TEAM"
|
|
21
|
+
"ARCHIVE_TEAM",
|
|
22
|
+
"UNARCHIVE_TEAM"
|
|
21
23
|
];
|
|
22
24
|
export type TeamAction = (typeof AllTeamActions)[number];
|
|
23
25
|
export type TeamPermissions = {
|
|
@@ -24,6 +24,7 @@ declare const TeamsClientExperienceKeyList: readonly [
|
|
|
24
24
|
"revokeTeamInvite",
|
|
25
25
|
"deleteTeam",
|
|
26
26
|
"archiveTeam",
|
|
27
|
+
"unarchiveTeam",
|
|
27
28
|
"isSingleFullMemberTeam",
|
|
28
29
|
"createTeam",
|
|
29
30
|
"createTeamContainers",
|
|
@@ -75,5 +76,5 @@ declare const TeamsClientExperienceKeyList: readonly [
|
|
|
75
76
|
"getReportingLines"
|
|
76
77
|
];
|
|
77
78
|
export type TeamsClientExperienceKeys = (typeof TeamsClientExperienceKeyList)[number];
|
|
78
|
-
export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "addAgentToTeam" | "removeAgentTeamAssociation" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamSiteAssignmentOrgDetails" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "archiveTeam" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
|
|
79
|
+
export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "addAgentToTeam" | "removeAgentTeamAssociation" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamSiteAssignmentOrgDetails" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "archiveTeam" | "unarchiveTeam" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
|
|
79
80
|
export {};
|
|
@@ -3,7 +3,7 @@ import { type AlignmentPermission, type AssignedTeamsResponse, type AssignTeamsT
|
|
|
3
3
|
import { type ApiTeamContainerCreationPayload, type ApiTeamContainerResponse } from '../../types/team-container';
|
|
4
4
|
import { type UserInSiteUserbase } from '../../types/user';
|
|
5
5
|
import { RestClient } from '../rest-client';
|
|
6
|
-
import { type LegionAssociateAgentResponse, type LegionLinkResponseV3, type LegionLinkResponseV4, type LegionPaginatedResponse, type LegionTeamAndGroupDifferenceResponse, type OrgAlignmentStatus } from './types';
|
|
6
|
+
import { type LegionAssociateAgentResponse, type LegionLinkResponseV3, type LegionLinkResponseV4, type LegionPaginatedResponse, type LegionTeamAndGroupDifferenceResponse, type OrgAlignmentStatus, type TeamStatesInBulkResponse } from './types';
|
|
7
7
|
export interface PaginationResult<T> {
|
|
8
8
|
entities: T[];
|
|
9
9
|
}
|
|
@@ -89,6 +89,7 @@ export interface LegionClient {
|
|
|
89
89
|
revokeTeamInvite(teamId: string, memberId: string): Promise<TeamMembership>;
|
|
90
90
|
deleteTeam(teamId: string): Promise<void>;
|
|
91
91
|
archiveTeam(teamId: string): Promise<void>;
|
|
92
|
+
unArchiveTeam(teamId: string): Promise<void>;
|
|
92
93
|
isSingleFullMemberTeam(teamId: string): Promise<boolean>;
|
|
93
94
|
createTeam(displayName: string, originQuery: OriginQuery, members?: string[], membershipSettings?: TeamMembershipSettings): Promise<Team>;
|
|
94
95
|
createExternalTeam(description: string, externalReference: ExternalReference, teamName?: string, siteId?: string): Promise<Team>;
|
|
@@ -96,7 +97,7 @@ export interface LegionClient {
|
|
|
96
97
|
canSearchUsers: boolean;
|
|
97
98
|
}>;
|
|
98
99
|
getLinkedTeamsBulk(groupIds: string[]): Promise<LinkedTeamsBulkResponse>;
|
|
99
|
-
getTeamProfileDetails(teamId: string): Promise<LinkedTeamsProfileDetails>;
|
|
100
|
+
getTeamProfileDetails(teamId: string, siteId?: string): Promise<LinkedTeamsProfileDetails>;
|
|
100
101
|
getOrgScope(): Promise<OrgScope>;
|
|
101
102
|
getPermissions(): Promise<TeamsPermissionFromApi>;
|
|
102
103
|
restoreTeamToSyncedGroup(teamId: string, externalReference: ExternalReference): Promise<void>;
|
|
@@ -111,6 +112,7 @@ export interface LegionClient {
|
|
|
111
112
|
getUnassignedTeams(orgId: string, count: number, cursor?: string | null, query?: string | null): Promise<UnassignedTeamsResponse>;
|
|
112
113
|
getTeamSiteAssignmentOrgDetails(): Promise<TeamSiteAssignmentOrgDetailsResponse>;
|
|
113
114
|
checkOrgFullAlignmentStatus(orgId: string): Promise<OrgAlignmentStatus>;
|
|
115
|
+
getTeamStatesInBulk(orgId: string, teamIds: string[]): Promise<TeamStatesInBulkResponse>;
|
|
114
116
|
}
|
|
115
117
|
/**
|
|
116
118
|
* REST Client to make calls to Legion.
|
|
@@ -118,3 +118,10 @@ export interface OrgAlignmentStatus {
|
|
|
118
118
|
orgId: string;
|
|
119
119
|
scopeAligned: boolean;
|
|
120
120
|
}
|
|
121
|
+
export interface TeamStateEntry {
|
|
122
|
+
teamId: string;
|
|
123
|
+
state: TeamState;
|
|
124
|
+
}
|
|
125
|
+
export interface TeamStatesInBulkResponse {
|
|
126
|
+
teamStates: TeamStateEntry[];
|
|
127
|
+
}
|
|
@@ -197,6 +197,10 @@ export declare class TeamsClient {
|
|
|
197
197
|
* Archive a team
|
|
198
198
|
*/
|
|
199
199
|
archiveTeam(teamId: string): Promise<void>;
|
|
200
|
+
/**
|
|
201
|
+
* Unarchive a team
|
|
202
|
+
*/
|
|
203
|
+
unarchiveTeam(teamId: string): Promise<void>;
|
|
200
204
|
/**
|
|
201
205
|
* @private
|
|
202
206
|
* @deprecated should be other means to solve this issue
|
|
@@ -396,6 +400,7 @@ export declare class TeamsClient {
|
|
|
396
400
|
deleteHelpPointer(...args: Parameters<typeof teamCentralClient.deleteHelpPointer>): Promise<AwaitedReturn<typeof teamCentralClient.deleteHelpPointer>>;
|
|
397
401
|
getUserTenure(...args: Parameters<typeof replinesClient.getUserTenure>): Promise<AwaitedReturn<typeof replinesClient.getUserTenure>>;
|
|
398
402
|
checkOrgFullAlignmentStatus(...args: Parameters<typeof defaultLegionClient.checkOrgFullAlignmentStatus>): Promise<AwaitedReturn<typeof defaultLegionClient.checkOrgFullAlignmentStatus>>;
|
|
403
|
+
getTeamStatesInBulk(...args: Parameters<typeof defaultLegionClient.getTeamStatesInBulk>): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamStatesInBulk>>;
|
|
399
404
|
getReportingLines(...args: Parameters<typeof reportingLinesClient.getReportingLines>): Promise<AwaitedReturn<typeof reportingLinesClient.getReportingLines>>;
|
|
400
405
|
}
|
|
401
406
|
export declare const teamsClient: TeamsClient;
|
|
@@ -184,7 +184,7 @@ export interface UnassignedTeam {
|
|
|
184
184
|
}
|
|
185
185
|
export interface UnassignedTeamsResponse {
|
|
186
186
|
teams: UnassignedTeam[];
|
|
187
|
-
cursor: string;
|
|
187
|
+
cursor: string | null;
|
|
188
188
|
}
|
|
189
189
|
export type AlignmentPermission = 'ALL_USERS' | 'ORG_ADMIN';
|
|
190
190
|
export interface TeamSiteAssignmentOrgDetailsResponse {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/teams-client",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.22.0",
|
|
4
4
|
"description": "A client to retrieve team related data",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -98,9 +98,6 @@
|
|
|
98
98
|
"fix_query_settings_context": {
|
|
99
99
|
"type": "boolean"
|
|
100
100
|
},
|
|
101
|
-
"enable_new_team_profile": {
|
|
102
|
-
"type": "boolean"
|
|
103
|
-
},
|
|
104
101
|
"legion-enable-archive-teams": {
|
|
105
102
|
"type": "boolean"
|
|
106
103
|
}
|