@capawesome/capacitor-live-update 7.3.0 → 7.4.0

package/ios/Plugin/LiveUpdate.swift

@@ -35,11 +35,18 @@ import CommonCrypto
         self.preferences = LiveUpdatePreferences()
         super.init()
 
+        // Check version and reset config if version changed
+        checkAndResetConfigIfVersionChanged()
+
         // Start the rollback timer to rollback to the default bundle
         // if the app is not ready after a certain time
         startRollbackTimer()
     }
 
+    @objc public func clearBlockedBundles() {
+        preferences.setBlockedBundleIds(nil)
+    }
+
     @objc public func deleteBundle(_ options: DeleteBundleOptions, completion: @escaping (Error?) -> Void) {
         let bundleId = options.getBundleId()
 
@@ -82,18 +89,40 @@ import CommonCrypto
         return FetchLatestBundleResult(artifactType: response?.artifactType, bundleId: response?.bundleId, checksum: response?.checksum, customProperties: response?.customProperties, downloadUrl: response?.url, signature: response?.signature)
     }
 
+    @objc public func getBlockedBundles(completion: @escaping (Result?, Error?) -> Void) {
+        var bundleIds: [String] = []
+        if let blockedIds = preferences.getBlockedBundleIds(), !blockedIds.isEmpty {
+            bundleIds = blockedIds.split(separator: ",").map(String.init)
+        }
+        let result = GetBlockedBundlesResult(bundleIds: bundleIds)
+        completion(result, nil)
+    }
+
     @objc public func getBundles(completion: @escaping (Result?, Error?) -> Void) {
-        let bundleIds = getBundleIds()
+        let bundleIds = getDownloadedBundleIds()
         let result = GetBundlesResult(bundleIds: bundleIds)
         completion(result, nil)
     }
 
+    @objc public func getDownloadedBundles(completion: @escaping (Result?, Error?) -> Void) {
+        let bundleIds = getDownloadedBundleIds()
+        let result = GetDownloadedBundlesResult(bundleIds: bundleIds)
+        completion(result, nil)
+    }
+
     @objc public func getChannel(completion: @escaping (Result?, Error?) -> Void) {
         let channel = getChannel()
         let result = GetChannelResult(channel: channel)
         completion(result, nil)
     }
 
+    @objc public func getConfig(completion: @escaping (Result?, Error?) -> Void) {
+        let appId = getAppId()
+        let autoUpdateStrategy = config.autoUpdateStrategy
+        let result = GetConfigResult(appId: appId, autoUpdateStrategy: autoUpdateStrategy)
+        completion(result, nil)
+    }
+
     @objc public func getCurrentBundle(completion: @escaping (Result?, Error?) -> Void) {
         let bundleId = getCurrentBundleId()
         let result = GetCurrentBundleResult(bundleId: bundleId)
@@ -131,6 +160,11 @@ import CommonCrypto
         completion(result, nil)
     }
 
+    @objc public func isSyncing(completion: @escaping (Result?, Error?) -> Void) {
+        let result = IsSyncingResult(syncing: syncInProgress)
+        completion(result, nil)
+    }
+
     @objc public func handleLoad() {
         if config.autoUpdateStrategy == "background" {
             performAutoUpdate()
@@ -180,6 +214,10 @@ import CommonCrypto
         self.setNextBundleById(nil)
     }
 
+    @objc public func resetConfig() {
+        preferences.setAppId(nil)
+    }
+
     @objc public func setChannel(_ options: SetChannelOptions, completion: @escaping (Error?) -> Void) {
         let channel = options.getChannel()
 
@@ -187,6 +225,11 @@ import CommonCrypto
         completion(nil)
     }
 
+    @objc public func setConfig(_ options: SetConfigOptions) {
+        let appId = options.getAppId()
+        preferences.setAppId(appId)
+    }
+
     @objc public func setCustomId(_ options: SetCustomIdOptions, completion: @escaping (Error?) -> Void) {
         let customId = options.getCustomId()
 
@@ -371,7 +414,7 @@ import CommonCrypto
     }
 
     private func deleteUnusedBundles() {
-        let bundleIds = getBundleIds()
+        let bundleIds = getDownloadedBundleIds()
         let currentBundleId = getCurrentBundleId()
         let nextBundleId = getNextBundleId()
 
@@ -516,7 +559,7 @@ import CommonCrypto
         parameters["osVersion"] = await UIDevice.current.systemVersion
         parameters["platform"] = "1"
         parameters["pluginVersion"] = LiveUpdatePlugin.version
-        var urlComponents = URLComponents(string: "https://\(config.serverDomain)/v1/apps/\(config.appId ?? "")/bundles/latest")!
+        var urlComponents = URLComponents(string: "https://\(config.serverDomain)/v1/apps/\(getAppId() ?? "")/bundles/latest")!
         urlComponents.queryItems = parameters.map { URLQueryItem(name: $0.key, value: $0.value) }
         let url = try urlComponents.asURL()
         CAPLog.print("[", LiveUpdatePlugin.tag, "] Fetching latest bundle: ", url)
@@ -539,7 +582,7 @@ import CommonCrypto
         }
     }
 
