@capgo/capacitor-updater 5.7.3 → 5.7.4

package/dist/docs.json

@@ -7,9 +7,9 @@
     "methods": [
       {
         "name": "notifyAppReady",
-        "signature": "() => Promise<{ bundle: BundleInfo; }>",
+        "signature": "() => Promise<AppReadyResult>",
         "parameters": [],
-        "returns": "Promise<{ bundle: BundleInfo; }>",
+        "returns": "Promise<AppReadyResult>",
         "tags": [
           {
             "name": "returns",
@@ -17,38 +17,37 @@
           },
           {
             "name": "throws",
-            "text": "An error if something went wrong"
+            "text": "{Error}"
           }
         ],
         "docs": "Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch)\nBy default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\nChange this behaviour with {@link appReadyTimeout}",
         "complexTypes": [
-          "BundleInfo"
+          "AppReadyResult"
         ],
         "slug": "notifyappready"
       },
       {
         "name": "setUpdateUrl",
-        "signature": "(options: { url: string; }) => Promise<void>",
+        "signature": "(options: UpdateUrl) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ url: string; }"
+            "docs": "contains the URL to use for checking for updates.",
+            "type": "UpdateUrl"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an empty Promise"
+            "name": "param",
+            "text": "options contains the URL to use for checking for updates."
           },
           {
-            "name": "param",
-            "text": "url The URL to use for checking for updates."
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
@@ -56,65 +55,67 @@
           }
         ],
         "docs": "Set the updateUrl for the app, this will be used to check for updates.",
-        "complexTypes": [],
+        "complexTypes": [
+          "UpdateUrl"
+        ],
         "slug": "setupdateurl"
       },
       {
         "name": "setStatsUrl",
-        "signature": "(options: { url: string; }) => Promise<void>",
+        "signature": "(options: StatsUrl) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ url: string; }"
+            "docs": "contains the URL to use for sending statistics.",
+            "type": "StatsUrl"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an empty Promise"
+            "name": "param",
+            "text": "options contains the URL to use for sending statistics."
           },
           {
-            "name": "param",
-            "text": "url The URL to use for sending statistics."
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "5.4.0"
           }
         ],
-        "docs": "Set the statsUrl for the app, this will be used to send statistics.",
-        "complexTypes": [],
+        "docs": "Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.",
+        "complexTypes": [
+          "StatsUrl"
+        ],
         "slug": "setstatsurl"
       },
       {
         "name": "setChannelUrl",
-        "signature": "(options: { url: string; }) => Promise<void>",
+        "signature": "(options: ChannelUrl) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ url: string; }"
+            "docs": "contains the URL to use for setting the channel.",
+            "type": "ChannelUrl"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an empty Promise"
+            "name": "param",
+            "text": "options contains the URL to use for setting the channel."
           },
           {
-            "name": "param",
-            "text": "url The URL to use for setting the channel."
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
@@ -122,201 +123,205 @@
           }
         ],
         "docs": "Set the channelUrl for the app, this will be used to set the channel.",
