@swiftpatch/react-native 2.0.0

package/README.md

@@ -0,0 +1,430 @@
+# SwiftPatch React Native SDK
+
+[![npm version](https://img.shields.io/npm/v/@swiftpatch/react-native.svg)](https://www.npmjs.com/package/@swiftpatch/react-native)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![React Native](https://img.shields.io/badge/React%20Native-0.76+-blue.svg)](https://reactnative.dev/)
+[![New Architecture](https://img.shields.io/badge/New%20Architecture-Supported-green.svg)](https://reactnative.dev/architecture/landing-page)
+
+Over-the-Air (OTA) update SDK for React Native with **differential patching**, automatic rollback, and cryptographic verification. Optimized for the React Native New Architecture.
+
+## ✨ Features
+
+- 🚀 **Differential Patching** - Download only what changed (bsdiff/bspatch)
+- 🔄 **Automatic Rollback** - Crash detection with instant recovery
+- 🔒 **Bundle Signing** - RSA signature verification for security
+- ⚡ **New Architecture** - TurboModules for 40% faster performance
+- 🎯 **Dual-Slot System** - Safe production/staging environment switching
+- 📦 **Small Updates** - Patches typically 10-50x smaller than full bundles
+- 🛡️ **Type-Safe** - Full TypeScript support
+- 🎨 **React Hooks** - Modern API with Provider pattern
+- 📱 **Cross-Platform** - iOS and Android support
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @swiftpatch/react-native
+# or
+yarn add @swiftpatch/react-native
+```
+
+### iOS Setup
+
+```bash
+cd ios
+pod install
+cd ..
+```
+
+### Android Setup
+
+No additional steps required.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Wrap your app with SwiftPatchProvider
+
+```tsx
+import { SwiftPatchProvider } from '@swiftpatch/react-native';
+
+export default function App() {
+  return (
+    <SwiftPatchProvider
+      config={{
+        deploymentKey: 'YOUR_DEPLOYMENT_KEY',
+        serverUrl: 'https://your-server.com/api/v1', // optional
+        debug: __DEV__,
+      }}
+    >
+      <YourApp />
+    </SwiftPatchProvider>
+  );
+}
+```
+
+### 2. Use the hook in your components
+
+```tsx
+import { useSwiftPatch, UpdateStatus } from '@swiftpatch/react-native';
+
+function UpdateButton() {
+  const {
+    status,
+    availableUpdate,
+    downloadProgress,
+    checkForUpdate,
+    downloadUpdate,
+    installUpdate,
+    restart,
+  } = useSwiftPatch();
+
+  const handleUpdate = async () => {
+    // Check for updates
+    const update = await checkForUpdate();
+
+    if (update) {
+      // Download the update
+      await downloadUpdate();
+
+      // Install and restart
+      await installUpdate();
+      restart();
+    }
+  };
+
+  if (status === UpdateStatus.DOWNLOADING) {
+    return <Text>Downloading: {downloadProgress?.percentage}%</Text>;
+  }
+
+  return (
+    <Button
+      title={availableUpdate ? 'Update Available' : 'Check for Updates'}
+      onPress={handleUpdate}
+    />
+  );
+}
+```
+
+### 3. Or use the built-in modal
+
+```tsx
+import { useSwiftPatchModal, SwiftPatchModal } from '@swiftpatch/react-native';
+
+function App() {
+  const { showModal } = useSwiftPatchModal();
+
+  return (
+    <>
+      <YourApp />
+      <SwiftPatchModal />
+      <Button title="Check for Updates" onPress={showModal} />
+    </>
+  );
+}
+```
+
+---
+
+## 📚 API Reference
+
+### SwiftPatchProvider
+
+```tsx
+interface SwiftPatchConfig {
+  deploymentKey: string;
+  serverUrl?: string;
+  checkOnResume?: boolean;
+  checkInterval?: number;
+  installMode?: InstallMode;
+  mandatoryInstallMode?: InstallMode;
+  debug?: boolean;
+  customHeaders?: Record<string, string>;
+  publicKey?: string;
+  autoStabilizeAfterLaunches?: number;
+}
+```
+
+### useSwiftPatch Hook
+
+```tsx
+const {
+  // State
+  status,                    // Current update status
+  downloadProgress,          // Download progress (0-100%)
+  currentBundle,             // Currently installed bundle info
+  availableUpdate,           // Available update info
+  isRestartRequired,         // Whether restart is needed
+  error,                     // Last error
+  lastCheckedAt,             // Last check timestamp
+  slotMetadata,             // Dual-slot system metadata
+  environment,              // Current environment (PROD/STAGE)
+
+  // Actions
+  checkForUpdate,           // Check for available updates
+  downloadUpdate,           // Download available update
+  installUpdate,            // Install downloaded update
+  restart,                  // Restart app to apply update
+  rollback,                 // Rollback to previous version
+  clearPendingUpdate,       // Clear pending update
+  getCurrentBundle,         // Get current bundle info
+  stabilize,                // Stabilize current bundle
+  switchEnvironment,        // Switch PROD/STAGE environment
+  getSlotMetadata,          // Get slot metadata
+  markMounted,              // Mark app as mounted (crash detection)
+  downloadStageBundle,      // Download staging bundle
+} = useSwiftPatch();
+```
+
+### Imperative API (Non-React)
+
+For use outside React components:
+
+```tsx
+import { SwiftPatch } from '@swiftpatch/react-native';
+
+const swiftPatch = new SwiftPatch({
+  deploymentKey: 'YOUR_KEY',
+});
+
+await swiftPatch.init();
+
+const update = await swiftPatch.checkForUpdate();
+if (update) {
+  await swiftPatch.downloadAndInstall(update);
+  swiftPatch.restart();
+}
+```
+
+---
+
+## 🎯 Install Modes
+
+```tsx
+enum InstallMode {
+  IMMEDIATE = 'immediate',           // Install and restart immediately
+  ON_NEXT_RESTART = 'onNextRestart', // Install on next app restart
+  ON_NEXT_RESUME = 'onNextResume',   // Install when app resumes
+}
+```
+
+---
+
+## 🔧 Advanced Features
+
+### Differential Patching
+
+SwiftPatch automatically uses differential patching when available:
+
+```tsx
+// Server determines if patch is available
+// SDK handles full bundle vs patch automatically
+await downloadUpdate();
+
+// Patch files are typically 10-50x smaller
+// e.g., 50MB bundle → 2MB patch
+```
+
+### Automatic Rollback
+
+```tsx
+// Crash detection window: 10 seconds
+// If app crashes during this window, automatic rollback occurs
+
+const { rollback } = useSwiftPatch();
+
+// Manual rollback
+await rollback();
+```
+
+### Bundle Signing (Optional)
+
+```tsx
+<SwiftPatchProvider
+  config={{
+    deploymentKey: 'YOUR_KEY',
+    publicKey: 'YOUR_RSA_PUBLIC_KEY',
+  }}
+>
+  <App />
+</SwiftPatchProvider>
+
+// SDK automatically verifies signatures
+```
+
+### Environment Switching (PROD/STAGE)
+
+```tsx
+const { switchEnvironment, environment } = useSwiftPatch();
+
+// Switch to staging
+await switchEnvironment(EnvironmentMode.STAGING);
+
+// Download and test staging bundle
+await downloadStageBundle(url, hash);
+
+// Switch back to production
+await switchEnvironment(EnvironmentMode.PRODUCTION);
+```
+
+---
+
+## 🆕 New Architecture Support
+
+SwiftPatch v2.0+ fully supports the React Native New Architecture:
+
+### Enable New Architecture
+
+**iOS** (`ios/Podfile`):
+```ruby
+ENV['RCT_NEW_ARCH_ENABLED'] = '1'
+```
+
+**Android** (`android/gradle.properties`):
+```properties
+newArchEnabled=true
+```
+
+### Performance Benefits
+
+| Operation | Legacy | TurboModule | Improvement |
+|-----------|--------|-------------|-------------|
+| Check Update | 15ms | 2ms | 87% faster |
+| Get Bundle Info | 8ms | 1ms | 87% faster |
+| Native Calls | 3-5ms | 0.5-1ms | 80% faster |
+
+### Detection
+
+```tsx
+import { IS_TURBO_MODULE_ENABLED } from '@swiftpatch/react-native';
+
+console.log('Using TurboModules:', IS_TURBO_MODULE_ENABLED);
+```
+
+---
+
+## 🧪 Testing
+
+```bash
+npm test
+```
+
+All core functionality is tested:
+- Update checking
+- Download & installation
+- Rollback mechanisms
+- Cryptographic verification
+- Event handling
+
+---
+
+## 📱 Platform Requirements
+
+| Platform | Minimum | Recommended |
+|----------|---------|-------------|
+| iOS | 13.4+ | 15.0+ |
+| Android | API 24+ (7.0) | API 31+ (12) |
+| React Native | 0.76.0+ | 0.76.5+ |
+| React | 18.2.0+ | 18.3.0+ |
+
+---
+
+## 🔒 Security
+
+- **Bundle Signing**: Optional RSA signature verification
+- **HTTPS Only**: All downloads over secure connections
+- **Hash Verification**: SHA-256 hash checking for all bundles
+- **Integrity Checks**: Automatic corruption detection
+
+---
+
+## 📊 Bundle Size
+
+| File | Size | Compressed |
+|------|------|------------|
+| Core JS | ~45KB | ~12KB |
+| Native (iOS) | ~150KB | - |
+| Native (Android) | ~200KB | - |
+
+---
+
+## 🛠️ Development
+
+```bash
+# Clone the repository
+git clone https://github.com/codewprincee/react-native-swiftpatch.git
+
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Build
+npm run prepare
+
+# Run example app
+npm run example start
+```
+
+---
+
+## 🐛 Troubleshooting
+
+### iOS Build Errors
+
+```bash
+cd ios
+rm -rf Pods Podfile.lock
+pod install
+cd ..
+```
+
+### Android Build Errors
+
+```bash
+cd android
+./gradlew clean
+cd ..
+```
+
+### Type Errors
+
+```bash
+npm run typescript
+```
+
+---
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) for details
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) first.
+
+---
+
+## 📞 Support
+
+- 📧 Email: sdk@swiftpatch.io
+- 🐛 Issues: [GitHub Issues](https://github.com/codewprincee/react-native-swiftpatch/issues)
+- 📖 Docs: [swiftpatch.io](https://swiftpatch.io)
+
+---
+
+## 🎉 Acknowledgments
+
+Built with:
+- [React Native](https://reactnative.dev/)
+- [bsdiff/bspatch](http://www.daemonology.net/bsdiff/) for differential patching
+- [TypeScript](https://www.typescriptlang.org/)
+
+---
+
+**Made with ❤️ by the SwiftPatch Team**

package/android/build.gradle

@@ -0,0 +1,105 @@
+buildscript {
+    ext.safeExtGet = {prop, fallback ->
+        rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+    }
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath("com.android.tools.build:gradle:8.7.3")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${safeExtGet('kotlinVersion', '2.0.21')}")
+    }
+}
+
+def isNewArchitectureEnabled() {
+    return project.hasProperty("newArchEnabled") && project.newArchEnabled == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+if (isNewArchitectureEnabled()) {
+    apply plugin: "com.facebook.react"
+}
+
+def reactNativeArchitectures() {
+    def value = project.getProperties().get("reactNativeArchitectures")
+    return value ? value.split(",") : ["armeabi-v7a", "arm64-v8a", "x86", "x86_64"]
+}
+
+android {
+    namespace "com.swiftpatch"
+    compileSdkVersion safeExtGet("compileSdkVersion", 35)
+
+    defaultConfig {
+        minSdkVersion safeExtGet("minSdkVersion", 24)
+        targetSdkVersion safeExtGet("targetSdkVersion", 35)
+
+        ndk {
+            abiFilters(*reactNativeArchitectures())
+        }
+
+        externalNativeBuild {
+            cmake {
+                cppFlags "-std=c++17"
+                arguments "-DANDROID_STL=c++_shared"
+            }
+        }
+
+        buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+    }
+
+    externalNativeBuild {
+        cmake {
+            path "src/main/jni/CMakeLists.txt"
+        }
+    }
+
+    buildFeatures {
+        buildConfig true
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = "17"
+    }
+
+    sourceSets {
+        main {
+            java.srcDirs = ['src/main/java']
+            if (isNewArchitectureEnabled()) {
+                java.srcDirs += ['build/generated/source/codegen/java']
+            }
+        }
+    }
+}
+
+repositories {
+    mavenCentral()
+    google()
+    maven {
+        url "$projectDir/../node_modules/react-native/android"
+    }
+}
+
+dependencies {
+    implementation "com.facebook.react:react-android:+"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:${safeExtGet('kotlinVersion', '2.0.21')}"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0"
+
+    if (isNewArchitectureEnabled()) {
+        implementation "com.facebook.react:react-native:+"
+        implementation "androidx.annotation:annotation:1.9.1"
+    }
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,6 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.swiftpatch">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+</manifest>

package/android/src/main/java/com/swiftpatch/BundleManager.kt

@@ -0,0 +1,107 @@
+package com.swiftpatch
+
+import android.content.Context
+import android.content.SharedPreferences
+import java.io.File
+import java.io.FileOutputStream
+
+class BundleManager(private val context: Context) {
+
+    private val baseDir: File
+        get() = File(context.filesDir, "swiftpatch")
+
+    private val bundlesDir: File
+        get() = File(baseDir, "bundles")
+
+    private val patchesDir: File
+        get() = File(baseDir, "patches")
+
+    private val tempDir: File
+        get() = File(baseDir, "temp")
+
+    /**
+     * Ensure all required directories exist
+     */
+    fun ensureDirectoriesExist() {
+        bundlesDir.mkdirs()
+        patchesDir.mkdirs()
+        tempDir.mkdirs()
+    }
+
+    /**
+     * Get the file path for a downloaded update (before processing)
+     */
+    fun getDownloadFile(hash: String): File {
+        return File(tempDir, "$hash.download")
+    }
+
+    /**
+     * Get the file path for a decompressed file
+     */
+    fun getDecompressedFile(hash: String): File {
+        return File(tempDir, "$hash.decompressed")
+    }
+
+    /**
+     * Get the file path for a bundle by its hash
+     */
+    fun getBundleFile(hash: String): File {
+        return File(bundlesDir, "$hash.bundle")
+    }
+
+    /**
+     * Extract the original bundled JS bundle from APK assets
+     */
+    fun extractOriginalBundle(context: Context): File {
+        val originalFile = File(tempDir, "original.bundle")
+        if (originalFile.exists()) {
+            return originalFile
+        }
+
+        try {
+            context.assets.open("index.android.bundle").use { input ->
+                FileOutputStream(originalFile).use { output ->
+                    input.copyTo(output)
+                }
+            }
+        } catch (_: Exception) {
+            // Try alternate bundle name
+            context.assets.open("main.jsbundle").use { input ->
+                FileOutputStream(originalFile).use { output ->
+                    input.copyTo(output)
+                }
+            }
+        }
+
+        return originalFile
+    }
+
+    /**
+     * Clean up old bundles that are no longer needed.
+     * Keeps only the current and previous bundles.
+     */
+    fun cleanupOldBundles(prefs: SharedPreferences) {
+        val currentHash = prefs.getString("current_bundle_hash", null)
+        val previousHash = prefs.getString("previous_bundle_hash", null)
+
+        val keepHashes = setOfNotNull(currentHash, previousHash)
+
+        // Clean up bundles
+        bundlesDir.listFiles()?.forEach { file ->
+            val fileHash = file.nameWithoutExtension
+            if (fileHash !in keepHashes) {
+                file.delete()
+            }
+        }
+
+        // Clean up temp directory
+        tempDir.listFiles()?.forEach { file ->
+            file.delete()
+        }
+
+        // Clean up patches
+        patchesDir.listFiles()?.forEach { file ->
+            file.delete()
+        }
+    }
+}