@capgo/capacitor-updater 3.3.12 → 4.0.0-alpha.11

package/dist/docs.json

@@ -5,134 +5,180 @@
     "docs": "",
     "tags": [],
     "methods": [
+      {
+        "name": "notifyAppReady",
+        "signature": "() => Promise<BundleInfo>",
+        "parameters": [],
+        "returns": "Promise<BundleInfo>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise resolved directly"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          }
+        ],
+        "docs": "Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)",
+        "complexTypes": [
+          "BundleInfo"
+        ],
+        "slug": "notifyappready"
+      },
       {
         "name": "download",
-        "signature": "(options: { url: string; }) => Promise<{ version: string; }>",
+        "signature": "(options: { url: string; version?: string; }) => Promise<BundleInfo>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ url: string; }"
+            "type": "{ url: string; version?: string | undefined; }"
           }
         ],
-        "returns": "Promise<{ version: string; }>",
+        "returns": "Promise<BundleInfo>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with version name of the downloaded version, version is generated by the plugin, it's a random string of 10 char length"
+            "text": "The {@link BundleInfo} for the specified version."
+          },
+          {
+            "name": "param",
+            "text": "url The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a github tag, any other place you've hosted your bundle.)"
           },
           {
             "name": "param",
-            "text": "url The URL where download the version, it can be S3 github tag or whatever, it should be a zip file"
+            "text": "version (optional) set the version code/name of this bundle/version"
+          },
+          {
+            "name": "example",
+            "text": "https://example.com/versions/{version}/dist.zip"
           }
         ],
-        "docs": "Download a new version from the provided URL, it should be a zip file, with files inside or with a unique folder inside with all your files",
-        "complexTypes": [],
+        "docs": "Download a new version from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files",
+        "complexTypes": [
+          "BundleInfo"
+        ],
         "slug": "download"
       },
       {
-        "name": "set",
-        "signature": "(options: { version: string; versionName?: string; }) => Promise<void>",
+        "name": "next",
+        "signature": "(options: { id: string; }) => Promise<BundleInfo>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ version: string; versionName?: string | undefined; }"
+            "type": "{ id: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "Promise<BundleInfo>",
         "tags": [
           {
             "name": "returns",
-            "text": "an empty Promise when the version is set, if there are no index.html or no version folder throw an error"
+            "text": "The {@link BundleInfo} for the specified bundle id."
           },
           {
             "name": "param",
-            "text": "version The version name to set as current version"
+            "text": "id The bundle id to set as current, next time the app is reloaded. See {@link BundleInfo.id}"
+          },
+          {
+            "name": "throws",
+            "text": "An error if there are is no index.html file inside the version folder."
           }
         ],
-        "docs": "Set version as current version, set will return an error if there are is no index.html file inside the version folder. `versionName` is optional and it's a custom value that will be saved for you",
-        "complexTypes": [],
-        "slug": "set"
+        "docs": "Set the next bundle to be used when the app is reloaded.",
+        "complexTypes": [
+          "BundleInfo"
+        ],
+        "slug": "next"
       },
       {
-        "name": "getId",
-        "signature": "() => Promise<{ id: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ id: string; }>",
-        "tags": [
+        "name": "set",
+        "signature": "(options: { id: string; }) => Promise<void>",
+        "parameters": [
           {
-            "name": "returns",
-            "text": "an Promise with id for this device"
+            "name": "options",
+            "docs": "",
+            "type": "{ id: string; }"
           }
         ],
-        "docs": "Get unique ID used to identify device into auto update server",
-        "complexTypes": [],
-        "slug": "getid"
-      },
-      {
-        "name": "getPluginVersion",
-        "signature": "() => Promise<{ version: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ version: string; }>",
+        "returns": "Promise<void>",
         "tags": [
+          {
+            "name": "param",
+            "text": "id The bundle id to set as current. See {@link BundleInfo.id}"
+          },
           {
             "name": "returns",
-            "text": "an Promise with version for this device"
+            "text": "An empty promise."
+          },
+          {
+            "name": "throws",
+            "text": "An error if there are is no index.html file inside the version folder."
           }
         ],
-        "docs": "Get plugin version used in native code",
+        "docs": "Set the current bundle and immediately reloads the app.",
         "complexTypes": [],
-        "slug": "getpluginversion"
+        "slug": "set"
       },
       {
         "name": "delete",
-        "signature": "(options: { version: string; }) => Promise<void>",
+        "signature": "(options: { id: string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ version: string; }"
+            "type": "{ id: string; }"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
             "name": "returns",
-            "text": "an empty Promise when the version is delete, otherwise throw an error"
+            "text": "an empty Promise when the bundle is deleted"
           },
           {
             "name": "param",
-            "text": "version The version name to delete"
+            "text": "id The bundle id to delete (note, this is the bundle id, NOT the version name)"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
           }
         ],
