@payrails/web-sdk 5.37.4 → 5.37.5

package/package.json

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

package/payrails.d.ts

@@ -1,6 +1,6 @@
-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';
+import * as _payrails_iframe_event_bus from '@payrails/iframe-event-bus';
 
 declare const UI_POSITION_FIELD = "ui:position";
 
@@ -486,16 +486,218 @@ interface SaveInstrumentResponse {
     futureUsage?: string;
 }
 
-interface BinLookupResponse {
-    bin: string;
-    network: string;
-    issuer?: string;
-    issuerCountry?: {
+interface SdkConfiguration {
+    token: string;
+    amount: PayrailsAmount;
+    holderReference: string;
+    links?: {
+        binLookup?: Links;
+        instrumentDelete?: Links;
+        instrumentUpdate?: Links;
+    };
+    type?: 'tokenization' | 'dropIn' | 'secureFields';
+    vaultConfiguration: {
+        cardTableName: string;
+        token: string;
+        vaultId: string;
+        vaultUrl: string;
+        providerId: string;
+        providerConfigId: string;
+        vaultType: 'Payrails' | 'Test';
+        encryptionPublicKey?: string;
+        links: {
+            saveInstrument: {
+                href: string;
+            };
+        };
+    };
+    execution?: WorkflowExecutionResponse;
+}
+interface PayrailsAmount {
+    value: string;
+    currency: string;
+}
+interface LookupUpdateOptions {
+    value: string;
+    currency: string;
+    installmentConfig?: InstallmentUpdateConfig | null;
+}
+interface Links {
+    method: 'GET' | 'POST';
+    href: string;
+}
+
+interface ReturnInfo {
+    success?: string;
+    cancel?: string;
+    error?: string;
+    pending?: string;
+}
+declare global {
+    interface Window {
+        PayrailsData: {
+            riskIds: {
+                [key in FraudProvider]?: string;
+            };
+        };
+    }
+}
+interface PayoutResponse {
+    name: 'payout';
+    executedAt: string;
+    workspaceId: string;
+    actionId: string;
+    links: {
+        execution: string;
+    };
+}
+type PayoutComposition = Array<{
+    integrationType: string;
+    amount: PayrailsAmount;
+    paymentMethodCode: PAYMENT_METHOD_CODES;
+    paymentInstrumentId?: string;
+}>;
+interface PayoutReqBody {
+    amount: PayrailsAmount;
+    payoutComposition: PayoutComposition;
+}
+type ERROR_RESULT = 'Unknown' | 'UnexpectedProviderResponse' | 'ProviderUnknownError' | 'ProviderConnectionError' | 'Timeout' | 'ProviderTimeout' | 'GenericRejection' | 'DuplicateOperation' | 'OperationNotAllowed' | 'NetworkTransactionReferenceRejected' | 'PayerCanceled' | 'LimitExceeded' | 'InstrumentNotAllowed' | 'InvalidInstrument' | 'InsufficientBalance' | 'BlockedInstrument' | 'ExpiredInstrument' | 'ValidationError' | 'ParamsError' | 'ProviderConfigError' | 'InvalidSignature' | 'InternalServerError' | 'AuthenticationError' | 'PaymentMethodNotSupported' | 'PayerAuthenticationRequired' | 'PayerAuthenticationFailed' | 'FraudRisk';
+
+interface Mountable {
+    mount(selector: string | PayrailsElement): void;
+    unmount(): void;
+}
+interface ElementOptions {
+    id?: string;
+    dataTestId?: string;
+    className?: string | string[];
+    styles?: Partial<CSSStyleDeclaration>;
+}
+declare class PayrailsElement implements Mountable {
+    protected element: HTMLElement;
+    protected subElements: Array<Mountable>;
+    readonly id: string | undefined;
+    readonly dataTestId: string | undefined;
+    protected eventBus: _payrails_iframe_event_bus.IframeEventBus;
+    constructor(elementType: string, { id, className, dataTestId }?: ElementOptions);
+    get parentElement(): HTMLElement | null;
+    get selector(): string;
+    mount(location: string): void;
+    protected clean(): void;
+    unmount(): void;
+}
+
+interface IAddress {
+    country?: {
         code?: string;
-        name?: string;
+        fullName?: string;
         iso3?: string;
     };
-    type?: string;
+    postalCode?: string;
+}
+interface IOnChange {
+    isValid: boolean;
+    billingAddress?: IAddress;
+}
+interface AddressSelectorElementOptions extends ElementOptions {
+    translations?: {
+        labels?: {
+            countrySelector?: string;
+            postalCodeInput?: string;
+        };
+        placeholders?: {
+            postalCodeInput?: string;
+            countrySelector?: string;
+        };
+    };
+    styles?: {
+        wrapper?: Partial<CSSStyleDeclaration>;
+        countrySelector?: {
+            wrapper?: Partial<CSSStyleDeclaration>;
+            element?: Partial<CSSStyleDeclaration>;
+            label?: Partial<CSSStyleDeclaration>;
+        };
+        postalCodeInput?: {
+            wrapper?: Partial<CSSStyleDeclaration>;
+            element?: Partial<CSSStyleDeclaration>;
+            label?: Partial<CSSStyleDeclaration>;
+        };
+    };
+    events?: {
+        onBillingAddressChanged?: (e: IOnChange) => void;
+    };
+}
+
+interface StoreInstrumentElementOptions extends ElementOptions {
+    showStoreInstrumentCheckbox?: boolean;
+    alwaysStoreInstrument?: boolean;
+    defaultStoreInstrumentState?: 'checked' | 'unchecked';
+    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;
+    abortAfterAuthorizeFailed?: boolean;
+    translations?: {
+        labels?: {
+            storeInstrument?: string;
+            saveInstrument?: string;
+            paymentScreenLabel?: string;
+        };
+    };
+    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 {
+    protected options: ApplePayButtonOptions;
+    private appleButton;
+    private paymentExecutor;
+    private action;
+    private isProcessing;
+    static isApplePayAvailable(): Promise<boolean>;
+    constructor(options: ApplePayButtonOptions);
+    mount(location: string): void;
+    unmount(): void;
+    private mountApplePayButton;
+    private onAuthorizeFailedHandler;
+    private createApplePaySession;
+    private onApplePayAuthorized;
+    private doAuthorizedPayment;
+    private doTokenize;
 }
 
 declare enum RedactionType {
@@ -674,6 +876,32 @@ interface FontDescriptor {
     display?: string;
 }
 
+declare const regexes: {
+    visa: RegExp;
+    mastercard: RegExp;
+    amex: RegExp;
+    diners_club: RegExp;
+    discover: RegExp;
+    jcb: RegExp;
+    hipercard: RegExp;
+    unionpay: RegExp;
+    maestro: RegExp;
+    elo: RegExp;
+};
+type CardNetwork = keyof typeof regexes;
+
+interface BinLookupResponse {
+    bin: string;
+    network: string;
+    issuer?: string;
+    issuerCountry?: {
+        code?: string;
+        name?: string;
+        iso3?: string;
+    };
+    type?: string;
+}
+
 declare class ComposableElement {
     #private;
     type: string;
@@ -839,30 +1067,6 @@ declare class Skyflow {
     static get ValidationRuleType(): typeof ValidationRuleType;
 }
 
-interface Mountable {
-    mount(selector: string | PayrailsElement): void;
-    unmount(): void;
-}
-interface ElementOptions {
-    id?: string;
-    dataTestId?: string;
-    className?: string | string[];
-    styles?: Partial<CSSStyleDeclaration>;
-}
-declare class PayrailsElement implements Mountable {
-    protected element: HTMLElement;
-    protected subElements: Array<Mountable>;
-    readonly id: string | undefined;
-    readonly dataTestId: string | undefined;
-    protected eventBus: _payrails_iframe_event_bus.IframeEventBus;
-    constructor(elementType: string, { id, className, dataTestId }?: ElementOptions);
-    get parentElement(): HTMLElement | null;
-    get selector(): string;
-    mount(location: string): void;
-    protected clean(): void;
-    unmount(): void;
-}
-
 interface TokenizeOptions {
     futureUsage?: FutureUsages;
     storeInstrument?: boolean;
@@ -972,61 +1176,6 @@ declare class PayrailsCollectContainer implements Mountable {
     }>;
 }
 
-interface IAddress {
-    country?: {
-        code?: string;
-        fullName?: string;
-        iso3?: string;
-    };
-    postalCode?: string;
-}
-interface IOnChange {
-    isValid: boolean;
-    billingAddress?: IAddress;
-}
-interface AddressSelectorElementOptions extends ElementOptions {
-    translations?: {
-        labels?: {
-            countrySelector?: string;
-            postalCodeInput?: string;
-        };
-        placeholders?: {
-            postalCodeInput?: string;
-            countrySelector?: string;
-        };
-    };
-    styles?: {
-        wrapper?: Partial<CSSStyleDeclaration>;
-        countrySelector?: {
-            wrapper?: Partial<CSSStyleDeclaration>;
-            element?: Partial<CSSStyleDeclaration>;
-            label?: Partial<CSSStyleDeclaration>;
-        };
-        postalCodeInput?: {
-            wrapper?: Partial<CSSStyleDeclaration>;
-            element?: Partial<CSSStyleDeclaration>;
-            label?: Partial<CSSStyleDeclaration>;
-        };
-    };
-    events?: {
-        onBillingAddressChanged?: (e: IOnChange) => void;
-    };
-}
-
-declare const regexes: {
-    visa: RegExp;
-    mastercard: RegExp;
-    amex: RegExp;
-    diners_club: RegExp;
-    discover: RegExp;
-    jcb: RegExp;
-    hipercard: RegExp;
-    unionpay: RegExp;
-    maestro: RegExp;
-    elo: RegExp;
-};
-type CardNetwork = keyof typeof regexes;
-
 interface PaymentInstallmentsElementOptions extends ElementOptions {
     showPaymentInstallmentsDropdown?: boolean;
     installmentConfig?: {
@@ -1070,36 +1219,6 @@ declare class PayrailsElementWithPaymentInstallmentsDropdown extends PayrailsEle
     setDisabled(state: boolean): void;
 }
 
-interface StoreInstrumentElementOptions extends ElementOptions {
-    showStoreInstrumentCheckbox?: boolean;
-    alwaysStoreInstrument?: boolean;
-    defaultStoreInstrumentState?: 'checked' | 'unchecked';
-    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 | '';
@@ -1241,83 +1360,6 @@ declare class CardList extends PayrailsElement {
     reset(): void;
 }
 
-interface SdkConfiguration {
-    token: string;
-    amount: PayrailsAmount;
-    holderReference: string;
-    links?: {
-        binLookup?: Links;
-        instrumentDelete?: Links;
-        instrumentUpdate?: Links;
-    };
-    type?: 'tokenization' | 'dropIn' | 'secureFields';
-    vaultConfiguration: {
-        cardTableName: string;
-        token: string;
-        vaultId: string;
-        vaultUrl: string;
-        providerId: string;
-        providerConfigId: string;
-        vaultType: 'Payrails' | 'Test';
-        encryptionPublicKey?: string;
-        links: {
-            saveInstrument: {
-                href: string;
-            };
-        };
-    };
-    execution?: WorkflowExecutionResponse;
-}
-interface PayrailsAmount {
-    value: string;
-    currency: string;
-}
-interface LookupUpdateOptions {
-    value: string;
-    currency: string;
-    installmentConfig?: InstallmentUpdateConfig | null;
-}
-interface Links {
-    method: 'GET' | 'POST';
-    href: string;
-}
-
-interface ReturnInfo {
-    success?: string;
-    cancel?: string;
-    error?: string;
-    pending?: string;
-}
-declare global {
-    interface Window {
-        PayrailsData: {
-            riskIds: {
-                [key in FraudProvider]?: string;
-            };
-        };
-    }
-}
-interface PayoutResponse {
-    name: 'payout';
-    executedAt: string;
-    workspaceId: string;
-    actionId: string;
-    links: {
-        execution: string;
-    };
-}
-type PayoutComposition = Array<{
-    integrationType: string;
-    amount: PayrailsAmount;
-    paymentMethodCode: PAYMENT_METHOD_CODES;
-    paymentInstrumentId?: string;
-}>;
-interface PayoutReqBody {
-    amount: PayrailsAmount;
-    payoutComposition: PayoutComposition;
-}
-type ERROR_RESULT = 'Unknown' | 'UnexpectedProviderResponse' | 'ProviderUnknownError' | 'ProviderConnectionError' | 'Timeout' | 'ProviderTimeout' | 'GenericRejection' | 'DuplicateOperation' | 'OperationNotAllowed' | 'NetworkTransactionReferenceRejected' | 'PayerCanceled' | 'LimitExceeded' | 'InstrumentNotAllowed' | 'InvalidInstrument' | 'InsufficientBalance' | 'BlockedInstrument' | 'ExpiredInstrument' | 'ValidationError' | 'ParamsError' | 'ProviderConfigError' | 'InvalidSignature' | 'InternalServerError' | 'AuthenticationError' | 'PaymentMethodNotSupported' | 'PayerAuthenticationRequired' | 'PayerAuthenticationFailed' | 'FraudRisk';
-
 interface CardPaymentButtonOptions {
     events?: PayrailsSDKEvents & {
         onStateChanged?: (state: 'enabled' | 'disabled') => void;
@@ -1864,16 +1906,6 @@ interface PublicSharedState {
     instrument: StoredPaymentInstrument | null;
 }
 
-interface PayrailsClientOptions {
-    environment?: PayrailsEnvironment;
-    events?: ClientEvents;
-    redirectFor3DS?: boolean;
-    returnInfo?: ReturnInfo;
-    telemetry?: {
-        enabled?: boolean;
-        logLevel?: LogLevel$1;
-    };
-}
 declare class Payrails {
     private vaultClient;
     private options?;
@@ -1885,7 +1917,6 @@ declare class Payrails {
     private __genericRedirectButton;
     private __dynamicElementForm;
     private __dropin;
-    private __sharedState;
     static preloadCardForm: typeof SdkLoader.preloadCardForm;
     static init(initResponse: InitOptions, options?: PayrailsClientOptions): Payrails;
     update(updateOptions: LookupUpdateOptions): void;
@@ -2011,46 +2042,16 @@ declare enum PayrailsEnvironment {
     PRODUCTION = "PRODUCTION"
 }
 
-interface ApplePayButtonOptions extends StoreInstrumentElementOptions {
-    clientDomain?: string;
-    showPaymentMethodLogo?: boolean;
-    abortAfterAuthorizeFailed?: boolean;
-    translations?: {
-        labels?: {
-            storeInstrument?: string;
-            saveInstrument?: string;
-            paymentScreenLabel?: string;
-        };
-    };
-    events?: PaymentEvents & {
-        onApplePayAvailable?: () => void;
+interface PayrailsClientOptions {
+    environment?: PayrailsEnvironment;
+    events?: ClientEvents;
+    redirectFor3DS?: boolean;
+    returnInfo?: ReturnInfo;
+    telemetry?: {
+        enabled?: boolean;
+        logLevel?: LogLevel$1;
+        collectMetadata?: boolean;
     };
-    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 {
-    protected options: ApplePayButtonOptions;
-    private appleButton;
-    private paymentExecutor;
-    private action;
-    private isProcessing;
-    static isApplePayAvailable(): Promise<boolean>;
-    constructor(options: ApplePayButtonOptions);
-    mount(location: string): void;
-    unmount(): void;
-    private mountApplePayButton;
-    private onAuthorizeFailedHandler;
-    private createApplePaySession;
-    private onApplePayAuthorized;
-    private doAuthorizedPayment;
-    private doTokenize;
 }
 
 export { AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsEnvironment };