@capgo/capacitor-updater 7.27.7 → 7.27.9

package/dist/docs.json

@@ -13,14 +13,10 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved directly"
-          },
-          {
-            "name": "throws",
-            "text": "{Error}"
+            "text": "Always resolves successfully with current bundle info. This method never fails."
           }
         ],
-        "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}",
+        "docs": "Notify the native layer that JavaScript initialized successfully.\n\n**CRITICAL: You must call this method on every app launch to prevent automatic rollback.**\n\nThis is a simple notification to confirm that your bundle's JavaScript loaded and executed.\nThe native web server successfully served the bundle files and your JS runtime started.\nThat's all it checks - nothing more complex.\n\n**What triggers rollback:**\n- NOT calling this method within the timeout (default: 10 seconds)\n- Complete JavaScript failure (bundle won't load at all)\n\n**What does NOT trigger rollback:**\n- Runtime errors after initialization (API failures, crashes, etc.)\n- Network request failures\n- Application logic errors\n\n**IMPORTANT: Call this BEFORE any network requests.**\nDon't wait for APIs, data loading, or async operations. Call it as soon as your\nJavaScript bundle starts executing to confirm the bundle itself is valid.\n\nBest practices:\n- Call immediately in your app entry point (main.js, app component mount, etc.)\n- Don't put it after network calls or heavy initialization\n- Don't wrap it in try/catch with conditions\n- Adjust {@link PluginsConfig.CapacitorUpdater.appReadyTimeout} if you need more time",
         "complexTypes": [
           "AppReadyResult"
         ],
@@ -32,7 +28,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "contains the URL to use for checking for updates.",
+            "docs": "Contains the URL to use for checking for updates.",
             "type": "UpdateUrl"
           }
         ],
@@ -40,21 +36,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options contains the URL to use for checking for updates."
+            "text": "options Contains the URL to use for checking for updates."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the URL is successfully updated."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
           },
           {
             "name": "since",
             "text": "5.4.0"
           }
         ],
-        "docs": "Set the updateUrl for the app, this will be used to check for updates.",
+        "docs": "Set the update URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.updateUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.",
         "complexTypes": [
           "UpdateUrl"
         ],
@@ -66,7 +63,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "contains the URL to use for sending statistics.",
+            "docs": "Contains the URL to use for sending statistics, or an empty string to disable.",
             "type": "StatsUrl"
           }
         ],
@@ -74,21 +71,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options contains the URL to use for sending statistics."
+            "text": "options Contains the URL to use for sending statistics, or an empty string to disable."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the URL is successfully updated."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
           },
           {
             "name": "since",
             "text": "5.4.0"
           }
         ],
-        "docs": "Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.",
+        "docs": "Set the statistics URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.statsUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nPass an empty string to disable statistics gathering entirely.\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.",
         "complexTypes": [
           "StatsUrl"
         ],
@@ -100,7 +98,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "contains the URL to use for setting the channel.",
+            "docs": "Contains the URL to use for channel operations.",
             "type": "ChannelUrl"
           }
         ],
@@ -108,21 +106,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options contains the URL to use for setting the channel."
+            "text": "options Contains the URL to use for channel operations."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the URL is successfully updated."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
           },
           {
             "name": "since",
             "text": "5.4.0"
           }
         ],
-        "docs": "Set the channelUrl for the app, this will be used to set the channel.",
+        "docs": "Set the channel URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.channelUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.",
         "complexTypes": [
           "ChannelUrl"
         ],
@@ -142,18 +141,22 @@
         "tags": [
           {
             "name": "example",
-            "text": "const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });"
+            "text": "const bundle = await CapacitorUpdater.download({\n  url: `https://example.com/versions/${version}/dist.zip`,\n  version: version\n});\n// Bundle is downloaded but not active yet\nawait CapacitorUpdater.next({ id: bundle.id }); // Will activate on next background"
+          },
+          {
+            "name": "param",
+            "text": "options The {@link DownloadOptions} for downloading a new bundle zip."
           },
           {
             "name": "returns",
-            "text": "The {@link BundleInfo} for the specified bundle."
+            "text": "The {@link BundleInfo} for the downloaded bundle."
           },
           {
-            "name": "param",
-            "text": "options The {@link DownloadOptions} for downloading a new bundle zip."
+            "name": "throws",
+            "text": "{Error} If the download fails or the bundle is invalid."
           }
         ],
