@odata2ts/http-client-api 0.4.0 → 0.5.0

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.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

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,34 +20,34 @@ export interface ODataHttpClient<RequestConfig = any> {
      * @param url
      * @param data
      * @param requestConfig
-     * @param additionalHeaders
+     * @param config
      */
-    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ResponseModel>;
-    get<ResponseModel>(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): 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 additionalHeaders
+     * @param config
      */
-    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): 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 additionalHeaders
+     * @param config
      */
-    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ResponseModel>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
     /**
      * Delete a model or collection.
      *
      * @param url
      * @param requestConfig
-     * @param additionalHeaders
+     * @param config
      */
-    delete(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<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\";\n\n/**\n * Retrieves the configuration type for the given HTTP client.\n */\nexport type ODataHttpClientConfig<ClientType extends ODataHttpClient> = ClientType extends ODataHttpClient<infer Config>\n  ? Config\n  : never;\n\nexport interface ODataHttpClient<RequestConfig = any> {\n  /**\n   * Create a model or collection entry.\n   *\n   * @param url\n   * @param data\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  post<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>\n  ): ODataResponse<ResponseModel>;\n\n  get<ResponseModel>(\n    url: string,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>\n  ): ODataResponse<ResponseModel>;\n\n  /**\n   * Replace a model.\n   *\n   * @param url\n   * @param data\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  put<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>\n  ): ODataResponse<ResponseModel>;\n\n  /**\n   * Partially update a model.\n   *\n   * @param url\n   * @param data\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  patch<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>\n  ): ODataResponse<ResponseModel>;\n\n  /**\n   * Delete a model or collection.\n   *\n   * @param url\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  delete(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<void>;\n}\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.4.0",
+  "version": "0.5.0",
   "publishConfig": {
     "access": "public"
   },
@@ -39,5 +39,5 @@
     "typescript": "5.0.4"
   },
   "types": "./lib/index.d.ts",
-  "gitHead": "dc6e29cef27b2f5fca6e838e4a22766b90249e8e"
+  "gitHead": "67c7fc10f25461c33baf4e35694a457a03b81b78"
 }