@globalpayments/vega 2.25.0 → 2.27.0

package/dist/collection/helpers/theme/theme-manager.js

@@ -20,6 +20,7 @@ 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
    */
   async overrideColors(overrideColors) {
     const overrideThemes = VegaColorSchemaOverridingController.generateOverrideThemes(overrideColors);
@@ -27,6 +28,8 @@ class ThemeManager {
   }
   /**
    * It removes all the custom override theme styles from the DOM
+   *
+   * @vegaVersion 1.20.0
    */
   async reset() {
     VegaColorSchemaOverridingController.getOverrideThemeContainer().innerHTML = '';
@@ -37,6 +40,7 @@ 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) {
     if (darkMode) {
@@ -52,6 +56,7 @@ 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() {
     return document.documentElement.classList.contains('dark');

package/dist/collection/helpers/translation/index.js

@@ -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/collection/helpers/translation/internal-translation-controller.js

@@ -0,0 +1,104 @@
+import en from './locales/en';
+import { LogUtility } from '../../utils/log';
+import ChangeManager from '../change-manager/change-manager';
+import { UPDATE_TRANSLATION } from '../change-manager/subject/static-subject/static-subject-title';
+/**
+ * Vega translation controller to control the internal text translation
+ */
+class InternalTranslationController {
+  constructor() {
+    this.resources = { en };
+    this._currentLanguage = 'en';
+  }
+  /**
+   * Get current language
+   *
+   * @returns {string} current language
+   */
+  get currentLanguage() {
+    return this._currentLanguage;
+  }
+  /**
+   * Initializes the translation controller with provided resources and language.
+   *
+   * @param {VegaTranslationConfig} config - The configuration object containing resources and initial language.
+   */
+  init({ resources, language }) {
+    if (resources && Object.keys(resources).length > 0) {
+      this.resources = resources;
+    }
+    else {
+      LogUtility.warn(`Resources are empty. Falling back to default language "en".`);
+      this.resources = { en };
+    }
+    if (language && language in this.resources) {
+      this._currentLanguage = language;
+    }
+    else {
+      LogUtility.warn(`Language "${language}" not found in resources. Falling back to default language "en".`);
+      this._currentLanguage = 'en';
+    }
+    ChangeManager.notify(UPDATE_TRANSLATION, {});
+  }
+  /**
+   * Changes the current language if it exists in the resources.
+   *
+   * @param {string} language - The language code to change to.
+   */
+  changeLanguage(language) {
+    if (this.resources[language]) {
+      this._currentLanguage = language;
+      ChangeManager.notify(UPDATE_TRANSLATION, {});
+    }
+    else {
+      LogUtility.warn(`Language "${language}" not found in resources.`);
+    }
+  }
+  /**
+   * 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(key, ...args) {
+    const translation = this.resources[this._currentLanguage][key] || en[key] || key;
+    return args.reduce((result, arg, index) => result.replace(new RegExp(`\\{${index}\\}`, 'g'), String(arg)), translation);
+  }
+  /**
+   * 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(host) {
+    const connectedComponents = InternalTranslationController.connectedComponents.get(host.tagName);
+    if (connectedComponents) {
+      connectedComponents.add(host);
+    }
+    else {
+      InternalTranslationController.connectedComponents.set(host.tagName, new Set([host]));
+    }
+  }
+  /**
+   * Unregister a component from the `connectedComponents` map.
+   *
+   * @param {HTMLStencilElement} host - The component instance to unregister.
+   */
+  unRegisterComponent(host) {
+    const connectedComponents = InternalTranslationController.connectedComponents.get(host.tagName);
+    if (connectedComponents) {
+      connectedComponents.delete(host);
+    }
+  }
+  /**
+   * 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() {
+    return InternalTranslationController.connectedComponents;
+  }
+}
+InternalTranslationController.connectedComponents = new Map();
+export const VegaInternalTranslation = new InternalTranslationController();

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

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

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

@@ -0,0 +1,182 @@
+import en from '../locales/en';
+import ChangeManager from '../../change-manager/change-manager';
+import { UPDATE_TRANSLATION } from '../../change-manager/subject/static-subject/static-subject-title';
+import { LogUtility } from '../../../utils/log';
+import { VegaInternalTranslation } from '../internal-translation-controller';
+describe('VegaTranslationController', () => {
+  beforeEach(() => {
+    VegaInternalTranslation.init({ resources: { en }, language: 'en' });
+  });
+  it('should initialize with the default language as "en"', () => {
+    expect(VegaInternalTranslation.t('This field is required')).toBe('This field is required');
+  });
+  it('should initialize with default resources when no resources are provided', () => {
+    VegaInternalTranslation.init({ resources: undefined, language: 'en' });
+    expect(VegaInternalTranslation.t('This field is required')).toBe('This field is required');
+  });
+  it('should fallback to default language if resources are empty during initialization', () => {
+    spyOn(LogUtility, 'warn');
+    VegaInternalTranslation.init({ resources: {}, language: 'en' });
+    expect(VegaInternalTranslation.t('Viewing {0}-{1} of {2}', 1, 10, 100)).toBe('Viewing 1-10 of 100');
+    expect(LogUtility.warn).toHaveBeenCalledWith('Resources are empty. Falling back to default language "en".');
+  });
+  it('should set the current language correctly', () => {
+    const resources = {
+      en: en,
+      fr: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention,spellcheck/spell-checker
+        'This field is required': 'Ce champ est obligatoire',
+      },
+    };
+    VegaInternalTranslation.init({ resources, language: 'fr' });
+    // eslint-disable-next-line spellcheck/spell-checker
+    expect(VegaInternalTranslation.t('This field is required')).toBe('Ce champ est obligatoire');
+  });
+  it('should fall back to default language if invalid language is provided', () => {
+    const resources = {
+      en: en,
+    };
+    VegaInternalTranslation.init({ resources, language: 'invalid_language' });
+    expect(VegaInternalTranslation.t('This field is required')).toBe('This field is required');
+  });
+  it('should change the current language if valid', () => {
+    spyOn(ChangeManager, 'notify');
+    const fr = {
+      // eslint-disable-next-line spellcheck/spell-checker,@typescript-eslint/naming-convention
+      'This field is required': 'Ce champ est obligatoire',
+      // eslint-disable-next-line spellcheck/spell-checker,@typescript-eslint/naming-convention
+      'The minimum input value is {0}': "La valeur d'entrée minimale est {0}",
+    };
+    VegaInternalTranslation.init({ resources: { en, fr }, language: 'en' });
+    VegaInternalTranslation.changeLanguage('fr');
+    // eslint-disable-next-line spellcheck/spell-checker
+    expect(VegaInternalTranslation.t('This field is required')).toBe('Ce champ est obligatoire');
+    expect(ChangeManager.notify).toHaveBeenCalledWith(UPDATE_TRANSLATION, {});
+  });
+  it('should log a warning if the language does not exist', () => {
+    spyOn(LogUtility, 'warn');
+    VegaInternalTranslation.changeLanguage('es');
+    expect(LogUtility.warn).toHaveBeenCalledWith('Language "es" not found in resources.');
+  });
+  it('should return the key if the translation is not found', () => {
+    expect(VegaInternalTranslation.t('Non existent key')).toBe('Non existent key');
+  });
+  it('should interpolate arguments into the translation string', () => {
+    expect(VegaInternalTranslation.t('The minimum input value is {0}', 5)).toBe('The minimum input value is 5');
+  });
+  it('should handle multiple arguments in the translation string', () => {
+    const enWithMultipleArgs = {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      'Viewing {0}-{1} of {2}': 'Viewing {0}-{1} of {2}',
+    };
+    VegaInternalTranslation.init({ resources: { en: enWithMultipleArgs }, language: 'en' });
+    expect(VegaInternalTranslation.t('Viewing {0}-{1} of {2}', 1, 10, 100)).toBe('Viewing 1-10 of 100');
+  });
+  it('should return translated text as expect', () => {
+    const resources = {
+      /* eslint-disable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+      en: Object.assign(Object.assign({}, en), { 'Custom text': 'Custom text' }),
+      fr: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention,spellcheck/spell-checker
+        'This field is required': 'Ce champ est obligatoire',
+        'Custom text': 'Texte personnalisé',
+      },
+      /* eslint-enable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+    };
+    VegaInternalTranslation.init({ resources, language: 'fr' });
+    /* eslint-disable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+    expect(VegaInternalTranslation.t('This field is required')).toBe('Ce champ est obligatoire');
+    expect(VegaInternalTranslation.t('Custom text')).toBe('Texte personnalisé');
+    /* eslint-enable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+  });
+  it('should return en resource as expected', () => {
+    /* eslint-disable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+    expect(en).toEqual({
+      'This field is required': 'This field is required',
+      'The minimum input value is {0}': 'The minimum input value is {0}',
+      'The maximum input value is {0}': 'The maximum input value is {0}',
+      'The end value should be greater than the start value': 'The end value should be greater than the start value',
+      'The end date should be later than start date': 'The end date should be later than start date',
+      'Credit card number is invalid': 'Credit card number is invalid',
+      'Please enter the correct email format.': 'Please enter the correct email format.',
+      'The maximum input length is {0}': 'The maximum input length is {0}',
+      'The start date should be later than {0}': 'The start date should be later than {0}',
+      'The start date should be earlier than {0}': 'The start date should be earlier than {0}',
+      'The end 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 later than {0}',
+      'The date should be earlier than {0}': 'The date should be earlier than {0}',
+      'The minimum input length is {0}': 'The minimum input length is {0}',
+      'The end time should be later than start time': 'The end time should be later than start time',
+      'Phone number is not valid': 'Phone number is not valid',
+      'Phone number is valid but it belongs to country {0}, not country {1}': 'Phone number is valid but it belongs to country {0}, not country {1}',
+      'Viewing': 'Viewing',
+      'Show': 'Show',
+      'Go To': 'Go To',
+      'Viewing {0}-{1} of {2}': 'Viewing {0}-{1} of {2}',
+      'Upload': 'Upload',
+      'Clear': 'Clear',
+      'Today': 'Today',
+      'Day': 'Day',
+      'Week': 'Week',
+      'Month': 'Month',
+      'Sun': 'Sun',
+      'Mon': 'Mon',
+      'Tue': 'Tue',
+      'Wed': 'Wed',
+      'Thu': 'Thu',
+      'Fri': 'Fri',
+      'Sat': 'Sat',
+      'Sun-short': 'S',
+      'Mon-short': 'M',
+      'Tue-short': 'T',
+      'Wed-short': 'W',
+      'Thu-short': 'T',
+      'Fri-short': 'F',
+      'Sat-short': 'S',
+      'January': 'January',
+      'February': 'February',
+      'March': 'March',
+      'April': 'April',
+      'May': 'May',
+      'June': 'June',
+      'July': 'July',
+      'August': 'August',
+      'September': 'September',
+      'October': 'October',
+      'November': 'November',
+      'December': 'December',
+      'All Day': 'All Day',
+      'Select or drop your file here': 'Select or drop your file here',
+      'Please sign here': 'Please sign here',
+      'Clear Signature': 'Clear Signature',
+      'Start Date': 'Start Date',
+      'End Date': 'End Date',
+      'Please select': 'Please select',
+      'No options': 'No options',
+      'No results found': 'No results found',
+      'Minimum': 'Minimum',
+      'Maximum': 'Maximum',
+      'Select Time': 'Select Time',
+      'Start Time': 'Start Time',
+      'End Time': 'End Time',
+      'There is no data to display': 'There is no data to display',
+    });
+    /* eslint-enable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+  });
+  it('should return default resource(en) translated text if the key not exist in custom resource', () => {
+    const resources = {
+      /* eslint-disable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+      en: en,
+      fr: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention,spellcheck/spell-checker
+        'This field is required': 'Ce champ est obligatoire',
+        'Custom text': 'Texte personnalisé',
+      },
+      /* eslint-enable @typescript-eslint/naming-convention,spellcheck/spell-checker */
+    };
+    VegaInternalTranslation.init({ resources, language: 'fr' });
+    // eslint-disable-next-line spellcheck/spell-checker
+    expect(VegaInternalTranslation.t('Custom text')).toBe('Texte personnalisé');
+    expect(VegaInternalTranslation.t('Sun-short')).toBe('S');
+  });
+});

