@capgo/capacitor-updater 4.4.9 → 4.4.11

package/README.md

@@ -177,7 +177,7 @@ Notify Capacitor Updater that the current bundle is working (a rollback will occ
 download(options: { url: string; version: string; }) => Promise<BundleInfo>
 ```
 
-Download a new version from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files
+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
 
 | Param         | Type                                           |
 | ------------- | ---------------------------------------------- |
@@ -241,7 +241,7 @@ Delete bundle in storage
 list() => Promise<{ bundles: BundleInfo[]; }>
 ```
 
-Get all available versions
+Get all available bundles
 
 **Returns:** <code>Promise&lt;{ bundles: BundleInfo[]; }&gt;</code>
 
@@ -254,7 +254,7 @@ Get all available versions
 reset(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>
 ```
 
-Set the `builtin` version (the one sent to Apple store / Google play store ) as current version
+Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle
 
 | Param         | Type                                         |
 | ------------- | -------------------------------------------- |
@@ -340,7 +340,7 @@ Cancel delay to updates as usual
 getLatest() => Promise<latestVersion>
 ```
 
-Get Latest version available from update Url
+Get Latest bundle available from update Url
 
 **Returns:** <code>Promise&lt;<a href="#latestversion">latestVersion</a>&gt;</code>
 
@@ -644,9 +644,9 @@ removeAllListeners() => Promise<void>
 
 #### MajorAvailableEvent
 
-| Prop          | Type                | Description                                 | Since |
-| ------------- | ------------------- | ------------------------------------------- | ----- |
-| **`version`** | <code>string</code> | Emit when a new major version is available. | 4.0.0 |
+| Prop          | Type                | Description                                | Since |
+| ------------- | ------------------- | ------------------------------------------ | ----- |
+| **`version`** | <code>string</code> | Emit when a new major bundle is available. | 4.0.0 |
 
 
 #### UpdateFailedEvent

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

@@ -45,7 +45,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.4.9";
+    public static final String pluginVersion = "4.4.11";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;

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

@@ -207,6 +207,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                             final JSObject ret = new JSObject();
                             ret.put("version", version);
                             CapacitorUpdaterPlugin.this.notifyListeners("downloadFailed", ret);
+                            final BundleInfo current = CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
+                            CapacitorUpdaterPlugin.this.implementation.sendStats("download_fail", current.getVersionName());
                         }
                     }
                 }
@@ -713,6 +715,8 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                                             final JSObject ret = new JSObject();
                                                             ret.put("version", latestVersionName);
                                                             CapacitorUpdaterPlugin.this.notifyListeners("downloadFailed", ret);
+                                                            final BundleInfo current = CapacitorUpdaterPlugin.this.implementation.getCurrentBundle();
+                                                            CapacitorUpdaterPlugin.this.implementation.sendStats("download_fail", current.getVersionName());
                                                             final JSObject retNoNeed = new JSObject();
                                                             retNoNeed.put("bundle", current.toJSON());
                                                             CapacitorUpdaterPlugin.this.notifyListeners("noNeedUpdate", retNoNeed);

package/dist/docs.json

@@ -40,7 +40,7 @@
         "tags": [
           {
             "name": "returns",
-            "text": "The {@link BundleInfo} for the specified version."
+            "text": "The {@link BundleInfo} for the specified bundle."
           },
           {
             "name": "param",
@@ -55,7 +55,7 @@
             "text": "https://example.com/versions/{version}/dist.zip"
           }
         ],
-        "docs": "Download a new version from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files",
+        "docs": "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",
         "complexTypes": [
           "BundleInfo"
         ],
@@ -83,7 +83,7 @@
           },
           {
             "name": "throws",
-            "text": "An error if there are is no index.html file inside the version folder."
+            "text": "An error if there are is no index.html file inside the bundle folder."
           }
         ],
         "docs": "Set the next bundle to be used when the app is reloaded.",
@@ -114,7 +114,7 @@
           },
           {
             "name": "throws",
-            "text": "An error if there are is no index.html file inside the version folder."
+            "text": "An error if there are is no index.html file inside the bundle folder."
           }
         ],
         "docs": "Set the current bundle and immediately reloads the app.",
@@ -158,14 +158,14 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise witht the version list"
+            "text": "an Promise witht the bundles list"
           },
           {
             "name": "throws",
             "text": "An error if the something went wrong"
           }
         ],
-        "docs": "Get all available versions",
+        "docs": "Get all available bundles",
         "complexTypes": [
           "BundleInfo"
         ],
@@ -196,7 +196,7 @@
             "text": "An error if the something went wrong"
           }
         ],
-        "docs": "Set the `builtin` version (the one sent to Apple store / Google play store ) as current version",
+        "docs": "Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle",
         "complexTypes": [],
         "slug": "reset"
       },
@@ -368,7 +368,7 @@
             "text": "4.0.0"
           }
         ],
-        "docs": "Get Latest version available from update Url",
+        "docs": "Get Latest bundle available from update Url",
         "complexTypes": [
           "latestVersion"
         ],
