@atlaskit/teams-client 4.26.0 → 4.27.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/teams-client
 
+## 4.27.0
+
+### Minor Changes
+
+- [`0df25f7dfb6a2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0df25f7dfb6a2) -
+  Add X-Query-Context to UGS requests
+
 ## 4.26.0
 
 ### Minor Changes

package/dist/cjs/common/utils/ufo/constants.js

@@ -8,7 +8,7 @@ exports.TEAMS_CLIENT_EXPERIENCES = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _ufo = require("@atlaskit/ufo");
 var _index = require("./index");
-var TeamsClientExperienceKeyList = ['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'];
+var TeamsClientExperienceKeyList = ['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'];
 var TEAMS_CLIENT_EXPERIENCES = exports.TEAMS_CLIENT_EXPERIENCES = new Map((0, _toConsumableArray2.default)(TeamsClientExperienceKeyList.map(function (key) {
   return [key,
   // camelCase to kebab-case

package/dist/cjs/services/agg-client/utils/query-context-headers.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createQueryContextHeaders = createQueryContextHeaders;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+/**
+ * Creates headers object with X-Query-Context header if cloudId is provided and feature flag is enabled.
+ * Use this for AGG client makeGraphQLRequest calls.
+ */
+function createQueryContextHeaders(cloudId) {
+  if (!cloudId || !(0, _platformFeatureFlags.fg)('enable_x_query_context_header')) {
+    return undefined;
+  }
+  return {
+    'X-Query-Context': "ari:cloud:platform::site/".concat(cloudId)
+  };
+}

package/dist/cjs/services/collaborationgraph-client/index.js

@@ -51,6 +51,30 @@ var CollaborationGraphClient = exports.CollaborationGraphClient = /*#__PURE__*/f
         expanded: true
       });
     }
+  }, {
+    key: "getRecommendedUsers",
+    value: function getRecommendedUsers(_ref2) {
+      var accountId = _ref2.accountId,
+        cloudId = _ref2.cloudId,
+        _ref2$maxNumberOfResu = _ref2.maxNumberOfResults,
+        maxNumberOfResults = _ref2$maxNumberOfResu === void 0 ? 12 : _ref2$maxNumberOfResu,
+        _ref2$filter = _ref2.filter,
+        filter = _ref2$filter === void 0 ? 'account_status:"active" AND (NOT email_domain:"connect.atlassian.com") AND (NOT account_type:"app")' : _ref2$filter;
+      return this.postResource('/v2/recommend/user', {
+        context: {
+          userId: accountId,
+          tenantId: cloudId
+        },
+        modelRequestParams: {
+          experience: 'CgUserNearbyUser',
+          caller: 'atlas'
+        },
+        requestingUserId: accountId,
+        expand: 'existing',
+        maxNumberOfResults: maxNumberOfResults,
+        filter: filter
+      });
+    }
   }]);
 }(_restClient.RestClient);
 var _default = exports.default = new CollaborationGraphClient({

package/dist/cjs/services/graphql-client/main.js

@@ -6,15 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.BaseGraphQlClient = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _error = require("../../common/utils/error");
 var _baseClient = require("../base-client");
 var _utils = require("./utils");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var BaseGraphQlClient = exports.BaseGraphQlClient = /*#__PURE__*/function (_BaseClient) {
@@ -31,34 +35,57 @@ var BaseGraphQlClient = exports.BaseGraphQlClient = /*#__PURE__*/function (_Base
     value: function setServiceUrl(serviceUrl) {
       this.serviceUrl = serviceUrl;
     }
+
+    /**
+     * Creates query context headers if cloudId is available and feature flag is enabled.
+     */
+  }, {
+    key: "createQueryContextHeaders",
+    value: function createQueryContextHeaders(cloudId) {
+      if (!cloudId || !(0, _platformFeatureFlags.fg)('enable_x_query_context_header')) {
+        return undefined;
+      }
+      return {
+        'X-Query-Context': "ari:cloud:platform::site/".concat(cloudId)
+      };
+    }
   }, {
     key: "makeGraphQLRequest",
     value: function () {
       var _makeGraphQLRequest = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(body) {
         var options,
+          cloudId,
+          queryContextHeaders,
+          mergedOptions,
           _args = arguments;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
               _context.prev = 1;
-              return _context.abrupt("return", (0, _utils.handleGraphQLRequest)(this.serviceUrl, body, options));
-            case 5:
-              _context.prev = 5;
+              // Automatically add X-Query-Context header if cloudId is available in context
+              cloudId = this.getCloudId();
+              queryContextHeaders = this.createQueryContextHeaders(cloudId); // Merge headers: query context headers first, then provided headers (provided headers take precedence)
+              mergedOptions = _objectSpread(_objectSpread({}, options), {}, {
+                headers: _objectSpread(_objectSpread({}, queryContextHeaders), options.headers)
+              });
+              return _context.abrupt("return", (0, _utils.handleGraphQLRequest)(this.serviceUrl, body, mergedOptions));
+            case 8:
+              _context.prev = 8;
               _context.t0 = _context["catch"](1);
               if (!(_context.t0 instanceof _error.GraphQLError)) {
-                _context.next = 9;
+                _context.next = 12;
                 break;
               }
               throw _context.t0;
-            case 9:
+            case 12:
               this.logException(_context.t0, 'UnknownError in GraphQLClient.makeGraphQLRequestWithoutRetries');
               throw new _error.DefaultError({});
-            case 11:
+            case 14:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[1, 5]]);
+        }, _callee, this, [[1, 8]]);
       }));
       function makeGraphQLRequest(_x) {
         return _makeGraphQLRequest.apply(this, arguments);

package/dist/cjs/services/graphql-client/utils/index.js

@@ -7,10 +7,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.handleGraphQLRequest = handleGraphQLRequest;
 exports.makeGraphQLRequestWithoutRetries = makeGraphQLRequestWithoutRetries;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _error = require("../../../common/utils/error");
 var _http = require("../../../common/utils/http");
 var _statusCodeHandlersProvider = require("../../../common/utils/status-code-handlers-provider");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function makeGraphQLRequestWithoutRetries(_x, _x2) {
   return _makeGraphQLRequestWithoutRetries.apply(this, arguments);
 }
@@ -33,9 +36,9 @@ function _makeGraphQLRequestWithoutRetries() {
           url = serviceUrl + operationNameQuery;
           request = fetch(url, {
             method: 'POST',
-            headers: new Headers({
+            headers: new Headers(_objectSpread({
               'Content-Type': 'application/json'
-            }),
+            }, options.headers || {})),
             credentials: 'include',
             body: JSON.stringify(body)
           }).then(function (res) {