@capawesome/capacitor-live-update 7.0.0 → 7.1.1

package/CapawesomeCapacitorLiveUpdate.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '14.0'
   s.dependency 'Capacitor'
-  s.dependency 'Alamofire', '~> 5.9.0'
+  s.dependency 'Alamofire', '~> 5.9'
   s.dependency 'SSZipArchive', '~> 2.2.3'
   s.swift_version = '5.1'
   s.static_framework = true

package/README.md

@@ -5,9 +5,9 @@ Capacitor plugin to update your app remotely in real-time.
 ## Features
 
 - 🔋 Supports **Android and iOS**
-- ⚡️ **Capacitor 6** support
+- ⚡️ **Capacitor 7** support
 - 📦 **Bundle Management**: Download, set, and delete bundles.
-- ☁️ **Cloud Support**: Use the [Capawesome Cloud](https://capawesome.io/cloud/live-updates/) to manage your app updates.
+- ☁️ **Cloud Support**: Use the [Capawesome Cloud](https://cloud.capawesome.io/) to manage your app updates.
 - 📺 **Channel Support**: Set a channel for the app to manage different versions.
 - 🔄 **Auto Update**: Automatically download and set the latest bundle for the app.
 - 🛟 **Rollback**: Reset the app to the default bundle if an incompatible bundle has been set.
@@ -191,7 +191,16 @@ const getVersionName = async () => {
 };
 
 const ready = async () => {
-  await LiveUpdate.ready();
+  const result = await LiveUpdate.ready();
+  if (result.currentBundleId) {
+    console.log(`The app is now using the bundle with the identifier ${result.currentBundleId}.`);
+  }
+  if (result.previousBundleId) {
+    console.log(`The app was using the bundle with the identifier ${result.previousBundleId}.`);
+  }
+  if (result.rollback) {
+    console.log('The app was reset to the default bundle.');
+  }
 };
 
 const reload = async () => {
@@ -203,7 +212,7 @@ const reset = async () => {
 };
 
 const setChannel = async () => {
-  await LiveUpdate.setChannel({ channel: 'beta' });
+  await LiveUpdate.setChannel({ channel: 'production-5' });
 };
 
 const setCustomId = async () => {
@@ -211,18 +220,22 @@ const setCustomId = async () => {
 };
 
 const setNextBundle = async () => {
-  await LiveUpdate.setNextBundle({ bundleId: '1.0.0' });
+  await LiveUpdate.setNextBundle({ bundleId: '7f0b9bf2-dff6-4be2-bcac-b068cc5ea756' });
 };
 
 const sync = async () => {
-  const result = await LiveUpdate.sync();
+  const result = await LiveUpdate.sync({
+    channel: 'production-5',
+  });
   return result.nextBundleId;
 };
 
 const isNewBundleAvailable = async () => {
-  const { bundleId: latestBundleId } = await LiveUpdate.fetchLatestBundle();
+  const { bundleId: latestBundleId } = await LiveUpdate.fetchLatestBundle({
+    channel: 'production-5',
+  });
   if (latestBundleId) {
-    const { bundleId: currentBundleId } = await LiveUpdate.getBundle();
+    const { bundleId: currentBundleId } = await LiveUpdate.getCurrentBundle();
     return latestBundleId !== currentBundleId;
   } else {
     return false;
@@ -633,21 +646,25 @@ Only available on Android and iOS.
 
 #### DownloadBundleOptions
 
-| Prop               | Type                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default            | Since |
-| ------------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
-| **`artifactType`** | <code>'manifest' \| 'zip'</code> | The artifact type of the bundle.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | <code>'zip'</code> | 6.6.0 |
-| **`bundleId`**     | <code>string</code>              | The unique identifier of the bundle. **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                    | 5.0.0 |
-| **`url`**          | <code>string</code>              | The URL of the bundle to download. For the `zip` artifact type, the URL must point to a ZIP file. For the `manifest` artifact type, the URL serves as the base URL to download the individual files. For example, if the URL is `https://example.com/download`, the plugin will download the file with the href `index.html` from `https://example.com/download?href=index.html`. To **verify the integrity** of the file, the server must return a `X-Checksum` header with the SHA-256 hash in base64 format. To **verify the signature** of the file, the server must return a `X-Signature` header with the signed SHA-256 hash in base64 format. |                    | 5.0.0 |
+| Prop               | Type                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Default            | Since |
+| ------------------ | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`artifactType`** | <code>'manifest' \| 'zip'</code> | The artifact type of the bundle.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | <code>'zip'</code> | 6.6.0 |
+| **`bundleId`**     | <code>string</code>              | The unique identifier of the bundle. **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                    | 5.0.0 |
+| **`checksum`**     | <code>string</code>              | The checksum of the self-hosted bundle as a SHA-256 hash in base64 format to verify the integrity of the bundle. **Attention**: Only supported for the `zip` artifact type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                    | 7.1.0 |
+| **`signature`**    | <code>string</code>              | The signature of the self-hosted bundle as a signed SHA-256 hash in base64 format to verify the integrity of the bundle. **Attention**: Only supported for the `zip` artifact type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                    | 7.1.0 |
+| **`url`**          | <code>string</code>              | The URL of the bundle to download. For the `zip` artifact type, the URL must point to a ZIP file. For the `manifest` artifact type, the URL serves as the base URL to download the individual files. For example, if the URL is `https://example.com/download`, the plugin will download the file with the href `index.html` from `https://example.com/download?href=index.html`. To **verify the integrity** of the file, the server should return a `X-Checksum` header with the SHA-256 hash in base64 format. To **verify the signature** of the file, the server should return a `X-Signature` header with the signed SHA-256 hash in base64 format. |                    | 5.0.0 |
 
 
 #### FetchLatestBundleResult
 
-| Prop                   | Type                                    | Description                                                                                                         | Since |
-| ---------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----- |
-| **`artifactType`**     | <code>'manifest' \| 'zip'</code>        | The artifact type of the bundle.                                                                                    | 6.7.0 |
-| **`bundleId`**         | <code>string \| null</code>             | The unique identifier of the latest bundle. If `null`, no bundle is available.                                      | 6.6.0 |
-| **`customProperties`** | <code>{ [key: string]: string; }</code> | Custom properties that are associated with the latest bundle.                                                       | 7.0.0 |
-| **`downloadUrl`**      | <code>string</code>                     | The URL of the latest bundle to download. Pass this URL to the `downloadBundle(...)` method to download the bundle. | 6.7.0 |
+| Prop                   | Type                                    | Description                                                                                                                                                                                  | Since |
+| ---------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`artifactType`**     | <code>'manifest' \| 'zip'</code>        | The artifact type of the bundle.                                                                                                                                                             | 6.7.0 |
+| **`bundleId`**         | <code>string \| null</code>             | The unique identifier of the latest bundle. If `null`, no bundle is available.                                                                                                               | 6.6.0 |
+| **`checksum`**         | <code>string</code>                     | The checksum of the latest bundle if the bundle is self-hosted. If the bundle is hosted on Capawesome Cloud, the checksum will be returned as response header when downloading the bundle.   | 7.1.0 |
+| **`customProperties`** | <code>{ [key: string]: string; }</code> | Custom properties that are associated with the latest bundle.                                                                                                                                | 7.0.0 |
+| **`downloadUrl`**      | <code>string</code>                     | The URL of the latest bundle to download. Pass this URL to the `downloadBundle(...)` method to download the bundle.                                                                          | 6.7.0 |
+| **`signature`**        | <code>string</code>                     | The signature of the latest bundle if the bundle is self-hosted. If the bundle is hosted on Capawesome Cloud, the signature will be returned as response header when downloading the bundle. | 7.1.0 |
 
 
 #### FetchLatestBundleOptions
@@ -789,7 +806,7 @@ Listener for the download progress of a bundle.
 
 ## Testing
 
-When testing the plugin, you must make sure that you do not use the [Live Reload](https://ionicframework.com/docs/cli/livereload) option, as in this case a development server is used to load the bundle.
+When testing the plugin, you must make sure that you do not use the [Live Reload](https://ionicframework.com/docs/cli/livereload) option, as in this case a development server is used to load the bundle and not the local file system.
 
 Therefore, simply start your app without the live reload option, for example with the following command:
 
@@ -797,7 +814,17 @@ Therefore, simply start your app without the live reload option, for example wit
 npx ionic cap run android --open
 ```
 
-If you want to disable the plugin to test other parts of your app, you can set the [`enabled`](#configuration) configuration option to `false`.
+If you want to **not** receive live updates to test other parts of your app, you can simply set a non-existent channel, for example:
+
+```typescript
+import { LiveUpdate } from '@capawesome/capacitor-live-update';
+
+const sync = async () => {
+  await LiveUpdate.sync({ channel: 'non-existent-channel' });
+};
+```
+
+This way, the app will check for updates, but no updates will be found.
 
 ## Limitations
 

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

@@ -118,6 +118,8 @@ public class LiveUpdate {
     public void downloadBundle(@NonNull DownloadBundleOptions options, @NonNull EmptyCallback callback) throws Exception {
         ArtifactType artifactType = options.getArtifactType();
         String bundleId = options.getBundleId();
+        String checksum = options.getChecksum();
+        String signature = options.getSignature();
         String url = options.getUrl();
 
         // Check if the bundle already exists
@@ -131,7 +133,7 @@ public class LiveUpdate {
         if (artifactType == ArtifactType.MANIFEST) {
             downloadBundleOfTypeManifest(bundleId, url);
         } else {
-            downloadBundleOfTypeZip(bundleId, url);
+            downloadBundleOfTypeZip(bundleId, checksum, signature, url);
         }
         callback.success();
     }
@@ -140,9 +142,18 @@ public class LiveUpdate {
         GetLatestBundleResponse response = fetchLatestBundle(options);
         ArtifactType artifactType = response == null ? null : response.getArtifactType();
         String bundleId = response == null ? null : response.getBundleId();
+        String checksum = response == null ? null : response.getChecksum();
         JSONObject customProperties = response == null ? null : response.getCustomProperties();
         String downloadUrl = response == null ? null : response.getUrl();
-        FetchLatestBundleResult result = new FetchLatestBundleResult(artifactType, bundleId, customProperties, downloadUrl);
+        String signature = response == null ? null : response.getSignature();
+        FetchLatestBundleResult result = new FetchLatestBundleResult(
+            artifactType,
+            bundleId,
+            checksum,
+            customProperties,
+            downloadUrl,
+            signature
+        );
         callback.success(result);
     }
 
@@ -271,6 +282,8 @@ public class LiveUpdate {
         }
         ArtifactType artifactType = response.getArtifactType();
         String latestBundleId = response.getBundleId();
+        String checksum = response.getChecksum();
+        String signature = response.getSignature();
         String url = response.getUrl();
         // Check if the bundle already exists
         if (hasBundleById(latestBundleId)) {
@@ -289,7 +302,7 @@ public class LiveUpdate {
         if (artifactType == ArtifactType.MANIFEST) {
             downloadBundleOfTypeManifest(latestBundleId, url);
         } else {
-            downloadBundleOfTypeZip(latestBundleId, url);
+            downloadBundleOfTypeZip(latestBundleId, checksum, signature, url);
         }
         // Set the next bundle
         setNextBundleById(latestBundleId);
@@ -450,15 +463,24 @@ public class LiveUpdate {
         }
     }
 
-    private void downloadAndVerifyFile(@NonNull String url, @NonNull File file, @Nullable DownloadProgressCallback callback)
-        throws Exception {
+    private void downloadAndVerifyFile(
+        @NonNull String url,
+        @NonNull File file,
+        @Nullable String checksum,
+        @Nullable String signature,
+        @Nullable DownloadProgressCallback callback
+    ) throws Exception {
         Response response = httpClient.execute(url);
         ResponseBody responseBody = response.body();
         if (response.isSuccessful()) {
             LiveUpdateHttpClient.writeResponseBodyToFile(responseBody, file, callback);
             // Verify the file
-            String checksum = LiveUpdateHttpClient.getChecksumFromResponse(response);
-            String signature = LiveUpdateHttpClient.getSignatureFromResponse(response);
+            if (checksum == null) {
+                checksum = LiveUpdateHttpClient.getChecksumFromResponse(response);
+            }
+            if (signature == null) {
+                signature = LiveUpdateHttpClient.getSignatureFromResponse(response);
+            }
             verifyFile(file, checksum, signature);
         } else {
             Exception exception = new Exception(responseBody.string());
@@ -479,7 +501,7 @@ public class LiveUpdate {
 
         File destinationFile = new File(destinationDirectory, href);
         destinationFile.getParentFile().mkdirs();
-        downloadAndVerifyFile(url, destinationFile, callback);
+        downloadAndVerifyFile(url, destinationFile, null, null, callback);
         return destinationFile;
     }
 
@@ -580,10 +602,15 @@ public class LiveUpdate {
         addBundleOfTypeManifest(bundleId, temporaryDirectory);
     }
 
-    private void downloadBundleOfTypeZip(@NonNull String bundleId, @NonNull String downloadUrl) throws Exception {
+    private void downloadBundleOfTypeZip(
+        @NonNull String bundleId,
+        @Nullable String checksum,
+        @Nullable String signature,
+        @NonNull String downloadUrl
+    ) throws Exception {
         File file = buildTemporaryZipFile();
         // Download the bundle
-        downloadAndVerifyFile(downloadUrl, file, (downloadedBytes, totalBytes) -> {
+        downloadAndVerifyFile(downloadUrl, file, checksum, signature, (downloadedBytes, totalBytes) -> {
             DownloadBundleProgressEvent event = new DownloadBundleProgressEvent(bundleId, downloadedBytes, totalBytes);
             notifyDownloadBundleProgressListeners(event);
         });

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

@@ -26,7 +26,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "7.0.0";
+    public static final String VERSION = "7.1.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.";
@@ -100,13 +100,15 @@ public class LiveUpdatePlugin extends Plugin {
                 call.reject(ERROR_BUNDLE_ID_MISSING);
                 return;
             }
+            String checksum = call.getString("checksum");
+            String signature = call.getString("signature");
             String url = call.getString("url");
             if (url == null) {
                 call.reject(ERROR_URL_MISSING);
                 return;
             }
 
-            DownloadBundleOptions options = new DownloadBundleOptions(artifactType, bundleId, url);
+            DownloadBundleOptions options = new DownloadBundleOptions(artifactType, bundleId, checksum, signature, url);
             EmptyCallback callback = new EmptyCallback() {
                 @Override
                 public void success() {

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

@@ -16,9 +16,15 @@ public class GetLatestBundleResponse {
     @NonNull
     private String bundleId;
 
+    @Nullable
+    private String checksum;
+
     @Nullable
     private JSONObject customProperties;
 
+    @Nullable
+    private String signature;
+
     @NonNull
     private String url;
 
@@ -30,7 +36,9 @@ public class GetLatestBundleResponse {
             this.artifactType = ArtifactType.ZIP;
         }
         this.bundleId = responseJson.optString("bundleId");
+        this.checksum = responseJson.optString("checksum");
         this.customProperties = responseJson.optJSONObject("customProperties");
+        this.signature = responseJson.optString("signature");
         this.url = responseJson.optString("url");
     }
 
@@ -49,6 +57,16 @@ public class GetLatestBundleResponse {
         return customProperties;
     }
 
+    @Nullable
+    public String getChecksum() {
+        return checksum;
+    }
+
+    @Nullable
+    public String getSignature() {
+        return signature;
+    }
+
     @NonNull
     public String getUrl() {
         return url;

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

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

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

@@ -15,22 +15,32 @@ public class FetchLatestBundleResult implements Result {
     @Nullable
     private final String bundleId;
 
+    @Nullable
+    private final String checksum;
+
     @Nullable
     private final JSONObject customProperties;
 
     @Nullable
     private final String downloadUrl;
 
+    @Nullable
+    private final String signature;
+
     public FetchLatestBundleResult(
         @Nullable ArtifactType artifactType,
         @Nullable String bundleId,
+        @Nullable String checksum,
         @Nullable JSONObject customProperties,
-        @Nullable String downloadUrl
+        @Nullable String downloadUrl,
+        @Nullable String signature
     ) {
         this.artifactType = artifactType;
         this.bundleId = bundleId;
+        this.checksum = checksum;
         this.customProperties = customProperties;
         this.downloadUrl = downloadUrl;
+        this.signature = signature;
     }
 
     @NonNull
@@ -42,12 +52,18 @@ public class FetchLatestBundleResult implements Result {
             result.put("artifactType", "zip");
         }
         result.put("bundleId", bundleId == null ? JSONObject.NULL : bundleId);
+        if (checksum != null) {
+            result.put("checksum", checksum);
+        }
         if (customProperties != null) {
             result.put("customProperties", customProperties);
         }
         if (downloadUrl != null) {
             result.put("downloadUrl", downloadUrl);
         }
+        if (signature != null) {
+            result.put("signature", signature);
+        }
         return result;
     }
 }

package/dist/docs.json

@@ -457,6 +457,30 @@
           "complexTypes": [],
           "type": "string"
         },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "7.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The checksum of the self-hosted bundle as a SHA-256 hash\nin base64 format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
+            {
+              "text": "7.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The signature of the self-hosted bundle as a signed SHA-256 hash\nin base64 format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "url",
           "tags": [
@@ -469,7 +493,7 @@
               "name": "example"
             }
           ],
-          "docs": "The URL of the bundle to download.\n\nFor the `zip` artifact type, the URL must point to a ZIP file.\nFor the `manifest` artifact type, the URL serves as the base URL\nto download the individual files. For example, if the URL is\n`https://example.com/download`, the plugin will download the file\nwith the href `index.html` from `https://example.com/download?href=index.html`.\n\nTo **verify the integrity** of the file, the server must return\na `X-Checksum` header with the SHA-256 hash in base64 format.\n\nTo **verify the signature** of the file, the server must return\na `X-Signature` header with the signed SHA-256 hash in base64 format.",
+          "docs": "The URL of the bundle to download.\n\nFor the `zip` artifact type, the URL must point to a ZIP file.\nFor the `manifest` artifact type, the URL serves as the base URL\nto download the individual files. For example, if the URL is\n`https://example.com/download`, the plugin will download the file\nwith the href `index.html` from `https://example.com/download?href=index.html`.\n\nTo **verify the integrity** of the file, the server should return\na `X-Checksum` header with the SHA-256 hash in base64 format.\n\nTo **verify the signature** of the file, the server should return\na `X-Signature` header with the signed SHA-256 hash in base64 format.",
           "complexTypes": [],
           "type": "string"
         }
@@ -511,6 +535,18 @@
           "complexTypes": [],
           "type": "string | null"
         },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "7.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The checksum of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the checksum will be\nreturned as response header when downloading the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "customProperties",
           "tags": [
@@ -538,6 +574,18 @@
           "docs": "The URL of the latest bundle to download.\nPass this URL to the `downloadBundle(...)` method to download the bundle.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
+            {
+              "text": "7.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The signature of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the signature will be\nreturned as response header when downloading the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -272,6 +272,24 @@ export interface DownloadBundleOptions {
      * @example '1.0.0'
      */
     bundleId: string;
+    /**
+     * The checksum of the self-hosted bundle as a SHA-256 hash
+     * in base64 format to verify the integrity of the bundle.
+     *
+     * **Attention**: Only supported for the `zip` artifact type.
+     *
+     * @since 7.1.0
+     */
+    checksum?: string;
+    /**
+     * The signature of the self-hosted bundle as a signed SHA-256 hash
+     * in base64 format to verify the integrity of the bundle.
+     *
+     * **Attention**: Only supported for the `zip` artifact type.
+     *
+     * @since 7.1.0
+     */
+    signature?: string;
     /**
      * The URL of the bundle to download.
      *
@@ -281,10 +299,10 @@ export interface DownloadBundleOptions {
      * `https://example.com/download`, the plugin will download the file
      * with the href `index.html` from `https://example.com/download?href=index.html`.
      *
-     * To **verify the integrity** of the file, the server must return
+     * To **verify the integrity** of the file, the server should return
      * a `X-Checksum` header with the SHA-256 hash in base64 format.
      *
-     * To **verify the signature** of the file, the server must return
+     * To **verify the signature** of the file, the server should return
      * a `X-Signature` header with the signed SHA-256 hash in base64 format.
      *
      * @since 5.0.0
@@ -321,6 +339,15 @@ export interface FetchLatestBundleResult {
      * @since 6.6.0
      */
     bundleId: string | null;
+    /**
+     * The checksum of the latest bundle if the bundle is self-hosted.
+     *
+     * If the bundle is hosted on Capawesome Cloud, the checksum will be
+     * returned as response header when downloading the bundle.
+     *
+     * @since 7.1.0
+     */
+    checksum?: string;
     /**
      * Custom properties that are associated with the latest bundle.
      *
@@ -337,6 +364,15 @@ export interface FetchLatestBundleResult {
      * @since 6.7.0
      */
     downloadUrl?: string;
+    /**
+     * The signature of the latest bundle if the bundle is self-hosted.
+     *
+     * If the bundle is hosted on Capawesome Cloud, the signature will be
+     * returned as response header when downloading the bundle.
+     *
+     * @since 7.1.0
+     */
+    signature?: string;
 }
 /**
  * @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\nimport type { PluginListenerHandle } from '@capacitor/core';\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       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\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\n       * before resetting to the default bundle.\n       *\n       * It is strongly **recommended** to configure this option so that\n       * the plugin can roll back to the default bundle in case of problems.\n       * If configured, the plugin will wait for the app to call the `ready()`\n       * method before resetting to the default bundle.\n       *\n       * Set to `0` to disable the timeout.\n       *\n       * @since 5.0.0\n       * @default 0\n       * @example 10000\n       */\n      readyTimeout?: number;\n      /**\n       * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server.\n       *\n       * @since 7.0.0\n       * @default 'api.cloud.capawesome.io'\n       */\n      serverDomain?: string;\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   * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.6.0\n   */\n  fetchLatestBundle(\n    options?: FetchLatestBundleOptions,\n  ): Promise<FetchLatestBundleResult>;\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 that is used for the update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the bundle identifier of the current bundle.\n   * The current bundle is the bundle that is currently used by the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getCurrentBundle(): Promise<GetCurrentBundleResult>;\n  /**\n   * Get the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the unique device identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the bundle identifier of the next bundle.\n   * The next bundle is the bundle that will be used after calling `reload()`\n   * or restarting the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getNextBundle(): Promise<GetNextBundleResult>;\n  /**\n   * Get 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   * 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   * 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   * 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 channel to use for the update.\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 device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): 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 6.7.0\n   */\n  setNextBundle(options: SetNextBundleOptions): 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(options?: SyncOptions): Promise<SyncResult>;\n  /**\n   * Listen for the download progress of a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 7.0.0\n   */\n  addListener(\n    eventName: 'downloadBundleProgress',\n    listenerFunc: DownloadBundleProgressListener,\n  ): Promise<PluginListenerHandle>;\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 artifact type of the bundle.\n   *\n   * @since 6.6.0\n   * @default 'zip'\n   * @example 'manifest'\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the bundle.\n   *\n   * **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * For the `zip` artifact type, the URL must point to a ZIP file.\n   * For the `manifest` artifact type, the URL serves as the base URL\n   * to download the individual files. For example, if the URL is\n   * `https://example.com/download`, the plugin will download the file\n   * with the href `index.html` from `https://example.com/download?href=index.html`.\n   *\n   * To **verify the integrity** of the file, the server must return\n   * a `X-Checksum` header with the SHA-256 hash in base64 format.\n   *\n   * To **verify the signature** of the file, the server must return\n   * a `X-Signature` header with the signed SHA-256 hash in base64 format.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 6.6.0\n */\nexport interface FetchLatestBundleResult {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.7.0\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the latest bundle.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * Custom properties that are associated with the latest bundle.\n   *\n   * @since 7.0.0\n   * @example { \"key\": \"value\" }\n   */\n  customProperties?: { [key: string]: string };\n  /**\n   * The URL of the latest bundle to download.\n   * Pass this URL to the `downloadBundle(...)` method to download the bundle.\n   *\n   * @since 6.7.0\n   */\n  downloadUrl?: 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 name.\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 6.7.0\n */\nexport interface GetCurrentBundleResult {\n  /**\n   * The unique identifier of the current bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: 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 6.7.0\n */\nexport interface GetNextBundleResult {\n  /**\n   * The unique identifier of the next bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\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 device.\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 name.\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 device.\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 6.7.0\n */\nexport interface SetNextBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * Set `null` to use the default bundle (same as calling `reset()`).\n   *\n   * @since 6.7.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SyncOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\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\n/**\n * Listener for the download progress of a bundle.\n *\n * @since 7.0.0\n */\nexport type DownloadBundleProgressListener = (\n  event: DownloadBundleProgressEvent,\n) => void;\n\n/**\n * Event that is triggered when the download progress of a bundle changes.\n *\n * @since 7.0.0\n */\nexport interface DownloadBundleProgressEvent {\n  /**\n   * The unique identifier of the bundle that is being downloaded.\n   *\n   * @since 7.0.0\n   */\n  bundleId: string;\n  /**\n   * The number of bytes that have been downloaded.\n   *\n   * @since 7.0.0\n   */\n  downloadedBytes: number;\n  /**\n   * The progress of the download in percent as a value between `0` and `1`.\n   *\n   * @since 7.0.0\n   * @example 0.5\n   */\n  progress: number;\n  /**\n   * The total number of bytes to download.\n   *\n   * @since 7.0.0\n   */\n  totalBytes: number;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from '@capacitor/core';\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       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\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\n       * before resetting to the default bundle.\n       *\n       * It is strongly **recommended** to configure this option so that\n       * the plugin can roll back to the default bundle in case of problems.\n       * If configured, the plugin will wait for the app to call the `ready()`\n       * method before resetting to the default bundle.\n       *\n       * Set to `0` to disable the timeout.\n       *\n       * @since 5.0.0\n       * @default 0\n       * @example 10000\n       */\n      readyTimeout?: number;\n      /**\n       * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server.\n       *\n       * @since 7.0.0\n       * @default 'api.cloud.capawesome.io'\n       */\n      serverDomain?: string;\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   * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.6.0\n   */\n  fetchLatestBundle(\n    options?: FetchLatestBundleOptions,\n  ): Promise<FetchLatestBundleResult>;\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 that is used for the update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the bundle identifier of the current bundle.\n   * The current bundle is the bundle that is currently used by the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getCurrentBundle(): Promise<GetCurrentBundleResult>;\n  /**\n   * Get the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the unique device identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the bundle identifier of the next bundle.\n   * The next bundle is the bundle that will be used after calling `reload()`\n   * or restarting the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getNextBundle(): Promise<GetNextBundleResult>;\n  /**\n   * Get 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   * 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   * 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   * 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 channel to use for the update.\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 device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): 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 6.7.0\n   */\n  setNextBundle(options: SetNextBundleOptions): 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(options?: SyncOptions): Promise<SyncResult>;\n  /**\n   * Listen for the download progress of a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 7.0.0\n   */\n  addListener(\n    eventName: 'downloadBundleProgress',\n    listenerFunc: DownloadBundleProgressListener,\n  ): Promise<PluginListenerHandle>;\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 artifact type of the bundle.\n   *\n   * @since 6.6.0\n   * @default 'zip'\n   * @example 'manifest'\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the bundle.\n   *\n   * **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the self-hosted bundle as a SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 7.1.0\n   */\n  checksum?: string;\n  /**\n   * The signature of the self-hosted bundle as a signed SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 7.1.0\n   */\n  signature?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * For the `zip` artifact type, the URL must point to a ZIP file.\n   * For the `manifest` artifact type, the URL serves as the base URL\n   * to download the individual files. For example, if the URL is\n   * `https://example.com/download`, the plugin will download the file\n   * with the href `index.html` from `https://example.com/download?href=index.html`.\n   *\n   * To **verify the integrity** of the file, the server should return\n   * a `X-Checksum` header with the SHA-256 hash in base64 format.\n   *\n   * To **verify the signature** of the file, the server should return\n   * a `X-Signature` header with the signed SHA-256 hash in base64 format.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 6.6.0\n */\nexport interface FetchLatestBundleResult {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.7.0\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the latest bundle.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * The checksum of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the checksum will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 7.1.0\n   */\n  checksum?: string;\n  /**\n   * Custom properties that are associated with the latest bundle.\n   *\n   * @since 7.0.0\n   * @example { \"key\": \"value\" }\n   */\n  customProperties?: { [key: string]: string };\n  /**\n   * The URL of the latest bundle to download.\n   * Pass this URL to the `downloadBundle(...)` method to download the bundle.\n   *\n   * @since 6.7.0\n   */\n  downloadUrl?: string;\n  /**\n   * The signature of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the signature will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 7.1.0\n   */\n  signature?: 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 name.\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 6.7.0\n */\nexport interface GetCurrentBundleResult {\n  /**\n   * The unique identifier of the current bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: 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 6.7.0\n */\nexport interface GetNextBundleResult {\n  /**\n   * The unique identifier of the next bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\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 device.\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 name.\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 device.\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 6.7.0\n */\nexport interface SetNextBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * Set `null` to use the default bundle (same as calling `reset()`).\n   *\n   * @since 6.7.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SyncOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\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\n/**\n * Listener for the download progress of a bundle.\n *\n * @since 7.0.0\n */\nexport type DownloadBundleProgressListener = (\n  event: DownloadBundleProgressEvent,\n) => void;\n\n/**\n * Event that is triggered when the download progress of a bundle changes.\n *\n * @since 7.0.0\n */\nexport interface DownloadBundleProgressEvent {\n  /**\n   * The unique identifier of the bundle that is being downloaded.\n   *\n   * @since 7.0.0\n   */\n  bundleId: string;\n  /**\n   * The number of bytes that have been downloaded.\n   *\n   * @since 7.0.0\n   */\n  downloadedBytes: number;\n  /**\n   * The progress of the download in percent as a value between `0` and `1`.\n   *\n   * @since 7.0.0\n   * @example 0.5\n   */\n  progress: number;\n  /**\n   * The total number of bytes to download.\n   *\n   * @since 7.0.0\n   */\n  totalBytes: number;\n}\n"]}

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

@@ -4,15 +4,19 @@ import Capacitor
 @objc public class DownloadBundleOptions: NSObject {
     private var artifactType: ArtifactType
     private var bundleId: String
+    private var checksum: String?
+    private var signature: String?
     private var url: String
 
-    init(artifactType: String, bundleId: String, url: String) {
+    init(artifactType: String, bundleId: String, checksum: String?, signature: String?, url: String) {
         if artifactType == "manifest" {
             self.artifactType = .manifest
         } else {
             self.artifactType = .zip
         }
         self.bundleId = bundleId
+        self.checksum = checksum
+        self.signature = signature
         self.url = url
     }
 
@@ -24,6 +28,14 @@ import Capacitor
         return bundleId
     }
 
+    func getChecksum() -> String? {
+        return checksum
+    }
+
+    func getSignature() -> String? {
+        return signature
+    }
+
     func getUrl() -> String {
         return url
     }

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

@@ -4,14 +4,18 @@ import Capacitor
 @objc public class FetchLatestBundleResult: NSObject, Result {
     private let artifactType: ArtifactType?
     private let bundleId: String?
+    private let checksum: String?
     private let customProperties: [String: Any]?
     private let downloadUrl: String?
+    private let signature: String?
 
-    init(artifactType: ArtifactType?, bundleId: String?, customProperties: [String: Any]?, downloadUrl: String?) {
+    init(artifactType: ArtifactType?, bundleId: String?, checksum: String?, customProperties: [String: Any]?, downloadUrl: String?, signature: String?) {
         self.artifactType = artifactType
         self.bundleId = bundleId
+        self.checksum = checksum
         self.customProperties = customProperties
         self.downloadUrl = downloadUrl
+        self.signature = signature
     }
 
     public func toJSObject() -> AnyObject {
@@ -22,12 +26,18 @@ import Capacitor
             result["artifactType"] = "zip"
         }
         result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        if let checksum = checksum {
+            result["checksum"] = checksum
+        }
         if let customProperties = JSTypes.coerceDictionaryToJSObject(customProperties) {
             result["customProperties"] = customProperties
         }
         if let downloadUrl = downloadUrl {
             result["downloadUrl"] = downloadUrl
         }
+        if let signature = signature {
+            result["signature"] = signature
+        }
         return result as AnyObject
     }
 }

package/ios/Plugin/LiveUpdate.swift

@@ -57,6 +57,8 @@ import CommonCrypto
     @objc public func downloadBundle(_ options: DownloadBundleOptions) async throws {
         let artifactType = options.getArtifactType()
         let bundleId = options.getBundleId()
+        let checksum = options.getChecksum()
+        let signature = options.getSignature()
         let url = options.getUrl()
 
         // Check if the bundle already exists
@@ -68,13 +70,13 @@ import CommonCrypto
         if artifactType == .manifest {
             try await downloadBundleOfTypeManifest(bundleId: bundleId, url: url)
         } else {
-            try await downloadBundleOfTypeZip(bundleId: bundleId, url: url)
+            try await downloadBundleOfTypeZip(bundleId: bundleId, checksum: checksum, signature: signature, url: url)
         }
     }
 
     @objc public func fetchLatestBundle(_ options: FetchLatestBundleOptions) async throws -> FetchLatestBundleResult {
         let response: GetLatestBundleResponse? = try await self.fetchLatestBundle(options)
-        return FetchLatestBundleResult(artifactType: response?.artifactType, bundleId: response?.bundleId, customProperties: response?.customProperties, downloadUrl: response?.url)
+        return FetchLatestBundleResult(artifactType: response?.artifactType, bundleId: response?.bundleId, checksum: response?.checksum, customProperties: response?.customProperties, downloadUrl: response?.url, signature: response?.signature)
     }
 
     @objc public func getBundles(completion: @escaping (Result?, Error?) -> Void) {
@@ -201,6 +203,8 @@ import CommonCrypto
         }
         let artifactType = response.artifactType
         let latestBundleId = response.bundleId
+        let checksum = response.checksum
+        let signature = response.signature
         let downloadUrl = response.url
         // Check if bundle already exists
         if hasBundleById(latestBundleId) {
@@ -217,7 +221,7 @@ import CommonCrypto
         if artifactType == .manifest {
             try await downloadBundleOfTypeManifest(bundleId: latestBundleId, url: downloadUrl)
         } else {
-            try await downloadBundleOfTypeZip(bundleId: latestBundleId, url: downloadUrl)
+            try await downloadBundleOfTypeZip(bundleId: latestBundleId, checksum: checksum, signature: signature, url: downloadUrl)
         }
         // Set the next bundle
         setNextBundleById(latestBundleId)
@@ -338,7 +342,7 @@ import CommonCrypto
         }
     }
 
-    private func downloadAndVerifyFile(url: String, file: URL, callback: ((Progress) -> Void)?) async throws {
+    private func downloadAndVerifyFile(url: String, file: URL, checksum: String?, signature: String?, callback: ((Progress) -> Void)?) async throws {
         let destination: DownloadRequest.Destination = { _, _ in
             return (file, [.createIntermediateDirectories])
         }
@@ -356,8 +360,8 @@ import CommonCrypto
         guard let response = result.response else {
             throw CustomError.unknown
         }
-        let checksum = LiveUpdateHttpClient.getChecksumFromResponse(response: response)
-        let signature = LiveUpdateHttpClient.getSignatureFromResponse(response: response)
+        let checksum = checksum ?? LiveUpdateHttpClient.getChecksumFromResponse(response: response)
+        let signature = signature ?? LiveUpdateHttpClient.getSignatureFromResponse(response: response)
         try verifyFile(url: file, checksum: checksum, signature: signature)
     }
 
@@ -368,7 +372,7 @@ import CommonCrypto
         var urlComponents = URLComponents(string: baseUrl)!
         urlComponents.queryItems = parameters.map { URLQueryItem(name: $0.key, value: $0.value) }
         let url = urlComponents.string!
-        try await self.downloadAndVerifyFile(url: url, file: fileURL, callback: callback)
+        try await self.downloadAndVerifyFile(url: url, file: fileURL, checksum: nil, signature: nil, callback: callback)
         return fileURL
     }
 
@@ -440,11 +444,11 @@ import CommonCrypto
         try await addBundleOfTypeManifest(bundleId: bundleId, directory: temporaryDirectory)
     }
 
-    private func downloadBundleOfTypeZip(bundleId: String, url: String) async throws {
+    private func downloadBundleOfTypeZip(bundleId: String, checksum: String?, signature: String?, url: String) async throws {
         let timestamp = String(Int(Date().timeIntervalSince1970))
         let temporaryZipFileUrl = self.cachesDirectoryUrl.appendingPathComponent(timestamp + ".zip")
         // Download the bundle
-        try await downloadAndVerifyFile(url: url, file: temporaryZipFileUrl, callback: { progress in
+        try await downloadAndVerifyFile(url: url, file: temporaryZipFileUrl, checksum: checksum, signature: signature, callback: { progress in
             let event = DownloadBundleProgressEvent(bundleId: bundleId, downloadedBytes: progress.completedUnitCount, totalBytes: progress.totalUnitCount)
             self.notifyDownloadBundleProgressListeners(event)
         })

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "7.0.0"
+    public static let version = "7.1.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"
@@ -70,12 +70,14 @@ public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
                     call.reject(CustomError.bundleIdMissing.localizedDescription)
                     return
                 }
+                let checksum = call.getString("checksum")
+                let signature = call.getString("signature")
                 guard let url = call.getString("url") else {
                     call.reject(CustomError.urlMissing.localizedDescription)
                     return
                 }
 
-                let options = DownloadBundleOptions(artifactType: artifactType, bundleId: bundleId, url: url)
+                let options = DownloadBundleOptions(artifactType: artifactType, bundleId: bundleId, checksum: checksum, signature: signature, url: url)
 
                 try await implementation?.downloadBundle(options)
                 self.resolveCall(call)

package/ios/Plugin/Protocols/Api/GetLatestBundleResponse.swift

@@ -1,6 +1,8 @@
 public struct GetLatestBundleResponse: Codable {
     var artifactType: ArtifactType
     var bundleId: String
+    var checksum: String?
     var customProperties: [String: String]?
+    var signature: String?
     var url: String
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "7.0.0",
+  "version": "7.1.1",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",