-        "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",
+        "docs": "Download a new bundle from the provided URL for later installation.\n\nThe downloaded bundle is stored locally but not activated. To use it:\n- Call {@link next} to set it for installation on next app backgrounding/restart\n- Call {@link set} to activate it immediately (destroys current JavaScript context)\n\nThe URL should point to a zip file containing either:\n- Your app files directly in the zip root, or\n- A single folder containing all your app files\n\nThe bundle must include an `index.html` file at the root level.\n\nFor encrypted bundles, provide the `sessionKey` and `checksum` parameters.\nFor multi-file partial updates, provide the `manifest` array.",
         "complexTypes": [
           "BundleInfo",
           "DownloadOptions"
@@ -166,7 +169,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}",
+            "docs": "Contains the ID of the bundle to set as next. Use {@link BundleInfo.id} from a downloaded bundle.",
             "type": "BundleId"
           }
         ],
@@ -174,18 +177,18 @@
         "tags": [
           {
             "name": "param",
-            "text": "options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}"
+            "text": "options Contains the ID of the bundle to set as next. Use {@link BundleInfo.id} from a downloaded bundle."
           },
           {
             "name": "returns",
-            "text": "The {@link BundleInfo} for the specified bundle id."
+            "text": "The {@link BundleInfo} for the specified bundle."
           },
           {
             "name": "throws",
-            "text": "{Error} When there is no index.html file inside the bundle folder."
+            "text": "{Error} When there is no index.html file inside the bundle folder or the bundle doesn't exist."
           }
         ],
-        "docs": "Set the next bundle to be used when the app is reloaded.",
+        "docs": "Set the next bundle to be activated when the app backgrounds or restarts.\n\nThis is the recommended way to apply updates as it doesn't interrupt the user's current session.\nThe bundle will be activated when:\n- The app is backgrounded (user switches away), or\n- The app is killed and relaunched, or\n- {@link reload} is called manually\n\nUnlike {@link set}, this method does NOT destroy the current JavaScript context immediately.\nYour app continues running normally until one of the above events occurs.\n\nUse {@link setMultiDelay} to add additional conditions before the update is applied.",
         "complexTypes": [
           "BundleInfo",
           "BundleId"
@@ -209,14 +212,15 @@
             "text": "options A {@link BundleId} object containing the new bundle id to set as current."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "A promise that will never resolve because the JavaScript context is destroyed."
           },
           {
             "name": "throws",
-            "text": "{Error} When 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 current bundle and immediately reloads the app.",
+        "docs": "Set the current bundle and immediately reloads the app.\n\n**IMPORTANT: This is a terminal operation that destroys the current JavaScript context.**\n\nWhen you call this method:\n- The entire JavaScript context is immediately destroyed\n- The app reloads from a different folder with different files\n- NO code after this call will execute\n- NO promises will resolve\n- NO callbacks will fire\n- Event listeners registered after this call are unreliable and may never fire\n\nThe reload happens automatically - you don't need to do anything else.\nIf you need to preserve state like the current URL path, use the {@link PluginsConfig.CapacitorUpdater.keepUrlPathAfterReload} config option.\nFor other state preservation needs, save your data before calling this method (e.g., to localStorage).\n\n**Do not** try to execute additional logic after calling `set()` - it won't work as expected.",
         "complexTypes": [
           "BundleId"
         ],
@@ -228,7 +232,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)",
+            "docs": "A {@link BundleId} object containing the bundle ID to delete.",
             "type": "BundleId"
           }
         ],
@@ -236,18 +240,18 @@
         "tags": [
           {
             "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)"
+            "text": "options A {@link BundleId} object containing the bundle ID to delete."
           },
           {
             "name": "returns",
-            "text": "When the bundle is deleted"
+            "text": "Resolves when the bundle is successfully deleted."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the bundle is currently in use or doesn't exist."
           }
         ],
-        "docs": "Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.",
+        "docs": "Delete a bundle from local storage to free up disk space.\n\nYou cannot delete:\n- The currently active bundle\n- The `builtin` bundle (the version shipped with your app)\n- The bundle set as `next` (call {@link next} with a different bundle first)\n\nUse {@link list} to get all available bundle IDs.\n\n**Note:** The bundle ID is NOT the same as the version name.\nUse the `id` field from {@link BundleInfo}, not the `version` field.",
         "complexTypes": [
           "BundleId"
         ],
@@ -259,7 +263,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "A {@link BundleId} object containing the bundle id to mark as errored.",
+            "docs": "A {@link BundleId} object containing the bundle ID to mark as errored.",
             "type": "BundleId"
           }
         ],
@@ -267,22 +271,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options A {@link BundleId} object containing the bundle id to mark as errored."
+            "text": "options A {@link BundleId} object containing the bundle ID to mark as errored."
           },
           {
             "name": "returns",
-            "text": "The updated {@link BundleInfo} for the bundle."
+            "text": "The updated {@link BundleInfo} with status set to `error`."
           },
           {
             "name": "throws",
-            "text": "{Error} When the bundle does not exist or the feature is disabled."
+            "text": "{Error} When the bundle does not exist or `allowManualBundleError` is false."
           },
           {
             "name": "since",
             "text": "7.20.0"
           }
         ],
