@descope/web-components-ui 1.0.70 → 1.0.72

package/src/components/descope-passcode/descope-passcode-internal/PasscodeInternal.js

@@ -1,26 +1,30 @@
-import BaseInputClass from '../../../baseClasses/BaseInputClass';
+import { createBaseInputClass } from '../../../baseClasses/createBaseInputClass';
 import { getComponentName } from '../../../helpers/componentHelpers';
+import { createDispatchEvent, createEventListener } from '../../../helpers/mixinsHelpers';
 import { getSanitizedCharacters, focusElement } from './helpers';
 
 export const componentName = getComponentName('passcode-internal');
 
+const observedAttributes = [
+	'disabled',
+	'bordered',
+	'size',
+	'invalid'
+]
+
+const BaseInputClass = createBaseInputClass({ componentName, baseSelector: ':host > div' })
+
 class PasscodeInternal extends BaseInputClass {
 	static get observedAttributes() {
-		return [
-			...(BaseInputClass.observedAttributes || []),
-			'disabled',
-			'bordered',
-			'size',
-		];
+		return observedAttributes.concat(BaseInputClass.observedAttributes || []);
 	}
 
 	static get componentName() {
 		return componentName;
 	}
 
-	#boundHandleInvalid = this.#handleInvalid.bind(this)
-	#boundHandleValid = this.#handleValid.bind(this)
-	#boundHandleBlur = this.#handleBlur.bind(this)
+	#dispatchBlur = createDispatchEvent.bind(this, 'blur')
+	#dispatchFocus = createDispatchEvent.bind(this, 'focus')
 
 	constructor() {
 		super();
@@ -29,7 +33,7 @@ class PasscodeInternal extends BaseInputClass {
 			st-width="35px"
 			data-id=${idx}
 			type="tel"
-			autocomplete="none"
+			autocomplete="off"
 		></descope-text-field>
 	`)
 
@@ -39,8 +43,6 @@ class PasscodeInternal extends BaseInputClass {
 		</div>
 		`;
 
-		this.baseSelector = ':host > div';
-
 		this.inputs = Array.from(this.querySelectorAll('descope-text-field'))
 	}
 
@@ -66,16 +68,6 @@ class PasscodeInternal extends BaseInputClass {
 		return `^$|^\\d{${this.digits},}$`
 	}
 
-	#handleInvalid() {
-		if (this.hasAttribute('invalid')) {
-			this.inputs.forEach(input => input.setAttribute('invalid', 'true'))
-		}
-	}
-
-	#handleValid() {
-		this.inputs.forEach(input => input.removeAttribute('invalid'))
-	}
-
 	getValidity() {
 		if (this.isRequired && !this.value) {
 			return { valueMissing: true };
@@ -88,25 +80,17 @@ class PasscodeInternal extends BaseInputClass {
 		}
 	};
 
-	onFocus(){
-		this.inputs[0].focus()
-	}
-
 	connectedCallback() {
+		// we are adding listeners before calling to super because it's stopping the events
+		createEventListener.call(this, 'focus', (e) => {
+			// we want to ignore focus events we are dispatching
+			if (e.isTrusted)
+				this.inputs[0].focus()
+		})
+
 		super.connectedCallback?.();
 
 		this.initInputs()
-
-		this.addEventListener('invalid', this.#boundHandleInvalid)
-		this.addEventListener('valid', this.#boundHandleValid)
-		this.addEventListener('blur', this.#boundHandleBlur)
-	}
-
-	disconnectedCallback() {
-		super.connectedCallback?.();
-		this.removeEventListener('invalid', this.#boundHandleInvalid)
-		this.removeEventListener('valid', this.#boundHandleValid)
-		this.removeEventListener('blur', this.#boundHandleBlur)
 	}
 
 	getInputIdx(inputEle) {
@@ -138,33 +122,60 @@ class PasscodeInternal extends BaseInputClass {
 		focusElement(currentInput);
 	};
 
-	#handleBlur() {
-		this.#handleInvalid()
-	}
-
 	initInputs() {
+		let prevVal = this.value
+		let blurTimerId
+
 		this.inputs.forEach((input) => {
-			input.oninput = (e) => {
+			// in order to simulate blur on the input
+			// we are checking if focus on one of the digits happened immediately after blur on another digit
+			// if not, the component is no longer focused and we should simulate blur
+			createEventListener.call(this, 'blur', (e) => {
+				e.stopImmediatePropagation();
+
+				blurTimerId = setTimeout(() => {
+					blurTimerId = null
+					this.#dispatchBlur()
+				});
+			}, { element: input })
+
+			createEventListener.call(this, 'focus', (e) => {
+				e.stopImmediatePropagation();
+
+				clearTimeout(blurTimerId)
+				if (!blurTimerId) {
+					this.#dispatchFocus()
+				}
+			}, { element: input })
+
+			createEventListener.call(this, 'input', (e) => {
 				const charArr = getSanitizedCharacters(input.value);
 
 				if (!charArr.length) {
 					// if we got an invalid value we want to clear the input
 					input.value = '';
-					if (e.data === null) {
-						// if the user deleted the char, we want to focus the prev digit
-						focusElement(this.getPrevInput(input));
-					}
 				}
 				else this.fillDigits(charArr, input);
-			};
+
+				// we want to stop input events if the value wasn't change
+				if (prevVal === this.value) {
+					e.stopImmediatePropagation();
+				}
+			}, { element: input })
 
 			input.onkeydown = ({ key }) => {
+				prevVal = this.value
+
 				// when user deletes a digit, we want to focus the previous digit
 				if (key === 'Backspace') {
+					// if the cursor is at 0, we want to move it to 1, so the value will be deleted
+					if (!input.selectionStart) {
+						input.setSelectionRange(1, 1);
+					}
 					setTimeout(() => {
 						focusElement(this.getPrevInput(input));
 					});
-				} else if (key.match(/^(\d)$/g)) { // if input is a digit
+				} else if (key.length === 1) { // we want only characters and not command keys
 					input.value = ''; // we are clearing the previous value so we can override it with the new value
 				}
 			};
@@ -174,9 +185,14 @@ class PasscodeInternal extends BaseInputClass {
 	attributeChangedCallback(attrName, oldValue, newValue) {
 		super.attributeChangedCallback?.(attrName, oldValue, newValue)
 
+		// sync attributes to inputs
 		if (oldValue !== newValue) {
-			if (PasscodeInternal.observedAttributes.includes(attrName) && !BaseInputClass.observedAttributes.includes(attrName)) {
-				this.inputs.forEach((input) => input.setAttribute(attrName, newValue))
+			if (observedAttributes.includes(attrName)) {
+				this.inputs.forEach(
+					(input) => newValue === null ?
+						input.removeAttribute(attrName) :
+						input.setAttribute(attrName, newValue)
+				)
 			}
 		}
 	}

package/src/helpers/mixinsHelpers.js

@@ -1,18 +1,35 @@
-// move create event to here
 
+// create a dispatch event function that also calls to the onevent function in case  it's set
 // usage example:
-// #dispatchSomething = createDispatchEvent.bind(this, 'something')
-export function createDispatchEvent(eventName) {
-  this[`on${eventName}`]?.(); // in case we got an event callback as property
-  this.dispatchEvent(new Event(eventName));
+// #dispatchSomething = createDispatchEvent.bind(this, 'something' { ...options })
+// this will dispatch a new event when called, but also call to "onsomething"
+export function createDispatchEvent(eventName, options = {}) {
+  const event = new Event(eventName, options)
+
+  this[`on${eventName}`]?.(event); // in case we got an event callback as property
+  this.dispatchEvent(event);
 }
 
+// add an event listener that is automatically removed on disconnect
 // usage example:
-// #removeChangeListener = createEventListener.call(this,'change', this.onChange)
-export function createEventListener(event, callback) {
+// createEventListener.call(this,'change', this.onChange, { element? , ...options })
+export function createEventListener(event, callback, { element, ...options } = {}) {
+  const timerId = setTimeout(() => console.warn(this.localName, 'is not using "createBaseClass", events will not be removed automatically on disconnect'), 2000)
+
+  this.addEventListener('connected', () => {
+    clearTimeout(timerId);
+  }, { once: true })
+
+  const targetEle = element || this;
   const boundCallback = callback.bind(this);
 
-  this.addEventListener(event, boundCallback);
+  const onDisconnect = () => {
+    targetEle.removeEventListener(event, boundCallback);
+  }
+
+  this.addEventListener('disconnected', onDisconnect, { once: true })
+
+  targetEle.addEventListener(event, boundCallback, options);
 
-  return () => this.removeEventListener(event, boundCallback)
+  return onDisconnect
 }

package/src/index.js

@@ -15,6 +15,7 @@ import './components/descope-switch-toggle';
 import './components/descope-text';
 import './components/descope-text-area';
 import './components/descope-text-field';
+import './components/descope-image';
 
 export {
 	globalsThemeToStyle,

package/src/mixins/changeMixin.js

@@ -1,47 +1,21 @@
-import { createDispatchEvent } from "../helpers/mixinsHelpers";
+import { createDispatchEvent, createEventListener } from "../helpers/mixinsHelpers";
 
 export const changeMixin = (superclass) => class ChangeMixinClass extends superclass {
-
-  #boundedHandleChange
-  #boundedHandleBlur  
-  
-  #removeChangeListener
-  #removeBlurListener
-
   #dispatchChange = createDispatchEvent.bind(this, 'change')
 
-  constructor() {
-    super();
-
-    this.#boundedHandleChange = this.#handleChange.bind(this);
-    this.#boundedHandleBlur = this.#handleBlur.bind(this);
-  }
-
-  #handleChange(e) {
-    // we want to listen only to browser events 
-    // and not to events we are dispatching
-    if (e.isTrusted) {
-      // we want to control the change events that dispatched by the component
-      // so we are stopping propagation and handling it in handleBlur
-      e.stopPropagation()
-    }
-  }
-
-  #handleBlur() {
-    // on blur, we want to dispatch a change event
-    this.#dispatchChange()
-  }
-
   connectedCallback() {
     super.connectedCallback?.();
-
-    this.#removeChangeListener = addEventListener.bind()
-    this.addEventListener('change', this.#boundedHandleChange, true)
-    this.addEventListener('blur', this.#boundedHandleBlur)
-  }
-
-  disconnectedCallback() {
-    this.removeEventListener('change', this.#boundedHandleChange)
-    this.removeEventListener('blur', this.#boundedHandleBlur)
+    this.prevValue = this.value
+
+    createEventListener.call(this, 'change', (e) => {
+      e.stopPropagation();
+    })
+
+    createEventListener.call(this, 'blur', () => {
+      if (this.value !== this.prevValue) {
+        this.#dispatchChange()
+        this.prevValue = this.value
+      }
+    })
   }
 }

package/src/mixins/componentNameValidationMixin.js

@@ -1,7 +1,7 @@
 export const componentNameValidationMixin = (superclass) =>
 	class ComponentNameValidationMixinClass extends superclass {
 		#checkComponentName() {
-			const currentComponentName = this.shadowRoot.host.tagName.toLowerCase();
+			const currentComponentName = this.localName;
 
 			if (!superclass.componentName) {
 				throw Error(
@@ -18,8 +18,6 @@ export const componentNameValidationMixin = (superclass) =>
 
 		connectedCallback() {
 			super.connectedCallback?.();
-			if (this.shadowRoot.isConnected) {
-				this.#checkComponentName();
-			}
+			this.#checkComponentName();
 		}
 	};

package/src/mixins/createProxy.js

@@ -1,6 +1,7 @@
 import { createBaseClass } from '../baseClasses/createBaseClass';
 import { isFunction } from '../helpers';
 import { forwardProps, syncAttrs } from '../helpers/componentHelpers';
+import { createDispatchEvent, createEventListener } from '../helpers/mixinsHelpers';
 
 export const createProxy = ({
 	componentName,
@@ -11,71 +12,62 @@ export const createProxy = ({
 	includeAttrsSync = [],
 	includeForwardProps = []
 }) => {
-	const template = `
-		<style id="create-proxy"></style>
-		<${wrappedEleName}>
-		<slot></slot>
-		${slots.map((slot) => `<slot name="${slot}" slot="${slot}"></slot>`).join('')}
-		</${wrappedEleName}>
-	`;
-
 	class ProxyClass extends createBaseClass({ componentName, baseSelector: wrappedEleName }) {
-		constructor() {
-			super().attachShadow({ mode: 'open' }).innerHTML = template;
-			this.hostElement = this.shadowRoot.host;
-			this.shadowRoot.getElementById('create-proxy').innerHTML =
-				isFunction(style) ? style() : style;
-		}
-
-		#boundOnFocus = this.#onFocus.bind(this);
+		#dispatchBlur = createDispatchEvent.bind(this, 'blur')
+		#dispatchFocus = createDispatchEvent.bind(this, 'focus')
 
-		// we want to focus on the proxy element when focusing our WCP
-		#onFocus() {
-			this.proxyElement.focus();
+		constructor() {
+			super().attachShadow({ mode: 'open' }).innerHTML = `
+			<style id="create-proxy">${isFunction(style) ? style() : style
+				}</style>
+			<${wrappedEleName}>
+			<slot></slot>
+			${slots.map((slot) => `<slot name="${slot}" slot="${slot}"></slot>`).join('')}
+			</${wrappedEleName}>
+		`;
 		}
 
-		focus = this.#onFocus
+		focus = () => this.baseElement.focus()
 
 		connectedCallback() {
-			if (this.shadowRoot.isConnected) {
-				this.proxyElement = this.shadowRoot.querySelector(wrappedEleName);
-
-				this.addEventListener('focus', this.#boundOnFocus);
+			super.connectedCallback?.();
 
-				// this is needed for components that uses props, such as combo box
-				forwardProps(this.hostElement, this.proxyElement, includeForwardProps)
+			createEventListener.call(this, 'blur', (e) => {
+				this.#dispatchBlur()
+			}, { element: this.baseElement })
 
-				// `onkeydown` is set on `proxyElement` support proper tab-index navigation
-				// this support is needed since both proxy host and element catch `focus`/`blur` event
-				// which causes faulty behavior.
-				// we need this to happen only when the proxy component is in the light DOM, 
-				// otherwise it will focus the nested proxy element
-				this.proxyElement.onkeydown = (e) => {
-					if (e.shiftKey && e.keyCode === 9 && this.getRootNode() === document) {
-						this.removeAttribute('tabindex');
-						// We want to defer the action of setting the tab index back
-						// so it will happen after focusing the previous element
-						setTimeout(() => this.setAttribute('tabindex', '0'), 0);
-					}
-				};
+			createEventListener.call(this, 'focus', (e) => {
+				this.#dispatchFocus()
+			}, { element: this.baseElement })
 
-				syncAttrs(this.proxyElement, this.hostElement, {
-					excludeAttrs: excludeAttrsSync,
-					includeAttrs: includeAttrsSync
-				});
-			}
-		}
+			createEventListener.call(this, 'focus', (e) => {
+				// if we got a focus event we want to focus the proxy element
+				if (e.isTrusted) {
+					this.focus();
+				}
+			})
 
-		attributeChangedCallback() {
-			if (!this.proxyElement) {
-				return;
-			}
-		}
+			// this is needed for components that uses props, such as combo box
+			forwardProps(this, this.baseElement, includeForwardProps)
 
-		disconnectedCallback() {
-			super.disconnectedCallback?.()
+			// `onkeydown` is set on `baseElement` support proper tab-index navigation
+			// this support is needed since both proxy host and element catch `focus`/`blur` event
+			// which causes faulty behavior.
+			// we need this to happen only when the proxy component is in the light DOM, 
+			// otherwise it will focus the nested proxy element
+			this.baseElement.onkeydown = (e) => {
+				if (e.shiftKey && e.keyCode === 9 && this.getRootNode() === document) {
+					this.removeAttribute('tabindex');
+					// We want to defer the action of setting the tab index back
+					// so it will happen after focusing the previous element
+					setTimeout(() => this.setAttribute('tabindex', '0'), 0);
+				}
+			};
 
-			this.removeEventListener('focus', this.#boundOnFocus);
+			syncAttrs(this.baseElement, this, {
+				excludeAttrs: excludeAttrsSync,
+				includeAttrs: includeAttrsSync
+			});
 		}
 	}
 

package/src/mixins/createStyleMixin/index.js

@@ -131,6 +131,8 @@ export const createStyleMixin =
 			}
 
 			disconnectedCallback() {
+				super.disconnectedCallback?.();
+
 				this.#disconnectThemeManager?.();
 			}
 		};

package/src/mixins/focusMixin.js

@@ -1,130 +1,25 @@
-import { upperFirst } from "../helpers";
-
-const events = [
-  'blur',
-  'focus',
-  'focusin',
-  'focusout',
-]
+import { createEventListener } from "../helpers/mixinsHelpers"
 
 export const focusMixin = (superclass) => class FocusMixinClass extends superclass {
-  #isFocused = false
-  #setFocusTimer
-
-  #boundedHandleFocus
-  #boundedHandleBlur
-  #boundedHandleFocusIn
-  #boundedHandleFocusOut
-
-  constructor() {
-    super();
-
-    for (const event of events) {
-      this[`dispatch${upperFirst(event)}`] = function () {
-        this.dispatchInputEvent(event)
-      }
-    }
-
-    this.#boundedHandleFocus = this.#handleFocus.bind(this);
-    this.#boundedHandleBlur = this.#handleBlur.bind(this);
-    this.#boundedHandleFocusIn = this.#handleFocusIn.bind(this);
-    this.#boundedHandleFocusOut = this.#handleFocusOut.bind(this);
-  }
-
-  #handleFocus(e) {
-    if (this.isReadOnly) {
-      e.stopPropagation()
-      return
-    }
-    // we want to listen only to browser events 
-    // and not to events we are dispatching
-    if (e.isTrusted) { // TODO: check if this is needed, because Vaadin is also dispatching events
-      // we want to control the focus events that dispatched by the component
-      // so we are stopping propagation and handling it in setFocus
-      e.stopPropagation()
-      this.setFocus(true)
-
-      // if the focus event is on the root component (and not on the inner components)
-      // we want to notify the component and let it decide what to do with it
-      if (e.target === this) {
-        this.onFocus(e)
-      }
-    }
-  }
-
-  #handleFocusOut(e) {
-    // we want to listen only to browser events 
-    // and not to events we are dispatching
-    if (e.isTrusted) {
-      // we want to control the focus events that dispatched by the component
-      // so we are stopping propagation and handling it in setFocus
-      e.stopPropagation()
-    }
-  }
-
-  #handleFocusIn(e) {
-    // we want to listen only to browser events 
-    // and not to events we are dispatching
-    if (e.isTrusted) {
-      // we want to control the focus events that dispatched by the component
-      // so we are stopping propagation and handling it in setFocus
-      e.stopPropagation()
-    }
-  }
-
-  #handleBlur(e) {
-    if (e.isTrusted) {
-      e.stopPropagation()
-      this.setFocus(false)
-    }
-  }
-
-  get isReadOnly() {
-    return this.hasAttribute('readonly') && this.getAttribute('readonly') !== 'false'
-  }
-
-  // we want to debounce the calls to this fn
-  // so we can support input like components with multiple inputs inside
-  setFocus(isFocused) {
-    clearTimeout(this.#setFocusTimer)
-
-    this.#setFocusTimer = setTimeout(() => {
-      if (this.#isFocused !== isFocused) {
-        this.#isFocused = isFocused
-        if (isFocused) {
-          this.dispatchFocus();
-          this.dispatchFocusin();
-        }
-        else {
-          this.dispatchBlur()
-          this.dispatchFocusout();
-        }
-      }
-    })
-  }
-
-  onFocus() {
-    console.warn('onFocus', 'is not implemented')
-  }
-
-  dispatchInputEvent(eventName) {
-    this[`on${eventName}`]?.(); // in case we got an event callback as property
-    this.dispatchEvent(new InputEvent(eventName));
-  }
-
+  // we want to block all native events, 
+  // so the input can control when to dispatch it based on its internal behavior
   connectedCallback() {
-    super.connectedCallback?.();
-
-    this.addEventListener('focus', this.#boundedHandleFocus, true)
-    this.addEventListener('blur', this.#boundedHandleBlur, true)
-    this.addEventListener('focusin', this.#boundedHandleFocusIn)
-    this.addEventListener('focusout', this.#boundedHandleFocusOut)
-  }
-
-  disconnectedCallback() {
-    this.removeEventListener('focus', this.#boundedHandleFocus)
-    this.removeEventListener('blur', this.#boundedHandleBlur)
-    this.removeEventListener('focusin', this.#boundedHandleFocusIn)
-    this.removeEventListener('focusout', this.#boundedHandleFocusOut)
+		super.connectedCallback?.();
+		
+    createEventListener.call(this, 'blur', (e) => {
+			e.isTrusted && e.stopImmediatePropagation()
+		})
+
+		createEventListener.call(this, 'focus', (e) => {
+			e.isTrusted && e.stopImmediatePropagation();
+		})
+
+		createEventListener.call(this, 'focusout', (e) => {
+			e.isTrusted && e.stopImmediatePropagation();
+		})
+
+		createEventListener.call(this, 'focusin', (e) => {
+			e.isTrusted && e.stopImmediatePropagation();
+		})
   }
 }

package/src/mixins/hoverableMixin.js

@@ -1,24 +1,18 @@
+import { createEventListener } from "../helpers/mixinsHelpers";
+
 export const hoverableMixin =
 	(superclass) =>
 		class HoverableMixinClass extends superclass {
-			#boundOnMouseOver = this.#onMouseOver.bind(this)
-
-			#onMouseOver(e) {
-				this.setAttribute('hover', 'true');
-				e.target.addEventListener(
-					'mouseleave',
-					() => this.shadowRoot.host.removeAttribute('hover'),
-					{ once: true }
-				);
-			}
-
 			connectedCallback() {
 				super.connectedCallback?.();
 
-				const baseElement = this.shadowRoot.querySelector(
-					this.baseSelector
-				);
-
-				baseElement.addEventListener('mouseover', this.#boundOnMouseOver);
+				createEventListener.call(this, 'mouseover', (e) => {
+					this.setAttribute('hover', 'true');
+					e.target.addEventListener(
+						'mouseleave',
+						() => this.removeAttribute('hover'),
+						{ once: true }
+					);
+				}, { element: this.baseElement })
 			}
 		};

package/src/mixins/index.js

@@ -8,3 +8,4 @@ export { focusMixin } from './focusMixin'
 export { inputValidationMixin } from './inputValidationMixin'
 export { portalMixin } from './portalMixin'
 export { changeMixin } from './changeMixin'
+export { normalizeBooleanAttributesMixin } from './normalizeBooleanAttributesMixin'