npm - @odata2ts/http-client-base - Versions diffs - 0.3.0 → 0.4.0 - Mend

@odata2ts/http-client-base 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# [0.4.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-base@0.3.0...@odata2ts/http-client-base@0.4.0) (2023-09-13)
+### Code Refactoring
+* expand additionalHeaders param to internalConfig ([#15](https://github.com/odata2ts/http-client/issues/15)) ([7fe1d73](https://github.com/odata2ts/http-client/commit/7fe1d73a7436f64b84a060bd1dbf9e121ef901ce))
+### BREAKING CHANGES
+* additional headers are now part of the config parameter
+* fix: don't lose configuration when CSRF token is active
+* add new option which prevents FetchClient from evaluating response body (not needed for fetching csrf tokens & makes trouble with SAP's mockServer)
+* fix: add headers for content-type and accept for main methods
 # [0.3.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-base@0.2.0...@odata2ts/http-client-base@0.3.0) (2023-08-03)
 ### Code Refactoring

package/README.md CHANGED Viewed

@@ -1,80 +1,74 @@
-[![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).
+[![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, InternalHttpClientConfig } from "@odata2ts/http-client-base";
+export interface MyRequestConfig {}
+export class MyHttpClient extends BaseHttpClient<MyRequestConfig> {
+    constructor(clientOptions: BaseHttpClientOptions) {
+        super(clientOptions);
+    }
+    protected async executeRequest<ResponseModel>(
+        method: HttpMethods,
+        url: string,
+        data: any,
+        requestConfig: AxiosRequestConfig | undefined = {},
+        internalConfig?: InternalHttpClientConfig
+    ): 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 CHANGED Viewed

@@ -1,4 +1,4 @@
-import { HttpResponseModel, ODataHttpClient } from "@odata2ts/http-client-api";
+import { HttpResponseModel, InternalHttpClientConfig, ODataHttpClient } from "@odata2ts/http-client-api";
 import { ErrorMessageRetriever } from "./ErrorMessageRetriever";
 import { HttpMethods } from "./HttpMethods";
 export interface BaseHttpClientOptions {
@@ -20,15 +20,6 @@ export declare abstract class BaseHttpClient<RequestConfigType> implements OData
     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.
@@ -38,8 +29,9 @@ export declare abstract class BaseHttpClient<RequestConfigType> implements OData
      * @param url
      * @param data
      * @param config
+     * @param internalConfig
      */
-    protected abstract executeRequest<ResponseModel>(method: HttpMethods, url: string, data: any, config?: RequestConfigType): Promise<HttpResponseModel<ResponseModel>>;
+    protected abstract executeRequest<ResponseModel>(method: HttpMethods, url: string, data: any, config?: RequestConfigType, internalConfig?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
     getCsrfTokenKey(): string;
     setCsrfTokenKey(newKey: string): void;
     setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever): void;
@@ -52,13 +44,13 @@ export declare abstract class BaseHttpClient<RequestConfigType> implements OData
      * @param url
      * @param data
      * @param requestConfig
-     * @param additionalHeaders
+     * @param internalConfig
      * @private
      */
     private sendRequest;
-    get<ResponseModel>(url: string, requestConfig?: RequestConfigType, additionalHeaders?: Record<string, string>): Promise<HttpResponseModel<ResponseModel>>;
-    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, additionalHeaders?: Record<string, string>): Promise<HttpResponseModel<ResponseModel>>;
-    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, additionalHeaders?: Record<string, string>): Promise<HttpResponseModel<ResponseModel>>;
-    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, additionalHeaders?: Record<string, string>): Promise<HttpResponseModel<ResponseModel>>;
-    delete(url: string, requestConfig?: RequestConfigType, additionalHeaders?: Record<string, string>): Promise<HttpResponseModel<void>>;
+    get<ResponseModel>(url: string, requestConfig?: RequestConfigType, config?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
+    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, config?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, config?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfigType, config?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
+    delete(url: string, requestConfig?: RequestConfigType, config?: InternalHttpClientConfig): Promise<HttpResponseModel<void>>;
 }

package/lib/BaseHttpClient.js CHANGED Viewed

@@ -5,9 +5,13 @@ 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 EDIT_METHODS = [HttpMethods_1.HttpMethods.Post, HttpMethods_1.HttpMethods.Put, HttpMethods_1.HttpMethods.Patch, HttpMethods_1.HttpMethods.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!";
+const JSON_VALUE = "application/json";
+function addJsonHeaders(config, setContentType = true) {
+    config.headers = Object.assign(Object.assign({ Accept: JSON_VALUE }, (setContentType ? { "Content-Type": JSON_VALUE } : undefined)), config.headers);
+}
 class BaseHttpClient {
     constructor(baseOptions = { useCsrfProtection: false }) {
         var _a;
@@ -38,7 +42,10 @@ class BaseHttpClient {
     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" }));
+            const response = yield this.get(fetchUrl, undefined, {
+                noBodyEvaluation: true,
+                headers: { [this.csrfTokenKey]: "Fetch", Accept: "application/json" },
+            });
             return response.headers[this.csrfTokenKey];
         });
     }
@@ -49,30 +56,27 @@ class BaseHttpClient {
      * @param url
      * @param data
      * @param requestConfig
-     * @param additionalHeaders
+     * @param internalConfig
      * @private
      */
-    sendRequest(method, url, data, requestConfig, additionalHeaders) {
+    sendRequest(method, url, data, requestConfig, internalConfig = {}) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // noinspection SuspiciousTypeOfGuard
             if (typeof url !== "string") {
                 throw new Error(FAILURE_MISSING_URL);
             }
-            // use big numbers
-            let config = requestConfig;
-            // use additional headers
-            if (additionalHeaders) {
-                config = this.addHeaderToRequestConfig(additionalHeaders, config);
-            }
             // 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 });
+                    if (!internalConfig.headers) {
+                        internalConfig.headers = {};
+                    }
+                    internalConfig.headers[tokenKey] = tokenValue;
                 }
             }
             try {
-                return yield this.executeRequest(method, url, data, config);
+                return yield this.executeRequest(method, url, data, requestConfig, internalConfig);
             }
             catch (e) {
                 const clientError = e;
@@ -89,20 +93,24 @@ class BaseHttpClient {
             }
         });
     }
-    get(url, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Get, url, undefined, requestConfig, additionalHeaders);
+    get(url, requestConfig, config = {}) {
+        addJsonHeaders(config, false);
+        return this.sendRequest(HttpMethods_1.HttpMethods.Get, url, undefined, requestConfig, config);
     }
-    post(url, data, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, requestConfig, additionalHeaders);
+    post(url, data, requestConfig, config = {}) {
+        addJsonHeaders(config);
+        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, requestConfig, config);
     }
-    put(url, data, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Put, url, data, requestConfig, additionalHeaders);
+    put(url, data, requestConfig, config = {}) {
+        addJsonHeaders(config);
+        return this.sendRequest(HttpMethods_1.HttpMethods.Put, url, data, requestConfig, config);
     }
-    patch(url, data, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Patch, url, data, requestConfig, additionalHeaders);
+    patch(url, data, requestConfig, config = {}) {
+        addJsonHeaders(config);
+        return this.sendRequest(HttpMethods_1.HttpMethods.Patch, url, data, requestConfig, config);
     }
-    delete(url, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig, additionalHeaders);
+    delete(url, requestConfig, config = {}) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig, config);
     }
 }
 exports.BaseHttpClient = BaseHttpClient;

