@capgo/capacitor-updater 5.0.0-alpha.0 → 7.0.0

package/README.md

@@ -1,18 +1,33 @@
-# capacitor-updater
+# Capacitor updater
+  <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/VnYRvBfgA6)
+<a href="https://discord.com/invite/VnYRvBfgA6"><img src="https://img.shields.io/discord/912707985829163099?color=%237289DA&label=Discord" alt="Discord">
+[![npm](https://img.shields.io/npm/dm/@capgo/capacitor-updater)](https://www.npmjs.com/package/@capgo/capacitor-updater)
+[![GitHub latest commit](https://badgen.net/github/last-commit/Cap-go/capacitor-updater/main)](https://GitHub.com/Cap-go/capacitor-updater/commit/)
+[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)
+[![Open Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2FCapgo%2Fbounties%3Fstatus%3Dopen)](https://console.algora.io/org/Capgo/bounties?status=open)
+[![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)
 
 Update Ionic Capacitor apps without App/Play Store review (Code-push / hot-code updates).
 
-Usage options:
-- use [capgo.app](https://capgo.app), a full featured auto update system. (5 min Setup, easily manage versions, update, revert, and see detailed stats.)
-- integrate your own API with this plugin's auto update system.
-- use manual methods to zip, upload, download, from application code - you have full control.
+You have 3 ways possible :
+- Use [capgo.app](https://capgo.app) a full featured auto update system in 5 min Setup, to manage version, update, revert and see stats.
+- Use your own server update with auto update system
+- Use manual methods to zip, upload, download, from JS to do it when you want.
 
 
 ## Community
 Join the [discord](https://discord.gg/VnYRvBfgA6) to get help.
 
 ## Documentation
-I maintain a more user friendly and complete [documentation](https://github.com/Cap-go/capacitor-updater/wiki) in GitHub wiki.
+I maintain a more user friendly and complete [documentation here](https://docs.capgo.app/).
 
 ## Installation
 
@@ -23,12 +38,18 @@ npx cap sync
 
 ## Auto-update setup
 
-Create account in [capgo.app](https://capgo.app) and get your [API key](https://capgo.app/app/apikeys)
-- Download the CLI `npm i -g @capgo/cli`
-- Add app from CLI `capgo add -a API_KEY`
-- Upload app `capgo upload -a API_KEY`
-- Upload app `capgo set -a API_KEY -s public`
-- Edit your `capacitor.config.json` like below, set `autoUpdate` to true.
+Create your account in [capgo.app](https://capgo.app) and get your [API key](https://capgo.app/app/apikeys)
+- Login to CLI `npx @capgo/cli@latest init API_KEY`
+And follow the steps by step to setup your app.
+
+See more there in the [Auto update documentation](https://docs.capgo.app/plugin/auto-update).
+
+
+## Manual setup
+
+Download update distribution zipfiles from a custom url. Manually control the entire update process.
+
+- Edit your `capacitor.config.json` like below, set `autoUpdate` to false.
 ```json
 // capacitor.config.json
 {
@@ -36,29 +57,11 @@ Create account in [capgo.app](https://capgo.app) and get your [API key](https://
 	"appName": "Name",
 	"plugins": {
 		"CapacitorUpdater": {
-			"autoUpdate": true,
+			"autoUpdate": false,
 		}
 	}
 }
 ```
-- Add to your main code
-```javascript
-  import { CapacitorUpdater } from '@capgo/capacitor-updater'
-  CapacitorUpdater.notifyAppReady()
-```
-This tells Capacitor Updator that the current update bundle has loaded succesfully. Failing to call this method will cause your application to be rolled back to the previously successful version (or built-in bundle).
-
-- Do `npm run build && npx cap copy` to copy the build to capacitor.
-- Run the app and see app auto update after each backgrounding.
-- Failed updates will automatically roll back to the last successful version.
-
-See more details in the [Auto update](https://github.com/Cap-go/capacitor-updater/wiki) documentation.
-
-
-## Manual setup
-
-Download update distribution zipfiles from a custom url. Manually control the entire update process.
-
 - Add to your main code
 ```javascript
   import { CapacitorUpdater } from '@capgo/capacitor-updater'
@@ -126,15 +129,23 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
 * [`reset(...)`](#reset)
 * [`current()`](#current)
 * [`reload()`](#reload)
-* [`setDelay(...)`](#setdelay)
+* [`setMultiDelay(...)`](#setmultidelay)
+* [`cancelDelay()`](#canceldelay)
+* [`getLatest()`](#getlatest)
+* [`setChannel(...)`](#setchannel)
+* [`getChannel()`](#getchannel)
+* [`setCustomId(...)`](#setcustomid)
 * [`addListener('download', ...)`](#addlistenerdownload)
+* [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate)
+* [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable)
 * [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete)
 * [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
 * [`addListener('updateFailed', ...)`](#addlistenerupdatefailed)
-* [`getId()`](#getid)
+* [`addListener('downloadFailed', ...)`](#addlistenerdownloadfailed)
+* [`addListener('appReloaded', ...)`](#addlistenerappreloaded)
+* [`getDeviceId()`](#getdeviceid)
 * [`getPluginVersion()`](#getpluginversion)
 * [`isAutoUpdateEnabled()`](#isautoupdateenabled)
-* [`addListener(string, ...)`](#addlistenerstring)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
@@ -151,6 +162,8 @@ notifyAppReady() => Promise<BundleInfo>
 ```
 
 Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)
+By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.
+Change this behaviour with {@link appReadyTimeout}
 
 **Returns:** <code>Promise&lt;<a href="#bundleinfo">BundleInfo</a>&gt;</code>
 
@@ -160,14 +173,14 @@ Notify Capacitor Updater that the current bundle is working (a rollback will occ
 ### download(...)
 
 ```typescript
-download(options: { url: string; version?: string; }) => Promise<BundleInfo>
+download(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>
 ```
 
-Download a new version from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files
+Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files
 
-| Param         | Type                                            |
-| ------------- | ----------------------------------------------- |
-| **`options`** | <code>{ url: string; version?: string; }</code> |
+| Param         | Type                                                                                   |
+| ------------- | -------------------------------------------------------------------------------------- |
+| **`options`** | <code>{ url: string; version: string; sessionKey?: string; checksum?: string; }</code> |
 
 **Returns:** <code>Promise&lt;<a href="#bundleinfo">BundleInfo</a>&gt;</code>
 
@@ -227,7 +240,7 @@ Delete bundle in storage
 list() => Promise<{ bundles: BundleInfo[]; }>
 ```
 
-Get all available versions
+Get all available bundles
 
 **Returns:** <code>Promise&lt;{ bundles: BundleInfo[]; }&gt;</code>
 
@@ -240,7 +253,7 @@ Get all available versions
 reset(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>
 ```
 
-Set the `builtin` version (the one sent to Apple store / Google play store ) as current version
+Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle
 
 | Param         | Type                                         |
 | ------------- | -------------------------------------------- |
@@ -273,17 +286,98 @@ Reload the view
 --------------------
 
 
-### setDelay(...)
+### setMultiDelay(...)
+
+```typescript
+setMultiDelay(options: { delayConditions: DelayCondition[]; }) => Promise<void>
+```
+
+Set <a href="#delaycondition">DelayCondition</a>, skip updates until one of the conditions is met
+
+| Param         | Type                                                | Description                                                              |
+| ------------- | --------------------------------------------------- | ------------------------------------------------------------------------ |
+| **`options`** | <code>{ delayConditions: DelayCondition[]; }</code> | are the {@link <a href="#delaycondition">DelayCondition</a>} list to set |
+
+**Since:** 4.3.0
+
+--------------------
+
+
+### cancelDelay()
 
 ```typescript
-setDelay(options: { delay: boolean; }) => Promise<void>
+cancelDelay() => Promise<void>
 ```
 
-Set delay to skip updates in the next time the app goes into the background
+Cancel delay to updates as usual
 
-| Param         | Type                             |
-| ------------- | -------------------------------- |
-| **`options`** | <code>{ delay: boolean; }</code> |
+**Since:** 4.0.0
+
+--------------------
+
+
+### getLatest()
+
+```typescript
+getLatest() => Promise<latestVersion>
+```
+
+Get Latest bundle available from update Url
+
+**Returns:** <code>Promise&lt;<a href="#latestversion">latestVersion</a>&gt;</code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
+### setChannel(...)
+
+```typescript
+setChannel(options: SetChannelOptions) => Promise<channelRes>
+```
+
+Set Channel for this device
+
+| Param         | Type                                                            | Description                                                                      |
+| ------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#setchanneloptions">SetChannelOptions</a></code> | is the {@link <a href="#setchanneloptions">SetChannelOptions</a>} channel to set |
+
+**Returns:** <code>Promise&lt;<a href="#channelres">channelRes</a>&gt;</code>
+
+**Since:** 4.7.0
+
+--------------------
+
+
+### getChannel()
+
+```typescript
+getChannel() => Promise<getChannelRes>
+```
+
+get Channel for this device
+
+**Returns:** <code>Promise&lt;<a href="#getchannelres">getChannelRes</a>&gt;</code>
+
+**Since:** 4.8.0
+
+--------------------
+
+
+### setCustomId(...)
+
+```typescript
+setCustomId(options: SetCustomIdOptions) => Promise<void>
+```
+
+Set Channel for this device
+
+| Param         | Type                                                              | Description                                                                         |
+| ------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#setcustomidoptions">SetCustomIdOptions</a></code> | is the {@link <a href="#setcustomidoptions">SetCustomIdOptions</a>} customId to set |
+
+**Since:** 4.9.0
 
 --------------------
 
@@ -291,7 +385,7 @@ Set delay to skip updates in the next time the app goes into the background
 ### addListener('download', ...)
 
 ```typescript
-addListener(eventName: 'download', listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "download", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for download event in the App, let you know when the download is started, loading and finished
@@ -308,10 +402,50 @@ Listen for download event in the App, let you know when the download is started,
 --------------------
 
 
+### addListener('noNeedUpdate', ...)
+
+```typescript
+addListener(eventName: "noNeedUpdate", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for no need to update event, usefull when you want force check every time the app is launched
+
+| Param              | Type                                                      |
+| ------------------ | --------------------------------------------------------- |
+| **`eventName`**    | <code>'noNeedUpdate'</code>                               |
+| **`listenerFunc`** | <code><a href="#noneedlistener">NoNeedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
+### addListener('updateAvailable', ...)
+
+```typescript
+addListener(eventName: "updateAvailable", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for availbale update event, usefull when you want to force check every time the app is launched
+
+| Param              | Type                                                                          |
+| ------------------ | ----------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'updateAvailable'</code>                                                |
+| **`listenerFunc`** | <code><a href="#updateavailabledlistener">UpdateAvailabledListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
 ### addListener('downloadComplete', ...)
 
 ```typescript
-addListener(eventName: 'downloadComplete', listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "downloadComplete", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for download event in the App, let you know when the download is started, loading and finished
@@ -331,7 +465,7 @@ Listen for download event in the App, let you know when the download is started,
 ### addListener('majorAvailable', ...)
 
 ```typescript
-addListener(eventName: 'majorAvailable', listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "majorAvailable", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
@@ -351,10 +485,10 @@ Listen for Major update event in the App, let you know when major update is bloc
 ### addListener('updateFailed', ...)
 
 ```typescript
-addListener(eventName: 'updateFailed', listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "updateFailed", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for update event in the App, let you know when update is ready to install at next app start
+Listen for update fail event in the App, let you know when update has fail to install at next app start
 
 | Param              | Type                                                                  |
 | ------------------ | --------------------------------------------------------------------- |
@@ -368,57 +502,81 @@ Listen for update event in the App, let you know when update is ready to install
 --------------------
 
 
-### getId()
+### addListener('downloadFailed', ...)
 
 ```typescript
-getId() => Promise<{ id: string; }>
+addListener(eventName: "downloadFailed", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Get unique ID used to identify device (sent to auto update server)
+Listen for download fail event in the App, let you know when download has fail finished
 
-**Returns:** <code>Promise&lt;{ id: string; }&gt;</code>
+| Param              | Type                                                                      |
+| ------------------ | ------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadFailed'</code>                                             |
+| **`listenerFunc`** | <code><a href="#downloadfailedlistener">DownloadFailedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
 
 --------------------
 
 
-### getPluginVersion()
+### addListener('appReloaded', ...)
 
 ```typescript
-getPluginVersion() => Promise<{ version: string; }>
+addListener(eventName: "appReloaded", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Get the native Capacitor Updater plugin version (sent to auto update server)
+Listen for download fail event in the App, let you know when download has fail finished
 
-**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+| Param              | Type                                                                |
+| ------------------ | ------------------------------------------------------------------- |
+| **`eventName`**    | <code>'appReloaded'</code>                                          |
+| **`listenerFunc`** | <code><a href="#appreloadedlistener">AppReloadedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.3.0
 
 --------------------
 
 
-### isAutoUpdateEnabled()
+### getDeviceId()
 
 ```typescript
-isAutoUpdateEnabled() => Promise<{ enabled: boolean; }>
+getDeviceId() => Promise<{ deviceId: string; }>
 ```
 
-Get the state of auto update config. This will return `false` in manual mode.
+Get unique ID used to identify device (sent to auto update server)
 
-**Returns:** <code>Promise&lt;{ enabled: boolean; }&gt;</code>
+**Returns:** <code>Promise&lt;{ deviceId: string; }&gt;</code>
 
 --------------------
 
 
-### addListener(string, ...)
+### getPluginVersion()
 
 ```typescript
-addListener(eventName: string, listenerFunc: (...args: any[]) => any) => Promise<PluginListenerHandle>
+getPluginVersion() => Promise<{ version: string; }>
 ```
 
-| Param              | Type                                    |
-| ------------------ | --------------------------------------- |
-| **`eventName`**    | <code>string</code>                     |
-| **`listenerFunc`** | <code>(...args: any[]) =&gt; any</code> |
+Get the native Capacitor Updater plugin version (sent to auto update server)
 
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+
+--------------------
+
+
+### isAutoUpdateEnabled()
+
+```typescript
+isAutoUpdateEnabled() => Promise<{ enabled: boolean; }>
+```
+
+Get the state of auto update config. This will return `false` in manual mode.
+
+**Returns:** <code>Promise&lt;{ enabled: boolean; }&gt;</code>
 
 --------------------
 
@@ -429,6 +587,10 @@ addListener(eventName: string, listenerFunc: (...args: any[]) => any) => Promise
 removeAllListeners() => Promise<void>
 ```
 
+Remove all listeners for this plugin.
+
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -442,9 +604,65 @@ removeAllListeners() => Promise<void>
 | **`id`**         | <code>string</code>                                   |
 | **`version`**    | <code>string</code>                                   |
 | **`downloaded`** | <code>string</code>                                   |
+| **`checksum`**   | <code>string</code>                                   |
 | **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
 
 
+#### DelayCondition
+
+| Prop        | Type                                                      | Description                              |
+| ----------- | --------------------------------------------------------- | ---------------------------------------- |
+| **`kind`**  | <code><a href="#delayuntilnext">DelayUntilNext</a></code> | Set up delay conditions in setMultiDelay |
+| **`value`** | <code>string</code>                                       |                                          |
+
+
+#### latestVersion
+
+| Prop             | Type                 | Description             | Since |
+| ---------------- | -------------------- | ----------------------- | ----- |
+| **`version`**    | <code>string</code>  | Res of getLatest method | 4.0.0 |
+| **`major`**      | <code>boolean</code> |                         |       |
+| **`message`**    | <code>string</code>  |                         |       |
+| **`sessionKey`** | <code>string</code>  |                         |       |
+| **`error`**      | <code>string</code>  |                         |       |
+| **`old`**        | <code>string</code>  |                         |       |
+| **`url`**        | <code>string</code>  |                         |       |
+
+
+#### channelRes
+
+| Prop          | Type                | Description                   | Since |
+| ------------- | ------------------- | ----------------------------- | ----- |
+| **`status`**  | <code>string</code> | Current status of set channel | 4.7.0 |
+| **`error`**   | <code>any</code>    |                               |       |
+| **`message`** | <code>any</code>    |                               |       |
+
+
+#### SetChannelOptions
+
+| Prop          | Type                |
+| ------------- | ------------------- |
+| **`channel`** | <code>string</code> |
+
+
+#### getChannelRes
+
+| Prop           | Type                 | Description                   | Since |
+| -------------- | -------------------- | ----------------------------- | ----- |
+| **`channel`**  | <code>string</code>  | Current status of get channel | 4.8.0 |
+| **`error`**    | <code>any</code>     |                               |       |
+| **`message`**  | <code>any</code>     |                               |       |
+| **`status`**   | <code>string</code>  |                               |       |
+| **`allowSet`** | <code>boolean</code> |                               |       |
+
+
+#### SetCustomIdOptions
+
+| Prop           | Type                |
+| -------------- | ------------------- |
+| **`customId`** | <code>string</code> |
+
+
 #### PluginListenerHandle
 
 | Prop         | Type                                      |
@@ -460,6 +678,20 @@ removeAllListeners() => Promise<void>
 | **`bundle`**  | <code><a href="#bundleinfo">BundleInfo</a></code> |                                                |       |
 
 
+#### 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
+
+| Prop         | Type                                              | Description                                    | Since |
+| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
+
+
 #### DownloadCompleteEvent
 
 | Prop         | Type                                              | Description                          | Since |
@@ -469,9 +701,9 @@ removeAllListeners() => Promise<void>
 
 #### MajorAvailableEvent
 
-| Prop          | Type                | Description                                 | Since |
-| ------------- | ------------------- | ------------------------------------------- | ----- |
-| **`version`** | <code>string</code> | Emit when a new major version is available. | 4.0.0 |
+| Prop          | Type                | Description                                | Since |
+| ------------- | ------------------- | ------------------------------------------ | ----- |
+| **`version`** | <code>string</code> | Emit when a new major bundle is available. | 4.0.0 |
 
 
 #### UpdateFailedEvent
@@ -481,12 +713,24 @@ removeAllListeners() => Promise<void>
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a update failed to install. | 4.0.0 |
 
 
+#### DownloadFailedEvent
+
+| Prop          | Type                | Description                | Since |
+| ------------- | ------------------- | -------------------------- | ----- |
+| **`version`** | <code>string</code> | Emit when a download fail. | 4.0.0 |
+
+
 ### Type Aliases
 
 
 #### BundleStatus
 
-<code>'success' | 'error' | 'pending' | 'downloading'</code>
+<code>"success" | "error" | "pending" | "downloading"</code>
+
+
+#### DelayUntilNext
+
+<code>"background" | "kill" | "nativeVersion" | "date"</code>
 
 
 #### DownloadChangeListener
@@ -494,6 +738,16 @@ removeAllListeners() => Promise<void>
 <code>(state: <a href="#downloadevent">DownloadEvent</a>): void</code>
 
 
+#### NoNeedListener
+
+<code>(state: <a href="#noneedevent">noNeedEvent</a>): void</code>
+
+
+#### UpdateAvailabledListener
+
+<code>(state: <a href="#updateavailableevent">updateAvailableEvent</a>): void</code>
+
+
 #### DownloadCompleteListener
 
 <code>(state: <a href="#downloadcompleteevent">DownloadCompleteEvent</a>): void</code>
@@ -508,6 +762,16 @@ removeAllListeners() => Promise<void>
 
 <code>(state: <a href="#updatefailedevent">UpdateFailedEvent</a>): void</code>
 
+
+#### DownloadFailedListener
+
+<code>(state: <a href="#downloadfailedevent">DownloadFailedEvent</a>): void</code>
+
+
+#### AppReloadedListener
+
+<code>(state: void): void</code>
+
 </docgen-api>
 
 ### Listen to download events