@sanctum-key/react-native-sdk 1.0.4 → 1.0.5

package/README.md

@@ -1,6 +1,7 @@
-# Sanctumkey KYC SDK
+# Sanctum Key KYC SDK
+
+A comprehensive React Native SDK for identity verification (KYC — Know Your Customer) with Expo support, featuring advanced camera capabilities powered by `react-native-vision-camera`.
 
-A comprehensive React Native SDK for identity verification (KYC - Know Your Customer) with Expo support, featuring advanced camera capabilities powered by react-native-vision-camera.
 
 ## 🚀 Features
 
@@ -20,17 +21,43 @@ A comprehensive React Native SDK for identity verification (KYC - Know Your Cust
 ✅ **Country Selection** with region mapping  
 ✅ **Reusable UI Components**
 
-## 📦 Installation
+## Installation
+
+To avoid version conflicts, install the SDK and its peer dependencies in three distinct steps.
+
+### Prerequisites
 
-### Installing Dependencies
+Initialize a new Expo project with TypeScript (recommended):
 
 ```bash
-npm install @sanctum-key/react-native-sdk react-native-vision-camera expo-location expo-image-manipulator react-native-svg
+npx create-expo-app@latest my-kyc-app --template blank-typescript
+cd my-kyc-app
 ```
 
-### Expo Configuration (app.json / app.config.js)
+### Step 1 — Install the SDK
 
-Add the plugin to your Expo configuration file:
+```bash
+npm install @sanctum-key/react-native-sdk --legacy-peer-deps
+```
+
+### Step 2 — Install Native Expo Dependencies
+
+Use `npx expo install` so Expo automatically resolves the correct versions for your SDK build (e.g., SDK 53 or 54):
+
+```bash
+npx expo install react-native-vision-camera expo-location expo-image-manipulator react-native-svg
+```
+
+### Step 3 — Install Standard NPM Dependencies
+
+```bash
+npm install axios i18n-js iconsax-react-nativejs zustand
+```
+
+
+## Expo Configuration
+
+Because this SDK uses the camera and location, add the plugin to your `app.json` (or `app.config.js`) to automatically inject the correct native permissions for iOS and Android.
 
 ```json
 {
@@ -52,8 +79,8 @@ Add the plugin to your Expo configuration file:
             "microphonePermissionText": "This app uses the microphone for video recording."
           },
           "location": {
-            "locationPermissionText": "This app uses location to verify your identity and location.",
-            "locationWhenInUsePermissionText": "This app uses location to verify your identity and location.",
+            "locationPermissionText": "This app uses location to verify your identity.",
+            "locationWhenInUsePermissionText": "This app uses location to verify your identity.",
             "enableBackgroundLocation": false
           }
         }
@@ -63,216 +90,180 @@ Add the plugin to your Expo configuration file:
 }
 ```
 
-### Android Setup
+> **Important:** After updating your `app.json`, you must generate a new native build (`eas build --profile development` or `npx expo prebuild`) for the permissions to take effect.
 
-The config plugin automatically handles Android permissions. No additional setup required.
+### Building the App for Development
 
-### iOS Setup
+Since this SDK requires custom native code (camera and location permissions), you cannot use Expo Go. You must create a development build using Expo Application Services (EAS).
 
-iOS permissions are also automatically handled by the Expo plugin.
+1. Install the EAS CLI:
 
-## 🎯 Quick Start
+   ```bash
+   npm install -g eas-cli
+   ```
 
-### Using JSON Templates (Recommended)
+2. Log in and configure the build:
 
-The recommended approach is to use the JSON template system to configure your KYC flow:
+   ```bash
+   eas login
+   eas build:configure
+   ```
 
-```tsx
-import React from 'react';
-import { LaunchTransferGratisKYC } from '@sanctumkey/react-native-sdk';
+3. Run the build (select the `development` profile):
 
-export default function App() {
-  return (
-    <LaunchTransferGratisKYC
-          onComplete={(data:VerificationState) => {
-            Alert.alert('Template KYC completed');
-            setShowTemplateKYC(false);
-            console.log('Template KYC completed', JSON.stringify(data, null, 2));
-          }}
-          onCancel={() => {
-            setShowTemplateKYC(false);
-            Alert.alert('Template KYC cancelled');
-          }}
-          onError={(error) => {
-            Alert.alert('Template KYC error', error);
-            setShowTemplateKYC(false);
-          }}
-          language="en"
-          API_KEY={undefined} // for test env leave this blanc
-        />
-  );
-}
-```
+   ```bash
+   eas build --profile development --platform android
+   # or --platform ios
+   ```
 
+4. Once the build finishes, install the app on your device or emulator and start the local development server:
 
-## 🛠️ Development
+   ```bash
+   npx expo start --dev-client
+   ```
 
-### Building the SDK
 
-```bash
-cd transfergratis-sdk
-npm install
-npm run build
-```
+## Quick Start
 
-### Running the Example
+The recommended approach is to use the JSON template system to configure your KYC flow. Drop this into your `App.tsx`:
 
-```bash
-cd transfergratis-sdk/example
-npm install
-npm run ios # or npm run android
-```
+```tsx
+import React, { useState } from 'react';
+import { Alert, View, StyleSheet } from 'react-native';
+import { LaunchTransferGratisKYC, VerificationState } from '@sanctum-key/react-native-sdk';
 
-### Testing
+export default function App() {
+  const [showKYC, setShowKYC] = useState(true);
 
-```bash
-npm test
-```
+  if (!showKYC) return <View style={styles.container} />;
 
-### Linting
+  return (
+    <View style={styles.container}>
+      <LaunchTransferGratisKYC
+        onComplete={(data: VerificationState) => {
+          Alert.alert('Success', 'KYC Verification Completed');
+          setShowKYC(false);
+          console.log('KYC Data:', JSON.stringify(data, null, 2));
+        }}
+        onCancel={() => {
+          Alert.alert('Cancelled', 'User exited the KYC flow');
+          setShowKYC(false);
+        }}
+        onError={(error) => {
+          Alert.alert('Error', String(error));
+          setShowKYC(false);
+        }}
+        language="en"
+        API_KEY={undefined} // Leave undefined for test environments
+        env="PRODUCTION"
+      />
+    </View>
+  );
+}
 
-```bash
-npm run lint
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+  },
+});
 ```
 
-## 🚀 npm Publishing
 
-### Prerequisites
+## Supported Document Types
 
-- npm account with publish rights for the `@sanctum-key/react-native-sdk` package
-- Node 18+ and npm 9+
+| Key | Description |
+|---|---|
+| `identity_card` | Identity card |
+| `passport` | Passport |
+| `drivers_licence` | Driver's license |
+| `health_insurance_card` | Health insurance card |
+| `permanent_residence` | Permanent residence permit |
+| `national_id` | National ID card |
+| `work_permit` | Work permit |
 
-### Release Steps
 
-1. **Install and clean**
-
-```bash
-cd transfergratis-sdk
-npm ci
-npm run clean
-```
+## Multilingual Support
 
-2. **Build the SDK**
+The SDK currently supports **French** and **English**. Texts can be customized via the JSON template system using `LocalizedText` objects:
 
-```bash
-npm run build
+```json
+{
+  "labels": {
+    "en": "Upload your ID card",
+    "fr": "Téléversez votre carte d'identité"
+  }
+}
 ```
 