-        "docs": "Delete version in storage",
+        "docs": "Delete bundle in storage",
         "complexTypes": [],
         "slug": "delete"
       },
       {
         "name": "list",
-        "signature": "() => Promise<{ versions: string[]; }>",
+        "signature": "() => Promise<{ bundles: BundleInfo[]; }>",
         "parameters": [],
-        "returns": "Promise<{ versions: string[]; }>",
+        "returns": "Promise<{ bundles: BundleInfo[]; }>",
         "tags": [
           {
             "name": "returns",
             "text": "an Promise witht the version list"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
           }
         ],
         "docs": "Get all available versions",
-        "complexTypes": [],
+        "complexTypes": [
+          "BundleInfo"
+        ],
         "slug": "list"
       },
       {
         "name": "reset",
-        "signature": "(options?: { toAutoUpdate?: boolean | undefined; } | undefined) => Promise<void>",
+        "signature": "(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ toAutoUpdate?: boolean | undefined; } | undefined"
+            "type": "{ toLastSuccessful?: boolean | undefined; } | undefined"
           }
         ],
         "returns": "Promise<void>",
@@ -143,7 +189,11 @@
           },
           {
             "name": "param",
-            "text": "toAutoUpdate [false] if yes it reset to to the last AutoUpdate version instead of `builtin`"
+            "text": "toLastSuccessful [false] if yes it reset to to the last successfully loaded bundle instead of `builtin`"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
           }
         ],
         "docs": "Set the `builtin` version (the one sent to Apple store / Google play store ) as current version",
@@ -152,17 +202,23 @@
       },
       {
         "name": "current",
-        "signature": "() => Promise<{ current: string; currentNative: string; }>",
+        "signature": "() => Promise<{ bundle: BundleInfo; native: string; }>",
         "parameters": [],
-        "returns": "Promise<{ current: string; currentNative: string; }>",
+        "returns": "Promise<{ bundle: BundleInfo; native: string; }>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with the current version name"
+            "text": "an Promise with the current bundle info"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
           }
         ],
-        "docs": "Get the current version, if none are set it returns `builtin`, currentNative is the original version install on the device",
-        "complexTypes": [],
+        "docs": "Get the current bundle, if none are set it returns `builtin`, currentNative is the original bundle installed on the device",
+        "complexTypes": [
+          "BundleInfo"
+        ],
         "slug": "current"
       },
       {
@@ -174,6 +230,10 @@
           {
             "name": "returns",
             "text": "an Promise resolved when the view is reloaded"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
           }
         ],
         "docs": "Reload the view",
