@capawesome/cordova-live-update 0.1.0

package/dist/docs.json

@@ -0,0 +1,1654 @@
+{
+  "api": {
+    "name": "LiveUpdatePlugin",
+    "slug": "liveupdateplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "clearBlockedBundles",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Clear all blocked bundles from the blocked list.\n\nThis removes all bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.",
+        "complexTypes": [],
+        "slug": "clearblockedbundles"
+      },
+      {
+        "name": "deleteBundle",
+        "signature": "(options: DeleteBundleOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DeleteBundleOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Delete a bundle from the app.",
+        "complexTypes": [
+          "DeleteBundleOptions"
+        ],
+        "slug": "deletebundle"
+      },
+      {
+        "name": "downloadBundle",
+        "signature": "(options: DownloadBundleOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DownloadBundleOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Download a bundle.",
+        "complexTypes": [
+          "DownloadBundleOptions"
+        ],
+        "slug": "downloadbundle"
+      },
+      {
+        "name": "fetchChannels",
+        "signature": "(options?: FetchChannelsOptions | undefined) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "FetchChannelsOptions | undefined"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).\n\nThis is primarily intended for development and QA purposes.\nIt allows you to retrieve a list of available channels so you can\ndynamically switch between them using `setChannel(...)`.\n\n**Attention**: Only works for apps with public channels enabled.\nIf channels are private, they can still be set using `setChannel(...)`\nbut won't be returned by this method.",
+        "complexTypes": [
+          "FetchChannelsOptions",
+          "FetchChannelsResult"
+        ],
+        "slug": "fetchchannels"
+      },
+      {
+        "name": "fetchLatestBundle",
+        "signature": "(options?: FetchLatestBundleOptions | undefined) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "FetchLatestBundleOptions | undefined"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).",
+        "complexTypes": [
+          "FetchLatestBundleOptions",
+          "FetchLatestBundleResult"
+        ],
+        "slug": "fetchlatestbundle"
+      },
+      {
+        "name": "getBlockedBundles",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get all blocked bundle identifiers.\n\nReturns the list of bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.",
+        "complexTypes": [
+          "GetBlockedBundlesResult"
+        ],
+        "slug": "getblockedbundles"
+      },
+      {
+        "name": "getBundles",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          },
+          {
+            "name": "deprecated",
+            "text": "Use `getDownloadedBundles()` instead."
+          }
+        ],
+        "docs": "Get all identifiers of bundles that have been downloaded.",
+        "complexTypes": [
+          "GetBundlesResult"
+        ],
+        "slug": "getbundles"
+      },
+      {
+        "name": "getChannel",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the channel that is used for the update.\n\nThe channel is resolved in the following order (highest priority first):\n1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)\n2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or\n   `capawesome_live_update_default_channel` in `strings.xml` on Android)\n3. The `DEFAULT_CHANNEL` preference in `config.xml`\n\n**Note**: The `channel` parameter of `sync()` takes the highest priority\nbut is not persisted and therefore not returned by this method.",
+        "complexTypes": [
+          "GetChannelResult"
+        ],
+        "slug": "getchannel"
+      },
+      {
+        "name": "getConfig",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the runtime configuration.\n\nReturns the current plugin configuration including any runtime\noverrides set via `setConfig()`.",
+        "complexTypes": [
+          "GetConfigResult"
+        ],
+        "slug": "getconfig"
+      },
+      {
+        "name": "getDownloadedBundles",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get all identifiers of bundles that have been downloaded.",
+        "complexTypes": [
+          "GetDownloadedBundlesResult"
+        ],
+        "slug": "getdownloadedbundles"
+      },
+      {
+        "name": "getCurrentBundle",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the bundle identifier of the current bundle.\nThe current bundle is the bundle that is currently used by the app.",
+        "complexTypes": [
+          "GetCurrentBundleResult"
+        ],
+        "slug": "getcurrentbundle"
+      },
+      {
+        "name": "getCustomId",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the custom identifier of the device.",
+        "complexTypes": [
+          "GetCustomIdResult"
+        ],
+        "slug": "getcustomid"
+      },
+      {
+        "name": "getDeviceId",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the unique device identifier.",
+        "complexTypes": [
+          "GetDeviceIdResult"
+        ],
+        "slug": "getdeviceid"
+      },
+      {
+        "name": "isSyncing",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether a sync operation is currently in progress.",
+        "complexTypes": [
+          "IsSyncingResult"
+        ],
+        "slug": "issyncing"
+      },
+      {
+        "name": "getNextBundle",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the bundle identifier of the next bundle.\nThe next bundle is the bundle that will be used after calling `reload()`\nor restarting the app.",
+        "complexTypes": [
+          "GetNextBundleResult"
+        ],
+        "slug": "getnextbundle"
+      },
+      {
+        "name": "getVersionCode",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the version code of the app.\n\nOn **Android**, this is the `versionCode` from `PackageInfo`.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.",
+        "complexTypes": [
+          "GetVersionCodeResult"
+        ],
+        "slug": "getversioncode"
+      },
+      {
+        "name": "getVersionName",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the version name of the app.\n\nOn **Android**, this is the `versionName` from `PackageInfo`.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.",
+        "complexTypes": [
+          "GetVersionNameResult"
+        ],
+        "slug": "getversionname"
+      },
+      {
+        "name": "ready",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.",
+        "complexTypes": [
+          "ReadyResult"
+        ],
+        "slug": "ready"
+      },
+      {
+        "name": "reload",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Reload the app to apply the new bundle.",
+        "complexTypes": [],
+        "slug": "reload"
+      },
+      {
+        "name": "reset",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Reset the app to the default bundle.\n\nCall `reload()` or restart the app to apply the changes.",
+        "complexTypes": [],
+        "slug": "reset"
+      },
+      {
+        "name": "resetConfig",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Reset the runtime configuration to the values from `config.xml`.\n\nThis clears any runtime configuration set via `setConfig()`.\nThe changes take effect immediately.",
+        "complexTypes": [],
+        "slug": "resetconfig"
+      },
+      {
+        "name": "setChannel",
+        "signature": "(options: SetChannelOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetChannelOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the channel to use for the update.",
+        "complexTypes": [
+          "SetChannelOptions"
+        ],
+        "slug": "setchannel"
+      },
+      {
+        "name": "setConfig",
+        "signature": "(options: SetConfigOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetConfigOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the runtime configuration.\n\nThis allows updating plugin configuration options at runtime.\nThe changes are persisted across app restarts and take effect immediately.\n\n**Important:** Runtime configuration is automatically reset to default values\nwhenever the native app is updated to a new version. This ensures that\nconfiguration from previous versions doesn't persist after an app update.",
+        "complexTypes": [
+          "SetConfigOptions"
+        ],
+        "slug": "setconfig"
+      },
+      {
+        "name": "setCustomId",
+        "signature": "(options: SetCustomIdOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetCustomIdOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the custom identifier of the device.",
+        "complexTypes": [
+          "SetCustomIdOptions"
+        ],
+        "slug": "setcustomid"
+      },
+      {
+        "name": "setNextBundle",
+        "signature": "(options: SetNextBundleOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetNextBundleOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the next bundle to use for the app.\n\nCall `reload()` or restart the app to apply the changes.",
+        "complexTypes": [
+          "SetNextBundleOptions"
+        ],
+        "slug": "setnextbundle"
+      },
+      {
+        "name": "sync",
+        "signature": "(options?: SyncOptions | undefined) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SyncOptions | undefined"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nCall `reload()` or restart the app to apply the changes.",
+        "complexTypes": [
+          "SyncOptions",
+          "SyncResult"
+        ],
+        "slug": "sync"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener) => any",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'downloadBundleProgress'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "DownloadBundleProgressListener"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Listen for the download progress of a bundle.",
+        "complexTypes": [
+          "DownloadBundleProgressListener",
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerdownloadbundleprogress-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => any",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'nextBundleSet'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "NextBundleSetListener"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.",
+        "complexTypes": [
+          "NextBundleSetListener",
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenernextbundleset-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "DeleteBundleOptions",
+      "slug": "deletebundleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle to delete.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "DownloadBundleOptions",
+      "slug": "downloadbundleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "artifactType",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'zip'",
+              "name": "default"
+            },
+            {
+              "text": "'manifest'",
+              "name": "example"
+            }
+          ],
+          "docs": "The artifact type of the bundle.",
+          "complexTypes": [],
+          "type": "'manifest' | 'zip' | undefined"
+        },
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle.\n\n**Attention**: The value `public` is reserved and cannot be used as a bundle identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The checksum of the self-hosted bundle as a SHA-256 hash\nin hex format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The signature of the self-hosted bundle as a signed SHA-256 hash\nin base64 format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'https://example.com/bundle.zip'",
+              "name": "example"
+            }
+          ],
+          "docs": "The URL of the bundle to download.\n\nFor the `zip` artifact type, the URL must point to a ZIP file.\nFor the `manifest` artifact type, the URL serves as the base URL\nto download the individual files. For example, if the URL is\n`https://example.com/download`, the plugin will download the file\nwith the href `index.html` from `https://example.com/download?href=index.html`.\n\nTo **verify the integrity** of the file, the server should return\na `X-Checksum` header with the SHA-256 hash in hex format.\n\nTo **verify the signature** of the file, the server should return\na `X-Signature` header with the signed SHA-256 hash in base64 format.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "FetchChannelsOptions",
+      "slug": "fetchchannelsoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "limit",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "50",
+              "name": "default"
+            }
+          ],
+          "docs": "The maximum number of channels to return.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "offset",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0",
+              "name": "default"
+            }
+          ],
+          "docs": "The number of channels to skip.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "query",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The query to filter channels by name.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "FetchChannelsResult",
+      "slug": "fetchchannelsresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channels",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The list of channels.",
+          "complexTypes": [
+            "Channel"
+          ],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "Channel",
+      "slug": "channel",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the channel.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the channel.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "FetchLatestBundleOptions",
+      "slug": "fetchlatestbundleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the channel where the latest bundle is fetched from.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "FetchLatestBundleResult",
+      "slug": "fetchlatestbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "artifactType",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The artifact type of the bundle.",
+          "complexTypes": [],
+          "type": "'manifest' | 'zip' | undefined"
+        },
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the latest bundle.\n\nOn Capawesome Cloud, this is the ID of the app build artifact.\n\nIf `null`, no bundle is available.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The checksum of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the checksum will be\nreturned as response header when downloading the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "customProperties",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "{ \"key\": \"value\" }",
+              "name": "example"
+            }
+          ],
+          "docs": "Custom properties that are associated with the latest bundle.",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; } | undefined"
+        },
+        {
+          "name": "downloadUrl",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The URL of the latest bundle to download.\nPass this URL to the `downloadBundle(...)` method to download the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The signature of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the signature will be\nreturned as response header when downloading the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetBlockedBundlesResult",
+      "slug": "getblockedbundlesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleIds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An array of unique identifiers of all blocked bundles.",
+          "complexTypes": [],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "GetBundlesResult",
+      "slug": "getbundlesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleIds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An array of unique identifiers of all available bundles.",
+          "complexTypes": [],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "GetChannelResult",
+      "slug": "getchannelresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'production'",
+              "name": "example"
+            }
+          ],
+          "docs": "The channel name.\n\nIf `null`, the app is using the default channel.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetConfigResult",
+      "slug": "getconfigresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
+              "name": "example"
+            }
+          ],
+          "docs": "The app ID used to identify the app.\n\nIf `null`, no app ID is configured.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "autoUpdateStrategy",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'background'",
+              "name": "example"
+            }
+          ],
+          "docs": "The auto-update strategy for live updates.",
+          "complexTypes": [],
+          "type": "'none' | 'background'"
+        }
+      ]
+    },
+    {
+      "name": "GetDownloadedBundlesResult",
+      "slug": "getdownloadedbundlesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleIds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An array of unique identifiers of all downloaded bundles.",
+          "complexTypes": [],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "GetCurrentBundleResult",
+      "slug": "getcurrentbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the current bundle.\n\nIf `null`, the default bundle is being used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetCustomIdResult",
+      "slug": "getcustomidresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "customId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'50d2a548-80b7-4dad-adc7-97c0e79d8a89'",
+              "name": "example"
+            }
+          ],
+          "docs": "The custom identifier of the device.\n\nIf `null`, no custom identifier is set.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetDeviceIdResult",
+      "slug": "getdeviceidresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deviceId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'50d2a548-80b7-4dad-adc7-97c0e79d8a89'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the device.\n\nOn iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\nThe value of this property is the same for apps that come from the same vendor running on the same device.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "IsSyncingResult",
+      "slug": "issyncingresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "syncing",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a sync operation is currently in progress.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "GetNextBundleResult",
+      "slug": "getnextbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the next bundle.\n\nIf `null`, the default bundle is being used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetVersionCodeResult",
+      "slug": "getversioncoderesult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "versionCode",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"1\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The version code of the app.\n\nOn **Android**, this is the `versionCode` from `PackageInfo`.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetVersionNameResult",
+      "slug": "getversionnameresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "versionName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"1.0.0\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The version name of the app.\n\nOn **Android**, this is the `versionName` from `PackageInfo`.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ReadyResult",
+      "slug": "readyresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "previousBundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the previous bundle used.\n\nIf `null`, the default bundle was used.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "currentBundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the current bundle used.\n\nIf `null`, the default bundle is being used.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "rollback",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether or not the app was reset to the default bundle.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SetChannelOptions",
+      "slug": "setchanneloptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The channel name.\n\nSet `null` to remove the channel.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "SetConfigOptions",
+      "slug": "setconfigoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
+              "name": "example"
+            }
+          ],
+          "docs": "The app ID used to identify the app.\n\nSet `null` to reset to the value from the `APP_ID` preference in `config.xml`.",
+          "complexTypes": [],
+          "type": "string | null | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SetCustomIdOptions",
+      "slug": "setcustomidoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "customId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The custom identifier of the device.\n\nSet `null` to remove the custom identifier.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "SetNextBundleOptions",
+      "slug": "setnextbundleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle to use.\n\nSet `null` to use the default bundle (same as calling `reset()`).",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "SyncOptions",
+      "slug": "syncoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the channel where the latest bundle is fetched from.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SyncResult",
+      "slug": "syncresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "nextBundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the next bundle to use.\n\nIf `null`, the app is up-to-date and no new bundle is available.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "DownloadBundleProgressEvent",
+      "slug": "downloadbundleprogressevent",
+      "docs": "Event that is triggered when the download progress of a bundle changes.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the bundle that is being downloaded.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "downloadedBytes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number of bytes that have been downloaded.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "progress",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The progress of the download in percent as a value between `0` and `1`.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "totalBytes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The total number of bytes to download.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "Handle returned from `addListener(...)`. Call `remove()` to detach the\nlistener.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => any"
+        }
+      ]
+    },
+    {
+      "name": "NextBundleSetEvent",
+      "slug": "nextbundlesetevent",
+      "docs": "Event that is triggered when a bundle is set as the next bundle.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle that is set as the next bundle.\n\nIf `null`, the default bundle will be used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "DownloadBundleProgressListener",
+      "slug": "downloadbundleprogresslistener",
+      "docs": "Listener for the download progress of a bundle.",
+      "types": [
+        {
+          "text": "(event: DownloadBundleProgressEvent): void",
+          "complexTypes": [
+            "DownloadBundleProgressEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "NextBundleSetListener",
+      "slug": "nextbundlesetlistener",
+      "docs": "Listener for when a bundle is set as the next bundle.",
+      "types": [
+        {
+          "text": "(event: NextBundleSetEvent): void",
+          "complexTypes": [
+            "NextBundleSetEvent"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}