@capawesome/capacitor-live-update 6.8.0 → 6.9.0

package/CapawesomeCapacitorLiveUpdate.podspec

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

package/README.md

@@ -66,17 +66,20 @@ We recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bun
 <docgen-config>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
-| Prop                    | Type                      | Description                                                                                                                                                                                                                                                                          | Default            | Since |
-| ----------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
-| **`appId`**             | <code>string</code>       | The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud). This is **NOT** the same as the app identifier (e.g. `com.example.app`). This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`). |                    | 5.0.0 |
-| **`autoDeleteBundles`** | <code>boolean</code>      | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`.                                                                                                                                    | <code>false</code> | 5.0.0 |
-| **`defaultChannel`**    | <code>string</code>       | The default channel of the app.                                                                                                                                                                                                                                                      |                    | 6.3.0 |
-| **`enabled`**           | <code>boolean</code>      | Whether or not the plugin is enabled.                                                                                                                                                                                                                                                | <code>true</code>  | 5.0.0 |
-| **`httpTimeout`**       | <code>number</code>       | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                       | <code>60000</code> | 6.4.0 |
-| **`location`**          | <code>'us' \| 'eu'</code> | The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).                                                                                                                                                                                        | <code>'us'</code>  | 6.2.0 |
-| **`publicKey`**         | <code>string</code>       | The public key to verify the integrity of the bundle. The public key must be a PEM-encoded RSA public key.                                                                                                                                                                           |                    | 6.1.0 |
-| **`readyTimeout`**      | <code>number</code>       | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.                                                                                                                                                                                  | <code>10000</code> | 5.0.0 |
-| **`resetOnUpdate`**     | <code>boolean</code>      | Whether or not the app should be reset to the default bundle during an update.                                                                                                                                                                                                       | <code>true</code>  | 5.0.0 |
+| Prop                             | Type                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                | Default                                | Since |
+| -------------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ----- |
+| **`appId`**                      | <code>string</code>                 | The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud). This is **NOT** the same as the app identifier (e.g. `com.example.app`). This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).                                                                                                                                       |                                        | 5.0.0 |
+| **`autoBlockRolledBackBundles`** | <code>boolean</code>                | Whether or not to automatically block bundles that have been rolled back. When enabled, the plugin will automatically block bundles that caused a rollback (up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked. Blocked bundles will be skipped in future sync operations. **Attention**: This option has no effect if `readyTimeout` is set to `0`. Only available on Android and iOS. | <code>false</code>                     | 6.9.0 |
+| **`autoDeleteBundles`**          | <code>boolean</code>                | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`.                                                                                                                                                                                                                                                                          | <code>false</code>                     | 5.0.0 |
+| **`autoUpdateStrategy`**         | <code>'none' \| 'background'</code> | The auto-update strategy for live updates. - `none`: Live updates will not be applied automatically. - `background`: Live updates will be automatically downloaded and applied in the background at app startup and when the app resumes (if the last check was more than 15 minutes ago). Only available on Android and iOS.                                                                                              | <code>'none'</code>                    | 6.9.0 |
+| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app. This can be overridden by `setChannel()`, the `channel` parameter of `sync()`, or the native channel configuration (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel` in `strings.xml` on Android).                                                                                                                                  |                                        | 6.3.0 |
+| **`enabled`**                    | <code>boolean</code>                | Whether or not the plugin is enabled.                                                                                                                                                                                                                                                                                                                                                                                      | <code>true</code>                      | 5.0.0 |
+| **`httpTimeout`**                | <code>number</code>                 | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                                                                                                                                                             | <code>60000</code>                     | 6.4.0 |
+| **`location`**                   | <code>'us' \| 'eu'</code>           | The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).                                                                                                                                                                                                                                                                                                                              | <code>'us'</code>                      | 6.2.0 |
+| **`publicKey`**                  | <code>string</code>                 | The public key to verify the integrity of the bundle. The public key must be a PEM-encoded RSA public key.                                                                                                                                                                                                                                                                                                                 |                                        | 6.1.0 |
+| **`readyTimeout`**               | <code>number</code>                 | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.                                                                                                                                                                                                                                                                                                                        | <code>10000</code>                     | 5.0.0 |
+| **`resetOnUpdate`**              | <code>boolean</code>                | Whether or not the app should be reset to the default bundle during an update.                                                                                                                                                                                                                                                                                                                                             | <code>true</code>                      | 5.0.0 |
+| **`serverDomain`**               | <code>string</code>                 | The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path. This option takes precedence over the `location` configuration option.                                                                                                                                                                                                                                            | <code>'api.cloud.capawesome.io'</code> | 6.9.0 |
 
 ### Examples
 
