@capawesome/capacitor-live-update 6.0.8 → 6.2.0-dev.0a2a6a5.1722676620

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

@@ -1,17 +1,22 @@
 package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 public class DownloadBundleOptions {
 
     @NonNull
     private String bundleId;
 
+    @Nullable
+    private String checksum;
+
     @NonNull
     private String url;
 
-    public DownloadBundleOptions(@NonNull String bundleId, @NonNull String url) {
+    public DownloadBundleOptions(@NonNull String bundleId, @Nullable String checksum, @NonNull String url) {
         this.bundleId = bundleId;
+        this.checksum = checksum;
         this.url = url;
     }
 
@@ -20,6 +25,11 @@ 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/GetBundleResult.java

@@ -4,6 +4,7 @@ import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.LiveUpdate;
 import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 import org.json.JSONObject;
 
@@ -18,7 +19,7 @@ public class GetBundleResult implements Result {
 
     public JSObject toJSObject() {
         JSObject result = new JSObject();
-        result.put("bundleId", bundleId == null ? JSONObject.NULL : bundleId);
+        result.put("bundleId", bundleId.equals(LiveUpdate.DEFAULT_WEB_ASSET_DIR) ? JSONObject.NULL : bundleId);
         return result;
     }
 }

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.equals(LiveUpdate.DEFAULT_WEB_ASSET_DIR) ? JSONObject.NULL : currentBundleId);
+        result.put("previousBundleId", previousBundleId.equals(LiveUpdate.DEFAULT_WEB_ASSET_DIR) ? JSONObject.NULL : previousBundleId);
+        result.put("rollback", rollback);
+        return result;
+    }
+}

package/dist/docs.json

@@ -172,9 +172,9 @@
       },
       {
         "name": "ready",
-        "signature": "() => Promise<void>",
+        "signature": "() => Promise<ReadyResult>",
         "parameters": [],
-        "returns": "Promise<void>",
+        "returns": "Promise<ReadyResult>",
         "tags": [
           {
             "name": "since",
@@ -182,7 +182,9 @@
           }
         ],
         "docs": "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\nto prevent the app from being reset to the default bundle.\n\nOnly available on Android and iOS.",
-        "complexTypes": [],
+        "complexTypes": [
+          "ReadyResult"
+        ],
         "slug": "ready"
       },
       {
@@ -343,34 +345,50 @@
       "methods": [],
       "properties": [
         {
-          "name": "url",
+          "name": "bundleId",
           "tags": [
             {
               "text": "5.0.0",
               "name": "since"
             },
             {
-              "text": "'https://example.com/bundle.zip'",
+              "text": "'1.0.0'",
               "name": "example"
             }
           ],
-          "docs": "The URL of the bundle to download.\n\nThe bundle must be a ZIP file containing at least a `index.html` file.",
+          "docs": "The unique identifier of the bundle.",
           "complexTypes": [],
           "type": "string"
         },
         {
-          "name": "bundleId",
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "6.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'",
+              "name": "example"
+            }
+          ],
+          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in hexadecimal format.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
           "tags": [
             {
               "text": "5.0.0",
               "name": "since"
             },
             {
-              "text": "'1.0.0'",
+              "text": "'https://example.com/bundle.zip'",
               "name": "example"
             }
           ],
-          "docs": "The unique identifier of the bundle.",
+          "docs": "The URL of the bundle to download.\n\nThe bundle must be a ZIP file containing at least a `index.html` file.",
           "complexTypes": [],
           "type": "string"
         }
@@ -582,6 +600,56 @@
         }
       ]
     },
