@odata2ts/http-client-base 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.1.0 (2023-06-10)
+
+### Features
+
+* **http-client-base:** promote feature version & add some more documentation ([3216cf3](https://github.com/odata2ts/http-client/commit/3216cf34750732e9e3f064270351f56dac49e581))

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,80 @@
+[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/http-client-base?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/http-client-base)
+
+# OData HTTP Client Base
+
+Base implementation for [odata2ts](https://github.com/odata2ts/odata2ts) compatible HTTP clients:
+
+- implements automatic CSRF token handling
+  - allows user to set custom CSRF token header key (default: `x-csrf-token`)
+- implements standard error message retrieval method for OData error responses
+  - works for V2 & V4
+  - allows user to set custom retrieval method
+- streamlines all HTTP calls (POST, GET, ...) into one method
+
+## Installation
+
+Install package `@odata2ts/http-client-base` as dependency:
+
+```bash
+npm install --save @odata2ts/http-client-base
+```
+
+## Usage
+
+Extend the class `BaseHttpClient` to simplify your HttpClient implementation.
+You need to implement two abstract methods:
+
+```ts
+import { BaseHttpClient, BaseHttpClientOptions } from "@odata2ts/http-client-base";
+
+export interface MyRequestConfig {}
+
+export class MyHttpClient extends BaseHttpClient<MyRequestConfig> {
+    constructor(clientOptions: BaseHttpClientOptions) {
+        super(clientOptions);
+    }
+
+    protected addHeaderToRequestConfig(
+        headers: Record<string, string>,
+        config: BaseHttpClient | undefined
+    ): MyRequestConfig {
+        // your implementation
+    }
+
+    protected async executeRequest<ResponseModel>(
+        method: HttpMethods,
+        url: string,
+        data: any,
+        requestConfig: AxiosRequestConfig | undefined = {}
+    ): Promise<HttpResponseModel<ResponseModel>> {
+        // your implementation
+    }
+}
+```
+
+Compare any of the existing clients.
+
+## Documentation
+
+[HTTP Client Documentation](https://odata2ts.github.io/docs/http-client)
+
+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/core/test)
+for unit 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/BaseHttpClient.d.ts

@@ -0,0 +1,56 @@
+import { HttpResponseModel, ODataHttpClient } from "@odata2ts/http-client-api";
+import { ErrorMessageRetriever } from "./ErrorMessageRetriever";
+import { HttpMethods } from "./HttpMethods";
+export interface BaseHttpClientOptions {
+    useCsrfProtection?: boolean;
+    csrfTokenFetchUrl?: string;
+}
+export declare const DEFAULT_CSRF_TOKEN_KEY = "x-csrf-token";
+export declare abstract class BaseHttpClient<RequestConfigType> implements ODataHttpClient<RequestConfigType> {
+    private baseOptions;
+    private csrfToken;
+    private csrfTokenKey;
+    protected retrieveErrorMessage: ErrorMessageRetriever;
+    protected constructor(baseOptions?: BaseHttpClientOptions);
+    /**
+     * Use the given headers to either create an entire new request config or merge them into the given
+     * request config.
+     *
+     * @param headers
+     * @param config
+     * @returns request configuration
+     */
+    protected abstract addHeaderToRequestConfig(headers: Record<string, string>, config?: RequestConfigType): RequestConfigType;
+    /**
+     * Main function to implement by any extending http client.
+     * As it name suggests, the request gets executed in this method.
+     * Additionally, failures should be handled and errors of type <code>HttpClientError</code> should be thrown.
+     *
+     * @param method
+     * @param url
+     * @param data
+     * @param config
+     */
+    protected abstract executeRequest<ResponseModel>(method: HttpMethods, url: string, data: any, config?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    getCsrfTokenKey(): string;
+    setCsrfTokenKey(newKey: string): void;
+    setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever): void;
+    protected setupSecurityToken(): Promise<[string, string | undefined]>;
+    protected fetchSecurityToken(): Promise<string | undefined>;
+    /**
+     * Follows the template pattern.
+     *
+     * @param method
+     * @param url
+     * @param data
+     * @param requestConfig
+     * @private
+     */
+    private sendRequest;
+    get<ResponseModel>(url: string, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    merge<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    delete(url: string, requestConfig?: RequestConfigType): Promise<HttpResponseModel<void>>;
+}

package/lib/BaseHttpClient.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseHttpClient = exports.DEFAULT_CSRF_TOKEN_KEY = void 0;
+const tslib_1 = require("tslib");
+const ErrorMessageRetriever_1 = require("./ErrorMessageRetriever");
+const HttpMethods_1 = require("./HttpMethods");
+exports.DEFAULT_CSRF_TOKEN_KEY = "x-csrf-token";
+const EDIT_METHODS = ["POST", "PUT", "PATCH", "DELETE"];
+const FAILURE_MISSING_CSRF_URL = "When automatic CSRF token handling is activated, the URL must be supplied via attribute [csrfTokenFetchUrl]!";
+const FAILURE_MISSING_URL = "Value for URL must be provided!";
+class BaseHttpClient {
+    constructor(baseOptions = { useCsrfProtection: false }) {
+        var _a;
+        this.baseOptions = baseOptions;
+        this.csrfTokenKey = exports.DEFAULT_CSRF_TOKEN_KEY;
+        this.retrieveErrorMessage = ErrorMessageRetriever_1.retrieveErrorMessage;
+        if (baseOptions.useCsrfProtection && !((_a = baseOptions.csrfTokenFetchUrl) === null || _a === void 0 ? void 0 : _a.trim())) {
+            throw new Error(FAILURE_MISSING_CSRF_URL);
+        }
+    }
+    getCsrfTokenKey() {
+        return this.csrfTokenKey;
+    }
+    setCsrfTokenKey(newKey) {
+        this.csrfTokenKey = newKey || exports.DEFAULT_CSRF_TOKEN_KEY;
+    }
+    setErrorMessageRetriever(getErrorMsg) {
+        this.retrieveErrorMessage = getErrorMsg;
+    }
+    setupSecurityToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (!this.csrfToken) {
+                this.csrfToken = yield this.fetchSecurityToken();
+            }
+            return [this.csrfTokenKey, this.csrfToken];
+        });
+    }
+    fetchSecurityToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const fetchUrl = this.baseOptions.csrfTokenFetchUrl;
+            const response = yield this.get(fetchUrl, this.addHeaderToRequestConfig({ [this.csrfTokenKey]: "Fetch" }));
+            return response.headers[this.csrfTokenKey];
+        });
+    }
+    /**
+     * Follows the template pattern.
+     *
+     * @param method
+     * @param url
+     * @param data
+     * @param requestConfig
+     * @private
+     */
+    sendRequest(method, url, data, requestConfig) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            // noinspection SuspiciousTypeOfGuard
+            if (typeof url !== "string") {
+                throw new Error(FAILURE_MISSING_URL);
+            }
+            let config = requestConfig;
+            // setup automatic CSRF token handling
+            if (this.baseOptions.useCsrfProtection && EDIT_METHODS.includes(method)) {
+                const [tokenKey, tokenValue] = yield this.setupSecurityToken();
+                if (tokenValue) {
+                    config = this.addHeaderToRequestConfig({ [tokenKey]: tokenValue }, requestConfig);
+                }
+            }
+            try {
+                return yield this.executeRequest(method, url, data, config);
+            }
+            catch (e) {
+                const clientError = e;
+                // automatic CSRF token handling
+                if (!!this.baseOptions.useCsrfProtection &&
+                    clientError.status === 403 &&
+                    !!clientError.headers &&
+                    clientError.headers["x-csrf-token"] === "Required") {
+                    // token has expired: reset csrf token & perform the original request again
+                    this.csrfToken = undefined;
+                    return this.sendRequest(method, url, data, requestConfig);
+                }
+                throw e;
+            }
+        });
+    }
+    get(url, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Get, url, undefined, requestConfig);
+    }
+    post(url, data, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, requestConfig);
+    }
+    put(url, data, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Put, url, data, requestConfig);
+    }
+    patch(url, data, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Patch, url, data, requestConfig);
+    }
+    merge(url, data, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, this.addHeaderToRequestConfig({ "X-Http-Method": "MERGE" }, requestConfig));
+    }
+    delete(url, requestConfig) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig);
+    }
+}
+exports.BaseHttpClient = BaseHttpClient;
+//# sourceMappingURL=BaseHttpClient.js.map

