@yuno-payments/sdk-web-types 5.7.1-CORECM-17780.1 → 5.8.1

package/dist/global.d.ts

@@ -479,13 +479,21 @@ type InitializeOptions = {
      * Whitelabel override for every Yuno-hosted runtime URL the SDK reads
      * from its environment (REST, payment/enrollment WebSockets, 3DS
      * challenge/setup/event-origin, the SDK web bundle base, the card form,
-     * and the secure-field iframes). Path/query/hash/scheme of each URL are
-     * preserved; only the host (and ws↔wss) is swapped. The merchant-side
-     * gateway must therefore route every Yuno path under this single host.
+     * and the secure-field iframes). The host (and ws↔wss scheme) of each
+     * URL is swapped to this value while the env URL's own path/query/hash
+     * is kept.
+     *
+     * A base path on this value is supported: when the override carries one
+     * (e.g. a proxy mounted at `https://host/orchestrator`), that prefix is
+     * prepended to every resource path so all traffic stays under the
+     * sub-path. The 3DS postMessage event origin is the sole exception — it
+     * stays scheme+host only. The merchant-side gateway must therefore route
+     * every Yuno path under this single host (and optional base path).
      *
      * If `assetUrl` is unset, this also drives the lazy-chunk public path.
      *
      * @example 'https://payments.merchant.example.com'
+     * @example 'https://payments.merchant.example.com/orchestrator'
      */
     apiUrl?: string;
     /**
@@ -746,6 +754,59 @@ interface SecureFields {
 }
 
 declare namespace ExternalButtonsNameSpace {
+    type PaypalBraintreeButtonStyleConfig = {
+        type?: 'pay' | 'checkout' | 'buynow' | 'subscribe';
+        color?: 'gold' | 'blue' | 'white';
+        borderRadius?: number;
+        height?: number;
+        width?: number;
+    };
+    type ShippingAddressOverride = {
+        line1: string;
+        line2?: string;
+        city: string;
+        state: string;
+        postalCode: string;
+        countryCode: string;
+        phone?: string;
+        recipientName?: string;
+        recipientEmail?: string;
+    };
+    type GetShippingAddressOverride = () => ShippingAddressOverride | undefined;
+    type ShippingAddress = {
+        city: string;
+        state: string;
+        postalCode: string;
+        countryCode: string;
+    };
+    type OnShippingAddressChangeArgs = {
+        shippingAddress: ShippingAddress;
+        paypalOrderId: string;
+    };
+    type AmountBreakdown = {
+        itemTotal: string;
+        shipping?: string;
+        tax?: string;
+    };
+    type ShippingAddressUpdatePrice = {
+        action: 'UPDATE_PRICE';
+        amount: string;
+        breakdown?: AmountBreakdown;
+    };
+    type ShippingAddressAccept = {
+        action: 'ACCEPT';
+    };
+    type ShippingAddressReject = {
+        action: 'REJECT';
+        reason?: 'COUNTRY' | 'STATE' | 'POSTAL_CODE' | 'ADDRESS';
+    };
+    type ShippingAddressChangeResult = ShippingAddressUpdatePrice | ShippingAddressAccept | ShippingAddressReject;
+    type OnShippingAddressChange = (args: OnShippingAddressChangeArgs) => Promise<ShippingAddressChangeResult>;
+    type PaypalBraintreeButtonConfig = {
+        style?: PaypalBraintreeButtonStyleConfig;
+        shippingAddressOverride?: GetShippingAddressOverride;
+        onShippingAddressChange?: OnShippingAddressChange;
+    };
     type ExternalButton = {
         elementSelector: string;
         paymentMethodType: string;
@@ -796,6 +857,7 @@ declare namespace ExternalButtonsNameSpace {
         applePay?: ApplePayButtonConfig;
         paypal?: PayPalButtonConfig;
         revolutPay?: RevolutPayButtonConfig;
+        paypalBraintree?: PaypalBraintreeButtonConfig;
     };
 }
 
@@ -995,31 +1057,21 @@ interface MountStatusPaymentArgs {
     yunoError?: SdkPaymentsConfig["error"];
 }
 type ContinuePaymentResponse = {
-    /**
-     * Redirect handed back to the integrator (`open_external_browser`):
-     * the SDK does NOT navigate in this case.
-     */
-    action: "REDIRECT_URL";
     type: string;
