contentful-management 7.41.0 → 7.42.2

package/README.md

@@ -336,6 +336,12 @@ initialized with provided configuration.
 > The Adapter will take precedence over the other options. Therefore, ensure you're providing the Adapter all the
 > information it needs to issue the request (e.g., host or auth headers)
 
+#### throttle (default: `0`)
+Maximum number of requests per second.
+- `1`-`30` (fixed number of limit), 
+- `'auto'` (calculated limit based on your plan), 
+- `'0%'` - `'100%'` (calculated % limit based on your plan)
+
 ### Reference documentation
 
 The [Contentful's JS library reference](https://contentful.github.io/contentful-management.js) documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.

package/dist/contentful-management.browser.js

@@ -2294,10 +2294,13 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var fast_copy__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(fast_copy__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var qs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! qs */ "../node_modules/qs/lib/index.js");
 /* harmony import */ var qs__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(qs__WEBPACK_IMPORTED_MODULE_1__);
-/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! os */ 2);
-/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(os__WEBPACK_IMPORTED_MODULE_2__);
-/* harmony import */ var lodash__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! lodash */ "../node_modules/lodash/lodash.js");
-/* harmony import */ var lodash__WEBPACK_IMPORTED_MODULE_3___default = /*#__PURE__*/__webpack_require__.n(lodash__WEBPACK_IMPORTED_MODULE_3__);
+/* harmony import */ var lodash__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! lodash */ "../node_modules/lodash/lodash.js");
+/* harmony import */ var lodash__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(lodash__WEBPACK_IMPORTED_MODULE_2__);
+/* harmony import */ var p_throttle__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! p-throttle */ "../node_modules/p-throttle/index.js");
+/* harmony import */ var p_throttle__WEBPACK_IMPORTED_MODULE_3___default = /*#__PURE__*/__webpack_require__.n(p_throttle__WEBPACK_IMPORTED_MODULE_3__);
+/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! os */ 2);
+/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_4___default = /*#__PURE__*/__webpack_require__.n(os__WEBPACK_IMPORTED_MODULE_4__);
+
 
 
 
@@ -2357,6 +2360,69 @@ function _typeof(obj) {
   return _typeof(obj);
 }
 
