@atlaskit/teams-client 4.3.0 → 4.5.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.
Files changed (32) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/common/utils/ufo/constants.js +1 -1
  3. package/dist/cjs/common/utils/ufo/index.js +2 -2
  4. package/dist/cjs/services/legion-client/index.js +7 -2
  5. package/dist/cjs/services/main.js +144 -110
  6. package/dist/cjs/services/object-resolver-client/index.js +24 -0
  7. package/dist/cjs/services/sentry/utils/get-sentry-config.js +1 -1
  8. package/dist/es2019/common/utils/ufo/constants.js +1 -1
  9. package/dist/es2019/common/utils/ufo/index.js +2 -2
  10. package/dist/es2019/services/legion-client/index.js +7 -1
  11. package/dist/es2019/services/main.js +7 -0
  12. package/dist/es2019/services/object-resolver-client/index.js +8 -0
  13. package/dist/es2019/services/sentry/utils/get-sentry-config.js +1 -1
  14. package/dist/esm/common/utils/ufo/constants.js +1 -1
  15. package/dist/esm/common/utils/ufo/index.js +2 -2
  16. package/dist/esm/services/legion-client/index.js +7 -2
  17. package/dist/esm/services/main.js +144 -110
  18. package/dist/esm/services/object-resolver-client/index.js +24 -0
  19. package/dist/esm/services/sentry/utils/get-sentry-config.js +1 -1
  20. package/dist/types/common/utils/ufo/constants.d.ts +2 -2
  21. package/dist/types/services/legion-client/types.d.ts +2 -1
  22. package/dist/types/services/main.d.ts +4 -0
  23. package/dist/types/services/object-resolver-client/index.d.ts +1 -0
  24. package/dist/types/services/object-resolver-client/types.d.ts +15 -0
  25. package/dist/types/types/team.d.ts +6 -1
  26. package/dist/types-ts4.5/common/utils/ufo/constants.d.ts +3 -2
  27. package/dist/types-ts4.5/services/legion-client/types.d.ts +2 -1
  28. package/dist/types-ts4.5/services/main.d.ts +4 -0
  29. package/dist/types-ts4.5/services/object-resolver-client/index.d.ts +1 -0
  30. package/dist/types-ts4.5/services/object-resolver-client/types.d.ts +15 -0
  31. package/dist/types-ts4.5/types/team.d.ts +6 -1
  32. package/package.json +1 -1
@@ -1,5 +1,5 @@
1
1
  import { type TeamMembership } from '../../types/membership';
