@brandup/ui-ajax 2.0.1 → 2.0.2

package/dist/mjs/queue.js

@@ -0,0 +1,136 @@
+import { request } from './request.js';
+
+/** Queue that executes AJAX requests one at a time, in the order they were added. */
+class AjaxQueue {
+    _options;
+    _requests = [];
+    _current = null;
+    _destroyed = false;
+    /** @param options Optional queue-wide hooks. */
+    constructor(options) {
+        this._options = options ?? {};
+    }
+    /** Number of requests waiting in the queue (excluding the one currently executing). */
+    get length() { return this._requests.length; }
+    /** `true` when nothing is queued and no request is currently executing. */
+    get isFree() { return !this._requests.length && !this._current; }
+    /** `true` when no requests are waiting in the queue (a request may still be executing). */
+    get isEmpty() { return !this._requests.length; }
+    /**
+     * Adds a request to the queue. Starts executing immediately if the queue is idle.
+     *
+     * @param request Request options; its `success`/`error` callbacks are invoked as usual.
+     * @param abortSignal Optional signal used to cancel this specific request.
+     * @throws If the queue has been destroyed.
+     */
+    push(request, abortSignal) {
+        if (this._destroyed)
+            throw new Error("AjaxQueue is destroyed.");
+        this._requests.push({ request, cancel: abortSignal });
+        if (!this._current)
+            this.__execute();
+    }
+    /**
+     * Adds a request to the queue and returns a promise for its response.
+     *
+     * Wraps {@link push}; the request's own `success`/`error` callbacks are still invoked,
+     * then the promise resolves with the response or rejects with the failure reason.
+     *
+     * @param request Request options.
+     * @param abortSignal Optional signal used to cancel this specific request.
+     * @returns A promise resolving with the {@link AjaxResponse}.
+     */
+    enqueue(request, abortSignal) {
+        const { success, error } = request;
+        return new Promise((resolve, reject) => {
+            request.success = (response) => {
+                if (success)
+                    success(response);
+                resolve(response);
+            };
+            request.error = (request, reason) => {
+                if (error)
+                    error(request, reason);
+                reject(reason);
+            };
+            this.push(request, abortSignal);
+        });
+    }
+    /** @deprecated Renamed to {@link enqueue}. */
+    enque(request, abortSignal) {
+        return this.enqueue(request, abortSignal);
+    }
+    /**
+     * Clears all queued (not-yet-started) requests.
+     *
+     * @param cancelCurrentRequest When `true`, also aborts the request currently executing.
+     */
+    reset(cancelCurrentRequest = false) {
+        this._requests = [];
+        const current = this._current;
+        this._current = null;
+        if (cancelCurrentRequest && current)
+            current.abort?.abort("ResetAjaxQueue");
+    }
+    /** Destroys the queue: clears pending requests and aborts the current one. Subsequent {@link push} calls throw. */
+    destroy() {
+        if (this._destroyed)
+            return;
+        this._destroyed = true;
+        this._requests = [];
+        if (this._current) {
+            this._current.abort?.abort("DestroyAjaxQueue");
+            this._current = null;
+        }
+    }
+    __execute() {
+        if (this._destroyed)
+            return;
+        if (this._current)
+            throw new Error("AjaxQueue currently is executing.");
+        const task = this._current = this._requests.shift() ?? null;
+        if (task) {
+            if (this._options.canRequest && this._options.canRequest(task.request) === false) {
+                this.__next(task);
+                return;
+            }
+            if (task.request.abort?.aborted || task.cancel?.aborted) {
+                const err = new Error("Request cancelled");
+                task.request.error?.(task.request, err);
+                task.result = Promise.reject(err);
+            }
+            else {
+                task.abort = new AbortController();
+                task.result = request(task.request, task.cancel ? AbortSignal.any([task.abort.signal, task.cancel]) : task.abort.signal);
+            }
+            task.result
+                .then(response => {
+                if (this._destroyed)
+                    return;
+                if (this._options.successRequest)
+                    this._options.successRequest(task.request, response);
+            })
+                .catch(reason => {
+                if (this._destroyed)
+                    return;
+                if (this._options.errorRequest)
+                    this._options.errorRequest(task.request, reason);
+            })
+                .finally(() => this.__next(task));
+        }
+    }
+    // completedTask is the task that finished — if _current already changed
+    // (e.g. reset(true) was called and a new push() started a new task), bail out
+    // to avoid clearing the new task's reference or double-executing the queue.
+    __next(completedTask) {
+        if (this._destroyed)
+            return;
+        if (this._current !== completedTask)
+            return;
+        this._current = null;
+        this.__execute();
+    }
+}
+
+export { AjaxQueue };
+//# sourceMappingURL=queue.js.map

