@capawesome/capacitor-live-update 8.1.1 → 8.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +112 -1
  2. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java +88 -1
  3. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateHttpClient.java +12 -1
  4. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java +31 -1
  5. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/api/GetChannelsResponseItem.java +28 -0
  6. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/FetchChannelsOptions.java +38 -0
  7. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/ChannelResult.java +28 -0
  8. package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/FetchChannelsResult.java +28 -0
  9. package/dist/docs.json +150 -2
  10. package/dist/esm/definitions.d.ts +83 -0
  11. package/dist/esm/definitions.js.map +1 -1
  12. package/dist/esm/web.d.ts +2 -1
  13. package/dist/esm/web.js +3 -0
  14. package/dist/esm/web.js.map +1 -1
  15. package/dist/plugin.cjs.js +3 -0
  16. package/dist/plugin.cjs.js.map +1 -1
  17. package/dist/plugin.js +3 -0
  18. package/dist/plugin.js.map +1 -1
  19. package/ios/Plugin/Classes/Options/FetchChannelsOptions.swift +26 -0
  20. package/ios/Plugin/Classes/Results/ChannelResult.swift +19 -0
  21. package/ios/Plugin/Classes/Results/FetchChannelsResult.swift +16 -0
  22. package/ios/Plugin/Enums/CustomError.swift +3 -0
  23. package/ios/Plugin/LiveUpdate.swift +43 -0
  24. package/ios/Plugin/LiveUpdateHttpClient.swift +11 -0
  25. package/ios/Plugin/LiveUpdatePlugin.swift +21 -1
  26. package/ios/Plugin/Protocols/Api/GetChannelsResponseItem.swift +4 -0
  27. package/package.json +1 -3
package/README.md CHANGED
@@ -21,6 +21,10 @@ We are proud to offer one of the most complete and feature-rich Capacitor plugin
21
21
  - 🛟 **Rollback**: Reset the app to the default bundle if an incompatible bundle has been set.
22
22
  - 🚀 **Rollout**: Gradually roll out new bundles to gather valuable feedback.
23
23
  - 🔁 **Delta Updates**: Make your updates faster by only downloading changed files.
24
+ - ⚙️ **Runtime Configuration**: Update plugin configuration at runtime without rebuilding the app.
25
+ - 📡 **Update Lifecycle Events**: Track download progress, react to bundle changes, and detect reloads with auto-blocking of rolled back bundles.
26
+ - 🏠 **Self-Hosted Bundles**: Download bundles from any URL, no Capawesome Cloud dependency required.
27
+ - 🏷️ **Custom Properties**: Associate custom key-value metadata with bundles via Capawesome Cloud.
24
28
  - 🔒 **Security**: Verify the authenticity and integrity of the bundle using a public key.
25
29
  - ⚔️ **Battle-Tested**: Used in more than 1,000 projects to update apps on more than 20,000,000 devices.
26
30
  - 🌐 **Open Source**: Licensed under the MIT License.
@@ -51,6 +55,21 @@ npx cap sync
51
55
 
52
56
  ### Android
53
57
 
58
+ #### Channel
59
+
60
+ 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.
61
+ This allows you to tie the channel to the version code at build time.
62
+
63
+ Add the following to your app's `build.gradle` file:
64
+
65
+ ```groovy
66
+ android {
67
+ defaultConfig {
68
+ resValue "string", "capawesome_live_update_default_channel", "production-" + defaultConfig.versionCode
69
+ }
70
+ }
71
+ ```
72
+
54
73
  #### Variables
55
74
 
56
75
  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 +81,18 @@ This can be useful if you encounter dependency conflicts with other plugins in y
62
81
 
63
82
  ### iOS
64
83
 
84
+ #### Channel
85
+
86
+ 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.
87
+ This allows you to tie the channel to the build version at build time.
88
+
89
+ Add the following to your `Info.plist` file:
90
+
91
+ ```xml
92
+ <key>CapawesomeLiveUpdateDefaultChannel</key>
93
+ <string>production-$(CURRENT_PROJECT_VERSION)</string>
94
+ ```
95
+
65
96
  #### Privacy manifest
66
97
 
