@capawesome/capacitor-live-update 8.1.1 → 8.2.1-dev.70823ec8.1778138208

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

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.api;
+
+import androidx.annotation.NonNull;
+import org.json.JSONObject;
+
+public class GetChannelsResponseItem {
+
+    @NonNull
+    private final String id;
+
+    @NonNull
+    private final String name;
+
+    public GetChannelsResponseItem(@NonNull JSONObject responseJson) {
+        this.id = responseJson.optString("id");
+        this.name = responseJson.optString("name");
+    }
+
+    @NonNull
+    public String getId() {
+        return id;
+    }
+
+    @NonNull
+    public String getName() {
+        return name;
+    }
+}

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

@@ -0,0 +1,38 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+
+public class FetchChannelsOptions {
+
+    @Nullable
+    private final Integer limit;
+
+    @Nullable
+    private final Integer offset;
+
+    @Nullable
+    private final String query;
+
+    public FetchChannelsOptions(@NonNull PluginCall call) {
+        this.limit = call.getInt("limit");
+        this.offset = call.getInt("offset");
+        this.query = call.getString("query");
+    }
+
+    @Nullable
+    public Integer getLimit() {
+        return limit;
+    }
+
+    @Nullable
+    public Integer getOffset() {
+        return offset;
+    }
+
+    @Nullable
+    public String getQuery() {
+        return query;
+    }
+}

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

@@ -6,17 +6,32 @@ import com.getcapacitor.PluginCall;
 
 public class FetchLatestBundleOptions {
 
+    @Nullable
+    private final String appId;
+
     @Nullable
     private final String channel;
 
     public FetchLatestBundleOptions(@NonNull PluginCall call) {
+        this.appId = null;
         this.channel = call.getString("channel", null);
     }
 
     public FetchLatestBundleOptions(@Nullable String channel) {
+        this.appId = null;
+        this.channel = channel;
+    }
+
+    public FetchLatestBundleOptions(@Nullable String appId, @Nullable String channel) {
+        this.appId = appId;
         this.channel = channel;
     }
 
+    @Nullable
+    public String getAppId() {
+        return appId;
+    }
+
     @Nullable
     public String getChannel() {
         return channel;

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

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class ChannelResult implements Result {
+
+    @NonNull
+    private final String id;
+
+    @NonNull
+    private final String name;
+
+    public ChannelResult(@NonNull String id, @NonNull String name) {
+        this.id = id;
+        this.name = name;
+    }
+
+    @NonNull
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("id", id);
+        result.put("name", name);
+        return result;
+    }
+}

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

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class FetchChannelsResult implements Result {
+
+    @NonNull
+    private final ChannelResult[] channels;
+
+    public FetchChannelsResult(@NonNull ChannelResult[] channels) {
+        this.channels = channels;
+    }
+
+    @NonNull
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        JSArray channelsArray = new JSArray();
+        for (ChannelResult channel : channels) {
+            channelsArray.put(channel.toJSObject());
+        }
+        result.put("channels", channelsArray);
+        return result;
+    }
+}

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

@@ -43,6 +43,36 @@ public class FetchLatestBundleResult implements Result {
         this.signature = signature;
     }
 
