@chargehive/types 2.1.29 → 2.2.1

package/chargehive.d.ts

@@ -8,13 +8,12 @@ import {FieldValidation} from '@pci-bridge/types/validation';
 import {Address, Person} from './address';
 import ApplePayPaymentToken = ApplePayJS.ApplePayPaymentToken;
 
+type EmptyObject = Record<string, never>;
+
 declare global
 {
-  /* eslint-disable no-var */
-  // @ts-ignore
   // noinspection ES6ConvertVarToLetConst
-  var ChargeHive: ChargeHiveType;
-  /* eslint-enable no-var */
+  var ChargeHive: ChargeHiveType; // eslint-disable-line no-var
 }
 
 declare type FieldName = PCIBFieldName;
@@ -66,6 +65,30 @@ export interface ChargeHiveType extends ChargeType, ChargeHiveEventTarget
   setPaymentMethod<T extends PaymentMethodType>(type: T, data?: object | PaymentMethodDataTypes[T]): void;
 }
 
+export interface WalletOptions
+{
+  /**
+   * @default true
+   */
+  requireEmail?: boolean;
+  /**
+   * @default true
+   */
+  requireBillingAddress?: boolean;
+  /**
+   * @default false
+   */
+  requireBillingPhone?: boolean;
+  /**
+   * @default false
+   */
+  requireShippingAddress?: boolean;
+  /**
+   * @default false
+   */
+  requireShippingPhone?: boolean;
+}
+
 export interface ChargeHiveInitOptions
 {
   projectId: string;
@@ -75,6 +98,7 @@ export interface ChargeHiveInitOptions
   country: string;
   currency: string;
   environment?: ChargeEnvironment;
+  walletOptions?: WalletOptions;
 }
 
 export interface InitResponse
@@ -104,7 +128,7 @@ export type PaymentMethodDataTypes = {
     token: string;
   }
   PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeResponse
-  PLACEMENT_CAPABILITY_PAYPAL: {}
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
   PLACEMENT_CAPABILITY_APPLE_PAY: {
     initiativeContext?: string;
     sessionUrl?: string;
@@ -126,27 +150,27 @@ export type PaymentMethodDataTypes = {
 };
 
 export type PaymentMethodEphemeralDataTypes = {
-  PLACEMENT_CAPABILITY_TOKEN: {}
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
   PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeEphemeralResponse
-  PLACEMENT_CAPABILITY_PAYPAL: {}
-  PLACEMENT_CAPABILITY_APPLE_PAY: {}
-  PLACEMENT_CAPABILITY_GOOGLE_PAY: {}
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {}
+  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: {}
-  PLACEMENT_CAPABILITY_CARD_FORM: {}
-  PLACEMENT_CAPABILITY_PAYPAL: {}
-  PLACEMENT_CAPABILITY_APPLE_PAY: {}
-  PLACEMENT_CAPABILITY_GOOGLE_PAY: {}
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {}
+  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: {}
-  PLACEMENT_CAPABILITY_PAYPAL: {}
-  PLACEMENT_CAPABILITY_CARD_FORM: {}
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject
   PLACEMENT_CAPABILITY_APPLE_PAY: {
     Session?: string;
     InitiativeContext?: string;
@@ -157,7 +181,7 @@ export type PaymentMethodTokenizationConfig = {
     googlePayConfig?: google.payments.api.PaymentDataRequest | string;
     token?: string;
   }
-  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {}
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
 }
 
 export type PaymentMethodAuthenticationTypes = {
@@ -223,10 +247,10 @@ export interface OrderItem
   productType: number;
   skuType: number;
   deliveryType: number;
-  quantity: number;
+  quantity?: number;
   unitPrice: number;
-  taxAmount: number;
-  discountAmount: number;
+  taxAmount?: number;
+  discountAmount?: number;
   name: string;
   description: string;
   productCode: string;
@@ -238,6 +262,7 @@ export interface OrderItem
 export type EventName = PCIBEventName
   | 'init'
   | 'token'
+  | 'token-config'
   | 'success'
   | 'declined'
   | 'error'
@@ -248,7 +273,7 @@ export type EventName = PCIBEventName
   | 'method-type-changed'
   | 'charge-id';
 
-export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication'>
+export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication' | 'error' | 'token-config'>
 
 export type TransactionResponse = {
   responseCode: string;
@@ -283,11 +308,11 @@ export type ChargeHiveEventData = {
     responseBreakdown: TransactionResponse;
   }
   declined: {
-    chargeId: string
-    message: string
-    responseCode: string
-    paymentScheme: string
-    responseBreakdown: TransactionResponse
+    chargeId: string;
+    message: string;
+    responseCode: string;
+    paymentScheme: string;
+    responseBreakdown: TransactionResponse;
   }
   authentication: {
     environment: string;
@@ -296,6 +321,8 @@ export type ChargeHiveEventData = {
     connectorData: Dictionary;
     paymentType: string;
   }
+  error: object;
+  'token-config': PaymentMethodTokenizationConfig[PaymentMethodType];
 }
 
 export type Dictionary = { [key: string]: string };
@@ -306,10 +333,10 @@ export interface AuthorizeResponse
   message: string;
   continuationId: string;
   chargeId: string;
-  events: ChargeHiveEvent[];
+  events: ChargeHiveEvent<ChargeHiveEventType>[];
 }
 
-export interface ChargeHiveEvent<T extends ChargeHiveEventType = any>
+export interface ChargeHiveEvent<T extends ChargeHiveEventType>
 {
   type: T;
   data: ChargeHiveEventData[T];

package/package.json

@@ -9,5 +9,5 @@
     "typescript": "^3 || ^4",
     "@pci-bridge/types": "*"
   },
-  "version": "2.1.29"
+  "version": "2.2.1"
 }