-        "docs": "Mark an installed bundle as errored. Only available when {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} is true.",
+        "docs": "Manually mark a bundle as failed/errored in manual update mode.\n\nThis is useful when you detect that a bundle has critical issues and want to prevent\nit from being used again. The bundle status will be changed to `error` and the plugin\nwill avoid using this bundle in the future.\n\n**Requirements:**\n- {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} must be set to `true`\n- Only works in manual update mode (when autoUpdate is disabled)\n\nCommon use case: After downloading and testing a bundle, you discover it has critical\nbugs and want to mark it as failed so it won't be retried.",
         "complexTypes": [
           "BundleInfo",
           "BundleId"
@@ -295,26 +299,26 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "The {@link ListOptions} for listing bundles",
+            "docs": "The {@link ListOptions} for customizing the bundle list output.",
             "type": "ListOptions | undefined"
           }
         ],
         "returns": "Promise<BundleListResult>",
         "tags": [
           {
-            "name": "returns",
-            "text": "A Promise containing the {@link BundleListResult.bundles}"
+            "name": "param",
+            "text": "options The {@link ListOptions} for customizing the bundle list output."
           },
           {
-            "name": "param",
-            "text": "options The {@link ListOptions} for listing bundles"
+            "name": "returns",
+            "text": "A promise containing the array of {@link BundleInfo} objects."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get all locally downloaded bundles in your app",
+        "docs": "Get all locally downloaded bundles stored in your app.\n\nThis returns all bundles that have been downloaded and are available locally, including:\n- The currently active bundle\n- The `builtin` bundle (shipped with your app)\n- Any downloaded bundles waiting to be activated\n- Failed bundles (with `error` status)\n\nUse this to:\n- Check available disk space by counting bundles\n- Delete old bundles with {@link delete}\n- Monitor bundle download status",
         "complexTypes": [
           "BundleListResult",
           "ListOptions"
@@ -327,7 +331,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.",
+            "docs": "",
             "type": "ResetOptions | undefined"
           }
         ],
@@ -335,17 +339,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle."
+            "text": "options"
+          },
+          {
+            "name": "link",
+            "text": "ResetOptions} to control reset behavior. If `toLastSuccessful` is `false` (or omitted), resets to builtin. If `true`, resets to last successful bundle."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "A promise that may never resolve because the app will be reloaded."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the reset operation fails."
           }
         ],
-        "docs": "Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.",
+        "docs": "Reset the app to a known good bundle.\n\nThis method helps recover from problematic updates by reverting to either:\n- The `builtin` bundle (the original version shipped with your app to App Store/Play Store)\n- The last successfully loaded bundle (most recent bundle that worked correctly)\n\n**IMPORTANT: This triggers an immediate app reload, destroying the current JavaScript context.**\nSee {@link set} for details on the implications of this operation.\n\nUse cases:\n- Emergency recovery when an update causes critical issues\n- Testing rollback functionality\n- Providing users a \"reset to factory\" option",
         "complexTypes": [
           "ResetOptions"
         ],
@@ -359,14 +368,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise evaluating to the {@link CurrentBundleResult}"
+            "text": "A promise with the current bundle and native version info."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device",
+        "docs": "Get information about the currently active bundle.\n\nReturns:\n- `bundle`: The currently active bundle information\n- `native`: The version of the builtin bundle (the original app version from App/Play Store)\n\nIf no updates have been applied, `bundle.id` will be `\"builtin\"`, indicating the app\nis running the original version shipped with the native app.\n\nUse this to:\n- Display the current version to users\n- Check if an update is currently active\n- Compare against available updates\n- Log the active bundle for debugging",
         "complexTypes": [
           "CurrentBundleResult"
         ],
@@ -380,14 +389,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise which is resolved when the view is reloaded"
+            "text": "A promise that may never resolve because the app will be reloaded."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the reload operation fails."
           }
         ],
-        "docs": "Reload the view",
+        "docs": "Manually reload the app to apply a pending update.\n\nThis triggers the same reload behavior that happens automatically when the app backgrounds.\nIf you've called {@link next} to queue an update, calling `reload()` will apply it immediately.\n\n**IMPORTANT: This destroys the current JavaScript context immediately.**\nSee {@link set} for details on the implications of this operation.\n\nCommon use cases:\n- Applying an update immediately after download instead of waiting for backgrounding\n- Providing a \"Restart now\" button to users after an update is ready\n- Testing update flows during development\n\nIf no update is pending (no call to {@link next}), this simply reloads the current bundle.",
         "complexTypes": [],
         "slug": "reload"
       },
