@capawesome/capacitor-live-update 8.4.4 → 8.5.0

package/dist/docs.json

@@ -16,7 +16,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Clear all blocked bundles from the blocked list.\n\nThis removes all bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
+        "docs": "Clear all blocked bundles from the blocked list.\n\nThis removes all bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [],
         "slug": "clearblockedbundles"
       },
@@ -37,7 +37,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Delete a bundle from the app.\n\nOnly available on Android and iOS.",
+        "docs": "Delete a bundle from the app.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "DeleteBundleOptions"
         ],
@@ -60,7 +60,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Download a bundle.\n\nOnly available on Android and iOS.",
+        "docs": "Download a bundle.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "DownloadBundleOptions"
         ],
@@ -83,7 +83,7 @@
             "text": "8.2.0"
           }
         ],
-        "docs": "Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).\n\nThis is primarily intended for development and QA purposes.\nIt allows you to retrieve a list of available channels so you can\ndynamically switch between them using `setChannel(...)`.\n\n**Attention**: Only works for apps with public channels enabled.\nIf channels are private, they can still be set using `setChannel(...)`\nbut won't be returned by this method.\n\nOnly available on Android and iOS.",
+        "docs": "Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).\n\nThis is primarily intended for development and QA purposes.\nIt allows you to retrieve a list of available channels so you can\ndynamically switch between them using `setChannel(...)`.\n\n**Attention**: Only works for apps with public channels enabled.\nIf channels are private, they can still be set using `setChannel(...)`\nbut won't be returned by this method.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "FetchChannelsResult",
           "FetchChannelsOptions"
@@ -107,7 +107,7 @@
             "text": "6.6.0"
           }
         ],
-        "docs": "Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nOnly available on Android and iOS.",
+        "docs": "Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "FetchLatestBundleResult",
           "FetchLatestBundleOptions"
@@ -125,7 +125,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Get all blocked bundle identifiers.\n\nReturns the list of bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
+        "docs": "Get all blocked bundle identifiers.\n\nReturns the list of bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetBlockedBundlesResult"
         ],
@@ -146,7 +146,7 @@
             "text": "Use `getDownloadedBundles()` instead."
           }
         ],
-        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
+        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetBundlesResult"
         ],
@@ -163,7 +163,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the channel that is used for the update.\n\nThe channel is resolved in the following order (highest priority first):\n1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)\n2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or\n   `capawesome_live_update_default_channel` in `strings.xml` on Android)\n3. Capacitor config `defaultChannel`\n\n**Note**: The `channel` parameter of `sync()` takes the highest priority\nbut is not persisted and therefore not returned by this method.\n\nOnly available on Android and iOS.",
+        "docs": "Get the channel that is used for the update.\n\nThe channel is resolved in the following order (highest priority first):\n1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)\n2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS,\n   `capawesome_live_update_default_channel` in `strings.xml` on Android or\n   `defaultChannel` in `electron/capacitor.electron.config.ts` on Electron)\n3. Capacitor config `defaultChannel`\n\n**Note**: The `channel` parameter of `sync()` takes the highest priority\nbut is not persisted and therefore not returned by this method.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetChannelResult"
         ],
@@ -180,7 +180,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Get the runtime configuration.\n\nReturns the current plugin configuration including any runtime\noverrides set via `setConfig()`.\n\nOnly available on Android and iOS.",
+        "docs": "Get the runtime configuration.\n\nReturns the current plugin configuration including any runtime\noverrides set via `setConfig()`.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetConfigResult"
         ],
@@ -197,7 +197,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
+        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetDownloadedBundlesResult"
         ],
@@ -214,7 +214,7 @@
             "text": "6.7.0"
           }
         ],
-        "docs": "Get the bundle identifier of the current bundle.\nThe current bundle is the bundle that is currently used by the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the bundle identifier of the current bundle.\nThe current bundle is the bundle that is currently used by the app.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetCurrentBundleResult"
         ],
@@ -231,7 +231,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the custom identifier of the device.\n\nOnly available on Android and iOS.",
+        "docs": "Get the custom identifier of the device.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetCustomIdResult"
         ],
@@ -248,7 +248,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the unique device identifier.\n\nOnly available on Android and iOS.",
+        "docs": "Get the unique device identifier.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetDeviceIdResult"
         ],