-3. **Verify content to be published**
 
-```bash
-npm publish --dry-run
-npm pack
-tar -tf transfergratis-react-native-sdk-*.tgz | cat
-```
-
-4. **Bump version**
+## Troubleshooting
 
+**`Unable to resolve "@sanctum-key/react-native-sdk"`**  
+Metro has cached an old build. Stop your server and run:
 ```bash
-# patch | minor | major | prerelease
-npm version patch -m "release: %s"
+npx expo start --clear
 ```
 
-5. **npm login (if needed)**
+**`Unable to resolve "react-native-svg"` / `"expo-image-manipulator"`**  
+You are missing a peer dependency. Re-run the installation commands in Steps 2 and 3, then clear your Metro cache.
 
-```bash
-npm whoami || npm login
-```
+**Camera or location crashes on launch**  
+You likely haven't rebuilt your native app since adding the plugin to `app.json`. Run an EAS build to inject the permissions into your `AndroidManifest.xml` and `Info.plist`.
 
-6. **Publish to npm (public)**
 
-```bash
-npm publish --access public
-```
+## Development & Publishing
 
-- With 2FA:
+> This section is intended for SDK maintainers.
 
-```bash
-npm publish --access public --otp=123456
-```
+### Building Locally
 
-- Publish a pre-release (beta tag):
+When modifying the SDK, ensure all static assets (`.gif`, `.svg`) are correctly copied to the build folder:
 
 ```bash
-npm publish --tag beta --access public
+npm install
+npm run build
 ```
 
