@globalpayments/vega 2.41.0 → 2.43.0

package/dist/collection/helpers/slimmers/{test → element-appender/test}/element-appender-slimmer.test.js

@@ -5,13 +5,13 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { MockHTMLElement } from '@stencil/core/mock-doc';
-import { triggerMouseEvent } from '../../../utils/spec-utils';
-import '../../../polyfill/test-polyfill/unit/index';
+import { triggerMouseEvent } from '../../../../utils/spec-utils';
+import '../../../../polyfill/test-polyfill/unit/index';
 import { InjectVegaSlimmer, MapToComponentField } from 'vega-slimmer/core';
 import { ElementAppenderSlimmer } from '../element-appender-slimmer';
-import { LogUtility } from '../../../utils/log';
-import ChangeManager from '../../change-manager/change-manager';
-import { SHADOW_ROOT_ELEMENT_SCROLLING } from '../../change-manager/subject/static-subject/static-subject-title';
+import { LogUtility } from '../../../../utils/log';
+import ChangeManager from '../../../change-manager/change-manager';
+import { SHADOW_ROOT_ELEMENT_SCROLLING } from '../../../change-manager/subject/static-subject/static-subject-title';
 describe('ElementAppender slimmer test suite', () => {
   const mockedComponentDidLoadMethod = jest.fn();
   const mockedComponentDisconnectedCallbackMethod = jest.fn();
@@ -335,4 +335,236 @@ describe('ElementAppender slimmer test suite', () => {
       expect(mockedComponent.getElementAppender().onScroll).toBeCalledTimes(1);
     });
   });
