@capawesome/capacitor-live-update 6.1.0 → 6.2.0-dev.4ebc29c.1723183892

package/README.md

@@ -7,7 +7,7 @@ Capacitor plugin to update your app remotely in real-time.
 - 🔋 Supports **Android and iOS**
 - ⚡️ **Capacitor 6** support
 - 📦 **Bundle Management**: Download, set, and delete bundles.
-- ☁️ **Cloud Support**: Use the [Capawesome Cloud](https://capawesome.io/cloud) to manage your app updates.
+- ☁️ **Cloud Support**: Use the [Capawesome Cloud](https://capawesome.io/cloud/live-updates/) to manage your app updates.
 - 📺 **Channel Support**: Set a channel for the app to manage different versions.
 - 🔄 **Auto Update**: Automatically download and set the latest bundle for the app.
 - 🛟 **Rollback**: Reset the app to the default bundle if an incompatible bundle has been set.
@@ -65,14 +65,16 @@ We recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bun
 <docgen-config>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
-| Prop                    | Type                 | Description                                                                                                                                       | Default            | Since |
-| ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
-| **`appId`**             | <code>string</code>  | The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).                                                |                    | 5.0.0 |
-| **`autoDeleteBundles`** | <code>boolean</code> | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`. | <code>false</code> | 5.0.0 |
-| **`enabled`**           | <code>boolean</code> | Whether or not the plugin is enabled.                                                                                                             | <code>true</code>  | 5.0.0 |
-| **`publicKey`**         | <code>string</code>  | The public key to verify the integrity of the bundle. The public key must be a PEM-encoded RSA public key.                                        |                    | 6.1.0 |
-| **`readyTimeout`**      | <code>number</code>  | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.                                               | <code>10000</code> | 5.0.0 |
-| **`resetOnUpdate`**     | <code>boolean</code> | Whether or not the app should be reset to the default bundle during an update.                                                                    | <code>true</code>  | 5.0.0 |
+| Prop                    | Type                      | Description                                                                                                                                       | Default            | Since |
+| ----------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`appId`**             | <code>string</code>       | The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).                                                |                    | 5.0.0 |
+| **`autoDeleteBundles`** | <code>boolean</code>      | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`. | <code>false</code> | 5.0.0 |
+| **`defaultChannel`**    | <code>string</code>       | The default channel of the app.                                                                                                                   |                    | 6.3.0 |
+| **`enabled`**           | <code>boolean</code>      | Whether or not the plugin is enabled.                                                                                                             | <code>true</code>  | 5.0.0 |
+| **`location`**          | <code>'us' \| 'eu'</code> | The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).                                                     | <code>'us'</code>  | 6.2.0 |
+| **`publicKey`**         | <code>string</code>       | The public key to verify the integrity of the bundle. The public key must be a PEM-encoded RSA public key.                                        |                    | 6.1.0 |
+| **`readyTimeout`**      | <code>number</code>       | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.                                               | <code>10000</code> | 5.0.0 |
+| **`resetOnUpdate`**     | <code>boolean</code>      | Whether or not the app should be reset to the default bundle during an update.                                                                    | <code>true</code>  | 5.0.0 |
 
 ### Examples
 