package/dist/mjs/queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.js","sources":["../../../source/queue.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;MACa,SAAS,CAAA;AACb,IAAA,QAAQ;IACR,SAAS,GAAuB,EAAE;IAClC,QAAQ,GAAuB,IAAI;IACnC,UAAU,GAAG,KAAK;;AAG1B,IAAA,WAAA,CAAY,OAA0B,EAAA;AACrC,QAAA,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE;IAC9B;;IAGA,IAAI,MAAM,GAAA,EAAa,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;;AAErD,IAAA,IAAI,MAAM,GAAA,EAAc,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;;IAEzE,IAAI,OAAO,GAAA,EAAc,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAExD;;;;;;AAMG;IACH,IAAI,CAAC,OAAoB,EAAE,WAAyB,EAAA;QACnD,IAAI,IAAI,CAAC,UAAU;AAClB,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;AAE3C,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAErD,IAAI,CAAC,IAAI,CAAC,QAAQ;YACjB,IAAI,CAAC,SAAS,EAAE;IAClB;AAEA;;;;;;;;;AASG;IACH,OAAO,CAAkB,OAAoB,EAAE,WAAyB,EAAA;AACvE,QAAA,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO;QAElC,OAAO,IAAI,OAAO,CAA0B,CAAC,OAAO,EAAE,MAAM,KAAI;AAC/D,YAAA,OAAO,CAAC,OAAO,GAAG,CAAC,QAAiC,KAAI;AACvD,gBAAA,IAAI,OAAO;oBACV,OAAO,CAAC,QAAQ,CAAC;gBAElB,OAAO,CAAC,QAAQ,CAAC;AAClB,YAAA,CAAC;YACD,OAAO,CAAC,KAAK,GAAG,CAAC,OAAoB,EAAE,MAAY,KAAI;AACtD,gBAAA,IAAI,KAAK;AACR,oBAAA,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEvB,MAAM,CAAC,MAAM,CAAC;AACf,YAAA,CAAC;AAED,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC;AAChC,QAAA,CAAC,CAAC;IACH;;IAGA,KAAK,CAAkB,OAAoB,EAAE,WAAyB,EAAA;QACrE,OAAO,IAAI,CAAC,OAAO,CAAY,OAAO,EAAE,WAAW,CAAC;IACrD;AAEA;;;;AAIG;IACH,KAAK,CAAC,oBAAoB,GAAG,KAAK,EAAA;AACjC,QAAA,IAAI,CAAC,SAAS,GAAG,EAAE;AAEnB,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ;AAC7B,QAAA,IAAI,CAAC,QAAQ,GAAG,IAAI;QAEpB,IAAI,oBAAoB,IAAI,OAAO;AAClC,YAAA,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC;IACxC;;IAGA,OAAO,GAAA;QACN,IAAI,IAAI,CAAC,UAAU;YAClB;AACD,QAAA,IAAI,CAAC,UAAU,GAAG,IAAI;AAEtB,QAAA,IAAI,CAAC,SAAS,GAAG,EAAE;AAEnB,QAAA,IAAI,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC;AAC9C,YAAA,IAAI,CAAC,QAAQ,GAAG,IAAI;QACrB;IACD;IAEQ,SAAS,GAAA;QAChB,IAAI,IAAI,CAAC,UAAU;YAClB;QAED,IAAI,IAAI,CAAC,QAAQ;AAChB,YAAA,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAErD,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,IAAI;QAE3D,IAAI,IAAI,EAAE;AACT,YAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;AACjF,gBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACjB;YACD;AAEA,YAAA,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE;AACxD,gBAAA,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,mBAAmB,CAAC;AAC1C,gBAAA,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC;gBACvC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YAClC;iBACK;AACJ,gBAAA,IAAI,CAAC,KAAK,GAAG,IAAI,eAAe,EAAE;AAClC,gBAAA,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YACzH;AAEA,YAAA,IAAI,CAAC;iBACH,IAAI,CAAC,QAAQ,IAAG;gBAChB,IAAI,IAAI,CAAC,UAAU;oBAClB;AAED,gBAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc;oBAC/B,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;AACtD,YAAA,CAAC;iBACA,KAAK,CAAC,MAAM,IAAG;gBACf,IAAI,IAAI,CAAC,UAAU;oBAClB;AAED,gBAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY;oBAC7B,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;AAClD,YAAA,CAAC;iBACA,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnC;IACD;;;;AAKQ,IAAA,MAAM,CAAC,aAA0B,EAAA;QACxC,IAAI,IAAI,CAAC,UAAU;YAClB;AACD,QAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,aAAa;YAClC;AAED,QAAA,IAAI,CAAC,QAAQ,GAAG,IAAI;QACpB,IAAI,CAAC,SAAS,EAAE;IACjB;AACA;;;;"}