@@ -87,14 +90,17 @@ In `capacitor.config.json`:
   "plugins": {
     "LiveUpdate": {
       "appId": '6e351b4f-69a7-415e-a057-4567df7ffe94',
+      "autoBlockRolledBackBundles": undefined,
       "autoDeleteBundles": undefined,
+      "autoUpdateStrategy": 'background',
       "defaultChannel": 'production',
       "enabled": undefined,
       "httpTimeout": undefined,
       "location": 'eu',
       "publicKey": '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       "readyTimeout": undefined,
-      "resetOnUpdate": undefined
+      "resetOnUpdate": undefined,
+      "serverDomain": 'api.cloud.capawesome.eu'
     }
   }
 }
@@ -111,7 +117,9 @@ const config: CapacitorConfig = {
   plugins: {
     LiveUpdate: {
       appId: '6e351b4f-69a7-415e-a057-4567df7ffe94',
+      autoBlockRolledBackBundles: undefined,
       autoDeleteBundles: undefined,
+      autoUpdateStrategy: 'background',
       defaultChannel: 'production',
       enabled: undefined,
       httpTimeout: undefined,
@@ -119,6 +127,7 @@ const config: CapacitorConfig = {
       publicKey: '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       readyTimeout: undefined,
       resetOnUpdate: undefined,
+      serverDomain: 'api.cloud.capawesome.eu',
     },
   },
 };
@@ -240,33 +249,64 @@ const isNewBundleAvailable = async () => {
 
 <docgen-index>
 
+* [`clearBlockedBundles()`](#clearblockedbundles)
 * [`deleteBundle(...)`](#deletebundle)
 * [`downloadBundle(...)`](#downloadbundle)
+* [`fetchChannels(...)`](#fetchchannels)
 * [`fetchLatestBundle(...)`](#fetchlatestbundle)
+* [`getBlockedBundles()`](#getblockedbundles)
 * [`getBundle()`](#getbundle)
 * [`getBundles()`](#getbundles)
 * [`getChannel()`](#getchannel)
+* [`getConfig()`](#getconfig)
 * [`getCurrentBundle()`](#getcurrentbundle)
 * [`getCustomId()`](#getcustomid)
 * [`getDeviceId()`](#getdeviceid)
+* [`getDownloadedBundles()`](#getdownloadedbundles)
 * [`getNextBundle()`](#getnextbundle)
 * [`getVersionCode()`](#getversioncode)
 * [`getVersionName()`](#getversionname)
+* [`isSyncing()`](#issyncing)
 * [`ready()`](#ready)
 * [`reload()`](#reload)
 * [`reset()`](#reset)
+* [`resetConfig()`](#resetconfig)
 * [`setBundle(...)`](#setbundle)
 * [`setChannel(...)`](#setchannel)
+* [`setConfig(...)`](#setconfig)
 * [`setCustomId(...)`](#setcustomid)
 * [`setNextBundle(...)`](#setnextbundle)
 * [`sync(...)`](#sync)
+* [`addListener('downloadBundleProgress', ...)`](#addlistenerdownloadbundleprogress-)
+* [`addListener('nextBundleSet', ...)`](#addlistenernextbundleset-)
+* [`addListener('reloaded', ...)`](#addlistenerreloaded-)
+* [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+### clearBlockedBundles()
+
+```typescript
+clearBlockedBundles() => Promise<void>
+```
+
+Clear all blocked bundles from the blocked list.
+
+This removes all bundle identifiers that were automatically blocked
+due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+
+Only available on Android and iOS.
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### deleteBundle(...)
 
 ```typescript
@@ -305,6 +345,35 @@ Only available on Android and iOS.
 --------------------
 
 
+### fetchChannels(...)
+
+```typescript
+fetchChannels(options?: FetchChannelsOptions | undefined) => Promise<FetchChannelsResult>
+```
+
+Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).
+
+This is primarily intended for development and QA purposes.
+It allows you to retrieve a list of available channels so you can
+dynamically switch between them using `setChannel(...)`.
+
+**Attention**: Only works for apps with public channels enabled.
+If channels are private, they can still be set using `setChannel(...)`
+but won't be returned by this method.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                  |
+| ------------- | --------------------------------------------------------------------- |
+| **`options`** | <code><a href="#fetchchannelsoptions">FetchChannelsOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#fetchchannelsresult">FetchChannelsResult</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### fetchLatestBundle(...)
 
 ```typescript
@@ -326,6 +395,26 @@ Only available on Android and iOS.
 --------------------
 
 
+### getBlockedBundles()
+
+```typescript
+getBlockedBundles() => Promise<GetBlockedBundlesResult>
+```
+
+Get all blocked bundle identifiers.
+
+Returns the list of bundle identifiers that were automatically blocked
+due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getblockedbundlesresult">GetBlockedBundlesResult</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### getBundle()
 
 ```typescript
@@ -368,6 +457,15 @@ getChannel() => Promise<GetChannelResult>
 
 Get the channel that is used for the update.
 
+The channel is resolved in the following order (highest priority first):
+1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
+2. Capacitor config `defaultChannel`
+3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
+   `capawesome_live_update_default_channel` in `strings.xml` on Android)
+
+**Note**: The `channel` parameter of `sync()` takes the highest priority
+but is not persisted and therefore not returned by this method.
+
 Only available on Android and iOS.
 
 **Returns:** <code>Promise&lt;<a href="#getchannelresult">GetChannelResult</a>&gt;</code>
@@ -377,6 +475,26 @@ Only available on Android and iOS.
 --------------------
 
 
+### getConfig()
+
+```typescript
+getConfig() => Promise<GetConfigResult>
+```
+
+Get the runtime configuration.
+
+Returns the current plugin configuration including any runtime
+overrides set via `setConfig()`.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getconfigresult">GetConfigResult</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### getCurrentBundle()
 
 ```typescript
@@ -429,6 +547,23 @@ Only available on Android and iOS.
 --------------------
 
 
+### getDownloadedBundles()
+
+```typescript
+getDownloadedBundles() => Promise<GetDownloadedBundlesResult>
+```
+
+Get all identifiers of bundles that have been downloaded.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getdownloadedbundlesresult">GetDownloadedBundlesResult</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### getNextBundle()
 
 ```typescript
@@ -482,10 +617,27 @@ Only available on Android and iOS.
 --------------------
 
 
+### isSyncing()
+
+```typescript
+isSyncing() => Promise<IsSyncingResult>
+```
+
+Check whether a sync operation is currently in progress.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#issyncingresult">IsSyncingResult</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### ready()
 
 ```typescript
-ready() => Promise<void>
+ready() => Promise<ReadyResult>
 ```
 
 Notify the plugin that the app is ready to use and no rollback is needed.
@@ -495,6 +647,8 @@ to prevent the app from being reset to the default bundle.
 
 Only available on Android and iOS.
 
+**Returns:** <code>Promise&lt;<a href="#readyresult">ReadyResult</a>&gt;</code>
+
 **Since:** 5.0.0
 
 --------------------
@@ -532,6 +686,24 @@ Only available on Android and iOS.
 --------------------
 
 
+### resetConfig()
+
+```typescript
+resetConfig() => Promise<void>
+```
+
+Reset the runtime configuration to the values from the Capacitor config file.
+
+This clears any runtime configuration set via `setConfig()`.
+The changes take effect immediately.
+
+Only available on Android and iOS.
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### setBundle(...)
 
 ```typescript
@@ -572,6 +744,32 @@ Only available on Android and iOS.
 --------------------
 
 
+### setConfig(...)
+
+```typescript
+setConfig(options: SetConfigOptions) => Promise<void>
+```
+
+Set the runtime configuration.
+
+This allows updating plugin configuration options at runtime.
+The changes are persisted across app restarts and take effect immediately.
+
+**Important:** Runtime configuration is automatically reset to default values
+whenever the native app is updated to a new version. This ensures that
+configuration from previous versions doesn't persist after an app update.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#setconfigoptions">SetConfigOptions</a></code> |
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### setCustomId(...)
 
 ```typescript
@@ -635,6 +833,95 @@ Only available on Android and iOS.
 --------------------
 
 
+### addListener('downloadBundleProgress', ...)
+
+```typescript
+addListener(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener) => Promise<PluginListenerHandle>
+```
+
+Listen for the download progress of a bundle.
+
+Only available on Android and iOS.
+
+| Param              | Type                                                                                      |
+| ------------------ | ----------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadBundleProgress'</code>                                                     |
+| **`listenerFunc`** | <code><a href="#downloadbundleprogresslistener">DownloadBundleProgressListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
+### addListener('nextBundleSet', ...)
+
+```typescript
+addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => Promise<PluginListenerHandle>
+```
+
+Listen for when a bundle is set as the next bundle.
+
+This event is triggered whenever a bundle is set to be used on the next app restart,
+either through automatic updates or manual calls to `setNextBundle()`.
+
+Only available on Android and iOS.
+
+| Param              | Type                                                                    |
+| ------------------ | ----------------------------------------------------------------------- |
+| **`eventName`**    | <code>'nextBundleSet'</code>                                            |
+| **`listenerFunc`** | <code><a href="#nextbundlesetlistener">NextBundleSetListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
+### addListener('reloaded', ...)
+
+```typescript
+addListener(eventName: 'reloaded', listenerFunc: ReloadedListener) => Promise<PluginListenerHandle>
+```
+
+Listen for when the app is reloaded.
+
+This event is triggered after the `reload()` method is called
+and the app has been reloaded.
+
+**Note:** To verify whether an update was successfully applied after a reload,
+use the `ready()` method instead. The `ready()` method provides detailed information
+about the current bundle, previous bundle, and whether a rollback occurred.
+
+Only available on Android and iOS.
+
+| Param              | Type                                                          |
+| ------------------ | ------------------------------------------------------------- |
+| **`eventName`**    | <code>'reloaded'</code>                                       |
+| **`listenerFunc`** | <code><a href="#reloadedlistener">ReloadedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 6.9.0
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners for this plugin.
+
+**Since:** 6.9.0
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -656,15 +943,40 @@ Only available on Android and iOS.
 | **`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 |
 
 
+#### FetchChannelsResult
+
+| Prop           | Type                   | Description           | Since |
+| -------------- | ---------------------- | --------------------- | ----- |
+| **`channels`** | <code>Channel[]</code> | The list of channels. | 6.9.0 |
+
+
+#### Channel
+
+| Prop       | Type                | Description                           | Since |
+| ---------- | ------------------- | ------------------------------------- | ----- |
+| **`id`**   | <code>string</code> | The unique identifier of the channel. | 6.9.0 |
+| **`name`** | <code>string</code> | The name of the channel.              | 6.9.0 |
+
+
+#### FetchChannelsOptions
+
+| Prop         | Type                | Description                               | Default         | Since |
+| ------------ | ------------------- | ----------------------------------------- | --------------- | ----- |
+| **`limit`**  | <code>number</code> | The maximum number of channels to return. | <code>50</code> | 6.9.0 |
+| **`offset`** | <code>number</code> | The number of channels to skip.           | <code>0</code>  | 6.9.0 |
+| **`query`**  | <code>string</code> | The query to filter channels by name.     |                 | 6.9.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 |
-| **`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 |
+| 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 |
+| **`customProperties`** | <code>{ [key: string]: string; }</code> | Custom properties that are associated with the latest bundle.                                                                                                                                | 6.9.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
@@ -674,6 +986,13 @@ Only available on Android and iOS.
 | **`channel`** | <code>string</code> | The name of the channel where the latest bundle is fetched from. | 6.7.0 |
 
 
+#### GetBlockedBundlesResult
+
+| Prop            | Type                  | Description                                            | Since |
+| --------------- | --------------------- | ------------------------------------------------------ | ----- |
+| **`bundleIds`** | <code>string[]</code> | An array of unique identifiers of all blocked bundles. | 6.9.0 |
+
+
 #### GetBundleResult
 
 | Prop           | Type                        | Description                                                                              | Since |
@@ -695,6 +1014,14 @@ Only available on Android and iOS.
 | **`channel`** | <code>string \| null</code> | The channel name. If `null`, the app is using the default channel. | 5.0.0 |
 
 
+#### GetConfigResult
+
+| Prop                     | Type                                | Description                                                              | Since |
+| ------------------------ | ----------------------------------- | ------------------------------------------------------------------------ | ----- |
+| **`appId`**              | <code>string \| null</code>         | The app ID used to identify the app. If `null`, no app ID is configured. | 6.9.0 |
+| **`autoUpdateStrategy`** | <code>'none' \| 'background'</code> | The auto-update strategy for live updates.                               | 6.9.0 |
+
+
 #### GetCurrentBundleResult
 
 | Prop           | Type                        | Description                                                                               | Since |
@@ -716,6 +1043,13 @@ Only available on Android and iOS.
 | **`deviceId`** | <code>string</code> | The unique identifier of the device. On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used. The value of this property is the same for apps that come from the same vendor running on the same device. | 5.0.0 |
 
 
+#### GetDownloadedBundlesResult
+
+| Prop            | Type                  | Description                                               | Since |
+| --------------- | --------------------- | --------------------------------------------------------- | ----- |
+| **`bundleIds`** | <code>string[]</code> | An array of unique identifiers of all downloaded bundles. | 6.9.0 |
+
+
 #### GetNextBundleResult
 
 | Prop           | Type                        | Description                                                                            | Since |
@@ -737,6 +1071,22 @@ Only available on Android and iOS.
 | **`versionName`** | <code>string</code> | The version name of the app. On **Android**, this is the `versionName` from the `android/app/build.gradle` file. On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file. | 5.0.0 |
 
 
+#### IsSyncingResult
+
+| Prop          | Type                 | Description                                        | Since |
+| ------------- | -------------------- | -------------------------------------------------- | ----- |
+| **`syncing`** | <code>boolean</code> | Whether a sync operation is currently in progress. | 6.9.0 |
+
+
+#### ReadyResult
+
+| Prop                   | Type                        | Description                                                                             | Since |
+| ---------------------- | --------------------------- | --------------------------------------------------------------------------------------- | ----- |
+| **`previousBundleId`** | <code>string \| null</code> | The identifier of the previous bundle used. If `null`, the default bundle was used.     | 6.9.0 |
+| **`currentBundleId`**  | <code>string \| null</code> | The identifier of the current bundle used. If `null`, the default bundle is being used. | 6.9.0 |
+| **`rollback`**         | <code>boolean</code>        | Whether or not the app was reset to the default bundle.                                 | 6.9.0 |
+
+
 #### SetBundleOptions
 
 | Prop           | Type                | Description                                 | Since |
@@ -751,6 +1101,13 @@ Only available on Android and iOS.
 | **`channel`** | <code>string \| null</code> | The channel name. Set `null` to remove the channel. | 5.0.0 |
 
 
+#### SetConfigOptions
+
+| Prop        | Type                        | Description                                                                                           | Since |
+| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------- | ----- |
+| **`appId`** | <code>string \| null</code> | The app ID used to identify the app. Set `null` to reset to the value from the Capacitor config file. | 6.9.0 |
+
+
 #### SetCustomIdOptions
 
 | Prop           | Type                        | Description                                                                      | Since |
@@ -778,6 +1135,58 @@ Only available on Android and iOS.
 | ------------- | ------------------- | ---------------------------------------------------------------- | ----- |
 | **`channel`** | <code>string</code> | The name of the channel where the latest bundle is fetched from. | 6.7.0 |
 
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### DownloadBundleProgressEvent
+
+Event that is triggered when the download progress of a bundle changes.
+
+| Prop                  | Type                | Description                                                             | Since |
+| --------------------- | ------------------- | ----------------------------------------------------------------------- | ----- |
+| **`bundleId`**        | <code>string</code> | The unique identifier of the bundle that is being downloaded.           | 6.9.0 |
+| **`downloadedBytes`** | <code>number</code> | The number of bytes that have been downloaded.                          | 6.9.0 |
+| **`progress`**        | <code>number</code> | The progress of the download in percent as a value between `0` and `1`. | 6.9.0 |
+| **`totalBytes`**      | <code>number</code> | The total number of bytes to download.                                  | 6.9.0 |
+
+
+#### NextBundleSetEvent
+
+Event that is triggered when a bundle is set as the next bundle.
+
+| Prop           | Type                        | Description                                                                                                     | Since |
+| -------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the bundle that is set as the next bundle. If `null`, the default bundle will be used. | 6.9.0 |
+
+
+### Type Aliases
+
+
+#### DownloadBundleProgressListener
+
+Listener for the download progress of a bundle.
+
+<code>(event: <a href="#downloadbundleprogressevent">DownloadBundleProgressEvent</a>): void</code>
+
+
+#### NextBundleSetListener
+
+Listener for when a bundle is set as the next bundle.
+
+<code>(event: <a href="#nextbundlesetevent">NextBundleSetEvent</a>): void</code>
+
+
+#### ReloadedListener
+
+Listener for when the app is reloaded.
+
+<code>(): void</code>
+
 </docgen-api>
 
 ## Testing