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

package/CHANGELOG.md

@@ -0,0 +1,252 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive documentation system with README, deprecation policy, and migration guide
+- SBOM (Software Bill of Materials) automatic generation for security compliance
+- Enhanced TypeScript support and type definitions
+
+### Changed
+- Improved code formatting and linting standards
+- Enhanced error handling and logging
+
+## [1.3.0] - 2024-06-16
+
+### Added
+- 🆕 **Multi-instance support**: Ability to initialize multiple Hydra instances
+- 📋 **SBOM Generation**: Automatic Software Bill of Materials creation for security compliance
+- 🔧 **Enhanced Configuration**: Support for reading configuration from environment files
+- 🔒 **Dependabot Integration**: Automated dependency updates for security
+- 🧹 **Clear Persistent Data**: Added functionality to clear persisted data
+- 📱 **React Native Vector Icons**: Added vector icon dependency for better UI
+
+### Changed
+- 🔄 **Multi-account functionality**: Enhanced support for multiple Hydra accounts
+- 📦 **Dependency Updates**: Updated Yarn lock file and dependencies
+- 🏗️ **Build Improvements**: Removed hard-coded secrets and improved build process
+
+### Fixed
+- 🐛 **Configuration Management**: Improved environment variable handling
+- 🔧 **Build Process**: Removed task blocks that were causing build issues
+
+## [1.2.7] - 2024-02-04
+
+### Added
+- 🔧 **Cross-initialization**: Enabled cross-initialization between different Hydra instances
+- 📱 **Custom Notification Center**: Custom notification center UI with enhanced functionality
+- 🔔 **Enhanced Notifications**: Improved notification handling and display
+
+### Changed
+- 📦 **Hydra Dependencies**: Updated Hydra SDK dependencies to latest versions
+- 🏗️ **Build Configuration**: Improved build configuration for better stability
+
+### Fixed
+- 🐛 **Android Notification Issues**: Fixed notification data limit issues on Android
+- 🔔 **Badge Count**: Fixed badge count decrement issues on iOS
+- 🌐 **Base URL Validation**: Added proper validation for base URLs (must start with https)
+- 📱 **Android 12 Compatibility**: Fixed bell icon count disappearing issue on Android 12
+
+## [1.2.6] - 2024-01-15
+
+### Added
+- 📧 **Expanded Inbox Details**: Added expandedDetails in Inbox Message functionality
+- 🔥 **Firebase Remote Config**: Completed Firebase remote config implementation for multiple instances
+- 🔧 **Multi-instance Support**: Enhanced multi-instance functionality across platforms
+
+### Changed
+- 🏗️ **Architecture Updates**: Updated project structure for better maintainability
+- 📦 **Version Management**: Improved version management and release process
+
+### Fixed
+- 🐛 **iOS Issues**: Fixed various iOS-specific issues with multi-instance support
+- 🔧 **Configuration**: Fixed issues with remote configuration handling
+
+## [1.2.5] - 2023-12-10
+
+### Added
+- 📧 **Inbox Message Details**: Added expandedDetails property to inbox messages
+- 🔄 **App State Listener**: Added app state change listener functionality
+
+### Changed
+- 📦 **SDK Updates**: Updated both Android and iOS SDK dependencies
+- 🏗️ **Build Process**: Improved build process and dependency management
+
+### Fixed
+- 🐛 **iOS Crash**: Fixed critical iOS crash issue (CAP-146407)
+- 📱 **Android SDK**: Updated Android SDK to resolve compatibility issues
+
+## [1.2.4] - 2023-11-25
+
+### Fixed
+- 🐛 **iOS Critical Fix**: Fixed major iOS issue affecting app stability
+- 📱 **Android Updates**: Updated Android SDK to latest stable version
+
+## [1.2.3] - 2023-11-20
+
+### Added
+- 📅 **CreatedAt Field**: Added createdAt timestamp from NotificationPayload to Android mapping
+- 🔗 **Deep Link Improvements**: Enhanced deep link and external link handling
+
+### Changed
+- 📦 **Android Dependencies**: Updated to new Android dependencies (v1.9.2)
+- 🔔 **Notification Click**: Improved notification click handling
+
+### Fixed
+- 🐛 **Notification Issues**: Fixed various issues with notification processing
+- 🔗 **Link Handling**: Resolved deep link and external link issues
+
+## [1.2.2] - 2023-11-05
+
+### Added
+- 🔔 **SDK Initialization Event**: New event for SDK initialization status
+- 🔗 **CTA Handling**: Enhanced CTA (Call-to-Action) handling in notifications
+
+### Changed
+- 📦 **Dependency Rollback**: Reverted some dependencies to stable versions for compatibility
+
+### Fixed
+- 🛡️ **Null Safety**: Handled null values for CTA in hydra notification click listener
+- ⚡ **Promise Handling**: Added proper return statements after promise rejection
+
+## [1.2.1] - 2023-10-28
+
+### Added
+- 🔥 **Firebase Remote Config**: Enhanced Firebase Remote Config support with error handling
+- 🔧 **Environment Variables**: Better environment variable management
+- 📱 **iOS 13.2+ Support**: Hard-coded minimum iOS version to 13.2 for Firebase compatibility
+
+### Fixed
+- 🐛 **iOS Compilation**: Fixed compile issues on iOS for Firebase Remote Config
+- 💥 **Crash Prevention**: Fixed crashes in notification core function calls
+- 🚫 **Initialization Flag**: Added flag to disable Firebase initialization when needed
+
+## [1.2.0] - 2023-10-15
+
+### Added
+- 🔥 **Firebase Remote Config**: Initial Firebase Remote Config implementation
+- 🏗️ **Local Environment Support**: Added support for building with local environment configuration
+- 🔐 **Credential Management**: Enhanced credential and account ID management
+- 📱 **iOS Callbacks**: Added comprehensive notification callbacks for iOS
+
+### Changed
+- 🏗️ **Build Configuration**: Moved GitHub setup from build.gradle to separate file
+- 🏷️ **Environment Naming**: Added "Hydra" prefix to environment parameters
+- 📦 **Dependency Management**: Updated iOS package version to 1.6.2
+
+### Fixed
+- 🛠️ **Build Issues**: Resolved various build configuration issues
+- 🔧 **Error Handling**: Enhanced error handling for remote config
+
+## [1.1.7] - 2023-09-30
+
+### Added
+- 🔔 **Notification Callbacks**: Added callbacks for non-Hydra and Hydra notification events on iOS
+- 🔥 **Firebase Integration**: Added Firebase Remote Config initializer
+- 📝 **Example Code**: Added examples for custom Hydra initializer usage
+
+### Changed
+- 🏗️ **Build Structure**: Improved build configuration and GitHub setup
+- 🔐 **Credential Management**: Enhanced placeholder system for credentials
+
+## [1.1.6] - 2023-09-15
+
+### Added
+- 📱 **Personal Access Token**: Allow different PAT for Android and iOS platforms
+- 🔔 **Notification Events**: Enhanced notification event handling
+
+### Changed
+- 📦 **iOS Package**: Updated iOS package version to 1.6.2
+- 🧹 **Code Cleanup**: Added .kotlin folder to .gitignore
+
+### Fixed
+- 🔤 **Typo Corrections**: Fixed various typos in codebase
+
+## [1.1.5] - 2023-09-01
+
+### Added
+- ⚙️ **Default Inbox UI**: Added config property to use default inbox UI config on iOS
+- 🧹 **Environment Management**: Improved .xcode.env.local handling
+
+### Changed
+- 🗑️ **Code Cleanup**: Removed user defaults usage
+- 📱 **iOS Configuration**: Enhanced iOS configuration management
+
+## [1.1.4] - 2023-08-20
+
+### Added
+- 📱 **Push Notification Extension**: Added HydraPushNotificationServiceExtension pod in main target
+
+### Changed
+- 🚀 **React Native 0.77**: Updated example app to React Native 0.77
+- 📦 **Version Handling**: Fixed issue with ^ in React Native version specification
+
+## [1.1.3] - 2023-08-10
+
+### Added
+- 🏗️ **New Architecture Support**: Added new architecture condition in Podfile
+- 📦 **Pod Versions**: Updated pod versions for better compatibility
+
+### Fixed
+- 🔧 **Build Compatibility**: Fixed compilation issues for React Native 0.72 on both platforms
+- 📱 **Android Build**: Resolved Android build issues on React Native 0.72
+
+## [1.1.2] - 2023-07-25
+
+### Added
+- 🌍 **Geo Configuration**: Implemented updateGeoConfig functionality on iOS
+- 📱 **Pod Version Support**: Enhanced support for pod version 1.6.0
+
+### Fixed
+- 📧 **Inbox Message**: Fixed issue with markInboxMessageAsRead functionality
+- 🏗️ **Build Issues**: Resolved various build-related problems
+
+## [1.1.1] - 2023-07-10
+
+### Added
+- 🏗️ **Architecture Support**: Added support for old architecture on both iOS and Android
+- 🔧 **ReactNative 0.72**: Enhanced compatibility with ReactNative 0.72.15
+
+### Changed
+- 📦 **Package Scope**: Added scoped package name (@capillary/react-native-hydra-lib)
+- 🚫 **Pod Install**: Disabled automatic pod install for better control
+
+### Fixed
+- 🏗️ **Old Architecture**: Fixed issues with old architecture support
+- 🔧 **Module Configuration**: Improved ReactModuleInfo configuration
+- 📱 **iOS Threading**: Added requiresMainQueueSetup for proper iOS threading
+
+## [1.1.0] - 2023-06-25
+
+### Added
+- 🎉 **Initial Stable Release**: First major stable release
+- 📱 **Cross-Platform Support**: Full iOS and Android support
+- 🔔 **Notification System**: Comprehensive notification handling
+- 📧 **Inbox Management**: Complete inbox message management
+- 🌍 **Geolocation Support**: Location-based features
+- 🔧 **Configuration Management**: Flexible configuration system
+
+### Features
+- ✅ **React Native 0.72+ Support**: Full compatibility with latest React Native
+- ✅ **TypeScript Support**: Complete TypeScript definitions
+- ✅ **Modern Architecture**: Built with latest React Native architecture
+- ✅ **Native Performance**: Direct integration with native SDKs
+
+---
+
+## Release Notes
+
+For detailed release notes with migration guides and breaking changes, see [RELEASE_NOTES.md](./RELEASE_NOTES.md).
+
+## Migration Guide
+
+For migration instructions between versions, see [MIGRATION.md](./MIGRATION.md).
+
+## Deprecation Policy
+
+For information about our deprecation policy and timeline, see [DEPRECATION_POLICY.md](./DEPRECATION_POLICY.md). 