@@ -1163,7 +1163,7 @@
               "name": "since"
             }
           ],
-          "docs": "Emit when a new major version is available.",
+          "docs": "Emit when a new major bundle is available.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1518,7 +1518,7 @@
               "name": "example"
             }
           ],
-          "docs": "Automatically delete previous downloaded bundles when a newer native app version is installed to the device.\n\nOnly available for Android and iOS.",
+          "docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },

package/dist/esm/definitions.d.ts

@@ -42,7 +42,7 @@ declare module '@capacitor/cli' {
              */
             autoUpdate?: boolean;
             /**
-             * Automatically delete previous downloaded bundles when a newer native app version is installed to the device.
+             * Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.
              *
              * Only available for Android and iOS.
              *
@@ -98,7 +98,7 @@ export interface DownloadEvent {
 }
 export interface MajorAvailableEvent {
     /**
-     * Emit when a new major version is available.
+     * Emit when a new major bundle is available.
      *
      * @since  4.0.0
      */
@@ -174,9 +174,9 @@ export interface CapacitorUpdaterPlugin {
      */
     notifyAppReady(): Promise<BundleInfo>;
     /**
-     * Download a new version from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files
+     * 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
      *
-     * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified version.
+     * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.
      * @param url 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.)
      * @param version set the version code/name of this bundle/version
      * @example https://example.com/versions/{version}/dist.zip
@@ -190,7 +190,7 @@ export interface CapacitorUpdaterPlugin {
      *
      * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.
      * @param id The bundle id to set as current, next time the app is reloaded. See {@link BundleInfo.id}
-     * @throws An error if there are is no index.html file inside the version folder.
+     * @throws An error if there are is no index.html file inside the bundle folder.
      */
     next(options: {
         id: string;
@@ -200,7 +200,7 @@ export interface CapacitorUpdaterPlugin {
      *
      * @param id The bundle id to set as current. See {@link BundleInfo.id}
      * @returns {Promise<Void>} An empty promise.
-     * @throws An error if there are is no index.html file inside the version folder.
+     * @throws An error if there are is no index.html file inside the bundle folder.
      */
     set(options: {
         id: string;
@@ -216,16 +216,16 @@ export interface CapacitorUpdaterPlugin {
         id: string;
     }): Promise<void>;
     /**
-     * Get all available versions
+     * Get all available bundles
      *
-     * @returns {Promise<{version: BundleInfo[]}>} an Promise witht the version list
+     * @returns {Promise<{bundles: BundleInfo[]}>} an Promise witht the bundles list
      * @throws An error if the something went wrong
      */
     list(): Promise<{
         bundles: BundleInfo[];
     }>;
     /**
-     * Set the `builtin` version (the one sent to Apple store / Google play store ) as current version
+     * Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle
      *
      * @returns {Promise<void>} an empty Promise
      * @param toLastSuccessful [false] if yes it reset to to the last successfully loaded bundle instead of `builtin`
@@ -294,7 +294,7 @@ export interface CapacitorUpdaterPlugin {
      */
     cancelDelay(): Promise<void>;
     /**
-     * Get Latest version available from update Url
+     * Get Latest bundle available from update Url
      *
      * @returns {Promise<latestVersion>} an Promise resolved when url is loaded
      * @throws An error if the something went wrong

package/ios/Plugin/CapacitorUpdater.swift

@@ -148,7 +148,7 @@ extension CustomError: LocalizedError {
 
     public let TAG = "✨  Capacitor-updater:"
     public let CAP_SERVER_PATH = "serverBasePath"
-    public let pluginVersion = "4.4.9"
+    public let pluginVersion = "4.4.11"
     public var statsUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -107,11 +107,13 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         let url = URL(string: urlString)
         print("\(self.implementation.TAG) Downloading \(url!)")
         do {
-            let res = try implementation.download(url: url!, version: version)
+            let res = try self.implementation.download(url: url!, version: version)
             call.resolve(res.toJSON())
         } catch {
             print("\(self.implementation.TAG) Failed to download from: \(url!) \(error.localizedDescription)")
             self.notifyListeners("downloadFailed", data: ["version": version])
+            let current: BundleInfo = self.implementation.getCurrentBundle()
+            self.implementation.sendStats(action: "download_fail", versionName: current.getVersionName())
             call.reject("Failed to download from: \(url!)", error.localizedDescription)
         }
     }
@@ -192,7 +194,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             resArr.append(v.toJSON())
         }
         call.resolve([
-            "versions": resArr
+            "bundles": resArr
         ])
     }
 
@@ -480,6 +482,8 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                         _ = self.implementation.setNextBundle(next: next.getId())
                     } catch {
                         print("\(self.implementation.TAG) Error downloading file", error.localizedDescription)
+                        let current: BundleInfo = self.implementation.getCurrentBundle()
+                        self.implementation.sendStats(action: "download_fail", versionName: current.getVersionName())
                         self.notifyListeners("downloadFailed", data: ["version": latestVersionName])
                         self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()])
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.4.9",
+  "version": "4.4.11",
   "license": "LGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",