@capillarytech/react-native-hydra-lib 1.7.0-beta.9 → 1.8.1

package/README.md

@@ -1,6 +1,6 @@
-# @capillary/react-native-hydra-lib
+# @capillarytech/react-native-hydra-lib
 
-[![npm version](https://badge.fury.io/js/@capillary%2Freact-native-hydra-lib.svg)](https://badge.fury.io/js/@capillary%2Freact-native-hydra-lib)
+[![npm version](https://badge.fury.io/js/@capillarytech%2Freact-native-hydra-lib.svg)](https://badge.fury.io/js/@capillarytech%2Freact-native-hydra-lib)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
 [![React Native](https://img.shields.io/badge/React%20Native-0.77.0-blue.svg)](https://reactnative.dev/)
@@ -12,16 +12,6 @@ A comprehensive React Native library that provides seamless integration with Hyd
 - [Features](#features)
 - [Requirements](#requirements)
 - [Installation](#installation)
-- [Quick Start](#quick-start)
-- [API Reference](#api-reference)
-- [Platform-Specific Setup](#platform-specific-setup)
-- [Security & Compliance](#security--compliance)
-- [Development](#development)
-- [Contributing](#contributing)
-- [Troubleshooting](#troubleshooting)
-- [Changelog](#changelog)
-- [Support](#support)
-- [License](#license)
 
 ## Features
 
@@ -49,443 +39,23 @@ A comprehensive React Native library that provides seamless integration with Hyd
 
 | Platform         | Version                 |
 | ---------------- | ----------------------- |
-| **React Native** | >= 0.72.0               |
-| **iOS**          | >= 13.0                 |
+| **React Native** | >= 0.77.0               |
+| **iOS**          | >= 15.0                 |
 | **Android**      | >= API 21 (Android 5.0) |
 | **Node.js**      | >= 18.0.0               |
-| **targetSdk**    | >= 32                   |
-| **compileSdk**   | >= 32                   |
+| **targetSdk**    | >= 31                   |
+| **compileSdk**   | >= 31                   |
 
 ## Installation
 
 ### Using npm
 
 ```bash
-npm install @capillary/react-native-hydra-lib
+npm install @capillarytech/react-native-hydra-lib
 ```
 
-## Project Setup
-
-Before you start development, you need to set up your environment:
-
-1. Create a `.env` file in the project root with the following variables:
-
-```sh
-HYDRA_GITHUB_USER_NAME=your_github_username
-HYDRA_IOS_GITHUB_PAT=your_github_personal_access_token
-```
-
-2. Run the setup script:
-
-```sh
-./scripts/setup_local.sh
-```
-
-This script will:
-
-- Configure your GitHub credentials for accessing private repositories
-- Set up necessary environment variables
-- Configure Git authentication for Capillary repositories
-
-Note: The setup script will run automatically when you install dependencies in the example app.
-
 ### Using yarn
 
 ```bash
-yarn add @capillary/react-native-hydra-lib
-```
-
-### Post-Installation Setup
-
-After installation, the library automatically generates SBOM (Software Bill of Materials) files for security and compliance tracking.
-
-#### iOS Setup
-
-```bash
-cd ios && pod install
-```
-
-#### Android Setup
-
-No additional setup required for Android.
-
-## Quick Start
-
-### Basic Integration
-
-```typescript
-import { HydraLib } from '@capillary/react-native-hydra-lib';
-
-// Initialize using Firebase Remote Config
-// This is the recommended way to initialize the SDK
-const initializeHydra = async () => {
-  try {
-    await HydraLib.setFirebaseRemoteConfigKeys({
-      keyForAccountId: 'hydra_account_id',
-      keyForBaseUrl: 'hydra_base_url',
-      keyForSsl: 'hydra_ssl_public_key',
-      keyForRemoteLogLevel: 'hydra_remote_log_level'
-    });
-    console.log('Hydra SDK initialized successfully');
-  } catch (error) {
-    console.error('Failed to initialize Hydra SDK:', error);
-  }
-};
-
-// Alternative: Initialize using Account Config directly
-const initializeWithAccountConfig = async () => {
-  try {
-    await HydraLib.setHydraAccountConfig({
-      accountId: 'your-account-id',
-      baseUrl: 'your-base-url',
-      sslPublicKey: 'your-ssl-public-key',
-      remoteDebugLevel: 4 // 0-5, where 0 is off and 5 is verbose
-    });
-    console.log('Hydra SDK initialized successfully');
-  } catch (error) {
-    console.error('Failed to initialize Hydra SDK:', error);
-  }
-};
-
-// Call during app startup
-initializeHydra();
-```
-
-
-## API Reference
-
-### Core Methods
-
-#### `setFirebaseRemoteConfigKeys(keys: HydraFirebaseRemoteConfigKeys): Promise<void>`
-
-Initializes the Hydra SDK using Firebase Remote Config keys.
-
-**Parameters:**
-
-- `keys`: Object containing Firebase Remote Config key names
-  - `keyForAccountId`: Key for account ID in Firebase Remote Config
-  - `keyForBaseUrl`: Key for base URL in Firebase Remote Config
-  - `keyForSsl`: Key for SSL public key in Firebase Remote Config
-  - `keyForRemoteLogLevel`: Key for remote debug level in Firebase Remote Config
-
-**Example:**
-
-```typescript
-await HydraLib.setFirebaseRemoteConfigKeys({
-  keyForAccountId: 'hydra_account_id',
-  keyForBaseUrl: 'hydra_base_url',
-  keyForSsl: 'hydra_ssl_public_key',
-  keyForRemoteLogLevel: 'hydra_remote_log_level'
-});
-```
-
-#### `setHydraAccountConfig(config: HydraAccountConfig): Promise<void>`
-
-Sets the Hydra account configuration directly without using Firebase Remote Config.
-
-**Parameters:**
-
-- `config`: Account configuration object
-  - `accountId`: Your Hydra account ID
-  - `baseUrl`: Base URL for the Hydra API
-  - `sslPublicKey`: SSL public key for secure communication
-  - `remoteDebugLevel`: Debug level (0-5, where 0 is off and 5 is verbose)
-
-**Example:**
-
-```typescript
-await HydraLib.setHydraAccountConfig({
-  accountId: 'your-account-id',
-  baseUrl: 'your-base-url',
-  sslPublicKey: 'your-ssl-public-key',
-  remoteDebugLevel: 4
-});
-```
-
-#### `signIn(userDetails: UserDetails, customData?: object): Promise<void>`
-
-Signs in a user with the provided details.
-
-**Parameters:**
-
-- `userDetails`: User profile information
-- `customData`: Optional custom attributes
-
-**Example:**
-
-```typescript
-await HydraLib.signIn({
-  userId: 'user123',
-  email: 'user@example.com'
-}, {
-  preferences: ['tech', 'mobile']
-});
-```
-
-#### `signOut(customerId: string): Promise<void>`
-
-Signs out the user with the specified customer ID.
-
-**Parameters:**
-
-- `customerId`: The ID of the customer to sign out
-
-**Example:**
-
-```typescript
-await HydraLib.signOut('user123');
-```
-
-### Messaging Methods
-
-#### `showNotificationCenter(): Promise<void>`
-
-Displays the notification center UI.
-
-#### `hideNotificationCenterIfShowing(): Promise<void>`
-
-Hides the notification center if it's currently visible.
-
-#### `getInboxMessages(): Promise<void>`
-
-Retrieves the list of inbox messages.
-
-#### `getUnreadInboxMessagesCount(): Promise<number>`
-
-Returns the number of unread inbox messages.
-
-### Utility Methods
-
-#### `getSDKVersion(): Promise<string>`
-
-Returns the current SDK version.
-
-#### `isInitialized(): Promise<boolean>`
-
-Checks if the SDK is properly initialized.
-
-## Platform-Specific Setup
-
-### iOS Configuration
-
-Add the following to your `ios/YourApp/Info.plist`:
-
-```xml
-<key>NSLocationWhenInUseUsageDescription</key>
-<string>This app uses location for personalized content</string>
-<key>NSUserNotificationUsageDescription</key>
-<string>This app sends notifications for important updates</string>
-```
-
-### Android Configuration
-
-Add permissions to `android/app/src/main/AndroidManifest.xml`:
-
-```xml
-<uses-permission android:name="android.permission.INTERNET" />
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:required="false" />
+yarn add @capillarytech/react-native-hydra-lib
 ```
-
-## Security & Compliance
-
-### SBOM (Software Bill of Materials)
-
-This library automatically generates SBOM files for security and compliance tracking:
-
-- **Main Project SBOM**: `sbom.spdx.json` (generated in project root)
-- **Example Project SBOM**: `example/example_sbom.spdx.json`
-
-#### SBOM Generation
-
-The SBOM is automatically generated during:
-
-- Package installation (`postinstall` script)
-- Manual execution: `npm run generate-sbom`
-
-#### SBOM Features
-
-- ✅ **SPDX 2.3 Compliant**: Industry standard format
-- ✅ **Comprehensive Coverage**: All dependencies tracked
-- ✅ **Automatic Updates**: Regenerated when dependencies change
-- ✅ **Supply Chain Security**: Complete dependency lineage
-- ✅ **Enterprise Ready**: Compliance with security requirements
-
-### Deprecation Policy
-
-We follow a structured deprecation policy to ensure smooth transitions:
-
-- **📅 Advance Notice**: 6-12 months before removal
-- **🔄 Migration Support**: Comprehensive guides and examples
-- **⚠️ Clear Warnings**: Development-time deprecation warnings
-- **📚 Documentation**: Detailed migration paths
-
-For complete details, see our [Deprecation Policy](./DEPRECATION_POLICY.md).
-
-## Development
-
-### Running the Example App
-
-```bash
-# Install dependencies
-yarn install
-
-# iOS
-yarn example ios
-
-# Android
-yarn example android
-```
-
-### Building the Library
-
-```bash
-# Build TypeScript
-yarn prepare
-
-# Run tests
-yarn test
-
-# Lint code
-yarn lint
-
-# Type checking
-yarn typecheck
-```
-
-### Scripts
-
-| Script               | Description              |
-| -------------------- | ------------------------ |
-| `yarn test`          | Run tests                |
-| `yarn typecheck`     | TypeScript type checking |
-| `yarn lint`          | ESLint code linting      |
-| `yarn prepare`       | Build the library        |
-| `yarn generate-sbom` | Generate SBOM files      |
-| `yarn clean`         | Clean build artifacts    |
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
-
-### Development Workflow
-
-1. **Fork** the repository
-2. **Clone** your fork
-3. **Create** a feature branch
-4. **Make** your changes
-5. **Test** your changes
-6. **Submit** a pull request
-
-### Code Standards
-
-- **TypeScript**: All code must be TypeScript
-- **ESLint**: Follow our linting rules
-- **Testing**: Add tests for new features
-- **Documentation**: Update docs for API changes
-
-## Troubleshooting
-
-### Common Issues
-
-#### Installation Issues
-
-**Problem**: `pod install` fails on iOS
-
-```bash
-# Solution: Clean and reinstall
-cd ios
-rm -rf Pods Podfile.lock
-pod install
-```
-
-**Problem**: Android build fails
-
-```bash
-# Solution: Clean and rebuild
-cd android
-./gradlew clean
-cd ..
-yarn android
-```
-
-#### Runtime Issues
-
-**Problem**: SDK initialization fails
-
-- Verify your API key is correct
-- Check network connectivity
-- Ensure required permissions are granted
-
-**Problem**: TypeScript errors
-
-```bash
-# Solution: Regenerate types
-yarn prepare
-```
-
-### Getting Help
-
-1. **Check Documentation**: Review this README and guides
-2. **Search Issues**: Look for existing solutions in GitHub issues
-3. **Ask Questions**: Create a new issue with detailed information
-4. **Community Support**: Join our discussions
-
-## Changelog & Release Notes
-
-### Quick Links
-
-- 📋 **[Changelog](./CHANGELOG.md)**: Complete change history in standard format
-- 📝 **[Release Notes](./RELEASE_NOTES.md)**: Detailed release information with examples
-- 🔄 **[Migration Guide](./MIGRATION.md)**: Version upgrade instructions
-- 📚 **[Deprecation Policy](./DEPRECATION_POLICY.md)**: How we handle deprecations
-
-### Recent Updates
-
-- **v1.3.0**: Added SBOM generation, multi-instance support, enhanced security
-- **v1.2.x**: Enhanced iOS and Android SDK integration, Firebase Remote Config
-- **v1.1.x**: Initial stable release with core features
-
-## Support
-
-### Documentation
-
-- 📚 **API Reference**: Detailed API documentation
-- 🎯 **Examples**: Working code examples
-- 🔧 **Platform Guides**: iOS and Android specific setup
-- 📋 **Migration Guides**: Version upgrade instructions
-
-### Community
-
-- 🐛 **Issues**: [GitHub Issues](https://github.com/Capillary/react-native-hydra-lib/issues)
-- 💬 **Discussions**: [GitHub Discussions](https://github.com/Capillary/react-native-hydra-lib/discussions)
-- 📧 **Contact**: [rakesh.ostwal@capillarytech.com](mailto:rakesh.ostwal@capillarytech.com)
-
-### Enterprise Support
-
-For enterprise customers, we provide:
-
-- Priority support and SLA
-- Custom integration assistance
-- Security and compliance consulting
-- Training and onboarding
-
-Contact us at [enterprise@capillarytech.com](mailto:enterprise@capillarytech.com)
-
-## License
-
-MIT License - see the [LICENSE](./LICENSE) file for details.
-
----
-
-## About Capillary Technologies
-
-[Capillary Technologies](https://www.capillarytech.com/) is a leading provider of customer engagement and commerce solutions. Our Hydra SDK enables businesses to create personalized, omnichannel experiences that drive customer loyalty and growth.
-
----
-
-**Made with ❤️ by the Capillary Technologies team**
-
-_This library was created using [create-react-native-library](https://github.com/callstack/react-native-builder-bob)_
-
-

package/android/build.gradle

@@ -163,8 +163,17 @@ android {
   }
 }
 
+def hydraLocalRepo = "${project.projectDir}/libs/repo"
+
+// Consuming apps resolve these transitive AARs with their own repositories, so expose the bundled repo to them too.
+rootProject.allprojects {
+  repositories {
+    maven { url uri(hydraLocalRepo) }
+  }
+}
+
 repositories {
-  mavenLocal()
+  maven { url uri(hydraLocalRepo) }
   mavenCentral()
   google()
 }
@@ -179,14 +188,14 @@ dependencies {
   //noinspection GradleDependency
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  implementation "com.capillarytech:hydra-core:1.9.22-beta09"
-  implementation "com.capillarytech:hydra-pushbase:1.9.22-beta09"
-  implementation "com.capillarytech:hydra-firebase:1.9.22-beta09"
-  implementation "com.capillarytech:hydra-richnotification:1.9.22-beta09"
+  implementation "com.capillarytech:hydra-core:1.10.0"
+  implementation "com.capillarytech:hydra-pushbase:1.10.0"
+  implementation "com.capillarytech:hydra-firebase:1.10.0"
+  implementation "com.capillarytech:hydra-richnotification:1.10.0"
 
-  implementation "com.capillarytech:hydra-inbox-core:1.9.22-beta09"
-  implementation "com.capillarytech:hydra-inbox-ui:1.9.22-beta09"
-  implementation "com.capillarytech:hydra-inapp:1.9.22-beta09"
+  implementation "com.capillarytech:hydra-inbox-core:1.10.0"
+  implementation "com.capillarytech:hydra-inbox-ui:1.10.0"
+  implementation "com.capillarytech:hydra-inapp:1.10.0"
   implementation "com.google.firebase:firebase-messaging-ktx:24.1.0"
 
   implementation "com.google.code.gson:gson:2.11.0"

package/android/libs/repo/com/capillarytech/hydra-anonymous/1.10.0/hydra-anonymous-1.10.0.module

@@ -0,0 +1,114 @@
+{
+  "formatVersion": "1.1",
+  "component": {
+    "group": "com.capillarytech",
+    "module": "hydra-anonymous",
+    "version": "1.10.0",
+    "attributes": {
+      "org.gradle.status": "release"
+    }
+  },
+  "createdBy": {
+    "gradle": {
+      "version": "7.3.3"
+    }
+  },
+  "variants": [
+    {
+      "name": "releaseVariantReleaseApiPublication",
+      "attributes": {
+        "org.gradle.category": "library",
+        "org.gradle.dependency.bundling": "external",
+        "org.gradle.libraryelements": "aar",
+        "org.gradle.usage": "java-api"
+      },
+      "dependencies": [
+        {
+          "group": "org.jetbrains.kotlin",
+          "module": "kotlin-stdlib-jdk8",
+          "version": {
+            "requires": "1.7.0"
+          }
+        }
+      ],
+      "files": [
+        {
+          "name": "hydra-anonymous-1.10.0.aar",
+          "url": "hydra-anonymous-1.10.0.aar",
+          "size": 126548,
+          "sha512": "5eadbd67aceb09c179b7b1b4bd299f951ebb5d19521ce4af35cfcd76c03d8c876f5539823f9638f44542d043fff28f415094d611d9247ad83e102360f787c46a",
+          "sha256": "6c9a10f6e079645463ff827722236f2743beadb2bedf16d6092afbd98c232e91",
+          "sha1": "8f1c36bedf0294e57c922301bbed92a701e03cf5",
+          "md5": "5fa6d5f3af471311aae8cc2f675e6d76"
+        }
+      ]
+    },
+    {
+      "name": "releaseVariantReleaseRuntimePublication",
+      "attributes": {
+        "org.gradle.category": "library",
+        "org.gradle.dependency.bundling": "external",
+        "org.gradle.libraryelements": "aar",
+        "org.gradle.usage": "java-runtime"
+      },
+      "dependencies": [
+        {
+          "group": "org.jetbrains.kotlin",
+          "module": "kotlin-parcelize-runtime",
+          "version": {
+            "requires": "1.7.0"
+          }
+        },
+        {
+          "group": "org.jetbrains.kotlin",
+          "module": "kotlin-stdlib-jdk8",
+          "version": {
+            "requires": "1.7.0"
+          }
+        },
+        {
+          "group": "androidx.core",
+          "module": "core-ktx",
+          "version": {
+            "requires": "1.8.0"
+          }
+        },
+        {
+          "group": "org.jetbrains.kotlin",
+          "module": "kotlin-bom",
+          "version": {
+            "requires": "1.8.0"
+          },
+          "attributes": {
+            "org.gradle.category": "platform"
+          }
+        },
+        {
+          "group": "androidx.appcompat",
+          "module": "appcompat",
+          "version": {
+            "requires": "1.5.0"
+          }
+        },
+        {
+          "group": "com.google.android.material",
+          "module": "material",
+          "version": {
+            "requires": "1.6.1"
+          }
+        }
+      ],
+      "files": [
+        {
+          "name": "hydra-anonymous-1.10.0.aar",
+          "url": "hydra-anonymous-1.10.0.aar",
+          "size": 126548,
+          "sha512": "5eadbd67aceb09c179b7b1b4bd299f951ebb5d19521ce4af35cfcd76c03d8c876f5539823f9638f44542d043fff28f415094d611d9247ad83e102360f787c46a",
+          "sha256": "6c9a10f6e079645463ff827722236f2743beadb2bedf16d6092afbd98c232e91",
+          "sha1": "8f1c36bedf0294e57c922301bbed92a701e03cf5",
+          "md5": "5fa6d5f3af471311aae8cc2f675e6d76"
+        }
+      ]
+    }
+  ]
+}

package/android/libs/repo/com/capillarytech/hydra-anonymous/1.10.0/hydra-anonymous-1.10.0.pom

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <!-- This module was also published with a richer model, Gradle metadata,  -->
+  <!-- which should be used instead. Do not delete the following line which  -->
+  <!-- is to indicate to Gradle or any Gradle module metadata file consumer  -->
+  <!-- that they should prefer consuming it instead. -->
+  <!-- do_not_remove: published-with-gradle-metadata -->
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.capillarytech</groupId>
+  <artifactId>hydra-anonymous</artifactId>
+  <version>1.10.0</version>
+  <packaging>aar</packaging>
+  <name>hydra-anonymous</name>
+  <description>Capillary Hydra Anonymous SDK</description>
+  <url>https://github.com/Capillary/hydra-sdk-android</url>
+  <licenses>
+    <license>
+      <name>The Apache Software License, Version 2.0</name>
+      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+    </license>
+  </licenses>
+  <developers>
+    <developer>
+      <id>capillary</id>
+      <name>Capillary</name>
+      <email>support@capillarytech.com</email>
+    </developer>
+  </developers>
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>org.jetbrains.kotlin</groupId>
+        <artifactId>kotlin-bom</artifactId>
+        <version>1.8.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+  <dependencies>
+    <dependency>
+      <groupId>org.jetbrains.kotlin</groupId>
+      <artifactId>kotlin-stdlib-jdk8</artifactId>
+      <version>1.7.0</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jetbrains.kotlin</groupId>
+      <artifactId>kotlin-parcelize-runtime</artifactId>
+      <version>1.7.0</version>
+      <scope>runtime</scope>
+    </dependency>
+    <dependency>
+      <groupId>androidx.core</groupId>
+      <artifactId>core-ktx</artifactId>
+      <version>1.8.0</version>
+      <scope>runtime</scope>
+    </dependency>
+    <dependency>
+      <groupId>androidx.appcompat</groupId>
+      <artifactId>appcompat</artifactId>
+      <version>1.5.0</version>
+      <scope>runtime</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.android.material</groupId>
+      <artifactId>material</artifactId>
+      <version>1.6.1</version>
+      <scope>runtime</scope>
+    </dependency>
+  </dependencies>
+</project>