@capgo/capacitor-updater 7.23.3 → 7.24.0

package/README.md

@@ -16,14 +16,27 @@
 [![Rewarded Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2FCapgo%2Fbounties%3Fstatus%3Dcompleted)](https://console.algora.io/org/Capgo/bounties?status=completed)
 
 <div align="center">
-  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
-  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+  <h2><a href="https://capgo.app/?ref=plugin_updater_v7"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin_updater_v7"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
 </div>
 
 Capacitor plugin to update your app remotely in real-time.
 
 Open-source Alternative to Appflow, Codepush or Capawesome
 
+## Why Capacitor Updater?
+
+App store review processes can take days or weeks, blocking critical bug fixes and updates from reaching your users. Capacitor Updater solves this by:
+
+- **Instant updates** - Push JavaScript/HTML/CSS updates directly to users without app store review
+- **Delta updates** - Only download changed files, making updates ultra-fast
+- **Rollback protection** - Automatically revert broken updates to keep your app stable
+- **Open source** - Self-host or use Capgo Cloud, with full control over your update infrastructure
+- **Battle-tested** - Used by 3000+ production apps with proven reliability
+- **Most stared** - Capacitor updater is the most stared Capacitor plugin on GitHub
+
+Perfect for fixing bugs immediately, A/B testing features, and maintaining control over your release schedule.
+
 ## Features
 
 - ☁️ Cloud / Self hosted Support: Use our [Cloud](https://capgo.app/) to manage your app updates or yours.
@@ -63,7 +76,7 @@ Join the [discord](https://discord.gg/VnYRvBfgA6) to get help.
 | Plugin version | Capacitor compatibility | Maintained        |
 | -------------- | ----------------------- | ----------------- |
 | v7.\*.\*       | v7.\*.\*                | ✅                 |
-| v6.\*.\*       | v6.\*.\*                | Critical bug only  |
+| v6.\*.\*       | v6.\*.\*                | ✅                 |
 | v5.\*.\*       | v5.\*.\*                | ⚠️ Deprecated |
 | v4.\*.\*       | v4.\*.\*                | ⚠️ Deprecated |
 | v3.\*.\*       | v3.\*.\*                | ⚠️ Deprecated     |
@@ -111,7 +124,7 @@ npx cap sync
 
 ## Auto-update setup
 
-Create your account in [capgo.app](https://capgo.app) and get your [API key](https://web.capgo.app/dashboard/apikeys)
+Create your account in [capgo.app](https://capgo.app) and get your [API key](https://console.capgo.app/dashboard/apikeys)
 - Login to CLI `npx @capgo/cli@latest init API_KEY`
 And follow the steps by step to setup your app.
 
@@ -365,6 +378,7 @@ export default config;
 ## API
 
 <docgen-index>
+<!--Auto-generated, compact index-->
 
 * [`notifyAppReady()`](#notifyappready)
 * [`setUpdateUrl(...)`](#setupdateurl)
@@ -417,7 +431,7 @@ export default config;
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
-### notifyAppReady()
+#### notifyAppReady()
 
 ```typescript
 notifyAppReady() => Promise<AppReadyResult>
@@ -432,7 +446,7 @@ Change this behaviour with {@link appReadyTimeout}
 --------------------
 
 
-### setUpdateUrl(...)
+#### setUpdateUrl(...)
 
 ```typescript
 setUpdateUrl(options: UpdateUrl) => Promise<void>
@@ -449,7 +463,7 @@ Set the updateUrl for the app, this will be used to check for updates.
 --------------------
 
 
-### setStatsUrl(...)
+#### setStatsUrl(...)
 
 ```typescript
 setStatsUrl(options: StatsUrl) => Promise<void>
@@ -466,7 +480,7 @@ Set the statsUrl for the app, this will be used to send statistics. Passing an e
 --------------------
 
 
-### setChannelUrl(...)
+#### setChannelUrl(...)
 
 ```typescript
 setChannelUrl(options: ChannelUrl) => Promise<void>
@@ -483,7 +497,7 @@ Set the channelUrl for the app, this will be used to set the channel.
 --------------------
 
 
-### download(...)
+#### download(...)
 
 ```typescript
 download(options: DownloadOptions) => Promise<BundleInfo>
@@ -500,7 +514,7 @@ Download a new bundle from the provided URL, it should be a zip file, with files
 --------------------
 
 
-### next(...)
+#### next(...)
 
 ```typescript
 next(options: BundleId) => Promise<BundleInfo>
@@ -517,7 +531,7 @@ Set the next bundle to be used when the app is reloaded.
 --------------------
 
 
-### set(...)
+#### set(...)
 
 ```typescript
 set(options: BundleId) => Promise<void>
@@ -532,7 +546,7 @@ Set the current bundle and immediately reloads the app.
 --------------------
 
 
-### delete(...)
+#### delete(...)
 
 ```typescript
 delete(options: BundleId) => Promise<void>
@@ -547,7 +561,7 @@ Deletes the specified bundle from the native app storage. Use with {@link list}
 --------------------
 
 
-### setBundleError(...)
+#### setBundleError(...)
 
 ```typescript
 setBundleError(options: BundleId) => Promise<BundleInfo>
@@ -566,7 +580,7 @@ Mark an installed bundle as errored. Only available when {@link PluginsConfig.Ca
 --------------------
 
 
-### list(...)
+#### list(...)
 
 ```typescript
 list(options?: ListOptions | undefined) => Promise<BundleListResult>
@@ -583,7 +597,7 @@ Get all locally downloaded bundles in your app
 --------------------
 
 
-### reset(...)
+#### reset(...)
 
 ```typescript
 reset(options?: ResetOptions | undefined) => Promise<void>
@@ -598,7 +612,7 @@ Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google
 --------------------
 
 
-### current()
+#### current()
 
 ```typescript
 current() => Promise<CurrentBundleResult>
@@ -611,7 +625,7 @@ Get the current bundle, if none are set it returns `builtin`. currentNative is t
 --------------------
 
 
-### reload()
+#### reload()
 
 ```typescript
 reload() => Promise<void>
@@ -622,7 +636,7 @@ Reload the view
 --------------------
 
 
-### setMultiDelay(...)
+#### setMultiDelay(...)
 
 ```typescript
 setMultiDelay(options: MultiDelayConditions) => Promise<void>
@@ -645,7 +659,7 @@ The function has unconsistent behavior the option kill do trigger the update aft
 --------------------
 
 
-### cancelDelay()
+#### cancelDelay()
 
 ```typescript
 cancelDelay() => Promise<void>
@@ -658,7 +672,7 @@ Cancels a {@link <a href="#delaycondition">DelayCondition</a>} to process an upd
 --------------------
 
 
-### getLatest(...)
+#### getLatest(...)
 
 ```typescript
 getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>
@@ -677,7 +691,7 @@ Get Latest bundle available from update Url
 --------------------
 
 
-### setChannel(...)
+#### setChannel(...)
 
 ```typescript
 setChannel(options: SetChannelOptions) => Promise<ChannelRes>
@@ -700,7 +714,7 @@ This methods send to Capgo backend a request to link the device ID to the channe
 --------------------
 
 
-### unsetChannel(...)
+#### unsetChannel(...)
 
 ```typescript
 unsetChannel(options: UnsetChannelOptions) => Promise<void>
@@ -717,7 +731,7 @@ Unset the channel for this device. The device will then return to the default ch
 --------------------
 
 
-### getChannel()
+#### getChannel()
 
 ```typescript
 getChannel() => Promise<GetChannelRes>
@@ -732,7 +746,7 @@ Get the channel for this device
 --------------------
 
 
-### listChannels()
+#### listChannels()
 
 ```typescript
 listChannels() => Promise<ListChannelsResult>
@@ -747,7 +761,7 @@ List all channels available for this device that allow self-assignment
 --------------------
 
 
-### setCustomId(...)
+#### setCustomId(...)
 
 ```typescript
 setCustomId(options: SetCustomIdOptions) => Promise<void>
@@ -767,7 +781,7 @@ Pass an empty string to remove any previously stored customId.
 --------------------
 
 
-### getBuiltinVersion()
+#### getBuiltinVersion()
 
 ```typescript
 getBuiltinVersion() => Promise<BuiltinVersion>
@@ -782,20 +796,29 @@ Get the native app version or the builtin version if set in config
 --------------------
 
 
-### getDeviceId()
+#### getDeviceId()
 
 ```typescript
 getDeviceId() => Promise<DeviceId>
 ```
 
-Get unique ID used to identify device (sent to auto update server), this ID is made following Apple and Google privacy best practices, and not persisted between installs
+Get unique ID used to identify device (sent to auto update server).
+
+This ID is privacy-friendly and follows Apple and Google best practices:
+- Generated as a UUID and stored securely
+- Android: Uses EncryptedSharedPreferences with Auto Backup (persists across reinstalls)
+- iOS: Uses Keychain with kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly (persists across reinstalls)
+- Data stays on device (not synced to cloud on iOS)
+- Can be cleared by user via system settings (Android) or keychain access (iOS)
+
+The device ID now persists between app reinstalls to maintain consistent device identity.
 
 **Returns:** <code>Promise&lt;<a href="#deviceid">DeviceId</a>&gt;</code>
 
 --------------------
 
 
-### getPluginVersion()
+#### getPluginVersion()
 
 ```typescript
 getPluginVersion() => Promise<PluginVersion>
@@ -808,7 +831,7 @@ Get the native Capacitor Updater plugin version (sent to auto update server)
 --------------------
 
 
-### isAutoUpdateEnabled()
+#### isAutoUpdateEnabled()
 
 ```typescript
 isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>
@@ -821,7 +844,7 @@ Get the state of auto update config.
 --------------------
 
 
-### removeAllListeners()
+#### removeAllListeners()
 
 ```typescript
 removeAllListeners() => Promise<void>
@@ -834,7 +857,7 @@ Remove all listeners for this plugin.
 --------------------
 
 
-### addListener('download', ...)
+#### addListener('download', ...)
 
 ```typescript
 addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>
@@ -855,7 +878,7 @@ This will return you all download percent during the download
 --------------------
 
 
-### addListener('noNeedUpdate', ...)
+#### addListener('noNeedUpdate', ...)
 
 ```typescript
 addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>
@@ -875,7 +898,7 @@ Listen for no need to update event, useful when you want force check every time
 --------------------
 
 
-### addListener('updateAvailable', ...)
+#### addListener('updateAvailable', ...)
 
 ```typescript
 addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>
@@ -895,7 +918,7 @@ Listen for available update event, useful when you want to force check every tim
 --------------------
 
 
-### addListener('downloadComplete', ...)
+#### addListener('downloadComplete', ...)
 
 ```typescript
 addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>
@@ -915,7 +938,7 @@ Listen for downloadComplete events.
 --------------------
 
 
-### addListener('breakingAvailable', ...)
+#### addListener('breakingAvailable', ...)
 
 ```typescript
 addListener(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void) => Promise<PluginListenerHandle>
@@ -936,7 +959,7 @@ Emits the same payload as the legacy `majorAvailable` listener.
 --------------------
 
 
-### addListener('majorAvailable', ...)
+#### addListener('majorAvailable', ...)
 
 ```typescript
 addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>
@@ -956,7 +979,7 @@ Listen for Major update event in the App, let you know when major update is bloc
 --------------------
 
 
-### addListener('updateFailed', ...)
+#### addListener('updateFailed', ...)
 
 ```typescript
 addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>
@@ -976,7 +999,7 @@ Listen for update fail event in the App, let you know when update has fail to in
 --------------------
 
 
-### addListener('downloadFailed', ...)
+#### addListener('downloadFailed', ...)
 
 ```typescript
 addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>
@@ -996,7 +1019,7 @@ Listen for download fail event in the App, let you know when a bundle download h
 --------------------
 
 
-### addListener('appReloaded', ...)
+#### addListener('appReloaded', ...)
 
 ```typescript
 addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
@@ -1016,7 +1039,7 @@ Listen for reload event in the App, let you know when reload has happened
 --------------------
 
 
-### addListener('appReady', ...)
+#### addListener('appReady', ...)
 
 ```typescript
 addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>
@@ -1036,7 +1059,7 @@ Listen for app ready event in the App, let you know when app is ready to use, th
 --------------------
 
 
-### isAutoUpdateAvailable()
+#### isAutoUpdateAvailable()
 
 ```typescript
 isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>
@@ -1049,7 +1072,7 @@ Get if auto update is available (not disabled by serverUrl).
 --------------------
 
 
-### getNextBundle()
+#### getNextBundle()
 
 ```typescript
 getNextBundle() => Promise<BundleInfo | null>
@@ -1065,7 +1088,7 @@ Returns null if no next bundle is set.
 --------------------
 
 
-### getFailedUpdate()
+#### getFailedUpdate()
 
 ```typescript
 getFailedUpdate() => Promise<UpdateFailedEvent | null>
@@ -1080,7 +1103,7 @@ Get the most recent update that failed to install, if any. The stored value is c
 --------------------
 
 
-### setShakeMenu(...)
+#### setShakeMenu(...)
 
 ```typescript
 setShakeMenu(options: SetShakeMenuOptions) => Promise<void>
@@ -1097,7 +1120,7 @@ Enable or disable the shake menu for debugging/testing purposes
 --------------------
 
 
-### isShakeMenuEnabled()
+#### isShakeMenuEnabled()
 
 ```typescript
 isShakeMenuEnabled() => Promise<ShakeMenuEnabled>
@@ -1112,7 +1135,7 @@ Get the current state of the shake menu
 --------------------
 
 
-### getAppId()
+#### getAppId()
 
 ```typescript
 getAppId() => Promise<GetAppIdRes>
@@ -1127,7 +1150,7 @@ Get the configured App ID
 --------------------
 
 
-### setAppId(...)
+#### setAppId(...)
 
 ```typescript
 setAppId(options: SetAppIdOptions) => Promise<void>
@@ -1144,17 +1167,17 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
 --------------------
 
 
-### Interfaces
+#### Interfaces
 
 
-#### AppReadyResult
+##### AppReadyResult
 
 | Prop         | Type                                              |
 | ------------ | ------------------------------------------------- |
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> |
 
 
-#### BundleInfo
+##### BundleInfo
 
 | Prop             | Type                                                  |
 | ---------------- | ----------------------------------------------------- |
@@ -1165,28 +1188,28 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
 | **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
 
 
-#### UpdateUrl
+##### UpdateUrl
 
 | Prop      | Type                |
 | --------- | ------------------- |
 | **`url`** | <code>string</code> |
 
 
-#### StatsUrl
+##### StatsUrl
 
 | Prop      | Type                |
 | --------- | ------------------- |
 | **`url`** | <code>string</code> |
 
 
-#### ChannelUrl
+##### ChannelUrl
 
 | Prop      | Type                |
 | --------- | ------------------- |
 | **`url`** | <code>string</code> |
 
 
-#### DownloadOptions
+##### DownloadOptions
 
 This URL and versions are used to download the bundle from the server, If you use backend all information will be gived by the method getLatest.
 If you don't use backend, you need to provide the URL and version of the bundle. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.
@@ -1200,7 +1223,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`manifest`**   | <code>ManifestEntry[]</code> | The manifest for multi-file downloads                                                                                                                            | <code>undefined</code> | 6.1.0 |
 
 
-#### ManifestEntry
+##### ManifestEntry
 
 | Prop               | Type                        |
 | ------------------ | --------------------------- |
@@ -1209,35 +1232,35 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`download_url`** | <code>string \| null</code> |
 
 
-#### BundleId
+##### BundleId
 
 | Prop     | Type                |
 | -------- | ------------------- |
 | **`id`** | <code>string</code> |
 
 
-#### BundleListResult
+##### BundleListResult
 
 | Prop          | Type                      |
 | ------------- | ------------------------- |
 | **`bundles`** | <code>BundleInfo[]</code> |
 
 
-#### ListOptions
+##### ListOptions
 
 | Prop      | Type                 | Description                                                                                                                                   | Default            | Since  |
 | --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ |
 | **`raw`** | <code>boolean</code> | Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk. | <code>false</code> | 6.14.0 |
 
 
-#### ResetOptions
+##### ResetOptions
 
 | Prop                   | Type                 |
 | ---------------------- | -------------------- |
 | **`toLastSuccessful`** | <code>boolean</code> |
 
 
-#### CurrentBundleResult
+##### CurrentBundleResult
 
 | Prop         | Type                                              |
 | ------------ | ------------------------------------------------- |
@@ -1245,14 +1268,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`native`** | <code>string</code>                               |
 
 
-#### MultiDelayConditions
+##### MultiDelayConditions
 
 | Prop                  | Type                          |
 | --------------------- | ----------------------------- |
 | **`delayConditions`** | <code>DelayCondition[]</code> |
 
 
-#### DelayCondition
+##### DelayCondition
 
 | Prop        | Type                                                      | Description                              |
 | ----------- | --------------------------------------------------------- | ---------------------------------------- |
@@ -1260,7 +1283,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`value`** | <code>string</code>                                       |                                          |
 
 
-#### LatestVersion
+##### LatestVersion
 
 | Prop             | Type                         | Description                                                          | Since  |
 | ---------------- | ---------------------------- | -------------------------------------------------------------------- | ------ |
@@ -1276,14 +1299,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`manifest`**   | <code>ManifestEntry[]</code> |                                                                      | 6.1    |
 
 
-#### GetLatestOptions
+##### GetLatestOptions
 
 | Prop          | Type                | Description                                                                                     | Default                | Since |
 | ------------- | ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- | ----- |
 | **`channel`** | <code>string</code> | The channel to get the latest version for The channel must allow 'self_assign' for this to work | <code>undefined</code> | 6.8.0 |
 
 
-#### ChannelRes
+##### ChannelRes
 
 | Prop          | Type                | Description                   | Since |
 | ------------- | ------------------- | ----------------------------- | ----- |
@@ -1292,7 +1315,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`message`** | <code>string</code> |                               |       |
 
 
-#### SetChannelOptions
+##### SetChannelOptions
 
 | Prop                    | Type                 |
 | ----------------------- | -------------------- |
@@ -1300,14 +1323,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`triggerAutoUpdate`** | <code>boolean</code> |
 
 
-#### UnsetChannelOptions
+##### UnsetChannelOptions
 
 | Prop                    | Type                 |
 | ----------------------- | -------------------- |
 | **`triggerAutoUpdate`** | <code>boolean</code> |
 
 
-#### GetChannelRes
+##### GetChannelRes
 
 | Prop           | Type                 | Description                   | Since |
 | -------------- | -------------------- | ----------------------------- | ----- |
@@ -1318,14 +1341,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`allowSet`** | <code>boolean</code> |                               |       |
 
 
-#### ListChannelsResult
+##### ListChannelsResult
 
 | Prop           | Type                       | Description                | Since |
 | -------------- | -------------------------- | -------------------------- | ----- |
 | **`channels`** | <code>ChannelInfo[]</code> | List of available channels | 7.5.0 |
 
 
-#### ChannelInfo
+##### ChannelInfo
 
 | Prop                 | Type                 | Description                                     | Since |
 | -------------------- | -------------------- | ----------------------------------------------- | ----- |
@@ -1335,49 +1358,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`allow_self_set`** | <code>boolean</code> | Whether devices can self-assign to this channel | 7.5.0 |
 
 
-#### SetCustomIdOptions
+##### SetCustomIdOptions
 
 | Prop           | Type                | Description                                                                                   |
 | -------------- | ------------------- | --------------------------------------------------------------------------------------------- |
 | **`customId`** | <code>string</code> | Custom identifier to associate with the device. Use an empty string to clear any saved value. |
 
 
-#### BuiltinVersion
+##### BuiltinVersion
 
 | Prop          | Type                |
 | ------------- | ------------------- |
 | **`version`** | <code>string</code> |
 
 
-#### DeviceId
+##### DeviceId
 
 | Prop           | Type                |
 | -------------- | ------------------- |
 | **`deviceId`** | <code>string</code> |
 
 
-#### PluginVersion
+##### PluginVersion
 
 | Prop          | Type                |
 | ------------- | ------------------- |
 | **`version`** | <code>string</code> |
 
 
-#### AutoUpdateEnabled
+##### AutoUpdateEnabled
 
 | Prop          | Type                 |
 | ------------- | -------------------- |
 | **`enabled`** | <code>boolean</code> |
 
 
-#### PluginListenerHandle
+##### PluginListenerHandle
 
 | Prop         | Type                                      |
 | ------------ | ----------------------------------------- |
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
-#### DownloadEvent
+##### DownloadEvent
 
 | Prop          | Type                                              | Description                                    | Since |
 | ------------- | ------------------------------------------------- | ---------------------------------------------- | ----- |
@@ -1385,49 +1408,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`bundle`**  | <code><a href="#bundleinfo">BundleInfo</a></code> |                                                |       |
 
 
-#### NoNeedEvent
+##### NoNeedEvent
 
 | Prop         | Type                                              | Description                                    | Since |
 | ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
 
 
-#### UpdateAvailableEvent
+##### UpdateAvailableEvent
 
 | Prop         | Type                                              | Description                                    | Since |
 | ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
 
 
-#### DownloadCompleteEvent
+##### DownloadCompleteEvent
 
 | Prop         | Type                                              | Description                          | Since |
 | ------------ | ------------------------------------------------- | ------------------------------------ | ----- |
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a new update is available. | 4.0.0 |
 
 
-#### MajorAvailableEvent
+##### MajorAvailableEvent
 
 | Prop          | Type                | Description                               | Since |
 | ------------- | ------------------- | ----------------------------------------- | ----- |
 | **`version`** | <code>string</code> | Emit when a breaking update is available. | 4.0.0 |
 
 
-#### UpdateFailedEvent
+##### UpdateFailedEvent
 
 | Prop         | Type                                              | Description                           | Since |
 | ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a update failed to install. | 4.0.0 |
 
 
-#### DownloadFailedEvent
+##### DownloadFailedEvent
 
 | Prop          | Type                | Description                | Since |
 | ------------- | ------------------- | -------------------------- | ----- |
 | **`version`** | <code>string</code> | Emit when a download fail. | 4.0.0 |
 
 
-#### AppReadyEvent
+##### AppReadyEvent
 
 | Prop         | Type                                              | Description                           | Since |
 | ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
@@ -1435,45 +1458,45 @@ If you don't use backend, you need to provide the URL and version of the bundle.
 | **`status`** | <code>string</code>                               |                                       |       |
 
 
-#### AutoUpdateAvailable
+##### AutoUpdateAvailable
 
 | Prop            | Type                 |
 | --------------- | -------------------- |
 | **`available`** | <code>boolean</code> |
 
 
-#### SetShakeMenuOptions
+##### SetShakeMenuOptions
 
 | Prop          | Type                 |
 | ------------- | -------------------- |
 | **`enabled`** | <code>boolean</code> |
 
 
-#### ShakeMenuEnabled
+##### ShakeMenuEnabled
 
 | Prop          | Type                 |
 | ------------- | -------------------- |
 | **`enabled`** | <code>boolean</code> |
 
 
-#### GetAppIdRes
+##### GetAppIdRes
 
 | Prop        | Type                |
 | ----------- | ------------------- |
 | **`appId`** | <code>string</code> |
 
 
-#### SetAppIdOptions
+##### SetAppIdOptions
 
 | Prop        | Type                |
 | ----------- | ------------------- |
 | **`appId`** | <code>string</code> |
 
 
-### Type Aliases
+#### Type Aliases
 
 
-#### BundleStatus
+##### BundleStatus
 
 pending: The bundle is pending to be **SET** as the next bundle.
 downloading: The bundle is being downloaded.
@@ -1483,12 +1506,12 @@ error: The bundle has failed to download.
 <code>'success' | 'error' | 'pending' | 'downloading'</code>
 
 
-#### DelayUntilNext
+##### DelayUntilNext
 
 <code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
 
 
-#### BreakingAvailableEvent
+##### BreakingAvailableEvent
 
 Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.