@@ -397,7 +406,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Containing the {@link MultiDelayConditions} array of conditions to set",
+            "docs": "Contains the {@link MultiDelayConditions} array of conditions.",
             "type": "MultiDelayConditions"
           }
         ],
@@ -405,33 +414,34 @@
         "tags": [
           {
             "name": "example",
-            "text": "// Delay 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' }] })"
+            "text": "// Update after user kills app OR after 5 minutes in background\nawait CapacitorUpdater.setMultiDelay({\n  delayConditions: [\n    { kind: 'kill' },\n    { kind: 'background', value: '300000' }\n  ]\n});"
           },
           {
             "name": "example",
-            "text": "// Delay the update after the specific iso8601 date is expired\nawait CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })"
+            "text": "// Update after a specific date\nawait CapacitorUpdater.setMultiDelay({\n  delayConditions: [{ kind: 'date', value: '2025-12-31T23:59:59Z' }]\n});"
           },
           {
             "name": "example",
-            "text": "// Delay the update after the first background (default behaviour without setting delay)\nawait CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })"
+            "text": "// Default behavior: update on next background\nawait CapacitorUpdater.setMultiDelay({\n  delayConditions: [{ kind: 'background' }]\n});"
           },
           {
             "name": "param",
-            "text": "options Containing the {@link MultiDelayConditions} array of conditions to set"
+            "text": "options Contains the {@link MultiDelayConditions} array of conditions."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the delay conditions are set."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails or conditions are invalid."
           },
           {
             "name": "since",
             "text": "4.3.0"
           }
         ],
-        "docs": "Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.\nAfter 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.\nFor the `date` kind, the value should be an iso8601 date string.\nFor the `background` kind, the value should be a number in milliseconds.\nFor the `nativeVersion` kind, the value should be the version number.\nFor the `kill` kind, the value is not used.\nThe function has inconsistent 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.",
+        "docs": "Configure conditions that must be met before a pending update is applied.\n\nAfter calling {@link next} to queue an update, use this method to control when it gets applied.\nThe update will only be installed after ALL specified conditions are satisfied.\n\nAvailable condition types:\n- `background`: Wait for the app to be backgrounded. Optionally specify duration in milliseconds.\n- `kill`: Wait for the app to be killed and relaunched (**Note:** Current behavior triggers update immediately on kill, not on next background. This will be fixed in v8.)\n- `date`: Wait until a specific date/time (ISO 8601 format)\n- `nativeVersion`: Wait until the native app is updated to a specific version\n\nCondition value formats:\n- `background`: Number in milliseconds (e.g., `\"300000\"` for 5 minutes), or omit for immediate\n- `kill`: No value needed\n- `date`: ISO 8601 date string (e.g., `\"2025-12-31T23:59:59Z\"`)\n- `nativeVersion`: Version string (e.g., `\"2.0.0\"`)",
         "complexTypes": [
           "MultiDelayConditions"
         ],
@@ -444,18 +454,19 @@
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the delay conditions are cleared."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "4.0.0"
           }
         ],
-        "docs": "Cancels a {@link DelayCondition} to process an update immediately.",
+        "docs": "Cancel all delay conditions and apply the pending update immediately.\n\nIf you've set delay conditions with {@link setMultiDelay}, this method clears them\nand triggers the pending update to be applied on the next app background or restart.\n\nThis is useful when:\n- User manually requests to update now (e.g., clicks \"Update now\" button)\n- Your app detects it's a good time to update (e.g., user finished critical task)\n- You want to override a time-based delay early",
         "complexTypes": [],
         "slug": "canceldelay"
       },
@@ -465,26 +476,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "Optional {@link GetLatestOptions} to specify which channel to check.",
             "type": "GetLatestOptions | undefined"
           }
         ],
         "returns": "Promise<LatestVersion>",
         "tags": [
+          {
+            "name": "param",
+            "text": "options Optional {@link GetLatestOptions} to specify which channel to check."
+          },
           {
             "name": "returns",
-            "text": "A Promise resolved when url is loaded"
+            "text": "Information about the latest available bundle version."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the request fails or the server returns an error."
           },
           {
             "name": "since",
             "text": "4.0.0"
           }
         ],
