@contentstack/marketplace-sdk 1.2.9 → 1.4.0

package/CHANGELOG.md

@@ -1,10 +1,18 @@
 # Changelog
-## [v1.2.8](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.2.9) (2024-08-04)
+
+## [v1.4.0](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.3.0) (2024-08-25)
+ - Enhancement: Retry logic to make use of x-ratelimit-remaining header
+
+## [v1.3.0](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.3.0) (2024-08-11)
+ - Enh: Add search function to query apps by names
+
+## [v1.2.9](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.2.9) (2024-08-04)
  - Fix: Fixed the Linting issues
  - Updated all the dependency to the latest version
  - Added Pre-commit hook to run the snyk and talismand scans
 
 ## [v1.2.8](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.2.8) (2024-05-26)
+
  - Fix: Added params support to getInstalledApps method for enhanced flexibility
 
 ## [v1.2.7](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.2.7) (2024-05-15)

package/dist/es-modules/core/concurrency-queue.js

@@ -213,18 +213,31 @@ export function ConcurrencyQueue(_ref) {
       } else {
         return Promise.reject(responseHandler(error));
       }
-    } else if (response.status === 429 || response.status === 401 && _this.config.refreshToken) {
-      retryErrorType = "Error with status: ".concat(response.status);
-      networkError++;
-      if (networkError > _this.config.retryLimit) {
-        return Promise.reject(responseHandler(error));
+    } else {
+      var rateLimitRemaining = response.headers['x-ratelimit-remaining'];
+      if (rateLimitRemaining !== undefined && parseInt(rateLimitRemaining) <= 0) {
+        // return Promise.reject(responseHandler(error))
+
+        _this.running.shift();
+        return _delay(wait).then(function () {
+          error.config.retryCount = networkError++;
+          // deepcode ignore Ssrf: URL is dynamic
+          return axios(updateRequestConfig(error, 'Rate Limit Hit', wait));
+        });
+      }
+      if (response.status === 429 || response.status === 401 && _this.config.refreshToken) {
+        retryErrorType = "Error with status: ".concat(response.status);
+        networkError++;
+        if (networkError > _this.config.retryLimit) {
+          return Promise.reject(responseHandler(error));
+        }
+        _this.running.shift();
+        // Cool down the running requests
+        _delay(wait, response.status === 401);
+        error.config.retryCount = networkError;
+        // deepcode ignore Ssrf: URL is dynamic
+        return axios(updateRequestConfig(error, retryErrorType, wait));
       }
-      _this.running.shift();
-      // Cool down the running requests
-      _delay(wait, response.status === 401);
-      error.config.retryCount = networkError;
-      // deepcode ignore Ssrf: URL is dynamic
-      return axios(updateRequestConfig(error, retryErrorType, wait));
     }
     if (_this.config.retryCondition && _this.config.retryCondition(error)) {
       retryErrorType = error.response ? "Error with status: ".concat(response.status) : "Error Code:".concat(error.code);

package/dist/es-modules/marketplace/index.js

@@ -112,6 +112,74 @@ export function Marketplace(http, data) {
     this.urlPath = '/manifests';
     this.findAllApps = fetchAll(http, AppCollection, this.params);
 
+    /**
+     * @description Search installed apps
+     * @memberof Marketplace
+     * @func searchInstalledApps
+     * @param {String} search - Search term
+     * @param {Object} queryParams - Additional query parameters
+     * @returns {Promise<ContentstackCollection<App>>}
+     *
+     * @example
+     * import * as contentstack from '@contentstack/marketplace'
+     * const client = contentstack.client({ authtoken: 'TOKEN'})
+     *
+     * client.marketplace('organization_uid').searchApps('search_term')
+     * .then((collection) => console.log(collection))
+     *
+     */
+    this.searchApps = /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(search) {
+        var queryParams,
+          headers,
+          response,
+          _args = arguments,
+          _t;
+        return _regeneratorRuntime.wrap(function (_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              queryParams = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+              _context.prev = 1;
+              if (search) {
+                _context.next = 2;
+                break;
+              }
+              throw new Error("Search parameter is required");
+            case 2:
+              headers = {
+                headers: _objectSpread({}, cloneDeep(_this.params)),
+                params: _objectSpread({
+                  search: search
+                }, cloneDeep(queryParams))
+              };
+              _context.next = 3;
+              return http.get(_this.urlPath, headers);
+            case 3:
+              response = _context.sent;
+              if (!response.data) {
+                _context.next = 4;
+                break;
+              }
+              return _context.abrupt("return", response.data);
+            case 4:
+              throw error(response);
+            case 5:
+              _context.next = 7;
+              break;
+            case 6:
+              _context.prev = 6;
+              _t = _context["catch"](1);
+              throw error(_t);
+            case 7:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, null, [[1, 6]]);
+      }));
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }();
     /**
      * @description To get the apps list of authorized apps for the particular organization
      * @memberof Marketplace
@@ -126,44 +194,44 @@ export function Marketplace(http, data) {
      * .then((roles) => console.log(roles))
      *
      */
-    this.findAllAuthorizedApps = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+    this.findAllAuthorizedApps = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
       var param,
         headers,
         response,
-        _args = arguments,
-        _t;
-      return _regeneratorRuntime.wrap(function (_context) {
-        while (1) switch (_context.prev = _context.next) {
+        _args2 = arguments,
+        _t2;
+      return _regeneratorRuntime.wrap(function (_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
           case 0:
-            param = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+            param = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
             headers = {
               headers: _objectSpread({}, cloneDeep(_this.params))
             };
             headers.params = _objectSpread({}, param);
-            _context.prev = 1;
-            _context.next = 2;
+            _context2.prev = 1;
+            _context2.next = 2;
             return http.get("/authorized-apps", headers);
           case 2:
-            response = _context.sent;
+            response = _context2.sent;
             if (!response.data) {
-              _context.next = 3;
+              _context2.next = 3;
               break;
             }
-            return _context.abrupt("return", response.data);
+            return _context2.abrupt("return", response.data);
           case 3:
-            return _context.abrupt("return", error(response));
+            return _context2.abrupt("return", error(response));
           case 4:
-            _context.next = 6;
+            _context2.next = 6;
             break;
           case 5:
-            _context.prev = 5;
-            _t = _context["catch"](1);
-            return _context.abrupt("return", error(_t));
+            _context2.prev = 5;
+            _t2 = _context2["catch"](1);
+            return _context2.abrupt("return", error(_t2));
           case 6:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
-      }, _callee, null, [[1, 5]]);
+      }, _callee2, null, [[1, 5]]);
     }));
   }
   return this;

