@payrails/web-sdk 5.19.0 → 5.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payrails/web-sdk",
-  "version": "5.19.0",
+  "version": "5.20.0",
   "description": "SDK providing tokenization options on the client for merchants",
   "main": "index.js",
   "types": "payrails.d.ts",

package/payrails.d.ts

@@ -1,3 +1,4 @@
+import * as _payrails_iframe_event_bus from '@payrails/iframe-event-bus';
 import { LogLevel as LogLevel$1 } from '@payrails/logger';
 import { FraudProvider } from '@payrails/fraud-sdk';
 
@@ -516,6 +517,7 @@ declare class PayrailsElement implements Mountable {
     protected element: HTMLElement;
     protected subElements: Array<Mountable>;
     readonly id: string | undefined;
+    protected eventBus: _payrails_iframe_event_bus.IframeEventBus;
     constructor(elementType: string, { id, className }?: ElementOptions);
     get parentElement(): HTMLElement | null;
     get selector(): string;
@@ -524,6 +526,92 @@ declare class PayrailsElement implements Mountable {
     unmount(): void;
 }
 
+declare enum ElementType {
+    CARD_NUMBER = "CARD_NUMBER",
+    CARDHOLDER_NAME = "CARDHOLDER_NAME",
+    CVV = "CVV",
+    EXPIRATION_MONTH = "EXPIRATION_MONTH",
+    EXPIRATION_YEAR = "EXPIRATION_YEAR",
+    EXPIRATION_DATE = "EXPIRATION_DATE"
+}
+
+interface EncryptedCollectResult {
+    vaultProviderConfigId: string;
+    encryptedData: string;
+}
+interface CollectElementOptions {
+    type: ElementType;
+    label?: string;
+    placeholder?: string;
+    altText?: string;
+    format?: string;
+    inputStyles?: object;
+    labelStyles?: object;
+    errorTextStyles?: object;
+    required?: boolean;
+    enableCardIcon?: boolean;
+}
+type PayrailsContainerType = 'COLLECT' | 'COMPOSABLE';
+interface CollectContainerOptions {
+    layout?: number[];
+    cardTableName?: string;
+    containerType?: PayrailsContainerType;
+    styles?: {
+        base?: Partial<CSSStyleDeclaration>;
+    };
+    errorTextStyles?: {
+        base?: Partial<CSSStyleDeclaration>;
+    };
+}
+type PayrailsSecureFieldEvent = 'CHANGE' | 'FOCUS' | 'BLUR' | 'READY' | 'SUBMIT';
+interface PayrailsSecureField {
+    on(eventName: PayrailsSecureFieldEvent, handler: any): void;
+    mount?: (domElement: any) => void;
+    unmount?: () => void;
+    getState?: () => {
+        isEmpty: boolean;
+        isComplete: boolean;
+        isValid: boolean;
+        isFocused: boolean;
+        value: unknown;
+        required: boolean;
+    };
+    isValidElement?: () => boolean;
+    setError?: (clientErrorText: string) => void;
+    resetError?: () => void;
+    setValue?: (elementValue: string) => void;
+    clearValue?: () => void;
+}
+declare class PayrailsCollectContainer implements Mountable {
+    bin: string;
+    isBinLookupEnabled: boolean;
+    readonly id = "payrails-container-wrapper";
+    private static instance;
+    private readonly __container;
+    private element;
+    private readonly cardTableName;
+    private readonly containerType;
+    constructor(__client: Skyflow, options: CollectContainerOptions);
+    static init(vaultClient: Skyflow, options: CollectContainerOptions): PayrailsCollectContainer;
+    createCollectElement(options: CollectElementOptions): PayrailsSecureField;
+    mount(selector: string): void;
+    unmount(): void;
+    collect(): Promise<EncryptedCollectResult>;
+    private collectPayrailsData;
+    tokenize(opts: TokenizeOptions): Promise<SaveInstrumentResponse>;
+    private constructSaveInstrumentBody;
+    private attachCustomEventHandler;
+    private formatBin;
+    private get elementToFieldMap();
+    fetchBinLookup: (bin: string) => Promise<string | BinLookupResponse | {
+        bin: string;
+    }>;
+}
+interface TokenizeOptions {
+    futureUsage?: 'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile';
+    storeInstrument?: boolean;
+}
+
 interface IAddress {
     country?: {
         code?: string;
@@ -565,65 +653,6 @@ interface AddressSelectorElementOptions extends ElementOptions {
     };
 }
 
-interface StoreInstrumentElementOptions extends ElementOptions {
-    showStoreInstrumentCheckbox?: boolean;
-    alwaysStoreInstrument?: boolean;
-    translations?: {
-        labels?: {
-            storeInstrument?: string;
-            saveInstrument?: string;
-        };
-    };
-    styles?: {
-        storeInstrumentCheckbox?: Partial<CSSStyleDeclaration>;
-    };
-    events?: PayrailsSDKEvents;
-}
-declare class StoreInstrumentCheckbox extends PayrailsElement {
-    private options;
-    constructor(options: StoreInstrumentElementOptions);
-    get isChecked(): boolean;
-    private createHTML;
-    private applyStyles;
-    private addListeners;
-}
-declare abstract class PayrailsElementWithStoreInstrumentCheckbox extends PayrailsElement {
-    protected options?: StoreInstrumentElementOptions | undefined;
-    protected storeInstrumentCheckbox: StoreInstrumentCheckbox | null;
-    protected constructor(elementType: string, options?: StoreInstrumentElementOptions | undefined);
-    protected get shouldStoreInstrument(): boolean;
-}
-
-interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
-    clientDomain?: string;
-    showPaymentMethodLogo?: boolean;
-    events?: PaymentEvents & {
-        onApplePayAvailable?: () => void;
-    };
-    styles?: {
-        type?: 'plain' | 'buy' | 'addMoney' | 'book' | 'checkout' | 'continue' | 'contribute' | 'donate' | 'inStore' | 'order' | 'reload' | 'rent' | 'setUp' | 'subscribe' | 'support' | 'tip' | 'topUp';
-        style?: 'white' | 'whiteOutline' | 'black' | 'automatic';
-    } & StoreInstrumentElementOptions['styles'];
-}
-declare global {
-    interface Window {
-        ApplePaySession?: ApplePaySession;
-    }
-}
-declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
-    private sdkConfig;
-    protected options: ApplePayButtonOptions;
-    private appleButton;
-    private paymentExecutor;
-    static isApplePayAvailable(): Promise<boolean>;
-    constructor(sdkConfig: SdkConfiguration, options: ApplePayButtonOptions);
-    mount(location: string): void;
-    unmount(): void;
-    private mountApplePayButton;
-    private createApplePaySession;
-    private onApplePayAuthorized;
-}
-
 declare const regexes: {
     visa: RegExp;
     mastercard: RegExp;
@@ -637,15 +666,6 @@ declare const regexes: {
 };
 type CardNetwork = keyof typeof regexes;
 
-declare enum ElementType {
-    CARD_NUMBER = "CARD_NUMBER",
-    CARDHOLDER_NAME = "CARDHOLDER_NAME",
-    CVV = "CVV",
-    EXPIRATION_MONTH = "EXPIRATION_MONTH",
-    EXPIRATION_YEAR = "EXPIRATION_YEAR",
-    EXPIRATION_DATE = "EXPIRATION_DATE"
-}
-
 interface PaymentInstallmentsElementOptions extends ElementOptions {
     showPaymentInstallmentsDropdown?: boolean;
     installmentOptions?: BaseInstallmentOption[] | null;
@@ -683,6 +703,35 @@ declare class PayrailsElementWithPaymentInstallmentsDropdown extends PayrailsEle
     setDisabled(state: boolean): void;
 }
 
+interface StoreInstrumentElementOptions extends ElementOptions {
+    showStoreInstrumentCheckbox?: boolean;
+    alwaysStoreInstrument?: boolean;
+    translations?: {
+        labels?: {
+            storeInstrument?: string;
+            saveInstrument?: string;
+        };
+    };
+    styles?: {
+        storeInstrumentCheckbox?: Partial<CSSStyleDeclaration>;
+    };
+    events?: PayrailsSDKEvents;
+}
+declare class StoreInstrumentCheckbox extends PayrailsElement {
+    private options;
+    constructor(options: StoreInstrumentElementOptions);
+    get isChecked(): boolean;
+    private createHTML;
+    private applyStyles;
+    private addListeners;
+}
+declare abstract class PayrailsElementWithStoreInstrumentCheckbox extends PayrailsElement {
+    protected options?: StoreInstrumentElementOptions | undefined;
+    protected storeInstrumentCheckbox: StoreInstrumentCheckbox | null;
+    protected constructor(elementType: string, options?: StoreInstrumentElementOptions | undefined);
+    protected get shouldStoreInstrument(): boolean;
+}
+
 interface OnChange {
     isValid: boolean;
     cardNetwork: CardNetwork | '';
@@ -752,8 +801,8 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     get cardNetwork(): "" | "visa" | "mastercard" | "amex" | "diners" | "discover" | "jcb" | "hipercard" | "unionpay" | "maestro";
     onChange(): void;
     private updateInstallments;
-    collectValues<T extends TokenizedCollectResult | EncryptedCollectResult = EncryptedCollectResult>(): Promise<{
-        cardData: T;
+    collectValues(): Promise<{
+        cardData: EncryptedCollectResult;
         storeInstrument: boolean;
         selectedInstallment: number | undefined;
         enrollInstrumentToNetworkOffers: boolean;
@@ -789,6 +838,15 @@ declare class CardList extends PayrailsElement {
     reset(): void;
 }
 
+interface InitOptions {
+    version: string;
+    data: string;
+}
+interface PayrailsAmount {
+    value: string;
+    currency: string;
+}
+
 interface ReturnInfo {
     success?: string;
     cancel?: string;
@@ -821,7 +879,6 @@ interface CardPaymentButtonOptions {
     };
 }
 declare class CardPaymentButton extends PayrailsElement {
-    private readonly sdkConfig;
     private readonly options;
     private readonly returnInfo?;
     selectedInstrument: StoredPaymentInstrument | null;
@@ -829,7 +886,7 @@ declare class CardPaymentButton extends PayrailsElement {
     get bin(): string | undefined;
     private readonly paymentExecutor;
     private cardForm;
-    constructor(sdkConfig: SdkConfiguration, options: CardPaymentButtonOptions, returnInfo?: ReturnInfo | undefined);
+    constructor(options: CardPaymentButtonOptions, returnInfo?: ReturnInfo | undefined);
     setDisabled(isDisabled: boolean): void;
     setSavedCreditCard(savedCard: StoredPaymentInstrument<CardMetadata>): void;
     setSavedInstrument(savedInstrument: StoredPaymentInstrument): void;
@@ -841,7 +898,6 @@ declare class CardPaymentButton extends PayrailsElement {
     triggerLoading(isLoading: boolean): void;
     private onAuthorizationFailed;
     private onPay;
-    private constructTokenizedPayment;
     private constructEncryptedPayment;
     private handleAuthorizationResult;
 }
@@ -878,14 +934,13 @@ interface GooglePayButtonOptions extends StoreInstrumentElementOptions {
     } & StoreInstrumentElementOptions['styles'];
 }
 declare class GooglePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
-    private sdkConfig;
     protected options: GooglePayButtonOptions;
     private googleButton;
     private readonly paymentExecutor;
     private static googleSDKClient;
     private static getSDKClient;
     static isGooglePayAvailable(allowedPaymentMethods: google.payments.api.IsReadyToPayPaymentMethodSpecification[], environment?: PayrailsEnvironment, merchantInfo?: google.payments.api.MerchantInfo): Promise<boolean>;
-    constructor(sdkConfig: SdkConfiguration, options: GooglePayButtonOptions);
+    constructor(options: GooglePayButtonOptions);
     private sdkLoaded;
     private onLoadPaymentData;
     private authorize;
@@ -904,6 +959,28 @@ interface DropinElementStyles {
     active?: Partial<CSSStyleDeclaration>;
 }
 
+interface ApplePayDropinOptions extends ApplePayButtonOptions {
+    translations?: {
+        labels?: {
+            label?: string;
+            storeInstrument?: string;
+        };
+    };
+    events?: ApplePayButtonOptions['events'] & DropinElementEvents;
+    styles?: DropinElementStyles & ApplePayButtonOptions['styles'];
+}
+
+interface CrediCardDropinOptions {
+    showPaymentMethodLogo?: boolean;
+    styles?: DropinElementStyles;
+    events?: DropinElementEvents;
+    translations?: {
+        labels?: {
+            label?: string;
+        };
+    } & CardFormOptions['translations'];
+}
+
 interface ButtonOptions {
     id: string;
     events?: PayrailsSDKEvents & {
@@ -928,10 +1005,9 @@ interface GenericRedirectButtonOptions {
     paymentMethod: BasePaymentMethodConfig;
 }
 declare class GenericRedirectButton extends PayrailsElement {
-    private sdkConfig;
     protected options: GenericRedirectButtonOptions;
     private readonly returnInfo?;
-    constructor(sdkConfig: SdkConfiguration, options: GenericRedirectButtonOptions, returnInfo?: ReturnInfo | undefined);
+    constructor(options: GenericRedirectButtonOptions, returnInfo?: ReturnInfo | undefined);
     private popup;
     private buildRedirectButton;
     private readonly paymentExecutor;
@@ -982,9 +1058,8 @@ interface PaypalButtonOptions extends StoreInstrumentElementOptions {
     } & StoreInstrumentElementOptions['styles'];
 }
 declare class PaypalButton extends PayrailsElementWithStoreInstrumentCheckbox {
-    private sdkConfig;
     protected options?: PaypalButtonOptions | undefined;
-    constructor(sdkConfig: SdkConfiguration, options?: PaypalButtonOptions | undefined);
+    constructor(options?: PaypalButtonOptions | undefined);
     fraudNetGuid: string | undefined;
     private paymentExecutor;
     private button;
@@ -996,6 +1071,7 @@ declare class PaypalButton extends PayrailsElementWithStoreInstrumentCheckbox {
     private createPaypalButton;
     private createPayPalButtonConfig;
     private createBillingAgreementConfig;
+    private onCancel;
     private createOneTimeOrderConfig;
     private createBaseConfig;
     private createOneTimeOrder;
@@ -1020,14 +1096,13 @@ declare class Dropin extends PayrailsElement {
     private collectContainer;
     private readonly clientConfig;
     private readonly dropinConfig;
-    private readonly sdkConfig;
     private cardPaymentButton;
     private creditCard;
     private googlePay;
     private applePay;
     private cardForm;
     private paypal;
-    constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions, sdkConfig: SdkConfiguration);
+    constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions);
     private isHppIntegration;
     private createStoredInstrumentElement;
     private createInstallmentsDropdown;
@@ -1078,7 +1153,7 @@ interface DropinOptions {
         [key: string]: any;
         googlePayButton?: GooglePayDropinOptions['translations'];
         cardPaymentButton?: CardPaymentButtonOptions['translations'];
-        cardForm?: CardFormOptions['translations'];
+        cardForm?: CrediCardDropinOptions['translations'];
         paymentResult?: {
             success?: string;
             fail?: string;
@@ -1087,6 +1162,7 @@ interface DropinOptions {
         paypalButton?: PaypalDropinOptions['translations'];
         mercadoPago?: GenericRedirectDropinOptions['translations'];
         addressSelector?: AddressSelectorElementOptions['translations'];
+        applePayButton?: ApplePayDropinOptions['translations'];
     };
     styles?: {
         [key: string]: any;
@@ -1149,9 +1225,7 @@ declare class FraudNet implements Mountable {
 
 interface PayrailsClientOptions {
     environment?: PayrailsEnvironment;
-    events?: {
-        onClientInitialized: (execution?: typeof WorkflowExecution) => void;
-    };
+    events?: ClientEvents;
     redirectFor3DS?: boolean;
     returnInfo?: ReturnInfo;
     telemetry?: {
@@ -1160,7 +1234,6 @@ interface PayrailsClientOptions {
     };
 }
 declare class Payrails {
-    private sdkConfiguration;
     private vaultClient;
     private options?;
     private __container;
@@ -1197,9 +1270,9 @@ declare class Payrails {
     private getContainerLayout;
     binLookup(): Promise<any>;
 }
-interface InitOptions {
-    version: string;
-    data: string;
+interface ClientEvents {
+    onClientInitialized?: (execution?: typeof WorkflowExecution) => void;
+    onSessionExpired?: () => Promise<InitOptions>;
 }
 interface PaymentEvents {
     onAuthorizeSuccess?: (e?: any) => void;
@@ -1228,129 +1301,38 @@ interface DropinEvents {
     onPaymentOptionSelected?: (e: onPaymentMethodSelectedParams) => void;
 }
 type PayrailsSDKEvents = PaymentEvents & UIEvents & DropinEvents;
-interface SdkConfiguration {
-    token: string;
-    amount: PayrailsAmount;
-    holderReference: string;
-    usePayrailsFrames: boolean;
-    links?: {
-        binLookup?: {
-            method: 'GET' | 'POST';
-            href: string;
-        };
-    };
-    vaultConfiguration: {
-        cardTableName: string;
-        token: string;
-        vaultId: string;
-        vaultUrl: string;
-        providerId: string;
-        providerConfigId: string;
-        vaultType: 'Skyflow' | 'Payrails' | 'Test';
-        encryptionPublicKey?: string;
-        links: {
-            saveInstrument: {
-                href: string;
-            };
-        };
-    };
-    execution?: WorkflowExecutionResponse;
-}
-interface PayrailsAmount {
-    value: string;
-    currency: string;
-}
 declare enum PayrailsEnvironment {
     TEST = "TEST",
     PRODUCTION = "PRODUCTION"
 }
 
-type TokenizedCollectResult = {
-    skyflow_id?: string;
-    card_number?: string;
-    cardholder_name?: string;
-    expiry_month?: string;
-    expiry_year?: string;
-    security_code: string;
-    instrumentId?: string;
-};
-interface EncryptedCollectResult {
-    vaultProviderConfigId: string;
-    encryptedData: string;
-}
-interface CollectElementOptions {
-    type: ElementType;
-    label?: string;
-    placeholder?: string;
-    altText?: string;
-    format?: string;
-    inputStyles?: object;
-    labelStyles?: object;
-    errorTextStyles?: object;
-    required?: boolean;
-    enableCardIcon?: boolean;
-}
-type PayrailsContainerType = 'COLLECT' | 'COMPOSABLE';
-interface CollectContainerOptions {
-    layout?: number[];
-    cardTableName?: string;
-    containerType?: PayrailsContainerType;
-    styles?: {
-        base?: Partial<CSSStyleDeclaration>;
-    };
-    errorTextStyles?: {
-        base?: Partial<CSSStyleDeclaration>;
+interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
+    clientDomain?: string;
+    showPaymentMethodLogo?: boolean;
+    events?: PaymentEvents & {
+        onApplePayAvailable?: () => void;
     };
+    styles?: {
+        type?: 'plain' | 'buy' | 'addMoney' | 'book' | 'checkout' | 'continue' | 'contribute' | 'donate' | 'inStore' | 'order' | 'reload' | 'rent' | 'setUp' | 'subscribe' | 'support' | 'tip' | 'topUp';
+        style?: 'white' | 'whiteOutline' | 'black' | 'automatic';
+    } & StoreInstrumentElementOptions['styles'];
 }
-type PayrailsSecureFieldEvent = 'CHANGE' | 'FOCUS' | 'BLUR' | 'READY' | 'SUBMIT';
-interface PayrailsSecureField {
-    on(eventName: PayrailsSecureFieldEvent, handler: any): void;
-    mount?: (domElement: any) => void;
-    unmount?: () => void;
-    getState?: () => {
-        isEmpty: boolean;
-        isComplete: boolean;
-        isValid: boolean;
-        isFocused: boolean;
-        value: unknown;
-        required: boolean;
-    };
-    isValidElement?: () => boolean;
-    setError?: (clientErrorText: string) => void;
-    resetError?: () => void;
-    setValue?: (elementValue: string) => void;
-    clearValue?: () => void;
+declare global {
+    interface Window {
+        ApplePaySession?: ApplePaySession;
+    }
 }
-declare class PayrailsCollectContainer implements Mountable {
-    private sdkConfig;
-    bin: string;
-    isBinLookupEnabled: boolean;
-    readonly id = "payrails-container-wrapper";
-    private static instance;
-    private readonly __container;
-    private element;
-    private readonly cardTableName;
-    private readonly containerType;
-    constructor(__client: Skyflow, options: CollectContainerOptions, sdkConfig: SdkConfiguration);
-    static init(vaultClient: Skyflow, options: CollectContainerOptions, sdkConfig: SdkConfiguration): PayrailsCollectContainer;
-    createCollectElement(options: CollectElementOptions): PayrailsSecureField;
-    mount(selector: string): void;
+declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
+    protected options: ApplePayButtonOptions;
+    private appleButton;
+    private paymentExecutor;
+    static isApplePayAvailable(): Promise<boolean>;
+    constructor(options: ApplePayButtonOptions);
+    mount(location: string): void;
     unmount(): void;
-    collect<T extends EncryptedCollectResult | TokenizedCollectResult = EncryptedCollectResult>(): Promise<T>;
-    private collectSkyflowData;
-    private collectPayrailsData;
-    tokenize(opts: TokenizeOptions): Promise<SaveInstrumentResponse>;
-    private constructSaveInstrumentBody;
-    private attachCustomEventHandler;
-    private formatBin;
-    private get elementToFieldMap();
-    fetchBinLookup: (bin: string) => Promise<string | BinLookupResponse | {
-        bin: string;
-    }>;
-}
-interface TokenizeOptions {
-    futureUsage?: 'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile';
-    storeInstrument?: boolean;
+    private mountApplePayButton;
+    private createApplePaySession;
+    private onApplePayAuthorized;
 }
 
 export { ApplePayButtonOptions, AuthorizationFailureReasons, CardFormOptions, CardListOptions, CardPaymentButtonOptions, DropinOptions, ElementType, GooglePayButtonOptions, INTEGRATION_TYPE, InitOptions, PAYMENT_METHOD_CODES, PaymentEvents, PaypalButtonOptions, Payrails, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsEnvironment, PayrailsSecureField, PayrailsSecureFieldEvent, SaveInstrumentResponse, WorkflowExecutionResponse };