@capgo/capacitor-updater 4.0.0-alpha.43 → 4.0.0-alpha.44

package/README.md

@@ -131,6 +131,7 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
 * [`getLatest(...)`](#getlatest)
 * [`addListener('download', ...)`](#addlistenerdownload)
 * [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate)
+* [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable)
 * [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete)
 * [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
 * [`addListener('updateFailed', ...)`](#addlistenerupdatefailed)
@@ -366,6 +367,26 @@ Listen for no need to update event, usefull when you want force check every time
 --------------------
 
 
+### addListener('updateAvailable', ...)
+
+```typescript
+addListener(eventName: 'updateAvailable', listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for availbale update event, usefull when you want to force check every time the app is launched
+
+| Param              | Type                                                                          |
+| ------------------ | ----------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'updateAvailable'</code>                                                |
+| **`listenerFunc`** | <code><a href="#updateavailabledlistener">UpdateAvailabledListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 4.0.0
+
+--------------------
+
+
 ### addListener('downloadComplete', ...)
 
 ```typescript
@@ -557,6 +578,13 @@ removeAllListeners() => Promise<void>
 | **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
 
 
+#### updateAvailableEvent
+
+| Prop         | Type                                              | Description                                    | Since |
+| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
+| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
+
+
 #### DownloadCompleteEvent
 
 | Prop         | Type                                              | Description                          | Since |
@@ -580,9 +608,9 @@ removeAllListeners() => Promise<void>
 
 #### DownloadFailedEvent
 
-| 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 download fail. | 4.0.0 |
 
 
 ### Type Aliases
@@ -608,6 +636,11 @@ removeAllListeners() => Promise<void>
 <code>(state: <a href="#noneedevent">noNeedEvent</a>): void</code>
 
 
+#### UpdateAvailabledListener
+
+<code>(state: <a href="#updateavailableevent">updateAvailableEvent</a>): void</code>
+
+
 #### DownloadCompleteListener
 
 <code>(state: <a href="#downloadcompleteevent">DownloadCompleteEvent</a>): void</code>

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

@@ -47,7 +47,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.0.0-alpha.43";
+    public static final String pluginVersion = "4.0.0-alpha.44";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;

package/dist/docs.json

@@ -391,6 +391,35 @@
         ],
         "slug": "addlistenernoneedupdate"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'updateAvailable', listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'updateAvailable'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "UpdateAvailabledListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "since",
+            "text": "4.0.0"
+          }
+        ],
+        "docs": "Listen for availbale update event, usefull when you want to force check every time the app is launched",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UpdateAvailabledListener"
+        ],
+        "slug": "addlistenerupdateavailable"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'downloadComplete', listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
@@ -603,6 +632,7 @@
       "PluginListenerHandle",
       "\"@capacitor/cli\"",
       "noNeedEvent",
+      "updateAvailableEvent",
       "DownloadEvent",
       "MajorAvailableEvent",
       "DownloadFailedEvent",
@@ -614,6 +644,7 @@
       "DelayUntilNext",
       "DownloadChangeListener",
       "NoNeedListener",
+      "UpdateAvailabledListener",
       "DownloadFailedListener",
       "DownloadCompleteListener",
       "MajorAvailableListener",
@@ -670,6 +701,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -680,6 +712,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -739,6 +772,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -749,6 +783,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -817,6 +852,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
         "DownloadCompleteEvent",
@@ -827,6 +863,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -859,6 +896,7 @@
       "importObject": [
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -870,6 +908,52 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
+        "DownloadFailedListener",
+        "DownloadCompleteListener",
+        "MajorAvailableListener",
+        "UpdateFailedListener",
+        "CapacitorUpdaterPlugin"
+      ]
+    },
+    {
+      "name": "updateAvailableEvent",
+      "slug": "updateavailableevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundle",
+          "tags": [
+            {
+              "text": "4.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Current status of download, between 0 and 100.",
+          "complexTypes": [
+            "BundleInfo"
+          ],
+          "type": "BundleInfo"
+        }
+      ],
+      "importObject": [
+        "PluginListenerHandle",
+        "\"@capacitor/cli\"",
+        "noNeedEvent",
+        "DownloadEvent",
+        "MajorAvailableEvent",
+        "DownloadFailedEvent",
+        "DownloadCompleteEvent",
+        "UpdateFailedEvent",
+        "latestVersion",
+        "BundleInfo",
+        "BundleStatus",
+        "DelayUntilNext",
+        "DownloadChangeListener",
+        "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -903,6 +987,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -913,6 +998,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -944,6 +1030,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "DownloadFailedEvent",
         "DownloadCompleteEvent",
@@ -954,6 +1041,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -987,6 +1075,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadFailedEvent",
@@ -997,6 +1086,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -1019,7 +1109,7 @@
               "name": "since"
             }
           ],