@@ -265,7 +265,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Check whether a sync operation is currently in progress.\n\nOnly available on Android and iOS.",
+        "docs": "Check whether a sync operation is currently in progress.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "IsSyncingResult"
         ],
@@ -282,7 +282,7 @@
             "text": "6.7.0"
           }
         ],
-        "docs": "Get the bundle identifier of the next bundle.\nThe next bundle is the bundle that will be used after calling `reload()`\nor restarting the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the bundle identifier of the next bundle.\nThe next bundle is the bundle that will be used after calling `reload()`\nor restarting the app.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetNextBundleResult"
         ],
@@ -299,7 +299,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n\nOnly available on Android and iOS.",
+        "docs": "Get the version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\nOn **Electron**, this is the `version` from the `electron/package.json` file.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetVersionCodeResult"
         ],
@@ -316,7 +316,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n\nOnly available on Android and iOS.",
+        "docs": "Get the version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\nOn **Electron**, this is the `version` from the `electron/package.json` file.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "GetVersionNameResult"
         ],
@@ -333,7 +333,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.\nIt must always be called before `sync(...)` or any other method that changes the bundle.\n\nOnly available on Android and iOS.",
+        "docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.\nIt must always be called before `sync(...)` or any other method that changes the bundle.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "ReadyResult"
         ],
@@ -350,7 +350,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Reload the app to apply the new bundle.\n\nThis method reloads the web view only, the native process is **not** restarted.\nResources of the web layer that hold an exclusive lock (e.g. IndexedDB or WebSockets)\nare therefore not released automatically and may prevent the new bundle from starting.\nRelease these resources before calling this method or apply the new bundle\non the next app start instead.\n\n**Attention**: The in-memory state of the app (e.g. unsaved user input) is lost.\n\nOnly available on Android and iOS.",
+        "docs": "Reload the app to apply the new bundle.\n\nThis method reloads the web view only, the native process is **not** restarted.\nResources of the web layer that hold an exclusive lock (e.g. IndexedDB or WebSockets)\nare therefore not released automatically and may prevent the new bundle from starting.\nRelease these resources before calling this method or apply the new bundle\non the next app start instead.\n\n**Attention**: The in-memory state of the app (e.g. unsaved user input) is lost.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [],
         "slug": "reload"
       },
@@ -365,7 +365,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Reset the app to the default bundle.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
+        "docs": "Reset the app to the default bundle.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [],
         "slug": "reset"
       },
@@ -380,7 +380,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Reset the runtime configuration to the values from the Capacitor config file.\n\nThis clears any runtime configuration set via `setConfig()`.\nThe changes take effect immediately.\n\nOnly available on Android and iOS.",
+        "docs": "Reset the runtime configuration to the values from the Capacitor config file.\n\nThis clears any runtime configuration set via `setConfig()`.\nThe changes take effect immediately.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [],
         "slug": "resetconfig"
       },
@@ -401,7 +401,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Set the channel to use for the update.\n\nOnly available on Android and iOS.",
+        "docs": "Set the channel to use for the update.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "SetChannelOptions"
         ],
@@ -424,7 +424,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Set the runtime configuration.\n\nThis allows updating plugin configuration options at runtime.\nThe changes are persisted across app restarts and take effect immediately.\n\n**Important:** Runtime configuration is automatically reset to default values\nwhenever the native app is updated to a new version. This ensures that\nconfiguration from previous versions doesn't persist after an app update.\n\nOnly available on Android and iOS.",
+        "docs": "Set the runtime configuration.\n\nThis allows updating plugin configuration options at runtime.\nThe changes are persisted across app restarts and take effect immediately.\n\n**Important:** Runtime configuration is automatically reset to default values\nwhenever the native app is updated to a new version. This ensures that\nconfiguration from previous versions doesn't persist after an app update.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "SetConfigOptions"
         ],
@@ -447,7 +447,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Set the custom identifier of the device.\n\nOnly available on Android and iOS.",
+        "docs": "Set the custom identifier of the device.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "SetCustomIdOptions"
         ],
@@ -470,7 +470,7 @@
             "text": "6.7.0"
           }
         ],
-        "docs": "Set the next bundle to use for the app.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
+        "docs": "Set the next bundle to use for the app.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "SetNextBundleOptions"
         ],
@@ -493,7 +493,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
+        "docs": "Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "SyncResult",
           "SyncOptions"
