@odata2ts/http-client-base 0.5.3 → 0.5.4

package/CHANGELOG.md

@@ -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.5.4](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-base@0.5.3...@odata2ts/http-client-base-v0.5.4) (2025-03-26)
+
+
+### Bug Fixes
+
+* always build all packages before release ([#26](https://github.com/odata2ts/http-client/issues/26)) ([a316f6c](https://github.com/odata2ts/http-client/commit/a316f6ce54c4360c8d6f87799ba6fd9c53bff52c))
+* delete requests with Accept json header ([ea1b06d](https://github.com/odata2ts/http-client/commit/ea1b06d509b490e1e899e96a62a10eac3f65da8e))
+* deploy with code ([#25](https://github.com/odata2ts/http-client/issues/25)) ([3e0e78c](https://github.com/odata2ts/http-client/commit/3e0e78cd2e0b0c3215bc0ed97dd62c75d8b6c5ea))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @odata2ts/http-client-api bumped from ^0.6.2 to ^0.6.3
+
 ## [0.5.3](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-base@0.5.2...@odata2ts/http-client-base@0.5.3) (2024-08-24)
 
 **Note:** Version bump only for package @odata2ts/http-client-base

package/LICENSE

@@ -1,21 +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.
+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/lib/BaseHttpClient.js

@@ -112,7 +112,7 @@ class BaseHttpClient {
         return additionalHeaders ? { headers: additionalHeaders } : undefined;
     }
     delete(url, requestConfig, additionalHeaders) {
-        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig, this.getAdditionalHeaders(additionalHeaders));
+        return this.sendRequest(HttpMethods_1.HttpMethods.Delete, url, undefined, requestConfig, getInternalConfigWithJsonHeaders(additionalHeaders, false));
     }
     getBlob(url, requestConfig, additionalHeaders) {
         return this.sendRequest(HttpMethods_1.HttpMethods.Get, url, undefined, requestConfig, Object.assign(Object.assign({}, this.getAdditionalHeaders(additionalHeaders)), { dataType: "blob" }));

package/lib/BaseHttpClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseHttpClient.js","sourceRoot":"","sources":["../src/BaseHttpClient.ts"],"names":[],"mappings":";;;;AACA,mEAAsF;AACtF,+CAA4C;AA2B/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,gCAAgC,CACvC,OAAgC,EAChC,iBAA0B,IAAI;IAE9B,OAAO;QACL,OAAO,gCACL,MAAM,EAAE,UAAU,IACf,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAC7D,OAAO,CACX;QACD,QAAQ,EAAE,MAAM;KACjB,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,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE;gBACvF,gBAAgB,EAAE,IAAI;gBACtB,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE;aAC9D,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,CAC9B,MAAM,EACN,GAAG,EACH,IAAI,EACJ,aAAa,EACb,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAChE,CAAC;aACH;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,CACrB,yBAAW,CAAC,GAAG,EACf,GAAG,EACH,SAAS,EACT,aAAa,EACb,gCAAgC,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAC3D,CAAC;IACJ,CAAC;IAEM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,IAAI,EAChB,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,GAAG,EACf,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,KAAK,EACjB,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEO,oBAAoB,CAAC,iBAA0C;QACrE,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,CAAC;IAEM,MAAM,CACX,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,MAAM,EAClB,GAAG,EACH,SAAS,EACT,aAAa,EACb,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAC7C,CAAC;IACJ,CAAC;IAEM,OAAO,CACZ,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,kCACjE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAC/C,QAAQ,EAAE,MAAM,IAChB,CAAC;IACL,CAAC;IAEM,SAAS,CACd,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,kCACjE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAC/C,QAAQ,EAAE,QAAQ,IAClB,CAAC;IACL,CAAC;IAEM,UAAU,CACf,GAAW,EACX,IAAU,EACV,QAAgB,EAChB,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;YACjE,OAAO,kCAAO,iBAAiB,KAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,GAAE;YAC7E,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;IACL,CAAC;CACF;AAvOD,wCAuOC","sourcesContent":["import { HttpResponseModel, ODataClientError, ODataResponse } from \"@odata2ts/http-client-api\";\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 interface InternalHttpClientConfig {\r\n  dataType?: \"json\" | \"blob\" | \"stream\";\r\n  /**\r\n   * Additional headers set internally by services or HttpClient implementation.\r\n   */\r\n  headers?: Record<string, string>;\r\n  /**\r\n   * Very special option needed for FetchClient to not evaluate the response body in certain situations.\r\n   */\r\n  noBodyEvaluation?: boolean;\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 getInternalConfigWithJsonHeaders(\r\n  headers?: Record<string, string>,\r\n  setContentType: boolean = true,\r\n): InternalHttpClientConfig {\r\n  return {\r\n    headers: {\r\n      Accept: JSON_VALUE,\r\n      ...(setContentType ? { \"Content-Type\": JSON_VALUE } : undefined),\r\n      ...headers,\r\n    },\r\n    dataType: \"json\",\r\n  };\r\n}\r\n\r\nexport abstract class BaseHttpClient<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 the http method to use\r\n   * @param url the URL to use\r\n   * @param data data for the request body if any\r\n   * @param config request configuration from end user which should override default settings\r\n   * @param internalConfig request configuration from base client including additional headers which should override end user configurations\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.sendRequest(HttpMethods.Get, fetchUrl, undefined, undefined, {\r\n      noBodyEvaluation: true,\r\n      headers: { [this.csrfTokenKey]: \"Fetch\", Accept: JSON_VALUE },\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>(\r\n        method,\r\n        url,\r\n        data,\r\n        requestConfig,\r\n        Object.keys(internalConfig).length ? internalConfig : undefined,\r\n      );\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    additionalHeaders?: Record<string, string>,\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(\r\n      HttpMethods.Get,\r\n      url,\r\n      undefined,\r\n      requestConfig,\r\n      getInternalConfigWithJsonHeaders(additionalHeaders, false),\r\n    );\r\n  }\r\n\r\n  public post<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(\r\n      HttpMethods.Post,\r\n      url,\r\n      data,\r\n      requestConfig,\r\n      getInternalConfigWithJsonHeaders(additionalHeaders),\r\n    );\r\n  }\r\n\r\n  public put<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(\r\n      HttpMethods.Put,\r\n      url,\r\n      data,\r\n      requestConfig,\r\n      getInternalConfigWithJsonHeaders(additionalHeaders),\r\n    );\r\n  }\r\n\r\n  public patch<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): Promise<HttpResponseModel<ResponseModel>> {\r\n    return this.sendRequest<ResponseModel>(\r\n      HttpMethods.Patch,\r\n      url,\r\n      data,\r\n      requestConfig,\r\n      getInternalConfigWithJsonHeaders(additionalHeaders),\r\n    );\r\n  }\r\n\r\n  private getAdditionalHeaders(additionalHeaders?: Record<string, string>) {\r\n    return additionalHeaders ? { headers: additionalHeaders } : undefined;\r\n  }\r\n\r\n  public delete(\r\n    url: string,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): Promise<HttpResponseModel<void>> {\r\n    return this.sendRequest<void>(\r\n      HttpMethods.Delete,\r\n      url,\r\n      undefined,\r\n      requestConfig,\r\n      this.getAdditionalHeaders(additionalHeaders),\r\n    );\r\n  }\r\n\r\n  public getBlob(\r\n    url: string,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): ODataResponse<Blob> {\r\n    return this.sendRequest(HttpMethods.Get, url, undefined, requestConfig, {\r\n      ...this.getAdditionalHeaders(additionalHeaders),\r\n      dataType: \"blob\",\r\n    });\r\n  }\r\n\r\n  public getStream(\r\n    url: string,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): ODataResponse<ReadableStream> {\r\n    return this.sendRequest(HttpMethods.Get, url, undefined, requestConfig, {\r\n      ...this.getAdditionalHeaders(additionalHeaders),\r\n      dataType: \"stream\",\r\n    });\r\n  }\r\n\r\n  public updateBlob(\r\n    url: string,\r\n    data: Blob,\r\n    mimeType: string,\r\n    requestConfig?: RequestConfigType,\r\n    additionalHeaders?: Record<string, string>,\r\n  ): ODataResponse<void | Blob> {\r\n    return this.sendRequest(HttpMethods.Put, url, data, requestConfig, {\r\n      headers: { ...additionalHeaders, Accept: mimeType, \"Content-Type\": mimeType },\r\n      dataType: \"blob\",\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BaseHttpClient.js","sourceRoot":"","sources":["../src/BaseHttpClient.ts"],"names":[],"mappings":";;;;AACA,mEAAsF;AACtF,+CAA4C;AA2B/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,gCAAgC,CACvC,OAAgC,EAChC,iBAA0B,IAAI;IAE9B,OAAO;QACL,OAAO,gCACL,MAAM,EAAE,UAAU,IACf,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAC7D,OAAO,CACX;QACD,QAAQ,EAAE,MAAM;KACjB,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,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE;gBACvF,gBAAgB,EAAE,IAAI;gBACtB,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE;aAC9D,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,CAC9B,MAAM,EACN,GAAG,EACH,IAAI,EACJ,aAAa,EACb,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAChE,CAAC;aACH;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,CACrB,yBAAW,CAAC,GAAG,EACf,GAAG,EACH,SAAS,EACT,aAAa,EACb,gCAAgC,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAC3D,CAAC;IACJ,CAAC;IAEM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,IAAI,EAChB,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,GAAG,EACf,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,KAAK,EACjB,GAAG,EACH,IAAI,EACJ,aAAa,EACb,gCAAgC,CAAC,iBAAiB,CAAC,CACpD,CAAC;IACJ,CAAC;IAEO,oBAAoB,CAAC,iBAA0C;QACrE,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,CAAC;IAEM,MAAM,CACX,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,yBAAW,CAAC,MAAM,EAClB,GAAG,EACH,SAAS,EACT,aAAa,EACb,gCAAgC,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAC3D,CAAC;IACJ,CAAC;IAEM,OAAO,CACZ,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,kCACjE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAC/C,QAAQ,EAAE,MAAM,IAChB,CAAC;IACL,CAAC;IAEM,SAAS,CACd,GAAW,EACX,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,kCACjE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAC/C,QAAQ,EAAE,QAAQ,IAClB,CAAC;IACL,CAAC;IAEM,UAAU,CACf,GAAW,EACX,IAAU,EACV,QAAgB,EAChB,aAAiC,EACjC,iBAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,yBAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;YACjE,OAAO,kCAAO,iBAAiB,KAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,GAAE;YAC7E,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;IACL,CAAC;CACF;AAvOD,wCAuOC","sourcesContent":["import { HttpResponseModel, ODataClientError, ODataResponse } from \"@odata2ts/http-client-api\";\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 interface InternalHttpClientConfig {\n  dataType?: \"json\" | \"blob\" | \"stream\";\n  /**\n   * Additional headers set internally by services or HttpClient implementation.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Very special option needed for FetchClient to not evaluate the response body in certain situations.\n   */\n  noBodyEvaluation?: boolean;\n}\n\nexport const DEFAULT_CSRF_TOKEN_KEY = \"x-csrf-token\";\n\nconst EDIT_METHODS = [HttpMethods.Post, HttpMethods.Put, HttpMethods.Patch, HttpMethods.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!\";\nconst JSON_VALUE = \"application/json\";\n\nfunction getInternalConfigWithJsonHeaders(\n  headers?: Record<string, string>,\n  setContentType: boolean = true,\n): InternalHttpClientConfig {\n  return {\n    headers: {\n      Accept: JSON_VALUE,\n      ...(setContentType ? { \"Content-Type\": JSON_VALUE } : undefined),\n      ...headers,\n    },\n    dataType: \"json\",\n  };\n}\n\nexport abstract class BaseHttpClient<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   * 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 the http method to use\n   * @param url the URL to use\n   * @param data data for the request body if any\n   * @param config request configuration from end user which should override default settings\n   * @param internalConfig request configuration from base client including additional headers which should override end user configurations\n   */\n  protected abstract executeRequest<ResponseModel>(\n    method: HttpMethods,\n    url: string,\n    data: any,\n    config?: RequestConfigType,\n    internalConfig?: InternalHttpClientConfig,\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.sendRequest(HttpMethods.Get, fetchUrl, undefined, undefined, {\n      noBodyEvaluation: true,\n      headers: { [this.csrfTokenKey]: \"Fetch\", Accept: JSON_VALUE },\n    });\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 internalConfig\n   * @private\n   */\n  private async sendRequest<ResponseModel>(\n    method: HttpMethods,\n    url: string,\n    data: any,\n    requestConfig?: RequestConfigType,\n    internalConfig: InternalHttpClientConfig = {},\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    // noinspection SuspiciousTypeOfGuard\n    if (typeof url !== \"string\") {\n      throw new Error(FAILURE_MISSING_URL);\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        if (!internalConfig.headers) {\n          internalConfig.headers = {};\n        }\n        internalConfig.headers[tokenKey] = tokenValue;\n      }\n    }\n\n    try {\n      return await this.executeRequest<ResponseModel>(\n        method,\n        url,\n        data,\n        requestConfig,\n        Object.keys(internalConfig).length ? internalConfig : undefined,\n      );\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>(\n      HttpMethods.Get,\n      url,\n      undefined,\n      requestConfig,\n      getInternalConfigWithJsonHeaders(additionalHeaders, false),\n    );\n  }\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>(\n      HttpMethods.Post,\n      url,\n      data,\n      requestConfig,\n      getInternalConfigWithJsonHeaders(additionalHeaders),\n    );\n  }\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>(\n      HttpMethods.Put,\n      url,\n      data,\n      requestConfig,\n      getInternalConfigWithJsonHeaders(additionalHeaders),\n    );\n  }\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>(\n      HttpMethods.Patch,\n      url,\n      data,\n      requestConfig,\n      getInternalConfigWithJsonHeaders(additionalHeaders),\n    );\n  }\n\n  private getAdditionalHeaders(additionalHeaders?: Record<string, string>) {\n    return additionalHeaders ? { headers: additionalHeaders } : undefined;\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>(\n      HttpMethods.Delete,\n      url,\n      undefined,\n      requestConfig,\n      getInternalConfigWithJsonHeaders(additionalHeaders, false)\n    );\n  }\n\n  public getBlob(\n    url: string,\n    requestConfig?: RequestConfigType,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<Blob> {\n    return this.sendRequest(HttpMethods.Get, url, undefined, requestConfig, {\n      ...this.getAdditionalHeaders(additionalHeaders),\n      dataType: \"blob\",\n    });\n  }\n\n  public getStream(\n    url: string,\n    requestConfig?: RequestConfigType,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<ReadableStream> {\n    return this.sendRequest(HttpMethods.Get, url, undefined, requestConfig, {\n      ...this.getAdditionalHeaders(additionalHeaders),\n      dataType: \"stream\",\n    });\n  }\n\n  public updateBlob(\n    url: string,\n    data: Blob,\n    mimeType: string,\n    requestConfig?: RequestConfigType,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<void | Blob> {\n    return this.sendRequest(HttpMethods.Put, url, data, requestConfig, {\n      headers: { ...additionalHeaders, Accept: mimeType, \"Content-Type\": mimeType },\n      dataType: \"blob\",\n    });\n  }\n}\n"]}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,kEAAwC;AACxC,mDAAmG;AAA1F,gHAAA,cAAc,OAAA;AACvB,6CAA4C;AAAnC,0GAAA,WAAW,OAAA","sourcesContent":["export * from \"./ErrorMessageRetriever\";\r\nexport { BaseHttpClient, BaseHttpClientOptions, InternalHttpClientConfig } from \"./BaseHttpClient\";\r\nexport { HttpMethods } from \"./HttpMethods\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,kEAAwC;AACxC,mDAAmG;AAA1F,gHAAA,cAAc,OAAA;AACvB,6CAA4C;AAAnC,0GAAA,WAAW,OAAA","sourcesContent":["export * from \"./ErrorMessageRetriever\";\nexport { BaseHttpClient, BaseHttpClientOptions, InternalHttpClientConfig } from \"./BaseHttpClient\";\nexport { HttpMethods } from \"./HttpMethods\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odata2ts/http-client-base",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "Core functionality for odata2ts HTTP clients",
   "keywords": [
     "http client",
@@ -24,11 +24,10 @@
     "check-circular-deps": "madge ./src --extensions ts --circular",
     "clean": "rimraf lib coverage",
     "compile": "tsc",
-    "prepublish": "yarn build",
     "test": "vitest run"
   },
   "dependencies": {
-    "@odata2ts/http-client-api": "^0.6.2"
+    "@odata2ts/http-client-api": "^0.6.3"
   },
   "devDependencies": {
     "@odata2ts/odata-core": "^0.3.7",
@@ -38,6 +37,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "d74b162906b89826cce7944308bc5950e325389f"
-}
+  }
+}