-          "docs": "Emit when a new major version is available.",
+          "docs": "Emit when a download fail.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1028,6 +1118,7 @@
         "PluginListenerHandle",
         "\"@capacitor/cli\"",
         "noNeedEvent",
+        "updateAvailableEvent",
         "DownloadEvent",
         "MajorAvailableEvent",
         "DownloadCompleteEvent",
@@ -1038,6 +1129,7 @@
         "DelayUntilNext",
         "DownloadChangeListener",
         "NoNeedListener",
+        "UpdateAvailabledListener",
         "DownloadFailedListener",
         "DownloadCompleteListener",
         "MajorAvailableListener",
@@ -1120,6 +1212,19 @@
         }
       ]
     },
+    {
+      "name": "UpdateAvailabledListener",
+      "slug": "updateavailabledlistener",
+      "docs": "",
+      "types": [
+        {
+          "text": "(state: updateAvailableEvent): void",
+          "complexTypes": [
+            "updateAvailableEvent"
+          ]
+        }
+      ]
+    },
     {
       "name": "DownloadCompleteListener",
       "slug": "downloadcompletelistener",

package/dist/esm/definitions.d.ts

@@ -79,6 +79,14 @@ export interface noNeedEvent {
      */
     bundle: BundleInfo;
 }
+export interface updateAvailableEvent {
+    /**
+     * Current status of download, between 0 and 100.
+     *
+     * @since  4.0.0
+     */
+    bundle: BundleInfo;
+}
 export interface DownloadEvent {
     /**
      * Current status of download, between 0 and 100.
@@ -98,7 +106,7 @@ export interface MajorAvailableEvent {
 }
 export interface DownloadFailedEvent {
     /**
-     * Emit when a new major version is available.
+     * Emit when a download fail.
      *
      * @since  4.0.0
      */
@@ -143,6 +151,7 @@ export declare type BundleStatus = 'success' | 'error' | 'pending' | 'downloadin
 export declare type DelayUntilNext = 'background' | 'kill' | 'nativeVersion' | 'date';
 export declare type DownloadChangeListener = (state: DownloadEvent) => void;
 export declare type NoNeedListener = (state: noNeedEvent) => void;
+export declare type UpdateAvailabledListener = (state: updateAvailableEvent) => void;
 export declare type DownloadFailedListener = (state: DownloadFailedEvent) => void;
 export declare type DownloadCompleteListener = (state: DownloadCompleteEvent) => void;
 export declare type MajorAvailableListener = (state: MajorAvailableEvent) => void;
@@ -276,6 +285,12 @@ export interface CapacitorUpdaterPlugin {
      * @since 4.0.0
      */
     addListener(eventName: 'noNeedUpdate', listenerFunc: NoNeedListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    /**
+   * Listen for availbale update event, usefull when you want to force check every time the app is launched
+   *
+   * @since 4.0.0
+   */
+    addListener(eventName: 'updateAvailable', listenerFunc: UpdateAvailabledListener): Promise<PluginListenerHandle> & PluginListenerHandle;
     /**
      * Listen for download event in the App, let you know when the download is started, loading and finished
      *

package/ios/Plugin/CapacitorUpdater.swift

@@ -149,7 +149,7 @@ extension CustomError: LocalizedError {
     
     public let TAG = "✨  Capacitor-updater:";
     public let CAP_SERVER_PATH = "serverBasePath"
-    public let pluginVersion = "4.0.0-alpha.43"
+    public let pluginVersion = "4.0.0-alpha.44"
     public var statsUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.0.0-alpha.43",
+  "version": "4.0.0-alpha.44",
   "license": "AGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",