@odata2ts/http-client-api 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.6.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.5.1...@odata2ts/http-client-api@0.6.0) (2024-08-13)
+
+### Code Refactoring
+
+* switch to vitest & ESM ([#18](https://github.com/odata2ts/http-client/issues/18)) ([748558f](https://github.com/odata2ts/http-client/commit/748558f1e3f699085ade1058b1459c843f60994f))
+
+### Features
+
+* blob and stream support ([#12](https://github.com/odata2ts/http-client/issues/12)) ([ae6f062](https://github.com/odata2ts/http-client/commit/ae6f062371a0ad11707fa3f9edff9571998edb5b))
+
+### BREAKING CHANGES
+
+* switch to ESM tends to break stuff
+
+## [0.5.1](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.5.0...@odata2ts/http-client-api@0.5.1) (2023-09-13)
+
+**Note:** Version bump only for package @odata2ts/http-client-api
+
 # [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

package/README.md

@@ -1,46 +1,52 @@
-[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/http-client-api?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/http-client-api)
-
-# HTTP Client API
-
-Defines the contract between [odata2ts](https://github.com/odata2ts/odata2ts) and any HTTP client implementation.
-
-The responsibilities of the HTTP Client are:
-- HTTP request execution
-- mapping responses to conventionalized structures
-- custom request configuration (optional)
-- automatic CSRF Token Handling (optional)
-
-Features like **optimistic locking** (via `ETag`) or **batch requests** are currently not in scope
-of the HTTP client and may never be.
-
-## Documentation
-[HTTP Client Documentation](https://odata2ts.github.io/docs/odata-client/http-client)
-
-Main documentation for the odata2ts eco system:
-[https://odata2ts.github.io](https://odata2ts.github.io/)
-
-## Tests
-As this library provides the API as TypeScript types, there are no runtime
-artefacts to test.
-
-## Support, Feedback, Contributing
-This project is open to feature requests, suggestions, bug reports, usage questions etc.
-via [GitHub issues](https://github.com/odata2ts/odata2ts/issues).
-
-Contributions and feedback are encouraged and always welcome.
-
-See the [contribution guidelines](https://github.com/odata2ts/odata2ts/blob/main/CONTRIBUTING.md) for further information.
-
-## Spirit
-This project and this module have been created and are maintained in the following spirit:
-
-* adhere to the **OData specification** as much as possible
-  * support any OData service implementation which conforms to the spec
-  * allow to work around faulty implementations if possible
-* stability matters
-  * exercise Test Driven Development
-  * bomb the place with unit tests (code coverage > 95%)
-  * ensure that assumptions & understanding are correct by creating integration tests
-
-## License
-MIT - see [License](./LICENSE).
+[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/http-client-api?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/http-client-api)
+
+# HTTP Client API
+
+Defines the contract between [odata2ts](https://github.com/odata2ts/odata2ts) and any HTTP client implementation.
+
+The responsibilities of the HTTP Client are:
+
+- HTTP request execution
+- mapping responses to conventionalized structures
+- custom request configuration (optional)
+- automatic CSRF Token Handling (optional)
+
+Features like **optimistic locking** (via `ETag`) or **batch requests** are currently not in scope
+of the HTTP client and may never be.
+
+## Documentation
+
+[HTTP Client Documentation](https://odata2ts.github.io/docs/odata-client/http-client)
+
+Main documentation for the odata2ts eco system:
+[https://odata2ts.github.io](https://odata2ts.github.io/)
+
+## Tests
+
+As this library provides the API as TypeScript types, there are no runtime
+artefacts to test.
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests, suggestions, bug reports, usage questions etc.
+via [GitHub issues](https://github.com/odata2ts/odata2ts/issues).
+
+Contributions and feedback are encouraged and always welcome.
+
+See the [contribution guidelines](https://github.com/odata2ts/odata2ts/blob/main/CONTRIBUTING.md) for further information.
+
+## Spirit
+
+This project and this module have been created and are maintained in the following spirit:
+
+- adhere to the **OData specification** as much as possible
+  - support any OData service implementation which conforms to the spec
+  - allow to work around faulty implementations if possible
+- stability matters
+  - exercise Test Driven Development
+  - bomb the place with unit tests (code coverage > 95%)
+  - ensure that assumptions & understanding are correct by creating integration tests
+
+## License
+
+MIT - see [License](./LICENSE).

package/lib/ODataClientError.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=ODataClientError.js.map

package/lib/ODataClientError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ODataClientError.js","sourceRoot":"","sources":["../src/ODataClientError.ts"],"names":[],"mappings":"","sourcesContent":["export interface ODataClientError {\r\n  readonly name: string;\r\n  readonly status?: number;\r\n  readonly headers?: Record<string, string>;\r\n  readonly cause?: Error;\r\n}\r\n"]}
+{"version":3,"file":"ODataClientError.js","sourceRoot":"","sources":["../src/ODataClientError.ts"],"names":[],"mappings":"","sourcesContent":["export interface ODataClientError {\n  readonly name: string;\n  readonly status?: number;\n  readonly headers?: Record<string, string>;\n  readonly cause?: Error;\n}\n"]}

package/lib/ODataHttpClient.d.ts

@@ -3,16 +3,6 @@ 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.
@@ -20,34 +10,63 @@ export interface ODataHttpClient<RequestConfig = any> {
      * @param url
      * @param data
      * @param requestConfig
-     * @param config
+     * @param additionalHeaders
      */
-    post<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
-    get<ResponseModel>(url: string, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
+    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>;
     /**
      * Replace a model.
      *
      * @param url
      * @param data
      * @param requestConfig
-     * @param config
+     * @param additionalHeaders
      */
-    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ResponseModel>;
     /**
      * Partially update a model.
      *
      * @param url
      * @param data
      * @param requestConfig
-     * @param config
+     * @param additionalHeaders
      */
-    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<ResponseModel>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ResponseModel>;
     /**
      * Delete a model or collection.
      *
      * @param url
      * @param requestConfig
-     * @param config
+     * @param additionalHeaders
+     */
+    delete(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<void>;
+    /**
+     * Get binary data (Edm.Stream) as Blob.
+     *
+     * @param url
+     * @param requestConfig
+     * @param additionalHeaders
+     */
+    getBlob(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<Blob>;
+    /**
+     * Get binary data (Edm.Stream) as ReadableStream.
+     *
+     * Cannot be supported by HTTP clients based on XmlHttpRequest, e.g. axios.
+     * Should throw an error in this case.
+     *
+     * @param url
+     * @param requestConfig
+     * @param additionalHeaders
+     */
+    getStream(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ReadableStream>;
+    /**
+     * Updates binary data (Edm.Stream).
+     *
+     * @param url
+     * @param data
+     * @param mimeType
+     * @param requestConfig
+     * @param additionalHeaders
      */
-    delete(url: string, requestConfig?: RequestConfig, config?: InternalHttpClientConfig): ODataResponse<void>;
+    updateBlob(url: string, data: Blob, mimeType: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<void | Blob>;
 }

package/lib/ODataHttpClient.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=ODataHttpClient.js.map

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 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"]}
+{"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> =\n  ClientType extends ODataHttpClient<infer Config> ? Config : 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  /**\n   * Get binary data (Edm.Stream) as Blob.\n   *\n   * @param url\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  getBlob(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<Blob>;\n\n  /**\n   * Get binary data (Edm.Stream) as ReadableStream.\n   *\n   * Cannot be supported by HTTP clients based on XmlHttpRequest, e.g. axios.\n   * Should throw an error in this case.\n   *\n   * @param url\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  getStream(\n    url: string,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<ReadableStream>;\n\n  /**\n   * Updates binary data (Edm.Stream).\n   *\n   * @param url\n   * @param data\n   * @param mimeType\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  updateBlob(\n    url: string,\n    data: Blob,\n    mimeType: string,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<void | Blob>;\n}\n"]}

package/lib/ODataResponseModel.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=ODataResponseModel.js.map

package/lib/ODataResponseModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"ODataResponseModel.js","sourceRoot":"","sources":["../src/ODataResponseModel.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * This model represents the response for any completed HTTP request.\r\n */\r\nexport interface HttpResponseModel<T> {\r\n  /** status code, e.g. 200 or 404 */\r\n  status: number;\r\n  /** status text, e.g. 200 = \"OK\" or 404 = \"Not Found\" */\r\n  statusText: string;\r\n  /** response headers as key value pairs */\r\n  headers: { [key: string]: string };\r\n  // config?: any;\r\n  /** response data */\r\n  data: T;\r\n}\r\n\r\n/**\r\n * Wrapping response instance, containing status code info, headers\r\n * and the response body.\r\n */\r\nexport type ODataResponse<T> = Promise<HttpResponseModel<T>>;\r\n"]}
+{"version":3,"file":"ODataResponseModel.js","sourceRoot":"","sources":["../src/ODataResponseModel.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This model represents the response for any completed HTTP request.\n */\nexport interface HttpResponseModel<T> {\n  /** status code, e.g. 200 or 404 */\n  status: number;\n  /** status text, e.g. 200 = \"OK\" or 404 = \"Not Found\" */\n  statusText: string;\n  /** response headers as key value pairs */\n  headers: { [key: string]: string };\n  // config?: any;\n  /** response data */\n  data: T;\n}\n\n/**\n * Wrapping response instance, containing status code info, headers\n * and the response body.\n */\nexport type ODataResponse<T> = Promise<HttpResponseModel<T>>;\n"]}

package/lib/index.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./ODataResponseModel"), exports);
-tslib_1.__exportStar(require("./ODataHttpClient"), exports);
-tslib_1.__exportStar(require("./ODataClientError"), exports);
+export * from "./ODataResponseModel";
+export * from "./ODataHttpClient";
+export * from "./ODataClientError";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,4DAAkC;AAClC,6DAAmC","sourcesContent":["export * from \"./ODataResponseModel\";\r\nexport * from \"./ODataHttpClient\";\r\nexport * from \"./ODataClientError\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC","sourcesContent":["export * from \"./ODataResponseModel\";\nexport * from \"./ODataHttpClient\";\nexport * from \"./ODataClientError\";\n"]}

package/package.json

@@ -1,43 +1,39 @@
 {
   "name": "@odata2ts/http-client-api",
-  "version": "0.5.0",
-  "publishConfig": {
-    "access": "public"
-  },
+  "version": "0.6.0",
   "description": "Specifies the contract between HTTP clients and odata2ts",
-  "license": "MIT",
+  "keywords": [
+    "http client",
+    "api",
+    "odata2ts",
+    "ts",
+    "typescript"
+  ],
   "repository": "git@github.com:odata2ts/http-client.git",
+  "license": "MIT",
   "author": "texttechne",
+  "type": "module",
   "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "*.md",
+    "lib",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "yarn clean && yarn compile",
     "check-circular-deps": "madge ./src --extensions ts --circular",
     "clean": "rimraf lib coverage",
     "compile": "tsc",
-    "prepublish": "yarn build",
-    "test": "jest --passWithNoTests"
+    "prepublish": "yarn build"
   },
-  "files": [
-    "*.md",
-    "lib",
-    "LICENSE"
-  ],
-  "keywords": [
-    "http client",
-    "api",
-    "odata2ts",
-    "ts",
-    "typescript"
-  ],
   "devDependencies": {
-    "@types/jest": "^27.4.1",
     "@types/node": "^20.2.5",
-    "jest": "29.5.0",
     "rimraf": "^5.0.1",
-    "ts-jest": "^29.1.0",
-    "ts-node": "10.9.1",
     "typescript": "5.0.4"
   },
-  "types": "./lib/index.d.ts",
-  "gitHead": "67c7fc10f25461c33baf4e35694a457a03b81b78"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "6a0905bd7f201a5c91d83a9319c2a0325a017651"
 }