@globalpayments/vega 2.38.0 → 2.40.0

package/dist/types/helpers/validator/rules/required-field-rule.d.ts

@@ -1,18 +1,19 @@
-import { FormFieldStatusMeta, FormFieldValidationRule, FormFieldValueType } from './form-field-validation-rule';
-import { EvaluateResultTranslation } from './validation-rule';
+import { FormFieldStatusMeta, FormFieldValueType } from './form-field-validation-rule';
+import { EvaluateResult } from './validation-rule';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if a string is empty or not
  *
- * @implements {FormFieldValidationRule<string>}
+ * @augments {InternalFormFieldValidationRule<string>}
  */
-export declare class RequiredFieldRule implements FormFieldValidationRule<FormFieldValueType | Array<FormFieldValueType>> {
+export declare class RequiredFieldRule extends InternalFormFieldValidationRule<FormFieldValueType | Array<FormFieldValueType>> {
   /**
    * If the input is a number or a boolean, return true. If the input is a string, return true if the string is not empty
    *
    * @param {FormFieldValueType | Array<FormFieldValueType>} input - The input to be evaluated.
-   * @returns {EvaluateResultTranslation} An object with two properties: isValid and message.
+   * @returns {EvaluateResult} An object with two properties: isValid and message.
    */
-  evaluate(input: FormFieldValueType | Array<FormFieldValueType>): EvaluateResultTranslation;
+  evaluate(input: FormFieldValueType | Array<FormFieldValueType>): EvaluateResult;
   /**
    * If the input is accepted and the status is not disabled and visible, then return true
    *

package/dist/types/helpers/validator/rules/rich-text-editor-required-rule.d.ts

@@ -1,19 +1,20 @@
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
-import { EvaluateResultTranslation } from './validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
+import { EvaluateResult } from './validation-rule';
 import { VegaRTEContent } from '../../../components/vega-rich-text-editor/dto/content-state';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if the input range is empty or not
  *
- * @implements {FormFieldValidationRule<string[]>}
+ * @augments {InternalFormFieldValidationRule<string[]>}
  */
-export declare class RichTextEditorRequiredRule implements FormFieldValidationRule<VegaRTEContent> {
+export declare class RichTextEditorRequiredRule extends InternalFormFieldValidationRule<VegaRTEContent> {
   /**
    * It checks if the input is a valid value.
    *
    * @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: unknown): EvaluateResultTranslation;
+  evaluate(input: unknown): EvaluateResult;
   /**
    * If the input is accepted and the status is not disabled and visible, then return true
    *

package/dist/types/helpers/validator/rules/time-range-required-rule.d.ts

@@ -1,12 +1,13 @@
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
 import { TimeFormat } from '../../../types/general';
-import { EvaluateResultTranslation } from './validation-rule';
+import { EvaluateResult } from './validation-rule';
+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 declare class TimeRangeRequiredRule implements FormFieldValidationRule<string[]> {
+export declare class TimeRangeRequiredRule extends InternalFormFieldValidationRule<string[]> {
   private readonly config;
   /**
    * It creates a new instance of the class with the given config.
@@ -21,9 +22,9 @@ export declare class TimeRangeRequiredRule implements FormFieldValidationRule<st
    * 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: unknown): EvaluateResultTranslation;
+  evaluate(input: unknown): EvaluateResult;
   /**
    * If the input is accepted and the status is not disabled and visible, then return true
    *

package/dist/types/helpers/validator/rules/time-range-rule.d.ts

@@ -1,11 +1,12 @@
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
 import { DatePickerModeType, DatePickerValueType } from '../../../components/vega-date-picker/types';
 import { TimeFormat } from '../../../types/general';
 import { EvaluateResultTranslation } from './validation-rule';
+import { InternalFormFieldValidationRule } from './internal-form-field-validation-rule.abstract';
 /**
  * A rule that checks if start time is before than end time
  */
-export declare class TimeRangeRule implements FormFieldValidationRule<DatePickerValueType<DatePickerModeType>> {
+export declare class TimeRangeRule extends InternalFormFieldValidationRule<DatePickerValueType<DatePickerModeType>> {
   private readonly config;
   /**
    * It creates a new instance of the class with the given config.

package/dist/types/helpers/validator/rules/time-required-rule.d.ts

@@ -1,12 +1,13 @@
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
 import { TimeFormat } from '../../../types/general';
-import { EvaluateResultTranslation } from './validation-rule';
+import { EvaluateResult } from './validation-rule';
+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 declare class TimeRequiredRule implements FormFieldValidationRule<string> {
+export declare class TimeRequiredRule extends InternalFormFieldValidationRule<string> {
   private readonly config;
   /**
    * It creates a new instance of the class with the given config.
@@ -21,9 +22,9 @@ export declare class TimeRequiredRule implements FormFieldValidationRule<string>
    * 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: unknown): EvaluateResultTranslation;
+  evaluate(input: unknown): EvaluateResult;
   /**
    * If the input is accepted and the status is not disabled and visible, then return true
    *

package/dist/types/helpers/validator/rules/toggle-switch-required-rule.d.ts

@@ -1,10 +1,11 @@
-import { EvaluateResult, FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { EvaluateResult, FormFieldStatusMeta } from './form-field-validation-rule';
+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 declare class ToggleSwitchRequiredRule implements FormFieldValidationRule<boolean> {
+export declare class ToggleSwitchRequiredRule extends InternalFormFieldValidationRule<boolean> {
   /**
    * If the input is a boolean, return a boolean. If the
    * input is anything else, return false

package/dist/types/helpers/validator/rules/valid-credit-card-number-rule.d.ts

@@ -1,12 +1,13 @@
 import { Primitive } from '../../../types/general';
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
 import { EvaluateResult } from './validation-rule';
+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 declare class ValidCreditCardNumberRule implements FormFieldValidationRule<Primitive | Array<Primitive>> {
+export declare class ValidCreditCardNumberRule extends InternalFormFieldValidationRule<Primitive | Array<Primitive>> {
   /**
    * 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/types/helpers/validator/rules/valid-phone-number-rule.d.ts

@@ -1,14 +1,16 @@
 import { VegaCountryCode } from '../../../components/vega-input-phone-number/types';
-import { FormFieldStatusMeta, FormFieldValidationRule } from './form-field-validation-rule';
+import { FormFieldStatusMeta } from './form-field-validation-rule';
 import { EvaluateResultTranslation } from './validation-rule';
+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 declare class ValidPhoneNumberRule implements FormFieldValidationRule<string> {
+export declare class ValidPhoneNumberRule extends InternalFormFieldValidationRule<string> {
   private readonly countryCodeGetter;
-  constructor(countryCodeGetter: () => VegaCountryCode);
+  private emptyValueEnabled;
+  constructor(countryCodeGetter: () => VegaCountryCode, emptyValueEnabled?: boolean);
   /**
    * It checks if the phone number is valid.
    *
@@ -40,6 +42,7 @@ export declare class ValidPhoneNumberRule implements FormFieldValidationRule<str
    * 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.
    */
   private isAcceptedInputType;
   /**

package/dist/types/helpers/validator/test/rules/file-uploader-required-rule.test.d.ts

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

package/dist/types/helpers/validator/test/rules/public-rules.test.d.ts

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

package/dist/types/index.d.ts

@@ -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/types/types/public-api.d.ts

@@ -2,7 +2,7 @@ export * from './components.type';
 export * from './vega-chart';
 export * from '../components/vega-calendar/types';
 export { VegaTableNode, VegaTableCellNode, VegaTableCreateElementFunction, VegaTableSorterType, VegaTableCellRenderFunction, VegaTableFormItemProps, VegaTableEditComponentProps, VegaTableCellFormItemRenderFunction, } from '../components/vega-table/interface';
-export { EvaluateResult, FormFieldStatusMeta } from '../helpers/validator/rules/form-field-validation-rule';
+export { EvaluateResult, FormFieldStatusMeta, FormFieldValueType, } from '../helpers/validator/rules/form-field-validation-rule';
 export { VegaThemeOverrideColors } from '../helpers/theme/theme';
 export { LogLevelType } from '../utils/log';
 export { VegaDialogOption } from '../helpers/dialog/vega-dialog-controller';

package/dist/vega/index.esm.js

@@ -1 +1 @@
-export{g as getCurrentBreakpoint}from"./p-4bcd6612.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-6e1ab235.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-666cd80f.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-b1f65b13.js";export{B as Breakpoints}from"./p-ed45b3b6.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{b as Typography,a as TypographyKeys,T as TypographyUrls}from"./p-d884c644.js";export{e as BoxDisplay,B as BreakpointKeys,C as CssStates,F as FlexDirections}from"./p-74168615.js";export{F as FrameworkEnum,v as VegaEnvManager}from"./p-5f377954.js";export{b as VegaEventManager,V as VegaLoader,a as VegaNotify,d as VegaSkeletonLoader,c as VegaZIndexManager}from"./p-76a8ccbb.js";export{F as FeatureFlag}from"./p-ff4bafa3.js";export{M as ModifyContentAction,R as RTENode,V as VegaThemeManager}from"./p-0461e318.js";export{V as VegaDialog}from"./p-149d2801.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-1b860f90.js";export{V as VegaIconManager}from"./p-032df16f.js";export{V as ValidCreditCardNumberRule}from"./p-74958b1a.js";export{w as waitForVega}from"./p-f86ec91b.js";export{a as VegaTranslation,s as VegaTranslationResourceEN}from"./p-483c483a.js";export{d as RTEBlock,a as RTEImageBlock,e as RTEImageNode,c as RTEListBlock,b as RTEListItemBlock,R as RTETextBlock,f as RTETextNode,V as VegaRTEContent}from"./p-52a8a4f8.js";export{G as GridColumns,a as GridRows}from"./p-7f2441d6.js";import"./p-2205ee4c.js";import"./p-3a0a4d15.js";import"./p-33b62194.js";import"./p-6a334573.js";import"./p-79ec5d69.js";import"./p-781fd6e0.js";import"./p-262ec334.js";import"./p-5f589974.js";import"./p-7a40e033.js";import"./p-112455b1.js";import"./p-5dce8dfe.js";import"./p-2d0d575f.js";import"./p-331a62d5.js";import"./p-7c37e5bb.js";import"./p-348e95ba.js";import"./p-0c667d6a.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}
+export{g as getCurrentBreakpoint}from"./p-4bcd6612.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-6e1ab235.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-666cd80f.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-b1f65b13.js";export{B as Breakpoints}from"./p-ed45b3b6.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{b as Typography,a as TypographyKeys,T as TypographyUrls}from"./p-d884c644.js";export{e as BoxDisplay,B as BreakpointKeys,C as CssStates,F as FlexDirections}from"./p-74168615.js";export{F as FrameworkEnum,v as VegaEnvManager}from"./p-5f377954.js";export{b as VegaEventManager,V as VegaLoader,a as VegaNotify,d as VegaSkeletonLoader,c as VegaZIndexManager}from"./p-76a8ccbb.js";export{F as FeatureFlag}from"./p-ff4bafa3.js";export{M as ModifyContentAction,e as RTEBlock,b as RTEImageBlock,f as RTEImageNode,d as RTEListBlock,c as RTEListItemBlock,h as RTENode,R as RTETextBlock,g as RTETextNode,a as VegaRTEContent,V as VegaThemeManager}from"./p-e0d3ca2d.js";export{V as VegaDialog}from"./p-149d2801.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-1b860f90.js";export{V as VegaIconManager}from"./p-032df16f.js";export{V as ValidCreditCardNumberRule}from"./p-6f90d444.js";export{w as waitForVega}from"./p-0cc1ad76.js";export{a as VegaTranslation,s as VegaTranslationResourceEN}from"./p-483c483a.js";export{G as GridColumns,a as GridRows}from"./p-7f2441d6.js";export{C as CheckBoxRequiredRule}from"./p-590fd123.js";export{D as DateRequiredRule}from"./p-8fae8f9e.js";export{I as InputPhoneNumberRequiredRule}from"./p-07c2725a.js";export{I as InputRangeRequiredRule}from"./p-f396c69a.js";export{R as RequiredFieldRule}from"./p-280cbcdb.js";export{R as RichTextEditorRequiredRule}from"./p-e0446879.js";export{T as TimeRangeRequiredRule,a as TimeRequiredRule}from"./p-924b4e24.js";export{T as ToggleSwitchRequiredRule}from"./p-7c0b4c36.js";export{F as FileUploaderRequiredRule}from"./p-0bb860cc.js";import"./p-2205ee4c.js";import"./p-3a0a4d15.js";import"./p-33b62194.js";import"./p-6a334573.js";import"./p-79ec5d69.js";import"./p-781fd6e0.js";import"./p-262ec334.js";import"./p-5f589974.js";import"./p-7a40e033.js";import"./p-112455b1.js";import"./p-2d0d575f.js";import"./p-7c37e5bb.js";import"./p-d2ff56d8.js";import"./p-5dce8dfe.js";import"./p-331a62d5.js";import"./p-abd7aeaa.js";import"./p-0c667d6a.js";import"./p-08835909.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}