@capawesome/capacitor-live-update 6.5.0 → 6.7.0

package/README.md

@@ -103,7 +103,7 @@ In `capacitor.config.json`:
 In `capacitor.config.ts`:
 
 ```ts
-/// <reference types="@capacitor/live-update" />
+/// <reference types="@capawesome/capacitor-live-update" />
 
 import { CapacitorConfig } from '@capacitor/cli';
 
@@ -128,10 +128,6 @@ export default config;
 
 </docgen-config>
 
-## Demo
-
-A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)
-
 ## Starter templates
 
 The following starter templates are available:
@@ -156,9 +152,8 @@ const downloadBundle = async () => {
   await LiveUpdate.downloadBundle({ url: 'https://example.com/1.0.0.zip', bundleId: '1.0.0' });
 };
 
-const getBundle = async () => {
-  const result = await LiveUpdate.getBundle();
-  return result.bundleId;
+const fetchLatestBundle = async () => {
+  await LiveUpdate.fetchLatestBundle();
 };
 
 const getBundles = async () => {
@@ -171,6 +166,11 @@ const getChannel = async () => {
   return result.channel;
 };
 
+const getCurrentBundle = async () => {
+  const result = await LiveUpdate.getCurrentBundle();
+  return result.bundleId;
+};
+
 const getCustomId = async () => {
   const result = await LiveUpdate.getCustomId();
   return result.customId;
@@ -181,6 +181,11 @@ const getDeviceId = async () => {
   return result.deviceId;
 };
 
+const getNextBundle = async () => {
+  const result = await LiveUpdate.getNextBundle();
+  return result.bundleId;
+};
+
 const getVersionCode = async () => {
   const result = await LiveUpdate.getVersionCode();
   return result.versionCode;
@@ -203,10 +208,6 @@ const reset = async () => {
   await LiveUpdate.reset();
 };
 
-const setBundle = async () => {
-  await LiveUpdate.setBundle({ bundleId: '1.0.0' });
-};
-
 const setChannel = async () => {
   await LiveUpdate.setChannel({ channel: 'beta' });
 };
@@ -215,10 +216,24 @@ const setCustomId = async () => {
   await LiveUpdate.setCustomId({ customId: 'my-custom-id' });
 };
 
+const setNextBundle = async () => {
+  await LiveUpdate.setNextBundle({ bundleId: '1.0.0' });
+};
+
 const sync = async () => {
   const result = await LiveUpdate.sync();
   return result.nextBundleId;
 };
+
+const isNewBundleAvailable = async () => {
+  const { bundleId: latestBundleId } = await LiveUpdate.fetchLatestBundle();
+  if (latestBundleId) {
+    const { bundleId: currentBundleId } = await LiveUpdate.getBundle();
+    return latestBundleId !== currentBundleId;
+  } else {
+    return false;
+  }
+};
 ```
 
 ## API
