@atlaskit/teams-client 4.25.0 → 4.27.0

package/dist/types/common/utils/ufo/constants.d.ts

@@ -1,5 +1,5 @@
 import { TeamsUFOExperience } from './index';
-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", "unlinkTeamFromGroup", "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"];
+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", "unlinkTeamFromGroup", "isSingleFullMemberTeam", "createTeam", "createTeamContainers", "createExternalTeam", "getProfileWithMutability", "getIsSiteAdmin", "addUsersToTeam", "removeTeamMemberships", "getRecommendedProducts", "joinOrRequestDefaultAccessToProductsBulk", "getReadMediaToken", "getWriteUserMediaToken", "updateUserHeaderImage", "getWriteTeamMediaToken", "getSoftDeletedTeamById", "restoreTeam", "getUserInSiteUserBase", "getLinkedTeamsBulk", "getTeamProfileDetails", "getUserContainers", "getRecommendedUsers", "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"];
 export type TeamsClientExperienceKeys = (typeof TeamsClientExperienceKeyList)[number];
-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" | "unlinkTeamFromGroup" | "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>;
+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" | "unlinkTeamFromGroup" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getRecommendedUsers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
 export {};

package/dist/types/services/agg-client/utils/query-context-headers.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Creates headers object with X-Query-Context header if cloudId is provided and feature flag is enabled.
+ * Use this for AGG client makeGraphQLRequest calls.
+ */
+export declare function createQueryContextHeaders(cloudId?: string): Record<string, string> | undefined;

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

@@ -6,6 +6,12 @@ export type UserContainerArgs = {
     sessionId: string;
     maxNumberOfResults: number;
 };
+export type RecommendedUsersArgs = {
+    accountId: string;
+    cloudId: string;
+    maxNumberOfResults?: number;
+    filter?: string;
+};
 declare enum CONTAINER_TYPE {
     JIRA_PROJECT = "jiraProject",
     CONFLUENCE_SPACE = "confluenceSpace"
@@ -30,8 +36,27 @@ type CollaborationGraphEntities = {
 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, }: RecommendedUsersArgs): Promise<RecommendedUsersResponse>;
 }
 declare const _default: CollaborationGraphClient;
 export default _default;

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

@@ -4,5 +4,9 @@ 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 feature flag is enabled.
+     */
+    private createQueryContextHeaders;
     makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;
 }

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

@@ -2,6 +2,7 @@ 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;

package/dist/types/services/main.d.ts