-        "complexTypes": [],
+        "complexTypes": [
+          "ChannelUrl"
+        ],
         "slug": "setchannelurl"
       },
       {
         "name": "download",
-        "signature": "(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>",
+        "signature": "(options: DownloadOptions) => Promise<BundleInfo>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ url: string; version: string; sessionKey?: string | undefined; checksum?: string | undefined; }"
+            "docs": "The {@link DownloadOptions} for downloading a new bundle zip.",
+            "type": "DownloadOptions"
           }
         ],
         "returns": "Promise<BundleInfo>",
         "tags": [
           {
-            "name": "returns",
-            "text": "The {@link BundleInfo} for the specified bundle."
+            "name": "example",
+            "text": "const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });"
           },
           {
-            "name": "param",
-            "text": "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.)"
+            "name": "returns",
+            "text": "The {@link BundleInfo} for the specified bundle."
           },
           {
             "name": "param",
-            "text": "version set the version code/name of this bundle/version"
-          },
-          {
-            "name": "example",
-            "text": "https://example.com/versions/{version}/dist.zip"
+            "text": "options The {@link DownloadOptions} for downloading a new bundle zip."
           }
         ],
         "docs": "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",
         "complexTypes": [
-          "BundleInfo"
+          "BundleInfo",
+          "DownloadOptions"
         ],
         "slug": "download"
       },
       {
         "name": "next",
-        "signature": "(options: { id: string; }) => Promise<BundleInfo>",
+        "signature": "(options: BundleId) => Promise<BundleInfo>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ id: string; }"
+            "docs": "Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}",
+            "type": "BundleId"
           }
         ],
         "returns": "Promise<BundleInfo>",
         "tags": [
           {
-            "name": "returns",
-            "text": "The {@link BundleInfo} for the specified bundle id."
+            "name": "param",
+            "text": "options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}"
           },
           {
-            "name": "param",
-            "text": "id The bundle id to set as current, next time the app is reloaded. See {@link BundleInfo.id}"
+            "name": "returns",
+            "text": "The {@link BundleInfo} for the specified bundle id."
           },
           {
             "name": "throws",
-            "text": "An error if there are is no index.html file inside the bundle folder."
+            "text": "{Error} When there is no index.html file inside the bundle folder."
           }
         ],
         "docs": "Set the next bundle to be used when the app is reloaded.",
         "complexTypes": [
-          "BundleInfo"
+          "BundleInfo",
+          "BundleId"
         ],
         "slug": "next"
       },
       {
         "name": "set",
-        "signature": "(options: { id: string; }) => Promise<void>",
+        "signature": "(options: BundleId) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ id: string; }"
+            "docs": "A {@link BundleId} object containing the new bundle id to set as current.",
+            "type": "BundleId"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "id The bundle id to set as current. See {@link BundleInfo.id}"
+            "text": "options A {@link BundleId} object containing the new bundle id to set as current."
           },
           {
-            "name": "returns",
-            "text": "An empty promise."
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if there are is no index.html file inside the bundle folder."
+            "text": "{Error} When there are is no index.html file inside the bundle folder."
           }
         ],
         "docs": "Set the current bundle and immediately reloads the app.",
-        "complexTypes": [],
+        "complexTypes": [
+          "BundleId"
+        ],
         "slug": "set"
       },
       {
         "name": "delete",
-        "signature": "(options: { id: string; }) => Promise<void>",
+        "signature": "(options: BundleId) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ id: string; }"
+            "docs": "A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)",
+            "type": "BundleId"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an empty Promise when the bundle is deleted"
+            "name": "param",
+            "text": "options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)"
           },
           {
-            "name": "param",
-            "text": "id The bundle id to delete (note, this is the bundle id, NOT the version name)"
+            "name": "returns",
+            "text": "When the bundle is deleted"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           }
         ],
-        "docs": "Delete bundle in storage",
-        "complexTypes": [],
+        "docs": "Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.",
+        "complexTypes": [
+          "BundleId"
+        ],
         "slug": "delete"
       },
       {
         "name": "list",
-        "signature": "() => Promise<{ bundles: BundleInfo[]; }>",
+        "signature": "() => Promise<BundleListResult>",
         "parameters": [],
-        "returns": "Promise<{ bundles: BundleInfo[]; }>",
+        "returns": "Promise<BundleListResult>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise witht the bundles list"
+            "text": "A Promise containing the {@link BundleListResult.bundles}"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           }
         ],
         "docs": "Get all locally downloaded bundles in your app",
         "complexTypes": [
-          "BundleInfo"
+          "BundleListResult"
         ],
         "slug": "list"
       },
       {
         "name": "reset",
-        "signature": "(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>",
+        "signature": "(options?: ResetOptions | undefined) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "",
-            "type": "{ toLastSuccessful?: boolean | undefined; } | undefined"
+            "docs": "Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.",
+            "type": "ResetOptions | undefined"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an empty Promise"
+            "name": "param",
+            "text": "options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle."
           },
           {
-            "name": "param",
-            "text": "toLastSuccessful [false] if yes it reset to to the last successfully loaded bundle instead of `builtin`"
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           }
         ],
