native-update 1.0.3 → 1.0.4

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)
+- Check the [API Reference](./api/app-review-api.md)
 - See [Example Implementation](../example/src/services/review.service.ts)

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);
@@ -169,7 +169,7 @@ export class UpdateService {
   async checkForUpdates(silent = false) {
     try {
       const { available, version, mandatory, notes } =
-        await NativeUpdate.checkForUpdate();
+        await NativeUpdate.sync();
 
       if (!available) {
         if (!silent) {
@@ -220,7 +220,7 @@ export class UpdateService {
 
     try {
       // Download with progress
-      await NativeUpdate.downloadUpdate({
+      await NativeUpdate.download({
         onProgress: (progress) => {
           loading.message = `Downloading... ${Math.round(progress.percent)}%`;
         },
@@ -229,7 +229,7 @@ export class UpdateService {
       loading.message = 'Applying update...';
 
       // Apply the update
-      await NativeUpdate.applyUpdate();
+      await NativeUpdate.reload();
 
       // The app will restart automatically
     } catch (error) {
@@ -291,18 +291,18 @@ export class AppComponent implements OnInit {
 export class UpdateStrategies {
   // Immediate update (default)
   async immediateUpdate() {
-    const { available } = await NativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.sync();
     if (available) {
-      await NativeUpdate.downloadUpdate();
-      await NativeUpdate.applyUpdate(); // Restarts immediately
+      await NativeUpdate.download();
+      await NativeUpdate.reload(); // Restarts immediately
     }
   }
 
   // Update on next restart
   async updateOnRestart() {
-    const { available } = await NativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.sync();
     if (available) {
-      await NativeUpdate.downloadUpdate();
+      await NativeUpdate.download();
       await NativeUpdate.applyUpdate({
         reloadStrategy: 'on-next-restart',
       });
@@ -312,14 +312,14 @@ export class UpdateStrategies {
 
   // Update with confirmation
   async updateWithConfirmation() {
-    const { available } = await NativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.sync();
     if (available) {
-      await NativeUpdate.downloadUpdate();
+      await NativeUpdate.download();
 
       // Show confirmation dialog
       const confirmed = await this.showUpdateReadyDialog();
       if (confirmed) {
-        await NativeUpdate.applyUpdate();
+        await NativeUpdate.reload();
       }
     }
   }
@@ -444,7 +444,7 @@ const { versions } = await NativeUpdate.getVersions();
 
 // Rollback to previous version
 if (versions.length > 1) {
-  await NativeUpdate.rollback();
+  await NativeUpdate.reset();
 }
 
 // Rollback to specific version
@@ -482,7 +482,7 @@ await NativeUpdate.configure({
 class CustomUpdateUI {
   async showUpdateFlow() {
     // Custom check
-    const update = await NativeUpdate.checkForUpdate();
+    const update = await NativeUpdate.sync();
 
     if (update.available) {
       // Show custom UI
@@ -519,7 +519,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,7 +561,7 @@ await NativeUpdate.setChannel({
 // Download during off-peak hours
 const now = new Date().getHours();
 if (now >= 2 && now <= 6) {
-  await NativeUpdate.downloadUpdate({
+  await NativeUpdate.download({
     priority: 'low',
   });
 }
@@ -646,5 +646,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

@@ -188,5 +188,5 @@ await NativeUpdate.configure(config);
 ### Getting Help
 
 - Check our [example app](../example) for implementation patterns
-- Review the [API documentation](../API.md)
+- 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
@@ -261,7 +261,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 +314,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');
@@ -534,7 +534,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,7 +643,7 @@ const state = await NativeUpdate.getUpdateState();
 if (state.status === 'FAILED') {
   // Clear update data and retry
   await NativeUpdate.clearUpdateData();
-  await NativeUpdate.checkAppUpdate();
+  await NativeUpdate.getAppUpdateInfo();
 }
 ```
 
@@ -690,5 +690,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)

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();
@@ -422,12 +414,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 +424,7 @@ export class AppComponent implements OnInit {
           buttons: [
             {
               text: 'Restart',
-              handler: () => NativeUpdate.applyUpdate(),
+              handler: () => NativeUpdate.reload(),
             },
           ],
         });
@@ -462,7 +451,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
@@ -569,8 +558,8 @@ 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
 

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-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();