+function _wrapRegExp() {
+  _wrapRegExp = function (re, groups) {
+    return new BabelRegExp(re, undefined, groups);
+  };
+
+  var _super = RegExp.prototype;
+
+  var _groups = new WeakMap();
+
+  function BabelRegExp(re, flags, groups) {
+    var _this = new RegExp(re, flags);
+
+    _groups.set(_this, groups || _groups.get(re));
+
+    return _setPrototypeOf(_this, BabelRegExp.prototype);
+  }
+
+  _inherits(BabelRegExp, RegExp);
+
+  BabelRegExp.prototype.exec = function (str) {
+    var result = _super.exec.call(this, str);
+
+    if (result) result.groups = buildGroups(result, this);
+    return result;
+  };
+
+  BabelRegExp.prototype[Symbol.replace] = function (str, substitution) {
+    if (typeof substitution === "string") {
+      var groups = _groups.get(this);
+
+      return _super[Symbol.replace].call(this, str, substitution.replace(/\$<([^>]+)>/g, function (_, name) {
+        return "$" + groups[name];
+      }));
+    } else if (typeof substitution === "function") {
+      var _this = this;
+
+      return _super[Symbol.replace].call(this, str, function () {
+        var args = arguments;
+
+        if (typeof args[args.length - 1] !== "object") {
+          args = [].slice.call(args);
+          args.push(buildGroups(args, _this));
+        }
+
+        return substitution.apply(this, args);
+      });
+    } else {
+      return _super[Symbol.replace].call(this, str, substitution);
+    }
+  };
+
+  function buildGroups(result, re) {
+    var g = _groups.get(re);
+
+    return Object.keys(g).reduce(function (groups, name) {
+      groups[name] = result[g[name]];
+      return groups;
+    }, Object.create(null));
+  }
+
+  return _wrapRegExp.apply(this, arguments);
+}
+
 function _defineProperty(obj, key, value) {
   if (key in obj) {
     Object.defineProperty(obj, key, {
@@ -2372,6 +2438,30 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
+function _inherits(subClass, superClass) {
+  if (typeof superClass !== "function" && superClass !== null) {
+    throw new TypeError("Super expression must either be null or a function");
+  }
+
+  subClass.prototype = Object.create(superClass && superClass.prototype, {
+    constructor: {
+      value: subClass,
+      writable: true,
+      configurable: true
+    }
+  });
+  if (superClass) _setPrototypeOf(subClass, superClass);
+}
+
+function _setPrototypeOf(o, p) {
+  _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+    o.__proto__ = p;
+    return o;
+  };
+
+  return _setPrototypeOf(o, p);
+}
+
 function _slicedToArray(arr, i) {
   return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
 }
@@ -2488,13 +2578,82 @@ function _createForOfIteratorHelper(o, allowArrayLike) {
   };
 }
 
-var attempts = {};
-var networkErrorAttempts = 0;
+var PERCENTAGE_REGEX = /*#__PURE__*/_wrapRegExp(/([0-9]+)(%)/, {
+  value: 1
+});
+
+function calculateLimit(type) {
+  var max = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 7;
+  var limit = max;
+
+  if (PERCENTAGE_REGEX.test(type)) {
+    var _type$match;
 
-function noop() {
-  return undefined;
+    var groups = (_type$match = type.match(PERCENTAGE_REGEX)) === null || _type$match === void 0 ? void 0 : _type$match.groups;
+
+    if (groups && groups.value) {
+      var percentage = parseInt(groups.value) / 100;
+      limit = Math.round(max * percentage);
+    }
+  }
+
+  return Math.min(30, Math.max(1, limit));
 }
 
+function createThrottle(limit, logger) {
+  logger('info', "Throttle request to ".concat(limit, "/s"));
+  return p_throttle__WEBPACK_IMPORTED_MODULE_3___default()({
+    limit: limit,
+    interval: 1000,
+    strict: false
+  });
+}
+
+var rateLimitThrottle = (function (axiosInstance) {
+  var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'auto';
+  var _axiosInstance$defaul = axiosInstance.defaults.logHandler,
+      logHandler = _axiosInstance$defaul === void 0 ? lodash__WEBPACK_IMPORTED_MODULE_2__["noop"] : _axiosInstance$defaul;
+  var limit = Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isString"])(type) ? calculateLimit(type) : calculateLimit('auto', type);
+  var throttle = createThrottle(limit, logHandler);
+  var isCalculated = false;
+  var requestInterceptorId = axiosInstance.interceptors.request.use(function (config) {
+    return throttle(function () {
+      return config;
+    })();
+  }, Promise.reject);
+  var responseInterceptorId = axiosInstance.interceptors.response.use(function (response) {
+    if (!isCalculated && Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isString"])(type) && (type === 'auto' || PERCENTAGE_REGEX.test(type)) && response.headers && response.headers['x-contentful-ratelimit-second-limit']) {
+      var rawLimit = parseInt(response.headers['x-contentful-ratelimit-second-limit']);
+      var nextLimit = calculateLimit(type, rawLimit);
+
+      if (nextLimit !== limit) {
+        if (requestInterceptorId) {
+          axiosInstance.interceptors.request.eject(requestInterceptorId);
+        }
+
+        limit = nextLimit;
+        throttle = createThrottle(nextLimit, logHandler);
+        requestInterceptorId = axiosInstance.interceptors.request.use(function (config) {
+          return throttle(function () {
+            return config;
+          })();
+        }, Promise.reject);
+      }
+
+      isCalculated = true;
+    }
+
+    return response;
+  }, Promise.reject);
+  return function () {
+    axiosInstance.interceptors.request.eject(requestInterceptorId);
+    axiosInstance.interceptors.response.eject(responseInterceptorId);
+  };
+});
+
+var attempts = {};
+var networkErrorAttempts = 0;
+
 var delay = function delay(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);
@@ -2505,9 +2664,9 @@ function rateLimit(instance) {
   var maxRetry = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5;
   var _instance$defaults = instance.defaults,
       _instance$defaults$re = _instance$defaults.responseLogger,
-      responseLogger = _instance$defaults$re === void 0 ? noop : _instance$defaults$re,
+      responseLogger = _instance$defaults$re === void 0 ? lodash__WEBPACK_IMPORTED_MODULE_2__["noop"] : _instance$defaults$re,
       _instance$defaults$re2 = _instance$defaults.requestLogger,
-      requestLogger = _instance$defaults$re2 === void 0 ? noop : _instance$defaults$re2;
+      requestLogger = _instance$defaults$re2 === void 0 ? lodash__WEBPACK_IMPORTED_MODULE_2__["noop"] : _instance$defaults$re2;
   instance.interceptors.request.use(function (config) {
     requestLogger(config);
     return config;
@@ -2529,7 +2688,7 @@ function rateLimit(instance) {
     }
 
     var retryErrorType = null;
-    var wait = 0; // Errors without response did not recieve anything from the server
+    var wait = 0; // Errors without response did not receive anything from the server
 
     if (!response) {
       retryErrorType = 'Connection';
@@ -2652,6 +2811,7 @@ function createHttpClient(axios, options) {
     httpAgent: false,
     httpsAgent: false,
     timeout: 30000,
+    throttle: 0,
     proxy: false,
     basePath: '',
     adapter: undefined,
@@ -2756,6 +2916,10 @@ function createHttpClient(axios, options) {
     asyncToken(instance, config.accessToken);
   }
 
+  if (config.throttle) {
+    rateLimitThrottle(instance, config.throttle);
+  }
+
   rateLimit(instance, config.retryLimit);
 
   if (config.onError) {
@@ -2855,8 +3019,8 @@ function getBrowserOS() {
 }
 
 function getNodeOS() {
-  var platform = os__WEBPACK_IMPORTED_MODULE_2___default.a.platform() || 'linux';
-  var version = os__WEBPACK_IMPORTED_MODULE_2___default.a.release() || '0.0.0';
+  var platform = os__WEBPACK_IMPORTED_MODULE_4___default.a.platform() || 'linux';
+  var version = os__WEBPACK_IMPORTED_MODULE_4___default.a.release() || '0.0.0';
   var platformMap = {
     android: 'Android',
     aix: 'Linux',
@@ -2953,7 +3117,7 @@ function errorHandler(errorResponse) {
     config.headers['Authorization'] = "Bearer ".concat(token);
   }
 
-  if (!Object(lodash__WEBPACK_IMPORTED_MODULE_3__["isPlainObject"])(response) || !Object(lodash__WEBPACK_IMPORTED_MODULE_3__["isPlainObject"])(config)) {
+  if (!Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isPlainObject"])(response) || !Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isPlainObject"])(config)) {
     throw errorResponse;
   }
 
@@ -2965,7 +3129,7 @@ function errorHandler(errorResponse) {
     details: {}
   };
 
-  if (Object(lodash__WEBPACK_IMPORTED_MODULE_3__["isPlainObject"])(config)) {
+  if (Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isPlainObject"])(config)) {
     errorData.request = {
       url: config.url,
       headers: config.headers,
@@ -2974,7 +3138,7 @@ function errorHandler(errorResponse) {
     };
   }
 
-  if (data && Object(lodash__WEBPACK_IMPORTED_MODULE_3__["isPlainObject"])(data)) {
+  if (data && Object(lodash__WEBPACK_IMPORTED_MODULE_2__["isPlainObject"])(data)) {
     if ('requestId' in data) {
       errorData.requestId = data.requestId || 'UNKNOWN';
     }
@@ -21581,6 +21745,120 @@ function arrObjKeys(obj, inspect) {
 }
 
 
+/***/ }),
+
+/***/ "../node_modules/p-throttle/index.js":
+/*!*******************************************!*\
+  !*** ../node_modules/p-throttle/index.js ***!
+  \*******************************************/
+/*! no static exports found */
+/***/ (function(module, exports, __webpack_require__) {
+
+"use strict";
+
+
+class AbortError extends Error {
+	constructor() {
+		super('Throttled function aborted');
+		this.name = 'AbortError';
+	}
+}
+
+const pThrottle = ({limit, interval, strict}) => {
+	if (!Number.isFinite(limit)) {
+		throw new TypeError('Expected `limit` to be a finite number');
+	}
+
+	if (!Number.isFinite(interval)) {
+		throw new TypeError('Expected `interval` to be a finite number');
+	}
+
+	const queue = new Map();
+
+	let currentTick = 0;
+	let activeCount = 0;
+
+	function windowedDelay() {
+		const now = Date.now();
+
+		if ((now - currentTick) > interval) {
+			activeCount = 1;
+			currentTick = now;
+			return 0;
+		}
+
+		if (activeCount < limit) {
+			activeCount++;
+		} else {
+			currentTick += interval;
+			activeCount = 1;
+		}
+
+		return currentTick - now;
+	}
+
+	const strictTicks = [];
+
+	function strictDelay() {
+		const now = Date.now();
+
+		if (strictTicks.length < limit) {
+			strictTicks.push(now);
+			return 0;
+		}
+
+		const earliestTime = strictTicks.shift() + interval;
+
+		if (now >= earliestTime) {
+			strictTicks.push(now);
+			return 0;
+		}
+
+		strictTicks.push(earliestTime);
+		return earliestTime - now;
+	}
+
+	const getDelay = strict ? strictDelay : windowedDelay;
+
+	return function_ => {
+		const throttled = function (...args) {
+			if (!throttled.isEnabled) {
+				return (async () => function_.apply(this, args))();
+			}
+
+			let timeout;
+			return new Promise((resolve, reject) => {
+				const execute = () => {
+					resolve(function_.apply(this, args));
+					queue.delete(timeout);
+				};
+
+				timeout = setTimeout(execute, getDelay());
+
+				queue.set(timeout, reject);
+			});
+		};
+
+		throttled.abort = () => {
+			for (const timeout of queue.keys()) {
+				clearTimeout(timeout);
+				queue.get(timeout)(new AbortError());
+			}
+
+			queue.clear();
+			strictTicks.splice(0, strictTicks.length);
+		};
+
+		throttled.isEnabled = true;
+
+		return throttled;
+	};
+};
+
+module.exports = pThrottle;
+module.exports.AbortError = AbortError;
+
+
 /***/ }),
 
 /***/ "../node_modules/process/browser.js":
@@ -26336,7 +26614,7 @@ function createClient(params) {
   var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   var userAgent = Object(contentful_sdk_core__WEBPACK_IMPORTED_MODULE_0__["getUserAgentHeader"])( // @ts-expect-error
-  "".concat(sdkMain, "/").concat("7.41.0"), params.application, params.integration, params.feature);
+  "".concat(sdkMain, "/").concat("7.42.2"), params.application, params.integration, params.feature);
   var adapter = Object(_create_adapter__WEBPACK_IMPORTED_MODULE_1__["createAdapter"])(params); // Parameters<?> and ReturnType<?> only return the types of the last overload
   // https://github.com/microsoft/TypeScript/issues/26591
   // @ts-expect-error