package/dist/mjs/request.js

@@ -0,0 +1,106 @@
+import { addQuery } from './helpers.js';
+import internals from './internals.js';
+
+/**
+ * Performs an AJAX request using the Fetch API.
+ *
+ * The response body is parsed according to its `Content-Type`: JSON, `text/html`,
+ * `text/plain`, otherwise a `Blob`. `disableCache` maps to `cache: "no-store"`.
+ * The request is aborted when its `timeout` elapses (defaults to 30000 ms), or when
+ * `options.abort` or the `abortSignal` argument signals.
+ *
+ * @param options Request options. `GET`/`HEAD` requests must not carry `data`.
+ * @param abortSignal Optional additional signal used to cancel the request.
+ * @returns The parsed response. `options.success` is also invoked before resolving.
+ * @throws On network/abort/timeout errors, or for unsupported (opaque) response types; `options.error` is invoked before re-throwing.
+ */
+async function request(options, abortSignal) {
+    let { mode, credentials = "include" } = options;
+    let url = options.url || location.href;
+    url = addQuery(url, options.query);
+    const method = options.method ? options.method.toUpperCase() : "GET";
+    let body = options.data;
+    if (body && (method === "GET" || method === "HEAD"))
+        throw new Error(`${method} method does not support a request body.`);
+    internals.detectRequestType(options);
+    const prepared = internals.prepareRequest(options, body);
+    const abortSignals = [AbortSignal.timeout(options.timeout ?? internals.DEFAULT_TIMEOUT)];
+    if (options.abort)
+        abortSignals.push(options.abort);
+    if (abortSignal)
+        abortSignals.push(abortSignal);
+    try {
+        const response = await fetch(url, {
+            method,
+            headers: new Headers(prepared.headers),
+            cache: options.disableCache ? "no-store" : "default",
+            mode,
+            credentials,
+            redirect: "follow",
+            signal: AbortSignal.any(abortSignals),
+            body: prepared.body
+        });
+        let result;
+        switch (response.type) {
+            case "basic":
+            case "default":
+            case "cors": {
+                let responseData = null;
+                let responseType = "none";
+                let contentType = response.headers.get("content-type");
+                if (!response.redirected && response.body) {
+                    if (contentType) {
+                        const ctSplitIndex = contentType.indexOf(";");
+                        if (ctSplitIndex > 0)
+                            contentType = contentType.substring(0, ctSplitIndex);
+                        if (contentType.includes("json")) {
+                            responseType = "json";
+                            responseData = await response.json();
+                        }
+                        else if (contentType.includes("text/html")) {
+                            responseType = "html";
+                            responseData = await response.text();
+                        }
+                        else if (contentType.includes("text/plain")) {
+                            responseType = "text";
+                            responseData = await response.text();
+                        }
+                        else {
+                            responseType = "blob";
+                            responseData = await response.blob();
+                        }
+                    }
+                }
+                result = {
+                    status: response.status,
+                    url: response.url,
+                    redirected: response.redirected,
+                    type: responseType,
+                    contentType,
+                    headers: response.headers,
+                    data: responseData,
+                    state: options.state
+                };
+                break;
+            }
+            case "opaqueredirect":
+            case "opaque":
+                throw new Error(`Not supported response type: ${response.type}`);
+            case "error":
+                throw new Error("Response error.");
+            default:
+                throw new Error(`Unknown response type: ${response.type}`);
+        }
+        if (options.success)
+            options.success(result);
+        return result;
+    }
+    catch (error) {
+        if (options.error)
+            options.error(options, error);
+        throw error;
+    }
+}
+
+export { request };
+//# sourceMappingURL=request.js.map

