@optionfactory/ful 0.90.0 → 0.91.0

package/dist/ful.iife.js

@@ -73,21 +73,51 @@ var ful = (function (exports) {
         }
     }
 
+    /**
+     * @typedef {{ type: string; context: string?; reason: string; details: any?; }} Problem
+     */
     class Failure extends Error {
-        constructor(name, problems, cause) {
-            super(JSON.stringify(problems), { cause });
-            this.name = name;
+        /**
+         * 
+         * @param {string} message 
+         * @param {Problem[]} problems 
+         * @param {*} cause
+         */
+        constructor(message, problems, cause) {
+            super(message, { cause });
+            this.name = 'Failure';
             this.problems = problems;
         }
     }
 
+    /**
+     * @typedef {Int8Array| Uint8Array| Uint8ClampedArray| Int16Array| Uint16Array| Int32Array| Uint32Array| Float32Array| Float64Array| BigInt64Array| BigUint64Array} TypedArray
+     */
+    /**
+     * @typedef HttpInterceptor
+     * @property {function(Request,HttpInterceptorChain):Promise<Response>} intercept  
+     */
+
     class HttpClientError extends Failure {
-        constructor(status, problems, cause) {
-            super(`HttpClientError:${status}`, problems, cause);
+        /**
+         * @param {string} message
+         * @param {number} status
+         * @param {{ type: string; context: string?; reason: string; details: any?; }[]} problems
+         * @param {Error|undefined} [cause]
+         */
+        constructor(message, status, problems, cause) {
+            super(message, problems, cause);
+            this.name = 'HttpClientError';
             this.status = status;
         }
+        /**
+         * 
+         * @param {string} type 
+         * @param {any} cause 
+         * @returns 
+         */
         static of(type, cause) {
-            return new HttpClientError(0, [{
+            return new HttpClientError(cause.message, 0, [{
                 type,
                 context: null,
                 reason: cause.message,
@@ -101,47 +131,61 @@ var ful = (function (exports) {
          */
         static async fromResponse(response) {
             const text = await response.text();
-            const def = [{
+            const message = `${response.status} ${response.statusText}: ${text}`;
+            const fallback = [{
                 type: "GENERIC_PROBLEM",
                 context: null,
-                reason: `${response.status} ${response.statusText}: ${text}`,
+                reason: message,
                 details: null
             }];
             try {
-                return new HttpClientError(response.status, text ? JSON.parse(text) : def);
+                return new HttpClientError(message, response.status, text ? JSON.parse(text) : fallback);
             } catch (e) {
-                return new HttpClientError(response.status, def);
+                return new HttpClientError(message, response.status, fallback);
             }
         }
     }
 
+    /**
+     * @implements {HttpInterceptor}
+     */
     class CsrfTokenInterceptor {
         #k; #v;
         constructor() {
-            this.#k = document.querySelector("meta[name='_csrf_header']").getAttribute("content");
-            this.#v = document.querySelector("meta[name='_csrf']").getAttribute("content");
-        }
+            this.#k = document.querySelector("meta[name='_csrf_header']")?.getAttribute("content");
+            this.#v = document.querySelector("meta[name='_csrf']")?.getAttribute("content");
+        } 
         async intercept(request, chain) {
-            request.headers.set(this.#k, this.#v);
+            if(this.#k && this.#v) {
+                request.headers.set(this.#k, this.#v);
+            }
             return await chain.proceed(request);
         }
     }
-
+    /**
+     * @implements {HttpInterceptor}
+     */
     class RedirectOnUnauthorizedInterceptor {
         #redirectUri;
+        /**
+         * @param {string} redirectUri
+         */
         constructor(redirectUri) {
             this.#redirectUri = redirectUri;
         }
         async intercept(request, chain) {
             const response = await chain.proceed(request);
-            if (response.status !== 401) {
-                return response;
+            if (response.status === 401) {
+                window.location.href = this.#redirectUri;
             }
-            window.location.href = this.#redirectUri;
+            return response;
         }
     }
 
     class HttpClientBuilder {
+        /**
+         * @type {HttpInterceptor[]}
+         */
         #interceptors;
         constructor() {
             this.#interceptors = [];
@@ -154,6 +198,9 @@ var ful = (function (exports) {
             this.#interceptors.push(new RedirectOnUnauthorizedInterceptor(redirectUri));
             return this;
         }
+        /**
+         * @param {...HttpInterceptor} interceptors
+         */
         withInterceptors(...interceptors) {
             this.#interceptors.push(...interceptors);
             return this;
@@ -163,27 +210,35 @@ var ful = (function (exports) {
         }
     }
 
+    /**
+     * @implements {HttpInterceptor}
+     */
     class HttpCall {
-        /**
-         * 
-         * @async
-         * @param {Request} request 
-         * @param {HttpInterceptorChain} chain 
-         * @returns {Promise<Response>} the response
-         */
         async intercept(request, chain) {
             return await fetch(request);
         }
     }
 
     class HttpInterceptorChain {
+        #interceptors;
+        #current;
+        /**
+         * 
+         * @param {HttpInterceptor[]} interceptors 
+         * @param {number} current 
+         */
         constructor(interceptors, current) {
-            this.interceptors = interceptors;
-            this.current = current;
+            this.#interceptors = interceptors;
+            this.#current = current;
         }
+        /**
+         * 
+         * @param {Request} request 
+         * @returns {Promise<Response>} the response
+         */
         async proceed(request) {
-            const interceptor = this.interceptors[this.current];
-            return await interceptor.intercept(request, new HttpInterceptorChain(this.interceptors, this.current + 1));
+            const interceptor = this.#interceptors[this.#current];
+            return await interceptor.intercept(request, new HttpInterceptorChain(this.#interceptors, this.#current + 1));
         }
     }
 
@@ -191,14 +246,14 @@ var ful = (function (exports) {
         #interceptors;
         /**
          * Creates a builder for an HttpClient.
-         * @returns {HttpRequestBuilder} the client builder
+         * @returns {HttpClientBuilder} the client builder
          */
         static builder() {
             return new HttpClientBuilder();
         }
         /**
          * Creates an HttpClient.
-         * @returns {[HttpInterceptor]} interceptors - a list of interceptors to be registered for every request performed by the created client. 
+         * @param {HttpInterceptor[]|undefined} interceptors - a list of interceptors to be registered for every request performed by the created client. 
          */
         constructor(interceptors) {
             this.#interceptors = interceptors || [];
@@ -208,7 +263,7 @@ var ful = (function (exports) {
          * @async
          * @param {string} uri - the (possibly relative) request url
          * @param {RequestInit|undefined} options - fetch options
-         * @param {[any]|undefined} interceptors - the HttpInterceptors to be registered for this request.
+         * @param {HttpInterceptor[]|undefined} interceptors - the HttpInterceptors to be registered for this exchange.
          * @returns {Promise<Response>} the response
          */
         async exchange(uri, options, interceptors) {
@@ -275,12 +330,17 @@ var ful = (function (exports) {
         }
     }
 
-
+    /**
+     * 
+     * @param {Response} response 
+     * @param {'text'|'json'|'blob'|'arrayBuffer'} type 
+     * @returns 
+     */
     const unmarshal = async (response, type) => {
         try {
             return await response[type]();
-        } catch (e) {
-            throw HttpClientError.of("UNMARSHALING_PROBLEM", e);
+        } catch (ex) {
+            throw HttpClientError.of("UNMARSHALING_PROBLEM", ex);
         }
     };
 
@@ -322,7 +382,7 @@ var ful = (function (exports) {
          * @param {Headers} headers 
          * @param {any} body 
          * @param {Omit<RequestInit,"headers"|"method"|"body">} options 
-         * @param {[HttpInterceptor]} interceptors 
+         * @param {HttpInterceptor[]} interceptors 
          */
         constructor(client, method, uri, params, headers, body, options, interceptors) {
             this.#client = client;
@@ -336,7 +396,7 @@ var ful = (function (exports) {
         }
         /**
          * Add all passed headers to the request, overriding existing ones if that key already exists.
-         * @param {headersInit} hs 
+         * @param {HeadersInit} hs 
          * @returns {HttpRequestBuilder} this builder
          */
         headers(hs) {
@@ -398,6 +458,17 @@ var ful = (function (exports) {
             this.#body = JSON.stringify(body);
             return this;
         }
+        /**
+         * Sets the request body as a FormData configured using the callback.
+         * `Content-Type: multipart/form-data` header is automatically added by fetch if not explicitly set.
+         * @param {function(HttpMultipartRequestCustomizer):void} callback
+         */
+        multipart(callback) {
+            const formData = new FormData();
+            const builder = new HttpMultipartRequestCustomizer(formData);
+            callback(builder);
+            this.#body = formData;
+        }
         /**
          * Sets a fetch options for the request.
          * @param {Omit<RequestInit,"headers"|"method"|"body">} kvs
@@ -405,6 +476,7 @@ var ful = (function (exports) {
          */
         options(kvs) {
             for (const [k, v] of Object.entries(kvs)) {
+                // @ts-ignore
                 this.#options[k] = v;
             }
             return this;
@@ -471,11 +543,11 @@ var ful = (function (exports) {
                     throw await HttpClientError.fromResponse(response);
                 }
                 return response;
-            } catch (e) {
-                if (e instanceof Failure) {
-                    throw e;
+            } catch (ex) {
+                if (ex instanceof Failure) {
+                    throw ex;
                 }
-                throw HttpClientError.of("CONNECTION_PROBLEM", e);
+                throw HttpClientError.of("CONNECTION_PROBLEM", ex);
             }
         }
         /**
@@ -494,14 +566,6 @@ var ful = (function (exports) {
             const response = await this.fetch();
             return await unmarshal(response, 'json');
         }
-        /**
-         * Performs an HTTP exchange using the configured client request, and interceptos throwing a failure when response status is not in the 200-299 range.
-         * @returns {Promise<Uint8Array>} the response body, as an Uint8Array
-         */
-        async fetchBytes() {
-            const response = await this.fetch();
-            return await unmarshal(response, 'bytes');
-        }
         /**
          * Performs an HTTP exchange using the configured client request, and interceptos throwing a failure when response status is not in the 200-299 range.
          * @returns {Promise<Blob>} the response body, as a Blob
@@ -520,6 +584,54 @@ var ful = (function (exports) {
         }
     }
 
+
+    class HttpMultipartRequestCustomizer {
+        #formData;
+        /**
+         * 
+         * @param {FormData} formData 
+         */
+        constructor(formData){
+            this.#formData = formData;
+        }
+        /**
+         * Appends a value to the FormData.
+         * @param {string} name 
+         * @param {*} value 
+         * @returns this builder
+         */
+        field(name, value){
+            this.#formData.append(name, value);
+            return this;
+        }
+        /**
+         * Appends a Blob to the FormData. 
+         * If `filename` is omitted, FormData defaults are applied:
+         * The default filename for Blob objects is "blob"; 
+         * The default filename for File objects is the file's filename.
+         * @param {string} name 
+         * @param {Blob} value 
+         * @param {string|undefined} filename 
+         * @returns this builder
+         */
+        blob(name, value, filename){
+            this.#formData.append(name, value, filename);
+            return this;
+        }
+        /**
+         * Appends a JSON serialized blob to the FormData.
+         * @param {string} name 
+         * @param {any} value 
+         * @param {string|undefined} filename 
+         * @returns this builder
+         */
+        json(name, value, filename){
+            const blob = new Blob([JSON.stringify(value)], {type: 'application/json'});
+            this.#formData.append(name, blob, filename);
+            return this;
+        }
+    }
+
     class Storage {
         constructor(prefix, storage) {
             this.prefix = prefix;
@@ -616,7 +728,7 @@ var ful = (function (exports) {
             Object.entries(additionalParams || {}).forEach(kv => {
                 url.searchParams.set(kv[0], kv[1]);
             });
-            window.location = url;
+            window.location.href = url.toString();
         }
         async registration(additionalParams){
             await this.action(this.uri.registration, additionalParams);
@@ -626,7 +738,7 @@ var ful = (function (exports) {
                 kc_action: kcAction
             });
         }
-        async _tokenExchange(code, state) {
+        async #tokenExchange(code, state) {
             window.history.replaceState('', "", this.uri.redirect);
             const stateAndVerifier = this.storage.pop(AuthorizationCodeFlow.PKCE_AND_STATE_KEY);
             if (stateAndVerifier.state !== state) {
@@ -659,7 +771,7 @@ var ful = (function (exports) {
             if (code && this.storage.load(AuthorizationCodeFlow.PKCE_AND_STATE_KEY)) {
                 //if callback from keycloak and we have our state still stored
                 const state = url.searchParams.get("state");
-                return await this._tokenExchange(code, state);
+                return await this.#tokenExchange(code, state);
             }
             //if not authorized
             await this.action(this.uri.auth, {});
@@ -730,7 +842,7 @@ var ful = (function (exports) {
             const url = new URL(this.uri.logout);
             url.searchParams.set("post_logout_redirect_uri", this.uri.redirect);
             url.searchParams.set("id_token_hint", this.token.id_token);
-            window.location = url;
+            window.location.href = url.toString();
         }
 
         bearerToken() {
@@ -789,7 +901,7 @@ var ful = (function (exports) {
             };
 
             return function () {
-                args = arguments;
+                args = [...arguments];
                 previousTimestamp = new Date().getTime();
                 if (tid === null) {
                     tid = setTimeout(later, timeoutMs);
@@ -823,7 +935,7 @@ var ful = (function (exports) {
                     previousTimestamp = now;
                 }
                 const remaining = timeoutMs - (now - previousTimestamp);
-                args = arguments;
+                args = [...arguments];
                 if (remaining <= 0 || remaining > timeoutMs) {
                     if (tid !== null) {
                         clearTimeout(tid);
@@ -929,16 +1041,18 @@ var ful = (function (exports) {
                 .forEach(a => {
                     const target = a.substring(prefix.length);
                     if (target === 'class') {
-                        to.classList.add(...from.getAttribute(prefix + "class").split(" ").filter(a => a.length));
+                        const classes = from.getAttribute(prefix + "class")?.split(" ").filter(a => a.length) ?? [];
+                        to.classList.add(...classes);
                         return;
                     }
+                    // @ts-ignore
                     to.setAttribute(target, from.getAttribute(a));
                 });
         }
         /**
          * 
          * @param {HTMLElement} el 
-         * @param {stirng} attr 
+         * @param {string} attr 
          * @param {boolean} value 
          */
         static toggle(el, attr, value) {
@@ -965,19 +1079,21 @@ var ful = (function (exports) {
          * @returns the slots
          */
         static from(el) {
+            /** @type [string, Element][] */
             const namedSlots = Array.from(el.childNodes)
-                .filter(el => el.matches && el.matches('[slot]'))
+                .filter(el => el instanceof Element)
+                .filter(el => el.matches('[slot]'))
                 .map(el => {
                     el.remove();
                     const slot = el.getAttribute("slot");
                     el.removeAttribute("slot");
-                    return [slot, el];
+                    return [slot ?? 'unnamed', el];
                 });
             const slots = {};
             slots.default = new DocumentFragment();
             slots.default.append(...el.childNodes);
-            for(const [name,el] of namedSlots){
-                if(!(name in slots)){
+            for (const [name, el] of namedSlots) {
+                if (!(name in slots)) {
                     slots[name] = new DocumentFragment();
                 }
                 slots[name].append(el);
@@ -1003,7 +1119,8 @@ var ful = (function (exports) {
         #ec;
         put(k, fragment) {
             if (this.#ec) {
-                this.#idToTemplate[k] = Template.fromFragment(fragment, ec);
+                // @ts-ignore
+                this.#idToTemplate[k] = ftl.Template.fromFragment(fragment, this.#ec);
                 return;
             }
             this.#idToFragment[k] = fragment;
@@ -1022,6 +1139,7 @@ var ful = (function (exports) {
             this.#ec = ec;
             for (const [k, fragment] of Object.entries(this.#idToFragment)) {
                 delete this.#idToFragment[k];
+                // @ts-ignore
                 this.#idToTemplate[k] = ftl.Template.fromFragment(fragment, ec, ...data);
             }
         }
@@ -1125,8 +1243,8 @@ var ful = (function (exports) {
             #initialized;
             #reflecting;
             #internals;
-            constructor(...args) {
-                super(...args);
+            constructor() {
+                super();
                 this.#internals = this.attachInternals();
             }
             get initialized() {
@@ -1154,6 +1272,7 @@ var ful = (function (exports) {
                     observer.disconnect();
                     upgradeQueue.enqueue(this);
                 });
+                // @ts-ignore
                 observer.observe(this.parentNode, { childList: true, subtree: true });
             }
             attributeChangedCallback(attr, oldValue, newValue) {
@@ -1179,6 +1298,7 @@ var ful = (function (exports) {
                     return;
                 }
                 this.#parsed = true;
+                // @ts-ignore
                 await this.render(elements.template(templateId), slots ? LightSlots.from(this) : undefined);
 
                 for (const [attr, mapper] of attrsAndMappers) {
@@ -1330,7 +1450,7 @@ var ful = (function (exports) {
         }
         get values() {
             return Array.from(this.querySelectorAll('[name]'))
-                .filter((el) => {
+                .filter(el => {
                     if (el.dataset['fulBindInclude'] === 'never') {
                         return false;
                     }
@@ -1341,14 +1461,14 @@ var ful = (function (exports) {
                 }, {});
         }
         set errors(es) {
-            const fieldErrors = es.filter((e) => e.type === 'FIELD_ERROR' || e.type === 'INVALID_FORMAT');
-            const globalErrors = es.filter((e) => e.type !== 'FIELD_ERROR' && e.type !== 'INVALID_FORMAT');
+            const fieldErrors = es.filter(e => e.type === 'FIELD_ERROR' || e.type === 'INVALID_FORMAT');
+            const globalErrors = es.filter(e => e.type !== 'FIELD_ERROR' && e.type !== 'INVALID_FORMAT');
             this.querySelectorAll(`.${Form.INVALID_CLASS}`).forEach(el => el.classList.remove(Form.INVALID_CLASS));
             this.querySelectorAll("ful-errors").forEach(el => {
                 el.replaceChildren();
                 el.setAttribute('hidden', '');
             });
-            fieldErrors.forEach((e) => {
+            fieldErrors.forEach(e => {
                 const name = e.context.replace("[", ".").replace("].", ".");
                 const validationTargetsSelector = `[name='${CSS.escape(name)}'] [ful-validation-target],[name='${CSS.escape(name)}']:not(:has([ful-validation-target]))`;
                 this.querySelectorAll(validationTargetsSelector).forEach(input => input.classList.add(Form.INVALID_CLASS));
@@ -1419,6 +1539,7 @@ var ful = (function (exports) {
         slots: true,
         template: INPUT_TEMPLATE
     }){
+        input;
         render(template, slots) {
             const fragment = makeInputFragment(this, template, slots);
             this.replaceChildren(fragment);
@@ -1589,27 +1710,40 @@ var ful = (function (exports) {
                 input.addEventListener('change', evt => {
                     evt.stopPropagation();
                     //change is not cancelable
-                    this.dispatchEvent(new CustomEvent('change', { 
-                        bubbles: true, 
-                        cancelable: false, 
+                    this.dispatchEvent(new CustomEvent('change', {
+                        bubbles: true,
+                        cancelable: false,
                         detail: {
                             value: this.value
                         }
-                    }));        
-                });           
+                    }));
+                });
                 const label = Fragments.fromChildNodes(el);
                 return [input, label];
             });
 
             radioEls.forEach(el => el.remove());
-            template.renderTo(this, {name, slots, inputsAndLabels});
+            template.renderTo(this, { name, slots, inputsAndLabels });
         }
         get value() {
+            /** @type {HTMLInputElement|null} */
             const checked = this.querySelector('input[type=radio]:checked');
             return checked ? checked.value : null;
         }
         set value(value) {
-            this.querySelector(`input[type=radio][value=${CSS.escape(value)}]`).checked = true;
+            if (value === null) {
+                /** @type {HTMLInputElement[]} */
+                this.querySelectorAll(`input[type=radio]`).forEach(el => {
+                    // @ts-ignore
+                    el.checked = false;
+                });
+                return;
+            }
+            /** @type {HTMLInputElement|null} */
+            const el = this.querySelector(`input[type=radio][value=${CSS.escape(value)}]`);
+            if (el) {
+                el.checked = true;
+            }
         }
     }