@capawesome/capacitor-live-update 6.7.2 → 7.0.0

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateConfig.java

@@ -13,17 +13,13 @@ public class LiveUpdateConfig {
     @Nullable
     private String defaultChannel = null;
 
-    private boolean enabled = true;
     private int httpTimeout = 60000;
 
-    @Nullable
-    private String location = null;
-
     @Nullable
     private String publicKey = null;
 
-    private int readyTimeout = 10000;
-    private boolean resetOnUpdate = true;
+    private int readyTimeout = 0;
+    private String serverDomain = "api.cloud.capawesome.io";
 
     @Nullable
     public String getAppId() {
@@ -39,19 +35,10 @@ public class LiveUpdateConfig {
         return defaultChannel;
     }
 
-    public boolean getEnabled() {
-        return enabled;
-    }
-
     public int getHttpTimeout() {
         return httpTimeout;
     }
 
-    @Nullable
-    public String getLocation() {
-        return location;
-    }
-
     @Nullable
     public String getPublicKey() {
         return publicKey;
@@ -61,8 +48,8 @@ public class LiveUpdateConfig {
         return readyTimeout;
     }
 
-    public boolean getResetOnUpdate() {
-        return resetOnUpdate;
+    public String getServerDomain() {
+        return serverDomain;
     }
 
     public void setAppId(@Nullable String appId) {
@@ -77,18 +64,10 @@ public class LiveUpdateConfig {
         this.defaultChannel = defaultChannel;
     }
 
-    public void setEnabled(boolean enabled) {
-        this.enabled = enabled;
-    }
-
     public void setHttpTimeout(int httpTimeout) {
         this.httpTimeout = httpTimeout;
     }
 
-    public void setLocation(@Nullable String location) {
-        this.location = location;
-    }
-
     public void setPublicKey(@Nullable String publicKey) {
         this.publicKey = publicKey;
     }
@@ -97,7 +76,7 @@ public class LiveUpdateConfig {
         this.readyTimeout = readyTimeout;
     }
 
-    public void setResetOnUpdate(boolean resetOnUpdate) {
-        this.resetOnUpdate = resetOnUpdate;
+    public void setServerDomain(String serverDomain) {
+        this.serverDomain = serverDomain;
     }
 }

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateHttpClient.java

@@ -2,6 +2,8 @@ package io.capawesome.capacitorjs.plugins.liveupdate;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.DownloadProgressCallback;
 import java.io.File;
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
@@ -52,7 +54,8 @@ public class LiveUpdateHttpClient {
         return okHttpClient.newCall(request).execute();
     }
 
-    public static void writeResponseBodyToFile(ResponseBody body, File file) throws IOException {
+    public static void writeResponseBodyToFile(ResponseBody body, File file, @Nullable DownloadProgressCallback callback)
+        throws IOException {
         long contentLength = body.contentLength();
         BufferedSource source = body.source();
         BufferedSink sink = Okio.buffer(Okio.sink(file));
@@ -62,7 +65,9 @@ public class LiveUpdateHttpClient {
         for (long bytesRead; (bytesRead = source.read(sinkBuffer, bufferSize)) != -1;) {
             sink.emit();
             totalBytesRead += bytesRead;
-            int progress = (int) ((totalBytesRead * 100) / contentLength);
+            if (callback != null) {
+                callback.onProgress(totalBytesRead, contentLength);
+            }
         }
         sink.flush();
         sink.close();

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java

@@ -1,15 +1,17 @@
 package io.capawesome.capacitorjs.plugins.liveupdate;
 
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
 import com.getcapacitor.Logger;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundleProgressEvent;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
-import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
@@ -24,7 +26,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "6.7.2";
+    public static final String VERSION = "7.0.0";
     public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdate"; // DO NOT CHANGE
     public static final String ERROR_APP_ID_MISSING = "appId must be configured.";
     public static final String ERROR_BUNDLE_EXISTS = "bundle already exists.";
@@ -42,6 +44,7 @@ public class LiveUpdatePlugin extends Plugin {
     public static final String ERROR_SIGNATURE_MISSING = "Bundle does not contain a signature.";
     public static final String ERROR_SYNC_IN_PROGRESS = "Sync is already in progress.";
     public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String EVENT_DOWNLOAD_BUNDLE_PROGRESS = "downloadBundleProgress";
 
     private boolean syncInProgress = false;
 
@@ -73,7 +76,7 @@ public class LiveUpdatePlugin extends Plugin {
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {
-                    call.resolve();
+                    resolveCall(call);
                 }
 
                 @Override
@@ -97,18 +100,17 @@ public class LiveUpdatePlugin extends Plugin {
                 call.reject(ERROR_BUNDLE_ID_MISSING);
                 return;
             }
-            String checksum = call.getString("checksum");
             String url = call.getString("url");
             if (url == null) {
                 call.reject(ERROR_URL_MISSING);
                 return;
             }
 
-            DownloadBundleOptions options = new DownloadBundleOptions(artifactType, bundleId, checksum, url);
+            DownloadBundleOptions options = new DownloadBundleOptions(artifactType, bundleId, url);
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {
-                    call.resolve();
+                    resolveCall(call);
                 }
 
                 @Override
@@ -130,7 +132,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -145,34 +147,13 @@ public class LiveUpdatePlugin extends Plugin {
         }
     }
 
-    @PluginMethod
-    public void getBundle(PluginCall call) {
-        try {
-            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
-                @Override
-                public void success(Result result) {
-                    call.resolve(result.toJSObject());
-                }
-
-                @Override
-                public void error(Exception exception) {
-                    rejectCall(call, exception);
-                }
-            };
-
-            implementation.getBundle(callback);
-        } catch (Exception exception) {
-            rejectCall(call, exception);
-        }
-    }
-
     @PluginMethod
     public void getBundles(PluginCall call) {
         try {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -193,7 +174,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -214,7 +195,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<GetCurrentBundleResult> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(GetCurrentBundleResult result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -236,7 +217,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -257,7 +238,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -278,7 +259,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<GetNextBundleResult> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(GetNextBundleResult result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -300,7 +281,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -321,7 +302,7 @@ public class LiveUpdatePlugin extends Plugin {
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -339,8 +320,19 @@ public class LiveUpdatePlugin extends Plugin {
     @PluginMethod
     public void ready(PluginCall call) {
         try {
-            implementation.ready();
-            call.resolve();
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    resolveCall(call, result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.ready(callback);
         } catch (Exception exception) {
             rejectCall(call, exception);
         }
@@ -350,7 +342,7 @@ public class LiveUpdatePlugin extends Plugin {
     public void reload(PluginCall call) {
         try {
             implementation.reload();
-            call.resolve();
+            resolveCall(call);
         } catch (Exception exception) {
             rejectCall(call, exception);
         }
@@ -360,35 +352,7 @@ public class LiveUpdatePlugin extends Plugin {
     public void reset(PluginCall call) {
         try {
             implementation.reset();
-            call.resolve();
-        } catch (Exception exception) {
-            rejectCall(call, exception);
-        }
-    }
-
-    @PluginMethod
-    public void setBundle(PluginCall call) {
-        try {
-            String bundleId = call.getString("bundleId");
-            if (bundleId == null) {
-                call.reject(ERROR_BUNDLE_ID_MISSING);
-                return;
-            }
-
-            SetBundleOptions options = new SetBundleOptions(bundleId);
-            EmptyCallback callback = new EmptyCallback() {
-                @Override
-                public void success() {
-                    call.resolve();
-                }
-
-                @Override
-                public void error(Exception exception) {
-                    rejectCall(call, exception);
-                }
-            };
-
-            implementation.setBundle(options, callback);
+            resolveCall(call);
         } catch (Exception exception) {
             rejectCall(call, exception);
         }
@@ -403,7 +367,7 @@ public class LiveUpdatePlugin extends Plugin {
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {
-                    call.resolve();
+                    resolveCall(call);
                 }
 
                 @Override
@@ -431,7 +395,7 @@ public class LiveUpdatePlugin extends Plugin {
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {
-                    call.resolve();
+                    resolveCall(call);
                 }
 
                 @Override
@@ -453,7 +417,7 @@ public class LiveUpdatePlugin extends Plugin {
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {
-                    call.resolve();
+                    resolveCall(call);
                 }
 
                 @Override
@@ -488,7 +452,7 @@ public class LiveUpdatePlugin extends Plugin {
                 @Override
                 public void success(Result result) {
                     syncInProgress = false;
-                    call.resolve(result.toJSObject());
+                    resolveCall(call, result.toJSObject());
                 }
 
                 @Override
@@ -505,6 +469,10 @@ public class LiveUpdatePlugin extends Plugin {
         }
     }
 
+    public void notifyDownloadBundleProgressListeners(@NonNull DownloadBundleProgressEvent event) {
+        notifyListeners(EVENT_DOWNLOAD_BUNDLE_PROGRESS, event.toJSObject(), false);
+    }
+
     private LiveUpdateConfig getLiveUpdateConfig() {
         LiveUpdateConfig config = new LiveUpdateConfig();
 
@@ -514,22 +482,26 @@ public class LiveUpdatePlugin extends Plugin {
         config.setAutoDeleteBundles(autoDeleteBundles);
         String defaultChannel = getConfig().getString("defaultChannel", config.getDefaultChannel());
         config.setDefaultChannel(defaultChannel);
-        boolean enabled = getConfig().getBoolean("enabled", config.getEnabled());
-        config.setEnabled(enabled);
         int httpTimeout = getConfig().getInt("httpTimeout", config.getHttpTimeout());
         config.setHttpTimeout(httpTimeout);
-        String location = getConfig().getString("location", config.getLocation());
-        config.setLocation(location);
         String publicKey = getConfig().getString("publicKey", config.getPublicKey());
         config.setPublicKey(publicKey);
         int readyTimeout = getConfig().getInt("readyTimeout", config.getReadyTimeout());
         config.setReadyTimeout(readyTimeout);
-        boolean resetOnUpdate = getConfig().getBoolean("resetOnUpdate", config.getResetOnUpdate());
-        config.setResetOnUpdate(resetOnUpdate);
+        String serverDomain = getConfig().getString("serverDomain", config.getServerDomain());
+        config.setServerDomain(serverDomain);
 
         return config;
     }
 
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @NonNull JSObject result) {
+        call.resolve(result);
+    }
+
     private void rejectCall(PluginCall call, Exception exception) {
         String message = exception.getMessage();
         if (exception instanceof java.net.SocketTimeoutException) {

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePreferences.java

@@ -18,7 +18,7 @@ public class LiveUpdatePreferences {
     private final String channelKey = "channel"; // DO NOT CHANGE
     private final String deviceIdKey = "deviceId"; // DO NOT CHANGE
     private final String customIdKey = "customId"; // DO NOT CHANGE
-    private final String lastVersionCodeKey = "lastVersionCode"; // DO NOT CHANGE
+    private final String previousBundleIdKey = "previousBundleId"; // DO NOT CHANGE
 
     public LiveUpdatePreferences(@NonNull Context context) {
         this.context = context;
@@ -48,8 +48,11 @@ public class LiveUpdatePreferences {
         }
     }
 
-    public int getLastVersionCode() {
-        return context.getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE).getInt(lastVersionCodeKey, 0);
+    @Nullable
+    public String getPreviousBundleId() {
+        return context
+            .getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE)
+            .getString(previousBundleIdKey, null);
     }
 
     public void setChannel(@Nullable String channel) {
@@ -79,8 +82,12 @@ public class LiveUpdatePreferences {
         settingsEditor.apply();
     }
 
-    public void setLastVersionCode(int lastVersionCode) {
-        settingsEditor.putInt(lastVersionCodeKey, lastVersionCode);
+    public void setPreviousBundleId(@Nullable String bundleId) {
+        if (bundleId == null) {
+            settingsEditor.remove(previousBundleIdKey);
+        } else {
+            settingsEditor.putString(previousBundleIdKey, bundleId);
+        }
         settingsEditor.apply();
     }
 }

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/api/GetLatestBundleResponse.java

@@ -16,6 +16,9 @@ public class GetLatestBundleResponse {
     @NonNull
     private String bundleId;
 
+    @Nullable
+    private JSONObject customProperties;
+
     @NonNull
     private String url;
 
@@ -27,6 +30,7 @@ public class GetLatestBundleResponse {
             this.artifactType = ArtifactType.ZIP;
         }
         this.bundleId = responseJson.optString("bundleId");
+        this.customProperties = responseJson.optJSONObject("customProperties");
         this.url = responseJson.optString("url");
     }
 
@@ -40,6 +44,11 @@ public class GetLatestBundleResponse {
         return bundleId;
     }
 
+    @Nullable
+    public JSONObject getCustomProperties() {
+        return customProperties;
+    }
+
     @NonNull
     public String getUrl() {
         return url;

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/events/DownloadBundleProgressEvent.java

@@ -0,0 +1,32 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class DownloadBundleProgressEvent implements Result {
+
+    @NonNull
+    private final String bundleId;
+
+    private final long downloadedBytes;
+    private final long totalBytes;
+    private final double progress;
+
+    public DownloadBundleProgressEvent(@NonNull String bundleId, long downloadedBytes, long totalBytes) {
+        this.bundleId = bundleId;
+        this.downloadedBytes = downloadedBytes;
+        this.totalBytes = totalBytes;
+        this.progress = (double) downloadedBytes / (double) totalBytes;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("bundleId", bundleId);
+        result.put("downloadedBytes", downloadedBytes);
+        result.put("progress", progress);
+        result.put("totalBytes", totalBytes);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/DownloadBundleOptions.java

@@ -12,20 +12,16 @@ public class DownloadBundleOptions {
     @NonNull
     private String bundleId;
 
-    @Nullable
-    private String checksum;
-
     @NonNull
     private String url;
 
-    public DownloadBundleOptions(@NonNull String artifactType, @NonNull String bundleId, @Nullable String checksum, @NonNull String url) {
+    public DownloadBundleOptions(@NonNull String artifactType, @NonNull String bundleId, @NonNull String url) {
         if (artifactType.equals("manifest")) {
             this.artifactType = ArtifactType.MANIFEST;
         } else {
             this.artifactType = ArtifactType.ZIP;
         }
         this.bundleId = bundleId;
-        this.checksum = checksum;
         this.url = url;
     }
 
@@ -39,11 +35,6 @@ public class DownloadBundleOptions {
         return bundleId;
     }
 
-    @Nullable
-    public String getChecksum() {
-        return checksum;
-    }
-
     @NonNull
     public String getUrl() {
         return url;

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/FetchLatestBundleResult.java

@@ -15,12 +15,21 @@ public class FetchLatestBundleResult implements Result {
     @Nullable
     private final String bundleId;
 
+    @Nullable
+    private final JSONObject customProperties;
+
     @Nullable
     private final String downloadUrl;
 
-    public FetchLatestBundleResult(@Nullable ArtifactType artifactType, @Nullable String bundleId, @Nullable String downloadUrl) {
+    public FetchLatestBundleResult(
+        @Nullable ArtifactType artifactType,
+        @Nullable String bundleId,
+        @Nullable JSONObject customProperties,
+        @Nullable String downloadUrl
+    ) {
         this.artifactType = artifactType;
         this.bundleId = bundleId;
+        this.customProperties = customProperties;
         this.downloadUrl = downloadUrl;
     }
 
@@ -33,6 +42,9 @@ public class FetchLatestBundleResult implements Result {
             result.put("artifactType", "zip");
         }
         result.put("bundleId", bundleId == null ? JSONObject.NULL : bundleId);
+        if (customProperties != null) {
+            result.put("customProperties", customProperties);
+        }
         if (downloadUrl != null) {
             result.put("downloadUrl", downloadUrl);
         }

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/ReadyResult.java

@@ -0,0 +1,32 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdate;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+import org.json.JSONObject;
+
+public class ReadyResult implements Result {
+
+    @Nullable
+    private String currentBundleId;
+
+    @Nullable
+    private String previousBundleId;
+
+    private boolean rollback;
+
+    public ReadyResult(@Nullable String currentBundleId, @Nullable String previousBundleId, boolean rollback) {
+        this.currentBundleId = currentBundleId;
+        this.previousBundleId = previousBundleId;
+        this.rollback = rollback;
+    }
+
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("currentBundleId", currentBundleId == null ? JSONObject.NULL : currentBundleId);
+        result.put("previousBundleId", previousBundleId == null ? JSONObject.NULL : previousBundleId);
+        result.put("rollback", rollback);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/interfaces/DownloadProgressCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.interfaces;
+
+public interface DownloadProgressCallback {
+    void onProgress(long downloadedBytes, long totalBytes);
+}