@capawesome/capacitor-live-update 6.5.0 → 6.7.0

package/ios/Plugin/Classes/Results/FetchLatestBundle.swift

@@ -0,0 +1,28 @@
+import Foundation
+import Capacitor
+
+@objc public class FetchLatestBundleResult: NSObject, Result {
+    private let artifactType: ArtifactType?
+    private let bundleId: String?
+    private let downloadUrl: String?
+
+    init(artifactType: ArtifactType?, bundleId: String?, downloadUrl: String?) {
+        self.artifactType = artifactType
+        self.bundleId = bundleId
+        self.downloadUrl = downloadUrl
+    }
+
+    public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        if artifactType == .manifest {
+            result["artifactType"] = "manifest"
+        } else if artifactType == .zip {
+            result["artifactType"] = "zip"
+        }
+        result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        if let downloadUrl = downloadUrl {
+            result["downloadUrl"] = downloadUrl
+        }
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Results/GetCurrentBundleResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class GetCurrentBundleResult: NSObject, Result {
+    let bundleId: String?
+
+    init(bundleId: String?) {
+        self.bundleId = bundleId
+    }
+
+    public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Results/GetNextBundleResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class GetNextBundleResult: NSObject, Result {
+    let bundleId: String?
+
+    init(bundleId: String?) {
+        self.bundleId = bundleId
+    }
+
+    public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        return result as AnyObject
+    }
+}

package/ios/Plugin/LiveUpdate.swift

@@ -4,7 +4,7 @@ import SSZipArchive
 import Capacitor
 import Alamofire
 import CommonCrypto
- 
+
 // swiftlint:disable type_body_length
 @objc public class LiveUpdate: NSObject {
     private let bundlesDirectory = "NoCloud/ionic_built_snapshots" // DO NOT CHANGE! (See https://dub.sh/BLluidt)
@@ -61,6 +61,7 @@ import CommonCrypto
     }
 
     @objc public func downloadBundle(_ options: DownloadBundleOptions) async throws {
+        let artifactType = options.getArtifactType()
         let bundleId = options.getBundleId()
         let checksum = options.getChecksum()
         let url = options.getUrl()
@@ -71,7 +72,16 @@ import CommonCrypto
         }
 
         // Download the bundle
-        try await downloadBundleOfTypeZip(bundleId: bundleId, url: url, checksum: checksum)
+        if artifactType == .manifest {
+            try await downloadBundleOfTypeManifest(bundleId: bundleId, url: url)
+        } else {
+            try await downloadBundleOfTypeZip(bundleId: bundleId, url: url, checksum: checksum)
+        }
+    }
+
+    @objc public func fetchLatestBundle(_ options: FetchLatestBundleOptions) async throws -> FetchLatestBundleResult {
+        let response: GetLatestBundleResponse? = try await self.fetchLatestBundle(options)
+        return FetchLatestBundleResult(artifactType: response?.artifactType, bundleId: response?.bundleId, downloadUrl: response?.url)
     }
 
     @objc public func getBundle(completion: @escaping (Result?, Error?) -> Void) {
@@ -95,6 +105,15 @@ import CommonCrypto
         completion(result, nil)
     }
 
+    @objc public func getCurrentBundle(completion: @escaping (Result?, Error?) -> Void) {
+        var bundleId = getCurrentBundleId()
+        if bundleId == defaultWebAssetDir {
+            bundleId = nil
+        }
+        let result = GetCurrentBundleResult(bundleId: bundleId)
+        completion(result, nil)
+    }
+
     @objc public func getCustomId(completion: @escaping (Result?, Error?) -> Void) {
         let customId = preferences.getCustomId()
 
@@ -108,6 +127,15 @@ import CommonCrypto
         completion(result, nil)
     }
 