-        "docs": "Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle",
-        "complexTypes": [],
+        "docs": "Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.",
+        "complexTypes": [
+          "ResetOptions"
+        ],
         "slug": "reset"
       },
       {
         "name": "current",
-        "signature": "() => Promise<{ bundle: BundleInfo; native: string; }>",
+        "signature": "() => Promise<CurrentBundleResult>",
         "parameters": [],
-        "returns": "Promise<{ bundle: BundleInfo; native: string; }>",
+        "returns": "Promise<CurrentBundleResult>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with the current bundle info"
+            "text": "A Promise evaluating to the {@link CurrentBundleResult}"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           }
         ],
-        "docs": "Get the current bundle, if none are set it returns `builtin`, currentNative is the original bundle installed on the device",
+        "docs": "Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device",
         "complexTypes": [
-          "BundleInfo"
+          "CurrentBundleResult"
         ],
         "slug": "current"
       },
@@ -328,11 +333,11 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved when the view is reloaded"
+            "text": "A Promise which is resolved when the view is reloaded"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           }
         ],
         "docs": "Reload the view",
@@ -341,48 +346,47 @@
       },
       {
         "name": "setMultiDelay",
-        "signature": "(options: { delayConditions: DelayCondition[]; }) => Promise<void>",
+        "signature": "(options: MultiDelayConditions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "are the {@link DelayCondition} list to set",
-            "type": "{ delayConditions: DelayCondition[]; }"
+            "docs": "Containing the {@link MultiDelayConditions} array of conditions to set",
+            "type": "MultiDelayConditions"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an Promise resolved directly"
+            "name": "example",
+            "text": "// Install the update after the user kills the app or after a background of 300000 ms (5 minutes)\nawait CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })"
           },
           {
-            "name": "param",
-            "text": "options are the {@link DelayCondition} list to set"
+            "name": "example",
+            "text": "// Install the update after the specific iso8601 date is expired\nawait CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })"
           },
           {
             "name": "example",
-            "text": "setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n// installs the update after the user kills the app or after a background of 300000 ms (5 minutes)"
+            "text": "// Install the update after the first background (default behaviour without setting delay)\nawait CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })"
           },
           {
-            "name": "example",
-            "text": "setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n// installs the update after the specific iso8601 date is expired"
+            "name": "param",
+            "text": "options Containing the {@link MultiDelayConditions} array of conditions to set"
           },
           {
-            "name": "example",
-            "text": "setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n// installs the update after the the first background (default behaviour without setting delay)"
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.3.0"
           }
         ],
-        "docs": "Set DelayCondition, skip updates until one of the conditions is met",
+        "docs": "Sets a {@link DelayCondition} array containing conditions that the Plugin will use to determine when to install updates.",
         "complexTypes": [
-          "DelayCondition"
+          "MultiDelayConditions"
         ],
         "slug": "setmultidelay"
       },
@@ -393,35 +397,34 @@
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an Promise resolved directly"
+            "name": "returns"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.0.0"
           }
         ],
-        "docs": "Cancel delay to updates as usual",
+        "docs": "Cancels a {@link DelayCondition} to process an update immediately.",
         "complexTypes": [],
         "slug": "canceldelay"
       },
       {
         "name": "getLatest",
-        "signature": "() => Promise<latestVersion>",
+        "signature": "() => Promise<LatestVersion>",
         "parameters": [],
-        "returns": "Promise<latestVersion>",
+        "returns": "Promise<LatestVersion>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved when url is loaded"
+            "text": "A Promise resolved when url is loaded"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
@@ -430,42 +433,42 @@
         ],
         "docs": "Get Latest bundle available from update Url",
         "complexTypes": [
-          "latestVersion"
+          "LatestVersion"
         ],
         "slug": "getlatest"
       },
       {
         "name": "setChannel",
-        "signature": "(options: SetChannelOptions) => Promise<channelRes>",
+        "signature": "(options: SetChannelOptions) => Promise<ChannelRes>",
         "parameters": [
           {
             "name": "options",
-            "docs": "is the {@link SetChannelOptions} channel to set",
+            "docs": "Is the {@link SetChannelOptions} channel to set",
             "type": "SetChannelOptions"
           }
         ],
-        "returns": "Promise<channelRes>",
+        "returns": "Promise<ChannelRes>",
         "tags": [
           {
-            "name": "returns",
-            "text": "an Promise resolved when channel is set"
+            "name": "param",
+            "text": "options Is the {@link SetChannelOptions} channel to set"
           },
           {
-            "name": "param",
-            "text": "options is the {@link SetChannelOptions} channel to set"
+            "name": "returns",
+            "text": "A Promise which is resolved when the new channel is set"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.7.0"
           }
         ],
-        "docs": "Set Channel for this device, the channel have to allow self assignement to make this work\nDo 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",
+        "docs": "Sets the channel for this device. The channel has to allow for self assignment for this to work.\nDo not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\nThis method is to set the channel after the app is ready.",
         "complexTypes": [
-          "channelRes",
+          "ChannelRes",
           "SetChannelOptions"
         ],
         "slug": "setchannel"
@@ -484,18 +487,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved when channel is set"
+            "text": "A Promise resolved when channel is set"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.7.0"
           }
         ],
