@capawesome/capacitor-live-update 7.3.0 → 7.4.0

package/README.md

@@ -273,26 +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)
@@ -302,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
@@ -361,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
@@ -395,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
@@ -447,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
@@ -558,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
@@ -577,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
@@ -687,6 +831,35 @@ Only available on Android and iOS.
 --------------------
 
 
+### 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
@@ -740,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 |
@@ -754,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 |
@@ -775,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 |
@@ -812,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 |
@@ -884,6 +1093,13 @@ 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