@@ -522,7 +522,7 @@
             "text": "7.0.0"
           }
         ],
-        "docs": "Listen for the download progress of a bundle.\n\nOnly available on Android and iOS.",
+        "docs": "Listen for the download progress of a bundle.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "PluginListenerHandle",
           "DownloadBundleProgressListener"
@@ -551,7 +551,7 @@
             "text": "7.3.0"
           }
         ],
-        "docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.\n\nOnly available on Android and iOS.",
+        "docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "PluginListenerHandle",
           "NextBundleSetListener"
@@ -580,7 +580,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Listen for when the app is reloaded.\n\nThis event is triggered after the `reload()` method is called\nand the app has been reloaded.\n\n**Note:** To verify whether an update was successfully applied after a reload,\nuse the `ready()` method instead. The `ready()` method provides detailed information\nabout the current bundle, previous bundle, and whether a rollback occurred.\n\nOnly available on Android and iOS.",
+        "docs": "Listen for when the app is reloaded.\n\nThis event is triggered after the `reload()` method is called\nand the app has been reloaded.\n\n**Note:** To verify whether an update was successfully applied after a reload,\nuse the `ready()` method instead. The `ready()` method provides detailed information\nabout the current bundle, previous bundle, and whether a rollback occurred.\n\nOnly available on Android, iOS and Electron.",
         "complexTypes": [
           "PluginListenerHandle",
           "ReloadedListener"
@@ -659,7 +659,7 @@
               "name": "example"
             }
           ],
-          "docs": "The artifact type of the bundle.",
+          "docs": "The artifact type of the bundle.\n\nOn **Electron**, only the `zip` artifact type is supported.",
           "complexTypes": [],
           "type": "'manifest' | 'zip' | undefined"
         },
@@ -865,7 +865,7 @@
               "name": "since"
             }
           ],
-          "docs": "The artifact type of the bundle.",
+          "docs": "The artifact type of the bundle.\n\nOn **Electron**, only the `zip` artifact type is supported.",
           "complexTypes": [],
           "type": "'manifest' | 'zip' | undefined"
         },
@@ -1207,7 +1207,7 @@
               "name": "example"
             }
           ],
-          "docs": "The unique identifier of the device.\n\nOn iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\nThe value of this property is the same for apps that come from the same vendor running on the same device.",
+          "docs": "The unique identifier of the device.\n\nOn iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\nThe value of this property is the same for apps that come from the same vendor running on the same device.\n\nOn Electron, a random UUID is generated on first use and stored in the app's user data directory.\nThe value changes when the user data is cleared.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1289,7 +1289,7 @@
               "name": "example"
             }
           ],
-          "docs": "The version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.",
+          "docs": "The version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\nOn **Electron**, this is the `version` from the `electron/package.json` file.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1319,7 +1319,7 @@
               "name": "example"
             }
           ],
-          "docs": "The version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.",
+          "docs": "The version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\nOn **Electron**, this is the `version` from the `electron/package.json` file.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1725,7 +1725,7 @@
               "name": "default"
             }
           ],
-          "docs": "Whether or not to automatically block bundles that have been rolled back.\n\nWhen enabled, the plugin will automatically block bundles that caused a rollback\n(up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.\nBlocked bundles will be skipped in future sync operations.\n\n**Attention**: This option has no effect if `readyTimeout` is set to `0`.\n\nOnly available on Android and iOS.",
+          "docs": "Whether or not to automatically block bundles that have been rolled back.\n\nWhen enabled, the plugin will automatically block bundles that caused a rollback\n(up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.\nBlocked bundles will be skipped in future sync operations.\n\n**Attention**: This option has no effect if `readyTimeout` is set to `0`.\n\nOnly available on Android, iOS and Electron.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -1761,7 +1761,7 @@
               "name": "example"
             }
           ],
-          "docs": "The auto-update strategy for live updates.\n\n- `none`: Live updates will not be applied automatically.\n- `background`: Live updates will be automatically downloaded\nand applied in the background at app startup and when the app resumes\n(if the last check was more than 15 minutes ago).\n\nOnly available on Android and iOS.",
+          "docs": "The auto-update strategy for live updates.\n\n- `none`: Live updates will not be applied automatically.\n- `background`: Live updates will be automatically downloaded\nand applied in the background at app startup and when the app resumes\n(if the last check was more than 15 minutes ago).\n\nOnly available on Android, iOS and Electron.",
           "complexTypes": [],
           "type": "'none' | 'background' | undefined"
         },
