@globalpayments/vega 2.38.0 → 2.40.0

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

@@ -1,10 +1,11 @@
 import { isTimeStr } from '../../../utils/date';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if time is empty or not
  *
- * @implements {FormFieldValidationRule<string>}
+ * @augments {InternalFormFieldValidationRule<string>}
  */
-export class TimeRequiredRule {
+export class TimeRequiredRule extends InternalFormFieldValidationRule {
   /**
    * It creates a new instance of the class with the given config.
    *
@@ -12,13 +13,14 @@ export class TimeRequiredRule {
    * @param {TimeFormat} config.timeFormat - The timeFormat for time value
    */
   constructor(config) {
+    super();
     this.config = config;
   }
   /**
    * It checks if the input is a valid time string.
    *
    * @param {string} input - The value of the input field.
-   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
+   * @returns {EvaluateResult} An object with two properties: isValid and message.
    */
   evaluate(input) {
     if (!this.isAcceptedInputType(input)) {

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

@@ -1,9 +1,10 @@
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
- * A rule that checks if toggle switch is required to switch on
+ * A rule that checks if the toggle switch is required to switch on
  *
- * @implements {FormFieldValidationRule<boolean>}
+ * @augments {InternalFormFieldValidationRule<boolean>}
  */
-export class ToggleSwitchRequiredRule {
+export class ToggleSwitchRequiredRule extends InternalFormFieldValidationRule {
   /**
    * If the input is a boolean, return a boolean. If the
    * input is anything else, return false

package/dist/collection/helpers/validator/rules/valid-credit-card-number-rule.js

@@ -1,11 +1,12 @@
 import { AmexRegex, DiscoverRegex, MasterCardRegex, VisaRegex } from '../../../constants/regex';
 import { mapParityDigits, mapStringToNumberArray, sum } from '../../../utils/number';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if it's a valid credit card number
  *
- * @implements {FormFieldValidationRule<string>}
+ * @augments {InternalFormFieldValidationRule<string>}
  */
-export class ValidCreditCardNumberRule {
+export class ValidCreditCardNumberRule extends InternalFormFieldValidationRule {
   /**
    * It takes a string, maps it to an array of numbers, reverses the array, checks the length of the
    * array, maps the even digits to a new array, sums the new array, and returns true if the sum is

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

@@ -1,12 +1,15 @@
 import { getCountryCallingCode, parsePhoneNumber } from 'libphonenumber-js';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if it's a valid phone number
  *
- * @implements {FormFieldValidationRule<string>}
+ * @augments {InternalFormFieldValidationRule<string>}
  */
-export class ValidPhoneNumberRule {
-  constructor(countryCodeGetter) {
+export class ValidPhoneNumberRule extends InternalFormFieldValidationRule {
+  constructor(countryCodeGetter, emptyValueEnabled = false) {
+    super();
     this.countryCodeGetter = countryCodeGetter;
+    this.emptyValueEnabled = emptyValueEnabled;
     /**
      * Generate an invalid result
      *
@@ -66,9 +69,13 @@ export class ValidPhoneNumberRule {
    * specific country calling code.
    * @returns {boolean} a boolean value based on whether the input is a string and not equal to the country calling
    * code with a plus sign appended to it.
+   * The input is empty mean the component property `emptyValueEnabled` is true, we should not validate the input.
    */
   isAcceptedInputType(input) {
-    return typeof input === 'string' && input !== `+${getCountryCallingCode(this.countryCodeGetter())}`;
+    const shouldSkipEmptyValueCheck = this.emptyValueEnabled && input === '';
+    return (typeof input === 'string' &&
+      input !== `+${getCountryCallingCode(this.countryCodeGetter())}` &&
+      !shouldSkipEmptyValueCheck);
   }
   /**
    * The function `isValidPhoneNumberForCountry` validates a phone number for a specific country code.

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

@@ -0,0 +1,7 @@
+import { FileUploaderRequiredRule } from '../../rules/file-uploader-required-rule';
+test('return result as expect when call FileUploaderRequiredRule#checkArrayItemType', () => {
+  const rule = new FileUploaderRequiredRule();
+  expect(rule.checkArrayItemType({ key: '1', name: 'test.svg', url: '' })).toBeTruthy();
+  expect(rule.checkArrayItemType(null)).toBeFalsy();
+  expect(rule.checkArrayItemType('Test')).toBeFalsy();
+});

package/dist/collection/helpers/validator/test/rules/public-rules.test.js

@@ -0,0 +1,80 @@
+import { RequiredFieldRule, CheckBoxRequiredRule, DateRequiredRule, InputPhoneNumberRequiredRule, InputRangeRequiredRule, RichTextEditorRequiredRule, TimeRangeRequiredRule, ToggleSwitchRequiredRule, FileUploaderRequiredRule, TimeRequiredRule, } from '../../../../index';
+describe('public validation rules', () => {
+  test('required field rule should be extendable', () => {
+    const mockCanEvaluate = jest.fn();
+    const mockShouldShowError = jest.fn();
+    const mockEvaluate = jest.fn();
+    class CustomRequiredRule extends RequiredFieldRule {
+      constructor(fieldName) {
+        super();
+        this.fieldName = fieldName;
+      }
+      canEvaluate(input) {
+        return mockCanEvaluate(input);
+      }
+      shouldShowError(status) {
+        return mockShouldShowError(status);
+      }
+      evaluate(input) {
+        return mockEvaluate(input);
+      }
+    }
+    const customRequiredRule = new CustomRequiredRule('Name');
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('check box required rule should be extendable', () => {
+    class CustomRequiredRule extends CheckBoxRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule();
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('date required rule should be extendable', () => {
+    class CustomRequiredRule extends DateRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule({ mode: 'single' });
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('input phone number required rule should be extendable', () => {
+    class CustomRequiredRule extends InputPhoneNumberRequiredRule {
+    }
+    const mockPhoneNumberInputValueGetter = jest.fn();
+    const customRequiredRule = new CustomRequiredRule(mockPhoneNumberInputValueGetter);
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('input range required rule should be extendable', () => {
+    class CustomRequiredRule extends InputRangeRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule();
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('rich text editor required rule should be extendable', () => {
+    class CustomRequiredRule extends RichTextEditorRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule();
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('time range required rule should be extendable', () => {
+    class CustomRequiredRule extends TimeRangeRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule({ timeFormat: '24-hour' });
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('time required rule should be extendable', () => {
+    class CustomRequiredRule extends TimeRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule({ timeFormat: '24-hour' });
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('toggle switch required rule should be extendable', () => {
+    class CustomRequiredRule extends ToggleSwitchRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule();
+    expect(customRequiredRule).toBeDefined();
+  });
+  it('file uploader required rule should be extendable', () => {
+    class CustomRequiredRule extends FileUploaderRequiredRule {
+    }
+    const customRequiredRule = new CustomRequiredRule();
+    expect(customRequiredRule).toBeDefined();
+  });
+});

package/dist/collection/helpers/validator/test/rules/valid-phone-number-rule.test.js

@@ -74,4 +74,12 @@ describe('ValidPhoneNumberRule', () => {
       visible: true,
     })).toEqual(false);
   });
+  test('should return false when the input is empty', () => {
+    const rule = new ValidPhoneNumberRule(() => 'US', true);
+    expect(rule.canEvaluate('')).toBeFalsy();
+  });
+  test('should return true when the input is not empty', () => {
+    const rule = new ValidPhoneNumberRule(() => 'US', true);
+    expect(rule.canEvaluate('1')).toBeTruthy();
+  });
 });

package/dist/collection/index.js

@@ -3,3 +3,4 @@ export * from './utils/public-api';
 export * from './constants/public-api';
 export * from './helpers/public-api';
 export * from './types/public-api';
+export * from './helpers/validator/public-rules';

package/dist/esm/{app-globals-4cca4a96.js → app-globals-88fa3549.js}

@@ -1,16 +1,15 @@
 import { F as FeatureFlag } from './feature-flag-controller-4b3fe6f8.js';
 import { V as VegaLoader, a as VegaNotify, b as VegaEventManager, c as VegaZIndexManager, d as VegaSkeletonLoader } from './vega-skeleton-loader-controller-5aea7aeb.js';
-import { V as VegaThemeManager } from './node-annotation.abstract-b2e36bc4.js';
+import { V as VegaThemeManager, a as VegaRTEContent } from './content-state-2edba4ec.js';
 import { M as MapToComponentMethod, V as VegaSlimmer, s as setVegaLogLevel, G as GlobalSlimmersRegistry } from './global-slimmer-registry-17c4efd4.js';
 import { V as VegaDialog } from './vega-dialog-controller-34eb8967.js';
 import { v as vegaEnvManager } from './vega-env-manager-8f8dc473.js';
 import { V as VegaIconManager } from './icon-manager-b889176b.js';
-import { w as waitForVega } from './index-6e05b241.js';
+import { w as waitForVega } from './index-d172bafa.js';
 import './ui-62e4be97.js';
 import { V as VegaInternalTranslation, a as VegaTranslation, s as staticTranslations } from './translation-c08f2274.js';
 import { T as TypographyUrls } from './typography-396de03f.js';
-import { V as ValidCreditCardNumberRule } from './valid-credit-card-number-rule-2aef3ad5.js';
-import { V as VegaRTEContent } from './content-state-ccf5f960.js';
+import { V as ValidCreditCardNumberRule } from './valid-credit-card-number-rule-cc497bec.js';
 import { U as UPDATE_TRANSLATION } from './static-subject-title-8268945e.js';
 import { C as ChangeManager } from './change-manager-6a7eb88c.js';
 import { O as Observer } from './observer-3959f9dd.js';
@@ -175,6 +174,7 @@ function appGlobalScript () {
   injectVegaSkeletonLoaderIntoGlobal();
   injectVegaTranslationIntoGlobal();
   injectVegaRichTextEditorClassIntoGlobal();
+  injectVegaPublicValidationRules();
 }
 /**
  * Disable feature flags from the client global defined lists.
@@ -307,6 +307,16 @@ function injectVegaTranslationIntoGlobal() {
 function injectVegaRichTextEditorClassIntoGlobal() {
   globalThis.VegaRTEContent = VegaRTEContent;
 }
+/**
+ * Inject VegaPublicValidationRules to global as a public api
+ */
+function injectVegaPublicValidationRules() {
+  void import('./public-rules-413f6a17.js').then((module) => {
+    Object.entries(module).forEach(([name, value]) => {
+      globalThis[name] = value;
+    });
+  });
+}
 
 const globalScripts = appGlobalScript;
 

package/dist/esm/check-box-required-rule-cb0aa339.js

@@ -0,0 +1,68 @@
+import { I as InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract-f5b6bdbf.js';
+
+/**
+ * A rule that checks if a string is empty or not
+ *
+ * @augments {InternalFormFieldValidationRule<string>}
+ */
+class CheckBoxRequiredRule extends InternalFormFieldValidationRule {
+  /**
+   * If the input is a boolean, return a boolean. If the input is a string, return a boolean. If the
+   * 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.
+   */
+  evaluate(input) {
+    if (typeof input === 'boolean') {
+      return {
+        isValid: input,
+        message: input ? '' : 'This field is required',
+      };
+    }
+    else if (typeof input === 'string') {
+      return {
+        isValid: input !== '',
+        message: input !== '' ? '' : 'This field is required',
+      };
+    }
+    else {
+      return {
+        isValid: false,
+        message: 'This field is required',
+      };
+    }
+  }
+  /**
+   * If the input is accepted and the status is not disabled and visible, then return true
+   *
+   * @param {unknown} input - The input to be evaluated.
+   * @param {FormFieldStatusMeta} [status] - FormFieldStatusMeta
+   * @returns {boolean} The return value is a boolean that indicates whether the input can be evaluated.
+   */
+  canEvaluate(input, status) {
+    return status
+      ? this.isAcceptedInputType(input) && !status.disabled && status.visible
+      : this.isAcceptedInputType(input);
+  }
+  /**
+   * If the field is not disabled, visible, and has been touched or modified, then show the error
+   *
+   * @param {FormFieldStatusMeta} status - FormFieldStatusMeta
+   * @returns {boolean} A boolean value.
+   */
+  shouldShowError(status) {
+    return !status.disabled && status.visible && (status.touched || status.modified);
+  }
+  /**
+   * If the input is a string, number, boolean, or null, return true, otherwise return false.
+   *
+   * @param {unknown} input - The input value to be validated.
+   * @returns {boolean} a boolean value.
+   */
+  isAcceptedInputType(input) {
+    return typeof input === 'string' || typeof input === 'boolean' || input === null;
+  }
+}
+
+export { CheckBoxRequiredRule as C };