@chargehive/types 2.5.0 → 2.6.0

package/chargehive.d.ts

@@ -4,7 +4,7 @@ import {
   PCIBridgeTokenizeEphemeralResponse,
   PCIBridgeTokenizeResponse,
 } from '@pci-bridge/types/pcibridge';
-import {FieldValidation} from '@pci-bridge/types/validation';
+import {Validation, ValidationEventData} from './validation';
 import {Address, Person} from './address';
 
 type EmptyObject = Record<string, never>;
@@ -47,7 +47,11 @@ export interface ChargeHiveType extends ChargeType, ChargeHiveEventTarget
 
   getInitResponse(): InitResponse | undefined;
 
-  validate(field?: FieldName, timeout?: number): Promise<Map<FieldName, FieldValidation>>;
+  addValidator(fn: Validator): void;
+
+  assertValid(): Promise<void>;
+
+  validate(field?: FieldName, timeout?: number): Promise<Map<FieldName, Validation>>;
 
   tokenize(): Promise<TokenizeResponse>;
 
@@ -286,6 +290,7 @@ export type EventName = PCIBEventName
   | 'method-type-changed'
   | 'charge-id'
   | 'capability'
+  | 'validation'
   | 'google-pay-ready';
 
 export type ChargeHiveEvent<T extends EventName = EventName> = {
@@ -320,6 +325,8 @@ export type ChargeHiveEventData = {
   readonly 'tokenize-ephemeral': unknown;
   readonly 'field-validation': unknown;
   readonly 'field-changed': unknown;
+
+  readonly 'validation': ValidationEventData;
 }
 
 export type ChargehiveTokenEvent = TokenizeResponse

package/package.json

@@ -8,5 +8,5 @@
   "dependencies": {
     "@pci-bridge/types": "*"
   },
-  "version": "2.5.0"
+  "version": "2.6.0"
 }

package/validation.d.ts

@@ -1,10 +1,21 @@
 import {
   FieldValidation as PCIBFieldValidation,
-  CardFieldValidation as PCIBCardFieldValidation,
+  CardFieldValidation as PCIBCardFieldValidation, ValidationState,
 } from '@pci-bridge/types/validation';
+import {FieldName} from './chargehive';
 
-export type FieldValidation = PCIBFieldValidation
+export type ValidationEventData = Map<FieldName, Validation>;
 
-export type CardFieldValidation = PCIBCardFieldValidation
+export type Validator = () => Promise<Validations>;
 
-export type ValidationEvent = CustomEvent<FieldValidation | CardFieldValidation>;
+export type Validation = {
+  isValid: boolean;
+  isPotentiallyValid: boolean;
+  validationState: ValidationState;
+};
+
+export type FieldValidation = Validation & PCIBFieldValidation
+
+export type CardFieldValidation = Validation & PCIBCardFieldValidation
+
+export type ValidationEvent = CustomEvent<ValidationEventData>;