@chargehive/types 2.4.11 → 2.4.13

package/chargehive.d.ts

@@ -29,7 +29,7 @@ export interface ChargeHiveEventTarget extends Omit<EventTarget, 'dispatchEvent'
     options?: EventListenerOptions | boolean,
   ): void;
 
-  triggerEvent(type: EventName, data?: object);
+  triggerEvent<E extends ChargeHiveEventType>(type: E, data?: ChargeHiveEventData[E]): void;
 }
 
 export interface ChargeHiveType extends ChargeType, ChargeHiveEventTarget
@@ -120,7 +120,7 @@ export interface InitResponse
   sandboxMode: boolean;
   country: string;
   currency: string;
-  /** @deprecated */
+  /** @internal this should not be used to determine whether a capability is usable in this session */
   capabilities: PaymentMethodType[];
   defaultPaymentType: PaymentMethodType;
   walletOptions: WalletOptionsResponse;
@@ -287,7 +287,7 @@ export type EventName = PCIBEventName
   | 'capability'
   | 'google-pay-ready';
 
-export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication' | 'error' | 'token-config'>
+export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication' | 'error' | 'token-config' | 'charge-id' | 'method-type-changed'>
 
 export type TransactionResponse = {
   responseCode: string;
@@ -301,53 +301,65 @@ export type TransactionResponse = {
   specificErrors: TransactionResponse[];
 }
 
-export type ChargeHiveEventData = {
-  token: {
-    name: string;
-    scheme: string;
-    expiry: string;
-    token: string;
-    additionalData: Dictionary;
-    connectorId: string;
-    customerError: string;
-    merchantError: string;
-  }
-  success: {
-    chargeId: string;
-    transactionId: string;
-    transactedAmount: {
-      currency: string;
-      units: number;
-    };
-    responseBreakdown: TransactionResponse;
-  }
-  declined: {
-    chargeId: string;
-    message: string;
-    responseCode: string;
-    paymentScheme: string;
-    responseBreakdown: TransactionResponse;
-  }
-  authentication: {
-    environment: string;
-    type: string;
-    connector: string;
-    connectorData: Dictionary;
-    paymentType: string;
-  }
-  error: object;
+export type ChargeHiveEventData = { [key in EventName]: unknown } & {
+  'token': ChargehiveTokenEvent;
+  'success': ChargehiveSuccessEvent;
+  'declined': ChargehiveDeclinedEvent;
+  'authentication': AuthenticationEvent;
+  'error': object;
   'token-config': PaymentMethodTokenizationConfig[PaymentMethodType];
-  capability: {
-    type: PaymentMethodType;
-    data?: object;
+  'capability': ChargehiveCapabilityEvent;
+  'method-type-changed': ChargehiveMethodTypeChangedEvent;
+  'charge-id': string;
+}
+
+export type ChargehiveTokenEvent = TokenizeResponse
+
+interface ChargehiveSuccessEvent
+{
+  chargeId: string;
+  transactionId: string;
+  transactedAmount: {
+    currency: string;
+    units: number;
   };
+  responseBreakdown: TransactionResponse;
 }
 
-export type CapabilityResult = {
+interface ChargehiveDeclinedEvent
+{
+  chargeId: string;
+  message: string;
+  responseCode: string;
+  paymentScheme: string;
+  responseBreakdown: TransactionResponse;
+}
+
+interface CapabilityResult
+{
   result: boolean;
   data?: object;
 }
 
+interface ChargehiveMethodTypeChangedEvent
+{
+  type: PaymentMethodType;
+}
+
+interface ChargehiveCapabilityEvent extends CapabilityResult
+{
+  type: PaymentMethodType;
+}
+
+interface AuthenticationEvent
+{
+  environment: string;
+  type: string;
+  connector: string;
+  connectorData: Dictionary;
+  paymentType: string;
+}
+
 export type Dictionary = { [key: string]: string };
 
 export interface AuthorizeResponse

package/package.json

@@ -6,8 +6,7 @@
     "*.d.ts"
   ],
   "dependencies": {
-    "typescript": "^3 || ^4",
     "@pci-bridge/types": "*"
   },
-  "version": "2.4.11"
+  "version": "2.4.13"
 }