@capawesome/capacitor-live-update 8.4.4 → 8.5.0

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\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 7.3.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 7.3.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       * The timeout in milliseconds for HTTP requests.\n       *\n       * @since 6.4.0\n       * @default 60000\n       */\n      httpTimeout?: number;\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\n       * before resetting to the default bundle.\n       *\n       * It is strongly **recommended** to configure this option (e.g. `10000` ms)\n       * so that the plugin can roll back to the default bundle in case of problems.\n       * If configured, the plugin will wait for the app to call the `ready()`\n       * method before resetting to the default bundle.\n       *\n       * Set to `0` to disable the timeout.\n       *\n       * @since 5.0.0\n       * @default 0\n       * @example 10000\n       */\n      readyTimeout?: number;\n      /**\n       * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.\n       *\n       * @since 7.0.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 7.4.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 8.2.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(\n    options?: FetchLatestBundleOptions,\n  ): 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 7.4.0\n   */\n  getBlockedBundles(): Promise<GetBlockedBundlesResult>;\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. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or\n   *    `capawesome_live_update_default_channel` in `strings.xml` on Android)\n   * 3. Capacitor config `defaultChannel`\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 7.4.0\n   */\n  getConfig(): Promise<GetConfigResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 7.4.0\n   */\n  getDownloadedBundles(): Promise<GetDownloadedBundlesResult>;\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   * Check whether a sync operation is currently in progress.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 7.4.0\n   */\n  isSyncing(): Promise<IsSyncingResult>;\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   * 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   * 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   * 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   * 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   * It must always be called before `sync(...)` or any other method that changes the 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   * This method reloads the web view only, the native process is **not** restarted.\n   * Resources of the web layer that hold an exclusive lock (e.g. IndexedDB or WebSockets)\n   * are therefore not released automatically and may prevent the new bundle from starting.\n   * Release these resources before calling this method or apply the new bundle\n   * on the next app start instead.\n   *\n   * **Attention**: The in-memory state of the app (e.g. unsaved user input) is lost.\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 7.4.0\n   */\n  resetConfig(): 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 7.4.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 7.0.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 7.3.0\n   */\n  addListener(\n    eventName: 'nextBundleSet',\n    listenerFunc: NextBundleSetListener,\n  ): 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 7.4.0\n   */\n  addListener(\n    eventName: 'reloaded',\n    listenerFunc: ReloadedListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 7.2.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   * **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.\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 hex format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 7.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 7.1.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 should return\n   * a `X-Checksum` header with the SHA-256 hash in hex format.\n   *\n   * To **verify the signature** of the file, the server should 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 8.2.0\n */\nexport interface FetchChannelsOptions {\n  /**\n   * The maximum number of channels to return.\n   *\n   * @since 8.2.0\n   * @default 50\n   */\n  limit?: number;\n  /**\n   * The number of channels to skip.\n   *\n   * @since 8.2.0\n   * @default 0\n   */\n  offset?: number;\n  /**\n   * The query to filter channels by name.\n   *\n   * @since 8.2.0\n   */\n  query?: string;\n}\n\n/**\n * @since 8.2.0\n */\nexport interface FetchChannelsResult {\n  /**\n   * The list of channels.\n   *\n   * @since 8.2.0\n   */\n  channels: Channel[];\n}\n\n/**\n * @since 8.2.0\n */\nexport interface Channel {\n  /**\n   * The unique identifier of the channel.\n   *\n   * @since 8.2.0\n   */\n  id: string;\n  /**\n   * The name of the channel.\n   *\n   * @since 8.2.0\n   */\n  name: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The preferred channel name from which the latest bundle should be fetched.\n   *\n   * This is the SDK preference and may be overridden by a forced channel assignment\n   * configured in the Capawesome Cloud Console.\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   * On Capawesome Cloud, this is the ID of the app build artifact.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * The name of the channel that the bundle is actually from.\n   *\n   * This is the resolved channel after applying any forced channel assignment\n   * and may differ from the channel set by the Live Update SDK.\n   *\n   * @since 8.3.0\n   */\n  channel?: string;\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 7.1.0\n   */\n  checksum?: string;\n  /**\n   * Custom properties that are associated with the latest bundle.\n   *\n   * @since 7.0.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 7.1.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 7.4.0\n */\nexport interface GetBlockedBundlesResult {\n  /**\n   * An array of unique identifiers of all blocked bundles.\n   *\n   * @since 7.4.0\n   */\n  bundleIds: string[];\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 7.4.0\n */\nexport interface GetDownloadedBundlesResult {\n  /**\n   * An array of unique identifiers of all downloaded bundles.\n   *\n   * @since 7.4.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 7.4.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 7.4.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 7.4.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 7.4.0\n */\nexport interface IsSyncingResult {\n  /**\n   * Whether a sync operation is currently in progress.\n   *\n   * @since 7.4.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 7.0.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 7.0.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 7.0.0\n   */\n  currentBundleId: string | null;\n  /**\n   * Whether or not the app was reset to the default bundle.\n   *\n   * @since 7.0.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 7.4.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 7.4.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 preferred channel name from which the latest bundle should be fetched.\n   *\n   * This is the SDK preference and may be overridden by a forced channel assignment\n   * configured in the Capawesome Cloud Console.\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 7.0.0\n */\nexport type DownloadBundleProgressListener = (\n  event: DownloadBundleProgressEvent,\n) => void;\n\n/**\n * Event that is triggered when the download progress of a bundle changes.\n *\n * @since 7.0.0\n */\nexport interface DownloadBundleProgressEvent {\n  /**\n   * The unique identifier of the bundle that is being downloaded.\n   *\n   * @since 7.0.0\n   */\n  bundleId: string;\n  /**\n   * The number of bytes that have been downloaded.\n   *\n   * @since 7.0.0\n   */\n  downloadedBytes: number;\n  /**\n   * The progress of the download in percent as a value between `0` and `1`.\n   *\n   * @since 7.0.0\n   * @example 0.5\n   */\n  progress: number;\n  /**\n   * The total number of bytes to download.\n   *\n   * @since 7.0.0\n   */\n  totalBytes: number;\n}\n\n/**\n * Listener for when a bundle is set as the next bundle.\n *\n * @since 7.3.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 7.3.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 7.3.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 7.4.0\n */\nexport type ReloadedListener = () => void;\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, iOS and Electron.\n       *\n       * @since 7.3.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, iOS and Electron.\n       *\n       * @since 7.3.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, `capawesome_live_update_default_channel`\n       * in `strings.xml` on Android or `electron/capacitor.electron.config.ts` on Electron).\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\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 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\n       * before resetting to the default bundle.\n       *\n       * It is strongly **recommended** to configure this option (e.g. `10000` ms)\n       * so that the plugin can roll back to the default bundle in case of problems.\n       * If configured, the plugin will wait for the app to call the `ready()`\n       * method before resetting to the default bundle.\n       *\n       * Set to `0` to disable the timeout.\n       *\n       * @since 5.0.0\n       * @default 0\n       * @example 10000\n       */\n      readyTimeout?: number;\n      /**\n       * The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.\n       *\n       * @since 7.0.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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  clearBlockedBundles(): Promise<void>;\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 8.2.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, iOS and Electron.\n   *\n   * @since 6.6.0\n   */\n  fetchLatestBundle(\n    options?: FetchLatestBundleOptions,\n  ): 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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  getBlockedBundles(): Promise<GetBlockedBundlesResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android, iOS and Electron.\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. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS,\n   *    `capawesome_live_update_default_channel` in `strings.xml` on Android or\n   *    `defaultChannel` in `electron/capacitor.electron.config.ts` on Electron)\n   * 3. Capacitor config `defaultChannel`\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, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  getConfig(): Promise<GetConfigResult>;\n  /**\n   * Get all identifiers of bundles that have been downloaded.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  getDownloadedBundles(): Promise<GetDownloadedBundlesResult>;\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, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the unique device identifier.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Check whether a sync operation is currently in progress.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  isSyncing(): Promise<IsSyncingResult>;\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, iOS and Electron.\n   *\n   * @since 6.7.0\n   */\n  getNextBundle(): Promise<GetNextBundleResult>;\n  /**\n   * Get 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   * On **Electron**, this is the `version` from the `electron/package.json` file.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get 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   * On **Electron**, this is the `version` from the `electron/package.json` file.\n   *\n   * Only available on Android, iOS and Electron.\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   * It must always be called before `sync(...)` or any other method that changes the bundle.\n   *\n   * Only available on Android, iOS and Electron.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<ReadyResult>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * This method reloads the web view only, the native process is **not** restarted.\n   * Resources of the web layer that hold an exclusive lock (e.g. IndexedDB or WebSockets)\n   * are therefore not released automatically and may prevent the new bundle from starting.\n   * Release these resources before calling this method or apply the new bundle\n   * on the next app start instead.\n   *\n   * **Attention**: The in-memory state of the app (e.g. unsaved user input) is lost.\n   *\n   * Only available on Android, iOS and Electron.\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, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  resetConfig(): Promise<void>;\n  /**\n   * Set the channel to use for the update.\n   *\n   * Only available on Android, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  setConfig(options: SetConfigOptions): Promise<void>;\n  /**\n   * Set the custom identifier of the device.\n   *\n   * Only available on Android, iOS and Electron.\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, iOS and Electron.\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, iOS and Electron.\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, iOS and Electron.\n   *\n   * @since 7.0.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, iOS and Electron.\n   *\n   * @since 7.3.0\n   */\n  addListener(\n    eventName: 'nextBundleSet',\n    listenerFunc: NextBundleSetListener,\n  ): 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, iOS and Electron.\n   *\n   * @since 7.4.0\n   */\n  addListener(\n    eventName: 'reloaded',\n    listenerFunc: ReloadedListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 7.2.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   * On **Electron**, only the `zip` artifact type is supported.\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   * **Attention**: The value `public` is reserved and cannot be used as a bundle identifier.\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 hex format to verify the integrity of the bundle.\n   *\n   * **Attention**: Only supported for the `zip` artifact type.\n   *\n   * @since 7.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 7.1.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 should return\n   * a `X-Checksum` header with the SHA-256 hash in hex format.\n   *\n   * To **verify the signature** of the file, the server should 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 8.2.0\n */\nexport interface FetchChannelsOptions {\n  /**\n   * The maximum number of channels to return.\n   *\n   * @since 8.2.0\n   * @default 50\n   */\n  limit?: number;\n  /**\n   * The number of channels to skip.\n   *\n   * @since 8.2.0\n   * @default 0\n   */\n  offset?: number;\n  /**\n   * The query to filter channels by name.\n   *\n   * @since 8.2.0\n   */\n  query?: string;\n}\n\n/**\n * @since 8.2.0\n */\nexport interface FetchChannelsResult {\n  /**\n   * The list of channels.\n   *\n   * @since 8.2.0\n   */\n  channels: Channel[];\n}\n\n/**\n * @since 8.2.0\n */\nexport interface Channel {\n  /**\n   * The unique identifier of the channel.\n   *\n   * @since 8.2.0\n   */\n  id: string;\n  /**\n   * The name of the channel.\n   *\n   * @since 8.2.0\n   */\n  name: string;\n}\n\n/**\n * @since 6.7.0\n */\nexport interface FetchLatestBundleOptions {\n  /**\n   * The preferred channel name from which the latest bundle should be fetched.\n   *\n   * This is the SDK preference and may be overridden by a forced channel assignment\n   * configured in the Capawesome Cloud Console.\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   * On **Electron**, only the `zip` artifact type is supported.\n   *\n   * @since 6.7.0\n   */\n  artifactType?: 'manifest' | 'zip';\n  /**\n   * The unique identifier of the latest bundle.\n   *\n   * On Capawesome Cloud, this is the ID of the app build artifact.\n   *\n   * If `null`, no bundle is available.\n   *\n   * @since 6.6.0\n   */\n  bundleId: string | null;\n  /**\n   * The name of the channel that the bundle is actually from.\n   *\n   * This is the resolved channel after applying any forced channel assignment\n   * and may differ from the channel set by the Live Update SDK.\n   *\n   * @since 8.3.0\n   */\n  channel?: string;\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 7.1.0\n   */\n  checksum?: string;\n  /**\n   * Custom properties that are associated with the latest bundle.\n   *\n   * @since 7.0.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 7.1.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 7.4.0\n */\nexport interface GetBlockedBundlesResult {\n  /**\n   * An array of unique identifiers of all blocked bundles.\n   *\n   * @since 7.4.0\n   */\n  bundleIds: string[];\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 7.4.0\n */\nexport interface GetDownloadedBundlesResult {\n  /**\n   * An array of unique identifiers of all downloaded bundles.\n   *\n   * @since 7.4.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 7.4.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 7.4.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 7.4.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   * On Electron, a random UUID is generated on first use and stored in the app's user data directory.\n   * The value changes when the user data is cleared.\n   *\n   * @since 5.0.0\n   *\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  deviceId: string;\n}\n\n/**\n * @since 7.4.0\n */\nexport interface IsSyncingResult {\n  /**\n   * Whether a sync operation is currently in progress.\n   *\n   * @since 7.4.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   * On **Electron**, this is the `version` from the `electron/package.json` 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   * On **Electron**, this is the `version` from the `electron/package.json` 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 7.0.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 7.0.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 7.0.0\n   */\n  currentBundleId: string | null;\n  /**\n   * Whether or not the app was reset to the default bundle.\n   *\n   * @since 7.0.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 7.4.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 7.4.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 preferred channel name from which the latest bundle should be fetched.\n   *\n   * This is the SDK preference and may be overridden by a forced channel assignment\n   * configured in the Capawesome Cloud Console.\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 7.0.0\n */\nexport type DownloadBundleProgressListener = (\n  event: DownloadBundleProgressEvent,\n) => void;\n\n/**\n * Event that is triggered when the download progress of a bundle changes.\n *\n * @since 7.0.0\n */\nexport interface DownloadBundleProgressEvent {\n  /**\n   * The unique identifier of the bundle that is being downloaded.\n   *\n   * @since 7.0.0\n   */\n  bundleId: string;\n  /**\n   * The number of bytes that have been downloaded.\n   *\n   * @since 7.0.0\n   */\n  downloadedBytes: number;\n  /**\n   * The progress of the download in percent as a value between `0` and `1`.\n   *\n   * @since 7.0.0\n   * @example 0.5\n   */\n  progress: number;\n  /**\n   * The total number of bytes to download.\n   *\n   * @since 7.0.0\n   */\n  totalBytes: number;\n}\n\n/**\n * Listener for when a bundle is set as the next bundle.\n *\n * @since 7.3.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 7.3.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 7.3.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 7.4.0\n */\nexport type ReloadedListener = () => void;\n"]}

package/electron/dist/plugin.mjs

@@ -0,0 +1,213 @@
+import { ElectronPlugin } from '@capawesome/capacitor-electron/plugin';
+import { LiveUpdateEngine } from '@capawesome/electron-live-update/engine';
+import { app, powerMonitor } from 'electron';
+import { createRequire } from 'node:module';
+import { join } from 'node:path';
+
+const AUTO_UPDATE_MIN_INTERVAL = 15 * 60 * 1000;
+const CAPACITOR_RUNTIME = 'capacitor';
+// Platform enum of the Capawesome Cloud API: 0 = Android, 1 = iOS, 2 = Electron.
+const ELECTRON_PLATFORM = '2';
+// The built file lives at `electron/dist/plugin.mjs`, so the package root is two levels up.
+const PLUGIN_VERSION = createRequire(import.meta.url)('../../package.json').version;
+class LiveUpdateElectron extends ElectronPlugin {
+    static __capacitorElectronPlugin = {
+        name: 'LiveUpdate',
+        methods: [
+            'clearBlockedBundles',
+            'deleteBundle',
+            'downloadBundle',
+            'fetchChannels',
+            'fetchLatestBundle',
+            'getBlockedBundles',
+            'getBundles',
+            'getChannel',
+            'getConfig',
+            'getCurrentBundle',
+            'getCustomId',
+            'getDeviceId',
+            'getDownloadedBundles',
+            'getNextBundle',
+            'getVersionCode',
+            'getVersionName',
+            'isSyncing',
+            'ready',
+            'reload',
+            'reset',
+            'resetConfig',
+            'setChannel',
+            'setConfig',
+            'setCustomId',
+            'setNextBundle',
+            'sync',
+        ],
+    };
+    config;
+    lastAutoUpdateCheck = 0;
+    loadedEngine;
+    constructor(context) {
+        super(context);
+        this.config =
+            context.config.plugins?.LiveUpdate ?? {};
+    }
+    async load() {
+        // A failing live update must never prevent the app from booting.
+        try {
+            this.loadedEngine = this.createEngine();
+            await this.loadedEngine.initialize();
+            this.context.services.bundles.setActiveBundle(this.loadedEngine.getCurrentBundlePath());
+        }
+        catch (error) {
+            console.error(`[LiveUpdate] Failed to load, serving the default bundle: ${error}`);
+            return;
+        }
+        if (this.config.autoUpdateStrategy === 'background') {
+            this.setUpBackgroundAutoUpdate();
+        }
+    }
+    async clearBlockedBundles() {
+        return this.engine.clearBlockedBundles();
+    }
+    async deleteBundle(options) {
+        return this.engine.deleteBundle(options);
+    }
+    async downloadBundle(options) {
+        const { artifactType } = options;
+        if (artifactType === 'manifest') {
+            throw new Error('The manifest artifact type is not supported.');
+        }
+        return this.engine.downloadBundle({ ...options, artifactType });
+    }
+    async fetchChannels(options) {
+        return this.engine.fetchChannels(options);
+    }
+    async fetchLatestBundle(options) {
+        return this.engine.fetchLatestBundle(options);
+    }
+    async getBlockedBundles() {
+        return this.engine.getBlockedBundles();
+    }
+    async getBundles() {
+        return this.getDownloadedBundles();
+    }
+    async getChannel() {
+        return this.engine.getChannel();
+    }
+    async getConfig() {
+        const { appId } = await this.engine.getConfig();
+        return {
+            appId,
+            autoUpdateStrategy: this.config.autoUpdateStrategy ?? 'none',
+        };
+    }
+    async getCurrentBundle() {
+        return this.engine.getCurrentBundle();
+    }
+    async getCustomId() {
+        return this.engine.getCustomId();
+    }
+    async getDeviceId() {
+        return this.engine.getDeviceId();
+    }
+    async getDownloadedBundles() {
+        return this.engine.getDownloadedBundles();
+    }
+    async getNextBundle() {
+        return this.engine.getNextBundle();
+    }
+    async getVersionCode() {
+        return this.engine.getVersionCode();
+    }
+    async getVersionName() {
+        return this.engine.getVersionName();
+    }
+    async isSyncing() {
+        return this.engine.isSyncing();
+    }
+    async ready() {
+        return this.engine.ready();
+    }
+    async reload() {
+        await this.engine.applyNextBundle();
+        this.reloadCurrentBundle();
+    }
+    async reset() {
+        return this.engine.reset();
+    }
+    async resetConfig() {
+        return this.engine.resetConfig();
+    }
+    async setChannel(options) {
+        return this.engine.setChannel(options);
+    }
+    async setConfig(options) {
+        return this.engine.setConfig(options);
+    }
+    async setCustomId(options) {
+        return this.engine.setCustomId(options);
+    }
+    async setNextBundle(options) {
+        return this.engine.setNextBundle(options);
+    }
+    async sync(options) {
+        return this.engine.sync(options);
+    }
+    get engine() {
+        if (!this.loadedEngine) {
+            throw new Error('LiveUpdate failed to load. See the logs for details.');
+        }
+        return this.loadedEngine;
+    }
+    createEngine() {
+        const engine = new LiveUpdateEngine({
+            appId: this.config.appId,
+            autoBlockRolledBackBundles: this.config.autoBlockRolledBackBundles,
+            autoDeleteBundles: this.config.autoDeleteBundles,
+            dataDirectory: join(app.getPath('userData'), 'capawesome-live-update'),
+            defaultChannel: this.config.defaultChannel,
+            httpTimeout: this.config.httpTimeout,
+            osVersion: process.getSystemVersion(),
+            platform: ELECTRON_PLATFORM,
+            pluginVersion: PLUGIN_VERSION,
+            publicKey: this.config.publicKey,
+            readyTimeout: this.config.readyTimeout,
+            runtime: CAPACITOR_RUNTIME,
+            serverDomain: this.config.serverDomain,
+            versionCode: app.getVersion(),
+            versionName: app.getVersion(),
+        });
+        engine.on('downloadBundleProgress', event => this.context.notifyListeners('downloadBundleProgress', event));
+        engine.on('nextBundleSet', event => this.context.notifyListeners('nextBundleSet', event));
+        engine.on('rolledBack', () => {
+            try {
+                this.reloadCurrentBundle();
+            }
+            catch (error) {
+                console.error(`[LiveUpdate] Failed to apply rollback: ${error}`);
+            }
+        });
+        return engine;
+    }
+    reloadCurrentBundle() {
+        this.context.services.bundles.setActiveBundle(this.engine.getCurrentBundlePath());
+        // Retained so that the freshly reloaded page receives the event.
+        this.context.notifyListeners('reloaded', {}, { retain: true });
+    }
+    setUpBackgroundAutoUpdate() {
+        const check = () => {
+            const now = Date.now();
+            if (now - this.lastAutoUpdateCheck < AUTO_UPDATE_MIN_INTERVAL) {
+                return;
+            }
+            this.lastAutoUpdateCheck = now;
+            void this.sync().catch(error => console.warn(`[LiveUpdate] Background sync failed: ${error}`));
+        };
+        void app.whenReady().then(() => {
+            check();
+            app.on('browser-window-focus', check);
+            powerMonitor.on('resume', check);
+        });
+    }
+}
+
+export { LiveUpdateElectron };

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "8.4.4"
+    public static let version = "8.5.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "8.4.4",
-  "description": "Capacitor plugin to update your app remotely in real-time on Android and iOS.",
+  "version": "8.5.0",
+  "description": "Capacitor plugin to update your app remotely in real-time on Android, iOS and Electron.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -10,6 +10,7 @@
     "android/src/main/",
     "android/build.gradle",
     "dist/",
+    "electron/dist/",
     "ios/Plugin/",
     "CapawesomeCapacitorLiveUpdate.podspec",
     "Package.swift"
@@ -41,6 +42,7 @@
     "ionic",
     "android",
     "ios",
+    "electron",
     "live update",
     "remote update",
     "ota",
@@ -60,36 +62,51 @@
     "verify:web": "npm run build",
     "e2e:android": "npm install --prefix example && npm run build && npm --prefix example run e2e:android",
     "e2e:ios": "npm install --prefix example && npm run build && npm --prefix example run e2e:ios",
+    "e2e:electron": "npm install --prefix example && npm run build && npm --prefix example run e2e:electron",
     "lint": "npm run version:check && npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
     "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
     "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api LiveUpdatePlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
-    "clean": "rimraf ./dist",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs && npm run build:electron",
+    "build:electron": "rollup -c electron/rollup.config.mjs",
+    "clean": "rimraf ./dist ./electron/dist",
     "watch": "tsc --watch",
     "version": "node scripts/sync-plugin-version.mjs",
     "version:check": "node scripts/sync-plugin-version.mjs --check",
     "ios:pod:install": "cd ios && pod install --repo-update && cd ..",
     "prepublishOnly": "npm run build"
   },
+  "dependencies": {
+    "@capawesome/electron-live-update": "^0.1.0"
+  },
   "devDependencies": {
     "@capacitor/android": "8.0.0",
     "@capacitor/cli": "8.4.2",
     "@capacitor/core": "8.0.0",
     "@capacitor/docgen": "0.3.1",
     "@capacitor/ios": "8.0.0",
+    "@capawesome/capacitor-electron": "0.2.0",
     "@ionic/eslint-config": "0.4.0",
+    "@rollup/plugin-typescript": "12.3.0",
+    "electron": "44.5.1",
     "eslint": "8.57.0",
     "prettier-plugin-java": "2.9.7",
     "rimraf": "6.1.2",
     "rollup": "4.62.3",
     "swiftlint": "2.0.0",
+    "tslib": "2.8.1",
     "typescript": "5.9.3"
   },
   "peerDependencies": {
-    "@capacitor/core": ">=8.0.0"
+    "@capacitor/core": ">=8.0.0",
+    "@capawesome/capacitor-electron": ">=0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@capawesome/capacitor-electron": {
+      "optional": true
+    }
   },
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"
@@ -100,6 +117,9 @@
     },
     "android": {
       "src": "android"
+    },
+    "electron": {
+      "src": "electron"
     }
   }
 }