@@ -108,7 +108,7 @@ export declare class TeamsClient {
      * @param teamId
      * @returns {Promise<TeamWithImageUrls>}
      */
-    getTeamById(teamId: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
+    getTeamById(teamId: string, cloudId?: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
     /**
      * Search teams based on query
      */
@@ -351,6 +351,10 @@ export declare class TeamsClient {
      * Fetch user containers from collboration graph
      */
     getUserContainers(...args: Parameters<typeof collaborationGraphClient.getUserContainers>): Promise<AwaitedReturn<typeof collaborationGraphClient.getUserContainers>>;
+    /**
+     * Fetch recommended users from collaboration graph
+     */
+    getRecommendedUsers(...args: Parameters<typeof collaborationGraphClient.getRecommendedUsers>): Promise<AwaitedReturn<typeof collaborationGraphClient.getRecommendedUsers>>;
     /**
      * Fetch mutatability of external managed user fields
      */

package/dist/types-ts4.5/common/utils/ufo/constants.d.ts

@@ -46,6 +46,7 @@ declare const TeamsClientExperienceKeyList: readonly [
     "getLinkedTeamsBulk",
     "getTeamProfileDetails",
     "getUserContainers",
+    "getRecommendedUsers",
     "getPermissions",
     "getUserManageConfig",
     "getMyAvatarUploadedStatus",
@@ -77,5 +78,5 @@ declare const TeamsClientExperienceKeyList: readonly [
     "getReportingLines"
 ];
 export type TeamsClientExperienceKeys = (typeof TeamsClientExperienceKeyList)[number];
-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" | "unlinkTeamFromGroup" | "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>;
+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" | "unlinkTeamFromGroup" | "isSingleFullMemberTeam" | "createTeamContainers" | "createExternalTeam" | "getProfileWithMutability" | "getIsSiteAdmin" | "addUsersToTeam" | "removeTeamMemberships" | "getRecommendedProducts" | "joinOrRequestDefaultAccessToProductsBulk" | "getReadMediaToken" | "getWriteUserMediaToken" | "updateUserHeaderImage" | "getWriteTeamMediaToken" | "getSoftDeletedTeamById" | "restoreTeam" | "getUserInSiteUserBase" | "getUserContainers" | "getRecommendedUsers" | "getUserManageConfig" | "getMyAvatarUploadedStatus" | "deleteUserAvatar" | "getTeamLinkIcons" | "getTeamInSlack" | "restoreTeamToSyncedGroup" | "getTeamAndGroupDiff" | "linkExistingTeamToGroup" | "fetchUserAvatarInfo" | "updateUser" | "updateUserAvatar" | "disconnectTeamInSlack" | "updateTeamInSlack" | "getUserTenure" | "getAriFromUrl" | "getWebLinkTitle" | "getTeamEnabledSites" | "assignTeamsToSites" | "getAssignedTeams" | "setTeamSiteAssignmentPermission" | "getUnassignedTeams" | "getTeamsToBeClonedToJsmSites" | "getReportingLines", TeamsUFOExperience>;
 export {};

package/dist/types-ts4.5/services/agg-client/utils/query-context-headers.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Creates headers object with X-Query-Context header if cloudId is provided and feature flag is enabled.
+ * Use this for AGG client makeGraphQLRequest calls.
+ */
+export declare function createQueryContextHeaders(cloudId?: string): Record<string, string> | undefined;

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

@@ -6,6 +6,12 @@ export type UserContainerArgs = {
     sessionId: string;
     maxNumberOfResults: number;
 };
+export type RecommendedUsersArgs = {
+    accountId: string;
+    cloudId: string;
+    maxNumberOfResults?: number;
+    filter?: string;
+};
 declare enum CONTAINER_TYPE {
     JIRA_PROJECT = "jiraProject",
     CONFLUENCE_SPACE = "confluenceSpace"
@@ -30,8 +36,27 @@ type CollaborationGraphEntities = {
 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, }: RecommendedUsersArgs): Promise<RecommendedUsersResponse>;
 }
 declare const _default: CollaborationGraphClient;
 export default _default;

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

@@ -4,5 +4,9 @@ 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 feature flag is enabled.
+     */
+    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

@@ -2,6 +2,7 @@ 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;

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

@@ -108,7 +108,7 @@ export declare class TeamsClient {
      * @param teamId
      * @returns {Promise<TeamWithImageUrls>}
      */
-    getTeamById(teamId: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
+    getTeamById(teamId: string, cloudId?: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
     /**
      * Search teams based on query
      */
@@ -351,6 +351,10 @@ export declare class TeamsClient {
      * Fetch user containers from collboration graph
      */
     getUserContainers(...args: Parameters<typeof collaborationGraphClient.getUserContainers>): Promise<AwaitedReturn<typeof collaborationGraphClient.getUserContainers>>;
+    /**
+     * Fetch recommended users from collaboration graph
+     */
+    getRecommendedUsers(...args: Parameters<typeof collaborationGraphClient.getRecommendedUsers>): Promise<AwaitedReturn<typeof collaborationGraphClient.getRecommendedUsers>>;
     /**
      * Fetch mutatability of external managed user fields
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/teams-client",
-	"version": "4.25.0",
+	"version": "4.27.0",
 	"description": "A client to retrieve team related data",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -100,6 +100,9 @@
 		},
 		"legion-enable-archive-teams": {
 			"type": "boolean"
+		},
+		"enable_x_query_context_header": {
+			"type": "boolean"
 		}
 	}
 }