package/lib/BaseHttpClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseHttpClient.js","sourceRoot":"","sources":["../src/BaseHttpClient.ts"],"names":[],"mappings":";;;;AAEA,mEAAsF;AACtF,+CAA4C;AAO/B,QAAA,sBAAsB,GAAG,cAAc,CAAC;AAErD,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AACxD,MAAM,wBAAwB,GAC5B,8GAA8G,CAAC;AACjH,MAAM,mBAAmB,GAAG,iCAAiC,CAAC;AAE9D,MAAsB,cAAc;IAMlC,YAA8B,cAAqC,EAAE,iBAAiB,EAAE,KAAK,EAAE;;QAAjE,gBAAW,GAAX,WAAW,CAAsD;QAJvF,iBAAY,GAAG,8BAAsB,CAAC;QAEpC,yBAAoB,GAA0B,4CAAoB,CAAC;QAG3E,IAAI,WAAW,CAAC,iBAAiB,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,iBAAiB,0CAAE,IAAI,EAAE,CAAA,EAAE;YAC3E,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;IACH,CAAC;IAgCM,eAAe;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAEM,eAAe,CAAC,MAAc;QACnC,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,8BAAsB,CAAC;IACvD,CAAC;IAEM,wBAAwB,CAAC,WAAkC;QAChE,IAAI,CAAC,oBAAoB,GAAG,WAAW,CAAC;IAC1C,CAAC;IAEe,kBAAkB;;YAChC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aAClD;YACD,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEe,kBAAkB;;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAY,CAAC,iBAAkB,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAE3G,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED;;;;;;;;OAQG;IACW,WAAW,CACvB,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAiC;;YAEjC,qCAAqC;YACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aACtC;YAED,IAAI,MAAM,GAAG,aAAa,CAAC;YAE3B,sCAAsC;YACtC,IAAI,IAAI,CAAC,WAAW,CAAC,iBAAiB,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACvE,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC/D,IAAI,UAAU,EAAE;oBACd,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,EAAE,aAAa,CAAC,CAAC;iBACnF;aACF;YAED,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,cAAc,CAAgB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;aAC5E;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,WAAW,GAAG,CAAqB,CAAC;gBAE1C,gCAAgC;gBAChC,IACE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,iBAAiB;oBACpC,WAAW,CAAC,MAAM,KAAK,GAAG;oBAC1B,CAAC,CAAC,WAAW,CAAC,OAAO;oBACrB,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,UAAU,EAClD;oBACA,2EAA2E;oBAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;oBAC3B,OAAO,IAAI,CAAC,WAAW,CAAgB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;iBAC1E;gBAED,MAAM,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEM,GAAG,CAAgB,GAAW,EAAE,aAAiC;QACtE,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACzF,CAAC;IACM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACrF,CAAC;IACM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACpF,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACtF,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,IAAI,EAChB,GAAG,EACH,IAAI,EACJ,IAAI,CAAC,wBAAwB,CAAC,EAAE,eAAe,EAAE,OAAO,EAAE,EAAE,aAAa,CAAC,CAC3E,CAAC;IACJ,CAAC;IACM,MAAM,CAAC,GAAW,EAAE,aAAiC;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAO,yBAAW,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACnF,CAAC;CACF;AA9JD,wCA8JC","sourcesContent":["import { HttpResponseModel, ODataClientError, ODataHttpClient } from \"@odata2ts/http-client-api\";\r\n\r\nimport { ErrorMessageRetriever, retrieveErrorMessage } from \"./ErrorMessageRetriever\";\r\nimport { HttpMethods } from \"./HttpMethods\";\r\n\r\nexport interface BaseHttpClientOptions {\r\n  useCsrfProtection?: boolean;\r\n  csrfTokenFetchUrl?: string;\r\n}\r\n\r\nexport const DEFAULT_CSRF_TOKEN_KEY = \"x-csrf-token\";\r\n\r\nconst EDIT_METHODS = [\"POST\", \"PUT\", \"PATCH\", \"DELETE\"];\r\nconst FAILURE_MISSING_CSRF_URL =\r\n  \"When automatic CSRF token handling is activated, the URL must be supplied via attribute [csrfTokenFetchUrl]!\";\r\nconst FAILURE_MISSING_URL = \"Value for URL must be provided!\";\r\n\r\nexport abstract class BaseHttpClient<RequestConfigType> implements ODataHttpClient<RequestConfigType> {\r\n  private csrfToken: string | undefined;\r\n  private csrfTokenKey = DEFAULT_CSRF_TOKEN_KEY;\r\n\r\n  protected retrieveErrorMessage: ErrorMessageRetriever = retrieveErrorMessage;\r\n\r\n  protected constructor(private baseOptions: BaseHttpClientOptions = { useCsrfProtection: false }) {\r\n    if (baseOptions.useCsrfProtection && !baseOptions.csrfTokenFetchUrl?.trim()) {\r\n      throw new Error(FAILURE_MISSING_CSRF_URL);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Use the given headers to either create an entire new request config or merge them into the given\r\n   * request config.\r\n   *\r\n   * @param headers\r\n   * @param config\r\n   * @returns request configuration\r\n   */\r\n  protected abstract addHeaderToRequestConfig(\r\n    headers: Record<string, string>,\r\n    config?: RequestConfigType\r\n  ): RequestConfigType;\r\n\r\n  /**\r\n   * Main function to implement by any extending http client.\r\n   * As it name suggests, the request gets executed in this method.\r\n   * Additionally, failures should be handled and errors of type <code>HttpClientError</code> should be thrown.\r\n   *\r\n   * @param method\r\n   * @param url\r\n   * @param data\r\n   * @param config\r\n   */\r\n  protected abstract executeRequest<ResponseModel>(\r\n    method: HttpMethods,\r\n    url: string,\r\n    data: any,\r\n    config?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>>;\r\n\r\n  public getCsrfTokenKey() {\r\n    return this.csrfTokenKey;\r\n  }\r\n\r\n  public setCsrfTokenKey(newKey: string) {\r\n    this.csrfTokenKey = newKey || DEFAULT_CSRF_TOKEN_KEY;\r\n  }\r\n\r\n  public setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever) {\r\n    this.retrieveErrorMessage = getErrorMsg;\r\n  }\r\n\r\n  protected async setupSecurityToken(): Promise<[string, string | undefined]> {\r\n    if (!this.csrfToken) {\r\n      this.csrfToken = await this.fetchSecurityToken();\r\n    }\r\n    return [this.csrfTokenKey, this.csrfToken];\r\n  }\r\n\r\n  protected async fetchSecurityToken(): Promise<string | undefined> {\r\n    const fetchUrl = this.baseOptions!.csrfTokenFetchUrl!;\r\n    const response = await this.get(fetchUrl, this.addHeaderToRequestConfig({ [this.csrfTokenKey]: \"Fetch\" }));\r\n\r\n    return response.headers[this.csrfTokenKey];\r\n  }\r\n\r\n  /**\r\n   * Follows the template pattern.\r\n   *\r\n   * @param method\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   * @private\r\n   */\r\n  private async sendRequest<ResponseModel>(\r\n    method: HttpMethods,\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    // noinspection SuspiciousTypeOfGuard\r\n    if (typeof url !== \"string\") {\r\n      throw new Error(FAILURE_MISSING_URL);\r\n    }\r\n\r\n    let config = requestConfig;\r\n\r\n    // setup automatic CSRF token handling\r\n    if (this.baseOptions.useCsrfProtection && EDIT_METHODS.includes(method)) {\r\n      const [tokenKey, tokenValue] = await this.setupSecurityToken();\r\n      if (tokenValue) {\r\n        config = this.addHeaderToRequestConfig({ [tokenKey]: tokenValue }, requestConfig);\r\n      }\r\n    }\r\n\r\n    try {\r\n      return await this.executeRequest<ResponseModel>(method, url, data, config);\r\n    } catch (e) {\r\n      const clientError = e as ODataClientError;\r\n\r\n      // automatic CSRF token handling\r\n      if (\r\n        !!this.baseOptions.useCsrfProtection &&\r\n        clientError.status === 403 &&\r\n        !!clientError.headers &&\r\n        clientError.headers[\"x-csrf-token\"] === \"Required\"\r\n      ) {\r\n        // token has expired: reset csrf token & perform the original request again\r\n        this.csrfToken = undefined;\r\n        return this.sendRequest<ResponseModel>(method, url, data, requestConfig);\r\n      }\r\n\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  public get<ResponseModel>(url: string, requestConfig?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(HttpMethods.Get, url, undefined, requestConfig);\r\n  }\r\n  public post<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(HttpMethods.Post, url, data, requestConfig);\r\n  }\r\n  public put<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(HttpMethods.Put, url, data, requestConfig);\r\n  }\r\n  public patch<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(HttpMethods.Patch, url, data, requestConfig);\r\n  }\r\n  public merge<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(\r\n      HttpMethods.Post,\r\n      url,\r\n      data,\r\n      this.addHeaderToRequestConfig({ \"X-Http-Method\": \"MERGE\" }, requestConfig)\r\n    );\r\n  }\r\n  public delete(url: string, requestConfig?: RequestConfigType): Promise<HttpResponseModel<void>> {\r\n    return this.sendRequest<void>(HttpMethods.Delete, url, undefined, requestConfig);\r\n  }\r\n}\r\n"]}

