@odata2ts/http-client-jquery 0.6.0 → 0.7.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 +6 -0
- package/lib/AjaxRequestConfig.d.ts +10 -41
- package/lib/AjaxRequestConfig.js.map +1 -1
- package/lib/JQueryClient.js +8 -2
- package/lib/JQueryClient.js.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
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.7.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-jquery@0.6.0...@odata2ts/http-client-jquery@0.7.0) (2023-09-05)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* **jquery:** allow for query params ([afd13a8](https://github.com/odata2ts/http-client/commit/afd13a862dc07485c0f619a3e39521f7ce6fc65e))
|
|
11
|
+
|
|
6
12
|
# [0.6.0](https://github.com/odata2ts/http-client/compare/@odata2ts/http-client-jquery@0.5.1...@odata2ts/http-client-jquery@0.6.0) (2023-08-03)
|
|
7
13
|
|
|
8
14
|
### Code Refactoring
|
|
@@ -1,44 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Available config options for end user when making a given request.
|
|
3
3
|
*/
|
|
4
|
-
export
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
cache?: boolean | undefined;
|
|
15
|
-
complete?: JQuery.TypeOrArray<JQuery.Ajax.CompleteCallback<any>> | undefined;
|
|
16
|
-
contents?: JQuery.PlainObject<RegExp> | undefined;
|
|
17
|
-
contentType?: string | false | undefined;
|
|
18
|
-
context?: any;
|
|
19
|
-
converters?: JQuery.PlainObject<true | ((value: any) => any)> | undefined;
|
|
20
|
-
crossDomain?: boolean | undefined;
|
|
21
|
-
data?: string | JQuery.PlainObject<any> | undefined;
|
|
22
|
-
dataFilter?: ((data: string, type: string) => any) | undefined;
|
|
23
|
-
dataType?: string | undefined;
|
|
24
|
-
enctype?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain" | undefined;
|
|
25
|
-
error?: JQuery.TypeOrArray<JQuery.Ajax.ErrorCallback<any>> | undefined;
|
|
26
|
-
global?: boolean | undefined;
|
|
27
|
-
ifModified?: boolean | undefined;
|
|
28
|
-
isLocal?: boolean | undefined;
|
|
29
|
-
jsonp?: string | false | undefined;
|
|
30
|
-
jsonpCallback?: string | ((this: any) => string) | undefined;
|
|
31
|
-
method?: string | undefined;
|
|
32
|
-
mimeType?: string | undefined;
|
|
33
|
-
password?: string | undefined;
|
|
34
|
-
processData?: boolean | undefined;
|
|
35
|
-
scriptCharset?: string | undefined;
|
|
36
|
-
statusCode?: JQuery.Ajax.StatusCodeCallbacks<any> | undefined;
|
|
37
|
-
success?: JQuery.TypeOrArray<JQuery.Ajax.SuccessCallback<any>> | undefined;
|
|
38
|
-
timeout?: number | undefined;
|
|
39
|
-
traditional?: boolean | undefined;
|
|
40
|
-
type?: string | undefined;
|
|
41
|
-
username?: string | undefined;
|
|
42
|
-
xhr?: (() => XMLHttpRequest) | undefined;
|
|
43
|
-
xhrFields?: JQuery.Ajax.XHRFields | undefined;
|
|
44
|
-
};
|
|
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 +1 @@
|
|
|
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;
|
|
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 = {\r\n // we never want caching\r\n cache: false,\r\n // we always want JSON\r\n // dataType: \"json\",\r\n};\r\n\r\n/**\r\n * Available config options for end user when making a given request.\r\n */\r\nexport interface AjaxRequestConfig\r\n extends Pick<JQuery.AjaxSettings, \"complete\" | \"beforeSend\" | \"headers\" | \"statusCode\" | \"timeout\"> {\r\n /**\r\n * Add query params.\r\n */\r\n params?: Record<string, string | number | boolean | Array<string | number | boolean>>;\r\n}\r\n\r\nexport interface InternalRequestConfig extends JQuery.AjaxSettings, Pick<AjaxRequestConfig, \"params\"> {}\r\n\r\nexport function getDefaultConfig(config?: AjaxRequestConfig): InternalRequestConfig {\r\n return mergeAjaxConfig(DEFAULT_CONFIG, config);\r\n}\r\n\r\nexport function mergeAjaxConfig(config?: JQuery.AjaxSettings, toMerge?: JQuery.AjaxSettings): InternalRequestConfig {\r\n const { headers, ...passThrough } = config || {};\r\n const { headers: headers2, ...passThrough2 } = toMerge || {};\r\n return {\r\n ...passThrough,\r\n ...passThrough2,\r\n headers: {\r\n ...headers,\r\n ...headers2,\r\n },\r\n };\r\n}\r\n"]}
|
package/lib/JQueryClient.js
CHANGED
|
@@ -34,10 +34,16 @@ class JQueryClient extends http_client_base_1.BaseHttpClient {
|
|
|
34
34
|
}
|
|
35
35
|
executeRequest(method, url, data, requestConfig) {
|
|
36
36
|
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
37
|
-
const
|
|
37
|
+
const _a = (0, AjaxRequestConfig_1.mergeAjaxConfig)(this.config, requestConfig), { params } = _a, mergedConfig = tslib_1.__rest(_a, ["params"]);
|
|
38
38
|
mergedConfig.method = method;
|
|
39
|
-
mergedConfig.url = url;
|
|
40
39
|
mergedConfig.data = JSON.stringify(data);
|
|
40
|
+
mergedConfig.url = url;
|
|
41
|
+
if (params && Object.values(params).length) {
|
|
42
|
+
mergedConfig.url +=
|
|
43
|
+
(url.match(/\?/) ? "&" : "?") +
|
|
44
|
+
// @ts-ignore
|
|
45
|
+
new URLSearchParams(params).toString();
|
|
46
|
+
}
|
|
41
47
|
// the actual request
|
|
42
48
|
return new Promise((resolve, reject) => {
|
|
43
49
|
this.client.ajax(Object.assign(Object.assign({}, mergedConfig), { success: (response, textStatus, jqXHR) => {
|
package/lib/JQueryClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAG9E,iEAAgG;AAEhG,2DAA2F;AAC3F,2DAAwD;AAI3C,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AAIzD,MAAa,YAAa,SAAQ,iCAAiC;IAIjE,YAAY,MAAoB,EAAE,MAA0B,EAAU,aAA6B;QACjG,KAAK,CAAC,aAAa,CAAC,CAAC;QAD+C,kBAAa,GAAb,aAAa,CAAgB;QAEjG,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;IAES,wBAAwB,CAAC,OAA+B,EAAE,MAA0B;QAC5F,OAAO,IAAA,mCAAe,EAAC,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEe,cAAc,CAC5B,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAmC;;YAEnC,MAAM,
|
|
1
|
+
{"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,8EAA8E;;;;AAG9E,iEAAgG;AAEhG,2DAA2F;AAC3F,2DAAwD;AAI3C,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AAIzD,MAAa,YAAa,SAAQ,iCAAiC;IAIjE,YAAY,MAAoB,EAAE,MAA0B,EAAU,aAA6B;QACjG,KAAK,CAAC,aAAa,CAAC,CAAC;QAD+C,kBAAa,GAAb,aAAa,CAAgB;QAEjG,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;IAES,wBAAwB,CAAC,OAA+B,EAAE,MAA0B;QAC5F,OAAO,IAAA,mCAAe,EAAC,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEe,cAAc,CAC5B,MAAmB,EACnB,GAAW,EACX,IAAS,EACT,aAAmC;;YAEnC,MAAM,KAA8B,IAAA,mCAAe,EAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,EAAzE,EAAE,MAAM,OAAiE,EAA5D,YAAY,sBAAzB,UAA2B,CAA8C,CAAC;YAChF,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,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,MAAA,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,WAAW,mCAAI,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;AAtED,oCAsEC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/JQueryStatic.d.ts\" />\r\n\r\nimport { HttpResponseModel } from \"@odata2ts/http-client-api\";\r\nimport { BaseHttpClient, BaseHttpClientOptions, HttpMethods } from \"@odata2ts/http-client-base\";\r\n\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> {\r\n private readonly client: JQueryStatic;\r\n private readonly config: JQuery.AjaxSettings;\r\n\r\n constructor(jquery: JQueryStatic, config?: AjaxRequestConfig, private 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 addHeaderToRequestConfig(headers: Record<string, string>, config?: AjaxRequestConfig): AjaxRequestConfig {\r\n return mergeAjaxConfig({ headers }, config);\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 ): Promise<HttpResponseModel<ResponseModel>> {\r\n const { params, ...mergedConfig } = mergeAjaxConfig(this.config, requestConfig);\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 // 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"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@odata2ts/http-client-jquery",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"typescript": "5.0.4"
|
|
51
51
|
},
|
|
52
52
|
"types": "./lib/index.d.ts",
|
|
53
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "ed6b01821c2dc161f05144e3b4d8f8d899f954ae"
|
|
54
54
|
}
|