2
- import { type ScopeMode, type TeamDiscoverability, type TeamMembershipSettings, type TeamPermission, type TeamRestriction, type TeamState } from '../../types/team';
2
+ import { ExternalReference, type ScopeMode, type TeamDiscoverability, type TeamMembershipSettings, type TeamPermission, type TeamRestriction, type TeamState } from '../../types/team';
3
3
  export interface LegionTeamImagesResponse {
4
4
  smallHeaderImageUrl: string;
5
5
  largeHeaderImageUrl: string;
@@ -38,6 +38,7 @@ export interface LegionTeamBaseResponseV4 {
38
38
  permission?: TeamPermission;
39
39
  scopeMode: ScopeMode;
40
40
  isVerified?: boolean;
41
+ externalReference?: ExternalReference;
41
42
  }
42
43
  export type LegionTeamGetResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamImagesResponse>;
43
44
  export type LegionTeamCreateResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamMembershipResponse>;
@@ -303,6 +303,10 @@ export declare class TeamsClient {
303
303
  * Fetch Team link icons
304
304
  */
305
305
  getTeamLinkIcons(...args: Parameters<typeof objectResolverClient.getTeamLinkIcons>): Promise<AwaitedReturn<typeof objectResolverClient.getTeamLinkIcons>>;
306
+ /**
307
+ * Fetch ARI from URL
308
+ */
309
+ getAriFromUrl(...args: Parameters<typeof objectResolverClient.getAriFromUrl>): Promise<AwaitedReturn<typeof objectResolverClient.getAriFromUrl>>;
306
310
  /**
307
311
  * Fetch team in slack details
308
312
  */
@@ -3,6 +3,7 @@ import { type LinkIconData } from './types';
3
3
  export declare class ObjectResolverClient extends RestClient {
4
4
  constructor(config?: {});
5
5
  getTeamLinkIcons(teamLinkUrls: string[]): Promise<LinkIconData[]>;
6
+ getAriFromUrl(url: string): Promise<string | undefined>;
6
7
  }
7
8
  declare const _default: ObjectResolverClient;
8
9
  export default _default;
@@ -36,3 +36,18 @@ export interface IconItemFailure {
36
36
  };
37
37
  status: number;
38
38
  }
39
+ export type GetAriFromUrlErrorType = 'AuthError' | 'UnsupportedError' | 'TimeoutError' | 'InternalServerError';
40
+ export interface GetAriFromUrlResponse {
41
+ meta: Record<string, unknown>;
42
+ data: {
43
+ ari: string;
44
+ url: string;
45
+ };
46
+ }
47
+ export interface GetAriFromUrlError {
48
+ error: {
49
+ type: GetAriFromUrlErrorType;
50
+ message: string;
51
+ status: number;
52
+ };
53
+ }
@@ -60,6 +60,10 @@ export interface Team {
60
60
  orgId?: string;
61
61
  scopeMode?: ScopeMode;
62
62
  isVerified?: boolean;
63
+ externalReference?: {
64
+ id: string;
65
+ source: ExternalReferenceSource;
66
+ };
63
67
  }
64
68
  /**
65
69
  * @type TeamWithImageUrls
@@ -84,11 +88,12 @@ export interface SoftDeletedTeam {
84
88
  * @property {string} id - Group ID of source
85
89
  */
86
90
  export interface ExternalReference {
87
- source: string;
91
+ source: ExternalReferenceSource;
88
92
  id: string;
89
93
  displayName?: string;
90
94
  syncTeamName?: boolean;
91
95
  }
96
+ export type ExternalReferenceSource = 'ATLASSIAN_GROUP' | 'HRIS';
92
97
  export type TeamsPermissionApi = 'CAN_CREATE_TEAMS' | 'CAN_VIEW_TEAMS' | 'CAN_ADMIN_TEAMS';
93
98
  /**
94
99
  * @type TeamsPermissionFromApi
@@ -59,8 +59,9 @@ declare const TeamsClientExperienceKeyList: readonly [
59
59
  "updateUserAvatar",
60
60
  "disconnectTeamInSlack",
61
61
  "updateTeamInSlack",
62
- "getUserTenure"
62
+ "getUserTenure",
63
+ "getAriFromUrl"
63
64
  ];
64
65
  export type TeamsClientExperienceKeys = (typeof TeamsClientExperienceKeyList)[number];
65
- export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "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", TeamsUFOExperience>;
66
+ export declare const TEAMS_CLIENT_EXPERIENCES: Map<"getAllTeams" | "getOrgEligibilityForManagedTeams" | "createTeam" | "getPermissions" | "getLinkedTeamsBulk" | "getTeamProfileDetails" | "getOrgScope" | "getTeamById" | "updateTeamById" | "querySettings" | "queryFeatureFlags" | "queryTeamMemberships" | "queryUser" | "inviteUsersToTeam" | "getMyTeamMembership" | "getTeamLinksByTeamId" | "createTeamLink" | "updateTeamLink" | "deleteTeamLink" | "reorderTeamLink" | "acceptTeamInvitation" | "declineTeamInvitation" | "selfJoinTeam" | "cancelJoinRequest" | "acceptJoinRequest" | "declineJoinRequest" | "deleteTeamMembership" | "revokeTeamInvite" | "deleteTeam" | "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", TeamsUFOExperience>;
66
67
  export {};
@@ -1,5 +1,5 @@
1
1
  import { type TeamMembership } from '../../types/membership';
2
- import { type ScopeMode, type TeamDiscoverability, type TeamMembershipSettings, type TeamPermission, type TeamRestriction, type TeamState } from '../../types/team';
2
+ import { ExternalReference, type ScopeMode, type TeamDiscoverability, type TeamMembershipSettings, type TeamPermission, type TeamRestriction, type TeamState } from '../../types/team';
3
3
  export interface LegionTeamImagesResponse {
4
4
  smallHeaderImageUrl: string;
5
5
  largeHeaderImageUrl: string;
@@ -38,6 +38,7 @@ export interface LegionTeamBaseResponseV4 {
38
38
  permission?: TeamPermission;
39
39
  scopeMode: ScopeMode;
40
40
  isVerified?: boolean;
41
+ externalReference?: ExternalReference;
41
42
  }
42
43
  export type LegionTeamGetResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamImagesResponse>;
43
44
  export type LegionTeamCreateResponseV4 = LegionTeamBaseResponseV4 & Required<LegionTeamMembershipResponse>;
@@ -303,6 +303,10 @@ export declare class TeamsClient {
303
303
  * Fetch Team link icons
304
304
  */
305
305
  getTeamLinkIcons(...args: Parameters<typeof objectResolverClient.getTeamLinkIcons>): Promise<AwaitedReturn<typeof objectResolverClient.getTeamLinkIcons>>;
306
+ /**
307
+ * Fetch ARI from URL
308
+ */
309
+ getAriFromUrl(...args: Parameters<typeof objectResolverClient.getAriFromUrl>): Promise<AwaitedReturn<typeof objectResolverClient.getAriFromUrl>>;
306
310
  /**
307
311
  * Fetch team in slack details
308
312
  */
@@ -3,6 +3,7 @@ import { type LinkIconData } from './types';
3
3
  export declare class ObjectResolverClient extends RestClient {
4
4
  constructor(config?: {});
5
5
  getTeamLinkIcons(teamLinkUrls: string[]): Promise<LinkIconData[]>;
6
+ getAriFromUrl(url: string): Promise<string | undefined>;
6
7
  }
7
8
  declare const _default: ObjectResolverClient;
8
9
  export default _default;
@@ -36,3 +36,18 @@ export interface IconItemFailure {
36
36
  };
37
37
  status: number;
38
38
  }
