npm - @capgo/capacitor-updater - Versions diffs - 6.7.8 → 6.9.0 - Mend

@capgo/capacitor-updater 6.7.8 → 6.9.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 (9) hide show

package/README.md +44 -30
package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java +8 -1
package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +87 -4
package/dist/docs.json +51 -3
package/dist/esm/definitions.d.ts +18 -1
package/dist/esm/definitions.js.map +1 -1
package/ios/Plugin/CapacitorUpdater.swift +5 -2
package/ios/Plugin/CapacitorUpdaterPlugin.swift +30 -5
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -197,32 +197,33 @@ Capacitor Updater works by unzipping a compiled app bundle to the native device
 CapacitorUpdater can be configured with these options:
-| Prop                     | Type                 | Description                                                                                                                                                                                     | Default                                            | Since   |
-| ------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------- |
-| **`appReadyTimeout`**    | <code>number</code>  | Configure the number of milliseconds the native plugin should wait before considering an update 'failed'. Only available for Android and iOS.                                                   | <code>10000 // (10 seconds)</code>                 |         |
-| **`responseTimeout`**    | <code>number</code>  | Configure the number of milliseconds the native plugin should wait before considering API timeout. Only available for Android and iOS.                                                          | <code>20 // (20 second)</code>                     |         |
-| **`autoDeleteFailed`**   | <code>boolean</code> | Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS.                                                                                | <code>true</code>                                  |         |
-| **`autoDeletePrevious`** | <code>boolean</code> | Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS.                                                    | <code>true</code>                                  |         |
-| **`autoUpdate`**         | <code>boolean</code> | Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS.                                                                                   | <code>true</code>                                  |         |
-| **`resetWhenUpdate`**    | <code>boolean</code> | Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS.                                                 | <code>true</code>                                  |         |
-| **`updateUrl`**          | <code>string</code>  | Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS.                                                                                               | <code>https://plugin.capgo.app/updates</code>      |         |
-| **`channelUrl`**         | <code>string</code>  | Configure the URL / endpoint for channel operations. Only available for Android and iOS.                                                                                                        | <code>https://plugin.capgo.app/channel_self</code> |         |
-| **`statsUrl`**           | <code>string</code>  | Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting.                                                     | <code>https://plugin.capgo.app/stats</code>        |         |
-| **`privateKey`**         | <code>string</code>  | Configure the private key for end to end live update encryption. Only available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.                             | <code>undefined</code>                             |         |
-| **`publicKey`**          | <code>string</code>  | Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS.                                                                                    | <code>undefined</code>                             | 6.2.0   |
-| **`version`**            | <code>string</code>  | Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Only available for Android and iOS. | <code>undefined</code>                             | 4.17.48 |
-| **`directUpdate`**       | <code>boolean</code> | Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode. Only available for Android and iOS.                                               | <code>undefined</code>                             | 5.1.0   |
-| **`periodCheckDelay`**   | <code>number</code>  | Configure the delay period for period update check. the unit is in seconds. Only available for Android and iOS. Cannot be less than 600 seconds (10 minutes).                                   | <code>600 // (10 minutes)</code>                   |         |
-| **`localS3`**            | <code>boolean</code> | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
-| **`localHost`**          | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
-| **`localWebHost`**       | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
-| **`localSupa`**          | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
-| **`localSupaAnon`**      | <code>string</code>  | Configure the CLI to use a local server for testing.                                                                                                                                            | <code>undefined</code>                             | 4.17.48 |
-| **`localApi`**           | <code>string</code>  | Configure the CLI to use a local api for testing.                                                                                                                                               | <code>undefined</code>                             | 6.3.3   |
-| **`localApiFiles`**      | <code>string</code>  | Configure the CLI to use a local file api for testing.                                                                                                                                          | <code>undefined</code>                             | 6.3.3   |
-| **`allowModifyUrl`**     | <code>boolean</code> | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.                                                                                         | <code>false</code>                                 | 5.4.0   |
-| **`defaultChannel`**     | <code>string</code>  | Set the default channel for the app in the config.                                                                                                                                              | <code>undefined</code>                             | 5.5.0   |
-| **`appId`**              | <code>string</code>  | Configure the app id for the app in the config.                                                                                                                                                 | <code>undefined</code>                             | 6.0.0   |
+| Prop                         | Type                 | Description                                                                                                                                                                                     | Default                                            | Since   |
+| ---------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------- |
+| **`appReadyTimeout`**        | <code>number</code>  | Configure the number of milliseconds the native plugin should wait before considering an update 'failed'. Only available for Android and iOS.                                                   | <code>10000 // (10 seconds)</code>                 |         |
+| **`responseTimeout`**        | <code>number</code>  | Configure the number of milliseconds the native plugin should wait before considering API timeout. Only available for Android and iOS.                                                          | <code>20 // (20 second)</code>                     |         |
+| **`autoDeleteFailed`**       | <code>boolean</code> | Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS.                                                                                | <code>true</code>                                  |         |
+| **`autoDeletePrevious`**     | <code>boolean</code> | Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS.                                                    | <code>true</code>                                  |         |
+| **`autoUpdate`**             | <code>boolean</code> | Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS.                                                                                   | <code>true</code>                                  |         |
+| **`resetWhenUpdate`**        | <code>boolean</code> | Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS.                                                 | <code>true</code>                                  |         |
+| **`updateUrl`**              | <code>string</code>  | Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS.                                                                                               | <code>https://plugin.capgo.app/updates</code>      |         |
+| **`channelUrl`**             | <code>string</code>  | Configure the URL / endpoint for channel operations. Only available for Android and iOS.                                                                                                        | <code>https://plugin.capgo.app/channel_self</code> |         |
+| **`statsUrl`**               | <code>string</code>  | Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting.                                                     | <code>https://plugin.capgo.app/stats</code>        |         |
+| **`privateKey`**             | <code>string</code>  | Configure the private key for end to end live update encryption. Only available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.                             | <code>undefined</code>                             |         |
+| **`publicKey`**              | <code>string</code>  | Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS.                                                                                    | <code>undefined</code>                             | 6.2.0   |
+| **`version`**                | <code>string</code>  | Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Only available for Android and iOS. | <code>undefined</code>                             | 4.17.48 |
+| **`directUpdate`**           | <code>boolean</code> | Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode. Only available for Android and iOS.                                               | <code>undefined</code>                             | 5.1.0   |
+| **`periodCheckDelay`**       | <code>number</code>  | Configure the delay period for period update check. the unit is in seconds. Only available for Android and iOS. Cannot be less than 600 seconds (10 minutes).                                   | <code>600 // (10 minutes)</code>                   |         |
+| **`localS3`**                | <code>boolean</code> | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
+| **`localHost`**              | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
+| **`localWebHost`**           | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
+| **`localSupa`**              | <code>string</code>  | Configure the CLI to use a local server for testing or self-hosted update server.                                                                                                               | <code>undefined</code>                             | 4.17.48 |
+| **`localSupaAnon`**          | <code>string</code>  | Configure the CLI to use a local server for testing.                                                                                                                                            | <code>undefined</code>                             | 4.17.48 |
+| **`localApi`**               | <code>string</code>  | Configure the CLI to use a local api for testing.                                                                                                                                               | <code>undefined</code>                             | 6.3.3   |
+| **`localApiFiles`**          | <code>string</code>  | Configure the CLI to use a local file api for testing.                                                                                                                                          | <code>undefined</code>                             | 6.3.3   |
+| **`allowModifyUrl`**         | <code>boolean</code> | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.                                                                                         | <code>false</code>                                 | 5.4.0   |
+| **`defaultChannel`**         | <code>string</code>  | Set the default channel for the app in the config.                                                                                                                                              | <code>undefined</code>                             | 5.5.0   |
+| **`appId`**                  | <code>string</code>  | Configure the app id for the app in the config.                                                                                                                                                 | <code>undefined</code>                             | 6.0.0   |
+| **`keepUrlPathAfterReload`** | <code>boolean</code> | Configure the plugin to keep the URL path after a reload. WARNING: When a reload is triggered, 'window.history' will be cleared.                                                                | <code>false</code>                                 | 6.8.0   |
 ### Examples
