feat(payment): CHECKOUT-3031 Add Braintree & VisaCheckout types for VisaCheckout

Author: icatalina

src/payment/strategies/braintree/braintree.ts

@@ -1,8 +1,12 @@
+
+import { VisaCheckoutInitOptions, VisaCheckoutPaymentSuccessPayload, VisaCheckoutTokenizedPayload } from './visacheckout';
+
 export interface BraintreeSDK {
     client?: BraintreeClientCreator;
     dataCollector?: BraintreeDataCollectorCreator;
     paypal?: BraintreePaypalCreator;
     threeDSecure?: BraintreeThreeDSecureCreator;
+    visaCheckout?: BraintreeVisaCheckoutCreator;
 }
 
 export interface BraintreeModuleCreator<T> {
@@ -19,6 +23,7 @@ export interface BraintreeClientCreator extends BraintreeModuleCreator<Braintree
 export interface BraintreeDataCollectorCreator extends BraintreeModuleCreator<BraintreeDataCollector> {}
 export interface BraintreeThreeDSecureCreator extends BraintreeModuleCreator<BraintreeThreeDSecure> {}
 export interface BraintreePaypalCreator extends BraintreeModuleCreator<BraintreePaypal> {}
+export interface BraintreeVisaCheckoutCreator extends BraintreeModuleCreator<BraintreeVisaCheckout> {}
 
 export interface BraintreeModule {
     teardown(): Promise<void>;
@@ -52,6 +57,11 @@ export interface BraintreePaypal {
     tokenize(options: BraintreePaypalRequest): Promise<BraintreeTokenizePayload>;
 }
 
+export interface BraintreeVisaCheckout extends BraintreeModule {
+    tokenize(payment: VisaCheckoutPaymentSuccessPayload): Promise<VisaCheckoutTokenizedPayload>;
+    createInitOptions(options: Partial<VisaCheckoutInitOptions>): VisaCheckoutInitOptions;
+}
+
 export interface BraintreeTokenizeReturn {
     close(): void;
     focus(): void;

src/payment/strategies/braintree/visacheckout.ts

@@ -0,0 +1,135 @@
+export interface VisaCheckoutAddress {
+    countryCode?: string;
+    extendedAddress?: string;
+    firstName?: string;
+    lastName?: string;
+    locality?: string;
+    postalCode?: string;
+    region?: string;
+    streetAddress?: string;
+    phoneNumber?: string;
+}
+
+export interface VisaCheckoutUserData {
+    userEmail: string;
+    userFirstName: string;
+    userLastName: string;
+    userFullName: string;
+    userName: string;
+}
+
+export interface VisaCheckoutTokenizedPayload {
+    nonce: string;
+    details: {
+        cardType: string;
+        lastFour: string;
+        lastTwo: string;
+    };
+    description: string;
+    type: string;
+    billingAddress: VisaCheckoutAddress;
+    shippingAddress?: VisaCheckoutAddress;
+    userData: VisaCheckoutUserData;
+    binData: {
+        commercial: string;
+        countryOfIssuance: string;
+        debit: string;
+        durbinRegulated: string;
+        healthcare: string;
+        issuingBank: string;
+        payroll: string;
+        prepaid: string;
+        productId: string;
+    };
+}
+
+interface EventMap {
+    'payment.success'(payment: VisaCheckoutPaymentSuccessPayload): void;
+    'payment.error'(payment: VisaCheckoutPaymentSuccessPayload, Error: Error): void;
+}
+
+export interface VisaCheckoutSDK {
+    init(options: VisaCheckoutInitOptions): {};
+    on<EventType extends keyof EventMap>(eventType: EventType, callback: EventMap[EventType]): {};
+}
+
+export type CardType = 'VISA' | 'MASTERCARD' | 'AMEX' | 'DISCOVER' | 'ELECTRON' | 'ELO';
+
+export interface VisaCheckoutInitOptions {
+    apikey: string;
+    referenceCallID?: string;
+    externalProfileId?: string;
+    externalClientId?: string;
+    settings?: {
+        locale?: string;
+        countryCode?: string;
+        displayName?: string;
+        websiteUrl?: string;
+        customerSupportUrl?: string;
+        shipping?: {
+            acceptedRegions?: string;
+            collectShipping?: boolean;
+        };
+        review?: {
+            message?: string;
+            buttonAction?: 'Continue' | 'Pay';
+        };
+        payment?: {
+            cardBrands?: CardType[];
+            acceptCanadianVisaDebit?: boolean;
+            billingCountries?: string;
+        };
+        threeDSSetup?: {
+            threeDSActive?: false;
+            threeDSSuppressChallenge?: boolean;
+        };
+        dataLevel?: 'SUMMARY' | 'FULL' | 'NONE';
+        currencyFormat?: string;
+        enableUserDataPrefill?: boolean;
+    };
+    paymentRequest: {
+        merchantRequestId?: string;
+        currencyCode?: string;
+        subtotal: string;
+        shippingHandling?: string;
+        tax?: string;
+        discount?: string;
+        giftWrap?: string;
+        misc?: string;
+        total?: string;
+        orderId?: string;
+        description?: string;
+        promoCode?: string;
+        customData?: {
+            [key: string]: any;
+        }
+    };
+}
+
+export interface VisaCheckoutPaymentSuccessPayload {
+    callid: string;
+    responseStatus: VisaCheckoutResponseStatus;
+    encKey: string;
+    encPaymentData: string;
+    partialShippingAddress: {
+        countryCode: string;
+        postalCode: string;
+    };
+    paymentMethodType: 'PAN' | 'TOKEN';
+
+}
+
+export interface VisaCheckoutPaymentCancelledPayload {
+    callid: string;
+}
+
+export interface VisaCheckoutResponseStatus {
+    status: number;
+    code: number;
+    severity?: 'ERROR' | 'WARNING';
+    message: string;
+}
+
+export interface VisaCheckoutHostWindow extends Window {
+    V?: VisaCheckoutSDK;
+}