@globalpayments/vega 2.40.0 → 2.42.0

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

@@ -9,7 +9,7 @@ export declare type VegaDialogOption = {
   cancelButton?: VegaDialogActionButtonProps;
   handleCancel?: VegaDialogAction;
   showCancel?: boolean;
-} & Partial<Pick<HTMLVegaModalElement, 'size' | 'isVerticallyCenter' | 'isVerticallyCentered' | 'showCloseButton'>>;
+} & Partial<Pick<HTMLVegaModalElement, 'size' | 'isVerticallyCenter' | 'isVerticallyCentered' | 'showCloseButton' | 'handleClose'>>;
 /**
  * The dialog controller
  */
@@ -20,7 +20,7 @@ declare class VegaDialogController {
    * It creates a new `vega-dialog` element, sets its properties, appends it to the DOM, and opens it
    *
    * @param {VegaDialogOption} options - VegaDialogOption
-   * @returns {HTMLElement} The dialog reference.
+   * @returns {HTMLVegaDialogElement} The dialog reference.
    * @vegaVersion 1.24.0
    */
   open(options: VegaDialogOption): HTMLVegaDialogElement;

package/dist/types/helpers/event-manager/event-id/vega-internal-event-id.d.ts

@@ -39,3 +39,5 @@ export declare const VegaInternalRichTextImageDeleteButtonClicked: VegaInternalE
 export declare const VegaInternalComponentDidRender: VegaInternalEventID;
 export declare const VegaInternalPopoverUpdateTarget: VegaInternalEventID;
 export declare const VegaInternalRichTextEditDeleteSelectedNodes: VegaInternalEventID;
+export declare const VegaInternalPaginationPageSizeChange: VegaInternalEventID;
+export declare const VegaInternalPaginationCurrentChange: VegaInternalEventID;

package/dist/types/helpers/event-manager/internal-vega-event-manager.d.ts

@@ -46,7 +46,7 @@ declare class InternalVegaEventManager {
   /**
    * The function `getSemanticsInGlobal` returns the global event semantics configuration.
    *
-   * @returns {EventSemantics} The method is returning a nullable EventSemantics object.
+   * @returns {Nullable<EventSemantics>} The method is returning a nullable EventSemantics object.
    */
   private getSemanticsInGlobal;
   /**

package/dist/types/helpers/feature-control/feature-flag.d.ts

@@ -3,6 +3,9 @@
  *
  * @property {string} description - A description of the feature flag.
  * @property {number} createdAt - The timestamp the feature flag was created in **milliseconds**.
+ * @property {string} enabledByDefaultInVersion - The `disabledByDefault` of feature flag must be true after '2.32.0',
+ *    if you want enable it, you can set enabledByDefaultInVersion with a major version.
+ *    Note: the value of this property must be a major version.
  */
 export type FeatureFlagDefinition = {
 	description: string;
@@ -10,6 +13,7 @@ export type FeatureFlagDefinition = {
 	createdTimestamp: number;
 	disabledByDefault?: boolean;
 	removedAfterVersion?: string;
+	enabledByDefaultInVersion?: string;
 };
 
 /**
@@ -52,4 +56,6 @@ export type FeatureFlagKey =
 	| 'VEGA_TELEMETRY.ENABLE_COLLECT_PUBLIC_API'
 	| 'VEGA_LEFT_NAV.DISABLE_ANIMATION_ON_LOAD'
 	| 'VEGA_DATE_PICKER.ENABLE_CALCULATION_POSITION_BY_SCREEN'
-	| 'VEGA_TABLE.REVERSE_SORT_ORDER';
+	| 'VEGA_TABLE.REVERSE_SORT_ORDER'
+	| 'VEGA_PAGINATION.ENABLE_EXTENSIONS_RESPONSIVE_DEFAULT_VALUE'
+	| 'VEGA_COMPONENT.CORNERS_USE_OLD_BEHAVIOR';

package/dist/types/helpers/formatter/responsive-map-formatter/responsiv-border-radius-formatter.d.ts

@@ -3,6 +3,7 @@ import { ResponsiveClassStringFormatter } from './responsive-class-string-format
 /**
  * A class for format BorderRadiusType with BreakpointsForPrefixType to CSS class string
  *
+ * @deprecated Please use the `ResponsiveBorderRadiusStyleStyleFormatter` instead.
  * @augments ResponsiveClassStringFormatter
  */
 declare class ResponsiveBorderRadiusFormatter extends ResponsiveClassStringFormatter<'corners'> {

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-border-radius-style-formatter.d.ts

@@ -0,0 +1,26 @@
+import { CornersType } from '../../../types/ui.type';
+import { ResponsiveCSSTextFormatter } from './responsive-css-text-formatter';
+/**
+ * A class for format BorderRadiusType with BreakpointsForPrefixType to CSS text string
+ *
+ * @augments ResponsiveClassStringFormatter
+ */
+declare class ResponsiveBorderRadiusStyleFormatter extends ResponsiveCSSTextFormatter<'cornersStyle'> {
+  /**
+   * Given a border-radius type, return a string of CSS classes that can be used to apply the border-radius to an element
+   *
+   * @param {CornersType} input - CornersType
+   * @returns {string} - A string of CSS text.
+   */
+  formatToken(input: CornersType): string;
+  /**
+   * Get the corners object keys. Order the keys as exist array if the feature flag enabled.
+   * The order affects the weight of the styles.
+   *
+   * @param {DirectionalBorderRadiusType} map - The corners input object.
+   * @returns {string[]} - The input object keys.
+   */
+  private getDirectionKeys;
+}
+declare const _default: ResponsiveBorderRadiusStyleFormatter;
+export default _default;

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-css-text-formatter.d.ts

@@ -0,0 +1,25 @@
+import { BreakpointsForPrefixType, ManagedResponsiveScopeInput, ResponsiveType } from '../../../types/ui.type';
+import { ResponsiveFormatter } from './responsive-formatter';
+import { Nullable } from '../../../types/general';
+/**
+ * Get the style text from the responsive property.
+ */
+export declare abstract class ResponsiveCSSTextFormatter<Flag extends keyof ManagedResponsiveScopeInput> implements ResponsiveFormatter<ManagedResponsiveScopeInput[Flag], string> {
+  /**
+   * > It takes a `ResponsiveType<ManagedResponsiveScopeInput[Flag]>` and returns a string
+   *
+   * @typedef Flag key of ManagedResponsiveScopeInput
+   * @param {ResponsiveType<ManagedResponsiveScopeInput[Flag]>} input - ManagedResponsiveScopeInput[Flag]
+   * @returns {string} - CSS text string.
+   */
+  format(input: ResponsiveType<ManagedResponsiveScopeInput[Flag]>): string;
+  /**
+   * Create the complete style text with media query selector.
+   *
+   * @param {string} cssText - The style snippet.
+   * @param {BreakpointsTokenType} breakpoint - The screen breakpoint.
+   * @returns {string} - Style content with css selector.
+   */
+  private generateCssText;
+  abstract formatToken(input: ManagedResponsiveScopeInput[Flag], breakpoint?: Nullable<BreakpointsForPrefixType>): string;
+}

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-margin-formatter.d.ts

@@ -3,6 +3,7 @@ import { ResponsiveClassStringFormatter } from './responsive-class-string-format
 /**
  * A class for format MarginType with BreakpointsForPrefixType to CSS class string
  *
+ * @deprecated Please use the `ResponsiveMarginStyleFormatter` instead.
  * @augments ResponsiveClassStringFormatter
  */
 declare class ResponsiveMarginFormatter extends ResponsiveClassStringFormatter<'margin'> {

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-margin-style-formatter.d.ts

@@ -0,0 +1,16 @@
+import { MarginType } from '../../../types/ui.type';
+import { ResponsiveCSSTextFormatter } from './responsive-css-text-formatter';
+/**
+ * Get the padding style content.
+ */
+declare class ResponsiveMarginStyleFormatter extends ResponsiveCSSTextFormatter<'marginStyle'> {
+  /**
+   * Given a margin type, return a string of style content that can be used to apply the margin to an element
+   *
+   * @param {MarginType} input - MarginType
+   * @returns {string} - A string of style content.
+   */
+  formatToken(input: MarginType): string;
+}
+declare const _default: ResponsiveMarginStyleFormatter;
+export default _default;

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-padding-formatter.d.ts

@@ -3,6 +3,7 @@ import { ResponsiveClassStringFormatter } from './responsive-class-string-format
 /**
  * A class for format PaddingType with BreakpointsForPrefixType to CSS class string
  *
+ * @deprecated Please use the `ResponsivePaddingStyleFormatter` instead.
  * @augments ResponsiveClassStringFormatter
  */
 declare class ResponsivePaddingFormatter extends ResponsiveClassStringFormatter<'padding'> {

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-padding-style-formatter.d.ts

@@ -0,0 +1,16 @@
+import { PaddingType } from '../../../types/ui.type';
+import { ResponsiveCSSTextFormatter } from './responsive-css-text-formatter';
+/**
+ * Get the padding style content.
+ */
+declare class ResponsivePaddingStyleFormatter extends ResponsiveCSSTextFormatter<'paddingStyle'> {
+  /**
+   * Given a padding type, return the corresponding string of CSS text.
+   *
+   * @param {PaddingType} input - PaddingType
+   * @returns {string} - CSS text.
+   */
+  formatToken(input: PaddingType): string;
+}
+declare const _default: ResponsivePaddingStyleFormatter;
+export default _default;

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-size-formatter.d.ts

@@ -1,5 +1,6 @@
 import { ResponsiveType, SizeType } from '../../../types/ui.type';
 import { ResponsiveFormatter } from './responsive-formatter';
+declare type ResponsiveSizeType = number | `${number}%` | null;
 /**
  * A class for format SizeType
  *
@@ -10,9 +11,9 @@ declare class ResponsiveSizeFormatter implements ResponsiveFormatter<SizeType, n
    * Given a responsive size, return the size according current window width
    *
    * @param {ResponsiveType<SizeType>} input - ResponsiveScope
-   * @returns {SizeType} - size.
+   * @returns {ResponsiveSizeType} - size.
    */
-  format(input: ResponsiveType<SizeType>): number | `${number}%` | null;
+  format(input: ResponsiveType<SizeType>): ResponsiveSizeType;
 }
 declare const _default: ResponsiveSizeFormatter;
 export default _default;

package/dist/types/helpers/formatter/responsive-map-formatter/responsive-translocation-formatter.d.ts

@@ -11,7 +11,7 @@ declare class ResponsiveTranslocationFormatter implements ResponsiveFormatter<Tr
    * Given a responsive size, return the size according current window width
    *
    * @param {ResponsiveType<TranslocationType>} input - ResponsiveScope
-   * @returns {TranslocationType} - size.
+   * @returns {Nullable<TranslocationType>} - size.
    */
   format(input: ResponsiveType<TranslocationType>): Nullable<TranslocationType>;
 }

package/dist/types/helpers/formatter/string-formatter/number-mask-strategy.d.ts

@@ -38,7 +38,7 @@ export declare class NumberMaskStrategy extends StringFormatStrategy {
    *
    * @param {string} input - input number
    * @param {number} caretPosition - The current caret position
-   * @returns {number} The new position of caret
+   * @returns {Nullable<number>} The new position of caret
    */
   calculateCaretPosition(input: string, caretPosition: Nullable<number>): Nullable<number>;
   /**

package/dist/types/helpers/formatter/string-formatter/string-format-strategy.abstract.d.ts

@@ -23,7 +23,7 @@ export declare abstract class StringFormatStrategy {
    *
    * @param {string} input - The input string
    * @param {number} caretPosition - The current position of caret
-   * @returns {number} The new position of caret
+   * @returns {Nullable<number>} The new position of caret
    */
   calculateCaretPosition?(input: string, caretPosition: Nullable<number>): Nullable<number>;
   /**

package/dist/types/helpers/formatter/string-formatter/string-mask-strategy.d.ts

@@ -47,7 +47,7 @@ export declare class StringMaskStrategy extends StringFormatStrategy {
    *
    * @param {string} input - The input string
    * @param {number} caretPosition - The current position of caret
-   * @returns {number} The new position of caret
+   * @returns {Nullable<number>} The new position of caret
    */
   calculateCaretPosition(input: string, caretPosition: Nullable<number>): Nullable<number>;
   /**

package/dist/types/helpers/formatter/style-formatter.d.ts

@@ -1,5 +1,8 @@
 import { FlexType, FlexGrowType, FlexShrinkType, FlexBasisType, Nullable } from '../../types/components.type';
 import { ResponsiveType } from '../../types/ui.type';
+declare type FormattedStylesType = {
+  [key: string]: string | undefined;
+};
 /**
  * Fomatter flex styles.
  *
@@ -7,8 +10,7 @@ import { ResponsiveType } from '../../types/ui.type';
  * @param {Nullable<ResponsiveType<FlexGrowType>>} flexGrow - flex-grow
  * @param {Nullable<ResponsiveType<FlexShrinkType>>} flexShrink - flex-shrink
  * @param {Nullable<ResponsiveType<FlexBasisType>>} flexBasis - flex-basis
- * @returns {object} - formatted styles
+ * @returns {FormattedStylesType} - formatted styles
  */
-export declare function formatFlexStyles(flex: Nullable<ResponsiveType<FlexType>>, flexGrow: Nullable<ResponsiveType<FlexGrowType>>, flexShrink: Nullable<ResponsiveType<FlexShrinkType>>, flexBasis: Nullable<ResponsiveType<FlexBasisType>>): {
-  [key: string]: string | undefined;
-};
+export declare function formatFlexStyles(flex: Nullable<ResponsiveType<FlexType>>, flexGrow: Nullable<ResponsiveType<FlexGrowType>>, flexShrink: Nullable<ResponsiveType<FlexShrinkType>>, flexBasis: Nullable<ResponsiveType<FlexBasisType>>): FormattedStylesType;
+export {};

package/dist/types/helpers/formatter/test/responsive-map-formatter/responsive-border-radius-style-formatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/formatter/test/responsive-map-formatter/responsive-margin-style-formatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/formatter/test/responsive-map-formatter/responsive-padding-style-formatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/icon/icon-manager.d.ts

@@ -18,7 +18,7 @@ declare class IconManager {
    * Get an internal icon by name
    *
    * @param {string} name - The name of the icon
-   * @returns {Nullable<string>} returns the icon svg or null if not found
+   * @returns {Nullable<IconPayload>} returns the icon svg or null if not found
    * @vegaVersion 2.13.0
    */
   getIcon(name: string): Nullable<IconPayload>;

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'