@atlaskit/util-service-support 6.0.2 → 6.1.0

package/dist/es2019/serviceUtils.js

@@ -1,104 +1,123 @@
-import * as URL from 'url';
-import USP from 'url-search-params'; // IE, Safari, Mobile Chrome, Mobile Safari
-import { buildCredentials, } from './types';
-const URLSearchParams = USP.default || USP;
+import { buildCredentials } from './types';
 const defaultRequestServiceOptions = {};
+
 const buildUrl = (baseUrl, path = '', queryParams, secOptions) => {
-    const searchParam = new URLSearchParams(URL.parse(baseUrl).search || undefined);
-    baseUrl = baseUrl.split('?')[0];
-    if (queryParams) {
-        for (const key in queryParams) {
-            if ({}.hasOwnProperty.call(queryParams, key)) {
-                searchParam.append(key, queryParams[key]);
-            }
-        }
+  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);
-                }
-            }
+  }
+
+  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 seperator = '';
-    if (path && baseUrl.substr(-1) !== '/') {
-        seperator = '/';
-    }
-    let params = searchParam.toString();
-    if (params) {
-        params = '?' + params;
-    }
-    return `${baseUrl}${seperator}${path}${params}`;
+  }
+
+  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;
-                }
-            }
+  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;
+  const headers = {};
+  addToHeaders(headers, extraHeaders);
+
+  if (secOptions) {
+    addToHeaders(headers, secOptions.headers);
+  }
+
+  return headers;
 };
 /**
  * @returns Promise containing the json response
  */