-        "docs": "Unset Channel for this device, the device will return to the default channel",
+        "docs": "Unset the channel for this device. The device will then return to the default channel",
         "complexTypes": [
           "UnsetChannelOptions"
         ],
@@ -503,26 +506,26 @@
       },
       {
         "name": "getChannel",
-        "signature": "() => Promise<getChannelRes>",
+        "signature": "() => Promise<GetChannelRes>",
         "parameters": [],
-        "returns": "Promise<getChannelRes>",
+        "returns": "Promise<GetChannelRes>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved with channel info"
+            "text": "A Promise that resolves with the channel info"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.8.0"
           }
         ],
-        "docs": "get Channel for this device",
+        "docs": "Get the channel for this device",
         "complexTypes": [
-          "getChannelRes"
+          "GetChannelRes"
         ],
         "slug": "getchannel"
       },
@@ -538,32 +541,131 @@
         ],
         "returns": "Promise<void>",
         "tags": [
-          {
-            "name": "returns",
-            "text": "an Promise resolved instantly"
-          },
           {
             "name": "param",
             "text": "options is the {@link SetCustomIdOptions} customId to set"
           },
+          {
+            "name": "returns",
+            "text": "an Promise resolved instantly"
+          },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error}"
           },
           {
             "name": "since",
             "text": "4.9.0"
           }
         ],
-        "docs": "Set Channel for this device",
+        "docs": "Set a custom ID for this device",
         "complexTypes": [
           "SetCustomIdOptions"
         ],
         "slug": "setcustomid"
       },
+      {
+        "name": "getBuiltinVersion",
+        "signature": "() => Promise<BuiltinVersion>",
+        "parameters": [],
+        "returns": "Promise<BuiltinVersion>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A Promise with version for this device"
+          },
+          {
+            "name": "since",
+            "text": "5.2.0"
+          }
+        ],
+        "docs": "Get the native app version or the builtin version if set in config",
+        "complexTypes": [
+          "BuiltinVersion"
+        ],
+        "slug": "getbuiltinversion"
+      },
+      {
+        "name": "getDeviceId",
+        "signature": "() => Promise<DeviceId>",
+        "parameters": [],
+        "returns": "Promise<DeviceId>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A Promise with id for this device"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          }
+        ],
+        "docs": "Get unique ID used to identify device (sent to auto update server)",
+        "complexTypes": [
+          "DeviceId"
+        ],
+        "slug": "getdeviceid"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersion>",
+        "parameters": [],
+        "returns": "Promise<PluginVersion>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A Promise with Plugin version"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          }
+        ],
+        "docs": "Get the native Capacitor Updater plugin version (sent to auto update server)",
+        "complexTypes": [
+          "PluginVersion"
+        ],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "isAutoUpdateEnabled",
+        "signature": "() => Promise<AutoUpdateEnabled>",
+        "parameters": [],
+        "returns": "Promise<AutoUpdateEnabled>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The status for auto update. Evaluates to `false` in manual mode."
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          }
+        ],
+        "docs": "Get the state of auto update config.",
+        "complexTypes": [
+          "AutoUpdateEnabled"
+        ],
+        "slug": "isautoupdateenabled"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
       {
         "name": "addListener",
-        "signature": "(eventName: \"download\", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"download\", listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -573,7 +675,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "DownloadChangeListener"
+            "type": "(state: DownloadEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -583,16 +685,16 @@
             "text": "2.0.11"
           }
         ],
