@capgo/capacitor-updater 5.2.9 → 5.2.10

package/README.md

@@ -757,6 +757,14 @@ Remove all listeners for this plugin.
 | **`version`** | <code>string</code> | Emit when a download fail. | 4.0.0 |
 
 
+#### AppReadyEvent
+
+| Prop         | Type                                              | Description                      | Since |
+| ------------ | ------------------------------------------------- | -------------------------------- | ----- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a app is ready to use. | 5.2.0 |
+| **`status`** | <code>string</code>                               |                                  |       |
+
+
 ### Type Aliases
 
 
@@ -812,7 +820,7 @@ Remove all listeners for this plugin.
 
 #### AppReadyListener
 
-<code>(state: void): void</code>
+<code>(state: <a href="#appreadyevent">AppReadyEvent</a>): void</code>
 
 </docgen-api>
 

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

@@ -56,7 +56,7 @@ public class CapacitorUpdaterPlugin
   private static final String channelUrlDefault =
     "https://api.capgo.app/channel_self";
 
-  private final String PLUGIN_VERSION = "5.2.9";
+  private final String PLUGIN_VERSION = "5.2.10";
   private static final String DELAY_CONDITION_PREFERENCES = "";
 
   private SharedPreferences.Editor editor;
@@ -177,6 +177,7 @@ public class CapacitorUpdaterPlugin
   private void directUpdateFinish(final BundleInfo latest) {
     final JSObject ret = new JSObject();
     ret.put("bundle", latest.toJSON());
+    ret.put("status", "update installed");
     CapacitorUpdaterPlugin.this.implementation.set(latest);
     CapacitorUpdaterPlugin.this._reload();
     CapacitorUpdaterPlugin.this.notifyListeners("appReady", ret);
@@ -850,6 +851,26 @@ public class CapacitorUpdaterPlugin
     }
   }
 
+  private void endBackGroundTaskWithNotif(
+    String msg,
+    String latestVersionName,
+    BundleInfo current,
+    Boolean error
+  ) {
+    if (error) {
+      this.implementation.sendStats("download_fail", current.getVersionName());
+      final JSObject ret = new JSObject();
+      ret.put("version", latestVersionName);
+      this.notifyListeners("downloadFailed", ret);
+    }
+    final JSObject ret = new JSObject();
+    ret.put("bundle", current.toJSON());
+    this.notifyListeners("noNeedUpdate", ret);
+    ret.put("message", msg);
+    this.notifyListeners("appReady", ret);
+    Log.i(CapacitorUpdater.TAG, "endBackGroundTaskWithNotif " + msg);
+  }
+
   private void backgroundDownload() {
     String messageUpdate = this.implementation.directUpdate
       ? "Update will occur now."
@@ -885,15 +906,11 @@ public class CapacitorUpdaterPlugin
                           majorAvailable
                         );
                     }
-                    final JSObject retNoNeed = new JSObject();
-                    retNoNeed.put("bundle", current.toJSON());
-                    CapacitorUpdaterPlugin.this.notifyListeners(
-                        "noNeedUpdate",
-                        retNoNeed
-                      );
-                    CapacitorUpdaterPlugin.this.notifyListeners(
-                        "appReady",
-                        retNoNeed
+                    CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                        res.getString("message"),
+                        current.getVersionName(),
+                        current,
+                        true
                       );
                     return;
                   }
@@ -905,15 +922,11 @@ public class CapacitorUpdaterPlugin
                       )
                   ) {
                     Log.e(CapacitorUpdater.TAG, "Error no url or wrong format");
-                    final JSObject retNoNeed = new JSObject();
-                    retNoNeed.put("bundle", current.toJSON());
-                    CapacitorUpdaterPlugin.this.notifyListeners(
-                        "noNeedUpdate",
-                        retNoNeed
-                      );
-                    CapacitorUpdaterPlugin.this.notifyListeners(
-                        "appReady",
-                        retNoNeed
+                    CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                        "Error no url or wrong format",
+                        current.getVersionName(),
+                        current,
+                        true
                       );
                     return;
                   }
@@ -936,15 +949,11 @@ public class CapacitorUpdaterPlugin
                           CapacitorUpdater.TAG,
                           "Latest bundle already exists, and is in error state. Aborting update."
                         );
-                        final JSObject retNoNeed = new JSObject();
-                        retNoNeed.put("bundle", current.toJSON());
-                        CapacitorUpdaterPlugin.this.notifyListeners(
-                            "noNeedUpdate",
-                            retNoNeed
-                          );
-                        CapacitorUpdaterPlugin.this.notifyListeners(
-                            "appReady",
-                            ret
+                        CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                            "Latest bundle already exists, and is in error state. Aborting update.",
+                            latestVersionName,
+                            current,
+                            true
                           );
                         return;
                       }
@@ -961,6 +970,12 @@ public class CapacitorUpdaterPlugin
                               latest
                             );
                           CapacitorUpdaterPlugin.this._reload();