package/lib/ErrorMessageRetriever.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Function type used to retrieve the error message from the response payload.
+ *
+ * @return error message or <code>undefined</code> if retrieval failed / had no outcome
+ */
+export type ErrorMessageRetriever = (errorResponse: any) => string | undefined;
+/**
+ * Retrieves the OData error message from the response (V2 and V4 are supported).
+ * The structure of the error message is specified by OData.
+ *
+ * @param errorResponse
+ */
+export declare const retrieveErrorMessage: ErrorMessageRetriever;

package/lib/ErrorMessageRetriever.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveErrorMessage = void 0;
+/**
+ * Retrieves the OData error message from the response (V2 and V4 are supported).
+ * The structure of the error message is specified by OData.
+ *
+ * @param errorResponse
+ */
+const retrieveErrorMessage = (errorResponse) => {
+    var _a;
+    const eMsg = (_a = errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.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.retrieveErrorMessage = retrieveErrorMessage;
+//# sourceMappingURL=ErrorMessageRetriever.js.map

package/lib/ErrorMessageRetriever.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorMessageRetriever.js","sourceRoot":"","sources":["../src/ErrorMessageRetriever.ts"],"names":[],"mappings":";;;AAOA;;;;;GAKG;AACI,MAAM,oBAAoB,GAA0B,CAAC,aAAkB,EAAsB,EAAE;;IACpG,MAAM,IAAI,GAAG,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,0CAAE,OAAO,CAAC;IAC3C,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,oBAAoB,wBAG/B","sourcesContent":["/**\r\n * Function type used to retrieve the error message from the response payload.\r\n *\r\n * @return error message or <code>undefined</code> if retrieval failed / had no outcome\r\n */\r\nexport type ErrorMessageRetriever = (errorResponse: any) => string | undefined;\r\n\r\n/**\r\n * Retrieves the OData error message from the response (V2 and V4 are supported).\r\n * The structure of the error message is specified by OData.\r\n *\r\n * @param errorResponse\r\n */\r\nexport const retrieveErrorMessage: ErrorMessageRetriever = (errorResponse: any): string | undefined => {\r\n  const eMsg = errorResponse?.error?.message;\r\n  return typeof eMsg?.value === \"string\" ? eMsg.value : eMsg;\r\n};\r\n"]}

package/lib/HttpMethods.d.ts

@@ -0,0 +1,7 @@
+export declare enum HttpMethods {
+    Get = "GET",
+    Post = "POST",
+    Put = "PUT",
+    Patch = "PATCH",
+    Delete = "DELETE"
+}

package/lib/HttpMethods.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethods = void 0;
+var HttpMethods;
+(function (HttpMethods) {
+    HttpMethods["Get"] = "GET";
+    HttpMethods["Post"] = "POST";
+    HttpMethods["Put"] = "PUT";
+    HttpMethods["Patch"] = "PATCH";
+    HttpMethods["Delete"] = "DELETE";
+})(HttpMethods = exports.HttpMethods || (exports.HttpMethods = {}));
+//# sourceMappingURL=HttpMethods.js.map

package/lib/HttpMethods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpMethods.js","sourceRoot":"","sources":["../src/HttpMethods.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,0BAAW,CAAA;IACX,8BAAe,CAAA;IACf,gCAAiB,CAAA;AACnB,CAAC,EANW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAMtB","sourcesContent":["export enum HttpMethods {\r\n  Get = \"GET\",\r\n  Post = \"POST\",\r\n  Put = \"PUT\",\r\n  Patch = \"PATCH\",\r\n  Delete = \"DELETE\",\r\n}\r\n"]}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ErrorMessageRetriever";
+export { BaseHttpClient, BaseHttpClientOptions } from "./BaseHttpClient";
+export { HttpMethods } from "./HttpMethods";

