@capgo/capacitor-updater 6.38.0 → 6.40.0

package/dist/docs.json

@@ -1091,6 +1091,35 @@
         ],
         "slug": "addlistenerchannelprivate-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'onFlexibleUpdateStateChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(state: FlexibleUpdateState) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Listen for flexible update state changes on Android.\n\nThis event fires during the flexible update download process, providing:\n- Download progress (bytes downloaded / total bytes)\n- Installation status changes\n\n**Install status values:**\n- `UNKNOWN` (0): Unknown status\n- `PENDING` (1): Download pending\n- `DOWNLOADING` (2): Download in progress\n- `INSTALLING` (3): Installing the update\n- `INSTALLED` (4): Update installed (app restart needed)\n- `FAILED` (5): Update failed\n- `CANCELED` (6): Update was canceled\n- `DOWNLOADED` (11): Download complete, ready to install\n\nWhen status is `DOWNLOADED`, you should prompt the user and call\n{@link completeFlexibleUpdate} to finish the installation.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "FlexibleUpdateState"
+        ],
+        "slug": "addlisteneronflexibleupdatestatechange-"
+      },
       {
         "name": "isAutoUpdateAvailable",
         "signature": "() => Promise<AutoUpdateAvailable>",
@@ -1289,6 +1318,150 @@
           "SetAppIdOptions"
         ],
         "slug": "setappid"
+      },
+      {
+        "name": "getAppUpdateInfo",
+        "signature": "(options?: GetAppUpdateInfoOptions | undefined) => Promise<AppUpdateInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Optional {@link GetAppUpdateInfoOptions} with country code for iOS.",
+            "type": "GetAppUpdateInfoOptions | undefined"
+          }
+        ],
+        "returns": "Promise<AppUpdateInfo>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Optional {@link GetAppUpdateInfoOptions} with country code for iOS."
+          },
+          {
+            "name": "returns",
+            "text": "Information about the current and available app versions."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If the operation fails or store information is unavailable."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Get information about the app's availability in the App Store or Play Store.\n\nThis method checks the native app stores to see if a newer version of the app\nis available for download. This is different from Capgo's OTA updates - this\nchecks for native app updates that require going through the app stores.\n\n**Platform differences:**\n- **Android**: Uses Play Store's In-App Updates API for accurate update information\n- **iOS**: Queries the App Store lookup API (requires country code for accurate results)\n\n**Returns information about:**\n- Current installed version\n- Available version in the store (if any)\n- Whether an update is available\n- Update priority (Android only)\n- Whether immediate/flexible updates are allowed (Android only)\n\nUse this to:\n- Check if users need to update from the app store\n- Show \"Update Available\" prompts for native updates\n- Implement version gating (require minimum native version)\n- Combine with Capgo OTA updates for a complete update strategy",
+        "complexTypes": [
+          "AppUpdateInfo",
+          "GetAppUpdateInfoOptions"
+        ],
+        "slug": "getappupdateinfo"
+      },
+      {
+        "name": "openAppStore",
+        "signature": "(options?: OpenAppStoreOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Optional {@link OpenAppStoreOptions} to customize which app's store page to open.",
+            "type": "OpenAppStoreOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Optional {@link OpenAppStoreOptions} to customize which app's store page to open."
+          },
+          {
+            "name": "returns",
+            "text": "Resolves when the store is opened."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If the store cannot be opened."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Open the app's page in the App Store or Play Store.\n\nThis navigates the user to your app's store listing where they can manually\nupdate the app. Use this as a fallback when in-app updates are not available\nor when the user needs to update on iOS.\n\n**Platform behavior:**\n- **Android**: Opens Play Store to the app's page\n- **iOS**: Opens App Store to the app's page\n\n**Customization options:**\n- `appId`: Specify a custom App Store ID (iOS) - useful for opening a different app's page\n- `packageName`: Specify a custom package name (Android) - useful for opening a different app's page",
+        "complexTypes": [
+          "OpenAppStoreOptions"
+        ],
+        "slug": "openappstore"
+      },
+      {
+        "name": "performImmediateUpdate",
+        "signature": "() => Promise<AppUpdateResult>",
+        "parameters": [],
+        "returns": "Promise<AppUpdateResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Result indicating success, cancellation, or failure."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If not on Android, no update is available, or immediate updates not allowed."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Perform an immediate in-app update on Android.\n\nThis triggers Google Play's immediate update flow, which:\n1. Shows a full-screen update UI\n2. Downloads and installs the update\n3. Restarts the app automatically\n\nThe user cannot continue using the app until the update is complete.\nThis is ideal for critical updates that must be installed immediately.\n\n**Requirements:**\n- Android only (throws error on iOS)\n- An update must be available (check with {@link getAppUpdateInfo} first)\n- The update must allow immediate updates (`immediateUpdateAllowed: true`)\n\n**User experience:**\n- Full-screen blocking UI\n- Progress shown during download\n- App automatically restarts after installation",
+        "complexTypes": [
+          "AppUpdateResult"
+        ],
+        "slug": "performimmediateupdate"
+      },
+      {
+        "name": "startFlexibleUpdate",
+        "signature": "() => Promise<AppUpdateResult>",
+        "parameters": [],
+        "returns": "Promise<AppUpdateResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Result indicating the update was started, cancelled, or failed."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If not on Android, no update is available, or flexible updates not allowed."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Start a flexible in-app update on Android.\n\nThis triggers Google Play's flexible update flow, which:\n1. Downloads the update in the background\n2. Allows the user to continue using the app\n3. Notifies when download is complete\n4. Requires calling {@link completeFlexibleUpdate} to install\n\nMonitor the download progress using the `onFlexibleUpdateStateChange` listener.\n\n**Requirements:**\n- Android only (throws error on iOS)\n- An update must be available (check with {@link getAppUpdateInfo} first)\n- The update must allow flexible updates (`flexibleUpdateAllowed: true`)\n\n**Typical flow:**\n1. Call `startFlexibleUpdate()` to begin download\n2. Listen to `onFlexibleUpdateStateChange` for progress\n3. When status is `DOWNLOADED`, prompt user to restart\n4. Call `completeFlexibleUpdate()` to install and restart",
+        "complexTypes": [
+          "AppUpdateResult"
+        ],
+        "slug": "startflexibleupdate"
+      },
+      {
+        "name": "completeFlexibleUpdate",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Resolves when the update installation begins (app will restart)."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If not on Android or no downloaded update is pending."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Complete a flexible in-app update on Android.\n\nAfter a flexible update has been downloaded (status `DOWNLOADED` in\n`onFlexibleUpdateStateChange`), call this method to install the update\nand restart the app.\n\n**Important:** This will immediately restart the app. Make sure to:\n- Save any user data before calling\n- Prompt the user before restarting\n- Only call when the download status is `DOWNLOADED`",
+        "complexTypes": [],
+        "slug": "completeflexibleupdate"
       }
     ],
     "properties": []
