@globalpayments/vega 2.41.0 → 2.42.0

package/dist/types/helpers/immutable/immutable-map.d.ts

@@ -25,41 +25,50 @@ export declare class ImmutableMap<K, V> implements Immutable<Map<K, V>> {
   /**
    * The function returns an iterator of the keys in a map.
    *
-   * @returns {IterableIterator<unknown>} The `keys()` method is returning an `IterableIterator` object that contains the keys of the `map`.
+   * @typedef K generic type
+   * @returns {IterableIterator<K>} The `keys()` method is returning an `IterableIterator` object that contains the keys of the `map`.
    */
   keys(): IterableIterator<K>;
   /**
    * The `set` function adds a key-value pair to an immutable map.
    *
+   * @typedef K generic type
+   * @typedef V generic type
    * @param {unknown} key - The key parameter is the key of the entry that you want to add or update in the map. It is of type K, which represents the type of the keys in the map.
    * @param {unknown} value - The value parameter represents the value that you want to associate with the specified key in the ImmutableMap.
-   * @returns {ImmutableMap<unknown, unknown>} The method is returning an ImmutableMap<K, V>.
+   * @returns {ImmutableMap<K, V>} The method is returning an ImmutableMap<K, V>.
    */
   set(key: K, value: V): ImmutableMap<K, V>;
   /**
    * The get function retrieves the value associated with a given key from a map.
    *
+   * @typedef V generic type
    * @param {unknown} key - The parameter "key" is of type "K", which means it can be any type.
-   * @returns {unknown} The value associated with the given key in the map.
+   * @returns {Nullable<V>} The value associated with the given key in the map.
    */
   get(key: K): Nullable<V>;
   /**
    * The values() method of Map instances returns a new map iterator object that contains the values for each element in this map in insertion order.
    *
-   * @returns {IterableIterator<unknown>} An iterator of the values in the map.
+   * @typedef V generic type
+   * @returns {IterableIterator<V>} An iterator of the values in the map.
    */
   values(): IterableIterator<V>;
   /**
    * The `delete` function removes an entry from an ImmutableMap by deleting the corresponding key-value pair from the underlying Map.
    *
+   * @typedef K generic type
+   * @typedef V generic type
    * @param {unknown} key - The key parameter is the key of the entry that you want to delete from the ImmutableMap.
-   * @returns {ImmutableMap<unknown, unknown>} The method is returning an ImmutableMap<K, V>.
+   * @returns {ImmutableMap<K, V>} The method is returning an ImmutableMap<K, V>.
    */
   delete(key: K): ImmutableMap<K, V>;
   /**
    * The `clear` function clears all key-value pairs from an ImmutableMap.
    *
-   * @returns {ImmutableMap<unknown, unknown>} The method is returning an ImmutableMap<K, V>.
+   * @typedef K generic type
+   * @typedef V generic type
+   * @returns {ImmutableMap<K, V>} The method is returning an ImmutableMap<K, V>.
    */
   clear(): ImmutableMap<K, V>;
   /**
@@ -71,8 +80,10 @@ export declare class ImmutableMap<K, V> implements Immutable<Map<K, V>> {
   /**
    * The `withMutation` function takes a callback function that mutates a map and returns a new immutable map with the changes applied.
    *
+   * @typedef K generic type
+   * @typedef V generic type
    * @param {(map: Map<unknown, unknown>) => void} fn - A function that takes a map as its parameter and does some mutation on it.
-   * @returns {ImmutableMap<unknown, unknown>} a new instance of `ImmutableMap<K, V>`.
+   * @returns {ImmutableMap<K, V>} a new instance of `ImmutableMap<K, V>`.
    */
   private withMutation;
 }

package/dist/types/helpers/loading-indicator/vega-loader-controller.d.ts

