@capawesome/capacitor-live-update 6.8.0 → 6.9.0

package/ios/Plugin/LiveUpdateConfig.swift

@@ -1,6 +1,8 @@
 public struct LiveUpdateConfig {
     var appId: String?
+    var autoBlockRolledBackBundles = false
     var autoDeleteBundles = false
+    var autoUpdateStrategy = "none"
     var defaultChannel: String?
     var enabled = true
     var httpTimeout = 60000
@@ -8,4 +10,5 @@ public struct LiveUpdateConfig {
     var publicKey: String?
     var readyTimeout = 10000
     var resetOnUpdate = true
+    var serverDomain = "api.cloud.capawesome.io"
 }

package/ios/Plugin/LiveUpdateHttpClient.swift

@@ -5,25 +5,39 @@ import Alamofire
 public class LiveUpdateHttpClient: NSObject {
 
     private let config: LiveUpdateConfig
+    private var deviceId: String?
 
     public static func getChecksumFromResponse(response: HTTPURLResponse) -> String? {
-        return response.allHeaderFields["x-checksum"] as? String // Must be lowercase!
+        guard let headers = response.allHeaderFields as? [String: String] else { return nil }
+        return headers.first(where: { $0.key.lowercased() == "x-checksum" })?.value
     }
 
     public static func getSignatureFromResponse(response: HTTPURLResponse) -> String? {
-        return response.allHeaderFields["x-signature"] as? String // Must be lowercase!
+        guard let headers = response.allHeaderFields as? [String: String] else { return nil }
+        return headers.first(where: { $0.key.lowercased() == "x-signature" })?.value
     }
 
     init(config: LiveUpdateConfig) {
         self.config = config
     }
 
-    public func download(url: URL, destination: @escaping DownloadRequest.Destination) async throws -> AFDownloadResponse<Data> {
+    public func setDeviceId(_ deviceId: String) {
+        self.deviceId = deviceId
+    }
+
+    public func download(url: URL, destination: @escaping DownloadRequest.Destination, callback: ((Progress) -> Void)?) async throws -> AFDownloadResponse<Data> {
         var request = URLRequest(url: url)
         request.httpMethod = HTTPMethod.get.rawValue
         request.timeoutInterval = Double(config.httpTimeout) / 1000.0
+        if let deviceId = deviceId, !deviceId.isEmpty {
+            request.setValue(deviceId, forHTTPHeaderField: "X-Device-Id")
+        }
         return try await withCheckedThrowingContinuation { continuation in
-            AF.download(request, to: destination).responseData { response in
+            AF.download(request, to: destination).downloadProgress { progress in
+                if let callback = callback {
+                    callback(progress)
+                }
+            }.responseData(emptyResponseCodes: [200, 204, 205]) { response in
                 continuation.resume(returning: response)
             }
         }
@@ -33,6 +47,9 @@ public class LiveUpdateHttpClient: NSObject {
         var request = URLRequest(url: url)
         request.httpMethod = HTTPMethod.get.rawValue
         request.timeoutInterval = Double(config.httpTimeout) / 1000.0
+        if let deviceId = deviceId, !deviceId.isEmpty {
+            request.setValue(deviceId, forHTTPHeaderField: "X-Device-Id")
+        }
         return try await withCheckedThrowingContinuation { continuation in
             AF.request(request).validate().responseDecodable(of: type) { response in
                 continuation.resume(returning: response)

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -6,18 +6,70 @@ import Capacitor
  * here: https://capacitorjs.com/docs/plugins/ios
  */
 @objc(LiveUpdatePlugin)
-public class LiveUpdatePlugin: CAPPlugin {
+public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "6.8.0"
+    public static let version = "6.9.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: "fetchChannels", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "fetchLatestBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getBlockedBundles", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getBundle", 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: "setBundle", 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)
+    ]
+
+    private let eventDownloadBundleProgess = "downloadBundleProgress"
+    private let eventNextBundleSet = "nextBundleSet"
+    private let eventReloaded = "reloaded"
+
     private var config: LiveUpdateConfig?
     private var implementation: LiveUpdate?
-    private var syncInProgress = false
 
     override public func load() {
         self.config = liveUpdateConfig()
         self.implementation = LiveUpdate(config: config!, plugin: self)
+
+        // Notify implementation about load
+        implementation?.handleLoad()
+
+        // Register for app resume notifications
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(handleAppWillEnterForeground),
+            name: UIApplication.willEnterForegroundNotification,
+            object: nil
+        )
+    }
+
+    @objc func clearBlockedBundles(_ call: CAPPluginCall) {
+        implementation?.clearBlockedBundles()
+        resolveCall(call)
     }
 
     @objc func deleteBundle(_ call: CAPPluginCall) {
@@ -62,9 +114,33 @@ public class LiveUpdatePlugin: CAPPlugin {
         }
     }
 
+    @objc func fetchChannels(_ call: CAPPluginCall) {
+        Task {
+            do {
+                guard let appId = config?.appId, !appId.isEmpty else {
+                    call.reject(CustomError.appIdMissing.localizedDescription)
+                    return
+                }
+
+                let options = FetchChannelsOptions(call)
+                let result = try await implementation?.fetchChannels(options)
+                if let result = result?.toJSObject() as? JSObject {
+                    self.resolveCall(call, result)
+                }
+            } catch {
+                rejectCall(call, error)
+            }
+        }
+    }
+
     @objc func fetchLatestBundle(_ call: CAPPluginCall) {
         Task {
             do {
+                guard let appId = config?.appId, !appId.isEmpty else {
+                    call.reject(CustomError.appIdMissing.localizedDescription)
+                    return
+                }
+
                 let options = FetchLatestBundleOptions(call)
                 let result = try await implementation?.fetchLatestBundle(options)
                 if let result = result?.toJSObject() as? JSObject {
@@ -76,6 +152,18 @@ public class LiveUpdatePlugin: CAPPlugin {
         }
     }
 
+    @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 getBundle(_ call: CAPPluginCall) {
         implementation?.getBundle(completion: { result, error in
             if let error = error {
@@ -100,6 +188,18 @@ public class LiveUpdatePlugin: CAPPlugin {
         })
     }
 
+    @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 {
@@ -112,6 +212,18 @@ public class LiveUpdatePlugin: CAPPlugin {
         })
     }
 
+    @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 {
@@ -184,9 +296,28 @@ public class LiveUpdatePlugin: CAPPlugin {
         })
     }
 
+    @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()
-        resolveCall(call)
+        implementation?.ready(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 reload(_ call: CAPPluginCall) {
@@ -199,6 +330,11 @@ public class LiveUpdatePlugin: CAPPlugin {
         resolveCall(call)
     }
 
+    @objc func resetConfig(_ call: CAPPluginCall) {
+        implementation?.resetConfig()
+        resolveCall(call)
+    }
+
     @objc func setBundle(_ call: CAPPluginCall) {
         guard let bundleId = call.getString("bundleId") else {
             call.reject(CustomError.bundleIdMissing.localizedDescription)
@@ -230,6 +366,12 @@ public class LiveUpdatePlugin: CAPPlugin {
         })
     }
 
+    @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)
@@ -262,35 +404,48 @@ public class LiveUpdatePlugin: CAPPlugin {
     @objc func sync(_ call: CAPPluginCall) {
         Task {
             do {
-                guard let _ = config?.appId else {
+                guard let appId = config?.appId, !appId.isEmpty else {
                     call.reject(CustomError.appIdMissing.localizedDescription)
                     return
                 }
 
-                guard !syncInProgress else {
-                    call.reject(CustomError.syncInProgress.localizedDescription)
-                    return
-                }
-                syncInProgress = true
-
                 let options = SyncOptions(call)
                 let result = try await implementation?.sync(options)
-                self.syncInProgress = false
                 if let result = result?.toJSObject() as? JSObject {
                     resolveCall(call, result)
                 }
             } catch {
-                self.syncInProgress = false
                 rejectCall(call, error)
             }
         }
     }
 
+    func notifyDownloadBundleProgressListeners(_ event: DownloadBundleProgressEvent) {
+        if let event = event.toJSObject() as? JSObject {
+            notifyListeners(eventDownloadBundleProgess, data: event, retainUntilConsumed: false)
+        }
+    }
+
+    func notifyNextBundleSetListeners(_ event: NextBundleSetEvent) {
+        notifyListeners(eventNextBundleSet, data: event.toJSObject(), retainUntilConsumed: false)
+    }
+
+    func notifyReloadedListeners() {
+        let event = JSObject()
+        notifyListeners(eventReloaded, data: event, retainUntilConsumed: true)
+    }
+
+    @objc private func handleAppWillEnterForeground() {
+        implementation?.handleAppWillEnterForeground()
+    }
+
     private func liveUpdateConfig() -> LiveUpdateConfig {
         var config = LiveUpdateConfig()
 
         config.appId = getConfig().getString("appId", config.appId)
+        config.autoBlockRolledBackBundles = getConfig().getBoolean("autoBlockRolledBackBundles", config.autoBlockRolledBackBundles)
         config.autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.autoDeleteBundles)
+        config.autoUpdateStrategy = getConfig().getString("autoUpdateStrategy", config.autoUpdateStrategy) ?? config.autoUpdateStrategy
         config.defaultChannel = getConfig().getString("defaultChannel", config.defaultChannel)
         config.enabled = getConfig().getBoolean("enabled", config.enabled)
         config.httpTimeout = getConfig().getInt("httpTimeout", config.httpTimeout)
@@ -298,6 +453,11 @@ public class LiveUpdatePlugin: CAPPlugin {
         config.publicKey = getConfig().getString("publicKey", config.publicKey)
         config.readyTimeout = getConfig().getInt("readyTimeout", config.readyTimeout)
         config.resetOnUpdate = getConfig().getBoolean("resetOnUpdate", config.resetOnUpdate)
+        config.serverDomain = getConfig().getString("serverDomain", config.serverDomain) ?? config.serverDomain
+        // Map the deprecated `location` option to `serverDomain` if `serverDomain` was not explicitly set.
+        if config.serverDomain == "api.cloud.capawesome.io", config.location == "eu" {
+            config.serverDomain = "api.cloud.capawesome.eu"
+        }
 
         return config
     }

package/ios/Plugin/LiveUpdatePreferences.swift

@@ -1,10 +1,21 @@
 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 lastBundleShortVersionStringKey = "lastBundleShortVersionString" // DO NOT CHANGE
-    private let lastBundleVersionKey = "lastBundleVersion" // 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,34 @@ public class LiveUpdatePreferences: NSObject {
         return UserDefaults.standard.string(forKey: applyPrefix(to: customIdKey))
     }
 
-    public func getLastBundleShortVersionString() -> String? {
-        return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
+    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 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 getLastBundleVersion() -> String? {
-        return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleVersionKey))
+    public func setBlockedBundleIds(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: blockedBundleIdsKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: blockedBundleIdsKey))
+        }
+        UserDefaults.standard.synchronize()
     }
 
     public func setChannel(_ value: String?) {
@@ -36,20 +69,29 @@ public class LiveUpdatePreferences: NSObject {
         UserDefaults.standard.synchronize()
     }
 
-    public func setLastBundleShortVersionString(_ value: String?) {
+    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: lastBundleShortVersionStringKey))
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastVersionNameKey))
         } else {
-            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastVersionNameKey))
         }
         UserDefaults.standard.synchronize()
     }
 
-    public func setLastBundleVersion(_ value: String?) {
+    public func setPreviousBundleId(_ value: String?) {
         if let value = value {
-            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastBundleVersionKey))
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: previousBundleIdKey))
         } else {
-            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastBundleVersionKey))
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: previousBundleIdKey))
         }
         UserDefaults.standard.synchronize()
     }

