@capawesome/capacitor-live-update 7.2.1 → 7.3.0

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java

@@ -1,5 +1,6 @@
 package io.capawesome.capacitorjs.plugins.liveupdate;
 
+import android.webkit.WebView;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.getcapacitor.JSObject;
@@ -7,8 +8,10 @@ import com.getcapacitor.Logger;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
+import com.getcapacitor.WebViewListener;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundleProgressEvent;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.NextBundleSetEvent;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
@@ -26,7 +29,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "7.1.0";
+    public static final String VERSION = "7.3.0";
     public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdate"; // DO NOT CHANGE
     public static final String ERROR_APP_ID_MISSING = "appId must be configured.";
     public static final String ERROR_BUNDLE_EXISTS = "bundle already exists.";
@@ -45,8 +48,7 @@ public class LiveUpdatePlugin extends Plugin {
     public static final String ERROR_SYNC_IN_PROGRESS = "Sync is already in progress.";
     public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
     public static final String EVENT_DOWNLOAD_BUNDLE_PROGRESS = "downloadBundleProgress";
-
-    private boolean syncInProgress = false;
+    public static final String EVENT_NEXT_BUNDLE_SET = "nextBundleSet";
 
     @Nullable
     private LiveUpdateConfig config;
@@ -54,6 +56,8 @@ public class LiveUpdatePlugin extends Plugin {
     @Nullable
     private LiveUpdate implementation;
 
+    private boolean webViewListenerRegistered = false;
+
     public void load() {
         try {
             config = getLiveUpdateConfig();
@@ -63,6 +67,36 @@ public class LiveUpdatePlugin extends Plugin {
         }
     }
 
+    @Override
+    protected void handleOnResume() {
+        super.handleOnResume();
+        try {
+            // Notify the implementation that the app has resumed
+            if (implementation != null) {
+                implementation.handleOnResume();
+            }
+            // Register WebView listener to trigger auto-update when page is loaded
+            // Important: For some reason, the listener CANNOT be registered in the load() method
+            // or constructor, it MUST be done here in onResume().
+            if (!webViewListenerRegistered) {
+                webViewListenerRegistered = true;
+                getBridge()
+                    .addWebViewListener(
+                        new WebViewListener() {
+                            @Override
+                            public void onPageLoaded(WebView webView) {
+                                if (implementation != null) {
+                                    implementation.handleOnPageLoaded();
+                                }
+                            }
+                        }
+                    );
+            }
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+        }
+    }
+
     @PluginMethod
     public void deleteBundle(PluginCall call) {
         try {
@@ -130,6 +164,12 @@ public class LiveUpdatePlugin extends Plugin {
     @PluginMethod
     public void fetchLatestBundle(PluginCall call) {
         try {
+            String appId = config.getAppId();
+            if (appId == null || appId.isEmpty()) {
+                call.reject(ERROR_APP_ID_MISSING);
+                return;
+            }
+
             FetchLatestBundleOptions options = new FetchLatestBundleOptions(call);
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
@@ -438,35 +478,26 @@ public class LiveUpdatePlugin extends Plugin {
     public void sync(PluginCall call) {
         try {
             String appId = config.getAppId();
-            if (appId == null) {
+            if (appId == null || appId.isEmpty()) {
                 call.reject(ERROR_APP_ID_MISSING);
                 return;
             }
 
-            if (syncInProgress) {
-                call.reject(ERROR_SYNC_IN_PROGRESS);
-                return;
-            }
-            syncInProgress = true;
-
             SyncOptions options = new SyncOptions(call);
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
-                    syncInProgress = false;
                     resolveCall(call, result.toJSObject());
                 }
 
                 @Override
                 public void error(Exception exception) {
-                    syncInProgress = false;
                     rejectCall(call, exception);
                 }
             };
 
             implementation.sync(options, callback);
         } catch (Exception exception) {
-            syncInProgress = false;
             rejectCall(call, exception);
         }
     }
@@ -475,13 +506,21 @@ public class LiveUpdatePlugin extends Plugin {
         notifyListeners(EVENT_DOWNLOAD_BUNDLE_PROGRESS, event.toJSObject(), false);
     }
 
+    public void notifyNextBundleSetListeners(@NonNull NextBundleSetEvent event) {
+        notifyListeners(EVENT_NEXT_BUNDLE_SET, event.toJSObject(), false);
+    }
+
     private LiveUpdateConfig getLiveUpdateConfig() {
         LiveUpdateConfig config = new LiveUpdateConfig();
 
         String appId = getConfig().getString("appId", config.getAppId());
         config.setAppId(appId);
+        boolean autoBlockRolledBackBundles = getConfig().getBoolean("autoBlockRolledBackBundles", config.getAutoBlockRolledBackBundles());
+        config.setAutoBlockRolledBackBundles(autoBlockRolledBackBundles);
         boolean autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.getAutoDeleteBundles());
         config.setAutoDeleteBundles(autoDeleteBundles);
+        String autoUpdateStrategy = getConfig().getString("autoUpdateStrategy", config.getAutoUpdateStrategy());
+        config.setAutoUpdateStrategy(autoUpdateStrategy);
         String defaultChannel = getConfig().getString("defaultChannel", config.getDefaultChannel());
         config.setDefaultChannel(defaultChannel);
         int httpTimeout = getConfig().getInt("httpTimeout", config.getHttpTimeout());

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePreferences.java

@@ -15,6 +15,7 @@ public class LiveUpdatePreferences {
     @NonNull
     private final SharedPreferences.Editor settingsEditor;
 
+    private final String blockedBundleIdsKey = "blockedBundleIds"; // DO NOT CHANGE
     private final String channelKey = "channel"; // DO NOT CHANGE
     private final String deviceIdKey = "deviceId"; // DO NOT CHANGE
     private final String customIdKey = "customId"; // DO NOT CHANGE
@@ -55,6 +56,22 @@ public class LiveUpdatePreferences {
             .getString(previousBundleIdKey, null);
     }
 
+    @Nullable
+    public String getBlockedBundleIds() {
+        return context
+            .getSharedPreferences(LiveUpdatePlugin.SHARED_PREFERENCES_NAME, Activity.MODE_PRIVATE)
+            .getString(blockedBundleIdsKey, null);
+    }
+
+    public void setBlockedBundleIds(@Nullable String blockedBundleIds) {
+        if (blockedBundleIds == null) {
+            settingsEditor.remove(blockedBundleIdsKey);
+        } else {
+            settingsEditor.putString(blockedBundleIdsKey, blockedBundleIds);
+        }
+        settingsEditor.apply();
+    }
+
     public void setChannel(@Nullable String channel) {
         if (channel == null) {
             settingsEditor.remove(channelKey);

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/events/NextBundleSetEvent.java

@@ -0,0 +1,26 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.events;
+
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import org.json.JSONObject;
+
+public class NextBundleSetEvent {
+
+    @Nullable
+    private final String bundleId;
+
+    public NextBundleSetEvent(@Nullable String bundleId) {
+        this.bundleId = bundleId;
+    }
+
+    @Nullable
+    public String getBundleId() {
+        return bundleId;
+    }
+
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("bundleId", bundleId == null ? JSONObject.NULL : bundleId);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/SyncOptions.java

@@ -13,6 +13,10 @@ public class SyncOptions {
         this.channel = call.getString("channel", null);
     }
 
+    public SyncOptions(@Nullable String channel) {
+        this.channel = channel;
+    }
+
     @Nullable
     public String getChannel() {
         return channel;

package/dist/docs.json

@@ -380,6 +380,35 @@
         ],
         "slug": "addlistenerdownloadbundleprogress-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'nextBundleSet'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "NextBundleSetListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.3.0"
+          }
+        ],
+        "docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NextBundleSetListener"
+        ],
+        "slug": "addlistenernextbundleset-"
+      },
       {
         "name": "removeAllListeners",
         "signature": "() => Promise<void>",
@@ -1123,6 +1152,36 @@
           "type": "number"
         }
       ]
+    },
+    {
+      "name": "NextBundleSetEvent",
+      "slug": "nextbundlesetevent",
+      "docs": "Event that is triggered when a bundle is set as the next bundle.",
+      "tags": [
+        {
+          "text": "7.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle that is set as the next bundle.\n\nIf `null`, the default bundle will be used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -1139,6 +1198,19 @@
           ]
         }
       ]
+    },
+    {
+      "name": "NextBundleSetListener",
+      "slug": "nextbundlesetlistener",
+      "docs": "Listener for when a bundle is set as the next bundle.",
+      "types": [
+        {
+          "text": "(event: NextBundleSetEvent): void",
+          "complexTypes": [
+            "NextBundleSetEvent"
+          ]
+        }
+      ]
     }
   ],
   "pluginConfigs": [
@@ -1162,6 +1234,22 @@
           "complexTypes": [],
           "type": "string | undefined"
         },
+        {
+          "name": "autoBlockRolledBackBundles",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether or not to automatically block bundles that have been rolled back.\n\nWhen 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.\nBlocked bundles will be skipped in future sync operations.\n\n**Attention**: This option has no effect if `readyTimeout` is set to `0`.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "autoDeleteBundles",
           "tags": [
@@ -1178,6 +1266,26 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "autoUpdateStrategy",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "'none'",
+              "name": "default"
+            },
+            {
+              "text": "'background'",
+              "name": "example"
+            }
+          ],
+          "docs": "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\nand applied in the background at app startup and when the app resumes\n(if the last check was more than 15 minutes ago).\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "'none' | 'background' | undefined"
+        },
         {
           "name": "defaultChannel",
           "tags": [
@@ -1242,7 +1350,7 @@
               "name": "example"
             }
           ],
-          "docs": "The timeout in milliseconds to wait for the app to be ready\nbefore resetting to the default bundle.\n\nIt is strongly **recommended** to configure this option so that\nthe plugin can roll back to the default bundle in case of problems.\nIf configured, the plugin will wait for the app to call the `ready()`\nmethod before resetting to the default bundle.\n\nSet to `0` to disable the timeout.",
+          "docs": "The timeout in milliseconds to wait for the app to be ready\nbefore resetting to the default bundle.\n\nIt is strongly **recommended** to configure this option (e.g. `10000` ms)\nso that the plugin can roll back to the default bundle in case of problems.\nIf configured, the plugin will wait for the app to call the `ready()`\nmethod before resetting to the default bundle.\n\nSet to `0` to disable the timeout.",
           "complexTypes": [],
           "type": "number | undefined"
         },

package/dist/esm/definitions.d.ts

@@ -12,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 7.3.0
+             * @default false
+             */
+            autoBlockRolledBackBundles?: boolean;
             /**
              * Whether or not to automatically delete unused bundles.
              *
@@ -21,6 +36,21 @@ 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 7.3.0
+             * @default 'none'
+             * @example 'background'
+             */
+            autoUpdateStrategy?: 'none' | 'background';
             /**
              * The default channel of the app.
              *
@@ -48,8 +78,8 @@ declare module '@capacitor/cli' {
              * The timeout in milliseconds to wait for the app to be ready
              * before resetting to the default bundle.
              *
-             * It is strongly **recommended** to configure this option so that
-             * the plugin can roll back to the default bundle in case of problems.
+             * It is strongly **recommended** to configure this option (e.g. `10000` ms)
+             * so that the plugin can roll back to the default bundle in case of problems.
              * If configured, the plugin will wait for the app to call the `ready()`
              * method before resetting to the default bundle.
              *
@@ -242,6 +272,17 @@ export interface LiveUpdatePlugin {
      * @since 7.0.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 7.3.0
+     */
+    addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener): Promise<PluginListenerHandle>;
     /**
      * Remove all listeners for this plugin.
      *
@@ -647,3 +688,25 @@ export interface DownloadBundleProgressEvent {
      */
     totalBytes: number;
 }
