@capawesome/capacitor-live-update 6.4.1 → 6.5.0

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

@@ -0,0 +1,71 @@
+package io.capawesome.capacitorjs.plugins.liveupdate;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import java.io.File;
+import java.io.IOException;
+import java.util.concurrent.TimeUnit;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
+import okio.Buffer;
+import okio.BufferedSink;
+import okio.BufferedSource;
+import okio.Okio;
+
+public class LiveUpdateHttpClient {
+
+    @NonNull
+    private final LiveUpdateConfig config;
+
+    @Nullable
+    public static String getChecksumFromResponse(Response response) {
+        String checksum = response.header("X-Checksum");
+        if (checksum == null) {
+            return null;
+        }
+        return checksum;
+    }
+
+    @Nullable
+    public static String getSignatureFromResponse(Response response) {
+        String signature = response.header("X-Signature");
+        if (signature == null) {
+            return null;
+        }
+        return signature;
+    }
+
+    public LiveUpdateHttpClient(@NonNull LiveUpdateConfig config) {
+        this.config = config;
+    }
+
+    public Response execute(String url) throws IOException {
+        int httpTimeout = config.getHttpTimeout();
+        OkHttpClient okHttpClient = new OkHttpClient.Builder()
+            .connectTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .readTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .writeTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .build();
+        Request request = new Request.Builder().url(url).build();
+        return okHttpClient.newCall(request).execute();
+    }
+
+    public static void writeResponseBodyToFile(ResponseBody body, File file) throws IOException {
+        long contentLength = body.contentLength();
+        BufferedSource source = body.source();
+        BufferedSink sink = Okio.buffer(Okio.sink(file));
+        Buffer sinkBuffer = sink.getBuffer();
+        long totalBytesRead = 0;
+        int bufferSize = 8 * 1024;
+        for (long bytesRead; (bytesRead = source.read(sinkBuffer, bufferSize)) != -1;) {
+            sink.emit();
+            totalBytesRead += bytesRead;
+            int progress = (int) ((totalBytesRead * 100) / contentLength);
+        }
+        sink.flush();
+        sink.close();
+        source.close();
+    }
+}

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