+                          CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                              "Update installed",
+                              latestVersionName,
+                              latest,
+                              false
+                            );
                         } else {
                           CapacitorUpdaterPlugin.this.notifyListeners(
                               "updateAvailable",
@@ -969,11 +984,13 @@ public class CapacitorUpdaterPlugin
                           CapacitorUpdaterPlugin.this.implementation.setNextBundle(
                               latest.getId()
                             );
+                          CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                              "update downloaded, will install next background",
+                              latestVersionName,
+                              latest,
+                              false
+                            );
                         }
-                        CapacitorUpdaterPlugin.this.notifyListeners(
-                            "appReady",
-                            ret
-                          );
                         return;
                       }
                       if (latest.isDeleted()) {
@@ -1003,10 +1020,6 @@ public class CapacitorUpdaterPlugin
                           );
                         }
                       }
-                      CapacitorUpdaterPlugin.this.notifyListeners(
-                          "appReady",
-                          ret
-                        );
                     }
 
                     new Thread(
@@ -1043,27 +1056,13 @@ public class CapacitorUpdaterPlugin
                               "error downloading file",
                               e
                             );
-                            final JSObject ret = new JSObject();
-                            ret.put("version", latestVersionName);
-                            CapacitorUpdaterPlugin.this.notifyListeners(
-                                "downloadFailed",
-                                ret
-                              );
                             final BundleInfo current =
                               CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
-                            CapacitorUpdaterPlugin.this.implementation.sendStats(
-                                "download_fail",
-                                current.getVersionName()
-                              );
-                            final JSObject retNoNeed = new JSObject();
-                            retNoNeed.put("bundle", current.toJSON());
-                            CapacitorUpdaterPlugin.this.notifyListeners(
-                                "noNeedUpdate",
-                                retNoNeed
-                              );
-                            CapacitorUpdaterPlugin.this.notifyListeners(
-                                "appReady",
-                                ret
+                            CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                                "Error downloading file",
+                                latestVersionName,
+                                current,
+                                true
                               );
                           }
                         }
@@ -1077,20 +1076,20 @@ public class CapacitorUpdaterPlugin
                       current.getId() +
                       " is the latest bundle."
                     );
-                    final JSObject retNoNeed = new JSObject();
-                    retNoNeed.put("bundle", current.toJSON());
-                    CapacitorUpdaterPlugin.this.notifyListeners(
-                        "noNeedUpdate",
-                        retNoNeed
+                    CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                        "No need to update",
+                        latestVersionName,
+                        current,
+                        false
                       );
                   }
                 } catch (final JSONException e) {
                   Log.e(CapacitorUpdater.TAG, "error parsing JSON", e);
-                  final JSObject retNoNeed = new JSObject();
-                  retNoNeed.put("bundle", current.toJSON());
-                  CapacitorUpdaterPlugin.this.notifyListeners(
-                      "noNeedUpdate",
-                      retNoNeed
+                  CapacitorUpdaterPlugin.this.endBackGroundTaskWithNotif(
+                      "Error parsing JSON",
+                      current.getVersionName(),
+                      current,
+                      true
                     );
                 }
               }
@@ -1246,6 +1245,7 @@ public class CapacitorUpdaterPlugin
             public void run() {
               final JSObject ret = new JSObject();
               ret.put("bundle", current.toJSON());
+              ret.put("status", "disabled");
               CapacitorUpdaterPlugin.this.notifyListeners("appReady", ret);
             }
           },

package/dist/docs.json

@@ -1225,6 +1225,36 @@
           "type": "string"
         }
       ]
+    },
+    {
+      "name": "AppReadyEvent",
+      "slug": "appreadyevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Emit when a app is ready to use.",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -1383,8 +1413,10 @@
       "docs": "",
       "types": [
         {
-          "text": "(state: void): void",
-          "complexTypes": []
+          "text": "(state: AppReadyEvent): void",
+          "complexTypes": [
+            "AppReadyEvent"
+          ]
         }
       ]
     }

package/dist/esm/definitions.d.ts

@@ -177,6 +177,15 @@ export interface UpdateFailedEvent {
      */
     bundle: BundleInfo;
 }