+    {
+      "name": "ReadyResult",
+      "slug": "readyresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "previousBundleId",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the previous bundle used.\n\nIf `null`, the default bundle was used.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "currentBundleId",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the current bundle used.\n\nIf `null`, the default bundle is being used.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "rollback",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether or not the app was reset to the default bundle.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "SetBundleOptions",
       "slug": "setbundleoptions",
@@ -746,6 +814,46 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "location",
+          "tags": [
+            {
+              "text": "6.2.0",
+              "name": "since"
+            },
+            {
+              "text": "'us'",
+              "name": "default"
+            },
+            {
+              "text": "'eu'",
+              "name": "example"
+            },
+            {
+              "text": "https ://capawesome.io/cloud/live-updates/advanced/privacy/",
+              "name": "see"
+            }
+          ],
+          "docs": "The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).",
+          "complexTypes": [],
+          "type": "'us' | 'eu' | undefined"
+        },
+        {
+          "name": "publicKey",
+          "tags": [
+            {
+              "text": "6.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'",
+              "name": "example"
+            }
+          ],
+          "docs": "The public key to verify the integrity of the bundle.\n\nThe public key must be a PEM-encoded RSA public key.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "readyTimeout",
           "tags": [

package/dist/esm/definitions.d.ts

@@ -24,6 +24,24 @@ declare module '@capacitor/cli' {
              * @default true
              */
             enabled?: boolean;
+            /**
+             * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).
+             *
+             * @since 6.2.0
+             * @default 'us'
+             * @example 'eu'
+             * @see https://capawesome.io/cloud/live-updates/advanced/privacy/
+             */
+            location?: 'us' | 'eu';
+            /**
+             * The public key to verify the integrity of the bundle.
+             *
+             * The public key must be a PEM-encoded RSA public key.
+             *
+             * @since 6.1.0
+             * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'
+             */
+            publicKey?: string;
             /**
              * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.
              *
@@ -124,7 +142,7 @@ export interface LiveUpdatePlugin {
      *
      * @since 5.0.0
      */
-    ready(): Promise<void>;
+    ready(): Promise<ReadyResult>;
     /**
      * Reload the app to apply the new bundle.
      *
@@ -193,6 +211,22 @@ export interface DeleteBundleOptions {
     bundleId: string;
 }
 export interface DownloadBundleOptions {
+    /**
+     * The unique identifier of the bundle.
+     *
+     * @since 5.0.0
+     * @example '1.0.0'
+     */
+    bundleId: string;
+    /**
+     * The checksum of the bundle to verify the integrity of the ZIP file.
+     *
+     * Must be a SHA-256 hash in hexadecimal format.
+     *
+     * @since 6.1.0
+     * @example 'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'
+     */
+    checksum?: string;
     /**
      * The URL of the bundle to download.
      *
@@ -202,13 +236,6 @@ export interface DownloadBundleOptions {
      * @example 'https://example.com/bundle.zip'
      */
     url: string;
-    /**
-     * The unique identifier of the bundle.
-     *
-     * @since 5.0.0
-     * @example '1.0.0'
-     */
-    bundleId: string;
 }
 /**
  * @since 5.0.0
@@ -309,6 +336,33 @@ export interface GetCustomIdResult {
      */
     customId: string | null;
 }
+/**
+ * @since 7.0.0
+ */
+export interface ReadyResult {
+    /**
+     * The identifier of the previous bundle used.
+     *
+     * If `null`, the default bundle was used.
+     *
+     * @since 7.0.0
+     */
+    previousBundleId: string | null;
+    /**
+     * The identifier of the current bundle used.
+     *
+     * If `null`, the default bundle is being used.
+     *
+     * @since 7.0.0
+     */
+    currentBundleId: string | null;
+    /**
+     * Whether or not the app was reset to the default bundle.
+     *
+     * @since 7.0.0
+     */
+    rollback: boolean;
+}
 /**
  * @since 5.0.0
  */

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       * @since 5.0.0\n       * @example '4100e356-e851-47fe-9d3c-b411eb325a99'\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       * 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 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 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   * The unique identifier of the bundle.\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 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       * @since 5.0.0\n       * @example '4100e356-e851-47fe-9d3c-b411eb325a99'\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       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\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<ReadyResult>;\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 7.0.0\n */\nexport interface ReadyResult {\n  /**\n   * The identifier of the previous bundle used.\n   *\n   * If `null`, the default bundle was used.\n   *\n   * @since 7.0.0\n   */\n  previousBundleId: string | null;\n  /**\n   * The identifier of the current bundle used.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 7.0.0\n   */\n  currentBundleId: string | null;\n  /**\n   * Whether or not the app was reset to the default bundle.\n   *\n   * @since 7.0.0\n   */\n  rollback: boolean;\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/dist/esm/web.d.ts

@@ -1,5 +1,5 @@
 import { WebPlugin } from '@capacitor/core';
-import type { DeleteBundleOptions, DownloadBundleOptions, GetBundleResult, GetBundlesResult, GetChannelResult, GetCustomIdResult, GetDeviceIdResult, GetVersionCodeResult, GetVersionNameResult, LiveUpdatePlugin, SetBundleOptions, SetChannelOptions, SetCustomIdOptions, SyncResult } from './definitions';
+import type { DeleteBundleOptions, DownloadBundleOptions, GetBundleResult, GetBundlesResult, GetChannelResult, GetCustomIdResult, GetDeviceIdResult, GetVersionCodeResult, GetVersionNameResult, LiveUpdatePlugin, ReadyResult, SetBundleOptions, SetChannelOptions, SetCustomIdOptions, SyncResult } from './definitions';
 export declare class LiveUpdateWeb extends WebPlugin implements LiveUpdatePlugin {
     deleteBundle(_options: DeleteBundleOptions): Promise<void>;
     downloadBundle(_options: DownloadBundleOptions): Promise<void>;
@@ -10,7 +10,7 @@ export declare class LiveUpdateWeb extends WebPlugin implements LiveUpdatePlugin
     getDeviceId(): Promise<GetDeviceIdResult>;
     getVersionCode(): Promise<GetVersionCodeResult>;
     getVersionName(): Promise<GetVersionNameResult>;
-    ready(): Promise<void>;
+    ready(): Promise<ReadyResult>;
     reload(): Promise<void>;
     reset(): Promise<void>;
     setBundle(_options: SetBundleOptions): Promise<void>;

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAmB5C,MAAM,OAAO,aAAc,SAAQ,SAAS;IACnC,KAAK,CAAC,YAAY,CAAC,QAA6B;QACrD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAA+B;QACzD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,QAA0B;QAC/C,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAA2B;QACjD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,QAA4B;QACnD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,uBAAuB;QAC7B,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  DeleteBundleOptions,\n  DownloadBundleOptions,\n  GetBundleResult,\n  GetBundlesResult,\n  GetChannelResult,\n  GetCustomIdResult,\n  GetDeviceIdResult,\n  GetVersionCodeResult,\n  GetVersionNameResult,\n  LiveUpdatePlugin,\n  SetBundleOptions,\n  SetChannelOptions,\n  SetCustomIdOptions,\n  SyncResult,\n} from './definitions';\n\nexport class LiveUpdateWeb extends WebPlugin implements LiveUpdatePlugin {\n  public async deleteBundle(_options: DeleteBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async downloadBundle(_options: DownloadBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async getBundle(): Promise<GetBundleResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getBundles(): Promise<GetBundlesResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getChannel(): Promise<GetChannelResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getCustomId(): Promise<GetCustomIdResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getDeviceId(): Promise<GetDeviceIdResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getVersionCode(): Promise<GetVersionCodeResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getVersionName(): Promise<GetVersionNameResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async ready(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async reload(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async reset(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setBundle(_options: SetBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setChannel(_options: SetChannelOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setCustomId(_options: SetCustomIdOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async sync(): Promise<SyncResult> {\n    this.throwUnimplementedError();\n  }\n\n  private throwUnimplementedError(): never {\n    throw this.unimplemented('Not implemented on web.');\n  }\n}\n"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAoB5C,MAAM,OAAO,aAAc,SAAQ,SAAS;IACnC,KAAK,CAAC,YAAY,CAAC,QAA6B;QACrD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAA+B;QACzD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,QAA0B;QAC/C,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAA2B;QACjD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,QAA4B;QACnD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,uBAAuB;QAC7B,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  DeleteBundleOptions,\n  DownloadBundleOptions,\n  GetBundleResult,\n  GetBundlesResult,\n  GetChannelResult,\n  GetCustomIdResult,\n  GetDeviceIdResult,\n  GetVersionCodeResult,\n  GetVersionNameResult,\n  LiveUpdatePlugin,\n  ReadyResult,\n  SetBundleOptions,\n  SetChannelOptions,\n  SetCustomIdOptions,\n  SyncResult,\n} from './definitions';\n\nexport class LiveUpdateWeb extends WebPlugin implements LiveUpdatePlugin {\n  public async deleteBundle(_options: DeleteBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async downloadBundle(_options: DownloadBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async getBundle(): Promise<GetBundleResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getBundles(): Promise<GetBundlesResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getChannel(): Promise<GetChannelResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getCustomId(): Promise<GetCustomIdResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getDeviceId(): Promise<GetDeviceIdResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getVersionCode(): Promise<GetVersionCodeResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async getVersionName(): Promise<GetVersionNameResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async ready(): Promise<ReadyResult> {\n    this.throwUnimplementedError();\n  }\n\n  public async reload(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async reset(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setBundle(_options: SetBundleOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setChannel(_options: SetChannelOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async setCustomId(_options: SetCustomIdOptions): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  public async sync(): Promise<SyncResult> {\n    this.throwUnimplementedError();\n  }\n\n  private throwUnimplementedError(): never {\n    throw this.unimplemented('Not implemented on web.');\n  }\n}\n"]}

package/ios/Plugin/Classes/CustomError.swift

@@ -7,8 +7,12 @@ public enum CustomError: Error {
     case bundleIndexHtmlMissing
     case bundleNotFound
     case channelMissing
+    case checksumCalculationFailed
+    case checksumMismatch
     case customIdMissing
     case downloadFailed
+    case signatureMissing
+    case signatureVerificationFailed
     case urlMissing
 }
 
@@ -27,10 +31,18 @@ extension CustomError: LocalizedError {
             return NSLocalizedString("bundle not found.", comment: "bundleNotFound")
         case .channelMissing:
             return NSLocalizedString("channel must be provided.", comment: "channelMissing")
+        case .checksumCalculationFailed:
+            return NSLocalizedString("Failed to calculate checksum.", comment: "checksumCalculationFailed")
+        case .checksumMismatch:
+            return NSLocalizedString("Checksum mismatch.", comment: "checksumMismatch")
         case .customIdMissing:
             return NSLocalizedString("customId must be provided.", comment: "customIdMissing")
         case .downloadFailed:
             return NSLocalizedString("Bundle could not be downloaded.", comment: "downloadFailed")
+        case .signatureMissing:
+            return NSLocalizedString("Bundle does not contain a signature.", comment: "signatureMissing")
+        case .signatureVerificationFailed:
+            return NSLocalizedString("Signature verification failed.", comment: "signatureVerificationFailed")
         case .urlMissing:
             return NSLocalizedString("url must be provided.", comment: "urlMissing")
         }

package/ios/Plugin/Classes/Options/DownloadBundleOptions.swift

@@ -3,10 +3,12 @@ import Capacitor
 
 @objc public class DownloadBundleOptions: NSObject {
     private var bundleId: String
+    private var checksum: String?
     private var url: String
 
-    init(bundleId: String, url: String) {
+    init(bundleId: String, checksum: String?, url: String) {
         self.bundleId = bundleId
+        self.checksum = checksum
         self.url = url
     }
 
@@ -14,6 +16,10 @@ import Capacitor
         return bundleId
     }
 
+    func getChecksum() -> String? {
+        return checksum
+    }
+
     func getUrl() -> String {
         return url
     }

package/ios/Plugin/Classes/Results/GetBundleResult.swift

@@ -10,7 +10,7 @@ import Capacitor
 
     public func toJSObject() -> AnyObject {
         var result = JSObject()
-        result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        result["bundleId"] = bundleId == LiveUpdate.defaultWebAssetDir ? NSNull() : bundleId
         return result as AnyObject
     }
 }

package/ios/Plugin/Classes/Results/ReadyResult.swift

@@ -0,0 +1,22 @@
+import Foundation
+import Capacitor
+
+@objc public class ReadyResult: NSObject, Result {
+    let currentBundleId: String?
+    let previousBundleId: String?
+    let rollback: Bool
+
+    init(currentBundleId: String?, previousBundleId: String?, rollback: Bool) {
+        self.currentBundleId = currentBundleId
+        self.previousBundleId = previousBundleId
+        self.rollback = rollback
+    }
+
+    public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["currentBundleId"] = currentBundleId == LiveUpdate.defaultWebAssetDir ? NSNull() : currentBundleId
+        result["previousBundleId"] = previousBundleId == LiveUpdate.defaultWebAssetDir ? NSNull() : previousBundleId
+        result["rollback"] = rollback
+        return result as AnyObject
+    }
+}