@@ -19,7 +19,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.4.1";
+    public static final String VERSION = "6.5.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.";
@@ -36,6 +36,7 @@ public class LiveUpdatePlugin extends Plugin {
     public static final String ERROR_PUBLIC_KEY_INVALID = "Invalid public key.";
     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.";
 
     private boolean syncInProgress = false;
 
@@ -72,15 +73,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.deleteBundle(options, callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -108,15 +107,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.downloadBundle(options, callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -131,15 +128,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getBundle(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -154,15 +149,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getBundles(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -177,15 +170,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getChannel(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -200,15 +191,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getCustomId(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -223,15 +212,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getDeviceId(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -246,15 +233,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getVersionCode(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -269,15 +254,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.getVersionName(callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -287,8 +270,7 @@ public class LiveUpdatePlugin extends Plugin {
             implementation.ready();
             call.resolve();
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -298,8 +280,7 @@ public class LiveUpdatePlugin extends Plugin {
             implementation.reload();
             call.resolve();
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -309,8 +290,7 @@ public class LiveUpdatePlugin extends Plugin {
             implementation.reset();
             call.resolve();
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -332,15 +312,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.setBundle(options, callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -358,15 +336,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.setChannel(options, callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -388,15 +364,13 @@ public class LiveUpdatePlugin extends Plugin {
 
                 @Override
                 public void error(Exception exception) {
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.setCustomId(options, callback);
         } catch (Exception exception) {
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -425,16 +399,14 @@ public class LiveUpdatePlugin extends Plugin {
                 @Override
                 public void error(Exception exception) {
                     syncInProgress = false;
-                    Logger.error(TAG, exception.getMessage(), exception);
-                    call.reject(exception.getMessage());
+                    rejectCall(call, exception);
                 }
             };
 
             implementation.sync(callback);
         } catch (Exception exception) {
             syncInProgress = false;
-            Logger.error(TAG, exception.getMessage(), exception);
-            call.reject(exception.getMessage());
+            rejectCall(call, exception);
         }
     }
 
@@ -462,4 +434,15 @@ public class LiveUpdatePlugin extends Plugin {
 
         return config;
     }
+
+    private void rejectCall(PluginCall call, Exception exception) {
+        String message = exception.getMessage();
+        if (exception instanceof java.net.SocketTimeoutException) {
+            message = ERROR_HTTP_TIMEOUT;
+        } else {
+            message = message == null ? ERROR_UNKNOWN_ERROR : message;
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message);
+    }
 }

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

@@ -0,0 +1,58 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import org.json.JSONArray;
+import org.json.JSONException;
+
+public class Manifest {
+
+    private List<ManifestItem> items = new ArrayList<>();
+
+    public Manifest(JSONArray jsonArray) throws JSONException {
+        for (int i = 0; i < jsonArray.length(); i++) {
+            ManifestItem manifestItem = new ManifestItem(jsonArray.getJSONObject(i));
+            items.add(manifestItem);
+        }
+    }
+
+    public List<ManifestItem> getItems() {
+        return items;
+    }
+
+    public static List<ManifestItem> findDuplicateItems(Manifest manifest1, Manifest manifest2) {
+        List<ManifestItem> duplicateItems = new ArrayList<>();
+        Set<String> checksums = new HashSet<>();
+
+        for (ManifestItem item : manifest2.getItems()) {
+            checksums.add(item.getChecksum());
+        }
+
+        for (ManifestItem item : manifest1.getItems()) {
+            if (checksums.contains(item.getChecksum())) {
+                duplicateItems.add(item);
+            }
+        }
+
+        return duplicateItems;
+    }
+
+    public static List<ManifestItem> findMissingItems(Manifest manifest1, Manifest manifest2) {
+        List<ManifestItem> missingItems = new ArrayList<>();
+        Set<String> checksums = new HashSet<>();
+
+        for (ManifestItem item : manifest2.getItems()) {
+            checksums.add(item.getChecksum());
+        }
+
+        for (ManifestItem item : manifest1.getItems()) {
+            if (!checksums.contains(item.getChecksum())) {
+                missingItems.add(item);
+            }
+        }
+
+        return missingItems;
+    }
+}

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

@@ -0,0 +1,37 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes;
+
+import androidx.annotation.NonNull;
+import org.json.JSONObject;
+
+public class ManifestItem {
+
+    @NonNull
+    private String checksum;
+
+    @NonNull
+    private String href;
+
+    @NonNull
+    private int sizeInBytes;
+
+    public ManifestItem(JSONObject json) {
+        this.href = json.optString("href");
+        this.checksum = json.optString("checksum");
+        this.sizeInBytes = json.optInt("sizeInBytes");
+    }
+
+    @NonNull
+    public String getHref() {
+        return href;
+    }
+
+    @NonNull
+    public String getChecksum() {
+        return checksum;
+    }
+
+    @NonNull
+    public int getSizeInBytes() {
+        return sizeInBytes;
+    }
+}

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

@@ -1,49 +1,41 @@
 package io.capawesome.capacitorjs.plugins.liveupdate.classes.api;
 
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import io.capawesome.capacitorjs.plugins.liveupdate.enums.ArtifactType;
+import java.util.ArrayList;
+import java.util.List;
+import org.json.JSONArray;
 import org.json.JSONObject;
 
 public class GetLatestBundleResponse {
 
-    private String bundleId;
-
-    @Nullable
-    private String checksum;
+    @NonNull
+    private ArtifactType artifactType;
 
-    @Nullable
-    private String signature;
+    @NonNull
+    private String bundleId;
 
+    @NonNull
     private String url;
 
     public GetLatestBundleResponse(JSONObject responseJson) {
-        this.bundleId = responseJson.optString("bundleId");
-        String checksum = responseJson.optString("checksum", "null");
-        if (checksum.equals("null")) {
-            this.checksum = null;
+        String artifactType = responseJson.optString("artifactType");
+        if (artifactType.equals("manifest")) {
+            this.artifactType = ArtifactType.MANIFEST;
         } else {
-            this.checksum = checksum;
-        }
-        String signature = responseJson.optString("signature", "null");
-        if (signature.equals("null")) {
-            this.signature = null;
-        } else {
-            this.signature = signature;
+            this.artifactType = ArtifactType.ZIP;
         }
+        this.bundleId = responseJson.optString("bundleId");
         this.url = responseJson.optString("url");
     }
 
-    public String getBundleId() {
-        return bundleId;
-    }
-
-    @Nullable
-    public String getChecksum() {
-        return checksum;
+    public ArtifactType getArtifactType() {
+        return artifactType;
     }
 
-    @Nullable
-    public String getSignature() {
-        return signature;
+    public String getBundleId() {
+        return bundleId;
     }
 
     public String getUrl() {

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

@@ -3,6 +3,7 @@ package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSObject;
 import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+import org.json.JSONObject;
 
 public class GetChannelResult implements Result {
 
@@ -15,7 +16,7 @@ public class GetChannelResult implements Result {
 
     public JSObject toJSObject() {
         JSObject result = new JSObject();
-        result.put("channel", channel);
+        result.put("channel", channel == null ? JSONObject.NULL : channel);
         return result;
     }
 }

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

@@ -0,0 +1,6 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.enums;
+
+public enum ArtifactType {
+    MANIFEST,
+    ZIP
+}

package/dist/docs.json

@@ -79,7 +79,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get all available bundle identifiers.\n\nOnly available on Android and iOS.",
+        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetBundlesResult"
         ],

package/dist/esm/definitions.d.ts

@@ -102,7 +102,7 @@ export interface LiveUpdatePlugin {
      */
     getBundle(): Promise<GetBundleResult>;
     /**
-     * Get all available bundle identifiers.
+     * Get all identifiers of bundles that have been downloaded.
      *
      * Only available on Android and iOS.
      *

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @see https://capawesome.io/cloud/live-updates/advanced/privacy/\n       */\n      location?: 'us' | 'eu';\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all available bundle identifiers.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the device identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * Notify the plugin that the app is ready to use and no rollback is needed.\n   *\n   * **Attention**: This method should be called as soon as the app is ready to use\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<void>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setChannel(options: SetChannelOptions): Promise<void>;\n  /**\n   * Set the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): Promise<void>;\n  /**\n   * Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  sync(): Promise<SyncResult>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the bundle to verify the integrity of the ZIP file.\n   *\n   * Must be a SHA-256 hash in hexadecimal format.\n   *\n   * @since 6.1.0\n   * @example 'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'\n   */\n  checksum?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * The bundle must be a ZIP file containing at least a `index.html` file.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundleResult {\n  /**\n   * The unique identifier of the active bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundlesResult {\n  /**\n   * An array of unique identifiers of all available bundles.\n   *\n   * @since 5.0.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetChannelResult {\n  /**\n   * The channel of the app.\n   *\n   * If `null`, the app is using the default channel.\n   *\n   * @since 5.0.0\n   * @example 'production'\n   */\n  channel: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetDeviceIdResult {\n  /**\n   * The unique identifier of the device.\n   *\n   * On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\n   * The value of this property is the same for apps that come from the same vendor running on the same device.\n   *\n   * @since 5.0.0\n   *\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  deviceId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionCodeResult {\n  /**\n   * The version code of the app.\n   *\n   * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1\"\n   */\n  versionCode: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionNameResult {\n  /**\n   * The version name of the app.\n   *\n   * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1.0.0\"\n   */\n  versionName: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetCustomIdResult {\n  /**\n   * The custom identifier of the app.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel of the app.\n   *\n   * Set `null` to remove the channel.\n   *\n   * @since 5.0.0\n   */\n  channel: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetCustomIdOptions {\n  /**\n   * The custom identifier of the app.\n   *\n   * Set `null` to remove the custom identifier.\n   *\n   * @since 5.0.0\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SyncResult {\n  /**\n   * The identifier of the next bundle to use.\n   *\n   * If `null`, the app is up-to-date and no new bundle is available.\n   *\n   * @since 5.0.0\n   */\n  nextBundleId: string | null;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @see https://capawesome.io/cloud/live-updates/advanced/privacy/\n       */\n      location?: 'us' | 'eu';\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the device identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * Notify the plugin that the app is ready to use and no rollback is needed.\n   *\n   * **Attention**: This method should be called as soon as the app is ready to use\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<void>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setChannel(options: SetChannelOptions): Promise<void>;\n  /**\n   * Set the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): Promise<void>;\n  /**\n   * Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  sync(): Promise<SyncResult>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the bundle to verify the integrity of the ZIP file.\n   *\n   * Must be a SHA-256 hash in hexadecimal format.\n   *\n   * @since 6.1.0\n   * @example 'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'\n   */\n  checksum?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * The bundle must be a ZIP file containing at least a `index.html` file.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundleResult {\n  /**\n   * The unique identifier of the active bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundlesResult {\n  /**\n   * An array of unique identifiers of all available bundles.\n   *\n   * @since 5.0.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetChannelResult {\n  /**\n   * The channel of the app.\n   *\n   * If `null`, the app is using the default channel.\n   *\n   * @since 5.0.0\n   * @example 'production'\n   */\n  channel: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetDeviceIdResult {\n  /**\n   * The unique identifier of the device.\n   *\n   * On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\n   * The value of this property is the same for apps that come from the same vendor running on the same device.\n   *\n   * @since 5.0.0\n   *\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  deviceId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionCodeResult {\n  /**\n   * The version code of the app.\n   *\n   * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1\"\n   */\n  versionCode: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionNameResult {\n  /**\n   * The version name of the app.\n   *\n   * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1.0.0\"\n   */\n  versionName: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetCustomIdResult {\n  /**\n   * The custom identifier of the app.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel of the app.\n   *\n   * Set `null` to remove the channel.\n   *\n   * @since 5.0.0\n   */\n  channel: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetCustomIdOptions {\n  /**\n   * The custom identifier of the app.\n   *\n   * Set `null` to remove the custom identifier.\n   *\n   * @since 5.0.0\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SyncResult {\n  /**\n   * The identifier of the next bundle to use.\n   *\n   * If `null`, the app is up-to-date and no new bundle is available.\n   *\n   * @since 5.0.0\n   */\n  nextBundleId: string | null;\n}\n"]}

package/ios/Plugin/Classes/Manifest.swift

@@ -0,0 +1,20 @@
+import Foundation
+import Capacitor
+
+@objc public class Manifest: NSObject, Codable {
+    let items: [ManifestItem]
+
+    init(items: [ManifestItem]) {
+        self.items = items
+    }
+
+    public static func findDuplicateItems(_ manifest1: Manifest, _ manifest2: Manifest) -> [ManifestItem] {
+        let checksumSet = Set(manifest2.items.map { $0.checksum })
+        return manifest1.items.filter { checksumSet.contains($0.checksum) }
+    }
+
+    public static func findMissingItems(_ manifest1: Manifest, _ manifest2: Manifest) -> [ManifestItem] {
+        let checksumSet = Set(manifest2.items.map { $0.checksum })
+        return manifest1.items.filter { !checksumSet.contains($0.checksum) }
+    }
+}

package/ios/Plugin/Enums/ArtifactType.swift

@@ -0,0 +1,4 @@
+enum ArtifactType: String, Codable {
+    case manifest
+    case zip
+}

package/ios/Plugin/{Classes → Enums}/CustomError.swift

@@ -15,6 +15,7 @@ public enum CustomError: Error {
     case signatureMissing
     case signatureVerificationFailed
     case syncInProgress
+    case unknown
     case urlMissing
 }
 
@@ -49,6 +50,8 @@ extension CustomError: LocalizedError {
             return NSLocalizedString("Signature verification failed.", comment: "signatureVerificationFailed")
         case .syncInProgress:
             return NSLocalizedString("Sync is already in progress.", comment: "syncInProgress")
+        case .unknown:
+            return NSLocalizedString("An unknown error occurred.", comment: "unknown")
         case .urlMissing:
             return NSLocalizedString("url must be provided.", comment: "urlMissing")
         }