@descope/web-components-ui 1.44.0 → 1.45.0

package/src/components/phone-fields/descope-phone-field/descope-phone-field-internal/PhoneFieldInternal.js

@@ -2,10 +2,11 @@ import { createBaseInputClass } from '../../../../baseClasses/createBaseInputCla
 import { forwardAttrs, getComponentName } from '../../../../helpers/componentHelpers';
 import CountryCodes from '../../CountryCodes';
 import { comboBoxItem, parsePhoneNumber } from '../helpers';
+import { AsYouType, parsePhoneNumberFromString } from 'libphonenumber-js/min';
 
 export const componentName = getComponentName('phone-field-internal');
 
-const commonAttrs = ['disabled', 'size', 'bordered', 'readonly', 'allow-alphanumeric-input'];
+const commonAttrs = ['disabled', 'size', 'bordered', 'readonly'];
 const countryAttrs = ['country-input-placeholder', 'default-code', 'restrict-countries'];
 const phoneAttrs = ['phone-input-placeholder', 'maxlength', 'autocomplete', 'name'];
 const labelTypeAttrs = ['label-type', 'country-input-label', 'label'];
@@ -24,6 +25,8 @@ class PhoneFieldInternal extends BaseInputClass {
     return [].concat(BaseInputClass.observedAttributes || [], inputRelatedAttrs);
   }
 
