@capgo/capacitor-updater 4.9.1 → 4.10.0

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java

@@ -1,6 +1,7 @@
 package ee.forgr.capacitor_updater;
 
 import android.content.SharedPreferences;
+import android.os.Build;
 import android.util.Log;
 import com.android.volley.Request;
 import com.android.volley.RequestQueue;
@@ -51,7 +52,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.9.1";
+    public static final String pluginVersion = "4.10.0";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;
@@ -77,6 +78,30 @@ public class CapacitorUpdater {
         }
     };
 
+    private boolean isProd() {
+        return !BuildConfig.DEBUG;
+    }
+
+    private boolean isEmulator() {
+        return (Build.BRAND.startsWith("generic") && Build.DEVICE.startsWith("generic"))
+                || Build.FINGERPRINT.startsWith("generic")
+                || Build.FINGERPRINT.startsWith("unknown")
+                || Build.HARDWARE.contains("goldfish")
+                || Build.HARDWARE.contains("ranchu")
+                || Build.MODEL.contains("google_sdk")
+                || Build.MODEL.contains("Emulator")
+                || Build.MODEL.contains("Android SDK built for x86")
+                || Build.MANUFACTURER.contains("Genymotion")
+                || Build.PRODUCT.contains("sdk_google")
+                || Build.PRODUCT.contains("google_sdk")
+                || Build.PRODUCT.contains("sdk")
+                || Build.PRODUCT.contains("sdk_x86")
+                || Build.PRODUCT.contains("sdk_gphone64_arm64")
+                || Build.PRODUCT.contains("vbox86p")
+                || Build.PRODUCT.contains("emulator")
+                || Build.PRODUCT.contains("simulator");
+    }
+
     private int calcTotalPercent(final int percent, final int min, final int max) {
         return (percent * (max - min)) / 100 + min;
     }
@@ -358,18 +383,25 @@ public class CapacitorUpdater {
         }
     }
 