+    @Nullable
+    public ArtifactType getArtifactType() {
+        return artifactType;
+    }
+
+    @Nullable
+    public String getBundleId() {
+        return bundleId;
+    }
+
+    @Nullable
+    public String getChecksum() {
+        return checksum;
+    }
+
+    @Nullable
+    public JSONObject getCustomProperties() {
+        return customProperties;
+    }
+
+    @Nullable
+    public String getDownloadUrl() {
+        return downloadUrl;
+    }
+
+    @Nullable
+    public String getSignature() {
+        return signature;
+    }
+
     @NonNull
     public JSObject toJSObject() {
         JSObject result = new JSObject();

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/providers/ionic/LiveUpdateIonicManager.java

@@ -0,0 +1,232 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.providers.ionic;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdate;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdatePlugin;
+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.results.FetchLatestBundleResult;
+import io.capawesome.capacitorjs.plugins.liveupdate.enums.ArtifactType;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.NonEmptyCallback;
+import io.ionic.liveupdateprovider.FederatedCapacitorSyncResult;
+import io.ionic.liveupdateprovider.LiveUpdateProviderError;
+import io.ionic.liveupdateprovider.LiveUpdateProviderManager;
+import io.ionic.liveupdateprovider.LiveUpdateProviderSyncCallback;
+import java.io.File;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import org.json.JSONObject;
+
+/**
+ * Ionic Live Update Provider manager backed by the Capawesome live update plugin.
+ *
+ * Each manager instance is scoped by a {@code managerKey} so that multiple shells (Portals or
+ * Federated Capacitor apps) can persist their own active bundle without colliding with each
+ * other or with the standalone plugin's {@code currentBundleId} / {@code nextBundleId} state.
+ *
+ * Provider config keys (V1):
+ * <ul>
+ *   <li>{@code managerKey} (required) — scopes per-manager persisted state</li>
+ *   <li>{@code appId} (optional) — Capawesome Cloud app UUID; falls back to plugin config</li>
+ *   <li>{@code channel} (optional) — channel to sync; falls back to plugin config</li>
+ * </ul>
+ */
+public class LiveUpdateIonicManager implements LiveUpdateProviderManager {
+
+    public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdateIonicProvider";
+    public static final String PREF_PREFIX_LAST_SYNCED_BUNDLE_ID = "lastSyncedBundleId.";
+
+    @Nullable
+    private final String appId;
+
+    @Nullable
+    private final String channel;
+
+    @Nullable
+    private File latestAppDirectory;
+
+    @NonNull
+    private final LiveUpdate liveUpdate;
+
+    @NonNull
+    private final String managerKey;
+
+    @NonNull
+    private final SharedPreferences sharedPreferences;
+
+    public LiveUpdateIonicManager(@NonNull Context context, @NonNull Map<String, ?> config, @NonNull LiveUpdate liveUpdate)
+        throws LiveUpdateProviderError.InvalidConfiguration {
+        Object managerKeyValue = config.get("managerKey");
+        if (!(managerKeyValue instanceof String) || ((String) managerKeyValue).isEmpty()) {
+            throw new LiveUpdateProviderError.InvalidConfiguration(LiveUpdatePlugin.ERROR_MANAGER_KEY_MISSING, null);
+        }
+        this.managerKey = (String) managerKeyValue;
+
+        Object appIdValue = config.get("appId");
+        this.appId = appIdValue instanceof String ? (String) appIdValue : null;
+
+        Object channelValue = config.get("channel");
+        this.channel = channelValue instanceof String ? (String) channelValue : null;
+
+        this.liveUpdate = liveUpdate;
+        this.sharedPreferences = context.getApplicationContext().getSharedPreferences(SHARED_PREFERENCES_NAME, Context.MODE_PRIVATE);
+
+        // Restore the last synced bundle directory, if any.
+        String persistedBundleId = sharedPreferences.getString(getLastSyncedBundleIdKey(), null);
+        if (persistedBundleId != null) {
+            this.latestAppDirectory = liveUpdate.getBundleDirectory(persistedBundleId);
+        }
+    }
+
+    @Nullable
+    @Override
+    public File getLatestAppDirectory() {
+        return latestAppDirectory;
+    }
+
+    @Override
+    public void sync(@Nullable LiveUpdateProviderSyncCallback callback) {
+        try {
+            FetchLatestBundleOptions fetchOptions = new FetchLatestBundleOptions(appId, channel);
+            liveUpdate.fetchLatestBundle(
+                fetchOptions,
+                new NonEmptyCallback<FetchLatestBundleResult>() {
+                    @Override
+                    public void success(@NonNull FetchLatestBundleResult result) {
+                        handleFetchLatestBundleSuccess(result, callback);
+                    }
+
+                    @Override
+                    public void error(@NonNull Exception exception) {
+                        notifyFailure(callback, exception);
+                    }
+                }
+            );
+        } catch (Exception exception) {
+            notifyFailure(callback, exception);
+        }
+    }
+
+    private void handleFetchLatestBundleSuccess(
+        @NonNull FetchLatestBundleResult result,
+        @Nullable LiveUpdateProviderSyncCallback callback
+    ) {
+        try {
+            String bundleId = result.getBundleId();
+            if (bundleId == null) {
+                // No update available; report success without changing state.
+                notifySuccess(callback, null, null);
+                return;
+            }
+
+            // Bundle already on disk — just point latestAppDirectory at it and persist.
+            File existingDirectory = liveUpdate.getBundleDirectory(bundleId);
+            if (existingDirectory != null) {
+                applySyncedBundle(bundleId, existingDirectory);
+                notifySuccess(callback, bundleId, result.getCustomProperties());
+                return;
+            }
+
+            // Otherwise, download and then apply.
+            String downloadUrl = result.getDownloadUrl();
+            if (downloadUrl == null || downloadUrl.isEmpty()) {
+                notifyFailure(callback, new Exception(LiveUpdatePlugin.ERROR_DOWNLOAD_URL_MISSING));
+                return;
+            }
+            ArtifactType artifactType = result.getArtifactType() == null ? ArtifactType.ZIP : result.getArtifactType();
+            String artifactTypeString = artifactType == ArtifactType.MANIFEST ? "manifest" : "zip";
+            DownloadBundleOptions downloadOptions = new DownloadBundleOptions(
+                artifactTypeString,
+                bundleId,
+                result.getChecksum(),
+                result.getSignature(),
+                downloadUrl
+            );
+            liveUpdate.downloadBundle(
+                downloadOptions,
+                new EmptyCallback() {
+                    @Override
+                    public void success() {
+                        File downloadedDirectory = liveUpdate.getBundleDirectory(bundleId);
+                        if (downloadedDirectory == null) {
+                            notifyFailure(callback, new Exception(LiveUpdatePlugin.ERROR_BUNDLE_DIRECTORY_NOT_FOUND));
+                            return;
+                        }
+                        applySyncedBundle(bundleId, downloadedDirectory);
+                        notifySuccess(callback, bundleId, result.getCustomProperties());
+                    }
+
+                    @Override
+                    public void error(@NonNull Exception exception) {
+                        notifyFailure(callback, exception);
+                    }
+                }
+            );
+        } catch (Exception exception) {
+            notifyFailure(callback, exception);
+        }
+    }
+
+    private void applySyncedBundle(@NonNull String bundleId, @NonNull File directory) {
+        latestAppDirectory = directory;
+        sharedPreferences.edit().putString(getLastSyncedBundleIdKey(), bundleId).apply();
+    }
+
+    private void notifySuccess(
+        @Nullable LiveUpdateProviderSyncCallback callback,
+        @Nullable String bundleId,
+        @Nullable JSONObject customProperties
+    ) {
+        if (callback == null) {
+            return;
+        }
+        Map<String, Object> metadata = new HashMap<>();
+        if (bundleId != null) {
+            metadata.put("bundleId", bundleId);
+        }
+        if (channel != null) {
+            metadata.put("channel", channel);
+        }
+        if (customProperties != null) {
+            Map<String, Object> customPropertiesMap = jsonObjectToMap(customProperties);
+            if (!customPropertiesMap.isEmpty()) {
+                metadata.put("customProperties", customPropertiesMap);
+            }
+        }
+        callback.onSuccess(new FederatedCapacitorSyncResult(metadata));
+    }
+
+    private void notifyFailure(@Nullable LiveUpdateProviderSyncCallback callback, @NonNull Exception exception) {
+        Logger.error(LiveUpdatePlugin.TAG, "Ionic provider sync failed: " + exception.getMessage(), exception);
+        if (callback == null) {
+            return;
+        }
+        String message = exception.getMessage() == null ? LiveUpdatePlugin.ERROR_UNKNOWN_ERROR : exception.getMessage();
+        callback.onFailure(new LiveUpdateProviderError.SyncFailed(message, exception));
+    }
+
+    @NonNull
+    private String getLastSyncedBundleIdKey() {
+        return PREF_PREFIX_LAST_SYNCED_BUNDLE_ID + managerKey;
+    }
+
+    @NonNull
+    private static Map<String, Object> jsonObjectToMap(@NonNull JSONObject jsonObject) {
+        Map<String, Object> map = new HashMap<>();
+        Iterator<String> keys = jsonObject.keys();
+        while (keys.hasNext()) {
+            String key = keys.next();
+            Object value = jsonObject.opt(key);
+            if (value != null && value != JSONObject.NULL) {
+                map.put(key, value);
+            }
+        }
+        return map;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/providers/ionic/LiveUpdateIonicProvider.java

@@ -0,0 +1,41 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.providers.ionic;
+
+import android.content.Context;
+import androidx.annotation.NonNull;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdate;
+import io.ionic.liveupdateprovider.LiveUpdateProvider;
+import io.ionic.liveupdateprovider.LiveUpdateProviderError;
+import io.ionic.liveupdateprovider.LiveUpdateProviderManager;
+import java.util.Map;
+
+/**
+ * Ionic Live Update Provider implementation backed by the Capawesome live update plugin.
+ *
+ * Registered with {@link io.ionic.liveupdateprovider.LiveUpdateProviderRegistry} when the
+ * Capacitor plugin loads, so Federated Capacitor can resolve provider id {@code "capawesome"}
+ * and create managers from the per-shell configuration.
+ */
+public class LiveUpdateIonicProvider implements LiveUpdateProvider {
+
+    public static final String ID = "capawesome";
+
+    @NonNull
+    private final LiveUpdate liveUpdate;
+
+    public LiveUpdateIonicProvider(@NonNull LiveUpdate liveUpdate) {
+        this.liveUpdate = liveUpdate;
+    }
+
+    @NonNull
+    @Override
+    public String getId() {
+        return ID;
+    }
+
+    @NonNull
+    @Override
+    public LiveUpdateProviderManager createManager(@NonNull Context context, @NonNull Map<String, ?> config)
+        throws LiveUpdateProviderError.InvalidConfiguration {
+        return new LiveUpdateIonicManager(context, config, liveUpdate);
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/providers/ionic/LiveUpdateIonicProviderRegistration.java

@@ -0,0 +1,46 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.providers.ionic;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.Logger;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdate;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdatePlugin;
+import io.ionic.liveupdateprovider.LiveUpdateProviderRegistry;
+
+/**
+ * Helper that registers the Capawesome live update provider with the Ionic
+ * {@link LiveUpdateProviderRegistry}, but only when the optional
+ * {@code io.ionic:liveupdateprovider} dependency is present at runtime.
+ *
+ * The Gradle build wires the SDK as either {@code implementation} (when the consumer opts in
+ * via {@code capawesomeCapacitorLiveUpdateIncludeIonicProvider = true}) or {@code compileOnly}
+ * (the default). When opted out, the SDK classes are stripped from the consumer APK and the
+ * reflection check below short-circuits registration.
+ */
+public final class LiveUpdateIonicProviderRegistration {
+
+    private LiveUpdateIonicProviderRegistration() {
+        // Static utility — no instances.
+    }
+
+    public static boolean isAvailable() {
+        try {
+            Class.forName("io.ionic.liveupdateprovider.LiveUpdateProviderRegistry");
+            return true;
+        } catch (ClassNotFoundException exception) {
+            return false;
+        }
+    }
+
+    public static void tryRegister(@NonNull LiveUpdate liveUpdate) {
+        try {
+            if (LiveUpdateProviderRegistry.resolve(LiveUpdateIonicProvider.ID) != null) {
+                Logger.debug(LiveUpdatePlugin.TAG, "Ionic provider '" + LiveUpdateIonicProvider.ID + "' already registered.");
+                return;
+            }
+            LiveUpdateProviderRegistry.register(new LiveUpdateIonicProvider(liveUpdate));
+            Logger.debug(LiveUpdatePlugin.TAG, "Registered Ionic provider '" + LiveUpdateIonicProvider.ID + "'.");
+        } catch (Exception exception) {
+            Logger.error(LiveUpdatePlugin.TAG, "Failed to register Ionic provider: " + exception.getMessage(), exception);
+        }
+    }
+}