@paynext/sdk 1.0.16 → 1.0.18

package/README.md

@@ -45,7 +45,7 @@ await checkout.mount('checkout-form', {
 ## React Example
 
 ```tsx
-import { useEffect } from 'react'
+import { useEffect, type FC } from 'react'
 import { PayNextCheckout, type PaymentResult, type AttemptResult, type CheckoutError } from '@paynext/sdk'
 
 // interface
@@ -89,7 +89,7 @@ export const CheckoutComponent: FC<Readonly<IProps>> = (props) => {
     })
 
     return () => {
-      checkout.unmount(componentId)
+      checkout.unmount()
     }
   }, [clientToken])
 
@@ -102,15 +102,18 @@ export const CheckoutComponent: FC<Readonly<IProps>> = (props) => {
 
 ```typescript
 interface PayNextConfig {
-  clientToken: string             
+  clientToken: string
   apiVersion: string
-  environment: 'sandbox' | 'production',
-  variant?: 'default' | 'compact' 
-  locale?: Locale                
-  translate?: CheckoutTranslate   
+  environment: 'sandbox' | 'production'
+  variant?: 'default' | 'compact'
+  theme?: 'light' | 'dark' | 'system'
+  locale?: Locale
+  translate?: CheckoutTranslate
   errorMessageText?: string
-  styles?: StylesConfig          
+  returnUrl?: string
+  styles?: StylesConfig
   onCheckoutLoaded?: (result: LoadedResult) => void
+  beforeCheckoutAttempt?: (result: AttemptResult) => boolean | Promise<boolean>
   onCheckoutAttempt?: (result: AttemptResult) => void
   onCheckoutComplete?: (result: PaymentResult) => void
   onCheckoutFail?: (error: CheckoutError) => void
@@ -128,6 +131,29 @@ interface AttemptResult {
 
 ```
 
+### Gate a Payment with `beforeCheckoutAttempt`
+
+`beforeCheckoutAttempt` runs **before** each payment attempt is sent and decides whether it should proceed. It receives the same `AttemptResult` as `onCheckoutAttempt` and may be synchronous or return a `Promise`.
+
+- Return `true` (or `undefined`) — the payment proceeds.
+- Return `false` — the attempt is blocked; the SDK surfaces it as a failure via `onCheckoutFail`.
+- Throw / reject — the attempt is treated as a failure and reported through `onCheckoutFail`.
+
+Use it for last-mile checks such as confirming an order, validating your own state, or asking the user to confirm.
+
+```ts
+const checkout = new PayNextCheckout()
+
+await checkout.mount('checkout-container', {
+  ...config,
+  beforeCheckoutAttempt: async (attempt) => {
+    // e.g. confirm the order on your backend before charging
+    const ok = await confirmOrder(attempt)
+    return ok
+  }
+})
+```
+
 ### Add a Submit Button Icon
 
 Provide inline SVG markup via `styles.SubmitButton.iconSvg` to render an icon to the left of the "Pay with card" button label. The SDK hides the icon and shows a spinner while a payment request is in flight, then restores the icon once processing finishes. A 24x24px viewBox keeps the layout balanced.

package/dist/index.d.ts

@@ -7,7 +7,9 @@ export declare interface AttemptResult {
 
 export declare enum CardType {
     Visa = "visa",
-    Mastercard = "mastercard"
+    Mastercard = "mastercard",
+    Discover = "discover",
+    JCB = "jcb"
 }
 
 export declare interface CheckoutError {
@@ -483,6 +485,7 @@ export declare interface PayNextConfig {
     returnUrl?: string;
     onCheckoutLoaded?: (result: LoadedResult) => void;
     onCheckoutAttempt?: (result: AttemptResult) => void;
+    beforeCheckoutAttempt?: (result: AttemptResult) => boolean | Promise<boolean>;
     onCheckoutComplete?: (result: PaymentResult) => void;
     onCheckoutFail?: (error: CheckoutError) => void;
 }
@@ -506,7 +509,7 @@ export declare interface StylesConfig {
     cssVariables?: CSSVariablesConfig;
 }
 
-export declare type TEnvironment = 'develop' | 'preview1' | 'preview2' | 'staging' | 'sandbox' | 'production';
+export declare type TEnvironment = 'develop' | 'preview1' | 'preview2' | 'preview3' | 'staging' | 'sandbox' | 'production';
 
 export declare type ThemeMode = 'light' | 'dark' | 'system';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paynext/sdk",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "PayNext SDK - Payment processing with automatic CDN loading",
   "type": "module",
   "main": "dist/index.es.js",