package/lib/BaseHttpClient.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"BaseHttpClient.js","sourceRoot":"","sources":["../src/BaseHttpClient.ts"],"names":[],"mappings":";;;;AAEA,mEAAsF;AACtF,+CAA4C;AAe/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;;;;;;;;;OASG;IACW,WAAW,CACvB,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;;YAE1C,qCAAqC;YACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aACtC;YAED,kBAAkB;YAClB,IAAI,MAAM,GAAG,aAAa,CAAC;YAE3B,yBAAyB;YACzB,IAAI,iBAAiB,EAAE;gBACrB,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;aACnE;YAED,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,CAAC,CAAC;iBACpE;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,CACR,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IAC5G,CAAC;IACM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IACxG,CAAC;IACM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IACvG,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IACzG,CAAC;IAEM,MAAM,CACX,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAO,yBAAW,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;IACtG,CAAC;CACF;AAtKD,wCAsKC","sourcesContent":["import { HttpResponseModel, ODataClientError, ODataHttpClient } from \"@odata2ts/http-client-api\";\n\nimport { ErrorMessageRetriever, retrieveErrorMessage } from \"./ErrorMessageRetriever\";\nimport { HttpMethods } from \"./HttpMethods\";\n\nexport interface BaseHttpClientOptions {\n /*\n Enable automatic CSRF token handling.\n /\n useCsrfProtection?: boolean;\n /\n Specify the URL from which the token is fetched.\n * This could be any path to your OData service, since the token is exchanged via HTTP request headers.\n * However, it should be a fast response and usually the root URL to the OData service is a good choice.\n /\n csrfTokenFetchUrl?: string;\n}\n\nexport const DEFAULT_CSRF_TOKEN_KEY = \"x-csrf-token\";\n\nconst EDIT_METHODS = [\"POST\", \"PUT\", \"PATCH\", \"DELETE\"];\nconst FAILURE_MISSING_CSRF_URL =\n \"When automatic CSRF token handling is activated, the URL must be supplied via attribute [csrfTokenFetchUrl]!\";\nconst FAILURE_MISSING_URL = \"Value for URL must be provided!\";\n\nexport abstract class BaseHttpClient<RequestConfigType> implements ODataHttpClient<RequestConfigType> {\n private csrfToken: string \| undefined;\n private csrfTokenKey = DEFAULT_CSRF_TOKEN_KEY;\n\n protected retrieveErrorMessage: ErrorMessageRetriever = retrieveErrorMessage;\n\n protected constructor(private baseOptions: BaseHttpClientOptions = { useCsrfProtection: false }) {\n if (baseOptions.useCsrfProtection && !baseOptions.csrfTokenFetchUrl?.trim()) {\n throw new Error(FAILURE_MISSING_CSRF_URL);\n }\n }\n\n /\n Use the given headers to either create an entire new request config or merge them into the given\n * request config.\n \n @param headers\n * @param config\n * @returns request configuration\n /\n protected abstract addHeaderToRequestConfig(\n headers: Record<string, string>,\n config?: RequestConfigType\n ): RequestConfigType;\n\n /\n Main function to implement by any extending http client.\n * As it name suggests, the request gets executed in this method.\n * Additionally, failures should be handled and errors of type <code>HttpClientError</code> should be thrown.\n \n @param method\n * @param url\n * @param data\n * @param config\n /\n protected abstract executeRequest<ResponseModel>(\n method: HttpMethods,\n url: string,\n data: any,\n config?: RequestConfigType\n ): Promise<HttpResponseModel<ResponseModel>>;\n\n public getCsrfTokenKey() {\n return this.csrfTokenKey;\n }\n\n public setCsrfTokenKey(newKey: string) {\n this.csrfTokenKey = newKey \|\| DEFAULT_CSRF_TOKEN_KEY;\n }\n\n public setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever) {\n this.retrieveErrorMessage = getErrorMsg;\n }\n\n protected async setupSecurityToken(): Promise<[string, string \| undefined]> {\n if (!this.csrfToken) {\n this.csrfToken = await this.fetchSecurityToken();\n }\n return [this.csrfTokenKey, this.csrfToken];\n }\n\n protected async fetchSecurityToken(): Promise<string \| undefined> {\n const fetchUrl = this.baseOptions!.csrfTokenFetchUrl!;\n const response = await this.get(fetchUrl, this.addHeaderToRequestConfig({ [this.csrfTokenKey]: \"Fetch\" }));\n\n return response.headers[this.csrfTokenKey];\n }\n\n /\n Follows the template pattern.\n \n @param method\n * @param url\n * @param data\n * @param requestConfig\n * @param additionalHeaders\n * @private\n */\n private async sendRequest<ResponseModel>(\n method: HttpMethods,\n url: string,\n data: any,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<ResponseModel>> {\n // noinspection SuspiciousTypeOfGuard\n if (typeof url !== \"string\") {\n throw new Error(FAILURE_MISSING_URL);\n }\n\n // use big numbers\n let config = requestConfig;\n\n // use additional headers\n if (additionalHeaders) {\n config = this.addHeaderToRequestConfig(additionalHeaders, config);\n }\n\n // setup automatic CSRF token handling\n if (this.baseOptions.useCsrfProtection && EDIT_METHODS.includes(method)) {\n const [tokenKey, tokenValue] = await this.setupSecurityToken();\n if (tokenValue) {\n config = this.addHeaderToRequestConfig({ [tokenKey]: tokenValue });\n }\n }\n\n try {\n return await this.executeRequest<ResponseModel>(method, url, data, config);\n } catch (e) {\n const clientError = e as ODataClientError;\n\n // automatic CSRF token handling\n if (\n !!this.baseOptions.useCsrfProtection &&\n clientError.status === 403 &&\n !!clientError.headers &&\n clientError.headers[\"x-csrf-token\"] === \"Required\"\n ) {\n // token has expired: reset csrf token & perform the original request again\n this.csrfToken = undefined;\n return this.sendRequest<ResponseModel>(method, url, data, requestConfig);\n }\n\n throw e;\n }\n }\n\n public get<ResponseModel>(\n url: string,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<ResponseModel>> {\n return this.sendRequest<ResponseModel>(HttpMethods.Get, url, undefined, requestConfig, additionalHeaders);\n }\n public post<ResponseModel>(\n url: string,\n data: any,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<ResponseModel>> {\n return this.sendRequest<ResponseModel>(HttpMethods.Post, url, data, requestConfig, additionalHeaders);\n }\n public put<ResponseModel>(\n url: string,\n data: any,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<ResponseModel>> {\n return this.sendRequest<ResponseModel>(HttpMethods.Put, url, data, requestConfig, additionalHeaders);\n }\n public patch<ResponseModel>(\n url: string,\n data: any,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<ResponseModel>> {\n return this.sendRequest<ResponseModel>(HttpMethods.Patch, url, data, requestConfig, additionalHeaders);\n }\n\n public delete(\n url: string,\n requestConfig?: RequestConfigType,\n additionalHeaders?: Record<string, string>\n ): Promise<HttpResponseModel<void>> {\n return this.sendRequest<void>(HttpMethods.Delete, url, undefined, requestConfig, additionalHeaders);\n }\n}\n"]}
1	+ {"version":3,"file":"BaseHttpClient.js","sourceRoot":"","sources":["../src/BaseHttpClient.ts"],"names":[],"mappings":";;;;AAOA,mEAAsF;AACtF,+CAA4C;AAe/B,QAAA,sBAAsB,GAAG,cAAc,CAAC;AAErD,MAAM,YAAY,GAAG,CAAC,yBAAW,CAAC,IAAI,EAAE,yBAAW,CAAC,GAAG,EAAE,yBAAW,CAAC,KAAK,EAAE,yBAAW,CAAC,MAAM,CAAC,CAAC;AAChG,MAAM,wBAAwB,GAC5B,8GAA8G,CAAC;AACjH,MAAM,mBAAmB,GAAG,iCAAiC,CAAC;AAC9D,MAAM,UAAU,GAAG,kBAAkB,CAAC;AAEtC,SAAS,cAAc,CAAC,MAAgC,EAAE,iBAA0B,IAAI;IACtF,MAAM,CAAC,OAAO,iCACZ,MAAM,EAAE,UAAU,IACf,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAC7D,MAAM,CAAC,OAAO,CAClB,CAAC;AACJ,CAAC;AAED,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;IAqBM,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,SAAS,EAAE;gBACnD,gBAAgB,EAAE,IAAI;gBACtB,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE;aACtE,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED;;;;;;;;;OASG;IACW,WAAW,CACvB,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA2C,EAAE;;YAE7C,qCAAqC;YACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aACtC;YAED,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,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;wBAC3B,cAAc,CAAC,OAAO,GAAG,EAAE,CAAC;qBAC7B;oBACD,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;iBAC/C;aACF;YAED,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,cAAc,CAAgB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;aACnG;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,CACR,GAAW,EACX,aAAiC,EACjC,SAAmC,EAAE;QAErC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACjG,CAAC;IAEM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,SAAmC,EAAE;QAErC,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC7F,CAAC;IAEM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,SAAmC,EAAE;QAErC,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC5F,CAAC;IAEM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,SAAmC,EAAE;QAErC,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,WAAW,CAAgB,yBAAW,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CACX,GAAW,EACX,aAAiC,EACjC,SAAmC,EAAE;QAErC,OAAO,IAAI,CAAC,WAAW,CAAO,yBAAW,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC3F,CAAC;CACF;AAhKD,wCAgKC","sourcesContent":["import {\r\n HttpResponseModel,\r\n InternalHttpClientConfig,\r\n ODataClientError,\r\n ODataHttpClient,\r\n} 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 /*\r\n Enable automatic CSRF token handling.\r\n /\r\n useCsrfProtection?: boolean;\r\n /\r\n Specify the URL from which the token is fetched.\r\n * This could be any path to your OData service, since the token is exchanged via HTTP request headers.\r\n * However, it should be a fast response and usually the root URL to the OData service is a good choice.\r\n /\r\n csrfTokenFetchUrl?: string;\r\n}\r\n\r\nexport const DEFAULT_CSRF_TOKEN_KEY = \"x-csrf-token\";\r\n\r\nconst EDIT_METHODS = [HttpMethods.Post, HttpMethods.Put, HttpMethods.Patch, HttpMethods.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\nconst JSON_VALUE = \"application/json\";\r\n\r\nfunction addJsonHeaders(config: InternalHttpClientConfig, setContentType: boolean = true) {\r\n config.headers = {\r\n Accept: JSON_VALUE,\r\n ...(setContentType ? { \"Content-Type\": JSON_VALUE } : undefined),\r\n ...config.headers,\r\n };\r\n}\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 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 * @param internalConfig\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 internalConfig?: InternalHttpClientConfig\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, undefined, {\r\n noBodyEvaluation: true,\r\n headers: { [this.csrfTokenKey]: \"Fetch\", Accept: \"application/json\" },\r\n });\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 * @param internalConfig\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 internalConfig: InternalHttpClientConfig = {}\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 // 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 if (!internalConfig.headers) {\r\n internalConfig.headers = {};\r\n }\r\n internalConfig.headers[tokenKey] = tokenValue;\r\n }\r\n }\r\n\r\n try {\r\n return await this.executeRequest<ResponseModel>(method, url, data, requestConfig, internalConfig);\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>(\r\n url: string,\r\n requestConfig?: RequestConfigType,\r\n config: InternalHttpClientConfig = {}\r\n ): Promise<HttpResponseModel<ResponseModel>> {\r\n addJsonHeaders(config, false);\r\n return this.sendRequest<ResponseModel>(HttpMethods.Get, url, undefined, requestConfig, config);\r\n }\r\n\r\n public post<ResponseModel>(\r\n url: string,\r\n data: any,\r\n requestConfig?: RequestConfigType,\r\n config: InternalHttpClientConfig = {}\r\n ): Promise<HttpResponseModel<ResponseModel>> {\r\n addJsonHeaders(config);\r\n return this.sendRequest<ResponseModel>(HttpMethods.Post, url, data, requestConfig, config);\r\n }\r\n\r\n public put<ResponseModel>(\r\n url: string,\r\n data: any,\r\n requestConfig?: RequestConfigType,\r\n config: InternalHttpClientConfig = {}\r\n ): Promise<HttpResponseModel<ResponseModel>> {\r\n addJsonHeaders(config);\r\n return this.sendRequest<ResponseModel>(HttpMethods.Put, url, data, requestConfig, config);\r\n }\r\n\r\n public patch<ResponseModel>(\r\n url: string,\r\n data: any,\r\n requestConfig?: RequestConfigType,\r\n config: InternalHttpClientConfig = {}\r\n ): Promise<HttpResponseModel<ResponseModel>> {\r\n addJsonHeaders(config);\r\n return this.sendRequest<ResponseModel>(HttpMethods.Patch, url, data, requestConfig, config);\r\n }\r\n\r\n public delete(\r\n url: string,\r\n requestConfig?: RequestConfigType,\r\n config: InternalHttpClientConfig = {}\r\n ): Promise<HttpResponseModel<void>> {\r\n return this.sendRequest<void>(HttpMethods.Delete, url, undefined, requestConfig, config);\r\n }\r\n}\r\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@odata2ts/http-client-base",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },
@@ -29,7 +29,7 @@
     "odata2ts"
   ],
   "dependencies": {
-    "@odata2ts/http-client-api": "^0.4.0"
+    "@odata2ts/http-client-api": "^0.5.0"
   },
   "devDependencies": {
     "@odata2ts/odata-core": "^0.3.7",
@@ -42,5 +42,5 @@
     "typescript": "5.0.4"
   },
   "types": "./lib/index.d.ts",
-  "gitHead": "dc6e29cef27b2f5fca6e838e4a22766b90249e8e"
+  "gitHead": "67c7fc10f25461c33baf4e35694a457a03b81b78"
 }