package/dist/collection/helpers/translation/tests/translation.test.js

@@ -0,0 +1,32 @@
+import { VegaTranslation } from '../translation';
+import { VegaInternalTranslation } from '../internal-translation-controller';
+import { VegaTranslationResourceEN } from '../../public-api';
+describe('VegaTranslation', () => {
+  it('should translate to expected message', () => {
+    const resources = {
+      en: VegaTranslationResourceEN,
+      fr: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention,spellcheck/spell-checker
+        'This field is required': 'Ce champ est obligatoire',
+      },
+    };
+    VegaTranslation.init({ resources, language: 'fr' });
+    // eslint-disable-next-line spellcheck/spell-checker
+    expect(VegaInternalTranslation.t('This field is required')).toBe('Ce champ est obligatoire');
+    VegaTranslation.changeLanguage('en');
+    expect(VegaInternalTranslation.t('This field is required')).toBe('This field is required');
+  });
+  it('should return current language when get currentLanguage', () => {
+    const resources = {
+      en: VegaTranslationResourceEN,
+      fr: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention,spellcheck/spell-checker
+        'This field is required': 'Ce champ est obligatoire',
+      },
+    };
+    VegaTranslation.init({ resources, language: 'fr' });
+    expect(VegaTranslation.currentLanguage).toBe('fr');
+    VegaTranslation.changeLanguage('en');
+    expect(VegaTranslation.currentLanguage).toBe('en');
+  });
+});

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