@@ -11,7 +11,7 @@ declare class VegaLoaderController {
    * Create a loading indicator and append it to the container
    *
    * @param {VegaLoaderIndicatorOptions} options - VegaLoaderOptions = {} options of the method
-   * @returns {string} The uuid of the loader.
+   * @returns {Nullable<string>} The uuid of the loader.
    * @vegaVersion 1.16.0
    */
   load(options?: VegaLoaderOptions): Nullable<string>;
@@ -26,7 +26,7 @@ declare class VegaLoaderController {
    * Find loader by id, if the id include '>>>' it will find inside shadowRoot
    *
    * @param {string} id - The id of the loader.
-   * @returns {string} The loader found by id.
+   * @returns {Nullable<HTMLElement>} The loader found by id.
    */
   private findLoader;
   /**
@@ -40,7 +40,7 @@ declare class VegaLoaderController {
    * Create a loading indicator
    *
    * @param {VegaLoaderIndicatorOptions} indicatorOptions the props of vega loading indicator
-   * @returns {HTMLElement} vega-loading-indicator component template
+   * @returns {HTMLVegaLoadingIndicatorElement} vega-loading-indicator component template
    */
   private createLoadingIndicator;
   /**

package/dist/types/helpers/notify/vega-notify-controller.d.ts

@@ -12,7 +12,7 @@ declare class VegaNotifyController {
    * It creates a new notification element, adds it to the container, and returns the notification's ID
    *
    * @param {VegaNotifyOption} options - VegaNotifyProps
-   * @returns {string} The ID of the notification.
+   * @returns {Promise<string>} The ID of the notification.
    * @vegaVersion 1.17.0
    */
   open(options: VegaNotifyOption): Promise<string>;
@@ -39,14 +39,14 @@ declare class VegaNotifyController {
    * It creates a new page notification element, sets its properties, and returns it
    *
    * @param {VegaNotifyOption} props - VegaNotifyProps - the properties of the notification
-   * @returns {HTMLElement} A function that takes in a props object and returns a pageNotification element.
+   * @returns {HTMLVegaPageNotificationElement} A function that takes in a props object and returns a pageNotification element.
    */
   private createPageNotification;
   /**
    * It creates a div element, sets its z-index to be on top of everything else, adds a class to it, and
    * then adds it to the body of the page
    *
-   * @returns {HTMLElement} The container is being returned.
+   * @returns {HTMLVegaPageNotificationListElement} The container is being returned.
    */
   private getContainer;
 }

package/dist/types/helpers/remote-invocation/remote-invocation-registry.d.ts

@@ -8,9 +8,10 @@ export declare class RemoteInvocationRegistry {
   /**
    * This function performs a remote invocation call and returning the result.
    *
+   * @typedef T generic type
    * @param {HTMLElement} subject the dom node subject
    * @param {unknown[]} args - The `args` parameter of specific method.
-   * @returns {unknown} The result of call `remoteInvocation`.
+   * @returns {Nullable<T>} The result of call `remoteInvocation`.
    */
   call<T>(subject: DomNodeSubject, ...args: unknown[]): Nullable<T>;
   /**

package/dist/types/helpers/skeleton-loader/vega-skeleton-loader-controller.d.ts

@@ -38,7 +38,7 @@ declare class VegaSkeletonLoaderController {
    * Create a skeleton item. The skeleton animated always be true
    *
    * @param {VegaSkeletonLoaderItem} config - Configuration for the skeleton item.
-   * @returns {HTMLElement} - Skeleton item.
+   * @returns {HTMLVegaSkeletonElement} - Skeleton item.
    */
   private createSkeleton;
   /**
@@ -46,7 +46,7 @@ declare class VegaSkeletonLoaderController {
    *
    * @param {HTMLElement[]} skeletons - Skeleton elements of the loader.
    * @param {VegaSkeletonLoaderLayout} layout - Flex properties for the layout.
-   * @returns {HTMLElement} - Container wrapping the skeletons in the specified flex layout.
+   * @returns {HTMLVegaFlexElement} - Container wrapping the skeletons in the specified flex layout.
    */
   private wrapLayout;
 }

package/dist/types/helpers/slimmers/deprecated-property-slimmer.d.ts

@@ -16,7 +16,8 @@ export declare class DeprecatedPropertySlimmerBase<T> extends VegaSlimmer {
    * The `getValue` function returns either the old property or the new property based on a deep equality
    * check.
    *
-   * @returns {unknown} The `getValue` method returns either the `oldProperty` or `newProperty` based on the result
+   * @typedef T generic type
+   * @returns {T} The `getValue` method returns either the `oldProperty` or `newProperty` based on the result
    * of the `deepEqual` comparison between them. If `newProperty` is deeply equal to `oldProperty`, then
    * `oldProperty` is returned; otherwise, `newProperty` is returned.
    */
@@ -25,10 +26,11 @@ export declare class DeprecatedPropertySlimmerBase<T> extends VegaSlimmer {
 /**
  * Create dynamic deprecated property slimmer
  *
+ * @typedef K generic type
  * @param {ClassPrototype} mapFromClass - It represents the class that you want to map from.
  * @param {string} newPropertyName - The new prop name or name path
  * @param {string} oldPropertyName - The old prop name or name path
  * @param {unknown} defaultValue - The default value of the prop
- * @returns {DeprecatedPropertySlimmerBase<unknown>} - deprecated property slimmer
+ * @returns {DeprecatedPropertySlimmerBase<K>} - deprecated property slimmer
  */
 export declare function createDeprecatedPropertySlimmer<T extends DynamicMapFromClass, K>(mapFromClass: ClassPrototype<T>, newPropertyName: string, oldPropertyName: string, defaultValue: unknown): DeprecatedPropertySlimmerBase<K>;

package/dist/types/helpers/slimmers/{element-appender-container → element-appender}/body-positioned-wrapper/body-positioned-wrapper.abstract.d.ts

@@ -1,5 +1,5 @@
 import { ElementAppenderShowConfig } from '../../../ui/element-appender';
-import { ElementAppenderContainerRetriever } from '../element-appender-container-controller';
+import { ElementAppenderContainerRetriever } from '../../element-appender/element-appender-container-controller';
 /**
  * Body positioned wrapper.
  */

package/dist/types/helpers/slimmers/{element-appender-container → element-appender/body-positioned-wrapper}/default-wrapper.d.ts

@@ -1,5 +1,5 @@
-import { ElementAppenderShowConfig } from '../../ui/element-appender';
-import { ElementAppenderContainerRetriever } from './element-appender-container-controller';
+import { ElementAppenderShowConfig } from '../../../ui/element-appender';
+import { ElementAppenderContainerRetriever } from '../../element-appender/element-appender-container-controller';
 /**
  * This class is is used to retrieve the body element of document.
  */

package/dist/types/helpers/slimmers/{element-appender-container → element-appender}/element-appender-container-controller.d.ts

@@ -1,6 +1,6 @@
 import { VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
 import { ElementAppenderShowConfig } from '../../ui/element-appender';
-import { DefaultWrapper } from './default-wrapper';
+import { DefaultWrapper } from './body-positioned-wrapper/default-wrapper';
 import { PositionRelativeToWrapper } from './body-positioned-wrapper/position-relative-to-wrapper';
 import { VegaModalWrapper } from './body-positioned-wrapper/vega-modal-wrapper';
 import { VegaPopoverWrapper } from './body-positioned-wrapper/vega-popover-wrapper';

package/dist/types/helpers/slimmers/{element-appender-slimmer.d.ts → element-appender/element-appender-slimmer.d.ts}

@@ -1,6 +1,6 @@
-import { VegaSlimmer } from '../../vega-slimmer/vega-slimmer-core';
-import { ElementAppender, ElementAppenderShowConfig } from '../ui/element-appender';
-import { Nullable } from '../../types/general';
+import { VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
+import { ElementAppender, ElementAppenderShowConfig } from '../../ui/element-appender';
+import { Nullable } from '../../../types/general';
 declare type ShowConfigFactoryType = () => ElementAppenderShowConfig;
 /**
  * - click: means the dropdown show/hide by click, it also listen global area click. example: VegaPopover

package/dist/types/helpers/slimmers/element-appender/test/element-appender-slimmer.test.d.ts

@@ -0,0 +1 @@
+import '../../../../polyfill/test-polyfill/unit/index';

package/dist/types/helpers/slimmers/field-error-ui-controller-slimmer.d.ts

@@ -33,7 +33,7 @@ export declare 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.
    */
   private getErrorContainer;
   /**

package/dist/types/helpers/slimmers/form-field-controller-slimmer.d.ts

@@ -90,7 +90,8 @@ export declare class FormFieldControllerSlimmer<T> 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.
    */
   private getPropertyRules;
   /**

package/dist/types/helpers/slimmers/mutation-observer/mutation-observer-filters.d.ts

@@ -7,7 +7,7 @@ export declare type MutationFilter = (records: MutationRecord[], host?: HTMLElem
  * 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`.
  */
@@ -16,7 +16,7 @@ export declare const TagNameMutationFilter: (...tagNames: string[]) => MutationF
  * 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.
  */
@@ -25,6 +25,6 @@ export declare const AttributeOldValueMutationFilter: () => MutationFilter;
  * 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 declare const TagNameAndAttributeMutationFilter: (...tagNames: string[]) => MutationFilter;

package/dist/types/helpers/slimmers/position-calculation/base-position-calculation-strategy.d.ts

@@ -129,7 +129,7 @@ export declare abstract class BasePositionCalculationStrategy extends VegaSlimme
   /**
    * Retrieves and formats the translocation.
    *
-   * @returns {TranslocationType} current translocation.
+   * @returns {Nullable<TranslocationType>} current translocation.
    */
   private getTranslocation;
   abstract getPosition(usePreviousPlacement?: boolean): ElementPositionBox;

package/dist/types/helpers/slimmers/position-calculation/test/body-position-calculation-strategy.test.d.ts

@@ -1,7 +1,7 @@
 import { ElementPositionBox, PlacementType, PositionAlignmentType, TranslocationType } from '../../../../types/ui.type';
 import { ElementAppenderShowConfig } from '../../../ui/element-appender';
 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 declare class PositionCalculationMockedComponent {
   showConfig: ElementAppenderShowConfig;
   container: HTMLElement;

package/dist/types/helpers/slimmers/runtime-metrics/public-api-runtime-metrics-slimmer-base.d.ts

@@ -36,7 +36,7 @@ export declare 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/types/helpers/theme/controllers/color-schema-overriding-controller.d.ts

@@ -33,7 +33,7 @@ declare 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
    */
   private parseCssVarValue;
 }

package/dist/types/helpers/touch-helper/touch-listener.d.ts

@@ -43,14 +43,14 @@ export declare 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.
    */
   private static getTouchDirectionAndDistance;
   /**
    * 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.
    */
   private static getTouchEventCoordinates;
   /**

package/dist/types/helpers/translation/interface.d.ts

@@ -72,6 +72,7 @@ export type StaticTranslationKey =
 	| 'Show'
 	| 'Go To'
 	| 'Viewing {0}-{1} of {2}'
+	| 'Items Per Page'
 	| 'Upload'
 	| 'All Day'
 	| 'Select or drop your file here'

package/dist/types/helpers/ui/element-appender.d.ts

@@ -1,7 +1,7 @@
 import { ElementAppenderAlignmentType, ElementAppenderPlacementType, ResponsiveType, SizeType, TranslocationType } from '../../types/ui.type';
 import { ComponentInterface } from '../../stencil-public-runtime';
 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';
 export declare type ElementAppenderShowConfig = {
   target: HTMLElement;

package/dist/types/helpers/validator/form-field-controller.d.ts

@@ -77,7 +77,8 @@ export declare class FormFieldController<T> implements Validator<T> {
   /**
    * 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(): FormFieldValidationRule<T>[];
   /**
@@ -177,7 +178,7 @@ export declare class FormFieldController<T> implements Validator<T> {
   /**
    * 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
    */
   private getInputContainerElements;
   /**
@@ -249,9 +250,10 @@ export declare class FormFieldController<T> implements Validator<T> {
    * 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.
    */
   private overrideDefaultRuleByAdditionalRule;
 }

package/dist/types/polyfill/shadow-selection/shadow-selection-polyfill.d.ts

@@ -26,7 +26,7 @@ export declare 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: ShadowRoot): Nullable<Selection>;
   /**

package/dist/types/types/components.type.d.ts

@@ -157,7 +157,11 @@ export {
 	VegaPageNotificationActionButtonConfig,
 	VegaPageNotificationTypes,
 } from '../components/vega-page-notification/types';
-export { DropdownPropsForPagination, VegaPaginationItemType } from '../components/vega-pagination/types';
+export {
+	DropdownPropsForPagination,
+	VegaPaginationItemType,
+	VegaPaginationLayoutType,
+} from '../components/vega-pagination/types';
 export { PieChartOptions } from '../helpers/chart/pie-chart';
 export { VegaRTEContent } from '../components/vega-rich-text-editor/dto/content-state';
 export { VegaRichTextEditorImage, VegaRTEToolbarItem } from '../components/vega-rich-text-editor/interface';

package/dist/types/utils/api.d.ts

@@ -5,31 +5,34 @@ export declare 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 get<T>(url: string, headers?: HeadersInit): Promise<T>;
   /**
    * 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 post<T>(url: string, data: unknown, headers?: HeadersInit): Promise<T>;
   /**
    * 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.
    */
   private static getResponseInJSON;
 }

package/dist/types/utils/array.d.ts

@@ -48,7 +48,7 @@ export declare function getLongestTextLengthFromArray(textArray: string[]): numb
  * 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 declare function convertArrayToNestedArray<T>(flatArr: T[], lengthArr: number[]): T[] | T[][];
 /**
@@ -77,7 +77,7 @@ export declare function sortArrayOrNestedArray<T>(data: T[] | T[][], sortBy: (da
  * @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/types/utils/breakpoints.d.ts

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

package/dist/types/utils/design-token.d.ts

@@ -4,7 +4,7 @@ import { Nullable } from '../types/general';
  * If the token is a valid spacing token, return the CSS class string. Otherwise, log an error message
  *
  * @param {unknown} token - The value that was passed into the function.
- * @returns {string} The the CSS class string of the padding token.
+ * @returns {Nullable<string>} The the CSS class string of the padding token.
  */
 export declare function formatAndValidPadding(token: unknown): Nullable<string>;
 /**
@@ -12,7 +12,7 @@ export declare function formatAndValidPadding(token: unknown): Nullable<string>;
  * a valid border style type, otherwise it logs an invalid value message.
  *
  * @param {unknown} token - The `token` parameter is a value that represents a border style type.
- * @returns {string} The function `formatAndValidBorderStyle` returns a string that is formatted as
+ * @returns {Nullable<string>} The function `formatAndValidBorderStyle` returns a string that is formatted as
  * `v-border-` if the `token` parameter is of a valid border style type. If the `token` is not
  * a valid border style type, it logs an invalid value message and does not return anything (implicitly
  * returns `undefined`).
@@ -23,21 +23,21 @@ export declare function formatAndValidBorderStyle(token: unknown): Nullable<stri
  * error message
  *
  * @param {unknown} token - The value passed in by the user.
- * @returns {string} The the CSS class string of the border radius token.
+ * @returns {Nullable<string>} The the CSS class string of the border radius token.
  */
 export declare function formatAndValidBorderRadius(token: unknown): Nullable<string>;
 /**
  * If the token is a valid border color, return CSS class string of the border color. Otherwise, log an error message
  *
  * @param {unknown} token - The value passed in by the user.
- * @returns {string}  return the CSS class string of the border color
+ * @returns {Nullable<string>}  return the CSS class string of the border color
  */
 export declare function formatAndValidBorderColor(token: unknown): Nullable<string>;
 /**
  * If the token is a valid border, return CSS class string of the border. Otherwise, log an error message
  *
  * @param {unknown} token - The value passed in by the user.
- * @returns {string}  return the CSS class string of the border
+ * @returns {Nullable<string>}  return the CSS class string of the border
  */
 export declare function formatAndValidBorder(token: unknown): Nullable<string>;
 /**
@@ -45,7 +45,7 @@ export declare function formatAndValidBorder(token: unknown): Nullable<string>;
  *
  * @param {unknown} token - The value of the token.
  * @param {TokenMode[]} withModes - TokenMode[] = []
- * @returns {string} CSS class string for the background color token with modes supported.
+ * @returns {Nullable<string>} CSS class string for the background color token with modes supported.
  */
 export declare function formatAndValidBackgroundColor(token: unknown, withModes?: TokenMode[]): Nullable<string>;
 /**
@@ -54,21 +54,21 @@ export declare function formatAndValidBackgroundColor(token: unknown, withModes?
  *
  * @param {unknown} token - The token to format.
  * @param {TokenMode[]} withModes - TokenMode[] = []
- * @returns {string} A CSS class string that is either a valid color or a valid color with modes.
+ * @returns {Nullable<string>} A CSS class string that is either a valid color or a valid color with modes.
  */
 export declare function formatAndValidTextColor(token: unknown, withModes?: TokenMode[]): Nullable<string>;
 /**
  * If the token is a valid breakpoint, return CSS class string for the flex breakpoint. Otherwise, log an error
  *
  * @param {unknown} token - The value of the breakpoint.
- * @returns {string} CSS class string for the flex breakpoint.
+ * @returns {Nullable<string>} CSS class string for the flex breakpoint.
  */
 export declare function formatAndValidFlexBreakpoint(token: unknown): Nullable<string>;
 /**
  * If the token is a breakpoint, return the breakpoint value. Otherwise, log an error and return 0
  *
  * @param {unknown} token - The value passed in by the user.
- * @returns {number} value of the breakpoint.
+ * @returns {Nullable<number>} value of the breakpoint.
  */
 export declare function formatAndValidBreakpointSize(token: unknown): Nullable<number>;
 /**
@@ -76,7 +76,7 @@ export declare function formatAndValidBreakpointSize(token: unknown): Nullable<n
  * error message
  *
  * @param {unknown} token - The value passed in by the user.
- * @returns {string} CSS class string for the given gap token.
+ * @returns {Nullable<string>} CSS class string for the given gap token.
  */
 export declare function formatAndValidGap(token: unknown): Nullable<string>;
 /**
@@ -84,7 +84,7 @@ export declare function formatAndValidGap(token: unknown): Nullable<string>;
  *
  * @param {string} token - The token to format.
  * @param {TokenMode[]} withModes - TokenMode[] = []
- * @returns {string} CSS class string of the shadow token with modes supported
+ * @returns {Nullable<string>} CSS class string of the shadow token with modes supported
  */
 export declare function formatAndValidShadow(token: string, withModes?: TokenMode[]): Nullable<string>;
 /**
@@ -93,14 +93,14 @@ export declare function formatAndValidShadow(token: string, withModes?: TokenMod
  * @typedef Flag key of ManagedResponsiveScopeInput
  * @param {ResponsiveType<ManagedResponsiveScopeInput[Flag]>} token - The token to format.
  * @param {Flag} flag - The flag that the token is being formatted for.
- * @returns {Nullable<string>} A nullable string
+ * @returns {Nullable<ManagedResponsiveScopeOutput[Flag]>} A nullable string
  */
 export declare function formatAndValidResponsiveToken<Flag extends keyof ManagedResponsiveScopeInput>(token: ResponsiveType<ManagedResponsiveScopeInput[Flag]>, flag: Flag): Nullable<ManagedResponsiveScopeOutput[Flag]>;
 /**
  * The function `formatAndValidTypographyToken` formats a typography token by adding a prefix and checks if it is a valid typography token.
  *
  * @param {string} token - The `token` parameter is a string that represents a typography token.
- * @returns {string} a string value.
+ * @returns {Nullable<string>} a string value.
  */
 export declare function formatAndValidTypographyToken(token: string): Nullable<string>;
 /**

package/dist/types/utils/local-storage.d.ts

@@ -8,7 +8,8 @@ export declare function setItem(key: string, value: unknown): void;
 /**
  * If the browser supports localStorage, return the value of the key, otherwise return null.
  *
+ * @typedef T generic type
  * @param {string} key - The key of the item you want to get.
- * @returns {string} A string
+ * @returns {T | null} A any type
  */
 export declare function getItem<T>(key: string): T | null;

package/dist/types/utils/pagination.d.ts

@@ -8,6 +8,6 @@ export declare const MINIMAL_PAGER_ITEM_COUNT: number;
  * @param {number} current - the current page number
  * @param {number} total - the total number of pages
  * @param {number} [pagerCount=7] - the count of pager items, must be odd number
- * @returns {(number|string)[]} returns an array of page numbers and placeholders
+ * @returns {(number | string)[]} returns an array of page numbers and placeholders
  */
 export declare const generatePagerItems: (current: number, total: number, pagerCount?: number) => (number | string)[];