native-update 1.0.3 → 1.0.5

package/docs/APP_REVIEW_GUIDE.md

@@ -764,5 +764,5 @@ Key takeaways for implementing app reviews:
 ## Next Steps
 
 - Review the [Quick Start Guide](./QUICK_START.md)
-- Check the [API Reference](../API.md)
-- See [Example Implementation](../example/src/services/review.service.ts)
+- Check the [API Reference](./api/app-review-api.md)
+- See example implementation in the `/example` directory

package/docs/BUNDLE_SIGNING.md

@@ -240,12 +240,18 @@ Response: {
 ### Plugin Methods
 
 ```typescript
-// Manual verification (advanced use)
-const isValid = await NativeUpdate.verifySignature({
+// Signature verification is handled automatically during sync/download
+// Use validateUpdate for manual verification
+const result = await NativeUpdate.LiveUpdate.validateUpdate({
   bundlePath: '/path/to/bundle.zip',
-  signature: 'base64-signature',
-  publicKey: 'base64-public-key', // Optional, uses config if not provided
+  checksum: 'expected-sha256-checksum',
+  signature: 'base64-signature' // Optional
 });
+
+console.log('Validation result:', result.isValid);
+if (!result.isValid) {
+  console.log('Validation details:', result.details);
+}
 ```
 
 ## Compliance

package/docs/LIVE_UPDATES_GUIDE.md

@@ -127,25 +127,25 @@ import { NativeUpdate } from 'native-update';
 export class UpdateManager {
   async checkAndUpdate() {
     try {
-      // Check for updates
-      const { available, version } =
-        await NativeUpdate.checkForUpdate();
-
-      if (available) {
-        console.log(`Update available: ${version}`);
-
-        // Download the update
-        const { success } = await NativeUpdate.downloadUpdate({
-          onProgress: (progress) => {
-            console.log(`Download progress: ${progress.percent}%`);
-          },
-        });
-
-        if (success) {
-          // Apply the update
-          await NativeUpdate.applyUpdate();
-          // App will restart automatically
-        }
+      // Sync with the update server
+      const result = await NativeUpdate.sync();
+
+      switch (result.status) {
+        case 'UPDATE_AVAILABLE':
+          console.log(`Update available: ${result.bundle?.version}`);
+          // Update will be downloaded automatically by sync
+          break;
+        case 'UPDATE_INSTALLED':
+          console.log(`Update installed: ${result.bundle?.version}`);
+          // Reload the app to apply the update
+          await NativeUpdate.reload();
+          break;
+        case 'UP_TO_DATE':
+          console.log('App is up to date');
+          break;
+        case 'ERROR':
+          console.error('Update error:', result.error);
+          break;
       }
     } catch (error) {
       console.error('Update failed:', error);
@@ -168,41 +168,41 @@ export class UpdateService {
 
   async checkForUpdates(silent = false) {
     try {
-      const { available, version, mandatory, notes } =
-        await NativeUpdate.checkForUpdate();
+      const result = await NativeUpdate.sync();
 
-      if (!available) {
+      if (result.status === 'UP_TO_DATE') {
         if (!silent) {
           await this.showAlert('No Updates', 'Your app is up to date!');
         }
         return;
       }
 
-      // Show update dialog
-      const alert = await this.alertCtrl.create({
-        header: 'Update Available',
-        message: `Version ${version} is available.\n\n${notes || 'Bug fixes and improvements'}`,
-        buttons: [
-          {
-            text: mandatory ? 'Update Now' : 'Later',
-            role: 'cancel',
-            handler: () => {
-              if (mandatory) {
-                // Force update for mandatory updates
-                this.downloadAndApplyUpdate();
-                return false;
-              }
+      if (result.status === 'UPDATE_AVAILABLE' || result.status === 'UPDATE_INSTALLED') {
+        // Show update dialog
+        const alert = await this.alertCtrl.create({
+          header: 'Update Available',
+          message: `Version ${result.version} is available.\n\n${result.description || 'Bug fixes and improvements'}`,
+          buttons: [
+            {
+              text: result.mandatory ? 'Update Now' : 'Later',
+              role: 'cancel',
+              handler: () => {
+                if (result.mandatory) {
+                  // Force update for mandatory updates
+                  this.downloadAndApplyUpdate();
+                  return false;
+                }
+              },
             },
-          },
-          {
-            text: 'Update',
-            handler: () => {
-              this.downloadAndApplyUpdate();
+            {
+              text: 'Update',
+              handler: () => {
+                this.downloadAndApplyUpdate();
+              },
             },
-          },
-        ],
-        backdropDismiss: !mandatory,
-      });
+          ],
+          backdropDismiss: !result.mandatory,
+        });
 
       await alert.present();
     } catch (error) {
@@ -220,16 +220,19 @@ export class UpdateService {
 
     try {
       // Download with progress
-      await NativeUpdate.downloadUpdate({
-        onProgress: (progress) => {
+      // The sync method already handles downloading
+      // Progress tracking would be done via event listeners
+      const downloadListener = NativeUpdate.addListener(
+        'downloadProgress',
+        (progress) => {
           loading.message = `Downloading... ${Math.round(progress.percent)}%`;
-        },
-      });
+        }
+      );
 
       loading.message = 'Applying update...';
 
       // Apply the update
-      await NativeUpdate.applyUpdate();
+      await NativeUpdate.reload();
 
       // The app will restart automatically
     } catch (error) {
@@ -291,35 +294,29 @@ export class AppComponent implements OnInit {
 export class UpdateStrategies {
   // Immediate update (default)
   async immediateUpdate() {
-    const { available } = await NativeUpdate.checkForUpdate();
-    if (available) {
-      await NativeUpdate.downloadUpdate();
-      await NativeUpdate.applyUpdate(); // Restarts immediately
+    const result = await NativeUpdate.sync();
+    if (result.status === 'UPDATE_INSTALLED') {
+      await NativeUpdate.reload(); // Restarts immediately
     }
   }
 
   // Update on next restart
   async updateOnRestart() {
-    const { available } = await NativeUpdate.checkForUpdate();
-    if (available) {
-      await NativeUpdate.downloadUpdate();
-      await NativeUpdate.applyUpdate({
-        reloadStrategy: 'on-next-restart',
-      });
-      // Update will be applied next time app starts
+    const result = await NativeUpdate.sync();
+    if (result.status === 'UPDATE_INSTALLED') {
+      // Update is already installed, just don't reload immediately
+      // Update will be applied on next app restart
     }
   }
 
   // Update with confirmation
   async updateWithConfirmation() {
-    const { available } = await NativeUpdate.checkForUpdate();
-    if (available) {
-      await NativeUpdate.downloadUpdate();
-
+    const result = await NativeUpdate.sync();
+    if (result.status === 'UPDATE_INSTALLED') {
       // Show confirmation dialog
       const confirmed = await this.showUpdateReadyDialog();
       if (confirmed) {
-        await NativeUpdate.applyUpdate();
+        await NativeUpdate.reload();
       }
     }
   }
@@ -429,45 +426,51 @@ await NativeUpdate.setChannel({ channel: 'beta' });
 ### 2. Delta Updates
 
 ```typescript
-// Enable delta updates to reduce download size
-await NativeUpdate.configureDeltaUpdates({
-  enabled: true,
-  threshold: 0.3, // Use delta if size < 30% of full bundle
-});
+// Delta updates would be handled server-side
+// The sync() method will automatically use delta updates if available
+// Configure your server to provide delta updates when appropriate
 ```
 
 ### 3. Rollback Support
 
 ```typescript
-// List available versions
-const { versions } = await NativeUpdate.getVersions();
+// List all downloaded bundles
+const bundles = await NativeUpdate.list();
 
-// Rollback to previous version
-if (versions.length > 1) {
-  await NativeUpdate.rollback();
-}
+// Rollback to original app bundle
+await NativeUpdate.reset();
 
-// Rollback to specific version
-await NativeUpdate.switchVersion({
-  version: '1.0.0',
-});
+// Rollback to a specific bundle
+if (bundles.length > 1) {
+  const previousBundle = bundles[bundles.length - 2];
+  await NativeUpdate.set(previousBundle);
+  await NativeUpdate.reload();
+}
 ```
 
 ### 4. Update Metrics
 
 ```typescript
-// Track update success
-await NativeUpdate.reportUpdateSuccess({
-  version: '1.0.1',
-  duration: 5000,
-});
+// Implement your own metrics tracking
+class UpdateMetrics {
+  async trackSuccess(version: string, duration: number) {
+    // Send to your analytics service
+    await analytics.track('update_success', {
+      version,
+      duration,
+      timestamp: Date.now()
+    });
+  }
 
-// Track update failure
-await NativeUpdate.reportUpdateFailure({
-  version: '1.0.1',
-  error: 'DOWNLOAD_FAILED',
-  details: 'Network timeout',
-});
+  async trackFailure(version: string, error: string) {
+    // Send to your analytics service
+    await analytics.track('update_failure', {
+      version,
+      error,
+      timestamp: Date.now()
+    });
+  }
+}
 ```
 
 ### 5. Custom Update UI
@@ -482,9 +485,9 @@ await NativeUpdate.configure({
 class CustomUpdateUI {
   async showUpdateFlow() {
     // Custom check
-    const update = await NativeUpdate.checkForUpdate();
+    const update = await NativeUpdate.sync();
 
-    if (update.available) {
+    if (update.status === 'UPDATE_AVAILABLE' || update.status === 'UPDATE_INSTALLED') {
       // Show custom UI
       const modal = await this.modalCtrl.create({
         component: UpdateModalComponent,
@@ -519,7 +522,7 @@ const skipVersions = ['1.0.2', '1.0.3']; // Known bad versions
 class RobustUpdateManager {
   async safeUpdate() {
     try {
-      await NativeUpdate.checkForUpdate();
+      await NativeUpdate.sync();
     } catch (error) {
       if (error.code === 'NETWORK_ERROR') {
         // Retry with exponential backoff
@@ -561,15 +564,13 @@ await NativeUpdate.setChannel({
 // Download during off-peak hours
 const now = new Date().getHours();
 if (now >= 2 && now <= 6) {
-  await NativeUpdate.downloadUpdate({
-    priority: 'low',
-  });
+  // Download priority would be configured during sync
+  await NativeUpdate.sync();
 }
 
-// Pause/resume downloads
-const downloadId = await NativeUpdate.startDownload();
-await NativeUpdate.pauseDownload({ id: downloadId });
-await NativeUpdate.resumeDownload({ id: downloadId });
+// Download management would be handled by the sync() method
+// For custom download control, implement your own download manager
+// that uses the download() method with proper retry logic
 ```
 
 ## Troubleshooting
@@ -579,42 +580,56 @@ await NativeUpdate.resumeDownload({ id: downloadId });
 1. **Update not applying**
 
    ```typescript
-   // Check if update was downloaded
-   const { ready } = await NativeUpdate.isUpdateReady();
-   if (ready) {
-     // Force apply
-     await NativeUpdate.applyUpdate({ force: true });
+   // Check current bundle status
+   const current = await NativeUpdate.current();
+   console.log('Current bundle:', current);
+   
+   // List all bundles to see if update was downloaded
+   const bundles = await NativeUpdate.list();
+   console.log('Available bundles:', bundles);
+   
+   // If update bundle exists but not active, set it
+   const updateBundle = bundles.find(b => b.version === 'new-version');
+   if (updateBundle && updateBundle.bundleId !== current.bundleId) {
+     await NativeUpdate.set(updateBundle);
+     await NativeUpdate.reload();
    }
    ```
 
 2. **Signature verification fails**
 
    ```typescript
-   // Verify public key configuration
-   const config = await NativeUpdate.getConfiguration();
-   console.log('Public key:', config.publicKey);
+   // Check current configuration by examining the plugin setup
+   // Configuration is set during plugin initialization
+   console.log('Verify your capacitor.config.json for publicKey setting');
    ```
 
 3. **Storage issues**
    ```typescript
-   // Clear old versions
-   await NativeUpdate.cleanup({
-     keepVersions: 1,
+   // Delete old bundles, keeping only the latest N versions
+   await NativeUpdate.delete({
+     keepVersions: 2  // Keep only 2 most recent versions
+   });
+   
+   // Or delete bundles older than a certain date
+   const thirtyDaysAgo = Date.now() - (30 * 24 * 60 * 60 * 1000);
+   await NativeUpdate.delete({
+     olderThan: thirtyDaysAgo
    });
    ```
 
 ### Debug Mode
 
 ```typescript
-// Enable debug logging
-await NativeUpdate.setDebugMode({ enabled: true });
+// Enable debug logging through your app's logging system
+// The plugin will log errors and important events automatically
 
 // Monitor update events
-NativeUpdate.addListener('updateDownloadProgress', (progress) => {
+NativeUpdate.addListener('downloadProgress', (progress) => {
   console.log('Download progress:', progress);
 });
 
-NativeUpdate.addListener('updateStateChange', (state) => {
+NativeUpdate.addListener('updateStateChanged', (state) => {
   console.log('Update state:', state);
 });
 ```
@@ -622,15 +637,25 @@ NativeUpdate.addListener('updateStateChange', (state) => {
 ### Health Checks
 
 ```typescript
-// Verify update system health
-const health = await NativeUpdate.getHealth();
-console.log('Update system health:', {
-  enabled: health.enabled,
-  lastCheck: health.lastCheck,
-  lastUpdate: health.lastUpdate,
-  currentVersion: health.currentVersion,
-  availableSpace: health.availableSpace,
-});
+// Implement your own health check system
+class UpdateHealthCheck {
+  async checkHealth() {
+    const current = await NativeUpdate.current();
+    const bundles = await NativeUpdate.list();
+    
+    const health = {
+      currentVersion: current.version,
+      currentBundleId: current.bundleId,
+      bundleStatus: current.status,
+      totalBundles: bundles.length,
+      lastUpdateTime: current.downloadTime,
+      isVerified: current.verified
+    };
+    
+    console.log('Update system health:', health);
+    return health;
+  }
+}
 ```
 
 ## Security Considerations
@@ -646,5 +671,5 @@ console.log('Update system health:', {
 
 - Read the [Native App Updates Guide](./NATIVE_UPDATES_GUIDE.md)
 - Learn about [App Review Integration](./APP_REVIEW_GUIDE.md)
-- Check out [Security Best Practices](./SECURITY.md)
+- Check out [Security Best Practices](./guides/security-best-practices.md)
 - See [Bundle Signing Documentation](./BUNDLE_SIGNING.md)

package/docs/MIGRATION.md

@@ -187,6 +187,6 @@ await NativeUpdate.configure(config);
 
 ### Getting Help
 
-- Check our [example app](../example) for implementation patterns
-- Review the [API documentation](../API.md)
+- Check our example app in the `/example` directory for implementation patterns
+- Review the [API documentation](./api/live-update-api.md)
 - File issues on GitHub for migration problems

package/docs/NATIVE_UPDATES_GUIDE.md

@@ -113,7 +113,7 @@ export class NativeUpdateService {
       const platform = Capacitor.getPlatform();
 
       // Check for native app updates
-      const result = await NativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.getAppUpdateInfo();
 
       if (result.updateAvailable) {
         console.log(`Update available: ${result.availableVersion}`);
@@ -144,7 +144,7 @@ export class AndroidImmediateUpdate {
   async performImmediateUpdate() {
     try {
       // Start immediate update
-      const { started } = await NativeUpdate.startImmediateUpdate();
+      const { started } = await NativeUpdate.performImmediateUpdate();
 
       if (started) {
         // The app will be restarted automatically after update
@@ -201,10 +201,12 @@ export class AndroidFlexibleUpdate {
       );
 
       // Listen for download completion
-      NativeUpdate.addListener('onAppUpdateDownloaded', () => {
-        console.log('Update downloaded');
-        this.updateDownloaded = true;
-        this.showInstallPrompt();
+      NativeUpdate.addListener('updateStateChanged', (event) => {
+        if (event.status === 'DOWNLOADED') {
+          console.log('Update downloaded');
+          this.updateDownloaded = true;
+          this.showInstallPrompt();
+        }
       });
     } catch (error) {
       console.error('Flexible update failed:', error);
@@ -261,7 +263,7 @@ export class AndroidFlexibleUpdate {
 export class iOSAppStoreUpdate {
   async checkAndPromptUpdate() {
     try {
-      const result = await NativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.getAppUpdateInfo();
 
       if (result.updateAvailable) {
         await this.showiOSUpdateDialog(result);
@@ -314,7 +316,7 @@ export class UnifiedUpdateService {
 
   async checkAndUpdateApp() {
     try {
-      const updateInfo = await NativeUpdate.checkAppUpdate();
+      const updateInfo = await NativeUpdate.getAppUpdateInfo();
 
       if (!updateInfo.updateAvailable) {
         console.log('App is up to date');
@@ -411,7 +413,7 @@ export class UpdateStatusManager {
 
   private setupUpdateListeners() {
     // Installation status
-    NativeUpdate.addListener('onAppUpdateInstallStatus', (status) => {
+    NativeUpdate.addListener('updateStateChanged', (status) => {
       switch (status.status) {
         case 'PENDING':
           console.log('Update pending');
@@ -534,7 +536,7 @@ export class UpdateUIService {
 ```typescript
 export class SmartUpdateScheduler {
   async scheduleUpdate() {
-    const updateInfo = await NativeUpdate.checkAppUpdate();
+    const updateInfo = await NativeUpdate.getAppUpdateInfo();
 
     if (!updateInfo.updateAvailable) return;
 
@@ -643,16 +645,15 @@ const state = await NativeUpdate.getUpdateState();
 if (state.status === 'FAILED') {
   // Clear update data and retry
   await NativeUpdate.clearUpdateData();
-  await NativeUpdate.checkAppUpdate();
+  await NativeUpdate.getAppUpdateInfo();
 }
 ```
 
 #### 3. iOS App Store Not Opening
 
 ```typescript
-// Verify App Store ID configuration
-const config = await NativeUpdate.getConfiguration();
-console.log('App Store ID:', config.appStoreId);
+// App Store ID is configured in capacitor.config.json
+// Check your configuration file for the appStoreId setting
 
 // Manual fallback
 if (!config.appStoreId) {
@@ -690,5 +691,5 @@ if (!config.appStoreId) {
 
 - Learn about [Live Updates (OTA)](./LIVE_UPDATES_GUIDE.md)
 - Implement [App Review Features](./APP_REVIEW_GUIDE.md)
-- Review [Security Guidelines](./SECURITY.md)
-- Check [API Reference](../API.md)
+- Review [Security Guidelines](./guides/security-best-practices.md)
+- Check [API Reference](./api/app-update-api.md)