@chargehive/types 2.4.16 → 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>;
@@ -12,7 +12,7 @@ type EmptyObject = Record<string, never>;
 declare global
 {
   // noinspection ES6ConvertVarToLetConst
-  var ChargeHive: ChargeHiveType; // eslint-disable-line no-var
+  var ChargeHive: ChargeHiveType;
 }
 
 declare type FieldName = PCIBFieldName;
@@ -29,7 +29,7 @@ export interface ChargeHiveEventTarget extends Omit<EventTarget, 'dispatchEvent'
     options?: EventListenerOptions | boolean,
   ): void;
 
-  triggerEvent<E extends ChargeHiveEventType>(type: E, data?: ChargeHiveEventData[E]): void;
+  triggerEvent<E extends EventName>(type: E, data?: ChargeHiveEventData[E]): void;
 }
 
 export interface ChargeHiveType extends ChargeType, ChargeHiveEventTarget
@@ -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>;
 
@@ -124,7 +128,7 @@ export interface InitResponse
   capabilities: PaymentMethodType[];
   defaultPaymentType: PaymentMethodType;
   walletOptions: WalletOptionsResponse;
-  riskCheckers: { [key: string]: RiskChecker };
+  riskCheckers: { [key: string]: RiskChecker; };
 }
 
 export type RiskChecker = {
@@ -142,63 +146,65 @@ export type PaymentMethodType =
 export type PaymentMethodDataTypes = {
   PLACEMENT_CAPABILITY_TOKEN: {
     token: string;
-  }
-  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeResponse
-  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  };
+  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeResponse;
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject;
   PLACEMENT_CAPABILITY_APPLE_PAY:
-    { token: ApplePayJS.ApplePayPaymentToken } |
+    { token: ApplePayJS.ApplePayPaymentToken; } |
     {
       initiativeContext: string;
       sessionUrl: string;
-    }
-  PLACEMENT_CAPABILITY_GOOGLE_PAY: google.payments.api.PaymentData
+    };
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: google.payments.api.PaymentData;
   PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {
     accountName: string;
     accountNum: string;
     sortCode: string;
     payerReference: string;
-  }
+  };
 };
 
 export type PaymentMethodEphemeralDataTypes = {
-  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
-  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeEphemeralResponse
-  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
-  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject
-  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject;
+  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeEphemeralResponse;
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject;
+  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject;
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject;
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject;
 };
 
 export type PaymentMethodEphemeralTokenizationConfig = {
-  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
-  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject
-  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
-  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject
-  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject;
+  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject;
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject;
+  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject;
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject;
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject;
 };
 
 export type PaymentMethodTokenizationConfig = {
-  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
-  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
-  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject;
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject;
+  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject;
   PLACEMENT_CAPABILITY_APPLE_PAY: {
     Session?: string;
     InitiativeContext?: string;
     SessionUrl?: string;
-  }
+  };
   PLACEMENT_CAPABILITY_GOOGLE_PAY: {
     environment?: string;
     googlePayConfig?: google.payments.api.PaymentDataRequest | string;
     token?: string;
-  }
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+  };
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject;
 }
 
 export type PaymentMethodAuthenticationTypes = {
   cvv: string;
 }
 
+export type ChallengeWindowSize = '01' | '02' | '03' | '04' | '05';
+
 export type ChargeEnvironment =
   | 'CHARGE_ENVIRONMENT_RETAIL'
   | 'CHARGE_ENVIRONMENT_ECOMMERCE'
@@ -223,7 +229,7 @@ export interface ChargeData
   language?: string;
   meta?: ChargeMeta;
   connectorId?: string;
-  challengeWindowSize?: string;
+  challengeWindowSize?: ChallengeWindowSize;
 }
 
 export interface ChargeType
@@ -251,24 +257,24 @@ export interface ChargeType
 
 export interface OrderItem
 {
-  subscriptionId: string;
-  renewalNumber: number;
-  duration: number;
-  startDate: number;
-  endDate: number;
-  productType: number;
-  skuType: number;
-  deliveryType: number;
+  subscriptionId?: string;
+  renewalNumber?: number;
+  duration?: number;
+  startDate?: number;
+  endDate?: number;
+  productType?: number;
+  skuType?: number;
+  deliveryType?: number;
   quantity?: number;
   unitPrice: number;
   taxAmount?: number;
   discountAmount?: number;
   name: string;
-  description: string;
-  productCode: string;
-  skuCode: string;
-  termType: number;
-  termUnits: number;
+  description?: string;
+  productCode?: string;
+  skuCode?: string;
+  termType?: number;
+  termUnits?: number;
 }
 
 export type EventName = PCIBEventName