@@ -1777,7 +1777,7 @@
               "name": "example"
             }
           ],
-          "docs": "The default channel of the app.\n\nThis can be overridden by `setChannel()`, the `channel` parameter of `sync()`,\nor the native channel configuration\n(`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`\nin `strings.xml` on Android).",
+          "docs": "The default channel of the app.\n\nThis can be overridden by `setChannel()`, the `channel` parameter of `sync()`,\nor the native channel configuration\n(`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS, `capawesome_live_update_default_channel`\nin `strings.xml` on Android or `electron/capacitor.electron.config.ts` on Electron).",
           "complexTypes": [],
           "type": "string | undefined"
         },

package/dist/esm/definitions.d.ts

@@ -21,7 +21,7 @@ declare module '@capacitor/cli' {
              *
              * **Attention**: This option has no effect if `readyTimeout` is set to `0`.
              *
-             * Only available on Android and iOS.
+             * Only available on Android, iOS and Electron.
              *
              * @since 7.3.0
              * @default false
@@ -44,7 +44,7 @@ declare module '@capacitor/cli' {
              * and applied in the background at app startup and when the app resumes
              * (if the last check was more than 15 minutes ago).
              *
-             * Only available on Android and iOS.
+             * Only available on Android, iOS and Electron.
              *
              * @since 7.3.0
              * @default 'none'
@@ -56,8 +56,8 @@ declare module '@capacitor/cli' {
              *
              * This can be overridden by `setChannel()`, the `channel` parameter of `sync()`,
              * or the native channel configuration
-             * (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`
-             * in `strings.xml` on Android).
+             * (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS, `capawesome_live_update_default_channel`
+             * in `strings.xml` on Android or `electron/capacitor.electron.config.ts` on Electron).
              *
              * @since 6.3.0
              * @example 'production'
@@ -113,7 +113,7 @@ export interface LiveUpdatePlugin {
      * This removes all bundle identifiers that were automatically blocked
      * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -121,7 +121,7 @@ export interface LiveUpdatePlugin {
     /**
      * Delete a bundle from the app.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -129,7 +129,7 @@ export interface LiveUpdatePlugin {
     /**
      * Download a bundle.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -145,7 +145,7 @@ export interface LiveUpdatePlugin {
      * If channels are private, they can still be set using `setChannel(...)`
      * but won't be returned by this method.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 8.2.0
      */
@@ -153,7 +153,7 @@ export interface LiveUpdatePlugin {
     /**
      * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 6.6.0
      */
@@ -164,7 +164,7 @@ export interface LiveUpdatePlugin {
      * Returns the list of bundle identifiers that were automatically blocked
      * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -172,7 +172,7 @@ export interface LiveUpdatePlugin {
     /**
      * Get all identifiers of bundles that have been downloaded.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      * @deprecated Use `getDownloadedBundles()` instead.
@@ -183,14 +183,15 @@ export interface LiveUpdatePlugin {
      *
      * The channel is resolved in the following order (highest priority first):
      * 1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
-     * 2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
-     *    `capawesome_live_update_default_channel` in `strings.xml` on Android)
+     * 2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS,
+     *    `capawesome_live_update_default_channel` in `strings.xml` on Android or
+     *    `defaultChannel` in `electron/capacitor.electron.config.ts` on Electron)
      * 3. Capacitor config `defaultChannel`
      *
      * **Note**: The `channel` parameter of `sync()` takes the highest priority
      * but is not persisted and therefore not returned by this method.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -201,7 +202,7 @@ export interface LiveUpdatePlugin {
      * Returns the current plugin configuration including any runtime
      * overrides set via `setConfig()`.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -209,7 +210,7 @@ export interface LiveUpdatePlugin {
     /**
      * Get all identifiers of bundles that have been downloaded.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -218,7 +219,7 @@ export interface LiveUpdatePlugin {
      * Get the bundle identifier of the current bundle.
      * The current bundle is the bundle that is currently used by the app.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 6.7.0
      */
@@ -226,7 +227,7 @@ export interface LiveUpdatePlugin {
     /**
      * Get the custom identifier of the device.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -234,7 +235,7 @@ export interface LiveUpdatePlugin {
     /**
      * Get the unique device identifier.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -242,7 +243,7 @@ export interface LiveUpdatePlugin {
     /**
      * Check whether a sync operation is currently in progress.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -252,7 +253,7 @@ export interface LiveUpdatePlugin {
      * The next bundle is the bundle that will be used after calling `reload()`
      * or restarting the app.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 6.7.0
      */
@@ -262,8 +263,9 @@ export interface LiveUpdatePlugin {
      *
      * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.
      * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.
+     * On **Electron**, this is the `version` from the `electron/package.json` file.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -273,8 +275,9 @@ export interface LiveUpdatePlugin {
      *
      * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.
      * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.
+     * On **Electron**, this is the `version` from the `electron/package.json` file.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -286,7 +289,7 @@ export interface LiveUpdatePlugin {
      * to prevent the app from being reset to the default bundle.
      * It must always be called before `sync(...)` or any other method that changes the bundle.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -302,7 +305,7 @@ export interface LiveUpdatePlugin {
      *
      * **Attention**: The in-memory state of the app (e.g. unsaved user input) is lost.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -312,7 +315,7 @@ export interface LiveUpdatePlugin {
      *
      * Call `reload()` or restart the app to apply the changes.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -323,7 +326,7 @@ export interface LiveUpdatePlugin {
      * This clears any runtime configuration set via `setConfig()`.
      * The changes take effect immediately.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -331,7 +334,7 @@ export interface LiveUpdatePlugin {
     /**
      * Set the channel to use for the update.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -346,7 +349,7 @@ export interface LiveUpdatePlugin {
      * whenever the native app is updated to a new version. This ensures that
      * configuration from previous versions doesn't persist after an app update.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -354,7 +357,7 @@ export interface LiveUpdatePlugin {
     /**
      * Set the custom identifier of the device.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -364,7 +367,7 @@ export interface LiveUpdatePlugin {
      *
      * Call `reload()` or restart the app to apply the changes.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 6.7.0
      */
@@ -374,7 +377,7 @@ export interface LiveUpdatePlugin {
      *
      * Call `reload()` or restart the app to apply the changes.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 5.0.0
      */
@@ -382,7 +385,7 @@ export interface LiveUpdatePlugin {
     /**
      * Listen for the download progress of a bundle.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.0.0
      */
@@ -393,7 +396,7 @@ export interface LiveUpdatePlugin {
      * This event is triggered whenever a bundle is set to be used on the next app restart,
      * either through automatic updates or manual calls to `setNextBundle()`.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.3.0
      */
@@ -408,7 +411,7 @@ export interface LiveUpdatePlugin {
      * use the `ready()` method instead. The `ready()` method provides detailed information
      * about the current bundle, previous bundle, and whether a rollback occurred.
      *
-     * Only available on Android and iOS.
+     * Only available on Android, iOS and Electron.
      *
      * @since 7.4.0
      */
@@ -436,6 +439,8 @@ export interface DownloadBundleOptions {
     /**
      * The artifact type of the bundle.
      *
+     * On **Electron**, only the `zip` artifact type is supported.
+     *
      * @since 6.6.0
      * @default 'zip'
      * @example 'manifest'
@@ -562,6 +567,8 @@ export interface FetchLatestBundleResult {
     /**
      * The artifact type of the bundle.
      *
+     * On **Electron**, only the `zip` artifact type is supported.
+     *
      * @since 6.7.0
      */
     artifactType?: 'manifest' | 'zip';
@@ -724,6 +731,9 @@ export interface GetDeviceIdResult {
      * On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.
      * The value of this property is the same for apps that come from the same vendor running on the same device.
      *
+     * On Electron, a random UUID is generated on first use and stored in the app's user data directory.
+     * The value changes when the user data is cleared.
+     *
      * @since 5.0.0
      *
      * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'
@@ -763,6 +773,7 @@ export interface GetVersionCodeResult {
      *
      * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.
      * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.
+     * On **Electron**, this is the `version` from the `electron/package.json` file.
      *
      * @since 5.0.0
      * @example "1"
@@ -778,6 +789,7 @@ export interface GetVersionNameResult {
      *
      * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.
      * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.
+     * On **Electron**, this is the `version` from the `electron/package.json` file.
      *
      * @since 5.0.0
      * @example "1.0.0"