@payrails/web-sdk 3.0.0-RC.8 → 3.1.0

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@payrails/web-sdk",
-  "version": "3.0.0-RC.8",
+  "version": "3.1.0",
   "description": "SDK providing tokenization options on the client for merchants",
   "main": "index.js",
   "types": "payrails.d.ts",
   "type": "commonjs",
-  "scripts": {},
-  "author": "Petr Prchal <petr@payrails.com>",
+  "author": "Payrails GitHub Bot <github@payrails.com>",
   "license": "MIT",
   "dependencies": {
-    "@payrails/web-cse": "1.2.2",
-    "@types/applepayjs": "3.0.4",
-    "@types/googlepay": "0.7.1"
-  }
-}
+    "@payrails/web-cse": "1.2.2-RC.1",
+    "@types/applepayjs": "14.0.4",
+    "@types/googlepay": "0.7.5"
+  },
+  "scripts": {}
+}

package/payrails.d.ts

@@ -1,11 +1,174 @@
 /// <reference types="applepayjs" />
 /// <reference types="googlepay" />
+declare enum PAYMENT_METHOD_CODES {
+    'CARD' = "card",
+    'GOOGLE_PAY' = "googlePay",
+    'PAYPAL' = "payPal",
+    'APPLE_PAY' = "applePay"
+}
+declare enum PAYMENT_INSTRUMENT_STATUS {
+    'ENABLED' = "enabled",
+    'CREATED' = "created",
+    'DELETED' = "deleted",
+    'DISABLED' = "disabled",
+    'INVALID' = "invalid",
+    'TRANSIENT' = "transient"
+}
+declare class WorkflowExecution {
+    private executionResponse;
+    constructor(executionResponse: WorkflowExecutionResponse);
+    get lookup(): {
+        httpCode: number;
+        body: {
+            data: {
+                paymentCompositionOptions: StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
+            };
+            links: {
+                authorize: {
+                    href: string;
+                    method: "POST";
+                };
+                execution: string;
+            };
+            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(): {
+        merchantIdentifier: string;
+        supportedNetworks: string[];
+        countryCode: string;
+        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
+    };
+    get url(): string;
+    get response(): WorkflowExecutionResponse;
+    get meta(): {
+        customer?: {
+            country?: {
+                code: string;
+            } | undefined;
+        } | undefined;
+    };
+    get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
+    get authorizeLink(): string | undefined;
+    get createSessionLink(): string | undefined;
+    get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
+    private getStoredInstrumentForPaymentMethod;
+}
+interface WorkflowExecutionResponse {
+    id: string;
+    merchantReference: string;
+    holderReference: string;
+    actionRequired?: string;
+    meta: {
+        customer?: {
+            country?: {
+                code: string;
+            };
+        };
+    };
+    status: Array<{
+        code: string;
+        time: string;
+    }>;
+    initialResults: Array<{
+        httpCode: number;
+        body: {
+            data: {
+                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
+            };
+            links: {
+                authorize: {
+                    href: string;
+                    method: 'POST';
+                };
+                execution: string;
+            };
+            name: 'lookup';
+        };
+    }>;
+    links: {
+        startPaymentSession?: {
+            href: string;
+            method: 'POST';
+        };
+        confirm?: {
+            href: string;
+            action?: {
+                parameters?: {
+                    orderId?: string;
+                    tokenId?: string;
+                };
+            };
+        };
+        '3ds'?: string;
+        self: string;
+    };
+}
+interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> {
+    paymentMethodCode?: PAYMENT_METHOD_CODES;
+    description: string;
+    id: string;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    config: C;
+    paymentInstruments?: Array<StoredPaymentInstrument<I>>;
+    integrationType: string;
+}
+interface GooglePayConfig {
+    parameters: {
+        allowedAuthMethods: string[];
+        allowedCardNetworks: string[];
+    };
+    tokenizationSpecification: {
+        parameters: {
+            gateway: string;
+            gatewayMerchantId: string;
+        };
+        type: string;
+    };
+    type: string;
+}
+interface PayPalConfig {
+    clientId: string;
+    merchantId: string;
+    captureMode: 'Delayed' | 'Instant' | 'Manual';
+}
+interface ApplePayConfig {
+    parameters: {
+        merchantIdentifier: string;
+        supportedNetworks: string[];
+        countryCode: string;
+        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
+    };
+    type: string;
+}
+interface StoredPaymentInstrument<T = CardMetadata | PayPalMetadata> {
+    id: string;
+    status: PAYMENT_INSTRUMENT_STATUS;
+    paymentMethod: PAYMENT_METHOD_CODES;
+    data?: T;
+}
+interface PayPalMetadata {
+    email?: string;
+}
+interface CardMetadata {
+    bin?: string;
+    suffix?: string;
+}
+
 interface SaveInstrumentResponse {
     id: string;
     createdAt: string;
     holderId: string;
-    paymentMethod: 'card';
-    status: 'created' | 'deleted' | 'enabled' | 'disabled' | 'invalid' | 'transient';
+    paymentMethod: PAYMENT_METHOD_CODES.CARD;
+    status: PAYMENT_INSTRUMENT_STATUS;
     data: {
         bin: string;
         binLookup?: {
@@ -312,165 +475,6 @@ declare class PayrailsElement implements Mountable {
     unmount(): void;
 }
 
-declare enum PAYMENT_METHOD_CODES {
-    'CARD' = "card",
-    'GOOGLE_PAY' = "googlePay",
-    'PAYPAL' = "payPal",
-    'APPLE_PAY' = "applePay"
-}
-declare enum PAYMENT_INSTRUMENT_STATUS {
-    'ENABLED' = "enabled",
-    'CREATED' = "created"
-}
-declare class WorkflowExecution {
-    private executionResponse;
-    constructor(executionResponse: WorkflowExecutionResponse);
-    get lookup(): {
-        httpCode: number;
-        body: {
-            data: {
-                paymentCompositionOptions: StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
-            };
-            links: {
-                authorize: {
-                    href: string;
-                    method: "POST";
-                };
-                execution: string;
-            };
-            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(): {
-        merchantIdentifier: string;
-        supportedNetworks: string[];
-        countryCode: string;
-        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
-    };
-    get url(): string;
-    get response(): WorkflowExecutionResponse;
-    get meta(): {
-        customer?: {
-            country?: {
-                code: string;
-            } | undefined;
-        } | undefined;
-    };
-    get availablePaymentMethods(): StorablePaymentCompositionOption<CardMetadata | PayPalMetadata, ApplePayConfig | PayPalConfig | GooglePayConfig | undefined>[];
-    get authorizeLink(): string | undefined;
-    get createSessionLink(): string | undefined;
-    get storedPaymentInstruments(): StoredPaymentInstrument<PayPalMetadata & CardMetadata>[];
-    private getStoredInstrumentForPaymentMethod;
-}
-interface WorkflowExecutionResponse {
-    id: string;
-    merchantReference: string;
-    holderReference: string;
-    actionRequired?: string;
-    meta: {
-        customer?: {
-            country?: {
-                code: string;
-            };
-        };
-    };
-    status: Array<{
-        code: string;
-        time: string;
-    }>;
-    initialResults: Array<{
-        httpCode: number;
-        body: {
-            data: {
-                paymentCompositionOptions: Array<StorablePaymentCompositionOption>;
-            };
-            links: {
-                authorize: {
-                    href: string;
-                    method: 'POST';
-                };
-                execution: string;
-            };
-            name: 'lookup';
-        };
-    }>;
-    links: {
-        startPaymentSession?: {
-            href: string;
-            method: 'POST';
-        };
-        confirm?: {
-            href: string;
-            action?: {
-                parameters?: {
-                    orderId?: string;
-                    tokenId?: string;
-                };
-            };
-        };
-        '3ds'?: string;
-        self: string;
-    };
-}
-interface StorablePaymentCompositionOption<I = CardMetadata | PayPalMetadata, C = undefined | ApplePayConfig | PayPalConfig | GooglePayConfig> {
-    paymentMethodCode?: PAYMENT_METHOD_CODES;
-    description: string;
-    id: string;
-    status: PAYMENT_INSTRUMENT_STATUS;
-    config: C;
-    paymentInstruments?: Array<StoredPaymentInstrument<I>>;
-    integrationType: string;
-}
-interface GooglePayConfig {
-    parameters: {
-        allowedAuthMethods: string[];
-        allowedCardNetworks: string[];
-    };
-    tokenizationSpecification: {
-        parameters: {
-            gateway: string;
-            gatewayMerchantId: string;
-        };
-        type: string;
-    };
-    type: string;
-}
-interface PayPalConfig {
-    clientId: string;
-    merchantId: string;
-    captureMode: 'Delayed' | 'Instant' | 'Manual';
-}
-interface ApplePayConfig {
-    parameters: {
-        merchantIdentifier: string;
-        supportedNetworks: string[];
-        countryCode: string;
-        merchantCapabilities: ApplePayJS.ApplePayMerchantCapability[];
-    };
-    type: string;
-}
-interface StoredPaymentInstrument<T = CardMetadata | PayPalMetadata> {
-    id: string;
-    status: PAYMENT_INSTRUMENT_STATUS;
-    paymentMethod: PAYMENT_METHOD_CODES;
-    data?: T;
-}
-interface PayPalMetadata {
-    email?: string;
-}
-interface CardMetadata {
-    bin?: string;
-    suffix?: string;
-}
-
 interface StoreInstrumentElementOptions extends ElementOptions {
     showStoreInstrumentCheckbox?: boolean;
     alwaysStoreInstrument?: boolean;
@@ -591,6 +595,7 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     get bin(): string;
     private readonly formFields;
     constructor(collectContainer: PayrailsCollectContainer, options?: CardFormOptions | undefined);
+    tokenize(opts: TokenizeOptions): Promise<SaveInstrumentResponse>;
     show(): void;
     hide(): void;
     private triggerOnReady;
@@ -600,7 +605,7 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     get cardNetwork(): "" | "visa" | "mastercard" | "amex" | "diners" | "discover" | "jcb" | "hipercard" | "unionpay" | "maestro";
     onChange(): void;
     collectValues(): Promise<{
-        cardData: EncryptedCollectResult | TokenizedCollectResult;
+        cardData: TokenizedCollectResult | EncryptedCollectResult;
         storeInstrument: boolean;
         enrollInstrumentToNetworkOffers: boolean;
     }>;
@@ -682,6 +687,10 @@ declare enum AuthorizationFailureReasons {
 
 interface GooglePayButtonOptions extends StoreInstrumentElementOptions {
     environment?: 'TEST' | 'PRODUCTION';
+    merchantInfo?: {
+        merchantId: string;
+        merchantName?: string;
+    };
     events?: PaymentEvents & UIEvents & {
         onGooglePayAvailable?: () => void;
     };
@@ -773,6 +782,7 @@ interface PaypalDropinOptions extends PaypalButtonOptions {
 
 declare class Dropin extends PayrailsElement {
     private collectContainer;
+    private readonly clientConfig;
     private readonly dropinConfig;
     private readonly execution;
     private readonly sdkConfig;
@@ -783,7 +793,7 @@ declare class Dropin extends PayrailsElement {
     private applePay;
     private cardForm;
     private paypal;
-    constructor(collectContainer: PayrailsCollectContainer, dropinConfig: DropinOptions, execution: WorkflowExecution, sdkConfig: SdkConfiguration, returnLinks: RedirectReturnLinks);
+    constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions, execution: WorkflowExecution, sdkConfig: SdkConfiguration, returnLinks: RedirectReturnLinks);
     private createStoredInstrumentElement;
     private createCreditCardButton;
     private createGooglePayButton;
@@ -805,7 +815,9 @@ interface DropinOptions {
             showExistingCards?: boolean;
         } & StorablePaymentMethodConfiguration;
         payPal?: StorablePaymentMethodConfiguration;
-        googlePay?: StorablePaymentMethodConfiguration;
+        googlePay?: StorablePaymentMethodConfiguration & {
+            merchantInfo?: GooglePayButtonOptions['merchantInfo'];
+        };
         applePay?: {
             clientDomain?: string;
         } & StorablePaymentMethodConfiguration;
@@ -840,7 +852,7 @@ declare class FraudNet implements Mountable {
     private sdkConfig;
     private environment;
     constructor(pageId: FraudNetPageId, sdkConfig: SdkConfiguration, environment: PayrailsClientOptions['environment']);
-    readonly guid: string;
+    readonly guid: any;
     mount(): void;
     unmount(): void;
     private loadFraudnet;
@@ -998,10 +1010,11 @@ declare class PayrailsCollectContainer implements Mountable {
     createCollectElement(options: CollectElementOptions): PayrailsSecureField;
     mount(selector: string): void;
     unmount(): void;
-    collect(): Promise<EncryptedCollectResult | TokenizedCollectResult>;
+    collect(): Promise<TokenizedCollectResult | EncryptedCollectResult>;
     private collectSkyflowData;
     private collectPayrailsData;
     tokenize(opts: TokenizeOptions): Promise<SaveInstrumentResponse>;
+    private constructSaveInstrumentBody;
     private attachCustomEventHandler;
     private formatBin;
     private get elementToFieldMap();