package/DEPRECATION_POLICY.md

@@ -0,0 +1,220 @@
+# Deprecation Policy
+
+This document outlines the deprecation policy for `@capillary/react-native-hydra-lib`. Our goal is to provide a stable, predictable experience for developers while allowing the library to evolve and improve over time.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Versioning Strategy](#versioning-strategy)
+- [Deprecation Process](#deprecation-process)
+- [Timeline and Support](#timeline-and-support)
+- [Migration Guidelines](#migration-guidelines)
+- [Communication Channels](#communication-channels)
+- [Examples](#examples)
+
+## Overview
+
+We follow a structured approach to deprecations that balances the need for library evolution with developer stability. All deprecations are clearly communicated with sufficient advance notice and migration paths.
+
+### Principles
+
+1. **Predictability**: Deprecations follow a consistent timeline and process
+2. **Transparency**: Clear communication about what's being deprecated and why
+3. **Support**: Adequate time and resources for migration
+4. **Backwards Compatibility**: Maintained during deprecation periods
+
+## Versioning Strategy
+
+We follow [Semantic Versioning (SemVer)](https://semver.org/) with the following interpretation:
+
+- **MAJOR** (X.0.0): Breaking changes, including removal of deprecated features
+- **MINOR** (X.Y.0): New features, new deprecations, but no breaking changes
+- **PATCH** (X.Y.Z): Bug fixes, security patches, no new deprecations
+
+### Version Support Policy
+
+| Version Type | Support Duration | Security Updates | Bug Fixes |
+|--------------|------------------|------------------|-----------|
+| Current Major | Until next major | ✅ Yes | ✅ Yes |
+| Previous Major | 12 months | ✅ Yes | ⚠️ Critical only |
+| Older Majors | None | ❌ No | ❌ No |
+
+## Deprecation Process
+
+### Phase 1: Deprecation Announcement (Minor Release)
+
+When a feature is marked for deprecation:
+
+1. **Warning Implementation**: Add runtime warnings (development only)
+2. **Documentation Update**: Mark as deprecated in docs with migration path
+3. **TypeScript Types**: Mark with `@deprecated` JSDoc comments
+4. **Changelog Entry**: Document the deprecation and timeline
+
+**Example Warning:**
+```javascript
+console.warn(
+  '[DEPRECATED] HydraLib.oldMethod() is deprecated and will be removed in v2.0.0. ' +
+  'Please use HydraLib.newMethod() instead. ' +
+  'See migration guide: https://github.com/Capillary/react-native-hydra-lib/blob/main/MIGRATION.md#oldmethod'
+);
+```
+
+### Phase 2: Migration Period (6+ months)
+
+During this period:
+
+1. **Continued Support**: Deprecated features remain functional
+2. **Bug Fixes**: Critical bugs in deprecated features are still fixed
+3. **Migration Support**: Documentation and examples provided
+4. **Community Support**: Help users migrate through issues/discussions
+
+### Phase 3: Removal (Next Major Release)
+
+In the next major version:
+
+1. **Complete Removal**: Deprecated features are removed
+2. **Migration Guide**: Comprehensive guide published
+3. **Breaking Changes**: All removals documented in changelog
+4. **Support**: Extended support for migration questions
+
+## Timeline and Support
+
+### Standard Deprecation Timeline
+
+| Phase | Duration | Actions |
+|-------|----------|---------|
+| **Announcement** | 0 months | Feature marked deprecated, warnings added |
+| **Grace Period** | 6-12 months | Migration support, continued functionality |
+| **Final Notice** | 2-4 weeks | Last warning before removal |
+| **Removal** | Next major | Feature removed completely |
+
+### Expedited Deprecation (Security/Critical Issues)
+
+For security vulnerabilities or critical issues:
+
+| Phase | Duration | Actions |
+|-------|----------|---------|
+| **Announcement** | 0 months | Immediate notice, security advisory |
+| **Grace Period** | 1-3 months | Urgent migration support |
+| **Removal** | Next release | Feature removed (may be patch/minor) |
+
+## Migration Guidelines
+
+### For Library Maintainers
+
+1. **Clear Documentation**: Provide step-by-step migration instructions
+2. **Code Examples**: Show before/after code snippets
+3. **Automated Tools**: Provide codemods when possible
+4. **Comprehensive Testing**: Ensure migration paths work correctly
+
+### For Library Users
+
+1. **Monitor Warnings**: Pay attention to deprecation warnings in development
+2. **Plan Migration**: Allow sufficient time for migration in your development cycle
+3. **Test Thoroughly**: Test migration changes comprehensively
+4. **Seek Help**: Use GitHub issues/discussions for migration support
+
+## Communication Channels
+
+### Primary Channels
+
+1. **GitHub Releases**: Official announcements and changelogs
+2. **README.md**: Current deprecation status and links
+3. **Documentation**: Migration guides and examples
+4. **TypeScript Definitions**: JSDoc deprecation markers
+
+### Secondary Channels
+
+1. **GitHub Issues**: For specific migration questions
+2. **GitHub Discussions**: For community support
+3. **Package Warnings**: Runtime warnings in development
+
+### Notification Format
+
+All deprecation notices include:
+
+- **What**: Specific feature being deprecated
+- **When**: Timeline for removal
+- **Why**: Reason for deprecation
+- **How**: Migration path and alternatives
+- **Where**: Links to documentation and examples
+
+## Examples
+
+### API Method Deprecation
+
+```typescript
+/**
+ * @deprecated This method is deprecated and will be removed in v2.0.0.
+ * Use `initializeHydra()` instead.
+ * @see https://github.com/Capillary/react-native-hydra-lib/blob/main/MIGRATION.md#init
+ */
+export function init(config: HydraConfig): Promise<void> {
+  if (__DEV__) {
+    console.warn(
+      '[DEPRECATED] HydraLib.init() is deprecated and will be removed in v2.0.0. ' +
+      'Please use HydraLib.initializeHydra() instead. ' +
+      'Migration guide: https://github.com/Capillary/react-native-hydra-lib/blob/main/MIGRATION.md#init'
+    );
+  }
+  return initializeHydra(config);
+}
+```
+
+### Configuration Property Deprecation
+
+```typescript
+interface HydraConfig {
+  /**
+   * @deprecated Use `apiEndpoint` instead. Will be removed in v2.0.0.
+   */
+  apiUrl?: string;
+  
+  /** New recommended property */
+  apiEndpoint?: string;
+}
+```
+
+### Breaking Change Migration
+
+#### Before (v1.x)
+```javascript
+import { HydraLib } from '@capillary/react-native-hydra-lib';
+
+// Old initialization
+HydraLib.init({
+  apiUrl: 'https://api.example.com',
+  debug: true
+});
+```
+
+#### After (v2.x)
+```javascript
+import { HydraLib } from '@capillary/react-native-hydra-lib';
+
+// New initialization
+HydraLib.initializeHydra({
+  apiEndpoint: 'https://api.example.com',
+  logLevel: 'debug'
+});
+```
+
+## Current Deprecations
+
+> **Note**: This section will be updated as deprecations are introduced.
+
+Currently, there are no active deprecations in this library.
+
+## Questions and Support
+
+If you have questions about deprecations or need help with migration:
+
+1. **Check the Migration Guide**: [MIGRATION.md](./MIGRATION.md)
+2. **Search Existing Issues**: [GitHub Issues](https://github.com/Capillary/react-native-hydra-lib/issues)
+3. **Create New Issue**: For specific problems or questions
+4. **Join Discussions**: [GitHub Discussions](https://github.com/Capillary/react-native-hydra-lib/discussions)
+
+---
+
+**Last Updated**: June 2025  
+**Policy Version**: 1.0.0 

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Sandesh Jain
+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.