native-update 1.0.3 → 1.0.5

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,18 @@ async function checkForDeltaUpdate() {
 }
 
 async function downloadDeltaUpdate(deltaUrl: string) {
-  const download = await NativeUpdate.downloadUpdate({
-    url: deltaUrl,
-    isDelta: true
+  // Download requires url, version, and checksum parameters
+  const download = await NativeUpdate.download({
+    url: result.deltaUrl,
+    version: result.version,
+    checksum: result.checksum
   });
   
-  // 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 +63,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 +80,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,21 +103,22 @@ 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
   });
 }
 
 // Handle background update events
-NativeUpdate.addListener('backgroundUpdateReady', (event) => {
+NativeUpdate.addListener('backgroundUpdateNotification', (event) => {
   // Notify user that update is ready
-  showUpdateNotification({
-    version: event.version,
-    releaseNotes: event.releaseNotes
-  });
+  if (event.updateAvailable) {
+    showUpdateNotification({
+      version: event.version,
+      type: event.type
+    });
+  }
 });
 ```
 
@@ -134,14 +128,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 +145,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 +194,17 @@ async function setupABTest(config: ABTestConfig) {
     ? config.variants.treatment 
     : config.variants.control;
     
-  const download = await NativeUpdate.downloadUpdate({
+  const download = await NativeUpdate.download({
     url: bundleUrl,
-    metadata: {
-      testId: config.testId,
-      variant
-    }
+    version: variant,
+    checksum: 'bundle-checksum' // This should come from server
   });
   
-  // 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 +219,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 +254,20 @@ class UpdateManager {
     );
     
     try {
-      const download = await NativeUpdate.downloadUpdate({
-        url: updateInfo.downloadUrl
+      // Download requires url, version, and checksum
+      const download = await NativeUpdate.download({
+        url: updateInfo.url,
+        version: updateInfo.version,
+        checksum: updateInfo.checksum
       });
       
       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 +294,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 +305,20 @@ 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({
+    url: url,
+    version: 'secure-version',
+    checksum: expectedHash
   });
   
   // Additional verification
-  const verified = await NativeUpdate.verifyBundle({
-    bundleId: download.bundleId,
-    publicKey: await getPublicKey()
+  const verified = await NativeUpdate.LiveUpdate.validateUpdate({
+    bundlePath: download.path,
+    checksum: download.checksum,
+    signature: 'bundle-signature'
   });
   
-  if (!verified.valid) {
+  if (!verified.isValid) {
     throw new Error('Bundle verification failed');
   }
   
@@ -362,10 +345,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 +355,20 @@ class UpdateMetrics {
       
       // Download phase
       metrics.downloadStarted = Date.now();
-      const download = await NativeUpdate.downloadUpdate({
-        url: result.downloadUrl
+      const download = await NativeUpdate.download({
+        url: result.url,
+        version: result.version,
+        checksum: result.checksum
       });
       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 +389,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,37 @@ 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({
+    bundleId: download.bundleId,
+    version: download.version,
+    checksum: download.checksum
   });
   
   // Reload the app with new bundle
-  await NativeUpdate.reloadApp();
+  await NativeUpdate.reload();
 }
 ```
 
@@ -58,7 +56,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 +145,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 +169,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 +201,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/features/app-reviews.md

@@ -966,7 +966,7 @@ async function monitorReviewSuccess() {
 ## Next Steps
 
 - Implement [Security Best Practices](../guides/security-best-practices.md)
-- Set up [Analytics Tracking](../examples/analytics-integration.md)
+- Review the [API Reference](../api/app-review-api.md)
 - Configure [Live Updates](./live-updates.md)
 - Review [API Reference](../api/app-review-api.md)
 

package/docs/features/app-updates.md

@@ -777,7 +777,7 @@ async function trackUpdateMetrics(event: string, data: any) {
 
 - Configure [App Reviews](./app-reviews.md) for user feedback
 - Implement [Security Best Practices](../guides/security-best-practices.md)
-- Set up [Update Monitoring](../guides/monitoring.md)
+- Review [Testing Guide](../guides/testing-guide.md)
 - Review [API Reference](../api/app-update-api.md)
 
 ---

package/docs/features/live-updates.md

@@ -379,9 +379,10 @@ async function getFeatureFlags() {
 2. **Implement delta updates** (coming soon):
    ```typescript
    // Future API
-   const delta = await NativeUpdate.LiveUpdate.downloadDelta({
-     fromVersion: current.version,
-     toVersion: latest.version,
+   // Note: Delta updates are handled automatically by the sync() method
+   // when configured on the server. Direct delta download is not available
+   const bundle = await NativeUpdate.LiveUpdate.download({
+     version: latest.version,
    });
    ```
 
@@ -409,15 +410,23 @@ async function getFeatureFlags() {
 ### Storage Management
 
 ```typescript
-// Monitor storage usage
-const storage = await NativeUpdate.LiveUpdate.getStorageInfo();
-console.log(`Used: ${storage.usedBytes} / ${storage.totalBytes}`);
-
-// Clean up when needed
-if (storage.usedBytes > storage.totalBytes * 0.8) {
-  await NativeUpdate.LiveUpdate.delete({
-    olderThan: Date.now() - 30 * 24 * 60 * 60 * 1000, // 30 days
-  });
+// Monitor bundle count and clean up old versions
+const bundles = await NativeUpdate.LiveUpdate.list();
+console.log(`Total bundles: ${bundles.length}`);
+
+// Clean up old bundles (keep only recent 5)
+if (bundles.length > 5) {
+  // Sort by downloadTime and keep the 5 most recent
+  const sortedBundles = bundles.sort((a, b) => 
+    new Date(b.downloadTime).getTime() - new Date(a.downloadTime).getTime()
+  );
+  
+  const toDelete = sortedBundles.slice(5);
+  for (const bundle of toDelete) {
+    await NativeUpdate.LiveUpdate.delete({
+      bundleId: bundle.bundleId,
+    });
+  }
 }
 ```
 
@@ -526,7 +535,7 @@ const devConfig = {
 };
 
 // Force update check
-await NativeUpdate.LiveUpdate.sync({ forceCheck: true });
+await NativeUpdate.LiveUpdate.sync();
 
 // Simulate different scenarios
 await testUpdateScenarios();
@@ -623,7 +632,7 @@ async function loadFeature(featureName: string) {
 
 ## Next Steps
 
-- Set up your [Update Server](../examples/server-setup.md)
+- Set up your update server (see backend-template folder)
 - Implement [Security Best Practices](../guides/security-best-practices.md)
 - Configure [App Updates](./app-updates.md) for native changes
 - Explore [API Reference](../api/live-update-api.md)

package/docs/getting-started/configuration.md

@@ -460,7 +460,7 @@ try {
 ## Next Steps
 
 - Implement [Security Best Practices](../guides/security-best-practices.md)
-- Set up your [Update Server](../examples/server-setup.md)
+- Set up your update server (see backend-template folder)
 - Explore [Advanced Features](../features/live-updates.md)
 
 ---

package/docs/getting-started/installation.md

@@ -194,13 +194,13 @@ After successful installation:
 1. Read the [Quick Start Guide](./quick-start.md) for basic usage
 2. Configure the plugin with your [update server settings](./configuration.md)
 3. Implement [security best practices](../guides/security-best-practices.md)
-4. Set up your [update server](../examples/server-setup.md)
+4. Set up your update server (see backend-template folder)
 
 ## Support
 
 If you encounter any issues during installation:
 
-- Check our [Troubleshooting Guide](../guides/troubleshooting.md)
+- Check our [Testing Guide](../guides/testing-guide.md)
 - Search existing [GitHub Issues](https://github.com/aoneahsan/native-update/issues)
 - Create a new issue with detailed information about your setup
 

package/docs/getting-started/quick-start.md

@@ -53,7 +53,7 @@ initializeUpdates();
 // Sync with server and apply updates if available
 async function syncUpdates() {
   try {
-    const result = await NativeUpdate.LiveUpdate.sync();
+    const result = await NativeUpdate.sync();
 
     if (result.status === 'UPDATE_INSTALLED') {
       console.log('Update installed:', result.bundle.version);
@@ -259,7 +259,7 @@ class UpdateManager {
 
   async checkForUpdates() {
     try {
-      const result = await NativeUpdate.LiveUpdate.sync();
+      const result = await NativeUpdate.sync();
 
       if (result.status === 'UPDATE_INSTALLED') {
         // Notify user about update
@@ -349,7 +349,7 @@ async function safeUpdateCheck() {
 
 Now that you have the basics working:
 
-1. Set up your [Update Server](../examples/server-setup.md)
+1. Set up your update server (see backend-template folder)
 2. Implement [Security Best Practices](../guides/security-best-practices.md)
 3. Configure [Advanced Options](./configuration.md)
 4. Explore [API Reference](../api/live-update-api.md) for all available 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
 
@@ -137,6 +136,6 @@ node tools/bundle-signer.js sign bundle.zip private-key.pem
 
 ## Need Help?
 
-- See [Troubleshooting Guide](../guides/troubleshooting.md)
+- See [Testing Guide](../guides/testing-guide.md)
 - Check [Server Requirements](../server-requirements.md)
 - Review [Security Best Practices](./security-best-practices.md)

package/docs/guides/security-best-practices.md

@@ -1048,9 +1048,9 @@ const productionSecurityConfig = {
 ## Next Steps
 
 - Review [Production Readiness](../production-readiness.md) checklist
-- Implement [Monitoring and Analytics](../examples/monitoring-setup.md)
-- Set up [Incident Response](../guides/incident-response.md) procedures
-- Configure [Update Server Security](../examples/server-security.md)
+- Implement proper monitoring and analytics
+- Set up incident response procedures
+- Configure update server security (see backend-template folder)
 
 ---