native-update 1.1.3 → 1.1.6

package/docs/NATIVE_UPDATES_GUIDE.md

@@ -191,7 +191,7 @@ export class AndroidFlexibleUpdate {
 
       // Listen for download progress
       NativeUpdate.addListener(
-        'onAppUpdateDownloadProgress',
+        'appUpdateProgress',
         (progress) => {
           console.log(
             `Download progress: ${progress.bytesDownloaded} / ${progress.totalBytesToDownload}`

package/docs/QUICK_START.md

@@ -229,7 +229,7 @@ export class AndroidUpdateProgress {
 
     // Track progress
     NativeUpdate.addListener(
-      'onAppUpdateDownloadProgress',
+      'appUpdateProgress',
       (progress) => {
         this.downloadProgress = Math.round(
           (progress.bytesDownloaded / progress.totalBytesToDownload) * 100

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

@@ -73,7 +73,15 @@ await NativeUpdate.openAppStore({
 
 ## Events
 
-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.
+App update events are available for monitoring the native app update process. See the [Events API Reference](./events-api.md#app-update-events) for complete documentation of the following events:
+
+- `appUpdateStateChanged` - Fired when update state changes
+- `appUpdateProgress` - Monitor download progress for flexible updates
+- `appUpdateAvailable` - Notified when a new version is available
+- `appUpdateReady` - Update downloaded and ready to install
+- `appUpdateFailed` - Update process failed
+- `appUpdateNotificationClicked` - User clicked update notification
+- `appUpdateInstallClicked` - User clicked install in notification
 
 ## Platform Differences
 

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

@@ -0,0 +1,157 @@
+# Background Update API Reference
+
+Complete API documentation for background update functionality.
+
+## Methods
+
+### enableBackgroundUpdates(config)
+
+Enable background update checking.
+
+```typescript
+await NativeUpdate.enableBackgroundUpdates({
+  checkInterval: 3600000,           // Check every hour (in ms)
+  requireWifi: true,                // Only check on WiFi
+  requireCharging: false,           // Don't require charging
+  updateTypes: ['live', 'native'],  // Check both update types
+  notificationConfig: {
+    enabled: true,
+    title: 'Update Available',
+    autoCancel: true
+  }
+});
+```
+
+### disableBackgroundUpdates()
+
+Disable all background update checks.
+
+```typescript
+await NativeUpdate.disableBackgroundUpdates();
+```
+
+### getBackgroundUpdateStatus()
+
+Get current background update configuration and status.
+
+```typescript
+const status = await NativeUpdate.getBackgroundUpdateStatus();
+// Returns:
+{
+  enabled: boolean;
+  lastCheckTime?: number;
+  nextScheduledCheck?: number;
+  checkInterval?: number;
+  updateTypes: string[];
+  notificationEnabled: boolean;
+}
+```
+
+### scheduleBackgroundCheck(options)
+
+Schedule a one-time background check.
+
+```typescript
+await NativeUpdate.scheduleBackgroundCheck({
+  delay: 60000,  // Check in 1 minute
+  type: 'live'   // Check for live updates only
+});
+```
+
+### triggerBackgroundCheck()
+
+Immediately trigger a background update check.
+
+```typescript
+const result = await NativeUpdate.triggerBackgroundCheck();
+// Returns:
+{
+  liveUpdateAvailable: boolean;
+  nativeUpdateAvailable: boolean;
+  error?: string;
+}
+```
+
+### setNotificationPreferences(preferences)
+
+Configure notification preferences for background updates.
+
+```typescript
+await NativeUpdate.setNotificationPreferences({
+  enabled: true,
+  showProgress: true,
+  soundEnabled: false,
+  vibrationEnabled: true,
+  ledColor: '#00FF00',
+  importance: 'HIGH'
+});
+```
+
+### getNotificationPermissions()
+
+Check current notification permissions.
+
+```typescript
+const permissions = await NativeUpdate.getNotificationPermissions();
+// Returns:
+{
+  granted: boolean;
+  canRequestPermission: boolean;
+  permanentlyDenied: boolean;
+}
+```
+
+### requestNotificationPermissions()
+
+Request notification permissions from the user.
+
+```typescript
+const result = await NativeUpdate.requestNotificationPermissions();
+// Returns:
+{
+  granted: boolean;
+  permanentlyDenied: boolean;
+}
+```
+
+## Events
+
+### backgroundUpdateProgress
+
+Fired during background update operations.
+
+```typescript
+NativeUpdate.addListener('backgroundUpdateProgress', (event) => {
+  console.log('Background update:', event.status);
+  // event.type: 'live' | 'native'
+  // event.status: 'checking' | 'downloading' | 'completed' | 'failed'
+});
+```
+
+### backgroundUpdateNotification
+
+Fired when background check finds an update.
+
+```typescript
+NativeUpdate.addListener('backgroundUpdateNotification', (event) => {
+  console.log('Update available:', event.updateAvailable);
+  // event.type: 'live' | 'native'
+  // event.version: string
+});
+```
+
+## Platform Notes
+
+### Android
+- Uses WorkManager for reliable scheduling
+- Respects battery optimization settings
+- Requires notification permission for user alerts
+
+### iOS
+- Uses BackgroundTasks framework
+- Limited by iOS background execution policies
+- May not run exactly at scheduled times
+
+### Web
+- Uses Service Workers when available
+- Falls back to periodic checks when app is active

package/docs/api/events-api.md

@@ -64,6 +64,129 @@ NativeUpdate.addListener('downloadProgress', (progress) => {
 }
 ```
 
+## App Update Events
+
+### appUpdateStateChanged
+
+Fired when the native app update state changes.
+
+```typescript
+NativeUpdate.addListener('appUpdateStateChanged', (state) => {
+  console.log('App update state:', state.status);
+});
+```
+
+**Event Data:**
+```typescript
+{
+  status: InstallStatus; // See InstallStatus enum
+  installErrorCode?: number; // Error code if status is FAILED
+}
+```
+
+### appUpdateProgress
+
+Fired during app update download progress.
+
+```typescript
+NativeUpdate.addListener('appUpdateProgress', (progress) => {
+  console.log(`Download progress: ${progress.percent}%`);
+});
+```
+
+**Event Data:**
+```typescript
+{
+  percent: number; // Download percentage (0-100)
+  bytesDownloaded: number; // Bytes downloaded so far
+  totalBytes: number; // Total download size
+}
+```
+
+### appUpdateAvailable
+
+Fired when a new app update is detected.
+
+```typescript
+NativeUpdate.addListener('appUpdateAvailable', (info) => {
+  console.log(`Update available: ${info.availableVersion}`);
+});
+```
+
+**Event Data:**
+```typescript
+{
+  currentVersion: string;
+  availableVersion: string;
+  updatePriority: number; // 0-5, where 5 is critical
+  updateSize?: number; // Update size in bytes
+  releaseNotes?: string[]; // Release notes array
+  storeUrl?: string; // App store URL
+}
+```
+
+### appUpdateReady
+
+Fired when the app update is downloaded and ready to install.
+
+```typescript
+NativeUpdate.addListener('appUpdateReady', (event) => {
+  console.log('Update ready to install');
+  // Prompt user to restart/install
+});
+```
+
+**Event Data:**
+```typescript
+{
+  message: string; // "Update downloaded and ready to install"
+}
+```
+
+### appUpdateFailed
+
+Fired when an app update fails.
+
+```typescript
+NativeUpdate.addListener('appUpdateFailed', (error) => {
+  console.error('Update failed:', error.error);
+});
+```
+
+**Event Data:**
+```typescript
+{
+  error: string; // Error message
+  code: string; // Error code
+}
+```
+
+### appUpdateNotificationClicked
+
+Fired when the user clicks on an update notification.
+
+```typescript
+NativeUpdate.addListener('appUpdateNotificationClicked', () => {
+  console.log('User clicked update notification');
+  // Navigate to update screen
+});
+```
+
+**Event Data:** Empty object `{}`
+
+### appUpdateInstallClicked
+
+Fired when the user clicks the install button in an update notification.
+
+```typescript
+NativeUpdate.addListener('appUpdateInstallClicked', () => {
+  console.log('User clicked install in notification');
+  // Start update installation
+});
+```
+
+**Event Data:** Empty object `{}`
+
 ## Background Update Events
 
 ### backgroundUpdateProgress

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

@@ -148,6 +148,22 @@ Notify that the app has successfully started with the new bundle.
 await NativeUpdate.notifyAppReady();
 ```
 
+### getLatest()
+
+Get information about the latest available update from the server.
+
+```typescript
+const latest = await NativeUpdate.getLatest();
+// Returns:
+{
+  available: boolean;         // Whether an update is available
+  version?: string;          // Version number of the latest update
+  url?: string;              // Download URL for the update
+  mandatory?: boolean;       // Whether this is a mandatory update
+  notes?: string;            // Release notes for the update
+  size?: number;             // Size in bytes of the update bundle
+}
+```
 
 ### setChannel(channel)
 

package/docs/features/app-updates.md

@@ -95,7 +95,7 @@ class AppUpdateManager {
   private setupUpdateListeners() {
     // Android flexible update state changes
     NativeUpdate.addListener(
-      'flexibleUpdateStateChanged',
+      'appUpdateStateChanged',
       (state) => {
         this.handleFlexibleUpdateState(state);
       }
@@ -103,7 +103,7 @@ class AppUpdateManager {
 
     // Download progress for flexible updates
     NativeUpdate.addListener(
-      'flexibleUpdateProgress',
+      'appUpdateProgress',
       (progress) => {
         this.downloadProgress = progress.percent;
         this.updateProgressUI(progress);
@@ -276,7 +276,7 @@ const androidUpdate = {
 
     // Monitor progress
     const listener = await NativeUpdate.addListener(
-      'flexibleUpdateProgress',
+      'appUpdateProgress',
       (progress) => {
         console.log(
           `Downloaded: ${progress.bytesDownloaded}/${progress.totalBytes}`
@@ -551,7 +551,7 @@ class UpdateProgressUI {
     this.createProgressUI();
 
     NativeUpdate.addListener(
-      'flexibleUpdateProgress',
+      'appUpdateProgress',
       (progress) => {
         this.updateProgress(progress);
       }

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

@@ -159,7 +159,7 @@ async function startFlexibleUpdate() {
 
   // Listen for download completion
   const listener = await NativeUpdate.addListener(
-    'flexibleUpdateStateChanged',
+    'appUpdateStateChanged',
     (state) => {
       if (state.status === 'DOWNLOADED') {
         // Prompt user to restart

package/ios/Plugin/AppUpdate/AppUpdatePlugin.swift

@@ -6,11 +6,16 @@ class AppUpdatePlugin {
     private weak var plugin: CAPPlugin?
     private var config: [String: Any]?
     private let iTunesLookupURL = "https://itunes.apple.com/lookup"
+    private var eventListener: ((String, [String: Any]) -> Void)?
     
     init(plugin: CAPPlugin) {
         self.plugin = plugin
     }
     
+    func setEventListener(_ listener: @escaping (String, [String: Any]) -> Void) {
+        self.eventListener = listener
+    }
+    
     func configure(_ config: [String: Any]) throws {
         self.config = config
     }
@@ -43,6 +48,16 @@ class AppUpdatePlugin {
                             result["clientVersionStalenessDays"] = days
                         }
                     }
+                    
+                    // Emit available event
+                    var availableData: [String: Any] = [
+                        "currentVersion": currentVersion,
+                        "availableVersion": storeVersion
+                    ]
+                    if let priority = result["updatePriority"] as? Int {
+                        availableData["updatePriority"] = priority
+                    }
+                    eventListener?("appUpdateAvailable", availableData)
                 }
                 
                 // iOS doesn't have the same update types as Android

package/ios/Plugin/LiveUpdate/LiveUpdatePlugin.swift

@@ -517,6 +517,12 @@ class LiveUpdatePlugin {
         defaults.set(bundles, forKey: "native_update_bundles")
     }
     
+    func cleanup() {
+        // Clean up any resources
+        downloadTask?.cancel()
+        downloadTask = nil
+    }
+    
     private func cleanupOldBundles(keepVersions: Int) {
         let bundles = getAllBundles().sorted { bundle1, bundle2 in
             let time1 = bundle1["downloadTime"] as? Double ?? 0

package/ios/Plugin/NativeUpdatePlugin.swift

@@ -8,6 +8,7 @@ public class NativeUpdatePlugin: CAPPlugin {
     private var appReviewPlugin: AppReviewPlugin!
     private var backgroundUpdatePlugin: BackgroundUpdatePlugin!
     private var securityManager: SecurityManager!
+    private var isInitialized = false
     
     override public func load() {
         super.load()
@@ -27,6 +28,49 @@ public class NativeUpdatePlugin: CAPPlugin {
         liveUpdatePlugin.setStateChangeListener { [weak self] state in
             self?.notifyListeners("updateStateChanged", data: state)
         }
+        
+        // Set up app update event listener
+        appUpdatePlugin.setEventListener { [weak self] eventName, data in
+            self?.notifyListeners(eventName, data: data)
+        }
+    }
+    
+    @objc func initialize(_ call: CAPPluginCall) {
+        guard let config = call.getObject("config") else {
+            call.reject("Configuration object is required")
+            return
+        }
+        
+        do {
+            // Initialize with filesystem and preferences if provided
+            // In iOS, we typically don't need these as we use native APIs
+            
+            // Apply configuration
+            configure(call)
+            
+            isInitialized = true
+            call.resolve()
+        } catch {
+            call.reject("Initialization failed", error.localizedDescription)
+        }
+    }
+    
+    @objc func isInitialized(_ call: CAPPluginCall) {
+        call.resolve(["initialized": isInitialized])
+    }
+    
+    @objc func cleanup(_ call: CAPPluginCall) {
+        // Clean up any resources
+        liveUpdatePlugin.cleanup()
+        // Disable background updates through the plugin method
+        let disableCall = CAPPluginCall(
+            callbackId: "cleanup_disable",
+            options: [:],
+            success: { _ in },
+            error: { _ in }
+        )
+        backgroundUpdatePlugin.disableBackgroundUpdates(disableCall)
+        call.resolve()
     }
     
     @objc func configure(_ call: CAPPluginCall) {
@@ -88,6 +132,7 @@ public class NativeUpdatePlugin: CAPPlugin {
     
     @objc func reset(_ call: CAPPluginCall) {
         liveUpdatePlugin.reset(call)
+        isInitialized = false
     }
     
     @objc func current(_ call: CAPPluginCall) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "native-update",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "description": "Foundation package for building a comprehensive update system for Capacitor apps. Provides architecture and interfaces but requires backend implementation.",
   "type": "module",
   "main": "dist/plugin.cjs.js",
@@ -23,7 +23,7 @@
     "NativeUpdate.podspec",
     "docs/",
     "cli/",
-    "templates/"
+    "backend-template/"
   ],
   "author": {
     "name": "Ahsan Mahmood",
@@ -44,7 +44,17 @@
     "plugin",
     "native",
     "app-updates",
-    "native-updates"
+    "native-updates",
+    "ota",
+    "live-updates",
+    "hot-reload",
+    "app-store",
+    "google-play",
+    "in-app-updates",
+    "app-reviews",
+    "ios",
+    "android",
+    "hybrid"
   ],
   "scripts": {
     "build": "npm run clean && npm run tsc && rollup -c rollup.config.js",
@@ -62,35 +72,35 @@
   },
   "dependencies": {
     "archiver": "^7.0.1",
-    "chalk": "^5.6.0",
-    "commander": "^14.0.0",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.1",
     "express": "^5.1.0",
     "ora": "^8.2.0",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "@capacitor/android": "^7.4.2",
-    "@capacitor/core": "^7.4.2",
+    "@capacitor/android": "^7.4.3",
+    "@capacitor/core": "^7.4.3",
     "@capacitor/filesystem": "^7.1.4",
-    "@capacitor/ios": "^7.4.2",
+    "@capacitor/ios": "^7.4.3",
     "@capacitor/preferences": "^7.0.2",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-terser": "^0.4.4",
-    "@types/node": "^24.3.0",
-    "@typescript-eslint/eslint-plugin": "^8.39.1",
-    "@typescript-eslint/parser": "^8.39.1",
+    "@types/node": "^24.3.3",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
     "@vitest/ui": "^3.2.4",
-    "eslint": "^9.33.0",
+    "eslint": "^9.35.0",
     "happy-dom": "^18.0.1",
     "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
-    "rollup": "^4.46.2",
+    "rollup": "^4.50.1",
     "typescript": "^5.9.2",
     "vitest": "^3.2.4"
   },
   "peerDependencies": {
-    "@capacitor/core": "^7.4.2"
+    "@capacitor/core": "^7.4.3"
   },
   "capacitor": {
     "ios": {