@capgo/capacitor-updater 5.7.3 → 5.7.4

package/README.md

@@ -153,7 +153,7 @@ Capacitor Updater works by unzipping a compiled app bundle to the native device
 <docgen-config>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
-CapacitorUpdater can be configured with this options:
+CapacitorUpdater can be configured with these options:
 
 | Prop                     | Type                 | Description                                                                                                                                                                                     | Default                                        | Since   |
 | ------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------- |
@@ -270,6 +270,11 @@ export default config;
 * [`unsetChannel(...)`](#unsetchannel)
 * [`getChannel()`](#getchannel)
 * [`setCustomId(...)`](#setcustomid)
+* [`getBuiltinVersion()`](#getbuiltinversion)
+* [`getDeviceId()`](#getdeviceid)
+* [`getPluginVersion()`](#getpluginversion)
+* [`isAutoUpdateEnabled()`](#isautoupdateenabled)
+* [`removeAllListeners()`](#removealllisteners)
 * [`addListener('download', ...)`](#addlistenerdownload)
 * [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate)
 * [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable)
@@ -279,11 +284,6 @@ export default config;
 * [`addListener('downloadFailed', ...)`](#addlistenerdownloadfailed)
 * [`addListener('appReloaded', ...)`](#addlistenerappreloaded)
 * [`addListener('appReady', ...)`](#addlistenerappready)
-* [`getBuiltinVersion()`](#getbuiltinversion)
-* [`getDeviceId()`](#getdeviceid)
-* [`getPluginVersion()`](#getpluginversion)
-* [`isAutoUpdateEnabled()`](#isautoupdateenabled)
-* [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 
@@ -295,14 +295,14 @@ export default config;
 ### notifyAppReady()
 
 ```typescript
-notifyAppReady() => Promise<{ bundle: BundleInfo; }>
+notifyAppReady() => Promise<AppReadyResult>
 ```
 
 Notify Capacitor Updater that the current bundle is working (a rollback will occur if 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;{ bundle: <a href="#bundleinfo">BundleInfo</a>; }&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#appreadyresult">AppReadyResult</a>&gt;</code>
 
 --------------------
 
@@ -310,14 +310,14 @@ Change this behaviour with {@link appReadyTimeout}
 ### setUpdateUrl(...)
 
 ```typescript
-setUpdateUrl(options: { url: string; }) => Promise<void>
+setUpdateUrl(options: UpdateUrl) => Promise<void>
 ```
 
 Set the updateUrl for the app, this will be used to check for updates.
 
-| Param         | Type                          |
-| ------------- | ----------------------------- |
-| **`options`** | <code>{ url: string; }</code> |
+| Param         | Type                                            | Description                                       |
+| ------------- | ----------------------------------------------- | ------------------------------------------------- |
+| **`options`** | <code><a href="#updateurl">UpdateUrl</a></code> | contains the URL to use for checking for updates. |
 
 **Since:** 5.4.0
 
@@ -327,14 +327,14 @@ Set the updateUrl for the app, this will be used to check for updates.
 ### setStatsUrl(...)
 
 ```typescript
-setStatsUrl(options: { url: string; }) => Promise<void>
+setStatsUrl(options: StatsUrl) => Promise<void>
 ```
 
-Set the statsUrl for the app, this will be used to send statistics.
+Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.
 
-| Param         | Type                          |
-| ------------- | ----------------------------- |
-| **`options`** | <code>{ url: string; }</code> |
+| Param         | Type                                          | Description                                     |
+| ------------- | --------------------------------------------- | ----------------------------------------------- |
+| **`options`** | <code><a href="#statsurl">StatsUrl</a></code> | contains the URL to use for sending statistics. |
 
 **Since:** 5.4.0
 
@@ -344,14 +344,14 @@ Set the statsUrl for the app, this will be used to send statistics.
 ### setChannelUrl(...)
 
 ```typescript
-setChannelUrl(options: { url: string; }) => Promise<void>
+setChannelUrl(options: ChannelUrl) => Promise<void>
 ```
 
 Set the channelUrl for the app, this will be used to set the channel.
 
-| Param         | Type                          |
-| ------------- | ----------------------------- |
-| **`options`** | <code>{ url: string; }</code> |
+| Param         | Type                                              | Description                                      |
+| ------------- | ------------------------------------------------- | ------------------------------------------------ |
+| **`options`** | <code><a href="#channelurl">ChannelUrl</a></code> | contains the URL to use for setting the channel. |
 
 **Since:** 5.4.0
 
@@ -361,14 +361,14 @@ Set the channelUrl for the app, this will be used to set the channel.
 ### download(...)
 
 ```typescript
-download(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>
+download(options: DownloadOptions) => Promise<BundleInfo>
 ```
 
 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; sessionKey?: string; checksum?: string; }</code> |
+| Param         | Type                                                        | Description                                                                                  |
+| ------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#downloadoptions">DownloadOptions</a></code> | The {@link <a href="#downloadoptions">DownloadOptions</a>} for downloading a new bundle zip. |
 
 **Returns:** <code>Promise&lt;<a href="#bundleinfo">BundleInfo</a>&gt;</code>
 
@@ -378,14 +378,14 @@ Download a new bundle from the provided URL, it should be a zip file, with files
 ### next(...)
 
 ```typescript
-next(options: { id: string; }) => Promise<BundleInfo>
+next(options: BundleId) => Promise<BundleInfo>
 ```
 
 Set the next bundle to be used when the app is reloaded.
 
-| Param         | Type                         |
-| ------------- | ---------------------------- |
-| **`options`** | <code>{ id: string; }</code> |
+| Param         | Type                                          | Description                                                                                                   |
+| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#bundleid">BundleId</a></code> | Contains the ID of the next Bundle to set on next app launch. {@link <a href="#bundleinfo">BundleInfo.id</a>} |
 
 **Returns:** <code>Promise&lt;<a href="#bundleinfo">BundleInfo</a>&gt;</code>
 
@@ -395,14 +395,14 @@ Set the next bundle to be used when the app is reloaded.
 ### set(...)
 
 ```typescript
-set(options: { id: string; }) => Promise<void>
+set(options: BundleId) => Promise<void>
 ```
 
 Set the current bundle and immediately reloads the app.
 
-| Param         | Type                         |
-| ------------- | ---------------------------- |
-| **`options`** | <code>{ id: string; }</code> |
+| Param         | Type                                          | Description                                                                                       |
+| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#bundleid">BundleId</a></code> | A {@link <a href="#bundleid">BundleId</a>} object containing the new bundle id to set as current. |
 
 --------------------
 
@@ -410,14 +410,14 @@ Set the current bundle and immediately reloads the app.
 ### delete(...)
 
 ```typescript
-delete(options: { id: string; }) => Promise<void>
+delete(options: BundleId) => Promise<void>
 ```
 
-Delete bundle in storage
+Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.
 
-| Param         | Type                         |
-| ------------- | ---------------------------- |
-| **`options`** | <code>{ id: string; }</code> |
+| Param         | Type                                          | Description                                                                                                                                   |
+| ------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#bundleid">BundleId</a></code> | A {@link <a href="#bundleid">BundleId</a>} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name) |
 
 --------------------
 
@@ -425,12 +425,12 @@ Delete bundle in storage
 ### list()
 
 ```typescript
-list() => Promise<{ bundles: BundleInfo[]; }>
+list() => Promise<BundleListResult>
 ```
 
 Get all locally downloaded bundles in your app
 
-**Returns:** <code>Promise&lt;{ bundles: BundleInfo[]; }&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#bundlelistresult">BundleListResult</a>&gt;</code>
 
 --------------------
 
@@ -438,14 +438,14 @@ Get all locally downloaded bundles in your app
 ### reset(...)
 
 ```typescript
-reset(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>
+reset(options?: ResetOptions | undefined) => Promise<void>
 ```
 
-Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle
+Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.
 
-| Param         | Type                                         |
-| ------------- | -------------------------------------------- |
-| **`options`** | <code>{ toLastSuccessful?: boolean; }</code> |
+| Param         | Type                                                  | Description                                                                                                                                                                      |
+| ------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#resetoptions">ResetOptions</a></code> | Containing {@link <a href="#resetoptions">ResetOptions.toLastSuccessful</a>}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle. |
 
 --------------------
 
@@ -453,12 +453,12 @@ Set the `builtin` bundle (the one sent to Apple store / Google play store ) as c
 ### current()
 
 ```typescript
-current() => Promise<{ bundle: BundleInfo; native: string; }>
+current() => Promise<CurrentBundleResult>
 ```
 
-Get the current bundle, if none are set it returns `builtin`, currentNative is the original bundle installed on the device
+Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device
 
-**Returns:** <code>Promise&lt;{ bundle: <a href="#bundleinfo">BundleInfo</a>; native: string; }&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#currentbundleresult">CurrentBundleResult</a>&gt;</code>
 
 --------------------
 
@@ -477,14 +477,14 @@ Reload the view
 ### setMultiDelay(...)
 
 ```typescript
-setMultiDelay(options: { delayConditions: DelayCondition[]; }) => Promise<void>
+setMultiDelay(options: MultiDelayConditions) => Promise<void>
 ```
 
-Set <a href="#delaycondition">DelayCondition</a>, skip updates until one of the conditions is met
+Sets a {@link <a href="#delaycondition">DelayCondition</a>} array containing conditions that the Plugin will use to determine when to install updates.
 
-| Param         | Type                                                | Description                                                              |
-| ------------- | --------------------------------------------------- | ------------------------------------------------------------------------ |
-| **`options`** | <code>{ delayConditions: DelayCondition[]; }</code> | are the {@link <a href="#delaycondition">DelayCondition</a>} list to set |
+| Param         | Type                                                                  | Description                                                                                                |
+| ------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#multidelayconditions">MultiDelayConditions</a></code> | Containing the {@link <a href="#multidelayconditions">MultiDelayConditions</a>} array of conditions to set |
 
 **Since:** 4.3.0
 
@@ -497,7 +497,7 @@ Set <a href="#delaycondition">DelayCondition</a>, skip updates until one of the
 cancelDelay() => Promise<void>
 ```
 
-Cancel delay to updates as usual
+Cancels a {@link <a href="#delaycondition">DelayCondition</a>} to process an update immediately.
 
 **Since:** 4.0.0
 
@@ -507,12 +507,12 @@ Cancel delay to updates as usual
 ### getLatest()
 
 ```typescript
-getLatest() => Promise<latestVersion>
+getLatest() => Promise<LatestVersion>
 ```
 
 Get Latest bundle available from update Url
 
-**Returns:** <code>Promise&lt;<a href="#latestversion">latestVersion</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#latestversion">LatestVersion</a>&gt;</code>
 
 **Since:** 4.0.0
 
@@ -522,17 +522,18 @@ Get Latest bundle available from update Url
 ### setChannel(...)
 
 ```typescript
-setChannel(options: SetChannelOptions) => Promise<channelRes>
+setChannel(options: SetChannelOptions) => Promise<ChannelRes>
 ```
 
-Set Channel for this device, the channel have to allow self assignement to make this work
-Do not use this method to set the channel at boot when autoUpdate is enabled, this method is made to set the channel after the app is ready when user click on a button for example
+Sets the channel for this device. The channel has to allow for self assignment for this to work.
+Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.
+This method is to set the channel after the app is ready.
 
 | Param         | Type                                                            | Description                                                                      |
 | ------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| **`options`** | <code><a href="#setchanneloptions">SetChannelOptions</a></code> | is the {@link <a href="#setchanneloptions">SetChannelOptions</a>} channel to set |
+| **`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>
+**Returns:** <code>Promise&lt;<a href="#channelres">ChannelRes</a>&gt;</code>
 
 **Since:** 4.7.0
 
@@ -545,7 +546,7 @@ Do not use this method to set the channel at boot when autoUpdate is enabled, th
 unsetChannel(options: UnsetChannelOptions) => Promise<void>
 ```
 
-Unset Channel for this device, the device will return to the default channel
+Unset the channel for this device. The device will then return to the default channel
 
 | Param         | Type                                                                |
 | ------------- | ------------------------------------------------------------------- |
@@ -559,12 +560,12 @@ Unset Channel for this device, the device will return to the default channel
 ### getChannel()
 
 ```typescript
-getChannel() => Promise<getChannelRes>
+getChannel() => Promise<GetChannelRes>
 ```
 
-get Channel for this device
+Get the channel for this device
 
-**Returns:** <code>Promise&lt;<a href="#getchannelres">getChannelRes</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#getchannelres">GetChannelRes</a>&gt;</code>
 
 **Since:** 4.8.0
 
@@ -577,7 +578,7 @@ get Channel for this device
 setCustomId(options: SetCustomIdOptions) => Promise<void>
 ```
 
-Set Channel for this device
+Set a custom ID for this device
 
 | Param         | Type                                                              | Description                                                                         |
 | ------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
@@ -588,18 +589,85 @@ Set Channel for this device
 --------------------
 
 
+### getBuiltinVersion()
+
+```typescript
+getBuiltinVersion() => Promise<BuiltinVersion>
+```
+
+Get the native app version or the builtin version if set in config
+
+**Returns:** <code>Promise&lt;<a href="#builtinversion">BuiltinVersion</a>&gt;</code>
+
+**Since:** 5.2.0
+
+--------------------
+
+
+### getDeviceId()
+
+```typescript
+getDeviceId() => Promise<DeviceId>
+```
+
+Get unique ID used to identify device (sent to auto update server)
+
+**Returns:** <code>Promise&lt;<a href="#deviceid">DeviceId</a>&gt;</code>
+
+--------------------
+
+
+### getPluginVersion()
+
+```typescript
+getPluginVersion() => Promise<PluginVersion>
+```
+
+Get the native Capacitor Updater plugin version (sent to auto update server)
+
+**Returns:** <code>Promise&lt;<a href="#pluginversion">PluginVersion</a>&gt;</code>
+
+--------------------
+
+
+### isAutoUpdateEnabled()
+
+```typescript
+isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>
+```
+
+Get the state of auto update config.
+
+**Returns:** <code>Promise&lt;<a href="#autoupdateenabled">AutoUpdateEnabled</a>&gt;</code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners for this plugin.
+
+**Since:** 1.0.0
+
+--------------------
+
+
 ### addListener('download', ...)
 
 ```typescript
-addListener(eventName: "download", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "download", listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for download event in the App, let you know when the download is started, loading and finished, with a percent value
+Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.
 
-| Param              | Type                                                                      |
-| ------------------ | ------------------------------------------------------------------------- |
-| **`eventName`**    | <code>'download'</code>                                                   |
-| **`listenerFunc`** | <code><a href="#downloadchangelistener">DownloadChangeListener</a></code> |
+| Param              | Type                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'download'</code>                                                     |
+| **`listenerFunc`** | <code>(state: <a href="#downloadevent">DownloadEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -611,15 +679,15 @@ 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
+addListener(eventName: "noNeedUpdate", listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for no need to update event, usefull when you want force check every time the app is launched
+Listen for no need to update event, useful 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> |
+| Param              | Type                                                                    |
+| ------------------ | ----------------------------------------------------------------------- |
+| **`eventName`**    | <code>'noNeedUpdate'</code>                                             |
+| **`listenerFunc`** | <code>(state: <a href="#noneedevent">NoNeedEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -631,15 +699,15 @@ Listen for no need to update event, usefull when you want force check every time
 ### addListener('updateAvailable', ...)
 
 ```typescript
-addListener(eventName: "updateAvailable", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "updateAvailable", listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for availbale update event, usefull when you want to force check every time the app is launched
+Listen for available update event, useful 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> |
+| Param              | Type                                                                                      |
+| ------------------ | ----------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'updateAvailable'</code>                                                            |
+| **`listenerFunc`** | <code>(state: <a href="#updateavailableevent">UpdateAvailableEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -651,15 +719,15 @@ Listen for availbale update event, usefull when you want to force check every ti
 ### addListener('downloadComplete', ...)
 
 ```typescript
-addListener(eventName: "downloadComplete", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "downloadComplete", listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for download event in the App, let you know when the download is started, loading and finished
+Listen for downloadComplete events.
 
-| Param              | Type                                                                          |
-| ------------------ | ----------------------------------------------------------------------------- |
-| **`eventName`**    | <code>'downloadComplete'</code>                                               |
-| **`listenerFunc`** | <code><a href="#downloadcompletelistener">DownloadCompleteListener</a></code> |
+| Param              | Type                                                                                        |
+| ------------------ | ------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadComplete'</code>                                                             |
+| **`listenerFunc`** | <code>(state: <a href="#downloadcompleteevent">DownloadCompleteEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -671,15 +739,15 @@ 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: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
 
-| Param              | Type                                                                      |
-| ------------------ | ------------------------------------------------------------------------- |
-| **`eventName`**    | <code>'majorAvailable'</code>                                             |
-| **`listenerFunc`** | <code><a href="#majoravailablelistener">MajorAvailableListener</a></code> |
+| Param              | Type                                                                                    |
+| ------------------ | --------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'majorAvailable'</code>                                                           |
+| **`listenerFunc`** | <code>(state: <a href="#majoravailableevent">MajorAvailableEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -691,15 +759,15 @@ 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: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for update fail event in the App, let you know when update has fail to install at next app start
 
-| Param              | Type                                                                  |
-| ------------------ | --------------------------------------------------------------------- |
-| **`eventName`**    | <code>'updateFailed'</code>                                           |
-| **`listenerFunc`** | <code><a href="#updatefailedlistener">UpdateFailedListener</a></code> |
+| Param              | Type                                                                                |
+| ------------------ | ----------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'updateFailed'</code>                                                         |
+| **`listenerFunc`** | <code>(state: <a href="#updatefailedevent">UpdateFailedEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -711,15 +779,15 @@ Listen for update fail event in the App, let you know when update has fail to in
 ### addListener('downloadFailed', ...)
 
 ```typescript
-addListener(eventName: "downloadFailed", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "downloadFailed", listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for download fail event in the App, let you know when download has fail finished
+Listen for download fail event in the App, let you know when a bundle download has failed
 
-| Param              | Type                                                                      |
-| ------------------ | ------------------------------------------------------------------------- |
-| **`eventName`**    | <code>'downloadFailed'</code>                                             |
-| **`listenerFunc`** | <code><a href="#downloadfailedlistener">DownloadFailedListener</a></code> |
+| Param              | Type                                                                                    |
+| ------------------ | --------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadFailed'</code>                                                           |
+| **`listenerFunc`** | <code>(state: <a href="#downloadfailedevent">DownloadFailedEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -731,15 +799,15 @@ Listen for download fail event in the App, let you know when download has fail f
 ### addListener('appReloaded', ...)
 
 ```typescript
-addListener(eventName: "appReloaded", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "appReloaded", listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-Listen for reload event in the App, let you know when reload has happend
+Listen for reload event in the App, let you know when reload has happened
 
-| Param              | Type                                                                |
-| ------------------ | ------------------------------------------------------------------- |
-| **`eventName`**    | <code>'appReloaded'</code>                                          |
-| **`listenerFunc`** | <code><a href="#appreloadedlistener">AppReloadedListener</a></code> |
+| Param              | Type                       |
+| ------------------ | -------------------------- |
+| **`eventName`**    | <code>'appReloaded'</code> |
+| **`listenerFunc`** | <code>() =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -751,15 +819,15 @@ Listen for reload event in the App, let you know when reload has happend
 ### addListener('appReady', ...)
 
 ```typescript
-addListener(eventName: "appReady", listenerFunc: AppReadyListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "appReady", listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for app ready event in the App, let you know when app is ready to use
 
-| Param              | Type                                                          |
-| ------------------ | ------------------------------------------------------------- |
-| **`eventName`**    | <code>'appReady'</code>                                       |
-| **`listenerFunc`** | <code><a href="#appreadylistener">AppReadyListener</a></code> |
+| Param              | Type                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'appReady'</code>                                                     |
+| **`listenerFunc`** | <code>(state: <a href="#appreadyevent">AppReadyEvent</a>) =&gt; void</code> |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
@@ -768,85 +836,92 @@ Listen for app ready event in the App, let you know when app is ready to use
 --------------------
 
 
-### getBuiltinVersion()
-
-```typescript
-getBuiltinVersion() => Promise<{ version: string; }>
-```
+### Interfaces
 
-Get the native app version or the builtin version if set in config
 
-**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+#### AppReadyResult
 
-**Since:** 5.2.0
+| Prop         | Type                                              |
+| ------------ | ------------------------------------------------- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> |
 
---------------------
 
+#### BundleInfo
 
-### getDeviceId()
+| Prop             | Type                                                  |
+| ---------------- | ----------------------------------------------------- |
+| **`id`**         | <code>string</code>                                   |
+| **`version`**    | <code>string</code>                                   |
+| **`downloaded`** | <code>string</code>                                   |
+| **`checksum`**   | <code>string</code>                                   |
+| **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
 
-```typescript
-getDeviceId() => Promise<{ deviceId: string; }>
-```
 
-Get unique ID used to identify device (sent to auto update server)
+#### UpdateUrl
 
-**Returns:** <code>Promise&lt;{ deviceId: string; }&gt;</code>
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
 
---------------------
 
+#### StatsUrl
 
-### getPluginVersion()
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
 
-```typescript
-getPluginVersion() => Promise<{ version: string; }>
-```
 
-Get the native Capacitor Updater plugin version (sent to auto update server)
+#### ChannelUrl
 
-**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
 
---------------------
 
+#### DownloadOptions
 
-### isAutoUpdateEnabled()
+| Prop             | Type                | Description                                                                                                                                                      |
+| ---------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`url`**        | <code>string</code> | The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.) |
+| **`version`**    | <code>string</code> | The version code/name of this bundle/version                                                                                                                     |
+| **`sessionKey`** | <code>string</code> |                                                                                                                                                                  |
+| **`checksum`**   | <code>string</code> |                                                                                                                                                                  |
 
-```typescript
-isAutoUpdateEnabled() => Promise<{ enabled: boolean; }>
-```
 
-Get the state of auto update config. This will return `false` in manual mode.
+#### BundleId
 
-**Returns:** <code>Promise&lt;{ enabled: boolean; }&gt;</code>
+| Prop     | Type                |
+| -------- | ------------------- |
+| **`id`** | <code>string</code> |
 
---------------------
 
+#### BundleListResult
 
-### removeAllListeners()
+| Prop          | Type                      |
+| ------------- | ------------------------- |
+| **`bundles`** | <code>BundleInfo[]</code> |
 
-```typescript
-removeAllListeners() => Promise<void>
-```
 
-Remove all listeners for this plugin.
+#### ResetOptions
 
-**Since:** 1.0.0
+| Prop                   | Type                 |
+| ---------------------- | -------------------- |
+| **`toLastSuccessful`** | <code>boolean</code> |
 
---------------------
 
+#### CurrentBundleResult
 
-### Interfaces
+| Prop         | Type                                              |
+| ------------ | ------------------------------------------------- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> |
+| **`native`** | <code>string</code>                               |
 
 
-#### BundleInfo
+#### MultiDelayConditions
 
-| Prop             | Type                                                  |
-| ---------------- | ----------------------------------------------------- |
-| **`id`**         | <code>string</code>                                   |
-| **`version`**    | <code>string</code>                                   |
-| **`downloaded`** | <code>string</code>                                   |
-| **`checksum`**   | <code>string</code>                                   |
-| **`status`**     | <code><a href="#bundlestatus">BundleStatus</a></code> |
+| Prop                  | Type                          |
+| --------------------- | ----------------------------- |
+| **`delayConditions`** | <code>DelayCondition[]</code> |
 
 
 #### DelayCondition
@@ -857,20 +932,20 @@ Remove all listeners for this plugin.
 | **`value`** | <code>string</code>                                       |                                          |
 
 
-#### latestVersion
+#### 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>  |                         |       |
+| Prop             | Type                 | Description                | Since |
+| ---------------- | -------------------- | -------------------------- | ----- |
+| **`version`**    | <code>string</code>  | Result 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
+#### ChannelRes
 
 | Prop          | Type                | Description                   | Since |
 | ------------- | ------------------- | ----------------------------- | ----- |
@@ -894,7 +969,7 @@ Remove all listeners for this plugin.
 | **`triggerAutoUpdate`** | <code>boolean</code> |
 
 
-#### getChannelRes
+#### GetChannelRes
 
 | Prop           | Type                 | Description                   | Since |
 | -------------- | -------------------- | ----------------------------- | ----- |
@@ -912,6 +987,34 @@ Remove all listeners for this plugin.
 | **`customId`** | <code>string</code> |
 
 
+#### BuiltinVersion
+
+| Prop          | Type                |
+| ------------- | ------------------- |
+| **`version`** | <code>string</code> |
+
+
+#### DeviceId
+
+| Prop           | Type                |
+| -------------- | ------------------- |
+| **`deviceId`** | <code>string</code> |
+
+
+#### PluginVersion
+
+| Prop          | Type                |
+| ------------- | ------------------- |
+| **`version`** | <code>string</code> |
+
+
+#### AutoUpdateEnabled
+
+| Prop          | Type                 |
+| ------------- | -------------------- |
+| **`enabled`** | <code>boolean</code> |
+
+
 #### PluginListenerHandle
 
 | Prop         | Type                                      |
@@ -927,14 +1030,14 @@ Remove all listeners for this plugin.
 | **`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 |
 | ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
@@ -971,10 +1074,10 @@ Remove all listeners for this plugin.
 
 #### AppReadyEvent
 
-| Prop         | Type                                              | Description                      | Since |
-| ------------ | ------------------------------------------------- | -------------------------------- | ----- |
-| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a app is ready to use. | 5.2.0 |
-| **`status`** | <code>string</code>                               |                                  |       |
+| Prop         | Type                                              | Description                           | Since |
+| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emitted when the app is ready to use. | 5.2.0 |
+| **`status`** | <code>string</code>                               |                                       |       |
 
 
 ### Type Aliases
@@ -989,51 +1092,6 @@ Remove all listeners for this plugin.
 
 <code>"background" | "kill" | "nativeVersion" | "date"</code>
 
-
-#### DownloadChangeListener
-
-<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>
-
-
-#### MajorAvailableListener
-
-<code>(state: <a href="#majoravailableevent">MajorAvailableEvent</a>): void</code>
-
-
-#### UpdateFailedListener
-
-<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>
-
-
-#### AppReadyListener
-
-<code>(state: <a href="#appreadyevent">AppReadyEvent</a>): void</code>
-
 </docgen-api>
 
 ### Listen to download events