@odata2ts/http-client-jquery 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.4.0 (2023-06-03)
+
+### Features
+
+* **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))
+* switch to http-client-api ([52d1b86](https://github.com/odata2ts/http-client/commit/52d1b868ee82dbaf45486da6b22fdcf4c773dfb8))
+* switch to http-client-api ([5a6da23](https://github.com/odata2ts/http-client/commit/5a6da23053b3ea5adb866bb7e30b469f1b8ed260))
+
+## [0.3.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/jquery-odata-client@0.3.0...@odata2ts/jquery-odata-client@0.3.1) (2023-05-02)
+
+### Bug Fixes
+
+* **jquery-client:** stringify request body & parse response headers ([#159](https://github.com/odata2ts/odata2ts/issues/159)) ([4d5217f](https://github.com/odata2ts/odata2ts/commit/4d5217f6f168b8b906cb07cc9be90a13374ed681))
+
+# [0.3.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/jquery-odata-client@0.2.0...@odata2ts/jquery-odata-client@0.3.0) (2023-04-27)
+
+### Features
+
+* **jquery-client:** automatic CSRF token handling ([c86fe0c](https://github.com/odata2ts/odata2ts/commit/c86fe0c96a347afc7a3525de718bf266fd6a4da0))
+
+# [0.2.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/jquery-odata-client@0.1.2...@odata2ts/jquery-odata-client@0.2.0) (2023-04-20)
+
+### Features
+
+* better errors for jquery and axios odata clients ([#139](https://github.com/odata2ts/odata2ts/issues/139)) ([bb74514](https://github.com/odata2ts/odata2ts/commit/bb745144fb37235ad9864ab78eebbecf1d69107c))
+
+## [0.1.2](https://github.com/odata2ts/odata2ts/compare/@odata2ts/jquery-odata-client@0.1.1...@odata2ts/jquery-odata-client@0.1.2) (2023-04-08)
+
+**Note:** Version bump only for package @odata2ts/jquery-odata-client
+
+## [0.1.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/jquery-odata-client@0.1.0...@odata2ts/jquery-odata-client@0.1.1) (2023-02-24)
+
+### Bug Fixes
+
+* **jquery-odata-client:** better typings and version for jquery ([#136](https://github.com/odata2ts/odata2ts/issues/136)) ([de29772](https://github.com/odata2ts/odata2ts/commit/de297722113c16e0bf48255d4108ee29daf70fa2))
+
+# 0.1.0 (2023-02-24)
+
+### Features
+
+* jquery based OData client ([#135](https://github.com/odata2ts/odata2ts/issues/135)) ([183602f](https://github.com/odata2ts/odata2ts/commit/183602f9686b36e23679091ed8223088b4591192))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 odata2ts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/http-client-jquery?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/http-client-jquery)
+
+# JQuery HTTP Client
+
+[odata2ts](https://github.com/odata2ts/odata2ts) compatible odata client based on [JQuery](https://jquery.com/)
+and its [ajax method](https://api.jquery.com/Jquery.ajax/).
+
+JQuery is used by this client but not installed (declared as peer dependency).
+The existing JQuery instance must be provided when initializing the client.
+
+The whole client is meant to support usage of `odata2ts` in UI5 apps, which use Jquery for HTTP communication.
+
+## Installation
+
+Install package `@odata2ts/http-client-jquery` as runtime dependency:
+
+```bash
+npm install --save @odata2ts/http-client-jquery
+```
+
+JQuery is a peer-dependency of this package, so it's not contained in or installed through this package.
+
+## Documentation
+
+[JQuery Client Documentation](https://odata2ts.github.io/docs/odata-client/http-client/jquery)
+
+Main documentation for the odata2ts eco system:
+[https://odata2ts.github.io](https://odata2ts.github.io/)
+
+## Tests
+
+See folder [test](https://github.com/odata2ts/http-client/tree/main/packages/jquery/test)
+for unit tests.
+
+## 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.
+
+## License
+
+MIT - see [License](./LICENSE).

package/lib/AjaxRequestConfig.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Available config options for end user when making a given request.
+ */
+export type AjaxRequestConfig = Pick<JQuery.AjaxSettings, "complete" | "beforeSend" | "headers" | "statusCode" | "timeout">;
+export declare function getDefaultConfig(config?: AjaxRequestConfig): JQuery.AjaxSettings;
+export declare function mergeAjaxConfig(config?: JQuery.AjaxSettings, toMerge?: JQuery.AjaxSettings): {
+    headers: {
+        [x: string]: string | null | undefined;
+    };
+    url?: string | undefined;
+    accepts?: JQuery.PlainObject<string> | undefined;
+    async?: boolean | undefined;
+    beforeSend?: ((this: any, jqXHR: JQuery.jqXHR<any>, settings: JQuery.AjaxSettings<any>) => false | void) | undefined;
+    cache?: boolean | undefined;
+    complete?: JQuery.TypeOrArray<JQuery.Ajax.CompleteCallback<any>> | undefined;
+    contents?: JQuery.PlainObject<RegExp> | undefined;
+    contentType?: string | false | undefined;
+    context?: any;
+    converters?: JQuery.PlainObject<true | ((value: any) => any)> | undefined;
+    crossDomain?: boolean | undefined;
+    data?: string | JQuery.PlainObject<any> | undefined;
+    dataFilter?: ((data: string, type: string) => any) | undefined;
+    dataType?: string | undefined;
+    enctype?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain" | undefined;
+    error?: JQuery.TypeOrArray<JQuery.Ajax.ErrorCallback<any>> | undefined;
+    global?: boolean | undefined;
+    ifModified?: boolean | undefined;
+    isLocal?: boolean | undefined;
+    jsonp?: string | false | undefined;
+    jsonpCallback?: string | ((this: any) => string) | undefined;
+    method?: string | undefined;
+    mimeType?: string | undefined;
+    password?: string | undefined;
+    processData?: boolean | undefined;
+    scriptCharset?: string | undefined;
+    statusCode?: JQuery.Ajax.StatusCodeCallbacks<any> | undefined;
+    success?: JQuery.TypeOrArray<JQuery.Ajax.SuccessCallback<any>> | undefined;
+    timeout?: number | undefined;
+    traditional?: boolean | undefined;
+    type?: string | undefined;
+    username?: string | undefined;
+    xhr?: (() => XMLHttpRequest) | undefined;
+    xhrFields?: JQuery.Ajax.XHRFields | undefined;
+};

package/lib/AjaxRequestConfig.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeAjaxConfig = exports.getDefaultConfig = void 0;
+const tslib_1 = require("tslib");
+const DEFAULT_CONFIG = {
+    // we never want caching
+    cache: false,
+    // we always want JSON
+    dataType: "json",
+    headers: { Accept: "application/json", "Content-Type": "application/json" },
+};
+function getDefaultConfig(config) {
+    return mergeAjaxConfig(DEFAULT_CONFIG, config);
+}
+exports.getDefaultConfig = getDefaultConfig;
+function mergeAjaxConfig(config, toMerge) {
+    const _a = config || {}, { headers } = _a, passThrough = tslib_1.__rest(_a, ["headers"]);
+    const _b = toMerge || {}, { headers: headers2 } = _b, passThrough2 = tslib_1.__rest(_b, ["headers"]);
+    return Object.assign(Object.assign(Object.assign({}, passThrough), passThrough2), { headers: Object.assign(Object.assign({}, headers), headers2) });
+}
+exports.mergeAjaxConfig = mergeAjaxConfig;
+//# sourceMappingURL=AjaxRequestConfig.js.map

package/lib/AjaxRequestConfig.js.map

@@ -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,QAAQ,EAAE,MAAM;IAChB,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE;CAC5E,CAAC;AAUF,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  headers: { Accept: \"application/json\", \"Content-Type\": \"application/json\" },\r\n};\r\n\r\n/**\r\n * Available config options for end user when making a given request.\r\n */\r\nexport type AjaxRequestConfig = Pick<\r\n  JQuery.AjaxSettings,\r\n  \"complete\" | \"beforeSend\" | \"headers\" | \"statusCode\" | \"timeout\"\r\n>;\r\n\r\nexport function getDefaultConfig(config?: AjaxRequestConfig): JQuery.AjaxSettings {\r\n  return mergeAjaxConfig(DEFAULT_CONFIG, config);\r\n}\r\n\r\nexport function mergeAjaxConfig(config?: JQuery.AjaxSettings, toMerge?: JQuery.AjaxSettings) {\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.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="jquery/misc" />
+/// <reference types="jquery/jquerystatic" />
+import { HttpResponseModel, ODataHttpClient } from "@odata2ts/http-client-api";
+import { AjaxRequestConfig } from "./AjaxRequestConfig";
+export type ErrorMessageRetriever = (errorResponse: any) => string | undefined;
+export interface ClientOptions {
+    useCsrfProtection?: boolean;
+    csrfTokenFetchUrl?: string;
+}
+export declare const getV2OrV4ErrorMessage: ErrorMessageRetriever;
+export declare class JQueryClient implements ODataHttpClient<AjaxRequestConfig> {
+    private clientOptions?;
+    private readonly client;
+    private readonly config;
+    private csrfToken;
+    private getErrorMessage;
+    constructor(jquery: JQueryStatic, config?: AjaxRequestConfig, clientOptions?: ClientOptions | undefined);
+    setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever): void;
+    private setupSecurityToken;
+    private fetchSecurityToken;
+    private sendRequest;
+    private prepareData;
+    post<ResponseModel>(url: string, data: any, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    get<ResponseModel>(url: string, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    put<ResponseModel>(url: string, data: any, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    patch<ResponseModel>(url: string, data: any, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    merge<ResponseModel>(url: string, data: any, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>>;
+    delete(url: string, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<void>>;
+}

package/lib/JQueryClient.js

@@ -0,0 +1,132 @@
+"use strict";
+/// <reference path="../../../node_modules/@types/jquery/misc.d.ts" />
+/// <reference path="../../../node_modules/@types/jquery/JQueryStatic.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JQueryClient = exports.getV2OrV4ErrorMessage = void 0;
+const tslib_1 = require("tslib");
+const AjaxRequestConfig_1 = require("./AjaxRequestConfig");
+const JQueryClientError_1 = require("./JQueryClientError");
+const getV2OrV4ErrorMessage = (errorResponse) => {
+    var _a;
+    const eMsg = (_a = errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.error) === null || _a === void 0 ? void 0 : _a.message;
+    return typeof (eMsg === null || eMsg === void 0 ? void 0 : eMsg.value) === "string" ? eMsg.value : eMsg;
+};
+exports.getV2OrV4ErrorMessage = getV2OrV4ErrorMessage;
+class JQueryClient {
+    constructor(jquery, config, clientOptions) {
+        this.clientOptions = clientOptions;
+        this.getErrorMessage = exports.getV2OrV4ErrorMessage;
+        this.client = jquery;
+        this.config = (0, AjaxRequestConfig_1.getDefaultConfig)(config);
+    }
+    setErrorMessageRetriever(getErrorMsg) {
+        this.getErrorMessage = getErrorMsg;
+    }
+    setupSecurityToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (!this.csrfToken) {
+                this.csrfToken = yield this.fetchSecurityToken();
+            }
+            return this.csrfToken;
+        });
+    }
+    fetchSecurityToken() {
+        var _a, _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const fetchUrl = (_b = (_a = this.clientOptions) === null || _a === void 0 ? void 0 : _a.csrfTokenFetchUrl) !== null && _b !== void 0 ? _b : "/";
+            const response = yield this.get(fetchUrl, { headers: { "x-csrf-token": "Fetch" } });
+            return response.headers["x-csrf-token"];
+        });
+    }
+    sendRequest(config, requestConfig) {
+        var _a;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mergedConfig = (0, AjaxRequestConfig_1.mergeAjaxConfig)((0, AjaxRequestConfig_1.mergeAjaxConfig)(this.config, requestConfig), config);
+            // setup automatic CSRF token handling
+            if (((_a = this.clientOptions) === null || _a === void 0 ? void 0 : _a.useCsrfProtection) &&
+                mergedConfig.method &&
+                ["POST", "PUT", "PATCH", "DELETE"].includes(mergedConfig.method.toUpperCase())) {
+                const csrfToken = yield this.setupSecurityToken();
+                if (!mergedConfig.headers) {
+                    mergedConfig.headers = {};
+                }
+                if (this.csrfToken) {
+                    mergedConfig.headers["x-csrf-token"] = csrfToken;
+                }
+            }
+            // the actual request
+            return new Promise((resolve, reject) => {
+                this.client.ajax(Object.assign(Object.assign({}, mergedConfig), { success: (response, textStatus, jqXHR) => {
+                        // Convert the header string into an array of individual headers
+                        const headers = jqXHR
+                            .getAllResponseHeaders()
+                            .trim()
+                            .split(/[\r\n]+/)
+                            .reduce((collector, line) => {
+                            const parts = line.split(": ");
+                            const header = parts.shift();
+                            const value = parts.join(": ");
+                            if (header) {
+                                collector[header.toLowerCase()] = value;
+                            }
+                            return collector;
+                        }, {});
+                        resolve({
+                            status: jqXHR.status,
+                            statusText: jqXHR.statusText,
+                            headers,
+                            data: response,
+                        });
+                    }, error: (jqXHR, textStatus, thrownError) => {
+                        var _a;
+                        // automatic CSRF token handling
+                        if (((_a = this.clientOptions) === null || _a === void 0 ? void 0 : _a.useCsrfProtection) &&
+                            jqXHR.status === 403 &&
+                            jqXHR.getResponseHeader("x-csrf-token") === "Required") {
+                            // csrf token expired, let's reset it and perform the original request again
+                            this.csrfToken = undefined;
+                            this.sendRequest(config, requestConfig).then(resolve).catch(reject);
+                        }
+                        // actual error handling
+                        else {
+                            const message = this.getErrorMessage(jqXHR.responseJSON);
+                            if (message) {
+                                reject(new JQueryClientError_1.JQueryClientError("Server responded with error: " + message, jqXHR.status, jqXHR));
+                            }
+                            else {
+                                reject(new JQueryClientError_1.JQueryClientError(textStatus + " " + thrownError, jqXHR.status, jqXHR));
+                            }
+                        }
+                    } }));
+            });
+        });
+    }
+    prepareData(data) {
+        return JSON.stringify(data);
+    }
+    post(url, data, requestConfig) {
+        return this.sendRequest({ url, data: this.prepareData(data), method: "POST" }, requestConfig);
+    }
+    get(url, requestConfig) {
+        return this.sendRequest({ url, method: "GET" }, requestConfig);
+    }
+    put(url, data, requestConfig) {
+        return this.sendRequest({ url, data: this.prepareData(data), method: "PUT" }, requestConfig);
+    }
+    patch(url, data, requestConfig) {
+        return this.sendRequest({ url, data: this.prepareData(data), method: "PATCH" }, requestConfig);
+    }
+    merge(url, data, requestConfig) {
+        const config = (0, AjaxRequestConfig_1.mergeAjaxConfig)(requestConfig, {
+            headers: {
+                "X-Http-Method": "MERGE",
+            },
+        });
+        return this.sendRequest({ url, data: this.prepareData(data), method: "POST" }, config);
+    }
+    delete(url, requestConfig) {
+        return this.sendRequest({ url, method: "DELETE" }, requestConfig);
+    }
+}
+exports.JQueryClient = JQueryClient;
+//# sourceMappingURL=JQueryClient.js.map

package/lib/JQueryClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JQueryClient.js","sourceRoot":"","sources":["../src/JQueryClient.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,8EAA8E;;;;AAI9E,2DAA2F;AAC3F,2DAAwD;AASjD,MAAM,qBAAqB,GAA0B,CAAC,aAAkB,EAAsB,EAAE;;IACrG,MAAM,IAAI,GAAG,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,0CAAE,OAAO,CAAC;IAC3C,OAAO,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7D,CAAC,CAAC;AAHW,QAAA,qBAAqB,yBAGhC;AAEF,MAAa,YAAY;IAMvB,YAAY,MAAoB,EAAE,MAA0B,EAAU,aAA6B;QAA7B,kBAAa,GAAb,aAAa,CAAgB;QAF3F,oBAAe,GAA0B,6BAAqB,CAAC;QAGrE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAA,oCAAgB,EAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,wBAAwB,CAAC,WAAkC;QAChE,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;IACrC,CAAC;IAEa,kBAAkB;;YAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aAClD;YACD,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;KAAA;IAEa,kBAAkB;;;YAC9B,MAAM,QAAQ,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,iBAAiB,mCAAI,GAAG,CAAC;YAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YAEpF,OAAO,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;;KACzC;IAEa,WAAW,CACvB,MAA2B,EAC3B,aAAiC;;;YAEjC,MAAM,YAAY,GAAG,IAAA,mCAAe,EAAC,IAAA,mCAAe,EAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;YAE1F,sCAAsC;YACtC,IACE,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,iBAAiB;gBACrC,YAAY,CAAC,MAAM;gBACnB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAC9E;gBACA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAClD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;oBACzB,YAAY,CAAC,OAAO,GAAG,EAAE,CAAC;iBAC3B;gBACD,IAAI,IAAI,CAAC,SAAS,EAAE;oBAClB,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;iBAClD;aACF;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,gEAAgE;wBAChE,MAAM,OAAO,GAAG,KAAK;6BAClB,qBAAqB,EAAE;6BACvB,IAAI,EAAE;6BACN,KAAK,CAAC,SAAS,CAAC;6BAChB,MAAM,CAAC,CAAC,SAAiC,EAAE,IAAY,EAAE,EAAE;4BAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;4BAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;4BAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BAE/B,IAAI,MAAM,EAAE;gCACV,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;6BACzC;4BACD,OAAO,SAAS,CAAC;wBACnB,CAAC,EAAE,EAAE,CAAC,CAAC;wBAET,OAAO,CAAC;4BACN,MAAM,EAAE,KAAK,CAAC,MAAM;4BACpB,UAAU,EAAE,KAAK,CAAC,UAAU;4BAC5B,OAAO;4BACP,IAAI,EAAE,QAAQ;yBACf,CAAC,CAAC;oBACL,CAAC,EACD,KAAK,EAAE,CAAC,KAAmB,EAAE,UAAkB,EAAE,WAAmB,EAAE,EAAE;;wBACtE,gCAAgC;wBAChC,IACE,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,iBAAiB;4BACrC,KAAK,CAAC,MAAM,KAAK,GAAG;4BACpB,KAAK,CAAC,iBAAiB,CAAC,cAAc,CAAC,KAAK,UAAU,EACtD;4BACA,4EAA4E;4BAC5E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;4BAC3B,IAAI,CAAC,WAAW,CAAe,MAAM,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;yBACnF;wBACD,wBAAwB;6BACnB;4BACH,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;4BACzD,IAAI,OAAO,EAAE;gCACX,MAAM,CAAC,IAAI,qCAAiB,CAAC,+BAA+B,GAAG,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;6BAC/F;iCAAM;gCACL,MAAM,CAAC,IAAI,qCAAiB,CAAC,UAAU,GAAG,GAAG,GAAG,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;6BACpF;yBACF;oBACH,CAAC,IACD,CAAC;YACL,CAAC,CAAC,CAAC;;KACJ;IAEO,WAAW,CAAC,IAAS;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAEM,IAAI,CACT,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/G,CAAC;IACM,GAAG,CAAgB,GAAW,EAAE,aAAiC;QACtE,OAAO,IAAI,CAAC,WAAW,CAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IACM,GAAG,CACR,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9G,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;IAChH,CAAC;IACM,KAAK,CACV,GAAW,EACX,IAAS,EACT,aAAiC;QAEjC,MAAM,MAAM,GAAG,IAAA,mCAAe,EAAC,aAAa,EAAE;YAC5C,OAAO,EAAE;gBACP,eAAe,EAAE,OAAO;aACzB;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,CAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC;IACxG,CAAC;IACM,MAAM,CAAC,GAAW,EAAE,aAAiC;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAO,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;CACF;AAlJD,oCAkJC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/misc.d.ts\" />\n/// <reference path=\"../../../node_modules/@types/jquery/JQueryStatic.d.ts\" />\n\nimport { HttpResponseModel, ODataHttpClient } from \"@odata2ts/http-client-api\";\n\nimport { AjaxRequestConfig, getDefaultConfig, mergeAjaxConfig } from \"./AjaxRequestConfig\";\nimport { JQueryClientError } from \"./JQueryClientError\";\n\nexport type ErrorMessageRetriever = (errorResponse: any) => string | undefined;\n\nexport interface ClientOptions {\n  useCsrfProtection?: boolean;\n  csrfTokenFetchUrl?: string;\n}\n\nexport const getV2OrV4ErrorMessage: ErrorMessageRetriever = (errorResponse: any): string | undefined => {\n  const eMsg = errorResponse?.error?.message;\n  return typeof eMsg?.value === \"string\" ? eMsg.value : eMsg;\n};\n\nexport class JQueryClient implements ODataHttpClient<AjaxRequestConfig> {\n  private readonly client: JQueryStatic;\n  private readonly config: JQuery.AjaxSettings;\n  private csrfToken: string | undefined;\n  private getErrorMessage: ErrorMessageRetriever = getV2OrV4ErrorMessage;\n\n  constructor(jquery: JQueryStatic, config?: AjaxRequestConfig, private clientOptions?: ClientOptions) {\n    this.client = jquery;\n    this.config = getDefaultConfig(config);\n  }\n\n  public setErrorMessageRetriever(getErrorMsg: ErrorMessageRetriever) {\n    this.getErrorMessage = getErrorMsg;\n  }\n\n  private async setupSecurityToken() {\n    if (!this.csrfToken) {\n      this.csrfToken = await this.fetchSecurityToken();\n    }\n    return this.csrfToken;\n  }\n\n  private async fetchSecurityToken(): Promise<string | undefined> {\n    const fetchUrl = this.clientOptions?.csrfTokenFetchUrl ?? \"/\";\n    const response = await this.get(fetchUrl, { headers: { \"x-csrf-token\": \"Fetch\" } });\n\n    return response.headers[\"x-csrf-token\"];\n  }\n\n  private async sendRequest<ResponseType>(\n    config: JQuery.AjaxSettings,\n    requestConfig?: AjaxRequestConfig\n  ): Promise<HttpResponseModel<ResponseType>> {\n    const mergedConfig = mergeAjaxConfig(mergeAjaxConfig(this.config, requestConfig), config);\n\n    // setup automatic CSRF token handling\n    if (\n      this.clientOptions?.useCsrfProtection &&\n      mergedConfig.method &&\n      [\"POST\", \"PUT\", \"PATCH\", \"DELETE\"].includes(mergedConfig.method.toUpperCase())\n    ) {\n      const csrfToken = await this.setupSecurityToken();\n      if (!mergedConfig.headers) {\n        mergedConfig.headers = {};\n      }\n      if (this.csrfToken) {\n        mergedConfig.headers[\"x-csrf-token\"] = csrfToken;\n      }\n    }\n\n    // the actual request\n    return new Promise((resolve, reject) => {\n      this.client.ajax({\n        ...mergedConfig,\n        success: (response: any, textStatus: string, jqXHR: JQuery.jqXHR) => {\n          // Convert the header string into an array of individual headers\n          const headers = 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          resolve({\n            status: jqXHR.status,\n            statusText: jqXHR.statusText,\n            headers,\n            data: response,\n          });\n        },\n        error: (jqXHR: JQuery.jqXHR, textStatus: string, thrownError: string) => {\n          // automatic CSRF token handling\n          if (\n            this.clientOptions?.useCsrfProtection &&\n            jqXHR.status === 403 &&\n            jqXHR.getResponseHeader(\"x-csrf-token\") === \"Required\"\n          ) {\n            // csrf token expired, let's reset it and perform the original request again\n            this.csrfToken = undefined;\n            this.sendRequest<ResponseType>(config, requestConfig).then(resolve).catch(reject);\n          }\n          // actual error handling\n          else {\n            const message = this.getErrorMessage(jqXHR.responseJSON);\n            if (message) {\n              reject(new JQueryClientError(\"Server responded with error: \" + message, jqXHR.status, jqXHR));\n            } else {\n              reject(new JQueryClientError(textStatus + \" \" + thrownError, jqXHR.status, jqXHR));\n            }\n          }\n        },\n      });\n    });\n  }\n\n  private prepareData(data: any): string {\n    return JSON.stringify(data);\n  }\n\n  public post<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AjaxRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest<ResponseModel>({ url, data: this.prepareData(data), method: \"POST\" }, requestConfig);\n  }\n  public get<ResponseModel>(url: string, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest<ResponseModel>({ url, method: \"GET\" }, requestConfig);\n  }\n  public put<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AjaxRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest<ResponseModel>({ url, data: this.prepareData(data), method: \"PUT\" }, requestConfig);\n  }\n  public patch<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AjaxRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    return this.sendRequest<ResponseModel>({ url, data: this.prepareData(data), method: \"PATCH\" }, requestConfig);\n  }\n  public merge<ResponseModel>(\n    url: string,\n    data: any,\n    requestConfig?: AjaxRequestConfig\n  ): Promise<HttpResponseModel<ResponseModel>> {\n    const config = mergeAjaxConfig(requestConfig, {\n      headers: {\n        \"X-Http-Method\": \"MERGE\",\n      },\n    });\n    return this.sendRequest<ResponseModel>({ url, data: this.prepareData(data), method: \"POST\" }, config);\n  }\n  public delete(url: string, requestConfig?: AjaxRequestConfig): Promise<HttpResponseModel<void>> {\n    return this.sendRequest<void>({ url, method: \"DELETE\" }, requestConfig);\n  }\n}\n"]}

package/lib/JQueryClientError.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="jquery/misc" />
+export declare class JQueryClientError extends Error {
+    readonly status: number | undefined;
+    readonly cause: Error | JQuery.jqXHR | undefined;
+    constructor(msg: string, status: number | undefined, cause: Error | JQuery.jqXHR | undefined);
+}

package/lib/JQueryClientError.js

@@ -0,0 +1,14 @@
+"use strict";
+/// <reference path="../../../node_modules/@types/jquery/misc.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JQueryClientError = void 0;
+class JQueryClientError extends Error {
+    constructor(msg, status, cause) {
+        super(msg, { cause });
+        this.status = status;
+        this.cause = cause;
+        this.name = this.constructor.name;
+    }
+}
+exports.JQueryClientError = JQueryClientError;
+//# sourceMappingURL=JQueryClientError.js.map

package/lib/JQueryClientError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JQueryClientError.js","sourceRoot":"","sources":["../src/JQueryClientError.ts"],"names":[],"mappings":";AAAA,sEAAsE;;;AAEtE,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACE,GAAW,EACK,MAA0B,EAC1B,KAAuC;QAEvD,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAHN,WAAM,GAAN,MAAM,CAAoB;QAC1B,UAAK,GAAL,KAAK,CAAkC;QAGvD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AATD,8CASC","sourcesContent":["/// <reference path=\"../../../node_modules/@types/jquery/misc.d.ts\" />\r\n\r\nexport class JQueryClientError extends Error {\r\n  constructor(\r\n    msg: string,\r\n    public readonly status: number | undefined,\r\n    public readonly cause: Error | JQuery.jqXHR | undefined\r\n  ) {\r\n    super(msg, { cause });\r\n    this.name = this.constructor.name;\r\n  }\r\n}\r\n"]}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { AjaxRequestConfig } from "./AjaxRequestConfig";
+export * from "./JQueryClient";
+export type { JQueryClientError } from "./JQueryClientError";

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./JQueryClient"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,yDAA+B","sourcesContent":["export { AjaxRequestConfig } from \"./AjaxRequestConfig\";\r\nexport * from \"./JQueryClient\";\r\nexport type { JQueryClientError } from \"./JQueryClientError\";\r\n"]}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@odata2ts/http-client-jquery",
+  "version": "0.4.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "JQuery based http client usable by odata2ts",
+  "license": "MIT",
+  "repository": "git@github.com:odata2ts/http-client.git",
+  "author": "texttechne",
+  "main": "./lib/index.js",
+  "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"
+  },
+  "files": [
+    "*.md",
+    "lib",
+    "LICENSE"
+  ],
+  "keywords": [
+    "http client",
+    "jquery",
+    "ui5",
+    "odata2ts",
+    "ts",
+    "typescript"
+  ],
+  "peerDependencies": {
+    "jquery": ">1.0"
+  },
+  "dependencies": {
+    "@odata2ts/http-client-api": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@types/jquery": "^3.5.16",
+    "@types/node": "^20.2.5",
+    "jest": "29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "jquery": "^3.6.3",
+    "rimraf": "^5.0.1",
+    "ts-jest": "^29.1.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.0.4"
+  },
+  "types": "./lib/index.d.ts",
+  "gitHead": "a93b726286ef9a118fda63b0e7900d6b3e739dd2"
+}