@@ -281,36 +287,46 @@ export type EventName = PCIBEventName
   | 'cancel'
   | 'authentication'
   | 'ready'
-  | 'paste'
   | 'method-type-changed'
   | 'charge-id'
   | 'capability'
+  | 'validation'
   | 'google-pay-ready';
 
-export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication' | 'error' | 'token-config' | 'charge-id' | 'method-type-changed'>
-
-export type TransactionResponse = {
-  responseCode: string;
-  responseMessage: string;
-  merchantMessage: string;
-  failureType: string;
-  category: string;
-  errorType: string;
-  errorProperties: Dictionary;
-  originatingCode: string;
-  specificErrors: TransactionResponse[];
+export type ChargeHiveEvent<T extends EventName = EventName> = {
+  type: T;
+  data: ChargeHiveEventData[T];
 }
 
-export type ChargeHiveEventData = { [key in EventName]: unknown } & {
-  'token': ChargehiveTokenEvent;
-  'success': ChargehiveSuccessEvent;
-  'declined': ChargehiveDeclinedEvent;
-  'authentication': AuthenticationEvent;
-  'error': object;
-  'token-config': PaymentMethodTokenizationConfig[PaymentMethodType];
-  'capability': ChargehiveCapabilityEvent;
-  'method-type-changed': ChargehiveMethodTypeChangedEvent;
-  'charge-id': string;
+export type ChargeHiveEventData = {
+  readonly 'token': ChargehiveTokenEvent;
+  readonly 'success': ChargehiveSuccessEvent;
+  readonly 'declined': ChargehiveDeclinedEvent;
+  readonly 'authentication': AuthenticationEvent;
+  readonly 'error': object;
+  readonly 'token-config': PaymentMethodTokenizationConfig[PaymentMethodType];
+  readonly 'capability': ChargehiveCapabilityEvent;
+  readonly 'method-type-changed': ChargehiveMethodTypeChangedEvent;
+  readonly 'charge-id': string;
+
+  readonly 'init': InitResponse;
+  readonly 'cancel': undefined;
+  readonly 'ready': undefined;
+  readonly 'google-pay-ready': undefined;
+
+  /* pcib */
+  readonly 'focus': unknown;
+  readonly 'focusin': unknown;
+  readonly 'focusout': unknown;
+  readonly 'blur': unknown;
+  readonly 'paste': unknown;
+  readonly 'field-ready': unknown;
+  readonly 'tokenize': unknown;
+  readonly 'tokenize-ephemeral': unknown;
+  readonly 'field-validation': unknown;
+  readonly 'field-changed': unknown;
+
+  readonly 'validation': ValidationEventData;
 }
 
 export type ChargehiveTokenEvent = TokenizeResponse
@@ -360,7 +376,7 @@ interface AuthenticationEvent
   paymentType: string;
 }
 
-export type Dictionary = { [key: string]: string };
+export type Dictionary = { [key: string]: unknown; };
 
 export interface AuthorizeResponse
 {
@@ -368,13 +384,19 @@ export interface AuthorizeResponse
   message: string;
   continuationId: string;
   chargeId: string;
-  events: ChargeHiveEvent<ChargeHiveEventType>[];
+  events: ChargeHiveEvent[];
 }
 
-export interface ChargeHiveEvent<T extends ChargeHiveEventType>
-{
-  type: T;
-  data: ChargeHiveEventData[T];
+export type TransactionResponse = {
+  responseCode: string;
+  responseMessage: string;
+  merchantMessage: string;
+  failureType: string;
+  category: string;
+  errorType: string;
+  errorProperties: Dictionary;
+  originatingCode: string;
+  specificErrors: TransactionResponse[];
 }
 
 export interface TokenizeResponse
@@ -435,8 +457,8 @@ export interface WalletOptionsResponse
 
       allowedCardNetworks?: string[];
 
-      parameters: Dictionary,
-    }]
+      parameters: Dictionary;
+    }];
   };
 
   applePay: {
@@ -455,4 +477,11 @@ export interface WalletOptionsResponse
     supportedNetworks: string[];
     merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
   };
+
+  paypal: {
+    connectorId: string;
+    connectorLibrary: string;
+    clientId: string;
+    merchantId: string;
+  };
 }

package/package.json

@@ -8,5 +8,5 @@
   "dependencies": {
     "@pci-bridge/types": "*"
   },
-  "version": "2.4.16"
+  "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>;