@capawesome/capacitor-live-update 6.7.1 → 6.8.0

package/README.md

@@ -651,17 +651,20 @@ Only available on Android and iOS.
 | ------------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
 | **`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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                    | 5.0.0 |
-| **`checksum`**     | <code>string</code>              | The checksum of the bundle to verify the integrity of the ZIP file. Must be a SHA-256 hash in base64 format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                    | 6.1.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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                    | 6.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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                    | 6.8.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 |
 
 
 #### 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 |
-| **`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.   | 6.8.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. | 6.8.0 |
 
 
 #### FetchLatestBundleOptions

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

@@ -104,6 +104,7 @@ public class LiveUpdate {
 
         if (config.getEnabled()) {
             if (wasUpdated() && config.getResetOnUpdate()) {
+                Logger.debug(LiveUpdatePlugin.TAG, "App was updated. Resetting to default bundle.");
                 reset();
             } else {
                 startRollbackTimer();
@@ -129,6 +130,7 @@ public class LiveUpdate {
         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
@@ -142,7 +144,7 @@ public class LiveUpdate {
         if (artifactType == ArtifactType.MANIFEST) {
             downloadBundleOfTypeManifest(bundleId, url);
         } else {
-            downloadBundleOfTypeZip(bundleId, url, checksum);
+            downloadBundleOfTypeZip(bundleId, url, checksum, signature);
         }
         callback.success();
     }
@@ -151,8 +153,10 @@ 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();
         String downloadUrl = response == null ? null : response.getUrl();
-        FetchLatestBundleResult result = new FetchLatestBundleResult(artifactType, bundleId, downloadUrl);
+        String signature = response == null ? null : response.getSignature();
+        FetchLatestBundleResult result = new FetchLatestBundleResult(artifactType, bundleId, checksum, downloadUrl, signature);
         callback.success(result);
     }
 
@@ -295,6 +299,8 @@ public class LiveUpdate {
             return;
         }
         ArtifactType artifactType = response.getArtifactType();
+        String checksum = response.getChecksum();
+        String signature = response.getSignature();
         String latestBundleId = response.getBundleId();
         String url = response.getUrl();
         // Check if the bundle already exists
@@ -314,7 +320,7 @@ public class LiveUpdate {
         if (artifactType == ArtifactType.MANIFEST) {
             downloadBundleOfTypeManifest(latestBundleId, url);
         } else {
-            downloadBundleOfTypeZip(latestBundleId, url, null);
+            downloadBundleOfTypeZip(latestBundleId, url, checksum, signature);
         }
         // Set the next bundle
         setNextBundle(latestBundleId);
@@ -474,14 +480,15 @@ public class LiveUpdate {
         }
     }
 
-    private void downloadAndVerifyFile(@NonNull String url, @NonNull File file, @Nullable String checksum) throws Exception {
+    private void downloadAndVerifyFile(@NonNull String url, @NonNull File file, @Nullable String checksum, @Nullable String signature)
+        throws Exception {
         Response response = httpClient.execute(url);
         ResponseBody responseBody = response.body();
         if (response.isSuccessful()) {
             LiveUpdateHttpClient.writeResponseBodyToFile(responseBody, file);
             // Verify the file
             checksum = checksum == null ? LiveUpdateHttpClient.getChecksumFromResponse(response) : checksum;
-            String signature = LiveUpdateHttpClient.getSignatureFromResponse(response);
+            signature = signature == null ? LiveUpdateHttpClient.getSignatureFromResponse(response) : signature;
             verifyFile(file, checksum, signature);
         } else {
             Exception exception = new Exception(responseBody.string());
@@ -497,7 +504,7 @@ public class LiveUpdate {
 
         File destinationFile = new File(destinationDirectory, href);
         destinationFile.getParentFile().mkdirs();
-        downloadAndVerifyFile(url, destinationFile, null);
+        downloadAndVerifyFile(url, destinationFile, null, null);
         return destinationFile;
     }
 
@@ -579,11 +586,15 @@ public class LiveUpdate {
         addBundleOfTypeManifest(bundleId, temporaryDirectory);
     }
 
-    private void downloadBundleOfTypeZip(@NonNull String bundleId, @NonNull String downloadUrl, @Nullable String checksum)
-        throws Exception {
+    private void downloadBundleOfTypeZip(
+        @NonNull String bundleId,
+        @NonNull String downloadUrl,
+        @Nullable String checksum,
+        @Nullable String signature
+    ) throws Exception {
         File file = buildTemporaryZipFile();
         // Download the bundle
-        downloadAndVerifyFile(downloadUrl, file, checksum);
+        downloadAndVerifyFile(downloadUrl, file, checksum, signature);
         // Add the bundle
         addBundleOfTypeZip(bundleId, file);
         // Delete the temporary file

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

@@ -24,7 +24,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "6.7.1";
+    public static final String VERSION = "6.8.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.";
@@ -98,13 +98,14 @@ public class LiveUpdatePlugin extends Plugin {
                 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, checksum, 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,6 +16,12 @@ public class GetLatestBundleResponse {
     @NonNull
     private String bundleId;
 
+    @Nullable
+    private String checksum;
+
+    @Nullable
+    private String signature;
+
     @NonNull
     private String url;
 
@@ -27,6 +33,8 @@ public class GetLatestBundleResponse {
             this.artifactType = ArtifactType.ZIP;
         }
         this.bundleId = responseJson.optString("bundleId");
+        this.checksum = responseJson.optString("checksum");
+        this.signature = responseJson.optString("signature");
         this.url = responseJson.optString("url");
     }
 
@@ -40,6 +48,16 @@ public class GetLatestBundleResponse {
         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/options/DownloadBundleOptions.java

@@ -15,10 +15,19 @@ public class DownloadBundleOptions {
     @Nullable
     private String checksum;
 
+    @Nullable
+    private String signature;
+
     @NonNull
     private String url;
 
-    public DownloadBundleOptions(@NonNull String artifactType, @NonNull String bundleId, @Nullable String checksum, @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 {
@@ -26,6 +35,7 @@ public class DownloadBundleOptions {
         }
         this.bundleId = bundleId;
         this.checksum = checksum;
+        this.signature = signature;
         this.url = url;
     }
 
@@ -44,6 +54,11 @@ public class DownloadBundleOptions {
         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,13 +15,27 @@ public class FetchLatestBundleResult implements Result {
     @Nullable
     private final String bundleId;
 
+    @Nullable
+    private final String checksum;
+
     @Nullable
     private final String downloadUrl;
 
-    public FetchLatestBundleResult(@Nullable ArtifactType artifactType, @Nullable String bundleId, @Nullable String downloadUrl) {
+    @Nullable
+    private final String signature;
+
+    public FetchLatestBundleResult(
+        @Nullable ArtifactType artifactType,
+        @Nullable String bundleId,
+        @Nullable String checksum,
+        @Nullable String downloadUrl,
+        @Nullable String signature
+    ) {
         this.artifactType = artifactType;
         this.bundleId = bundleId;
+        this.checksum = checksum;
         this.downloadUrl = downloadUrl;
+        this.signature = signature;
     }
 
     @NonNull
@@ -33,9 +47,15 @@ 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 (downloadUrl != null) {
             result.put("downloadUrl", downloadUrl);
         }
+        if (signature != null) {
+            result.put("signature", signature);
+        }
         return result;
     }
 }

package/dist/docs.json

@@ -480,13 +480,21 @@
             {
               "text": "6.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": "The server should return a `X-Checksum` header instead.",
-              "name": "deprecated"
+              "text": "6.8.0",
+              "name": "since"
             }
           ],
-          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in base64 format.",
+          "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"
         },
@@ -544,6 +552,18 @@
           "complexTypes": [],
           "type": "string | null"
         },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "6.8.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": "downloadUrl",
           "tags": [
@@ -555,6 +575,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": "6.8.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

@@ -283,14 +283,23 @@ export interface DownloadBundleOptions {
      */
     bundleId: string;
     /**
-     * The checksum of the bundle to verify the integrity of the ZIP file.
+     * The checksum of the self-hosted bundle as a SHA-256 hash
+     * in base64 format to verify the integrity of the bundle.
      *
-     * Must be a SHA-256 hash in base64 format.
+     * **Attention**: Only supported for the `zip` artifact type.
      *
      * @since 6.1.0
-     * @deprecated The server should return a `X-Checksum` header instead.
      */
     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 6.8.0
+     */
+    signature?: string;
     /**
      * The URL of the bundle to download.
      *
@@ -340,6 +349,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 6.8.0
+     */
+    checksum?: string;
     /**
      * The URL of the latest bundle to download.
      * Pass this URL to the `downloadBundle(...)` method to download the bundle.
@@ -347,6 +365,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 6.8.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\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @deprecated This option will be removed in the future.\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   * 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(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `getCurrentBundle()` instead.\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel 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   * 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   * @deprecated Use `setNextBundle()` instead.\n   */\n  setBundle(options: SetBundleOptions): 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\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   * @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 base64 format.\n   *\n   * @since 6.1.0\n   * @deprecated The server should return a `X-Checksum` header instead.\n   */\n  checksum?: 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   * 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 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"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @deprecated This option will be removed in the future.\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   * 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(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `getCurrentBundle()` instead.\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel 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   * 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   * @deprecated Use `setNextBundle()` instead.\n   */\n  setBundle(options: SetBundleOptions): 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\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   * @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 6.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 6.8.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 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   * 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 6.8.0\n   */\n  checksum?: 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 6.8.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 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"]}

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

@@ -5,9 +5,10 @@ import Capacitor
     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, checksum: String?, url: String) {
+    init(artifactType: String, bundleId: String, checksum: String?, signature: String?, url: String) {
         if artifactType == "manifest" {
             self.artifactType = .manifest
         } else {
@@ -15,6 +16,7 @@ import Capacitor
         }
         self.bundleId = bundleId
         self.checksum = checksum
+        self.signature = signature
         self.url = url
     }
 
@@ -30,6 +32,10 @@ import Capacitor
         return checksum
     }
 
+    func getSignature() -> String? {
+        return signature
+    }
+
     func getUrl() -> String {
         return url
     }

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

@@ -4,12 +4,16 @@ import Capacitor
 @objc public class FetchLatestBundleResult: NSObject, Result {
     private let artifactType: ArtifactType?
     private let bundleId: String?
+    private let checksum: String?
     private let downloadUrl: String?
+    private let signature: String?
 
-    init(artifactType: ArtifactType?, bundleId: String?, downloadUrl: String?) {
+    init(artifactType: ArtifactType?, bundleId: String?, checksum: String?, downloadUrl: String?, signature: String?) {
         self.artifactType = artifactType
         self.bundleId = bundleId
+        self.checksum = checksum
         self.downloadUrl = downloadUrl
+        self.signature = signature
     }
 
     public func toJSObject() -> AnyObject {
@@ -20,9 +24,15 @@ import Capacitor
             result["artifactType"] = "zip"
         }
         result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        if let checksum = checksum {
+            result["checksum"] = checksum
+        }
         if let downloadUrl = downloadUrl {
             result["downloadUrl"] = downloadUrl
         }
+        if let signature = signature {
+            result["signature"] = signature
+        }
         return result as AnyObject
     }
 }

package/ios/Plugin/LiveUpdate.swift

@@ -35,11 +35,12 @@ import CommonCrypto
 
         if config.enabled {
             if wasUpdated() && config.resetOnUpdate {
+                CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "App was updated. Resetting to default bundle.")
                 reset()
             } else {
                 startRollbackTimer()
             }
-            saveCurrentBundleVersion()
+            saveCurrentBundleShortVersionStringAndBundleVersion()
         }
     }
 
@@ -64,6 +65,7 @@ import CommonCrypto
         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
@@ -75,13 +77,13 @@ import CommonCrypto
         if artifactType == .manifest {
             try await downloadBundleOfTypeManifest(bundleId: bundleId, url: url)
         } else {
-            try await downloadBundleOfTypeZip(bundleId: bundleId, url: url, checksum: checksum)
+            try await downloadBundleOfTypeZip(bundleId: bundleId, url: url, checksum: checksum, signature: signature)
         }
     }
 
     @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, downloadUrl: response?.url)
+        return FetchLatestBundleResult(artifactType: response?.artifactType, bundleId: response?.bundleId, checksum: response?.checksum, downloadUrl: response?.url, signature: response?.signature)
     }
 
     @objc public func getBundle(completion: @escaping (Result?, Error?) -> Void) {
@@ -222,6 +224,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 hasBundle(bundleId: latestBundleId) {
@@ -238,7 +242,7 @@ import CommonCrypto
         if artifactType == .manifest {
             try await downloadBundleOfTypeManifest(bundleId: latestBundleId, url: downloadUrl)
         } else {
-            try await downloadBundleOfTypeZip(bundleId: latestBundleId, url: downloadUrl, checksum: nil)
+            try await downloadBundleOfTypeZip(bundleId: latestBundleId, url: downloadUrl, checksum: checksum, signature: signature)
         }
         // Set the next bundle
         setNextBundle(bundleId: latestBundleId)
@@ -362,7 +366,7 @@ import CommonCrypto
         }
     }
 
-    private func downloadAndVerifyFile(url: String, file: URL, checksum: String?) async throws {
+    private func downloadAndVerifyFile(url: String, file: URL, checksum: String?, signature: String?) async throws {
         let destination: DownloadRequest.Destination = { _, _ in
             return (file, [.createIntermediateDirectories])
         }
@@ -380,8 +384,8 @@ import CommonCrypto
         guard let response = result.response else {
             throw CustomError.unknown
         }
-        let checksum = checksum == nil ? LiveUpdateHttpClient.getChecksumFromResponse(response: response) : checksum
-        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)
     }
 
@@ -392,7 +396,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, checksum: nil)
+        try await self.downloadAndVerifyFile(url: url, file: fileURL, checksum: nil, signature: nil)
         return fileURL
     }
 
@@ -433,11 +437,11 @@ import CommonCrypto
         try await addBundleOfTypeManifest(bundleId: bundleId, directory: temporaryDirectory)
     }
 
-    private func downloadBundleOfTypeZip(bundleId: String, url: String, checksum: String?) async throws {
+    private func downloadBundleOfTypeZip(bundleId: String, url: String, checksum: String?, signature: 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, checksum: checksum)
+        try await downloadAndVerifyFile(url: url, file: temporaryZipFileUrl, checksum: checksum, signature: signature)
         // Add the bundle
         try await addBundleOfTypeZip(bundleId: bundleId, zipFile: temporaryZipFileUrl)
     }
@@ -611,10 +615,10 @@ import CommonCrypto
         setCurrentCapacitorServerPathToDefaultWebAssetDir()
     }
 
