@odata2ts/http-client-base 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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
+
+* **http-client-base:** remove merge & retrieveBigNumbersAsString method ([2b1df56](https://github.com/odata2ts/http-client/commit/2b1df5677c42457430a968b3e61132818a83dc57))
+
+### Features
+
+* allow for additional headers for all operations ([#10](https://github.com/odata2ts/http-client/issues/10)) ([75eedd3](https://github.com/odata2ts/http-client/commit/75eedd3ebb8534188a5a644aee9e69e17f1f0c80))
+
+### BREAKING CHANGES
+
+* **http-client-base:** removed remove merge & retrieveBigNumbersAsString methods; use the additionalHeaders option on the appropriate operations
+
 # [0.2.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-base@0.1.0...@odata2ts/http-client-base@0.2.0) (2023-07-26)
 
 ### Features

package/lib/BaseHttpClient.d.ts

@@ -14,15 +14,10 @@ export interface BaseHttpClientOptions {
     csrfTokenFetchUrl?: string;
 }
 export declare const DEFAULT_CSRF_TOKEN_KEY = "x-csrf-token";
-export declare const BIG_NUMBERS_CONFIG: {
-    Accept: string;
-    "Content-Type": string;
-};
 export declare abstract class BaseHttpClient<RequestConfigType> implements ODataHttpClient<RequestConfigType> {
     private baseOptions;
     private csrfToken;
     private csrfTokenKey;
-    private bigNumbersAsString;
     protected retrieveErrorMessage: ErrorMessageRetriever;
     protected constructor(baseOptions?: BaseHttpClientOptions);
     /**
@@ -57,14 +52,13 @@ export declare abstract class BaseHttpClient<RequestConfigType> implements OData
      * @param url
      * @param data
      * @param requestConfig
+     * @param additionalHeaders
      * @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>>;
-    retrieveBigNumbersAsString(enabled: boolean): void;
+    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>>;
 }

package/lib/BaseHttpClient.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseHttpClient = exports.BIG_NUMBERS_CONFIG = exports.DEFAULT_CSRF_TOKEN_KEY = void 0;
+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 BIG_NUMBER_FORMAT = "application/json;IEEE754Compatible=true";
-exports.BIG_NUMBERS_CONFIG = { Accept: BIG_NUMBER_FORMAT, "Content-Type": BIG_NUMBER_FORMAT };
 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!";
@@ -15,7 +13,6 @@ class BaseHttpClient {
         var _a;
         this.baseOptions = baseOptions;
         this.csrfTokenKey = exports.DEFAULT_CSRF_TOKEN_KEY;
-        this.bigNumbersAsString = false;
         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);
@@ -52,20 +49,26 @@ class BaseHttpClient {
      * @param url
      * @param data
      * @param requestConfig
+     * @param additionalHeaders
      * @private
      */
-    sendRequest(method, url, data, requestConfig) {
+    sendRequest(method, url, data, requestConfig, additionalHeaders) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // noinspection SuspiciousTypeOfGuard
             if (typeof url !== "string") {
                 throw new Error(FAILURE_MISSING_URL);
             }
-            let config = this.bigNumbersAsString ? this.addHeaderToRequestConfig(exports.BIG_NUMBERS_CONFIG) : requestConfig;
+            // 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 }, requestConfig);
+                    config = this.addHeaderToRequestConfig({ [tokenKey]: tokenValue });
                 }
             }
             try {
@@ -86,26 +89,20 @@ class BaseHttpClient {
             }
         });
     }
-    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);
+    get(url, requestConfig, additionalHeaders) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Get, url, undefined, requestConfig, additionalHeaders);
     }
-    patch(url, data, requestConfig) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Patch, url, data, requestConfig);
+    post(url, data, requestConfig, additionalHeaders) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, requestConfig, additionalHeaders);
     }
-    merge(url, data, requestConfig) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Post, url, data, this.addHeaderToRequestConfig({ "X-Http-Method": "MERGE" }, requestConfig));
+    put(url, data, requestConfig, additionalHeaders) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Put, url, data, requestConfig, additionalHeaders);
     }
-    delete(url, requestConfig) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig);
+    patch(url, data, requestConfig, additionalHeaders) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Patch, url, data, requestConfig, additionalHeaders);
     }
-    retrieveBigNumbersAsString(enabled) {
-        this.bigNumbersAsString = enabled;
+    delete(url, requestConfig, additionalHeaders) {
+        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig, additionalHeaders);
     }
 }
 exports.BaseHttpClient = BaseHttpClient;

package/lib/BaseHttpClient.js.map

@@ -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;AACrD,MAAM,iBAAiB,GAAG,yCAAyC,CAAC;AACvD,QAAA,kBAAkB,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;AAEnG,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;IAOlC,YAA8B,cAAqC,EAAE,iBAAiB,EAAE,KAAK,EAAE;;QAAjE,gBAAW,GAAX,WAAW,CAAsD;QALvF,iBAAY,GAAG,8BAAsB,CAAC;QACtC,uBAAkB,GAAY,KAAK,CAAC;QAElC,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,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,0BAAkB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAEzG,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;IAEM,0BAA0B,CAAC,OAAgB;QAChD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;IACpC,CAAC;CACF;AAnKD,wCAmKC","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  /**\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\nconst BIG_NUMBER_FORMAT = \"application/json;IEEE754Compatible=true\";\r\nexport const BIG_NUMBERS_CONFIG = { Accept: BIG_NUMBER_FORMAT, \"Content-Type\": BIG_NUMBER_FORMAT };\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  private bigNumbersAsString: boolean = false;\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 = this.bigNumbersAsString ? this.addHeaderToRequestConfig(BIG_NUMBERS_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  public retrieveBigNumbersAsString(enabled: boolean) {\r\n    this.bigNumbersAsString = enabled;\r\n  }\r\n}\r\n"]}
+{"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"]}

package/package.json

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