package/lib/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethods = exports.BaseHttpClient = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ErrorMessageRetriever"), exports);
+var BaseHttpClient_1 = require("./BaseHttpClient");
+Object.defineProperty(exports, "BaseHttpClient", { enumerable: true, get: function () { return BaseHttpClient_1.BaseHttpClient; } });
+var HttpMethods_1 = require("./HttpMethods");
+Object.defineProperty(exports, "HttpMethods", { enumerable: true, get: function () { return HttpMethods_1.HttpMethods; } });
+//# 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,kEAAwC;AACxC,mDAAyE;AAAhE,gHAAA,cAAc,OAAA;AACvB,6CAA4C;AAAnC,0GAAA,WAAW,OAAA","sourcesContent":["export * from \"./ErrorMessageRetriever\";\r\nexport { BaseHttpClient, BaseHttpClientOptions } from \"./BaseHttpClient\";\r\nexport { HttpMethods } from \"./HttpMethods\";\r\n"]}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@odata2ts/http-client-base",
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Core functionality for odata2ts HTTP clients",
+  "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 ./test"
+  },
+  "files": [
+    "*.md",
+    "lib",
+    "LICENSE"
+  ],
+  "keywords": [
+    "http client",
+    "odata",
+    "ts",
+    "odata2ts"
+  ],
+  "dependencies": {
+    "@odata2ts/http-client-api": "^0.2.0"
+  },
+  "devDependencies": {
+    "@odata2ts/odata-core": "^0.3.7",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.2.5",
+    "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": "485559dce9388b480c7d0b3ded2fe2f3f5f98fad"
+}