@@ -2341,6 +2514,58 @@
         }
       ]
     },
+    {
+      "name": "FlexibleUpdateState",
+      "slug": "flexibleupdatestate",
+      "docs": "State information for flexible update progress (Android only).",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "installStatus",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The current installation status.",
+          "complexTypes": [
+            "FlexibleUpdateInstallStatus"
+          ],
+          "type": "FlexibleUpdateInstallStatus"
+        },
+        {
+          "name": "bytesDownloaded",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of bytes downloaded so far.\nOnly available during the `DOWNLOADING` status.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "totalBytesToDownload",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Total number of bytes to download.\nOnly available during the `DOWNLOADING` status.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
     {
       "name": "AutoUpdateAvailable",
       "slug": "autoupdateavailable",
@@ -2420,641 +2645,450 @@
           "type": "string"
         }
       ]
-    }
-  ],
-  "enums": [],
-  "typeAliases": [
-    {
-      "name": "BundleStatus",
-      "slug": "bundlestatus",
-      "docs": "pending: The bundle is pending to be **SET** as the next bundle.\ndownloading: The bundle is being downloaded.\nsuccess: The bundle has been downloaded and is ready to be **SET** as the next bundle.\nerror: The bundle has failed to download.",
-      "types": [
-        {
-          "text": "'success'",
-          "complexTypes": []
-        },
-        {
-          "text": "'error'",
-          "complexTypes": []
-        },
-        {
-          "text": "'pending'",
-          "complexTypes": []
-        },
-        {
-          "text": "'downloading'",
-          "complexTypes": []
-        }
-      ]
-    },
-    {
-      "name": "DelayUntilNext",
-      "slug": "delayuntilnext",
-      "docs": "",
-      "types": [
-        {
-          "text": "'background'",
-          "complexTypes": []
-        },
-        {
-          "text": "'kill'",
-          "complexTypes": []
-        },
-        {
-          "text": "'nativeVersion'",
-          "complexTypes": []
-        },
-        {
-          "text": "'date'",
-          "complexTypes": []
-        }
-      ]
     },
     {
-      "name": "BreakingAvailableEvent",
-      "slug": "breakingavailableevent",
-      "docs": "Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.",
-      "types": [
+      "name": "AppUpdateInfo",
+      "slug": "appupdateinfo",
+      "docs": "Information about app updates available in the App Store or Play Store.",
+      "tags": [
         {
-          "text": "MajorAvailableEvent",
-          "complexTypes": [
-            "MajorAvailableEvent"
-          ]
+          "text": "8.0.0",
+          "name": "since"
         }
-      ]
-    }
-  ],
-  "pluginConfigs": [
-    {
-      "name": "CapacitorUpdater",
-      "slug": "capacitorupdater",
+      ],
+      "methods": [],
       "properties": [
         {
-          "name": "appReadyTimeout",
+          "name": "currentVersionName",
           "tags": [
             {
-              "text": "10000 // (10 seconds)",
-              "name": "default"
-            },
-            {
-              "text": "1000 // (1 second, minimum 1000)",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
+          "docs": "The currently installed version name (e.g., \"1.2.3\").",
           "complexTypes": [],
-          "type": "number | undefined"
+          "type": "string"
         },
         {
-          "name": "responseTimeout",
+          "name": "availableVersionName",
           "tags": [
             {
-              "text": "20 // (20 second)",
-              "name": "default"
-            },
-            {
-              "text": "10 // (10 second)",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the number of seconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
+          "docs": "The version name available in the store, if an update is available.\nMay be undefined if no update information is available.",
           "complexTypes": [],
-          "type": "number | undefined"
+          "type": "string | undefined"
         },
         {
-          "name": "autoDeleteFailed",
+          "name": "currentVersionCode",
           "tags": [
             {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "false",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
+          "docs": "The currently installed version code (Android) or build number (iOS).",
           "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "string"
         },
         {
-          "name": "autoDeletePrevious",
+          "name": "availableVersionCode",
           "tags": [
             {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "false",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
+          "docs": "The version code available in the store (Android only).\nOn iOS, this will be the same as `availableVersionName`.",
           "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "string | undefined"
         },
         {
-          "name": "autoUpdate",
+          "name": "availableVersionReleaseDate",
           "tags": [
             {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "false",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
+          "docs": "The release date of the available version (iOS only).\nFormat: ISO 8601 date string.",
           "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "string | undefined"
         },
         {
-          "name": "resetWhenUpdate",
+          "name": "updateAvailability",
           "tags": [
             {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "false",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\nSetting this to false can broke the auto update flow if the user download from the store a native app bundle that is older than the current downloaded bundle. Upload will be prevented by channel setting downgrade_under_native.\nOnly available for Android and iOS.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
-        },
+          "docs": "The current update availability status.",
+          "complexTypes": [
+            "AppUpdateAvailability"
+          ],
+          "type": "AppUpdateAvailability"
+        },
         {
-          "name": "updateUrl",
+          "name": "updatePriority",
           "tags": [
             {
-              "text": "https://plugin.capgo.app/updates",
-              "name": "default"
-            },
-            {
-              "text": "https://example.com/api/auto_update",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
+          "docs": "The priority of the update as set by the developer in Play Console (Android only).\nValues range from 0 (default/lowest) to 5 (highest priority).\n\nUse this to decide whether to show an update prompt or force an update.",
           "complexTypes": [],
-          "type": "string | undefined"
+          "type": "number | undefined"
         },
         {
-          "name": "channelUrl",
+          "name": "immediateUpdateAllowed",
           "tags": [
             {
-              "text": "https://plugin.capgo.app/channel_self",
-              "name": "default"
-            },
-            {
-              "text": "https://example.com/api/channel",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the URL / endpoint for channel operations.\n\nOnly available for Android and iOS.",
+          "docs": "Whether an immediate update is allowed (Android only).\n\nIf `true`, you can call {@link CapacitorUpdaterPlugin.performImmediateUpdate}.",
           "complexTypes": [],
-          "type": "string | undefined"
+          "type": "boolean | undefined"
         },
         {
-          "name": "statsUrl",
+          "name": "flexibleUpdateAllowed",
           "tags": [
             {
-              "text": "https://plugin.capgo.app/stats",
-              "name": "default"
-            },
-            {
-              "text": "https://example.com/api/stats",
-              "name": "example"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
+          "docs": "Whether a flexible update is allowed (Android only).\n\nIf `true`, you can call {@link CapacitorUpdaterPlugin.startFlexibleUpdate}.",
           "complexTypes": [],
-          "type": "string | undefined"
+          "type": "boolean | undefined"
         },
         {
-          "name": "privateKey",
+          "name": "clientVersionStalenessDays",
           "tags": [
             {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "Use publicKey instead",
-              "name": "deprecated"
+              "text": "8.0.0",
+              "name": "since"
             }
           ],
-          "docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS. Deprecated in version 6.2.0 in favor of publicKey.\nStill supported for backwards compatibility.",
+          "docs": "Number of days since the update became available (Android only).\n\nUse this to implement \"update nagging\" - remind users more frequently\nas the update ages.",
           "complexTypes": [],
-          "type": "string | undefined"
+          "type": "number | undefined"
         },
         {
-          "name": "publicKey",
+          "name": "installStatus",
           "tags": [
             {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "6.2.0",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Configure the public key for end to end live update encryption Version 2\n\nOnly available for Android and iOS.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "docs": "The current install status of a flexible update (Android only).",
+          "complexTypes": [
+            "FlexibleUpdateInstallStatus"
+          ],
+          "type": "FlexibleUpdateInstallStatus"
         },
         {
-          "name": "version",
+          "name": "minimumOsVersion",
           "tags": [
             {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Configure the current version of the app. This will be used for the first update request.\nIf not set, the plugin will get the version from the native code.\n\nOnly available for Android and iOS.",
+          "docs": "The minimum OS version required for the available update (iOS only).",
           "complexTypes": [],
           "type": "string | undefined"
-        },
+        }
+      ]
+    },
+    {
+      "name": "GetAppUpdateInfoOptions",
+      "slug": "getappupdateinfooptions",
+      "docs": "Options for {@link CapacitorUpdaterPlugin.getAppUpdateInfo}.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
         {
-          "name": "directUpdate",
+          "name": "country",
           "tags": [
             {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "5.1.0",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.\nWorks well for apps less than 10MB and with uploads done using --partial flag.\nZip or apps more than 10MB will be relatively slow for users to update.\n- false: Never do direct updates (use default behavior: download at start, set when backgrounded)\n- atInstall: Direct update only when app is installed, updated from store, otherwise act as directUpdate = false\n- onLaunch: Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false\n- always: Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false\n- true: (deprecated) Same as \"always\" for backward compatibility\n\nOnly available for Android and iOS.",
+          "docs": "Two-letter country code (ISO 3166-1 alpha-2) for the App Store lookup.\n\nThis is required on iOS to get accurate App Store information, as app\navailability and versions can vary by country.\n\nExamples: \"US\", \"GB\", \"DE\", \"JP\", \"FR\"\n\nOn Android, this option is ignored as the Play Store handles region\ndetection automatically.",
           "complexTypes": [],
-          "type": "boolean | 'always' | 'atInstall' | 'onLaunch' | undefined"
-        },
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OpenAppStoreOptions",
+      "slug": "openappstoreoptions",
+      "docs": "Options for {@link CapacitorUpdaterPlugin.openAppStore}.",
+      "tags": [
         {
-          "name": "autoSplashscreen",
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "packageName",
           "tags": [
             {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.6.0",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\nOnly works when directUpdate is set to \"atInstall\", \"always\", \"onLaunch\", or true.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\nRequires autoUpdate and directUpdate to be enabled.\n\nOnly available for Android and iOS.",
+          "docs": "The Android package name to open in the Play Store.\n\nIf not specified, uses the current app's package name.\nUse this to open a different app's store page.\n\nOnly used on Android.",
           "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "string | undefined"
         },
         {
-          "name": "autoSplashscreenLoader",
+          "name": "appId",
           "tags": [
             {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.19.0",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Display a native loading indicator on top of the splashscreen while automatic direct updates are running.\nOnly takes effect when {@link autoSplashscreen} is enabled.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n\nOnly available for Android and iOS.",
+          "docs": "The iOS App Store ID to open.\n\nIf not specified, uses the current app's bundle identifier to look up the app.\nUse this to open a different app's store page or when automatic lookup fails.\n\nOnly used on iOS.",
           "complexTypes": [],
-          "type": "boolean | undefined"
-        },
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AppUpdateResult",
+      "slug": "appupdateresult",
+      "docs": "Result of an app update operation.",
+      "tags": [
         {
-          "name": "autoSplashscreenTimeout",
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
           "tags": [
             {
-              "text": "10000 // (10 seconds)",
-              "name": "default"
-            },
-            {
-              "text": "7.19.0",
+              "text": "8.0.0",
               "name": "since"
             }
           ],
-          "docs": "Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.\nIf the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.\nSet to `0` (zero) to disable the timeout.\nWhen the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.\nRequires {@link autoSplashscreen} to be enabled.\n\nOnly available for Android and iOS.",
-          "complexTypes": [],
-          "type": "number | undefined"
+          "docs": "The result code of the update operation.",
+          "complexTypes": [
+            "AppUpdateResultCode"
+          ],
+          "type": "AppUpdateResultCode"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "FlexibleUpdateInstallStatus",
+      "slug": "flexibleupdateinstallstatus",
+      "members": [
+        {
+          "name": "UNKNOWN",
+          "value": "0",
+          "tags": [],
+          "docs": "Unknown install status."
         },
         {
-          "name": "periodCheckDelay",
-          "tags": [
-            {
-              "text": "0 (disabled)",
-              "name": "default"
-            },
-            {
-              "text": "3600 (1 hour)",
-              "name": "example"
-            },
-            {
-              "text": "86400 (24 hours)",
-              "name": "example"
-            }
-          ],
-          "docs": "Configure the delay period for period update check. the unit is in seconds.\n\nOnly available for Android and iOS.\nCannot be less than 600 seconds (10 minutes).",
-          "complexTypes": [],
-          "type": "number | undefined"
+          "name": "PENDING",
+          "value": "1",
+          "tags": [],
+          "docs": "Download is pending and will start soon."
         },
         {
-          "name": "localS3",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "DOWNLOADING",
+          "value": "2",
+          "tags": [],
+          "docs": "Download is in progress.\nCheck `bytesDownloaded` and `totalBytesToDownload` for progress."
         },
         {
-          "name": "localHost",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "INSTALLING",
+          "value": "3",
+          "tags": [],
+          "docs": "The update is being installed."
         },
         {
-          "name": "localWebHost",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "INSTALLED",
+          "value": "4",
+          "tags": [],
+          "docs": "The update has been installed.\nThe app needs to be restarted to use the new version."
         },
         {
-          "name": "localSupa",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "FAILED",
+          "value": "5",
+          "tags": [],
+          "docs": "The update failed to download or install."
         },
         {
-          "name": "localSupaAnon",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "4.17.48",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local server for testing.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "CANCELED",
+          "value": "6",
+          "tags": [],
+          "docs": "The update was canceled by the user."
         },
         {
-          "name": "localApi",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "6.3.3",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local api for testing.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "DOWNLOADED",
+          "value": "11",
+          "tags": [],
+          "docs": "The update has been downloaded and is ready to install.\nCall {@link CapacitorUpdaterPlugin.completeFlexibleUpdate} to install."
+        }
+      ]
+    },
+    {
+      "name": "AppUpdateAvailability",
+      "slug": "appupdateavailability",
+      "members": [
+        {
+          "name": "UNKNOWN",
+          "value": "0",
+          "tags": [],
+          "docs": "Update availability is unknown.\nThis typically means the check hasn't completed or failed."
         },
         {
-          "name": "localApiFiles",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "6.3.3",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the CLI to use a local file api for testing.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "UPDATE_NOT_AVAILABLE",
+          "value": "1",
+          "tags": [],
+          "docs": "No update is available.\nThe installed version is the latest."
         },
         {
-          "name": "allowModifyUrl",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "5.4.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "UPDATE_AVAILABLE",
+          "value": "2",
+          "tags": [],
+          "docs": "An update is available for download."
         },
         {
-          "name": "allowModifyAppId",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.14.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Allow the plugin to modify the appId dynamically from the JavaScript side.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "UPDATE_IN_PROGRESS",
+          "value": "3",
+          "tags": [],
+          "docs": "An update is currently being downloaded or installed."
+        }
+      ]
+    },
+    {
+      "name": "AppUpdateResultCode",
+      "slug": "appupdateresultcode",
+      "members": [
+        {
+          "name": "OK",
+          "value": "0",
+          "tags": [],
+          "docs": "The update completed successfully."
         },
         {
-          "name": "allowManualBundleError",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.20.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Allow marking bundles as errored from JavaScript while using manual update flows.\nWhen enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "CANCELED",
+          "value": "1",
+          "tags": [],
+          "docs": "The user canceled the update."
         },
         {
-          "name": "persistCustomId",
-          "tags": [
-            {
-              "text": "false (will be true by default in a future major release v8.x.x)",
-              "name": "default"
-            },
-            {
-              "text": "7.17.3",
-              "name": "since"
-            }
-          ],
-          "docs": "Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n\nOnly available for Android and iOS.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "FAILED",
+          "value": "2",
+          "tags": [],
+          "docs": "The update failed."
         },
         {
-          "name": "persistModifyUrl",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.20.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},\n{@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.\n\nOnly available for Android and iOS.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "NOT_AVAILABLE",
+          "value": "3",
+          "tags": [],
+          "docs": "No update is available."
         },
         {
-          "name": "allowSetDefaultChannel",
-          "tags": [
-            {
-              "text": "true",
-              "name": "default"
-            },
-            {
-              "text": "7.34.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Allow or disallow the {@link CapacitorUpdaterPlugin.setChannel} method to modify the defaultChannel.\nWhen set to `false`, calling `setChannel()` will return an error with code `disabled_by_config`.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "NOT_ALLOWED",
+          "value": "4",
+          "tags": [],
+          "docs": "The requested update type is not allowed.\nFor example, trying to perform an immediate update when only flexible is allowed."
         },
         {
-          "name": "defaultChannel",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "5.5.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Set the default channel for the app in the config. Case sensitive.\nThis will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.\nThis requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "INFO_MISSING",
+          "value": "5",
+          "tags": [],
+          "docs": "Required information is missing.\nThis can happen if {@link CapacitorUpdaterPlugin.getAppUpdateInfo} wasn't called first."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "BundleStatus",
+      "slug": "bundlestatus",
+      "docs": "pending: The bundle is pending to be **SET** as the next bundle.\ndownloading: The bundle is being downloaded.\nsuccess: The bundle has been downloaded and is ready to be **SET** as the next bundle.\nerror: The bundle has failed to download.",
+      "types": [
+        {
+          "text": "'success'",
+          "complexTypes": []
         },
         {
-          "name": "appId",
-          "tags": [
-            {
-              "text": "undefined",
-              "name": "default"
-            },
-            {
-              "text": "6.0.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the app id for the app in the config.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "text": "'error'",
+          "complexTypes": []
         },
         {
-          "name": "keepUrlPathAfterReload",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "6.8.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "text": "'pending'",
+          "complexTypes": []
         },
         {
-          "name": "disableJSLogging",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.3.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "text": "'downloading'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "DelayUntilNext",
+      "slug": "delayuntilnext",
+      "docs": "",
+      "types": [
+        {
+          "text": "'background'",
+          "complexTypes": []
         },
         {
-          "name": "shakeMenu",
-          "tags": [
-            {
-              "text": "false",
-              "name": "default"
-            },
-            {
-              "text": "7.5.0",
-              "name": "since"
-            }
-          ],
-          "docs": "Enable shake gesture to show update menu for debugging/testing purposes",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "text": "'kill'",
+          "complexTypes": []
+        },
+        {
+          "text": "'nativeVersion'",
+          "complexTypes": []
+        },
+        {
+          "text": "'date'",
+          "complexTypes": []
         }
-      ],
-      "docs": "CapacitorUpdater can be configured with these options:"
+      ]
+    },
+    {
+      "name": "BreakingAvailableEvent",
+      "slug": "breakingavailableevent",
+      "docs": "Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.",
+      "types": [
+        {
+          "text": "MajorAvailableEvent",
+          "complexTypes": [
+            "MajorAvailableEvent"
+          ]
+        }
+      ]
     }
-  ]
+  ],
+  "pluginConfigs": []
 }