-    private func getBundleIds() -> [String] {
+    private func getDownloadedBundleIds() -> [String] {
         let url = libraryDirectoryUrl.appendingPathComponent(bundlesDirectory)
         do {
             let pathExists = FileManager.default.fileExists(atPath: url.path)
@@ -553,6 +596,13 @@ import CommonCrypto
         }
     }
 
+    private func getAppId() -> String? {
+        if let appId = preferences.getAppId() {
+            return appId
+        }
+        return config.appId
+    }
+
     private func getChannel() -> String? {
         var channel: String?
         if let _ = config.defaultChannel {
@@ -755,6 +805,8 @@ import CommonCrypto
             return
         }
         viewController.setServerBasePath(path: path)
+        // Notify listeners
+        notifyReloadedListeners()
     }
 
     /// - Parameter bundleId: The bundle ID to set as the next bundle. If `nil`, the default bundle will be used.
@@ -771,6 +823,10 @@ import CommonCrypto
         plugin.notifyNextBundleSetListeners(event)
     }
 
+    private func notifyReloadedListeners() {
+        plugin.notifyReloadedListeners()
+    }
+
     private func addBlockedBundleId(_ bundleId: String) {
         var blockedList: [String] = []
 
@@ -818,6 +874,23 @@ import CommonCrypto
         }
     }
 
+    private func checkAndResetConfigIfVersionChanged() {
+        let currentVersionCode = getVersionCode()
+        let currentVersionName = getVersionName()
+        let lastVersionCode = preferences.getLastVersionCode()
+        let lastVersionName = preferences.getLastVersionName()
+
+        if lastVersionCode == nil || lastVersionName == nil || lastVersionCode != currentVersionCode || lastVersionName != currentVersionName {
+            CAPLog.print(
+                "[", LiveUpdatePlugin.tag, "] ",
+                "App version changed (last: \(lastVersionName ?? "nil")/\(lastVersionCode ?? "nil"), current: \(currentVersionName)/\(currentVersionCode)), resetting config."
+            )
+            resetConfig()
+            preferences.setLastVersionCode(currentVersionCode)
+            preferences.setLastVersionName(currentVersionName)
+        }
+    }
+
     /// - Parameter bundleId: The bundle ID to save as the previous bundle ID. If `nil`, the value will be removed.
     private func setPreviousBundleId(bundleId: String?) {
         preferences.setPreviousBundleId(bundleId)

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,27 +8,34 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "7.3.0"
+    public static let version = "7.4.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"
     public let jsName = "LiveUpdate"
     public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "clearBlockedBundles", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "deleteBundle", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "downloadBundle", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "fetchLatestBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getBlockedBundles", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getBundles", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getChannel", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getConfig", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getDownloadedBundles", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getCurrentBundle", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getCustomId", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getDeviceId", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getNextBundle", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getVersionCode", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getVersionName", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "isSyncing", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "ready", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "reload", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "reset", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "resetConfig", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setChannel", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setConfig", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setCustomId", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setNextBundle", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "sync", returnType: CAPPluginReturnPromise)
@@ -36,6 +43,7 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
 
     private let eventDownloadBundleProgess = "downloadBundleProgress"
     private let eventNextBundleSet = "nextBundleSet"
+    private let eventReloaded = "reloaded"
 
     private var config: LiveUpdateConfig?
     private var implementation: LiveUpdate?
@@ -56,6 +64,11 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         )
     }
 
