@payrails/web-sdk 5.16.1 → 5.18.0

package/package.json

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

package/payrails.d.ts

@@ -17,9 +17,10 @@ declare enum PAYMENT_INSTRUMENT_STATUS {
     'TRANSIENT' = "transient"
 }
 declare class WorkflowExecution {
-    private executionResponse;
-    constructor(executionResponse: WorkflowExecutionResponse);
-    get lookup(): {
+    private static _response;
+    static get response(): WorkflowExecutionResponse;
+    static setResponse(response: WorkflowExecutionResponse): typeof WorkflowExecution;
+    static get lookup(): {
         httpCode: number;
         body: {
             data: {
@@ -35,24 +36,23 @@ declare class WorkflowExecution {
             name: "lookup";
         };
     } | undefined;
-    get holderReference(): string;
-    get savedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
-    get savedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
-    get savedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    get savedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
-    get paypalConfig(): PayPalConfig;
-    get googlePayConfig(): GooglePayConfig[];
-    isPaymentMethodAvailable(paymentMethod: PAYMENT_METHOD_CODES): boolean;
-    get applePayConfig(): {
+    static get holderReference(): string;
+    static get savedCreditCards(): StoredPaymentInstrument<CardMetadata>[];
+    static get savedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
+    static get savedGooglePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    static get savedApplePayAccounts(): StoredPaymentInstrument<CardMetadata>[];
+    static get paypalConfig(): PayPalConfig;
+    static get googlePayConfig(): GooglePayConfig[];
+    static isPaymentMethodAvailable(paymentMethod: PAYMENT_METHOD_CODES): boolean;
+    static get applePayConfig(): {
         merchantIdentifier: string;
         supportedNetworks: string[];
         countryCode: string;
         merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
         requiredBillingContactFields?: ApplePayJS.ApplePayContactField[];
     };
-    get url(): string;
-    get response(): WorkflowExecutionResponse;
-    get meta(): {
+    static get url(): string;
+    static get meta(): {
         customer?: {
             country?: {
                 code?: string;
@@ -66,15 +66,15 @@ declare class WorkflowExecution {
             };
         };
     };
-    get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
-    get authorizeLink(): string | undefined;
-    get createSessionLink(): string | undefined;
-    get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    getFullPaymentMethodConfig(paymentMethod: PAYMENT_METHOD_CODES): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
-    isPaymentInstallmentsEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
-    getPaymentInstallmentOptions(paymentMethod: PAYMENT_METHOD_CODES): PaymentInstallmentsConfig;
-    private getStoredInstrumentForPaymentMethod;
-    getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
+    static get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
+    static get authorizeLink(): string | undefined;
+    static get createSessionLink(): string | undefined;
+    static get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    static getFullPaymentMethodConfig(paymentMethod: PAYMENT_METHOD_CODES): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined> | undefined;
+    static isPaymentInstallmentsEnabled(paymentMethod: PAYMENT_METHOD_CODES): boolean | undefined;
+    static getPaymentInstallmentOptions(paymentMethod: PAYMENT_METHOD_CODES): PaymentInstallmentsConfig;
+    private static getStoredInstrumentForPaymentMethod;
+    static getPaymentMethodForStoredInstrument<T extends CardMetadata | PayPalMetadata>(instrument: StoredPaymentInstrument<T>): {
         id: string;
         description?: string;
         status: PAYMENT_INSTRUMENT_STATUS;
@@ -88,7 +88,7 @@ declare class WorkflowExecution {
         };
         paymentMethodCode: PAYMENT_METHOD_CODES;
     } | undefined;
-    getPaymentMethodConfig(paymentMethod: StorablePaymentCompositionOption): {
+    static getPaymentMethodConfig(paymentMethod: StorablePaymentCompositionOption): {
         id: string;
         description?: string;
         status: PAYMENT_INSTRUMENT_STATUS;
@@ -502,14 +502,6 @@ declare class Skyflow {
     static get ValidationRuleType(): typeof ValidationRuleType;
 }
 
-declare enum ElementType {
-    CARD_NUMBER = "CARD_NUMBER",
-    CARDHOLDER_NAME = "CARDHOLDER_NAME",
-    CVV = "CVV",
-    EXPIRATION_MONTH = "EXPIRATION_MONTH",
-    EXPIRATION_YEAR = "EXPIRATION_YEAR"
-}
-
 interface Mountable {
     mount(selector: string | PayrailsElement): void;
     unmount(): void;
@@ -619,12 +611,11 @@ declare global {
 }
 declare class ApplePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
     private sdkConfig;
-    private execution;
     protected options: ApplePayButtonOptions;
     private appleButton;
     private paymentExecutor;
     static isApplePayAvailable(): Promise<boolean>;
-    constructor(sdkConfig: SdkConfiguration, execution: WorkflowExecution, options: ApplePayButtonOptions);
+    constructor(sdkConfig: SdkConfiguration, options: ApplePayButtonOptions);
     mount(location: string): void;
     unmount(): void;
     private mountApplePayButton;
@@ -645,6 +636,15 @@ 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;
@@ -690,8 +690,8 @@ interface OnChange {
 }
 interface CardFormOptions extends StoreInstrumentElementOptions {
     showCardHolderName?: boolean;
+    showSingleExpiryDateField?: boolean;
     enrollInstrumentToNetworkOffers?: boolean;
-    execution?: WorkflowExecution;
     translations?: {
         placeholders?: {
             [key in ElementType]?: string;
@@ -751,8 +751,8 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     get cardNetwork(): "" | "visa" | "mastercard" | "amex" | "diners" | "discover" | "jcb" | "hipercard" | "unionpay" | "maestro";
     onChange(): void;
     private updateInstallments;
-    collectValues(): Promise<{
-        cardData: EncryptedCollectResult | TokenizedCollectResult;
+    collectValues<T extends TokenizedCollectResult | EncryptedCollectResult = EncryptedCollectResult>(): Promise<{
+        cardData: T;
         storeInstrument: boolean;
         selectedInstallment: number | undefined;
         enrollInstrumentToNetworkOffers: boolean;
@@ -783,9 +783,8 @@ interface CardListOptions {
     onCardChange: (selectedCard: StoredPaymentInstrument<CardMetadata>) => void;
 }
 declare class CardList extends PayrailsElement {
-    private readonly workflowExecution;
     private listItems;
-    constructor(workflowExecution: WorkflowExecution, options?: CardListOptions);
+    constructor(options?: CardListOptions);
     reset(): void;
 }
 
@@ -822,15 +821,14 @@ interface CardPaymentButtonOptions {
 }
 declare class CardPaymentButton extends PayrailsElement {
     private readonly sdkConfig;
-    private readonly execution;
     private readonly options;
     private readonly returnInfo?;
     selectedInstrument: StoredPaymentInstrument | null;
     paymentInstallmentElement: PayrailsElementWithPaymentInstallmentsDropdown | null;
     get bin(): string | undefined;
-    private paymentExecutor;
+    private readonly paymentExecutor;
     private cardForm;
-    constructor(sdkConfig: SdkConfiguration, execution: WorkflowExecution, options: CardPaymentButtonOptions, returnInfo?: ReturnInfo | undefined);
+    constructor(sdkConfig: SdkConfiguration, options: CardPaymentButtonOptions, returnInfo?: ReturnInfo | undefined);
     setDisabled(isDisabled: boolean): void;
     setSavedCreditCard(savedCard: StoredPaymentInstrument<CardMetadata>): void;
     setSavedInstrument(savedInstrument: StoredPaymentInstrument): void;
@@ -838,7 +836,7 @@ declare class CardPaymentButton extends PayrailsElement {
     private removeStyles;
     setLabel(label: string): void;
     setCardForm(cardForm: CardForm): void;
-    setPaymentInstallmentsDropdown(paymentInsallmentsDropdown: PayrailsElementWithPaymentInstallmentsDropdown): void;
+    setPaymentInstallmentsDropdown(paymentInstallmentsDropdown: PayrailsElementWithPaymentInstallmentsDropdown): void;
     triggerLoading(isLoading: boolean): void;
     private onAuthorizationFailed;
     private onPay;
@@ -870,14 +868,13 @@ interface GooglePayButtonOptions extends StoreInstrumentElementOptions {
 }
 declare class GooglePayButton extends PayrailsElementWithStoreInstrumentCheckbox {
     private sdkConfig;
-    private execution;
     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, execution: WorkflowExecution, options: GooglePayButtonOptions);
+    constructor(sdkConfig: SdkConfiguration, options: GooglePayButtonOptions);
     private sdkLoaded;
     private onLoadPaymentData;
     private authorize;
@@ -921,10 +918,9 @@ interface GenericRedirectButtonOptions {
 }
 declare class GenericRedirectButton extends PayrailsElement {
     private sdkConfig;
-    private execution;
     protected options: GenericRedirectButtonOptions;
     private readonly returnInfo?;
-    constructor(sdkConfig: SdkConfiguration, execution: WorkflowExecution, options: GenericRedirectButtonOptions, returnInfo?: ReturnInfo | undefined);
+    constructor(sdkConfig: SdkConfiguration, options: GenericRedirectButtonOptions, returnInfo?: ReturnInfo | undefined);
     private popup;
     private buildRedirectButton;
     private readonly paymentExecutor;
@@ -976,9 +972,8 @@ interface PaypalButtonOptions extends StoreInstrumentElementOptions {
 }
 declare class PaypalButton extends PayrailsElementWithStoreInstrumentCheckbox {
     private sdkConfig;
-    private execution;
     protected options?: PaypalButtonOptions | undefined;
-    constructor(sdkConfig: SdkConfiguration, execution: WorkflowExecution, options?: PaypalButtonOptions | undefined);
+    constructor(sdkConfig: SdkConfiguration, options?: PaypalButtonOptions | undefined);
     fraudNetGuid: string | undefined;
     private paymentExecutor;
     private button;
@@ -1014,7 +1009,6 @@ declare class Dropin extends PayrailsElement {
     private collectContainer;
     private readonly clientConfig;
     private readonly dropinConfig;
-    private readonly execution;
     private readonly sdkConfig;
     private cardPaymentButton;
     private creditCard;
@@ -1022,8 +1016,7 @@ declare class Dropin extends PayrailsElement {
     private applePay;
     private cardForm;
     private paypal;
-    private paymentInstallmentsDropdown;
-    constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions, execution: WorkflowExecution, sdkConfig: SdkConfiguration);
+    constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions, sdkConfig: SdkConfiguration);
     private isHppIntegration;
     private createStoredInstrumentElement;
     private createInstallmentsDropdown;
@@ -1058,6 +1051,7 @@ interface DropinOptions {
         cards?: {
             showCardHolderName?: boolean;
             showExistingCards?: boolean;
+            showSingleExpiryDateField?: boolean;
         } & StorablePaymentMethodConfiguration;
         payPal?: StorablePaymentMethodConfiguration;
         googlePay?: StorablePaymentMethodConfiguration & {
@@ -1127,9 +1121,8 @@ declare enum ThirdPartySDK {
 type FraudNetPageId = 'home-page' | 'search-result-page' | 'category-page' | 'product-detail-page' | 'cart-page' | 'inline-cart-page' | 'checkout-page';
 declare class FraudNet implements Mountable {
     private pageId;
-    private execution;
     private environment;
-    constructor(pageId: FraudNetPageId, execution: WorkflowExecution, environment: PayrailsClientOptions['environment']);
+    constructor(pageId: FraudNetPageId, environment: PayrailsClientOptions['environment']);
     readonly guid: any;
     mount(): void;
     unmount(): void;
@@ -1137,14 +1130,13 @@ declare class FraudNet implements Mountable {
     private readonly fnclsVal;
     private readonly configId;
     private readonly scriptId;
-    private get payPalConfig();
     private createFraudnetConfig;
 }
 
 interface PayrailsClientOptions {
     environment?: PayrailsEnvironment;
     events?: {
-        onClientInitialized: (execution?: WorkflowExecution) => void;
+        onClientInitialized: (execution?: typeof WorkflowExecution) => void;
     };
     redirectFor3DS?: boolean;
     returnInfo?: ReturnInfo;
@@ -1156,7 +1148,6 @@ interface PayrailsClientOptions {
 declare class Payrails {
     private sdkConfiguration;
     private vaultClient;
-    private execution;
     private options?;
     private __container;
     private __cardForm;
@@ -1187,7 +1178,6 @@ declare class Payrails {
     genericRedirectButton(options: GenericRedirectButtonOptions): GenericRedirectButton;
     getSavedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
     fraudNet(pageId: FraudNetPageId): FraudNet;
-    private get safeExecution();
     private logIntegrationMode;
     private constructor();
     private getContainerLayout;
@@ -1332,7 +1322,7 @@ declare class PayrailsCollectContainer implements Mountable {
     createCollectElement(options: CollectElementOptions): PayrailsSecureField;
     mount(selector: string): void;
     unmount(): void;
-    collect(): Promise<TokenizedCollectResult | EncryptedCollectResult>;
+    collect<T extends EncryptedCollectResult | TokenizedCollectResult = EncryptedCollectResult>(): Promise<T>;
     private collectSkyflowData;
     private collectPayrailsData;
     tokenize(opts: TokenizeOptions): Promise<SaveInstrumentResponse>;