native-update 1.0.0 → 1.0.1

package/docs/examples/advanced-scenarios.md

@@ -7,12 +7,12 @@ This guide covers complex use cases and advanced patterns for the Capacitor Nati
 Minimize download sizes by only downloading changed files:
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 async function checkForDeltaUpdate() {
-  const currentManifest = await CapacitorNativeUpdate.getCurrentManifest();
+  const currentManifest = await NativeUpdate.getCurrentManifest();
   
-  const result = await CapacitorNativeUpdate.checkForUpdate({
+  const result = await NativeUpdate.checkForUpdate({
     updateUrl: 'https://your-update-server.com/api/check',
     currentVersion: currentManifest.version,
     currentChecksum: currentManifest.checksum,
@@ -26,13 +26,13 @@ async function checkForDeltaUpdate() {
 }
 
 async function downloadDeltaUpdate(deltaUrl: string) {
-  const download = await CapacitorNativeUpdate.downloadUpdate({
+  const download = await NativeUpdate.downloadUpdate({
     url: deltaUrl,
     isDelta: true
   });
   
   // Apply delta patch
-  await CapacitorNativeUpdate.applyDelta({
+  await NativeUpdate.applyDelta({
     bundleId: download.bundleId,
     baseVersion: getCurrentVersion()
   });
@@ -52,7 +52,7 @@ enum UpdateChannel {
 }
 
 async function setupUpdateChannel(channel: UpdateChannel) {
-  await CapacitorNativeUpdate.configure({
+  await NativeUpdate.configure({
     updateChannel: channel,
     updateUrl: `https://updates.example.com/api/${channel}/check`
   });
@@ -63,7 +63,7 @@ async function switchToBetaChannel() {
   await setupUpdateChannel(UpdateChannel.BETA);
   
   // Check for updates in the new channel
-  const result = await CapacitorNativeUpdate.checkForUpdate({
+  const result = await NativeUpdate.checkForUpdate({
     currentVersion: await getCurrentVersion()
   });
   
@@ -82,7 +82,7 @@ async function checkStagedUpdate() {
   const deviceId = await getDeviceId();
   const rolloutPercentage = hashDeviceId(deviceId) % 100;
   
-  const result = await CapacitorNativeUpdate.checkForUpdate({
+  const result = await NativeUpdate.checkForUpdate({
     updateUrl: 'https://your-update-server.com/api/check',
     currentVersion: '1.0.0',
     metadata: {
@@ -105,13 +105,13 @@ Download updates in the background without interrupting users:
 ```typescript
 async function setupBackgroundUpdates() {
   // Configure background update behavior
-  await CapacitorNativeUpdate.configure({
+  await NativeUpdate.configure({
     backgroundUpdateMode: 'wifi-only',
     autoInstallMode: 'on-restart'
   });
   
   // Schedule background update checks
-  await CapacitorNativeUpdate.scheduleBackgroundCheck({
+  await NativeUpdate.scheduleBackgroundCheck({
     interval: 14400000, // 4 hours
     requiresWifi: true,
     requiresCharging: false
@@ -119,7 +119,7 @@ async function setupBackgroundUpdates() {
 }
 
 // Handle background update events
-CapacitorNativeUpdate.addListener('backgroundUpdateReady', (event) => {
+NativeUpdate.addListener('backgroundUpdateReady', (event) => {
   // Notify user that update is ready
   showUpdateNotification({
     version: event.version,
@@ -135,11 +135,11 @@ Implement automatic rollback on update failures:
 ```typescript
 async function safeUpdate() {
   // Save current version info before update
-  const backup = await CapacitorNativeUpdate.createBackup();
+  const backup = await NativeUpdate.createBackup();
   
   try {
     // Attempt update
-    await CapacitorNativeUpdate.installUpdate({
+    await NativeUpdate.installUpdate({
       bundleId: 'new-update-id',
       validateAfterInstall: true
     });
@@ -151,12 +151,12 @@ async function safeUpdate() {
     }
     
     // Confirm successful update
-    await CapacitorNativeUpdate.confirmUpdate();
+    await NativeUpdate.confirmUpdate();
   } catch (error) {
     console.error('Update failed, rolling back:', error);
     
     // Automatic rollback
-    await CapacitorNativeUpdate.rollback({
+    await NativeUpdate.rollback({
       backupId: backup.id
     });
     
@@ -201,7 +201,7 @@ async function setupABTest(config: ABTestConfig) {
     ? config.variants.treatment 
     : config.variants.control;
     
-  const download = await CapacitorNativeUpdate.downloadUpdate({
+  const download = await NativeUpdate.downloadUpdate({
     url: bundleUrl,
     metadata: {
       testId: config.testId,
@@ -210,7 +210,7 @@ async function setupABTest(config: ABTestConfig) {
   });
   
   // Install with test metadata
-  await CapacitorNativeUpdate.installUpdate({
+  await NativeUpdate.installUpdate({
     bundleId: download.bundleId,
     preserveData: true
   });
@@ -227,7 +227,7 @@ class UpdateManager {
   
   async checkAndPromptUpdate() {
     // Check for update
-    const result = await CapacitorNativeUpdate.checkForUpdate({
+    const result = await NativeUpdate.checkForUpdate({
       updateUrl: 'https://your-update-server.com/api/check',
       currentVersion: await this.getCurrentVersion()
     });
@@ -253,7 +253,7 @@ class UpdateManager {
     this.updateState = { status: 'downloading', progress: 0 };
     
     // Download with progress tracking
-    const downloadListener = CapacitorNativeUpdate.addListener(
+    const downloadListener = NativeUpdate.addListener(
       'downloadProgress',
       (progress) => {
         this.updateState = {
@@ -265,14 +265,14 @@ class UpdateManager {
     );
     
     try {
-      const download = await CapacitorNativeUpdate.downloadUpdate({
+      const download = await NativeUpdate.downloadUpdate({
         url: updateInfo.downloadUrl
       });
       
       this.updateState = { status: 'installing' };
       this.updateUI();
       
-      await CapacitorNativeUpdate.installUpdate({
+      await NativeUpdate.installUpdate({
         bundleId: download.bundleId
       });
       
@@ -300,7 +300,7 @@ async function secureUpdateCheck() {
     version: getCurrentVersion()
   });
   
-  const result = await CapacitorNativeUpdate.checkForUpdate({
+  const result = await NativeUpdate.checkForUpdate({
     updateUrl: 'https://your-update-server.com/api/check',
     currentVersion: getCurrentVersion(),
     headers: {
@@ -322,7 +322,7 @@ async function secureUpdateCheck() {
 }
 
 async function downloadWithIntegrityCheck(url: string, expectedHash: string) {
-  const download = await CapacitorNativeUpdate.downloadUpdate({
+  const download = await NativeUpdate.downloadUpdate({
     url,
     validateChecksum: true,
     expectedChecksum: expectedHash,
@@ -330,7 +330,7 @@ async function downloadWithIntegrityCheck(url: string, expectedHash: string) {
   });
   
   // Additional verification
-  const verified = await CapacitorNativeUpdate.verifyBundle({
+  const verified = await NativeUpdate.verifyBundle({
     bundleId: download.bundleId,
     publicKey: await getPublicKey()
   });
@@ -362,7 +362,7 @@ class UpdateMetrics {
     
     try {
       // Check phase
-      const result = await CapacitorNativeUpdate.checkForUpdate({
+      const result = await NativeUpdate.checkForUpdate({
         updateUrl: 'https://your-update-server.com/api/check',
         currentVersion: getCurrentVersion()
       });
@@ -375,7 +375,7 @@ class UpdateMetrics {
       
       // Download phase
       metrics.downloadStarted = Date.now();
-      const download = await CapacitorNativeUpdate.downloadUpdate({
+      const download = await NativeUpdate.downloadUpdate({
         url: result.downloadUrl
       });
       metrics.downloadCompleted = Date.now();
@@ -383,7 +383,7 @@ class UpdateMetrics {
       
       // Install phase
       metrics.installStarted = Date.now();
-      await CapacitorNativeUpdate.installUpdate({
+      await NativeUpdate.installUpdate({
         bundleId: download.bundleId
       });
       metrics.installCompleted = Date.now();

package/docs/examples/basic-usage.md

@@ -5,19 +5,19 @@ This guide demonstrates basic usage patterns for the Capacitor Native Update plu
 ## Installation
 
 ```bash
-yarn add capacitor-native-update
+yarn add native-update
 npx cap sync
 ```
 
 ## Simple Live Update Check
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 // Check for updates on app startup
 async function checkForUpdates() {
   try {
-    const result = await CapacitorNativeUpdate.checkForUpdate({
+    const result = await NativeUpdate.checkForUpdate({
       updateUrl: 'https://your-update-server.com/api/check',
       currentVersion: '1.0.0'
     });
@@ -34,22 +34,22 @@ async function checkForUpdates() {
 
 async function downloadAndInstall(downloadUrl: string) {
   // Download the update
-  const download = await CapacitorNativeUpdate.downloadUpdate({
+  const download = await NativeUpdate.downloadUpdate({
     url: downloadUrl
   });
   
   // Monitor download progress
-  CapacitorNativeUpdate.addListener('downloadProgress', (progress) => {
+  NativeUpdate.addListener('downloadProgress', (progress) => {
     console.log(`Download progress: ${progress.percent}%`);
   });
   
   // Install the update
-  await CapacitorNativeUpdate.installUpdate({
+  await NativeUpdate.installUpdate({
     bundleId: download.bundleId
   });
   
   // Reload the app with new bundle
-  await CapacitorNativeUpdate.reloadApp();
+  await NativeUpdate.reloadApp();
 }
 ```
 
@@ -58,7 +58,7 @@ async function downloadAndInstall(downloadUrl: string) {
 ```typescript
 // Check if a native app update is available
 async function checkAppStoreUpdate() {
-  const result = await CapacitorNativeUpdate.checkAppUpdate();
+  const result = await NativeUpdate.checkAppUpdate();
   
   if (result.updateAvailable) {
     // Show update prompt to user
@@ -68,7 +68,7 @@ async function checkAppStoreUpdate() {
     
     if (shouldUpdate) {
       // Open app store for update
-      await CapacitorNativeUpdate.openAppStore();
+      await NativeUpdate.openAppStore();
     }
   }
 }
@@ -80,7 +80,7 @@ async function checkAppStoreUpdate() {
 // Request app review after positive user action
 async function requestReview() {
   try {
-    const result = await CapacitorNativeUpdate.requestReview();
+    const result = await NativeUpdate.requestReview();
     
     if (result.displayed) {
       console.log('Review dialog was shown');
@@ -107,7 +107,7 @@ async function onTaskCompleted() {
 
 ```typescript
 // Initialize with custom configuration
-CapacitorNativeUpdate.configure({
+NativeUpdate.configure({
   // Live update settings
   autoCheckOnStart: true,
   updateCheckInterval: 3600000, // 1 hour
@@ -129,7 +129,7 @@ CapacitorNativeUpdate.configure({
 // Comprehensive error handling
 async function safeUpdateCheck() {
   try {
-    const result = await CapacitorNativeUpdate.checkForUpdate({
+    const result = await NativeUpdate.checkForUpdate({
       updateUrl: 'https://your-update-server.com/api/check',
       currentVersion: '1.0.0'
     });
@@ -155,26 +155,26 @@ async function safeUpdateCheck() {
 // Set up event listeners
 function setupUpdateListeners() {
   // Download progress
-  CapacitorNativeUpdate.addListener('downloadProgress', (event) => {
+  NativeUpdate.addListener('downloadProgress', (event) => {
     updateProgressBar(event.percent);
   });
   
   // Update installed
-  CapacitorNativeUpdate.addListener('updateInstalled', (event) => {
+  NativeUpdate.addListener('updateInstalled', (event) => {
     console.log(`Update ${event.version} installed successfully`);
   });
   
   // Update failed
-  CapacitorNativeUpdate.addListener('updateFailed', (event) => {
+  NativeUpdate.addListener('updateFailed', (event) => {
     console.error(`Update failed: ${event.error}`);
     // Optionally rollback
-    CapacitorNativeUpdate.rollback();
+    NativeUpdate.rollback();
   });
 }
 
 // Clean up listeners when done
 function cleanup() {
-  CapacitorNativeUpdate.removeAllListeners();
+  NativeUpdate.removeAllListeners();
 }
 ```
 

package/docs/features/app-reviews.md

@@ -63,7 +63,7 @@ App reviews are crucial for app store visibility and user trust. This feature he
 
 ```typescript
 // Configure app reviews
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   appReview: {
     minimumDaysSinceInstall: 7,
     minimumDaysSinceLastPrompt: 60,
@@ -75,11 +75,11 @@ await CapacitorNativeUpdate.configure({
 async function requestReview() {
   try {
     // Check if we can request a review
-    const canRequest = await CapacitorNativeUpdate.AppReview.canRequestReview();
+    const canRequest = await NativeUpdate.AppReview.canRequestReview();
 
     if (canRequest.allowed) {
       // Request the review
-      const result = await CapacitorNativeUpdate.AppReview.requestReview();
+      const result = await NativeUpdate.AppReview.requestReview();
 
       if (result.shown) {
         console.log('Review dialog was shown');
@@ -104,7 +104,7 @@ class AppReviewManager {
 
   async initialize() {
     // Configure with advanced settings
-    await CapacitorNativeUpdate.configure({
+    await NativeUpdate.configure({
       appReview: {
         minimumDaysSinceInstall: 14,
         minimumDaysSinceLastPrompt: 90,
@@ -182,7 +182,7 @@ class AppReviewManager {
 
   private async analyzeReviewReadiness() {
     // Check basic eligibility
-    const canRequest = await CapacitorNativeUpdate.AppReview.canRequestReview();
+    const canRequest = await NativeUpdate.AppReview.canRequestReview();
 
     if (!canRequest.allowed) {
       return {
@@ -243,7 +243,7 @@ class AppReviewManager {
 
   async requestReview() {
     try {
-      const result = await CapacitorNativeUpdate.AppReview.requestReview();
+      const result = await NativeUpdate.AppReview.requestReview();
 
       // Track the request
       this.trackReviewRequest(result);
@@ -367,7 +367,7 @@ class ReviewFatigueManager {
   async canRequestReview(): Promise<boolean> {
     // Check platform limits
     const platformCheck =
-      await CapacitorNativeUpdate.AppReview.canRequestReview();
+      await NativeUpdate.AppReview.canRequestReview();
 
     if (!platformCheck.allowed) {
       return false;
@@ -596,7 +596,7 @@ class iOSReviewManager {
   async requestReview(): Promise<ReviewResult> {
     try {
       // Use StoreKit review controller
-      const result = await CapacitorNativeUpdate.AppReview.requestReview();
+      const result = await NativeUpdate.AppReview.requestReview();
 
       // iOS handles everything natively
       return {
@@ -614,7 +614,7 @@ class iOSReviewManager {
 
   private async fallbackToAppStore() {
     // Open App Store page
-    await CapacitorNativeUpdate.AppUpdate.openAppStore();
+    await NativeUpdate.AppUpdate.openAppStore();
 
     return {
       shown: true,
@@ -633,7 +633,7 @@ class AndroidReviewManager {
   async requestReview(): Promise<ReviewResult> {
     try {
       // Use Play Core in-app review
-      const result = await CapacitorNativeUpdate.AppReview.requestReview();
+      const result = await NativeUpdate.AppReview.requestReview();
 
       return {
         shown: result.shown,
@@ -650,7 +650,7 @@ class AndroidReviewManager {
 
   private async fallbackToPlayStore() {
     // Open Play Store page
-    await CapacitorNativeUpdate.AppUpdate.openAppStore();
+    await NativeUpdate.AppUpdate.openAppStore();
 
     return {
       shown: true,
@@ -921,10 +921,10 @@ const debugConfig = {
 // Test different scenarios
 async function testReviewScenarios() {
   // Test immediate request
-  await CapacitorNativeUpdate.AppReview.requestReview();
+  await NativeUpdate.AppReview.requestReview();
 
   // Test eligibility check
-  const canRequest = await CapacitorNativeUpdate.AppReview.canRequestReview();
+  const canRequest = await NativeUpdate.AppReview.canRequestReview();
   console.log('Can request review:', canRequest);
 
   // Test custom triggers

package/docs/features/app-updates.md

@@ -44,7 +44,7 @@ While Live Updates handle web assets, App Updates manage the native app binary i
 // Check for app updates on startup
 async function checkForAppUpdates() {
   try {
-    const updateInfo = await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+    const updateInfo = await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
     if (updateInfo.updateAvailable) {
       console.log(`Update available: ${updateInfo.availableVersion}`);
@@ -52,7 +52,7 @@ async function checkForAppUpdates() {
       // Handle based on priority
       if (updateInfo.updatePriority >= 4) {
         // High priority - immediate update
-        await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+        await NativeUpdate.AppUpdate.performImmediateUpdate();
       } else {
         // Optional update - show custom UI
         showUpdateDialog(updateInfo);
@@ -73,7 +73,7 @@ class AppUpdateManager {
 
   async initialize() {
     // Configure app updates
-    await CapacitorNativeUpdate.configure({
+    await NativeUpdate.configure({
       appUpdate: {
         checkOnAppStart: true,
         minimumVersion: '2.0.0',
@@ -94,7 +94,7 @@ class AppUpdateManager {
 
   private setupUpdateListeners() {
     // Android flexible update state changes
-    CapacitorNativeUpdate.AppUpdate.addListener(
+    NativeUpdate.AppUpdate.addListener(
       'flexibleUpdateStateChanged',
       (state) => {
         this.handleFlexibleUpdateState(state);
@@ -102,7 +102,7 @@ class AppUpdateManager {
     );
 
     // Download progress for flexible updates
-    CapacitorNativeUpdate.AppUpdate.addListener(
+    NativeUpdate.AppUpdate.addListener(
       'flexibleUpdateProgress',
       (progress) => {
         this.downloadProgress = progress.percent;
@@ -114,7 +114,7 @@ class AppUpdateManager {
   async checkForUpdates() {
     try {
       this.updateInfo =
-        await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+        await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
       if (!this.updateInfo.updateAvailable) {
         console.log('App is up to date');
@@ -166,7 +166,7 @@ class AppUpdateManager {
       this.showImmediateUpdateUI();
 
       // Start immediate update
-      await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+      await NativeUpdate.AppUpdate.performImmediateUpdate();
 
       // App will restart automatically after update
     } catch (error) {
@@ -183,7 +183,7 @@ class AppUpdateManager {
   async startFlexibleUpdate() {
     try {
       // Start background download
-      await CapacitorNativeUpdate.AppUpdate.startFlexibleUpdate();
+      await NativeUpdate.AppUpdate.startFlexibleUpdate();
 
       // Show download progress UI
       this.showFlexibleUpdateUI();
@@ -223,7 +223,7 @@ class AppUpdateManager {
 
   async completeFlexibleUpdate() {
     try {
-      await CapacitorNativeUpdate.AppUpdate.completeFlexibleUpdate();
+      await NativeUpdate.AppUpdate.completeFlexibleUpdate();
       // App will restart with new version
     } catch (error) {
       console.error('Failed to complete update:', error);
@@ -265,17 +265,17 @@ const androidUpdate = {
   // Immediate update flow
   immediate: async () => {
     // Blocks UI until update is installed
-    await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+    await NativeUpdate.AppUpdate.performImmediateUpdate();
     // App restarts automatically
   },
 
   // Flexible update flow
   flexible: async () => {
     // Download in background
-    await CapacitorNativeUpdate.AppUpdate.startFlexibleUpdate();
+    await NativeUpdate.AppUpdate.startFlexibleUpdate();
 
     // Monitor progress
-    const listener = await CapacitorNativeUpdate.AppUpdate.addListener(
+    const listener = await NativeUpdate.AppUpdate.addListener(
       'flexibleUpdateProgress',
       (progress) => {
         console.log(
@@ -285,7 +285,7 @@ const androidUpdate = {
     );
 
     // Complete when ready
-    await CapacitorNativeUpdate.AppUpdate.completeFlexibleUpdate();
+    await NativeUpdate.AppUpdate.completeFlexibleUpdate();
   },
 };
 ```
@@ -299,7 +299,7 @@ iOS requires manual version checking and App Store redirection:
 const iosUpdate = {
   // Check version manually
   check: async () => {
-    const info = await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+    const info = await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
     if (info.updateAvailable) {
       // Show custom update dialog
@@ -307,7 +307,7 @@ const iosUpdate = {
 
       if (shouldUpdate) {
         // Open App Store
-        await CapacitorNativeUpdate.AppUpdate.openAppStore();
+        await NativeUpdate.AppUpdate.openAppStore();
       }
     }
   },
@@ -322,7 +322,7 @@ Web platforms show update notifications:
 // Web fallback
 const webUpdate = {
   notify: async () => {
-    const info = await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+    const info = await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
     if (info.updateAvailable) {
       // Show notification
@@ -455,13 +455,13 @@ async function enforceMinimumVersion() {
     },
   };
 
-  const info = await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+  const info = await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
   // Check if current version is below minimum
   if (isVersionBelow(info.currentVersion, config.appUpdate.minimumVersion)) {
     // Force immediate update
     try {
-      await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+      await NativeUpdate.AppUpdate.performImmediateUpdate();
     } catch (error) {
       // If update fails or is cancelled, restrict app usage
       showMinimumVersionRequired();
@@ -550,7 +550,7 @@ class UpdateProgressUI {
   showProgress() {
     this.createProgressUI();
 
-    CapacitorNativeUpdate.AppUpdate.addListener(
+    NativeUpdate.AppUpdate.addListener(
       'flexibleUpdateProgress',
       (progress) => {
         this.updateProgress(progress);
@@ -587,7 +587,7 @@ class UpdateProgressUI {
 ```typescript
 async function handleAppUpdateErrors() {
   try {
-    await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+    await NativeUpdate.AppUpdate.performImmediateUpdate();
   } catch (error) {
     switch (error.code) {
       case 'UPDATE_NOT_AVAILABLE':
@@ -635,7 +635,7 @@ class UpdateRetryStrategy {
 
   async retryUpdate() {
     try {
-      await CapacitorNativeUpdate.AppUpdate.startFlexibleUpdate();
+      await NativeUpdate.AppUpdate.startFlexibleUpdate();
       this.retryCount = 0;
     } catch (error) {
       if (this.shouldRetry(error)) {