@capawesome/capacitor-live-update 6.4.2 → 6.6.0

package/README.md

@@ -12,6 +12,7 @@ Capacitor plugin to update your app remotely in real-time.
 - 🔄 **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.
 - 🚀 **Rollout**: Gradually roll out new bundles to gather valuable feedback.
+- 🔁 **Delta Updates**: Make your updates faster by only downloading changed files.
 - 🔒 **Security**: Verify the authenticity and integrity of the bundle using a public key.
 - 🌐 **Open Source**: Licensed under the MIT License.
 
@@ -155,6 +156,10 @@ const downloadBundle = async () => {
   await LiveUpdate.downloadBundle({ url: 'https://example.com/1.0.0.zip', bundleId: '1.0.0' });
 };
 
+const fetchLatestBundle = async () => {
+  await LiveUpdate.fetchLatestBundle();
+};
+
 const getBundle = async () => {
   const result = await LiveUpdate.getBundle();
   return result.bundleId;
@@ -218,6 +223,16 @@ const sync = async () => {
   const result = await LiveUpdate.sync();
   return result.nextBundleId;
 };
+
+const isNewBundleAvailable = async () => {
+  const { bundleId: latestBundleId } = await LiveUpdate.fetchLatestBundle();
+  if (latestBundleId) {
+    const { bundleId: currentBundleId } = await LiveUpdate.getBundle();
+    return latestBundleId !== currentBundleId;
+  } else {
+    return false;
+  }
+};
 ```
 
 ## API
@@ -226,6 +241,7 @@ const sync = async () => {
 
 * [`deleteBundle(...)`](#deletebundle)
 * [`downloadBundle(...)`](#downloadbundle)
+* [`fetchLatestBundle()`](#fetchlatestbundle)
 * [`getBundle()`](#getbundle)
 * [`getBundles()`](#getbundles)
 * [`getChannel()`](#getchannel)
@@ -285,6 +301,23 @@ Only available on Android and iOS.
 --------------------
 
 
+### fetchLatestBundle()
+
+```typescript
+fetchLatestBundle() => Promise<FetchLatestBundleResult>
+```
+
+Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#fetchlatestbundleresult">FetchLatestBundleResult</a>&gt;</code>
+
+**Since:** 6.6.0
+
+--------------------
+
+
 ### getBundle()
 
 ```typescript
@@ -544,11 +577,19 @@ Only available on Android and iOS.
 
 #### DownloadBundleOptions
 
-| Prop           | Type                | Description                                                                                                       | Since |
-| -------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------- | ----- |
-| **`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 hexadecimal format. | 6.1.0 |
-| **`url`**      | <code>string</code> | The URL of the bundle to download. The bundle must be a ZIP file containing at least a `index.html` file.         | 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                    | 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 |
+| **`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 |
+| -------------- | --------------------------- | ------------------------------------------------------------------------------ | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the latest bundle. If `null`, no bundle is available. | 6.6.0 |
 
 
 #### GetBundleResult