-        "docs": "Get Latest bundle available from update Url",
+        "docs": "Check the update server for the latest available bundle version.\n\nThis queries your configured update URL (or Capgo backend) to see if a newer bundle\nis available for download. It does NOT download the bundle automatically.\n\nThe response includes:\n- `version`: The latest available version identifier\n- `url`: Download URL for the bundle (if available)\n- `breaking`: Whether this update is marked as incompatible (requires native app update)\n- `message`: Optional message from the server\n- `manifest`: File list for partial updates (if using multi-file downloads)\n\nAfter receiving the latest version info, you can:\n1. Compare it with your current version\n2. Download it using {@link download}\n3. Apply it using {@link next} or {@link set}",
         "complexTypes": [
           "LatestVersion",
           "GetLatestOptions"
@@ -497,7 +512,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Is the {@link SetChannelOptions} channel to set",
+            "docs": "The {@link SetChannelOptions} containing the channel name and optional auto-update trigger.",
             "type": "SetChannelOptions"
           }
         ],
@@ -505,22 +520,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options Is the {@link SetChannelOptions} channel to set"
+            "text": "options The {@link SetChannelOptions} containing the channel name and optional auto-update trigger."
           },
           {
             "name": "returns",
-            "text": "A Promise which is resolved when the new channel is set"
+            "text": "Channel operation result with status and optional error/message."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the channel doesn't exist or doesn't allow self-assignment."
           },
           {
             "name": "since",
             "text": "4.7.0"
           }
         ],
-        "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.\nThis method is to set the channel after the app is ready, and user interacted.\nIf you want to set the channel at boot, use the {@link PluginsConfig} to set the default channel.\nThis 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.",
+        "docs": "Assign this device to a specific update channel at runtime.\n\nChannels allow you to distribute different bundle versions to different groups of users\n(e.g., \"production\", \"beta\", \"staging\"). This method switches the device to a new channel.\n\n**Requirements:**\n- The target channel must allow self-assignment (configured in your Capgo dashboard or backend)\n- The backend may accept or reject the request based on channel settings\n\n**When to use:**\n- After the app is ready and the user has interacted (e.g., opted into beta program)\n- To implement in-app channel switching (beta toggle, tester access, etc.)\n- For user-driven channel changes\n\n**When NOT to use:**\n- At app boot/initialization - use {@link PluginsConfig.CapacitorUpdater.defaultChannel} config instead\n- Before user interaction\n\nThis sends a request to the Capgo backend linking your device ID to the specified channel.",
         "complexTypes": [
           "ChannelRes",
           "SetChannelOptions"
@@ -539,20 +554,28 @@
         ],
         "returns": "Promise<void>",
         "tags": [
+          {
+            "name": "param",
+            "text": "options"
+          },
+          {
+            "name": "link",
+            "text": "UnsetChannelOptions} containing optional auto-update trigger."
+          },
           {
             "name": "returns",
-            "text": "A Promise resolved when channel is set"
+            "text": "Resolves when the channel is successfully unset."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "4.7.0"
           }
         ],
-        "docs": "Unset the channel for this device. The device will then return to the default channel",
+        "docs": "Remove the device's channel assignment and return to the default channel.\n\nThis unlinks the device from any specifically assigned channel, causing it to fall back to:\n- The {@link PluginsConfig.CapacitorUpdater.defaultChannel} if configured, or\n- Your backend's default channel for this app\n\nUse this when:\n- Users opt out of beta/testing programs\n- You want to reset a device to standard update distribution\n- Testing channel switching behavior",
         "complexTypes": [
           "UnsetChannelOptions"
         ],
@@ -566,18 +589,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise that resolves with the channel info"
+            "text": "The current channel information."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "4.8.0"
           }
         ],
-        "docs": "Get the channel for this device",
+        "docs": "Get the current channel assigned to this device.\n\nReturns information about:\n- `channel`: The currently assigned channel name (if any)\n- `allowSet`: Whether the channel allows self-assignment\n- `status`: Operation status\n- `error`/`message`: Additional information (if applicable)\n\nUse this to:\n- Display current channel to users (e.g., \"You're on the Beta channel\")\n- Check if a device is on a specific channel before showing features\n- Verify channel assignment after calling {@link setChannel}",
         "complexTypes": [
           "GetChannelRes"
         ],
@@ -591,18 +614,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise that resolves with the available channels"
+            "text": "List of channels the device can self-assign to."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails or the request to the backend fails."
           },
           {
             "name": "since",
             "text": "7.5.0"
           }
         ],
-        "docs": "List all channels available for this device that allow self-assignment",
+        "docs": "Get a list of all channels available for this device to self-assign to.\n\nOnly returns channels where `allow_self_set` is `true`. These are channels that\nusers can switch to using {@link setChannel} without backend administrator intervention.\n\nEach channel includes:\n- `id`: Unique channel identifier\n- `name`: Human-readable channel name\n- `public`: Whether the channel is publicly visible\n- `allow_self_set`: Always `true` in results (filtered to only self-assignable channels)\n\nUse this to:\n- Build a channel selector UI for users (e.g., \"Join Beta\" button)\n- Show available testing/preview channels\n- Implement channel discovery features",
         "complexTypes": [
           "ListChannelsResult"
         ],
