feat(live-update): add native channel configuration support (#783)

* feat(live-update): add native channel configuration support

* docs: add changeset

* style: format

Author: robingenz

.changeset/full-pigs-eat.md

@@ -0,0 +1,5 @@
+---
+'@capawesome/capacitor-live-update': minor
+---
+
+feat: add native channel configuration support

packages/live-update/README.md

@@ -51,6 +51,21 @@ npx cap sync
 
 ### Android
 
+#### Channel
+
+If you are using [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels), you can set a default channel directly in your native project by adding a string resource.
+This allows you to tie the channel to the version code at build time.
+
+Add the following to your app's `build.gradle` file:
+
+```groovy
+android {
+    defaultConfig {
+        resValue "string", "capawesome_live_update_default_channel", "production-" + defaultConfig.versionCode
+    }
+}
+```
+
 #### Variables
 
 If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency:
@@ -62,6 +77,18 @@ This can be useful if you encounter dependency conflicts with other plugins in y
 
 ### iOS
 
+#### Channel
+
+If you are using [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels), you can set a default channel directly in your native project by adding a key to your `Info.plist` file.
+This allows you to tie the channel to the build version at build time.
+
+Add the following to your `Info.plist` file:
+
+```xml
+<key>CapawesomeLiveUpdateDefaultChannel</key>
+<string>production-$(CURRENT_PROJECT_VERSION)</string>
+```
+
 #### Privacy manifest
 
 Add the `NSPrivacyAccessedAPICategoryUserDefaults` dictionary key to your [Privacy Manifest](https://capacitorjs.com/docs/ios/privacy-manifest) (usually `ios/App/PrivacyInfo.xcprivacy`):
@@ -100,7 +127,7 @@ We recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bun
 | **`autoBlockRolledBackBundles`** | <code>boolean</code>                | 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. | <code>false</code>                     | 7.3.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 |
 | **`autoUpdateStrategy`**         | <code>'none' \| 'background'</code> | 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.                                                                                              | <code>'none'</code>                    | 7.3.0 |
-| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app.                                                                                                                                                                                                                                                                                                                                                                                            |                                        | 6.3.0 |
+| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app. This can be overridden by `setChannel()` or the `channel` parameter of `sync()`. It takes priority over the native channel configuration (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel` in `strings.xml` on Android).                                                                                                            |                                        | 6.3.0 |
 | **`httpTimeout`**                | <code>number</code>                 | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                                                                                                                                                             | <code>60000</code>                     | 6.4.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. 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. Set to `0` to disable the timeout.          | <code>0</code>                         | 5.0.0 |
@@ -429,6 +456,15 @@ getChannel() => Promise<GetChannelResult>
 
 Get the channel that is used for the update.
 
+The channel is resolved in the following order (highest priority first):
+1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
+2. Capacitor config `defaultChannel`
+3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
+   `capawesome_live_update_default_channel` in `strings.xml` on Android)
+
+**Note**: The `channel` parameter of `sync()` takes the highest priority
+but is not persisted and therefore not returned by this method.
+
 Only available on Android and iOS.
 
 **Returns:** <code>Promise&lt;<a href="#getchannelresult">GetChannelResult</a>&gt;</code>

packages/live-update/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java

@@ -1012,6 +1012,10 @@ private String getAppId() {
     @Nullable
     private String getChannel() {
         String channel = null;
+        String nativeChannel = getNativeChannel();
+        if (nativeChannel != null) {
+            channel = nativeChannel;
+        }
         if (config.getDefaultChannel() != null) {
             channel = config.getDefaultChannel();
         }
@@ -1021,6 +1025,18 @@ private String getChannel() {
         return channel;
     }
 
+    @Nullable
+    private String getNativeChannel() {
+        int resId = plugin
+            .getContext()
+            .getResources()
+            .getIdentifier("capawesome_live_update_default_channel", "string", plugin.getContext().getPackageName());
+        if (resId == 0) {
+            return null;
+        }
+        return plugin.getContext().getResources().getString(resId);
+    }
+
     /**
      * @return The current bundle ID or `null` if the default bundle is in use.
      */

packages/live-update/ios/Plugin/LiveUpdate.swift

@@ -601,6 +601,9 @@ import CommonCrypto
 
     private func getChannel() -> String? {
         var channel: String?
+        if let nativeChannel = getNativeChannel() {
+            channel = nativeChannel
+        }
         if let _ = config.defaultChannel {
             channel = config.defaultChannel
         }
@@ -610,6 +613,10 @@ import CommonCrypto
         return channel
     }
 
+    private func getNativeChannel() -> String? {
+        return Bundle.main.object(forInfoDictionaryKey: "CapawesomeLiveUpdateDefaultChannel") as? String
+    }
+
     /// - Returns: The sha256 checksum of the file at the given URL.
     private func getChecksumForFile(url: URL) throws -> String {
         let handle = try FileHandle(forReadingFrom: url)

packages/live-update/src/definitions.ts

@@ -57,6 +57,11 @@ declare module '@capacitor/cli' {
       /**
        * The default channel of the app.
        *
+       * This can be overridden by `setChannel()` or the `channel` parameter of `sync()`.
+       * It takes priority over the native channel configuration
+       * (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`
+       * in `strings.xml` on Android).
+       *
        * @since 6.3.0
        * @example 'production'
        */
@@ -166,6 +171,15 @@ export interface LiveUpdatePlugin {
   /**
    * Get the channel that is used for the update.
    *
+   * The channel is resolved in the following order (highest priority first):
+   * 1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
+   * 2. Capacitor config `defaultChannel`
+   * 3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
+   *    `capawesome_live_update_default_channel` in `strings.xml` on Android)
+   *
+   * **Note**: The `channel` parameter of `sync()` takes the highest priority
+   * but is not persisted and therefore not returned by this method.
+   *
    * Only available on Android and iOS.
    *
    * @since 5.0.0