67
98
  Add the `NSPrivacyAccessedAPICategoryUserDefaults` dictionary key to your [Privacy Manifest](https://capacitorjs.com/docs/ios/privacy-manifest) (usually `ios/App/PrivacyInfo.xcprivacy`):
@@ -100,7 +131,7 @@ We recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bun
100
131
  | **`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 |
101
132
  | **`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 |
102
133
  | **`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 |
103
- | **`defaultChannel`** | <code>string</code> | The default channel of the app. | | 6.3.0 |
134
+ | **`defaultChannel`** | <code>string</code> | The default channel of the app. This can be overridden by `setChannel()`, the `channel` parameter of `sync()`, or the native channel configuration (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel` in `strings.xml` on Android). | | 6.3.0 |
104
135
  | **`httpTimeout`** | <code>number</code> | The timeout in milliseconds for HTTP requests. | <code>60000</code> | 6.4.0 |
105
136
  | **`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 |
106
137
  | **`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 |
@@ -169,6 +200,11 @@ const downloadBundle = async () => {
169
200
  await LiveUpdate.downloadBundle({ url: 'https://example.com/1.0.0.zip', bundleId: '1.0.0' });
170
201
  };
171
202
 
203
+ const fetchChannels = async () => {
204
+ const result = await LiveUpdate.fetchChannels();
205
+ return result.channels;
206
+ };
207
+
172
208
  const fetchLatestBundle = async () => {
173
209
  await LiveUpdate.fetchLatestBundle();
174
210
  };