package/dist/mjs/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sources":["../../../source/request.ts"],"sourcesContent":[null],"names":["helpers.addQuery"],"mappings":";;;AAIA;;;;;;;;;;;;AAYG;AACI,eAAe,OAAO,CAA4B,OAA4B,EAAE,WAAyB,EAAA;IAC/G,IAAI,EAAE,IAAI,EAAE,WAAW,GAAG,SAAS,EAAE,GAAG,OAAO;IAC/C,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI;IACtC,GAAG,GAAGA,QAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC;AAE1C,IAAA,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,KAAK;AAEpE,IAAA,IAAI,IAAI,GAAQ,OAAO,CAAC,IAAI;IAC5B,IAAI,IAAI,KAAK,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,CAAC;AAClD,QAAA,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAA,wCAAA,CAA0C,CAAC;AAErE,IAAA,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;AAExD,IAAA,MAAM,YAAY,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC;IACxF,IAAI,OAAO,CAAC,KAAK;AAChB,QAAA,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;AACjC,IAAA,IAAI,WAAW;AACd,QAAA,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC;AAE/B,IAAA,IAAI;AACH,QAAA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YACjC,MAAM;AACN,YAAA,OAAO,EAAE,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YACtC,KAAK,EAAE,OAAO,CAAC,YAAY,GAAG,UAAU,GAAG,SAAS;YACpD,IAAI;YACJ,WAAW;AACX,YAAA,QAAQ,EAAE,QAAQ;AAClB,YAAA,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC;YACrC,IAAI,EAAE,QAAQ,CAAC;AACf,SAAA,CAAC;AAEF,QAAA,IAAI,MAAoB;AAExB,QAAA,QAAQ,QAAQ,CAAC,IAAI;AACpB,YAAA,KAAK,OAAO;AACZ,YAAA,KAAK,SAAS;YACd,KAAK,MAAM,EAAE;gBACZ,IAAI,YAAY,GAAQ,IAAI;gBAC5B,IAAI,YAAY,GAAiB,MAAM;gBAEvC,IAAI,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;gBACtD,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,IAAI,EAAE;oBAC1C,IAAI,WAAW,EAAE;wBAChB,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;wBAC7C,IAAI,YAAY,GAAG,CAAC;4BACnB,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC;AAErD,wBAAA,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;4BACjC,YAAY,GAAG,MAAM;AACrB,4BAAA,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;wBACrC;AACK,6BAAA,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;4BAC3C,YAAY,GAAG,MAAM;AACrB,4BAAA,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;wBACrC;AACK,6BAAA,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;4BAC5C,YAAY,GAAG,MAAM;AACrB,4BAAA,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;wBACrC;6BACK;4BACJ,YAAY,GAAG,MAAM;AACrB,4BAAA,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE;wBACrC;oBACD;gBACD;AAEA,gBAAA,MAAM,GAAG;oBACR,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,GAAG,EAAE,QAAQ,CAAC,GAAG;oBACjB,UAAU,EAAE,QAAQ,CAAC,UAAU;AAC/B,oBAAA,IAAI,EAAE,YAAY;oBAClB,WAAW;oBACX,OAAO,EAAE,QAAQ,CAAC,OAAO;AACzB,oBAAA,IAAI,EAAE,YAAY;oBAClB,KAAK,EAAE,OAAO,CAAC;iBACf;gBAED;YACD;AACA,YAAA,KAAK,gBAAgB;AACrB,YAAA,KAAK,QAAQ;gBACZ,MAAM,IAAI,KAAK,CAAC,CAAA,6BAAA,EAAgC,QAAQ,CAAC,IAAI,CAAA,CAAE,CAAC;AACjE,YAAA,KAAK,OAAO;AACX,gBAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC;AACnC,YAAA;gBACC,MAAM,IAAI,KAAK,CAAC,CAAA,uBAAA,EAA0B,QAAQ,CAAC,IAAI,CAAA,CAAE,CAAC;;QAG5D,IAAI,OAAO,CAAC,OAAO;AAClB,YAAA,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;AAExB,QAAA,OAAO,MAAM;IACd;IACA,OAAO,KAAU,EAAE;QAClB,IAAI,OAAO,CAAC,KAAK;AAChB,YAAA,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC;AAE9B,QAAA,MAAM,KAAK;IACZ;AACD;;;;"}

package/package.json

@@ -21,10 +21,18 @@
     "email": "it@brandup.online"
   },
   "license": "Apache-2.0",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
   "types": "dist/types.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "files": [
     "dist",
     "README.md"