package/dist/es5/core/concurrency-queue.js

@@ -223,18 +223,31 @@ function ConcurrencyQueue(_ref) {
       } else {
         return Promise.reject(responseHandler(error));
       }
-    } else if (response.status === 429 || response.status === 401 && _this.config.refreshToken) {
-      retryErrorType = "Error with status: ".concat(response.status);
-      networkError++;
-      if (networkError > _this.config.retryLimit) {
-        return Promise.reject(responseHandler(error));
+    } else {
+      var rateLimitRemaining = response.headers['x-ratelimit-remaining'];
+      if (rateLimitRemaining !== undefined && parseInt(rateLimitRemaining) <= 0) {
+        // return Promise.reject(responseHandler(error))
+
+        _this.running.shift();
+        return _delay(wait).then(function () {
+          error.config.retryCount = networkError++;
+          // deepcode ignore Ssrf: URL is dynamic
+          return axios(updateRequestConfig(error, 'Rate Limit Hit', wait));
+        });
+      }
+      if (response.status === 429 || response.status === 401 && _this.config.refreshToken) {
+        retryErrorType = "Error with status: ".concat(response.status);
+        networkError++;
+        if (networkError > _this.config.retryLimit) {
+          return Promise.reject(responseHandler(error));
+        }
+        _this.running.shift();
+        // Cool down the running requests
+        _delay(wait, response.status === 401);
+        error.config.retryCount = networkError;
+        // deepcode ignore Ssrf: URL is dynamic
+        return axios(updateRequestConfig(error, retryErrorType, wait));
       }
-      _this.running.shift();
-      // Cool down the running requests
-      _delay(wait, response.status === 401);
-      error.config.retryCount = networkError;
-      // deepcode ignore Ssrf: URL is dynamic
-      return axios(updateRequestConfig(error, retryErrorType, wait));
     }
     if (_this.config.retryCondition && _this.config.retryCondition(error)) {
       retryErrorType = error.response ? "Error with status: ".concat(response.status) : "Error Code:".concat(error.code);

package/dist/es5/marketplace/index.js

@@ -125,6 +125,74 @@ function Marketplace(http, data) {
     this.urlPath = '/manifests';
     this.findAllApps = (0, _entity.fetchAll)(http, AppCollection, this.params);
 
+    /**
+     * @description Search installed apps
+     * @memberof Marketplace
+     * @func searchInstalledApps
+     * @param {String} search - Search term
+     * @param {Object} queryParams - Additional query parameters
+     * @returns {Promise<ContentstackCollection<App>>}
+     *
+     * @example
+     * import * as contentstack from '@contentstack/marketplace'
+     * const client = contentstack.client({ authtoken: 'TOKEN'})
+     *
+     * client.marketplace('organization_uid').searchApps('search_term')
+     * .then((collection) => console.log(collection))
+     *
+     */
+    this.searchApps = /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator3["default"])(/*#__PURE__*/_regenerator2["default"].mark(function _callee(search) {
+        var queryParams,
+          headers,
+          response,
+          _args = arguments,
+          _t;
+        return _regenerator2["default"].wrap(function (_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              queryParams = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+              _context.prev = 1;
+              if (search) {
+                _context.next = 2;
+                break;
+              }
+              throw new Error("Search parameter is required");
+            case 2:
+              headers = {
+                headers: _objectSpread({}, (0, _cloneDeep2["default"])(_this.params)),
+                params: _objectSpread({
+                  search: search
+                }, (0, _cloneDeep2["default"])(queryParams))
+              };
+              _context.next = 3;
+              return http.get(_this.urlPath, headers);
+            case 3:
+              response = _context.sent;
+              if (!response.data) {
+                _context.next = 4;
+                break;
+              }
+              return _context.abrupt("return", response.data);
+            case 4:
+              throw (0, _contentstackError2["default"])(response);
+            case 5:
+              _context.next = 7;
+              break;
+            case 6:
+              _context.prev = 6;
+              _t = _context["catch"](1);
+              throw (0, _contentstackError2["default"])(_t);
+            case 7:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, null, [[1, 6]]);
+      }));
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }();
     /**
      * @description To get the apps list of authorized apps for the particular organization
      * @memberof Marketplace
@@ -139,44 +207,44 @@ function Marketplace(http, data) {
      * .then((roles) => console.log(roles))
      *
      */
-    this.findAllAuthorizedApps = /*#__PURE__*/(0, _asyncToGenerator3["default"])(/*#__PURE__*/_regenerator2["default"].mark(function _callee() {
+    this.findAllAuthorizedApps = /*#__PURE__*/(0, _asyncToGenerator3["default"])(/*#__PURE__*/_regenerator2["default"].mark(function _callee2() {
       var param,
         headers,
         response,
-        _args = arguments,
-        _t;
-      return _regenerator2["default"].wrap(function (_context) {
-        while (1) switch (_context.prev = _context.next) {
+        _args2 = arguments,
+        _t2;
+      return _regenerator2["default"].wrap(function (_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
           case 0:
-            param = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+            param = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
             headers = {
               headers: _objectSpread({}, (0, _cloneDeep2["default"])(_this.params))
             };
             headers.params = _objectSpread({}, param);
-            _context.prev = 1;
-            _context.next = 2;
+            _context2.prev = 1;
+            _context2.next = 2;
             return http.get("/authorized-apps", headers);
           case 2:
-            response = _context.sent;
+            response = _context2.sent;
             if (!response.data) {
-              _context.next = 3;
+              _context2.next = 3;
               break;
             }
-            return _context.abrupt("return", response.data);
+            return _context2.abrupt("return", response.data);
           case 3:
-            return _context.abrupt("return", (0, _contentstackError2["default"])(response));
+            return _context2.abrupt("return", (0, _contentstackError2["default"])(response));
           case 4:
-            _context.next = 6;
+            _context2.next = 6;
             break;
           case 5:
-            _context.prev = 5;
-            _t = _context["catch"](1);
-            return _context.abrupt("return", (0, _contentstackError2["default"])(_t));
+            _context2.prev = 5;
+            _t2 = _context2["catch"](1);
+            return _context2.abrupt("return", (0, _contentstackError2["default"])(_t2));
           case 6:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
-      }, _callee, null, [[1, 5]]);
+      }, _callee2, null, [[1, 5]]);
     }));
   }
   return this;