+  describe('Nest element appender', () => {
+    const createMockedComponent = (trigger, parentElement) => {
+      const component = new MockedComponent();
+      const target = new MockHTMLElement('body', 'div');
+      const appendableElement = new MockHTMLElement('body', 'div');
+      if (parentElement) {
+        parentElement.append(target);
+      }
+      appendableElement.classList.add('vega-force-hidden');
+      component.target = target;
+      component.appendableElement = appendableElement;
+      component.trigger = trigger;
+      return component;
+    };
+    const triggerHoverEvent = (from, to) => {
+      jest.useFakeTimers();
+      triggerMouseEvent(from, 'mouseleave');
+      triggerMouseEvent(to, 'mouseenter');
+      jest.advanceTimersByTime(100);
+      jest.useRealTimers();
+    };
+    test('should work proper while parent trigger is click and child trigger is click', () => {
+      const parent = createMockedComponent('click');
+      const child1 = createMockedComponent('click', parent.appendableElement);
+      const child2 = createMockedComponent('click', child1.appendableElement);
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // show parent
+      parent.target.click();
+      // show child1
+      child1.target.click();
+      // show child2
+      child2.target.click();
+      child2.appendableElement.click();
+      triggerMouseEvent(child2.appendableElement, 'mousedown');
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // hide child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // hide child1
+      child1.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // hide parent
+      parent.target.click();
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // show parent
+      parent.target.click();
+      // show child1
+      child1.target.click();
+      // show child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // outer click
+      triggerMouseEvent(document.documentElement, 'mousedown');
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+    test('should work proper while parent trigger is click and child trigger is hover', () => {
+      const parent = createMockedComponent('click');
+      const child1 = createMockedComponent('hover', parent.appendableElement);
+      const child2 = createMockedComponent('click', child1.appendableElement);
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // show parent
+      parent.target.click();
+      // show child1
+      triggerHoverEvent(parent.target, child1.target);
+      // show child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // hide child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // hide child1
+      triggerHoverEvent(child1.target, parent.target);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // hide parent
+      parent.target.click();
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // show parent
+      parent.target.click();
+      // show child1
+      triggerHoverEvent(parent.target, child1.target);
+      // show child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // mouse leave child1
+      triggerHoverEvent(child1.target, parent.target);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+    test('should work proper while parent trigger is hover and child trigger is hover', () => {
+      const parent = createMockedComponent('hover');
+      const child1 = createMockedComponent('hover', parent.appendableElement);
+      const child2 = createMockedComponent('hover', child1.appendableElement);
+      const outer = new MockHTMLElement('body', 'div');
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // mouseenter parent
+      triggerHoverEvent(outer, parent.target);
+      // mouseenter child1
+      triggerHoverEvent(parent.target, child1.target);
+      // mouseenter child2
+      triggerHoverEvent(child1.target, child2.target);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // mouseleave child2
+      triggerHoverEvent(child2.appendableElement, child1.appendableElement);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // mouseleave child1
+      triggerHoverEvent(child1.appendableElement, parent.appendableElement);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // mouseleave parent
+      triggerHoverEvent(parent.appendableElement, outer);
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+      // mouseenter parent
+      triggerHoverEvent(outer, parent.target);
+      // mouseenter child1
+      triggerHoverEvent(parent.target, child1.target);
+      // mouseenter child2
+      triggerHoverEvent(child1.target, child2.target);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // mouseenter outer
+      triggerHoverEvent(child2.appendableElement, outer);
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+    test('should work proper while parent directly hide in click nest', () => {
+      const parent = createMockedComponent('click');
+      const child1 = createMockedComponent('click', parent.appendableElement);
+      const child2 = createMockedComponent('click', child1.appendableElement);
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // show parent
+      parent.target.click();
+      // mouseenter child1
+      child1.target.click();
+      // show child2
+      child2.target.click();
+      child2.appendableElement.click();
+      triggerMouseEvent(child2.appendableElement, 'mousedown');
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // parent directly hide
+      parent.hide();
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+    test('should work proper while parent directly hide in click and hover nest', () => {
+      const parent = createMockedComponent('click');
+      const child1 = createMockedComponent('hover', parent.appendableElement);
+      const child2 = createMockedComponent('click', child1.appendableElement);
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // show parent
+      parent.target.click();
+      // show child1
+      triggerHoverEvent(parent.target, child1.target);
+      // show child2
+      child2.target.click();
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // parent directly hide
+      parent.hide();
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+    test('should work proper while parent directly hide in hover nest', () => {
+      const parent = createMockedComponent('hover');
+      const child1 = createMockedComponent('hover', parent.appendableElement);
+      const child2 = createMockedComponent('hover', child1.appendableElement);
+      const outer = new MockHTMLElement('body', 'div');
+      child2.componentDidLoad();
+      child1.componentDidLoad();
+      parent.componentDidLoad();
+      // mouseenter parent
+      triggerHoverEvent(outer, parent.target);
+      // mouseenter child1
+      triggerHoverEvent(parent.target, child1.target);
+      // mouseenter child2
+      triggerHoverEvent(child1.target, child2.target);
+      expect(parent.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).not.toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).not.toHaveClass('vega-force-hidden');
+      // parent directly hide
+      parent.hide();
+      expect(parent.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child1.appendableElement).toHaveClass('vega-force-hidden');
+      expect(child2.appendableElement).toHaveClass('vega-force-hidden');
+    });
+  });
 });

package/dist/collection/helpers/slimmers/field-error-ui-controller-slimmer.js

@@ -78,7 +78,7 @@ export class FieldErrorUIControllerSlimmer extends VegaSlimmer {
    * Get the error container, if it doesn't exist, create it
    *
    * @param {HTMLElement} inputContainer - The input element container.
-   * @returns {HTMLElement} The error container.
+   * @returns {HTMLElement | undefined} The error container.
    */
   getErrorContainer(inputContainer) {
     for (const strategy of this.fieldErrorUiControllerStrategies) {

package/dist/collection/helpers/slimmers/form-field-controller-slimmer.js

@@ -130,7 +130,8 @@ export class FormFieldControllerSlimmer extends VegaSlimmer {
    * It takes the property rules from the option, maps them to a function that returns a validation rule,
    * and then filters out any falsy values
    *
-   * @returns {FormFieldValidationRule[]} An array of validation rules.
+   * @typedef T generic type
+   * @returns {FormFieldValidationRule<T>[]} An array of validation rules.
    */
   getPropertyRules() {
     const { propertyRules, attributeGetter } = this.options;

package/dist/collection/helpers/slimmers/mutation-observer/mutation-observer-filters.js

@@ -7,7 +7,7 @@ import { findNodeList } from '../../../utils/array';
  * a string representing the tag name of an HTML element. The function then returns a `MutationFilter`
  * function that filters mutations based on whether any added or removed nodes have the specified tag
  * name.
- * @returns {Function} The `TagNameMutationFilter` function is being returned. It takes a `tagName` parameter of
+ * @returns {MutationFilter} The `TagNameMutationFilter` function is being returned. It takes a `tagName` parameter of
  * type string and returns a `MutationFilter` function that filters mutations based on whether any
  * added or removed nodes have a tag name matching the provided `tagName`.
  */
@@ -28,7 +28,7 @@ export const TagNameMutationFilter = (...tagNames) => {
  * The function `AttributeOldValueMutationFilter` filters mutations based on whether the old attribute
  * value differs from the current attribute value on the host element.
  *
- * @returns { Function }The code snippet defines a function named `AttributeOldValueMutationFilter` that returns a
+ * @returns { MutationFilter }The code snippet defines a function named `AttributeOldValueMutationFilter` that returns a
  * `MutationFilter` function. The `MutationFilter` function takes an array of `MutationRecord` objects
  * and an `HTMLElement` as parameters.
  */
@@ -41,7 +41,7 @@ export const AttributeOldValueMutationFilter = () => {
  * Filters mutations based on specified tag names or attribute changes.
  *
  * @param {string[]} tagNames - The tagName of need listened child.
- * @returns {Function} - Filter function.
+ * @returns {MutationFilter} - Filter function.
  */
 export const TagNameAndAttributeMutationFilter = (...tagNames) => {
   return (mutations) => {

package/dist/collection/helpers/slimmers/position-calculation/base-position-calculation-strategy.js

@@ -336,7 +336,7 @@ export class BasePositionCalculationStrategy extends VegaSlimmer {
   /**
    * Retrieves and formats the translocation.
    *
-   * @returns {TranslocationType} current translocation.
+   * @returns {Nullable<TranslocationType>} current translocation.
    */
   getTranslocation() {
     const translocation = this.showConfig.translocation;

package/dist/collection/helpers/slimmers/position-calculation/test/body-position-calculation-strategy.test.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { InjectVegaSlimmer } from 'vega-slimmer/core';
 import { LogUtility } from '../../../../utils/log';
 import { PositionCalculationController } from '../position-calculation-controller';
-import { ElementAppenderContainerController } from '../../element-appender-container/element-appender-container-controller';
+import { ElementAppenderContainerController } from '../../element-appender/element-appender-container-controller';
 export class PositionCalculationMockedComponent {
   constructor() {
     this.elementAppenderContainerController = new ElementAppenderContainerController();

package/dist/collection/helpers/slimmers/runtime-metrics/public-api-runtime-metrics-slimmer-base.js

@@ -48,7 +48,7 @@ export class VegaPublicAPIRuntimeMetricsSlimmerBase extends VegaSlimmer {
    * The `CurrentlyInvokedMethodName` is a public API method name, it comes from the `InjectVegaTelemetrySlimmer` definition and assignment
    *
    * @param {unknown[]} [args] - The `args` parameter passed in when the slimmer method is executed
-   * @returns {Record<string, unknown>} The `getPublicAPIMetricsPayload` method returns an object with the following
+   * @returns {Nullable<Record<string, unknown>>} The `getPublicAPIMetricsPayload` method returns an object with the following
    * structure:
    * {
    * 	publicAPIName: string, // The public api name

package/dist/collection/helpers/slimmers/string-input-formatter-slimmer.js

@@ -8,7 +8,7 @@ import { MapToComponentField, MapToComponentMethod, VegaSlimmer } from 'vega-sli
 import { isNonNullable } from '../../types/type-guard';
 import ChangeManager from '../change-manager/change-manager';
 import domNodeSubjectFactory from '../change-manager/subject/dom-node-subject/dom-node-subject-factory';
-import { VegaInternalComponentDidRender } from '../event-manager/event-id/vega-internal-event-id';
+import { VegaInternalComponentDidRender, VegaInternalPasteEvent, } from '../event-manager/event-id/vega-internal-event-id';
 import { waitForComponentDidRender } from '../common';
 /** The `StringInputFormatterSlimmer` class in TypeScript is used to format input values based on specified strategies and handle events like keydown, blur, and focus. */
 export class StringInputFormatterSlimmer extends VegaSlimmer {
@@ -51,7 +51,7 @@ export class StringInputFormatterSlimmer extends VegaSlimmer {
       const rawValue = target.value;
       const caretPosition = target.selectionStart; // selectionStart is nullable, link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#dom-textarea/input-selectionstart
       if (this.inputFormatStrategy) {
-        this.formatValue(rawValue.replace(/\s/g, ''), 'input', {
+        this.formatValue(rawValue, 'input', {
           caretPosition: e.inputType === 'insertFromPaste' ? undefined : caretPosition,
         });
         this.updateInputCaretPosition(rawValue, caretPosition);
@@ -66,6 +66,9 @@ export class StringInputFormatterSlimmer extends VegaSlimmer {
       if (this.disableCopyPaste) {
         e.preventDefault();
       }
+      else {
+        ChangeManager.notify(domNodeSubjectFactory.getSubject(this.host, VegaInternalPasteEvent), e);
+      }
     };
   }
   /**

package/dist/collection/helpers/theme/controllers/color-schema-overriding-controller.js

@@ -64,7 +64,7 @@ class ColorSchemaOverridingController {
    *
    * @param {OverridableToken} overrideColorToken The token will be overridden
    * @param {VegaThemeOverrideColors} overrideColors the payload of override colors
-   * @returns {string} The css var value
+   * @returns {Nullable<string>} The css var value
    */
   parseCssVarValue(overrideColorToken, overrideColors) {
     var _a;

package/dist/collection/helpers/touch-helper/touch-listener.js

@@ -44,7 +44,7 @@ export class TouchListener {
    * @param {number} startY - The y-coordinate of the touch start event.
    * @param {number} endX - The x coordinate of the touch end event.
    * @param {number} endY - the y coordinate of the touch event.
-   * @returns {{ direction: TouchDirection; distance: number }} The direction and distance of the touch.
+   * @returns {TouchDirectionAndDistanceType} The direction and distance of the touch.
    */
   static getTouchDirectionAndDistance(startX, startY, endX, endY) {
     const delX = endX - startX;
@@ -66,7 +66,7 @@ export class TouchListener {
    * Get the coordinates of a touch event
    *
    * @param {TouchEvent} event - The event object that was passed to the handler.
-   * @returns {{ x: number; y: number }} The coordinates of the touch event.
+   * @returns {TouchEventCoordinatesType} The coordinates of the touch event.
    */
   static getTouchEventCoordinates(event) {
     return { x: event.changedTouches[0].screenX, y: event.changedTouches[0].screenY };

package/dist/collection/helpers/translation/locales/en.js

@@ -23,6 +23,7 @@ export const staticTranslations = {
   'Show': 'Show',
   'Go To': 'Go To',
   'Viewing {0}-{1} of {2}': 'Viewing {0}-{1} of {2}',
+  'Items Per Page': 'Items Per Page',
   'Upload': 'Upload',
   'Clear': 'Clear',
   'Today': 'Today',

package/dist/collection/helpers/translation/tests/internal-translation-controller.test.js

@@ -113,6 +113,7 @@ describe('VegaTranslationController', () => {
       'Show': 'Show',
       'Go To': 'Go To',
       'Viewing {0}-{1} of {2}': 'Viewing {0}-{1} of {2}',
+      'Items Per Page': 'Items Per Page',
       'Upload': 'Upload',
       'Clear': 'Clear',
       'Today': 'Today',

package/dist/collection/helpers/ui/element-appender.js

@@ -9,7 +9,7 @@ import InternalVegaZIndexManager from '../zindex/internal-vega-z-index-manager';
 import { LogUtility } from '../../utils/log';
 import { InjectVegaSlimmer, createDynamicSlimmer, methodPlaceholder } from 'vega-slimmer/core';
 import { PageResizeObserverSlimmer } from '../slimmers/page-resize-observer-slimmer';
-import { ElementAppenderContainerController } from '../slimmers/element-appender-container/element-appender-container-controller';
+import { ElementAppenderContainerController } from '../slimmers/element-appender/element-appender-container-controller';
 import { PositionCalculationController } from '../slimmers/position-calculation/position-calculation-controller';
 /**
  * This class is responsible for attaching the appendable element to the host element and adjusting its position
@@ -31,7 +31,7 @@ export class ElementAppender {
    * target for the showConfigCallback.
    */
   constructor(showConfigCallback, showConfigCallbackTarget) {
-    var _a;
+    var _a, _b;
     this.resizeObserverSlimmer = createDynamicSlimmer(ElementAppender, PageResizeObserverSlimmer, [], [
       { mapFrom: 'connectResizeObserver', mapTo: 'connectResizeObserver' },
       { mapFrom: 'disconnectResizeObserver', mapTo: 'disconnectResizeObserver' },
@@ -62,6 +62,7 @@ export class ElementAppender {
     this.showConfigCallbackTarget = showConfigCallbackTarget;
     const config = this.getShowConfig();
     (_a = config.appendableElement) === null || _a === void 0 ? void 0 : _a.classList.add('vega-force-hidden');
+    (_b = config.appendableElement) === null || _b === void 0 ? void 0 : _b.classList.add('vega-element-appender-appendable');
   }
   /**
    * It takes an element and appends it to the DOM, then adjusts its position and size to match the
@@ -212,7 +213,6 @@ export class ElementAppender {
     if (!this.showConfig.isScreenPosition) {
       this.initVisibleAppendElement();
     }
-    this.showConfig.appendableElement.classList.add('vega-element-appender-appendable');
     this.showConfig.appendableElement.style.boxSizing = 'border-box';
     this.positionCalculationController.setCalculationStrategy();
   }

package/dist/collection/helpers/validator/form-field-controller.js

@@ -150,7 +150,8 @@ export class FormFieldController {
   /**
    * It returns an array of all the validation rules for the field
    *
-   * @returns {FormFieldValidationRule<number | string | boolean>[]} An array of FormFieldValidationRule<T>
+   * @typedef T generic type
+   * @returns {FormFieldValidationRule<T>[]} An array of FormFieldValidationRule<T>
    */
   getRules() {
     const additionalRules = [...this.additionalRules];
@@ -319,7 +320,7 @@ export class FormFieldController {
   /**
    * Get the input container element based on the options provided.
    *
-   * @returns {HTMLElement} the form field element input container element
+   * @returns {Nullable<HTMLElement>} the form field element input container element
    */
   getInputContainerElements() {
     return this.options && this.options.inputContainerGetter ? this.options.inputContainerGetter() : null;
@@ -451,9 +452,10 @@ export class FormFieldController {
    * If it does, it returns that additional rule, and the rule will be removed from the additional rules array.
    * otherwise, it returns the default rule.
    *
+   * @typedef T generic type
    * @param {InternalFormFieldValidationRule} defaultRule - The rule to be overridden.
    * @param {FormFieldValidationRule[]} additionalRules - The additional rules to be applied.
-   * @returns {FormFieldValidationRule} The overridden rule.
+   * @returns {FormFieldValidationRule<T>} The overridden rule.
    */
   overrideDefaultRuleByAdditionalRule(defaultRule, additionalRules) {
     if (defaultRule && additionalRules) {

package/dist/collection/polyfill/shadow-selection/shadow-selection-polyfill.js

@@ -68,7 +68,7 @@ export class ShadowSelectionPolyfill {
    * For browser which supported shadowroot.getSelection, we use shadowRoot.getselection().
    *
    * @param {ShadowRoot} shadow - A shadow.
-   * @returns {Selection} - The shadow selection.
+   * @returns {Nullable<Selection>} - The shadow selection.
    */
   getSelection(shadow) {
     if (this.supportShadowSelection) {

package/dist/collection/utils/api.js

@@ -5,9 +5,10 @@ export class ApiUtil {
   /**
    * It returns a promise that resolves to a JSON object of type T
    *
+   * @typedef T generic type
    * @param {string} url - The url to make the request to.
    * @param {HeadersInit} headers - HeadersInit
-   * @returns {Promise}A promise of type T
+   * @returns {Promise<T>}A promise of type T
    */
   static async get(url, headers) {
     return await ApiUtil.getResponseInJSON(url, 'GET', headers, undefined);
@@ -16,10 +17,11 @@ export class ApiUtil {
    * It takes a URL, a method, some headers, and some data, and returns a promise that resolves to the
    * response in JSON format
    *
+   * @typedef T generic type
    * @param {string} url - The URL to make the request to.
    * @param {unknown} data - The data to send to the server.
    * @param {HeadersInit} headers - HeadersInit
-   * @returns {Promise} A promise that resolves to the response in JSON format.
+   * @returns {Promise<T>} A promise that resolves to the response in JSON format.
    */
   static async post(url, data, headers) {
     return await ApiUtil.getResponseInJSON(url, 'POST', headers, JSON.stringify(data));
@@ -28,12 +30,13 @@ export class ApiUtil {
    * It takes a URL, a method, a set of headers, and an optional body, and returns a promise that
    * resolves to a JSON object
    *
+   * @typedef T generic type
    * @param {string} url - The URL to send the request to.
    * @param {string} method - The HTTP method to use.
    * @param {HeadersInit} headers - HeadersInit - This is the headers that will be sent with the
    * request.
    * @param {string} [body] - The body of the request.
-   * @returns {Promise} A promise that resolves to a JSON object.
+   * @returns {Promise<T>} A promise that resolves to a JSON object.
    */
   static async getResponseInJSON(url, method, headers, body) {
     if (headers) {

package/dist/collection/utils/array.js

@@ -75,7 +75,7 @@ export function getLongestTextLengthFromArray(textArray) {
  * revertArrayFromFlatArray([1,2,3,4,5,6],[])
  * @param {T[]} flatArr - an array of elements that have been flattened into a single array.
  * @param {T[]} lengthArr - `lengthArr` is an array of numbers that specifies the length of each sub-array that the `flatArr`
- * @returns {T[]|T[][]} The function `revertArrayFromFlatArray` returns either a single-dimensional array of type `T[]` or a two-dimensional array of type `T[][]`
+ * @returns {T[] | T[][]} The function `revertArrayFromFlatArray` returns either a single-dimensional array of type `T[]` or a two-dimensional array of type `T[][]`
  */
 export function convertArrayToNestedArray(flatArr, lengthArr) {
   if (lengthArr.length) {
@@ -133,7 +133,7 @@ export function sortArrayOrNestedArray(data, sortBy) {
  * @param {string[]} [existArray] - The `existArray` parameter is an optional array of strings that
  * represents the desired order of the elements in the `needSortArray`. If provided, the function will
  * sort the elements in `needSortArray` based on their position in `existArray`. If not provided, the default exist array will use the default order of the array
- * @returns {unknown[] | unknown[][]} The function `sortAsExistArray` returns a sorted array or nested array of type `T[] |
+ * @returns {T[] | T[][]} The function `sortAsExistArray` returns a sorted array or nested array of type `T[] |
  * T[][]`. The sorting is based on the order of elements in the `existArray` parameter, or if
  * `existArray` is not provided, it is based on the order of appearance of elements in the input array
  * or nested array. The sorting is done using the `sortArrayOrNested

package/dist/collection/utils/breakpoints.js

@@ -32,8 +32,9 @@ export const getCurrentBreakpoint = () => {
  *   XL: 'size-24',
  * }
  *
+ * @typedef T generic type
  * @param {ResponsiveType<ResponsiveScope>} breakpoints - responsive token
- * @returns {ResponsiveType<ResponsiveScope>} - completed breakpointss
+ * @returns {ResponsiveType<T>} - completed breakpointss
  */
 export const createCompleteResponsiveMap = (breakpoints) => {
   let responsiveScope;