+    @objc func clearBlockedBundles(_ call: CAPPluginCall) {
+        implementation?.clearBlockedBundles()
+        resolveCall(call)
+    }
+
     @objc func deleteBundle(_ call: CAPPluginCall) {
         guard let bundleId = call.getString("bundleId") else {
             call.reject(CustomError.bundleIdMissing.localizedDescription)
@@ -117,6 +130,18 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    @objc func getBlockedBundles(_ call: CAPPluginCall) {
+        implementation?.getBlockedBundles(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
     @objc func getBundles(_ call: CAPPluginCall) {
         implementation?.getBundles(completion: { result, error in
             if let error = error {
@@ -129,6 +154,18 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         })
     }
 
+    @objc func getDownloadedBundles(_ call: CAPPluginCall) {
+        implementation?.getDownloadedBundles(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
     @objc func getChannel(_ call: CAPPluginCall) {
         implementation?.getChannel(completion: { result, error in
             if let error = error {
@@ -141,6 +178,18 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         })
     }
 
+    @objc func getConfig(_ call: CAPPluginCall) {
+        implementation?.getConfig(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
     @objc func getCurrentBundle(_ call: CAPPluginCall) {
         implementation?.getCurrentBundle(completion: { result, error in
             if let error = error {
@@ -213,6 +262,18 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         })
     }
 
+    @objc func isSyncing(_ call: CAPPluginCall) {
+        implementation?.isSyncing(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
     @objc func ready(_ call: CAPPluginCall) {
         implementation?.ready(completion: { result, error in
             if let error = error {
@@ -235,6 +296,11 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         resolveCall(call)
     }
 
+    @objc func resetConfig(_ call: CAPPluginCall) {
+        implementation?.resetConfig()
+        resolveCall(call)
+    }
+
     @objc func setChannel(_ call: CAPPluginCall) {
         let channel = call.getString("channel")
 
@@ -249,6 +315,12 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         })
     }
 
+    @objc func setConfig(_ call: CAPPluginCall) {
+        let options = SetConfigOptions(call)
+        implementation?.setConfig(options)
+        resolveCall(call)
+    }
+
     @objc func setCustomId(_ call: CAPPluginCall) {
         guard let customId = call.getString("customId") else {
             call.reject(CustomError.customIdMissing.localizedDescription)
@@ -307,6 +379,11 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         notifyListeners(eventNextBundleSet, data: event.toJSObject(), retainUntilConsumed: false)
     }
 
+    func notifyReloadedListeners() {
+        let event = JSObject()
+        notifyListeners(eventReloaded, data: event, retainUntilConsumed: true)
+    }
+
     @objc private func handleAppWillEnterForeground() {
         implementation?.handleAppWillEnterForeground()
     }

package/ios/Plugin/LiveUpdatePreferences.swift

@@ -1,11 +1,22 @@
 import Foundation
 
 public class LiveUpdatePreferences: NSObject {
+    private let appIdKey = "appId" // DO NOT CHANGE
     private let blockedBundleIdsKey = "blockedBundleIds" // DO NOT CHANGE
     private let channelKey = "channel" // DO NOT CHANGE
     private let customIdKey = "customId" // DO NOT CHANGE
+    private let lastVersionCodeKey = "lastVersionCode" // DO NOT CHANGE
+    private let lastVersionNameKey = "lastVersionName" // DO NOT CHANGE
     private let previousBundleIdKey = "previousBundleIdKey" // DO NOT CHANGE
 
+    public func getAppId() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: appIdKey))
+    }
+
+    public func getBlockedBundleIds() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: blockedBundleIdsKey))
+    }
+
     public func getChannel() -> String? {
         return UserDefaults.standard.string(forKey: applyPrefix(to: channelKey))
     }
@@ -14,12 +25,25 @@ public class LiveUpdatePreferences: NSObject {
         return UserDefaults.standard.string(forKey: applyPrefix(to: customIdKey))
     }
 
+    public func getLastVersionCode() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: lastVersionCodeKey))
+    }
+
+    public func getLastVersionName() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: lastVersionNameKey))
+    }
+
     public func getPreviousBundleId() -> String? {
         return UserDefaults.standard.string(forKey: applyPrefix(to: previousBundleIdKey))
     }
 
-    public func getBlockedBundleIds() -> String? {
-        return UserDefaults.standard.string(forKey: applyPrefix(to: blockedBundleIdsKey))
+    public func setAppId(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: appIdKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: appIdKey))
+        }
+        UserDefaults.standard.synchronize()
     }
 
     public func setBlockedBundleIds(_ value: String?) {
@@ -45,6 +69,24 @@ public class LiveUpdatePreferences: NSObject {
         UserDefaults.standard.synchronize()
     }
 
+    public func setLastVersionCode(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastVersionCodeKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastVersionCodeKey))
+        }
+        UserDefaults.standard.synchronize()
+    }
+
+    public func setLastVersionName(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastVersionNameKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastVersionNameKey))
+        }
+        UserDefaults.standard.synchronize()
+    }
+
     public func setPreviousBundleId(_ value: String?) {
         if let value = value {
             UserDefaults.standard.set(value, forKey: applyPrefix(to: previousBundleIdKey))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",