@@ -181,64 +241,64 @@
         "slug": "reload"
       },
       {
-        "name": "versionName",
-        "signature": "() => Promise<{ versionName: string; }>",
-        "parameters": [],
-        "returns": "Promise<{ versionName: string; }>",
-        "tags": [
+        "name": "setDelay",
+        "signature": "(options: { delay: boolean; }) => Promise<void>",
+        "parameters": [
           {
-            "name": "returns",
-            "text": "an Promise witht the current versionName"
+            "name": "options",
+            "docs": "",
+            "type": "{ delay: boolean; }"
           }
         ],
-        "docs": "Get the version name, if it was set during the set phase",
-        "complexTypes": [],
-        "slug": "versionname"
-      },
-      {
-        "name": "notifyAppReady",
-        "signature": "() => Promise<void>",
-        "parameters": [],
         "returns": "Promise<void>",
         "tags": [
           {
             "name": "returns",
             "text": "an Promise resolved directly"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "4.0.0"
           }
         ],
-        "docs": "Notify native plugin that the update is working, only in auto-update",
+        "docs": "Set delay to skip updates in the next time the app goes into the background",
         "complexTypes": [],
-        "slug": "notifyappready"
+        "slug": "setdelay"
       },
       {
-        "name": "delayUpdate",
-        "signature": "() => Promise<void>",
-        "parameters": [],
-        "returns": "Promise<void>",
-        "tags": [
+        "name": "getLatest",
+        "signature": "(options: { delay: boolean; }) => Promise<latestVersion>",
+        "parameters": [
           {
-            "name": "returns",
-            "text": "an Promise resolved directly"
+            "name": "options",
+            "docs": "",
+            "type": "{ delay: boolean; }"
           }
         ],
-        "docs": "Skip updates in the next time the app goes into the background, only in auto-update",
-        "complexTypes": [],
-        "slug": "delayupdate"
-      },
-      {
-        "name": "cancelDelay",
-        "signature": "() => Promise<void>",
-        "parameters": [],
-        "returns": "Promise<void>",
+        "returns": "Promise<latestVersion>",
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise resolved directly"
+            "text": "an Promise resolved when url is loaded"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "4.0.0"
           }
         ],
-        "docs": "allow update in the next time the app goes into the background, only in auto-update",
-        "complexTypes": [],
-        "slug": "canceldelay"
+        "docs": "Get Latest version available from update Url",
+        "complexTypes": [
+          "latestVersion"
+        ],
+        "slug": "getlatest"
       },
       {
         "name": "addListener",
@@ -269,6 +329,35 @@
         ],
         "slug": "addlistenerdownload"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'downloadComplete', listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'downloadComplete'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "DownloadCompleteListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "since",
+            "text": "4.0.0"
+          }
+        ],
+        "docs": "Listen for download event in the App, let you know when the download is started, loading and finished",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DownloadCompleteListener"
+        ],
+        "slug": "addlistenerdownloadcomplete"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'majorAvailable', listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -300,17 +389,17 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'updateAvailable', listenerFunc: UpdateAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: 'updateFailed', listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
             "docs": "",
-            "type": "'updateAvailable'"
+            "type": "'updateFailed'"
           },
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "UpdateAvailableListener"
+            "type": "UpdateFailedListener"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -323,9 +412,66 @@
         "docs": "Listen for update event in the App, let you know when update is ready to install at next app start",
         "complexTypes": [
           "PluginListenerHandle",
-          "UpdateAvailableListener"
+          "UpdateFailedListener"
+        ],
+        "slug": "addlistenerupdatefailed"
+      },
+      {
+        "name": "getId",
+        "signature": "() => Promise<{ id: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ id: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise with id for this device"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          }
+        ],
+        "docs": "Get unique ID used to identify device (sent to auto update server)",
+        "complexTypes": [],
+        "slug": "getid"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise with version for this device"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          }
         ],