+    private JSONObject createInfoObject() throws JSONException {
+        JSONObject json = new JSONObject();
+        json.put("platform", "android");
+        json.put("device_id", this.deviceID);
+        json.put("app_id", this.appId);
+        json.put("custom_id", this.customId);
+        json.put("version_build", this.versionBuild);
+        json.put("version_code", this.versionCode);
+        json.put("version_os", this.versionOs);
+        json.put("version_name", this.getCurrentBundle().getVersionName());
+        json.put("plugin_version", this.pluginVersion);
+        json.put("is_emulator", this.isEmulator());
+        json.put("is_prod", this.isProd());
+        return json;
+    }
+
     public void getLatest(final String updateUrl, final Callback callback) {
         try {
-            JSONObject json = new JSONObject();
-            json.put("platform", "android");
-            json.put("device_id", this.deviceID);
-            json.put("custom_id", this.customId);
-            json.put("app_id", this.appId);
-            json.put("version_build", this.versionBuild);
-            json.put("version_code", this.versionCode);
-            json.put("version_os", this.versionOs);
-            json.put("version_name", this.getCurrentBundle().getVersionName());
-            json.put("plugin_version", CapacitorUpdater.pluginVersion);
+            JSONObject json = this.createInfoObject();
 
             Log.i(CapacitorUpdater.TAG, "Auto-update parameters: " + json);
             // Building a request
@@ -403,16 +435,7 @@ public class CapacitorUpdater {
             return;
         }
         try {
-            JSONObject json = new JSONObject();
-            json.put("platform", "android");
-            json.put("device_id", this.deviceID);
-            json.put("custom_id", this.customId);
-            json.put("app_id", this.appId);
-            json.put("version_build", this.versionBuild);
-            json.put("version_code", this.versionCode);
-            json.put("version_os", this.versionOs);
-            json.put("version_name", this.getCurrentBundle().getVersionName());
-            json.put("plugin_version", pluginVersion);
+            JSONObject json = this.createInfoObject();
             json.put("channel", channel);
 
             // Building a request
@@ -459,16 +482,7 @@ public class CapacitorUpdater {
             return;
         }
         try {
-            JSONObject json = new JSONObject();
-            json.put("platform", "android");
-            json.put("device_id", this.deviceID);
-            json.put("custom_id", this.customId);
-            json.put("app_id", this.appId);
-            json.put("version_build", this.versionBuild);
-            json.put("version_code", this.versionCode);
-            json.put("version_os", this.versionOs);
-            json.put("version_name", this.getCurrentBundle().getVersionName());
-            json.put("plugin_version", pluginVersion);
+            JSONObject json = this.createInfoObject();
 
             // Building a request
             JsonObjectRequest request = new JsonObjectRequest(
@@ -514,16 +528,7 @@ public class CapacitorUpdater {
             return;
         }
         try {
-            JSONObject json = new JSONObject();
-            json.put("platform", "android");
-            json.put("device_id", this.deviceID);
-            json.put("custom_id", this.customId);
-            json.put("app_id", this.appId);
-            json.put("version_build", this.versionBuild);
-            json.put("version_code", this.versionCode);
-            json.put("version_os", this.versionOs);
-            json.put("version_name", versionName);
-            json.put("plugin_version", pluginVersion);
+            JSONObject json = this.createInfoObject();
             json.put("action", action);
 
             // Building a request

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java

@@ -62,10 +62,6 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
     @Override
     public void load() {
         super.load();
-        final Boolean allowEmulatorProd = this.getConfig().getBoolean("allowEmulatorProd", true);
-        if (!allowEmulatorProd && this.isEmulator() && this.isProd()) {
-            return;
-        }
         this.prefs = this.getContext().getSharedPreferences(WebView.WEBVIEW_PREFS_NAME, Activity.MODE_PRIVATE);
         this.editor = this.prefs.edit();
 
@@ -118,30 +114,6 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         this._checkCancelDelay(true);
     }
 
-    private boolean isProd() {
-        return !BuildConfig.DEBUG;
-    }
-
-    private boolean isEmulator() {
-        return (Build.BRAND.startsWith("generic") && Build.DEVICE.startsWith("generic"))
-                || Build.FINGERPRINT.startsWith("generic")
-                || Build.FINGERPRINT.startsWith("unknown")
-                || Build.HARDWARE.contains("goldfish")
-                || Build.HARDWARE.contains("ranchu")
-                || Build.MODEL.contains("google_sdk")
-                || Build.MODEL.contains("Emulator")
-                || Build.MODEL.contains("Android SDK built for x86")
-                || Build.MANUFACTURER.contains("Genymotion")
-                || Build.PRODUCT.contains("sdk_google")
-                || Build.PRODUCT.contains("google_sdk")
-                || Build.PRODUCT.contains("sdk")
-                || Build.PRODUCT.contains("sdk_x86")
-                || Build.PRODUCT.contains("sdk_gphone64_arm64")
-                || Build.PRODUCT.contains("vbox86p")
-                || Build.PRODUCT.contains("emulator")
-                || Build.PRODUCT.contains("simulator");
-    }
-
     private void cleanupObsoleteVersions() {
         try {
             final Version previous = new Version(this.prefs.getString("LatestVersionNative", ""));
@@ -234,9 +206,9 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                         @Override
                         public void run() {
                             CapacitorUpdaterPlugin.this.implementation.setChannel(channel,
-                                res -> {
-                                    call.resolve(res);
-                                });
+                                    res -> {
+                                        call.resolve(res);
+                                    });
                         }
                     }
             )
@@ -256,9 +228,9 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                         @Override
                         public void run() {
                             CapacitorUpdaterPlugin.this.implementation.getChannel(
-                                res -> {
-                                    call.resolve(res);
-                                });
+                                    res -> {
+                                        call.resolve(res);
+                                    });
                         }
                     }
             )

package/dist/docs.json

@@ -1907,22 +1907,6 @@
           "docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
           "complexTypes": [],
           "type": "string | undefined"
-        },
-        {
-          "name": "allowEmulatorProd",
-          "tags": [
-            {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "false",
-              "name": "example"
-            }
-          ],
-          "docs": "Allow the plugin to automatically check for updates on app launch on emulator devices in production app.\n\nThis is useful for CI/CD who send builds to google at each commit.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
         }
       ],
       "docs": "These configuration values are available:"

package/dist/esm/definitions.d.ts