@@ -614,7 +637,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "is the {@link SetCustomIdOptions} customId to set",
+            "docs": "The {@link SetCustomIdOptions} containing the custom identifier string.",
             "type": "SetCustomIdOptions"
           }
         ],
@@ -622,22 +645,22 @@
         "tags": [
           {
             "name": "param",
-            "text": "options is the {@link SetCustomIdOptions} customId to set"
+            "text": "options The {@link SetCustomIdOptions} containing the custom identifier string."
           },
           {
             "name": "returns",
-            "text": "an Promise resolved instantly"
+            "text": "Resolves immediately (synchronous operation)."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "4.9.0"
           }
         ],
-        "docs": "Set a custom ID for this device\n\nWhen {@link PluginsConfig.CapacitorUpdater.persistCustomId} is true, the value will be stored natively and restored on the next app launch.\nPass an empty string to remove any previously stored customId.",
+        "docs": "Set a custom identifier for this device.\n\nThis allows you to identify devices by your own custom ID (user ID, account ID, etc.)\ninstead of or in addition to the device's unique hardware ID. The custom ID is sent\nto your update server and can be used for:\n- Targeting specific users for updates\n- Analytics and user tracking\n- Debugging and support (correlating devices with users)\n- A/B testing or feature flagging\n\n**Persistence:**\n- When {@link PluginsConfig.CapacitorUpdater.persistCustomId} is `true`, the ID persists across app restarts\n- When `false`, the ID is only kept for the current session\n\n**Clearing the custom ID:**\n- Pass an empty string `\"\"` to remove any stored custom ID",
         "complexTypes": [
           "SetCustomIdOptions"
         ],
@@ -651,14 +674,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise with version for this device"
+            "text": "The builtin bundle version string."
           },
           {
             "name": "since",
             "text": "5.2.0"
           }
         ],
-        "docs": "Get the native app version or the builtin version if set in config",
+        "docs": "Get the builtin bundle version (the original version shipped with your native app).\n\nThis returns the version of the bundle that was included when the app was installed\nfrom the App Store or Play Store. This is NOT the currently active bundle version -\nuse {@link current} for that.\n\nReturns:\n- The {@link PluginsConfig.CapacitorUpdater.version} config value if set, or\n- The native app version from platform configs (package.json, Info.plist, build.gradle)\n\nUse this to:\n- Display the \"factory\" version to users\n- Compare against downloaded bundle versions\n- Determine if any updates have been applied\n- Debugging version mismatches",
         "complexTypes": [
           "BuiltinVersion"
         ],
@@ -672,14 +695,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise with id for this device"
+            "text": "The unique device identifier string."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get unique ID used to identify device (sent to auto update server).\n\nThis ID is privacy-friendly and follows Apple and Google best practices:\n- Generated as a UUID and stored securely\n- Android: Uses Android Keystore (persists across reinstalls on API 23+)\n- iOS: Uses Keychain with kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly (persists across reinstalls)\n- Data stays on device (not synced to cloud on iOS)\n- Can be cleared by user via system settings (Android) or keychain access (iOS)\n\nThe device ID now persists between app reinstalls to maintain consistent device identity.",
+        "docs": "Get the unique, privacy-friendly identifier for this device.\n\nThis ID is used to identify the device when communicating with update servers.\nIt's automatically generated and stored securely by the plugin.\n\n**Privacy & Security characteristics:**\n- Generated as a UUID (not based on hardware identifiers)\n- Stored securely in platform-specific secure storage\n- Android: Android Keystore (persists across app reinstalls on API 23+)\n- iOS: Keychain with `kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly`\n- Not synced to cloud (iOS)\n- Follows Apple and Google privacy best practices\n- Users can clear it via system settings (Android) or keychain access (iOS)\n\n**Persistence:**\nThe device ID persists across app reinstalls to maintain consistent device identity\nfor update tracking and analytics.\n\nUse this to:\n- Debug update delivery issues (check what ID the server sees)\n- Implement device-specific features\n- Correlate server logs with specific devices",
         "complexTypes": [
           "DeviceId"
         ],
