@capawesome/capacitor-live-update 6.8.0 → 6.9.1

package/dist/esm/definitions.d.ts

@@ -1,3 +1,4 @@
+import type { PluginListenerHandle } from '@capacitor/core';
 declare module '@capacitor/cli' {
     interface PluginsConfig {
         LiveUpdate?: {
@@ -11,6 +12,21 @@ declare module '@capacitor/cli' {
              * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
              */
             appId?: string;
+            /**
+             * Whether or not to automatically block bundles that have been rolled back.
+             *
+             * When enabled, the plugin will automatically block bundles that caused a rollback
+             * (up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.
+             * Blocked bundles will be skipped in future sync operations.
+             *
+             * **Attention**: This option has no effect if `readyTimeout` is set to `0`.
+             *
+             * Only available on Android and iOS.
+             *
+             * @since 6.9.0
+             * @default false
+             */
+            autoBlockRolledBackBundles?: boolean;
             /**
              * Whether or not to automatically delete unused bundles.
              *
@@ -20,9 +36,29 @@ declare module '@capacitor/cli' {
              * @default false
              */
             autoDeleteBundles?: boolean;
+            /**
+             * The auto-update strategy for live updates.
+             *
+             * - `none`: Live updates will not be applied automatically.
+             * - `background`: Live updates will be automatically downloaded
+             * and applied in the background at app startup and when the app resumes
+             * (if the last check was more than 15 minutes ago).
+             *
+             * Only available on Android and iOS.
+             *
+             * @since 6.9.0
+             * @default 'none'
+             * @example 'background'
+             */
+            autoUpdateStrategy?: 'none' | 'background';
             /**
              * The default channel of the app.
              *
+             * This can be overridden by `setChannel()`, the `channel` parameter of `sync()`,
+             * or the native channel configuration
+             * (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`
+             * in `strings.xml` on Android).
+             *
              * @since 6.3.0
              * @example 'production'
              */
@@ -73,10 +109,31 @@ declare module '@capacitor/cli' {
              * @default true
              */
             resetOnUpdate?: boolean;
+            /**
+             * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.
+             *
+             * This option takes precedence over the `location` configuration option.
+             *
+             * @since 6.9.0
+             * @default 'api.cloud.capawesome.io'
+             * @example 'api.cloud.capawesome.eu'
+             */
+            serverDomain?: string;
         };
     }
 }
 export interface LiveUpdatePlugin {
+    /**
+     * Clear all blocked bundles from the blocked list.
+     *
+     * This removes all bundle identifiers that were automatically blocked
+     * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    clearBlockedBundles(): Promise<void>;
     /**
      * Delete a bundle from the app.
      *
@@ -93,6 +150,22 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     downloadBundle(options: DownloadBundleOptions): Promise<void>;
+    /**
+     * Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).
+     *
+     * This is primarily intended for development and QA purposes.
+     * It allows you to retrieve a list of available channels so you can
+     * dynamically switch between them using `setChannel(...)`.
+     *
+     * **Attention**: Only works for apps with public channels enabled.
+     * If channels are private, they can still be set using `setChannel(...)`
+     * but won't be returned by this method.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    fetchChannels(options?: FetchChannelsOptions): Promise<FetchChannelsResult>;
     /**
      * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).
      *
@@ -101,6 +174,17 @@ export interface LiveUpdatePlugin {
      * @since 6.6.0
      */
     fetchLatestBundle(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;
+    /**
+     * Get all blocked bundle identifiers.
+     *
+     * Returns the list of bundle identifiers that were automatically blocked
+     * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    getBlockedBundles(): Promise<GetBlockedBundlesResult>;
     /**
      * Get the active bundle identifier.
      *
@@ -116,16 +200,37 @@ export interface LiveUpdatePlugin {
      * Only available on Android and iOS.
      *
      * @since 5.0.0
+     * @deprecated Use `getDownloadedBundles()` instead.
      */
     getBundles(): Promise<GetBundlesResult>;
     /**
      * Get the channel that is used for the update.
      *
+     * The channel is resolved in the following order (highest priority first):
+     * 1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
+     * 2. Capacitor config `defaultChannel`
+     * 3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
+     *    `capawesome_live_update_default_channel` in `strings.xml` on Android)
+     *
+     * **Note**: The `channel` parameter of `sync()` takes the highest priority
+     * but is not persisted and therefore not returned by this method.
+     *
      * Only available on Android and iOS.
      *
      * @since 5.0.0
      */
     getChannel(): Promise<GetChannelResult>;
+    /**
+     * Get the runtime configuration.
+     *
+     * Returns the current plugin configuration including any runtime
+     * overrides set via `setConfig()`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    getConfig(): Promise<GetConfigResult>;
     /**
      * Get the bundle identifier of the current bundle.
      * The current bundle is the bundle that is currently used by the app.
@@ -151,6 +256,14 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     getDeviceId(): Promise<GetDeviceIdResult>;
+    /**
+     * Get all identifiers of bundles that have been downloaded.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    getDownloadedBundles(): Promise<GetDownloadedBundlesResult>;
     /**
      * Get the bundle identifier of the next bundle.
      * The next bundle is the bundle that will be used after calling `reload()`
@@ -177,6 +290,14 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     getVersionName(): Promise<GetVersionNameResult>;
+    /**
+     * Check whether a sync operation is currently in progress.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    isSyncing(): Promise<IsSyncingResult>;
     /**
      * Notify the plugin that the app is ready to use and no rollback is needed.
      *
@@ -187,7 +308,7 @@ export interface LiveUpdatePlugin {
      *
      * @since 5.0.0
      */
-    ready(): Promise<void>;
+    ready(): Promise<ReadyResult>;
     /**
      * Reload the app to apply the new bundle.
      *
@@ -206,6 +327,17 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     reset(): Promise<void>;
+    /**
+     * Reset the runtime configuration to the values from the Capacitor config file.
+     *
+     * This clears any runtime configuration set via `setConfig()`.
+     * The changes take effect immediately.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    resetConfig(): Promise<void>;
     /**
      * Set the next bundle to use for the app.
      *
@@ -225,6 +357,21 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     setChannel(options: SetChannelOptions): Promise<void>;
+    /**
+     * Set the runtime configuration.
+     *
+     * This allows updating plugin configuration options at runtime.
+     * The changes are persisted across app restarts and take effect immediately.
+     *
+     * **Important:** Runtime configuration is automatically reset to default values
+     * whenever the native app is updated to a new version. This ensures that
+     * configuration from previous versions doesn't persist after an app update.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    setConfig(options: SetConfigOptions): Promise<void>;
     /**
      * Set the custom identifier of the device.
      *
@@ -253,6 +400,46 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     sync(options?: SyncOptions): Promise<SyncResult>;
+    /**
+     * Listen for the download progress of a bundle.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    addListener(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener): Promise<PluginListenerHandle>;
+    /**
+     * Listen for when a bundle is set as the next bundle.
+     *
+     * This event is triggered whenever a bundle is set to be used on the next app restart,
+     * either through automatic updates or manual calls to `setNextBundle()`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener): Promise<PluginListenerHandle>;
+    /**
+     * Listen for when the app is reloaded.
+     *
+     * This event is triggered after the `reload()` method is called
+     * and the app has been reloaded.
+     *
+     * **Note:** To verify whether an update was successfully applied after a reload,
+     * use the `ready()` method instead. The `ready()` method provides detailed information
+     * about the current bundle, previous bundle, and whether a rollback occurred.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 6.9.0
+     */
+    addListener(eventName: 'reloaded', listenerFunc: ReloadedListener): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 6.9.0
+     */
+    removeAllListeners(): Promise<void>;
 }
 /**
  * @since 5.0.0
@@ -320,6 +507,59 @@ export interface DownloadBundleOptions {
      */
     url: string;
 }
+/**
+ * @since 6.9.0
+ */
+export interface FetchChannelsOptions {
+    /**
+     * The maximum number of channels to return.
+     *
+     * @since 6.9.0
+     * @default 50
+     */
+    limit?: number;
+    /**
+     * The number of channels to skip.
+     *
+     * @since 6.9.0
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * The query to filter channels by name.
+     *
+     * @since 6.9.0
+     */
+    query?: string;
+}
+/**
+ * @since 6.9.0
+ */
+export interface FetchChannelsResult {
+    /**
+     * The list of channels.
+     *
+     * @since 6.9.0
+     */
+    channels: Channel[];
+}
+/**
+ * @since 6.9.0
+ */
+export interface Channel {
+    /**
+     * The unique identifier of the channel.
+     *
+     * @since 6.9.0
+     */
+    id: string;
+    /**
+     * The name of the channel.
+     *
+     * @since 6.9.0
+     */
+    name: string;
+}
 /**
  * @since 6.7.0
  */
@@ -358,6 +598,15 @@ export interface FetchLatestBundleResult {
      * @since 6.8.0
      */
     checksum?: string;
+    /**
+     * Custom properties that are associated with the latest bundle.
+     *
+     * @since 6.9.0
+     * @example { "key": "value" }
+     */
+    customProperties?: {
+        [key: string]: string;
+    };
     /**
      * The URL of the latest bundle to download.
      * Pass this URL to the `downloadBundle(...)` method to download the bundle.
@@ -375,6 +624,17 @@ export interface FetchLatestBundleResult {
      */
     signature?: string;
 }
+/**
+ * @since 6.9.0
+ */
+export interface GetBlockedBundlesResult {
+    /**
+     * An array of unique identifiers of all blocked bundles.
+     *
+     * @since 6.9.0
+     */
+    bundleIds: string[];
+}
 /**
  * @since 5.0.0
  */
@@ -400,6 +660,17 @@ export interface GetBundlesResult {
      */
     bundleIds: string[];
 }
+/**
+ * @since 6.9.0
+ */
+export interface GetDownloadedBundlesResult {
+    /**
+     * An array of unique identifiers of all downloaded bundles.
+     *
+     * @since 6.9.0
+     */
+    bundleIds: string[];
+}
 /**
  * @since 5.0.0
  */
@@ -414,6 +685,27 @@ export interface GetChannelResult {
      */
     channel: string | null;
 }
+/**
+ * @since 6.9.0
+ */
+export interface GetConfigResult {
+    /**
+     * The app ID used to identify the app.
+     *
+     * If `null`, no app ID is configured.
+     *
+     * @since 6.9.0
+     * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
+     */
+    appId: string | null;
+    /**
+     * The auto-update strategy for live updates.
+     *
+     * @since 6.9.0
+     * @example 'background'
+     */
+    autoUpdateStrategy: 'none' | 'background';
+}
 /**
  * @since 6.7.0
  */
@@ -443,6 +735,17 @@ export interface GetDeviceIdResult {
      */
     deviceId: string;
 }
+/**
+ * @since 6.9.0
+ */
+export interface IsSyncingResult {
+    /**
+     * Whether a sync operation is currently in progress.
+     *
+     * @since 6.9.0
+     */
+    syncing: boolean;
+}
 /**
  * @since 6.7.0
  */
@@ -500,6 +803,33 @@ export interface GetCustomIdResult {
      */
     customId: string | null;
 }
+/**
+ * @since 6.9.0
+ */
+export interface ReadyResult {
+    /**
+     * The identifier of the previous bundle used.
+     *
+     * If `null`, the default bundle was used.
+     *
+     * @since 6.9.0
+     */
+    previousBundleId: string | null;
+    /**
+     * The identifier of the current bundle used.
+     *
+     * If `null`, the default bundle is being used.
+     *
+     * @since 6.9.0
+     */
+    currentBundleId: string | null;
+    /**
+     * Whether or not the app was reset to the default bundle.
+     *
+     * @since 6.9.0
+     */
+    rollback: boolean;
+}
 /**
  * @since 5.0.0
  */
@@ -525,6 +855,20 @@ export interface SetChannelOptions {
      */
     channel: string | null;
 }
+/**
+ * @since 6.9.0
+ */
+export interface SetConfigOptions {
+    /**
+     * The app ID used to identify the app.
+     *
+     * Set `null` to reset to the value from the Capacitor config file.
+     *
+     * @since 6.9.0
+     * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
+     */
+    appId?: string | null;
+}
 /**
  * @since 5.0.0
  */
@@ -576,3 +920,69 @@ export interface SyncResult {
      */
     nextBundleId: string | null;
 }
+/**
+ * Listener for the download progress of a bundle.
+ *
+ * @since 6.9.0
+ */
+export declare type DownloadBundleProgressListener = (event: DownloadBundleProgressEvent) => void;
+/**
+ * Event that is triggered when the download progress of a bundle changes.
+ *
+ * @since 6.9.0
+ */
+export interface DownloadBundleProgressEvent {
+    /**
+     * The unique identifier of the bundle that is being downloaded.
+     *
+     * @since 6.9.0
+     */
+    bundleId: string;
+    /**
+     * The number of bytes that have been downloaded.
+     *
+     * @since 6.9.0
+     */
+    downloadedBytes: number;
+    /**
+     * The progress of the download in percent as a value between `0` and `1`.
+     *
+     * @since 6.9.0
+     * @example 0.5
+     */
+    progress: number;
+    /**
+     * The total number of bytes to download.
+     *
+     * @since 6.9.0
+     */
+    totalBytes: number;
+}
+/**
+ * Listener for when a bundle is set as the next bundle.
+ *
+ * @since 6.9.0
+ */
+export declare type NextBundleSetListener = (event: NextBundleSetEvent) => void;
+/**
+ * Event that is triggered when a bundle is set as the next bundle.
+ *
+ * @since 6.9.0
+ */
+export interface NextBundleSetEvent {
+    /**
+     * The unique identifier of the bundle that is set as the next bundle.
+     *
+     * If `null`, the default bundle will be used.
+     *
+     * @since 6.9.0
+     * @example '1.0.0'
+     */
+    bundleId: string | null;
+}
+/**
+ * Listener for when the app is reloaded.
+ *
+ * @since 6.9.0
+ */
+export declare type ReloadedListener = () => void;

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @deprecated This option will be removed in the future.\n       */\n      location?: 'us' | 'eu';\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.6.0\n   */\n  fetchLatestBundle(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `getCurrentBundle()` instead.\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel that is used for the update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the bundle identifier of the current bundle.\n   * The current bundle is the bundle that is currently used by the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getCurrentBundle(): Promise<GetCurrentBundleResult>;\n  /**\n   * Get the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the unique device identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the bundle identifier of the next bundle.\n   * The next bundle is the bundle that will be used after calling `reload()`\n   * or restarting the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getNextBundle(): Promise<GetNextBundleResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * 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\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<void>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `setNextBundle()` instead.\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel to use for the update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setChannel(options: SetChannelOptions): Promise<void>;\n  /**\n   * Set the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  setNextBundle(options: SetNextBundleOptions): Promise<void>;\n  /**\n   * Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  sync(options?: SyncOptions): Promise<SyncResult>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.6.0\n   * @default 'zip'\n   * @example 'manifest'\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the self-hosted bundle as a SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 6.1.0\n   */\n  checksum?: string;\n  /**\n   * The signature of the self-hosted bundle as a signed SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 6.8.0\n   */\n  signature?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * For the `zip` artifact type, the URL must point to a ZIP file.\n   * For the `manifest` artifact type, the URL serves as the base URL\n   * to download the individual files. For example, if the URL is\n   * `https://example.com/download`, the plugin will download the file\n   * with the href `index.html` from `https://example.com/download?href=index.html`.\n   *\n   * To **verify the integrity** of the file, the server must return\n   * a `X-Checksum` header with the SHA-256 hash in base64 format.\n   *\n   * To **verify the signature** of the file, the server must return\n   * a `X-Signature` header with the signed SHA-256 hash in base64 format.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 6.6.0\n */\nexport interface FetchLatestBundleResult {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.7.0\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the latest bundle.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * The checksum of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the checksum will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 6.8.0\n   */\n  checksum?: string;\n  /**\n   * The URL of the latest bundle to download.\n   * Pass this URL to the `downloadBundle(...)` method to download the bundle.\n   *\n   * @since 6.7.0\n   */\n  downloadUrl?: string;\n  /**\n   * The signature of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the signature will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 6.8.0\n   */\n  signature?: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundleResult {\n  /**\n   * The unique identifier of the active bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundlesResult {\n  /**\n   * An array of unique identifiers of all available bundles.\n   *\n   * @since 5.0.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetChannelResult {\n  /**\n   * The channel name.\n   *\n   * If `null`, the app is using the default channel.\n   *\n   * @since 5.0.0\n   * @example 'production'\n   */\n  channel: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface GetCurrentBundleResult {\n  /**\n   * The unique identifier of the current bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetDeviceIdResult {\n  /**\n   * The unique identifier of the device.\n   *\n   * On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\n   * The value of this property is the same for apps that come from the same vendor running on the same device.\n   *\n   * @since 5.0.0\n   *\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  deviceId: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface GetNextBundleResult {\n  /**\n   * The unique identifier of the next bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionCodeResult {\n  /**\n   * The version code of the app.\n   *\n   * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1\"\n   */\n  versionCode: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionNameResult {\n  /**\n   * The version name of the app.\n   *\n   * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1.0.0\"\n   */\n  versionName: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetCustomIdResult {\n  /**\n   * The custom identifier of the device.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel name.\n   *\n   * Set `null` to remove the channel.\n   *\n   * @since 5.0.0\n   */\n  channel: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetCustomIdOptions {\n  /**\n   * The custom identifier of the device.\n   *\n   * Set `null` to remove the custom identifier.\n   *\n   * @since 5.0.0\n   */\n  customId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SetNextBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * Set `null` to use the default bundle (same as calling `reset()`).\n   *\n   * @since 6.7.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SyncOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SyncResult {\n  /**\n   * The identifier of the next bundle to use.\n   *\n   * If `null`, the app is up-to-date and no new bundle is available.\n   *\n   * @since 5.0.0\n   */\n  nextBundleId: string | null;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from '@capacitor/core';\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * This is **NOT** the same as the app identifier (e.g. `com.example.app`).\n       * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n       *\n       * @since 5.0.0\n       * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically block bundles that have been rolled back.\n       *\n       * When enabled, the plugin will automatically block bundles that caused a rollback\n       * (up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.\n       * Blocked bundles will be skipped in future sync operations.\n       *\n       * **Attention**: This option has no effect if `readyTimeout` is set to `0`.\n       *\n       * Only available on Android and iOS.\n       *\n       * @since 6.9.0\n       * @default false\n       */\n      autoBlockRolledBackBundles?: boolean;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The auto-update strategy for live updates.\n       *\n       * - `none`: Live updates will not be applied automatically.\n       * - `background`: Live updates will be automatically downloaded\n       * and applied in the background at app startup and when the app resumes\n       * (if the last check was more than 15 minutes ago).\n       *\n       * Only available on Android and iOS.\n       *\n       * @since 6.9.0\n       * @default 'none'\n       * @example 'background'\n       */\n      autoUpdateStrategy?: 'none' | 'background';\n      /**\n       * The default channel of the app.\n       *\n       * This can be overridden by `setChannel()`, the `channel` parameter of `sync()`,\n       * or the native channel configuration\n       * (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`\n       * in `strings.xml` on Android).\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @deprecated This option will be removed in the future.\n       */\n      location?: 'us' | 'eu';\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n      /**\n       * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.\n       *\n       * This option takes precedence over the `location` configuration option.\n       *\n       * @since 6.9.0\n       * @default 'api.cloud.capawesome.io'\n       * @example 'api.cloud.capawesome.eu'\n       */\n      serverDomain?: string;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Clear all blocked bundles from the blocked list.\n   *\n   * This removes all bundle identifiers that were automatically blocked\n   * due to rollbacks when `autoBlockRolledBackBundles` is enabled.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  clearBlockedBundles(): Promise<void>;\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * This is primarily intended for development and QA purposes.\n   * It allows you to retrieve a list of available channels so you can\n   * dynamically switch between them using `setChannel(...)`.\n   *\n   * **Attention**: Only works for apps with public channels enabled.\n   * If channels are private, they can still be set using `setChannel(...)`\n   * but won't be returned by this method.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  fetchChannels(options?: FetchChannelsOptions): Promise<FetchChannelsResult>;\n  /**\n   * Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.6.0\n   */\n  fetchLatestBundle(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;\n  /**\n   * Get all blocked bundle identifiers.\n   *\n   * Returns the list of bundle identifiers that were automatically blocked\n   * due to rollbacks when `autoBlockRolledBackBundles` is enabled.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  getBlockedBundles(): Promise<GetBlockedBundlesResult>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `getCurrentBundle()` instead.\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `getDownloadedBundles()` instead.\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel that is used for the update.\n   *\n   * The channel is resolved in the following order (highest priority first):\n   * 1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)\n   * 2. Capacitor config `defaultChannel`\n   * 3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or\n   *    `capawesome_live_update_default_channel` in `strings.xml` on Android)\n   *\n   * **Note**: The `channel` parameter of `sync()` takes the highest priority\n   * but is not persisted and therefore not returned by this method.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the runtime configuration.\n   *\n   * Returns the current plugin configuration including any runtime\n   * overrides set via `setConfig()`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  getConfig(): Promise<GetConfigResult>;\n  /**\n   * Get the bundle identifier of the current bundle.\n   * The current bundle is the bundle that is currently used by the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getCurrentBundle(): Promise<GetCurrentBundleResult>;\n  /**\n   * Get the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the unique device identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  getDownloadedBundles(): Promise<GetDownloadedBundlesResult>;\n  /**\n   * Get the bundle identifier of the next bundle.\n   * The next bundle is the bundle that will be used after calling `reload()`\n   * or restarting the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  getNextBundle(): Promise<GetNextBundleResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * Check whether a sync operation is currently in progress.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  isSyncing(): Promise<IsSyncingResult>;\n  /**\n   * 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\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<ReadyResult>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Reset the runtime configuration to the values from the Capacitor config file.\n   *\n   * This clears any runtime configuration set via `setConfig()`.\n   * The changes take effect immediately.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  resetConfig(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   * @deprecated Use `setNextBundle()` instead.\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel to use for the update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setChannel(options: SetChannelOptions): Promise<void>;\n  /**\n   * Set the runtime configuration.\n   *\n   * This allows updating plugin configuration options at runtime.\n   * The changes are persisted across app restarts and take effect immediately.\n   *\n   * **Important:** Runtime configuration is automatically reset to default values\n   * whenever the native app is updated to a new version. This ensures that\n   * configuration from previous versions doesn't persist after an app update.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  setConfig(options: SetConfigOptions): Promise<void>;\n  /**\n   * Set the custom identifier of the device.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.7.0\n   */\n  setNextBundle(options: SetNextBundleOptions): Promise<void>;\n  /**\n   * Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  sync(options?: SyncOptions): Promise<SyncResult>;\n  /**\n   * Listen for the download progress of a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  addListener(\n    eventName: 'downloadBundleProgress',\n    listenerFunc: DownloadBundleProgressListener\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for when a bundle is set as the next bundle.\n   *\n   * This event is triggered whenever a bundle is set to be used on the next app restart,\n   * either through automatic updates or manual calls to `setNextBundle()`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener): Promise<PluginListenerHandle>;\n  /**\n   * Listen for when the app is reloaded.\n   *\n   * This event is triggered after the `reload()` method is called\n   * and the app has been reloaded.\n   *\n   * **Note:** To verify whether an update was successfully applied after a reload,\n   * use the `ready()` method instead. The `ready()` method provides detailed information\n   * about the current bundle, previous bundle, and whether a rollback occurred.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 6.9.0\n   */\n  addListener(eventName: 'reloaded', listenerFunc: ReloadedListener): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 6.9.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.6.0\n   * @default 'zip'\n   * @example 'manifest'\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the self-hosted bundle as a SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 6.1.0\n   */\n  checksum?: string;\n  /**\n   * The signature of the self-hosted bundle as a signed SHA-256 hash\n   * in base64 format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 6.8.0\n   */\n  signature?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * For the `zip` artifact type, the URL must point to a ZIP file.\n   * For the `manifest` artifact type, the URL serves as the base URL\n   * to download the individual files. For example, if the URL is\n   * `https://example.com/download`, the plugin will download the file\n   * with the href `index.html` from `https://example.com/download?href=index.html`.\n   *\n   * To **verify the integrity** of the file, the server must return\n   * a `X-Checksum` header with the SHA-256 hash in base64 format.\n   *\n   * To **verify the signature** of the file, the server must return\n   * a `X-Signature` header with the signed SHA-256 hash in base64 format.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: string;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface FetchChannelsOptions {\n  /**\n   * The maximum number of channels to return.\n   *\n   * @since 6.9.0\n   * @default 50\n   */\n  limit?: number;\n  /**\n   * The number of channels to skip.\n   *\n   * @since 6.9.0\n   * @default 0\n   */\n  offset?: number;\n  /**\n   * The query to filter channels by name.\n   *\n   * @since 6.9.0\n   */\n  query?: string;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface FetchChannelsResult {\n  /**\n   * The list of channels.\n   *\n   * @since 6.9.0\n   */\n  channels: Channel[];\n}\n\n/**\n * @since 6.9.0\n */\nexport interface Channel {\n  /**\n   * The unique identifier of the channel.\n   *\n   * @since 6.9.0\n   */\n  id: string;\n  /**\n   * The name of the channel.\n   *\n   * @since 6.9.0\n   */\n  name: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 6.6.0\n */\nexport interface FetchLatestBundleResult {\n  /**\n   * The artifact type of the bundle.\n   *\n   * @since 6.7.0\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the latest bundle.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * The checksum of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the checksum will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 6.8.0\n   */\n  checksum?: string;\n  /**\n   * Custom properties that are associated with the latest bundle.\n   *\n   * @since 6.9.0\n   * @example { \"key\": \"value\" }\n   */\n  customProperties?: { [key: string]: string };\n  /**\n   * The URL of the latest bundle to download.\n   * Pass this URL to the `downloadBundle(...)` method to download the bundle.\n   *\n   * @since 6.7.0\n   */\n  downloadUrl?: string;\n  /**\n   * The signature of the latest bundle if the bundle is self-hosted.\n   *\n   * If the bundle is hosted on Capawesome Cloud, the signature will be\n   * returned as response header when downloading the bundle.\n   *\n   * @since 6.8.0\n   */\n  signature?: string;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface GetBlockedBundlesResult {\n  /**\n   * An array of unique identifiers of all blocked bundles.\n   *\n   * @since 6.9.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundleResult {\n  /**\n   * The unique identifier of the active bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetBundlesResult {\n  /**\n   * An array of unique identifiers of all available bundles.\n   *\n   * @since 5.0.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 6.9.0\n */\nexport interface GetDownloadedBundlesResult {\n  /**\n   * An array of unique identifiers of all downloaded bundles.\n   *\n   * @since 6.9.0\n   */\n  bundleIds: string[];\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetChannelResult {\n  /**\n   * The channel name.\n   *\n   * If `null`, the app is using the default channel.\n   *\n   * @since 5.0.0\n   * @example 'production'\n   */\n  channel: string | null;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface GetConfigResult {\n  /**\n   * The app ID used to identify the app.\n   *\n   * If `null`, no app ID is configured.\n   *\n   * @since 6.9.0\n   * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n   */\n  appId: string | null;\n  /**\n   * The auto-update strategy for live updates.\n   *\n   * @since 6.9.0\n   * @example 'background'\n   */\n  autoUpdateStrategy: 'none' | 'background';\n}\n\n/**\n * @since 6.7.0\n */\nexport interface GetCurrentBundleResult {\n  /**\n   * The unique identifier of the current bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetDeviceIdResult {\n  /**\n   * The unique identifier of the device.\n   *\n   * On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\n   * The value of this property is the same for apps that come from the same vendor running on the same device.\n   *\n   * @since 5.0.0\n   *\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  deviceId: string;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface IsSyncingResult {\n  /**\n   * Whether a sync operation is currently in progress.\n   *\n   * @since 6.9.0\n   */\n  syncing: boolean;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface GetNextBundleResult {\n  /**\n   * The unique identifier of the next bundle.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.7.0\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionCodeResult {\n  /**\n   * The version code of the app.\n   *\n   * On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1\"\n   */\n  versionCode: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetVersionNameResult {\n  /**\n   * The version name of the app.\n   *\n   * On **Android**, this is the `versionName` from the `android/app/build.gradle` file.\n   * On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n   *\n   * @since 5.0.0\n   * @example \"1.0.0\"\n   */\n  versionName: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface GetCustomIdResult {\n  /**\n   * The custom identifier of the device.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface ReadyResult {\n  /**\n   * The identifier of the previous bundle used.\n   *\n   * If `null`, the default bundle was used.\n   *\n   * @since 6.9.0\n   */\n  previousBundleId: string | null;\n  /**\n   * The identifier of the current bundle used.\n   *\n   * If `null`, the default bundle is being used.\n   *\n   * @since 6.9.0\n   */\n  currentBundleId: string | null;\n  /**\n   * Whether or not the app was reset to the default bundle.\n   *\n   * @since 6.9.0\n   */\n  rollback: boolean;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel name.\n   *\n   * Set `null` to remove the channel.\n   *\n   * @since 5.0.0\n   */\n  channel: string | null;\n}\n\n/**\n * @since 6.9.0\n */\nexport interface SetConfigOptions {\n  /**\n   * The app ID used to identify the app.\n   *\n   * Set `null` to reset to the value from the Capacitor config file.\n   *\n   * @since 6.9.0\n   * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n   */\n  appId?: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetCustomIdOptions {\n  /**\n   * The custom identifier of the device.\n   *\n   * Set `null` to remove the custom identifier.\n   *\n   * @since 5.0.0\n   */\n  customId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SetNextBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * Set `null` to use the default bundle (same as calling `reset()`).\n   *\n   * @since 6.7.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface SyncOptions {\n  /**\n   * The name of the channel where the latest bundle is fetched from.\n   *\n   * @since 6.7.0\n   */\n  channel?: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SyncResult {\n  /**\n   * The identifier of the next bundle to use.\n   *\n   * If `null`, the app is up-to-date and no new bundle is available.\n   *\n   * @since 5.0.0\n   */\n  nextBundleId: string | null;\n}\n\n/**\n * Listener for the download progress of a bundle.\n *\n * @since 6.9.0\n */\nexport type DownloadBundleProgressListener = (event: DownloadBundleProgressEvent) => void;\n\n/**\n * Event that is triggered when the download progress of a bundle changes.\n *\n * @since 6.9.0\n */\nexport interface DownloadBundleProgressEvent {\n  /**\n   * The unique identifier of the bundle that is being downloaded.\n   *\n   * @since 6.9.0\n   */\n  bundleId: string;\n  /**\n   * The number of bytes that have been downloaded.\n   *\n   * @since 6.9.0\n   */\n  downloadedBytes: number;\n  /**\n   * The progress of the download in percent as a value between `0` and `1`.\n   *\n   * @since 6.9.0\n   * @example 0.5\n   */\n  progress: number;\n  /**\n   * The total number of bytes to download.\n   *\n   * @since 6.9.0\n   */\n  totalBytes: number;\n}\n\n/**\n * Listener for when a bundle is set as the next bundle.\n *\n * @since 6.9.0\n */\nexport type NextBundleSetListener = (event: NextBundleSetEvent) => void;\n\n/**\n * Event that is triggered when a bundle is set as the next bundle.\n *\n * @since 6.9.0\n */\nexport interface NextBundleSetEvent {\n  /**\n   * The unique identifier of the bundle that is set as the next bundle.\n   *\n   * If `null`, the default bundle will be used.\n   *\n   * @since 6.9.0\n   * @example '1.0.0'\n   */\n  bundleId: string | null;\n}\n\n/**\n * Listener for when the app is reloaded.\n *\n * @since 6.9.0\n */\nexport type ReloadedListener = () => void;\n"]}