@@ -255,7 +256,8 @@ In `capacitor.config.json`:
       "localApiFiles": undefined,
       "allowModifyUrl": undefined,
       "defaultChannel": undefined,
-      "appId": undefined
+      "appId": undefined,
+      "keepUrlPathAfterReload": undefined
     }
   }
 }
@@ -295,6 +297,7 @@ const config: CapacitorConfig = {
       allowModifyUrl: undefined,
       defaultChannel: undefined,
       appId: undefined,
+      keepUrlPathAfterReload: undefined,
     },
   },
 };
@@ -322,7 +325,7 @@ export default config;
 * [`reload()`](#reload)
 * [`setMultiDelay(...)`](#setmultidelay)
 * [`cancelDelay()`](#canceldelay)
-* [`getLatest()`](#getlatest)
+* [`getLatest(...)`](#getlatest)
 * [`setChannel(...)`](#setchannel)
 * [`unsetChannel(...)`](#unsetchannel)
 * [`getChannel()`](#getchannel)
@@ -569,14 +572,18 @@ Cancels a {@link <a href="#delaycondition">DelayCondition</a>} to process an upd
 --------------------
-### getLatest()
+### getLatest(...)
 ```typescript
-getLatest() => Promise<LatestVersion>
+getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>
 ```
 Get Latest bundle available from update Url
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#getlatestoptions">GetLatestOptions</a></code> |
 **Returns:** <code>Promise&lt;<a href="#latestversion">LatestVersion</a>&gt;</code>
 **Since:** 4.0.0
@@ -1051,6 +1058,13 @@ Returns null if no next bundle is set.
 | **`download_url`** | <code>string \| null</code> |
+#### GetLatestOptions
+| Prop          | Type                | Description                                                                                     | Default                | Since |
+| ------------- | ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- | ----- |
+| **`channel`** | <code>string</code> | The channel to get the latest version for The channel must allow 'self_assign' for this to work | <code>undefined</code> | 6.8.0 |
 #### ChannelRes
 | Prop          | Type                | Description                   | Since |

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java CHANGED Viewed

@@ -1058,10 +1058,17 @@ public class CapacitorUpdater {
       );
   }
-  public void getLatest(final String updateUrl, final Callback callback) {
+  public void getLatest(
+    final String updateUrl,
+    final String channel,
+    final Callback callback
+  ) {
     JSONObject json;
     try {
       json = this.createInfoObject();
+      if (channel != null && json != null) {
+        json.put("defaultChannel", channel);
+      }
     } catch (JSONException e) {
       Log.e(TAG, "Error getLatest JSONException", e);
       final JSObject retError = new JSObject();

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java CHANGED Viewed

@@ -13,6 +13,7 @@ import android.content.SharedPreferences;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.os.Build;
+import android.os.Looper;
 import android.util.Log;
 import com.getcapacitor.CapConfig;
 import com.getcapacitor.JSArray;
@@ -40,8 +41,10 @@ import java.util.Timer;
 import java.util.TimerTask;
 import java.util.UUID;
 import java.util.concurrent.Phaser;
+import java.util.concurrent.Semaphore;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
+import java.util.concurrent.atomic.AtomicReference;
 import okhttp3.OkHttpClient;
 import okhttp3.Protocol;
 import org.json.JSONArray;
@@ -57,7 +60,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
   private static final String channelUrlDefault =
     "https://plugin.capgo.app/channel_self";
-  private final String PLUGIN_VERSION = "6.7.8";
+  private final String PLUGIN_VERSION = "6.9.0";
   private static final String DELAY_CONDITION_PREFERENCES = "";
   private SharedPreferences.Editor editor;
@@ -74,6 +77,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
   private Version currentVersionNative;
   private Thread backgroundTask;
   private Boolean taskRunning = false;
+  private Boolean keepUrlPathAfterReload = false;
   private Boolean isPreviousMainActivity = true;
@@ -229,6 +233,8 @@ public class CapacitorUpdaterPlugin extends Plugin {
     this.updateUrl = this.getConfig().getString("updateUrl", updateUrlDefault);
     this.autoUpdate = this.getConfig().getBoolean("autoUpdate", true);
     this.appReadyTimeout = this.getConfig().getInt("appReadyTimeout", 10000);
+    this.keepUrlPathAfterReload = this.getConfig()
+      .getBoolean("keepUrlPathAfterReload", false);
     this.implementation.timeout =
       this.getConfig().getInt("responseTimeout", 20) * 1000;
     boolean resetWhenUpdate =
@@ -659,11 +665,84 @@ public class CapacitorUpdaterPlugin extends Plugin {
     final String path = this.implementation.getCurrentBundlePath();
     this.semaphoreUp();
     Log.i(CapacitorUpdater.TAG, "Reloading: " + path);
-    if (this.implementation.isUsingBuiltin()) {
-      this.bridge.setServerAssetPath(path);
+    AtomicReference<URL> url = new AtomicReference<>();
+    if (this.keepUrlPathAfterReload) {
+      try {
+        if (Looper.myLooper() != Looper.getMainLooper()) {
+          Semaphore mainThreadSemaphore = new Semaphore(0);
+          this.bridge.executeOnMainThread(() -> {
+              try {
+                url.set(new URL(this.bridge.getWebView().getUrl()));
+              } catch (Exception e) {
+                Log.e(
+                  CapacitorUpdater.TAG,
+                  "Error executing on main thread",
+                  e
+                );
+              }
+              mainThreadSemaphore.release();
+            });
+          mainThreadSemaphore.acquire();
+        } else {
+          try {
+            url.set(new URL(this.bridge.getWebView().getUrl()));
+          } catch (Exception e) {
+            Log.e(CapacitorUpdater.TAG, "Error executing on main thread", e);
+          }
+        }
+      } catch (InterruptedException e) {
+        Log.e(
+          CapacitorUpdater.TAG,
+          "Error waiting for main thread or getting the current URL from webview",
+          e
+        );
+      }
+    }
+    if (url.get() != null) {
+      if (this.implementation.isUsingBuiltin()) {
+        this.bridge.getLocalServer().hostAssets(path);
+      } else {
+        this.bridge.getLocalServer().hostFiles(path);
+      }
+      try {
+        URL finalUrl = null;
+        finalUrl = new URL(this.bridge.getAppUrl());
+        finalUrl = new URL(
+          finalUrl.getProtocol(),
+          finalUrl.getHost(),
+          finalUrl.getPort(),
+          url.get().getPath()
+        );
+        URL finalUrl1 = finalUrl;
+        this.bridge.getWebView()
+          .post(() -> {
+            this.bridge.getWebView().loadUrl(finalUrl1.toString());
+            this.bridge.getWebView().clearHistory();
+          });
+      } catch (MalformedURLException e) {
+        Log.e(
+          CapacitorUpdater.TAG,
+          "Cannot get finalUrl from capacitor bridge",
+          e
+        );
+        if (this.implementation.isUsingBuiltin()) {
+          this.bridge.setServerAssetPath(path);
+        } else {
+          this.bridge.setServerBasePath(path);
+        }
+      }
     } else {
-      this.bridge.setServerBasePath(path);
+      if (this.implementation.isUsingBuiltin()) {
+        this.bridge.setServerAssetPath(path);
+      } else {
+        this.bridge.setServerBasePath(path);
+      }
     }
     this.checkAppReady();
     this.notifyListeners("appReloaded", new JSObject());
     return true;
@@ -781,9 +860,11 @@ public class CapacitorUpdaterPlugin extends Plugin {
   @PluginMethod
   public void getLatest(final PluginCall call) {
+    final String channel = call.getString("channel");
     startNewThread(() ->
       CapacitorUpdaterPlugin.this.implementation.getLatest(
           CapacitorUpdaterPlugin.this.updateUrl,
+          channel,
           res -> {
             if (res.has("error")) {
               call.reject(res.getString("error"));
@@ -886,6 +967,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
           try {
             CapacitorUpdaterPlugin.this.implementation.getLatest(
                 CapacitorUpdaterPlugin.this.updateUrl,
+                null,
                 res -> {
                   if (res.has("error")) {
                     Log.e(
@@ -1178,6 +1260,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
       );
       CapacitorUpdaterPlugin.this.implementation.getLatest(
           CapacitorUpdaterPlugin.this.updateUrl,
+          null,
           res -> {
             final BundleInfo current =
               CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();

package/dist/docs.json CHANGED Viewed

@@ -414,8 +414,14 @@
       },
       {
         "name": "getLatest",
-        "signature": "() => Promise<LatestVersion>",
-        "parameters": [],
+        "signature": "(options?: GetLatestOptions | undefined) => Promise<LatestVersion>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetLatestOptions | undefined"
+          }
+        ],
         "returns": "Promise<LatestVersion>",
         "tags": [
           {
@@ -433,7 +439,8 @@
         ],
         "docs": "Get Latest bundle available from update Url",
         "complexTypes": [
-          "LatestVersion"
+          "LatestVersion",
+          "GetLatestOptions"
         ],
         "slug": "getlatest"
       },
@@ -1386,6 +1393,31 @@
         }
       ]
     },
+    {
+      "name": "GetLatestOptions",
+      "slug": "getlatestoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "6.8.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
     {
       "name": "ChannelRes",
       "slug": "channelres",
@@ -2245,6 +2277,22 @@
           "docs": "Configure the app id for the app in the config.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "keepUrlPathAfterReload",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "6.8.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ],
       "docs": "CapacitorUpdater can be configured with these options:"

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

@@ -211,6 +211,14 @@ declare module "@capacitor/cli" {
              * @since  6.0.0
              */
             appId?: string;
+            /**
+             * Configure the plugin to keep the URL path after a reload.
+             * WARNING: When a reload is triggered, 'window.history' will be cleared.
+             *
+             * @default false
+             * @since  6.8.0
+             */
+            keepUrlPathAfterReload?: boolean;
         };
     }
 }
@@ -351,7 +359,7 @@ export interface CapacitorUpdaterPlugin {
      * @throws {Error}
      * @since 4.0.0
      */
-    getLatest(): Promise<LatestVersion>;
+    getLatest(options?: GetLatestOptions): Promise<LatestVersion>;
     /**
      * Sets the channel for this device. The channel has to allow for self assignment for this to work.
      * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.
@@ -638,6 +646,15 @@ export interface DelayCondition {
     kind: DelayUntilNext;
     value?: string;
 }
+export interface GetLatestOptions {
+    /**
+     * The channel to get the latest version for
+     * The channel must allow 'self_assign' for this to work
+     * @since 6.8.0
+     * @default undefined
+     */
+    channel?: string;
+}
 export interface AppReadyResult {
     bundle: BundleInfo;
 }

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

	@@ -1 +1 @@
1	- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA;;;;GAIG","sourcesContent":["/\n This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at https://mozilla.org/MPL/2.0/.\n /\n\n/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from \"@capacitor/core\";\n\ndeclare module \"@capacitor/cli\" {\n export interface PluginsConfig {\n /\n CapacitorUpdater can be configured with these options:\n /\n CapacitorUpdater?: {\n /\n Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n \n Only available for Android and iOS.\n \n @default 10000 // (10 seconds)\n * @example 1000 // (1 second)\n /\n appReadyTimeout?: number;\n /\n Configure the number of milliseconds the native plugin should wait before considering API timeout.\n \n Only available for Android and iOS.\n \n @default 20 // (20 second)\n * @example 10 // (10 second)\n /\n responseTimeout?: number;\n /\n Configure whether the plugin should use automatically delete failed bundles.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeleteFailed?: boolean;\n\n /\n Configure whether the plugin should use automatically delete previous bundles after a successful update.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeletePrevious?: boolean;\n\n /\n Configure whether the plugin should use Auto Update via an update server.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoUpdate?: boolean;\n\n /\n Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n resetWhenUpdate?: boolean;\n\n /\n Configure the URL / endpoint to which update checks are sent.\n \n Only available for Android and iOS.\n \n @default https://plugin.capgo.app/updates\n * @example https://example.com/api/auto_update\n /\n updateUrl?: string;\n\n /\n Configure the URL / endpoint for channel operations.\n \n Only available for Android and iOS.\n \n @default https://plugin.capgo.app/channel_self\n * @example https://example.com/api/channel\n /\n channelUrl?: string;\n\n /\n Configure the URL / endpoint to which update statistics are sent.\n \n Only available for Android and iOS. Set to \"\" to disable stats reporting.\n \n @default https://plugin.capgo.app/stats\n * @example https://example.com/api/stats\n /\n statsUrl?: string;\n /\n Configure the private key for end to end live update encryption.\n \n Only available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.\n \n @default undefined\n /\n privateKey?: string;\n /\n Configure the public key for end to end live update encryption Version 2\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 6.2.0\n /\n publicKey?: string;\n\n /\n Configure the current version of the app. This will be used for the first update request.\n * If not set, the plugin will get the version from the native code.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 4.17.48\n /\n version?: string;\n /\n Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 5.1.0\n /\n directUpdate?: boolean;\n\n /\n Configure the delay period for period update check. the unit is in seconds.\n \n Only available for Android and iOS.\n * Cannot be less than 600 seconds (10 minutes).\n \n @default 600 // (10 minutes)\n /\n periodCheckDelay?: number;\n\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localS3?: boolean;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localWebHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupa?: string;\n /\n Configure the CLI to use a local server for testing.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupaAnon?: string;\n /\n Configure the CLI to use a local api for testing.\n \n \n * @default undefined\n * @since 6.3.3\n /\n localApi?: string;\n /\n Configure the CLI to use a local file api for testing.\n \n \n * @default undefined\n * @since 6.3.3\n /\n localApiFiles?: string;\n /\n Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.\n \n \n * @default false\n * @since 5.4.0\n /\n allowModifyUrl?: boolean;\n\n /\n Set the default channel for the app in the config.\n \n \n \n @default undefined\n * @since 5.5.0\n /\n defaultChannel?: string;\n /\n Configure the app id for the app in the config.\n \n @default undefined\n * @since 6.0.0\n /\n appId?: string;\n };\n }\n}\n\nexport interface CapacitorUpdaterPlugin {\n /\n Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch)\n * By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\n * Change this behaviour with {@link appReadyTimeout}\n \n @returns {Promise<AppReadyResult>} an Promise resolved directly\n * @throws {Error}\n /\n notifyAppReady(): Promise<AppReadyResult>;\n\n /\n Set the updateUrl for the app, this will be used to check for updates.\n \n @param options contains the URL to use for checking for updates.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setUpdateUrl(options: UpdateUrl): Promise<void>;\n\n /\n Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.\n \n @param options contains the URL to use for sending statistics.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setStatsUrl(options: StatsUrl): Promise<void>;\n\n /\n Set the channelUrl for the app, this will be used to set the channel.\n \n @param options contains the URL to use for setting the channel.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setChannelUrl(options: ChannelUrl): Promise<void>;\n\n /\n Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files\n \n @example const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.\n * @param options The {@link DownloadOptions} for downloading a new bundle zip.\n /\n download(options: DownloadOptions): Promise<BundleInfo>;\n\n /\n Set the next bundle to be used when the app is reloaded.\n \n @param options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.\n * @throws {Error} When there is no index.html file inside the bundle folder.\n /\n next(options: BundleId): Promise<BundleInfo>;\n\n /\n Set the current bundle and immediately reloads the app.\n \n @param options A {@link BundleId} object containing the new bundle id to set as current.\n * @returns {Promise<void>}\n * @throws {Error} When there are is no index.html file inside the bundle folder.\n /\n set(options: BundleId): Promise<void>;\n\n /\n Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.\n \n @param options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)\n * @returns {Promise<void>} When the bundle is deleted\n * @throws {Error}\n /\n delete(options: BundleId): Promise<void>;\n\n /\n Get all locally downloaded bundles in your app\n \n @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}\n * @throws {Error}\n /\n list(): Promise<BundleListResult>;\n\n /\n Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.\n \n @param options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.\n * @returns {Promise<void>}\n * @throws {Error}\n /\n reset(options?: ResetOptions): Promise<void>;\n\n /\n Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device\n \n @returns {Promise<CurrentBundleResult>} A Promise evaluating to the {@link CurrentBundleResult}\n * @throws {Error}\n /\n current(): Promise<CurrentBundleResult>;\n\n /\n Reload the view\n \n @returns {Promise<void>} A Promise which is resolved when the view is reloaded\n * @throws {Error}\n /\n reload(): Promise<void>;\n\n /\n Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.\n * After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app.\n * For the `date` kind, the value should be an iso8601 date string.\n * For the `background` kind, the value should be a number in milliseconds.\n * For the `nativeVersion` kind, the value should be the version number.\n * For the `kill` kind, the value is not used.\n * The function has unconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.\n \n @example\n * // Delay the update after the user kills the app or after a background of 300000 ms (5 minutes)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n * @example\n * // Delay the update after the specific iso8601 date is expired\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n * @example\n * // Delay the update after the first background (default behaviour without setting delay)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n * @param options Containing the {@link MultiDelayConditions} array of conditions to set\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 4.3.0\n /\n setMultiDelay(options: MultiDelayConditions): Promise<void>;\n\n /\n Cancels a {@link DelayCondition} to process an update immediately.\n \n @returns {Promise<void>}\n * @throws {Error}\n * @since 4.0.0\n /\n cancelDelay(): Promise<void>;\n\n /\n Get Latest bundle available from update Url\n \n @returns {Promise<LatestVersion>} A Promise resolved when url is loaded\n * @throws {Error}\n * @since 4.0.0\n /\n getLatest(): Promise<LatestVersion>;\n\n /\n Sets the channel for this device. The channel has to allow for self assignment for this to work.\n * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\n * This method is to set the channel after the app is ready.\n * This methods send to Capgo backend a request to link the device ID to the channel. Capgo can accept or refuse depending of the setting of your channel.\n \n \n \n @param options Is the {@link SetChannelOptions} channel to set\n * @returns {Promise<ChannelRes>} A Promise which is resolved when the new channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n setChannel(options: SetChannelOptions): Promise<ChannelRes>;\n\n /\n Unset the channel for this device. The device will then return to the default channel\n \n @returns {Promise<ChannelRes>} A Promise resolved when channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n unsetChannel(options: UnsetChannelOptions): Promise<void>;\n\n /\n Get the channel for this device\n \n @returns {Promise<ChannelRes>} A Promise that resolves with the channel info\n * @throws {Error}\n * @since 4.8.0\n /\n getChannel(): Promise<GetChannelRes>;\n\n /\n Set a custom ID for this device\n \n @param options is the {@link SetCustomIdOptions} customId to set\n * @returns {Promise<void>} an Promise resolved instantly\n * @throws {Error}\n * @since 4.9.0\n /\n setCustomId(options: SetCustomIdOptions): Promise<void>;\n\n /\n Get the native app version or the builtin version if set in config\n \n @returns {Promise<BuiltinVersion>} A Promise with version for this device\n * @since 5.2.0\n /\n getBuiltinVersion(): Promise<BuiltinVersion>;\n\n /\n Get unique ID used to identify device (sent to auto update server)\n \n @returns {Promise<DeviceId>} A Promise with id for this device\n * @throws {Error}\n /\n getDeviceId(): Promise<DeviceId>;\n\n /\n Get the native Capacitor Updater plugin version (sent to auto update server)\n \n @returns {Promise<PluginVersion>} A Promise with Plugin version\n * @throws {Error}\n /\n getPluginVersion(): Promise<PluginVersion>;\n\n /\n Get the state of auto update config.\n \n @returns {Promise<AutoUpdateEnabled>} The status for auto update. Evaluates to `false` in manual mode.\n * @throws {Error}\n /\n isAutoUpdateEnabled(): Promise<AutoUpdateEnabled>;\n\n /\n Remove all listeners for this plugin.\n \n @since 1.0.0\n /\n removeAllListeners(): Promise<void>;\n\n /\n Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\n \n @since 2.0.11\n /\n addListener(\n eventName: \"download\",\n listenerFunc: (state: DownloadEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for no need to update event, useful when you want force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"noNeedUpdate\",\n listenerFunc: (state: NoNeedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for available update event, useful when you want to force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"updateAvailable\",\n listenerFunc: (state: UpdateAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for downloadComplete events.\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadComplete\",\n listenerFunc: (state: DownloadCompleteEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking\n \n @since 2.3.0\n /\n addListener(\n eventName: \"majorAvailable\",\n listenerFunc: (state: MajorAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for update fail event in the App, let you know when update has fail to install at next app start\n \n @since 2.3.0\n /\n addListener(\n eventName: \"updateFailed\",\n listenerFunc: (state: UpdateFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for download fail event in the App, let you know when a bundle download has failed\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadFailed\",\n listenerFunc: (state: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for reload event in the App, let you know when reload has happened\n \n @since 4.3.0\n /\n addListener(\n eventName: \"appReloaded\",\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for app ready event in the App, let you know when app is ready to use\n \n @since 5.1.0\n /\n addListener(\n eventName: \"appReady\",\n listenerFunc: (state: AppReadyEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Get if auto update is available (not disabled by serverUrl).\n \n @returns {Promise<AutoUpdateAvailable>} The availability status for auto update. Evaluates to `false` when serverUrl is set.\n * @throws {Error}\n /\n isAutoUpdateAvailable(): Promise<AutoUpdateAvailable>;\n\n /\n Get the next bundle that will be used when the app reloads.\n * Returns null if no next bundle is set.\n \n @returns {Promise<BundleInfo \| null>} A Promise that resolves with the next bundle information or null\n * @throws {Error}\n * @since 6.8.0\n /\n getNextBundle(): Promise<BundleInfo \| null>;\n}\n\nexport type BundleStatus = \"success\" \| \"error\" \| \"pending\" \| \"downloading\";\n\nexport type DelayUntilNext = \"background\" \| \"kill\" \| \"nativeVersion\" \| \"date\";\n\nexport interface NoNeedEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateAvailableEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface ChannelRes {\n /\n Current status of set channel\n \n @since 4.7.0\n /\n status: string;\n error?: string;\n message?: string;\n}\n\nexport interface GetChannelRes {\n /\n Current status of get channel\n \n @since 4.8.0\n /\n channel?: string;\n error?: string;\n message?: string;\n status?: string;\n allowSet?: boolean;\n}\n\nexport interface DownloadEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n percent: number;\n bundle: BundleInfo;\n}\n\nexport interface MajorAvailableEvent {\n /\n Emit when a new major bundle is available.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadFailedEvent {\n /\n Emit when a download fail.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadCompleteEvent {\n /\n Emit when a new update is available.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateFailedEvent {\n /\n Emit when a update failed to install.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface AppReadyEvent {\n /\n Emitted when the app is ready to use.\n \n @since 5.2.0\n /\n bundle: BundleInfo;\n status: string;\n}\n\nexport interface ManifestEntry {\n file_name: string \| null;\n file_hash: string \| null;\n download_url: string \| null;\n}\n\nexport interface LatestVersion {\n /\n Result of getLatest method\n \n @since 4.0.0\n /\n version: string;\n /\n @since 6\n /\n checksum?: string;\n major?: boolean;\n message?: string;\n sessionKey?: string;\n error?: string;\n old?: string;\n url?: string;\n /\n @since 6.1\n /\n manifest?: ManifestEntry[];\n}\n\nexport interface BundleInfo {\n id: string;\n version: string;\n downloaded: string;\n checksum: string;\n status: BundleStatus;\n}\n\nexport interface SetChannelOptions {\n channel: string;\n triggerAutoUpdate?: boolean;\n}\n\nexport interface UnsetChannelOptions {\n triggerAutoUpdate?: boolean;\n}\n\nexport interface SetCustomIdOptions {\n customId: string;\n}\n\nexport interface DelayCondition {\n /\n Set up delay conditions in setMultiDelay\n * @param value is useless for @param kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"\n /\n kind: DelayUntilNext;\n value?: string;\n}\n\nexport interface AppReadyResult {\n bundle: BundleInfo;\n}\n\nexport interface UpdateUrl {\n url: string;\n}\n\nexport interface StatsUrl {\n url: string;\n}\n\nexport interface ChannelUrl {\n url: string;\n}\n\nexport interface DownloadOptions {\n /\n The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)\n /\n url: string;\n /\n The version code/name of this bundle/version\n /\n version: string;\n /\n The session key for the update\n * @since 4.0.0\n * @default undefined\n /\n sessionKey?: string;\n /\n The checksum for the update\n * @since 4.0.0\n * @default undefined\n */\n checksum?: string;\n}\n\nexport interface BundleId {\n id: string;\n}\n\nexport interface BundleListResult {\n bundles: BundleInfo[];\n}\n\nexport interface ResetOptions {\n toLastSuccessful: boolean;\n}\n\nexport interface CurrentBundleResult {\n bundle: BundleInfo;\n native: string;\n}\n\nexport interface MultiDelayConditions {\n delayConditions: DelayCondition[];\n}\n\nexport interface BuiltinVersion {\n version: string;\n}\n\nexport interface DeviceId {\n deviceId: string;\n}\n\nexport interface PluginVersion {\n version: string;\n}\n\nexport interface AutoUpdateEnabled {\n enabled: boolean;\n}\n\nexport interface AutoUpdateAvailable {\n available: boolean;\n}\n"]}
1	+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA;;;;GAIG","sourcesContent":["/\n This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at https://mozilla.org/MPL/2.0/.\n /\n\n/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from \"@capacitor/core\";\n\ndeclare module \"@capacitor/cli\" {\n export interface PluginsConfig {\n /\n CapacitorUpdater can be configured with these options:\n /\n CapacitorUpdater?: {\n /\n Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n \n Only available for Android and iOS.\n \n @default 10000 // (10 seconds)\n * @example 1000 // (1 second)\n /\n appReadyTimeout?: number;\n /\n Configure the number of milliseconds the native plugin should wait before considering API timeout.\n \n Only available for Android and iOS.\n \n @default 20 // (20 second)\n * @example 10 // (10 second)\n /\n responseTimeout?: number;\n /\n Configure whether the plugin should use automatically delete failed bundles.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeleteFailed?: boolean;\n\n /\n Configure whether the plugin should use automatically delete previous bundles after a successful update.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeletePrevious?: boolean;\n\n /\n Configure whether the plugin should use Auto Update via an update server.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoUpdate?: boolean;\n\n /\n Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n resetWhenUpdate?: boolean;\n\n /\n Configure the URL / endpoint to which update checks are sent.\n \n Only available for Android and iOS.\n \n @default https://plugin.capgo.app/updates\n * @example https://example.com/api/auto_update\n /\n updateUrl?: string;\n\n /\n Configure the URL / endpoint for channel operations.\n \n Only available for Android and iOS.\n \n @default https://plugin.capgo.app/channel_self\n * @example https://example.com/api/channel\n /\n channelUrl?: string;\n\n /\n Configure the URL / endpoint to which update statistics are sent.\n \n Only available for Android and iOS. Set to \"\" to disable stats reporting.\n \n @default https://plugin.capgo.app/stats\n * @example https://example.com/api/stats\n /\n statsUrl?: string;\n /\n Configure the private key for end to end live update encryption.\n \n Only available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.\n \n @default undefined\n /\n privateKey?: string;\n /\n Configure the public key for end to end live update encryption Version 2\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 6.2.0\n /\n publicKey?: string;\n\n /\n Configure the current version of the app. This will be used for the first update request.\n * If not set, the plugin will get the version from the native code.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 4.17.48\n /\n version?: string;\n /\n Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 5.1.0\n /\n directUpdate?: boolean;\n\n /\n Configure the delay period for period update check. the unit is in seconds.\n \n Only available for Android and iOS.\n * Cannot be less than 600 seconds (10 minutes).\n \n @default 600 // (10 minutes)\n /\n periodCheckDelay?: number;\n\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localS3?: boolean;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localWebHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupa?: string;\n /\n Configure the CLI to use a local server for testing.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupaAnon?: string;\n /\n Configure the CLI to use a local api for testing.\n \n \n * @default undefined\n * @since 6.3.3\n /\n localApi?: string;\n /\n Configure the CLI to use a local file api for testing.\n \n \n * @default undefined\n * @since 6.3.3\n /\n localApiFiles?: string;\n /\n Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.\n \n \n * @default false\n * @since 5.4.0\n /\n allowModifyUrl?: boolean;\n\n /\n Set the default channel for the app in the config.\n \n \n \n @default undefined\n * @since 5.5.0\n /\n defaultChannel?: string;\n /\n Configure the app id for the app in the config.\n \n @default undefined\n * @since 6.0.0\n /\n appId?: string;\n\n /\n Configure the plugin to keep the URL path after a reload.\n * WARNING: When a reload is triggered, 'window.history' will be cleared.\n \n @default false\n * @since 6.8.0\n /\n keepUrlPathAfterReload?: boolean;\n };\n }\n}\n\nexport interface CapacitorUpdaterPlugin {\n /\n Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch)\n * By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\n * Change this behaviour with {@link appReadyTimeout}\n \n @returns {Promise<AppReadyResult>} an Promise resolved directly\n * @throws {Error}\n /\n notifyAppReady(): Promise<AppReadyResult>;\n\n /\n Set the updateUrl for the app, this will be used to check for updates.\n \n @param options contains the URL to use for checking for updates.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setUpdateUrl(options: UpdateUrl): Promise<void>;\n\n /\n Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.\n \n @param options contains the URL to use for sending statistics.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setStatsUrl(options: StatsUrl): Promise<void>;\n\n /\n Set the channelUrl for the app, this will be used to set the channel.\n \n @param options contains the URL to use for setting the channel.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setChannelUrl(options: ChannelUrl): Promise<void>;\n\n /\n Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files\n \n @example const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.\n * @param options The {@link DownloadOptions} for downloading a new bundle zip.\n /\n download(options: DownloadOptions): Promise<BundleInfo>;\n\n /\n Set the next bundle to be used when the app is reloaded.\n \n @param options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.\n * @throws {Error} When there is no index.html file inside the bundle folder.\n /\n next(options: BundleId): Promise<BundleInfo>;\n\n /\n Set the current bundle and immediately reloads the app.\n \n @param options A {@link BundleId} object containing the new bundle id to set as current.\n * @returns {Promise<void>}\n * @throws {Error} When there are is no index.html file inside the bundle folder.\n /\n set(options: BundleId): Promise<void>;\n\n /\n Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.\n \n @param options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)\n * @returns {Promise<void>} When the bundle is deleted\n * @throws {Error}\n /\n delete(options: BundleId): Promise<void>;\n\n /\n Get all locally downloaded bundles in your app\n \n @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}\n * @throws {Error}\n /\n list(): Promise<BundleListResult>;\n\n /\n Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.\n \n @param options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.\n * @returns {Promise<void>}\n * @throws {Error}\n /\n reset(options?: ResetOptions): Promise<void>;\n\n /\n Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device\n \n @returns {Promise<CurrentBundleResult>} A Promise evaluating to the {@link CurrentBundleResult}\n * @throws {Error}\n /\n current(): Promise<CurrentBundleResult>;\n\n /\n Reload the view\n \n @returns {Promise<void>} A Promise which is resolved when the view is reloaded\n * @throws {Error}\n /\n reload(): Promise<void>;\n\n /\n Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.\n * After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app.\n * For the `date` kind, the value should be an iso8601 date string.\n * For the `background` kind, the value should be a number in milliseconds.\n * For the `nativeVersion` kind, the value should be the version number.\n * For the `kill` kind, the value is not used.\n * The function has unconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.\n \n @example\n * // Delay the update after the user kills the app or after a background of 300000 ms (5 minutes)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n * @example\n * // Delay the update after the specific iso8601 date is expired\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n * @example\n * // Delay the update after the first background (default behaviour without setting delay)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n * @param options Containing the {@link MultiDelayConditions} array of conditions to set\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 4.3.0\n /\n setMultiDelay(options: MultiDelayConditions): Promise<void>;\n\n /\n Cancels a {@link DelayCondition} to process an update immediately.\n \n @returns {Promise<void>}\n * @throws {Error}\n * @since 4.0.0\n /\n cancelDelay(): Promise<void>;\n\n /\n Get Latest bundle available from update Url\n \n @returns {Promise<LatestVersion>} A Promise resolved when url is loaded\n * @throws {Error}\n * @since 4.0.0\n /\n getLatest(options?: GetLatestOptions): Promise<LatestVersion>;\n\n /\n Sets the channel for this device. The channel has to allow for self assignment for this to work.\n * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\n * This method is to set the channel after the app is ready.\n * This methods send to Capgo backend a request to link the device ID to the channel. Capgo can accept or refuse depending of the setting of your channel.\n \n \n \n @param options Is the {@link SetChannelOptions} channel to set\n * @returns {Promise<ChannelRes>} A Promise which is resolved when the new channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n setChannel(options: SetChannelOptions): Promise<ChannelRes>;\n\n /\n Unset the channel for this device. The device will then return to the default channel\n \n @returns {Promise<ChannelRes>} A Promise resolved when channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n unsetChannel(options: UnsetChannelOptions): Promise<void>;\n\n /\n Get the channel for this device\n \n @returns {Promise<ChannelRes>} A Promise that resolves with the channel info\n * @throws {Error}\n * @since 4.8.0\n /\n getChannel(): Promise<GetChannelRes>;\n\n /\n Set a custom ID for this device\n \n @param options is the {@link SetCustomIdOptions} customId to set\n * @returns {Promise<void>} an Promise resolved instantly\n * @throws {Error}\n * @since 4.9.0\n /\n setCustomId(options: SetCustomIdOptions): Promise<void>;\n\n /\n Get the native app version or the builtin version if set in config\n \n @returns {Promise<BuiltinVersion>} A Promise with version for this device\n * @since 5.2.0\n /\n getBuiltinVersion(): Promise<BuiltinVersion>;\n\n /\n Get unique ID used to identify device (sent to auto update server)\n \n @returns {Promise<DeviceId>} A Promise with id for this device\n * @throws {Error}\n /\n getDeviceId(): Promise<DeviceId>;\n\n /\n Get the native Capacitor Updater plugin version (sent to auto update server)\n \n @returns {Promise<PluginVersion>} A Promise with Plugin version\n * @throws {Error}\n /\n getPluginVersion(): Promise<PluginVersion>;\n\n /\n Get the state of auto update config.\n \n @returns {Promise<AutoUpdateEnabled>} The status for auto update. Evaluates to `false` in manual mode.\n * @throws {Error}\n /\n isAutoUpdateEnabled(): Promise<AutoUpdateEnabled>;\n\n /\n Remove all listeners for this plugin.\n \n @since 1.0.0\n /\n removeAllListeners(): Promise<void>;\n\n /\n Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\n \n @since 2.0.11\n /\n addListener(\n eventName: \"download\",\n listenerFunc: (state: DownloadEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for no need to update event, useful when you want force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"noNeedUpdate\",\n listenerFunc: (state: NoNeedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for available update event, useful when you want to force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"updateAvailable\",\n listenerFunc: (state: UpdateAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for downloadComplete events.\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadComplete\",\n listenerFunc: (state: DownloadCompleteEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking\n \n @since 2.3.0\n /\n addListener(\n eventName: \"majorAvailable\",\n listenerFunc: (state: MajorAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for update fail event in the App, let you know when update has fail to install at next app start\n \n @since 2.3.0\n /\n addListener(\n eventName: \"updateFailed\",\n listenerFunc: (state: UpdateFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for download fail event in the App, let you know when a bundle download has failed\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadFailed\",\n listenerFunc: (state: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for reload event in the App, let you know when reload has happened\n \n @since 4.3.0\n /\n addListener(\n eventName: \"appReloaded\",\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for app ready event in the App, let you know when app is ready to use\n \n @since 5.1.0\n /\n addListener(\n eventName: \"appReady\",\n listenerFunc: (state: AppReadyEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Get if auto update is available (not disabled by serverUrl).\n \n @returns {Promise<AutoUpdateAvailable>} The availability status for auto update. Evaluates to `false` when serverUrl is set.\n * @throws {Error}\n /\n isAutoUpdateAvailable(): Promise<AutoUpdateAvailable>;\n\n /\n Get the next bundle that will be used when the app reloads.\n * Returns null if no next bundle is set.\n \n @returns {Promise<BundleInfo \| null>} A Promise that resolves with the next bundle information or null\n * @throws {Error}\n * @since 6.8.0\n /\n getNextBundle(): Promise<BundleInfo \| null>;\n}\n\nexport type BundleStatus = \"success\" \| \"error\" \| \"pending\" \| \"downloading\";\n\nexport type DelayUntilNext = \"background\" \| \"kill\" \| \"nativeVersion\" \| \"date\";\n\nexport interface NoNeedEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateAvailableEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface ChannelRes {\n /\n Current status of set channel\n \n @since 4.7.0\n /\n status: string;\n error?: string;\n message?: string;\n}\n\nexport interface GetChannelRes {\n /\n Current status of get channel\n \n @since 4.8.0\n /\n channel?: string;\n error?: string;\n message?: string;\n status?: string;\n allowSet?: boolean;\n}\n\nexport interface DownloadEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n percent: number;\n bundle: BundleInfo;\n}\n\nexport interface MajorAvailableEvent {\n /\n Emit when a new major bundle is available.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadFailedEvent {\n /\n Emit when a download fail.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadCompleteEvent {\n /\n Emit when a new update is available.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateFailedEvent {\n /\n Emit when a update failed to install.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface AppReadyEvent {\n /\n Emitted when the app is ready to use.\n \n @since 5.2.0\n /\n bundle: BundleInfo;\n status: string;\n}\n\nexport interface ManifestEntry {\n file_name: string \| null;\n file_hash: string \| null;\n download_url: string \| null;\n}\n\nexport interface LatestVersion {\n /\n Result of getLatest method\n \n @since 4.0.0\n /\n version: string;\n /\n @since 6\n /\n checksum?: string;\n major?: boolean;\n message?: string;\n sessionKey?: string;\n error?: string;\n old?: string;\n url?: string;\n /\n @since 6.1\n /\n manifest?: ManifestEntry[];\n}\n\nexport interface BundleInfo {\n id: string;\n version: string;\n downloaded: string;\n checksum: string;\n status: BundleStatus;\n}\n\nexport interface SetChannelOptions {\n channel: string;\n triggerAutoUpdate?: boolean;\n}\n\nexport interface UnsetChannelOptions {\n triggerAutoUpdate?: boolean;\n}\n\nexport interface SetCustomIdOptions {\n customId: string;\n}\n\nexport interface DelayCondition {\n /\n Set up delay conditions in setMultiDelay\n * @param value is useless for @param kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"\n /\n kind: DelayUntilNext;\n value?: string;\n}\n\nexport interface GetLatestOptions {\n /\n The channel to get the latest version for\n * The channel must allow 'self_assign' for this to work\n * @since 6.8.0\n * @default undefined\n /\n channel?: string;\n}\n\nexport interface AppReadyResult {\n bundle: BundleInfo;\n}\n\nexport interface UpdateUrl {\n url: string;\n}\n\nexport interface StatsUrl {\n url: string;\n}\n\nexport interface ChannelUrl {\n url: string;\n}\n\nexport interface DownloadOptions {\n /\n The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)\n /\n url: string;\n /\n The version code/name of this bundle/version\n /\n version: string;\n /\n The session key for the update\n * @since 4.0.0\n * @default undefined\n /\n sessionKey?: string;\n /\n The checksum for the update\n * @since 4.0.0\n * @default undefined\n */\n checksum?: string;\n}\n\nexport interface BundleId {\n id: string;\n}\n\nexport interface BundleListResult {\n bundles: BundleInfo[];\n}\n\nexport interface ResetOptions {\n toLastSuccessful: boolean;\n}\n\nexport interface CurrentBundleResult {\n bundle: BundleInfo;\n native: string;\n}\n\nexport interface MultiDelayConditions {\n delayConditions: DelayCondition[];\n}\n\nexport interface BuiltinVersion {\n version: string;\n}\n\nexport interface DeviceId {\n deviceId: string;\n}\n\nexport interface PluginVersion {\n version: string;\n}\n\nexport interface AutoUpdateEnabled {\n enabled: boolean;\n}\n\nexport interface AutoUpdateAvailable {\n available: boolean;\n}\n"]}

package/ios/Plugin/CapacitorUpdater.swift CHANGED Viewed

@@ -579,10 +579,13 @@ extension CustomError: LocalizedError {
         )
     }
-    public func getLatest(url: URL) -> AppVersion {
+    public func getLatest(url: URL, channel: String?) -> AppVersion {
         let semaphore: DispatchSemaphore = DispatchSemaphore(value: 0)
         let latest: AppVersion = AppVersion()
-        let parameters: InfoObject = self.createInfoObject()
+        var parameters: InfoObject = self.createInfoObject()
+        if let channel = channel {
+            parameters.defaultChannel = channel
+        }
         print("\(self.TAG) Auto-update parameters: \(parameters)")
         let request = AF.request(url, method: .post, parameters: parameters, encoder: JSONParameterEncoder.default, requestModifier: { $0.timeoutInterval = self.timeout })

package/ios/Plugin/CapacitorUpdaterPlugin.swift CHANGED Viewed

@@ -45,7 +45,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "getNextBundle", returnType: CAPPluginReturnPromise)
     ]
     public var implementation = CapacitorUpdater()
-    private let PLUGIN_VERSION: String = "6.7.8"
+    private let PLUGIN_VERSION: String = "6.9.0"
     static let updateUrlDefault = "https://plugin.capgo.app/updates"
     static let statsUrlDefault = "https://plugin.capgo.app/stats"
     static let channelUrlDefault = "https://plugin.capgo.app/channel_self"
@@ -61,6 +61,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     private var directUpdate = false
     private var autoDeleteFailed = false
     private var autoDeletePrevious = false
+    private var keepUrlPathAfterReload = false
     private var backgroundWork: DispatchWorkItem?
     private var taskRunning = false
     private var periodCheckDelay = 0
@@ -91,6 +92,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         implementation.versionBuild = getConfig().getString("version", Bundle.main.versionName)!
         autoDeleteFailed = getConfig().getBoolean("autoDeleteFailed", true)
         autoDeletePrevious = getConfig().getBoolean("autoDeletePrevious", true)
+        keepUrlPathAfterReload = getConfig().getBoolean("keepUrlPathAfterReload", false)
         directUpdate = getConfig().getBoolean("directUpdate", false)
         updateUrl = getConfig().getString("updateUrl", CapacitorUpdaterPlugin.updateUrlDefault)!
         autoUpdate = getConfig().getBoolean("autoUpdate", true)
@@ -331,7 +333,29 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
         print("\(self.implementation.TAG) Reloading \(id)")
         if let vc = bridge.viewController as? CAPBridgeViewController {
-            vc.setServerBasePath(path: dest.path)
+            guard let capBridge = vc.bridge else {
+                print("\(self.implementation.TAG) Cannot get capBridge")
+                return false
+            }
+            if keepUrlPathAfterReload {
+                DispatchQueue.main.async {
+                    guard let url = vc.webView?.url else {
+                        print("\(self.implementation.TAG) vc.webView?.url is null?")
+                        return
+                    }
+                    capBridge.setServerBasePath(dest.path)
+                    var urlComponents = URLComponents(url: capBridge.config.serverURL, resolvingAgainstBaseURL: false)!
+                    urlComponents.path = url.path
+                    if let finalUrl = urlComponents.url {
+                        _ = vc.webView?.load(URLRequest(url: finalUrl))
+                        vc.webView?.backForwardList.perform(Selector(("_removeAllItems")))
+                    }
+                }
+            } else {
+                vc.setServerBasePath(path: dest.path)
+            }
             self.checkAppReady()
             self.notifyListeners("appReloaded", data: [:])
             return true
@@ -406,8 +430,9 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
     @objc func getLatest(_ call: CAPPluginCall) {
+        let channel = call.getString("channel")
         DispatchQueue.global(qos: .background).async {
-            let res = self.implementation.getLatest(url: URL(string: self.updateUrl)!)
+            let res = self.implementation.getLatest(url: URL(string: self.updateUrl)!, channel: channel)
             if res.error != nil {
                 call.reject( res.error!)
             } else if res.message != nil {
@@ -724,7 +749,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
                 self.endBackGroundTask()
             }
             print("\(self.implementation.TAG) Check for update via \(self.updateUrl)")
-            let res = self.implementation.getLatest(url: url)
+            let res = self.implementation.getLatest(url: url, channel: nil)
             let current = self.implementation.getCurrentBundle()
             if (res.message) != nil {
@@ -898,7 +923,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         }
         let timer = Timer.scheduledTimer(withTimeInterval: TimeInterval(periodCheckDelay), repeats: true) { _ in
             DispatchQueue.global(qos: .background).async {
-                let res = self.implementation.getLatest(url: url)
+                let res = self.implementation.getLatest(url: url, channel: nil)
                 let current = self.implementation.getCurrentBundle()
                 if res.version != current.getVersionName() {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "6.7.8",
+  "version": "6.9.0",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",