@capawesome/capacitor-live-update 6.7.2 → 7.0.0

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -6,11 +6,36 @@ 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.7.2"
+    public static let version = "7.0.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
+    public let identifier = "LiveUpdatePlugin"
+    public let jsName = "LiveUpdate"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "deleteBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "downloadBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "fetchLatestBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getBundles", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getChannel", 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: "ready", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "reload", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "reset", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setChannel", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setCustomId", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setNextBundle", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "sync", returnType: CAPPluginReturnPromise)
+    ]
+
+    private let eventDownloadBundleProgess = "downloadBundleProgress"
+
     private var config: LiveUpdateConfig?
     private var implementation: LiveUpdate?
     private var syncInProgress = false
@@ -45,13 +70,12 @@ public class LiveUpdatePlugin: CAPPlugin {
                     call.reject(CustomError.bundleIdMissing.localizedDescription)
                     return
                 }
-                let checksum = call.getString("checksum")
                 guard let url = call.getString("url") else {
                     call.reject(CustomError.urlMissing.localizedDescription)
                     return
                 }
 
-                let options = DownloadBundleOptions(artifactType: artifactType, bundleId: bundleId, checksum: checksum, url: url)
+                let options = DownloadBundleOptions(artifactType: artifactType, bundleId: bundleId, url: url)
 
                 try await implementation?.downloadBundle(options)
                 self.resolveCall(call)
@@ -75,18 +99,6 @@ public class LiveUpdatePlugin: CAPPlugin {
         }
     }
 
-    @objc func getBundle(_ call: CAPPluginCall) {
-        implementation?.getBundle(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 {
@@ -184,8 +196,15 @@ public class LiveUpdatePlugin: CAPPlugin {
     }
 
     @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) {
@@ -198,23 +217,6 @@ public class LiveUpdatePlugin: CAPPlugin {
         resolveCall(call)
     }
 
-    @objc func setBundle(_ call: CAPPluginCall) {
-        guard let bundleId = call.getString("bundleId") else {
-            call.reject(CustomError.bundleIdMissing.localizedDescription)
-            return
-        }
-
-        let options = SetBundleOptions(bundleId: bundleId)
-
-        implementation?.setBundle(options, completion: { error in
-            if let error = error {
-                self.rejectCall(call, error)
-                return
-            }
-            self.resolveCall(call)
-        })
-    }
-
     @objc func setChannel(_ call: CAPPluginCall) {
         let channel = call.getString("channel")
 
@@ -285,18 +287,22 @@ public class LiveUpdatePlugin: CAPPlugin {
         }
     }
 
+    func notifyDownloadBundleProgressListeners(_ event: DownloadBundleProgressEvent) {
+        if let event = event.toJSObject() as? JSObject {
+            notifyListeners(eventDownloadBundleProgess, data: event, retainUntilConsumed: false)
+        }
+    }
+
     private func liveUpdateConfig() -> LiveUpdateConfig {
         var config = LiveUpdateConfig()
 
         config.appId = getConfig().getString("appId", config.appId)
         config.autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.autoDeleteBundles)
         config.defaultChannel = getConfig().getString("defaultChannel", config.defaultChannel)
-        config.enabled = getConfig().getBoolean("enabled", config.enabled)
         config.httpTimeout = getConfig().getInt("httpTimeout", config.httpTimeout)
-        config.location = getConfig().getString("location", config.location)
         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
 
         return config
     }

package/ios/Plugin/LiveUpdatePreferences.swift

@@ -3,8 +3,7 @@ import Foundation
 public class LiveUpdatePreferences: NSObject {
     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 previousBundleIdKey = "previousBundleIdKey" // DO NOT CHANGE
 
     public func getChannel() -> String? {
         return UserDefaults.standard.string(forKey: applyPrefix(to: channelKey))
@@ -13,13 +12,9 @@ public class LiveUpdatePreferences: NSObject {
     public func getCustomId() -> String? {
         return UserDefaults.standard.string(forKey: applyPrefix(to: customIdKey))
     }
-    
-    public func getLastBundleShortVersionString() -> String? {
-        return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
-    }
 
-    public func getLastBundleVersion() -> String? {
-        return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleVersionKey))
+    public func getPreviousBundleId() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: previousBundleIdKey))
     }
 
     public func setChannel(_ value: String?) {
@@ -35,21 +30,12 @@ public class LiveUpdatePreferences: NSObject {
         UserDefaults.standard.set(value, forKey: applyPrefix(to: customIdKey))
         UserDefaults.standard.synchronize()
     }
-    
-    public func setLastBundleShortVersionString(_ value: String?) {
-        if let value = value {
-            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastBundleShortVersionStringKey))
-        } else {
-            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
-        }
-        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/GetLatestBundleResponse.swift

@@ -1,5 +1,6 @@
 public struct GetLatestBundleResponse: Codable {
     var artifactType: ArtifactType
     var bundleId: String
+    var customProperties: [String: String]?
     var url: String
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "6.7.2",
+  "version": "7.0.0",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -11,7 +11,8 @@
     "android/build.gradle",
     "dist/",
     "ios/Plugin/",
-    "CapawesomeCapacitorLiveUpdate.podspec"
+    "CapawesomeCapacitorLiveUpdate.podspec",
+    "Package.swift"
   ],
   "author": "Robin Genz <mail@robingenz.dev>",
   "license": "MIT",
@@ -56,7 +57,7 @@
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api LiveUpdatePlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
     "version": "node scripts/sync-plugin-version.mjs",
@@ -64,26 +65,24 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "6.0.0",
-    "@capacitor/cli": "6.0.0",
-    "@capacitor/core": "6.0.0",
+    "@capacitor/android": "7.0.0",
+    "@capacitor/cli": "7.0.0",
+    "@capacitor/core": "7.0.0",
     "@capacitor/docgen": "0.3.0",
-    "@capacitor/ios": "6.0.0",
-    "@ionic/eslint-config": "0.3.0",
-    "@ionic/prettier-config": "2.0.0",
-    "@ionic/swiftlint-config": "1.1.2",
-    "eslint": "7.32.0",
-    "prettier": "2.6.2",
-    "prettier-plugin-java": "1.6.1",
-    "rimraf": "3.0.2",
-    "rollup": "2.77.2",
-    "swiftlint": "1.0.1",
+    "@capacitor/ios": "7.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",
+    "rimraf": "6.0.1",
+    "rollup": "4.30.1",
+    "swiftlint": "2.0.0",
     "typescript": "4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^6.0.0"
+    "@capacitor/core": ">=7.0.0"
   },
