@capawesome/capacitor-live-update 8.1.0 → 8.2.0

package/ios/Plugin/Enums/CustomError.swift

@@ -6,6 +6,7 @@ public enum CustomError: Error {
     case bundleIdMissing
     case bundleIndexHtmlMissing
     case bundleNotFound
+    case channelDiscoveryNotEnabled
     case channelMissing
     case checksumCalculationFailed
     case checksumMismatch
@@ -32,6 +33,8 @@ extension CustomError: LocalizedError {
             return NSLocalizedString("The bundle does not contain an index.html file.", comment: "bundleIndexHtmlMissing")
         case .bundleNotFound:
             return NSLocalizedString("bundle not found.", comment: "bundleNotFound")
+        case .channelDiscoveryNotEnabled:
+            return NSLocalizedString("Unauthorized. Channel Discovery may not be enabled for this app.", comment: "channelDiscoveryNotEnabled")
         case .channelMissing:
             return NSLocalizedString("channel must be provided.", comment: "channelMissing")
         case .checksumCalculationFailed:

package/ios/Plugin/LiveUpdate.swift

@@ -34,6 +34,9 @@ import CommonCrypto
         // Check version and reset config if version changed
         checkAndResetConfigIfVersionChanged()
 
+        // Set the device ID on the HTTP client (after any potential config reset)
+        self.httpClient.setDeviceId(getDeviceId())
+
         // Start the rollback timer to rollback to the default bundle
         // if the app is not ready after a certain time
         startRollbackTimer()
@@ -80,6 +83,39 @@ import CommonCrypto
         }
     }
 
+    @objc public func fetchChannels(_ options: FetchChannelsOptions) async throws -> FetchChannelsResult {
+        var parameters = [String: String]()
+        if let limit = options.getLimit() {
+            parameters["limit"] = String(limit)
+        }
+        if let offset = options.getOffset() {
+            parameters["offset"] = String(offset)
+        }
+        if let query = options.getQuery() {
+            parameters["query"] = query
+        }
+        var urlComponents = URLComponents(string: "https://\(config.serverDomain)/v1/apps/\(getAppId() ?? "")/channels")!
+        if !parameters.isEmpty {
+            urlComponents.queryItems = parameters.map { URLQueryItem(name: $0.key, value: $0.value) }
+        }
+        let url = try urlComponents.asURL()
+        let response = try await self.httpClient.request(url: url, type: [GetChannelsResponseItem].self)
+        if let error = response.error {
+            if response.response?.statusCode == 401 {
+                throw CustomError.channelDiscoveryNotEnabled
+            }
+            if let urlError = error.underlyingError as? URLError {
+                if urlError.code == .timedOut {
+                    throw urlError
+                }
+            }
+            throw error
+        }
+        let items = response.value ?? []
+        let channels = items.map { ChannelResult(id: $0.id, name: $0.name) }
+        return FetchChannelsResult(channels: channels)
+    }
+
     @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, checksum: response?.checksum, customProperties: response?.customProperties, downloadUrl: response?.url, signature: response?.signature)
@@ -604,12 +640,19 @@ import CommonCrypto
         if let _ = config.defaultChannel {
             channel = config.defaultChannel
         }
+        if let nativeChannel = getNativeChannel() {
+            channel = nativeChannel
+        }
         if let _ = preferences.getChannel() {
             channel = preferences.getChannel()
         }
         return channel
     }
 
+    private func getNativeChannel() -> String? {
+        return Bundle.main.object(forInfoDictionaryKey: "CapawesomeLiveUpdateDefaultChannel") as? String
+    }
+
     /// - Returns: The sha256 checksum of the file at the given URL.
     private func getChecksumForFile(url: URL) throws -> String {
         let handle = try FileHandle(forReadingFrom: url)

package/ios/Plugin/LiveUpdateHttpClient.swift

@@ -5,6 +5,7 @@ import Alamofire
 public class LiveUpdateHttpClient: NSObject {
 
     private let config: LiveUpdateConfig
+    private var deviceId: String?
 
     public static func getChecksumFromResponse(response: HTTPURLResponse) -> String? {
         guard let headers = response.allHeaderFields as? [String: String] else { return nil }
@@ -20,10 +21,17 @@ public class LiveUpdateHttpClient: NSObject {
         self.config = config
     }
 
+    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-Capawesome-Device-Id")
+        }
         return try await withCheckedThrowingContinuation { continuation in
             AF.download(request, to: destination).downloadProgress { progress in
                 if let callback = callback {
@@ -39,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-Capawesome-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

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "8.1.0"
+    public static let version = "8.2.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"
@@ -17,6 +17,7 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         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: "getBundles", returnType: CAPPluginReturnPromise),
@@ -111,6 +112,25 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    @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 {

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -71,7 +71,6 @@
     "@capacitor/docgen": "0.3.1",
     "@capacitor/ios": "8.0.0",
     "@ionic/eslint-config": "0.4.0",
-    "@ionic/swiftlint-config": "2.0.0",
     "eslint": "8.57.0",
     "prettier": "3.4.2",
     "prettier-plugin-java": "2.6.7",
@@ -83,7 +82,6 @@
   "peerDependencies": {
     "@capacitor/core": ">=8.0.0"
   },
-  "swiftlint": "@ionic/swiftlint-config",
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"
   },