@@ -273,6 +309,7 @@ const isNewBundleAvailable = async () => {
273
309
  * [`clearBlockedBundles()`](#clearblockedbundles)
274
310
  * [`deleteBundle(...)`](#deletebundle)
275
311
  * [`downloadBundle(...)`](#downloadbundle)
312
+ * [`fetchChannels(...)`](#fetchchannels)
276
313
  * [`fetchLatestBundle(...)`](#fetchlatestbundle)
277
314
  * [`getBlockedBundles()`](#getblockedbundles)
278
315
  * [`getBundles()`](#getbundles)
@@ -363,6 +400,35 @@ Only available on Android and iOS.
363
400
  --------------------
364
401
 
365
402
 
403
+ ### fetchChannels(...)
404
+
405
+ ```typescript
406
+ fetchChannels(options?: FetchChannelsOptions | undefined) => Promise<FetchChannelsResult>
407
+ ```
408
+
409
+ Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).
410
+
411
+ This is primarily intended for development and QA purposes.
412
+ It allows you to retrieve a list of available channels so you can
413
+ dynamically switch between them using `setChannel(...)`.
414
+
415
+ **Attention**: Only works for apps with public channels enabled.
416
+ If channels are private, they can still be set using `setChannel(...)`
417
+ but won't be returned by this method.
418
+
419
+ Only available on Android and iOS.
420
+
421
+ | Param | Type |
422
+ | ------------- | --------------------------------------------------------------------- |
423
+ | **`options`** | <code><a href="#fetchchannelsoptions">FetchChannelsOptions</a></code> |
424
+
425
+ **Returns:** <code>Promise&lt;<a href="#fetchchannelsresult">FetchChannelsResult</a>&gt;</code>
426
+
427
+ **Since:** 8.2.0
428
+
429
+ --------------------
430
+
431
+
366
432
  ### fetchLatestBundle(...)
367
433
 
368
434
  ```typescript
@@ -429,6 +495,15 @@ getChannel() => Promise<GetChannelResult>
429
495
 
430
496
  Get the channel that is used for the update.
431
497
 
498
+ The channel is resolved in the following order (highest priority first):
499
+ 1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
500
+ 2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
501
+ `capawesome_live_update_default_channel` in `strings.xml` on Android)
502
+ 3. Capacitor config `defaultChannel`
503
+
504
+ **Note**: The `channel` parameter of `sync()` takes the highest priority
505
+ but is not persisted and therefore not returned by this method.
506
+
432
507
  Only available on Android and iOS.
433
508
 
434
509
  **Returns:** <code>Promise&lt;<a href="#getchannelresult">GetChannelResult</a>&gt;</code>
@@ -891,6 +966,30 @@ Remove all listeners for this plugin.
891
966
  | **`url`** | <code>string</code> | The URL of the bundle to download. For the `zip` artifact type, the URL must point to a ZIP file. For the `manifest` artifact type, the URL serves as the base URL to download the individual files. For example, if the URL is `https://example.com/download`, the plugin will download the file with the href `index.html` from `https://example.com/download?href=index.html`. To **verify the integrity** of the file, the server should return a `X-Checksum` header with the SHA-256 hash in hex format. To **verify the signature** of the file, the server should return a `X-Signature` header with the signed SHA-256 hash in base64 format. | | 5.0.0 |
892
967
 
893
968
 
969
+ #### FetchChannelsResult
970
+
971
+ | Prop | Type | Description | Since |
972
+ | -------------- | ---------------------- | --------------------- | ----- |
973
+ | **`channels`** | <code>Channel[]</code> | The list of channels. | 8.2.0 |
974
+
975
+
976
+ #### Channel
977
+
978
+ | Prop | Type | Description | Since |
979
+ | ---------- | ------------------- | ------------------------------------- | ----- |
980
+ | **`id`** | <code>string</code> | The unique identifier of the channel. | 8.2.0 |
981
+ | **`name`** | <code>string</code> | The name of the channel. | 8.2.0 |
982
+
983
+
984
+ #### FetchChannelsOptions
985
+
986
+ | Prop | Type | Description | Default | Since |
987
+ | ------------ | ------------------- | ----------------------------------------- | --------------- | ----- |
988
+ | **`limit`** | <code>number</code> | The maximum number of channels to return. | <code>50</code> | 8.2.0 |
989
+ | **`offset`** | <code>number</code> | The number of channels to skip. | <code>0</code> | 8.2.0 |
990
+ | **`query`** | <code>string</code> | The query to filter channels by name. | | 8.2.0 |
991
+
992
+
894
993
  #### FetchLatestBundleResult
895
994
 
896
995
  | Prop | Type | Description | Since |
@@ -1129,6 +1228,18 @@ For this reason, you must be careful to [restrict live updates to compatible nat
1129
1228
 
1130
1229
  ## FAQ
1131
1230
 
1231
+ ### How do I set a channel?
1232
+
1233
+ There are four ways to set a channel, listed from lowest to highest priority:
1234
+
1235
+ 1. **Capacitor config**: Set the `defaultChannel` property in the [plugin configuration](#configuration). This is the simplest way to set a static default channel.
1236
+ 2. **Native config**: Set `CapawesomeLiveUpdateDefaultChannel` in `Info.plist` (iOS) or `capawesome_live_update_default_channel` in `strings.xml` (Android). This is useful for [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels) where the channel is tied to the build version.
1237
+ 3. **[`setChannel(...)`](#setchannel)**: Set the channel at runtime. The value is persisted across app restarts.
1238
+ 4. **[`sync(...)`](#sync)**: Pass a `channel` option to override the channel for a single sync call. This does **not** persist the channel.
1239
+
1240
+ Each method overrides the ones above it.
1241
+ You can check the currently resolved channel by calling [`getChannel()`](#getchannel).
1242
+
1132
1243
  ### Why can't I see my changes during development?
1133
1244
 
1134
1245
  As soon as you have installed a live update, the app will use the live update bundle and no longer the default bundle.
@@ -15,17 +15,21 @@ import com.getcapacitor.Logger;
15
15
  import com.getcapacitor.plugin.WebView;
16
16
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.Manifest;
17
17
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.ManifestItem;
18
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.api.GetChannelsResponseItem;
18
19
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.api.GetLatestBundleResponse;
19
20
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundleProgressEvent;
20
21
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.NextBundleSetEvent;
21
22
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
22
23
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
24
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchChannelsOptions;
23
25
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
24
26
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
25
27
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetConfigOptions;
26
28
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
27
29
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
28
30
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SyncOptions;
31
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.ChannelResult;
32
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchChannelsResult;
29
33
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchLatestBundleResult;
30
34
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBlockedBundlesResult;
31
35
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBundlesResult;
@@ -65,6 +69,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
65
69
  import java.util.concurrent.atomic.AtomicLong;
66
70
  import java.util.concurrent.atomic.AtomicReference;
67
71
  import net.lingala.zip4j.ZipFile;
72
+ import net.lingala.zip4j.model.FileHeader;
68
73
  import okhttp3.Call;
69
74
  import okhttp3.HttpUrl;
70
75
  import okhttp3.Response;
@@ -115,6 +120,9 @@ public class LiveUpdate {
115
120
  // Check version and reset config if version changed
116
121
  checkAndResetConfigIfVersionChanged();
117
122
 
123
+ // Set the device ID on the HTTP client (after any potential config reset)
124
+ this.httpClient.setDeviceId(getDeviceId());
125
+
118
126
  // Start the rollback timer to rollback to the default bundle
119
127
  // if the app is not ready after a certain time
120
128
  startRollbackTimer();
@@ -159,6 +167,63 @@ public class LiveUpdate {
159
167
  }
160
168
  }
161
169
 
170
+ public void fetchChannels(@NonNull FetchChannelsOptions options, @NonNull NonEmptyCallback<FetchChannelsResult> callback) {
171
+ try {
172
+ HttpUrl.Builder urlBuilder = new HttpUrl.Builder()
173
+ .scheme("https")
174
+ .host(config.getServerDomain())
175
+ .addPathSegment("v1")
176
+ .addPathSegment("apps")
177
+ .addPathSegment(getAppId())
178
+ .addPathSegment("channels");
179
+ if (options.getLimit() != null) {
180
+ urlBuilder.addQueryParameter("limit", String.valueOf(options.getLimit()));
181
+ }
182
+ if (options.getOffset() != null) {
183
+ urlBuilder.addQueryParameter("offset", String.valueOf(options.getOffset()));
184
+ }
185
+ if (options.getQuery() != null) {
186
+ urlBuilder.addQueryParameter("query", options.getQuery());
187
+ }
188
+ String url = urlBuilder.build().toString();
189
+
190
+ httpClient.enqueue(
191
+ url,
192
+ new NonEmptyCallback<Response>() {
193
+ @Override
194
+ public void success(@NonNull Response response) {
195
+ try {
196
+ String responseBodyString = response.body().string();
197
+ if (response.isSuccessful()) {
198
+ JSONArray responseJsonArray = new JSONArray(responseBodyString);
199
+ ChannelResult[] channels = new ChannelResult[responseJsonArray.length()];
200
+ for (int i = 0; i < responseJsonArray.length(); i++) {
201
+ GetChannelsResponseItem item = new GetChannelsResponseItem(responseJsonArray.getJSONObject(i));
202
+ channels[i] = new ChannelResult(item.getId(), item.getName());
203
+ }
204
+ FetchChannelsResult result = new FetchChannelsResult(channels);
205
+ callback.success(result);
206
+ } else if (response.code() == 401) {
207
+ callback.error(new Exception("Unauthorized. Channel Discovery may not be enabled for this app."));
208
+ } else {
209
+ callback.error(new Exception(responseBodyString));
210
+ }
211
+ } catch (Exception e) {
212
+ callback.error(e);
213
+ }
214
+ }
215
+
216
+ @Override
217
+ public void error(@NonNull Exception exception) {
218
+ callback.error(exception);
219
+ }
220
+ }
221
+ );
222
+ } catch (Exception e) {
223
+ callback.error(e);
224
+ }
225
+ }
226
+
162
227
  public void fetchLatestBundle(@NonNull FetchLatestBundleOptions options, @NonNull NonEmptyCallback<FetchLatestBundleResult> callback) {
163
228
  fetchLatestBundleInternal(
164
229
  options,
@@ -1015,12 +1080,28 @@ public class LiveUpdate {
1015
1080
  if (config.getDefaultChannel() != null) {
1016
1081
  channel = config.getDefaultChannel();
1017
1082
  }
1083
+ String nativeChannel = getNativeChannel();
1084
+ if (nativeChannel != null) {
1085
+ channel = nativeChannel;
1086
+ }
1018
1087
  if (preferences.getChannel() != null) {
1019
1088
  channel = preferences.getChannel();
1020
1089
  }
1021
1090
  return channel;
1022
1091
  }
1023
1092
 
1093
+ @Nullable
1094
+ private String getNativeChannel() {
1095
+ int resId = plugin
1096
+ .getContext()
1097
+ .getResources()
1098
+ .getIdentifier("capawesome_live_update_default_channel", "string", plugin.getContext().getPackageName());
1099
+ if (resId == 0) {
1100
+ return null;
1101
+ }
1102
+ return plugin.getContext().getResources().getString(resId);
1103
+ }
1104
+
1024
1105
  /**
1025
1106
  * @return The current bundle ID or `null` if the default bundle is in use.
1026
1107
  */
@@ -1352,7 +1433,13 @@ public class LiveUpdate {
1352
1433
  private File unzipFile(@NonNull File zipFile) throws IOException {
1353
1434
  File destination = buildTemporaryDirectory();
1354
1435
  String destinationPath = destination.getPath();
1355
- new ZipFile(zipFile).extractAll(destinationPath);
1436
+ ZipFile zip = new ZipFile(zipFile);
1437
+ // Clear stored Unix permissions to prevent EACCES errors on newer Android versions
1438
+ // where restrictive directory permissions from the zip block file creation.
1439
+ for (FileHeader fileHeader : zip.getFileHeaders()) {
1440
+ fileHeader.setExternalFileAttributes(null);
1441
+ }
1442
+ zip.extractAll(destinationPath);
1356
1443
  return destination;
1357
1444
  }
1358
1445
 
@@ -25,6 +25,9 @@ public class LiveUpdateHttpClient {
25
25
  @NonNull
26
26
  private final LiveUpdateConfig config;
27
27
 
28
+ @Nullable
29
+ private String deviceId;
30
+
28
31
  @NonNull
29
32
  private final OkHttpClient okHttpClient;
30
33
 
@@ -62,8 +65,16 @@ public class LiveUpdateHttpClient {
62
65
  .build();
63
66
  }
64
67
 
68
+ public void setDeviceId(@NonNull String deviceId) {
69
+ this.deviceId = deviceId;
70
+ }
71
+
65
72
  public Call enqueue(String url, NonEmptyCallback<Response> callback) {
66
- Request request = new Request.Builder().url(url).build();
73
+ Request.Builder builder = new Request.Builder().url(url);
74
+ if (deviceId != null) {
75
+ builder.addHeader("X-Capawesome-Device-Id", deviceId);
76
+ }
77
+ Request request = builder.build();
67
78
 
68
79
  Call call = okHttpClient.newCall(request);
69
80
  call.enqueue(
@@ -14,12 +14,14 @@ import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundl
14
14
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.NextBundleSetEvent;
15
15
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
16
16
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
17
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchChannelsOptions;
17
18
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
18
19
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
19
20
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetConfigOptions;
20
21
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
21
22
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
22
23
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SyncOptions;
24
+ import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchChannelsResult;
23
25
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchLatestBundleResult;
24
26
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBlockedBundlesResult;
25
27
  import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetConfigResult;
@@ -35,7 +37,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
35
37
  public class LiveUpdatePlugin extends Plugin {
36
38
 
37
39
  public static final String TAG = "LiveUpdate";
38
- public static final String VERSION = "8.1.0";
40
+ public static final String VERSION = "8.2.0";
39
41
  public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdate"; // DO NOT CHANGE
40
42
  public static final String ERROR_APP_ID_MISSING = "appId must be configured.";
41
43
  public static final String ERROR_BUNDLE_EXISTS = "bundle already exists.";
@@ -178,6 +180,34 @@ public class LiveUpdatePlugin extends Plugin {
178
180
  }
179
181
  }
180
182
 
183
+ @PluginMethod
184
+ public void fetchChannels(PluginCall call) {
185
+ try {
186
+ String appId = config.getAppId();
187
+ if (appId == null || appId.isEmpty()) {
188
+ call.reject(ERROR_APP_ID_MISSING);
189
+ return;
190
+ }
191
+
192
+ FetchChannelsOptions options = new FetchChannelsOptions(call);
193
+ NonEmptyCallback<FetchChannelsResult> callback = new NonEmptyCallback<>() {
194
+ @Override
195
+ public void success(FetchChannelsResult result) {
196
+ resolveCall(call, result.toJSObject());
197
+ }
198
+
199
+ @Override
200
+ public void error(Exception exception) {
201
+ rejectCall(call, exception);
202
+ }
203
+ };
204
+
205
+ implementation.fetchChannels(options, callback);
206
+ } catch (Exception exception) {
207
+ rejectCall(call, exception);
208
+ }
209
+ }
210
+
181
211
  @PluginMethod
182
212
  public void fetchLatestBundle(PluginCall call) {
183
213
  try {
@@ -0,0 +1,28 @@
1
+ package io.capawesome.capacitorjs.plugins.liveupdate.classes.api;
2
+
3
+ import androidx.annotation.NonNull;
4
+ import org.json.JSONObject;
5
+
6
+ public class GetChannelsResponseItem {
7
+
8
+ @NonNull
9
+ private final String id;
10
+
11
+ @NonNull
12
+ private final String name;
13
+
14
+ public GetChannelsResponseItem(@NonNull JSONObject responseJson) {
15
+ this.id = responseJson.optString("id");
16
+ this.name = responseJson.optString("name");
17
+ }
18
+
19
+ @NonNull
20
+ public String getId() {
21
+ return id;
22
+ }
23
+
24
+ @NonNull
25
+ public String getName() {
26
+ return name;
27
+ }
28
+ }
@@ -0,0 +1,38 @@
1
+ package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
2
+
3
+ import androidx.annotation.NonNull;
4
+ import androidx.annotation.Nullable;
5
+ import com.getcapacitor.PluginCall;
6
+
7
+ public class FetchChannelsOptions {
8
+
9
+ @Nullable
10
+ private final Integer limit;
11
+
12
+ @Nullable
13
+ private final Integer offset;
14
+
15
+ @Nullable
16
+ private final String query;
17
+
18
+ public FetchChannelsOptions(@NonNull PluginCall call) {
19
+ this.limit = call.getInt("limit");
20
+ this.offset = call.getInt("offset");
21
+ this.query = call.getString("query");
22
+ }
23
+
24
+ @Nullable
25
+ public Integer getLimit() {
26
+ return limit;
27
+ }
28
+
29
+ @Nullable
30
+ public Integer getOffset() {
31
+ return offset;
32
+ }
33
+
34
+ @Nullable
35
+ public String getQuery() {
36
+ return query;
37
+ }
38
+ }
@@ -0,0 +1,28 @@
1
+ package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
2
+
3
+ import androidx.annotation.NonNull;
4
+ import com.getcapacitor.JSObject;
5
+ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
6
+
7
+ public class ChannelResult implements Result {
8
+
9
+ @NonNull
10
+ private final String id;
11
+
12
+ @NonNull
13
+ private final String name;
14
+
15
+ public ChannelResult(@NonNull String id, @NonNull String name) {
16
+ this.id = id;
17
+ this.name = name;
18
+ }
19
+
20
+ @NonNull
21
+ @Override
22
+ public JSObject toJSObject() {
23
+ JSObject result = new JSObject();
24
+ result.put("id", id);
25
+ result.put("name", name);
26
+ return result;
27
+ }
28
+ }
@@ -0,0 +1,28 @@
1
+ package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
2
+
3
+ import androidx.annotation.NonNull;
4
+ import com.getcapacitor.JSArray;
5
+ import com.getcapacitor.JSObject;
6
+ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
7
+
8
+ public class FetchChannelsResult implements Result {
9
+
10
+ @NonNull
11
+ private final ChannelResult[] channels;
12
+
13
+ public FetchChannelsResult(@NonNull ChannelResult[] channels) {
14
+ this.channels = channels;
15
+ }
16
+
17
+ @NonNull
18
+ @Override
19
+ public JSObject toJSObject() {
20
+ JSObject result = new JSObject();
21
+ JSArray channelsArray = new JSArray();
22
+ for (ChannelResult channel : channels) {
23
+ channelsArray.put(channel.toJSObject());
24
+ }
25
+ result.put("channels", channelsArray);
26
+ return result;
27
+ }
28
+ }