-    private func saveCurrentBundleVersion() {
-        guard let currentBundleVersion = Bundle.main.infoDictionary?["CFBundleVersion"] as? String else {
-            return
-        }
+    private func saveCurrentBundleShortVersionStringAndBundleVersion() {
+        let currentBundleShortVersionString = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String
+        preferences.setLastBundleShortVersionString(currentBundleShortVersionString)
+        let currentBundleVersion = Bundle.main.infoDictionary?["CFBundleVersion"] as? String
         preferences.setLastBundleVersion(currentBundleVersion)
     }
 
@@ -786,19 +790,24 @@ import CommonCrypto
     }
 
     private func wasUpdated() -> Bool {
+        guard let lastBundleShortVersionString = preferences.getLastBundleShortVersionString() else {
+            // If the last bundle short version is not set, the app may have been updated
+            return true
+        }
         guard let lastBundleVersionString = preferences.getLastBundleVersion() else {
-            return false
+            // If the last bundle version is not set, the app may have been updated
+            return true
         }
-        guard let lastBundleVersion = Int(lastBundleVersionString) else {
-            return false
+        guard let currentBundleShortVersionString = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String else {
+            // If the current bundle short version is not set, return true for safety reasons
+            return true
         }
         guard let currentBundleVersionString = Bundle.main.infoDictionary?["CFBundleVersion"] as? String else {
-            return false
-        }
-        guard let currentBundleVersion = Int(currentBundleVersionString) else {
-            return false
+            // If the current bundle version is not set, return true for safety reasons
+            return true
         }
-        return currentBundleVersion > lastBundleVersion
+        // `CFBundleVersion` is not unique across different versions of the app
+        return lastBundleShortVersionString + "_" + lastBundleVersionString != currentBundleShortVersionString + "_" + currentBundleVersionString
     }
 }
 

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "6.7.1"
+    public static let version = "6.8.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     private var config: LiveUpdateConfig?
@@ -46,12 +46,13 @@ public class LiveUpdatePlugin: CAPPlugin {
                     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, checksum: checksum, 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/LiveUpdatePreferences.swift

@@ -3,6 +3,7 @@ import Foundation
 public class LiveUpdatePreferences: NSObject {
     private let channelKey = "channel" // DO NOT CHANGE
     private let customIdKey = "customId" // DO NOT CHANGE
+    private let lastBundleShortVersionStringKey = "lastBundleShortVersionString" // DO NOT CHANGE
     private let lastBundleVersionKey = "lastBundleVersion" // DO NOT CHANGE
 
     public func getChannel() -> String? {
@@ -13,6 +14,10 @@ public class LiveUpdatePreferences: NSObject {
         return UserDefaults.standard.string(forKey: applyPrefix(to: customIdKey))
     }
 
+    public func getLastBundleShortVersionString() -> String? {
+        return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
+    }
+
     public func getLastBundleVersion() -> String? {
         return UserDefaults.standard.string(forKey: applyPrefix(to: lastBundleVersionKey))
     }
@@ -31,8 +36,21 @@ public class LiveUpdatePreferences: NSObject {
         UserDefaults.standard.synchronize()
     }
 
-    public func setLastBundleVersion(_ value: String) {
-        UserDefaults.standard.set(value, forKey: applyPrefix(to: lastBundleVersionKey))
+    public func setLastBundleShortVersionString(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastBundleShortVersionStringKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastBundleShortVersionStringKey))
+        }
+        UserDefaults.standard.synchronize()
+    }
+
+    public func setLastBundleVersion(_ value: String?) {
+        if let value = value {
+            UserDefaults.standard.set(value, forKey: applyPrefix(to: lastBundleVersionKey))
+        } else {
+            UserDefaults.standard.removeObject(forKey: applyPrefix(to: lastBundleVersionKey))
+        }
         UserDefaults.standard.synchronize()
     }
 

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

@@ -1,5 +1,7 @@
 public struct GetLatestBundleResponse: Codable {
     var artifactType: ArtifactType
     var bundleId: String
+    var checksum: String?
+    var signature: String?
     var url: String
 }

package/package.json

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