@globalpayments/vega 2.25.0 → 2.27.0

package/dist/types/constants/runtime-metrics-payload-definition/public-api/VegaTranslation/runtime-metrics-payload-definition.d.ts

@@ -0,0 +1,2 @@
+import { PublicAPIRuntimeMetricsDefinition } from '../../../../helpers/slimmers/runtime-metrics/public-api-runtime-metrics-slimmer-base';
+export declare const VegaTranslationRuntimeMetricsPayloadDefinition: PublicAPIRuntimeMetricsDefinition[];

package/dist/types/constants/ui.d.ts

@@ -9,7 +9,7 @@ export declare const FlexDirections: readonly ["row", "col", "row-reverse", "col
 export declare const FlexAlignItem: readonly ["start", "center", "end", "baseline", "stretch"];
 export declare const FlexJustifyContent: readonly ["start", "center", "end", "space-around", "space-between", "space-evenly"];
 export declare const FlexWrap: readonly ["nowrap", "wrap", "wrap-reverse"];
-export declare const BoxDisplay: readonly ["block", "none"];
+export declare const BoxDisplay: readonly ["block", "inline-block", "none"];
 export declare const BorderStyle: readonly ["solid", "dashed", "dotted", "double", "none"];
 export declare const TextAlign: readonly ["start", "end", "left", "right", "center", "justify"];
 export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "rowExpand", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateDblClick", "countryChange", "actionButtonClick", "moreActionClick", "expand", "rowSelect", "rowSelectAll", "retry", "selectedFileChange", "preview", "labelButtonClick"];

package/dist/types/global/icons/arrow-up-arrow-down.d.ts

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/global/icons/circle-arrow-down.d.ts

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/global/icons/circle-arrow-up.d.ts

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/helpers/change-manager/subject/dom-node-subject/dom-node-subject-factory.d.ts

@@ -1,5 +1,6 @@
 import { DomNodeSubject } from './dom-node-subject';
 import { VegaEventIDInterface } from '../../../event-manager/event-id/vega-event-id-interface';
+import { Nullable } from '../../../../types/general';
 /** The `DomNodesSubjectFactory` class is responsible for managing and caching `DomNodeSubject` objects associated with HTML elements. */
 declare class DomNodeSubjectFactory {
   private cache;
@@ -19,6 +20,14 @@ declare class DomNodeSubjectFactory {
    * @returns {boolean} a boolean value.
    */
   isExist(node: HTMLElement, eventId: VegaEventIDInterface): boolean;
+  /**
+   * The function find if the parent of a given node exists in the cache and if it has a specific event ID.
+   *
+   * @param {HTMLElement} childNode - Child node.
+   * @param {VegaEventIDInterface} eventId - eventId.
+   * @returns {DomNodeSubject} - Parent node subject.
+   */
+  getSubjectFromParentNodeByEventId(childNode: HTMLElement, eventId: VegaEventIDInterface): Nullable<DomNodeSubject>;
   /**
    * The function `setSubject` creates a new `DomNodeSubject` and associates it with a given `node` and `eventId`, and then returns the created subject.
    *

package/dist/types/helpers/change-manager/subject/static-subject/static-subject-title.d.ts

@@ -1,5 +1,5 @@
 import { Subject } from '../subject-interface';
-export declare type SubjectTitle = 'SIDENAV_LINK_SELECTED_TOPIC' | 'LEFT_NAV_LINK_SELECTED_TOPIC' | 'ACCORDION_EXPAND_TOPIC' | 'FORM_RESET_OPERATION_TRIGGERED' | 'FORM_FIELD_ELEMENT_DISCONNECTED' | 'FORM_SUBMIT' | 'FORM_RESET' | 'RADIO_GROUP_DISABLED_CHANGE' | 'CHECKBOX_GROUP_DISABLED_CHANGE' | 'FORM_FIELD_PENDING_VALID_CHANGE' | 'TAB_PANEL_ADD_OR_DEL_TO_GROUP' | 'TABLE_EXPAND_ROW' | 'TABLE_ROW_SELECTION' | 'TABLE_ROW_SELECTION_ALL' | 'TABLE_SELECTION' | 'TABLE_ROW_CLICK' | 'TABLE_ROW_SELECT' | 'TABLE_ROW_SELECT_ALL' | 'FIELD_ERROR_MESSAGE_CHANGE' | 'DROPDOWN_ITEM_CLICK' | 'CHECKBOX_VALUE_CHANGE' | 'RADIO_VALUE_CHANGE' | 'FORM_ELEMENT_VALUE_CHANGE' | 'FORM_EMEMENT_VALIDATE' | 'FIELD_ERROR_STATE_CHANGE' | 'VEGA_VIRTUAL_SCROLL_TO_BOTTOM' | 'SELECTION_TILE_VALUE_CHANGE' | 'DROPDOWN_RENDER_ITEM_INTERNAL_OVERRIDEN' | 'DROPDOWN_SEARCH_INTERNAL_OVERRIDEN';
+export declare type SubjectTitle = 'SIDENAV_LINK_SELECTED_TOPIC' | 'LEFT_NAV_LINK_SELECTED_TOPIC' | 'ACCORDION_EXPAND_TOPIC' | 'FORM_RESET_OPERATION_TRIGGERED' | 'FORM_FIELD_ELEMENT_DISCONNECTED' | 'FORM_SUBMIT' | 'FORM_RESET' | 'RADIO_GROUP_DISABLED_CHANGE' | 'CHECKBOX_GROUP_DISABLED_CHANGE' | 'FORM_FIELD_PENDING_VALID_CHANGE' | 'TAB_PANEL_ADD_OR_DEL_TO_GROUP' | 'TABLE_EXPAND_ROW' | 'TABLE_ROW_SELECTION' | 'TABLE_ROW_SELECTION_ALL' | 'TABLE_SELECTION' | 'TABLE_ROW_CLICK' | 'TABLE_ROW_SELECT' | 'TABLE_ROW_SELECT_ALL' | 'FIELD_ERROR_MESSAGE_CHANGE' | 'DROPDOWN_ITEM_CLICK' | 'CHECKBOX_VALUE_CHANGE' | 'RADIO_VALUE_CHANGE' | 'FORM_ELEMENT_VALUE_CHANGE' | 'FORM_EMEMENT_VALIDATE' | 'FIELD_ERROR_STATE_CHANGE' | 'VEGA_VIRTUAL_SCROLL_TO_BOTTOM' | 'SELECTION_TILE_VALUE_CHANGE' | 'DROPDOWN_RENDER_ITEM_INTERNAL_OVERRIDEN' | 'DROPDOWN_SEARCH_INTERNAL_OVERRIDEN' | 'UPDATE_TRANSLATION';
 export declare const SIDENAV_LINK_SELECTED_TOPIC: Subject;
 export declare const LEFT_NAV_LINK_SELECTED_TOPIC: Subject;
 export declare const ACCORDION_EXPAND_TOPIC: Subject;
@@ -24,5 +24,4 @@ export declare const FORM_ELEMENT_VALIDATE: Subject;
 export declare const FIELD_ERROR_STATE_CHANGE: Subject;
 export declare const VEGA_VIRTUAL_SCROLL_TO_BOTTOM: Subject;
 export declare const SELECTION_TILE_VALUE_CHANGE: Subject;
-export declare const DROPDOWN_RENDER_ITEM_INTERNAL_OVERRIDEN: Subject;
-export declare const DROPDOWN_SEARCH_INTERNAL_OVERRIDEN: Subject;
+export declare const UPDATE_TRANSLATION: Subject;

package/dist/types/helpers/common/wait-for-vega-handler.d.ts

@@ -10,6 +10,8 @@ declare class WaitForVegaHandler {
    * Wait for all vega elements to be ready.
    *
    * The below method is e2e-test covered in @see{module:wait-for-vega-should-work-as-expected}
+   *
+   * @vegaVersion 2.8.0
    */
   handle(): Promise<Awaited<HTMLVegaElementType>[]>;
 }

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

@@ -22,6 +22,7 @@ declare class VegaDialogController {
    *
    * @param {VegaDialogOption} options - VegaDialogOption
    * @returns {HTMLElement} 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

@@ -27,3 +27,5 @@ export declare const VegaInternalDropdownTemplateItemsChange: VegaInternalEventI
 export declare const VegaInternalTableRowSelect: VegaInternalEventID;
 export declare const VegaInternalTableRowSelectAll: VegaInternalEventID;
 export declare const VegaInternalTableRowExpand: VegaInternalEventID;
+export declare const VegaDropdownRenderItemInternalOverridden: VegaInternalEventID;
+export declare const VegaDropdownSearchInternalOverridden: VegaInternalEventID;

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

@@ -16,6 +16,7 @@ declare class VegaEventManager {
    * configuration settings for the event semantics. It may include properties such as the event type,
    * event source, event target, event data, and any other relevant information for setting up the
    * semantics of the event.
+   * @vegaVersion 2.0.0
    */
   setSemantics(config: EventSemanticsConfig): void;
   /**
@@ -25,6 +26,7 @@ declare class VegaEventManager {
    * in the DOM (Document Object Model). It can be any valid HTML element such as a div, span, button,
    * etc.
    * @returns {EventSemantics} an object of type EventSemantics.
+   * @vegaVersion 2.0.0
    */
   getSemantics(host: HTMLElement): EventSemantics;
   /**
@@ -33,6 +35,7 @@ declare class VegaEventManager {
    * @param {VegaComponentName} componentName - The component name,
    * etc.
    * @returns {Nullable<VegaEventID[]>} All eventIds.
+   * @vegaVersion 2.0.0
    */
   getEnabledEventIdsByComponent(componentName: VegaComponentName): Nullable<VegaEventID[]>;
 }

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

@@ -15,12 +15,14 @@ declare class FeatureFlagController {
    * This function enables the feature flags with the given keys.
    *
    * @param {FeatureFlagKey[]} featureFlagKeys - The feature flags to enable.
+   * @vegaVersion 1.3.0
    */
   enable(...featureFlagKeys: FeatureFlagKey[]): void;
   /**
    * Disable the feature flags with the given keys.
    *
    * @param {FeatureFlagKey[]} featureFlagKeys - The feature flags to disable.
+   * @vegaVersion 1.3.0
    */
   disable(...featureFlagKeys: FeatureFlagKey[]): void;
   /**
@@ -28,6 +30,7 @@ declare class FeatureFlagController {
    *
    * @param {FeatureFlagKey} featureFlagKey - The feature flag key to check.
    * @returns {boolean} - True if the feature flag key is in the set of enabled feature flag keys, otherwise false.
+   * @vegaVersion 1.3.0
    */
   isEnabled(featureFlagKey: FeatureFlagKey): boolean;
   /**

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

@@ -49,4 +49,5 @@ export type FeatureFlagKey =
 	| 'VEGA_REACT.ENABLE_ON_CLOSE_HANDLE_UNDER_LOW_VERSION'
 	| 'VEGA_BANNER_DEPRECATED_ACTION_BUTTON_PROP_VEGA_CLICK'
 	| 'VEGA_REACT.SKIP_NATIVE_EVENT_PREVENT_BY_DEFAULT'
-	| 'VEGA_TELEMETRY.ENABLE_COLLECT_PUBLIC_API';
+	| 'VEGA_TELEMETRY.ENABLE_COLLECT_PUBLIC_API'
+	| 'VEGA_LEFT_NAV.DISABLE_ANIMATION_ON_LOAD';

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

@@ -0,0 +1,14 @@
+import { FlexType, FlexGrowType, FlexShrinkType, FlexBasisType, Nullable } from '../../types/components.type';
+import { ResponsiveType } from '../../types/ui.type';
+/**
+ * Fomatter flex styles.
+ *
+ * @param {Nullable<ResponsiveType<FlexType>>} flex - flex
+ * @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
+ */
+export declare function formatFlexStyles(flex: Nullable<ResponsiveType<FlexType>>, flexGrow: Nullable<ResponsiveType<FlexGrowType>>, flexShrink: Nullable<ResponsiveType<FlexShrinkType>>, flexBasis: Nullable<ResponsiveType<FlexBasisType>>): {
+  [key: string]: string | undefined;
+};

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

@@ -11,6 +11,7 @@ declare class IconManager {
    * Registers the icons into the map.
    *
    * @param {Record<string, string>} icons - icon records
+   * @vegaVersion 2.13.0
    */
   register(icons: Record<string, IconPayload>): void;
   /**
@@ -18,6 +19,7 @@ declare class IconManager {
    *
    * @param {string} name - The name of the icon
    * @returns {Nullable<string>} returns the icon svg or null if not found
+   * @vegaVersion 2.13.0
    */
   getIcon(name: string): Nullable<IconPayload>;
   /**
@@ -25,6 +27,7 @@ declare class IconManager {
    *
    * @param {string} name - The name of the icon
    * @returns {boolean} returns true if the icon exists
+   * @vegaVersion 2.13.0
    */
   hasIcon(name: string): boolean;
 }

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

@@ -11,12 +11,14 @@ declare class VegaLoaderController {
    *
    * @param {VegaLoaderIndicatorOptions} options - VegaLoaderOptions = {} options of the method
    * @returns {string} The uuid of the loader.
+   * @vegaVersion 1.16.0
    */
   load(options?: VegaLoaderOptions): Nullable<string>;
   /**
    * Close the loader by id
    *
    * @param {string} id - The id of the loader.
+   * @vegaVersion 1.16.0
    */
   close(id: string): void;
   /**

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

@@ -13,20 +13,26 @@ declare class VegaNotifyController {
    *
    * @param {VegaNotifyOption} options - VegaNotifyProps
    * @returns {string} The ID of the notification.
+   * @vegaVersion 1.17.0
    */
   open(options: VegaNotifyOption): Promise<string>;
   /**
    * It closes all notifications
+   *
+   * @vegaVersion 1.17.0
    */
   closeAll(): Promise<void>;
   /**
    * It closes the notification with the given id
    *
    * @param {string} id - The id of the notification to close.
+   * @vegaVersion 1.17.0
    */
   close(id: string): Promise<void>;
   /**
    * The function "connectResizeObserver" is used to connect a resize observer.
+   *
+   * @vegaVersion 1.17.0
    */
   connectResizeObserver(): void;
   /**

package/dist/types/helpers/public-api.d.ts

@@ -14,3 +14,4 @@ export { ValidCreditCardNumberRule } from './validator/rules/valid-credit-card-n
 export { waitForVega } from './common';
 export { IconPayload } from './icon/interface';
 export { VegaSkeletonLoader } from './skeleton-loader/vega-skeleton-loader-controller';
+export { VegaTranslation, en as VegaTranslationResourceEN } from './translation';

package/dist/types/helpers/queue/synchronize-task-queue.d.ts

@@ -11,13 +11,14 @@ export declare type Task = {
 export declare class SynchronizeTaskQueue implements Queue<Task> {
   queue: Task[];
   /**
-   * If the queue is empty, run the task immediately. Otherwise, add it to the queue
+   * If immediatelyRun is true, run the task immediately while the queue is empty. Otherwise, add it to the queue.
+   * If immediatelyRun is false, add it to the queue.
    *
    * @param {Task} item - Task - The task to be added to the queue.
    */
-  enqueue(item: Task): Promise<void>;
+  enqueue(item: Task, immediatelyRun?: boolean): Promise<void>;
   /**
    * Run the first task in the queue, then remove it from the queue and run the next task if there is one
    */
-  private runTask;
+  runTask(): Promise<void>;
 }

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

@@ -0,0 +1,39 @@
+import { Nullable } from '../../types/general';
+import { DomNodeSubject } from '../change-manager/subject/dom-node-subject/dom-node-subject';
+/**
+ * The `RemoteInvocationRegistry` provides methods for performing remote invocation calls
+ * and registering remote invocation handlers.
+ */
+export declare class RemoteInvocationRegistry {
+  /**
+   * This function performs a remote invocation call and returning the result.
+   *
+   * @param {HTMLElement} subject the dom node subject
+   * @param {unknown[]} args - The `args` parameter of specific method.
+   * @returns {unknown} The result of call `remoteInvocation`.
+   */
+  call<T>(subject: DomNodeSubject, ...args: unknown[]): Nullable<T>;
+  /**
+   * The function registers a remote invocation handler.
+   *
+   * @param {HTMLElement} subject the dom node subject
+   * @param {Function}remoteInvocationHandler - The method that is ultimately called.
+   */
+  register<T>(subject: DomNodeSubject, remoteInvocationHandler: (...args: unknown[]) => T): void;
+  /**
+   * The function un-registers a remote invocation call handler.
+   *
+   * @param {HTMLElement} subject the dom node subject
+   */
+  unRegister(subject: DomNodeSubject): void;
+  /**
+   * The function isAcceptableObserver checks if the input matches a specified type T.
+   *
+   * @param {unknown} _input - The `_input` parameter is of type `unknown`, which means it can hold any
+   * value.
+   * @returns {boolean} The `isAcceptableObserver` function is returning `true`.
+   */
+  private isAcceptableObserver;
+}
+declare const _default: RemoteInvocationRegistry;
+export default _default;

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

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

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

@@ -18,16 +18,20 @@ declare class VegaSkeletonLoaderController {
    * @param {VegaSkeletonLoaderConfig.items} config.items - Configuration for multiple skeleton items.
    * @param {VegaSkeletonLoaderConfig.layout} config.layout - Layout of the skeleton items.
    * @returns { string } - Key of the loaded skeleton items.
+   * @vegaVersion 2.16.0
    */
   load({ target, type, width, height, items, layout }: VegaSkeletonLoaderConfig): string;
   /**
    * Remove the skeletons from the dom.
    *
    * @param {string} key - The key returned from {@link VegaSkeletonLoaderController.load}.
+   * @vegaVersion 2.16.0
    */
   unLoad(key: string): void;
   /**
    * Remove all the skeletons from the dom.
+   *
+   * @vegaVersion 2.16.0
    */
   unLoadAll(): void;
   /**

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

@@ -1,17 +1,20 @@
 import { VegaSlimmer } from '../../vega-slimmer/vega-slimmer-core';
+import { EvaluateResult } from '../validator/rules/validation-rule';
 /** The `FieldErrorUIControllerSlimmer` class is responsible for displaying error messages and managing the invalid UI state of a form field. */
 export declare class FieldErrorUIControllerSlimmer extends VegaSlimmer {
   private host;
   private options;
   private fieldErrorUiControllerStrategies;
+  private errorMessage;
+  constructor();
   /**
    * It takes an error message and displays it in the error container.
    * TODO: Each component displays the error message and puts it in the code of the respective component.
    * The ticket is https://gethired.atlassian.net/browse/VD-2508
    *
-   * @param {string} errorMessage - The error message to display.
+   * @param {EvaluateResult['message']} errorMessage - The error message to display.
    */
-  applyInputInvalidUI(errorMessage: string): void;
+  applyInputInvalidUI(errorMessage: EvaluateResult['message']): void;
   /**
    * Reset the input element's invalid UI
    * TODO: Each component hides the error message and puts it in the code of the respective component.
@@ -31,4 +34,21 @@ export declare class FieldErrorUIControllerSlimmer extends VegaSlimmer {
    * @returns {HTMLElement} The error container.
    */
   private getErrorContainer;
+  /**
+   * Translates a given message based on its type.
+   *
+   * @param {EvaluateResult['message'] | EvaluateResultTranslation['message']} message - The message to be translated, which can be a string or a TranslationMessage.
+   * @returns {string} The translated message.
+   */
+  private getTranslatedMessage;
+  /**
+   * Init translation observer of translation language changes
+   */
+  private initTranslationObserver;
+  /**
+   * Determines whether the observer should accept changes.
+   *
+   * @returns {boolean} Always returns true in the current implementation.
+   */
+  private isAcceptableTranslationObserver;
 }

package/dist/types/helpers/slimmers/global/vega-translate-observer-slimmer.d.ts

@@ -0,0 +1,19 @@
+import { GlobalSlimmerConfig, VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
+/**
+ * Class responsible for observing translation updates and triggering re-renders.
+ */
+export declare class VegaTranslateObserverSlimmer extends VegaSlimmer {
+  private readonly component;
+  /**
+   * Component lifecycle - [connectedCallback]
+   * Registers an observer to watch for translation updates, which triggers a forced update on the component.
+   */
+  connectedCallback(): void;
+  constructor(option: GlobalSlimmerConfig);
+  /**
+   * Determines whether the observer should accept changes.
+   *
+   * @returns {boolean} Always returns true in the current implementation.
+   */
+  private isAcceptable;
+}

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

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

package/dist/types/helpers/slimmers/translation/index.d.ts

@@ -0,0 +1 @@
+export { TranslationSlimmer } from './translation-slimmer';

package/dist/types/helpers/slimmers/translation/translation-slimmer.d.ts

@@ -0,0 +1,22 @@
+import { VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
+import { HTMLStencilElement } from '../../../stencil-public-runtime';
+import { TranslationKeyMap, TranslationKeyType } from '../../translation/interface';
+/**
+ * Translation slimmer for components to use.
+ * Automatically triggers re-render in components that rely on this utility when the language changes.
+ */
+export declare class TranslationSlimmer<T extends HTMLStencilElement> extends VegaSlimmer {
+  host: T;
+  /**
+   * Component lifecycle - [disconnectedCallback]
+   */
+  disconnectedCallback(): void;
+  /**
+   * Retrieves the translated string for the given key based on the current language.
+   *
+   * @param {string} key - The key for the translation.
+   * @param {unknown[]} args - A list of values to replace in the translation string.
+   * @returns {string} The translated string or the key itself if not found.
+   */
+  t<T extends TranslationKeyType = 'static'>(key: TranslationKeyMap[T], ...args: unknown[]): string;
+}

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

@@ -9,10 +9,13 @@ declare class ThemeManager {
    * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme
    *
    * @param {VegaThemeOverrideColors} overrideColors - OverrideColors - This is the object that you pass to the function.
+   * @vegaVersion 1.20.0
    */
   overrideColors(overrideColors: VegaThemeOverrideColors): Promise<void>;
   /**
    * It removes all the custom override theme styles from the DOM
+   *
+   * @vegaVersion 1.20.0
    */
   reset(): Promise<void>;
   /**
@@ -21,6 +24,7 @@ declare class ThemeManager {
    * @param {boolean | undefined} darkMode - A boolean or undefined value that determines whether to enable or disable dark mode.
    * If it is true, dark mode is enabled.
    * If it is false, dark mode is disabled.
+   * @vegaVersion 1.32.0
    */
   toggleDarkMode(darkMode: boolean): void;
   /**
@@ -28,6 +32,7 @@ declare class ThemeManager {
    *
    * @returns {boolean} A boolean value indicating whether the HTML element has a class of "dark", which is
    * typically used to indicate that the website is in dark mode.
+   * @vegaVersion 1.32.0
    */
   isDarkMode(): boolean;
 }

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

@@ -0,0 +1,4 @@
+export * from './interface';
+export { default as en } from './locales/en';
+export { VegaTranslation } from './translation';
+export { VegaInternalTranslation } from './internal-translation-controller';

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

@@ -0,0 +1,90 @@
+export type VegaTranslationConfig = {
+	resources?: VegaTranslationResources;
+	language?: string;
+};
+
+export interface VegaTranslationResources {
+	[language: string]: Record<string, string>;
+}
+
+export type TranslationKeyType = 'static' | 'dynamic';
+
+export interface TranslationKeyMap {
+	static: StaticTranslationKey;
+	dynamic: string;
+}
+
+/* eslint-disable @typescript-eslint/naming-convention */
+export type StaticTranslationKey =
+	// Form validation rule
+	| 'This field is required'
+	| 'The minimum input value is {0}'
+	| 'The maximum input value is {0}'
+	| 'The end value should be greater than the start value'
+	| 'The end date should be later than start date'
+	| 'Credit card number is invalid'
+	| 'Please enter the correct email format.'
+	| 'The maximum input length is {0}'
+	| 'The start date should be later than {0}'
+	| 'The start date should be earlier than {0}'
+	| 'The end date should be earlier than {0}'
+	| 'The date should be later than {0}'
+	| 'The date should be earlier than {0}'
+	| 'The minimum input length is {0}'
+	| 'The end time should be later than start time'
+	| 'Phone number is not valid'
+	| 'Phone number is valid but it belongs to country {0}, not country {1}'
+	// Component internal text
+	// Common start
+	| 'January'
+	| 'February'
+	| 'March'
+	| 'April'
+	| 'May'
+	| 'June'
+	| 'July'
+	| 'August'
+	| 'September'
+	| 'October'
+	| 'November'
+	| 'December'
+	| 'Sun'
+	| 'Mon'
+	| 'Tue'
+	| 'Wed'
+	| 'Thu'
+	| 'Fri'
+	| 'Sat'
+	| 'Sun-short'
+	| 'Mon-short'
+	| 'Tue-short'
+	| 'Wed-short'
+	| 'Thu-short'
+	| 'Fri-short'
+	| 'Sat-short'
+	| 'Day'
+	| 'Week'
+	| 'Month'
+	| 'Today'
+	| 'Clear'
+	// Common end
+	| 'Viewing'
+	| 'Show'
+	| 'Go To'
+	| 'Viewing {0}-{1} of {2}'
+	| 'Upload'
+	| 'All Day'
+	| 'Select or drop your file here'
+	| 'Please sign here'
+	| 'Clear Signature'
+	| 'Start Date'
+	| 'End Date'
+	| 'Please select'
+	| 'No options'
+	| 'No results found'
+	| 'Minimum'
+	| 'Maximum'
+	| 'Select Time'
+	| 'Start Time'
+	| 'End Time'
+	| 'There is no data to display';

package/dist/types/helpers/translation/internal-translation-controller.d.ts

@@ -0,0 +1,58 @@
+import { TranslationKeyMap, TranslationKeyType, VegaTranslationConfig } from './interface';
+import { HTMLStencilElement } from '../../stencil-public-runtime';
+/**
+ * Vega translation controller to control the internal text translation
+ */
+declare class InternalTranslationController {
+  private static connectedComponents;
+  private resources;
+  private _currentLanguage;
+  constructor();
+  /**
+   * Get current language
+   *
+   * @returns {string} current language
+   */
+  get currentLanguage(): string;
+  /**
+   * Initializes the translation controller with provided resources and language.
+   *
+   * @param {VegaTranslationConfig} config - The configuration object containing resources and initial language.
+   */
+  init({ resources, language }: VegaTranslationConfig): void;
+  /**
+   * Changes the current language if it exists in the resources.
+   *
+   * @param {string} language - The language code to change to.
+   */
+  changeLanguage(language: string): void;
+  /**
+   * Retrieves the translated string for the given key based on the current language.
+   *
+   * @param {string} key - The key for the translation.
+   * @param {unknown[]} args - A list of values to replace in the translation string.
+   * @returns {string} The translated string or the key itself if not found.
+   */
+  t<T extends TranslationKeyType = 'static'>(key: TranslationKeyMap[T], ...args: unknown[]): string;
+  /**
+   * Registers a component to the `connectedComponents` map, associating it with the component's tag name.
+   * If the tag already exists, it adds the component to the existing set of components.
+   *
+   * @param {HTMLStencilElement} host - The component instance to register.
+   */
+  registerComponent<T extends HTMLStencilElement>(host: T): void;
+  /**
+   * Unregister a component from the `connectedComponents` map.
+   *
+   * @param {HTMLStencilElement} host - The component instance to unregister.
+   */
+  unRegisterComponent<T extends HTMLStencilElement>(host: T): void;
+  /**
+   * Retrieves the map of connected components, where each entry associates a tag name with a set of components.
+   *
+   * @returns {Map<string, Set<HTMLElement>>} A map of connected components.
+   */
+  getConnectedComponents(): Map<string, Set<HTMLElement>>;
+}
+export declare const VegaInternalTranslation: InternalTranslationController;
+export {};

package/dist/types/helpers/translation/locales/en.d.ts

@@ -0,0 +1,5 @@
+import { StaticTranslationKey } from '../interface';
+export declare const staticTranslations: {
+  [key in StaticTranslationKey]: string;
+};
+export default staticTranslations;

package/dist/types/helpers/translation/tests/internal-translation-controller.test.d.ts

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

package/dist/types/helpers/translation/tests/translation.test.d.ts

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