native-update 1.0.3 → 1.0.5

package/docs/QUICK_START.md

@@ -70,26 +70,19 @@ import { NativeUpdate } from 'native-update';
 export class LiveUpdateService {
   async checkAndApplyUpdates() {
     try {
-      // 1. Check for updates
-      const { available, version } =
-        await NativeUpdate.checkForUpdate();
+      // 1. Sync with the update server
+      const result = await NativeUpdate.sync();
 
-      if (!available) {
+      if (result.status === 'UP_TO_DATE') {
         console.log('No updates available');
         return;
       }
 
-      console.log(`Update ${version} available!`);
-
-      // 2. Download the update
-      await NativeUpdate.downloadUpdate({
-        onProgress: (progress) => {
-          console.log(`Download: ${progress.percent}%`);
-        },
-      });
-
-      // 3. Apply the update (app will restart)
-      await NativeUpdate.applyUpdate();
+      if (result.status === 'UPDATE_INSTALLED') {
+        console.log(`Update ${result.bundle?.version} installed!`);
+        // Reload to apply the update
+        await NativeUpdate.reload();
+      }
     } catch (error) {
       console.error('Update failed:', error);
     }
@@ -107,42 +100,41 @@ export class UpdateUIService {
   ) {}
 
   async checkForUpdatesWithUI() {
-    const { available, version, notes } =
-      await NativeUpdate.checkForUpdate();
+    const result = await NativeUpdate.sync();
 
-    if (!available) return;
+    if (result.status === 'UP_TO_DATE') return;
 
-    // Show update dialog
-    const alert = await this.alertController.create({
-      header: 'Update Available',
-      message: `Version ${version} is ready!\n\n${notes || 'Bug fixes and improvements'}`,
-      buttons: [
-        { text: 'Later', role: 'cancel' },
-        {
-          text: 'Update Now',
-          handler: () => this.downloadAndInstall(),
-        },
-      ],
-    });
+    if (result.status === 'UPDATE_AVAILABLE') {
+      // Show update dialog
+      const alert = await this.alertController.create({
+        header: 'Update Available',
+        message: `Version ${result.bundle?.version} is ready!\n\nBug fixes and improvements`,
+        buttons: [
+          { text: 'Later', role: 'cancel' },
+          {
+            text: 'Update Now',
+            handler: () => this.applyUpdate(),
+          },
+        ],
+      });
 
-    await alert.present();
+      await alert.present();
+    } else if (result.status === 'UPDATE_INSTALLED') {
+      // Update already installed, just need to reload
+      await NativeUpdate.reload();
+    }
   }
 
-  private async downloadAndInstall() {
+  private async applyUpdate() {
     const loading = await this.loadingController.create({
-      message: 'Downloading update...',
+      message: 'Applying update...',
     });
     await loading.present();
 
     try {
-      await NativeUpdate.downloadUpdate({
-        onProgress: (progress) => {
-          loading.message = `Downloading: ${Math.round(progress.percent)}%`;
-        },
-      });
-
-      loading.message = 'Installing...';
-      await NativeUpdate.applyUpdate();
+      // The sync method already downloaded the update
+      // We just need to reload the app
+      await NativeUpdate.reload();
     } catch (error) {
       await loading.dismiss();
       // Show error
@@ -179,7 +171,7 @@ Check for app store updates and install them!
 export class NativeUpdateService {
   async checkForAppStoreUpdates() {
     try {
-      const result = await NativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.getAppUpdateInfo();
 
       if (!result.updateAvailable) {
         console.log('App is up to date');
@@ -200,7 +192,7 @@ export class NativeUpdateService {
   private async handleAndroidUpdate(result: any) {
     if (result.immediateUpdateAllowed) {
       // Critical update - must install
-      await NativeUpdate.startImmediateUpdate();
+      await NativeUpdate.performImmediateUpdate();
     } else {
       // Optional update - download in background
       await NativeUpdate.startFlexibleUpdate();
@@ -246,19 +238,21 @@ export class AndroidUpdateProgress {
     );
 
     // Handle completion
-    NativeUpdate.addListener('onAppUpdateDownloaded', async () => {
-      const alert = await this.alertController.create({
-        header: 'Update Ready',
-        message: 'Update has been downloaded. Install now?',
-        buttons: [
-          { text: 'Later' },
-          {
-            text: 'Install',
-            handler: () => NativeUpdate.completeFlexibleUpdate(),
-          },
-        ],
-      });
-      await alert.present();
+    NativeUpdate.addListener('updateStateChanged', async (event) => {
+      if (event.status === 'DOWNLOADED') {
+        const alert = await this.alertController.create({
+          header: 'Update Ready',
+          message: 'Update has been downloaded. Install now?',
+          buttons: [
+            { text: 'Later' },
+            {
+              text: 'Install',
+              handler: () => NativeUpdate.completeFlexibleUpdate(),
+            },
+          ],
+        });
+        await alert.present();
+      }
     });
   }
 }
@@ -422,12 +416,9 @@ export class AppComponent implements OnInit {
   // Live Updates
   private async checkLiveUpdates() {
     try {
-      const { available } = await NativeUpdate.checkForUpdate();
-
-      if (available) {
-        // Auto-download in background
-        await NativeUpdate.downloadUpdate();
+      const result = await NativeUpdate.sync();
 
+      if (result.status === 'UPDATE_INSTALLED') {
         // Notify user
         const toast = await this.toastCtrl.create({
           message: 'Update ready! Restart to apply.',
@@ -435,7 +426,7 @@ export class AppComponent implements OnInit {
           buttons: [
             {
               text: 'Restart',
-              handler: () => NativeUpdate.applyUpdate(),
+              handler: () => NativeUpdate.reload(),
             },
           ],
         });
@@ -462,7 +453,7 @@ export class AppComponent implements OnInit {
 
   private async checkNativeUpdates() {
     try {
-      const result = await NativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.getAppUpdateInfo();
 
       if (result.updateAvailable && result.flexibleUpdateAllowed) {
         // Start background download for Android
@@ -544,11 +535,10 @@ curl -X POST http://localhost:3000/api/v1/bundles \
 ### 3. Test App Reviews
 
 ```typescript
-// Enable debug mode
-await NativeUpdate.setReviewDebugMode({ enabled: true });
-
-// Force show review (debug only)
-await NativeUpdate.requestReview({ force: true });
+// Test review prompts
+// Note: Reviews may not show in development builds
+// Test with TestFlight (iOS) or Internal Test Track (Android)
+await NativeUpdate.requestReview();
 ```
 
 ## What's Next?
@@ -569,20 +559,19 @@ Now that you have the basics working:
    - [Live Updates Guide](./LIVE_UPDATES_GUIDE.md) - Complete OTA implementation
    - [Native Updates Guide](./NATIVE_UPDATES_GUIDE.md) - Platform-specific details
    - [App Review Guide](./APP_REVIEW_GUIDE.md) - Maximize review rates
-   - [Security Guide](./SECURITY.md) - Best practices
-   - [API Reference](../API.md) - All methods and options
+   - [Security Guide](./guides/security-best-practices.md) - Best practices
+   - [API Reference](./api/live-update-api.md) - All methods and options
 
 ## Troubleshooting
 
 ### Live Updates Not Working?
 
 ```typescript
-// Enable debug logging
-await NativeUpdate.setDebugMode({ enabled: true });
+// Enable debug logging in your app
+console.log('Checking update configuration...');
 
-// Check configuration
-const config = await NativeUpdate.getConfiguration();
-console.log('Update URL:', config.updateUrl);
+// Configuration is set in capacitor.config.json
+// Check your config file for updateUrl and other settings
 ```
 
 ### Native Updates Not Detected?

package/docs/README.md

@@ -7,7 +7,6 @@
 > - Bundle storage and CDN
 > - Signing and security services
 > 
-> See [ROADMAP.md](../ROADMAP.md) for complete requirements.
 
 Welcome to the comprehensive documentation for **Capacitor Native Update**, a foundation plugin that provides architecture for a complete update lifecycle management solution for Capacitor applications.
 
@@ -34,8 +33,9 @@ Created by **Ahsan Mahmood** and open-sourced for the developer community, this
 ### Guides
 
 - [**Security Best Practices**](./guides/security-best-practices.md) - Implement secure updates
-- [**Migration Guide**](./guides/migration-guide.md) - Migrate from other update solutions
-- [**Troubleshooting**](./guides/troubleshooting.md) - Common issues and solutions
+- [**Migration from CodePush**](./guides/migration-from-codepush.md) - Migrate from CodePush
+- [**Testing Guide**](./guides/testing-guide.md) - Testing your update implementation
+- [**Deployment Guide**](./guides/deployment-guide.md) - Deploy to production
 
 ### API Reference
 
@@ -47,8 +47,7 @@ Created by **Ahsan Mahmood** and open-sourced for the developer community, this
 ### Examples
 
 - [**Basic Usage**](./examples/basic-usage.md) - Simple implementation examples
-- [**Advanced Scenarios**](./examples/advanced-scenarios.md) - Complex use cases
-- [**Integration Examples**](./examples/integration-examples.md) - Framework-specific integrations
+- [**Advanced Scenarios**](./examples/advanced-scenarios.md) - Complex use cases and framework integrations
 
 ### Production
 

package/docs/api/app-review-api.md

@@ -92,27 +92,7 @@ await NativeUpdate.trackSignificantEvent(eventName: string);
 
 ## Events
 
-### reviewPromptDisplayed
-
-Fired when review prompt is shown.
-
-```typescript
-NativeUpdate.addListener('reviewPromptDisplayed', (event) => {
-  console.log('Review prompt shown on:', event.platform);
-  analytics.track('review_prompt_displayed');
-});
-```
-
-### reviewPromptDismissed
-
-Fired when review prompt is dismissed.
-
-```typescript
-NativeUpdate.addListener('reviewPromptDismissed', (event) => {
-  console.log('Review prompt dismissed');
-  analytics.track('review_prompt_dismissed');
-});
-```
+Note: App review events are handled natively by the platform's review system. The plugin does not expose custom events for review prompts as these are controlled by iOS StoreKit and Android Play Core.
 
 ## Platform Implementation
 

package/docs/api/app-update-api.md

@@ -4,12 +4,12 @@ Complete API documentation for native app store update functionality.
 
 ## Methods
 
-### checkAppUpdate()
+### getAppUpdateInfo()
 
-Check if a native app update is available in the app store.
+Get information about available app updates in the app store.
 
 ```typescript
-const result = await NativeUpdate.checkAppUpdate();
+const result = await NativeUpdate.getAppUpdateInfo();
 // Returns:
 {
   updateAvailable: boolean;
@@ -29,13 +29,13 @@ const result = await NativeUpdate.checkAppUpdate();
 }
 ```
 
-### startImmediateUpdate()
+### performImmediateUpdate()
 
-Start an immediate (blocking) update. Android only - shows full-screen update UI.
+Perform an immediate (blocking) update. Android only - shows full-screen update UI.
 
 ```typescript
 try {
-  await NativeUpdate.startImmediateUpdate();
+  await NativeUpdate.performImmediateUpdate();
   // App will restart after update
 } catch (error) {
   // User cancelled or update failed
@@ -60,105 +60,20 @@ await NativeUpdate.completeFlexibleUpdate();
 // App will restart
 ```
 
-### getVersionInfo()
-
-Get detailed version information.
-
-```typescript
-const info = await NativeUpdate.getVersionInfo();
-// Returns:
-{
-  currentVersion: string;      // e.g., "1.2.3"
-  buildNumber: string;         // e.g., "123"
-  packageName: string;         // e.g., "com.example.app"
-  platform: 'ios' | 'android' | 'web';
-  availableVersion?: string;   // From app store
-  minimumVersion?: string;     // Minimum required version
-}
-```
-
-### isMinimumVersionMet()
-
-Check if the app meets minimum version requirements.
-
-```typescript
-const result = await NativeUpdate.isMinimumVersionMet();
-// Returns:
-{
-  isMet: boolean;
-  currentVersion: string;
-  minimumVersion: string;
-  updateRequired: boolean;
-}
-```
-
 ### openAppStore()
 
 Open the app store page for updates.
 
 ```typescript
-await NativeUpdate.openAppStore();
-```
-
-### getAppStoreUrl()
-
-Get the app store URL without opening it.
-
-```typescript
-const result = await NativeUpdate.getAppStoreUrl();
-// Returns:
-{
-  url: string;  // e.g., "https://apps.apple.com/app/id123456789"
-  platform: 'ios' | 'android' | 'web';
-}
-```
-
-### getUpdateInstallState()
-
-Get the current install state of a flexible update. Android only.
-
-```typescript
-const state = await NativeUpdate.getUpdateInstallState();
-// Returns:
-{
-  installStatus: number;    // Android InstallStatus code
-  bytesDownloaded: number;
-  totalBytesToDownload: number;
-  percentComplete: number;
-}
-```
-
-## Events
-
-### appUpdateStateChanged
-
-Fired when app update state changes. Android only.
-
-```typescript
-NativeUpdate.addListener('appUpdateStateChanged', (state) => {
-  console.log('Install status:', state.installStatus);
-  // InstallStatus codes:
-  // 0: Unknown
-  // 1: Pending
-  // 2: Downloading
-  // 3: Installing
-  // 4: Installed
-  // 5: Failed
-  // 6: Canceled
-  // 11: Downloaded
+await NativeUpdate.openAppStore({
+  // Optional: specify app ID for iOS or package name for Android
+  appId: 'your-app-id'
 });
 ```
 
-### appUpdateProgress
+## Events
 
-Fired during flexible update download. Android only.
-
-```typescript
-NativeUpdate.addListener('appUpdateProgress', (progress) => {
-  console.log(`Downloaded: ${progress.bytesDownloaded}/${progress.totalBytesToDownload}`);
-  console.log(`Progress: ${progress.percentComplete}%`);
-});
-```
+Note: App update events are not directly exposed. Instead, use the `updateStateChanged` and `downloadProgress` events from the Live Update API when performing app updates. The native update process on Android and iOS is handled by the platform's native update mechanisms.
 
 ## Platform Differences
 
@@ -200,9 +115,9 @@ NativeUpdate.addListener('appUpdateProgress', (progress) => {
 1. **Check for updates on app start**
    ```typescript
    async function checkOnStart() {
-     const result = await NativeUpdate.checkAppUpdate();
+     const result = await NativeUpdate.getAppUpdateInfo();
      if (result.updateAvailable && result.updatePriority === 'IMMEDIATE') {
-       await NativeUpdate.startImmediateUpdate();
+       await NativeUpdate.performImmediateUpdate();
      }
    }
    ```
@@ -212,23 +127,16 @@ NativeUpdate.addListener('appUpdateProgress', (progress) => {
    // Start download
    await NativeUpdate.startFlexibleUpdate();
    
-   // Monitor progress
-   const listener = NativeUpdate.addListener('appUpdateProgress', (progress) => {
-     updateProgressBar(progress.percentComplete);
-   });
-   
-   // Complete when ready
-   const stateListener = NativeUpdate.addListener('appUpdateStateChanged', (state) => {
-     if (state.installStatus === 11) { // Downloaded
-       showUpdateReadyPrompt();
-     }
-   });
+   // Note: Progress monitoring for native app updates is handled
+   // internally by the platform. For Android, the Play Core library
+   // shows its own UI. For custom progress tracking, use Live Updates
+   // instead of native app updates.
    ```
 
 3. **Fallback for iOS**
    ```typescript
    if (platform === 'ios') {
-     const result = await NativeUpdate.checkAppUpdate();
+     const result = await NativeUpdate.getAppUpdateInfo();
      if (result.updateAvailable) {
        showUpdateDialog(() => {
          NativeUpdate.openAppStore();