@@ -84,7 +86,9 @@ In `capacitor.config.json`:
     "LiveUpdate": {
       "appId": '4100e356-e851-47fe-9d3c-b411eb325a99',
       "autoDeleteBundles": undefined,
+      "defaultChannel": 'production',
       "enabled": undefined,
+      "location": 'eu',
       "publicKey": '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       "readyTimeout": undefined,
       "resetOnUpdate": undefined
@@ -105,7 +109,9 @@ const config: CapacitorConfig = {
     LiveUpdate: {
       appId: '4100e356-e851-47fe-9d3c-b411eb325a99',
       autoDeleteBundles: undefined,
+      defaultChannel: 'production',
       enabled: undefined,
+      location: 'eu',
       publicKey: '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       readyTimeout: undefined,
       resetOnUpdate: undefined,

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

@@ -133,7 +133,7 @@ public class LiveUpdate {
     }
 
     public void getChannel(@NonNull NonEmptyCallback callback) {
-        String channel = preferences.getChannel();
+        String channel = getChannel();
         GetChannelResult result = new GetChannelResult(channel);
         callback.success(result);
     }
@@ -472,9 +472,13 @@ public class LiveUpdate {
     @Nullable
     private void fetchLatestBundle(@NonNull NonEmptyCallback<GetLatestBundleResponse> callback)
         throws PackageManager.NameNotFoundException {
+        String host = "api.cloud.capawesome.io";
+        if (config.getLocation() != null && config.getLocation().equals("eu")) {
+            host = "api.cloud.capawesome.eu";
+        }
         HttpUrl url = new HttpUrl.Builder()
             .scheme("https")
-            .host("api.cloud.capawesome.io")
+            .host(host)
             .addPathSegment("v1")
             .addPathSegment("apps")
             .addPathSegment(config.getAppId())
@@ -483,7 +487,7 @@ public class LiveUpdate {
             .addQueryParameter("appVersionCode", getVersionCode())
             .addQueryParameter("appVersionName", getVersionName())
             .addQueryParameter("bundleId", getCurrentBundleId())
-            .addQueryParameter("channelName", preferences.getChannel())
+            .addQueryParameter("channelName", getChannel())
             .addQueryParameter("customId", preferences.getCustomId())
             .addQueryParameter("deviceId", getDeviceId())
             .addQueryParameter("osVersion", String.valueOf(Build.VERSION.SDK_INT))
@@ -526,14 +530,6 @@ public class LiveUpdate {
             );
     }
 
-    private String getVersionCode() throws PackageManager.NameNotFoundException {
-        return String.valueOf(getPackageInfo().versionCode);
-    }
-
-    private String getVersionName() throws PackageManager.NameNotFoundException {
-        return getPackageInfo().versionName;
-    }
-
     private String[] getBundleIds() {
         File bundlesDirectory = buildBundlesDirectory();
         File[] bundles = bundlesDirectory.listFiles();
@@ -549,6 +545,18 @@ public class LiveUpdate {
         return bundleIds;
     }
 
+    @Nullable
+    private String getChannel() {
+        String channel = null;
+        if (config.getDefaultChannel() != null) {
+            channel = config.getDefaultChannel();
+        }
+        if (preferences.getChannel() != null) {
+            channel = preferences.getChannel();
+        }
+        return channel;
+    }
+
     /**
      * @return The current bundle ID (`public` for the built-in bundle).
      */
@@ -600,6 +608,14 @@ public class LiveUpdate {
             .getString(WebView.CAP_SERVER_PATH, defaultWebAssetDir);
     }
 
+    private String getVersionCode() throws PackageManager.NameNotFoundException {
+        return String.valueOf(getPackageInfo().versionCode);
+    }
+
+    private String getVersionName() throws PackageManager.NameNotFoundException {
+        return getPackageInfo().versionName;
+    }
+
     private boolean hasBundle(@NonNull String bundleId) {
         File bundleDirectory = buildBundleDirectoryFor(bundleId);
         return bundleDirectory.exists();

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

@@ -9,8 +9,15 @@ public class LiveUpdateConfig {
     private String appId = null;
 
     private boolean autoDeleteBundles = false;
+
+    @Nullable
+    private String defaultChannel = null;
+
     private boolean enabled = true;
 
+    @Nullable
+    private String location = null;
+
     @Nullable
     private String publicKey = null;
 
@@ -26,10 +33,20 @@ public class LiveUpdateConfig {
         return autoDeleteBundles;
     }
 
+    @Nullable
+    public String getDefaultChannel() {
+        return defaultChannel;
+    }
+
     public boolean getEnabled() {
         return enabled;
     }
 
+    @Nullable
+    public String getLocation() {
+        return location;
+    }
+
     @Nullable
     public String getPublicKey() {
         return publicKey;
@@ -51,10 +68,18 @@ public class LiveUpdateConfig {
         this.autoDeleteBundles = autoDeleteBundles;
     }
 
+    public void setDefaultChannel(@Nullable String defaultChannel) {
+        this.defaultChannel = defaultChannel;
+    }
+
     public void setEnabled(boolean enabled) {
         this.enabled = enabled;
     }
 
+    public void setLocation(@Nullable String location) {
+        this.location = location;
+    }
+
     public void setPublicKey(@Nullable String publicKey) {
         this.publicKey = publicKey;
     }

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

@@ -19,7 +19,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 = "6.1.0";
+    public static final String VERSION = "6.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.";
@@ -431,8 +431,12 @@ public class LiveUpdatePlugin extends Plugin {
         config.setAppId(appId);
         boolean autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.getAutoDeleteBundles());
         config.setAutoDeleteBundles(autoDeleteBundles);
+        String defaultChannel = getConfig().getString("defaultChannel", config.getDefaultChannel());
+        config.setDefaultChannel(defaultChannel);
         boolean enabled = getConfig().getBoolean("enabled", config.getEnabled());
         config.setEnabled(enabled);
+        String location = getConfig().getString("location", config.getLocation());
+        config.setLocation(location);
         String publicKey = getConfig().getString("publicKey", config.getPublicKey());
         config.setPublicKey(publicKey);
         int readyTimeout = getConfig().getInt("readyTimeout", config.getReadyTimeout());

package/dist/docs.json

@@ -746,6 +746,22 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "defaultChannel",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            },
+            {
+              "text": "'production'",
+              "name": "example"
+            }
+          ],
+          "docs": "The default channel of the app.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "enabled",
           "tags": [
@@ -762,6 +778,30 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "location",
+          "tags": [
+            {
+              "text": "6.2.0",
+              "name": "since"
+            },
+            {
+              "text": "'us'",
+              "name": "default"
+            },
+            {
+              "text": "'eu'",
+              "name": "example"
+            },
+            {
+              "text": "https ://capawesome.io/cloud/live-updates/advanced/privacy/",
+              "name": "see"
+            }
+          ],
+          "docs": "The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).",
+          "complexTypes": [],
+          "type": "'us' | 'eu' | undefined"
+        },
         {
           "name": "publicKey",
           "tags": [

package/dist/esm/definitions.d.ts

@@ -17,6 +17,13 @@ declare module '@capacitor/cli' {
              * @default false
              */
             autoDeleteBundles?: boolean;
+            /**
+             * The default channel of the app.
+             *
+             * @since 6.3.0
+             * @example 'production'
+             */
+            defaultChannel?: string;
             /**
              * Whether or not the plugin is enabled.
              *
@@ -24,6 +31,15 @@ declare module '@capacitor/cli' {
              * @default true
              */
             enabled?: boolean;
+            /**
+             * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).
+             *
+             * @since 6.2.0
+             * @default 'us'
+             * @example 'eu'
+             * @see https://capawesome.io/cloud/live-updates/advanced/privacy/
+             */
+            location?: 'us' | 'eu';
             /**
              * The public key to verify the integrity of the bundle.
              *

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    LiveUpdate?: {\n      /**\n       * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 5.0.0\n       * @example '4100e356-e851-47fe-9d3c-b411eb325a99'\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       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all available bundle identifiers.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the device identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * Notify the plugin that the app is ready to use and no rollback is needed.\n   *\n   * **Attention**: This method should be called as soon as the app is ready to use\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<void>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel of the app.\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 app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): 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(): Promise<SyncResult>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the bundle to verify the integrity of the ZIP file.\n   *\n   * Must be a SHA-256 hash in hexadecimal format.\n   *\n   * @since 6.1.0\n   * @example 'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'\n   */\n  checksum?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * The bundle must be a ZIP file containing at least a `index.html` file.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: 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 of the app.\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 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 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 app.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel of the app.\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 app.\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 5.0.0\n */\nexport interface SyncResult {\n  /**\n   * The identifier of the next bundle to use.\n   *\n   * If `null`, the app is up-to-date and no new bundle is available.\n   *\n   * @since 5.0.0\n   */\n  nextBundleId: string | null;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\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       * @since 5.0.0\n       * @example '4100e356-e851-47fe-9d3c-b411eb325a99'\n       */\n      appId?: string;\n      /**\n       * Whether or not to automatically delete unused bundles.\n       *\n       * When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n       *\n       * @since 5.0.0\n       * @default false\n       */\n      autoDeleteBundles?: boolean;\n      /**\n       * The default channel of the app.\n       *\n       * @since 6.3.0\n       * @example 'production'\n       */\n      defaultChannel?: string;\n      /**\n       * Whether or not the plugin is enabled.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      enabled?: boolean;\n      /**\n       * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).\n       *\n       * @since 6.2.0\n       * @default 'us'\n       * @example 'eu'\n       * @see https://capawesome.io/cloud/live-updates/advanced/privacy/\n       */\n      location?: 'us' | 'eu';\n      /**\n       * The public key to verify the integrity of the bundle.\n       *\n       * The public key must be a PEM-encoded RSA public key.\n       *\n       * @since 6.1.0\n       * @example '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'\n       */\n      publicKey?: string;\n      /**\n       * The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.\n       *\n       * @since 5.0.0\n       * @default 10000\n       */\n      readyTimeout?: number;\n      /**\n       * Whether or not the app should be reset to the default bundle during an update.\n       *\n       * @since 5.0.0\n       * @default true\n       */\n      resetOnUpdate?: boolean;\n    };\n  }\n}\n\nexport interface LiveUpdatePlugin {\n  /**\n   * Delete a bundle from the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  deleteBundle(options: DeleteBundleOptions): Promise<void>;\n  /**\n   * Download a bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  downloadBundle(options: DownloadBundleOptions): Promise<void>;\n  /**\n   * Get the active bundle identifier.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundle(): Promise<GetBundleResult>;\n  /**\n   * Get all available bundle identifiers.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getBundles(): Promise<GetBundlesResult>;\n  /**\n   * Get the channel of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getChannel(): Promise<GetChannelResult>;\n  /**\n   * Get the custom identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getCustomId(): Promise<GetCustomIdResult>;\n  /**\n   * Get the device identifier of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getDeviceId(): Promise<GetDeviceIdResult>;\n  /**\n   * Get the version code of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionCode(): Promise<GetVersionCodeResult>;\n  /**\n   * Get the version name of the app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  getVersionName(): Promise<GetVersionNameResult>;\n  /**\n   * Notify the plugin that the app is ready to use and no rollback is needed.\n   *\n   * **Attention**: This method should be called as soon as the app is ready to use\n   * to prevent the app from being reset to the default bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  ready(): Promise<void>;\n  /**\n   * Reload the app to apply the new bundle.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reload(): Promise<void>;\n  /**\n   * Reset the app to the default bundle.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  reset(): Promise<void>;\n  /**\n   * Set the next bundle to use for the app.\n   *\n   * Call `reload()` or restart the app to apply the changes.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setBundle(options: SetBundleOptions): Promise<void>;\n  /**\n   * Set the channel of the app.\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 app.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.0.0\n   */\n  setCustomId(options: SetCustomIdOptions): 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(): Promise<SyncResult>;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface DeleteBundleOptions {\n  /**\n   * The unique identifier of the bundle to delete.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\nexport interface DownloadBundleOptions {\n  /**\n   * The unique identifier of the bundle.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n  /**\n   * The checksum of the bundle to verify the integrity of the ZIP file.\n   *\n   * Must be a SHA-256 hash in hexadecimal format.\n   *\n   * @since 6.1.0\n   * @example 'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'\n   */\n  checksum?: string;\n  /**\n   * The URL of the bundle to download.\n   *\n   * The bundle must be a ZIP file containing at least a `index.html` file.\n   *\n   * @since 5.0.0\n   * @example 'https://example.com/bundle.zip'\n   */\n  url: 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 of the app.\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 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 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 app.\n   *\n   * If `null`, no custom identifier is set.\n   *\n   * @since 5.0.0\n   * @example '50d2a548-80b7-4dad-adc7-97c0e79d8a89'\n   */\n  customId: string | null;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetBundleOptions {\n  /**\n   * The unique identifier of the bundle to use.\n   *\n   * @since 5.0.0\n   * @example '1.0.0'\n   */\n  bundleId: string;\n}\n\n/**\n * @since 5.0.0\n */\nexport interface SetChannelOptions {\n  /**\n   * The channel of the app.\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 app.\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 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"]}

package/ios/Plugin/LiveUpdate.swift

@@ -89,7 +89,7 @@ import CommonCrypto
     }
 
     @objc public func getChannel(completion: @escaping (Result?, Error?) -> Void) {
-        let channel = preferences.getChannel()
+        let channel = getChannel()
         let result = GetChannelResult(channel: channel)
         completion(result, nil)
     }
@@ -372,13 +372,19 @@ import CommonCrypto
         parameters["appVersionCode"] = getVersionCode()
         parameters["appVersionName"] = getVersionName()
         parameters["bundleId"] = getCurrentBundleId()
-        parameters["channelName"] = preferences.getChannel()
+        parameters["channelName"] = getChannel()
         parameters["customId"] = preferences.getCustomId()
         parameters["deviceId"] = getDeviceId()
         parameters["osVersion"] = UIDevice.current.systemVersion
         parameters["platform"] = "1"
         parameters["pluginVersion"] = LiveUpdatePlugin.version
-        let url = URL(string: "https://api.cloud.capawesome.io/v1/apps/\(config.appId ?? "")/bundles/latest")!
+        var host = "api.cloud.capawesome.io"
+        if let location = config.location {
+            if location == "eu" {
+                host = "api.cloud.capawesome.eu"
+            }
+        }
+        let url = URL(string: "https://\(host)/v1/apps/\(config.appId ?? "")/bundles/latest")!
         AF.request(url, method: .get, parameters: parameters).validate().responseDecodable(of: GetLatestBundleResponse.self) { response in
             CAPLog.print("[", LiveUpdatePlugin.tag, "] Fetching latest bundle from ", response.request?.url?.absoluteString ?? "")
             if let error = response.error {
@@ -393,20 +399,6 @@ import CommonCrypto
         }
     }
 
-    private func getVersionCode() -> String {
-        guard let appVersionCode = Bundle.main.infoDictionary?["CFBundleVersion"] as? String else {
-            return ""
-        }
-        return appVersionCode
-    }
-
-    private func getVersionName() -> String {
-        guard let appVersionName = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String else {
-            return ""
-        }
-        return appVersionName
-    }
-
     private func getBundleIds() -> [String] {
         let url = libraryDirectoryUrl.appendingPathComponent(bundlesDirectory)
         do {
@@ -421,6 +413,17 @@ import CommonCrypto
         }
     }
 
+    private func getChannel() -> String? {
+        var channel: String?
+        if let _ = config.defaultChannel {
+            channel = config.defaultChannel
+        }
+        if let _ = preferences.getChannel() {
+            channel = preferences.getChannel()
+        }
+        return channel
+    }
+
     /// - Returns: The current bundle ID (`public` for the built-in bundle) or `nil` if no view controller was found.
     private func getCurrentBundleId() -> String? {
         guard let path = getCurrentCapacitorServerPath() else {
@@ -457,6 +460,20 @@ import CommonCrypto
         return defaultCapacitorServerPath
     }
 
+    private func getVersionCode() -> String {
+        guard let appVersionCode = Bundle.main.infoDictionary?["CFBundleVersion"] as? String else {
+            return ""
+        }
+        return appVersionCode
+    }
+
+    private func getVersionName() -> String {
+        guard let appVersionName = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String else {
+            return ""
+        }
+        return appVersionName
+    }
+
     private func hasBundle(bundleId: String) -> Bool {
         let path = buildBundlePathFor(bundleId: bundleId)
         return FileManager.default.fileExists(atPath: path)
@@ -480,11 +497,28 @@ import CommonCrypto
     }
 
     private func searchIndexHtmlFile(url: URL) -> URL? {
-        let enumerator = FileManager.default.enumerator(atPath: url.path)
-        while let element = enumerator?.nextObject() as? String {
-            if element.hasSuffix("index.html") {
-                return url.appendingPathComponent(element)
+        do {
+            let directoryContents = try FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil, options: [])
+            if directoryContents.isEmpty {
+                return nil
+            }
+            let fileNames = directoryContents.map { $0.lastPathComponent }
+            if fileNames.contains("index.html") {
+                return url.appendingPathComponent("index.html")
+            } else {
+                for fileUrl in directoryContents {
+                    var isDirectory: ObjCBool = false
+                    if FileManager.default.fileExists(atPath: fileUrl.path, isDirectory: &isDirectory) {
+                        if isDirectory.boolValue {
+                            if let indexHtmlFile = searchIndexHtmlFile(url: fileUrl) {
+                                return indexHtmlFile
+                            }
+                        }
+                    }
+                }
             }
+        } catch {
+            CAPLog.print("[", LiveUpdatePlugin.tag, "] ", "Failed to search index.html file: \(error.localizedDescription)")
         }
         return nil
     }

package/ios/Plugin/LiveUpdateConfig.swift

@@ -1,7 +1,9 @@
 public struct LiveUpdateConfig {
     var appId: String?
     var autoDeleteBundles = false
+    var defaultChannel: String?
     var enabled = true
+    var location: String?
     var publicKey: String?
     var readyTimeout = 10000
     var resetOnUpdate = true

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "6.1.0"
+    public static let version = "6.3.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     private var config: LiveUpdateConfig?
@@ -239,7 +239,9 @@ public class LiveUpdatePlugin: CAPPlugin {
 
         config.appId = getConfig().getString("appId", config.appId)
         config.autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.autoDeleteBundles)
+        config.defaultChannel = getConfig().getString("defaultChannel", config.defaultChannel)
         config.enabled = getConfig().getBoolean("enabled", config.enabled)
+        config.location = getConfig().getString("location", config.location)
         config.publicKey = getConfig().getString("publicKey", config.publicKey)
         config.readyTimeout = getConfig().getInt("readyTimeout", config.readyTimeout)
         config.resetOnUpdate = getConfig().getBoolean("resetOnUpdate", config.resetOnUpdate)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "6.1.0",
+  "version": "6.2.0-dev.4ebc29c.1723183892",
   "description": "Capacitor plugin to update your app remotely in real-time.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",