-        "slug": "addlistenerupdateavailable"
+        "docs": "Get the native Capacitor Updater plugin version (sent to auto update server)",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "isAutoUpdateEnabled",
+        "signature": "() => Promise<{ enabled: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ enabled: boolean; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The status for auto update."
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          }
+        ],
+        "docs": "Get the state of auto update config. This will return `false` in manual mode.",
+        "complexTypes": [],
+        "slug": "isautoupdateenabled"
       },
       {
         "name": "addListener",
@@ -364,15 +510,139 @@
     "properties": [],
     "importObject": [
       "PluginListenerHandle",
+      "\"@capacitor/cli\"",
       "DownloadEvent",
       "MajorAvailableEvent",
-      "UpdateAvailableEvent",
+      "DownloadCompleteEvent",
+      "UpdateFailedEvent",
+      "latestVersion",
+      "BundleInfo",
+      "BundleStatus",
       "DownloadChangeListener",
+      "DownloadCompleteListener",
       "MajorAvailableListener",
-      "UpdateAvailableListener"
+      "UpdateFailedListener"
     ]
   },
   "interfaces": [
+    {
+      "name": "BundleInfo",
+      "slug": "bundleinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "downloaded",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "BundleStatus"
+          ],
+          "type": "BundleStatus"
+        }
+      ],
+      "importObject": [
+        "PluginListenerHandle",
+        "\"@capacitor/cli\"",
+        "DownloadEvent",
+        "MajorAvailableEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleStatus",
+        "DownloadChangeListener",
+        "DownloadCompleteListener",
+        "MajorAvailableListener",
+        "UpdateFailedListener",
+        "CapacitorUpdaterPlugin"
+      ]
+    },
+    {
+      "name": "latestVersion",
+      "slug": "latestversion",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "4.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Res of getLatest method",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "major",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "old",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ],
+      "importObject": [
+        "PluginListenerHandle",
+        "\"@capacitor/cli\"",
+        "DownloadEvent",
+        "MajorAvailableEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "BundleInfo",
+        "BundleStatus",
+        "DownloadChangeListener",
+        "DownloadCompleteListener",
+        "MajorAvailableListener",
+        "UpdateFailedListener",
+        "CapacitorUpdaterPlugin"
+      ]
+    },
     {
       "name": "PluginListenerHandle",
       "slug": "pluginlistenerhandle",
@@ -412,22 +682,75 @@
           "name": "percent",
           "tags": [
             {
-              "text": "2.0.11",
+              "text": "4.0.0",
               "name": "since"
             }
           ],
           "docs": "Current status of download, between 0 and 100.",
           "complexTypes": [],
           "type": "number"
+        },
+        {
+          "name": "bundle",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
         }
       ],
       "importObject": [
         "PluginListenerHandle",
+        "\"@capacitor/cli\"",
         "MajorAvailableEvent",
-        "UpdateAvailableEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
         "DownloadChangeListener",
+        "DownloadCompleteListener",
         "MajorAvailableListener",
-        "UpdateAvailableListener",
+        "UpdateFailedListener",
+        "CapacitorUpdaterPlugin"
+      ]
+    },
+    {
+      "name": "DownloadCompleteEvent",
+      "slug": "downloadcompleteevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [
+            {
+              "text": "4.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Emit when a new update is available.",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        }
+      ],
+      "importObject": [
+        "PluginListenerHandle",
+        "\"@capacitor/cli\"",
+        "DownloadEvent",
+        "MajorAvailableEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
+        "DownloadChangeListener",
+        "DownloadCompleteListener",
+        "MajorAvailableListener",
+        "UpdateFailedListener",
         "CapacitorUpdaterPlugin"
       ]
     },
@@ -442,7 +765,7 @@
           "name": "version",
           "tags": [
             {
-              "text": "2.3.0",
+              "text": "4.0.0",
               "name": "since"
             }
           ],
