@odata2ts/http-client-axios 0.7.0

package/CHANGELOG.md

@@ -0,0 +1,98 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.7.0 (2023-06-03)
+
+### Features
+
+* **axios:** take over axios-odata-client as http-client-axios ([#1](https://github.com/odata2ts/http-client/issues/1)) ([d679f60](https://github.com/odata2ts/http-client/commit/d679f60087adfdefa00f2a4860bed77ca9b15654))
+* switch to http-client-api ([52d1b86](https://github.com/odata2ts/http-client/commit/52d1b868ee82dbaf45486da6b22fdcf4c773dfb8))
+* switch to http-client-api ([5a6da23](https://github.com/odata2ts/http-client/commit/5a6da23053b3ea5adb866bb7e30b469f1b8ed260))
+
+### BREAKING CHANGES
+
+* **axios:** new name and axios becomes peer dependency
+
+# [0.6.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.5.3...@odata2ts/axios-odata-client@0.6.0) (2023-04-20)
+
+### Features
+
+* better errors for jquery and axios odata clients ([#139](https://github.com/odata2ts/odata2ts/issues/139)) ([bb74514](https://github.com/odata2ts/odata2ts/commit/bb745144fb37235ad9864ab78eebbecf1d69107c))
+
+## [0.5.3](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.5.2...@odata2ts/axios-odata-client@0.5.3) (2023-04-08)
+
+**Note:** Version bump only for package @odata2ts/axios-odata-client
+
+## [0.5.2](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.5.1...@odata2ts/axios-odata-client@0.5.2) (2023-02-03)
+
+**Note:** Version bump only for package @odata2ts/axios-odata-client
+
+## [0.5.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.5.0...@odata2ts/axios-odata-client@0.5.1) (2023-01-07)
+
+**Note:** Version bump only for package @odata2ts/axios-odata-client
+
+# [0.5.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.4.0...@odata2ts/axios-odata-client@0.5.0) (2023-01-05)
+
+### Features
+
+* **axios-odata-client:** default error message retriever ([#82](https://github.com/odata2ts/odata2ts/issues/82)) ([11b7b61](https://github.com/odata2ts/odata2ts/commit/11b7b6171291ba78c2e2b4c7ab39a6c425d02cf1))
+
+* **axios-odata-client:** MERGE implementation for V2 ([#83](https://github.com/odata2ts/odata2ts/issues/83)) ([097005f](https://github.com/odata2ts/odata2ts/commit/097005fda1f4008c1fe3ea71f177697867e761fe))
+
+### BREAKING CHANGES
+
+* **axios-odata-client:** errorMessageRetriever is not part of the constructor signature anymore; use the setter if you want to apply a custom error message retriever
+
+# [0.4.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.2.3...@odata2ts/axios-odata-client@0.4.0) (2022-12-18)
+
+### Features
+
+* **odata-client-api:** dynamic response data model for put and patch ([b6d9a7d](https://github.com/odata2ts/odata2ts/commit/b6d9a7de45b39106693515c6e2b5490112547ae4))
+
+### BREAKING CHANGES
+
+* **odata-client-api:** put and patch allow for response values now => OData v4 specifies that either void or the model representation might be returned (void is more usual though)
+
+# [0.3.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.2.3...@odata2ts/axios-odata-client@0.3.0) (2022-12-18)
+
+### Features
+
+* **odata-client-api:** dynamic response data model for put and patch ([b6d9a7d](https://github.com/odata2ts/odata2ts/commit/b6d9a7de45b39106693515c6e2b5490112547ae4))
+
+### BREAKING CHANGES
+
+* **odata-client-api:** put and patch allow for response values now => OData v4 specifies that either void or the model representation might be returned (void is more usual though)
+
+## [0.2.3](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.2.2...@odata2ts/axios-odata-client@0.2.3) (2022-09-08)
+
+**Note:** Version bump only for package @odata2ts/axios-odata-client
+
+## [0.2.2](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.2.1...@odata2ts/axios-odata-client@0.2.2) (2022-08-25)
+
+### Bug Fixes
+
+* **axios-odata-client:** export everything from AxiosODataClient ([#55](https://github.com/odata2ts/odata2ts/issues/55)) ([b43e8f8](https://github.com/odata2ts/odata2ts/commit/b43e8f88b54605edd75ced95fd09b84267c52716))
+
+## [0.2.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.2.0...@odata2ts/axios-odata-client@0.2.1) (2022-07-11)
+
+**Note:** Version bump only for package @odata2ts/axios-odata-client
+
+# [0.2.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.1.1...@odata2ts/axios-odata-client@0.2.0) (2022-07-06)
+
+### Features
+
+* add option to enable automatic csrf token handling ([#32](https://github.com/odata2ts/odata2ts/issues/32)) ([cf4b8c6](https://github.com/odata2ts/odata2ts/commit/cf4b8c60f02ef1fdf7af267e61791e4b7d94fb3e))
+
+## [0.1.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/axios-odata-client@0.1.0...@odata2ts/axios-odata-client@0.1.1) (2022-06-30)
+
+### Bug Fixes
+
+* add prebulish script to guarantee building before publishing ([b6986db](https://github.com/odata2ts/odata2ts/commit/b6986dbdb258b7b3cb8f36ab52ae1ff7b093f7dc))
+
+# 0.1.0 (2022-06-02)
+
+### Features
+
+* **axios-odata-client:** introduce new module ([ea5684f](https://github.com/odata2ts/odata2ts/commit/ea5684f1f07a7b753e7ef587f41fbc450578497a))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 odata2ts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/http-client-axios?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/http-client-axios)
+
+# Axios HTTP Client
+
+The **Axios HTTP Client** uses - as its name suggests - [axios](https://github.com/axios/axios) for realizing
+the HTTP communication for [odata2ts](https://github.com/odata2ts/odata2ts).
+
+It supports:
+
+- request configuration
+- automatic CSRF token handling
+
+## Installation
+
+Install package `@odata2ts/http-client-axios` as runtime dependency:
+
+```bash
+npm install --save @odata2ts/http-client-axios
+```
+
+s
+
+## Documentation
+
+[Axios HTTP Client Documentation](https://odata2ts.github.io/docs/odata-client/http-client/axios)
+
+Main documentation for the odata2ts eco system:
+[https://odata2ts.github.io](https://odata2ts.github.io/)
+
+## Tests
+
+See folder [test](https://github.com/odata2ts/http-client/tree/main/packages/axios/test)
+for unit tests.
+
+See folder [int-test](https://github.com/odata2ts/http-client/tree/main/packages/axios/int-test) for
+integration tests.
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests, suggestions, bug reports, usage questions etc.
+via [GitHub issues](https://github.com/odata2ts/http-client/issues).
+
+Contributions and feedback are encouraged and always welcome.
+
+See the [contribution guidelines](https://github.com/odata2ts/http-client/blob/main/CONTRIBUTING.md) for further information.
+
+## License
+
+MIT - see [License](./LICENSE).

package/lib/AxiosClient.d.ts

@@ -0,0 +1,26 @@
+import { HttpResponseModel, ODataHttpClient } from "@odata2ts/http-client-api";
+import { AxiosRequestConfig } from "./AxiosRequestConfig";
+export type ErrorMessageRetriever<ResponseType = any> = (error: any) => string | null | undefined;
+export interface ClientOptions {
+    useCsrfProtection?: boolean;
+    csrfTokenFetchUrl?: string;
+}
+export declare const DEFAULT_ERROR_MESSAGE = "No error message!";
+export declare const getV2OrV4ErrorMessage: ErrorMessageRetriever;
+export declare class AxiosClient implements ODataHttpClient<AxiosRequestConfig> {
+    private clientOptions?;
+    private readonly client;
+    private csrfToken;
+    private getErrorMessage;
+    constructor(config?: AxiosRequestConfig, clientOptions?: ClientOptions | undefined);
+    setErrorMessageRetriever<T = any>(getErrorMsg: ErrorMessageRetriever<T>): void;
+    private setupSecurityToken;
+    private fetchSecurityToken;
+    private sendRequest;
+    post<ResponseModel>(url: string, data: any, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    get<ResponseModel>(url: string, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    merge<ResponseModel>(url: string, data: any, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    delete(url: string, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<void>>;
+}

package/lib/AxiosClient.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxiosClient = exports.getV2OrV4ErrorMessage = exports.DEFAULT_ERROR_MESSAGE = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const AxiosClientError_1 = require("./AxiosClientError");
+const AxiosRequestConfig_1 = require("./AxiosRequestConfig");
+exports.DEFAULT_ERROR_MESSAGE = "No error message!";
+const FAILURE_MISSING_CSRF_URL = "When automatic CSRF token handling is activated, the URL must be supplied via attribute [csrfTokenFetchUrl]!";
+const FAILURE_NO_RESPONSE = "No response from server! Failure: ";
+const FAILURE_NO_REQUEST = "No request was sent! Failure: ";
+const FAILURE_RESPONSE_MESSAGE = "OData server responded with error: ";
+const FAILURE_AXIOS = "Fatal Axios failure: ";
+function buildErrorMessage(prefix, error) {
+    const msg = typeof error === "string" ? error : error === null || error === void 0 ? void 0 : error.message;
+    return prefix + (msg || exports.DEFAULT_ERROR_MESSAGE);
+}
+const getV2OrV4ErrorMessage = (responseData) => {
+    var _a;
+    const eMsg = (_a = responseData === null || responseData === void 0 ? void 0 : responseData.error) === null || _a === void 0 ? void 0 : _a.message;
+    return typeof (eMsg === null || eMsg === void 0 ? void 0 : eMsg.value) === "string" ? eMsg.value : eMsg;
+};
+exports.getV2OrV4ErrorMessage = getV2OrV4ErrorMessage;
+class AxiosClient {
+    constructor(config, clientOptions) {
+        var _a;
+        this.clientOptions = clientOptions;
+        this.getErrorMessage = exports.getV2OrV4ErrorMessage;
+        this.client = axios_1.default.create((0, AxiosRequestConfig_1.getDefaultConfig)(config));
+        if (clientOptions && clientOptions.useCsrfProtection && !((_a = clientOptions.csrfTokenFetchUrl) === null || _a === void 0 ? void 0 : _a.trim())) {
+            throw new Error(FAILURE_MISSING_CSRF_URL);
+        }
+    }
+    setErrorMessageRetriever(getErrorMsg) {
+        this.getErrorMessage = getErrorMsg;
+    }
+    setupSecurityToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (!this.csrfToken) {
+                this.csrfToken = yield this.fetchSecurityToken();
+            }
+            return this.csrfToken;
+        });
+    }
+    fetchSecurityToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const fetchUrl = this.clientOptions.csrfTokenFetchUrl;
+            const response = yield this.get(fetchUrl, { headers: { "x-csrf-token": "Fetch" } });
+            return response.headers["x-csrf-token"];
+        });
+    }
+    sendRequest(config) {
+        var _a, _b, _c;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (typeof config.url !== "string") {
+                throw new Error("Value for URL must be provided!");
+            }
+            // setup automatic CSRF token handling
+            if (((_a = this.clientOptions) === null || _a === void 0 ? void 0 : _a.useCsrfProtection) &&
+                ["POST", "PUT", "PATCH", "DELETE"].includes(config.method.toUpperCase())) {
+                const csrfToken = yield this.setupSecurityToken();
+                if (typeof csrfToken === "string") {
+                    if (!config.headers) {
+                        config.headers = {};
+                    }
+                    config.headers["x-csrf-token"] = csrfToken;
+                }
+            }
+            try {
+                return yield this.client.request(config);
+            }
+            catch (error) {
+                if (error.isAxiosError) {
+                    const axiosError = error;
+                    // automatic CSRF token handling
+                    // csrf token expired, let's reset it and perform the original request again
+                    if (((_b = this.clientOptions) === null || _b === void 0 ? void 0 : _b.useCsrfProtection) &&
+                        ((_c = axiosError.response) === null || _c === void 0 ? void 0 : _c.status) === 403 &&
+                        axiosError.response.headers["x-csrf-token"] === "Required") {
+                        this.csrfToken = undefined;
+                        return this.sendRequest(config);
+                    }
+                    // regular failure handling
+                    if (axiosError.response) {
+                        const msg = buildErrorMessage(FAILURE_RESPONSE_MESSAGE, this.getErrorMessage(axiosError.response.data));
+                        throw new AxiosClientError_1.AxiosClientError(msg, axiosError.response.status, axiosError);
+                    }
+                    // fatal failure without response
+                    else {
+                        throw new AxiosClientError_1.AxiosClientError(buildErrorMessage(axiosError.request ? FAILURE_NO_RESPONSE : FAILURE_NO_REQUEST, axiosError), undefined, axiosError);
+                    }
+                }
+                // not an Axios error
+                throw new AxiosClientError_1.AxiosClientError(buildErrorMessage(FAILURE_AXIOS, error), undefined, error);
+            }
+        });
+    }
+    post(url, data, requestConfig) {
+        return this.sendRequest(Object.assign(Object.assign({}, requestConfig), { url, data, method: "POST" }));
+    }
+    get(url, requestConfig) {
+        return this.sendRequest(Object.assign(Object.assign({}, requestConfig), { url, method: "GET" }));
+    }
+    put(url, data, requestConfig) {
+        return this.sendRequest(Object.assign(Object.assign({}, requestConfig), { url, data, method: "PUT" }));
+    }
+    patch(url, data, requestConfig) {
+        return this.sendRequest(Object.assign(Object.assign({}, requestConfig), { url, data, method: "PATCH" }));
+    }
+    merge(url, data, requestConfig) {
+        return this.sendRequest((0, AxiosRequestConfig_1.mergeConfig)(requestConfig, {
+            url,
+            method: "POST",
+            headers: { "X-Http-Method": "MERGE" },
+            data,
+        }));
+    }
+    delete(url, requestConfig) {
+        return this.sendRequest(Object.assign(Object.assign({}, requestConfig), { url, method: "DELETE" }));
+    }
+}
+exports.AxiosClient = AxiosClient;
+//# sourceMappingURL=AxiosClient.js.map

package/lib/AxiosClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosClient.js","sourceRoot":"","sources":["../src/AxiosClient.ts"],"names":[],"mappings":";;;;AACA,0DAAsG;AAEtG,yDAAsD;AACtD,6DAAgH;AASnG,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AACzD,MAAM,wBAAwB,GAC5B,8GAA8G,CAAC;AACjH,MAAM,mBAAmB,GAAG,oCAAoC,CAAC;AACjE,MAAM,kBAAkB,GAAG,gCAAgC,CAAC;AAC5D,MAAM,wBAAwB,GAAG,qCAAqC,CAAC;AACvE,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAE9C,SAAS,iBAAiB,CAAC,MAAc,EAAE,KAAU;IACnD,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,KAAe,aAAf,KAAK,uBAAL,KAAK,CAAY,OAAO,CAAC;IAC1E,OAAO,MAAM,GAAG,CAAC,GAAG,IAAI,6BAAqB,CAAC,CAAC;AACjD,CAAC;AAEM,MAAM,qBAAqB,GAA0B,CAAC,YAAiB,EAAsB,EAAE;;IACpG,MAAM,IAAI,GAAG,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,0CAAE,OAAO,CAAC;IAC1C,OAAO,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7D,CAAC,CAAC;AAHW,QAAA,qBAAqB,yBAGhC;AAEF,MAAa,WAAW;IAKtB,YAAY,MAA2B,EAAU,aAA6B;;QAA7B,kBAAa,GAAb,aAAa,CAAgB;QAFtE,oBAAe,GAA0B,6BAAqB,CAAC;QAGrE,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC,IAAA,qCAAgB,EAAC,MAAM,CAAC,CAAC,CAAC;QAErD,IAAI,aAAa,IAAI,aAAa,CAAC,iBAAiB,IAAI,CAAC,CAAA,MAAA,aAAa,CAAC,iBAAiB,0CAAE,IAAI,EAAE,CAAA,EAAE;YAChG,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;IACH,CAAC;IAEM,wBAAwB,CAAU,WAAqC;QAC5E,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;IACrC,CAAC;IAEa,kBAAkB;;YAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aAClD;YACD,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;KAAA;IAEa,kBAAkB;;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAc,CAAC,iBAAkB,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YAEpF,OAAO,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1C,CAAC;KAAA;IAEa,WAAW,CAAe,MAA6B;;;YACnE,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,EAAE;gBAClC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACpD;YAED,sCAAsC;YACtC,IACE,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,iBAAiB;gBACrC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAO,CAAC,WAAW,EAAE,CAAC,EACzE;gBACA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAClD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;oBACjC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;wBACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;qBACrB;oBACD,MAAM,CAAC,OAAQ,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;iBAC7C;aACF;YAED,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAA+B,CAAC,CAAC;aACnE;YAAC,OAAO,KAAU,EAAE;gBACnB,IAAK,KAAoB,CAAC,YAAY,EAAE;oBACtC,MAAM,UAAU,GAAG,KAAmB,CAAC;oBAEvC,gCAAgC;oBAChC,4EAA4E;oBAC5E,IACE,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,iBAAiB;wBACrC,CAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,MAAK,GAAG;wBACnC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,UAAU,EAC1D;wBACA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;wBAC3B,OAAO,IAAI,CAAC,WAAW,CAAe,MAAM,CAAC,CAAC;qBAC/C;oBAED,2BAA2B;oBAC3B,IAAI,UAAU,CAAC,QAAQ,EAAE;wBACvB,MAAM,GAAG,GAAG,iBAAiB,CAAC,wBAAwB,EAAE,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxG,MAAM,IAAI,mCAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;qBACzE;oBACD,iCAAiC;yBAC5B;wBACH,MAAM,IAAI,mCAAgB,CACxB,iBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,kBAAkB,EAAE,UAAU,CAAC,EAC5F,SAAS,EACT,UAAU,CACX,CAAC;qBACH;iBACF;gBACD,qBAAqB;gBACrB,MAAM,IAAI,mCAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;aACvF;;KACF;IAEM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,iCAAM,aAAa,KAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,IAAG,CAAC;IAC3E,CAAC;IACM,GAAG,CACR,GAAW,EACX,aAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,iCAAM,aAAa,KAAE,GAAG,EAAE,MAAM,EAAE,KAAK,IAAG,CAAC;IACpE,CAAC;IACM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,iCAAM,aAAa,KAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,IAAG,CAAC;IAC1E,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,iCAAM,aAAa,KAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,IAAG,CAAC;IAC5E,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CACrB,IAAA,gCAAW,EAAC,aAAa,EAAE;YACzB,GAAG;YACH,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,eAAe,EAAE,OAAO,EAAE;YACrC,IAAI;SACL,CAAC,CACH,CAAC;IACJ,CAAC;IACM,MAAM,CAAC,GAAW,EAAE,aAAkC;QAC3D,OAAO,IAAI,CAAC,WAAW,iCAAM,aAAa,KAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,IAAG,CAAC;IACvE,CAAC;CACF;AAlID,kCAkIC","sourcesContent":["import { HttpResponseModel, ODataHttpClient } from \"@odata2ts/http-client-api\";\nimport axios, { AxiosError, AxiosInstance, AxiosRequestConfig as OriginalRequestConfig } from \"axios\";\n\nimport { AxiosClientError } from \"./AxiosClientError\";\nimport { AxiosRequestConfig, InternalRequestConfig, getDefaultConfig, mergeConfig } from \"./AxiosRequestConfig\";\n\nexport type ErrorMessageRetriever<ResponseType = any> = (error: any) => string | null | undefined;\n\nexport interface ClientOptions {\n  useCsrfProtection?: boolean;\n  csrfTokenFetchUrl?: string;\n}\n\nexport const DEFAULT_ERROR_MESSAGE = \"No error message!\";\nconst FAILURE_MISSING_CSRF_URL =\n  \"When automatic CSRF token handling is activated, the URL must be supplied via attribute [csrfTokenFetchUrl]!\";\nconst FAILURE_NO_RESPONSE = \"No response from server! Failure: \";\nconst FAILURE_NO_REQUEST = \"No request was sent! Failure: \";\nconst FAILURE_RESPONSE_MESSAGE = \"OData server responded with error: \";\nconst FAILURE_AXIOS = \"Fatal Axios failure: \";\n\nfunction buildErrorMessage(prefix: string, error: any) {\n  const msg = typeof error === \"string\" ? error : (error as Error)?.message;\n  return prefix + (msg || DEFAULT_ERROR_MESSAGE);\n}\n\nexport const getV2OrV4ErrorMessage: ErrorMessageRetriever = (responseData: any): string | undefined => {\n  const eMsg = responseData?.error?.message;\n  return typeof eMsg?.value === \"string\" ? eMsg.value : eMsg;\n};\n\nexport class AxiosClient implements ODataHttpClient<AxiosRequestConfig> {\n  private readonly client: AxiosInstance;\n  private csrfToken: string | undefined;\n  private getErrorMessage: ErrorMessageRetriever = getV2OrV4ErrorMessage;\n\n  constructor(config?: AxiosRequestConfig, private clientOptions?: ClientOptions) {\n    this.client = axios.create(getDefaultConfig(config));\n\n    if (clientOptions && clientOptions.useCsrfProtection && !clientOptions.csrfTokenFetchUrl?.trim()) {\n      throw new Error(FAILURE_MISSING_CSRF_URL);\n    }\n  }\n\n  public setErrorMessageRetriever<T = any>(getErrorMsg: ErrorMessageRetriever<T>) {\n    this.getErrorMessage = getErrorMsg;\n  }\n\n  private async setupSecurityToken() {\n    if (!this.csrfToken) {\n      this.csrfToken = await this.fetchSecurityToken();\n    }\n    return this.csrfToken;\n  }\n\n  private async fetchSecurityToken(): Promise<string | undefined> {\n    const fetchUrl = this.clientOptions!.csrfTokenFetchUrl!;\n    const response = await this.get(fetchUrl, { headers: { \"x-csrf-token\": \"Fetch\" } });\n\n    return response.headers[\"x-csrf-token\"];\n  }\n\n  private async sendRequest<ResponseType>(config: InternalRequestConfig): Promise<HttpResponseModel<ResponseType>> {\n    if (typeof config.url !== \"string\") {\n      throw new Error(\"Value for URL must be provided!\");\n    }\n\n    // setup automatic CSRF token handling\n    if (\n      this.clientOptions?.useCsrfProtection &&\n      [\"POST\", \"PUT\", \"PATCH\", \"DELETE\"].includes(config.method!.toUpperCase())\n    ) {\n      const csrfToken = await this.setupSecurityToken();\n      if (typeof csrfToken === \"string\") {\n        if (!config.headers) {\n          config.headers = {};\n        }\n        config.headers![\"x-csrf-token\"] = csrfToken;\n      }\n    }\n\n    try {\n      return await this.client.request(config as OriginalRequestConfig);\n    } catch (error: any) {\n      if ((error as AxiosError).isAxiosError) {\n        const axiosError = error as AxiosError;\n\n        // automatic CSRF token handling\n        // csrf token expired, let's reset it and perform the original request again\n        if (\n          this.clientOptions?.useCsrfProtection &&\n          axiosError.response?.status === 403 &&\n          axiosError.response.headers[\"x-csrf-token\"] === \"Required\"\n        ) {\n          this.csrfToken = undefined;\n          return this.sendRequest<ResponseType>(config);\n        }\n\n        // regular failure handling\n        if (axiosError.response) {\n          const msg = buildErrorMessage(FAILURE_RESPONSE_MESSAGE, this.getErrorMessage(axiosError.response.data));\n          throw new AxiosClientError(msg, axiosError.response.status, axiosError);\n        }\n        // fatal failure without response\n        else {\n          throw new AxiosClientError(\n            buildErrorMessage(axiosError.request ? FAILURE_NO_RESPONSE : FAILURE_NO_REQUEST, axiosError),\n            undefined,\n            axiosError\n          );\n        }\n      }\n      // not an Axios error\n      throw new AxiosClientError(buildErrorMessage(FAILURE_AXIOS, error), undefined, error);\n    }\n  }\n\n  public post<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AxiosRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest({ ...requestConfig, url, data, method: \"POST\" });\n  }\n  public get<ResponseModel>(\n    url: string,\n    requestConfig?: AxiosRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest({ ...requestConfig, url, method: \"GET\" });\n  }\n  public put<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AxiosRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest({ ...requestConfig, url, data, method: \"PUT\" });\n  }\n  public patch<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AxiosRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest({ ...requestConfig, url, data, method: \"PATCH\" });\n  }\n  public merge<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AxiosRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest(\n      mergeConfig(requestConfig, {\n        url,\n        method: \"POST\",\n        headers: { \"X-Http-Method\": \"MERGE\" },\n        data,\n      })\n    );\n  }\n  public delete(url: string, requestConfig?: AxiosRequestConfig): Promise<HttpResponseModel<void>> {\n    return this.sendRequest({ ...requestConfig, url, method: \"DELETE\" });\n  }\n}\n"]}

package/lib/AxiosClientError.d.ts

@@ -0,0 +1,6 @@
+import type { AxiosError } from "axios";
+export declare class AxiosClientError extends Error {
+    readonly status: number | undefined;
+    readonly cause: Error | AxiosError | undefined;
+    constructor(msg: string, status: number | undefined, cause: Error | AxiosError | undefined);
+}

package/lib/AxiosClientError.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxiosClientError = void 0;
+class AxiosClientError extends Error {
+    constructor(msg, status, cause) {
+        super(msg, { cause });
+        this.status = status;
+        this.cause = cause;
+        this.name = this.constructor.name;
+    }
+}
+exports.AxiosClientError = AxiosClientError;
+//# sourceMappingURL=AxiosClientError.js.map

package/lib/AxiosClientError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosClientError.js","sourceRoot":"","sources":["../src/AxiosClientError.ts"],"names":[],"mappings":";;;AAEA,MAAa,gBAAiB,SAAQ,KAAK;IACzC,YACE,GAAW,EACK,MAA0B,EAC1B,KAAqC;QAErD,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAHN,WAAM,GAAN,MAAM,CAAoB;QAC1B,UAAK,GAAL,KAAK,CAAgC;QAGrD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AATD,4CASC","sourcesContent":["import type { AxiosError } from \"axios\";\n\nexport class AxiosClientError extends Error {\n  constructor(\n    msg: string,\n    public readonly status: number | undefined,\n    public readonly cause: Error | AxiosError | undefined\n  ) {\n    super(msg, { cause });\n    this.name = this.constructor.name;\n  }\n}\n"]}

package/lib/AxiosRequestConfig.d.ts

@@ -0,0 +1,11 @@
+import { CreateAxiosDefaults, AxiosRequestConfig as OriginalRequestConfig } from "axios";
+export interface AxiosRequestConfig extends Omit<OriginalRequestConfig, "method" | "url" | "headers"> {
+    headers?: Record<string, string>;
+}
+export interface InternalRequestConfig extends Omit<OriginalRequestConfig, "headers"> {
+    url?: string;
+    headers?: Record<string, string>;
+}
+export declare function getDefaultConfig(config?: AxiosRequestConfig | undefined): CreateAxiosDefaults;
+export declare function mergeConfig(): undefined;
+export declare function mergeConfig(...configs: Array<InternalRequestConfig | undefined>): InternalRequestConfig;

package/lib/AxiosRequestConfig.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeConfig = exports.getDefaultConfig = void 0;
+const tslib_1 = require("tslib");
+const DEFAULT_CONFIG = {
+    headers: { Accept: "application/json", "Content-Type": "application/json" },
+};
+function getDefaultConfig(config) {
+    return mergeConfig(DEFAULT_CONFIG, config);
+}
+exports.getDefaultConfig = getDefaultConfig;
+function mergeConfig(...configs) {
+    if (!configs.length) {
+        return undefined;
+    }
+    return configs
+        .filter((c) => !!c)
+        .reduce((collector, current) => {
+        const { headers } = current, passThrough = tslib_1.__rest(current, ["headers"]);
+        if (headers) {
+            Object.entries(headers).forEach(([key, val]) => (collector.headers[key] = val));
+        }
+        return Object.assign(Object.assign({}, collector), passThrough);
+    }, { headers: {} });
+}
+exports.mergeConfig = mergeConfig;
+//# sourceMappingURL=AxiosRequestConfig.js.map

package/lib/AxiosRequestConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosRequestConfig.js","sourceRoot":"","sources":["../src/AxiosRequestConfig.ts"],"names":[],"mappings":";;;;AAWA,MAAM,cAAc,GAA0B;IAC5C,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE;CAC5E,CAAC;AAEF,SAAgB,gBAAgB,CAAC,MAAuC;IACtE,OAAO,WAAW,CAAC,cAAc,EAAE,MAA+B,CAAwB,CAAC;AAC7F,CAAC;AAFD,4CAEC;AAID,SAAgB,WAAW,CAAC,GAAG,OAAiD;IAC9E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,CAAC,EAA8B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9C,MAAM,CACL,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;QACrB,MAAM,EAAE,OAAO,KAAqB,OAAO,EAAvB,WAAW,kBAAK,OAAO,EAArC,WAA2B,CAAU,CAAC;QAE5C,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,OAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;SAClF;QACD,uCAAY,SAAS,GAAK,WAAW,EAAG;IAC1C,CAAC,EACD,EAAE,OAAO,EAAE,EAAE,EAAE,CAChB,CAAC;AACN,CAAC;AAlBD,kCAkBC","sourcesContent":["import { CreateAxiosDefaults, AxiosRequestConfig as OriginalRequestConfig } from \"axios\";\n\nexport interface AxiosRequestConfig extends Omit<OriginalRequestConfig, \"method\" | \"url\" | \"headers\"> {\n  headers?: Record<string, string>;\n}\n\nexport interface InternalRequestConfig extends Omit<OriginalRequestConfig, \"headers\"> {\n  url?: string;\n  headers?: Record<string, string>;\n}\n\nconst DEFAULT_CONFIG: InternalRequestConfig = {\n  headers: { Accept: \"application/json\", \"Content-Type\": \"application/json\" },\n};\n\nexport function getDefaultConfig(config?: AxiosRequestConfig | undefined): CreateAxiosDefaults {\n  return mergeConfig(DEFAULT_CONFIG, config as InternalRequestConfig) as CreateAxiosDefaults;\n}\n\nexport function mergeConfig(): undefined;\nexport function mergeConfig(...configs: Array<InternalRequestConfig | undefined>): InternalRequestConfig;\nexport function mergeConfig(...configs: Array<InternalRequestConfig | undefined>) {\n  if (!configs.length) {\n    return undefined;\n  }\n\n  return configs\n    .filter((c): c is InternalRequestConfig => !!c)\n    .reduce<InternalRequestConfig>(\n      (collector, current) => {\n        const { headers, ...passThrough } = current;\n\n        if (headers) {\n          Object.entries(headers).forEach(([key, val]) => (collector.headers![key] = val));\n        }\n        return { ...collector, ...passThrough };\n      },\n      { headers: {} }\n    );\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./AxiosClient";
+export { AxiosClientError } from "./AxiosClientError";
+export { AxiosRequestConfig } from "./AxiosRequestConfig";

package/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxiosClientError = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./AxiosClient"), exports);
+var AxiosClientError_1 = require("./AxiosClientError");
+Object.defineProperty(exports, "AxiosClientError", { enumerable: true, get: function () { return AxiosClientError_1.AxiosClientError; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,wDAA8B;AAC9B,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA","sourcesContent":["export * from \"./AxiosClient\";\nexport { AxiosClientError } from \"./AxiosClientError\";\nexport { AxiosRequestConfig } from \"./AxiosRequestConfig\";\n"]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@odata2ts/http-client-axios",
+  "version": "0.7.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Axios based odata HTTP client consumable by odata2ts",
+  "license": "MIT",
+  "repository": "git@github.com:odata2ts/http-client.git",
+  "author": "texttechne",
+  "main": "./lib/index.js",
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "check-circular-deps": "madge ./src --extensions ts --circular",
+    "clean": "rimraf lib coverage",
+    "compile": "tsc",
+    "prepublish": "yarn build",
+    "test": "jest --passWithNoTests"
+  },
+  "files": [
+    "*.md",
+    "lib",
+    "LICENSE"
+  ],
+  "keywords": [
+    "http client",
+    "axios",
+    "odata",
+    "odata2ts",
+    "ts",
+    "typescript"
+  ],
+  "peerDependencies": {
+    "axios": "^0.27.0 || ^1.0.0"
+  },
+  "dependencies": {
+    "@odata2ts/http-client-api": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.23",
+    "axios": "^1.4.0",
+    "jest": "29.5.0",
+    "rimraf": "^5.0.1",
+    "ts-jest": "^29.1.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.0.4"
+  },
+  "types": "./lib/index.d.ts",
+  "gitHead": "a93b726286ef9a118fda63b0e7900d6b3e739dd2"
+}