@payrails/web-sdk 5.39.1 → 5.39.2-RC.0

package/package.json

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

package/payrails.d.ts

@@ -89,6 +89,7 @@ declare enum PAYMENT_METHOD_CODES {
     'PAYPAL' = "payPal",
     'APPLE_PAY' = "applePay",
     'GENERIC_REDIRECT' = "genericRedirect",
+    'LEAN' = "lean",
     'MERCADO_PAGO' = "mercadoPago",
     'PIX' = "pix",
     'BANK_ACCOUNT' = "bankAccount",
@@ -344,6 +345,12 @@ interface WorkflowExecutionResponse {
                     orderId?: string;
                     tokenId?: string;
                 };
+                paymentId?: string;
+                sdkToken?: string;
+                app_token?: string;
+                successUrl?: string;
+                failureUrl?: string;
+                sandbox?: boolean;
             };
         };
         redirect?: string;
@@ -1364,6 +1371,7 @@ declare class CardForm extends PayrailsElementWithStoreInstrumentCheckbox {
     update(options: Partial<Pick<CardFormOptions, 'styles' | 'translations' | 'events'>>): void;
     updateInstallmentConfig(installmentConfig?: InstallmentUpdateConfig): void;
     private createFormField;
+    private isFieldRequired;
     private initializeCustomLayout;
     private hasFieldBeenUsed;
     private initializeDefaultLayout;
@@ -1543,6 +1551,92 @@ declare class GooglePayButton extends PayrailsElementWithStoreInstrumentCheckbox
     unmount(): void;
 }
 
