@capgo/capacitor-updater 4.0.0-alpha.40 → 4.0.0-alpha.43

package/README.md

@@ -130,6 +130,7 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
 * [`cancelDelay()`](#canceldelay)
 * [`getLatest(...)`](#getlatest)
 * [`addListener('download', ...)`](#addlistenerdownload)
+* [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate)
 * [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete)
 * [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
 * [`addListener('updateFailed', ...)`](#addlistenerupdatefailed)
@@ -345,6 +346,26 @@ Listen for download event in the App, let you know when the download is started,
 --------------------
 
 
+### addListener('noNeedUpdate', ...)
+
+```typescript
+addListener(eventName: 'noNeedUpdate', listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for no need to update event, usefull when you want force check every time the app is launched
+
+| Param              | Type                                                      |
+| ------------------ | --------------------------------------------------------- |
+| **`eventName`**    | <code>'noNeedUpdate'</code>                               |
+| **`listenerFunc`** | <code><a href="#noneedlistener">NoNeedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
 ### addListener('downloadComplete', ...)
 
 ```typescript
@@ -529,6 +550,13 @@ removeAllListeners() => Promise<void>
 | **`bundle`**  | <code><a href="#bundleinfo">BundleInfo</a></code> |                                                |       |
 
 
+#### noNeedEvent
+
+| Prop         | Type                                              | Description                                    | Since |
+| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
+
+
 #### DownloadCompleteEvent
 
 | Prop         | Type                                              | Description                          | Since |
@@ -575,6 +603,11 @@ removeAllListeners() => Promise<void>
 <code>(state: <a href="#downloadevent">DownloadEvent</a>): void</code>
 
 
+#### NoNeedListener
+
+<code>(state: <a href="#noneedevent">noNeedEvent</a>): void</code>
+
+
 #### DownloadCompleteListener
 
 <code>(state: <a href="#downloadcompleteevent">DownloadCompleteEvent</a>): void</code>

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

@@ -47,7 +47,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.0.0-alpha.40";
+    public static final String pluginVersion = "4.0.0-alpha.43";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;
@@ -367,6 +367,7 @@ public class CapacitorUpdater {
             json.put("version_name", version);
             json.put("plugin_version", pluginVersion);
 
+            Log.e(CapacitorUpdater.TAG, "Auto-update parameters: " + json.toString());
             // Building a request
             JsonObjectRequest request = new JsonObjectRequest(
                     Request.Method.POST,
@@ -432,7 +433,7 @@ public class CapacitorUpdater {
 
     public BundleInfo getBundleInfo(final String id) {
         String trueId = BundleInfo.VERSION_UNKNOWN;
-        if(id == null) {
+        if(id != null) {
             trueId = id;
         }
         Log.d(TAG, "Getting info for bundle [" + trueId + "]");

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

@@ -28,6 +28,8 @@ import io.github.g00fy2.versioncompare.Version;
 import org.json.JSONException;
 
 import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Iterator;
@@ -521,7 +523,15 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         }
     }
 
-
+    private boolean isValidURL(String urlStr) {
+        try {
+            URL url = new URL(urlStr);
+            return true;
+        }
+        catch (MalformedURLException e) {
+            return false;
+        }
+    }
 
     @Override // appMovedToForeground
     public void onActivityStarted(@NonNull final Activity activity) {
@@ -532,17 +542,27 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
                     Log.i(CapacitorUpdater.TAG, "Check for update via: " + CapacitorUpdaterPlugin.this.updateUrl);
                     CapacitorUpdaterPlugin.this.implementation.getLatest(CapacitorUpdaterPlugin.this.updateUrl, (res) -> {
+                        final BundleInfo current = CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
                         try {
                             if (res.has("message")) {
-                                Log.i(CapacitorUpdater.TAG, "message: " + res.get("message"));
+                                Log.i(CapacitorUpdater.TAG, "message " + res.get("message"));
                                 if (res.has("major") && res.getBoolean("major") && res.has("version")) {
                                     final JSObject majorAvailable = new JSObject();
                                     majorAvailable.put("version", (String) res.get("version"));
                                     CapacitorUpdaterPlugin.this.notifyListeners("majorAvailable", majorAvailable);
                                 }
+                                final JSObject retNoNeed = new JSObject();
+                                retNoNeed.put("bundle", current.toJSON());
+                                CapacitorUpdaterPlugin.this.notifyListeners("noNeedUpdate", retNoNeed);
                                 return;
                             }
-                            final BundleInfo current = CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
+
+                            if (!res.has("url") || CapacitorUpdaterPlugin.this.isValidURL((String)res.get("url"))) {
+                                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);
+                            }
                             final String latestVersionName = (String) res.get("version");
 
                             if (latestVersionName != null && !"".equals(latestVersionName) && !current.getVersionName().equals(latestVersionName)) {
@@ -551,11 +571,17 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                 if(latest != null) {
                                     if(latest.isErrorStatus()) {
                                         Log.e(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);
                                         return;
                                     }
                                     if(latest.isDownloaded()){
                                         Log.e(CapacitorUpdater.TAG, "Latest bundle already exists and download is NOT required. Update will occur next time app moves to background.");
                                         CapacitorUpdaterPlugin.this.implementation.setNextBundle(latest.getId());
+                                        final JSObject ret = new JSObject();
+                                        ret.put("bundle", latest.toJSON());
+                                        CapacitorUpdaterPlugin.this.notifyListeners("updateAvailable", ret);
                                         return;
                                     }
                                 }
@@ -578,14 +604,23 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                             final JSObject ret = new JSObject();
                                             ret.put("version", latestVersionName);
                                             CapacitorUpdaterPlugin.this.notifyListeners("downloadFailed", ret);
+                                            final JSObject retNoNeed = new JSObject();
+                                            retNoNeed.put("bundle", current.toJSON());
+                                            CapacitorUpdaterPlugin.this.notifyListeners("noNeedUpdate", retNoNeed);
                                         }
                                     }
                                 }).start();
                             } else {
-                                Log.i(CapacitorUpdater.TAG, "No need to update, " + current + " is the latest bundle.");
+                                Log.i(CapacitorUpdater.TAG, "No need to update, " + current.getId() + " is the latest bundle.");
+                                final JSObject retNoNeed = new JSObject();
+                                retNoNeed.put("bundle", current.toJSON());
+                                CapacitorUpdaterPlugin.this.notifyListeners("noNeedUpdate", retNoNeed);
                             }
                         } 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);
                         }
                     });
                 }

package/dist/docs.json

@@ -362,6 +362,35 @@
         ],
         "slug": "addlistenerdownload"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'noNeedUpdate', listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'noNeedUpdate'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "NoNeedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "since",
