@odata2ts/http-client-api 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.5.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.4.0...@odata2ts/http-client-api@0.5.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.4.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.3.0...@odata2ts/http-client-api@0.4.0) (2023-08-03)
+
+### Code Refactoring
+
+* **api:** remove merge & retrieveBigNumbersAsString methods ([a99f89e](https://github.com/odata2ts/http-client/commit/a99f89ee7782733ba75543b3abd03a3060e5e7dc))
+
+### Features
+
+* **api:** additional headers for all operations ([#9](https://github.com/odata2ts/http-client/issues/9)) ([6379511](https://github.com/odata2ts/http-client/commit/637951126118aeb020d68ce16e48ea80e98987e1))
+
+### BREAKING CHANGES
+
+* **api:** removed remove merge & retrieveBigNumbersAsString methods; use the additionalHeaders option on the appropriate operations
+
 # [0.3.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.2.0...@odata2ts/http-client-api@0.3.0) (2023-07-26)
 
 ### Features

package/lib/ODataHttpClient.d.ts

@@ -3,6 +3,16 @@ import { ODataResponse } from "./ODataResponseModel";
  * Retrieves the configuration type for the given HTTP client.
  */
 export type ODataHttpClientConfig<ClientType extends ODataHttpClient> = ClientType extends ODataHttpClient<infer Config> ? Config : never;
+export interface InternalHttpClientConfig {
+    /**
+     * Additional headers set internally by services or HttpClient implementation.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Very special option needed for FetchClient to not evaluate the response body in certain situations.
+     */
+    noBodyEvaluation?: boolean;
+}
 export interface ODataHttpClient<RequestConfig = any> {
     /**
      * Create a model or collection entry.
@@ -10,54 +20,34 @@ export interface ODataHttpClient<RequestConfig = any> {
      * @param url
      * @param data
      * @param requestConfig
+     * @param config
      */
-    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;
-    get<ResponseModel>(url: string, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;
+    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
+    get<ResponseModel>(url: string, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
     /**
      * Replace a model.
      *
      * @param url
      * @param data
      * @param requestConfig
+     * @param config
      */
-    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
     /**
      * Partially update a model.
      *
      * @param url
      * @param data
      * @param requestConfig
+     * @param config
      */
-    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;
-    /**
-     * OData V2 only feature.
-     * Historically, PATCH method was not part of the official HTTP spec, when V1 & V2 were specified;
-     * but use of PATCH was already envisioned {@link https://www.odata.org/documentation/odata-version-2-0/operations/}.
-     * V3 and all following versions, specify use of PATCH method.
-     *
-     * If implemented, this method wil be used instead of patch to partially update models.
-     * Use case: You want to reuse this client and one server can only handle MERGE,
-     * but not PATCH http requests.
-     *
-     * @param url
-     * @param data
-     * @param requestConfig
-     */
-    merge?<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
     /**
      * Delete a model or collection.
      *
      * @param url
      * @param requestConfig
+     * @param config
      */
-    delete(url: string, requestConfig?: RequestConfig): ODataResponse<void>;
-    /**
-     * Get `Edm.Int64` and `Edm.Decimal` types as string instead of number to prevent precision loss.
-     * Only applies to V4 services.
-     *
-     * Set by odata2ts.
-     *
-     * @param enabled
-     */
-    retrieveBigNumbersAsString(enabled: boolean): void;
+    delete(url: string, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<void>;
 }

package/lib/ODataHttpClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"ODataHttpClient.js","sourceRoot":"","sources":["../src/ODataHttpClient.ts"],"names":[],"mappings":"","sourcesContent":["import { ODataResponse } from \"./ODataResponseModel\";\r\n\r\n/**\r\n * Retrieves the configuration type for the given HTTP client.\r\n */\r\nexport type ODataHttpClientConfig<ClientType extends ODataHttpClient> = ClientType extends ODataHttpClient<infer Config>\r\n  ? Config\r\n  : never;\r\n\r\nexport interface ODataHttpClient<RequestConfig = any> {\r\n  /**\r\n   * Create a model or collection entry.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   */\r\n  post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;\r\n\r\n  get<ResponseModel>(url: string, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Replace a model.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   */\r\n  put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Partially update a model.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   */\r\n  patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * OData V2 only feature.\r\n   * Historically, PATCH method was not part of the official HTTP spec, when V1 & V2 were specified;\r\n   * but use of PATCH was already envisioned {@link https://www.odata.org/documentation/odata-version-2-0/operations/}.\r\n   * V3 and all following versions, specify use of PATCH method.\r\n   *\r\n   * If implemented, this method wil be used instead of patch to partially update models.\r\n   * Use case: You want to reuse this client and one server can only handle MERGE,\r\n   * but not PATCH http requests.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   */\r\n  merge?<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Delete a model or collection.\r\n   *\r\n   * @param url\r\n   * @param requestConfig\r\n   */\r\n  delete(url: string, requestConfig?: RequestConfig): ODataResponse<void>;\r\n\r\n  /**\r\n   * Get `Edm.Int64` and `Edm.Decimal` types as string instead of number to prevent precision loss.\r\n   * Only applies to V4 services.\r\n   *\r\n   * Set by odata2ts.\r\n   *\r\n   * @param enabled\r\n   */\r\n  retrieveBigNumbersAsString(enabled: boolean): void;\r\n}\r\n"]}
+{"version":3,"file":"ODataHttpClient.js","sourceRoot":"","sources":["../src/ODataHttpClient.ts"],"names":[],"mappings":"","sourcesContent":["import { ODataResponse } from \"./ODataResponseModel\";\r\n\r\n/**\r\n * Retrieves the configuration type for the given HTTP client.\r\n */\r\nexport type ODataHttpClientConfig<ClientType extends ODataHttpClient> = ClientType extends ODataHttpClient<infer Config>\r\n  ? Config\r\n  : never;\r\n\r\nexport interface InternalHttpClientConfig {\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 interface ODataHttpClient<RequestConfig = any> {\r\n  /**\r\n   * Create a model or collection entry.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   * @param config\r\n   */\r\n  post<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfig,\r\n    config?: InternalHttpClientConfig\r\n  ): ODataResponse<ResponseModel>;\r\n\r\n  get<ResponseModel>(\r\n    url: string,\r\n    requestConfig?: RequestConfig,\r\n    config?: InternalHttpClientConfig\r\n  ): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Replace a model.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   * @param config\r\n   */\r\n  put<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfig,\r\n    config?: InternalHttpClientConfig\r\n  ): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Partially update a model.\r\n   *\r\n   * @param url\r\n   * @param data\r\n   * @param requestConfig\r\n   * @param config\r\n   */\r\n  patch<ResponseModel>(\r\n    url: string,\r\n    data: any,\r\n    requestConfig?: RequestConfig,\r\n    config?: InternalHttpClientConfig\r\n  ): ODataResponse<ResponseModel>;\r\n\r\n  /**\r\n   * Delete a model or collection.\r\n   *\r\n   * @param url\r\n   * @param requestConfig\r\n   * @param config\r\n   */\r\n  delete(url: string, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<void>;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odata2ts/http-client-api",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "publishConfig": {
     "access": "public"
   },
@@ -39,5 +39,5 @@
     "typescript": "5.0.4"
   },
   "types": "./lib/index.d.ts",
-  "gitHead": "9babd2df3010673249e7e3fa26705a8ba84f2cef"
+  "gitHead": "67c7fc10f25461c33baf4e35694a457a03b81b78"
 }