@@ -68,15 +68,6 @@ declare module '@capacitor/cli' {
              * @example https://example.com/api/stats
              */
             statsUrl?: string;
-            /**
-             * Allow the plugin to automatically check for updates on app launch on emulator devices in production app.
-             *
-             * This is useful for CI/CD who send builds to google at each commit.
-             *
-             * @default true
-             * @example false
-             */
-            allowEmulatorProd?: boolean;
         };
     }
 }

package/ios/Plugin/CapacitorUpdater.swift

@@ -60,6 +60,21 @@ extension GetChannel {
         return dict
     }
 }
+struct InfoObject : Codable {
+    let platform : String?
+    let device_id : String?
+    let app_id : String?
+    let custom_id : String?
+    let version_build : String?
+    let version_code : String?
+    let version_os : String?
+    let version_name : String?
+    let plugin_version : String?
+    let is_emulator : Bool?
+    let is_prod : Bool?
+    var action : String?
+    var channel : String?
+}
 struct AppVersionDec: Decodable {
     let version: String?
     let checksum: String?
@@ -193,7 +208,7 @@ extension CustomError: LocalizedError {
     public let TAG = "✨  Capacitor-updater:"
     public let CAP_SERVER_PATH = "serverBasePath"
     public var customId = ""
-    public let pluginVersion = "4.9.1"
+    public let pluginVersion = "4.10.0"
     public var statsUrl = ""
     public var channelUrl = ""
     public var appId = ""
@@ -210,6 +225,40 @@ extension CustomError: LocalizedError {
         return String((0..<length).map { _ in letters.randomElement()! })
     }
 
+    private func isProd() -> Bool {
+        return !self.isAppStoreReceiptSandbox() && !self.hasEmbeddedMobileProvision()
+    }
+
+    // MARK: Private
+    private func hasEmbeddedMobileProvision() -> Bool {
+        guard Bundle.main.path(forResource: "embedded", ofType: "mobileprovision") == nil else {
+            return true
+        }
+        return false
+    }
+    
+    private func isAppStoreReceiptSandbox() -> Bool {
+        
+        if isEmulator() {
+            return false
+        } else {
+            guard let url = Bundle.main.appStoreReceiptURL else {
+                return false
+            }
+            guard url.lastPathComponent == "sandboxReceipt" else {
+                return false
+            }
+            return true
+        }
+    }
+
+    private func isEmulator() -> Bool {
+        #if targetEnvironment(simulator)
+            return true
+        #else
+            return false
+        #endif
+    }
     // Persistent path /var/mobile/Containers/Data/Application/8C0C07BE-0FD3-4FD4-B7DF-90A88E12B8C3/Library/NoCloud/ionic_built_snapshots/FOLDER
     // Hot Reload path /var/mobile/Containers/Data/Application/8C0C07BE-0FD3-4FD4-B7DF-90A88E12B8C3/Documents/FOLDER
     // Normal /private/var/containers/Bundle/Application/8C0C07BE-0FD3-4FD4-B7DF-90A88E12B8C3/App.app/public
@@ -274,20 +323,28 @@ extension CustomError: LocalizedError {
         }
     }
 
+    private func createInfoObject() -> InfoObject {
+        return InfoObject(
+            platform: "ios",
+            device_id: self.deviceID,
+            app_id: self.appId,
+            custom_id: self.customId,
+            version_build: self.versionName,
+            version_code: self.versionCode,
+            version_os: self.versionOs,
+            version_name: self.getCurrentBundle().getVersionName(),
+            plugin_version: self.pluginVersion,
+            is_emulator: self.isEmulator(),
+            is_prod: self.isProd(),
+            action: nil,
+            channel: nil
+        )
+    }
+
     public func getLatest(url: URL) -> AppVersion {
         let semaphore = DispatchSemaphore(value: 0)
         let latest = AppVersion()
-        let parameters: [String: String] = [
-            "platform": "ios",
-            "device_id": self.deviceID,
-            "app_id": self.appId,
-            "custom_id": self.customId,
-            "version_build": self.versionName,
-            "version_code": self.versionCode,
-            "version_os": self.versionOs,
-            "plugin_version": self.pluginVersion,
-            "version_name": self.getCurrentBundle().getVersionName()
-        ]
+        let parameters: InfoObject = self.createInfoObject()
         print("\(self.TAG) Auto-update parameters: \(parameters)")
         let request = AF.request(url, method: .post, parameters: parameters, encoder: JSONParameterEncoder.default)
 
@@ -510,18 +567,9 @@ extension CustomError: LocalizedError {
         }
         let semaphore = DispatchSemaphore(value: 0)
         let setChannel = SetChannel()
-        let parameters: [String: String] = [
-            "platform": "ios",
-            "device_id": self.deviceID,
-            "custom_id": self.customId,
-            "version_name": self.getCurrentBundle().getVersionName(),
-            "version_build": self.versionName,
-            "version_code": self.versionCode,
-            "version_os": self.versionOs,
-            "plugin_version": self.pluginVersion,
-            "channel": channel,
-            "app_id": self.appId
-        ]
+        var parameters: InfoObject = self.createInfoObject()
+        parameters.channel = channel
+
         let request = AF.request(self.channelUrl, method: .post, parameters: parameters, encoder: JSONParameterEncoder.default)
 
         request.validate().responseDecodable(of: SetChannelDec.self) { response in
@@ -548,17 +596,7 @@ extension CustomError: LocalizedError {
         }
         let semaphore = DispatchSemaphore(value: 0)
         let getChannel = GetChannel()
-        let parameters: [String: String] = [
-            "platform": "ios",
-            "device_id": self.deviceID,
-            "custom_id": self.customId,
-            "version_name": self.getCurrentBundle().getVersionName(),
-            "version_build": self.versionName,
-            "version_code": self.versionCode,
-            "version_os": self.versionOs,
-            "plugin_version": self.pluginVersion,
-            "app_id": self.appId
-        ]
+        let parameters: InfoObject = self.createInfoObject()
         let request = AF.request(self.channelUrl, method: .put, parameters: parameters, encoder: JSONParameterEncoder.default)
 
         request.validate().responseDecodable(of: GetChannelDec.self) { response in
@@ -589,18 +627,8 @@ extension CustomError: LocalizedError {
         if self.statsUrl == "" {
             return
         }
-        let parameters: [String: String] = [
-            "platform": "ios",
-            "action": action,
-            "device_id": self.deviceID,
-            "custom_id": self.customId,
-            "version_name": versionName,
-            "version_build": self.versionName,
-            "version_code": self.versionCode,
-            "version_os": self.versionOs,
-            "plugin_version": self.pluginVersion,
-            "app_id": self.appId
-        ]
+        var parameters: InfoObject = self.createInfoObject()
+        parameters.action = action
         DispatchQueue.global(qos: .background).async {
             let request = AF.request(self.statsUrl, method: .post, parameters: parameters, encoder: JSONParameterEncoder.default)
             request.responseData { response in

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -26,10 +26,6 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
     private var taskRunning = false
 
     override public func load() {
-        let allowEmulatorProd = getConfig().getBoolean("allowEmulatorProd", true)
-        if (!allowEmulatorProd && self.isEmulator() && (self.isAppStoreReceiptSandbox() || self.hasEmbeddedMobileProvision())) {
-            return
-        }
         print("\(self.implementation.TAG) init for device \(self.implementation.deviceID)")
         do {
             currentVersionNative = try Version(Bundle.main.versionName ?? "0.0.0")
@@ -61,37 +57,6 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         self.appMovedToForeground()
     }
 
-    // MARK: Private
-    private func hasEmbeddedMobileProvision() -> Bool {
-        guard Bundle.main.path(forResource: "embedded", ofType: "mobileprovision") == nil else {
-            return true
-        }
-        return false
-    }
-    
-    private func isAppStoreReceiptSandbox() -> Bool {
-        
-        if isEmulator() {
-            return false
-        } else {
-            guard let url = Bundle.main.appStoreReceiptURL else {
-                return false
-            }
-            guard url.lastPathComponent == "sandboxReceipt" else {
-                return false
-            }
-            return true
-        }
-    }
-
-    private func isEmulator() -> Bool {
-        #if targetEnvironment(simulator)
-            return true
-        #else
-            return false
-        #endif
-    }
-
     private func cleanupObsoleteVersions() {
         var LatestVersionNative: Version = "0.0.0"
         do {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.9.1",
+  "version": "4.10.0",
   "license": "LGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",