+    @objc public func getNextBundle(completion: @escaping (Result?, Error?) -> Void) {
+        var bundleId: String? = getNextBundleId()
+        if bundleId == defaultWebAssetDir {
+            bundleId = nil
+        }
+        let result = GetNextBundleResult(bundleId: bundleId)
+        completion(result, nil)
+    }
+
     @objc public func getVersionCode(completion: @escaping (Result?, Error?) -> Void) {
         let versionCode = getVersionCode()
         let result = GetVersionCodeResult(versionCode: versionCode)
@@ -166,9 +194,29 @@ import CommonCrypto
         completion(nil)
     }
 
-    @objc public func sync() async throws -> SyncResult {
+    @objc public func setNextBundle(_ options: SetNextBundleOptions, completion: @escaping (Error?) -> Void) {
+        let bundleId = options.getBundleId()
+
+        if let bundleId = bundleId {
+            if hasBundle(bundleId: bundleId) {
+                setNextBundle(bundleId: bundleId)
+            } else {
+                let error = CustomError.bundleNotFound
+                completion(error)
+                return
+            }
+        } else {
+            reset()
+        }
+
+        completion(nil)
+    }
+
+    @objc public func sync(_ options: SyncOptions) async throws -> SyncResult {
+        let channel = options.getChannel()
         // Fetch the latest bundle
-        guard let response = try await fetchLatestBundle() else {
+        let fetchLatestBundleOptions = FetchLatestBundleOptions(channel: channel)
+        guard let response = try await fetchLatestBundle(fetchLatestBundleOptions) else {
             CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "No update available.")
             return SyncResult(nextBundleId: nil)
         }
@@ -394,12 +442,13 @@ import CommonCrypto
         try await addBundleOfTypeZip(bundleId: bundleId, zipFile: temporaryZipFileUrl)
     }
 
-    private func fetchLatestBundle() async throws -> GetLatestBundleResponse? {
+    private func fetchLatestBundle(_ options: FetchLatestBundleOptions) async throws -> GetLatestBundleResponse? {
+        let channel = options.getChannel() ?? getChannel()
         var parameters = [String: String]()
         parameters["appVersionCode"] = getVersionCode()
         parameters["appVersionName"] = getVersionName()
         parameters["bundleId"] = getCurrentBundleId()
-        parameters["channelName"] = getChannel()
+        parameters["channelName"] = channel
         parameters["customId"] = preferences.getCustomId()
         parameters["deviceId"] = getDeviceId()
         parameters["osVersion"] = await UIDevice.current.systemVersion

package/ios/Plugin/LiveUpdatePlugin.m

@@ -6,11 +6,14 @@
 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(getDeviceId, 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);
@@ -19,5 +22,6 @@ CAP_PLUGIN(LiveUpdatePlugin, "LiveUpdate",
            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);
 )

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "6.5.0"
+    public static let version = "6.6.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     private var config: LiveUpdateConfig?
@@ -33,13 +33,14 @@ public class LiveUpdatePlugin: CAPPlugin {
                 self.rejectCall(call, error)
                 return
             }
-            call.resolve()
+            self.resolveCall(call)
         })
     }
 
     @objc func downloadBundle(_ call: CAPPluginCall) {
         Task {
             do {
+                let artifactType = call.getString("artifactType", "zip")
                 guard let bundleId = call.getString("bundleId") else {
                     call.reject(CustomError.bundleIdMissing.localizedDescription)
                     return
@@ -50,10 +51,24 @@ public class LiveUpdatePlugin: CAPPlugin {
                     return
                 }
 
-                let options = DownloadBundleOptions(bundleId: bundleId, checksum: checksum, url: url)
+                let options = DownloadBundleOptions(artifactType: artifactType, bundleId: bundleId, checksum: checksum, url: url)
 
                 try await implementation?.downloadBundle(options)
-                call.resolve()
+                self.resolveCall(call)
+            } catch {
+                rejectCall(call, error)
+            }
+        }
+    }
+
+    @objc func fetchLatestBundle(_ call: CAPPluginCall) {
+        Task {
+            do {
+                let options = FetchLatestBundleOptions(call)
+                let result = try await implementation?.fetchLatestBundle(options)
+                if let result = result?.toJSObject() as? JSObject {
+                    self.resolveCall(call, result)
+                }
             } catch {
                 rejectCall(call, error)
             }
@@ -67,7 +82,7 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
             }
         })
     }