-7. **Push git tags**
+### Publishing to NPM
+
+Clean and build a fresh copy:
 
 ```bash
-git push && git push --tags
+npm ci
+npm run clean
+npm run build
 ```
 
-8. **Verify published version**
+Bump the version:
 
 ```bash
-npm info @sanctum-key/react-native-sdk version
+# Choose one: patch | minor | major
+npm version patch -m "release: %s"
 ```
 
-## 📝 Supported Document Types
+Publish to the public registry:
 
-The SDK supports several government document types:
-
-- `identity_card` - Identity card
-- `passport` - Passport
-- `drivers_licence` - Driver's license
-- `health_insurance_card` - Health insurance card
-- `permanent_residence` - Permanent residence permit
-- `national_id` - National ID card
-- `work_permit` - Work permit
-
-## 🌍 Multilingual Support
-
-The SDK currently supports French and English. Texts can be customized via the JSON template system using `LocalizedText` objects:
-
-```tsx
-{
-  labels: {
-    en: "Upload your ID card",
-    fr: "Téléversez votre carte d'identité"
-  }
-}
+```bash
+npm publish --access public
 ```
 
-## 🚨 Breaking Changes
-
-### v0.1.10
-
-- **JSON Template System**: New JSON-based configuration system
-- **Specialized KYC Components**: New components for each KYC flow step
-- **Web Support**: Added support for web applications
-- **Liveness Detection Improvements**: Enhanced orientation video processing
-- **Multilingual Support**: Improved support for multiple languages
-
-### v0.1.0
-
-- **Camera Implementation**: Switched from custom native views to react-native-vision-camera
-- **Permissions**: Now requires both camera and microphone permissions
-- **Component Props**: Updated prop interfaces for better type safety
-- **Config Plugin**: New plugin required for automatic permissions setup
-
-## 🤝 Contributing
+## Contributing
 
 1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
+2. Create your feature branch: `git checkout -b feature/amazing-feature`
+3. Commit your changes: `git commit -m 'Add some amazing feature'`
+4. Push to the branch: `git push origin feature/amazing-feature`
 5. Open a Pull Request
 
-## 📄 License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+## License
 
-## 🆘 Support
+This project is licensed under the **MIT License** — see the [LICENSE](./LICENSE) file for details.
 
-For support, email support@transfergratis.com or open an issue on GitHub.
 
-## 📚 Additional Resources
+## Support
 
-- [Vision Camera Documentation](https://react-native-vision-camera.com/)
-- [Expo Documentation](https://docs.expo.dev/)
-- [GitHub Repository](https://github.com/TransfergratisOrg/KYC-User-Frontend)
+For support, email [support@transfergratis.com](mailto:support@sanctumkey.com) or open an issue on GitHub.
 
----
 
-Built with ❤️ by the TransferGratis Team
+Built with ❤️ by the [Sanctum Key](https://service.sanctumkey.com) Team

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sanctum-key/react-native-sdk",
-    "version": "1.0.4",
+    "version": "1.0.5",
     "description": "Sanctum Key React Native SDK",
     "main": "build/src/index.js",
     "types": "build/src/index.d.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanctum-key/react-native-sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Sanctum Key React Native SDK",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",