native-update 1.0.2 → 1.0.4

package/docs/examples/advanced-scenarios.md

@@ -10,13 +10,10 @@ Minimize download sizes by only downloading changed files:
 import { NativeUpdate } from 'native-update';
 
 async function checkForDeltaUpdate() {
-  const currentManifest = await NativeUpdate.getCurrentManifest();
+  const currentManifest = await NativeUpdate.current();
   
-  const result = await NativeUpdate.checkForUpdate({
-    updateUrl: 'https://your-update-server.com/api/check',
-    currentVersion: currentManifest.version,
-    currentChecksum: currentManifest.checksum,
-    supportsDelta: true
+  const result = await NativeUpdate.sync({
+    installMode: 'ON_NEXT_RESTART'
   });
   
   if (result.updateAvailable && result.deltaAvailable) {
@@ -26,15 +23,15 @@ async function checkForDeltaUpdate() {
 }
 
 async function downloadDeltaUpdate(deltaUrl: string) {
-  const download = await NativeUpdate.downloadUpdate({
-    url: deltaUrl,
-    isDelta: true
+  const download = await NativeUpdate.download({
+    version: 'delta-version'
   });
   
-  // Apply delta patch
-  await NativeUpdate.applyDelta({
+  // Set the bundle as active
+  await NativeUpdate.set({
     bundleId: download.bundleId,
-    baseVersion: getCurrentVersion()
+    version: download.version,
+    checksum: download.checksum
   });
 }
 ```
@@ -63,9 +60,7 @@ async function switchToBetaChannel() {
   await setupUpdateChannel(UpdateChannel.BETA);
   
   // Check for updates in the new channel
-  const result = await NativeUpdate.checkForUpdate({
-    currentVersion: await getCurrentVersion()
-  });
+  const result = await NativeUpdate.sync();
   
   if (result.updateAvailable) {
     console.log(`Beta update ${result.version} available`);
@@ -82,13 +77,8 @@ async function checkStagedUpdate() {
   const deviceId = await getDeviceId();
   const rolloutPercentage = hashDeviceId(deviceId) % 100;
   
-  const result = await NativeUpdate.checkForUpdate({
-    updateUrl: 'https://your-update-server.com/api/check',
-    currentVersion: '1.0.0',
-    metadata: {
-      deviceId,
-      rolloutGroup: rolloutPercentage
-    }
+  const result = await NativeUpdate.sync({
+    installMode: 'ON_NEXT_RESTART'
   });
   
   if (result.updateAvailable && result.rolloutPercentage >= rolloutPercentage) {
@@ -110,11 +100,10 @@ async function setupBackgroundUpdates() {
     autoInstallMode: 'on-restart'
   });
   
-  // Schedule background update checks
-  await NativeUpdate.scheduleBackgroundCheck({
-    interval: 14400000, // 4 hours
-    requiresWifi: true,
-    requiresCharging: false
+  // Configure automatic update checks
+  await NativeUpdate.configure({
+    checkInterval: 14400, // 4 hours in seconds
+    autoCheck: true
   });
 }
 
@@ -134,14 +123,15 @@ Implement automatic rollback on update failures:
 
 ```typescript
 async function safeUpdate() {
-  // Save current version info before update
-  const backup = await NativeUpdate.createBackup();
+  // Get current version info before update
+  const backup = await NativeUpdate.current();
   
   try {
     // Attempt update
-    await NativeUpdate.installUpdate({
+    await NativeUpdate.set({
       bundleId: 'new-update-id',
-      validateAfterInstall: true
+      version: 'new-version',
+      checksum: 'bundle-checksum'
     });
     
     // Verify update success
@@ -150,15 +140,13 @@ async function safeUpdate() {
       throw new Error('Health check failed');
     }
     
-    // Confirm successful update
-    await NativeUpdate.confirmUpdate();
+    // Notify app is ready with new bundle
+    await NativeUpdate.notifyAppReady();
   } catch (error) {
     console.error('Update failed, rolling back:', error);
     
     // Automatic rollback
-    await NativeUpdate.rollback({
-      backupId: backup.id
-    });
+    await NativeUpdate.reset();
     
     // Report failure to analytics
     reportUpdateFailure(error);
@@ -201,18 +189,15 @@ async function setupABTest(config: ABTestConfig) {
     ? config.variants.treatment 
     : config.variants.control;
     
-  const download = await NativeUpdate.downloadUpdate({
-    url: bundleUrl,
-    metadata: {
-      testId: config.testId,
-      variant
-    }
+  const download = await NativeUpdate.download({
+    version: variant
   });
   
-  // Install with test metadata
-  await NativeUpdate.installUpdate({
+  // Set the bundle as active
+  await NativeUpdate.set({
     bundleId: download.bundleId,
-    preserveData: true
+    version: download.version,
+    checksum: download.checksum
   });
 }
 ```
@@ -227,10 +212,7 @@ class UpdateManager {
   
   async checkAndPromptUpdate() {
     // Check for update
-    const result = await NativeUpdate.checkForUpdate({
-      updateUrl: 'https://your-update-server.com/api/check',
-      currentVersion: await this.getCurrentVersion()
-    });
+    const result = await NativeUpdate.sync();
     
     if (!result.updateAvailable) return;
     
@@ -265,15 +247,17 @@ class UpdateManager {
     );
     
     try {
-      const download = await NativeUpdate.downloadUpdate({
-        url: updateInfo.downloadUrl
+      const download = await NativeUpdate.download({
+        version: updateInfo.version
       });
       
       this.updateState = { status: 'installing' };
       this.updateUI();
       
-      await NativeUpdate.installUpdate({
-        bundleId: download.bundleId
+      await NativeUpdate.set({
+        bundleId: download.bundleId,
+        version: download.version,
+        checksum: download.checksum
       });
       
       this.updateState = { status: 'ready' };
@@ -300,18 +284,7 @@ async function secureUpdateCheck() {
     version: getCurrentVersion()
   });
   
-  const result = await NativeUpdate.checkForUpdate({
-    updateUrl: 'https://your-update-server.com/api/check',
-    currentVersion: getCurrentVersion(),
-    headers: {
-      'X-Timestamp': timestamp.toString(),
-      'X-Nonce': nonce,
-      'X-Signature': signature
-    },
-    certificatePins: [
-      'sha256/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA='
-    ]
-  });
+  const result = await NativeUpdate.sync();
   
   // Verify response signature
   if (!await verifyUpdateSignature(result)) {
@@ -322,20 +295,18 @@ async function secureUpdateCheck() {
 }
 
 async function downloadWithIntegrityCheck(url: string, expectedHash: string) {
-  const download = await NativeUpdate.downloadUpdate({
-    url,
-    validateChecksum: true,
-    expectedChecksum: expectedHash,
-    algorithm: 'sha256'
+  const download = await NativeUpdate.download({
+    version: 'secure-version'
   });
   
   // Additional verification
-  const verified = await NativeUpdate.verifyBundle({
-    bundleId: download.bundleId,
-    publicKey: await getPublicKey()
+  const verified = await NativeUpdate.validateUpdate({
+    bundlePath: download.path,
+    checksum: download.checksum,
+    signature: 'bundle-signature'
   });
   
-  if (!verified.valid) {
+  if (!verified.isValid) {
     throw new Error('Bundle verification failed');
   }
   
@@ -362,10 +333,7 @@ class UpdateMetrics {
     
     try {
       // Check phase
-      const result = await NativeUpdate.checkForUpdate({
-        updateUrl: 'https://your-update-server.com/api/check',
-        currentVersion: getCurrentVersion()
-      });
+      const result = await NativeUpdate.sync();
       
       if (!result.updateAvailable) {
         metrics.checkCompleted = Date.now();
@@ -375,16 +343,18 @@ class UpdateMetrics {
       
       // Download phase
       metrics.downloadStarted = Date.now();
-      const download = await NativeUpdate.downloadUpdate({
-        url: result.downloadUrl
+      const download = await NativeUpdate.download({
+        version: result.version
       });
       metrics.downloadCompleted = Date.now();
       metrics.downloadSize = download.size;
       
       // Install phase
       metrics.installStarted = Date.now();
-      await NativeUpdate.installUpdate({
-        bundleId: download.bundleId
+      await NativeUpdate.set({
+        bundleId: download.bundleId,
+        version: download.version,
+        checksum: download.checksum
       });
       metrics.installCompleted = Date.now();
       
@@ -405,6 +375,6 @@ class UpdateMetrics {
 
 ## Next Steps
 
-- Review [Integration Examples](./integration-examples.md) for framework-specific implementations
-- See the [API Reference](../api/README.md) for detailed method documentation
+- Review [Basic Usage](./basic-usage.md) for framework-specific implementations
+- See the [API Reference](../api/live-update-api.md) for detailed method documentation
 - Check [Basic Usage](./basic-usage.md) for simpler examples

package/docs/examples/basic-usage.md

@@ -17,39 +17,36 @@ import { NativeUpdate } from 'native-update';
 // Check for updates on app startup
 async function checkForUpdates() {
   try {
-    const result = await NativeUpdate.checkForUpdate({
-      updateUrl: 'https://your-update-server.com/api/check',
-      currentVersion: '1.0.0'
+    const result = await NativeUpdate.sync({
+      updateUrl: 'https://your-update-server.com/api/check'
     });
     
-    if (result.updateAvailable) {
-      console.log(`Update available: ${result.version}`);
-      // Download and install the update
-      await downloadAndInstall(result.downloadUrl);
+    if (result.status === 'UPDATE_AVAILABLE') {
+      console.log(`Update available: ${result.bundle?.version}`);
+      // Update will be downloaded and installed automatically
+    } else if (result.status === 'UPDATE_INSTALLED') {
+      // Reload the app to apply the update
+      await NativeUpdate.reload();
     }
   } catch (error) {
     console.error('Update check failed:', error);
   }
 }
 
-async function downloadAndInstall(downloadUrl: string) {
-  // Download the update
-  const download = await NativeUpdate.downloadUpdate({
-    url: downloadUrl
+async function downloadAndInstall(version: string) {
+  // Download a specific version
+  const download = await NativeUpdate.download({
+    version: version
   });
   
-  // Monitor download progress
-  NativeUpdate.addListener('downloadProgress', (progress) => {
-    console.log(`Download progress: ${progress.percent}%`);
-  });
-  
-  // Install the update
-  await NativeUpdate.installUpdate({
-    bundleId: download.bundleId
+  // Set the downloaded bundle as active
+  await NativeUpdate.set({
+    version: download.version,
+    checksum: download.checksum
   });
   
   // Reload the app with new bundle
-  await NativeUpdate.reloadApp();
+  await NativeUpdate.reload();
 }
 ```
 
@@ -58,7 +55,7 @@ async function downloadAndInstall(downloadUrl: string) {
 ```typescript
 // Check if a native app update is available
 async function checkAppStoreUpdate() {
-  const result = await NativeUpdate.checkAppUpdate();
+  const result = await NativeUpdate.getAppUpdateInfo();
   
   if (result.updateAvailable) {
     // Show update prompt to user
@@ -147,12 +144,11 @@ await NativeUpdate.configure({
 // Comprehensive error handling
 async function safeUpdateCheck() {
   try {
-    const result = await NativeUpdate.checkForUpdate({
-      updateUrl: 'https://your-update-server.com/api/check',
-      currentVersion: '1.0.0'
+    const result = await NativeUpdate.sync({
+      updateUrl: 'https://your-update-server.com/api/check'
     });
     
-    if (result.updateAvailable) {
+    if (result.status === 'UPDATE_AVAILABLE' || result.status === 'UPDATE_INSTALLED') {
       await handleUpdate(result);
     }
   } catch (error) {
@@ -172,21 +168,26 @@ async function safeUpdateCheck() {
 ```typescript
 // Set up event listeners
 function setupUpdateListeners() {
-  // Download progress
-  NativeUpdate.addListener('downloadProgress', (event) => {
-    updateProgressBar(event.percent);
+  // Update state changes
+  NativeUpdate.addListener('updateStateChanged', (event) => {
+    console.log('Update state:', event.status);
+    if (event.status === 'READY') {
+      // Update has been applied successfully
+      console.log('Update ready to use');
+    }
   });
   
-  // Update installed
-  NativeUpdate.addListener('updateInstalled', (event) => {
-    console.log(`Update ${event.version} installed successfully`);
+  // Download progress
+  NativeUpdate.addListener('downloadProgress', (progress) => {
+    console.log(`Download progress: ${progress.percent}%`);
+    console.log(`Speed: ${progress.bytesPerSecond} bytes/s`);
   });
   
-  // Update failed
-  NativeUpdate.addListener('updateFailed', (event) => {
-    console.error(`Update failed: ${event.error}`);
-    // Optionally rollback
-    NativeUpdate.rollback();
+  // Background update notifications
+  NativeUpdate.addListener('backgroundUpdateNotification', (event) => {
+    if (event.updateAvailable) {
+      console.log(`Background update available: ${event.version}`);
+    }
   });
 }
 
@@ -199,5 +200,6 @@ function cleanup() {
 ## Next Steps
 
 - See [Advanced Scenarios](./advanced-scenarios.md) for more complex use cases
-- Check [Integration Examples](./integration-examples.md) for framework-specific implementations
-- Read the [API Reference](../api/README.md) for complete method documentation
+- Read the [Live Update API Reference](../api/live-update-api.md) for complete live update methods
+- Read the [App Update API Reference](../api/app-update-api.md) for native update methods
+- Read the [App Review API Reference](../api/app-review-api.md) for review request methods

package/docs/guides/migration-from-codepush.md

@@ -73,11 +73,10 @@ codePush.sync({
 });
 
 // New (Capacitor Native Update)
-const update = await NativeUpdate.checkForUpdate();
-if (update.available) {
-  await NativeUpdate.downloadUpdate();
-  await NativeUpdate.applyUpdate();
-}
+const result = await NativeUpdate.sync({
+  installMode: 'IMMEDIATE'
+});
+// Sync handles check, download, and apply automatically
 ```
 
 ### 5. Bundle Creation
@@ -98,11 +97,11 @@ node tools/bundle-signer.js sign bundle.zip private-key.pem
 
 | CodePush Feature | Capacitor Native Update |
 |-----------------|------------------------|
-| sync() | checkForUpdate() + downloadUpdate() + applyUpdate() |
-| getUpdateMetadata() | getCurrentVersion() |
-| notifyAppReady() | confirmUpdate() |
-| restartApp() | applyUpdate() |
-| clearUpdates() | rollback() |
+| sync() | sync() |
+| getUpdateMetadata() | current() |
+| notifyAppReady() | notifyAppReady() |
+| restartApp() | reload() |
+| clearUpdates() | reset() |
 
 ## Migration Checklist
 

package/docs/guides/testing-guide.md

@@ -55,12 +55,11 @@ src/__tests__/
 3. **Test Update Flow**
    ```typescript
    // Check for updates
-   const update = await NativeUpdate.checkForUpdate();
+   const update = await NativeUpdate.sync();
    
-   // Download if available
-   if (update.available) {
-     await NativeUpdate.downloadUpdate();
-     await NativeUpdate.applyUpdate();
+   // Update will be downloaded and applied based on sync result
+   if (update.status === 'UPDATE_INSTALLED') {
+     await NativeUpdate.reload();
    }
    ```
 
@@ -124,10 +123,11 @@ try {
 node tools/bundle-signer.js sign test-bundle.zip private-key.pem
 
 # Verify in app
-const isValid = await NativeUpdate.verifySignature(
-  bundleData,
-  signature
-);
+const isValid = await NativeUpdate.validateUpdate({
+  bundlePath: 'bundle-path',
+  checksum: 'bundle-checksum',
+  signature: signature
+});
 ```
 
 ### 4. Performance Testing
@@ -175,18 +175,16 @@ NativeUpdate.addListener('downloadProgress', (progress) => {
        publicKey: 'your-public-key',
      });
      
-     // Check
-     const update = await NativeUpdate.checkForUpdate();
-     if (!update.available) return;
-     
-     // Download with progress
-     await NativeUpdate.downloadUpdate();
+     // Sync will check, download and apply update
+     const result = await NativeUpdate.sync();
      
-     // Apply
-     await NativeUpdate.applyUpdate();
+     if (result.status === 'UPDATE_INSTALLED') {
+       // Reload to apply update
+       await NativeUpdate.reload();
+     }
      
      // Verify
-     const current = await NativeUpdate.getCurrentVersion();
+     const current = await NativeUpdate.current();
      console.log('Updated to:', current.version);
    }
    ```
@@ -196,7 +194,7 @@ NativeUpdate.addListener('downloadProgress', (progress) => {
 #### Network Failures
 ```typescript
 // Test offline behavior
-await NativeUpdate.checkForUpdate()
+await NativeUpdate.sync()
   .catch(error => {
     expect(error.code).toBe('NETWORK_ERROR');
   });
@@ -205,8 +203,9 @@ await NativeUpdate.checkForUpdate()
 #### Corrupted Bundles
 ```typescript
 // Test checksum validation
-const corruptedBundle = await fetch('corrupted-bundle.zip');
-await NativeUpdate.applyUpdate(corruptedBundle)
+await NativeUpdate.download({
+  version: 'corrupted-version'
+})
   .catch(error => {
     expect(error.code).toBe('CHECKSUM_ERROR');
   });
@@ -217,15 +216,15 @@ await NativeUpdate.applyUpdate(corruptedBundle)
 ```typescript
 // Test rollback mechanism
 async function testRollback() {
-  // Apply bad update
-  await NativeUpdate.applyUpdate(badUpdate);
+  // Set bad update
+  await NativeUpdate.set(badUpdate);
   
   // Simulate app crash
   await simulateCrash();
   
   // Verify rollback on restart
-  const version = await NativeUpdate.getCurrentVersion();
-  expect(version).toBe(previousVersion);
+  const version = await NativeUpdate.current();
+  expect(version.version).toBe(previousVersion);
 }
 ```
 
@@ -269,8 +268,8 @@ jobs:
   - [ ] Invalid configs rejected
   - [ ] Channel switching works
 
-- [ ] **Update Check**
-  - [ ] Returns correct update status
+- [ ] **Update Sync**
+  - [ ] Returns correct sync status
   - [ ] Respects version constraints
   - [ ] Handles network errors
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "native-update",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Foundation package for building a comprehensive update system for Capacitor apps. Provides architecture and interfaces but requires backend implementation.",
   "type": "module",
   "main": "dist/plugin.cjs.js",