@@ -79,7 +94,7 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
             }
         })
     }
@@ -91,7 +106,19 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
+    @objc func getCurrentBundle(_ call: CAPPluginCall) {
+        implementation?.getCurrentBundle(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
             }
         })
     }
@@ -103,7 +130,7 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
             }
         })
     }
@@ -115,7 +142,19 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
+            }
+        })
+    }
+
+    @objc func getNextBundle(_ call: CAPPluginCall) {
+        implementation?.getNextBundle(completion: { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            if let result = result?.toJSObject() as? JSObject {
+                self.resolveCall(call, result)
             }
         })
     }
@@ -127,7 +166,7 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
             }
         })
     }
@@ -139,24 +178,24 @@ public class LiveUpdatePlugin: CAPPlugin {
                 return
             }
             if let result = result?.toJSObject() as? JSObject {
-                call.resolve(result)
+                self.resolveCall(call, result)
             }
         })
     }
 
     @objc func ready(_ call: CAPPluginCall) {
         implementation?.ready()
-        call.resolve()
+        resolveCall(call)
     }
 
     @objc func reload(_ call: CAPPluginCall) {
         implementation?.reload()
-        call.resolve()
+        resolveCall(call)
     }
 
     @objc func reset(_ call: CAPPluginCall) {
         implementation?.reset()
-        call.resolve()
+        resolveCall(call)
     }
 
     @objc func setBundle(_ call: CAPPluginCall) {
@@ -172,8 +211,8 @@ public class LiveUpdatePlugin: CAPPlugin {
                 self.rejectCall(call, error)
                 return
             }
+            self.resolveCall(call)
         })
-        call.resolve()
     }
 
     @objc func setChannel(_ call: CAPPluginCall) {
@@ -186,8 +225,8 @@ public class LiveUpdatePlugin: CAPPlugin {
                 self.rejectCall(call, error)
                 return
             }
+            self.resolveCall(call)
         })
-        call.resolve()
     }
 
     @objc func setCustomId(_ call: CAPPluginCall) {
@@ -203,14 +242,25 @@ public class LiveUpdatePlugin: CAPPlugin {
                 self.rejectCall(call, error)
                 return
             }
+            self.resolveCall(call)
+        })
+    }
+
+    @objc func setNextBundle(_ call: CAPPluginCall) {
+        let options = SetNextBundleOptions(call)
+
+        implementation?.setNextBundle(options, completion: { error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call)
         })
-        call.resolve()
     }
 
     @objc func sync(_ call: CAPPluginCall) {
         Task {
             do {
-
                 guard let _ = config?.appId else {
                     call.reject(CustomError.appIdMissing.localizedDescription)
                     return
@@ -222,10 +272,11 @@ public class LiveUpdatePlugin: CAPPlugin {
                 }
                 syncInProgress = true
 
-                let result = try await implementation?.sync()
+                let options = SyncOptions(call)
+                let result = try await implementation?.sync(options)
                 self.syncInProgress = false
                 if let result = result?.toJSObject() as? JSObject {
-                    call.resolve(result)
+                    resolveCall(call, result)
                 }
             } catch {
                 self.syncInProgress = false
@@ -260,4 +311,12 @@ public class LiveUpdatePlugin: CAPPlugin {
         }
         call.reject(message)
     }
+
+    private func resolveCall(_ call: CAPPluginCall) {
+        call.resolve()
+    }
+
+    private func resolveCall(_ call: CAPPluginCall, _ result: JSObject) {
+        call.resolve(result)
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "6.5.0",
+  "version": "6.7.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -67,7 +67,7 @@
     "@capacitor/android": "6.0.0",
     "@capacitor/cli": "6.0.0",
     "@capacitor/core": "6.0.0",
-    "@capacitor/docgen": "0.0.17",
+    "@capacitor/docgen": "0.3.0",
     "@capacitor/ios": "6.0.0",
     "@ionic/eslint-config": "0.3.0",
     "@ionic/prettier-config": "2.0.0",