@@ -227,11 +242,14 @@ const sync = async () => {
 
 * [`deleteBundle(...)`](#deletebundle)
 * [`downloadBundle(...)`](#downloadbundle)
+* [`fetchLatestBundle(...)`](#fetchlatestbundle)
 * [`getBundle()`](#getbundle)
 * [`getBundles()`](#getbundles)
 * [`getChannel()`](#getchannel)
+* [`getCurrentBundle()`](#getcurrentbundle)
 * [`getCustomId()`](#getcustomid)
 * [`getDeviceId()`](#getdeviceid)
+* [`getNextBundle()`](#getnextbundle)
 * [`getVersionCode()`](#getversioncode)
 * [`getVersionName()`](#getversionname)
 * [`ready()`](#ready)
@@ -240,7 +258,8 @@ const sync = async () => {
 * [`setBundle(...)`](#setbundle)
 * [`setChannel(...)`](#setchannel)
 * [`setCustomId(...)`](#setcustomid)
-* [`sync()`](#sync)
+* [`setNextBundle(...)`](#setnextbundle)
+* [`sync(...)`](#sync)
 * [Interfaces](#interfaces)
 
 </docgen-index>
@@ -286,6 +305,27 @@ Only available on Android and iOS.
 --------------------
 
 
+### fetchLatestBundle(...)
+
+```typescript
+fetchLatestBundle(options?: FetchLatestBundleOptions | undefined) => Promise<FetchLatestBundleResult>
+```
+
+Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#fetchlatestbundleoptions">FetchLatestBundleOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#fetchlatestbundleresult">FetchLatestBundleResult</a>&gt;</code>
+
+**Since:** 6.6.0
+
+--------------------
+
+
 ### getBundle()
 
 ```typescript
@@ -326,7 +366,7 @@ Only available on Android and iOS.
 getChannel() => Promise<GetChannelResult>
 ```
 
-Get the channel of the app.
+Get the channel that is used for the update.
 
 Only available on Android and iOS.
 
@@ -337,13 +377,31 @@ Only available on Android and iOS.
 --------------------
 
 
+### getCurrentBundle()
+
+```typescript
+getCurrentBundle() => Promise<GetCurrentBundleResult>
+```
+
+Get the bundle identifier of the current bundle.
+The current bundle is the bundle that is currently used by the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getcurrentbundleresult">GetCurrentBundleResult</a>&gt;</code>
+
+**Since:** 6.7.0
+
+--------------------
+
+
 ### getCustomId()
 
 ```typescript
 getCustomId() => Promise<GetCustomIdResult>
 ```
 
-Get the custom identifier of the app.
+Get the custom identifier of the device.
 
 Only available on Android and iOS.
 
@@ -360,7 +418,7 @@ Only available on Android and iOS.
 getDeviceId() => Promise<GetDeviceIdResult>
 ```
 
-Get the device identifier of the app.
+Get the unique device identifier.
 
 Only available on Android and iOS.
 
@@ -371,6 +429,25 @@ Only available on Android and iOS.
 --------------------
 
 
+### getNextBundle()
+
+```typescript
+getNextBundle() => Promise<GetNextBundleResult>
+```
+
+Get the bundle identifier of the next bundle.
+The next bundle is the bundle that will be used after calling `reload()`
+or restarting the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getnextbundleresult">GetNextBundleResult</a>&gt;</code>
+
+**Since:** 6.7.0
+
+--------------------
+
+
 ### getVersionCode()
 
 ```typescript
@@ -482,7 +559,7 @@ Only available on Android and iOS.
 setChannel(options: SetChannelOptions) => Promise<void>
 ```
 
-Set the channel of the app.
+Set the channel to use for the update.
 
 Only available on Android and iOS.
 
@@ -501,7 +578,7 @@ Only available on Android and iOS.
 setCustomId(options: SetCustomIdOptions) => Promise<void>
 ```
 
-Set the custom identifier of the app.
+Set the custom identifier of the device.
 
 Only available on Android and iOS.
 
@@ -514,10 +591,31 @@ Only available on Android and iOS.
 --------------------
 
 
-### sync()
+### setNextBundle(...)
 
 ```typescript
-sync() => Promise<SyncResult>
+setNextBundle(options: SetNextBundleOptions) => Promise<void>
+```
+
+Set the next bundle to use for the app.
+
+Call `reload()` or restart the app to apply the changes.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                  |
+| ------------- | --------------------------------------------------------------------- |
+| **`options`** | <code><a href="#setnextbundleoptions">SetNextBundleOptions</a></code> |
+
+**Since:** 6.7.0
+
+--------------------
+
+
+### sync(...)
+
+```typescript
+sync(options?: SyncOptions | undefined) => Promise<SyncResult>
 ```
 
 Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).
@@ -526,6 +624,10 @@ Call `reload()` or restart the app to apply the changes.
 
 Only available on Android and iOS.
 
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#syncoptions">SyncOptions</a></code> |
+
 **Returns:** <code>Promise&lt;<a href="#syncresult">SyncResult</a>&gt;</code>
 
 **Since:** 5.0.0
@@ -545,11 +647,28 @@ Only available on Android and iOS.
 
 #### DownloadBundleOptions
 
-| Prop           | Type                | Description                                                                                                       | Since |
-| -------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------- | ----- |
-| **`bundleId`** | <code>string</code> | The unique identifier of the bundle.                                                                              | 5.0.0 |
-| **`checksum`** | <code>string</code> | The checksum of the bundle to verify the integrity of the ZIP file. Must be a SHA-256 hash in hexadecimal format. | 6.1.0 |
-| **`url`**      | <code>string</code> | The URL of the bundle to download. The bundle must be a ZIP file containing at least a `index.html` file.         | 5.0.0 |
+| Prop               | Type                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default            | Since |
+| ------------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`artifactType`** | <code>'manifest' \| 'zip'</code> | The artifact type of the bundle.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | <code>'zip'</code> | 6.6.0 |
+| **`bundleId`**     | <code>string</code>              | The unique identifier of the bundle.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                    | 5.0.0 |
+| **`checksum`**     | <code>string</code>              | The checksum of the bundle to verify the integrity of the ZIP file. Must be a SHA-256 hash in base64 format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                    | 6.1.0 |
+| **`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 must return a `X-Checksum` header with the SHA-256 hash in base64 format. To **verify the signature** of the file, the server must return a `X-Signature` header with the signed SHA-256 hash in base64 format. |                    | 5.0.0 |
+
+
+#### FetchLatestBundleResult
+
+| Prop               | Type                             | Description                                                                                                         | Since |
+| ------------------ | -------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`artifactType`** | <code>'manifest' \| 'zip'</code> | The artifact type of the bundle.                                                                                    | 6.7.0 |
+| **`bundleId`**     | <code>string \| null</code>      | The unique identifier of the latest bundle. If `null`, no bundle is available.                                      | 6.6.0 |
+| **`downloadUrl`**  | <code>string</code>              | The URL of the latest bundle to download. Pass this URL to the `downloadBundle(...)` method to download the bundle. | 6.7.0 |
+
+
+#### FetchLatestBundleOptions
+
+| Prop          | Type                | Description                                                      | Since |
+| ------------- | ------------------- | ---------------------------------------------------------------- | ----- |
+| **`channel`** | <code>string</code> | The name of the channel where the latest bundle is fetched from. | 6.7.0 |
 
 
 #### GetBundleResult
@@ -568,16 +687,23 @@ Only available on Android and iOS.
 
 #### GetChannelResult
 
-| Prop          | Type                        | Description                                                              | Since |
-| ------------- | --------------------------- | ------------------------------------------------------------------------ | ----- |
-| **`channel`** | <code>string \| null</code> | The channel of the app. If `null`, the app is using the default channel. | 5.0.0 |
+| Prop          | Type                        | Description                                                        | Since |
+| ------------- | --------------------------- | ------------------------------------------------------------------ | ----- |
+| **`channel`** | <code>string \| null</code> | The channel name. If `null`, the app is using the default channel. | 5.0.0 |
+
+
+#### GetCurrentBundleResult
+
+| Prop           | Type                        | Description                                                                               | Since |
+| -------------- | --------------------------- | ----------------------------------------------------------------------------------------- | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the current bundle. If `null`, the default bundle is being used. | 6.7.0 |
 
 
 #### GetCustomIdResult
 
-| Prop           | Type                        | Description                                                               | Since |
-| -------------- | --------------------------- | ------------------------------------------------------------------------- | ----- |
-| **`customId`** | <code>string \| null</code> | The custom identifier of the app. If `null`, no custom identifier is set. | 5.0.0 |
+| Prop           | Type                        | Description                                                                  | Since |
+| -------------- | --------------------------- | ---------------------------------------------------------------------------- | ----- |
+| **`customId`** | <code>string \| null</code> | The custom identifier of the device. If `null`, no custom identifier is set. | 5.0.0 |
 
 
 #### GetDeviceIdResult
@@ -587,6 +713,13 @@ Only available on Android and iOS.
 | **`deviceId`** | <code>string</code> | The unique identifier of the device. On iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used. The value of this property is the same for apps that come from the same vendor running on the same device. | 5.0.0 |
 
 
+#### GetNextBundleResult
+
+| Prop           | Type                        | Description                                                                            | Since |
+| -------------- | --------------------------- | -------------------------------------------------------------------------------------- | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the next bundle. If `null`, the default bundle is being used. | 6.7.0 |
+
+
 #### GetVersionCodeResult
 
 | Prop              | Type                | Description                                                                                                                                                                            | Since |
@@ -610,16 +743,23 @@ Only available on Android and iOS.
 
 #### SetChannelOptions
 
-| Prop          | Type                        | Description                                               | Since |
-| ------------- | --------------------------- | --------------------------------------------------------- | ----- |
-| **`channel`** | <code>string \| null</code> | The channel of the app. Set `null` to remove the channel. | 5.0.0 |
+| Prop          | Type                        | Description                                         | Since |
+| ------------- | --------------------------- | --------------------------------------------------- | ----- |
+| **`channel`** | <code>string \| null</code> | The channel name. Set `null` to remove the channel. | 5.0.0 |
 
 
 #### SetCustomIdOptions
 
-| Prop           | Type                        | Description                                                                   | Since |
-| -------------- | --------------------------- | ----------------------------------------------------------------------------- | ----- |
-| **`customId`** | <code>string \| null</code> | The custom identifier of the app. Set `null` to remove the custom identifier. | 5.0.0 |
+| Prop           | Type                        | Description                                                                      | Since |
+| -------------- | --------------------------- | -------------------------------------------------------------------------------- | ----- |
+| **`customId`** | <code>string \| null</code> | The custom identifier of the device. Set `null` to remove the custom identifier. | 5.0.0 |
+
+
+#### SetNextBundleOptions
+
+| Prop           | Type                        | Description                                                                                                   | Since |
+| -------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------- | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the bundle to use. Set `null` to use the default bundle (same as calling `reset()`). | 6.7.0 |
 
 
 #### SyncResult
@@ -628,6 +768,13 @@ Only available on Android and iOS.
 | ------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------- | ----- |
 | **`nextBundleId`** | <code>string \| null</code> | The identifier of the next bundle to use. If `null`, the app is up-to-date and no new bundle is available. | 5.0.0 |
 
+
+#### SyncOptions
+
+| Prop          | Type                | Description                                                      | Since |
+| ------------- | ------------------- | ---------------------------------------------------------------- | ----- |
+| **`channel`** | <code>string</code> | The name of the channel where the latest bundle is fetched from. | 6.7.0 |
+
 </docgen-api>
 
 ## Testing

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

@@ -17,14 +17,20 @@ import io.capawesome.capacitorjs.plugins.liveupdate.classes.ManifestItem;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.api.GetLatestBundleResponse;
 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;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SyncOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchLatestBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBundlesResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetChannelResult;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetCurrentBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetCustomIdResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetDeviceIdResult;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetNextBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetVersionCodeResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetVersionNameResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.SyncResult;
@@ -120,6 +126,7 @@ public class LiveUpdate {
     }
 
     public void downloadBundle(@NonNull DownloadBundleOptions options, @NonNull EmptyCallback callback) throws Exception {
+        ArtifactType artifactType = options.getArtifactType();
         String bundleId = options.getBundleId();
         String checksum = options.getChecksum();
         String url = options.getUrl();
@@ -132,10 +139,23 @@ public class LiveUpdate {
         }
 
         // Download the bundle
-        downloadBundleOfTypeZip(bundleId, url, checksum);
+        if (artifactType == ArtifactType.MANIFEST) {
+            downloadBundleOfTypeManifest(bundleId, url);
+        } else {
+            downloadBundleOfTypeZip(bundleId, url, checksum);
+        }
         callback.success();
     }
 
+    public void fetchLatestBundle(@NonNull FetchLatestBundleOptions options, @NonNull NonEmptyCallback callback) throws Exception {
+        GetLatestBundleResponse response = fetchLatestBundle(options);
+        ArtifactType artifactType = response == null ? null : response.getArtifactType();
+        String bundleId = response == null ? null : response.getBundleId();
+        String downloadUrl = response == null ? null : response.getUrl();
+        FetchLatestBundleResult result = new FetchLatestBundleResult(artifactType, bundleId, downloadUrl);
+        callback.success(result);
+    }
+
     public void getBundle(@NonNull NonEmptyCallback callback) {
         String bundleId = getCurrentBundleId();
         if (bundleId.equals(defaultWebAssetDir)) {
@@ -157,6 +177,15 @@ public class LiveUpdate {
         callback.success(result);
     }
 
+    public void getCurrentBundle(@NonNull NonEmptyCallback<GetCurrentBundleResult> callback) {
+        String bundleId = getCurrentBundleId();
+        if (bundleId.equals(defaultWebAssetDir)) {
+            bundleId = null;
+        }
+        GetCurrentBundleResult result = new GetCurrentBundleResult(bundleId);
+        callback.success(result);
+    }
+
     public void getCustomId(@NonNull NonEmptyCallback callback) {
         String customId = preferences.getCustomId();
         GetCustomIdResult result = new GetCustomIdResult(customId);
@@ -169,6 +198,15 @@ public class LiveUpdate {
         callback.success(result);
     }
 
+    public void getNextBundle(@NonNull NonEmptyCallback<GetNextBundleResult> callback) {
+        String bundleId = getNextBundleId();
+        if (bundleId.equals(defaultWebAssetDir)) {
+            bundleId = null;
+        }
+        GetNextBundleResult result = new GetNextBundleResult(bundleId);
+        callback.success(result);
+    }
+
     public void getVersionCode(@NonNull NonEmptyCallback callback) throws PackageManager.NameNotFoundException {
         String versionCode = getVersionCode();
         GetVersionCodeResult result = new GetVersionCodeResult(versionCode);
@@ -228,9 +266,28 @@ public class LiveUpdate {
         callback.success();
     }
 
-    public void sync(@NonNull NonEmptyCallback<Result> callback) throws Exception {
+    public void setNextBundle(@NonNull SetNextBundleOptions options, @NonNull EmptyCallback callback) {
+        String bundleId = options.getBundleId();
+
+        if (bundleId == null) {
+            reset();
+        } else {
+            if (hasBundle(bundleId)) {
+                setNextBundle(bundleId);
+            } else {
+                Exception exception = new Exception(LiveUpdatePlugin.ERROR_BUNDLE_NOT_FOUND);
+                callback.error(exception);
+                return;
+            }
+        }
+        callback.success();
+    }
+
+    public void sync(@NonNull SyncOptions options, @NonNull NonEmptyCallback<Result> callback) throws Exception {
+        String channel = options.getChannel();
         // Fetch the latest bundle
-        GetLatestBundleResponse response = fetchLatestBundle();
+        FetchLatestBundleOptions fetchLatestBundleOptions = new FetchLatestBundleOptions(channel);
+        GetLatestBundleResponse response = fetchLatestBundle(fetchLatestBundleOptions);
         if (response == null) {
             Logger.debug(LiveUpdatePlugin.TAG, "No update available.");
             SyncResult syncResult = new SyncResult(null);
@@ -534,7 +591,8 @@ public class LiveUpdate {
     }
 
     @Nullable
-    private GetLatestBundleResponse fetchLatestBundle() throws Exception {
+    private GetLatestBundleResponse fetchLatestBundle(@NonNull FetchLatestBundleOptions options) throws Exception {
+        String channel = options.getChannel() == null ? getChannel() : options.getChannel();
         String url = new HttpUrl.Builder()
             .scheme("https")
             .host(host)
@@ -546,7 +604,7 @@ public class LiveUpdate {
             .addQueryParameter("appVersionCode", getVersionCode())
             .addQueryParameter("appVersionName", getVersionName())
             .addQueryParameter("bundleId", getCurrentBundleId())
-            .addQueryParameter("channelName", getChannel())
+            .addQueryParameter("channelName", channel)
             .addQueryParameter("customId", preferences.getCustomId())
             .addQueryParameter("deviceId", getDeviceId())
             .addQueryParameter("osVersion", String.valueOf(Build.VERSION.SDK_INT))