@odata2ts/http-client-api 0.6.3 → 0.6.4

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.4](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api-v0.6.3...@odata2ts/http-client-api-v0.6.4) (2026-06-10)
+
+
+### Features
+
+* create blob request ([#28](https://github.com/odata2ts/http-client/issues/28)) ([4cc238d](https://github.com/odata2ts/http-client/commit/4cc238d3fbe07c09d56732b4b12d0b1b875a3ef5))
+
 ## [0.6.3](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-api@0.6.2...@odata2ts/http-client-api-v0.6.3) (2025-03-26)
 
 

package/lib/ODataHttpClient.d.ts

@@ -1,9 +1,10 @@
+import { ODataRequestConfig } from "./ODataRequestConfig";
 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 ODataHttpClient<RequestConfig = any> {
+export type ODataHttpClientConfig<ClientType extends ODataHttpClient<any>> = ClientType extends ODataHttpClient<infer Config> ? Config : never;
+export interface ODataHttpClient<RequestConfig extends ODataRequestConfig = ODataRequestConfig> {
     /**
      * Create a model or collection entry.
      *
@@ -59,6 +60,16 @@ export interface ODataHttpClient<RequestConfig = any> {
      * @param additionalHeaders
      */
     getStream(url: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<ReadableStream>;
+    /**
+     * Creates binary data (Edm.Stream).
+     *
+     * @param url
+     * @param data
+     * @param mimeType
+     * @param requestConfig
+     * @param additionalHeaders
+     */
+    createBlob(url: string, data: Blob, mimeType: string, requestConfig?: RequestConfig, additionalHeaders?: Record<string, string>): ODataResponse<void | Blob>;
     /**
      * Updates binary data (Edm.Stream).
      *

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> =\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"]}
+{"version":3,"file":"ODataHttpClient.js","sourceRoot":"","sources":["../src/ODataHttpClient.ts"],"names":[],"mappings":"","sourcesContent":["import { ODataRequestConfig } from \"./ODataRequestConfig\";\nimport { ODataResponse } from \"./ODataResponseModel\";\n\n/**\n * Retrieves the configuration type for the given HTTP client.\n */\nexport type ODataHttpClientConfig<ClientType extends ODataHttpClient<any>> =\n  ClientType extends ODataHttpClient<infer Config> ? Config : never;\n\nexport interface ODataHttpClient<RequestConfig extends ODataRequestConfig = ODataRequestConfig> {\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   * Creates binary data (Edm.Stream).\n   *\n   * @param url\n   * @param data\n   * @param mimeType\n   * @param requestConfig\n   * @param additionalHeaders\n   */\n  createBlob(\n    url: string,\n    data: Blob,\n    mimeType: string,\n    requestConfig?: RequestConfig,\n    additionalHeaders?: Record<string, string>,\n  ): ODataResponse<void | Blob>;\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/ODataHttpClientOptions.d.ts

@@ -0,0 +1,12 @@
+export interface ODataHttpClientOptions {
+    /**
+     * Enable automatic CSRF token handling.
+     */
+    useCsrfProtection?: boolean;
+    /**
+     * Specify the URL from which the token is fetched.
+     * This could be any path to your OData service, since the token is exchanged via HTTP request headers.
+     * However, it should be a fast response and usually the root URL to the OData service is a good choice.
+     */
+    csrfTokenFetchUrl?: string;
+}

package/lib/ODataHttpClientOptions.js

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

package/lib/ODataHttpClientOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ODataHttpClientOptions.js","sourceRoot":"","sources":["../src/ODataHttpClientOptions.ts"],"names":[],"mappings":"","sourcesContent":["export interface ODataHttpClientOptions {\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"]}

package/lib/ODataHttpDataTypes.d.ts

@@ -0,0 +1,5 @@
+export declare enum ODataHttpDataTypes {
+    JSON = "json",
+    BLOB = "blob",
+    STREAM = "stream"
+}

package/lib/ODataHttpDataTypes.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ODataHttpDataTypes = void 0;
+var ODataHttpDataTypes;
+(function (ODataHttpDataTypes) {
+    ODataHttpDataTypes["JSON"] = "json";
+    ODataHttpDataTypes["BLOB"] = "blob";
+    ODataHttpDataTypes["STREAM"] = "stream";
+})(ODataHttpDataTypes = exports.ODataHttpDataTypes || (exports.ODataHttpDataTypes = {}));
+//# sourceMappingURL=ODataHttpDataTypes.js.map

package/lib/ODataHttpDataTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ODataHttpDataTypes.js","sourceRoot":"","sources":["../src/ODataHttpDataTypes.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B","sourcesContent":["export enum ODataHttpDataTypes {\n  JSON = \"json\",\n  BLOB = \"blob\",\n  STREAM = \"stream\",\n}\n"]}

package/lib/ODataHttpMethods.d.ts

@@ -0,0 +1,8 @@
+export declare enum ODataHttpMethods {
+    Get = "GET",
+    Post = "POST",
+    Put = "PUT",
+    Patch = "PATCH",
+    Delete = "DELETE"
+}
+export declare const DATA_MANIPULATION_METHODS: ODataHttpMethods[];

package/lib/ODataHttpMethods.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DATA_MANIPULATION_METHODS = exports.ODataHttpMethods = void 0;
+var ODataHttpMethods;
+(function (ODataHttpMethods) {
+    ODataHttpMethods["Get"] = "GET";
+    ODataHttpMethods["Post"] = "POST";
+    ODataHttpMethods["Put"] = "PUT";
+    ODataHttpMethods["Patch"] = "PATCH";
+    ODataHttpMethods["Delete"] = "DELETE";
+})(ODataHttpMethods = exports.ODataHttpMethods || (exports.ODataHttpMethods = {}));
+exports.DATA_MANIPULATION_METHODS = [
+    ODataHttpMethods.Post,
+    ODataHttpMethods.Put,
+    ODataHttpMethods.Patch,
+    ODataHttpMethods.Delete,
+];
+//# sourceMappingURL=ODataHttpMethods.js.map

package/lib/ODataHttpMethods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ODataHttpMethods.js","sourceRoot":"","sources":["../src/ODataHttpMethods.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,iCAAa,CAAA;IACb,+BAAW,CAAA;IACX,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B;AAEY,QAAA,yBAAyB,GAAG;IACvC,gBAAgB,CAAC,IAAI;IACrB,gBAAgB,CAAC,GAAG;IACpB,gBAAgB,CAAC,KAAK;IACtB,gBAAgB,CAAC,MAAM;CACxB,CAAC","sourcesContent":["export enum ODataHttpMethods {\n  Get = \"GET\",\n  Post = \"POST\",\n  Put = \"PUT\",\n  Patch = \"PATCH\",\n  Delete = \"DELETE\",\n}\n\nexport const DATA_MANIPULATION_METHODS = [\n  ODataHttpMethods.Post,\n  ODataHttpMethods.Put,\n  ODataHttpMethods.Patch,\n  ODataHttpMethods.Delete,\n];\n"]}

package/lib/ODataRequestConfig.d.ts

@@ -0,0 +1,10 @@
+export interface ODataRequestConfig {
+    /**
+     * The request headers as plain key value pair.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Additional URL query params.
+     */
+    params?: Record<string, string | number | boolean | Array<string | number | boolean>>;
+}

package/lib/ODataRequestConfig.js

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

package/lib/ODataRequestConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ODataRequestConfig.js","sourceRoot":"","sources":["../src/ODataRequestConfig.ts"],"names":[],"mappings":"","sourcesContent":["export interface ODataRequestConfig {\n  /**\n   * The request headers as plain key value pair.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Additional URL query params.\n   */\n  params?: Record<string, string | number | boolean | Array<string | number | boolean>>;\n}\n"]}

package/lib/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./ODataResponseModel";
 export * from "./ODataHttpClient";
+export * from "./ODataHttpClientOptions";
+export * from "./ODataHttpMethods";
+export * from "./ODataRequestConfig";
 export * from "./ODataClientError";

package/lib/index.js

@@ -3,5 +3,8 @@ 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("./ODataHttpClientOptions"), exports);
+tslib_1.__exportStar(require("./ODataHttpMethods"), exports);
+tslib_1.__exportStar(require("./ODataRequestConfig"), exports);
 tslib_1.__exportStar(require("./ODataClientError"), exports);
 //# 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\";\nexport * from \"./ODataHttpClient\";\nexport * from \"./ODataClientError\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,4DAAkC;AAClC,mEAAyC;AACzC,6DAAmC;AACnC,+DAAqC;AACrC,6DAAmC","sourcesContent":["export * from \"./ODataResponseModel\";\nexport * from \"./ODataHttpClient\";\nexport * from \"./ODataHttpClientOptions\";\nexport * from \"./ODataHttpMethods\";\nexport * from \"./ODataRequestConfig\";\nexport * from \"./ODataClientError\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odata2ts/http-client-api",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "Specifies the contract between HTTP clients and odata2ts",
   "keywords": [
     "http client",