newt-client-js 1.1.0 → 1.2.0

package/README.md

@@ -53,6 +53,8 @@ The `createClient` method supports several options you may set to achieve the ex
 | `projectUid` | | **Required.** Your project uid. |
 | `token` | | **Required.** Your Newt CDN API token or Newt API token. |
 | `apiType` | `cdn` | You can specify `cdn` or `api`. Please specify `cdn` to send a request to the Newt CDN API, or `api` to send a request to the Newt API. |
+| `retryOnError` | `true` | By default, this client will retry if the response status is 429 too many requests or 500 server error. To turn off this behavior, set this to `false`. |
+| `retryLimit` | `3` | The number of times to retry before failure. Please specify a value less than or equal to `10`. |
 
 ### Get contents
 

package/dist/createClient.d.ts

@@ -1,5 +1,5 @@
 import { CreateClientParams, GetContentsParams, GetContentParams, Contents, GetAppParams, AppMeta } from './types';
-export declare const createClient: ({ projectUid, token, apiType, }: CreateClientParams) => {
+export declare const createClient: ({ projectUid, token, apiType, retryOnError, retryLimit, }: CreateClientParams) => {
     getContents: <T>({ appUid, modelUid, query, }: GetContentsParams) => Promise<Contents<T>>;
     getContent: <T_1>({ appUid, modelUid, contentId, query, }: GetContentParams) => Promise<T_1>;
     getApp: ({ appUid }: GetAppParams) => Promise<AppMeta | null>;

package/dist/createClient.js

@@ -41,19 +41,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClient = void 0;
 var axios_1 = __importDefault(require("axios"));
+var axios_retry_1 = __importDefault(require("axios-retry"));
 var parseQuery_1 = require("./utils/parseQuery");
 var createClient = function (_a) {
-    var projectUid = _a.projectUid, token = _a.token, _b = _a.apiType, apiType = _b === void 0 ? 'cdn' : _b;
+    var projectUid = _a.projectUid, token = _a.token, _b = _a.apiType, apiType = _b === void 0 ? 'cdn' : _b, _c = _a.retryOnError, retryOnError = _c === void 0 ? true : _c, _d = _a.retryLimit, retryLimit = _d === void 0 ? 3 : _d;
     if (!projectUid)
         throw new Error('projectUid parameter is required.');
     if (!token)
         throw new Error('token parameter is required.');
     if (!['cdn', 'api'].includes(apiType))
         throw new Error("apiType parameter should be set to \"cdn\" or \"api\". apiType: " + apiType);
+    if (retryLimit > 10)
+        throw new Error('retryLimit should be a value less than or equal to 10.');
     var axiosInstance = axios_1.default.create({
         baseURL: "https://" + projectUid + "." + apiType + ".newt.so/v1",
         headers: { Authorization: "Bearer " + token },
     });
+    if (retryOnError) {
+        (0, axios_retry_1.default)(axiosInstance, {
+            retries: retryLimit,
+            retryCondition: function (error) {
+                var _a, _b;
+                return ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 429 || ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) === 500;
+            },
+            retryDelay: function (retryCount) {
+                return retryCount * 1000;
+            },
+        });
+    }
     var getContents = function (_a) {
         var appUid = _a.appUid, modelUid = _a.modelUid, query = _a.query;
         return __awaiter(void 0, void 0, void 0, function () {

package/dist/types.d.ts

@@ -2,6 +2,8 @@ export interface CreateClientParams {
     projectUid: string;
     token: string;
     apiType?: 'cdn' | 'api';
+    retryOnError?: boolean;
+    retryLimit?: number;
 }
 export interface GetContentsParams {
     appUid: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newt-client-js",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "JavaScript SDK for Newt's API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -39,7 +39,8 @@
     ]
   },
   "dependencies": {
-    "axios": "^0.21.1",
+    "axios": "^0.25.0",
+    "axios-retry": "^3.2.4",
     "qs": "^6.10.1"
   },
   "devDependencies": {