@map-colonies/mc-utils 3.1.0 → 3.3.0

package/dist/communication/http/httpClient.js

@@ -1,318 +1,354 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpClient = void 0;
-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.axiosClient = axios_1.default.create();
-        this.axiosOptions.baseURL = baseUrl;
-        const axiosRetryConfig = retryConfig
-            ? this.parseConfig(retryConfig)
-            : {
-                retries: 0,
-            };
-        const delayFunc = axiosRetryConfig.retryDelay ?? (() => 0);
-        axiosRetryConfig.retryDelay = (retryCount, error) => {
-            this.logger.error({
-                err: error,
-                retries: retryCount,
-                targetService: this.targetService,
-                msg: `error from ${this.targetService}.`,
-                msgError: error.message,
-            });
-            return delayFunc(retryCount, error);
-        };
-        (0, axios_retry_1.default)(this.axiosClient, axiosRetryConfig);
-    }
-    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
-        const reqConfig = retryConfig ? { ...this.axiosOptions, 'axios-retry': retryConfig } : { ...this.axiosOptions };
-        if (queryParams !== undefined) {
-            reqConfig.params = reqConfig.params !== undefined ? { ...reqConfig.params, ...queryParams } : queryParams;
-        }
-        if (auth !== undefined) {
-            reqConfig.auth = auth;
-        }
-        if (headers !== undefined) {
-            reqConfig.headers = reqConfig.headers !== undefined ? { ...reqConfig.headers, ...headers } : headers;
-        }
-        return reqConfig;
-    }
-    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,
-                        url,
-                        body,
-                        targetService: this.targetService,
-                        msg: `invalid request error recieved from service ${this.targetService}.`,
-                        msgError: err.message,
-                    });
-                }
-                return new error_types_1.BadRequestError(err, message);
-            case http_status_codes_1.default.NOT_FOUND:
-                if (!this.disableDebugLogs) {
-                    this.logger.debug({
-                        err,
-                        url,
-                        body,
-                        targetService: this.targetService,
-                        msg: `not found error recieved from service ${this.targetService}.`,
-                        msgError: err.message,
-                    });
-                }
-                return new error_types_1.NotFoundError(err, message);
-            case http_status_codes_1.default.CONFLICT:
-                if (!this.disableDebugLogs) {
-                    this.logger.debug({
-                        err,
-                        url,
-                        body,
-                        targetService: this.targetService,
-                        msg: `conflict error recieved from service ${this.targetService}.`,
-                        msgError: err.message,
-                    });
-                }
-                return new error_types_1.ConflictError(err, message);
-            case http_status_codes_1.default.FORBIDDEN:
-                if (!this.disableDebugLogs) {
-                    this.logger.debug({
-                        err,
-                        url,
-                        body,
-                        targetService: this.targetService,
-                        msg: `forbidden error recieved from service ${this.targetService}.`,
-                        msgError: err.message,
-                    });
-                }
-                throw new error_types_1.ForbiddenError(err, message);
-            case http_status_codes_1.default.UNAUTHORIZED:
-                if (!this.disableDebugLogs) {
-                    this.logger.debug({
-                        err,
-                        url,
-                        body,
-                        targetService: this.targetService,
-                        msg: `unauthorized error recieved from service ${this.targetService}.`,
-                        msgError: err.message,
-                    });
-                }
-                throw new error_types_1.UnauthorizedError(err, message);
-            default:
-                this.logger.error({
-                    err,
-                    url,
-                    body,
-                    targetService: this.targetService,
-                    msg: `Internal Server Error recieved from service ${this.targetService}.`,
-                    msgError: err.message,
-                });
-                return new error_types_1.InternalServerError(err);
-        }
-    }
-    parseConfig(config) {
-        const retries = config.attempts - 1;
-        if (retries < 0) {
-            throw new Error('invalid retry configuration: attempts must be positive');
-        }
-        let delay;
-        if (config.delay === 'exponential') {
-            delay = axios_retry_1.exponentialDelay;
-        }
-        else if (typeof config.delay === 'number') {
-            delay = () => {
-                return config.delay;
-            };
-        }
-        else {
-            throw new Error('invalid retry configuration: delay must be "exponential" or number');
-        }
-        return {
-            retries: retries,
-            retryDelay: delay,
-            shouldResetTimeout: config.shouldResetTimeout,
-        };
-    }
-}
-exports.HttpClient = HttpClient;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = void 0;
+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.axiosClient = axios_1.default.create();
+        this.axiosOptions.baseURL = baseUrl;
+        const axiosRetryConfig = retryConfig
+            ? this.parseConfig(retryConfig)
+            : {
+                retries: 0,
+            };
+        const delayFunc = axiosRetryConfig.retryDelay ?? (() => 0);
+        axiosRetryConfig.retryDelay = (retryCount, error) => {
+            this.logger.error({
+                err: error,
+                retries: retryCount,
+                targetService: this.targetService,
+                msg: `error from ${this.targetService}.`,
+                msgError: error.message,
+            });
+            return delayFunc(retryCount, error);
+        };
+        (0, axios_retry_1.default)(this.axiosClient, axiosRetryConfig);
+    }
+    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
+        const reqConfig = retryConfig ? { ...this.axiosOptions, 'axios-retry': retryConfig } : { ...this.axiosOptions };
+        if (queryParams !== undefined) {
+            reqConfig.params = reqConfig.params !== undefined ? { ...reqConfig.params, ...queryParams } : queryParams;
+        }
+        if (auth !== undefined) {
+            reqConfig.auth = auth;
+        }
+        if (headers !== undefined) {
+            reqConfig.headers = reqConfig.headers !== undefined ? { ...reqConfig.headers, ...headers } : headers;
+        }
+        return reqConfig;
+    }
+    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,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `invalid request error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.BadRequestError(err, message);
+            case http_status_codes_1.default.NOT_FOUND:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `not found error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.NotFoundError(err, message);
+            case http_status_codes_1.default.CONFLICT:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `conflict error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.ConflictError(err, message);
+            case http_status_codes_1.default.FORBIDDEN:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `forbidden error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.ForbiddenError(err, message);
+            case http_status_codes_1.default.UNAUTHORIZED:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `unauthorized error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return 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 received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.MethodNotAllowedError(err, message);
+            case http_status_codes_1.default.REQUEST_TOO_LONG:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `content too large error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.ContentTooLarge(err, message);
+            case http_status_codes_1.default.TOO_MANY_REQUESTS:
+                if (!this.disableDebugLogs) {
+                    this.logger.debug({
+                        err,
+                        url,
+                        body,
+                        targetService: this.targetService,
+                        msg: `too many requests error received from service ${this.targetService}.`,
+                        msgError: err.message,
+                    });
+                }
+                return new error_types_1.TooManyRequestsError(err, message);
+            default:
+                this.logger.error({
+                    err,
+                    url,
+                    body,
+                    targetService: this.targetService,
+                    msg: `Internal Server Error received from service ${this.targetService}.`,
+                    msgError: err.message,
+                });
+                return new error_types_1.InternalServerError(err);
+        }
+    }
+    parseConfig(config) {
+        const retries = config.attempts - 1;
+        if (retries < 0) {
+            throw new Error('invalid retry configuration: attempts must be positive');
+        }
+        let delay;
+        if (config.delay === 'exponential') {
+            delay = axios_retry_1.exponentialDelay;
+        }
+        else if (typeof config.delay === 'number') {
+            delay = () => {
+                return config.delay;
+            };
+        }
+        else {
+            throw new Error('invalid retry configuration: delay must be "exponential" or number');
+        }
+        return {
+            retries: retries,
+            retryDelay: delay,
+            shouldResetTimeout: config.shouldResetTimeout,
+        };
+    }
+}
+exports.HttpClient = HttpClient;
 //# sourceMappingURL=httpClient.js.map