@paynext/sdk 0.0.32 → 0.0.34

package/README.md

@@ -1,54 +1,112 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config({
-  extends: [
-    // Remove ...tseslint.configs.recommended and replace with this
-    ...tseslint.configs.recommendedTypeChecked,
-    // Alternatively, use this for stricter rules
-    ...tseslint.configs.strictTypeChecked,
-    // Optionally, add this for stylistic rules
-    ...tseslint.configs.stylisticTypeChecked,
-  ],
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
+# PayNext TypeScript SDK
+
+TypeScript SDK for integrating PayNext payment processing with full type safety and multiple payment methods support.
+
+## Installation
+
+```bash
+npm install @paynext/sdk
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+## Quick Start
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+```typescript
+import { PayNextCheckout, type PaymentResult } from '@paynext/sdk'
 
-export default tseslint.config({
-  plugins: {
-    // Add the react-x and react-dom plugins
-    'react-x': reactX,
-    'react-dom': reactDom,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended typescript rules
-    ...reactX.configs['recommended-typescript'].rules,
-    ...reactDom.configs.recommended.rules,
+const checkout = new PayNextCheckout(document.getElementById('checkout-form'))
+
+await checkout.mount({
+  clientToken: 'your-client-token',
+  onCheckoutComplete: (result: PaymentResult) => {
+    console.log('Payment successful!', result)
   },
+  onCheckoutFail: (error: Error) => {
+    console.error('Payment failed:', error.message)
+  }
 })
 ```
+
+## React Example
+
+```tsx
+import { useEffect, useRef } from 'react'
+import { PayNextCheckout, type PaymentResult } from '@paynext/sdk'
+
+// interface
+interface IProps {
+  clientToken: string
+}
+
+// component
+export const CheckoutComponent: FC<Readonly<IProps> = (props) => {
+  const { clientToken } = props
+
+  const checkoutRef = useRef<HTMLDivElement>(null)
+
+  useEffect(() => {
+    if (!clientToken) {
+      return
+    }
+
+    const checkout = new PayNextCheckout(checkoutRef.current)
+    
+    checkout.mount({
+      clientToken,
+      locale: 'en',
+      onCheckoutComplete: (result: PaymentResult) => {
+        // Handle successful payment
+        console.log('Payment completed:', result.paymentMethod, result.transactionId)
+      },
+      onCheckoutFail: (error: Error) => {
+        // Handle payment failure
+        console.error('Payment failed:', error.message)
+      }
+    })
+  }, [clientToken])
+
+  // return
+  return <div ref={checkoutRef} />
+}
+```
+
+## Configuration
+
+```typescript
+interface PayNextConfig {
+  clientToken: string             // Required
+  supportedCardTypes?: CardType[] // Optional: restrict card types
+  variant?: 'default' | 'compact' // Optional: UI variant
+  locale?: Locale                 // Optional: language (en, de, fr, etc.)
+  translate?: CheckoutTranslate   // Optional: custom translations
+  onCheckoutComplete?: (result: PaymentResult) => void
+  onCheckoutFail?: (error: Error) => void
+}
+```
+
+## Supported Payment Methods
+
+- **Cards**: Visa, Mastercard, American Express, Discover, JCB, Diners Club, UnionPay, Maestro
+- **Digital Wallets**: Apple Pay, Google Pay
+- **Alternative**: PayPal
+
+## Supported Languages
+
+English, German, French, Spanish, Italian, Portuguese, Dutch, Polish, Czech, Slovak, Hungarian, Romanian, Bulgarian, Croatian, Slovenian, Estonian, Latvian, Lithuanian, Finnish, Swedish, Danish, Norwegian, Russian, Ukrainian, Arabic, Chinese, Japanese, Korean, Thai, Vietnamese, Indonesian, Malay, Filipino, Hindi, Turkish, Greek, Maltese.
+
+## TypeScript Support
+
+Full TypeScript support with comprehensive type definitions for all interfaces, payment methods, and configuration options.
+
+## Browser Support
+
+The SDK supports recent versions of all major browsers:
+
+- Chrome (v90+)
+- Safari (v14+)
+- Firefox (v88+)
+- Edge (v90+)
+- Android WebView / WKWebView (for in-app flows)
+
+## Security
+
+PCI DSS compliant with end-to-end encryption. No sensitive payment data is stored locally.

package/dist/index.d.ts

@@ -247,6 +247,57 @@ declare type Listener<TData> = (data: TData) => void;
 
 export declare type Locale = 'ar' | 'en' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'es' | 'et' | 'fi' | 'fil' | 'fr' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'ru' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'ro' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh';
 
+export declare interface PaymentResult {
+    paymentMethod: 'card' | 'apple_pay' | 'google_pay' | 'paypal';
+    transactionId?: string;
+    clientSession: string;
+    paymentDetails?: {
+        card?: {
+            brand: string;
+            lastFour: string;
+            expMonth?: number;
+            expYear?: number;
+            funding?: string;
+            country?: string;
+        };
+        applePay?: {
+            network: string;
+            lastFour?: string;
+            billingContact?: {
+                name?: string;
+                email?: string;
+                phone?: string;
+            };
+        };
+        googlePay?: {
+            network: string;
+            lastFour?: string;
+        };
+        paypal?: {
+            payerId?: string;
+            email?: string;
+        };
+    };
+    billingAddress?: {
+        name?: string;
+        line1?: string;
+        line2?: string;
+        city?: string;
+        state?: string;
+        postalCode?: string;
+        country?: string;
+    };
+    amount?: {
+        value: number;
+        currency: string;
+    };
+    metadata?: {
+        timestamp: string;
+        userAgent?: string;
+        locale?: string;
+    };
+}
+
 declare enum PaymentType {
     Card = "CARD"
 }
@@ -266,7 +317,7 @@ export declare interface PayNextConfig {
     styles?: StylesConfig;
     translate?: DeepPartial<CheckoutTranslate>;
     locale?: Locale;
-    onCheckoutComplete?: () => void;
+    onCheckoutComplete?: (result: PaymentResult) => void;
     onCheckoutFail?: (error: Error) => void;
 }