@capgo/capacitor-updater 8.0.0 → 8.0.1

package/dist/esm/definitions.d.ts

@@ -1,8 +1,8 @@
-import type { PluginListenerHandle } from "@capacitor/core";
-declare module "@capacitor/cli" {
+import type { PluginListenerHandle } from '@capacitor/core';
+declare module '@capacitor/cli' {
     interface PluginsConfig {
         /**
-         * These configuration values are available:
+         * CapacitorUpdater can be configured with these options:
          */
         CapacitorUpdater?: {
             /**
@@ -14,6 +14,15 @@ declare module "@capacitor/cli" {
              * @example 1000 // (1 second)
              */
             appReadyTimeout?: number;
+            /**
+             * Configure the number of milliseconds the native plugin should wait before considering API timeout.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default 20 // (20 second)
+             * @example 10 // (10 second)
+             */
+            responseTimeout?: number;
             /**
              * Configure whether the plugin should use automatically delete failed bundles.
              *
@@ -55,27 +64,37 @@ declare module "@capacitor/cli" {
              *
              * Only available for Android and iOS.
              *
-             * @default https://api.capgo.app/auto_update
+             * @default https://plugin.capgo.app/updates
              * @example https://example.com/api/auto_update
              */
             updateUrl?: string;
+            /**
+             * Configure the URL / endpoint for channel operations.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default https://plugin.capgo.app/channel_self
+             * @example https://example.com/api/channel
+             */
+            channelUrl?: string;
             /**
              * Configure the URL / endpoint to which update statistics are sent.
              *
              * Only available for Android and iOS. Set to "" to disable stats reporting.
              *
-             * @default https://api.capgo.app/stats
+             * @default https://plugin.capgo.app/stats
              * @example https://example.com/api/stats
              */
             statsUrl?: string;
             /**
-             * Configure the private key for end to end live update encryption.
+             * Configure the public key for end to end live update encryption Version 2
              *
              * Only available for Android and iOS.
              *
              * @default undefined
+             * @since 6.2.0
              */
-            privateKey?: string;
+            publicKey?: string;
             /**
              * Configure the current version of the app. This will be used for the first update request.
              * If not set, the plugin will get the version from the native code.
@@ -86,368 +105,619 @@ declare module "@capacitor/cli" {
              * @since  4.17.48
              */
             version?: string;
+            /**
+             * Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default undefined
+             * @since  5.1.0
+             */
+            directUpdate?: boolean;
+            /**
+             * Configure the delay period for period update check. the unit is in seconds.
+             *
+             * Only available for Android and iOS.
+             * Cannot be less than 600 seconds (10 minutes).
+             *
+             * @default 600 // (10 minutes)
+             */
+            periodCheckDelay?: number;
+            /**
+             * Configure the CLI to use a local server for testing or self-hosted update server.
+             *
+             *
+             * @default undefined
+             * @since  4.17.48
+             */
+            localS3?: boolean;
+            /**
+             * Configure the CLI to use a local server for testing or self-hosted update server.
+             *
+             *
+             * @default undefined
+             * @since  4.17.48
+             */
+            localHost?: string;
+            /**
+             * Configure the CLI to use a local server for testing or self-hosted update server.
+             *
+             *
+             * @default undefined
+             * @since  4.17.48
+             */
+            localWebHost?: string;
+            /**
+             * Configure the CLI to use a local server for testing or self-hosted update server.
+             *
+             *
+             * @default undefined
+             * @since  4.17.48
+             */
+            localSupa?: string;
+            /**
+             * Configure the CLI to use a local server for testing.
+             *
+             *
+             * @default undefined
+             * @since  4.17.48
+             */
+            localSupaAnon?: string;
+            /**
+             * Configure the CLI to use a local api for testing.
+             *
+             *
+             * @default undefined
+             * @since  6.3.3
+             */
+            localApi?: string;
+            /**
+             * Configure the CLI to use a local file api for testing.
+             *
+             *
+             * @default undefined
+             * @since  6.3.3
+             */
+            localApiFiles?: string;
+            /**
+             * Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.
+             *
+             *
+             * @default false
+             * @since  5.4.0
+             */
+            allowModifyUrl?: boolean;
+            /**
+             * Set the default channel for the app in the config.
+             *
+             *
+             *
+             * @default undefined
+             * @since  5.5.0
+             */
+            defaultChannel?: string;
+            /**
+             * Configure the app id for the app in the config.
+             *
+             * @default undefined
+             * @since  6.0.0
+             */
+            appId?: string;
+            /**
+             * Configure the plugin to keep the URL path after a reload.
+             * WARNING: When a reload is triggered, 'window.history' will be cleared.
+             *
+             * @default false
+             * @since  6.8.0
+             */
+            keepUrlPathAfterReload?: boolean;
         };
     }
 }
-export interface noNeedEvent {
-    /**
-     * Current status of download, between 0 and 100.
-     *
-     * @since  4.0.0
-     */
-    bundle: BundleInfo;
-}
-export interface updateAvailableEvent {
-    /**
-     * Current status of download, between 0 and 100.
-     *
-     * @since  4.0.0
-     */
-    bundle: BundleInfo;
-}
-export interface channelRes {
-    /**
-     * Current status of set channel
-     *
-     * @since  4.7.0
-     */
-    status: string;
-    error?: any;
-    message?: any;
-}
-export interface getChannelRes {
-    /**
-     * Current status of get channel
-     *
-     * @since  4.8.0
-     */
-    channel?: string;
-    error?: any;
-    message?: any;
-    status?: string;
-    allowSet?: boolean;
-}
-export interface DownloadEvent {
-    /**
-     * Current status of download, between 0 and 100.
-     *
-     * @since  4.0.0
-     */
-    percent: number;
-    bundle: BundleInfo;
-}
-export interface MajorAvailableEvent {
+export interface CapacitorUpdaterPlugin {
     /**
-     * Emit when a new major bundle is available.
+     * 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}
      *
-     * @since  4.0.0
+     * @returns {Promise<AppReadyResult>} an Promise resolved directly
+     * @throws {Error}
      */
-    version: string;
-}
-export interface DownloadFailedEvent {
+    notifyAppReady(): Promise<AppReadyResult>;
     /**
-     * Emit when a download fail.
+     * Set the updateUrl for the app, this will be used to check for updates.
      *
-     * @since  4.0.0
+     * @param options contains the URL to use for checking for updates.
+     * @returns {Promise<void>}
+     * @throws {Error}
+     * @since 5.4.0
      */
-    version: string;
-}
-export interface DownloadCompleteEvent {
+    setUpdateUrl(options: UpdateUrl): Promise<void>;
     /**
-     * Emit when a new update is available.
+     * Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.
      *
-     * @since  4.0.0
+     * @param options contains the URL to use for sending statistics.
+     * @returns {Promise<void>}
+     * @throws {Error}
+     * @since 5.4.0
      */
-    bundle: BundleInfo;
-}
-export interface UpdateFailedEvent {
+    setStatsUrl(options: StatsUrl): Promise<void>;
     /**
-     * Emit when a update failed to install.
+     * Set the channelUrl for the app, this will be used to set the channel.
      *
-     * @since 4.0.0
+     * @param options contains the URL to use for setting the channel.
+     * @returns {Promise<void>}
+     * @throws {Error}
+     * @since 5.4.0
      */
-    bundle: BundleInfo;
-}
-export interface latestVersion {
-    /**
-     * Res of getLatest method
-     *
-     * @since 4.0.0
-     */
-    version: string;
-    major?: boolean;
-    message?: string;
-    sessionKey?: string;
-    error?: string;
-    old?: string;
-    url?: string;
-}
-export interface BundleInfo {
-    id: string;
-    version: string;
-    downloaded: string;
-    checksum: string;
-    status: BundleStatus;
-}
-export interface SetChannelOptions {
-    channel: string;
-}
-export interface SetCustomIdOptions {
-    customId: string;
-}
-export interface DelayCondition {
-    /**
-     * Set up delay conditions in setMultiDelay
-     * @param value is useless for @param kind "kill", optional for "background" (default value: "0") and required for "nativeVersion" and "date"
-     */
-    kind: DelayUntilNext;
-    value?: string;
-}
-export type BundleStatus = "success" | "error" | "pending" | "downloading";
-export type DelayUntilNext = "background" | "kill" | "nativeVersion" | "date";
-export type DownloadChangeListener = (state: DownloadEvent) => void;
-export type NoNeedListener = (state: noNeedEvent) => void;
-export type UpdateAvailabledListener = (state: updateAvailableEvent) => void;
-export type DownloadFailedListener = (state: DownloadFailedEvent) => void;
-export type DownloadCompleteListener = (state: DownloadCompleteEvent) => void;
-export type MajorAvailableListener = (state: MajorAvailableEvent) => void;
-export type UpdateFailedListener = (state: UpdateFailedEvent) => void;
-export type AppReloadedListener = (state: void) => void;
-export interface CapacitorUpdaterPlugin {
-    /**
-     * 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 {Promise<BundleInfo>} an Promise resolved directly
-     * @throws An error if something went wrong
-     */
-    notifyAppReady(): Promise<BundleInfo>;
+    setChannelUrl(options: ChannelUrl): Promise<void>;
     /**
      * 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
      *
+     * @example const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });
      * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.
-     * @param url 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.)
-     * @param version set the version code/name of this bundle/version
-     * @example https://example.com/versions/{version}/dist.zip
+     * @param options The {@link DownloadOptions} for downloading a new bundle zip.
      */
-    download(options: {
-        url: string;
-        version: string;
-        sessionKey?: string;
-        checksum?: string;
-    }): Promise<BundleInfo>;
+    download(options: DownloadOptions): Promise<BundleInfo>;
     /**
      * Set the next bundle to be used when the app is reloaded.
      *
+     * @param options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}
      * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.
-     * @param id The bundle id to set as current, next time the app is reloaded. See {@link BundleInfo.id}
-     * @throws An error if there are is no index.html file inside the bundle folder.
+     * @throws {Error} When there is no index.html file inside the bundle folder.
      */
-    next(options: {
-        id: string;
-    }): Promise<BundleInfo>;
+    next(options: BundleId): Promise<BundleInfo>;
     /**
      * Set the current bundle and immediately reloads the app.
      *
-     * @param id The bundle id to set as current. See {@link BundleInfo.id}
-     * @returns {Promise<Void>} An empty promise.
-     * @throws An error if there are is no index.html file inside the bundle folder.
+     * @param options A {@link BundleId} object containing the new bundle id to set as current.
+     * @returns {Promise<void>}
+     * @throws {Error} When there are is no index.html file inside the bundle folder.
      */
-    set(options: {
-        id: string;
-    }): Promise<void>;
+    set(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.
      *
-     * @returns {Promise<void>} an empty Promise when the bundle is deleted
-     * @param id The bundle id to delete (note, this is the bundle id, NOT the version name)
-     * @throws An error if the something went wrong
+     * @param options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)
+     * @returns {Promise<void>} When the bundle is deleted
+     * @throws {Error}
      */
-    delete(options: {
-        id: string;
-    }): Promise<void>;
+    delete(options: BundleId): Promise<void>;
     /**
-     * Get all available bundles
+     * Get all locally downloaded bundles in your app
      *
-     * @returns {Promise<{bundles: BundleInfo[]}>} an Promise witht the bundles list
-     * @throws An error if the something went wrong
+     * @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}
+     * @param options The {@link ListOptions} for listing bundles
+     * @throws {Error}
      */
-    list(): Promise<{
-        bundles: BundleInfo[];
-    }>;
+    list(options?: ListOptions): Promise<BundleListResult>;
     /**
-     * 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.
      *
-     * @returns {Promise<void>} an empty Promise
-     * @param toLastSuccessful [false] if yes it reset to to the last successfully loaded bundle instead of `builtin`
-     * @throws An error if the something went wrong
+     * @param options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.
+     * @returns {Promise<void>}
+     * @throws {Error}
      */
-    reset(options?: {
-        toLastSuccessful?: boolean;
-    }): Promise<void>;
+    reset(options?: ResetOptions): Promise<void>;
     /**
-     * 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 {Promise<{ bundle: BundleInfo, native: string }>} an Promise with the current bundle info
-     * @throws An error if the something went wrong
+     * @returns {Promise<CurrentBundleResult>} A Promise evaluating to the {@link CurrentBundleResult}
+     * @throws {Error}
      */
-    current(): Promise<{
-        bundle: BundleInfo;
-        native: string;
-    }>;
+    current(): Promise<CurrentBundleResult>;
     /**
      * Reload the view
      *
-     * @returns {Promise<void>} an Promise resolved when the view is reloaded
-     * @throws An error if the something went wrong
+     * @returns {Promise<void>} A Promise which is resolved when the view is reloaded
+     * @throws {Error}
      */
     reload(): Promise<void>;
     /**
-     * Set DelayCondition, skip updates until one of the conditions is met
-     *
-     * @returns {Promise<void>} an Promise resolved directly
-     * @param options are the {@link DelayCondition} list to set
+     * Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.
+     * After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app.
+     * For the `date` kind, the value should be an iso8601 date string.
+     * For the `background` kind, the value should be a number in milliseconds.
+     * For the `nativeVersion` kind, the value should be the version number.
+     * For the `kill` kind, the value is not used.
+     * The function has unconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.
      *
      * @example
-     * setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })
-     * // installs the update after the user kills the app or after a background of 300000 ms (5 minutes)
-     *
+     * // Delay the update after the user kills the app or after a background of 300000 ms (5 minutes)
+     * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })
      * @example
-     * setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })
-     * // installs the update after the specific iso8601 date is expired
-     *
+     * // Delay the update after the specific iso8601 date is expired
+     * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })
      * @example
-     * setMultiDelay({ delayConditions: [{ kind: 'background' }] })
-     * // installs the update after the the first background (default behaviour without setting delay)
-     *
-     * @throws An error if the something went wrong
+     * // Delay the update after the first background (default behaviour without setting delay)
+     * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })
+     * @param options Containing the {@link MultiDelayConditions} array of conditions to set
+     * @returns {Promise<void>}
+     * @throws {Error}
      * @since 4.3.0
      */
-    setMultiDelay(options: {
-        delayConditions: DelayCondition[];
-    }): Promise<void>;
+    setMultiDelay(options: MultiDelayConditions): Promise<void>;
     /**
-     * Cancel delay to updates as usual
+     * Cancels a {@link DelayCondition} to process an update immediately.
      *
-     * @returns {Promise<void>} an Promise resolved directly
-     * @throws An error if the something went wrong
+     * @returns {Promise<void>}
+     * @throws {Error}
      * @since 4.0.0
      */
     cancelDelay(): Promise<void>;
     /**
      * Get Latest bundle available from update Url
      *
-     * @returns {Promise<latestVersion>} an Promise resolved when url is loaded
-     * @throws An error if the something went wrong
+     * @returns {Promise<LatestVersion>} A Promise resolved when url is loaded
+     * @throws {Error}
      * @since 4.0.0
      */
-    getLatest(): Promise<latestVersion>;
+    getLatest(options?: GetLatestOptions): Promise<LatestVersion>;
     /**
-     * Set Channel for this device
+     * 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.
+     * This methods send to Capgo backend a request to link the device ID to the channel. Capgo can accept or refuse depending of the setting of your channel.
+     *
+     *
      *
-     * @returns {Promise<channelRes>} an Promise resolved when channel is set
-     * @param options is the {@link SetChannelOptions} channel to set
-     * @throws An error if the something went wrong
+     * @param options Is the {@link SetChannelOptions} channel to set
+     * @returns {Promise<ChannelRes>} A Promise which is resolved when the new channel is set
+     * @throws {Error}
      * @since 4.7.0
      */
-    setChannel(options: SetChannelOptions): Promise<channelRes>;
+    setChannel(options: SetChannelOptions): Promise<ChannelRes>;
     /**
-     * get Channel for this device
+     * Unset the channel for this device. The device will then return to the default channel
      *
-     * @returns {Promise<channelRes>} an Promise resolved with channel info
-     * @throws An error if the something went wrong
+     * @returns {Promise<ChannelRes>} A Promise resolved when channel is set
+     * @throws {Error}
+     * @since 4.7.0
+     */
+    unsetChannel(options: UnsetChannelOptions): Promise<void>;
+    /**
+     * Get the channel for this device
+     *
+     * @returns {Promise<ChannelRes>} A Promise that resolves with the channel info
+     * @throws {Error}
      * @since 4.8.0
      */
-    getChannel(): Promise<getChannelRes>;
+    getChannel(): Promise<GetChannelRes>;
     /**
-     * Set Channel for this device
+     * Set a custom ID for this device
      *
-     * @returns {Promise<void>} an Promise resolved instantly
      * @param options is the {@link SetCustomIdOptions} customId to set
-     * @throws An error if the something went wrong
+     * @returns {Promise<void>} an Promise resolved instantly
+     * @throws {Error}
      * @since 4.9.0
      */
     setCustomId(options: SetCustomIdOptions): Promise<void>;
     /**
-     * Listen for download event in the App, let you know when the download is started, loading and finished
+     * Get the native app version or the builtin version if set in config
+     *
+     * @returns {Promise<BuiltinVersion>} A Promise with version for this device
+     * @since 5.2.0
+     */
+    getBuiltinVersion(): Promise<BuiltinVersion>;
+    /**
+     * Get unique ID used to identify device (sent to auto update server)
+     *
+     * @returns {Promise<DeviceId>} A Promise with id for this device
+     * @throws {Error}
+     */
+    getDeviceId(): Promise<DeviceId>;
+    /**
+     * Get the native Capacitor Updater plugin version (sent to auto update server)
+     *
+     * @returns {Promise<PluginVersion>} A Promise with Plugin version
+     * @throws {Error}
+     */
+    getPluginVersion(): Promise<PluginVersion>;
+    /**
+     * Get the state of auto update config.
+     *
+     * @returns {Promise<AutoUpdateEnabled>} The status for auto update. Evaluates to `false` in manual mode.
+     * @throws {Error}
+     */
+    isAutoUpdateEnabled(): Promise<AutoUpdateEnabled>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 1.0.0
+     */
+    removeAllListeners(): Promise<void>;
+    /**
+     * Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.
      *
      * @since 2.0.11
      */
-    addListener(eventName: "download", listenerFunc: DownloadChangeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void): Promise<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
      *
      * @since 4.0.0
      */
-    addListener(eventName: "noNeedUpdate", listenerFunc: NoNeedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void): Promise<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
      *
      * @since 4.0.0
      */
-    addListener(eventName: "updateAvailable", listenerFunc: UpdateAvailabledListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void): Promise<PluginListenerHandle>;
     /**
-     * Listen for download event in the App, let you know when the download is started, loading and finished
+     * Listen for downloadComplete events.
      *
      * @since 4.0.0
      */
-    addListener(eventName: "downloadComplete", listenerFunc: DownloadCompleteListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
      *
      * @since 2.3.0
      */
-    addListener(eventName: "majorAvailable", listenerFunc: MajorAvailableListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for update fail event in the App, let you know when update has fail to install at next app start
      *
      * @since 2.3.0
      */
-    addListener(eventName: "updateFailed", listenerFunc: UpdateFailedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void): Promise<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
      *
      * @since 4.0.0
      */
-    addListener(eventName: "downloadFailed", listenerFunc: DownloadFailedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void): Promise<PluginListenerHandle>;
     /**
-     * Listen for download fail event in the App, let you know when download has fail finished
+     *  Listen for reload event in the App, let you know when reload has happened
      *
      * @since 4.3.0
      */
-    addListener(eventName: "appReloaded", listenerFunc: AppReloadedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    addListener(eventName: 'appReloaded', listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
-     * Get unique ID used to identify device (sent to auto update server)
+     * Listen for app ready event in the App, let you know when app is ready to use
      *
-     * @returns {Promise<{ deviceId: string }>} an Promise with id for this device
-     * @throws An error if the something went wrong
+     * @since 5.1.0
      */
-    getDeviceId(): Promise<{
-        deviceId: string;
-    }>;
+    addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void): Promise<PluginListenerHandle>;
     /**
-     * Get the native Capacitor Updater plugin version (sent to auto update server)
+     * Get if auto update is available (not disabled by serverUrl).
      *
-     * @returns {Promise<{ id: string }>} an Promise with version for this device
-     * @throws An error if the something went wrong
+     * @returns {Promise<AutoUpdateAvailable>} The availability status for auto update. Evaluates to `false` when serverUrl is set.
+     * @throws {Error}
      */
-    getPluginVersion(): Promise<{
-        version: string;
-    }>;
+    isAutoUpdateAvailable(): Promise<AutoUpdateAvailable>;
     /**
-     * Get the state of auto update config. This will return `false` in manual mode.
+     * Get the next bundle that will be used when the app reloads.
+     * Returns null if no next bundle is set.
      *
-     * @returns {Promise<{enabled: boolean}>} The status for auto update.
-     * @throws An error if the something went wrong
+     * @returns {Promise<BundleInfo | null>} A Promise that resolves with the next bundle information or null
+     * @throws {Error}
+     * @since 6.8.0
      */
-    isAutoUpdateEnabled(): Promise<{
-        enabled: boolean;
-    }>;
+    getNextBundle(): Promise<BundleInfo | null>;
+}
+export type BundleStatus = 'success' | 'error' | 'pending' | 'downloading';
+export type DelayUntilNext = 'background' | 'kill' | 'nativeVersion' | 'date';
+export interface NoNeedEvent {
     /**
-     * Remove all listeners for this plugin.
+     * Current status of download, between 0 and 100.
      *
-     * @since 1.0.0
+     * @since  4.0.0
      */
-    removeAllListeners(): Promise<void>;
+    bundle: BundleInfo;
+}
+export interface UpdateAvailableEvent {
+    /**
+     * Current status of download, between 0 and 100.
+     *
+     * @since  4.0.0
+     */
+    bundle: BundleInfo;
+}
+export interface ChannelRes {
+    /**
+     * Current status of set channel
+     *
+     * @since  4.7.0
+     */
+    status: string;
+    error?: string;
+    message?: string;
+}
+export interface GetChannelRes {
+    /**
+     * Current status of get channel
+     *
+     * @since  4.8.0
+     */
+    channel?: string;
+    error?: string;
+    message?: string;
+    status?: string;
+    allowSet?: boolean;
+}
+export interface DownloadEvent {
+    /**
+     * Current status of download, between 0 and 100.
+     *
+     * @since  4.0.0
+     */
+    percent: number;
+    bundle: BundleInfo;
+}
+export interface MajorAvailableEvent {
+    /**
+     * Emit when a new major bundle is available.
+     *
+     * @since  4.0.0
+     */
+    version: string;
+}
+export interface DownloadFailedEvent {
+    /**
+     * Emit when a download fail.
+     *
+     * @since  4.0.0
+     */
+    version: string;
+}
+export interface DownloadCompleteEvent {
+    /**
+     * Emit when a new update is available.
+     *
+     * @since  4.0.0
+     */
+    bundle: BundleInfo;
+}
+export interface UpdateFailedEvent {
+    /**
+     * Emit when a update failed to install.
+     *
+     * @since 4.0.0
+     */
+    bundle: BundleInfo;
+}
+export interface AppReadyEvent {
+    /**
+     * Emitted when the app is ready to use.
+     *
+     * @since  5.2.0
+     */
+    bundle: BundleInfo;
+    status: string;
+}
+export interface ManifestEntry {
+    file_name: string | null;
+    file_hash: string | null;
+    download_url: string | null;
+}
+export interface LatestVersion {
+    /**
+     * Result of getLatest method
+     *
+     * @since 4.0.0
+     */
+    version: string;
+    /**
+     * @since 6
+     */
+    checksum?: string;
+    major?: boolean;
+    message?: string;
+    sessionKey?: string;
+    error?: string;
+    old?: string;
+    url?: string;
+    /**
+     * @since 6.1
+     */
+    manifest?: ManifestEntry[];
+}
+export interface BundleInfo {
+    id: string;
+    version: string;
+    downloaded: string;
+    checksum: string;
+    status: BundleStatus;
+}
+export interface SetChannelOptions {
+    channel: string;
+    triggerAutoUpdate?: boolean;
+}
+export interface UnsetChannelOptions {
+    triggerAutoUpdate?: boolean;
+}
+export interface SetCustomIdOptions {
+    customId: string;
+}
+export interface DelayCondition {
+    /**
+     * Set up delay conditions in setMultiDelay
+     * @param value is useless for @param kind "kill", optional for "background" (default value: "0") and required for "nativeVersion" and "date"
+     */
+    kind: DelayUntilNext;
+    value?: string;
+}
+export interface GetLatestOptions {
+    /**
+     * The channel to get the latest version for
+     * The channel must allow 'self_assign' for this to work
+     * @since 6.8.0
+     * @default undefined
+     */
+    channel?: string;
+}
+export interface AppReadyResult {
+    bundle: BundleInfo;
+}
+export interface UpdateUrl {
+    url: string;
+}
+export interface StatsUrl {
+    url: string;
+}
+export interface ChannelUrl {
+    url: string;
+}
+export interface DownloadOptions {
+    /**
+     * 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.)
+     */
+    url?: string;
+    /**
+     * The version code/name of this bundle/version
+     */
+    version: string;
+    /**
+     * The session key for the update
+     * @since 4.0.0
+     * @default undefined
+     */
+    sessionKey?: string;
+    /**
+     * The checksum for the update
+     * @since 4.0.0
+     * @default undefined
+     */
+    checksum?: string;
+}
+export interface BundleId {
+    id: string;
+}
+export interface BundleListResult {
+    bundles: BundleInfo[];
+}
+export interface ResetOptions {
+    toLastSuccessful: boolean;
+}
+export interface ListOptions {
+    /**
+     * 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.
+     * @since 6.14.0
+     * @default false
+     */
+    raw?: boolean;
+}
+export interface CurrentBundleResult {
+    bundle: BundleInfo;
+    native: string;
+}
+export interface MultiDelayConditions {
+    delayConditions: DelayCondition[];
+}
+export interface BuiltinVersion {
+    version: string;
+}
+export interface DeviceId {
+    deviceId: string;
+}
+export interface PluginVersion {
+    version: string;
+}
+export interface AutoUpdateEnabled {
+    enabled: boolean;
+}
+export interface AutoUpdateAvailable {
+    available: boolean;
 }