+/**
+ * Listener for when a bundle is set as the next bundle.
+ *
+ * @since 7.3.0
+ */
+export declare type NextBundleSetListener = (event: NextBundleSetEvent) => void;
+/**
+ * Event that is triggered when a bundle is set as the next bundle.
+ *
+ * @since 7.3.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 7.3.0
+     * @example '1.0.0'
+     */
+    bundleId: string | null;
+}

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 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       * 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 so that\n       * 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   * 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(\n    options?: FetchLatestBundleOptions,\n  ): Promise<FetchLatestBundleResult>;\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   * 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   *\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   * 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   * 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   * 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 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  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 base64 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 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 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 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 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 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 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"]}
+{"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       * @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   * 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(\n    options?: FetchLatestBundleOptions,\n  ): Promise<FetchLatestBundleResult>;\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   * 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   *\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   * 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   * 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   * 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 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  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 base64 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 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 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 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 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 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 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"]}

package/ios/Plugin/Classes/Events/NextBundleSetEvent.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class NextBundleSetEvent: NSObject {
+    let bundleId: String?
+
+    init(bundleId: String?) {
+        self.bundleId = bundleId
+    }
+
+    public func toJSObject() -> JSObject {
+        var result = JSObject()
+        result["bundleId"] = bundleId == nil ? NSNull() : bundleId
+        return result
+    }
+}

package/ios/Plugin/Classes/Options/SyncOptions.swift

@@ -8,6 +8,10 @@ import Capacitor
         self.channel = call.getString("channel")
     }
 
+    init(channel: String?) {
+        self.channel = channel
+    }
+
     func getChannel() -> String? {
         return channel
     }