@mgdis/mg-components 6.16.0 → 6.18.0

package/dist/collection/components/molecules/inputs/mg-input-combobox/mg-input-combobox.js

@@ -48,6 +48,7 @@ export class MgInputCombobox {
         this.classFocus = 'mg-u-is-focused';
         // hasDisplayedError (triggered by blur event)
         this.hasDisplayedError = false;
+        this.customErrorMessage = { lock: false };
         /**
          * Input name
          * If not set the value equals the identifier
@@ -182,7 +183,7 @@ export class MgInputCombobox {
             // override keys actions
             switch (event.key) {
                 case Keys.TAB:
-                case Keys.ENTER:
+                case Keys.ENTER: {
                     guard = event.key === Keys.ENTER;
                     const option = (_a = this.option) !== null && _a !== void 0 ? _a : this.options.items.find(this.isCurrentOption);
                     // Sets the value to the content of the focused option in the listbox.
@@ -192,12 +193,13 @@ export class MgInputCombobox {
                     // Closes the popover.
                     this.popoverDisplay = false;
                     break;
+                }
                 case Keys.DOWN:
                 case Keys.ARROWDOWN:
                 case Keys.UP:
-                case Keys.ARROWUP:
+                case Keys.ARROWUP: {
                     guard = true;
-                    if (this.isLoading || !(this.page.total > 0)) {
+                    if (this.isLoading || this.page.total === 0) {
                         this.popoverDisplay = true;
                         break;
                     }
@@ -228,12 +230,13 @@ export class MgInputCombobox {
                     // open popover
                     this.popoverDisplay = true;
                     break;
+                }
                 case Keys.LEFT:
                 case Keys.ARROWLEFT:
                 case Keys.HOME:
                 case Keys.RIGHT:
                 case Keys.ARROWRIGHT:
-                case Keys.END:
+                case Keys.END: {
                     // skip process if visual focus is not in popover
                     if (!isItem(this.option))
                         break;
@@ -253,8 +256,9 @@ export class MgInputCombobox {
                         this.input.setSelectionRange(index, index);
                     }
                     break;
+                }
                 case Keys.ESC:
-                case Keys.ESCAPE:
+                case Keys.ESCAPE: {
                     guard = true;
                     if (this.popoverDisplay) {
                         // If the popover is displayed, closes it.
@@ -268,10 +272,12 @@ export class MgInputCombobox {
                         this.option = null;
                     }
                     break;
-                default:
+                }
+                default: {
                     // Remove visual focus from popover options
                     this.option = null;
                     break;
+                }
             }
             if (guard) {
                 event.stopPropagation();
@@ -317,18 +323,20 @@ export class MgInputCombobox {
         };
         /**
          * Set input error message
-         * @param errorMessage - errorMessage override
+         * @param fromSetErrorContext - context come from `setError` method
          */
-        this.setErrorMessage = (errorMessage) => {
+        this.setErrorMessage = (fromSetErrorContext = false) => {
             // Set error message
             this.errorMessage = undefined;
-            // Does have a custom error message
-            if (!this.valid && errorMessage !== undefined) {
-                this.errorMessage = errorMessage;
-            }
-            // required
-            else if (!this.valid && this.input.validity.valueMissing) {
-                this.errorMessage = this.messages.errors.required;
+            if (!this.valid) {
+                // Does have a new custom error message OR does have a custom error message locked
+                if (fromSetErrorContext || (this.customErrorMessage.lock && this.customErrorMessage.message !== undefined)) {
+                    this.errorMessage = this.customErrorMessage.message;
+                }
+                // required
+                else if (this.input.validity.valueMissing) {
+                    this.errorMessage = this.messages.errors.required;
+                }
             }
         };
         /**
@@ -342,15 +350,14 @@ export class MgInputCombobox {
          * @returns promisified action
          */
         this.loadingWrapper = (action) => {
+            var _a;
             let promise;
             let index;
             // cache initial loading action if not defined
-            if (!Boolean(this.loadingAction)) {
-                this.loadingAction = action.name;
-            }
+            (_a = this.loadingAction) !== null && _a !== void 0 ? _a : (this.loadingAction = action.name);
             // update index
             if (Boolean(this.option) && this.loadingAction !== 'load-more') {
-                index = this.page.items.findIndex(option => option.value.toString() === this.option.value.toString());
+                index = this.page.items.findIndex(option => toString(option.value) === toString(this.option.value));
             }
             else if (this.loadingAction === 'load-more') {
                 index = this.page.items.length - this.page.baseIndex;
@@ -403,14 +410,14 @@ export class MgInputCombobox {
          */
         this.goToNextPage = () => {
             this.showMore.emit();
-            if (Boolean(this.fetchurl)) {
+            if (this.fetchurl !== undefined) {
                 return this.getOptions(typeof this.page.next === 'string' ? this.page.next : undefined).then(nextPage => {
-                    if (!Boolean(nextPage))
-                        return;
-                    // merge items from current page and next page
-                    const items = [...this.page.items, ...nextPage.items];
-                    // create new options pagination withe merged items
-                    this.options = new Paginate(items, { total: nextPage.total, next: nextPage.next, top: items.length });
+                    if (nextPage !== undefined) {
+                        // merge items from current page and next page
+                        const items = [...this.page.items, ...nextPage.items];
+                        // create new options pagination withe merged items
+                        this.options = new Paginate(items, { total: nextPage.total, next: nextPage.next, top: items.length });
+                    }
                 });
             }
             else {
@@ -427,12 +434,12 @@ export class MgInputCombobox {
          * @returns promise
          */
         this.updatePage = async () => {
-            if (Boolean(this.fetchurl)) {
+            if (this.fetchurl !== undefined) {
                 return this.getOptions().then(page => {
-                    if (!Boolean(page))
-                        return;
-                    // reset current options pagination from API response
-                    this.options = new Paginate(page.items, { total: page.total, next: page.next, top: page.top });
+                    if (page !== undefined) {
+                        // reset current options pagination from API response
+                        this.options = new Paginate(page.items, { total: page.total, next: page.next, top: page.top });
+                    }
                 });
             }
             else {
@@ -478,11 +485,11 @@ export class MgInputCombobox {
         this.valueChange.emit(newValue);
     }
     watchItems(newValue) {
-        if (Boolean(this.fetchurl) && !Boolean(newValue)) {
+        if (this.fetchurl !== undefined && newValue === undefined) {
             // skip newValue check
             return;
         }
-        else if (Boolean(this.fetchurl) && Boolean(newValue)) {
+        else if (this.fetchurl !== undefined && newValue !== undefined) {
             throw new Error(`<mg-input-combobox> prop "items" values cannot be use with "fetchurl" prop defined. Passed value: ${toString(newValue)}.`);
         }
         // Empty options
@@ -502,7 +509,7 @@ export class MgInputCombobox {
         }
     }
     watchIdentifier(newValue) {
-        if (Boolean(newValue)) {
+        if (isValidString(newValue)) {
             this.popoverId = `${newValue}-popover`;
             this.element.dataset.mgPopoverGuard = this.popoverId;
         }
@@ -542,7 +549,7 @@ export class MgInputCombobox {
         this.classCollection = new ClassList(this.classCollection.classes);
     }
     watchFetchUrl(newValue) {
-        if (Boolean(newValue)) {
+        if (newValue !== undefined) {
             this.loadingWrapper({ name: 'load-data' });
         }
     }
@@ -550,20 +557,17 @@ export class MgInputCombobox {
         if (this.fetchurl && newValue && !isObject(newValue)) {
             throw new Error(`<mg-input-combobox> prop "fetchoptions" value must be a valid RequestInit. Passed value: ${toString(newValue)}.`);
         }
-        else {
-            new Request(this.fetchurl, newValue);
-        }
     }
     watchFetchMappings(newValue) {
-        if (Boolean(this.fetchurl) && !Boolean(newValue)) {
+        if (this.fetchurl !== undefined && !isObject(newValue)) {
             throw new Error(`<mg-input-combobox> prop "fetchmappings" is required with "fetchurl" prop.`);
         }
-        else if (Boolean(newValue) && !isFetchmappings(newValue)) {
+        else if (newValue !== undefined && !isFetchmappings(newValue)) {
             throw new Error(`<mg-input-combobox> prop "fetchmappings" value must be { request: RequestMappingType, response: ResponseMappingType }. Passed value: ${toString(newValue)}.`);
         }
     }
     watchOptions(newValue) {
-        this.page = newValue.getPage(0, Boolean(this.filter) ? this.optionsFilter : undefined);
+        this.page = newValue.getPage(0, this.filter.length > 0 ? this.optionsFilter : undefined);
     }
     watchFilter(newValue) {
         this.loadingWrapper({ name: 'load-data' });
@@ -620,17 +624,22 @@ export class MgInputCombobox {
      * When used to set validity to `false`, you should use this method again to reset the validity to `true`.
      * @param valid - value indicating the validity
      * @param errorMessage - the error message to display
+     * @param errorMessageLock - lock the error message and validity state
      */
-    async setError(valid, errorMessage) {
+    async setError(valid, errorMessage, errorMessageLock = false) {
         if (typeof valid !== 'boolean') {
             throw new Error('<mg-input-combobox> method "setError()" param "valid" must be a boolean.');
         }
-        else if (!isValidString(errorMessage)) {
+        else if (errorMessage !== undefined && !isValidString(errorMessage)) {
             throw new Error('<mg-input-combobox> method "setError()" param "errorMessage" must be a string.');
         }
         else {
+            this.customErrorMessage = {
+                lock: valid ? false : errorMessageLock,
+                message: valid ? undefined : errorMessage,
+            };
             this.setValidity(valid);
-            this.setErrorMessage(valid ? undefined : errorMessage);
+            this.setErrorMessage(true);
             this.hasDisplayedError = this.invalid;
         }
     }
@@ -650,6 +659,8 @@ export class MgInputCombobox {
             // - Keep everything in sync both inside and outside the component
             return new Promise(resolve => {
                 requestAnimationFrame(() => {
+                    // unlock validity check by reseting customErrorMessage
+                    this.customErrorMessage = { lock: false };
                     this.checkValidity();
                     this.errorMessage = undefined;
                     this.hasDisplayedError = false;
@@ -678,11 +689,13 @@ export class MgInputCombobox {
      * @param newValue - valid new value
      */
     setValidity(newValue) {
-        const oldValidValue = this.valid;
-        this.valid = newValue;
+        const oldValue = this.valid;
+        if (!this.customErrorMessage.lock || (this.customErrorMessage.message !== undefined && !newValue)) {
+            this.valid = newValue;
+        }
         this.invalid = !this.valid;
         // We need to send valid event even if it is the same value
-        if (this.handlerInProgress === undefined || (this.handlerInProgress === 'blur' && this.valid !== oldValidValue))
+        if (this.handlerInProgress === undefined || (this.handlerInProgress === 'blur' && this.valid !== oldValue))
             this.inputValid.emit(this.valid);
     }
     /*************
@@ -698,7 +711,7 @@ export class MgInputCombobox {
         // Validate
         this.watchIdentifier(this.identifier);
         this.watchItems(this.items);
-        if (Boolean(this.fetchurl)) {
+        if (this.fetchurl !== undefined) {
             this.watchFetchOptions(this.fetchoptions);
             this.watchFetchMappings(this.fetchmappings);
             this.loadingWrapper({ name: 'load-data' });
@@ -725,14 +738,17 @@ export class MgInputCombobox {
         const readonlyValue = this.getValueTitle();
         const withResetButton = this.value && !this.disabled;
         let popoverContent;
-        if (((_a = this.page) === null || _a === void 0 ? void 0 : _a.items.length) > 0)
+        if (((_a = this.page) === null || _a === void 0 ? void 0 : _a.items.length) > 0) {
             popoverContent = 'list';
-        else if (((_b = this.page) === null || _b === void 0 ? void 0 : _b.items.length) === 0 && Boolean(this.filter))
+        }
+        else if (((_b = this.page) === null || _b === void 0 ? void 0 : _b.items.length) === 0 && this.filter.length > 0) {
             popoverContent = 'notfound';
-        else if (((_c = this.page) === null || _c === void 0 ? void 0 : _c.items.length) === 0)
+        }
+        else if (((_c = this.page) === null || _c === void 0 ? void 0 : _c.items.length) === 0) {
             popoverContent = 'notavailable';
+        }
         let activeDescendant;
-        if (Boolean((_d = this.option) === null || _d === void 0 ? void 0 : _d.value)) {
+        if (((_d = this.option) === null || _d === void 0 ? void 0 : _d.value) !== undefined) {
             activeDescendant = this.option.value;
         }
         else if (typeof this.value === 'string') {
@@ -741,8 +757,8 @@ export class MgInputCombobox {
         else {
             activeDescendant = (_e = this.value) === null || _e === void 0 ? void 0 : _e.value;
         }
-        return (h("mg-input", { key: '79e5263cd3b1c0fa0b3f386a547f2bdd48a33b28', label: this.label, identifier: this.identifier, class: this.classCollection.classes.join(' '), ariaDescribedbyIDs: popoverContent && popoverContent !== 'list' ? popoverContent : undefined, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, tooltip: this.tooltip, tooltipPosition: this.readonly && this.value === undefined ? 'label' : this.tooltipPosition, helpText: this.helpText, errorMessage: this.errorMessage }, this.readonly ? (readonlyValue && h("b", { class: "mg-c-input__readonly-value" }, readonlyValue)) : (h("mg-popover", { identifier: this.popoverId, placement: "bottom-start", display: this.popoverDisplay, "arrow-hide": true, style: {
-                '--mg-c-input-list-width': Boolean((_f = this.input) === null || _f === void 0 ? void 0 : _f.offsetWidth) ? `${this.input.offsetWidth}px` : undefined,
+        return (h("mg-input", { key: 'bebf380dbdea1a9f9e0257a9425dcb6cd94a7a52', label: this.label, identifier: this.identifier, class: this.classCollection.classes.join(' '), ariaDescribedbyIDs: popoverContent && popoverContent !== 'list' ? popoverContent : undefined, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, tooltip: this.tooltip, tooltipPosition: this.readonly && this.value === undefined ? 'label' : this.tooltipPosition, helpText: this.helpText, errorMessage: this.errorMessage }, this.readonly ? (readonlyValue && h("b", { class: "mg-c-input__readonly-value" }, readonlyValue)) : (h("mg-popover", { identifier: this.popoverId, placement: "bottom-start", display: this.popoverDisplay, "arrow-hide": true, style: {
+                '--mg-c-input-list-width': ((_f = this.input) === null || _f === void 0 ? void 0 : _f.offsetWidth) > 0 ? `${this.input.offsetWidth}px` : undefined,
             }, "data-fallback-placement": "bottom-end", "onDisplay-change": this.handlePopoverDisplay }, h("div", { class: "mg-c-input__input-group-container" }, h("mg-icon", { icon: "magnifying-glass" }), h("input", { type: "text", role: "combobox", class: "mg-c-input__box mg-c-input__box--width", value: this.filter, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, disabled: this.disabled, required: this.required, autocomplete: "off", "aria-autocomplete": "list", "aria-expanded": this.popoverDisplay.toString(), "aria-controls": listId, "aria-invalid": (this.invalid === true).toString(), "aria-activedescendant": formatID(activeDescendant), onInput: this.handleFilterInput, onBlur: this.handleFilterBlur, onFocus: this.handleFilterFocus, onKeyDown: this.handleFilterKeydown, ref: (el) => {
                 if (el !== null)
                     this.input = el;
@@ -781,7 +797,6 @@ export class MgInputCombobox {
         return {
             "value": {
                 "type": "string",
-                "attribute": "value",
                 "mutable": true,
                 "complexType": {
                     "original": "string | Option",
@@ -802,11 +817,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": true
+                "reflect": true,
+                "attribute": "value"
             },
             "items": {
                 "type": "unknown",
-                "attribute": "items",
                 "mutable": false,
                 "complexType": {
                     "original": "(string | Option)[]",
@@ -830,7 +845,6 @@ export class MgInputCombobox {
             },
             "itemsLabel": {
                 "type": "string",
-                "attribute": "items-label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -848,11 +862,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "items-label"
             },
             "identifier": {
                 "type": "string",
-                "attribute": "identifier",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -867,11 +881,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "identifier"
             },
             "name": {
                 "type": "string",
-                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -887,11 +901,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "name",
                 "defaultValue": "this.identifier"
             },
             "label": {
                 "type": "string",
-                "attribute": "label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -906,11 +920,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "label"
             },
             "labelOnTop": {
                 "type": "boolean",
-                "attribute": "label-on-top",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -926,11 +940,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "label-on-top",
                 "defaultValue": "false"
             },
             "labelHide": {
                 "type": "boolean",
-                "attribute": "label-hide",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -946,11 +960,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "label-hide",
                 "defaultValue": "false"
             },
             "placeholder": {
                 "type": "string",
-                "attribute": "placeholder",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -965,11 +979,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "placeholder"
             },
             "required": {
                 "type": "boolean",
-                "attribute": "required",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -985,11 +999,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "required",
                 "defaultValue": "false"
             },
             "readonly": {
                 "type": "boolean",
-                "attribute": "readonly",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1005,11 +1019,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "readonly",
                 "defaultValue": "false"
             },
             "disabled": {
                 "type": "boolean",
-                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1025,11 +1039,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "disabled",
                 "defaultValue": "false"
             },
             "mgWidth": {
                 "type": "any",
-                "attribute": "mg-width",
                 "mutable": false,
                 "complexType": {
                     "original": "Width",
@@ -1051,11 +1065,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "mg-width",
                 "defaultValue": "'full'"
             },
             "tooltip": {
                 "type": "string",
-                "attribute": "tooltip",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1070,11 +1084,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "tooltip"
             },
             "tooltipPosition": {
                 "type": "string",
-                "attribute": "tooltip-position",
                 "mutable": false,
                 "complexType": {
                     "original": "TooltipPosition",
@@ -1096,11 +1110,11 @@ export class MgInputCombobox {
                 "getter": false,
                 "setter": false,
                 "reflect": false,
+                "attribute": "tooltip-position",
                 "defaultValue": "'input'"
             },
             "helpText": {
                 "type": "string",
-                "attribute": "help-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1115,11 +1129,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "help-text"
             },
             "fetchurl": {
                 "type": "string",
-                "attribute": "fetchurl",
                 "mutable": false,
                 "complexType": {
                     "original": "string | URL",
@@ -1142,11 +1156,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "fetchurl"
             },
             "fetchoptions": {
                 "type": "unknown",
-                "attribute": "fetchoptions",
                 "mutable": false,
                 "complexType": {
                     "original": "RequestInit",
@@ -1175,7 +1189,6 @@ export class MgInputCombobox {
             },
             "fetchmappings": {
                 "type": "unknown",
-                "attribute": "fetchmappings",
                 "mutable": false,
                 "complexType": {
                     "original": "{ request: RequestMappingType; response: ResponseMappingType }",
@@ -1207,7 +1220,6 @@ export class MgInputCombobox {
             },
             "valid": {
                 "type": "boolean",
-                "attribute": "valid",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -1222,11 +1234,11 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "valid"
             },
             "invalid": {
                 "type": "boolean",
-                "attribute": "invalid",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -1241,7 +1253,8 @@ export class MgInputCombobox {
                 },
                 "getter": false,
                 "setter": false,
-                "reflect": false
+                "reflect": false,
+                "attribute": "invalid"
             }
         };
     }
@@ -1387,7 +1400,7 @@ export class MgInputCombobox {
             },
             "setError": {
                 "complexType": {
-                    "signature": "(valid: MgInputCombobox[\"valid\"], errorMessage: string) => Promise<void>",
+                    "signature": "(valid: MgInputCombobox[\"valid\"], errorMessage?: string, errorMessageLock?: boolean) => Promise<void>",
                     "parameters": [{
                             "name": "valid",
                             "type": "boolean",
@@ -1396,6 +1409,10 @@ export class MgInputCombobox {
                             "name": "errorMessage",
                             "type": "string",
                             "docs": "- the error message to display"
+                        }, {
+                            "name": "errorMessageLock",
+                            "type": "boolean",
+                            "docs": "- lock the error message and validity state"
                         }],
                     "references": {
                         "Promise": {
@@ -1417,6 +1434,9 @@ export class MgInputCombobox {
                         }, {
                             "name": "param",
                             "text": "errorMessage - the error message to display"
+                        }, {
+                            "name": "param",
+                            "text": "errorMessageLock - lock the error message and validity state"
                         }]
                 }
             },