@capillarytech/react-native-hydra-lib 1.7.0-beta.1

package/RELEASE_NOTES.md

@@ -0,0 +1,528 @@
+# Release Notes
+
+This document provides detailed release notes for `@capillary/react-native-hydra-lib`, including features, breaking changes, migration instructions, and technical details for each version.
+
+## Table of Contents
+
+- [Latest Release](#latest-release)
+- [Version 1.3.x](#version-13x)
+- [Version 1.2.x](#version-12x)
+- [Version 1.1.x](#version-11x)
+- [Release Schedule](#release-schedule)
+- [Support Policy](#support-policy)
+
+---
+
+## Latest Release
+
+### [1.3.0] - "Enterprise & Security" - June 16, 2024
+
+> **🎉 Major Feature Release**: This release introduces enterprise-grade security features and multi-instance support.
+
+#### 🆕 **New Features**
+
+##### Multi-Instance Support
+```typescript
+// Initialize multiple Hydra instances
+const instance1 = await HydraLib.initializeInstance('account1', config1);
+const instance2 = await HydraLib.initializeInstance('account2', config2);
+
+// Use specific instance
+await instance1.trackEvent('user_action', { ... });
+await instance2.showInbox();
+```
+
+##### SBOM (Software Bill of Materials)
+- **Automatic Generation**: SPDX 2.3 compliant SBOM files
+- **Security Compliance**: Enterprise-ready supply chain security
+- **Dual Project Support**: Main project + example project SBOMs
+- **Smart Updates**: Only regenerates when dependencies change
+
+##### Enhanced Configuration
+```typescript
+// Read from environment files
+const config = HydraLib.createConfigFromEnv();
+await HydraLib.initialize(config);
+
+// Clear persistent data
+await HydraLib.clearPersistentData();
+```
+
+#### 🔄 **Improvements**
+
+- **Dependabot Integration**: Automated security updates
+- **Enhanced Error Handling**: Better error messages and debugging
+- **Code Quality**: Improved linting and formatting standards
+- **Documentation**: Comprehensive documentation system
+
+#### 🛠️ **Technical Changes**
+
+- **Build Process**: Removed hard-coded secrets
+- **Dependencies**: Updated to latest versions
+- **Configuration**: Better environment variable handling
+
+#### 📦 **Package Updates**
+
+- React Native Vector Icons support
+- Enhanced TypeScript definitions
+- Improved build configuration
+
+#### 🚀 **Migration from 1.2.x**
+
+No breaking changes! This is a backward-compatible release.
+
+```bash
+# Update package
+npm install @capillary/react-native-hydra-lib@1.3.0
+
+# iOS (if needed)
+cd ios && pod install
+```
+
+---
+
+## Version 1.3.x
+
+### [1.3.0] - June 16, 2024
+*See [Latest Release](#latest-release) section above*
+
+---
+
+## Version 1.2.x
+
+### [1.2.7] - "Stability & Performance" - February 4, 2024
+
+#### 🆕 **New Features**
+
+##### Custom Notification Center
+- Enhanced notification UI with custom components
+- Improved notification center functionality
+- Better user experience for message handling
+
+##### Cross-Instance Initialization
+```typescript
+// Enable cross-initialization between instances
+await HydraLib.enableCrossInitialization();
+```
+
+#### 🔧 **Improvements**
+
+- **Notification Handling**: Enhanced notification processing
+- **UI Components**: Better notification center interface
+- **Performance**: Optimized notification rendering
+
+#### 🐛 **Bug Fixes**
+
+- **Android Notifications**: Fixed data limit issues
+- **iOS Badge Count**: Resolved badge count decrement problems
+- **URL Validation**: Enhanced base URL validation (HTTPS required)
+- **Android 12**: Fixed notification icon issues
+
+#### 🚀 **Migration from 1.2.6**
+
+```bash
+# Update package
+npm install @capillary/react-native-hydra-lib@1.2.7
+
+# Update iOS dependencies
+cd ios && pod install
+
+# Android - clean and rebuild
+cd android && ./gradlew clean
+```
+
+### [1.2.6] - "Multi-Instance Foundation" - January 15, 2024
+
+#### 🆕 **Major Features**
+
+##### Firebase Remote Config for Multi-Instance
+```typescript
+// Configure multiple instances with Firebase Remote Config
+await HydraLib.initializeWithRemoteConfig({
+  instances: ['account1', 'account2'],
+  firebaseConfig: { ... }
+});
+```
+
+##### Expanded Inbox Details
+```typescript
+// Access expanded message details
+const message = await HydraLib.getInboxMessage(messageId);
+console.log(message.expandedDetails);
+```
+
+#### 🔄 **Architecture Updates**
+
+- Enhanced project structure
+- Improved version management
+- Better build process
+
+#### 🐛 **Critical Fixes**
+
+- **iOS Multi-Instance**: Fixed various iOS-specific issues
+- **Remote Config**: Resolved configuration handling problems
+- **Build Stability**: Improved build reliability
+
+### [1.2.5] - "Enhanced Messaging" - December 10, 2023
+
+#### 🆕 **Features**
+
+##### App State Management
+```typescript
+// Listen to app state changes
+HydraLib.addAppStateListener((state) => {
+  console.log('App state changed:', state);
+});
+```
+
+##### Inbox Enhancements
+- Added expandedDetails property to inbox messages
+- Improved message metadata handling
+
+#### 📦 **Updates**
+
+- Updated Android and iOS SDK dependencies
+- Enhanced build process
+- Better dependency management
+
+#### 🐛 **Critical Fixes**
+
+- **iOS Crash Fix**: Resolved critical crash (CAP-146407)
+- **Android SDK**: Updated to resolve compatibility issues
+
+### [1.2.4] - "Stability Patch" - November 25, 2023
+
+#### 🐛 **Critical Fixes**
+
+- **iOS Stability**: Fixed major iOS issue affecting app stability
+- **Android SDK**: Updated to latest stable version
+
+#### 📋 **Notes**
+
+This is a stability-focused release addressing critical issues in production environments.
+
+### [1.2.3] - "Deep Link Enhancement" - November 20, 2023
+
+#### 🆕 **Features**
+
+##### Enhanced Notification Data
+```typescript
+// Access notification timestamp
+const notification = await HydraLib.getNotification(id);
+console.log(notification.createdAt); // Now available on Android
+```
+
+##### Improved Link Handling
+- Enhanced deep link processing
+- Better external link support
+- Improved CTA handling
+
+#### 📦 **Updates**
+
+- Updated Android dependencies to v1.9.2
+- Enhanced notification click handling
+
+#### 🐛 **Fixes**
+
+- **Notification Processing**: Various notification handling improvements
+- **Link Resolution**: Fixed deep link and external link issues
+
+### [1.2.2] - "Event System Enhancement" - November 5, 2023
+
+#### 🆕 **Features**
+
+##### SDK Initialization Events
+```typescript
+// Listen for SDK initialization
+HydraLib.addEventListener('sdkInitialized', (status) => {
+  console.log('SDK initialized:', status);
+});
+```
+
+##### Enhanced CTA Support
+- Improved Call-to-Action handling in notifications
+- Better null safety for CTA processing
+
+#### 🔄 **Stability Improvements**
+
+- Reverted some dependencies to stable versions
+- Enhanced promise handling
+- Better error management
+
+### [1.2.1] - "Firebase Integration" - October 28, 2023
+
+#### 🆕 **Major Features**
+
+##### Firebase Remote Config Support
+```typescript
+// Initialize with Firebase Remote Config
+await HydraLib.initializeWithFirebase({
+  apiKey: 'your-api-key',
+  firebaseConfig: { ... },
+  enableErrorHandling: true
+});
+```
+
+#### 📱 **Platform Requirements**
+
+- **iOS**: Minimum version 13.2+ (for Firebase compatibility)
+- **Error Handling**: Enhanced Firebase error management
+- **Environment Variables**: Better environment variable support
+
+#### 🐛 **Fixes**
+
+- **iOS Compilation**: Fixed Firebase Remote Config compilation issues
+- **Crash Prevention**: Resolved notification core crashes
+- **Initialization**: Added flag to disable Firebase when needed
+
+### [1.2.0] - "Configuration Revolution" - October 15, 2023
+
+#### 🆕 **Major Features**
+
+##### Local Environment Support
+```typescript
+// Build with local environment configuration
+const config = HydraLib.createLocalConfig({
+  environment: 'development',
+  apiKey: process.env.HYDRA_API_KEY,
+  customEndpoint: process.env.HYDRA_ENDPOINT
+});
+```
+
+##### Enhanced Credential Management
+- Improved account ID and credential handling
+- Better placeholder system for sensitive data
+- Enhanced security for credential storage
+
+##### iOS Notification Callbacks
+```typescript
+// Enhanced notification callbacks
+HydraLib.setNotificationCallbacks({
+  onNonHydraReceived: (notification) => { ... },
+  onHydraReceived: (notification) => { ... },
+  onHydraShown: (notification) => { ... },
+  onHydraDismissed: (notification) => { ... }
+});
+```
+
+#### 🏗️ **Build System Improvements**
+
+- Moved GitHub setup to separate gradle file
+- Added "Hydra" prefix to environment parameters
+- Enhanced build configuration management
+
+---
+
+## Version 1.1.x
+
+### [1.1.7] - "Notification Enhancement" - September 30, 2023
+
+#### 🆕 **Features**
+
+##### Comprehensive iOS Notifications
+- Added callbacks for all notification events
+- Support for both Hydra and non-Hydra notifications
+- Enhanced notification event tracking
+
+##### Firebase Remote Config Initializer
+- Basic Firebase Remote Config support
+- Custom initializer examples
+- Enhanced configuration management
+
+#### 🏗️ **Infrastructure**
+
+- Improved build configuration
+- Enhanced GitHub setup process
+- Better credential management system
+
+### [1.1.6] - "Multi-Platform Token Support" - September 15, 2023
+
+#### 🆕 **Features**
+
+##### Platform-Specific Personal Access Tokens
+```typescript
+// Different tokens for different platforms
+const config = {
+  ios: { personalAccessToken: 'ios-token' },
+  android: { personalAccessToken: 'android-token' }
+};
+```
+
+#### 🔄 **Improvements**
+
+- Enhanced notification event handling
+- Updated iOS package to version 1.6.2
+- Code cleanup and organization
+
+### [1.1.5] - "UI Configuration" - September 1, 2023
+
+#### 🆕 **Features**
+
+##### Default Inbox UI Configuration
+```typescript
+// Use default inbox UI configuration
+const config = {
+  useDefaultInboxUI: true,
+  customUIConfig: { ... }
+};
+```
+
+#### 🧹 **Cleanup**
+
+- Removed user defaults usage
+- Enhanced .xcode.env.local handling
+- Improved iOS configuration management
+
+### [1.1.4] - "Push Extension Support" - August 20, 2023
+
+#### 🆕 **Features**
+
+##### Push Notification Service Extension
+- Added HydraPushNotificationServiceExtension pod
+- Enhanced push notification handling
+- Better notification processing
+
+#### 📱 **Platform Updates**
+
+- Updated example app to React Native 0.77
+- Fixed React Native version specification issues
+
+### [1.1.3] - "Architecture Compatibility" - August 10, 2023
+
+#### 🆕 **Features**
+
+##### New Architecture Support
+- Added new architecture condition in Podfile
+- Enhanced compatibility with new React Native architecture
+- Updated pod versions for better stability
+
+#### 🐛 **Fixes**
+
+- **React Native 0.72**: Fixed compilation issues on both platforms
+- **Android Build**: Resolved Android-specific build problems
+- **Cross-Platform**: Enhanced cross-platform compatibility
+
+### [1.1.2] - "Geolocation Support" - July 25, 2023
+
+#### 🆕 **Features**
+
+##### Geo Configuration
+```typescript
+// Update geo configuration
+await HydraLib.updateGeoConfig({
+  enableLocation: true,
+  accuracy: 'high',
+  updateInterval: 30000
+});
+```
+
+#### 📦 **Updates**
+
+- Enhanced support for pod version 1.6.0
+- Improved geolocation functionality
+
+#### 🐛 **Fixes**
+
+- **Inbox Messages**: Fixed markInboxMessageAsRead functionality
+- **Build System**: Resolved various build-related issues
+
+### [1.1.1] - "Architecture Foundation" - July 10, 2023
+
+#### 🆕 **Features**
+
+##### Dual Architecture Support
+- Full support for both old and new React Native architecture
+- Enhanced compatibility with ReactNative 0.72.15
+- Improved threading support for iOS
+
+##### Package Scoping
+- Added scoped package name: `@capillary/react-native-hydra-lib`
+- Better namespace organization
+- Enhanced package management
+
+#### 🔧 **Technical Improvements**
+
+- Disabled automatic pod install for better control
+- Improved ReactModuleInfo configuration
+- Added requiresMainQueueSetup for proper iOS threading
+
+### [1.1.0] - "Foundation Release" - June 25, 2023
+
+#### 🎉 **Initial Stable Release**
+
+##### Core Features
+- **Cross-Platform Support**: Full iOS and Android integration
+- **Notification System**: Comprehensive push notification handling
+- **Inbox Management**: Complete message inbox functionality
+- **Geolocation**: Location-based features and targeting
+- **Configuration**: Flexible SDK configuration system
+
+##### Technical Foundation
+- **React Native 0.72+**: Full compatibility with latest React Native
+- **TypeScript**: Complete TypeScript definitions and support
+- **Modern Architecture**: Built with latest React Native Turbo Modules
+- **Native Performance**: Direct integration with native Hydra SDKs
+
+##### API Features
+```typescript
+// Core functionality available from v1.1.0
+await HydraLib.initialize(config);
+await HydraLib.setUserProfile(profile);
+await HydraLib.trackEvent('event', properties);
+await HydraLib.showInbox();
+const count = await HydraLib.getUnreadMessageCount();
+```
+
+---
+
+## Release Schedule
+
+### Release Cadence
+
+| Release Type | Frequency | Content |
+|--------------|-----------|---------|
+| **Major** (X.0.0) | ~6-12 months | Breaking changes, major features |
+| **Minor** (X.Y.0) | ~4-8 weeks | New features, deprecations |
+| **Patch** (X.Y.Z) | As needed | Bug fixes, security updates |
+
+### Upcoming Releases
+
+#### v1.4.0 (Planned - Q3 2024)
+- Enhanced analytics features
+- Improved performance metrics
+- Advanced segmentation capabilities
+
+#### v2.0.0 (Planned - Q1 2025)
+- Breaking changes for modernization
+- Enhanced TypeScript support
+- New React Native architecture requirement
+
+## Support Policy
+
+### Version Support
+
+| Version | Status | Support Until | Security Updates |
+|---------|--------|---------------|------------------|
+| **1.3.x** | Active | Current | ✅ Yes |
+| **1.2.x** | Maintenance | June 2024 | ✅ Yes |
+| **1.1.x** | Legacy | December 2023 | ⚠️ Critical only |
+| **<1.1.0** | Unsupported | - | ❌ No |
+
+### Upgrade Recommendations
+
+- **Production Apps**: Update to latest stable (1.3.0)
+- **Development**: Always use latest version
+- **Enterprise**: Contact support for migration assistance
+
+### Getting Help
+
+- 📚 **Documentation**: [README.md](./README.md)
+- 🔄 **Migration Guide**: [MIGRATION.md](./MIGRATION.md)
+- 🐛 **Issues**: [GitHub Issues](https://github.com/Capillary/react-native-hydra-lib/issues)
+- 💬 **Discussions**: [GitHub Discussions](https://github.com/Capillary/react-native-hydra-lib/discussions)
+- 📧 **Enterprise Support**: [enterprise@capillarytech.com](mailto:enterprise@capillarytech.com)
+
+---
+
+**Last Updated**: June 2025  
+**Document Version**: 1.0.0