@capawesome/capacitor-live-update 7.2.2 → 7.4.0

package/README.md

@@ -4,7 +4,7 @@ Capacitor plugin that allows you to update your app remotely in real-time withou
 
 <div class="capawesome-z29o10a">
   <a href="https://cloud.capawesome.io/" target="_blank">
-    <img alt="Deliver Live Updates to your Capacitor app with Capawesome Cloud" src="https://cloud.capawesome.io/assets/banners/cloud-deploy-real-time-app-updates.png?t=1" />
+    <img alt="Deliver Live Updates to your Capacitor app with Capawesome Cloud" src="https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1" />
   </a>
 </div>
 
@@ -17,16 +17,24 @@ We are proud to offer one of the most complete and feature-rich Capacitor plugin
 - 📦 **Bundle Management**: Download, set, and delete bundles.
 - ☁️ **Cloud Support**: Use the [Capawesome Cloud](https://cloud.capawesome.io/) to manage your app updates.
 - 📺 **Channel Support**: Set a channel for the app to manage different versions.
-- 🔄 **Auto Update**: Automatically download and set the latest bundle for the app.
+- 🔄 **Auto Update**: Automatically download and set the latest bundle for the app with configurable background update strategy.
 - 🛟 **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.
-- ⚔️ **Battle-Tested**: Used in more than 500 projects to update apps on more than 10,000,000 devices.
+- ⚔️ **Battle-Tested**: Used in more than 1,000 projects to update apps on more than 20,000,000 devices.
 - 🌐 **Open Source**: Licensed under the MIT License.
 
 Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
 
+## Compatibility
+
+| Plugin Version | Capacitor Version | Status         |
+| -------------- | ----------------- | -------------- |
+| 7.x.x          | >=7.x.x           | Active support |
+| 6.x.x          | 6.x.x             | Maintenance    |
+| 5.x.x          | 5.x.x             | Deprecated     |
+
 ## Guides
 
 - [Announcing the Capacitor Live Update Plugin](https://capawesome.io/blog/announcing-the-capacitor-live-update-plugin/)
@@ -89,15 +97,17 @@ 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 |
-| **`httpTimeout`**       | <code>number</code>  | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                                                                                                                                  | <code>60000</code>                     | 6.4.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. It is strongly **recommended** to configure this option so that the plugin can roll back to the default bundle in case of problems. If configured, the plugin will wait for the app to call the `ready()` method before resetting to the default bundle. Set to `0` to disable the timeout. | <code>0</code>                         | 5.0.0 |
-| **`serverDomain`**      | <code>string</code>  | The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.                                                                                                                                                                                                                                                                                        | <code>'api.cloud.capawesome.io'</code> | 7.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>                     | 7.3.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>                    | 7.3.0 |
+| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app.                                                                                                                                                                                                                                                                                                                                                                                            |                                        | 6.3.0 |
+| **`httpTimeout`**                | <code>number</code>                 | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                                                                                                                                                             | <code>60000</code>                     | 6.4.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. It is strongly **recommended** to configure this option (e.g. `10000` ms) so that the plugin can roll back to the default bundle in case of problems. If configured, the plugin will wait for the app to call the `ready()` method before resetting to the default bundle. Set to `0` to disable the timeout.          | <code>0</code>                         | 5.0.0 |
+| **`serverDomain`**               | <code>string</code>                 | The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.                                                                                                                                                                                                                                                                                                                   | <code>'api.cloud.capawesome.io'</code> | 7.0.0 |
 
 ### Examples
 
@@ -108,7 +118,9 @@ In `capacitor.config.json`:
   "plugins": {
     "LiveUpdate": {
       "appId": '6e351b4f-69a7-415e-a057-4567df7ffe94',
+      "autoBlockRolledBackBundles": undefined,
       "autoDeleteBundles": undefined,
+      "autoUpdateStrategy": 'background',
       "defaultChannel": 'production',
       "httpTimeout": undefined,
       "publicKey": '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
@@ -130,7 +142,9 @@ const config: CapacitorConfig = {
   plugins: {
     LiveUpdate: {
       appId: '6e351b4f-69a7-415e-a057-4567df7ffe94',
+      autoBlockRolledBackBundles: undefined,
       autoDeleteBundles: undefined,
+      autoUpdateStrategy: 'background',
       defaultChannel: 'production',
       httpTimeout: undefined,
       publicKey: '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
@@ -145,20 +159,6 @@ export default config;
 
 </docgen-config>
 
-## Starter templates
-
-The following starter templates are available:
-
-- [Ionstarter Angular Firebase](https://ionstarter.dev/)
-- [Ionstarter Angular SQLite](https://ionstarter.dev/)
-
-## Guides
-
-- [Announcing the Capacitor Live Update Plugin](https://capawesome.io/blog/announcing-the-capacitor-live-update-plugin/)
-- [How Live Updates for Capacitor work](https://capawesome.io/blog/how-live-updates-for-capacitor-work/)
-- [How to restrict Capacitor Live Updates to Native Versions](https://capawesome.io/blog/how-to-restrict-capacitor-live-updates-to-native-versions/)
-- [How to gradually roll out Capacitor Live Updates](https://capawesome.io/blog/how-to-gradually-roll-out-capacitor-live-updates/)
-
 ## Usage
 
 ```typescript
@@ -273,25 +273,34 @@ const isNewBundleAvailable = async () => {
 
 <docgen-index>
 
+* [`clearBlockedBundles()`](#clearblockedbundles)
 * [`deleteBundle(...)`](#deletebundle)
 * [`downloadBundle(...)`](#downloadbundle)
 * [`fetchLatestBundle(...)`](#fetchlatestbundle)
+* [`getBlockedBundles()`](#getblockedbundles)
 * [`getBundles()`](#getbundles)
 * [`getChannel()`](#getchannel)
+* [`getConfig()`](#getconfig)
+* [`getDownloadedBundles()`](#getdownloadedbundles)
 * [`getCurrentBundle()`](#getcurrentbundle)
 * [`getCustomId()`](#getcustomid)
 * [`getDeviceId()`](#getdeviceid)
+* [`isSyncing()`](#issyncing)
 * [`getNextBundle()`](#getnextbundle)
 * [`getVersionCode()`](#getversioncode)
 * [`getVersionName()`](#getversionname)
 * [`ready()`](#ready)
 * [`reload()`](#reload)
 * [`reset()`](#reset)
+* [`resetConfig()`](#resetconfig)
 * [`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)
@@ -301,6 +310,24 @@ const isNewBundleAvailable = async () => {
 <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:** 7.4.0
+
+--------------------
+
+
 ### deleteBundle(...)
 
 ```typescript
@@ -360,6 +387,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:** 7.4.0
+
+--------------------
+
+
 ### getBundles()
 
 ```typescript
@@ -394,6 +441,43 @@ 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:** 7.4.0
+
+--------------------
+
+
+### 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:** 7.4.0
+
+--------------------
+
+
 ### getCurrentBundle()
 
 ```typescript
@@ -446,6 +530,23 @@ 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:** 7.4.0
+
+--------------------
+
+
 ### getNextBundle()
 
 ```typescript
@@ -557,6 +658,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:** 7.4.0
+
+--------------------
+
+
 ### setChannel(...)
 
 ```typescript
@@ -576,6 +695,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:** 7.4.0
+
+--------------------
+
+
 ### setCustomId(...)
 
 ```typescript
@@ -661,6 +806,60 @@ Only available on Android and iOS.
 --------------------
 
 
+### 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:** 7.3.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:** 7.4.0
+
+--------------------
+
+
 ### removeAllListeners()
 
 ```typescript
@@ -714,6 +913,13 @@ Remove all listeners for this plugin.
 | **`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. | 7.4.0 |
+
+
 #### GetBundlesResult
 
 | Prop            | Type                  | Description                                              | Since |
@@ -728,6 +934,21 @@ Remove all listeners for this plugin.
 | **`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. | 7.4.0 |
+| **`autoUpdateStrategy`** | <code>'none' \| 'background'</code> | The auto-update strategy for live updates.                               | 7.4.0 |
+
+
+#### GetDownloadedBundlesResult
+
+| Prop            | Type                  | Description                                               | Since |
+| --------------- | --------------------- | --------------------------------------------------------- | ----- |
+| **`bundleIds`** | <code>string[]</code> | An array of unique identifiers of all downloaded bundles. | 7.4.0 |
+
+
 #### GetCurrentBundleResult
 
 | Prop           | Type                        | Description                                                                               | Since |
@@ -749,6 +970,13 @@ Remove all listeners for this plugin.
 | **`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 |
 
 
+#### IsSyncingResult
+
+| Prop          | Type                 | Description                                        | Since |
+| ------------- | -------------------- | -------------------------------------------------- | ----- |
+| **`syncing`** | <code>boolean</code> | Whether a sync operation is currently in progress. | 7.4.0 |
+
+
 #### GetNextBundleResult
 
 | Prop           | Type                        | Description                                                                            | Since |
@@ -786,6 +1014,13 @@ Remove all listeners for this plugin.
 | **`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. | 7.4.0 |
+
+
 #### SetCustomIdOptions
 
 | Prop           | Type                        | Description                                                                      | Since |
@@ -833,6 +1068,15 @@ Event that is triggered when the download progress of a bundle changes.
 | **`totalBytes`**      | <code>number</code> | The total number of bytes to download.                                  | 7.0.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. | 7.3.0 |
+
+
 ### Type Aliases
 
 
@@ -842,6 +1086,20 @@ 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