@@ -0,0 +1,51 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { VegaInternalTranslation } from './internal-translation-controller';
+import { InjectVegaTelemetrySlimmer } from 'vega-slimmer/core';
+import { createPublicAPIRuntimeMetricsSlimmer } from '../slimmers/runtime-metrics/create-public-api-runtime-metrics-slimmer';
+import { VegaTranslationRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/public-api/VegaTranslation/runtime-metrics-payload-definition';
+/**
+ * Vega Translation Public API
+ *
+ * @vegaVersion 2.27.0
+ */
+class TranslationController {
+  constructor() {
+    this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(TranslationController, ['init', 'changeLanguage'], VegaTranslationRuntimeMetricsPayloadDefinition);
+  }
+  /**
+   * Get current language
+   *
+   * @returns {string} current language
+   * @vegaVersion 2.27.0
+   */
+  get currentLanguage() {
+    return VegaInternalTranslation.currentLanguage;
+  }
+  /**
+   * Initializes the translation controller with provided resources and language.
+   *
+   * @param {VegaTranslationConfig} config - Configuration object containing resources and initial language.
+   * @vegaVersion 2.27.0
+   */
+  init(config) {
+    VegaInternalTranslation.init(config);
+  }
+  /**
+   * Changes the current language if it exists in the resources.
+   *
+   * @param {string} language - The language code to change to.
+   * @vegaVersion 2.27.0
+   */
+  changeLanguage(language) {
+    VegaInternalTranslation.changeLanguage(language);
+  }
+}
+__decorate([
+  InjectVegaTelemetrySlimmer()
+], TranslationController.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
+export const VegaTranslation = new TranslationController();

package/dist/collection/helpers/validator/rules/check-box-required-rule.js

@@ -9,7 +9,7 @@ export class CheckBoxRequiredRule {
    * input is anything else, return false
    *
    * @param {string | boolean} input - The input to be evaluated.
-   * @returns {EvaluateResult} - An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} - An object with two properties: isValid and message.
    */
   evaluate(input) {
     if (typeof input === 'boolean') {

package/dist/collection/helpers/validator/rules/date-range-rule.js

@@ -28,7 +28,7 @@ export class DateRangeRule {
    * Check if the start date is before than end date
    *
    * @param {string | string[]} input - The value of the date picker.
-   * @returns  {EvaluateResult} - The result of the evaluation.
+   * @returns  {EvaluateResultTranslation} - The result of the evaluation.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {

package/dist/collection/helpers/validator/rules/date-required-rule.js

@@ -19,7 +19,7 @@ export class DateRequiredRule {
    * Otherwise, return an object with a boolean indicating whether the input is valid and a message to display to the user
    *
    * @param {string | string[]} input - The value of the input field.
-   * @returns {EvaluateResult} An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {

package/dist/collection/helpers/validator/rules/email-field-rule.js

@@ -9,7 +9,7 @@ export class EmailFieldRule {
    * It checks if the input is a valid email address.
    *
    * @param {string} input - string
-   * @returns {EvaluateResult} An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
    * @throws {Error} if input is unable to evaluate
    */
   evaluate(input) {

package/dist/collection/helpers/validator/rules/file-uploader-required-rule.js

@@ -11,6 +11,6 @@ export class FileUploaderRequiredRule extends RequiredFieldRule {
      * @param {unknown} item the array item
      * @returns {boolean} true or false
      */
-    this.checkArrayItemType = (item) => item && typeof item === 'object';
+    this.checkArrayItemType = (item) => !!(item && typeof item === 'object');
   }
 }

package/dist/collection/helpers/validator/rules/input-phone-number-required-rule.js

@@ -11,7 +11,7 @@ export class InputPhoneNumberRequiredRule {
    * It checks if the input is a valid value.
    *
    * @param {unknown} input - The value of the input field.
-   * @returns {EvaluateResult} An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {

package/dist/collection/helpers/validator/rules/input-range-min-and-max-rule.js

@@ -14,7 +14,7 @@ export class InputRangeMinAndMaxRule {
      * Generate an invalid result
      *
      * @param {string} message Error message
-     * @returns {EvaluateResult} invalid validation result
+     * @returns {EvaluateResultTranslation} invalid validation result
      */
     this.invalidResult = (message) => ({
       isValid: false,
@@ -23,7 +23,7 @@ export class InputRangeMinAndMaxRule {
     /**
      * Generate a valid result
      *
-     * @returns {EvaluateResult} invalid validation result
+     * @returns {EvaluateResultTranslation} invalid validation result
      */
     this.validResult = () => ({
       isValid: true,
@@ -49,7 +49,7 @@ export class InputRangeMinAndMaxRule {
    * max range
    *
    * @param {string[]} input - The value of the input range.
-   * @returns  {EvaluateResult} - The result of the evaluation.
+   * @returns  {EvaluateResultTranslation} - The result of the evaluation.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {
@@ -58,11 +58,11 @@ export class InputRangeMinAndMaxRule {
     const startValue = Number(input[0]), endValue = Number(input[1]);
     if (this.minValue !== null &&
       ((input[0] !== '' && startValue < this.minValue) || (input[1] !== '' && endValue < this.minValue))) {
-      return this.invalidResult(`The minimum input value is ${this.minValue}`);
+      return this.invalidResult({ key: 'The minimum input value is {0}', args: [this.minValue] });
     }
     if (this.maxValue !== null &&
       ((input[0] !== '' && startValue > this.maxValue) || (input[1] !== '' && endValue > this.maxValue))) {
-      return this.invalidResult(`The maximum input value is ${this.maxValue}`);
+      return this.invalidResult({ key: 'The maximum input value is {0}', args: [this.maxValue] });
     }
     if (input[0] !== '' && input[1] !== '' && startValue > endValue) {
       return this.invalidResult(`The end value should be greater than the start value`);

package/dist/collection/helpers/validator/rules/input-range-required-rule.js

@@ -8,7 +8,7 @@ export class InputRangeRequiredRule {
    * It checks if the input is a valid value.
    *
    * @param {string[]} input - The value of the input field.
-   * @returns {EvaluateResult} An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {

package/dist/collection/helpers/validator/rules/max-number-rule.js

@@ -19,7 +19,7 @@ export class MaxNumberRule {
    * If the input is a number, return true if it's less than or equal to the maximum value, false otherwise
    *
    * @param {unknown} input - The input value to be evaluated.
-   * @returns {EvaluateResult} The result of the evaluation.
+   * @returns {EvaluateResultTranslation} The result of the evaluation.
    * @throws {Error} if input is unable to evaluate
    */
   evaluate(input) {
@@ -30,7 +30,9 @@ export class MaxNumberRule {
     const maxValue = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.maxValue) || Number.MAX_VALUE;
     return {
       isValid: convertToNumber(input) <= maxValue,
-      message: convertToNumber(input) <= maxValue ? '' : `The maximum input value is ${maxValue}`,
+      message: convertToNumber(input) <= maxValue
+        ? ''
+        : { key: 'The maximum input value is {0}', args: [maxValue] },
     };
   }
   /**

package/dist/collection/helpers/validator/rules/max-string-length-rule.js

@@ -18,7 +18,7 @@ export class MaxStringLengthRule {
    * It checks if the input is a string and if it's shorter than the maximum string length
    *
    * @param {string} input - string
-   * @returns {EvaluateResult} An object with two properties: isValid and message.
+   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
    * @throws {Error} if input is unable to evaluate
    */
   evaluate(input) {
@@ -29,7 +29,9 @@ export class MaxStringLengthRule {
     const maxStrLength = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.maxStrLength) || Number.MAX_VALUE;
     return {
       isValid: input.length <= maxStrLength,
-      message: input.length <= maxStrLength ? '' : `The maximum input length is ${maxStrLength}`,
+      message: input.length <= maxStrLength
+        ? ''
+        : { key: 'The maximum input length is {0}', args: [maxStrLength] },
     };
   }
   /**