react-native-codepush-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 React Native CodePush SDK
+
+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. 

package/README.md

@@ -0,0 +1,278 @@
+# React Native CodePush SDK
+
+A comprehensive SDK for integrating CodePush-style over-the-air updates into your React Native apps, with support for custom servers and advanced update workflows.
+
+> **Looking for a working demo app?**
+> See the `example/` folder for a full React Native project that consumes this SDK.
+
+## Features
+
+### 🚀 Core Functionality
+- **Custom Server Integration**: Connect to your own CodePush server
+- **Over-the-Air Updates**: Download and install app updates without app store releases
+- **Rollback Support**: Automatically rollback failed updates
+- **Progress Tracking**: Real-time download and installation progress
+- **Mandatory Updates**: Support for required updates that users cannot skip
+
+### 📱 Platform Support
+- **iOS**: Full native integration
+- **Android**: Complete Android support
+- **Cross-Platform**: Unified API for both platforms
+
+### 🔧 Advanced Features
+- **Gradual Rollouts**: Support for percentage-based rollouts
+- **Update Validation**: Verify update integrity before installation
+- **Offline Support**: Handle updates when network is unavailable
+- **Background Downloads**: Download updates in the background
+- **Custom Install Modes**: Immediate, on restart, or on resume installation
+
+## Installation
+
+### 1. Install Dependencies
+
+```bash
+npm install react-native-fs react-native-zip-archive react-native-device-info @react-native-async-storage/async-storage
+```
+
+### 2. Platform Setup
+
+#### iOS Setup
+1. Run `cd ios && pod install`
+2. Add the following to your `Info.plist`:
+```xml
+<key>NSAppTransportSecurity</key>
+<dict>
+    <key>NSAllowsArbitraryLoads</key>
+    <true/>
+</dict>
+```
+
+#### Android Setup
+1. Add permissions to `android/app/src/main/AndroidManifest.xml`:
+```xml
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+```
+
+## Usage
+
+### Basic Setup
+
+```tsx
+import React from 'react';
+import { SafeAreaView } from 'react-native';
+import { CodePushProvider } from './src/sdk/CodePushProvider';
+import UpdateChecker from './src/components/UpdateChecker';
+
+const App: React.FC = () => {
+  const codePushConfig = {
+    serverUrl: 'https://your-custom-codepush-server.com',
+    deploymentKey: 'your-deployment-key-here',
+    appVersion: '1.0.0',
+    checkFrequency: 'ON_APP_START',
+    installMode: 'ON_NEXT_RESTART',
+  };
+
+  return (
+    <CodePushProvider config={codePushConfig} autoCheck={true}>
+      <SafeAreaView style={{ flex: 1 }}>
+        <UpdateChecker />
+      </SafeAreaView>
+    </CodePushProvider>
+  );
+};
+
+export default App;
+```
+
+### Using the Hook
+
+```tsx
+import { useCodePush } from './src/sdk/CodePushProvider';
+
+const MyComponent = () => {
+  const {
+    availableUpdate,
+    isChecking,
+    checkForUpdate,
+    syncUpdate,
+  } = useCodePush();
+
+  return (
+    <View>
+      {availableUpdate && (
+        <Button title="Install Update" onPress={syncUpdate} />
+      )}
+      <Button 
+        title="Check for Updates" 
+        onPress={checkForUpdate}
+        disabled={isChecking}
+      />
+    </View>
+  );
+};
+```
+
+### Manual Integration
+
+```tsx
+import CustomCodePush from './src/sdk/CustomCodePush';
+
+const codePush = new CustomCodePush({
+  serverUrl: 'https://your-server.com',
+  deploymentKey: 'your-key',
+  appVersion: '1.0.0',
+});
+
+// Check for updates
+const update = await codePush.checkForUpdate();
+
+// Download and install
+if (update) {
+  const localPackage = await codePush.downloadUpdate(update, (progress) => {
+    console.log(`Download progress: ${progress.receivedBytes}/${progress.totalBytes}`);
+  });
+  
+  await codePush.installUpdate(localPackage);
+}
+```
+
+## Server Implementation
+
+Your custom CodePush server needs to implement these endpoints:
+
+### Check for Updates
+```
+POST /api/v1/updates/check
+```
+
+### Report Installation
+```
+POST /api/v1/updates/report
+```
+
+### Report Rollback
+```
+POST /api/v1/updates/rollback
+```
+
+See `src/api/server-example.md` for detailed API documentation.
+
+## Configuration Options
+
+```typescript
+interface CodePushConfiguration {
+  serverUrl: string;                    // Your server URL
+  deploymentKey: string;                // Deployment key for authentication
+  appVersion: string;                   // Current app version
+  checkFrequency?: 'ON_APP_START' |     // When to check for updates
+                   'ON_APP_RESUME' | 
+                   'MANUAL';
+  installMode?: 'IMMEDIATE' |           // When to install updates
+                'ON_NEXT_RESTART' | 
+                'ON_NEXT_RESUME';
+  minimumBackgroundDuration?: number;   // Minimum background time before checking
+}
+```
+
+## API Reference
+
+### CustomCodePush Class
+
+#### Methods
+
+- `checkForUpdate()`: Check if an update is available
+- `downloadUpdate(update, progressCallback)`: Download an update package
+- `installUpdate(localPackage)`: Install a downloaded update
+- `sync(options, statusCallback, progressCallback)`: Complete sync process
+- `getCurrentPackage()`: Get current installed package info
+- `rollback()`: Rollback to previous version
+- `clearUpdates()`: Clear all downloaded updates
+
+### CodePushProvider Component
+
+#### Props
+
+- `config`: CodePush configuration object
+- `autoCheck`: Automatically check for updates on app start
+- `checkOnResume`: Check for updates when app resumes
+
+### useCodePush Hook
+
+#### Returns
+
+- `codePush`: CustomCodePush instance
+- `currentUpdate`: Currently installed update info
+- `availableUpdate`: Available update info
+- `syncStatus`: Current sync status
+- `isChecking`: Whether checking for updates
+- `isDownloading`: Whether downloading an update
+- `isInstalling`: Whether installing an update
+- `checkForUpdate()`: Function to check for updates
+- `syncUpdate()`: Function to sync and install updates
+- `rollback()`: Function to rollback updates
+- `clearUpdates()`: Function to clear all updates
+
+## Update Package Format
+
+Update packages should be ZIP files with this structure:
+
+```
+package.zip
+├── index.bundle          # Main JavaScript bundle
+├── index.bundle.map      # Source map (optional)
+├── assets/              # Static assets
+│   ├── images/
+│   ├── fonts/
+│   └── ...
+└── metadata.json        # Package metadata
+```
+
+## Security Considerations
+
+1. **HTTPS Only**: Always use HTTPS for your server
+2. **Authentication**: Validate deployment keys on server
+3. **Package Signing**: Consider signing update packages
+4. **Rate Limiting**: Implement rate limiting on your server
+5. **Rollback Protection**: Implement automatic rollback for failed updates
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Network Errors**: Check server URL and network connectivity
+2. **Permission Errors**: Ensure file system permissions are granted
+3. **Bundle Errors**: Verify update package format and integrity
+4. **Installation Failures**: Check available storage space
+
+### Debug Mode
+
+Enable debug logging by setting:
+
+```typescript
+// Add to your configuration
+const config = {
+  // ... other config
+  debug: true,
+};
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions:
+- Check the troubleshooting section
+- Review the server API documentation
+- Create an issue in the repository

package/dist/hooks/useFrameworkReady.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFrameworkReady = useFrameworkReady;
+const react_1 = require("react");
+function useFrameworkReady() {
+    (0, react_1.useEffect)(() => {
+        if (typeof window !== 'undefined' && window.frameworkReady) {
+            window.frameworkReady();
+        }
+    });
+}

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFrameworkReady = exports.codePushService = exports.BundleManager = exports.UpdateChecker = exports.CustomCodePush = exports.useCodePush = exports.CodePushProvider = void 0;
+// Main entry point for React Native CodePush SDK
+var CodePushProvider_1 = require("./src/sdk/CodePushProvider");
+Object.defineProperty(exports, "CodePushProvider", { enumerable: true, get: function () { return CodePushProvider_1.CodePushProvider; } });
+Object.defineProperty(exports, "useCodePush", { enumerable: true, get: function () { return CodePushProvider_1.useCodePush; } });
+var CustomCodePush_1 = require("./src/sdk/CustomCodePush");
+Object.defineProperty(exports, "CustomCodePush", { enumerable: true, get: function () { return __importDefault(CustomCodePush_1).default; } });
+var UpdateChecker_1 = require("./src/components/UpdateChecker");
+Object.defineProperty(exports, "UpdateChecker", { enumerable: true, get: function () { return __importDefault(UpdateChecker_1).default; } });
+var BundleManager_1 = require("./src/utils/BundleManager");
+Object.defineProperty(exports, "BundleManager", { enumerable: true, get: function () { return BundleManager_1.BundleManager; } });
+var codepushService_1 = require("./services/codepushService");
+Object.defineProperty(exports, "codePushService", { enumerable: true, get: function () { return codepushService_1.codePushService; } });
+var useFrameworkReady_1 = require("./hooks/useFrameworkReady");
+Object.defineProperty(exports, "useFrameworkReady", { enumerable: true, get: function () { return useFrameworkReady_1.useFrameworkReady; } });
+// Export types
+__exportStar(require("./types/codepush"), exports);

package/dist/services/codepushService.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.codePushService = void 0;
+// Mock service for demonstration - replace with actual CodePush SDK calls
+class CodePushService {
+    constructor() {
+        this.mockDeployments = [
+            {
+                name: 'Production',
+                key: 'prod-key-12345678',
+                package: {
+                    id: '1',
+                    label: 'v1.2.3',
+                    description: 'Bug fixes and performance improvements',
+                    packageHash: 'abc123def456',
+                    blobUrl: 'https://codepush.blob.core.windows.net/package1',
+                    downloadUrl: 'https://codepush.blob.core.windows.net/package1',
+                    packageSize: 2048576,
+                    deploymentKey: 'prod-key-12345678',
+                    isFirstRun: false,
+                    failedInstall: false,
+                    isMandatory: false,
+                    timestamp: Date.now() - 86400000,
+                    version: '1.2.3'
+                }
+            },
+            {
+                name: 'Staging',
+                key: 'staging-key-87654321',
+                package: {
+                    id: '2',
+                    label: 'v1.2.4-beta',
+                    description: 'New feature preview and experimental changes',
+                    packageHash: 'def456ghi789',
+                    blobUrl: 'https://codepush.blob.core.windows.net/package2',
+                    downloadUrl: 'https://codepush.blob.core.windows.net/package2',
+                    packageSize: 3145728,
+                    deploymentKey: 'staging-key-87654321',
+                    isFirstRun: false,
+                    failedInstall: false,
+                    isMandatory: true,
+                    timestamp: Date.now() - 3600000,
+                    version: '1.2.4'
+                }
+            },
+            {
+                name: 'Development',
+                key: 'dev-key-11223344',
+            }
+        ];
+        this.mockHistory = [
+            {
+                id: '1',
+                version: '1.2.3',
+                timestamp: Date.now() - 86400000,
+                status: 'SUCCESS',
+                description: 'Bug fixes and performance improvements',
+                downloadSize: 2048576,
+            },
+            {
+                id: '2',
+                version: '1.2.2',
+                timestamp: Date.now() - 172800000,
+                status: 'SUCCESS',
+                description: 'UI improvements and new dashboard features',
+                downloadSize: 1536000,
+            },
+            {
+                id: '3',
+                version: '1.2.1',
+                timestamp: Date.now() - 259200000,
+                status: 'ROLLBACK',
+                description: 'Critical bug fix rollback',
+                downloadSize: 1024000,
+            },
+            {
+                id: '4',
+                version: '1.2.0',
+                timestamp: Date.now() - 345600000,
+                status: 'FAILED',
+                description: 'Major feature update with new authentication',
+                downloadSize: 4096000,
+            }
+        ];
+    }
+    async checkForUpdate() {
+        // Simulate API call delay
+        await new Promise(resolve => setTimeout(resolve, 1500));
+        // 70% chance of no update, 30% chance of update available
+        if (Math.random() > 0.3) {
+            return null;
+        }
+        return {
+            id: 'update-' + Date.now(),
+            label: 'v1.2.5',
+            description: 'Security updates and bug fixes',
+            packageHash: 'new-hash-123',
+            blobUrl: 'https://codepush.blob.core.windows.net/new-package',
+            downloadUrl: 'https://codepush.blob.core.windows.net/new-package',
+            packageSize: 1843200,
+            deploymentKey: 'prod-key-12345678',
+            isFirstRun: false,
+            failedInstall: false,
+            isMandatory: false,
+            timestamp: Date.now(),
+            version: '1.2.5'
+        };
+    }
+    async downloadUpdate(update, onProgress) {
+        // Simulate download progress
+        for (let i = 0; i <= 100; i += 5) {
+            await new Promise(resolve => setTimeout(resolve, 100));
+            onProgress(i);
+        }
+        return true;
+    }
+    async installUpdate() {
+        // Simulate installation
+        await new Promise(resolve => setTimeout(resolve, 2000));
+        return true;
+    }
+    async sync(onStatusChange) {
+        onStatusChange({ status: 'CHECKING_FOR_UPDATE' });
+        await new Promise(resolve => setTimeout(resolve, 1000));
+        const update = await this.checkForUpdate();
+        if (!update) {
+            onStatusChange({ status: 'UP_TO_DATE' });
+            return false;
+        }
+        onStatusChange({ status: 'DOWNLOADING_PACKAGE', progress: 0 });
+        const downloadSuccess = await this.downloadUpdate(update, (progress) => {
+            onStatusChange({ status: 'DOWNLOADING_PACKAGE', progress });
+        });
+        if (!downloadSuccess) {
+            onStatusChange({ status: 'UNKNOWN_ERROR' });
+            return false;
+        }
+        onStatusChange({ status: 'INSTALLING_UPDATE' });
+        const installSuccess = await this.installUpdate();
+        if (installSuccess) {
+            onStatusChange({ status: 'UPDATE_INSTALLED' });
+            return true;
+        }
+        else {
+            onStatusChange({ status: 'UNKNOWN_ERROR' });
+            return false;
+        }
+    }
+    async getDeployments() {
+        // Simulate API call
+        await new Promise(resolve => setTimeout(resolve, 500));
+        return this.mockDeployments;
+    }
+    async getUpdateHistory() {
+        // Simulate API call
+        await new Promise(resolve => setTimeout(resolve, 300));
+        return this.mockHistory;
+    }
+    async getCurrentPackageInfo() {
+        // Return current package info
+        return this.mockDeployments[0].package || null;
+    }
+}
+exports.codePushService = new CodePushService();