-        "docs": "Listen for download event in the App, let you know when the download is started, loading and finished, with a percent value",
+        "docs": "Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.",
         "complexTypes": [
           "PluginListenerHandle",
-          "DownloadChangeListener"
+          "DownloadEvent"
         ],
         "slug": "addlistenerdownload"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"noNeedUpdate\", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"noNeedUpdate\", listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -602,7 +704,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "NoNeedListener"
+            "type": "(state: NoNeedEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -612,16 +714,16 @@
             "text": "4.0.0"
           }
         ],
-        "docs": "Listen for no need to update event, usefull when you want force check every time the app is launched",
+        "docs": "Listen for no need to update event, useful when you want force check every time the app is launched",
         "complexTypes": [
           "PluginListenerHandle",
-          "NoNeedListener"
+          "NoNeedEvent"
         ],
         "slug": "addlistenernoneedupdate"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"updateAvailable\", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"updateAvailable\", listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -631,7 +733,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "UpdateAvailabledListener"
+            "type": "(state: UpdateAvailableEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -641,16 +743,16 @@
             "text": "4.0.0"
           }
         ],
-        "docs": "Listen for availbale update event, usefull when you want to force check every time the app is launched",
+        "docs": "Listen for available update event, useful when you want to force check every time the app is launched",
         "complexTypes": [
           "PluginListenerHandle",
-          "UpdateAvailabledListener"
+          "UpdateAvailableEvent"
         ],
         "slug": "addlistenerupdateavailable"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"downloadComplete\", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"downloadComplete\", listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -660,7 +762,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "DownloadCompleteListener"
+            "type": "(state: DownloadCompleteEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -670,16 +772,16 @@
             "text": "4.0.0"
           }
         ],
-        "docs": "Listen for download event in the App, let you know when the download is started, loading and finished",
+        "docs": "Listen for downloadComplete events.",
         "complexTypes": [
           "PluginListenerHandle",
-          "DownloadCompleteListener"
+          "DownloadCompleteEvent"
         ],
         "slug": "addlistenerdownloadcomplete"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"majorAvailable\", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"majorAvailable\", listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -689,7 +791,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "MajorAvailableListener"
+            "type": "(state: MajorAvailableEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -702,13 +804,13 @@
         "docs": "Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking",
         "complexTypes": [
           "PluginListenerHandle",
-          "MajorAvailableListener"
+          "MajorAvailableEvent"
         ],
         "slug": "addlistenermajoravailable"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"updateFailed\", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"updateFailed\", listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -718,7 +820,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "UpdateFailedListener"
+            "type": "(state: UpdateFailedEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -731,13 +833,13 @@
         "docs": "Listen for update fail event in the App, let you know when update has fail to install at next app start",
         "complexTypes": [
           "PluginListenerHandle",
-          "UpdateFailedListener"
+          "UpdateFailedEvent"
         ],
         "slug": "addlistenerupdatefailed"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"downloadFailed\", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"downloadFailed\", listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -747,7 +849,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "DownloadFailedListener"
+            "type": "(state: DownloadFailedEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -757,16 +859,16 @@
             "text": "4.0.0"
           }
         ],
-        "docs": "Listen for download fail event in the App, let you know when download has fail finished",
+        "docs": "Listen for download fail event in the App, let you know when a bundle download has failed",
         "complexTypes": [
           "PluginListenerHandle",
-          "DownloadFailedListener"
+          "DownloadFailedEvent"
         ],
         "slug": "addlistenerdownloadfailed"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"appReloaded\", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"appReloaded\", listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -776,7 +878,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "AppReloadedListener"
+            "type": "() => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -786,16 +888,15 @@
             "text": "4.3.0"
           }
         ],
-        "docs": "Listen for reload event in the App, let you know when reload has happend",
+        "docs": "Listen for reload event in the App, let you know when reload has happened",
         "complexTypes": [
-          "PluginListenerHandle",
-          "AppReloadedListener"
+          "PluginListenerHandle"
         ],
         "slug": "addlistenerappreloaded"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"appReady\", listenerFunc: AppReadyListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"appReady\", listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -805,7 +906,7 @@
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "AppReadyListener"
+            "type": "(state: AppReadyEvent) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -818,105 +919,32 @@
         "docs": "Listen for app ready event in the App, let you know when app is ready to use",
         "complexTypes": [
           "PluginListenerHandle",
-          "AppReadyListener"
+          "AppReadyEvent"
         ],
         "slug": "addlistenerappready"
