@payrails/web-sdk 5.45.0 → 5.46.0-RC.0

package/package.json

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

package/payrails.d.ts

@@ -2079,6 +2079,30 @@ interface PayPalScriptConfig {
     locale?: string;
 }
 
+interface PaymentAttemptContext {
+    readonly executionId: string;
+    readonly paymentMethodCode: PaymentMethodCode;
+}
+declare enum ACTION_REQUIRED_KIND {
+    GENERIC_REDIRECT = "genericRedirect",
+    THREE_DS = "3ds"
+}
+type ActionRequiredKind = `${ACTION_REQUIRED_KIND}`;
+interface ActionRequiredEvent extends PaymentAttemptContext {
+    readonly url: string;
+    readonly kind: ActionRequiredKind;
+    /**
+     * Call to take over the action. The SDK will not perform its default
+     * behavior (navigate, mount the 3DS popup).
+     */
+    preventDefault(): void;
+}
+type PayrailsEvents = {
+    actionRequired: ActionRequiredEvent;
+};
+type PayrailsEventName = keyof PayrailsEvents;
+type PayrailsEventHandler<K extends PayrailsEventName> = (event: PayrailsEvents[K]) => void | Promise<void>;
+
 interface QueryDefinition<T> {
     path: string[];
     returnType: T;
@@ -2147,6 +2171,8 @@ declare class Payrails {
     private logIntegrationMode;
     private constructor();
     private getContainerLayout;
+    on<K extends PayrailsEventName>(name: K, handler: PayrailsEventHandler<K>): () => void;
+    off<K extends PayrailsEventName>(name: K, handler: PayrailsEventHandler<K>): void;
     binLookup(): Promise<any>;
 }
 interface ClientEvents {
@@ -2272,5 +2298,5 @@ interface PayrailsClientOptions {
     };
 }
 
-export { AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsCollectContainer, PayrailsEnvironment, REVOLUT_PAY_DEFAULT_LABEL, REVOLUT_PAY_DEFAULT_THEME };
-export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, CollectContainerOptions, DropinOptions, ExecutionMeta, ExecutionMetaCustomer, ExecutionMetaKey, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, LeanButtonOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, RevolutPayButtonTheme, RevolutPayStyles, SaveInstrumentResponse, StorablePaymentCompositionOption, WorkflowExecutionResponse };
+export { ACTION_REQUIRED_KIND, AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsCollectContainer, PayrailsEnvironment, REVOLUT_PAY_DEFAULT_LABEL, REVOLUT_PAY_DEFAULT_THEME };
+export type { ActionRequiredEvent, ActionRequiredKind, ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, CollectContainerOptions, DropinOptions, ExecutionMeta, ExecutionMetaCustomer, ExecutionMetaKey, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, LeanButtonOptions, PaymentAttemptContext, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsEventHandler, PayrailsEventName, PayrailsEvents, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, RevolutPayButtonTheme, RevolutPayStyles, SaveInstrumentResponse, StorablePaymentCompositionOption, WorkflowExecutionResponse };