+  #ayt;
+
   constructor() {
     super();
 
@@ -40,200 +43,329 @@ class PhoneFieldInternal extends BaseInputClass {
     </div>
     `;
 
-    this.countryCodeInput = this.querySelector('descope-combo-box');
-    this.phoneNumberInput = this.querySelector('descope-text-field');
-    this.inputs = [this.countryCodeInput, this.phoneNumberInput];
+    this.comboBox = this.querySelector('descope-combo-box');
+    this.textField = this.querySelector('descope-text-field');
+
+    this.inputs = [this.comboBox, this.textField];
 
-    forwardAttrs(this, this.countryCodeInput, { includeAttrs: ['label-type'] });
-    forwardAttrs(this, this.phoneNumberInput, { includeAttrs: ['label-type', 'required'] });
+    forwardAttrs(this, this.comboBox, { includeAttrs: ['label-type'] });
+    forwardAttrs(this, this.textField, { includeAttrs: ['label-type', 'required'] });
 
     // override combo box setter to display dialCode value in input
-    this.countryCodeInput.customValueTransformFn = (val) => {
+    this.comboBox.customValueTransformFn = (val) => {
       const [, dialCode] = val?.split?.(' ') || [];
       return dialCode;
     };
   }
 
+  // exposed from main component
   get countryCodeInputData() {
-    return this.countryCodeInput.items;
+    return this.comboBox.items;
+  }
+
+  // exposed from main component
+  get countryCodeValue() {
+    return this.comboBox.shadowRoot.querySelector('input').value;
+  }
+
+  // exposed from main component
+  get phoneNumberInputEle() {
+    return this.textField.shadowRoot.querySelector('input');
   }
 
   get allowAlphanumericInput() {
     return this.getAttribute('allow-alphanumeric-input') === 'true';
   }
 
-  get value() {
-    if (!this.phoneNumberValue) {
-      return '';
-    }
-    return `${this.countryCodeInput.value}-${this.phoneNumberInput.value}`;
+  get defaultCode() {
+    return this.getAttribute('default-code');
   }
 
-  set value(val) {
-    const [countryCode, phoneNumber] = parsePhoneNumber(val);
+  get selectionStart() {
+    return this.textField.selectionStart;
+  }
 
-    this.#setCountryCode(countryCode);
-    this.#setPhoneNumber(phoneNumber);
+  get minLength() {
+    return parseInt(this.getAttribute('minlength'), 10) || 0;
   }
 
-  setSelectionRange(...args) {
-    this.phoneNumberInput.setSelectionRange(...args);
+  get selectedCountryCode() {
+    return this.comboBox?.selectedItem?.getAttribute('data-country-code');
   }
 
-  get selectionStart() {
-    return this.phoneNumberInput.selectionStart;
+  get restrictCountries() {
+    const attr = this.getAttribute('restrict-countries');
+    return attr?.split(',').filter(Boolean) || [];
   }
 
-  #setCountryCode(val) {
-    if (val) {
-      const countryCodeItem = this.getCountryByDialCode(val);
-      if (countryCodeItem) {
-        this.countryCodeInput.selectedItem = countryCodeItem;
-      }
-    } else {
-      this.countryCodeInput.selectedItem = undefined;
-    }
+  get isFormatValue() {
+    return this.getAttribute('format-value') === 'true';
+  }
+
+  // `strict validation` enforces value parsing with libphonenumber-js
+  get isStrictValidation() {
+    return this.getAttribute('strict-validation') === 'true';
   }
 
-  #setPhoneNumber(val) {
-    if (this.phoneNumberInput.value === val) {
-      return;
+  get value() {
+    if (!this.comboBox.value || !this.textField.value) {
+      return '';
     }
 
-    this.phoneNumberInput.value = val;
-  }
+    const [countryCode, phoneNumber] = parsePhoneNumber(
+      `${this.comboBox.value}-${this.textField.value}`
+    );
 
-  get phoneNumberValue() {
-    return this.phoneNumberInput.value;
+    return `${countryCode || this.comboBox.value}-${phoneNumber || this.textField.value}`;
   }
 
-  get countryCodeValue() {
-    return this.countryCodeInput.shadowRoot.querySelector('input').value;
-  }
+  set value(val) {
+    const [countryCode, nationalNumber] = parsePhoneNumber(val);
 
-  get phoneNumberInputEle() {
-    return this.phoneNumberInput.shadowRoot.querySelector('input');
+    this.#setCountryCode(countryCode);
+    this.#setNationalNumber(nationalNumber);
   }
 
-  get minLength() {
-    return parseInt(this.getAttribute('minlength'), 10) || 0;
+  init() {
+    this.addEventListener('focus', (e) => {
+      // we want to ignore focus events we are dispatching
+      if (e.isTrusted) this.inputs[1].focus();
+    });
+
+    super.init?.();
+
+    this.#initInputs();
   }
 
   getValidity() {
-    const hasCode = this.countryCodeInput.value;
-    const hasPhone = this.phoneNumberInput.value;
-    const emptyValue = !hasCode || !hasPhone;
-    const hasMinPhoneLength =
-      this.phoneNumberInput.value?.length && this.phoneNumberInput.value.length < this.minLength;
+    const countryCode = this.comboBox.value;
+    const nationalNumer = this.textField.value;
 
-    if (this.isRequired && emptyValue) {
+    const hasCountryCode = !!countryCode.length;
+    const hasNationalNumber = !!nationalNumer.length;
+
+    const isEmpty = !hasCountryCode || !hasNationalNumber;
+    const isValidLength = hasNationalNumber && nationalNumer.length >= this.minLength;
+
+    if (this.isRequired && isEmpty) {
       return { valueMissing: true };
     }
-    if (hasMinPhoneLength) {
+
+    if (!isValidLength) {
       return { tooShort: true };
     }
-    if (hasPhone && !hasCode) {
-      return { valueMissing: true };
+
+    if (this.value && this.isStrictValidation && !this.#isValidParsedValue()) {
+      return { patternMismatch: true };
     }
+
     return {};
   }
 
-  init() {
-    this.addEventListener('focus', (e) => {
-      // we want to ignore focus events we are dispatching
-      if (e.isTrusted) this.inputs[1].focus();
+  setSelectionRange(...args) {
+    this.textField.setSelectionRange(...args);
+  }
+
+  attributeChangedCallback(attrName, oldValue, newValue) {
+    super.attributeChangedCallback(attrName, oldValue, newValue);
+
+    if (oldValue !== newValue) {
+      if (attrName === 'default-code' && newValue) {
+        this.#handleDefaultCountryCode(newValue);
+      } else if (inputRelatedAttrs.includes(attrName)) {
+        const attr = mapAttrs[attrName] || attrName;
+
+        if (commonAttrs.includes(attrName)) {
+          this.inputs.forEach((input) => input.setAttribute(attr, newValue));
+        } else if (countryAttrs.includes(attrName)) {
+          this.comboBox.setAttribute(attr, newValue);
+        } else if (phoneAttrs.includes(attrName)) {
+          this.textField.setAttribute(attr, newValue);
+        }
+      }
+
+      if (labelTypeAttrs.includes(attrName)) {
+        this.#handleLabelTypeAttrs(attrName, newValue);
+      }
+
+      if (attrName === 'restrict-countries') {
+        this.#updateComboBoxItems(this.restrictCountries);
+      }
+    }
+  }
+
+  #initInputs() {
+    // Sanitize phone input value to filter everything but digits
+    this.textField.addEventListener('input', (e) => {
+      if (!this.allowAlphanumericInput) {
+        const telDigitsRegExp = /^\d$/;
+        const sanitizedInput = e.target.value
+          .split('')
+          .filter((char) => telDigitsRegExp.test(char))
+          .join('');
+        e.target.value = sanitizedInput;
+      }
     });
 
-    super.init?.();
-    this.initInputs();
+    this.handleFocusEventsDispatching(this.inputs);
+    this.handleInputEventDispatching();
+
+    // verify country code item against phone number pattern and replace if needed and country is allowed
+    // (e.g. +1 can be US or CA, depending on the pattern)
+    this.addEventListener('input', this.#handleSameCountryCodes.bind(this));
   }
 
-  getRestrictedCountries() {
-    const attr = this.getAttribute('restrict-countries');
-    return attr ? attr.split(',') : [];
+  #setCountryCode(val) {
+    if (!val || val === this.selectedCountryCode) return;
+
+    let countryCodeItem = undefined;
+
+    if (this.value) {
+      // try to parse the phone number, and set country code item according to actual dial code (e.g. `+1` can be `US` or `CA`)
+      const code = this.#getCountryCodeByPhoneNumber(`${val}-${this.textField.value}`);
+      countryCodeItem = this.#getCountryByCodeId(code);
+    }
+
+    // in case country code item does not exist (for example: Parsed code is CA for +1 - but Canada is not allowed)
+    // then use the first option with same dial code (e.g. in that case - `US` for +1)
+    if (!countryCodeItem) {
+      countryCodeItem = this.#getCountryByDialCode(val);
+    }
+
+    // set country code item; in it doesn't exist in list - set `undefined`
+    this.comboBox.selectedItem = countryCodeItem;
+  }
+
+  #setNationalNumber(val) {
+    if (this.isFormatValue) {
+      val = this.#formatNationalNumber(val);
+    }
+
+    if (this.textField.value !== val) {
+      this.textField.value = val;
+    }
   }
 
-  getCountryByDialCode(countryDialCode) {
-    return this.countryCodeInput.items?.find((c) => c.getAttribute('data-id') === countryDialCode);
+  #formatNationalNumber(nationalNumber = '') {
+    // re-initialize AsYouType if country code is outdated
+    if (!this.#ayt || this.#ayt.country !== this.selectedCountryCode) {
+      this.#ayt = new AsYouType(this.selectedCountryCode);
+    }
+
+    // reset previous AsYouType input
+    this.#ayt.reset();
+
+    const formattedVal = this.#ayt.input(nationalNumber);
+
+    return formattedVal || nationalNumber;
   }
 
-  getCountryByCodeId(countryCode) {
-    return this.countryCodeInput.items?.find(
-      (c) => c.getAttribute('data-country-code') === countryCode
+  #isValidParsedValue() {
+    const parsed = parsePhoneNumberFromString(this.value);
+
+    return (
+      parsed && // Parsed successfully (not undefined)
+      parsed.isValid?.() && // Parsed object is valid
+      parsed.country && // Parsed object with a country code
+      this.#isAllowedCountry(parsed.country) // Parsed with allowed country code
     );
   }
 
-  updateCountryCodeItems(restrictCountries) {
+  #isAllowedCountry(countryCode) {
+    if (!this.restrictCountries) {
+      return true;
+    }
+
+    return this.restrictCountries.includes(countryCode);
+  }
+
+  // return country item by dial code `data-id` (e.g. `+1`)
+  #getCountryByDialCode(dialCode) {
+    return this.comboBox.items?.find((c) => c.getAttribute('data-id') === dialCode) || undefined;
+  }
+
+  // return country item by country code `data-country-code` (e.g. `US`)
+  #getCountryByCodeId(countryCode) {
+    return this.comboBox.items?.find((c) => c.getAttribute('data-country-code') === countryCode);
+  }
+
+  #getCountryCodeByPhoneNumber(val) {
+    if (!val) return undefined;
+    const parsed = parsePhoneNumberFromString(val);
+    if (!parsed?.country) return undefined;
+    const foundCountryItem = this.#getCountryByCodeId(parsed.country);
+    return foundCountryItem?.getAttribute('data-country-code');
+  }
+
+  #updateComboBoxItems(restrictCountries) {
     const items = restrictCountries.length
       ? CountryCodes.filter((c) => restrictCountries.includes(c.code))
       : CountryCodes;
+
     this.querySelector('descope-combo-box').innerHTML = items
       .map((item) => comboBoxItem(item))
       .join('');
   }
 
-  handleDefaultCountryCode(countryCode) {
-    if (!this.countryCodeInput.value) {
-      const countryCodeItem = this.getCountryByCodeId(countryCode);
+  #handleDefaultCountryCode(countryCode) {
+    if (!this.comboBox.value) {
+      const countryCodeItem = this.#getCountryByCodeId(countryCode);
       // When replacing the input component (inserting internal component into text-field) -
       // Vaadin resets the input's value. We use setTimeout in order to make sure this happens
       // after the reset.
       if (countryCodeItem) {
         setTimeout(() => {
-          this.countryCodeInput.selectedItem = countryCodeItem;
+          this.comboBox.selectedItem = countryCodeItem;
         });
       }
     }
   }
 
-  initInputs() {
-    // Sanitize phone input value to filter everything but digits
-    this.phoneNumberInput.addEventListener('input', (e) => {
-      // we want to update only phoneNumberInput, and avoid triggering `set value`
-      e.stopPropagation();
+  #handleSameCountryCodes() {
+    if (!this.value) return;
 
-      if (!this.allowAlphanumericInput) {
-        const telDigitsRegExp = /^\d$/;
-        const sanitizedInput = e.target.value
-          .split('')
-          .filter((char) => telDigitsRegExp.test(char))
-          .join('');
-        e.target.value = sanitizedInput;
-      }
-    });
+    const country = this.#getCountryCodeByPhoneNumber(this.value);
 
-    this.handleFocusEventsDispatching(this.inputs);
-    this.handleInputEventDispatching();
+    if (!country) return;
+
+    // re-set country code if needed (same coutnry code for different countries, e.g. +1 for US or CA)
+    if (this.selectedCountryCode !== country) {
+      const foundCountryItem = this.#getCountryByCodeId(country);
+      // if found country is defined in country list then set it, otherwise - clear phone number
+      if (foundCountryItem) {
+        this.comboBox.selectedItem = foundCountryItem;
+      }
+    }
   }
 
-  handleLabelTypeAttrs(attrName, newValue) {
+  #handleLabelTypeAttrs(attrName, newValue) {
     // set or remove label attributes from inner text/combo components on `label-type` change
     const attr = mapAttrs[attrName] || attrName;
 
     if (attrName === 'label-type') {
-      this.onLabelTypeChange(newValue);
+      this.#handleLabelTypeChange(newValue);
     }
     // on inner components label attr change - set label attributes for text/combo components
     // only if label-type is `floating`
     else if (this.getAttribute('label-type') === 'floating') {
       if (attrName === 'country-input-label') {
-        this.countryCodeInput.setAttribute(attr, newValue);
+        this.comboBox.setAttribute(attr, newValue);
       } else if (attrName === 'label') {
-        this.phoneNumberInput.setAttribute(attr, newValue);
+        this.textField.setAttribute(attr, newValue);
       }
     }
   }
 
-  onLabelTypeChange(newValue) {
+  #handleLabelTypeChange(newValue) {
     if (newValue === 'floating') {
       // on change to `floating` label - set inner components `label` and `placeholder`
-      this.countryCodeInput.setAttribute('label', this.getAttribute('country-input-label') || '');
-      this.countryCodeInput.setAttribute(
+      this.comboBox.setAttribute('label', this.getAttribute('country-input-label') || '');
+      this.comboBox.setAttribute(
         'placeholder',
         this.getAttribute('country-input-placeholder') || ''
       );
-      this.phoneNumberInput.setAttribute('label', this.getAttribute('label') || '');
-      this.phoneNumberInput.setAttribute(
+      this.textField.setAttribute('label', this.getAttribute('label') || '');
+      this.textField.setAttribute(
         'placeholder',
         this.getAttribute('phone-input-placeholder') || ''
       );
@@ -242,34 +374,6 @@ class PhoneFieldInternal extends BaseInputClass {
       this.inputs.forEach((input) => input.removeAttribute('label'));
     }
   }
-
-  attributeChangedCallback(attrName, oldValue, newValue) {
-    super.attributeChangedCallback(attrName, oldValue, newValue);
-
-    if (oldValue !== newValue) {
-      if (attrName === 'default-code' && newValue) {
-        this.handleDefaultCountryCode(newValue);
-      } else if (inputRelatedAttrs.includes(attrName)) {
-        const attr = mapAttrs[attrName] || attrName;
-
-        if (commonAttrs.includes(attrName)) {
-          this.inputs.forEach((input) => input.setAttribute(attr, newValue));
-        } else if (countryAttrs.includes(attrName)) {
-          this.countryCodeInput.setAttribute(attr, newValue);
-        } else if (phoneAttrs.includes(attrName)) {
-          this.phoneNumberInput.setAttribute(attr, newValue);
-        }
-      }
-
-      if (labelTypeAttrs.includes(attrName)) {
-        this.handleLabelTypeAttrs(attrName, newValue);
-      }
-
-      if (attrName === 'restrict-countries') {
-        this.updateCountryCodeItems(this.getRestrictedCountries());
-      }
-    }
-  }
 }
 
 export default PhoneFieldInternal;

package/src/components/phone-fields/descope-phone-input-box-field/PhoneFieldInputBoxClass.js

@@ -1,7 +1,13 @@
 import { componentName as descopeInternalComponentName } from './descope-phone-input-box-internal/PhoneFieldInternalInputBox';
 import { forwardAttrs, getComponentName } from '../../../helpers/componentHelpers';
 import { compose } from '../../../helpers';
-import { createProxy, createStyleMixin, draggableMixin, proxyInputMixin } from '../../../mixins';
+import {
+  createProxy,
+  createStyleMixin,
+  draggableMixin,
+  inputOverrideValidConstraintsMixin,
+  proxyInputMixin,
+} from '../../../mixins';
 import { TextFieldClass } from '../../descope-text-field/TextFieldClass';
 import CountryCodes from '../CountryCodes';
 import {
@@ -18,7 +24,7 @@ const textVars = TextFieldClass.cssVarList;
 export const componentName = getComponentName('phone-input-box-field');
 
 const customMixin = (superclass) =>
-  class PhoneInputBoxFieldMixinClass extends superclass {
+  class PhoneFieldInputBoxMixinClass extends superclass {
     static get CountryCodes() {
       return CountryCodes;
     }
@@ -42,8 +48,6 @@ const customMixin = (superclass) =>
       forwardAttrs(this.shadowRoot.host, this.inputElement, {
         includeAttrs: [
           'size',
-          'bordered',
-          'invalid',
           'minlength',
           'maxlength',
           'default-code',
@@ -52,6 +56,10 @@ const customMixin = (superclass) =>
           'label',
           'label-type',
           'allow-alphanumeric-input',
+          'restrict-countries',
+          'format-value',
+          'strict-validation',
+          'data-errormessage-type-mismatch',
         ],
       });
     }
@@ -67,7 +75,8 @@ const {
   inputElement,
   requiredIndicator,
   inputField,
-  inputFieldInternal,
+  internalComponent,
+  internalComponentAfter,
   phoneInput,
   errorMessage,
   helperText,
@@ -78,8 +87,11 @@ const {
   inputElement: { selector: 'input' },
   requiredIndicator: { selector: '[required]::part(required-indicator)::after' },
   inputField: { selector: () => 'vaadin-text-field::part(input-field)' },
-  inputFieldInternal: {
-    selector: () => 'descope-phone-field-internal-input-box vaadin-text-field::part(input-field)',
+  internalComponent: {
+    selector: 'descope-phone-field-internal-input-box',
+  },
+  internalComponentAfter: {
+    selector: 'descope-phone-field-internal-input-box::after',
   },
   phoneInput: { selector: () => 'descope-text-field' },
   helperText: { selector: '::part(helper-text)' },
@@ -102,14 +114,6 @@ export const PhoneFieldInputBoxClass = compose(
       hostMinWidth: { ...host, property: 'min-width' },
       hostDirection: { ...host, property: 'direction' },
 
-      inputBorderStyle: { ...inputFieldInternal, property: 'border-style' },
-      inputBorderWidth: { ...inputFieldInternal, property: 'border-width' },
-      inputBorderColor: { ...inputFieldInternal, property: 'border-color' },
-      inputBorderRadius: [
-        { ...inputField, property: 'border-radius' },
-        { ...inputFieldInternal, property: 'border-radius' },
-      ],
-
       inputHorizontalPadding: [
         { ...phoneInput, property: 'padding-left' },
         { ...phoneInput, property: 'padding-right' },
@@ -134,10 +138,18 @@ export const PhoneFieldInputBoxClass = compose(
 
       inputPlaceholderTextColor: { ...phoneInput, property: textVars.inputPlaceholderColor },
 
-      inputOutlineStyle: { ...inputField, property: 'outline-style' },
-      inputOutlineColor: { ...inputField, property: 'outline-color' },
-      inputOutlineWidth: { ...inputField, property: 'outline-width' },
-      inputOutlineOffset: { ...inputField, property: 'outline-offset' },
+      inputBorderStyle: { ...internalComponentAfter, property: 'border-style' },
+      inputBorderWidth: { ...internalComponentAfter, property: 'border-width' },
+      inputBorderColor: { ...internalComponentAfter, property: 'border-color' },
+      inputBorderRadius: [
+        { ...internalComponent, property: 'border-radius' },
+        { ...internalComponentAfter, property: 'border-radius' },
+      ],
+
+      inputOutlineStyle: { ...internalComponent, property: 'outline-style' },
+      inputOutlineColor: { ...internalComponent, property: 'outline-color' },
+      inputOutlineWidth: { ...internalComponent, property: 'outline-width' },
+      inputOutlineOffset: { ...internalComponent, property: 'outline-offset' },
 
       labelPosition: { ...label, property: 'position' },
       labelTopPosition: { ...label, property: 'top' },
@@ -156,6 +168,7 @@ export const PhoneFieldInputBoxClass = compose(
     },
   }),
   draggableMixin,
+  inputOverrideValidConstraintsMixin,
   proxyInputMixin({ proxyProps: ['value', 'selectionStart'] }),
   customMixin
 )(
@@ -187,7 +200,6 @@ export const PhoneFieldInputBoxClass = compose(
     vaadin-text-field::part(input-field) {
       padding: 0;
       background: transparent;
-      overflow: hidden;
       -webkit-mask-image: none;
     }
     descope-phone-field-internal-input-box {
@@ -198,14 +210,20 @@ export const PhoneFieldInputBoxClass = compose(
     descope-phone-field-internal-input-box > div {
       width: 100%;
     }
-    descope-phone-field-internal-input-box .separator {
-      flex: 0;
-      border: none;
-    }
     descope-phone-field-internal-input-box descope-text-field {
       ${textVars.inputOutlineWidth}: 0;
       ${textVars.inputOutlineOffset}: 0;
     }
+    descope-phone-field-internal-input-box::after {
+      content: '';
+      position: absolute;
+      width: 100%;
+      height: 100%;
+      top: 0;
+      left: 0;
+      box-sizing: border-box;
+      pointer-events: none;
+    }
     descope-text-field {
       flex-grow: 1;
       width: 100%;