package/ios/Plugin/Protocols/Api/GetChannelsResponseItem.swift

@@ -0,0 +1,4 @@
+public struct GetChannelsResponseItem: Codable {
+    var id: String
+    var name: String
+}

package/ios/Plugin/Protocols/Api/GetLatestBundleResponse.swift

@@ -2,6 +2,7 @@ public struct GetLatestBundleResponse: Codable {
     var artifactType: ArtifactType
     var bundleId: String
     var checksum: String?
+    var customProperties: [String: String]?
     var signature: String?
     var url: String
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "6.8.0",
+  "version": "6.9.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -64,11 +64,11 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "6.0.0",
-    "@capacitor/cli": "6.0.0",
-    "@capacitor/core": "6.0.0",
+    "@capacitor/android": "6.2.1",
+    "@capacitor/cli": "6.2.1",
+    "@capacitor/core": "6.2.1",
     "@capacitor/docgen": "0.3.0",
-    "@capacitor/ios": "6.0.0",
+    "@capacitor/ios": "6.2.1",
     "@ionic/eslint-config": "0.3.0",
     "@ionic/prettier-config": "2.0.0",
     "@ionic/swiftlint-config": "1.1.2",

package/ios/Plugin/LiveUpdatePlugin.h

@@ -1,10 +0,0 @@
-#import <UIKit/UIKit.h>
-
-//! Project version number for Plugin.
-FOUNDATION_EXPORT double PluginVersionNumber;
-
-//! Project version string for Plugin.
-FOUNDATION_EXPORT const unsigned char PluginVersionString[];
-
-// In this header, you should import all the public headers of your framework using statements like #import <Plugin/PublicHeader.h>
-

package/ios/Plugin/LiveUpdatePlugin.m

@@ -1,27 +0,0 @@
-#import <Foundation/Foundation.h>
-#import <Capacitor/Capacitor.h>
-
-// Define the plugin using the CAP_PLUGIN Macro, and
-// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
-CAP_PLUGIN(LiveUpdatePlugin, "LiveUpdate",
-           CAP_PLUGIN_METHOD(deleteBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(downloadBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(fetchLatestBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getBundles, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getChannel, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getCurrentBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getCustomId, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getDeviceId, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getNextBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getVersionCode, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getVersionName, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(ready, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(reload, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(reset, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setChannel, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setCustomId, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setNextBundle, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(sync, CAPPluginReturnPromise);
-)