+interface LeanButtonOptions {
+    id?: string;
+    events?: PaymentEvents;
+    translations?: {
+        label?: string;
+    };
+    styles?: {
+        button?: {
+            base?: Partial<CSSStyleDeclaration>;
+            loading?: Partial<CSSStyleDeclaration>;
+            hover?: Partial<CSSStyleDeclaration>;
+        };
+        dialog?: LeanCustomization;
+    };
+    returnInfo?: ReturnInfo;
+}
+type LeanCallbackResponse = {
+    status?: string;
+    message?: string;
+    last_api_response?: string;
+    exit_point?: string;
+    secondary_status?: string;
+    bank?: {
+        bank_identifier?: string;
+        is_supported?: boolean;
+    };
+};
+type LeanCheckoutPayload = {
+    app_token: string;
+    access_token: string;
+    payment_intent_id: string;
+    success_redirect_url: string;
+    fail_redirect_url: string;
+    sandbox?: boolean;
+    bank_identifier?: string;
+    customization?: LeanCustomizationPayload;
+    callback: (response: LeanCallbackResponse) => void;
+};
+type LeanCustomization = {
+    themeColor?: string;
+    buttonTextColor?: string;
+    buttonBorderRadius?: string;
+    linkColor?: string;
+    overlayColor?: string;
+};
+type LeanCustomizationPayload = {
+    theme_color?: string;
+    button_text_color?: string;
+    button_border_radius?: string;
+    link_color?: string;
+    overlay_color?: string;
+};
+declare global {
+    interface Window {
+        Lean?: {
+            checkout: (payload: LeanCheckoutPayload) => void;
+        };
+    }
+}
+declare class LeanButton extends PayrailsElement {
+    private static leanSdkClient;
+    private readonly options;
+    private isLoading;
+    private readonly paymentExecutor;
+    private readonly handleClick;
+    private readonly handleMouseEnter;
+    private readonly handleMouseLeave;
+    private readonly handleSessionExpired;
+    constructor(options: LeanButtonOptions);
+    mount(location: string): void;
+    unmount(): void;
+    private static getLeanSDK;
+    static resetLeanSDK(): void;
+    private bindEvents;
+    private unbindEvents;
+    private setStyles;
+    private removeStyles;
+    private triggerLoading;
+    private renderLoadingMarkup;
+    private getConfirmActionParameters;
+    private startLeanCheckout;
+    private handleLeanCheckoutResponse;
+    private toLeanCustomizationPayload;
+    private onClick;
+}
+
 interface DropinElementEvents extends PaymentEvents {
     onActivate?: () => void;
     onDeactivate?: () => void;
@@ -1657,6 +1751,15 @@ interface GooglePayDropinOptions extends GooglePayButtonOptions {
     events?: GooglePayButtonOptions['events'] & DropinElementEvents;
 }
 
+interface LeanDropinOptions extends Omit<LeanButtonOptions, 'styles'> {
+    paymentMethod: StorablePaymentCompositionOption;
+    translations?: LeanButtonOptions['translations'];
+    events?: LeanButtonOptions['events'] & DropinElementEvents;
+    styles?: LeanButtonOptions['styles'];
+    elementStyles?: DropinElementStyles;
+    returnInfo?: ReturnInfo;
+}
+
 interface PaypalButtonOptions extends StoreInstrumentElementOptions {
     events?: PaymentEvents & UIEvents & {
         onPaypalAvailable?: () => void;
@@ -1732,6 +1835,7 @@ declare class Dropin extends PayrailsElement {
     private applePay;
     private cardForm;
     private paypal;
+    private lean;
     private loadingScreen;
     constructor(collectContainer: PayrailsCollectContainer, clientConfig: PayrailsClientOptions, dropinConfig: DropinOptions);
     private get returnInfo();
@@ -1745,6 +1849,7 @@ declare class Dropin extends PayrailsElement {
     private createCreditCardButton;
     private createGooglePayButton;
     private createPayPalButton;
+    private createLeanButton;
     private createCardForm;
     private createApplePayButton;
     private createCardPaymentButton;
@@ -1763,6 +1868,7 @@ interface StorablePaymentMethodConfiguration extends StoreInstrumentElementOptio
     showStoredInstruments?: boolean;
     showPaymentMethodLogo?: boolean;
 }
+type LeanPaymentMethodConfiguration = Omit<StorablePaymentMethodConfiguration, 'showPaymentMethodLogo'>;
 interface DropinOptions {
     paymentMethodsConfiguration?: {
         [key: string]: any;
@@ -1784,6 +1890,7 @@ interface DropinOptions {
         applePay?: {
             clientDomain?: string;
         } & StorablePaymentMethodConfiguration;
+        lean?: LeanPaymentMethodConfiguration;
     };
     returnInfo?: ReturnInfo;
     events?: PayrailsSDKEvents;
@@ -1801,6 +1908,7 @@ interface DropinOptions {
         mercadoPago?: GenericRedirectDropinOptions['translations'];
         addressSelector?: AddressSelectorElementOptions['translations'];
         applePayButton?: ApplePayDropinOptions['translations'];
+        leanButton?: LeanDropinOptions['translations'];
         errorMessages?: {
             [key in ERROR_RESULT]?: string;
         };
@@ -1812,6 +1920,7 @@ interface DropinOptions {
         googlePayButton?: GooglePayButtonOptions['styles'];
         paypalButton?: PaypalDropinOptions['styles'];
         applePayButton?: ApplePayButtonOptions['styles'];
+        leanButton?: LeanButtonOptions['styles'];
         cardForm?: CardFormOptions['styles'];
         cardPaymentButton?: CardPaymentButtonOptions['styles'];
         authSuccess?: Partial<CSSStyleDeclaration>;
@@ -1955,7 +2064,8 @@ interface PayPalScriptConfig {
 declare enum ThirdPartySDK {
     ApplePay = "https://applepay.cdn-apple.com/jsapi/1.latest/apple-pay-sdk.js",
     GooglePay = "https://pay.google.com/gp/p/js/pay.js",
-    PayPal = "paypal-sdk"
+    PayPal = "paypal-sdk",
+    Lean = "https://cdn.leantech.me/link/loader/prod/ae/latest/lean-link-loader.min.js"
 }
 
 interface QueryDefinition<T> {
@@ -1991,6 +2101,7 @@ declare class Payrails {
     private __cardList;
     private __cardPaymentButton;
     private __paypalButton;
+    private __leanButton;
     private __genericRedirectButton;
     private __dynamicElementForm;
     private __dropin;
@@ -2018,6 +2129,7 @@ declare class Payrails {
     getAvailablePaymentMethods(): PaymentMethodCode[];
     paymentButton(options: CardPaymentButtonOptions): CardPaymentButton;
     paypalButton(options?: PaypalButtonOptions): PaypalButton;
+    leanButton(options: LeanButtonOptions): LeanButton;
     genericRedirectButton(options: GenericRedirectButtonOptions): GenericRedirectButton;
     dynamicElement(options: DynamicElementOptions): DynamicElementForm;
     getSavedPaypalAccounts(): StoredPaymentInstrument<PayPalMetadata>[];
@@ -2133,4 +2245,4 @@ interface PayrailsClientOptions {
 }
 
 export { AuthorizationFailureReasons, ElementType, INTEGRATION_TYPE, PAYMENT_METHOD_CODES, Payrails, PayrailsCollectContainer, PayrailsEnvironment };
-export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, CollectContainerOptions, DropinOptions, ExecutionMeta, ExecutionMetaCustomer, ExecutionMetaKey, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, SaveInstrumentResponse, WorkflowExecutionResponse };
+export type { ApplePayButtonOptions, CardFormOptions, CardListOptions, CardPaymentButtonOptions, CollectContainerOptions, DropinOptions, ExecutionMeta, ExecutionMetaCustomer, ExecutionMetaKey, GenericRedirectButtonOptions, GooglePayButtonOptions, InitOptions, LeanButtonOptions, PaymentEvents, PaypalButtonOptions, PayrailsAmount, PayrailsClientOptions, PayrailsContainerType, PayrailsSecureField, PayrailsSecureFieldEvent, ReturnInfo, SaveInstrumentResponse, WorkflowExecutionResponse };