@capawesome/capacitor-live-update 5.0.0

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

@@ -0,0 +1,437 @@
+package io.capawesome.capacitorjs.plugins.liveupdate;
+
+import androidx.annotation.Nullable;
+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.options.DeleteBundleOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
+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.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.NonEmptyCallback;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+@CapacitorPlugin(name = "LiveUpdate")
+public class LiveUpdatePlugin extends Plugin {
+
+    public static final String TAG = "LiveUpdate";
+    public static final String VERSION = "5.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.";
+    public static final String ERROR_BUNDLE_ID_MISSING = "bundleId must be provided.";
+    public static final String ERROR_BUNDLE_INDEX_HTML_MISSING = "The bundle does not contain an index.html file.";
+    public static final String ERROR_BUNDLE_NOT_FOUND = "bundle not found.";
+    public static final String ERROR_CUSTOM_ID_MISSING = "customId must be provided.";
+    public static final String ERROR_DOWNLOAD_FAILED = "Bundle could not be downloaded.";
+    public static final String ERROR_URL_MISSING = "url must be provided.";
+
+    @Nullable
+    private LiveUpdateConfig config;
+
+    @Nullable
+    private LiveUpdate implementation;
+
+    public void load() {
+        try {
+            config = getLiveUpdateConfig();
+            implementation = new LiveUpdate(config, this);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+        }
+    }
+
+    @PluginMethod
+    public void deleteBundle(PluginCall call) {
+        try {
+            String bundleId = call.getString("bundleId");
+            if (bundleId == null) {
+                call.reject(ERROR_BUNDLE_ID_MISSING);
+                return;
+            }
+
+            DeleteBundleOptions options = new DeleteBundleOptions(bundleId);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    call.resolve();
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.deleteBundle(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void downloadBundle(PluginCall call) {
+        try {
+            String url = call.getString("url");
+            if (url == null) {
+                call.reject(ERROR_URL_MISSING);
+                return;
+            }
+            String bundleId = call.getString("bundleId");
+            if (bundleId == null) {
+                call.reject(ERROR_BUNDLE_ID_MISSING);
+                return;
+            }
+
+            DownloadBundleOptions options = new DownloadBundleOptions(bundleId, url);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    call.resolve();
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.downloadBundle(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @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) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getBundle(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getBundles(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getBundles(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getChannel(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getChannel(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getCustomId(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getCustomId(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getDeviceId(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getDeviceId(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getVersionCode(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getVersionCode(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getVersionName(PluginCall call) {
+        try {
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.getVersionName(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void ready(PluginCall call) {
+        try {
+            implementation.ready();
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void reload(PluginCall call) {
+        try {
+            implementation.reload();
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void reset(PluginCall call) {
+        try {
+            implementation.reset();
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @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) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.setBundle(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void setChannel(PluginCall call) {
+        try {
+            String channel = call.getString("channel");
+
+            SetChannelOptions options = new SetChannelOptions(channel);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    call.resolve();
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.setChannel(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void setCustomId(PluginCall call) {
+        try {
+            String customId = call.getString("customId");
+            if (customId == null) {
+                call.reject(ERROR_CUSTOM_ID_MISSING);
+                return;
+            }
+
+            SetCustomIdOptions options = new SetCustomIdOptions(customId);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    call.resolve();
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.setCustomId(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void sync(PluginCall call) {
+        try {
+            String appId = config.getAppId();
+            if (appId == null) {
+                call.reject(ERROR_APP_ID_MISSING);
+                return;
+            }
+            NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.sync(callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    private LiveUpdateConfig getLiveUpdateConfig() {
+        LiveUpdateConfig config = new LiveUpdateConfig();
+
+        String appId = getConfig().getString("appId", config.getAppId());
+        config.setAppId(appId);
+        boolean autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.getAutoDeleteBundles());
+        config.setAutoDeleteBundles(autoDeleteBundles);
+        boolean enabled = getConfig().getBoolean("enabled", config.getEnabled());
+        config.setEnabled(enabled);
+        int readyTimeout = getConfig().getInt("readyTimeout", config.getReadyTimeout());
+        config.setReadyTimeout(readyTimeout);
+        boolean resetOnUpdate = getConfig().getBoolean("resetOnUpdate", config.getResetOnUpdate());
+        config.setResetOnUpdate(resetOnUpdate);
+
+        return config;
+    }
+}

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

@@ -0,0 +1,86 @@
+package io.capawesome.capacitorjs.plugins.liveupdate;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.SharedPreferences;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import java.util.UUID;
+
+public class LiveUpdatePreferences {
+
+    @NonNull
+    private final Context context;
+
+    @NonNull
+    private final SharedPreferences.Editor settingsEditor;
+
+    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
+
+    public LiveUpdatePreferences(@NonNull Context context) {
+        this.context = context;
+        this.settingsEditor = context.getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE).edit();
+    }
+
+    @Nullable
+    public String getChannel() {
+        return context.getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE).getString(channelKey, null);
+    }
+
+    @Nullable
+    public String getCustomId() {
+        return context.getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE).getString(customIdKey, null);
+    }
+
+    @Nullable
+    public String getDeviceIdForApp(@Nullable String appId) {
+        if (appId == null) {
+            return context
+                .getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE)
+                .getString(deviceIdKey, null);
+        } else {
+            return context
+                .getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE)
+                .getString(deviceIdKey + "_" + appId, null);
+        }
+    }
+
+    public int getLastVersionCode() {
+        return context.getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE).getInt(lastVersionCodeKey, 0);
+    }
+
+    public void setChannel(@Nullable String channel) {
+        if (channel == null) {
+            settingsEditor.remove(channelKey);
+        } else {
+            settingsEditor.putString(channelKey, channel);
+        }
+        settingsEditor.apply();
+    }
+
+    public void setCustomId(@Nullable String customId) {
+        if (customId == null) {
+            settingsEditor.remove(customIdKey);
+        } else {
+            settingsEditor.putString(customIdKey, customId);
+        }
+        settingsEditor.apply();
+    }
+
+    public void setDeviceIdForApp(@Nullable String appId, @NonNull String deviceId) {
+        if (appId == null) {
+            settingsEditor.putString(deviceIdKey, deviceId);
+        } else {
+            settingsEditor.putString(deviceIdKey + "_" + appId, deviceId);
+        }
+        settingsEditor.apply();
+    }
+
+    public void setLastVersionCode(int lastVersionCode) {
+        settingsEditor.putInt(lastVersionCodeKey, lastVersionCode);
+        settingsEditor.apply();
+    }
+}

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

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.api;
+
+import androidx.annotation.Nullable;
+import org.json.JSONObject;
+
+public class GetLatestBundleResponse {
+
+    private String bundleId;
+    private String url;
+
+    public GetLatestBundleResponse(JSONObject responseJson) {
+        this.bundleId = responseJson.optString("bundleId");
+        this.url = responseJson.optString("url");
+    }
+
+    public String getBundleId() {
+        return bundleId;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+}

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

@@ -0,0 +1,18 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class DeleteBundleOptions {
+
+    @NonNull
+    private String bundleId;
+
+    public DeleteBundleOptions(@NonNull String bundleId) {
+        this.bundleId = bundleId;
+    }
+
+    @NonNull
+    public String getBundleId() {
+        return bundleId;
+    }
+}

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

@@ -0,0 +1,27 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class DownloadBundleOptions {
+
+    @NonNull
+    private String bundleId;
+
+    @NonNull
+    private String url;
+
+    public DownloadBundleOptions(@NonNull String bundleId, @NonNull String url) {
+        this.bundleId = bundleId;
+        this.url = url;
+    }
+
+    @NonNull
+    public String getBundleId() {
+        return bundleId;
+    }
+
+    @NonNull
+    public String getUrl() {
+        return url;
+    }
+}

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

@@ -0,0 +1,18 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class SetBundleOptions {
+
+    @NonNull
+    private String bundleId;
+
+    public SetBundleOptions(@NonNull String bundleId) {
+        this.bundleId = bundleId;
+    }
+
+    @NonNull
+    public String getBundleId() {
+        return bundleId;
+    }
+}

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

@@ -0,0 +1,18 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class SetChannelOptions {
+
+    @NonNull
+    private String channel;
+
+    public SetChannelOptions(@NonNull String channel) {
+        this.channel = channel;
+    }
+
+    @NonNull
+    public String getChannel() {
+        return channel;
+    }
+}

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

@@ -0,0 +1,18 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class SetCustomIdOptions {
+
+    @NonNull
+    private String customId;
+
+    public SetCustomIdOptions(@NonNull String customId) {
+        this.customId = customId;
+    }
+
+    @NonNull
+    public String getCustomId() {
+        return customId;
+    }
+}

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

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