+export interface AppReadyEvent {
+    /**
+     * Emit when a app is ready to use.
+     *
+     * @since  5.2.0
+     */
+    bundle: BundleInfo;
+    status: string;
+}
 export interface latestVersion {
     /**
      * Res of getLatest method
@@ -222,7 +231,7 @@ export type DownloadCompleteListener = (state: DownloadCompleteEvent) => void;
 export type MajorAvailableListener = (state: MajorAvailableEvent) => void;
 export type UpdateFailedListener = (state: UpdateFailedEvent) => void;
 export type AppReloadedListener = (state: void) => void;
-export type AppReadyListener = (state: void) => void;
+export type AppReadyListener = (state: AppReadyEvent) => void;
 export interface CapacitorUpdaterPlugin {
     /**
      * Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -15,7 +15,7 @@ import Version
 @objc(CapacitorUpdaterPlugin)
 public class CapacitorUpdaterPlugin: CAPPlugin {
     private var implementation = CapacitorUpdater()
-    private let PLUGIN_VERSION: String = "5.2.9"
+    private let PLUGIN_VERSION: String = "5.2.10"
     static let updateUrlDefault = "https://api.capgo.app/updates"
     static let statsUrlDefault = "https://api.capgo.app/stats"
     static let channelUrlDefault = "https://api.capgo.app/channel_self"
@@ -498,6 +498,17 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         self.backgroundTaskID = UIBackgroundTaskIdentifier.invalid
     }
 
+    func endBackGroundTaskWithNotif(msg: String, latestVersionName: String, current: BundleInfo, error: Bool = true) {
+        if error {
+            self.implementation.sendStats(action: "download_fail", versionName: current.getVersionName())
+            self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
+        }
+        self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
+        self.notifyListeners("appReady", data: ["bundle": current.toJSON(), "message": msg])
+        print("\(self.implementation.TAG) endBackGroundTaskWithNotif \(msg)")
+        self.endBackGroundTask()
+    }
+
     func backgroundDownload() {
         let messageUpdate = self.directUpdate ? "Update will occur now." : "Update will occur next time app moves to background."
         DispatchQueue.global(qos: .background).async {
@@ -515,17 +526,13 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                 if res.major == true {
                     self.notifyListeners("majorAvailable", data: ["version": res.version])
                 }
-                self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
-                self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
-                self.endBackGroundTask()
+                self.endBackGroundTaskWithNotif(msg: res.message ?? "", latestVersionName: res.version, current: current)
                 return
             }
             let sessionKey = res.sessionKey ?? ""
             guard let downloadUrl = URL(string: res.url) else {
                 print("\(self.implementation.TAG) Error no url or wrong format")
-                self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
-                self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
-                self.endBackGroundTask()
+                self.endBackGroundTaskWithNotif(msg: "Error no url or wrong format", latestVersionName: res.version, current: current)
                 return
             }
             let latestVersionName = res.version
@@ -547,17 +554,12 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                     }
                     guard let next = nextImpl else {
                         print("\(self.implementation.TAG) Error downloading file")
-                        self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
-                        self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
-                        self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
-                        self.endBackGroundTask()
+                        self.endBackGroundTaskWithNotif(msg: "Error downloading file", latestVersionName: latestVersionName, current: current)
                         return
                     }
                     if next.isErrorStatus() {
                         print("\(self.implementation.TAG) Latest version is in error state. Aborting update.")
-                        self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
-                        self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
-                        self.endBackGroundTask()
+                        self.endBackGroundTaskWithNotif(msg: "Latest version is in error state. Aborting update.", latestVersionName: latestVersionName, current: current)
                         return
                     }
                     if res.checksum != "" && next.getChecksum() != res.checksum {
@@ -568,28 +570,30 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                         if !resDel {
                             print("\(self.implementation.TAG) Delete failed, id \(id) doesn't exist")
                         }
-                        throw ObjectSavableError.checksum
+                        self.endBackGroundTaskWithNotif(msg: "Error checksum", latestVersionName: latestVersionName, current: current)
+                        return
                     }
                     if self.directUpdate {
                         _ = self.implementation.set(bundle: next)
                         _ = self._reload()
+                        self.endBackGroundTaskWithNotif(msg: "update installed", latestVersionName: latestVersionName, current: current)
                     } else {
                         self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()])
                         _ = self.implementation.setNextBundle(next: next.getId())
+                        self.endBackGroundTaskWithNotif(msg: "update downloaded, will install next background", latestVersionName: latestVersionName, current: current)
                     }
+                    return
                 } catch {
                     print("\(self.implementation.TAG) Error downloading file", error.localizedDescription)
                     let current: BundleInfo = self.implementation.getCurrentBundle()
-                    self.implementation.sendStats(action: "download_fail", versionName: current.getVersionName())
-                    self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
-                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
+                    self.endBackGroundTaskWithNotif(msg: "Error downloading file", latestVersionName: latestVersionName, current: current)
+                    return
                 }
             } else {
                 print("\(self.implementation.TAG) No need to update, \(current.getId()) is the latest bundle.")
-                self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
+                self.endBackGroundTaskWithNotif(msg: "No need to update, \(current.getId()) is the latest bundle.", latestVersionName: latestVersionName, current: current, error: false)
+                return
             }
-            self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
-            self.endBackGroundTask()
         }
     }
 
@@ -652,7 +656,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             print("\(self.implementation.TAG) Auto update is disabled")
             // run after 1 second to make sure that the app is ready
             DispatchQueue.main.asyncAfter(deadline: .now() + 3) {
-                self.notifyListeners("appReady", data: ["bundle": current.toJSON()])
+                self.notifyListeners("appReady", data: ["bundle": current.toJSON(), "status": "disabled"])
             }
         }
         self.checkAppReady()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "5.2.9",
+  "version": "5.2.10",
   "packageManager": "pnpm@8.6.12",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",