@capgo/capacitor-updater 4.0.0-alpha.2 → 4.0.0-alpha.20

package/README.md

@@ -127,6 +127,8 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
 * [`current()`](#current)
 * [`reload()`](#reload)
 * [`setDelay(...)`](#setdelay)
+* [`cancelDelay()`](#canceldelay)
+* [`getLatest(...)`](#getlatest)
 * [`addListener('download', ...)`](#addlistenerdownload)
 * [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete)
 * [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
@@ -276,15 +278,49 @@ Reload the view
 ### setDelay(...)
 
 ```typescript
-setDelay(options: { delay: boolean; }) => Promise<void>
+setDelay(options: { kind: DelayUntilNext; value?: string; }) => Promise<void>
 ```
 
 Set delay to skip updates in the next time the app goes into the background
 
+| Param         | Type                                                                                 |
+| ------------- | ------------------------------------------------------------------------------------ |
+| **`options`** | <code>{ kind: <a href="#delayuntilnext">DelayUntilNext</a>; value?: string; }</code> |
+
+**Since:** 4.0.0
+
+--------------------
+
+
+### cancelDelay()
+
+```typescript
+cancelDelay() => Promise<void>
+```
+
+Cancel delay to updates as usual
+
+**Since:** 4.0.0
+
+--------------------
+
+
+### getLatest(...)
+
+```typescript
+getLatest(options: { delay: boolean; }) => Promise<latestVersion>
+```
+
+Get Latest version available from update Url
+
 | Param         | Type                             |
 | ------------- | -------------------------------- |
 | **`options`** | <code>{ delay: boolean; }</code> |
 
+**Returns:** <code>Promise&lt;<a href="#latestversion">latestVersion</a>&gt;</code>
+
+**Since:** 4.0.0
+
 --------------------
 
 
@@ -445,6 +481,17 @@ removeAllListeners() => Promise<void>
 | **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
 
 
+#### latestVersion
+
+| Prop          | Type                 | Description             | Since |
+| ------------- | -------------------- | ----------------------- | ----- |
+| **`version`** | <code>string</code>  | Res of getLatest method | 4.0.0 |
+| **`major`**   | <code>boolean</code> |                         |       |
+| **`message`** | <code>string</code>  |                         |       |
+| **`old`**     | <code>string</code>  |                         |       |
+| **`url`**     | <code>string</code>  |                         |       |
+
+
 #### PluginListenerHandle
 
 | Prop         | Type                                      |
@@ -489,6 +536,11 @@ removeAllListeners() => Promise<void>
 <code>'success' | 'error' | 'pending' | 'downloading'</code>
 
 
+#### DelayUntilNext
+
+<code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
+
+
 #### DownloadChangeListener
 
 <code>(state: <a href="#downloadevent">DownloadEvent</a>): void</code>

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

@@ -46,7 +46,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.2";
+    public static final String pluginVersion = "4.0.0-alpha.20";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;
@@ -255,7 +255,7 @@ public class CapacitorUpdater {
             return true;
         }
         Log.e(TAG, "Directory not removed: " + bundle.getPath());
-        this.sendStats("delete", deleted);
+        this.sendStats("delete", deleted.getVersionName());
         return false;
     }
 
@@ -263,11 +263,11 @@ public class CapacitorUpdater {
         return new File(this.documentsDir, bundleDirectory + "/" + id);
     }
 
-    private boolean bundleExists(final File bundle) {
+    private boolean bundleExists(final String id) {
+        final File bundle = this.getBundleDirectory(id);
         if(bundle == null || !bundle.exists()) {
             return false;
         }
-
         return new File(bundle.getPath(), "/index.html").exists();
     }
 
@@ -277,17 +277,17 @@ public class CapacitorUpdater {
 
     public Boolean set(final String id) {
 
-        final BundleInfo existing = this.getBundleInfo(id);
+        final BundleInfo newBundle = this.getBundleInfo(id);
         final File bundle = this.getBundleDirectory(id);
 
-        Log.i(TAG, "Setting next active bundle: " + existing);
-        if (this.bundleExists(bundle)) {
+        Log.i(TAG, "Setting next active bundle: " + id);
+        if (this.bundleExists(id)) {
             this.setCurrentBundle(bundle);
             this.setBundleStatus(id, BundleStatus.PENDING);
-            this.sendStats("set", existing);
+            this.sendStats("set", newBundle.getVersionName());
             return true;
         }
-        this.sendStats("set_fail", existing);
+        this.sendStats("set_fail", newBundle.getVersionName());
         return false;
     }
 
@@ -307,9 +307,9 @@ public class CapacitorUpdater {
     public void reset(final boolean internal) {
         this.setCurrentBundle(new File("public"));
         this.setFallbackVersion(null);
-        this.setNextVersion(null);
+        this.setNext(null);
         if(!internal) {
-            this.sendStats("reset", this.getCurrentBundle());
+            this.sendStats("reset", this.getCurrentBundle().getVersionName());
         }
     }
 
@@ -356,7 +356,7 @@ public class CapacitorUpdater {
         }
     }
 
-    public void sendStats(final String action, final BundleInfo bundle) {
+    public void sendStats(final String action, final String versionName) {
         String statsUrl = this.statsUrl;
         if (statsUrl == null || "".equals(statsUrl) || statsUrl.length() == 0) { return; }
         try {
@@ -367,7 +367,7 @@ public class CapacitorUpdater {
             json.put("version_build", this.versionBuild);
             json.put("version_code", this.versionCode);
             json.put("version_os", this.versionOs);
-            json.put("version_name", bundle.getVersionName());
+            json.put("version_name", versionName);
             json.put("plugin_version", pluginVersion);
             json.put("action", action);
 
@@ -379,13 +379,13 @@ public class CapacitorUpdater {
                     new Response.Listener<JSONObject>() {
                         @Override
                         public void onResponse(JSONObject response) {
-                            Log.i(TAG, "Stats send for \"" + action + "\", version " + bundle.getVersionName());
+                            Log.i(TAG, "Stats send for \"" + action + "\", version " + versionName);
                         }
                     },
                     new Response.ErrorListener(){
                         @Override
                         public void onErrorResponse(VolleyError error) {
-                            Log.i(TAG, "Stats send for \"" + action + "\", version " + bundle.getVersionName());
+                            Log.i(TAG, "Stats send for \"" + action + "\", version " + versionName);
                         }
                     });
             this.requestQueue.add(request);
@@ -511,15 +511,13 @@ public class CapacitorUpdater {
         }
     }
 
-    public boolean setNextVersion(final String next) {
+    public boolean setNext(final String next) {
         if (next == null) {
             this.editor.remove(NEXT_VERSION);
         } else {
-            final File bundle = this.getBundleDirectory(next);
-            if (!this.bundleExists(bundle)) {
+            if (!this.bundleExists(next)) {
                 return false;
             }
-
             this.editor.putString(NEXT_VERSION, next);
             this.setBundleStatus(next, BundleStatus.PENDING);
         }

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

@@ -28,13 +28,17 @@ import io.github.g00fy2.versioncompare.Version;
 import org.json.JSONException;
 
 import java.io.IOException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Iterator;
 import java.util.List;
 
 @CapacitorPlugin(name = "CapacitorUpdater")
 public class CapacitorUpdaterPlugin extends Plugin implements Application.ActivityLifecycleCallbacks {
-    private static final String autoUpdateUrlDefault = "https://xvwzpoazmxkqosrdewyv.functions.supabase.co/updates";
+    private static final String updateUrlDefault = "https://xvwzpoazmxkqosrdewyv.functions.supabase.co/updates";
     private static final String statsUrlDefault = "https://xvwzpoazmxkqosrdewyv.functions.supabase.co/stats";
     private static final String DELAY_UPDATE = "delayUpdate";
+    private static final String DELAY_UPDATE_VAL = "delayUpdateVal";
 
     private SharedPreferences.Editor editor;
     private SharedPreferences prefs;
@@ -44,7 +48,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
     private Boolean autoDeleteFailed = true;
     private Boolean autoDeletePrevious = true;
     private Boolean autoUpdate = false;
-    private String autoUpdateUrl = "";
+    private String updateUrl = "";
     private Version currentVersionNative;
     private Boolean resetWhenUpdate = true;
 
@@ -87,7 +91,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
         this.autoDeleteFailed = this.getConfig().getBoolean("autoDeleteFailed", true);
         this.autoDeletePrevious = this.getConfig().getBoolean("autoDeletePrevious", true);
-        this.autoUpdateUrl = this.getConfig().getString("autoUpdateUrl", autoUpdateUrlDefault);
+        this.updateUrl = this.getConfig().getString("updateUrl", updateUrlDefault);
         this.autoUpdate = this.getConfig().getBoolean("autoUpdate", false);
         this.appReadyTimeout = this.getConfig().getInt("appReadyTimeout", 10000);
         this.resetWhenUpdate = this.getConfig().getBoolean("resetWhenUpdate", true);
@@ -97,8 +101,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         }
         final Application application = (Application) this.getContext().getApplicationContext();
         application.registerActivityLifecycleCallbacks(this);
-
         this.onActivityStarted(this.getActivity());
+        this._checkCancelDelay(true);
     }
 
     private void cleanupObsoleteVersions() {
@@ -133,7 +137,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         try {
             final JSObject ret = new JSObject();
             ret.put("percent", percent);
-            var bundle = this.implementation.getBundleInfo(id).toJSON();
+            JSObject bundle = this.implementation.getBundleInfo(id).toJSON();
             ret.put("bundle", bundle);
             this.notifyListeners("download", ret);
             if (percent == 100) {
@@ -146,10 +150,10 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
 
     @PluginMethod
-    public void getId(final PluginCall call) {
+    public void getDeviceId(final PluginCall call) {
         try {
             final JSObject ret = new JSObject();
-            ret.put("id", this.implementation.deviceID);
+            ret.put("deviceId", this.implementation.deviceID);
             call.resolve(ret);
         } catch (final Exception e) {
             Log.e(CapacitorUpdater.TAG, "Could not get device id", e);
@@ -174,6 +178,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         final String url = call.getString("url");
         final String version = call.getString("version");
         if (url == null || version == null) {
+            Log.e(CapacitorUpdater.TAG, "missing url or version");
             call.reject("missing url or version");
             return;
         }
@@ -216,6 +221,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
             if (this._reload()) {
                 call.resolve();
             } else {
+                Log.e(CapacitorUpdater.TAG, "Reload failed");
                 call.reject("Reload failed");
             }
         } catch(final Exception e) {
@@ -230,7 +236,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
         try {
             Log.i(CapacitorUpdater.TAG, "Setting next active id " + id);
-            if (!this.implementation.setNextVersion(id)) {
+            if (!this.implementation.setNext(id)) {
+                Log.e(CapacitorUpdater.TAG, "Set next id failed. Bundle " + id + " does not exist.");
                 call.reject("Set next id failed. Bundle " + id + " does not exist.");
             } else {
                 call.resolve(this.implementation.getBundleInfo(id).toJSON());
@@ -269,6 +276,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
             if (res) {
                 call.resolve();
             } else {
+                Log.e(CapacitorUpdater.TAG, "Delete failed, id " + id + " does not exist");
                 call.reject("Delete failed, id " + id + " does not exist");
             }
         } catch(final Exception e) {
@@ -296,6 +304,30 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         }
     }
 
+    @PluginMethod
+    public void getLatest(final PluginCall call) {
+        new Thread(new Runnable(){
+            @Override
+            public void run() {
+                CapacitorUpdaterPlugin.this.implementation.getLatest(CapacitorUpdaterPlugin.this.updateUrl, (res) -> {
+                    final JSObject ret = new JSObject();
+                    Iterator<String> keys = res.keys();
+                    while(keys.hasNext()) {
+                        String key = keys.next();
+                        if (res.has(key)) {
+                            try {
+                                ret.put(key, res.get(key));
+                            } catch (JSONException e) {
+                                e.printStackTrace();
+                            }
+                        }
+                    }
+                    call.resolve(ret);
+                });
+            }
+        });
+    }
+
     private boolean _reset(final Boolean toLastSuccessful) {
         final BundleInfo fallback = this.implementation.getFallbackVersion();
         this.implementation.reset();
@@ -317,6 +349,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                 call.resolve();
                 return;
             }
+            Log.e(CapacitorUpdater.TAG, "Reset failed");
             call.reject("Reset failed");
         }
         catch(final Exception e) {
@@ -357,9 +390,17 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
     @PluginMethod
     public void delayUpdate(final PluginCall call) {
         try {
-            Log.i(CapacitorUpdater.TAG, "Delay update.");
-            this.editor.putBoolean(DELAY_UPDATE, true);
+            final String kind = call.getString("kind");
+            final String value = call.getString("value");
+            if (kind == null) {
+                Log.e(CapacitorUpdater.TAG, "setDelay called without kind");
+                call.reject("setDelay called without kind");
+                return;
+            }
+            this.editor.putString(DELAY_UPDATE, kind);
+            this.editor.putString(DELAY_UPDATE_VAL, value);
             this.editor.commit();
+            Log.i(CapacitorUpdater.TAG, "Delay update saved");
             call.resolve();
         }
         catch(final Exception e) {
@@ -368,22 +409,68 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         }
     }
 
-    @PluginMethod
-    public void cancelDelay(final PluginCall call) {
+    private boolean _cancelDelay(String source) {
         try {
-            Log.i(CapacitorUpdater.TAG, "Cancel update delay.");
-            this.editor.putBoolean(DELAY_UPDATE, false);
+            this.editor.remove(DELAY_UPDATE);
+            this.editor.remove(DELAY_UPDATE_VAL);
             this.editor.commit();
-            call.resolve();
+            Log.i(CapacitorUpdater.TAG, "delay canceled from " + source);
+            return true;
         }
         catch(final Exception e) {
             Log.e(CapacitorUpdater.TAG, "Failed to cancel update delay", e);
-            call.reject("Failed to cancel update delay", e);
+            return false;
+        }
+    }
+
+    @PluginMethod
+    public void cancelDelay(final PluginCall call) {
+        if(this._cancelDelay("JS")) {
+            call.resolve();
+        } else {
+            call.reject("Failed to cancel delay");
+        }
+    }
+
+    private void _checkCancelDelay(Boolean killed) {
+        final String delayUpdate = this.prefs.getString(DELAY_UPDATE, "");
+        if ("".equals(delayUpdate)) {
+            if ("background".equals(delayUpdate) && !killed) {
+                this._cancelDelay("background check");
+            } else if ("kill".equals(delayUpdate) && killed) {
+                this._cancelDelay("kill check");
+            }
+            final String delayVal = this.prefs.getString(DELAY_UPDATE_VAL, "");
+            if ("".equals(delayVal)) {
+                this._cancelDelay("delayVal absent");
+            } else if ("date".equals(delayUpdate)) {
+                try {
+                    final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
+                    Date date = sdf.parse(delayVal);
+                    if (date.compareTo(new Date()) > 0)  {
+                        this._cancelDelay("date expired");
+                    }
+                }
+                catch(final Exception e) {
+                    this._cancelDelay("date parsing issue");
+                }
+
+            } else if ("nativeVersion".equals(delayUpdate)) {
+                try {
+                    final Version versionLimit = new Version(delayVal);
+                    if (this.currentVersionNative.isAtLeast(versionLimit)) {
+                        this._cancelDelay("nativeVersion above limit");
+                    }
+                }
+                catch(final Exception e) {
+                    this._cancelDelay("nativeVersion parsing issue");
+                }
+            }
         }
     }
 
     private Boolean _isAutoUpdateEnabled() {
-        return CapacitorUpdaterPlugin.this.autoUpdate && !"".equals(CapacitorUpdaterPlugin.this.autoUpdateUrl);
+        return CapacitorUpdaterPlugin.this.autoUpdate && !"".equals(CapacitorUpdaterPlugin.this.updateUrl);
     }
 
     @PluginMethod
@@ -410,6 +497,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
         }
     }
 
+
+
     @Override // appMovedToForeground
     public void onActivityStarted(@NonNull final Activity activity) {
         if (CapacitorUpdaterPlugin.this._isAutoUpdateEnabled()) {
@@ -417,8 +506,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                 @Override
                 public void run() {
 
-                    Log.i(CapacitorUpdater.TAG, "Check for update via: " + CapacitorUpdaterPlugin.this.autoUpdateUrl);
-                    CapacitorUpdaterPlugin.this.implementation.getLatest(CapacitorUpdaterPlugin.this.autoUpdateUrl, (res) -> {
+                    Log.i(CapacitorUpdater.TAG, "Check for update via: " + CapacitorUpdaterPlugin.this.updateUrl);
+                    CapacitorUpdaterPlugin.this.implementation.getLatest(CapacitorUpdaterPlugin.this.updateUrl, (res) -> {
                         try {
                             if (res.has("message")) {
                                 Log.i(CapacitorUpdater.TAG, "message: " + res.get("message"));
@@ -442,7 +531,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                     }
                                     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.setNextVersion(latest.getId());
+                                        CapacitorUpdaterPlugin.this.implementation.setNext(latest.getId());
                                         return;
                                     }
                                 }
@@ -457,7 +546,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                             final String url = (String) res.get("url");
                                             final BundleInfo next = CapacitorUpdaterPlugin.this.implementation.download(url, latestVersionName);
 
-                                            CapacitorUpdaterPlugin.this.implementation.setNextVersion(next.getId());
+                                            CapacitorUpdaterPlugin.this.implementation.setNext(next.getId());
                                         } catch (final Exception e) {
                                             Log.e(CapacitorUpdater.TAG, "error downloading file", e);
                                         }
@@ -481,15 +570,12 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
     public void onActivityStopped(@NonNull final Activity activity) {
         Log.i(CapacitorUpdater.TAG, "Checking for pending update");
         try {
-            final Boolean delayUpdate = this.prefs.getBoolean(DELAY_UPDATE, false);
-            this.editor.putBoolean(DELAY_UPDATE, false);
-            this.editor.commit();
-
-            if (delayUpdate) {
+            final String delayUpdate = this.prefs.getString(DELAY_UPDATE, "");
+            this._checkCancelDelay(false);
+            if ("".equals(delayUpdate)) {
                 Log.i(CapacitorUpdater.TAG, "Update delayed to next backgrounding");
                 return;
             }
-
             final BundleInfo fallback = this.implementation.getFallbackVersion();
             final BundleInfo current = this.implementation.getCurrentBundle();
             final BundleInfo next = this.implementation.getNextVersion();
@@ -504,7 +590,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                 Log.d(CapacitorUpdater.TAG, "Next bundle is: " + next.getVersionName());
                 if (this.implementation.set(next) && this._reload()) {
                     Log.i(CapacitorUpdater.TAG, "Updated to bundle: " + next.getVersionName());
-                    this.implementation.setNextVersion(null);
+                    this.implementation.setNext(null);
                 } else {
                     Log.e(CapacitorUpdater.TAG, "Update to bundle: " + next.getVersionName() + " Failed!");
                 }
@@ -523,7 +609,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                     final JSObject ret = new JSObject();
                     ret.put("bundle", current);
                     this.notifyListeners("updateFailed", ret);
-                    this.implementation.sendStats("revert", current);
+                    this.implementation.sendStats("update_fail", current.getVersionName());
                     if (!fallback.isBuiltin() && !fallback.equals(current)) {
                         final Boolean res = this.implementation.set(fallback);
                         if (res && this._reload()) {