@@ -453,47 +776,84 @@
       ],
       "importObject": [
         "PluginListenerHandle",
+        "\"@capacitor/cli\"",
         "DownloadEvent",
-        "UpdateAvailableEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
         "DownloadChangeListener",
+        "DownloadCompleteListener",
         "MajorAvailableListener",
-        "UpdateAvailableListener",
+        "UpdateFailedListener",
         "CapacitorUpdaterPlugin"
       ]
     },
     {
-      "name": "UpdateAvailableEvent",
-      "slug": "updateavailableevent",
+      "name": "UpdateFailedEvent",
+      "slug": "updatefailedevent",
       "docs": "",
       "tags": [],
       "methods": [],
       "properties": [
         {
-          "name": "version",
+          "name": "bundle",
           "tags": [
             {
-              "text": "3.0.0",
+              "text": "4.0.0",
               "name": "since"
             }
           ],
-          "docs": "Emit when a new update is available.",
-          "complexTypes": [],
-          "type": "string"
+          "docs": "Emit when a update failed to install.",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
         }
       ],
       "importObject": [
         "PluginListenerHandle",
+        "\"@capacitor/cli\"",
         "DownloadEvent",
         "MajorAvailableEvent",
+        "DownloadCompleteEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
         "DownloadChangeListener",
+        "DownloadCompleteListener",
         "MajorAvailableListener",
-        "UpdateAvailableListener",
+        "UpdateFailedListener",
         "CapacitorUpdaterPlugin"
       ]
     }
   ],
   "enums": [],
   "typeAliases": [
+    {
+      "name": "BundleStatus",
+      "slug": "bundlestatus",
+      "docs": "",
+      "types": [
+        {
+          "text": "'success'",
+          "complexTypes": []
+        },
+        {
+          "text": "'error'",
+          "complexTypes": []
+        },
+        {
+          "text": "'pending'",
+          "complexTypes": []
+        },
+        {
+          "text": "'downloading'",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "DownloadChangeListener",
       "slug": "downloadchangelistener",
@@ -507,6 +867,19 @@
         }
       ]
     },
+    {
+      "name": "DownloadCompleteListener",
+      "slug": "downloadcompletelistener",
+      "docs": "",
+      "types": [
+        {
+          "text": "(state: DownloadCompleteEvent): void",
+          "complexTypes": [
+            "DownloadCompleteEvent"
+          ]
+        }
+      ]
+    },
     {
       "name": "MajorAvailableListener",
       "slug": "majoravailablelistener",
@@ -521,18 +894,138 @@
       ]
     },
     {
-      "name": "UpdateAvailableListener",
-      "slug": "updateavailablelistener",
+      "name": "UpdateFailedListener",
+      "slug": "updatefailedlistener",
       "docs": "",
       "types": [
         {
-          "text": "(state: UpdateAvailableEvent): void",
+          "text": "(state: UpdateFailedEvent): void",
           "complexTypes": [
-            "UpdateAvailableEvent"
+            "UpdateFailedEvent"
           ]
         }
       ]
     }
   ],
-  "pluginConfigs": []
+  "pluginConfigs": [
+    {
+      "name": "CapacitorUpdater",
+      "slug": "capacitorupdater",
+      "properties": [
+        {
+          "name": "appReadyTimeout",
+          "tags": [
+            {
+              "text": "10000 // (10 seconds)",
+              "name": "default"
+            },
+            {
+              "text": "1000 // (1 second)",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "autoDeleteFailed",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "autoDeletePrevious",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "autoUpdate",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "updateUrl",
+          "tags": [
+            {
+              "text": "https://capgo.app/api/auto_update",
+              "name": "default"
+            },
+            {
+              "text": "https://example.com/api/auto_update",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure the URL / endpoint to which update checks are sent. \n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "resetWhenUpdate",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Automatically delete previous downloaded bundles when a newer native app version is installed to the device.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "statsUrl",
+          "tags": [
+            {
+              "text": "https://capgo.app/api/stats",
+              "name": "default"
+            },
+            {
+              "text": "https://example.com/api/stats",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure the URL / endpoint to which update statistics are sent. \n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ],
+      "docs": "These configuration values are available:"
+    }
+  ]
 }