-      },
-      {
-        "name": "getBuiltinVersion",
-        "signature": "() => Promise<{ version: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ version: string; }>",
-        "tags": [
-          {
-            "name": "returns",
-            "text": "an Promise with version for this device"
-          },
-          {
-            "name": "since",
-            "text": "5.2.0"
-          }
-        ],
-        "docs": "Get the native app version or the builtin version if set in config",
-        "complexTypes": [],
-        "slug": "getbuiltinversion"
-      },
-      {
-        "name": "getDeviceId",
-        "signature": "() => Promise<{ deviceId: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ deviceId: string; }>",
-        "tags": [
-          {
-            "name": "returns",
-            "text": "an Promise with id for this device"
-          },
-          {
-            "name": "throws",
-            "text": "An error if the something went wrong"
-          }
-        ],
-        "docs": "Get unique ID used to identify device (sent to auto update server)",
-        "complexTypes": [],
-        "slug": "getdeviceid"
-      },
-      {
-        "name": "getPluginVersion",
-        "signature": "() => Promise<{ version: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ version: string; }>",
-        "tags": [
-          {
-            "name": "returns",
-            "text": "an Promise with version for this device"
-          },
-          {
-            "name": "throws",
-            "text": "An error if the something went wrong"
-          }
-        ],
-        "docs": "Get the native Capacitor Updater plugin version (sent to auto update server)",
-        "complexTypes": [],
-        "slug": "getpluginversion"
-      },
-      {
-        "name": "isAutoUpdateEnabled",
-        "signature": "() => Promise<{ enabled: boolean; }>",
-        "parameters": [],
-        "returns": "Promise<{ enabled: boolean; }>",
-        "tags": [
-          {
-            "name": "returns",
-            "text": "The status for auto update."
-          },
-          {
-            "name": "throws",
-            "text": "An error if the something went wrong"
-          }
-        ],
-        "docs": "Get the state of auto update config. This will return `false` in manual mode.",
-        "complexTypes": [],
-        "slug": "isautoupdateenabled"
-      },
-      {
-        "name": "removeAllListeners",
-        "signature": "() => Promise<void>",
-        "parameters": [],
-        "returns": "Promise<void>",
-        "tags": [
-          {
-            "name": "since",
-            "text": "1.0.0"
-          }
-        ],
-        "docs": "Remove all listeners for this plugin.",
-        "complexTypes": [],
-        "slug": "removealllisteners"
       }
     ],
     "properties": []
   },
   "interfaces": [
+    {
+      "name": "AppReadyResult",
+      "slug": "appreadyresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        }
+      ]
+    },
     {
       "name": "BundleInfo",
       "slug": "bundleinfo",
@@ -964,16 +992,194 @@
       ]
     },
     {
-      "name": "DelayCondition",
-      "slug": "delaycondition",
+      "name": "UpdateUrl",
+      "slug": "updateurl",
       "docs": "",
       "tags": [],
       "methods": [],
       "properties": [
         {
-          "name": "kind",
-          "tags": [
-            {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "StatsUrl",
+      "slug": "statsurl",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ChannelUrl",
+      "slug": "channelurl",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "DownloadOptions",
+      "slug": "downloadoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "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.)",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "The version code/name of this bundle/version",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "sessionKey",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "checksum",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "BundleId",
+      "slug": "bundleid",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "BundleListResult",
+      "slug": "bundlelistresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundles",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo[]"
+        }
+      ]
+    },
+    {
+      "name": "ResetOptions",
+      "slug": "resetoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "toLastSuccessful",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "CurrentBundleResult",
+      "slug": "currentbundleresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        },
+        {
+          "name": "native",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "MultiDelayConditions",
+      "slug": "multidelayconditions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "delayConditions",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "DelayCondition"
+          ],
+          "type": "DelayCondition[]"
+        }
+      ]
+    },
+    {
+      "name": "DelayCondition",
+      "slug": "delaycondition",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "kind",
+          "tags": [
+            {
               "text": "value is useless for",
               "name": "param"
             },
@@ -998,7 +1204,7 @@
       ]
     },
     {
-      "name": "latestVersion",
+      "name": "LatestVersion",
       "slug": "latestversion",
       "docs": "",
       "tags": [],
@@ -1012,7 +1218,7 @@
               "name": "since"
             }
           ],
