@atlaskit/util-service-support 6.2.7 → 6.3.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/util-service-support
 
+## 6.3.1
+
+### Patch Changes
+
+- [#128616](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/128616)
+  [`6e9df3227a504`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6e9df3227a504) -
+  Improve type safety of requestServiceMultipart API
+
+## 6.3.0
+
+### Minor Changes
+
+- [#117306](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/117306)
+  [`d18a5954f7ca9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d18a5954f7ca9) -
+  Add utility function that supports multipart responses
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.2.7
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -5,9 +5,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  utils: true
+  utils: true,
+  multipartUtils: true
 };
-exports.utils = void 0;
+exports.utils = exports.multipartUtils = void 0;
 var _types = require("./types");
 Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -33,6 +34,8 @@ Object.keys(_serviceResources).forEach(function (key) {
   });
 });
 var serviceUtils = _interopRequireWildcard(require("./serviceUtils"));
+var multipartServiceUtils = _interopRequireWildcard(require("./multipartServiceUtils"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-var utils = exports.utils = serviceUtils;
+var utils = exports.utils = serviceUtils;
+var multipartUtils = exports.multipartUtils = multipartServiceUtils;

package/dist/cjs/multipartServiceUtils.js

@@ -0,0 +1,132 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.requestServiceMultipart = 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 _browser = require("meros/browser");
+var _types = require("./types");
+var _shared = require("./shared");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _featureFlagsAccessed = require("@atlaskit/react-ufo/feature-flags-accessed");
+var _experienceTraceIdContext = require("@atlaskit/react-ufo/experience-trace-id-context");
+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; }
+/** Copied from meros types, as there are difficulties with resolving the type in CI */
+
+/**
+ * Make a request that **may** result in an HTTP multipart response from the server.
+ * @returns an object with a parsed JSON body OR an object with the parts from
+ * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
+ */
+var _requestServiceMultipart = exports.requestServiceMultipart = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(serviceConfig) {
+    var options,
+      url,
+      securityProvider,
+      refreshedSecurityProvider,
+      path,
+      queryParams,
+      requestInit,
+      secOptions,
+      requestUrl,
+      headers,
+      credentials,
+      TRACING_HEADER_FOR_SERVICE_UTIL,
+      tracingHeaderEnabled,
+      tracingHeaders,
+      requestOptions,
+      fetchResponse,
+      parts,
+      _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] : _shared.defaultRequestServiceOptions;
+          url = serviceConfig.url, securityProvider = serviceConfig.securityProvider, refreshedSecurityProvider = serviceConfig.refreshedSecurityProvider;
+          path = options.path, queryParams = options.queryParams, requestInit = options.requestInit;
+          secOptions = securityProvider && securityProvider();
+          requestUrl = (0, _shared.buildUrl)(url, path, queryParams, secOptions);
+          headers = (0, _shared.buildHeaders)(secOptions, requestInit && requestInit.headers);
+          credentials = (0, _types.buildCredentials)(secOptions); // Get tracing headers from UFO
+          TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
+          tracingHeaderEnabled = (0, _platformFeatureFlags.fg)('platform_collab_provider_tracingheaders');
+          (0, _featureFlagsAccessed.addFeatureFlagAccessed)(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);
+          tracingHeaders = {};
+          if (tracingHeaderEnabled) {
+            tracingHeaders = (0, _experienceTraceIdContext.getActiveTraceHttpRequestHeaders)(url);
+          }
+          requestOptions = _objectSpread(_objectSpread({}, requestInit), {}, {
+            // populate headers mainly for the collab provider however
+            // other components which uses this util can get the header as well.
+            // Those tracing headers shall not incur any issues as long as backends handle them properly
+            headers: _objectSpread(_objectSpread({}, headers), tracingHeaders),
+            credentials: credentials
+          });
+          _context.next = 15;
+          return fetch(requestUrl, requestOptions);
+        case 15:
+          fetchResponse = _context.sent;
+          _context.next = 18;
+          return (0, _browser.meros)(fetchResponse);
+        case 18:
+          parts = _context.sent;
+          if (!(fetchResponse.ok && fetchResponse.status !== 204)) {
+            _context.next = 28;
+            break;
+          }
+          if (!(parts[Symbol.asyncIterator] < 'u')) {
+            _context.next = 22;
+            break;
+          }
+          return _context.abrupt("return", {
+            isMultipart: true,
+            parts: parts
+          });
+        case 22:
+          _context.next = 24;
+          return parts.json();
+        case 24:
+          _context.t0 = _context.sent;
+          return _context.abrupt("return", {
+            isMultipart: false,
+            body: _context.t0
+          });
+        case 28:
+          if (!(fetchResponse.status === 401 && refreshedSecurityProvider)) {
+            _context.next = 30;
+            break;
+          }
+          return _context.abrupt("return", refreshedSecurityProvider().then(function (newSecOptions) {
+            var retryServiceConfig = {
+              url: url,
+              securityProvider: function securityProvider() {
+                return newSecOptions;
+              }
+            };
+            return _requestServiceMultipart(retryServiceConfig, options);
+          }));
+        case 30:
+          return _context.abrupt("return", Promise.reject({
+            code: fetchResponse.status,
+            reason: fetchResponse.statusText
+          }));
+        case 31:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function requestServiceMultipart(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/dist/cjs/serviceUtils.js

@@ -10,74 +10,9 @@ var _experienceTraceIdContext = require("@atlaskit/react-ufo/experience-trace-id
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _featureFlagsAccessed = require("@atlaskit/react-ufo/feature-flags-accessed");
 var _types = require("./types");
+var _shared = require("./shared");
 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; }
-var defaultRequestServiceOptions = {};
-var buildUrl = function buildUrl(baseUrl) {
-  var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-  var queryParams = arguments.length > 2 ? arguments[2] : undefined;
-  var secOptions = arguments.length > 3 ? arguments[3] : undefined;
-  var searchParam = new URLSearchParams(
-  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
-  // Since we only care about search params it is fine to have any base url here.
-  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
-  baseUrl = baseUrl.split('?')[0];
-  if (queryParams) {
-    for (var key in queryParams) {
-      if ({}.hasOwnProperty.call(queryParams, key)) {
-        searchParam.append(key, queryParams[key]);
-      }
-    }
-  }
-  if (secOptions && secOptions.params) {
-    for (var _key in secOptions.params) {
-      if ({}.hasOwnProperty.call(secOptions.params, _key)) {
-        var values = secOptions.params[_key];
-        if (Array.isArray(values)) {
-          for (var i = 0; i < values.length; i++) {
-            searchParam.append(_key, values[i]);
-          }
-        } else {
-          searchParam.append(_key, values);
-        }
-      }
-    }
-  }
-  var separator = '';
-  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
-    separator = '/';
-  }
-  var params = searchParam.toString();
-  if (params) {
-    params = '?' + params;
-  }
-  return "".concat(baseUrl).concat(separator).concat(path).concat(params);
-};
-var addToHeaders = function addToHeaders(headers, keyValues) {
-  if (keyValues) {
-    for (var key in keyValues) {
-      if ({}.hasOwnProperty.call(keyValues, key)) {
-        var values = keyValues[key];
-        if (Array.isArray(values)) {
-          for (var i = 0; i < values.length; i++) {
-            headers[key] = values[i];
-          }
-        } else {
-          headers[key] = values;
-        }
-      }
-    }
-  }
-};
-var buildHeaders = function buildHeaders(secOptions, extraHeaders) {
-  var headers = {};
-  addToHeaders(headers, extraHeaders);
-  if (secOptions) {
-    addToHeaders(headers, secOptions.headers);
-  }
-  return headers;
-};
-
 /**
  * @returns Promise containing the json response
  */
@@ -85,17 +20,17 @@ var _requestService = exports.requestService = function requestService(serviceCo
   var url = serviceConfig.url,
     securityProvider = serviceConfig.securityProvider,
     refreshedSecurityProvider = serviceConfig.refreshedSecurityProvider;
-  var _ref = options || defaultRequestServiceOptions,
+  var _ref = options || _shared.defaultRequestServiceOptions,
     path = _ref.path,
     queryParams = _ref.queryParams,
     requestInit = _ref.requestInit;
   var secOptions = securityProvider && securityProvider();
-  var requestUrl = buildUrl(url, path, queryParams, secOptions);
-  var headers = buildHeaders(secOptions, requestInit && requestInit.headers);
+  var requestUrl = (0, _shared.buildUrl)(url, path, queryParams, secOptions);
+  var headers = (0, _shared.buildHeaders)(secOptions, requestInit && requestInit.headers);
   var credentials = (0, _types.buildCredentials)(secOptions);
   var ignoreResponsePayload = (options === null || options === void 0 ? void 0 : options.ignoreResponsePayload) || false;
 
-  //Get tracing headers from UFO
+  // Get tracing headers from UFO
   var TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
   var tracingHeaderEnabled = (0, _platformFeatureFlags.fg)('platform_collab_provider_tracingheaders');
   (0, _featureFlagsAccessed.addFeatureFlagAccessed)(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);

package/dist/cjs/shared.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultRequestServiceOptions = exports.buildUrl = exports.buildHeaders = void 0;
+var defaultRequestServiceOptions = exports.defaultRequestServiceOptions = {};
+var buildUrl = exports.buildUrl = function buildUrl(baseUrl) {
+  var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  var queryParams = arguments.length > 2 ? arguments[2] : undefined;
+  var secOptions = arguments.length > 3 ? arguments[3] : undefined;
+  var searchParam = new URLSearchParams(
+  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
+  // Since we only care about search params it is fine to have any base url here.
+  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
+  baseUrl = baseUrl.split('?')[0];
+  if (queryParams) {
+    for (var key in queryParams) {
+      if ({}.hasOwnProperty.call(queryParams, key)) {
+        searchParam.append(key, queryParams[key]);
+      }
+    }
+  }
+  if (secOptions && secOptions.params) {
+    for (var _key in secOptions.params) {
+      if ({}.hasOwnProperty.call(secOptions.params, _key)) {
+        var values = secOptions.params[_key];
+        if (Array.isArray(values)) {
+          for (var i = 0; i < values.length; i++) {
+            searchParam.append(_key, values[i]);
+          }
+        } else {
+          searchParam.append(_key, values);
+        }
+      }
+    }
+  }
+  var separator = '';
+  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
+    separator = '/';
+  }
+  var params = searchParam.toString();
+  if (params) {
+    params = '?' + params;
+  }
+  return "".concat(baseUrl).concat(separator).concat(path).concat(params);
+};
+var addToHeaders = function addToHeaders(headers, keyValues) {
+  if (keyValues) {
+    for (var key in keyValues) {
+      if ({}.hasOwnProperty.call(keyValues, key)) {
+        var values = keyValues[key];
+        if (Array.isArray(values)) {
+          for (var i = 0; i < values.length; i++) {
+            headers[key] = values[i];
+          }
+        } else {
+          headers[key] = values;
+        }
+      }
+    }
+  }
+};
+var buildHeaders = exports.buildHeaders = function buildHeaders(secOptions, extraHeaders) {
+  var headers = {};
+  addToHeaders(headers, extraHeaders);
+  if (secOptions) {
+    addToHeaders(headers, secOptions.headers);
+  }
+  return headers;
+};

package/dist/es2019/index.js

@@ -1,4 +1,6 @@
 export * from './types';
 export * from './serviceResources';
 import * as serviceUtils from './serviceUtils';
-export const utils = serviceUtils;
+import * as multipartServiceUtils from './multipartServiceUtils';
+export const utils = serviceUtils;
+export const multipartUtils = multipartServiceUtils;

package/dist/es2019/multipartServiceUtils.js

@@ -0,0 +1,87 @@
+import { meros } from 'meros/browser';
+import { buildCredentials } from './types';
+import { buildHeaders, buildUrl, defaultRequestServiceOptions } from './shared';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
+import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
+
+/** Copied from meros types, as there are difficulties with resolving the type in CI */
+
+/**
+ * Make a request that **may** result in an HTTP multipart response from the server.
+ * @returns an object with a parsed JSON body OR an object with the parts from
+ * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
+ */
+export const requestServiceMultipart = async (serviceConfig, options = defaultRequestServiceOptions) => {
+  const {
+    url,
+    securityProvider,
+    refreshedSecurityProvider
+  } = serviceConfig;
+  const {
+    path,
+    queryParams,
+    requestInit
+  } = options;
+  const secOptions = securityProvider && securityProvider();
+  const requestUrl = buildUrl(url, path, queryParams, secOptions);
+  const headers = buildHeaders(secOptions, requestInit && requestInit.headers);
+  const credentials = buildCredentials(secOptions);
+
+  // Get tracing headers from UFO
+  const TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
+  const tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
+  addFeatureFlagAccessed(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);
+  let tracingHeaders = {};
+  if (tracingHeaderEnabled) {
+    tracingHeaders = getActiveTraceHttpRequestHeaders(url);
+  }
+  const requestOptions = {
+    ...requestInit,
+    // populate headers mainly for the collab provider however
+    // other components which uses this util can get the header as well.
+    // Those tracing headers shall not incur any issues as long as backends handle them properly
+    headers: {
+      ...headers,
+      ...tracingHeaders
+    },
+    credentials
+  };
+  const fetchResponse = await fetch(requestUrl, requestOptions);
+  const parts = await meros(fetchResponse);
+  if (fetchResponse.ok && fetchResponse.status !== 204) {
+    if (parts[Symbol.asyncIterator] < 'u') {
+      // this lets us know that the response is multipart
+      //
+      // 	((parts as PartsGenerator)[Symbol.asyncIterator] as any) < 'u' came from the `meros` docs:
+      //	https://github.com/maraisr/meros/blob/dec4feaa24090b94e8ac42fab1aff38a1e521680/readme.md
+      // 	Look for expand section `If the content-type is NOT a multipart, then meros will resolve with the response argument.`
+      return {
+        isMultipart: true,
+        parts: parts
+      };
+    }
+    return {
+      isMultipart: false,
+      body: await parts.json()
+    };
+  } else if (fetchResponse.status === 401 && refreshedSecurityProvider) {
+    // auth issue - try once
+    return refreshedSecurityProvider().then(newSecOptions => {
+      const retryServiceConfig = {
+        url,
+        securityProvider: () => newSecOptions
+      };
+      return requestServiceMultipart(retryServiceConfig, options);
+    });
+  }
+  return Promise.reject({
+    code: fetchResponse.status,
+    reason: fetchResponse.statusText
+  });
+};

package/dist/es2019/serviceUtils.js

@@ -2,68 +2,7 @@ import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
 import { buildCredentials } from './types';
-const defaultRequestServiceOptions = {};
-const buildUrl = (baseUrl, path = '', queryParams, secOptions) => {
-  const searchParam = new URLSearchParams(
-  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
-  // Since we only care about search params it is fine to have any base url here.
-  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
-  baseUrl = baseUrl.split('?')[0];
-  if (queryParams) {
-    for (const key in queryParams) {
-      if ({}.hasOwnProperty.call(queryParams, key)) {
-        searchParam.append(key, queryParams[key]);
-      }
-    }
-  }
-  if (secOptions && secOptions.params) {
-    for (const key in secOptions.params) {
-      if ({}.hasOwnProperty.call(secOptions.params, key)) {
-        const values = secOptions.params[key];
-        if (Array.isArray(values)) {
-          for (let i = 0; i < values.length; i++) {
-            searchParam.append(key, values[i]);
-          }
-        } else {
-          searchParam.append(key, values);
-        }
-      }
-    }
-  }
-  let separator = '';
-  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
-    separator = '/';
-  }
-  let params = searchParam.toString();
-  if (params) {
-    params = '?' + params;
-  }
-  return `${baseUrl}${separator}${path}${params}`;
-};
-const addToHeaders = (headers, keyValues) => {
-  if (keyValues) {
-    for (const key in keyValues) {
-      if ({}.hasOwnProperty.call(keyValues, key)) {
-        const values = keyValues[key];
-        if (Array.isArray(values)) {
-          for (let i = 0; i < values.length; i++) {
-            headers[key] = values[i];
-          }
-        } else {
-          headers[key] = values;
-        }
-      }
-    }
-  }
-};
-const buildHeaders = (secOptions, extraHeaders) => {
-  const headers = {};
-  addToHeaders(headers, extraHeaders);
-  if (secOptions) {
-    addToHeaders(headers, secOptions.headers);
-  }
-  return headers;
-};
+import { defaultRequestServiceOptions, buildUrl, buildHeaders } from './shared';
 
 /**
  * @returns Promise containing the json response
@@ -85,7 +24,7 @@ export const requestService = (serviceConfig, options) => {
   const credentials = buildCredentials(secOptions);
   const ignoreResponsePayload = (options === null || options === void 0 ? void 0 : options.ignoreResponsePayload) || false;
 
-  //Get tracing headers from UFO
+  // Get tracing headers from UFO
   const TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
   const tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
   addFeatureFlagAccessed(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);

package/dist/es2019/shared.js

@@ -0,0 +1,62 @@
+export const defaultRequestServiceOptions = {};
+export const buildUrl = (baseUrl, path = '', queryParams, secOptions) => {
+  const searchParam = new URLSearchParams(
+  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
+  // Since we only care about search params it is fine to have any base url here.
+  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
+  baseUrl = baseUrl.split('?')[0];
+  if (queryParams) {
+    for (const key in queryParams) {
+      if ({}.hasOwnProperty.call(queryParams, key)) {
+        searchParam.append(key, queryParams[key]);
+      }
+    }
+  }
+  if (secOptions && secOptions.params) {
+    for (const key in secOptions.params) {
+      if ({}.hasOwnProperty.call(secOptions.params, key)) {
+        const values = secOptions.params[key];
+        if (Array.isArray(values)) {
+          for (let i = 0; i < values.length; i++) {
+            searchParam.append(key, values[i]);
+          }
+        } else {
+          searchParam.append(key, values);
+        }
+      }
+    }
+  }
+  let separator = '';
+  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
+    separator = '/';
+  }
+  let params = searchParam.toString();
+  if (params) {
+    params = '?' + params;
+  }
+  return `${baseUrl}${separator}${path}${params}`;
+};
+const addToHeaders = (headers, keyValues) => {
+  if (keyValues) {
+    for (const key in keyValues) {
+      if ({}.hasOwnProperty.call(keyValues, key)) {
+        const values = keyValues[key];
+        if (Array.isArray(values)) {
+          for (let i = 0; i < values.length; i++) {
+            headers[key] = values[i];
+          }
+        } else {
+          headers[key] = values;
+        }
+      }
+    }
+  }
+};
+export const buildHeaders = (secOptions, extraHeaders) => {
+  const headers = {};
+  addToHeaders(headers, extraHeaders);
+  if (secOptions) {
+    addToHeaders(headers, secOptions.headers);
+  }
+  return headers;
+};

package/dist/esm/index.js

@@ -1,4 +1,6 @@
 export * from './types';
 export * from './serviceResources';
 import * as serviceUtils from './serviceUtils';
-export var utils = serviceUtils;
+import * as multipartServiceUtils from './multipartServiceUtils';
+export var utils = serviceUtils;
+export var multipartUtils = multipartServiceUtils;

package/dist/esm/multipartServiceUtils.js

@@ -0,0 +1,127 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+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) { _defineProperty(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; }
+import { meros } from 'meros/browser';
+import { buildCredentials } from './types';
+import { buildHeaders, buildUrl, defaultRequestServiceOptions } from './shared';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
+import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
+
+/** Copied from meros types, as there are difficulties with resolving the type in CI */
+
+/**
+ * Make a request that **may** result in an HTTP multipart response from the server.
+ * @returns an object with a parsed JSON body OR an object with the parts from
+ * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
+ */
+var _requestServiceMultipart = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(serviceConfig) {
+    var options,
+      url,
+      securityProvider,
+      refreshedSecurityProvider,
+      path,
+      queryParams,
+      requestInit,
+      secOptions,
+      requestUrl,
+      headers,
+      credentials,
+      TRACING_HEADER_FOR_SERVICE_UTIL,
+      tracingHeaderEnabled,
+      tracingHeaders,
+      requestOptions,
+      fetchResponse,
+      parts,
+      _args = arguments;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          options = _args.length > 1 && _args[1] !== undefined ? _args[1] : defaultRequestServiceOptions;
+          url = serviceConfig.url, securityProvider = serviceConfig.securityProvider, refreshedSecurityProvider = serviceConfig.refreshedSecurityProvider;
+          path = options.path, queryParams = options.queryParams, requestInit = options.requestInit;
+          secOptions = securityProvider && securityProvider();
+          requestUrl = buildUrl(url, path, queryParams, secOptions);
+          headers = buildHeaders(secOptions, requestInit && requestInit.headers);
+          credentials = buildCredentials(secOptions); // Get tracing headers from UFO
+          TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
+          tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
+          addFeatureFlagAccessed(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);
+          tracingHeaders = {};
+          if (tracingHeaderEnabled) {
+            tracingHeaders = getActiveTraceHttpRequestHeaders(url);
+          }
+          requestOptions = _objectSpread(_objectSpread({}, requestInit), {}, {
+            // populate headers mainly for the collab provider however
+            // other components which uses this util can get the header as well.
+            // Those tracing headers shall not incur any issues as long as backends handle them properly
+            headers: _objectSpread(_objectSpread({}, headers), tracingHeaders),
+            credentials: credentials
+          });
+          _context.next = 15;
+          return fetch(requestUrl, requestOptions);
+        case 15:
+          fetchResponse = _context.sent;
+          _context.next = 18;
+          return meros(fetchResponse);
+        case 18:
+          parts = _context.sent;
+          if (!(fetchResponse.ok && fetchResponse.status !== 204)) {
+            _context.next = 28;
+            break;
+          }
+          if (!(parts[Symbol.asyncIterator] < 'u')) {
+            _context.next = 22;
+            break;
+          }
+          return _context.abrupt("return", {
+            isMultipart: true,
+            parts: parts
+          });
+        case 22:
+          _context.next = 24;
+          return parts.json();
+        case 24:
+          _context.t0 = _context.sent;
+          return _context.abrupt("return", {
+            isMultipart: false,
+            body: _context.t0
+          });
+        case 28:
+          if (!(fetchResponse.status === 401 && refreshedSecurityProvider)) {
+            _context.next = 30;
+            break;
+          }
+          return _context.abrupt("return", refreshedSecurityProvider().then(function (newSecOptions) {
+            var retryServiceConfig = {
+              url: url,
+              securityProvider: function securityProvider() {
+                return newSecOptions;
+              }
+            };
+            return _requestServiceMultipart(retryServiceConfig, options);
+          }));
+        case 30:
+          return _context.abrupt("return", Promise.reject({
+            code: fetchResponse.status,
+            reason: fetchResponse.statusText
+          }));
+        case 31:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function requestServiceMultipart(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+export { _requestServiceMultipart as requestServiceMultipart };

package/dist/esm/serviceUtils.js

@@ -5,71 +5,7 @@ import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
 import { buildCredentials } from './types';
-var defaultRequestServiceOptions = {};
-var buildUrl = function buildUrl(baseUrl) {
-  var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-  var queryParams = arguments.length > 2 ? arguments[2] : undefined;
-  var secOptions = arguments.length > 3 ? arguments[3] : undefined;
-  var searchParam = new URLSearchParams(
-  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
-  // Since we only care about search params it is fine to have any base url here.
-  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
-  baseUrl = baseUrl.split('?')[0];
-  if (queryParams) {
-    for (var key in queryParams) {
-      if ({}.hasOwnProperty.call(queryParams, key)) {
-        searchParam.append(key, queryParams[key]);
-      }
-    }
-  }
-  if (secOptions && secOptions.params) {
-    for (var _key in secOptions.params) {
-      if ({}.hasOwnProperty.call(secOptions.params, _key)) {
-        var values = secOptions.params[_key];
-        if (Array.isArray(values)) {
-          for (var i = 0; i < values.length; i++) {
-            searchParam.append(_key, values[i]);
-          }
-        } else {
-          searchParam.append(_key, values);
-        }
-      }
-    }
-  }
-  var separator = '';
-  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
-    separator = '/';
-  }
-  var params = searchParam.toString();
-  if (params) {
-    params = '?' + params;
-  }
-  return "".concat(baseUrl).concat(separator).concat(path).concat(params);
-};
-var addToHeaders = function addToHeaders(headers, keyValues) {
-  if (keyValues) {
-    for (var key in keyValues) {
-      if ({}.hasOwnProperty.call(keyValues, key)) {
-        var values = keyValues[key];
-        if (Array.isArray(values)) {
-          for (var i = 0; i < values.length; i++) {
-            headers[key] = values[i];
-          }
-        } else {
-          headers[key] = values;
-        }
-      }
-    }
-  }
-};
-var buildHeaders = function buildHeaders(secOptions, extraHeaders) {
-  var headers = {};
-  addToHeaders(headers, extraHeaders);
-  if (secOptions) {
-    addToHeaders(headers, secOptions.headers);
-  }
-  return headers;
-};
+import { defaultRequestServiceOptions, buildUrl, buildHeaders } from './shared';
 
 /**
  * @returns Promise containing the json response
@@ -88,7 +24,7 @@ var _requestService = function requestService(serviceConfig, options) {
   var credentials = buildCredentials(secOptions);
   var ignoreResponsePayload = (options === null || options === void 0 ? void 0 : options.ignoreResponsePayload) || false;
 
-  //Get tracing headers from UFO
+  // Get tracing headers from UFO
   var TRACING_HEADER_FOR_SERVICE_UTIL = 'platform_collab_provider_tracingheaders';
   var tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
   addFeatureFlagAccessed(TRACING_HEADER_FOR_SERVICE_UTIL, tracingHeaderEnabled);

package/dist/esm/shared.js

@@ -0,0 +1,65 @@
+export var defaultRequestServiceOptions = {};
+export var buildUrl = function buildUrl(baseUrl) {
+  var path = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  var queryParams = arguments.length > 2 ? arguments[2] : undefined;
+  var secOptions = arguments.length > 3 ? arguments[3] : undefined;
+  var searchParam = new URLSearchParams(
+  // For relative urls, the URL class requires base to be set. It's ignored if a url is not relative.
+  // Since we only care about search params it is fine to have any base url here.
+  new URL(baseUrl, 'https://BASE_FALLBACK').search || undefined);
+  baseUrl = baseUrl.split('?')[0];
+  if (queryParams) {
+    for (var key in queryParams) {
+      if ({}.hasOwnProperty.call(queryParams, key)) {
+        searchParam.append(key, queryParams[key]);
+      }
+    }
+  }
+  if (secOptions && secOptions.params) {
+    for (var _key in secOptions.params) {
+      if ({}.hasOwnProperty.call(secOptions.params, _key)) {
+        var values = secOptions.params[_key];
+        if (Array.isArray(values)) {
+          for (var i = 0; i < values.length; i++) {
+            searchParam.append(_key, values[i]);
+          }
+        } else {
+          searchParam.append(_key, values);
+        }
+      }
+    }
+  }
+  var separator = '';
+  if (path && baseUrl.substr(-1) !== '/' && !path.startsWith('/')) {
+    separator = '/';
+  }
+  var params = searchParam.toString();
+  if (params) {
+    params = '?' + params;
+  }
+  return "".concat(baseUrl).concat(separator).concat(path).concat(params);
+};
+var addToHeaders = function addToHeaders(headers, keyValues) {
+  if (keyValues) {
+    for (var key in keyValues) {
+      if ({}.hasOwnProperty.call(keyValues, key)) {
+        var values = keyValues[key];
+        if (Array.isArray(values)) {
+          for (var i = 0; i < values.length; i++) {
+            headers[key] = values[i];
+          }
+        } else {
+          headers[key] = values;
+        }
+      }
+    }
+  }
+};
+export var buildHeaders = function buildHeaders(secOptions, extraHeaders) {
+  var headers = {};
+  addToHeaders(headers, extraHeaders);
+  if (secOptions) {
+    addToHeaders(headers, secOptions.headers);
+  }
+  return headers;
+};

package/dist/types/index.d.ts

@@ -1,4 +1,7 @@
 export * from './types';
 export * from './serviceResources';
 import * as serviceUtils from './serviceUtils';
+import * as multipartServiceUtils from './multipartServiceUtils';
 export declare const utils: typeof serviceUtils;
+export declare const multipartUtils: typeof multipartServiceUtils;
+export type { RequestServiceResult, PartsGenerator, MultiPartFetchResult, BodyResult, } from './multipartServiceUtils';

package/dist/types/multipartServiceUtils.d.ts

@@ -0,0 +1,34 @@
+import { type RequestServiceOptions, type ServiceConfig } from './types';
+export type PartsGenerator<PartsType> = AsyncGenerator<Part<PartsType, unknown>>;
+export type MultiPartFetchResult<PartsType> = {
+    isMultipart: true;
+    parts: PartsGenerator<PartsType>;
+};
+export type BodyResult<T> = {
+    isMultipart: false;
+    body: T;
+};
+export type RequestServiceResult<PartsType, BodyType> = MultiPartFetchResult<PartsType> | BodyResult<BodyType>;
+/** Copied from meros types, as there are difficulties with resolving the type in CI */
+export type Part<Body, Fallback> = {
+    json: false;
+    headers: Record<string, string>;
+    body: Fallback;
+} | {
+    json: true;
+    headers: Record<string, string>;
+    body: Body;
+};
+type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
+/**
+ * Make a request that **may** result in an HTTP multipart response from the server.
+ * @returns an object with a parsed JSON body OR an object with the parts from
+ * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
+ */
+export declare const requestServiceMultipart: <PartsType, BodyType>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<PartsType, BodyType>>;
+export {};

package/dist/types/shared.d.ts

@@ -0,0 +1,4 @@
+import type { RequestServiceOptions, KeyValues, SecurityOptions } from './types';
+export declare const defaultRequestServiceOptions: RequestServiceOptions;
+export declare const buildUrl: (baseUrl: string, path?: string, queryParams?: KeyValues, secOptions?: SecurityOptions) => string;
+export declare const buildHeaders: (secOptions?: SecurityOptions, extraHeaders?: KeyValues) => KeyValues;

package/dist/types-ts4.5/index.d.ts

@@ -1,4 +1,7 @@
 export * from './types';
 export * from './serviceResources';
 import * as serviceUtils from './serviceUtils';
+import * as multipartServiceUtils from './multipartServiceUtils';
 export declare const utils: typeof serviceUtils;
+export declare const multipartUtils: typeof multipartServiceUtils;
+export type { RequestServiceResult, PartsGenerator, MultiPartFetchResult, BodyResult, } from './multipartServiceUtils';

package/dist/types-ts4.5/multipartServiceUtils.d.ts

@@ -0,0 +1,34 @@
+import { type RequestServiceOptions, type ServiceConfig } from './types';
+export type PartsGenerator<PartsType> = AsyncGenerator<Part<PartsType, unknown>>;
+export type MultiPartFetchResult<PartsType> = {
+    isMultipart: true;
+    parts: PartsGenerator<PartsType>;
+};
+export type BodyResult<T> = {
+    isMultipart: false;
+    body: T;
+};
+export type RequestServiceResult<PartsType, BodyType> = MultiPartFetchResult<PartsType> | BodyResult<BodyType>;
+/** Copied from meros types, as there are difficulties with resolving the type in CI */
+export type Part<Body, Fallback> = {
+    json: false;
+    headers: Record<string, string>;
+    body: Fallback;
+} | {
+    json: true;
+    headers: Record<string, string>;
+    body: Body;
+};
+type Options = Omit<RequestServiceOptions, 'ignoreResponsePayload'>;
+/**
+ * Make a request that **may** result in an HTTP multipart response from the server.
+ * @returns an object with a parsed JSON body OR an object with the parts from
+ * the HTTP multipart response.
+ *
+ * PartsType type parameter specifies the type of the response when the server response
+ * is multipart.
+ *
+ * BodyType specifies the type of the response when the server response is not multipart
+ */
+export declare const requestServiceMultipart: <PartsType, BodyType>(serviceConfig: ServiceConfig, options?: Options) => Promise<RequestServiceResult<PartsType, BodyType>>;
+export {};

package/dist/types-ts4.5/shared.d.ts

@@ -0,0 +1,4 @@
+import type { RequestServiceOptions, KeyValues, SecurityOptions } from './types';
+export declare const defaultRequestServiceOptions: RequestServiceOptions;
+export declare const buildUrl: (baseUrl: string, path?: string, queryParams?: KeyValues, secOptions?: SecurityOptions) => string;
+export declare const buildHeaders: (secOptions?: SecurityOptions, extraHeaders?: KeyValues) => KeyValues;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.2.7",
+	"version": "6.3.1",
 	"description": "A library of support classes for integrating React components with REST HTTP services",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,8 +35,9 @@
 	},
 	"dependencies": {
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/react-ufo": "^3.0.0",
-		"@babel/runtime": "^7.0.0"
+		"@atlaskit/react-ufo": "^3.4.0",
+		"@babel/runtime": "^7.0.0",
+		"meros": "^1.3.0"
 	},
 	"devDependencies": {
 		"es6-promise": "^4.0.5",