39
+ export type GetAriFromUrlErrorType = 'AuthError' | 'UnsupportedError' | 'TimeoutError' | 'InternalServerError';
40
+ export interface GetAriFromUrlResponse {
41
+ meta: Record<string, unknown>;
42
+ data: {
43
+ ari: string;
44
+ url: string;
45
+ };
46
+ }
47
+ export interface GetAriFromUrlError {
48
+ error: {
49
+ type: GetAriFromUrlErrorType;
50
+ message: string;
51
+ status: number;
52
+ };
53
+ }
@@ -60,6 +60,10 @@ export interface Team {
60
60
  orgId?: string;
61
61
  scopeMode?: ScopeMode;
62
62
  isVerified?: boolean;
63
+ externalReference?: {
64
+ id: string;
65
+ source: ExternalReferenceSource;
66
+ };
63
67
  }
64
68
  /**
65
69
  * @type TeamWithImageUrls
@@ -84,11 +88,12 @@ export interface SoftDeletedTeam {
84
88
  * @property {string} id - Group ID of source
85
89
  */
86
90
  export interface ExternalReference {
87
- source: string;
91
+ source: ExternalReferenceSource;
88
92
  id: string;
89
93
  displayName?: string;
90
94
  syncTeamName?: boolean;
91
95
  }
96
+ export type ExternalReferenceSource = 'ATLASSIAN_GROUP' | 'HRIS';
92
97
  export type TeamsPermissionApi = 'CAN_CREATE_TEAMS' | 'CAN_VIEW_TEAMS' | 'CAN_ADMIN_TEAMS';
93
98
  /**
94
99
  * @type TeamsPermissionFromApi
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/teams-client",
3
- "version": "4.3.0",
3
+ "version": "4.5.0",
4
4
  "description": "A client to retrieve team related data",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",