-          "docs": "Res of getLatest method",
+          "docs": "Result of getLatest method",
           "complexTypes": [],
           "type": "string"
         },
@@ -1061,7 +1267,7 @@
       ]
     },
     {
-      "name": "channelRes",
+      "name": "ChannelRes",
       "slug": "channelres",
       "docs": "",
       "tags": [],
@@ -1135,7 +1341,7 @@
       ]
     },
     {
-      "name": "getChannelRes",
+      "name": "GetChannelRes",
       "slug": "getchannelres",
       "docs": "",
       "tags": [],
@@ -1199,6 +1405,70 @@
         }
       ]
     },
+    {
+      "name": "BuiltinVersion",
+      "slug": "builtinversion",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "DeviceId",
+      "slug": "deviceid",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersion",
+      "slug": "pluginversion",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "AutoUpdateEnabled",
+      "slug": "autoupdateenabled",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "PluginListenerHandle",
       "slug": "pluginlistenerhandle",
@@ -1246,7 +1516,7 @@
       ]
     },
     {
-      "name": "noNeedEvent",
+      "name": "NoNeedEvent",
       "slug": "noneedevent",
       "docs": "",
       "tags": [],
@@ -1269,7 +1539,7 @@
       ]
     },
     {
-      "name": "updateAvailableEvent",
+      "name": "UpdateAvailableEvent",
       "slug": "updateavailableevent",
       "docs": "",
       "tags": [],
@@ -1394,7 +1664,7 @@
               "name": "since"
             }
           ],
-          "docs": "Emit when a app is ready to use.",
+          "docs": "Emitted when the app is ready to use.",
           "complexTypes": [
             "BundleInfo"
           ],
@@ -1457,121 +1727,6 @@
           "complexTypes": []
         }
       ]
-    },
-    {
-      "name": "DownloadChangeListener",
-      "slug": "downloadchangelistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: DownloadEvent): void",
-          "complexTypes": [
-            "DownloadEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "NoNeedListener",
-      "slug": "noneedlistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: noNeedEvent): void",
-          "complexTypes": [
-            "noNeedEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "UpdateAvailabledListener",
-      "slug": "updateavailabledlistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: updateAvailableEvent): void",
-          "complexTypes": [
-            "updateAvailableEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "DownloadCompleteListener",
-      "slug": "downloadcompletelistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: DownloadCompleteEvent): void",
-          "complexTypes": [
-            "DownloadCompleteEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "MajorAvailableListener",
-      "slug": "majoravailablelistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: MajorAvailableEvent): void",
-          "complexTypes": [
-            "MajorAvailableEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "UpdateFailedListener",
-      "slug": "updatefailedlistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: UpdateFailedEvent): void",
-          "complexTypes": [
-            "UpdateFailedEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "DownloadFailedListener",
-      "slug": "downloadfailedlistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: DownloadFailedEvent): void",
-          "complexTypes": [
-            "DownloadFailedEvent"
-          ]
-        }
-      ]
-    },
-    {
-      "name": "AppReloadedListener",
-      "slug": "appreloadedlistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: void): void",
-          "complexTypes": []
-        }
-      ]
-    },
-    {
-      "name": "AppReadyListener",
-      "slug": "appreadylistener",
-      "docs": "",
-      "types": [
-        {
-          "text": "(state: AppReadyEvent): void",
-          "complexTypes": [
-            "AppReadyEvent"
-          ]
-        }
-      ]
     }
   ],
   "pluginConfigs": [
@@ -1876,7 +2031,7 @@
           "type": "string | undefined"
         }
       ],
-      "docs": "CapacitorUpdater can be configured with this options:"
+      "docs": "CapacitorUpdater can be configured with these options:"
     }
   ]
 }