npm - @capawesome/capacitor-live-update - Versions diffs - 6.3.0 → 6.4.0 - Mend

@capawesome/capacitor-live-update 6.3.0 → 6.4.0

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 (12) hide show

package/README.md +29 -12
package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java +24 -2
package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateConfig.java +9 -0
package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java +17 -1
package/dist/docs.json +18 -2
package/dist/esm/definitions.d.ts +11 -1
package/dist/esm/definitions.js.map +1 -1
package/ios/Plugin/Classes/CustomError.swift +6 -0
package/ios/Plugin/LiveUpdate.swift +30 -6
package/ios/Plugin/LiveUpdateConfig.swift +1 -0
package/ios/Plugin/LiveUpdatePlugin.swift +11 -1
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -65,16 +65,17 @@ 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 |
-| **`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 |
+| 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). This is **NOT** the same as the app identifier (e.g. `com.example.app`). This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`). |                    | 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 |
+| **`httpTimeout`**       | <code>number</code>       | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                       | <code>60000</code> | 6.4.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,10 +85,11 @@ In `capacitor.config.json`:
 {
   "plugins": {
     "LiveUpdate": {
-      "appId": '4100e356-e851-47fe-9d3c-b411eb325a99',
+      "appId": '6e351b4f-69a7-415e-a057-4567df7ffe94',
       "autoDeleteBundles": undefined,
       "defaultChannel": 'production',
       "enabled": undefined,
+      "httpTimeout": undefined,
       "location": 'eu',
       "publicKey": '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       "readyTimeout": undefined,
@@ -107,10 +109,11 @@ import { CapacitorConfig } from '@capacitor/cli';
 const config: CapacitorConfig = {
   plugins: {
     LiveUpdate: {
-      appId: '4100e356-e851-47fe-9d3c-b411eb325a99',
+      appId: '6e351b4f-69a7-415e-a057-4567df7ffe94',
       autoDeleteBundles: undefined,
       defaultChannel: 'production',
       enabled: undefined,
+      httpTimeout: undefined,
       location: 'eu',
       publicKey: '-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----',
       readyTimeout: undefined,
@@ -644,6 +647,20 @@ Live updates are only supported for [binary-compatible changes](https://capaweso
 If you change native code, such as adding a new plugin, you need to resubmit your app to the app stores.
 For this reason, you must be careful to [restrict live updates to compatible native versions](https://capawesome.io/blog/how-to-restrict-capacitor-live-updates-to-native-versions/) of your app.
+## FAQ
+### Why can't I see my changes during development?
+As soon as you have installed a live update, the app will use the live update bundle and no longer the default bundle.
+So if you make local changes to your app and execute `npx cap run`, for example, these changes will apply to the default bundle, which is not currently in use.
+You then have three options to get back to the default bundle:
+1. **Reset**: Call the [`reset()`](#reset) method to reset the app to the default bundle.
+2. **Reinstall**: Reinstall the app to use the default bundle.
+3. **Update**: Increase the `versionCode`/`CFBundleVersion` so that the plugin automatically performs a reset (assuming the [`resetOnUpdate`](#configuration) configuration option is active).
+However, this is only a problem during development. It is not a problem in production as long as you have the [`resetOnUpdate`](#configuration) configuration option enabled, as the `versionCode`/`CFBundleVersion` is always incremented during a native update and thus always resets to the default bundle.
 ## Changelog
 See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/live-update/CHANGELOG.md).

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

@@ -37,6 +37,7 @@ import java.security.Signature;
 import java.security.spec.X509EncodedKeySpec;
 import java.util.Arrays;
 import java.util.UUID;
+import java.util.concurrent.TimeUnit;
 import net.lingala.zip4j.ZipFile;
 import okhttp3.Call;
 import okhttp3.Callback;
@@ -213,6 +214,11 @@ public class LiveUpdate {
             new NonEmptyCallback<GetLatestBundleResponse>() {
                 @Override
                 public void error(Exception exception) {
+                    // Throw error if the exception is a timeout
+                    if (exception instanceof java.net.SocketTimeoutException) {
+                        callback.error(new Exception(LiveUpdatePlugin.ERROR_HTTP_TIMEOUT));
+                        return;
+                    }
                     // No update available
                     Logger.debug(LiveUpdatePlugin.TAG, "No update available.");
                     SyncResult syncResult = new SyncResult(null);
@@ -381,6 +387,11 @@ public class LiveUpdate {
             new NonEmptyCallback<File>() {
                 @Override
                 public void error(Exception exception) {
+                    // Throw error if the exception is a timeout
+                    if (exception instanceof java.net.SocketTimeoutException) {
+                        callback.error(new Exception(LiveUpdatePlugin.ERROR_HTTP_TIMEOUT));
+                        return;
+                    }
                     callback.error(exception);
                 }
@@ -425,7 +436,12 @@ public class LiveUpdate {
     }
     private void downloadFile(@NonNull String url, @NonNull NonEmptyCallback<File> callback) {
-        OkHttpClient okHttpClient = new OkHttpClient();
+        int httpTimeout = config.getHttpTimeout();
+        OkHttpClient okHttpClient = new OkHttpClient.Builder()
+            .connectTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .readTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .writeTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .build();
         Request request = new Request.Builder().url(url).build();
         okHttpClient
             .newCall(request)
@@ -495,7 +511,13 @@ public class LiveUpdate {
             .addQueryParameter("pluginVersion", LiveUpdatePlugin.VERSION)
             .build();
         Logger.debug(LiveUpdatePlugin.TAG, "Fetching latest bundle from " + url);
-        OkHttpClient client = new OkHttpClient();
+        int httpTimeout = config.getHttpTimeout();
+        OkHttpClient client = new OkHttpClient()
+            .newBuilder()
+            .connectTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .readTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .writeTimeout(httpTimeout, TimeUnit.MILLISECONDS)
+            .build();
         okhttp3.Request request = new okhttp3.Request.Builder().url(url).build();
         client
             .newCall(request)

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

@@ -14,6 +14,7 @@ public class LiveUpdateConfig {
     private String defaultChannel = null;
     private boolean enabled = true;
+    private int httpTimeout = 60000;
     @Nullable
     private String location = null;
@@ -42,6 +43,10 @@ public class LiveUpdateConfig {
         return enabled;
     }
+    public int getHttpTimeout() {
+        return httpTimeout;
+    }
     @Nullable
     public String getLocation() {
         return location;
@@ -76,6 +81,10 @@ public class LiveUpdateConfig {
         this.enabled = enabled;
     }
+    public void setHttpTimeout(int httpTimeout) {
+        this.httpTimeout = httpTimeout;
+    }
     public void setLocation(@Nullable String location) {
         this.location = location;
     }

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

@@ -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.3.0";
+    public static final String VERSION = "6.4.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.";
@@ -30,10 +30,14 @@ public class LiveUpdatePlugin extends Plugin {
     public static final String ERROR_CHECKSUM_MISMATCH = "Checksum mismatch.";
     public static final String ERROR_CUSTOM_ID_MISSING = "customId must be provided.";
     public static final String ERROR_DOWNLOAD_FAILED = "Bundle could not be downloaded.";
+    public static final String ERROR_HTTP_TIMEOUT = "Request timed out.";
     public static final String ERROR_URL_MISSING = "url must be provided.";
     public static final String ERROR_SIGNATURE_VERIFICATION_FAILED = "Signature verification failed.";
     public static final String ERROR_PUBLIC_KEY_INVALID = "Invalid public key.";
     public static final String ERROR_SIGNATURE_MISSING = "Bundle does not contain a signature.";
+    public static final String ERROR_SYNC_IN_PROGRESS = "Sync is already in progress.";
+    private boolean syncInProgress = false;
     @Nullable
     private LiveUpdateConfig config;
@@ -404,14 +408,23 @@ public class LiveUpdatePlugin extends Plugin {
                 call.reject(ERROR_APP_ID_MISSING);
                 return;
             }
+            if (syncInProgress) {
+                call.reject(ERROR_SYNC_IN_PROGRESS);
+                return;
+            }
+            syncInProgress = true;
             NonEmptyCallback<Result> callback = new NonEmptyCallback<>() {
                 @Override
                 public void success(Result result) {
+                    syncInProgress = false;
                     call.resolve(result.toJSObject());
                 }
                 @Override
                 public void error(Exception exception) {
+                    syncInProgress = false;
                     Logger.error(TAG, exception.getMessage(), exception);
                     call.reject(exception.getMessage());
                 }
@@ -419,6 +432,7 @@ public class LiveUpdatePlugin extends Plugin {
             implementation.sync(callback);
         } catch (Exception exception) {
+            syncInProgress = false;
             Logger.error(TAG, exception.getMessage(), exception);
             call.reject(exception.getMessage());
         }
@@ -435,6 +449,8 @@ public class LiveUpdatePlugin extends Plugin {
         config.setDefaultChannel(defaultChannel);
         boolean enabled = getConfig().getBoolean("enabled", config.getEnabled());
         config.setEnabled(enabled);
+        int httpTimeout = getConfig().getInt("httpTimeout", config.getHttpTimeout());
+        config.setHttpTimeout(httpTimeout);
         String location = getConfig().getString("location", config.getLocation());
         config.setLocation(location);
         String publicKey = getConfig().getString("publicKey", config.getPublicKey());

package/dist/docs.json CHANGED Viewed

@@ -722,11 +722,11 @@
               "name": "since"
             },
             {
-              "text": "'4100e356-e851-47fe-9d3c-b411eb325a99'",
+              "text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
               "name": "example"
             }
           ],
-          "docs": "The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).",
+          "docs": "The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).\n\nThis is **NOT** the same as the app identifier (e.g. `com.example.app`).\nThis is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -778,6 +778,22 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "httpTimeout",
+          "tags": [
+            {
+              "text": "6.4.0",
+              "name": "since"
+            },
+            {
+              "text": "60000",
+              "name": "default"
+            }
+          ],
+          "docs": "The timeout in milliseconds for HTTP requests.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
         {
           "name": "location",
           "tags": [

package/dist/esm/definitions.d.ts CHANGED Viewed

@@ -4,8 +4,11 @@ declare module '@capacitor/cli' {
             /**
              * The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).
              *
+             * This is **NOT** the same as the app identifier (e.g. `com.example.app`).
+             * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).
+             *
              * @since 5.0.0
-             * @example '4100e356-e851-47fe-9d3c-b411eb325a99'
+             * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
              */
             appId?: string;
             /**
@@ -31,6 +34,13 @@ declare module '@capacitor/cli' {
              * @default true
              */
             enabled?: boolean;
+            /**
+             * The timeout in milliseconds for HTTP requests.
+             *
+             * @since 6.4.0
+             * @default 60000
+             */
+            httpTimeout?: number;
             /**
              * The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).
              *

package/dist/esm/definitions.js.map CHANGED Viewed

	@@ -1 +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 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"]}
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 This is NOT the same as the app identifier (e.g. `com.example.app`).\n * This is a unique identifier generated by Capawesome Cloud (e.g. `6e351b4f-69a7-415e-a057-4567df7ffe94`).\n \n @since 5.0.0\n * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'\n /\n appId?: string;\n /\n Whether or not to automatically delete unused bundles.\n \n When enabled, the plugin will automatically delete unused bundles after calling `ready()`.\n \n @since 5.0.0\n * @default false\n /\n autoDeleteBundles?: boolean;\n /\n The default channel of the app.\n \n @since 6.3.0\n * @example 'production'\n /\n defaultChannel?: string;\n /\n Whether or not the plugin is enabled.\n \n @since 5.0.0\n * @default true\n /\n enabled?: boolean;\n /\n The timeout in milliseconds for HTTP requests.\n \n @since 6.4.0\n * @default 60000\n /\n httpTimeout?: number;\n /\n The 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/Classes/CustomError.swift CHANGED Viewed

@@ -11,8 +11,10 @@ public enum CustomError: Error {
     case checksumMismatch
     case customIdMissing
     case downloadFailed
+    case httpTimeout
     case signatureMissing
     case signatureVerificationFailed
+    case syncInProgress
     case urlMissing
 }
@@ -39,10 +41,14 @@ extension CustomError: LocalizedError {
             return NSLocalizedString("customId must be provided.", comment: "customIdMissing")
         case .downloadFailed:
             return NSLocalizedString("Bundle could not be downloaded.", comment: "downloadFailed")
+        case .httpTimeout:
+            return NSLocalizedString("Request timed out.", comment: "httpTimeout")
         case .signatureMissing:
             return NSLocalizedString("Bundle does not contain a signature.", comment: "signatureMissing")
         case .signatureVerificationFailed:
             return NSLocalizedString("Signature verification failed.", comment: "signatureVerificationFailed")
+        case .syncInProgress:
+            return NSLocalizedString("Sync is already in progress.", comment: "syncInProgress")
         case .urlMissing:
             return NSLocalizedString("url must be provided.", comment: "urlMissing")
         }

package/ios/Plugin/LiveUpdate.swift CHANGED Viewed

@@ -356,11 +356,22 @@ import CommonCrypto
             let temporaryZipFileUrl = self.cachesDirectoryUrl.appendingPathComponent(timestamp + ".zip")
             return (temporaryZipFileUrl, [.createIntermediateDirectories])
         }
-        AF.download(url, to: destination).validate().response { response in
+        var request = URLRequest(url: URL(string: url)!)
+        request.httpMethod = HTTPMethod.get.rawValue
+        request.timeoutInterval = Double(config.httpTimeout) / 1000.0
+        AF.download(request, to: destination).validate().response { response in
             if let error = response.error {
                 CAPLog.print("[", LiveUpdatePlugin.tag, "] ", error)
-                completion(nil, CustomError.downloadFailed)
+                if let urlError = error.underlyingError as? URLError {
+                    switch urlError.code {
+                    case .timedOut:
+                        completion(nil, CustomError.httpTimeout)
+                    default:
+                        completion(nil, CustomError.downloadFailed)
+                    }
+                } else {
+                    completion(nil, CustomError.downloadFailed)
+                }
                 return
             }
             completion(response.fileURL, nil)
@@ -384,15 +395,28 @@ import CommonCrypto
                 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
+        var urlComponents = URLComponents(string: "https://\(host)/v1/apps/\(config.appId ?? "")/bundles/latest")!
+        urlComponents.queryItems = parameters.map { URLQueryItem(name: $0.key, value: $0.value) }
+        var request = URLRequest(url: urlComponents.url!)
+        request.httpMethod = HTTPMethod.get.rawValue
+        request.timeoutInterval = Double(config.httpTimeout) / 1000.0
+        AF.request(request).validate().responseDecodable(of: GetLatestBundleResponse.self) { response in
             CAPLog.print("[", LiveUpdatePlugin.tag, "] Fetching latest bundle from ", response.request?.url?.absoluteString ?? "")
             if let error = response.error {
                 CAPLog.print("[", LiveUpdatePlugin.tag, "] ", error)
                 if let data = response.data {
                     CAPLog.print("[", LiveUpdatePlugin.tag, "] ", String(decoding: data, as: UTF8.self))
                 }
-                completion(nil, error)
+                if let urlError = error.underlyingError as? URLError {
+                    switch urlError.code {
+                    case .timedOut:
+                        completion(nil, CustomError.httpTimeout)
+                    default:
+                        completion(nil, error)
+                    }
+                } else {
+                    completion(nil, error)
+                }
                 return
             }
             completion(response.value, nil)

package/ios/Plugin/LiveUpdateConfig.swift CHANGED Viewed

@@ -3,6 +3,7 @@ public struct LiveUpdateConfig {
     var autoDeleteBundles = false
     var defaultChannel: String?
     var enabled = true
+    var httpTimeout = 60000
     var location: String?
     var publicKey: String?
     var readyTimeout = 10000

package/ios/Plugin/LiveUpdatePlugin.swift CHANGED Viewed

@@ -8,11 +8,12 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "6.3.0"
+    public static let version = "6.4.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
     private var config: LiveUpdateConfig?
     private var implementation: LiveUpdate?
+    private var syncInProgress = false
     override public func load() {
         self.config = liveUpdateConfig()
@@ -222,7 +223,15 @@ public class LiveUpdatePlugin: CAPPlugin {
             call.reject(CustomError.appIdMissing.localizedDescription)
             return
         }
+        guard !syncInProgress else {
+            call.reject(CustomError.syncInProgress.localizedDescription)
+            return
+        }
+        syncInProgress = true
         implementation?.sync(completion: { result, error in
+            self.syncInProgress = false
             if let error = error {
                 CAPLog.print("[", LiveUpdatePlugin.tag, "] ", error)
                 call.reject(error.localizedDescription)
@@ -241,6 +250,7 @@ public class LiveUpdatePlugin: CAPPlugin {
         config.autoDeleteBundles = getConfig().getBoolean("autoDeleteBundles", config.autoDeleteBundles)
         config.defaultChannel = getConfig().getString("defaultChannel", config.defaultChannel)
         config.enabled = getConfig().getBoolean("enabled", config.enabled)
+        config.httpTimeout = getConfig().getInt("httpTimeout", config.httpTimeout)
         config.location = getConfig().getString("location", config.location)
         config.publicKey = getConfig().getString("publicKey", config.publicKey)
         config.readyTimeout = getConfig().getInt("readyTimeout", config.readyTimeout)

package/package.json CHANGED Viewed

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