-    redirect_url: {
-        init_url: string;
-        success_url: string;
-        error_url: string;
+    action: string;
+    redirect_url?: {
+        init_url?: string;
+        success_url?: string;
+        error_url?: string;
     };
-} | {
-    /**
-     * In-page navigation redirect: the SDK navigates (window.location or
-     * form POST) right after resolving. Integrators can keep their own
-     * loader visible until the navigation commits.
-     */
-    action: "REDIRECT_URL" | "THREE_D_SECURE_REDIRECT_URL";
-    type: string;
-} | null;
+};
+type OnActionExecuted = (result: ContinuePaymentResponse) => void;
 type ContinuePaymentArgs = {
     /**
      * @default true
      */
     showPaymentStatus?: boolean;
+    onActionExecuted?: OnActionExecuted;
 };
 type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "createPayment" | "yunoCreatePayment">;
 type ShowLoaderOptions = {
@@ -1045,7 +1097,7 @@ interface SdkPaymentsInstance extends ExternalButtonsNameSpace.ExternalButtonMet
     updateCheckoutSession(checkout: string): Promise<void>;
     submitOneTimeTokenForm(): Promise<void>;
     startPayment(): Promise<void>;
-    continuePayment(args?: ContinuePaymentArgs): Promise<ContinuePaymentResponse>;
+    continuePayment(args?: ContinuePaymentArgs): Promise<ContinuePaymentResponse | null>;
     notifyError(): Promise<void>;
     mountEnrollmentLite(args: MountEnrollmentLiteArgs): Promise<void>;
     showLoader(args?: ShowLoaderOptions): Promise<void>;

package/dist/index.d.ts

@@ -479,13 +479,21 @@ type InitializeOptions = {
      * Whitelabel override for every Yuno-hosted runtime URL the SDK reads
      * from its environment (REST, payment/enrollment WebSockets, 3DS
      * challenge/setup/event-origin, the SDK web bundle base, the card form,
-     * and the secure-field iframes). Path/query/hash/scheme of each URL are
-     * preserved; only the host (and ws↔wss) is swapped. The merchant-side
-     * gateway must therefore route every Yuno path under this single host.
+     * and the secure-field iframes). The host (and ws↔wss scheme) of each
+     * URL is swapped to this value while the env URL's own path/query/hash
+     * is kept.
+     *
+     * A base path on this value is supported: when the override carries one
+     * (e.g. a proxy mounted at `https://host/orchestrator`), that prefix is
+     * prepended to every resource path so all traffic stays under the
+     * sub-path. The 3DS postMessage event origin is the sole exception — it
+     * stays scheme+host only. The merchant-side gateway must therefore route
+     * every Yuno path under this single host (and optional base path).
      *
      * If `assetUrl` is unset, this also drives the lazy-chunk public path.
      *
      * @example 'https://payments.merchant.example.com'
+     * @example 'https://payments.merchant.example.com/orchestrator'
      */
     apiUrl?: string;
     /**
@@ -746,6 +754,59 @@ interface SecureFields {
 }
 
 declare namespace ExternalButtonsNameSpace {
+    type PaypalBraintreeButtonStyleConfig = {
+        type?: 'pay' | 'checkout' | 'buynow' | 'subscribe';
+        color?: 'gold' | 'blue' | 'white';
+        borderRadius?: number;
+        height?: number;
+        width?: number;
+    };
+    type ShippingAddressOverride = {
+        line1: string;
+        line2?: string;
+        city: string;
+        state: string;
+        postalCode: string;
+        countryCode: string;
+        phone?: string;
+        recipientName?: string;
+        recipientEmail?: string;
+    };
+    type GetShippingAddressOverride = () => ShippingAddressOverride | undefined;
+    type ShippingAddress = {
+        city: string;
+        state: string;
+        postalCode: string;
+        countryCode: string;
+    };
+    type OnShippingAddressChangeArgs = {
+        shippingAddress: ShippingAddress;
+        paypalOrderId: string;
+    };
+    type AmountBreakdown = {
+        itemTotal: string;
+        shipping?: string;
+        tax?: string;
+    };
+    type ShippingAddressUpdatePrice = {
+        action: 'UPDATE_PRICE';
+        amount: string;
+        breakdown?: AmountBreakdown;
+    };
+    type ShippingAddressAccept = {
+        action: 'ACCEPT';
+    };
+    type ShippingAddressReject = {
+        action: 'REJECT';
+        reason?: 'COUNTRY' | 'STATE' | 'POSTAL_CODE' | 'ADDRESS';
+    };
+    type ShippingAddressChangeResult = ShippingAddressUpdatePrice | ShippingAddressAccept | ShippingAddressReject;
+    type OnShippingAddressChange = (args: OnShippingAddressChangeArgs) => Promise<ShippingAddressChangeResult>;
+    type PaypalBraintreeButtonConfig = {
+        style?: PaypalBraintreeButtonStyleConfig;
+        shippingAddressOverride?: GetShippingAddressOverride;
+        onShippingAddressChange?: OnShippingAddressChange;
+    };
     type ExternalButton = {
         elementSelector: string;
         paymentMethodType: string;
@@ -796,6 +857,7 @@ declare namespace ExternalButtonsNameSpace {
         applePay?: ApplePayButtonConfig;
         paypal?: PayPalButtonConfig;
         revolutPay?: RevolutPayButtonConfig;
+        paypalBraintree?: PaypalBraintreeButtonConfig;
     };
 }
 
@@ -995,31 +1057,21 @@ interface MountStatusPaymentArgs {
     yunoError?: SdkPaymentsConfig["error"];
 }
 type ContinuePaymentResponse = {
-    /**
-     * Redirect handed back to the integrator (`open_external_browser`):
-     * the SDK does NOT navigate in this case.
-     */
-    action: "REDIRECT_URL";
     type: string;
-    redirect_url: {
-        init_url: string;
-        success_url: string;
-        error_url: string;
+    action: string;
+    redirect_url?: {
+        init_url?: string;
+        success_url?: string;
+        error_url?: string;
     };
-} | {
-    /**
-     * In-page navigation redirect: the SDK navigates (window.location or
-     * form POST) right after resolving. Integrators can keep their own
-     * loader visible until the navigation commits.
-     */
-    action: "REDIRECT_URL" | "THREE_D_SECURE_REDIRECT_URL";
-    type: string;
-} | null;
+};
+type OnActionExecuted = (result: ContinuePaymentResponse) => void;
 type ContinuePaymentArgs = {
     /**
      * @default true
      */
     showPaymentStatus?: boolean;
+    onActionExecuted?: OnActionExecuted;
 };
 type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "createPayment" | "yunoCreatePayment">;
 type ShowLoaderOptions = {
@@ -1045,7 +1097,7 @@ interface SdkPaymentsInstance extends ExternalButtonsNameSpace.ExternalButtonMet
     updateCheckoutSession(checkout: string): Promise<void>;
     submitOneTimeTokenForm(): Promise<void>;
     startPayment(): Promise<void>;
-    continuePayment(args?: ContinuePaymentArgs): Promise<ContinuePaymentResponse>;
+    continuePayment(args?: ContinuePaymentArgs): Promise<ContinuePaymentResponse | null>;
     notifyError(): Promise<void>;
     mountEnrollmentLite(args: MountEnrollmentLiteArgs): Promise<void>;
     showLoader(args?: ShowLoaderOptions): Promise<void>;
@@ -1076,4 +1128,4 @@ interface SdkPayments {
 interface Yuno extends SdkPayments {
 }
 
-export { type ButtonTextCard, C2PHeadless, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalButton, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type ExternalProviderId, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountSeamlessExternalButtonsArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SdkPayments, type SdkPaymentsConfig, type SdkPaymentsInstance, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };
+export { type ButtonTextCard, C2PHeadless, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalButton, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type ExternalProviderId, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountSeamlessExternalButtonsArgs, type MountStatusPaymentArgs, type OnActionExecuted, type OnChangeDataSF, type RenderMode, type SdkPayments, type SdkPaymentsConfig, type SdkPaymentsInstance, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuno-payments/sdk-web-types",
-  "version": "5.7.1-CORECM-17780.1",
+  "version": "5.8.1",
   "types": "dist/index.d.ts",
   "type": "module",
   "publishConfig": {
@@ -22,4 +22,4 @@
     "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.2.2"
   }
-}
+}