@@ -693,14 +716,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise with Plugin version"
+            "text": "The Capacitor Updater plugin version string."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get the native Capacitor Updater plugin version (sent to auto update server)",
+        "docs": "Get the version of the Capacitor Updater plugin installed in your app.\n\nThis returns the version of the native plugin code (Android/iOS), which is sent\nto the update server with each request. This is NOT your app version or bundle version.\n\nUse this to:\n- Debug plugin-specific issues (when reporting bugs)\n- Verify plugin installation and version\n- Check compatibility with backend features\n- Display in debug/about screens",
         "complexTypes": [
           "PluginVersion"
         ],
@@ -714,14 +737,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The status for auto update. Evaluates to `false` in manual mode."
+            "text": "`true` if auto-update is enabled, `false` if in manual mode."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get the state of auto update config.",
+        "docs": "Check if automatic updates are currently enabled.\n\nReturns `true` if {@link PluginsConfig.CapacitorUpdater.autoUpdate} is enabled,\nmeaning the plugin will automatically check for, download, and apply updates.\n\nReturns `false` if in manual mode, where you control the update flow using\n{@link getLatest}, {@link download}, {@link next}, and {@link set}.\n\nUse this to:\n- Determine which update flow your app is using\n- Show/hide manual update UI based on mode\n- Debug update behavior",
         "complexTypes": [
           "AutoUpdateEnabled"
         ],
@@ -733,12 +756,16 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [
+          {
+            "name": "returns",
+            "text": "Resolves when all listeners are removed."
+          },
           {
             "name": "since",
             "text": "1.0.0"
           }
         ],
-        "docs": "Remove all listeners for this plugin.",
+        "docs": "Remove all event listeners registered for this plugin.\n\nThis unregisters all listeners added via {@link addListener} for all event types:\n- `download`\n- `noNeedUpdate`\n- `updateAvailable`\n- `downloadComplete`\n- `downloadFailed`\n- `breakingAvailable` / `majorAvailable`\n- `updateFailed`\n- `appReloaded`\n- `appReady`\n\nUse this during cleanup (e.g., when unmounting components or closing screens)\nto prevent memory leaks from lingering event listeners.",
         "complexTypes": [],
         "slug": "removealllisteners"
       },
@@ -1043,14 +1070,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The availability status for auto update. Evaluates to `false` when serverUrl is set."
+            "text": "`false` when custom updateUrl is set, `true` otherwise."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           }
         ],
-        "docs": "Get if auto update is available (not disabled by serverUrl).",
+        "docs": "Check if the auto-update feature is available (not disabled by custom server configuration).\n\nReturns `false` when a custom `updateUrl` is configured, as this typically indicates\nyou're using a self-hosted update server that may not support all auto-update features.\n\nReturns `true` when using the default Capgo backend or when the feature is available.\n\nThis is different from {@link isAutoUpdateEnabled}:\n- `isAutoUpdateEnabled()`: Checks if auto-update MODE is turned on/off\n- `isAutoUpdateAvailable()`: Checks if auto-update is SUPPORTED with your current configuration",
         "complexTypes": [
           "AutoUpdateAvailable"
         ],
@@ -1064,18 +1091,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A Promise that resolves with the next bundle information or null"
+            "text": "The pending bundle info, or `null` if none is queued."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "6.8.0"
           }
         ],
-        "docs": "Get the next bundle that will be used when the app reloads.\nReturns null if no next bundle is set.",
+        "docs": "Get information about the bundle queued to be activated on next reload.\n\nReturns:\n- {@link BundleInfo} object if a bundle has been queued via {@link next}\n- `null` if no update is pending\n\nThis is useful to:\n- Check if an update is waiting to be applied\n- Display \"Update pending\" status to users\n- Show version info of the queued update\n- Decide whether to show a \"Restart to update\" prompt\n\nThe queued bundle will be activated when:\n- The app is backgrounded (default behavior)\n- The app is killed and restarted\n- {@link reload} is called manually\n- Delay conditions set by {@link setMultiDelay} are met",
         "complexTypes": [
           "BundleInfo"
         ],
@@ -1089,18 +1116,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The last failed update or null when no failure has been recorded. Value is cleared after it is returned once."
+            "text": "The failed update info (cleared after first retrieval), or `null`."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "7.22.0"
           }
         ],
-        "docs": "Get the most recent update that failed to install, if any. The stored value is cleared after it is retrieved once.",
+        "docs": "Retrieve information about the most recent bundle that failed to load.\n\nWhen a bundle fails to load (e.g., JavaScript errors prevent initialization, missing files),\nthe plugin automatically rolls back and stores information about the failure. This method\nretrieves that failure information.\n\n**IMPORTANT: The stored value is cleared after being retrieved once.**\nCalling this method multiple times will only return the failure info on the first call,\nthen `null` on subsequent calls until another failure occurs.\n\nReturns:\n- {@link UpdateFailedEvent} with bundle info if a failure was recorded\n- `null` if no failure has occurred or if it was already retrieved\n\nUse this to:\n- Show users why an update failed\n- Log failure information for debugging\n- Implement custom error handling/reporting\n- Display rollback notifications",
         "complexTypes": [
           "UpdateFailedEvent"
         ],