+
+
 export const requestService = (serviceConfig, options) => {
-    const { url, securityProvider, refreshedSecurityProvider } = serviceConfig;
-    const { path, queryParams, requestInit } = options || defaultRequestServiceOptions;
-    const secOptions = securityProvider && securityProvider();
-    const requestUrl = buildUrl(url, path, queryParams, secOptions);
-    const headers = buildHeaders(secOptions, requestInit && requestInit.headers);
-    const credentials = buildCredentials(secOptions);
-    const requestOptions = {
-        ...requestInit,
-        headers,
-        credentials,
-    };
-    return fetch(requestUrl, requestOptions).then((response) => {
-        if (response.status === 204) {
-            return Promise.resolve();
-        }
-        else if (response.ok) {
-            return response.json();
-        }
-        else if (response.status === 401 && refreshedSecurityProvider) {
-            // auth issue - try once
-            return refreshedSecurityProvider().then(newSecOptions => {
-                const retryServiceConfig = {
-                    url,
-                    securityProvider: () => newSecOptions,
-                };
-                return requestService(retryServiceConfig, options);
-            });
-        }
-        return Promise.reject({
-            code: response.status,
-            reason: response.statusText,
-        });
+  const {
+    url,
+    securityProvider,
+    refreshedSecurityProvider
+  } = serviceConfig;
+  const {
+    path,
+    queryParams,
+    requestInit
+  } = options || defaultRequestServiceOptions;
+  const secOptions = securityProvider && securityProvider();
+  const requestUrl = buildUrl(url, path, queryParams, secOptions);
+  const headers = buildHeaders(secOptions, requestInit && requestInit.headers);
+  const credentials = buildCredentials(secOptions);
+  const ignoreResponsePayload = (options === null || options === void 0 ? void 0 : options.ignoreResponsePayload) || false;
+  const requestOptions = { ...requestInit,
+    headers,
+    credentials
+  };
+  return fetch(requestUrl, requestOptions).then(response => {
+    if (response.status === 204) {
+      return Promise.resolve();
+    } else if (response.ok) {
+      return ignoreResponsePayload ? Promise.resolve() : response.json();
+    } else if (response.status === 401 && refreshedSecurityProvider) {
+      // auth issue - try once
+      return refreshedSecurityProvider().then(newSecOptions => {
+        const retryServiceConfig = {
+          url,
+          securityProvider: () => newSecOptions
+        };
+        return requestService(retryServiceConfig, options);
+      });
+    }
+
+    return Promise.reject({
+      code: response.status,
+      reason: response.statusText
     });
-};
-//# sourceMappingURL=serviceUtils.js.map
+  });
+};

package/dist/es2019/types.js

@@ -1,4 +1,16 @@
-export const buildCredentials = (secOptions) => {
-    return secOptions && secOptions.omitCredentials ? 'omit' : 'include';
+/**
+ * Defines a typical Resource.
+ *
+ * Q = query type
+ * R = result type
+ * E = error type
+ * I = info type
+ * O = options that filter can accept
+ */
+export const buildCredentials = secOptions => {
+  return secOptions && secOptions.omitCredentials ? 'omit' : 'include';
 };
-//# sourceMappingURL=types.js.map
+/**
+ * Returns a promise to a SecurityOptions that has just been forcibly refreshed with a
+ * new token. Will be used for single retry per request if a 401 is returned.
+ */

package/dist/es2019/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.0.2"
+	"version": "6.1.0"
 }

package/dist/esm/index.js

@@ -1,5 +1,4 @@
 export * from './types';
 export * from './serviceResources';
 import * as serviceUtils from './serviceUtils';
-export var utils = serviceUtils;
-//# sourceMappingURL=index.js.map
+export var utils = serviceUtils;

package/dist/esm/serviceResources.js

@@ -1,44 +1,63 @@
-var AbstractResource = /** @class */ (function () {
-    function AbstractResource() {
-        this.listeners = new Set();
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+export var AbstractResource = /*#__PURE__*/function () {
+  function AbstractResource() {
+    _classCallCheck(this, AbstractResource);
+
+    _defineProperty(this, "listeners", new Set());
+  }
+
+  _createClass(AbstractResource, [{
+    key: "subscribe",
+    value: function subscribe(onChange) {
+      this.listeners.add(onChange);
+
+      if (this.lastResult) {
+        // Notify subscribe of last result (i.e. initial state)
+        onChange.result(this.lastResult);
+      }
     }
-    AbstractResource.prototype.subscribe = function (onChange) {
-        this.listeners.add(onChange);
-        if (this.lastResult) {
-            // Notify subscribe of last result (i.e. initial state)
-            onChange.result(this.lastResult);
+  }, {
+    key: "unsubscribe",
+    value: function unsubscribe(onChange) {
+      this.listeners.delete(onChange);
+    }
+  }, {
+    key: "notifyResult",
+    value: function notifyResult(result) {
+      this.listeners.forEach(function (onChange) {
+        onChange.result(result);
+      });
+    }
+  }, {
+    key: "notifyError",
+    value: function notifyError(error) {
+      this.listeners.forEach(function (onChange) {
+        if (onChange.error) {
+          onChange.error(error);
+        }
+      });
+    }
+  }, {
+    key: "notifyInfo",
+    value: function notifyInfo(info) {
+      this.listeners.forEach(function (onChange) {
+        if (onChange.info) {
+          onChange.info(info);
         }
-    };
-    AbstractResource.prototype.unsubscribe = function (onChange) {
-        this.listeners.delete(onChange);
-    };
-    AbstractResource.prototype.notifyResult = function (result) {
-        this.listeners.forEach(function (onChange) {
-            onChange.result(result);
-        });
-    };
-    AbstractResource.prototype.notifyError = function (error) {
-        this.listeners.forEach(function (onChange) {
-            if (onChange.error) {
-                onChange.error(error);
-            }
-        });
-    };
-    AbstractResource.prototype.notifyInfo = function (info) {
-        this.listeners.forEach(function (onChange) {
-            if (onChange.info) {
-                onChange.info(info);
-            }
-        });
-    };
-    AbstractResource.prototype.notifyNotReady = function () {
-        this.listeners.forEach(function (onChange) {
-            if (onChange.notReady) {
-                onChange.notReady();
-            }
-        });
-    };
-    return AbstractResource;
-}());
-export { AbstractResource };
-//# sourceMappingURL=serviceResources.js.map
+      });
+    }
+  }, {
+    key: "notifyNotReady",
+    value: function notifyNotReady() {
+      this.listeners.forEach(function (onChange) {
+        if (onChange.notReady) {
+          onChange.notReady();
+        }
+      });
+    }
+  }]);
+
+  return AbstractResource;
+}();

package/dist/esm/serviceUtils.js

@@ -1,103 +1,135 @@
-import { __assign } from "tslib";
-import * as URL from 'url';
-import USP from 'url-search-params'; // IE, Safari, Mobile Chrome, Mobile Safari
-import { buildCredentials, } from './types';
-var URLSearchParams = USP.default || USP;
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import { buildCredentials } from './types';
 var defaultRequestServiceOptions = {};
-var buildUrl = function (baseUrl, path, queryParams, secOptions) {
-    if (path === void 0) { path = ''; }
-    var searchParam = new URLSearchParams(URL.parse(baseUrl).search || undefined);
-    baseUrl = baseUrl.split('?')[0];
-    if (queryParams) {
-        for (var key in queryParams) {
-            if ({}.hasOwnProperty.call(queryParams, key)) {
-                searchParam.append(key, queryParams[key]);
-            }
-        }
+
+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);
-                }
-            }
+  }
+
+  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 seperator = '';
-    if (path && baseUrl.substr(-1) !== '/') {
-        seperator = '/';
-    }
-    var params = searchParam.toString();
-    if (params) {
-        params = '?' + params;
-    }
-    return "" + baseUrl + seperator + path + params;
+  }
+
+  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 (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 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 (secOptions, extraHeaders) {
-    var headers = {};
-    addToHeaders(headers, extraHeaders);
-    if (secOptions) {
-        addToHeaders(headers, secOptions.headers);
-    }
-    return headers;
+
+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
  */
-export var requestService = function (serviceConfig, options) {
-    var url = serviceConfig.url, securityProvider = serviceConfig.securityProvider, refreshedSecurityProvider = serviceConfig.refreshedSecurityProvider;
-    var _a = options || defaultRequestServiceOptions, path = _a.path, queryParams = _a.queryParams, requestInit = _a.requestInit;
-    var secOptions = securityProvider && securityProvider();
-    var requestUrl = buildUrl(url, path, queryParams, secOptions);
-    var headers = buildHeaders(secOptions, requestInit && requestInit.headers);
-    var credentials = buildCredentials(secOptions);
-    var requestOptions = __assign(__assign({}, requestInit), { headers: headers,
-        credentials: credentials });
-    return fetch(requestUrl, requestOptions).then(function (response) {
-        if (response.status === 204) {
-            return Promise.resolve();
-        }
-        else if (response.ok) {
-            return response.json();
-        }
-        else if (response.status === 401 && refreshedSecurityProvider) {
-            // auth issue - try once
-            return refreshedSecurityProvider().then(function (newSecOptions) {
-                var retryServiceConfig = {
-                    url: url,
-                    securityProvider: function () { return newSecOptions; },
-                };
-                return requestService(retryServiceConfig, options);
-            });
-        }
-        return Promise.reject({
-            code: response.status,
-            reason: response.statusText,
-        });
+
+
+export var requestService = function requestService(serviceConfig, options) {
+  var url = serviceConfig.url,
+      securityProvider = serviceConfig.securityProvider,
+      refreshedSecurityProvider = serviceConfig.refreshedSecurityProvider;
+
+  var _ref = options || 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 credentials = buildCredentials(secOptions);
+  var ignoreResponsePayload = (options === null || options === void 0 ? void 0 : options.ignoreResponsePayload) || false;
+
+  var requestOptions = _objectSpread(_objectSpread({}, requestInit), {}, {
+    headers: headers,
+    credentials: credentials
+  });
+
+  return fetch(requestUrl, requestOptions).then(function (response) {
+    if (response.status === 204) {
+      return Promise.resolve();
+    } else if (response.ok) {
+      return ignoreResponsePayload ? Promise.resolve() : response.json();
+    } else if (response.status === 401 && refreshedSecurityProvider) {
+      // auth issue - try once
+      return refreshedSecurityProvider().then(function (newSecOptions) {
+        var retryServiceConfig = {
+          url: url,
+          securityProvider: function securityProvider() {
+            return newSecOptions;
+          }
+        };
+        return requestService(retryServiceConfig, options);
+      });
+    }
+
+    return Promise.reject({
+      code: response.status,
+      reason: response.statusText
     });
-};
-//# sourceMappingURL=serviceUtils.js.map
+  });
+};

package/dist/esm/types.js

@@ -1,4 +1,16 @@
-export var buildCredentials = function (secOptions) {
-    return secOptions && secOptions.omitCredentials ? 'omit' : 'include';
+/**
+ * Defines a typical Resource.
+ *
+ * Q = query type
+ * R = result type
+ * E = error type
+ * I = info type
+ * O = options that filter can accept
+ */
+export var buildCredentials = function buildCredentials(secOptions) {
+  return secOptions && secOptions.omitCredentials ? 'omit' : 'include';
 };
-//# sourceMappingURL=types.js.map
+/**
+ * Returns a promise to a SecurityOptions that has just been forcibly refreshed with a
+ * new token. Will be used for single retry per request if a 401 is returned.
+ */

package/dist/esm/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.0.2"
+	"version": "6.1.0"
 }

package/dist/types/types.d.ts

@@ -76,4 +76,5 @@ export interface RequestServiceOptions {
     path?: string;
     queryParams?: KeyValues;
     requestInit?: RequestInit;
+    ignoreResponsePayload?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/util-service-support",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "description": "A library of support classes for integrating React components with REST HTTP services",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -15,18 +15,18 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "deprecatedAutoEntryPoints": true,
-    "releaseModel": "continuous"
+    "releaseModel": "continuous",
+    "team": "AFP: Monorepo"
   },
   "config": {
     "access": "public"
   },
   "dependencies": {
-    "tslib": "^2.0.0",
-    "url": "^0.11.0",
-    "url-search-params": "^0.10.0"
+    "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "es6-promise": "^4.0.5",
     "fetch-mock": "^8.0.0",
     "sinon": "^2.2.0",
@@ -41,5 +41,6 @@
     "@atlassian/frontend": {
       "tree-shaking": []
     }
-  }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
 }