@odata2ts/http-client-jquery 0.9.3 → 0.11.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 CHANGED
@@ -3,6 +3,70 @@
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.11.0](https://github.com/odata2ts/http-client/compare/@odata2ts/jquery-v0.10.0...@odata2ts/jquery-v0.11.0) (2026-06-10)
7
+
8
+
9
+ ### ⚠ BREAKING CHANGES
10
+
11
+ * **jquery:** AjaxRequestConfig becomes JQueryRequestConfig
12
+
13
+ ### Features
14
+
15
+ * create blob request ([#28](https://github.com/odata2ts/http-client/issues/28)) ([4cc238d](https://github.com/odata2ts/http-client/commit/4cc238d3fbe07c09d56732b4b12d0b1b875a3ef5))
16
+
17
+
18
+ ### Code Refactoring
19
+
20
+ * **jquery:** benefit from api additions & improve config handling ([d08e4f3](https://github.com/odata2ts/http-client/commit/d08e4f30140d4c1d8968c71b89c9eb009ab44a93))
21
+
22
+
23
+ ### Dependencies
24
+
25
+ * The following workspace dependencies were updated
26
+ * dependencies
27
+ * @odata2ts/http-client-base bumped from ^0.5.4 to ^0.5.5
28
+
29
+ ## [0.10.0](https://github.com/odata2ts/http-client/compare/@odata2ts/jquery-v0.9.3...@odata2ts/jquery-v0.10.0) (2025-03-26)
30
+
31
+
32
+ ### ⚠ BREAKING CHANGES
33
+
34
+ * switch to ESM tends to break stuff
35
+ * additional headers are now part of the config parameter
36
+ * **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.
37
+
38
+ ### Features
39
+
40
+ * allow for additional headers for all operations ([#10](https://github.com/odata2ts/http-client/issues/10)) ([75eedd3](https://github.com/odata2ts/http-client/commit/75eedd3ebb8534188a5a644aee9e69e17f1f0c80))
41
+ * blob and stream support ([#12](https://github.com/odata2ts/http-client/issues/12)) ([ae6f062](https://github.com/odata2ts/http-client/commit/ae6f062371a0ad11707fa3f9edff9571998edb5b))
42
+ * conventionalize client errors ([#5](https://github.com/odata2ts/http-client/issues/5)) ([a8e8912](https://github.com/odata2ts/http-client/commit/a8e89125eeda47436d48507d6a71efc90953f878))
43
+ * **jquery:** allow for query params ([afd13a8](https://github.com/odata2ts/http-client/commit/afd13a862dc07485c0f619a3e39521f7ce6fc65e))
44
+ * **jquery:** copy over jquery-client and rename ([#3](https://github.com/odata2ts/http-client/issues/3)) ([55deb6c](https://github.com/odata2ts/http-client/commit/55deb6c75159bfc46b0ae87cb3c0ec3afda9508e))
45
+ * switch to http-client-api ([52d1b86](https://github.com/odata2ts/http-client/commit/52d1b868ee82dbaf45486da6b22fdcf4c773dfb8))
46
+ * switch to http-client-api ([5a6da23](https://github.com/odata2ts/http-client/commit/5a6da23053b3ea5adb866bb7e30b469f1b8ed260))
47
+
48
+
49
+ ### Bug Fixes
50
+
51
+ * 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))
52
+ * always build all packages before release ([#26](https://github.com/odata2ts/http-client/issues/26)) ([a316f6c](https://github.com/odata2ts/http-client/commit/a316f6ce54c4360c8d6f87799ba6fd9c53bff52c))
53
+ * delete requests with Accept json header ([ea1b06d](https://github.com/odata2ts/http-client/commit/ea1b06d509b490e1e899e96a62a10eac3f65da8e))
54
+ * deploy with code ([#25](https://github.com/odata2ts/http-client/issues/25)) ([3e0e78c](https://github.com/odata2ts/http-client/commit/3e0e78cd2e0b0c3215bc0ed97dd62c75d8b6c5ea))
55
+
56
+
57
+ ### Code Refactoring
58
+
59
+ * expand additionalHeaders param to internalConfig ([#15](https://github.com/odata2ts/http-client/issues/15)) ([7fe1d73](https://github.com/odata2ts/http-client/commit/7fe1d73a7436f64b84a060bd1dbf9e121ef901ce))
60
+ * **jquery:** remove default headers ([3106d97](https://github.com/odata2ts/http-client/commit/3106d9768765e7cc228097ed1270439d47ff0e0c))
61
+ * switch to vitest & ESM ([#18](https://github.com/odata2ts/http-client/issues/18)) ([748558f](https://github.com/odata2ts/http-client/commit/748558f1e3f699085ade1058b1459c843f60994f))
62
+
63
+
64
+ ### Dependencies
65
+
66
+ * The following workspace dependencies were updated
67
+ * dependencies
68
+ * @odata2ts/http-client-base bumped from ^0.5.3 to ^0.5.4
69
+
6
70
  ## [0.9.3](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-jquery@0.9.2...@odata2ts/http-client-jquery@0.9.3) (2024-08-24)
7
71
 
8
72
  **Note:** Version bump only for package @odata2ts/http-client-jquery
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2021 odata2ts
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2021 odata2ts
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,15 +1,13 @@
1
- /// <reference types="jquery/jquerystatic" />
2
- import { HttpResponseModel, ODataHttpClient } from "@odata2ts/http-client-api";
3
- import { BaseHttpClient, BaseHttpClientOptions, HttpMethods, InternalHttpClientConfig } from "@odata2ts/http-client-base";
4
- import { AjaxRequestConfig } from "./AjaxRequestConfig";
1
+ /// <reference types="jquery/JQueryStatic" />
2
+ import { HttpResponseModel, ODataHttpClient, ODataHttpClientOptions, ODataHttpMethods } from "@odata2ts/http-client-api";
3
+ import { BaseHttpClient, BaseRequestConfig } from "@odata2ts/http-client-base";
4
+ import { JQueryRequestConfig } from "./JQueryRequestConfig";
5
5
  import jqXHR = JQuery.jqXHR;
6
6
  export declare const DEFAULT_ERROR_MESSAGE = "No error message!";
7
- export interface ClientOptions extends BaseHttpClientOptions {
8
- }
9
- export declare class JQueryClient extends BaseHttpClient<AjaxRequestConfig> implements ODataHttpClient<AjaxRequestConfig> {
7
+ export declare class JQueryClient extends BaseHttpClient<JQueryRequestConfig> implements ODataHttpClient<JQueryRequestConfig> {
10
8
  private readonly client;
11
9
  private readonly config;
12
- constructor(jquery: JQueryStatic, config?: AjaxRequestConfig, clientOptions?: ClientOptions);
10
+ constructor(jquery: JQueryStatic, config?: JQueryRequestConfig, clientOptions?: ODataHttpClientOptions);
13
11
  protected mapHeaders(jqXhr: jqXHR): Record<string, string>;
14
- protected executeRequest<ResponseModel>(method: HttpMethods, url: string, data: any, requestConfig?: JQuery.AjaxSettings, internalConfig?: InternalHttpClientConfig): Promise<HttpResponseModel<ResponseModel>>;
12
+ protected executeRequest<ResponseModel>(method: ODataHttpMethods, url: string, data: any, requestConfig?: JQueryRequestConfig, internalConfig?: BaseRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
15
13
  }
@@ -4,14 +4,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.JQueryClient = 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
- const AjaxRequestConfig_1 = require("./AjaxRequestConfig");
8
7
  const JQueryClientError_1 = require("./JQueryClientError");
8
+ const JQueryRequestConfig_1 = require("./JQueryRequestConfig");
9
9
  exports.DEFAULT_ERROR_MESSAGE = "No error message!";
10
10
  class JQueryClient extends http_client_base_1.BaseHttpClient {
11
11
  constructor(jquery, config, clientOptions) {
12
12
  super(clientOptions);
13
13
  this.client = jquery;
14
- this.config = (0, AjaxRequestConfig_1.getDefaultConfig)(config);
14
+ this.config = config !== null && config !== void 0 ? config : {};
15
15
  }
16
16
  mapHeaders(jqXhr) {
17
17
  return jqXhr
@@ -30,26 +30,27 @@ class JQueryClient extends http_client_base_1.BaseHttpClient {
30
30
  }
31
31
  executeRequest(method, url, data, requestConfig, internalConfig = {}) {
32
32
  return tslib_1.__awaiter(this, void 0, void 0, function* () {
33
- const withInternalConfig = (0, AjaxRequestConfig_1.mergeAjaxConfig)({ headers: internalConfig.headers }, requestConfig);
34
- const _a = (0, AjaxRequestConfig_1.mergeAjaxConfig)(this.config, withInternalConfig), { params } = _a, mergedConfig = tslib_1.__rest(_a, ["params"]);
35
- mergedConfig.method = method;
36
- mergedConfig.data = JSON.stringify(data);
37
- mergedConfig.url = url;
33
+ const { headers } = internalConfig;
34
+ const _a = (0, JQueryRequestConfig_1.mergeConfigs)(this.config, (0, JQueryRequestConfig_1.mergeConfigs)({ headers }, requestConfig)), { params } = _a, mergedConfig = tslib_1.__rest(_a, ["params"]);
35
+ // set core inputs for request
36
+ const resultConfig = Object.assign(Object.assign({}, mergedConfig), { method, data: JSON.stringify(data), url });
37
+ // apply additional query params to the URL
38
38
  if (params && Object.values(params).length) {
39
- mergedConfig.url +=
39
+ resultConfig.url +=
40
40
  (url.match(/\?/) ? "&" : "?") +
41
41
  // @ts-ignore
42
42
  new URLSearchParams(params).toString();
43
43
  }
44
+ // handling of extra data types: blob and stream (not supported)
44
45
  if (internalConfig.dataType === "blob") {
45
- mergedConfig.xhrFields = { responseType: "blob" };
46
+ resultConfig.xhrFields = { responseType: "blob" };
46
47
  }
47
48
  else if (internalConfig.dataType === "stream") {
48
49
  throw new Error("Streaming is not supported by the JqueryClient!");
49
50
  }
50
51
  // the actual request
51
52
  return new Promise((resolve, reject) => {
52
- this.client.ajax(Object.assign(Object.assign({}, mergedConfig), { success: (response, textStatus, jqXHR) => {
53
+ this.client.ajax(Object.assign(Object.assign({}, resultConfig), { success: (response, textStatus, jqXHR) => {
53
54
  resolve({
54
55
  status: jqXHR.status,
55
56
  statusText: jqXHR.statusText,
@@ -1 +1 @@
1
- {"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAG9E,iEAKoC;AACpC,2DAA2F;AAC3F,2DAAwD;AAI3C,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AAIzD,MAAa,YAAa,SAAQ,iCAAiC;IAIjE,YAAY,MAAoB,EAAE,MAA0B,EAAE,aAA6B;QACzF,KAAK,CAAC,aAAa,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAA,oCAAgB,EAAC,MAAM,CAAC,CAAC;IACzC,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;gBACV,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;aACzC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAEe,cAAc,CAC5B,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAmC,EACnC,iBAA2C,EAAE;;YAE7C,MAAM,kBAAkB,GAAG,IAAA,mCAAe,EAAC,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;YAC/F,MAAM,KAA8B,IAAA,mCAAe,EAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAA9E,EAAE,MAAM,OAAsE,EAAjE,YAAY,sBAAzB,UAA2B,CAAmD,CAAC;YACrF,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;YAC7B,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACzC,YAAY,CAAC,GAAG,GAAG,GAAG,CAAC;YACvB,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;gBAC1C,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;aAC1C;YAED,IAAI,cAAc,CAAC,QAAQ,KAAK,MAAM,EAAE;gBACtC,YAAY,CAAC,SAAS,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;aACnD;iBAAM,IAAI,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAC/C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACpE;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,MAAM,eAAe,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC,CAAC;wBACvE,MAAM,OAAO,GAAG,eAAe,IAAI,WAAW,IAAI,6BAAqB,CAAC;wBACxE,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,qCAAqC,GAAG,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC;wBACzG,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;wBAC/C,MAAM,CAAC,IAAI,qCAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;oBACxG,CAAC,IACD,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA1ED,oCA0EC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/JQueryStatic.d.ts\" />\r\n\r\nimport { HttpResponseModel, ODataHttpClient } from \"@odata2ts/http-client-api\";\r\nimport {\r\n BaseHttpClient,\r\n BaseHttpClientOptions,\r\n HttpMethods,\r\n InternalHttpClientConfig,\r\n} from \"@odata2ts/http-client-base\";\r\nimport { AjaxRequestConfig, getDefaultConfig, mergeAjaxConfig } from \"./AjaxRequestConfig\";\r\nimport { JQueryClientError } from \"./JQueryClientError\";\r\n\r\nimport jqXHR = JQuery.jqXHR;\r\n\r\nexport const DEFAULT_ERROR_MESSAGE = \"No error message!\";\r\n\r\nexport interface ClientOptions extends BaseHttpClientOptions {}\r\n\r\nexport class JQueryClient extends BaseHttpClient<AjaxRequestConfig> implements ODataHttpClient<AjaxRequestConfig> {\r\n private readonly client: JQueryStatic;\r\n private readonly config: JQuery.AjaxSettings;\r\n\r\n constructor(jquery: JQueryStatic, config?: AjaxRequestConfig, clientOptions?: ClientOptions) {\r\n super(clientOptions);\r\n this.client = jquery;\r\n this.config = getDefaultConfig(config);\r\n }\r\n\r\n protected mapHeaders(jqXhr: jqXHR): Record<string, string> {\r\n return jqXhr\r\n .getAllResponseHeaders()\r\n .trim()\r\n .split(/[\\r\\n]+/)\r\n .reduce((collector: Record<string, string>, line: string) => {\r\n const parts = line.split(\": \");\r\n const header = parts.shift();\r\n const value = parts.join(\": \");\r\n\r\n if (header) {\r\n collector[header.toLowerCase()] = value;\r\n }\r\n return collector;\r\n }, {});\r\n }\r\n\r\n protected async executeRequest<ResponseModel>(\r\n method: HttpMethods,\r\n url: string,\r\n data: any,\r\n requestConfig?: JQuery.AjaxSettings,\r\n internalConfig: InternalHttpClientConfig = {},\r\n ): Promise<HttpResponseModel<ResponseModel>> {\r\n const withInternalConfig = mergeAjaxConfig({ headers: internalConfig.headers }, requestConfig);\r\n const { params, ...mergedConfig } = mergeAjaxConfig(this.config, withInternalConfig);\r\n mergedConfig.method = method;\r\n mergedConfig.data = JSON.stringify(data);\r\n mergedConfig.url = url;\r\n if (params && Object.values(params).length) {\r\n mergedConfig.url +=\r\n (url.match(/\\?/) ? \"&\" : \"?\") +\r\n // @ts-ignore\r\n new URLSearchParams(params).toString();\r\n }\r\n\r\n if (internalConfig.dataType === \"blob\") {\r\n mergedConfig.xhrFields = { responseType: \"blob\" };\r\n } else if (internalConfig.dataType === \"stream\") {\r\n throw new Error(\"Streaming is not supported by the JqueryClient!\");\r\n }\r\n\r\n // the actual request\r\n return new Promise((resolve, reject) => {\r\n this.client.ajax({\r\n ...mergedConfig,\r\n success: (response: any, textStatus: string, jqXHR: JQuery.jqXHR) => {\r\n resolve({\r\n status: jqXHR.status,\r\n statusText: jqXHR.statusText,\r\n headers: this.mapHeaders(jqXHR),\r\n data: response,\r\n });\r\n },\r\n error: (jqXHR: JQuery.jqXHR, textStatus: string, thrownError: string) => {\r\n const responseMessage = this.retrieveErrorMessage(jqXHR?.responseJSON);\r\n const failMsg = responseMessage || thrownError || DEFAULT_ERROR_MESSAGE;\r\n const errorMessage = responseMessage ? \"OData server responded with error: \" + responseMessage : failMsg;\r\n const responseHeaders = this.mapHeaders(jqXHR);\r\n reject(new JQueryClientError(errorMessage, jqXHR.status, responseHeaders, new Error(failMsg), jqXHR));\r\n },\r\n });\r\n });\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAQ9E,iEAA+E;AAC/E,2DAAwD;AACxD,+DAA0E;AAI7D,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AAMzD,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;gBACV,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;aACzC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAEe,cAAc,CAC5B,MAAwB,EACxB,GAAW,EACX,IAAS,EACT,aAAmC,EACnC,iBAAoC,EAAE;;YAEtC,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;YAExG,8BAA8B;YAC9B,MAAM,YAAY,mCACb,YAAY,KACf,MAAM,EACN,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAC1B,GAAG,GACJ,CAAC;YAEF,2CAA2C;YAC3C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;gBAC1C,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;aAC1C;YAED,gEAAgE;YAChE,IAAI,cAAc,CAAC,QAAQ,KAAK,MAAM,EAAE;gBACtC,YAAY,CAAC,SAAS,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;aACnD;iBAAM,IAAI,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAC/C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACpE;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,MAAM,eAAe,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC,CAAC;wBACvE,MAAM,OAAO,GAAG,eAAe,IAAI,WAAW,IAAI,6BAAqB,CAAC;wBACxE,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,qCAAqC,GAAG,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC;wBACzG,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;wBAC/C,MAAM,CAAC,IAAI,qCAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;oBACxG,CAAC,IACD,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAlFD,oCAkFC","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 } 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!\";\n\ninterface InternalRequestConfig\n extends JQueryRequestConfig,\n Pick<JQuery.AjaxSettings, \"url\" | \"data\" | \"dataType\" | \"method\" | \"xhrFields\"> {}\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 protected async executeRequest<ResponseModel>(\n method: ODataHttpMethods,\n url: string,\n data: any,\n requestConfig?: JQueryRequestConfig,\n internalConfig: BaseRequestConfig = {},\n ): Promise<HttpResponseModel<ResponseModel>> {\n const { headers } = internalConfig;\n const { params, ...mergedConfig } = mergeConfigs(this.config, mergeConfigs({ headers }, requestConfig));\n\n // set core inputs for request\n const resultConfig: InternalRequestConfig = {\n ...mergedConfig,\n method,\n 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 (internalConfig.dataType === \"blob\") {\n resultConfig.xhrFields = { responseType: \"blob\" };\n } else if (internalConfig.dataType === \"stream\") {\n throw new Error(\"Streaming is not supported by the JqueryClient!\");\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 const responseMessage = this.retrieveErrorMessage(jqXHR?.responseJSON);\n const failMsg = responseMessage || thrownError || DEFAULT_ERROR_MESSAGE;\n const errorMessage = responseMessage ? \"OData server responded with error: \" + responseMessage : failMsg;\n const responseHeaders = this.mapHeaders(jqXHR);\n reject(new JQueryClientError(errorMessage, jqXHR.status, responseHeaders, new Error(failMsg), jqXHR));\n },\n });\n });\n }\n}\n"]}
@@ -0,0 +1,4 @@
1
+ import { ODataRequestConfig } from "@odata2ts/http-client-api";
2
+ export interface JQueryRequestConfig extends ODataRequestConfig, Pick<JQuery.AjaxSettings, "complete" | "beforeSend" | "statusCode" | "timeout" | "cache"> {
3
+ }
4
+ export declare function mergeConfigs(config?: JQueryRequestConfig, toMerge?: JQueryRequestConfig): JQueryRequestConfig;
@@ -1,21 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.mergeAjaxConfig = exports.getDefaultConfig = void 0;
3
+ exports.mergeConfigs = void 0;
4
4
  const tslib_1 = require("tslib");
5
- const DEFAULT_CONFIG = {
6
- // we never want caching
7
- cache: false,
8
- // we always want JSON
9
- // dataType: "json",
10
- };
11
- function getDefaultConfig(config) {
12
- return mergeAjaxConfig(DEFAULT_CONFIG, config);
13
- }
14
- exports.getDefaultConfig = getDefaultConfig;
15
- function mergeAjaxConfig(config, toMerge) {
5
+ function mergeConfigs(config, toMerge) {
16
6
  const _a = config || {}, { headers } = _a, passThrough = tslib_1.__rest(_a, ["headers"]);
17
7
  const _b = toMerge || {}, { headers: headers2 } = _b, passThrough2 = tslib_1.__rest(_b, ["headers"]);
18
8
  return Object.assign(Object.assign(Object.assign({}, passThrough), passThrough2), { headers: Object.assign(Object.assign({}, headers), headers2) });
19
9
  }
20
- exports.mergeAjaxConfig = mergeAjaxConfig;
21
- //# sourceMappingURL=AjaxRequestConfig.js.map
10
+ exports.mergeConfigs = mergeConfigs;
11
+ //# sourceMappingURL=JQueryRequestConfig.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JQueryRequestConfig.js","sourceRoot":"","sources":["../src/JQueryRequestConfig.ts"],"names":[],"mappings":";;;;AAMA,SAAgB,YAAY,CAAC,MAA4B,EAAE,OAA6B;IACtF,MAAM,KAA8B,MAAM,IAAI,EAAE,EAA1C,EAAE,OAAO,OAAiC,EAA5B,WAAW,sBAAzB,WAA2B,CAAe,CAAC;IACjD,MAAM,KAAyC,OAAO,IAAI,EAAE,EAAtD,EAAE,OAAO,EAAE,QAAQ,OAAmC,EAA9B,YAAY,sBAApC,WAAsC,CAAgB,CAAC;IAC7D,qDACK,WAAW,GACX,YAAY,KACf,OAAO,kCACF,OAAO,GACP,QAAQ,KAEb;AACJ,CAAC;AAXD,oCAWC","sourcesContent":["import { ODataRequestConfig } from \"@odata2ts/http-client-api\";\n\nexport interface JQueryRequestConfig\n extends ODataRequestConfig,\n Pick<JQuery.AjaxSettings, \"complete\" | \"beforeSend\" | \"statusCode\" | \"timeout\" | \"cache\"> {}\n\nexport function mergeConfigs(config?: JQueryRequestConfig, toMerge?: JQueryRequestConfig): JQueryRequestConfig {\n const { headers, ...passThrough } = config || {};\n const { headers: headers2, ...passThrough2 } = toMerge || {};\n return {\n ...passThrough,\n ...passThrough2,\n headers: {\n ...headers,\n ...headers2,\n },\n };\n}\n"]}
package/lib/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- export { AjaxRequestConfig } from "./AjaxRequestConfig";
1
+ export { JQueryRequestConfig } from "./JQueryRequestConfig";
2
2
  export * from "./JQueryClient";
3
3
  export { JQueryClientError } from "./JQueryClientError";
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AACA,yDAA+B;AAC/B,yDAAwD;AAA/C,sHAAA,iBAAiB,OAAA","sourcesContent":["export { AjaxRequestConfig } from \"./AjaxRequestConfig\";\r\nexport * from \"./JQueryClient\";\r\nexport { JQueryClientError } from \"./JQueryClientError\";\r\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AACA,yDAA+B;AAC/B,yDAAwD;AAA/C,sHAAA,iBAAiB,OAAA","sourcesContent":["export { JQueryRequestConfig } from \"./JQueryRequestConfig\";\nexport * from \"./JQueryClient\";\nexport { JQueryClientError } from \"./JQueryClientError\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@odata2ts/http-client-jquery",
3
- "version": "0.9.3",
3
+ "version": "0.11.0",
4
4
  "description": "JQuery based http client usable by odata2ts",
5
5
  "keywords": [
6
6
  "http client",
@@ -28,11 +28,10 @@
28
28
  "compile": "tsc",
29
29
  "unit-test": "vitest run --dir test",
30
30
  "int-test": "vitest run --dir int-test",
31
- "test": "vitest run",
32
- "prepublish": "yarn build"
31
+ "test": "vitest run"
33
32
  },
34
33
  "dependencies": {
35
- "@odata2ts/http-client-base": "^0.5.3"
34
+ "@odata2ts/http-client-base": "^0.5.5"
36
35
  },
37
36
  "devDependencies": {
38
37
  "@types/jquery": "^3.5.16",
@@ -46,6 +45,5 @@
46
45
  },
47
46
  "publishConfig": {
48
47
  "access": "public"
49
- },
50
- "gitHead": "d74b162906b89826cce7944308bc5950e325389f"
51
- }
48
+ }
49
+ }
@@ -1,13 +0,0 @@
1
- /**
2
- * Available config options for end user when making a given request.
3
- */
4
- export interface AjaxRequestConfig extends Pick<JQuery.AjaxSettings, "complete" | "beforeSend" | "headers" | "statusCode" | "timeout"> {
5
- /**
6
- * Add query params.
7
- */
8
- params?: Record<string, string | number | boolean | Array<string | number | boolean>>;
9
- }
10
- export interface InternalRequestConfig extends JQuery.AjaxSettings, Pick<AjaxRequestConfig, "params"> {
11
- }
12
- export declare function getDefaultConfig(config?: AjaxRequestConfig): InternalRequestConfig;
13
- export declare function mergeAjaxConfig(config?: JQuery.AjaxSettings, toMerge?: JQuery.AjaxSettings): InternalRequestConfig;
@@ -1 +0,0 @@
1
- {"version":3,"file":"AjaxRequestConfig.js","sourceRoot":"","sources":["../src/AjaxRequestConfig.ts"],"names":[],"mappings":";;;;AAAA,MAAM,cAAc,GAAwB;IAC1C,wBAAwB;IACxB,KAAK,EAAE,KAAK;IACZ,sBAAsB;IACtB,oBAAoB;CACrB,CAAC;AAeF,SAAgB,gBAAgB,CAAC,MAA0B;IACzD,OAAO,eAAe,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AAFD,4CAEC;AAED,SAAgB,eAAe,CAAC,MAA4B,EAAE,OAA6B;IACzF,MAAM,KAA8B,MAAM,IAAI,EAAE,EAA1C,EAAE,OAAO,OAAiC,EAA5B,WAAW,sBAAzB,WAA2B,CAAe,CAAC;IACjD,MAAM,KAAyC,OAAO,IAAI,EAAE,EAAtD,EAAE,OAAO,EAAE,QAAQ,OAAmC,EAA9B,YAAY,sBAApC,WAAsC,CAAgB,CAAC;IAC7D,qDACK,WAAW,GACX,YAAY,KACf,OAAO,kCACF,OAAO,GACP,QAAQ,KAEb;AACJ,CAAC;AAXD,0CAWC","sourcesContent":["const DEFAULT_CONFIG: JQuery.AjaxSettings = {\n // we never want caching\n cache: false,\n // we always want JSON\n // dataType: \"json\",\n};\n\n/**\n * Available config options for end user when making a given request.\n */\nexport interface AjaxRequestConfig\n extends Pick<JQuery.AjaxSettings, \"complete\" | \"beforeSend\" | \"headers\" | \"statusCode\" | \"timeout\"> {\n /**\n * Add query params.\n */\n params?: Record<string, string | number | boolean | Array<string | number | boolean>>;\n}\n\nexport interface InternalRequestConfig extends JQuery.AjaxSettings, Pick<AjaxRequestConfig, \"params\"> {}\n\nexport function getDefaultConfig(config?: AjaxRequestConfig): InternalRequestConfig {\n return mergeAjaxConfig(DEFAULT_CONFIG, config);\n}\n\nexport function mergeAjaxConfig(config?: JQuery.AjaxSettings, toMerge?: JQuery.AjaxSettings): InternalRequestConfig {\n const { headers, ...passThrough } = config || {};\n const { headers: headers2, ...passThrough2 } = toMerge || {};\n return {\n ...passThrough,\n ...passThrough2,\n headers: {\n ...headers,\n ...headers2,\n },\n };\n}\n"]}