react-native-sdk-pianoio 0.3.4 → 0.3.5

package/README.md

@@ -1,28 +1,13 @@
-# 🎹 React Native SDK for Piano.io
+# React Native SDK for Piano.io
 
-[![npm version](https://img.shields.io/npm/v/react-native-sdk-pianoio.svg)](https://www.npmjs.com/package/react-native-sdk-pianoio)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-A React Native SDK for integrating Piano.io's digital monetization platform into your mobile applications. This SDK provides seamless integration with Piano's paywall, subscription, and content monetization features.
+A React Native SDK for integrating Piano.io's digital monetization platform into your mobile applications. This SDK provides seamless, cross-platform integration with Piano's paywall, subscription, and content monetization features.
 
 ## ✨ Features
 
-### 🚀 Core Functionality
-- **Piano Composer Integration**: Full integration with Piano's Composer API
-- **OAuth Authentication**: User authentication and token management
-- **Experience Execution**: Execute Piano experiences with custom configurations
-- **Cross-Platform**: Works on both iOS and Android (Android fully implemented)
-
-### 📱 Platform Support
-- ✅ **Android**: Fully implemented and tested (91% test coverage)
-- 🚧 **iOS**: Basic implementation (needs feature parity)
-
-### 🔧 Configuration Options
-- **Tags Management**: Add/remove tags for content categorization
-- **Zone Configuration**: Set zone IDs for targeted experiences
-- **Custom Variables**: Add custom data to experiences
-- **User Tokens**: Manage user authentication tokens
-- **URL Configuration**: Set referrer and target URLs
+- **Full Piano Composer Integration**: Execute experiences, manage content access, and handle paywalls
+- **Piano ID Authentication**: Complete user authentication and token management for both platforms
+- **Cross-Platform Parity**: A single, unified API for both iOS and Android
+- **Flexible Configuration**: Manage tags, zone IDs, custom variables, user tokens, and more
 
 ## 📦 Installation
 
@@ -36,7 +21,7 @@ yarn add react-native-sdk-pianoio
 
 ### 1. Initialize the SDK
 
-```typescript
+```javascript
 import { PianoComposer } from 'react-native-sdk-pianoio';
 
 // Initialize with your Piano Application ID
@@ -45,44 +30,42 @@ const composer = await PianoComposer.create('YOUR_PIANO_AID');
 
 ### 2. Configure the Experience
 
-```typescript
-// Add tags for content categorization
-await composer.addTag('premium');
-await composer.addTags(['article', 'featured']);
+```javascript
+// Set the required parameters for the experience
+await composer.setUrl('https://www.your-website.com/premium-article');
+await composer.setZoneId('your_zone_id'); // e.g., 'default'
+await composer.setReferrer('https://www.your-website.com/');
 
-// Set zone ID for targeted experiences
-await composer.setZoneId('Zone1');
-
-// Add custom variables
+// Add optional parameters
+await composer.addTag('premium-content');
 await composer.setCustomVariable('article_id', '12345');
-
-// Set user token for authentication
-await composer.setUserToken('user_token_123');
 ```
 
 ### 3. Execute the Experience
 
-```typescript
-// Execute with basic configuration
-const result = await composer.executeExperience();
-
-// Execute with advanced configuration
-const result = await composer.executeExperienceWithConfig(true, true);
+```javascript
+try {
+  const result = await composer.executeExperience();
+  console.log('Experience result:', result);
+  // Handle the event data from the Piano backend
+} catch (error) {
+  console.error('Failed to execute experience:', error);
+}
 ```
 
 ### 4. Handle Authentication
 
-```typescript
-// Sign in user
+```javascript
+// Sign in a user
 const user = await composer.signIn();
 
-// Check authentication status
+// Check if a user is authenticated
 const isAuthenticated = await composer.isAuthenticated();
 
-// Get current user
+// Get the current user's details
 const currentUser = await composer.getCurrentUser();
 
-// Sign out user
+// Sign out the user
 await composer.signOut();
 ```
 
@@ -90,95 +73,48 @@ await composer.signOut();
 
 ### Core Methods
 
-#### `PianoComposer.create(aid: string)`
-Creates and initializes a new PianoComposer instance.
-
-#### `composer.addTag(tag: string)`
-Adds a single tag to the experience.
-
-#### `composer.addTags(tags: string[])`
-Adds multiple tags to the experience.
-
-#### `composer.setZoneId(zoneId: string)`
-Sets the zone ID for targeted experiences.
-
-#### `composer.setCustomVariable(key: string, value: string)`
-Adds a custom variable to the experience.
-
-#### `composer.executeExperience()`
-Executes the Piano experience with current configuration.
-
-### Authentication Methods
-
-#### `composer.signIn()`
-Signs in the user with Piano OAuth.
-
-#### `composer.signOut()`
-Signs out the current user.
-
-#### `composer.getCurrentUser()`
-Gets information about the current authenticated user.
-
-#### `composer.isAuthenticated()`
-Checks if a user is currently authenticated.
-
-### Advanced Methods
-
-#### `composer.executeExperienceWithConfig(includeUserData: boolean, debug: boolean)`
-Executes experience with advanced configuration options.
-
-#### `composer.createExperienceRequest(includeUserData?: boolean, debug?: boolean)`
-Creates an experience request with custom parameters.
-
-#### `composer.getStatus()`
-Gets the current status of the composer.
-
-#### `composer.testExecutionFlow()`
-Tests the complete execution flow.
-
-## 🧪 Testing
-
-The SDK includes comprehensive test coverage:
-
-```bash
-# Run all tests
-npm test
-
-# Run tests with coverage
-npm run test:coverage
-
-# Run Android-specific tests
-cd android && ./test.sh
-```
-
-### Test Results
-- ✅ **91% Test Coverage** on Android implementation
-- ✅ **67/73 tests passing**
-- ✅ **All core functionality tested**
+- `PianoComposer.create(aid: string)` - Creates and initializes a new PianoComposer instance
+- `composer.executeExperience()` - Executes the Piano experience with the current configuration
+- `composer.signIn()` - Initiates the user sign-in flow
+- `composer.signOut()` - Signs out the current user
+
+### Configuration Methods
+
+- `addTag(tag: string)`
+- `addTags(tags: string[])`
+- `setZoneId(zoneId: string)`
+- `setReferrer(referrer: string)`
+- `setUrl(url: string)`
+- `setUserToken(token: string)`
+- `addCustomVariable(key: string, value: string)`
+- `setCustomVariables(variables: { [key: string]: string })`
+
+### Utility Methods
+
+- `getCurrentUser()`
+- `isAuthenticated()`
+- `getStatus()`
+- `clearConfiguration()`
+- `removeTag(tag: string)`
+- `removeCustomVariable(key: string)`
+- `clearTags()`
+- `clearCustomVariables()`
 
 ## 📱 Platform Status
 
-### Android ✅
-- **Status**: Fully implemented and tested
-- **Coverage**: 91% test coverage
-- **Features**: All core features implemented
-- **Dependencies**: React Native 0.78.1 compatible
-
-### iOS 🚧
-- **Status**: Basic implementation
-- **Coverage**: Needs feature parity with Android
-- **Features**: Core methods implemented
-- **Next Steps**: Implement advanced features and authentication
+- ✅ **Android**: Fully implemented and aligned with the official Piano Android SDK
+- ✅ **iOS**: Fully implemented and aligned with the official Piano iOS SDK
 
 ## 🔧 Development
 
 ### Prerequisites
+
 - Node.js 18+
-- React Native 0.78.1
+- React Native
 - Android Studio (for Android development)
-- Xcode (for iOS development)
+- Xcode & CocoaPods (for iOS development)
 
-### Setup Development Environment
+### Setup
 
 ```bash
 # Clone the repository
@@ -187,67 +123,44 @@ git clone https://github.com/HexagonSwiss/hex-react-native-sdk-pianoio.git
 # Install dependencies
 npm install
 
-# Run tests
-npm test
-
 # Build the library
 npm run build
 ```
 
 ### Project Structure
+
 ```
-├── android/                 # Android native implementation
-│   ├── src/main/java/      # Kotlin source files
-│   └── src/test/java/      # Android tests
-├── ios/                    # iOS native implementation
-├── src/                    # TypeScript source
-│   ├── index.tsx          # Main entry point
-│   ├── PianoComposer.tsx  # Main SDK class
-│   └── NativeSdkPianoio.ts # Native module interface
-├── example/               # Example React Native app
-└── lib/                   # Built library files
+├── android/      # Android native implementation
+├── ios/          # iOS native implementation
+├── src/          # TypeScript source (JS bridge)
+└── ...
 ```
 
 ## 🎯 Example App
 
-The repository includes a comprehensive example app demonstrating all SDK features:
+The repository includes an example app to demonstrate all SDK features.
 
 ```bash
-# Navigate to example directory
+# Navigate to the example directory
 cd example
 
 # Install dependencies
 npm install
 
 # Run on Android
-npx react-native run-android
+npx expo run:android
 
 # Run on iOS
-npx react-native run-ios
+npx expo run:ios
 ```
 
-The example app includes:
-- ✅ Basic configuration testing
-- ✅ Authentication flow testing
-- ✅ Advanced configuration options
-- ✅ Experience execution
-- ✅ Real-time logging
-
 ## 🤝 Contributing
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
-
-### Development Workflow
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests for new functionality
-5. Ensure all tests pass
-6. Submit a pull request
+We welcome contributions! Please see our Contributing Guide for details.
 
 ## 📄 License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.
 
 ## 🆘 Support
 
@@ -255,10 +168,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 - 🐛 **Issues**: [GitHub Issues](https://github.com/HexagonSwiss/hex-react-native-sdk-pianoio/issues)
 - 📖 **Documentation**: [Piano.io Documentation](https://docs.piano.io/)
 
-## 🔄 Changelog
-
-See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes.
-
 ---
 
-**Made with ❤️ by [HexagonSwiss](https://hexagonswiss.ch)**
+Made with ❤️ by HexagonSwiss

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-sdk-pianoio",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Piano io sdk integration",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",