+            "text": "4.0.0"
+          }
+        ],
+        "docs": "Listen for no need to update event, usefull when you want force check every time the app is launched",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NoNeedListener"
+        ],
+        "slug": "addlistenernoneedupdate"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'downloadComplete', listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -573,6 +602,7 @@
     "importObject": [
       "PluginListenerHandle",
       "\"@capacitor/cli\"",
+      "noNeedEvent",
       "DownloadEvent",
       "MajorAvailableEvent",
       "DownloadFailedEvent",
@@ -583,6 +613,7 @@
       "BundleStatus",
       "DelayUntilNext",
       "DownloadChangeListener",
+      "NoNeedListener",
       "DownloadFailedListener",
       "DownloadCompleteListener",
       "MajorAvailableListener",
@@ -638,6 +669,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -647,6 +679,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -705,6 +738,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -714,6 +748,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -781,6 +816,50 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
+        "MajorAvailableEvent",
+        "DownloadFailedEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
+        "DelayUntilNext",
+        "DownloadChangeListener",
+        "NoNeedListener",
+        "DownloadFailedListener",
+        "DownloadCompleteListener",
+        "MajorAvailableListener",
+        "UpdateFailedListener",
+        "CapacitorUpdaterPlugin"
+      ]
+    },
+    {
+      "name": "noNeedEvent",
+      "slug": "noneedevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [
+            {
+              "text": "4.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Current status of download, between 0 and 100.",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        }
+      ],
+      "importObject": [
+        "PluginListenerHandle",
+        "\"@capacitor/cli\"",
+        "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
         "DownloadCompleteEvent",
@@ -790,6 +869,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -822,6 +902,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -831,6 +912,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -861,6 +943,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "DownloadFailedEvent",
         "DownloadCompleteEvent",
@@ -870,6 +953,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -902,6 +986,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -911,6 +996,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -941,6 +1027,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "noNeedEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadCompleteEvent",
@@ -950,6 +1037,7 @@
         "BundleStatus",
         "DelayUntilNext",
         "DownloadChangeListener",
+        "NoNeedListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -1019,6 +1107,19 @@
         }
       ]
     },
