@odata2ts/http-client-jquery 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -25
- package/README.md +5 -0
- package/lib/JQueryClient.d.ts +11 -1
- package/lib/JQueryClient.js +44 -12
- package/lib/JQueryClient.js.map +1 -1
- package/lib/JQueryClientError.d.ts +5 -5
- package/lib/JQueryClientError.js.map +1 -1
- package/package.json +6 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,58 +3,72 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.14.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-jquery-v0.13.0...@odata2ts/http-client-jquery-v0.14.0) (2026-08-08)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### ⚠ BREAKING CHANGES
|
|
10
|
+
|
|
11
|
+
* the responseData of an error thrown for a binary request is no longer the Blob or the ReadableStream the successful response would have carried, but the parsed error document - or its text, if it is not JSON. Code decoding that Blob itself has to stop doing so.
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* surface the server's message when a binary request fails ([#47](https://github.com/odata2ts/http-client/issues/47)) ([c69ef66](https://github.com/odata2ts/http-client/commit/c69ef662171e7f2480fc928474b831fd18855133))
|
|
16
|
+
|
|
17
|
+
|
|
6
18
|
### Dependencies
|
|
7
19
|
|
|
8
20
|
* The following workspace dependencies were updated
|
|
9
21
|
* dependencies
|
|
10
|
-
* @odata2ts/http-client-base bumped from ^0.5.
|
|
22
|
+
* @odata2ts/http-client-base bumped from ^0.5.8 to ^0.6.0
|
|
11
23
|
|
|
12
|
-
## [0.
|
|
24
|
+
## [0.13.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-jquery-v0.12.0...@odata2ts/http-client-jquery-v0.13.0) (2026-08-02)
|
|
13
25
|
|
|
14
26
|
|
|
15
27
|
### ⚠ BREAKING CHANGES
|
|
16
28
|
|
|
17
|
-
*
|
|
18
|
-
* switch to ESM tends to break stuff
|
|
19
|
-
* additional headers are now part of the config parameter
|
|
20
|
-
* **jquery:** removed default accept & content-type headers as well as `dataType=json`; removed merge & retrieveBigNumbersAsString methods (base-lib); all of these settings can now be configured per operation via the `additionalHeaders` option.
|
|
29
|
+
* the trailing constructor parameters of JQueryClientError are optional now, as they already are for AxiosClientError and FetchClientError. Reading error.jqXHR therefore yields JQuery.jqXHR | undefined and needs a check under strict TypeScript.
|
|
21
30
|
|
|
22
31
|
### Features
|
|
23
32
|
|
|
24
|
-
*
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
* **jquery:**
|
|
30
|
-
*
|
|
31
|
-
|
|
33
|
+
* upload binary data as a stream ([#44](https://github.com/odata2ts/http-client/issues/44)) ([ccee77a](https://github.com/odata2ts/http-client/commit/ccee77a7f6ad13bcf147485b2b9b91ac3a899fc2))
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### Bug Fixes
|
|
37
|
+
|
|
38
|
+
* **http-client-jquery:** send binary data as it is ([#37](https://github.com/odata2ts/http-client/issues/37)) ([0615acc](https://github.com/odata2ts/http-client/commit/0615acc56ad183df7d93aaa9f55e5ee48a6db26a))
|
|
39
|
+
* report a refused or absent stream honestly ([#45](https://github.com/odata2ts/http-client/issues/45)) ([43be086](https://github.com/odata2ts/http-client/commit/43be086884c59cff45ae596b848e72a55b59ac83))
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Dependencies
|
|
43
|
+
|
|
44
|
+
* The following workspace dependencies were updated
|
|
45
|
+
* dependencies
|
|
46
|
+
* @odata2ts/http-client-base bumped from ^0.5.7 to ^0.5.8
|
|
47
|
+
|
|
48
|
+
## [0.12.0](https://github.com/odata2ts/http-client/compare/@odata2ts/jquery-v0.11.1...@odata2ts/jquery-v0.12.0) (2026-07-31)
|
|
32
49
|
|
|
33
50
|
|
|
34
51
|
### Bug Fixes
|
|
35
52
|
|
|
36
|
-
* add ".js" suffix for all relative imports ([#20](https://github.com/odata2ts/http-client/issues/20)) ([961c910](https://github.com/odata2ts/http-client/commit/961c91002c8b1e9a7a6256cccd6b6d0ec9c142cd))
|
|
37
|
-
* always build all packages before release ([#26](https://github.com/odata2ts/http-client/issues/26)) ([a316f6c](https://github.com/odata2ts/http-client/commit/a316f6ce54c4360c8d6f87799ba6fd9c53bff52c))
|
|
38
|
-
* delete requests with Accept json header ([ea1b06d](https://github.com/odata2ts/http-client/commit/ea1b06d509b490e1e899e96a62a10eac3f65da8e))
|
|
39
|
-
* deploy with code ([#25](https://github.com/odata2ts/http-client/issues/25)) ([3e0e78c](https://github.com/odata2ts/http-client/commit/3e0e78cd2e0b0c3215bc0ed97dd62c75d8b6c5ea))
|
|
40
|
-
* **http-client-jquery:** stop pinning an external image's exact byte size ([fb3fece](https://github.com/odata2ts/http-client/commit/fb3fece1b5d39459acdd69d0d3c37798641a2288))
|
|
41
53
|
* send a plain text request body as it is ([#35](https://github.com/odata2ts/http-client/issues/35)) ([2d44aff](https://github.com/odata2ts/http-client/commit/2d44aff43d4804070d53ea84dae271365bab4cf8))
|
|
42
54
|
* update typescript to 6.0.3 and migrate to nodenext resolution ([f713098](https://github.com/odata2ts/http-client/commit/f71309861d7a58b7f0fb65cf8395f0262a932a9f))
|
|
55
|
+
* **http-client-jquery:** stop pinning an external image's exact byte size ([fb3fece](https://github.com/odata2ts/http-client/commit/fb3fece1b5d39459acdd69d0d3c37798641a2288))
|
|
43
56
|
|
|
44
57
|
|
|
45
|
-
###
|
|
58
|
+
### Dependencies
|
|
46
59
|
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
|
|
60
|
+
* The following workspace dependencies were updated
|
|
61
|
+
* dependencies
|
|
62
|
+
* @odata2ts/http-client-base bumped from ^0.5.6 to ^0.5.7
|
|
63
|
+
|
|
64
|
+
## [0.11.1](https://github.com/odata2ts/http-client/compare/@odata2ts/jquery-v0.11.0...@odata2ts/jquery-v0.11.1) (2026-06-10)
|
|
51
65
|
|
|
52
66
|
|
|
53
67
|
### Dependencies
|
|
54
68
|
|
|
55
69
|
* The following workspace dependencies were updated
|
|
56
70
|
* dependencies
|
|
57
|
-
* @odata2ts/http-client-base bumped from ^0.5.
|
|
71
|
+
* @odata2ts/http-client-base bumped from ^0.5.5 to ^0.5.6
|
|
58
72
|
|
|
59
73
|
## [0.11.0](https://github.com/odata2ts/http-client/compare/@odata2ts/jquery-v0.10.0...@odata2ts/jquery-v0.11.0) (2026-06-10)
|
|
60
74
|
|
package/README.md
CHANGED
|
@@ -10,6 +10,11 @@ The existing JQuery instance must be provided when initializing the client.
|
|
|
10
10
|
|
|
11
11
|
The whole client is meant to support usage of `odata2ts` in UI5 apps, which use Jquery for HTTP communication.
|
|
12
12
|
|
|
13
|
+
It does **not** support **streaming** in either direction (`getStream`, `createStream` / `updateStream`):
|
|
14
|
+
XmlHttpRequest, which jQuery's ajax method builds upon, has no streaming API at all. Those calls are
|
|
15
|
+
refused with an error - use the [Fetch Client](https://www.npmjs.com/package/@odata2ts/http-client-fetch)
|
|
16
|
+
for streams. Binary data as `Blob` works (`getBlob` / `createBlob` / `updateBlob`).
|
|
17
|
+
|
|
13
18
|
## Installation
|
|
14
19
|
|
|
15
20
|
Install package `@odata2ts/http-client-jquery` as runtime dependency:
|
package/lib/JQueryClient.d.ts
CHANGED
|
@@ -3,10 +3,20 @@ import { BaseHttpClient, BaseRequestConfig } from "@odata2ts/http-client-base";
|
|
|
3
3
|
import { JQueryRequestConfig } from "./JQueryRequestConfig";
|
|
4
4
|
import jqXHR = JQuery.jqXHR;
|
|
5
5
|
export declare const DEFAULT_ERROR_MESSAGE = "No error message!";
|
|
6
|
+
export declare const FAILURE_STREAM_UNSUPPORTED: string;
|
|
6
7
|
export declare class JQueryClient extends BaseHttpClient<JQueryRequestConfig> implements ODataHttpClient<JQueryRequestConfig> {
|
|
7
8
|
private readonly client;
|
|
8
9
|
private readonly config;
|
|
9
10
|
constructor(jquery: JQueryStatic, config?: JQueryRequestConfig, clientOptions?: ODataHttpClientOptions);
|
|
10
11
|
protected mapHeaders(jqXhr: jqXHR): Record<string, string>;
|
|
11
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Turns a failed request into the error to reject with.
|
|
14
|
+
*
|
|
15
|
+
* `responseJSON` is jQuery's own parsing of the response and covers the ordinary case. It stays empty
|
|
16
|
+
* for a binary request though: with `responseType: "blob"` XmlHttpRequest offers neither `responseText`
|
|
17
|
+
* nor anything jQuery could have parsed, and the server's error document sits in `response` as binary.
|
|
18
|
+
* Reading it there is what keeps a failing `getBlob` from reporting the default message.
|
|
19
|
+
*/
|
|
20
|
+
private buildFailure;
|
|
21
|
+
protected executeRequest<ResponseModel>(method: ODataHttpMethods, url: string, data: any, requestConfig: JQueryRequestConfig | undefined, internalConfig: BaseRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
|
|
12
22
|
}
|
package/lib/JQueryClient.js
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/// <reference path="../../../node_modules/@types/jquery/JQueryStatic.d.ts" />
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.JQueryClient = exports.DEFAULT_ERROR_MESSAGE = void 0;
|
|
4
|
+
exports.JQueryClient = exports.FAILURE_STREAM_UNSUPPORTED = exports.DEFAULT_ERROR_MESSAGE = void 0;
|
|
5
5
|
const tslib_1 = require("tslib");
|
|
6
6
|
const http_client_base_1 = require("@odata2ts/http-client-base");
|
|
7
7
|
const JQueryClientError_1 = require("./JQueryClientError");
|
|
8
8
|
const JQueryRequestConfig_1 = require("./JQueryRequestConfig");
|
|
9
9
|
exports.DEFAULT_ERROR_MESSAGE = "No error message!";
|
|
10
|
+
exports.FAILURE_STREAM_UNSUPPORTED = "Streaming is not supported by the JqueryClient! XmlHttpRequest, which jQuery's ajax method builds " +
|
|
11
|
+
"upon, has no streaming API at all - neither for reading a response nor for sending a request body. " +
|
|
12
|
+
"Use the FetchClient for streams.";
|
|
10
13
|
class JQueryClient extends http_client_base_1.BaseHttpClient {
|
|
11
14
|
constructor(jquery, config, clientOptions) {
|
|
12
15
|
super(clientOptions);
|
|
@@ -28,14 +31,41 @@ class JQueryClient extends http_client_base_1.BaseHttpClient {
|
|
|
28
31
|
return collector;
|
|
29
32
|
}, {});
|
|
30
33
|
}
|
|
31
|
-
|
|
32
|
-
|
|
34
|
+
/**
|
|
35
|
+
* Turns a failed request into the error to reject with.
|
|
36
|
+
*
|
|
37
|
+
* `responseJSON` is jQuery's own parsing of the response and covers the ordinary case. It stays empty
|
|
38
|
+
* for a binary request though: with `responseType: "blob"` XmlHttpRequest offers neither `responseText`
|
|
39
|
+
* nor anything jQuery could have parsed, and the server's error document sits in `response` as binary.
|
|
40
|
+
* Reading it there is what keeps a failing `getBlob` from reporting the default message.
|
|
41
|
+
*/
|
|
42
|
+
buildFailure(jqXHR, thrownError) {
|
|
43
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
44
|
+
var _a;
|
|
45
|
+
let responseData;
|
|
46
|
+
try {
|
|
47
|
+
// `response` belongs to XmlHttpRequest itself, which jQuery's typing does not carry over
|
|
48
|
+
const rawResponse = jqXHR === null || jqXHR === void 0 ? void 0 : jqXHR.response;
|
|
49
|
+
responseData = (_a = jqXHR === null || jqXHR === void 0 ? void 0 : jqXHR.responseJSON) !== null && _a !== void 0 ? _a : (yield (0, http_client_base_1.parseErrorResponseBody)(rawResponse));
|
|
50
|
+
}
|
|
51
|
+
catch (e) {
|
|
52
|
+
responseData = undefined;
|
|
53
|
+
}
|
|
54
|
+
const responseMessage = this.retrieveErrorMessage(responseData);
|
|
55
|
+
const failMsg = responseMessage || thrownError || exports.DEFAULT_ERROR_MESSAGE;
|
|
56
|
+
const errorMessage = responseMessage ? "OData server responded with error: " + responseMessage : failMsg;
|
|
57
|
+
return new JQueryClientError_1.JQueryClientError(errorMessage, jqXHR.status, this.mapHeaders(jqXHR), new Error(failMsg), jqXHR);
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
executeRequest(method, url, data, requestConfig, internalConfig) {
|
|
61
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
33
62
|
const { headers } = internalConfig;
|
|
34
63
|
const _a = (0, JQueryRequestConfig_1.mergeConfigs)(this.config, (0, JQueryRequestConfig_1.mergeConfigs)({ headers }, requestConfig)), { params } = _a, mergedConfig = tslib_1.__rest(_a, ["params"]);
|
|
64
|
+
const isBinary = internalConfig.dataType === "blob";
|
|
35
65
|
// set core inputs for request
|
|
36
66
|
const resultConfig = Object.assign(Object.assign({}, mergedConfig), { method,
|
|
37
|
-
// only an explicitly plain text body
|
|
38
|
-
data: this.isPlainTextBody(internalConfig.headers) ? data : JSON.stringify(data), url });
|
|
67
|
+
// only binary data and an explicitly plain text body are passed through as they are
|
|
68
|
+
data: isBinary || this.isPlainTextBody(internalConfig.headers) ? data : JSON.stringify(data), url });
|
|
39
69
|
// apply additional query params to the URL
|
|
40
70
|
if (params && Object.values(params).length) {
|
|
41
71
|
resultConfig.url +=
|
|
@@ -44,11 +74,16 @@ class JQueryClient extends http_client_base_1.BaseHttpClient {
|
|
|
44
74
|
new URLSearchParams(params).toString();
|
|
45
75
|
}
|
|
46
76
|
// handling of extra data types: blob and stream (not supported)
|
|
47
|
-
if (
|
|
77
|
+
if (isBinary) {
|
|
48
78
|
resultConfig.xhrFields = { responseType: "blob" };
|
|
79
|
+
// jQuery would otherwise turn the blob into a query string (processData defaults to true)
|
|
80
|
+
// and add its own urlencoded content type; the actual mime type is already part of the headers
|
|
81
|
+
resultConfig.processData = false;
|
|
82
|
+
resultConfig.contentType = false;
|
|
49
83
|
}
|
|
50
84
|
else if (internalConfig.dataType === "stream") {
|
|
51
|
-
|
|
85
|
+
// a refusal is a failure of this client like any other, hence it carries the same error type
|
|
86
|
+
throw new JQueryClientError_1.JQueryClientError(exports.FAILURE_STREAM_UNSUPPORTED);
|
|
52
87
|
}
|
|
53
88
|
// the actual request
|
|
54
89
|
return new Promise((resolve, reject) => {
|
|
@@ -60,11 +95,8 @@ class JQueryClient extends http_client_base_1.BaseHttpClient {
|
|
|
60
95
|
data: response,
|
|
61
96
|
});
|
|
62
97
|
}, error: (jqXHR, textStatus, thrownError) => {
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
const errorMessage = responseMessage ? "OData server responded with error: " + responseMessage : failMsg;
|
|
66
|
-
const responseHeaders = this.mapHeaders(jqXHR);
|
|
67
|
-
reject(new JQueryClientError_1.JQueryClientError(errorMessage, jqXHR.status, responseHeaders, new Error(failMsg), jqXHR));
|
|
98
|
+
// decoding the error document may take a turn of the event loop, hence the detour
|
|
99
|
+
this.buildFailure(jqXHR, thrownError).then(reject, reject);
|
|
68
100
|
} }));
|
|
69
101
|
});
|
|
70
102
|
});
|
package/lib/JQueryClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAQ9E,
|
|
1
|
+
{"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAQ9E,iEAAuG;AACvG,2DAAwD;AACxD,+DAA0E;AAI7D,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AAC5C,QAAA,0BAA0B,GACrC,oGAAoG;IACpG,qGAAqG;IACrG,kCAAkC,CAAC;AAOrC,MAAa,YAAa,SAAQ,iCAAmC;IAInE,YAAY,MAAoB,EAAE,MAA4B,EAAE,aAAsC;QACpG,KAAK,CAAC,aAAa,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IAC7B,CAAC;IAES,UAAU,CAAC,KAAY;QAC/B,OAAO,KAAK;aACT,qBAAqB,EAAE;aACvB,IAAI,EAAE;aACN,KAAK,CAAC,SAAS,CAAC;aAChB,MAAM,CAAC,CAAC,SAAiC,EAAE,IAAY,EAAE,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE/B,IAAI,MAAM,EAAE,CAAC;gBACX,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;YAC1C,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACW,YAAY,CAAC,KAAY,EAAE,WAAmB;;;YAC1D,IAAI,YAAqB,CAAC;YAC1B,IAAI,CAAC;gBACH,yFAAyF;gBACzF,MAAM,WAAW,GAAI,KAAwD,aAAxD,KAAK,uBAAL,KAAK,CAAqD,QAAQ,CAAC;gBACxF,YAAY,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,mCAAI,CAAC,MAAM,IAAA,yCAAsB,EAAC,WAAW,CAAC,CAAC,CAAC;YACpF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,YAAY,GAAG,SAAS,CAAC;YAC3B,CAAC;YAED,MAAM,eAAe,GAAG,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,eAAe,IAAI,WAAW,IAAI,6BAAqB,CAAC;YACxE,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,qCAAqC,GAAG,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC;YAEzG,OAAO,IAAI,qCAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9G,CAAC;KAAA;IAEe,cAAc,CAC5B,MAAwB,EACxB,GAAW,EACX,IAAS,EACT,aAA8C,EAC9C,cAAiC;;YAEjC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;YACnC,MAAM,KAA8B,IAAA,kCAAY,EAAC,IAAI,CAAC,MAAM,EAAE,IAAA,kCAAY,EAAC,EAAE,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC,EAAjG,EAAE,MAAM,OAAyF,EAApF,YAAY,sBAAzB,UAA2B,CAAsE,CAAC;YACxG,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,KAAK,MAAM,CAAC;YAEpD,8BAA8B;YAC9B,MAAM,YAAY,mCACb,YAAY,KACf,MAAM;gBACN,oFAAoF;gBACpF,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAC5F,GAAG,GACJ,CAAC;YAEF,2CAA2C;YAC3C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC3C,YAAY,CAAC,GAAG;oBACd,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;wBAC7B,aAAa;wBACb,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC3C,CAAC;YAED,gEAAgE;YAChE,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,SAAS,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;gBAClD,0FAA0F;gBAC1F,+FAA+F;gBAC/F,YAAY,CAAC,WAAW,GAAG,KAAK,CAAC;gBACjC,YAAY,CAAC,WAAW,GAAG,KAAK,CAAC;YACnC,CAAC;iBAAM,IAAI,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAChD,6FAA6F;gBAC7F,MAAM,IAAI,qCAAiB,CAAC,kCAA0B,CAAC,CAAC;YAC1D,CAAC;YAED,qBAAqB;YACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,CAAC,MAAM,CAAC,IAAI,iCACX,YAAY,KACf,OAAO,EAAE,CAAC,QAAa,EAAE,UAAkB,EAAE,KAAmB,EAAE,EAAE;wBAClE,OAAO,CAAC;4BACN,MAAM,EAAE,KAAK,CAAC,MAAM;4BACpB,UAAU,EAAE,KAAK,CAAC,UAAU;4BAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;4BAC/B,IAAI,EAAE,QAAQ;yBACf,CAAC,CAAC;oBACL,CAAC,EACD,KAAK,EAAE,CAAC,KAAmB,EAAE,UAAkB,EAAE,WAAmB,EAAE,EAAE;wBACtE,kFAAkF;wBAClF,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBAC7D,CAAC,IACD,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA/GD,oCA+GC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/JQueryStatic.d.ts\" />\n\nimport {\n HttpResponseModel,\n ODataHttpClient,\n ODataHttpClientOptions,\n ODataHttpMethods,\n} from \"@odata2ts/http-client-api\";\nimport { BaseHttpClient, BaseRequestConfig, parseErrorResponseBody } from \"@odata2ts/http-client-base\";\nimport { JQueryClientError } from \"./JQueryClientError\";\nimport { JQueryRequestConfig, mergeConfigs } from \"./JQueryRequestConfig\";\n\nimport jqXHR = JQuery.jqXHR;\n\nexport const DEFAULT_ERROR_MESSAGE = \"No error message!\";\nexport const FAILURE_STREAM_UNSUPPORTED =\n \"Streaming is not supported by the JqueryClient! XmlHttpRequest, which jQuery's ajax method builds \" +\n \"upon, has no streaming API at all - neither for reading a response nor for sending a request body. \" +\n \"Use the FetchClient for streams.\";\n\ninterface InternalRequestConfig\n extends\n JQueryRequestConfig,\n Pick<JQuery.AjaxSettings, \"url\" | \"data\" | \"dataType\" | \"method\" | \"xhrFields\" | \"processData\" | \"contentType\"> {}\n\nexport class JQueryClient extends BaseHttpClient<JQueryRequestConfig> implements ODataHttpClient<JQueryRequestConfig> {\n private readonly client: JQueryStatic;\n private readonly config: JQueryRequestConfig;\n\n constructor(jquery: JQueryStatic, config?: JQueryRequestConfig, clientOptions?: ODataHttpClientOptions) {\n super(clientOptions);\n this.client = jquery;\n this.config = config ?? {};\n }\n\n protected mapHeaders(jqXhr: jqXHR): Record<string, string> {\n return jqXhr\n .getAllResponseHeaders()\n .trim()\n .split(/[\\r\\n]+/)\n .reduce((collector: Record<string, string>, line: string) => {\n const parts = line.split(\": \");\n const header = parts.shift();\n const value = parts.join(\": \");\n\n if (header) {\n collector[header.toLowerCase()] = value;\n }\n return collector;\n }, {});\n }\n\n /**\n * Turns a failed request into the error to reject with.\n *\n * `responseJSON` is jQuery's own parsing of the response and covers the ordinary case. It stays empty\n * for a binary request though: with `responseType: \"blob\"` XmlHttpRequest offers neither `responseText`\n * nor anything jQuery could have parsed, and the server's error document sits in `response` as binary.\n * Reading it there is what keeps a failing `getBlob` from reporting the default message.\n */\n private async buildFailure(jqXHR: jqXHR, thrownError: string): Promise<JQueryClientError> {\n let responseData: unknown;\n try {\n // `response` belongs to XmlHttpRequest itself, which jQuery's typing does not carry over\n const rawResponse = (jqXHR as unknown as Partial<XMLHttpRequest> | undefined)?.response;\n responseData = jqXHR?.responseJSON ?? (await parseErrorResponseBody(rawResponse));\n } catch (e) {\n responseData = undefined;\n }\n\n const responseMessage = this.retrieveErrorMessage(responseData);\n const failMsg = responseMessage || thrownError || DEFAULT_ERROR_MESSAGE;\n const errorMessage = responseMessage ? \"OData server responded with error: \" + responseMessage : failMsg;\n\n return new JQueryClientError(errorMessage, jqXHR.status, this.mapHeaders(jqXHR), new Error(failMsg), jqXHR);\n }\n\n protected async executeRequest<ResponseModel>(\n method: ODataHttpMethods,\n url: string,\n data: any,\n requestConfig: JQueryRequestConfig | undefined,\n internalConfig: BaseRequestConfig,\n ): Promise<HttpResponseModel<ResponseModel>> {\n const { headers } = internalConfig;\n const { params, ...mergedConfig } = mergeConfigs(this.config, mergeConfigs({ headers }, requestConfig));\n const isBinary = internalConfig.dataType === \"blob\";\n\n // set core inputs for request\n const resultConfig: InternalRequestConfig = {\n ...mergedConfig,\n method,\n // only binary data and an explicitly plain text body are passed through as they are\n data: isBinary || this.isPlainTextBody(internalConfig.headers) ? data : JSON.stringify(data),\n url,\n };\n\n // apply additional query params to the URL\n if (params && Object.values(params).length) {\n resultConfig.url +=\n (url.match(/\\?/) ? \"&\" : \"?\") +\n // @ts-ignore\n new URLSearchParams(params).toString();\n }\n\n // handling of extra data types: blob and stream (not supported)\n if (isBinary) {\n resultConfig.xhrFields = { responseType: \"blob\" };\n // jQuery would otherwise turn the blob into a query string (processData defaults to true)\n // and add its own urlencoded content type; the actual mime type is already part of the headers\n resultConfig.processData = false;\n resultConfig.contentType = false;\n } else if (internalConfig.dataType === \"stream\") {\n // a refusal is a failure of this client like any other, hence it carries the same error type\n throw new JQueryClientError(FAILURE_STREAM_UNSUPPORTED);\n }\n\n // the actual request\n return new Promise((resolve, reject) => {\n this.client.ajax({\n ...resultConfig,\n success: (response: any, textStatus: string, jqXHR: JQuery.jqXHR) => {\n resolve({\n status: jqXHR.status,\n statusText: jqXHR.statusText,\n headers: this.mapHeaders(jqXHR),\n data: response,\n });\n },\n error: (jqXHR: JQuery.jqXHR, textStatus: string, thrownError: string) => {\n // decoding the error document may take a turn of the event loop, hence the detour\n this.buildFailure(jqXHR, thrownError).then(reject, reject);\n },\n });\n });\n }\n}\n"]}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ODataClientError } from "@odata2ts/http-client-api";
|
|
2
2
|
export declare class JQueryClientError extends Error implements ODataClientError {
|
|
3
|
-
readonly status
|
|
4
|
-
readonly headers
|
|
5
|
-
readonly cause
|
|
6
|
-
readonly jqXHR
|
|
7
|
-
constructor(msg: string, status
|
|
3
|
+
readonly status?: number | undefined;
|
|
4
|
+
readonly headers?: Record<string, string> | undefined;
|
|
5
|
+
readonly cause?: Error | undefined;
|
|
6
|
+
readonly jqXHR?: JQuery.jqXHR | undefined;
|
|
7
|
+
constructor(msg: string, status?: number | undefined, headers?: Record<string, string> | undefined, cause?: Error | undefined, jqXHR?: JQuery.jqXHR | undefined);
|
|
8
8
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JQueryClientError.js","sourceRoot":"","sources":["../src/JQueryClientError.ts"],"names":[],"mappings":";AAAA,sEAAsE;;;AAItE,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACE,GAAW,EACK,
|
|
1
|
+
{"version":3,"file":"JQueryClientError.js","sourceRoot":"","sources":["../src/JQueryClientError.ts"],"names":[],"mappings":";AAAA,sEAAsE;;;AAItE,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACE,GAAW,EACK,MAAe,EACf,OAAgC,EAChC,KAAa,EACb,KAAoB;QAEpC,2GAA2G;QAC3G,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QANN,WAAM,GAAN,MAAM,CAAS;QACf,YAAO,GAAP,OAAO,CAAyB;QAChC,UAAK,GAAL,KAAK,CAAQ;QACb,UAAK,GAAL,KAAK,CAAe;QAIpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAZD,8CAYC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/misc.d.ts\" />\n\nimport { ODataClientError } from \"@odata2ts/http-client-api\";\n\nexport class JQueryClientError extends Error implements ODataClientError {\n constructor(\n msg: string,\n public readonly status?: number,\n public readonly headers?: Record<string, string>,\n public readonly cause?: Error,\n public readonly jqXHR?: JQuery.jqXHR,\n ) {\n // @ts-ignore: fetch requires lib \"dom\" or \"webworker\", but then the \"cause\" property becomes unknown to TS\n super(msg, { cause });\n this.name = this.constructor.name;\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@odata2ts/http-client-jquery",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"description": "JQuery based http client usable by odata2ts",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"http client",
|
|
@@ -26,20 +26,22 @@
|
|
|
26
26
|
"check-circular-deps": "madge ./src --extensions ts --circular",
|
|
27
27
|
"clean": "rimraf lib coverage",
|
|
28
28
|
"compile": "tsc",
|
|
29
|
-
"int-test": "vitest run --dir int-test",
|
|
30
29
|
"test": "vitest run",
|
|
31
30
|
"unit-test": "vitest run --dir test"
|
|
32
31
|
},
|
|
33
32
|
"dependencies": {
|
|
34
|
-
"@odata2ts/http-client-base": "^0.
|
|
33
|
+
"@odata2ts/http-client-base": "^0.6.0",
|
|
35
34
|
"tslib": "^2.8.1"
|
|
36
35
|
},
|
|
37
36
|
"devDependencies": {
|
|
38
37
|
"@types/jquery": "^3.5.34",
|
|
39
38
|
"@types/node": "^24",
|
|
40
39
|
"jquery": "~3.6.4",
|
|
40
|
+
"jsdom": "^30.0.0",
|
|
41
|
+
"madge": "^8.0.0",
|
|
41
42
|
"rimraf": "^6.1.3",
|
|
42
|
-
"typescript": "6.0.3"
|
|
43
|
+
"typescript": "6.0.3",
|
|
44
|
+
"vitest": "^4.1.10"
|
|
43
45
|
},
|
|
44
46
|
"peerDependencies": {
|
|
45
47
|
"jquery": ">1.0"
|