@yuno-payments/yuno-sdk-react-native 1.0.16

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Yuno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,621 @@
+# Yuno SDK React Native
+
+<p align="center">
+<img alt="Yuno React Native SDK" loading="lazy" src="https://files.readme.io/2e1d03a6eec5051a64763f36225454778d7125c344f1d741d0c01cfcdafe4186-flutter-image.png" title="" height="auto" width="auto">
+</p>
+
+<div align="center">
+  <a href="https://www.y.uno/">
+    <img alt="Maintained by Yuno" src="https://img.shields.io/badge/maintained_by-Yuno-4E3DD8?style=for-the-badge">
+  </a>
+  <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/license-MIT-purple.svg?style=for-the-badge" alt="License: MIT">
+  </a>
+</div>
+
+<br>
+
+> **⚠️ Open Source Project Notice**
+> 
+> This is an open source project related to YUNO. Support is provided by the community, not by YUNO directly. For community support, please open an issue in this repository.
+
+Yuno React Native SDK empowers you to create seamless payment experiences in your native Android and iOS apps built with React Native. It offers powerful and customizable functionality that can be used to gather payment details from your users efficiently and effectively.
+
+## 📱 Platform Support
+
+|             | Android | iOS   |
+|-------------|---------|-------|
+| **Support** | SDK 21+ | 14.0+ |
+
+## 🚀 Example App
+
+A complete example application is available in the [`example/`](./example) directory. This app demonstrates all SDK features with a fully functional UI:
+
+- ✅ **Full SDK Integration**: All payment flows implemented
+- ✅ **Modern UI**: Clean, professional interface with real-time status monitoring
+- ✅ **Ready to Run**: Pre-configured for both Android and iOS
+- ✅ **Complete Documentation**: Step-by-step guides included
+
+**Quick Start:**
+```bash
+cd example
+npm install
+npm run android  # or npm run ios
+```
+
+See [`example/README.md`](./example/README.md) for detailed instructions.
+
+## ✨ Features
+
+### 1. Powerful Payment Integrations
+- **Multiple Payment Methods**: Supports a variety of payment options including credit cards, debit cards, wallets, and alternative payment methods
+- **Tokenization**: Implements secure tokenization to safely handle sensitive card data, reducing PCI compliance scope
+- **Seamless Payments**: One-tap payments for returning users with saved payment methods
+
+### 2. Flexible Payment Flows
+- **Full Payment Flow**: Complete payment experience with built-in UI
+- **Payment Lite**: Lightweight payment flow for custom integrations
+- **Seamless Payment**: Headless payment flow for maximum customization
+- **Enrollment**: Save payment methods for future use
+
+### 3. Developer-Friendly
+- **TypeScript Support**: Full TypeScript definitions included
+- **Clean Architecture**: Well-structured codebase following React Native best practices
+- **Event-Based**: React to payment events in real-time
+- **Error Handling**: Comprehensive error messages and status reporting
+
+### 4. Security Features
+- **PCI Compliance**: Adheres to PCI DSS standards
+- **3D Secure Support**: Built-in support for additional authentication
+- **Data Encryption**: All transactions protected with advanced encryption
+
+### 5. Localization
+- **Multi-Language Support**: EN, ES, PT, MS, ID, TH
+- **Regional Configuration**: Country-specific payment method support
+
+## 📦 Installation
+
+```bash
+npm install @y.uno/yuno-sdk-react-native
+```
+
+or
+
+```bash
+yarn add @y.uno/yuno-sdk-react-native
+```
+
+## ⚙️ Setup
+
+### Android Configuration
+
+#### 1. Update your `android/build.gradle` (project level):
+
+```gradle
+allprojects {
+    repositories {
+        google()
+        mavenCentral()
+        maven { url "https://yunopayments.jfrog.io/artifactory/snapshots-libs-release" }
+    }
+}
+```
+
+#### 2. Create or update `android/app/src/main/java/.../MainApplication.kt`:
+
+```kotlin
+import android.app.Application
+import com.yunosdkreactnative.YunoSdkModule
+
+class MainApplication : Application(), ReactApplication {
+    override fun onCreate() {
+        super.onCreate()
+        
+        // Initialize Yuno SDK
+        YunoSdkModule.initialize(this, "YOUR_YUNO_API_KEY")
+    }
+    
+    // ... rest of your application code
+}
+```
+
+#### 3. Ensure minimum SDK version in `android/app/build.gradle`:
+
+```gradle
+android {
+    defaultConfig {
+        minSdkVersion 21
+        // ...
+    }
+}
+```
+
+### iOS Configuration
+
+#### 1. Install CocoaPods dependencies:
+
+```bash
+cd ios && pod install && cd ..
+```
+
+#### 2. Update your `Info.plist` if you need to handle deeplinks:
+
+```xml
+<key>CFBundleURLTypes</key>
+<array>
+    <dict>
+        <key>CFBundleURLSchemes</key>
+        <array>
+            <string>your-app-scheme</string>
+        </array>
+    </dict>
+</array>
+```
+
+## 🚀 Usage
+
+### Initialize the SDK
+
+```typescript
+import { YunoSdk, YunoLanguage, CardFlow } from '@y.uno/yuno-sdk-react-native';
+
+// Initialize the SDK
+await YunoSdk.initialize({
+  apiKey: 'YOUR_API_KEY',
+  countryCode: 'CO', // ISO country code
+  yunoConfig: {
+    lang: YunoLanguage.ES,
+    cardFlow: CardFlow.STEP_BY_STEP,
+    saveCardEnabled: true,
+    keepLoader: false,
+    isDynamicViewEnabled: true,
+  },
+});
+```
+
+### Listen to Payment Events
+
+```typescript
+import { YunoSdk, YunoStatus } from '@y.uno/yuno-sdk-react-native';
+import { useEffect } from 'react';
+
+function PaymentScreen() {
+  useEffect(() => {
+    // Listen to payment status
+    const paymentSubscription = YunoSdk.onPaymentStatus((state) => {
+      console.log('Payment Status:', state.status);
+      
+      switch (state.status) {
+        case YunoStatus.SUCCEEDED:
+          console.log('Payment succeeded!');
+          if (state.token) {
+            console.log('OTT Token:', state.token);
+          }
+          break;
+        case YunoStatus.FAILED:
+          console.log('Payment failed');
+          break;
+        case YunoStatus.REJECTED:
+          console.log('Payment rejected');
+          break;
+        case YunoStatus.CANCELLED_BY_USER:
+          console.log('Payment cancelled by user');
+          break;
+        // ... handle other cases
+      }
+    });
+    
+    // Listen to one-time tokens
+    const tokenSubscription = YunoSdk.onOneTimeToken((token) => {
+      console.log('Received OTT:', token);
+      // Use token for server-side processing
+    });
+    
+    return () => {
+      paymentSubscription.remove();
+      tokenSubscription.remove();
+    };
+  }, []);
+  
+  return (
+    // Your UI
+  );
+}
+```
+
+### Start a Full Payment Flow
+
+```typescript
+import { YunoSdk } from '@y.uno/yuno-sdk-react-native';
+
+async function handlePayment() {
+  try {
+    await YunoSdk.startPayment(true); // true to show payment status
+    console.log('Payment flow started');
+  } catch (error) {
+    console.error('Payment error:', error);
+  }
+}
+```
+
+### Start Payment Lite
+
+```typescript
+import { YunoSdk } from '@y.uno/yuno-sdk-react-native';
+
+async function handlePaymentLite() {
+  try {
+    await YunoSdk.startPaymentLite({
+      checkoutSession: 'your_checkout_session_token',
+      methodSelected: {
+        vaultedToken: 'payment_method_token',
+        paymentMethodType: 'CARD',
+      },
+      showPaymentStatus: true,
+    });
+  } catch (error) {
+    console.error('Payment lite error:', error);
+  }
+}
+```
+
+### Start Seamless Payment
+
+```typescript
+import { YunoSdk, YunoStatus } from '@y.uno/yuno-sdk-react-native';
+
+async function handleSeamlessPayment() {
+  try {
+    const status = await YunoSdk.startPaymentSeamlessLite({
+      checkoutSession: 'your_checkout_session_token',
+      methodSelected: {
+        vaultedToken: 'payment_method_token',
+        paymentMethodType: 'CARD',
+      },
+      showPaymentStatus: false,
+      countryCode: 'CO',
+    });
+    
+    console.log('Seamless payment status:', status);
+    
+    if (status === YunoStatus.SUCCEEDED) {
+      // Handle success
+    }
+  } catch (error) {
+    console.error('Seamless payment error:', error);
+  }
+}
+```
+
+### Enrollment Payment
+
+```typescript
+import { YunoSdk, YunoStatus } from '@y.uno/yuno-sdk-react-native';
+import { useEffect } from 'react';
+
+function EnrollmentScreen() {
+  useEffect(() => {
+    // Listen to enrollment status
+    const subscription = YunoSdk.onEnrollmentStatus((state) => {
+      console.log('Enrollment Status:', state.status);
+      
+      switch (state.status) {
+        case YunoStatus.SUCCEEDED:
+          console.log('Enrollment succeeded!');
+          break;
+        case YunoStatus.FAILED:
+          console.log('Enrollment failed');
+          break;
+        // ... handle other cases
+      }
+    });
+    
+    return () => subscription.remove();
+  }, []);
+  
+  const handleEnrollment = async () => {
+    try {
+      await YunoSdk.enrollmentPayment({
+        customerSession: 'customer_session_token',
+        showPaymentStatus: true,
+        countryCode: 'CO',
+      });
+    } catch (error) {
+      console.error('Enrollment error:', error);
+    }
+  };
+  
+  return (
+    // Your UI
+  );
+}
+```
+
+### Handle Deep Links (iOS)
+
+```typescript
+import { YunoSdk } from '@y.uno/yuno-sdk-react-native';
+import { Linking } from 'react-native';
+import { useEffect } from 'react';
+
+function App() {
+  useEffect(() => {
+    // Handle initial URL
+    Linking.getInitialURL().then((url) => {
+      if (url) {
+        YunoSdk.receiveDeeplink(url);
+      }
+    });
+    
+    // Handle URL updates
+    const subscription = Linking.addEventListener('url', (event) => {
+      YunoSdk.receiveDeeplink(event.url);
+    });
+    
+    return () => subscription.remove();
+  }, []);
+  
+  return (
+    // Your app
+  );
+}
+```
+
+### Continue Payment
+
+```typescript
+import { YunoSdk } from '@y.uno/yuno-sdk-react-native';
+
+async function handleContinuePayment() {
+  try {
+    await YunoSdk.continuePayment(true);
+    console.log('Payment continued');
+  } catch (error) {
+    console.error('Continue payment error:', error);
+  }
+}
+```
+
+### Hide Loader
+
+```typescript
+import { YunoSdk } from '@y.uno/yuno-sdk-react-native';
+
+async function hideLoader() {
+  try {
+    await YunoSdk.hideLoader();
+  } catch (error) {
+    console.error('Hide loader error:', error);
+  }
+}
+```
+
+## 📖 API Reference
+
+### YunoSdk
+
+The main class for interacting with the Yuno SDK.
+
+#### Methods
+
+##### `initialize(params)`
+
+Initializes the SDK with configuration.
+
+**Parameters:**
+- `apiKey` (string, required): Your Yuno API key
+- `countryCode` (string, required): ISO country code
+- `yunoConfig` (object, optional): SDK configuration
+  - `lang` (YunoLanguage): Language for the SDK UI
+  - `cardFlow` (CardFlow): Card flow type
+  - `saveCardEnabled` (boolean): Enable save card option
+  - `keepLoader` (boolean): Keep loader visible
+  - `isDynamicViewEnabled` (boolean): Enable dynamic view
+- `iosConfig` (object, optional): iOS-specific configuration
+- `androidConfig` (object, optional): Android-specific configuration
+
+**Returns:** Promise<void>
+
+##### `startPayment(showPaymentStatus)`
+
+Starts a full payment flow.
+
+**Parameters:**
+- `showPaymentStatus` (boolean): Show payment status screen
+
+**Returns:** Promise<void>
+
+##### `startPaymentLite(arguments, countryCode?)`
+
+Starts a payment lite flow.
+
+**Parameters:**
+- `arguments` (StartPayment): Payment configuration
+- `countryCode` (string, optional): Country code override
+
+**Returns:** Promise<void>
+
+##### `startPaymentSeamlessLite(arguments)`
+
+Starts a seamless payment lite flow.
+
+**Parameters:**
+- `arguments` (SeamlessArguments): Seamless payment configuration
+
+**Returns:** Promise<YunoStatus>
+
+##### `enrollmentPayment(arguments)`
+
+Starts an enrollment payment flow.
+
+**Parameters:**
+- `arguments` (EnrollmentArguments): Enrollment configuration
+
+**Returns:** Promise<void>
+
+##### `continuePayment(showPaymentStatus)`
+
+Continues a previously started payment.
+
+**Parameters:**
+- `showPaymentStatus` (boolean): Show payment status screen
+
+**Returns:** Promise<void>
+
+##### `hideLoader()`
+
+Hides the loading indicator.
+
+**Returns:** Promise<void>
+
+##### `receiveDeeplink(url)`
+
+Handles a deep link for payment resumption (iOS only).
+
+**Parameters:**
+- `url` (string): Deep link URL
+
+**Returns:** Promise<void>
+
+##### `onPaymentStatus(listener)`
+
+Subscribes to payment status events.
+
+**Parameters:**
+- `listener` (function): Callback function
+
+**Returns:** Subscription object with `remove()` method
+
+##### `onEnrollmentStatus(listener)`
+
+Subscribes to enrollment status events.
+
+**Parameters:**
+- `listener` (function): Callback function
+
+**Returns:** Subscription object with `remove()` method
+
+##### `onOneTimeToken(listener)`
+
+Subscribes to one-time token events.
+
+**Parameters:**
+- `listener` (function): Callback function
+
+**Returns:** Subscription object with `remove()` method
+
+### Enums
+
+#### YunoLanguage
+
+```typescript
+enum YunoLanguage {
+  EN = 'EN',
+  ES = 'ES',
+  PT = 'PT',
+  MS = 'MW',
+  ID = 'ID',
+  TH = 'TH',
+}
+```
+
+#### YunoStatus
+
+```typescript
+enum YunoStatus {
+  REJECTED = 'REJECTED',
+  SUCCEEDED = 'SUCCEEDED',
+  FAILED = 'FAILED',
+  PROCESSING = 'PROCESSING',
+  INTERNAL_ERROR = 'INTERNAL_ERROR',
+  CANCELLED_BY_USER = 'CANCELLED_BY_USER',
+}
+```
+
+#### CardFlow
+
+```typescript
+enum CardFlow {
+  ONE_STEP = 'ONE_STEP',
+  STEP_BY_STEP = 'STEP_BY_STEP',
+}
+```
+
+## 🔄 Updating Native SDK Versions
+
+### Android Native SDK
+
+To update the Android native SDK version:
+
+1. Navigate to `node_modules/@y.uno/yuno-sdk-react-native/android/build.gradle`
+2. Update the Yuno Android SDK version:
+```gradle
+dependencies {
+    implementation "com.yuno.payments:android-sdk:x.x.x"
+}
+```
+
+### iOS Native SDK
+
+To update the iOS native SDK version:
+
+1. Navigate to `node_modules/@y.uno/yuno-sdk-react-native/ios/YunoSdk.podspec`
+2. Update the Yuno iOS SDK version:
+```ruby
+s.dependency "YunoSDK", "x.x.x"
+```
+3. Run `pod install` in the `ios` directory
+
+## 🏗️ Project Structure
+
+```
+yuno-sdk-react-native/
+├── src/
+│   ├── core/
+│   │   ├── enums/          # TypeScript enums
+│   │   └── types/          # TypeScript type definitions
+│   ├── YunoSdk.ts          # Main SDK class
+│   └── index.ts            # Public API exports
+├── android/                # Android native implementation
+│   └── src/main/java/
+│       └── com/yunosdkreactnative/
+│           ├── YunoSdkModule.kt
+│           └── YunoSdkPackage.kt
+├── ios/                    # iOS native implementation
+│   ├── YunoSdk.swift
+│   ├── YunoSdk.m
+│   └── YunoSdk.podspec
+└── package.json
+```
+
+## 📝 Contributing
+
+We welcome contributions! Please feel free to open issues or submit pull requests.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `yarn install`
+3. Run type checking: `yarn typecheck`
+4. Run linting: `yarn lint`
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🔗 Links
+
+- [Yuno Website](https://www.y.uno/)
+- [Official Documentation](https://docs.y.uno/)
+- [GitHub Repository](https://github.com/yuno-payments/yuno-sdk-react-native)
+
+## 💬 Support
+
+For issues, questions, or contributions, please open an issue in this repository.
+
+---
+
+<div align="center">
+Made with ❤️ by the Yuno Team
+</div>
+