@capgo/capacitor-updater 4.15.5 → 4.16.0

package/README.md

@@ -182,14 +182,14 @@ Notify Capacitor Updater that the current bundle is working (a rollback will occ
 ### download(...)
 
 ```typescript
-download(options: { url: string; version: string; }) => Promise<BundleInfo>
+download(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>
 ```
 
 Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files
 
-| Param         | Type                                           |
-| ------------- | ---------------------------------------------- |
-| **`options`** | <code>{ url: string; version: string; }</code> |
+| Param         | Type                                                                                   |
+| ------------- | -------------------------------------------------------------------------------------- |
+| **`options`** | <code>{ url: string; version: string; sessionKey?: string; checksum?: string; }</code> |
 
 **Returns:** <code>Promise&lt;<a href="#bundleinfo">BundleInfo</a>&gt;</code>
 

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

@@ -64,7 +64,7 @@ public class CapacitorUpdater {
   private static final String bundleDirectory = "versions";
 
   public static final String TAG = "Capacitor-updater";
-  public static final String pluginVersion = "4.15.5";
+  public static final String pluginVersion = "4.16.0";
   public static final int timeout = 20000;
 
   public SharedPreferences.Editor editor;
@@ -281,6 +281,12 @@ public class CapacitorUpdater {
             checksum
           );
           if (dest == null) {
+            final JSObject ret = new JSObject();
+            ret.put(
+              "version",
+              CapacitorUpdater.this.getCurrentBundle().getVersionName()
+            );
+            CapacitorUpdater.this.notifyListeners("downloadFailed", ret);
             CapacitorUpdater.this.sendStats(
                 "download_fail",
                 CapacitorUpdater.this.getCurrentBundle().getVersionName()
@@ -354,6 +360,12 @@ public class CapacitorUpdater {
       }
     } catch (IOException e) {
       e.printStackTrace();
+      final JSObject ret = new JSObject();
+      ret.put(
+        "version",
+        CapacitorUpdater.this.getCurrentBundle().getVersionName()
+      );
+      CapacitorUpdater.this.notifyListeners("downloadFailed", ret);
       CapacitorUpdater.this.sendStats(
           "download_fail",
           CapacitorUpdater.this.getCurrentBundle().getVersionName()
@@ -516,7 +528,8 @@ public class CapacitorUpdater {
   public BundleInfo download(
     final String url,
     final String version,
-    final String sessionKey
+    final String sessionKey,
+    final String checksum
   ) throws IOException {
     final String id = this.randomString(10);
     this.saveBundleInfo(
@@ -534,7 +547,6 @@ public class CapacitorUpdater {
     this.notifyDownload(id, 5);
     final String dest = this.randomString(10);
     final File downloaded = this.downloadFile(id, url, dest);
-    final String checksum = this.getChecksum(downloaded);
     this.finishDownload(id, dest, version, sessionKey, checksum, false);
     BundleInfo info = new BundleInfo(
       id,

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

@@ -324,6 +324,7 @@ public class CapacitorUpdaterPlugin
     final String url = call.getString("url");
     final String version = call.getString("version");
     final String sessionKey = call.getString("sessionKey", "");
+    final String checksum = call.getString("checksum", "");
     if (url == null) {
       Log.e(CapacitorUpdater.TAG, "Download called without url");
       call.reject("Download called without url");
@@ -345,8 +346,10 @@ public class CapacitorUpdaterPlugin
                 CapacitorUpdaterPlugin.this.implementation.download(
                     url,
                     version,
-                    sessionKey
+                    sessionKey,
+                    checksum
                   );
+
               call.resolve(downloaded.toJSON());
             } catch (final IOException e) {
               Log.e(CapacitorUpdater.TAG, "Failed to download from: " + url, e);

package/dist/docs.json

@@ -28,12 +28,12 @@
       },
       {
         "name": "download",
-        "signature": "(options: { url: string; version: string; }) => Promise<BundleInfo>",
+        "signature": "(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ url: string; version: string; }"
+            "type": "{ url: string; version: string; sessionKey?: string | undefined; checksum?: string | undefined; }"
           }
         ],
         "returns": "Promise<BundleInfo>",

package/dist/esm/definitions.d.ts

@@ -221,6 +221,8 @@ export interface CapacitorUpdaterPlugin {
     download(options: {
         url: string;
         version: string;
+        sessionKey?: string;
+        checksum?: string;
     }): Promise<BundleInfo>;
     /**
      * Set the next bundle to be used when the app is reloaded.

package/ios/Plugin/CapacitorUpdater.swift

@@ -335,7 +335,7 @@ extension CustomError: LocalizedError {
 
     private func decryptFile(filePath: URL, sessionKey: String) throws {
         if self.privateKey == "" || sessionKey == "" {
-            print("\(self.TAG) Cannot fond privateKey or sessionKey")
+            print("\(self.TAG) Cannot found privateKey or sessionKey")
             return
         }
         do {
@@ -345,7 +345,10 @@ extension CustomError: LocalizedError {
             }
 
             let sessionKeyArray: [String] = sessionKey.components(separatedBy: ":")
-            let ivData: Data = Data(base64Encoded: sessionKeyArray[0])!
+            guard let ivData: Data = Data(base64Encoded: sessionKeyArray[0]) else {
+                print("cannot decode sessionKey", sessionKey)
+                return
+            }
             let sessionKeyDataEncrypted: Data = Data(base64Encoded: sessionKeyArray[1])!
             let sessionKeyDataDecrypted: Data = rsaPrivateKey.decrypt(data: sessionKeyDataEncrypted)!
             let aesPrivateKey: AES128Key = AES128Key(iv: ivData, aes128Key: sessionKeyDataDecrypted)
@@ -441,6 +444,7 @@ extension CustomError: LocalizedError {
         let semaphore: DispatchSemaphore = DispatchSemaphore(value: 0)
         let id: String = self.randomString(length: 10)
         var checksum: String = ""
+
         var mainError: NSError?
         let destination: DownloadRequest.Destination = { _, _ in
             let documentsURL: URL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -111,12 +111,23 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             return
         }
         let sessionKey = call.getString("sessionKey", "")
+        let checksum = call.getString("checksum", "")
         let url = URL(string: urlString)
         print("\(self.implementation.TAG) Downloading \(url!)")
         DispatchQueue.global(qos: .background).async {
             do {
-                let res = try self.implementation.download(url: url!, version: version, sessionKey: sessionKey)
-                call.resolve(res.toJSON())
+                let next = try self.implementation.download(url: url!, version: version, sessionKey: sessionKey)
+                if checksum != "" && next.getChecksum() != checksum {
+                    print("\(self.implementation.TAG) Error checksum", next.getChecksum(), checksum)
+                    self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
+                    let resDel = self.implementation.delete(id: next.getId())
+                    if !resDel {
+                        print("\(self.implementation.TAG) Delete failed, id \(next.getId()) doesn't exist")
+                    }
+                    return
+                }
+                self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()])
+                call.resolve(next.toJSON())
             } catch {
                 print("\(self.implementation.TAG) Failed to download from: \(url!) \(error.localizedDescription)")
                 self.notifyListeners("downloadFailed", data: ["version": version])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.15.5",
+  "version": "4.16.0",
   "packageManager": "pnpm@7.21.0",
   "license": "LGPL-3.0-only",
   "description": "Live update for capacitor apps",