@map-colonies/mc-utils 3.0.0 → 3.2.0

package/dist/communication/http/httpClient.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -33,315 +22,210 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpClient = void 0;
-var axios_1 = __importDefault(require("axios"));
-var http_status_codes_1 = __importDefault(require("http-status-codes"));
-var axios_retry_1 = __importStar(require("axios-retry"));
-var lodash_1 = require("lodash");
-var error_types_1 = require("@map-colonies/error-types");
-var HttpClient = /** @class */ (function () {
-    function HttpClient(logger, baseUrl, targetService, retryConfig, disableDebugLogs) {
-        if (targetService === void 0) { targetService = ''; }
-        if (disableDebugLogs === void 0) { disableDebugLogs = false; }
-        var _this = this;
-        var _a;
+const axios_1 = __importDefault(require("axios"));
+const http_status_codes_1 = __importDefault(require("http-status-codes"));
+const axios_retry_1 = __importStar(require("axios-retry"));
+const lodash_1 = require("lodash");
+const error_types_1 = require("@map-colonies/error-types");
+class HttpClient {
+    logger;
+    baseUrl;
+    targetService;
+    retryConfig;
+    disableDebugLogs;
+    axiosOptions = {};
+    axiosClient;
+    constructor(logger, baseUrl, targetService = '', retryConfig, disableDebugLogs = false) {
         this.logger = logger;
         this.baseUrl = baseUrl;
         this.targetService = targetService;
         this.retryConfig = retryConfig;
         this.disableDebugLogs = disableDebugLogs;
-        this.axiosOptions = {};
         this.axiosClient = axios_1.default.create();
         this.axiosOptions.baseURL = baseUrl;
-        var axiosRetryConfig = retryConfig
+        const axiosRetryConfig = retryConfig
             ? this.parseConfig(retryConfig)
             : {
                 retries: 0,
             };
-        var delayFunc = (_a = axiosRetryConfig.retryDelay) !== null && _a !== void 0 ? _a : (function () { return 0; });
-        axiosRetryConfig.retryDelay = function (retryCount, error) {
-            _this.logger.error({
+        const delayFunc = axiosRetryConfig.retryDelay ?? (() => 0);
+        axiosRetryConfig.retryDelay = (retryCount, error) => {
+            this.logger.error({
                 err: error,
                 retries: retryCount,
-                targetService: _this.targetService,
-                msg: "error from ".concat(_this.targetService, "."),
+                targetService: this.targetService,
+                msg: `error from ${this.targetService}.`,
                 msgError: error.message,
             });
             return delayFunc(retryCount, error);
         };
         (0, axios_retry_1.default)(this.axiosClient, axiosRetryConfig);
     }
-    HttpClient.prototype.get = function (url, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_1, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                targetService: this.targetService,
-                                msg: "Send GET message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.get(url, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_1 = _a.sent();
-                        error = this.wrapError(url, err_1);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.post = function (url, body, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_2, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                body: body,
-                                targetService: this.targetService,
-                                msg: "Send POST message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.post(url, body, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_2 = _a.sent();
-                        error = this.wrapError(url, err_2, body);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.put = function (url, body, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_3, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                body: body,
-                                targetService: this.targetService,
-                                msg: "Send PUT message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.put(url, body, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_3 = _a.sent();
-                        error = this.wrapError(url, err_3, body);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.delete = function (url, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_4, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                targetService: this.targetService,
-                                msg: "Send DELTE message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.delete(url, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_4 = _a.sent();
-                        error = this.wrapError(url, err_4);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.head = function (url, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_5, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                targetService: this.targetService,
-                                msg: "Send HEAD message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.head(url, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_5 = _a.sent();
-                        error = this.wrapError(url, err_5);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.options = function (url, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_6, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                targetService: this.targetService,
-                                msg: "Send OPTIONS message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.options(url, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_6 = _a.sent();
-                        error = this.wrapError(url, err_6);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.patch = function (url, body, queryParams, retryConfig, auth, headers) {
-        return __awaiter(this, void 0, void 0, function () {
-            var reqConfig, res, err_7, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
-                        if (!this.disableDebugLogs) {
-                            this.logger.debug({
-                                reqConfig: reqConfig,
-                                url: url,
-                                targetService: this.targetService,
-                                msg: "Send PATCH message to ".concat(this.targetService, "."),
-                            });
-                        }
-                        return [4 /*yield*/, this.axiosClient.patch(url, body, reqConfig)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res.data];
-                    case 2:
-                        err_7 = _a.sent();
-                        error = this.wrapError(url, err_7);
-                        throw error;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    HttpClient.prototype.getRequestConfig = function (retryConfig, queryParams, auth, headers) {
+    async get(url, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    targetService: this.targetService,
+                    msg: `Send GET message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.get(url, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err);
+            throw error;
+        }
+    }
+    async post(url, body, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    body,
+                    targetService: this.targetService,
+                    msg: `Send POST message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.post(url, body, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err, body);
+            throw error;
+        }
+    }
+    async put(url, body, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    body,
+                    targetService: this.targetService,
+                    msg: `Send PUT message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.put(url, body, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err, body);
+            throw error;
+        }
+    }
+    async delete(url, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    targetService: this.targetService,
+                    msg: `Send DELTE message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.delete(url, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err);
+            throw error;
+        }
+    }
+    async head(url, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    targetService: this.targetService,
+                    msg: `Send HEAD message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.head(url, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err);
+            throw error;
+        }
+    }
+    async options(url, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    targetService: this.targetService,
+                    msg: `Send OPTIONS message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.options(url, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err);
+            throw error;
+        }
+    }
+    async patch(url, body, queryParams, retryConfig, auth, headers) {
+        try {
+            const reqConfig = this.getRequestConfig(retryConfig, queryParams, auth, headers);
+            if (!this.disableDebugLogs) {
+                this.logger.debug({
+                    reqConfig,
+                    url,
+                    targetService: this.targetService,
+                    msg: `Send PATCH message to ${this.targetService}.`,
+                });
+            }
+            const res = await this.axiosClient.patch(url, body, reqConfig);
+            return res.data;
+        }
+        catch (err) {
+            const error = this.wrapError(url, err);
+            throw error;
+        }
+    }
+    getRequestConfig(retryConfig, queryParams, auth, headers) {
         // eslint-disable-next-line @typescript-eslint/naming-convention
-        var reqConfig = retryConfig ? __assign(__assign({}, this.axiosOptions), { 'axios-retry': retryConfig }) : __assign({}, this.axiosOptions);
+        const reqConfig = retryConfig ? { ...this.axiosOptions, 'axios-retry': retryConfig } : { ...this.axiosOptions };
         if (queryParams !== undefined) {
-            reqConfig.params = reqConfig.params !== undefined ? __assign(__assign({}, reqConfig.params), queryParams) : queryParams;
+            reqConfig.params = reqConfig.params !== undefined ? { ...reqConfig.params, ...queryParams } : queryParams;
         }
         if (auth !== undefined) {
             reqConfig.auth = auth;
         }
         if (headers !== undefined) {
-            reqConfig.headers = reqConfig.headers !== undefined ? __assign(__assign({}, reqConfig.headers), headers) : headers;
+            reqConfig.headers = reqConfig.headers !== undefined ? { ...reqConfig.headers, ...headers } : headers;
         }
         return reqConfig;
-    };
-    HttpClient.prototype.wrapError = function (url, err, body) {
-        var _a;
-        var message = (0, lodash_1.get)(err, 'response.data.message', undefined);
-        switch ((_a = err.response) === null || _a === void 0 ? void 0 : _a.status) {
+    }
+    wrapError(url, err, body) {
+        const message = (0, lodash_1.get)(err, 'response.data.message', undefined);
+        switch (err.response?.status) {
             case http_status_codes_1.default.BAD_REQUEST:
                 if (!this.disableDebugLogs) {
                     this.logger.debug({
-                        err: err,
-                        url: url,
-                        body: body,
+                        err,
+                        url,
+                        body,
                         targetService: this.targetService,
-                        msg: "invalid request error recieved from service ".concat(this.targetService, "."),
+                        msg: `invalid request error recieved from service ${this.targetService}.`,
                         msgError: err.message,
                     });
                 }
@@ -349,11 +233,11 @@ var HttpClient = /** @class */ (function () {
             case http_status_codes_1.default.NOT_FOUND:
                 if (!this.disableDebugLogs) {
                     this.logger.debug({
-                        err: err,
-                        url: url,
-                        body: body,
+                        err,
+                        url,
+                        body,
                         targetService: this.targetService,
-                        msg: "not found error recieved from service ".concat(this.targetService, "."),
+                        msg: `not found error recieved from service ${this.targetService}.`,
                         msgError: err.message,
                     });
                 }
@@ -361,11 +245,11 @@ var HttpClient = /** @class */ (function () {
             case http_status_codes_1.default.CONFLICT:
                 if (!this.disableDebugLogs) {
                     this.logger.debug({
-                        err: err,
-                        url: url,
-                        body: body,
+                        err,
+                        url,
+                        body,
                         targetService: this.targetService,
-                        msg: "conflict error recieved from service ".concat(this.targetService, "."),
+                        msg: `conflict error recieved from service ${this.targetService}.`,
                         msgError: err.message,
                     });
                 }
@@ -373,11 +257,11 @@ var HttpClient = /** @class */ (function () {
             case http_status_codes_1.default.FORBIDDEN:
                 if (!this.disableDebugLogs) {
                     this.logger.debug({
-                        err: err,
-                        url: url,
-                        body: body,
+                        err,
+                        url,
+                        body,
                         targetService: this.targetService,
-                        msg: "forbidden error recieved from service ".concat(this.targetService, "."),
+                        msg: `forbidden error recieved from service ${this.targetService}.`,
                         msgError: err.message,
                     });
                 }
@@ -385,38 +269,50 @@ var HttpClient = /** @class */ (function () {
             case http_status_codes_1.default.UNAUTHORIZED:
                 if (!this.disableDebugLogs) {
                     this.logger.debug({
-                        err: err,
-                        url: url,
-                        body: body,
+                        err,
+                        url,
+                        body,
                         targetService: this.targetService,
-                        msg: "unauthorized error recieved from service ".concat(this.targetService, "."),
+                        msg: `unauthorized error recieved from service ${this.targetService}.`,
                         msgError: err.message,
                     });
                 }
                 throw new error_types_1.UnauthorizedError(err, message);
+            case http_status_codes_1.default.METHOD_NOT_ALLOWED:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `method not allowed error recieved from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                throw new error_types_1.MethodNotAllowedError(err, message);
             default:
                 this.logger.error({
-                    err: err,
-                    url: url,
-                    body: body,
+                    err,
+                    url,
+                    body,
                     targetService: this.targetService,
-                    msg: "Internal Server Error recieved from service ".concat(this.targetService, "."),
+                    msg: `Internal Server Error recieved from service ${this.targetService}.`,
                     msgError: err.message,
                 });
                 return new error_types_1.InternalServerError(err);
         }
-    };
-    HttpClient.prototype.parseConfig = function (config) {
-        var retries = config.attempts - 1;
+    }
+    parseConfig(config) {
+        const retries = config.attempts - 1;
         if (retries < 0) {
             throw new Error('invalid retry configuration: attempts must be positive');
         }
-        var delay;
+        let delay;
         if (config.delay === 'exponential') {
             delay = axios_retry_1.exponentialDelay;
         }
         else if (typeof config.delay === 'number') {
-            delay = function () {
+            delay = () => {
                 return config.delay;
             };
         }
@@ -428,8 +324,7 @@ var HttpClient = /** @class */ (function () {
             retryDelay: delay,
             shouldResetTimeout: config.shouldResetTimeout,
         };
-    };
-    return HttpClient;
-}());
+    }
+}
 exports.HttpClient = HttpClient;
 //# sourceMappingURL=httpClient.js.map