@@ -1112,7 +1139,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Contains enabled boolean to enable or disable shake menu",
+            "docs": "",
             "type": "SetShakeMenuOptions"
           }
         ],
@@ -1120,21 +1147,26 @@
         "tags": [
           {
             "name": "param",
-            "text": "options Contains enabled boolean to enable or disable shake menu"
+            "text": "options"
+          },
+          {
+            "name": "link",
+            "text": "SetShakeMenuOptions} with `enabled: true` to enable or `enabled: false` to disable."
           },
           {
-            "name": "returns"
+            "name": "returns",
+            "text": "Resolves when the setting is applied."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "7.5.0"
           }
         ],
-        "docs": "Enable or disable the shake menu for debugging/testing purposes",
+        "docs": "Enable or disable the shake gesture menu for debugging and testing.\n\nWhen enabled, users can shake their device to open a debug menu that shows:\n- Current bundle information\n- Available bundles\n- Options to switch bundles manually\n- Update status\n\nThis is useful during development and testing to:\n- Quickly test different bundle versions\n- Debug update flows\n- Switch between production and test bundles\n- Verify bundle installations\n\n**Important:** Disable this in production builds or only enable for internal testers.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.",
         "complexTypes": [
           "SetShakeMenuOptions"
         ],
@@ -1148,18 +1180,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The current state of shake menu"
+            "text": "Object with `enabled: true` or `enabled: false`."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "7.5.0"
           }
         ],
-        "docs": "Get the current state of the shake menu",
+        "docs": "Check if the shake gesture debug menu is currently enabled.\n\nReturns the current state of the shake menu feature that can be toggled via\n{@link setShakeMenu} or configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.\n\nUse this to:\n- Check if debug features are enabled\n- Show/hide debug settings UI\n- Verify configuration during testing",
         "complexTypes": [
           "ShakeMenuEnabled"
         ],
@@ -1173,18 +1205,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The current App ID"
+            "text": "Object containing the current `appId` string."
           },
           {
             "name": "throws",
-            "text": "{Error}"
+            "text": "{Error} If the operation fails."
           },
           {
             "name": "since",
             "text": "7.14.0"
           }
         ],
-        "docs": "Get the configured App ID",
+        "docs": "Get the currently configured App ID used for update server communication.\n\nReturns the App ID that identifies this app to the update server. This can be:\n- The value set via {@link setAppId}, or\n- The {@link PluginsConfig.CapacitorUpdater.appId} config value, or\n- The default app identifier from your native app configuration\n\nUse this to:\n- Verify which App ID is being used for updates\n- Debug update delivery issues\n- Display app configuration in debug screens\n- Confirm App ID after calling {@link setAppId}",
         "complexTypes": [
           "GetAppIdRes"
         ],
@@ -1196,7 +1228,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "The new App ID to set",
+            "docs": "",
             "type": "SetAppIdOptions"
           }
         ],
@@ -1204,21 +1236,26 @@
         "tags": [
           {
             "name": "param",
-            "text": "options The new App ID to set"
+            "text": "options"
           },
           {
-            "name": "returns"
+            "name": "link",
+            "text": "SetAppIdOptions} containing the new App ID string."
+          },
+          {
+            "name": "returns",
+            "text": "Resolves when the App ID is successfully changed."
           },
           {
             "name": "throws",
-            "text": "{Error} If allowModifyAppId is false or if the operation fails"
+            "text": "{Error} If `allowModifyAppId` is false or the operation fails."
           },
           {
             "name": "since",
             "text": "7.14.0"
           }
         ],
-        "docs": "Set the App ID for the app (requires allowModifyAppId to be true in config)",
+        "docs": "Dynamically change the App ID used for update server communication.\n\nThis overrides the App ID used to identify your app to the update server, allowing you\nto switch between different app configurations at runtime (e.g., production vs staging\napp IDs, or multi-tenant configurations).\n\n**Requirements:**\n- {@link PluginsConfig.CapacitorUpdater.allowModifyAppId} must be set to `true`\n\n**Important considerations:**\n- Changing the App ID will affect which updates this device receives\n- The new App ID must exist on your update server\n- This is primarily for advanced use cases (multi-tenancy, environment switching)\n- Most apps should use the config-based {@link PluginsConfig.CapacitorUpdater.appId} instead",
         "complexTypes": [
           "SetAppIdOptions"
         ],