+    {
+      "name": "NoNeedListener",
+      "slug": "noneedlistener",
+      "docs": "",
+      "types": [
+        {
+          "text": "(state: noNeedEvent): void",
+          "complexTypes": [
+            "noNeedEvent"
+          ]
+        }
+      ]
+    },
     {
       "name": "DownloadCompleteListener",
       "slug": "downloadcompletelistener",

package/dist/esm/definitions.d.ts

@@ -71,6 +71,14 @@ declare module '@capacitor/cli' {
         };
     }
 }
+export interface noNeedEvent {
+    /**
+     * Current status of download, between 0 and 100.
+     *
+     * @since  4.0.0
+     */
+    bundle: BundleInfo;
+}
 export interface DownloadEvent {
     /**
      * Current status of download, between 0 and 100.
@@ -134,6 +142,7 @@ export interface BundleInfo {
 export declare type BundleStatus = 'success' | 'error' | 'pending' | 'downloading';
 export declare type DelayUntilNext = 'background' | 'kill' | 'nativeVersion' | 'date';
 export declare type DownloadChangeListener = (state: DownloadEvent) => void;
+export declare type NoNeedListener = (state: noNeedEvent) => void;
 export declare type DownloadFailedListener = (state: DownloadFailedEvent) => void;
 export declare type DownloadCompleteListener = (state: DownloadCompleteEvent) => void;
 export declare type MajorAvailableListener = (state: MajorAvailableEvent) => void;
@@ -261,6 +270,12 @@ export interface CapacitorUpdaterPlugin {
      * @since 2.0.11
      */
     addListener(eventName: 'download', listenerFunc: DownloadChangeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    /**
+     * Listen for no need to update event, usefull when you want force check every time the app is launched
+     *
+     * @since 4.0.0
+     */
+    addListener(eventName: 'noNeedUpdate', listenerFunc: NoNeedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
     /**
      * Listen for download event in the App, let you know when the download is started, loading and finished
      *

package/ios/Plugin/CapacitorUpdater.swift

@@ -149,7 +149,7 @@ extension CustomError: LocalizedError {
     
     public let TAG = "✨  Capacitor-updater:";
     public let CAP_SERVER_PATH = "serverBasePath"
-    public let pluginVersion = "4.0.0-alpha.40"
+    public let pluginVersion = "4.0.0-alpha.43"
     public var statsUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""
@@ -229,7 +229,7 @@ extension CustomError: LocalizedError {
         }
     }
 
-    public func getLatest(url: URL) -> AppVersion? {
+    public func getLatest(url: URL) -> AppVersion {
         let semaphore = DispatchSemaphore(value: 0)
         let latest = AppVersion()
         let parameters: [String: String] = [
@@ -242,6 +242,7 @@ extension CustomError: LocalizedError {
             "plugin_version": self.pluginVersion,
             "version_name": self.getCurrentBundle().getVersionName()
         ]
+        print("\(self.TAG) Auto-update parameters: \(parameters)")
         let request = AF.request(url, method: .post,parameters: parameters, encoder: JSONParameterEncoder.default)
 
         request.validate().responseDecodable(of: AppVersionDec.self) { response in
@@ -258,7 +259,6 @@ extension CustomError: LocalizedError {
                     }
                     if let message = response.value?.message {
                         latest.message = message
-                        print("\(self.TAG) Auto-update message: \(message)")
                     }
                 case let .failure(error):
                     print("\(self.TAG) Error getting Latest", error )
@@ -266,7 +266,7 @@ extension CustomError: LocalizedError {
             semaphore.signal()
         }
         semaphore.wait()
-        return latest.url != "" ? latest : nil
+        return latest
     }
     
     private func setCurrentBundle(bundle: String) {

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -193,7 +193,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
 
     @objc func getLatest(_ call: CAPPluginCall) {
         let res = self.implementation.getLatest(url: URL(string: self.updateUrl)!)
-        call.resolve((res?.toDict())!)
+        call.resolve(res.toDict())
     }
 
     @objc func _reset(toLastSuccessful: Bool) -> Bool {
@@ -364,46 +364,51 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                 print("\(self.implementation.TAG) Check for update via \(self.updateUrl)")
                 let url = URL(string: self.updateUrl)!
                 let res = self.implementation.getLatest(url: url)
-                if (res == nil) {
-                    print("\(self.implementation.TAG) No result found in \(self.updateUrl)")
-                    return
-                }
-                if ((res?.message) != nil) {
-                    print("\(self.implementation.TAG) message \(res!.message ?? "")")
-                    if (res?.major == true) {
-                        self.notifyListeners("majorAvailable", data: ["version": res?.version ?? "0.0.0"])
+                let current = self.implementation.getCurrentBundle()
+ 
+                if ((res.message) != nil) {
+                    print("\(self.implementation.TAG) message \(res.message ?? "")")
+                    if (res.major == true) {
+                        self.notifyListeners("majorAvailable", data: ["version": res.version])
                     }
+                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     return
                 }
-                guard let downloadUrl = URL(string: res?.url ?? "") else {
+                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()])
                     return
                 }
-                let current = self.implementation.getCurrentBundle()
-                let latestVersionName = res?.version
-                if (latestVersionName != nil && latestVersionName != "" && current.getVersionName() != latestVersionName) {
-                    let latest = self.implementation.getBundleInfoByVersionName(version: latestVersionName!)
+                let latestVersionName = res.version
+                if (latestVersionName != "" && current.getVersionName() != latestVersionName) {
+                    let latest = self.implementation.getBundleInfoByVersionName(version: latestVersionName)
                     if (latest != nil) {
                         if(latest!.isErrorStatus()) {
                             print("\(self.implementation.TAG) Latest version already exists, and is in error state. Aborting update.")
+                            self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                             return
                         }
                         if(latest!.isDownloaded()){
                             print("\(self.implementation.TAG) Latest version already exists and download is NOT required. Update will occur next time app moves to background.")
                             let _ = self.implementation.setNextBundle(next: latest!.getId())
+                            self.notifyListeners("updateAvailable", data: ["bundle": current.toJSON()])
                             return
                         }
                     }
 
                     do {
-                        print("\(self.implementation.TAG) New bundle: \(latestVersionName!) found. Current is: \(current.getVersionName()). Update will occur next time app moves to background.")
-                        let next = try self.implementation.download(url: downloadUrl, version: latestVersionName!)
+                        print("\(self.implementation.TAG) New bundle: \(latestVersionName) found. Current is: \(current.getVersionName()). Update will occur next time app moves to background.")
+                        let next = try self.implementation.download(url: downloadUrl, version: latestVersionName)
                         self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()])
                         let _ = self.implementation.setNextBundle(next: next.getId())
                     } catch {
                         print("\(self.implementation.TAG) Error downloading file", error.localizedDescription)
-                        self.notifyListeners("downloadFailed", data: ["version": latestVersionName ?? ""])
+                        self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
+                        self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     }
+                } else {
+                    print("\(self.implementation.TAG) No need to update, \(current.getId()) is the latest bundle.")
+                    self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.0.0-alpha.40",
+  "version": "4.0.0-alpha.43",
   "license": "AGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",