-  "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/SetBundleOptions.java

@@ -1,18 +0,0 @@
-package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
-
-import androidx.annotation.NonNull;
-
-public class SetBundleOptions {
-
-    @NonNull
-    private String bundleId;
-
-    public SetBundleOptions(@NonNull String bundleId) {
-        this.bundleId = bundleId;
-    }
-
-    @NonNull
-    public String getBundleId() {
-        return bundleId;
-    }
-}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetBundleResult.java

@@ -1,24 +0,0 @@
-package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-import com.getcapacitor.JSArray;
-import com.getcapacitor.JSObject;
-import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
-import org.json.JSONObject;
-
-public class GetBundleResult implements Result {
-
-    @Nullable
-    private String bundleId;
-
-    public GetBundleResult(@Nullable String bundleId) {
-        this.bundleId = bundleId;
-    }
-
-    public JSObject toJSObject() {
-        JSObject result = new JSObject();
-        result.put("bundleId", bundleId == null ? JSONObject.NULL : bundleId);
-        return result;
-    }
-}

package/ios/Plugin/Classes/Options/SetBundleOptions.swift

@@ -1,14 +0,0 @@
-import Foundation
-import Capacitor
-
-@objc public class SetBundleOptions: NSObject {
-    private var bundleId: String
-
-    init(bundleId: String) {
-        self.bundleId = bundleId
-    }
-
-    func getBundleId() -> String {
-        return bundleId
-    }
-}

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

@@ -1,16 +0,0 @@
-import Foundation
-import Capacitor
-
-@objc public class GetBundleResult: 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/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);
-)