@capgo/capacitor-updater 6.13.2 → 6.14.2

package/README.md

@@ -319,7 +319,7 @@ export default config;
 * [`next(...)`](#next)
 * [`set(...)`](#set)
 * [`delete(...)`](#delete)
-* [`list()`](#list)
+* [`list(...)`](#list)
 * [`reset(...)`](#reset)
 * [`current()`](#current)
 * [`reload()`](#reload)
@@ -484,14 +484,18 @@ Deletes the specified bundle from the native app storage. Use with {@link list}
 --------------------
 
 
-### list()
+### list(...)
 
 ```typescript
-list() => Promise<BundleListResult>
+list(options?: ListOptions | undefined) => Promise<BundleListResult>
 ```
 
 Get all locally downloaded bundles in your app
 
+| Param         | Type                                                | Description                                                            |
+| ------------- | --------------------------------------------------- | ---------------------------------------------------------------------- |
+| **`options`** | <code><a href="#listoptions">ListOptions</a></code> | The {@link <a href="#listoptions">ListOptions</a>} for listing bundles |
+
 **Returns:** <code>Promise&lt;<a href="#bundlelistresult">BundleListResult</a>&gt;</code>
 
 --------------------
@@ -732,7 +736,7 @@ Remove all listeners for this plugin.
 ### addListener('download', ...)
 
 ```typescript
-addListener(eventName: "download", listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.
@@ -752,7 +756,7 @@ Listen for bundle download event in the App. Fires once a download has started,
 ### addListener('noNeedUpdate', ...)
 
 ```typescript
-addListener(eventName: "noNeedUpdate", listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for no need to update event, useful when you want force check every time the app is launched
@@ -772,7 +776,7 @@ Listen for no need to update event, useful when you want force check every time
 ### addListener('updateAvailable', ...)
 
 ```typescript
-addListener(eventName: "updateAvailable", listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for available update event, useful when you want to force check every time the app is launched
@@ -792,7 +796,7 @@ Listen for available update event, useful when you want to force check every tim
 ### addListener('downloadComplete', ...)
 
 ```typescript
-addListener(eventName: "downloadComplete", listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for downloadComplete events.
@@ -812,7 +816,7 @@ Listen for downloadComplete events.
 ### addListener('majorAvailable', ...)
 
 ```typescript
-addListener(eventName: "majorAvailable", listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
@@ -832,7 +836,7 @@ Listen for Major update event in the App, let you know when major update is bloc
 ### addListener('updateFailed', ...)
 
 ```typescript
-addListener(eventName: "updateFailed", listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for update fail event in the App, let you know when update has fail to install at next app start
@@ -852,7 +856,7 @@ Listen for update fail event in the App, let you know when update has fail to in
 ### addListener('downloadFailed', ...)
 
 ```typescript
-addListener(eventName: "downloadFailed", listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for download fail event in the App, let you know when a bundle download has failed
@@ -872,7 +876,7 @@ Listen for download fail event in the App, let you know when a bundle download h
 ### addListener('appReloaded', ...)
 
 ```typescript
-addListener(eventName: "appReloaded", listenerFunc: () => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for reload event in the App, let you know when reload has happened
@@ -892,7 +896,7 @@ Listen for reload event in the App, let you know when reload has happened
 ### addListener('appReady', ...)
 
 ```typescript
-addListener(eventName: "appReady", listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 Listen for app ready event in the App, let you know when app is ready to use
@@ -1004,6 +1008,13 @@ Returns null if no next bundle is set.
 | **`bundles`** | <code>BundleInfo[]</code> |
 
 
+#### ListOptions
+
+| Prop      | Type                 | Description                                                                                                                                   | Default            | Since  |
+| --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ |
+| **`raw`** | <code>boolean</code> | Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk. | <code>false</code> | 6.14.0 |
+
+
 #### ResetOptions
 
 | Prop                   | Type                 |
@@ -1212,12 +1223,12 @@ Returns null if no next bundle is set.
 
 #### BundleStatus
 
-<code>"success" | "error" | "pending" | "downloading"</code>
+<code>'success' | 'error' | 'pending' | 'downloading'</code>
 
 
 #### DelayUntilNext
 
-<code>"background" | "kill" | "nativeVersion" | "date"</code>
+<code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
 
 </docgen-api>
 

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

@@ -17,198 +17,138 @@ import org.json.JSONTokener;
 
 public class BundleInfo {
 
-  private static final SimpleDateFormat sdf = new SimpleDateFormat(
-    "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
-  );
-
-  public static final String ID_BUILTIN = "builtin";
-  public static final String VERSION_UNKNOWN = "unknown";
-  public static final String DOWNLOADED_BUILTIN = "1970-01-01T00:00:00.000Z";
-
-  private final String downloaded;
-  private final String id;
-  private final String version;
-  private final String checksum;
-  private final BundleStatus status;
-
-  static {
-    sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-  }
-
-  public BundleInfo(final BundleInfo source) {
-    this(
-      source.id,
-      source.version,
-      source.status,
-      source.downloaded,
-      source.checksum
-    );
-  }
-
-  public BundleInfo(
-    final String id,
-    final String version,
-    final BundleStatus status,
-    final Date downloaded,
-    final String checksum
-  ) {
-    this(id, version, status, sdf.format(downloaded), checksum);
-  }
-
-  public BundleInfo(
-    final String id,
-    final String version,
-    final BundleStatus status,
-    final String downloaded,
-    final String checksum
-  ) {
-    this.downloaded = downloaded.trim();
-    this.id = id;
-    this.version = version;
-    this.checksum = checksum;
-    this.status = status;
-  }
-
-  public Boolean isBuiltin() {
-    return ID_BUILTIN.equals(this.id);
-  }
-
-  public Boolean isUnknown() {
-    return VERSION_UNKNOWN.equals(this.id);
-  }
-
-  public Boolean isErrorStatus() {
-    return BundleStatus.ERROR == this.status;
-  }
-
-  public Boolean isDeleted() {
-    return BundleStatus.DELETED == this.status;
-  }
-
-  public boolean isDownloaded() {
-    return (
-      !this.isBuiltin() &&
-      this.downloaded != null &&
-      !this.downloaded.isEmpty() &&
-      !this.isDeleted()
-    );
-  }
-
-  public String getDownloaded() {
-    return this.isBuiltin() ? DOWNLOADED_BUILTIN : this.downloaded;
-  }
-
-  public BundleInfo setDownloaded(Date downloaded) {
-    return new BundleInfo(
-      this.id,
-      this.version,
-      this.status,
-      downloaded,
-      this.checksum
-    );
-  }
-
-  public String getChecksum() {
-    return this.isBuiltin() ? "" : this.checksum;
-  }
-
-  public BundleInfo setChecksum(String checksum) {
-    return new BundleInfo(
-      this.id,
-      this.version,
-      this.status,
-      this.downloaded,
-      checksum
-    );
-  }
-
-  public String getId() {
-    return this.isBuiltin() ? ID_BUILTIN : this.id;
-  }
-
-  public BundleInfo setId(String id) {
-    return new BundleInfo(
-      id,
-      this.version,
-      this.status,
-      this.downloaded,
-      this.checksum
-    );
-  }
-
-  public String getVersionName() {
-    return this.version == null ? ID_BUILTIN : this.version;
-  }
-
-  public BundleInfo setVersionName(String version) {
-    return new BundleInfo(
-      this.id,
-      version,
-      this.status,
-      this.downloaded,
-      this.checksum
-    );
-  }
-
-  public BundleStatus getStatus() {
-    return this.isBuiltin() ? BundleStatus.SUCCESS : this.status;
-  }
-
-  public BundleInfo setStatus(BundleStatus status) {
-    return new BundleInfo(
-      this.id,
-      this.version,
-      status,
-      this.downloaded,
-      this.checksum
-    );
-  }
-
-  public static BundleInfo fromJSON(final JSObject json) throws JSONException {
-    return BundleInfo.fromJSON(json.toString());
-  }
-
-  public static BundleInfo fromJSON(final String jsonString)
-    throws JSONException {
-    JSONObject json = new JSONObject(new JSONTokener(jsonString));
-    return new BundleInfo(
-      json.has("id") ? json.getString("id") : "",
-      json.has("version")
-        ? json.getString("version")
-        : BundleInfo.VERSION_UNKNOWN,
-      json.has("status")
-        ? BundleStatus.fromString(json.getString("status"))
-        : BundleStatus.PENDING,
-      json.has("downloaded") ? json.getString("downloaded") : "",
-      json.has("checksum") ? json.getString("checksum") : ""
-    );
-  }
-
-  public JSObject toJSON() {
-    final JSObject result = new JSObject();
-    result.put("id", this.getId());
-    result.put("version", this.getVersionName());
-    result.put("downloaded", this.getDownloaded());
-    result.put("checksum", this.getChecksum());
-    result.put("status", this.getStatus());
-    return result;
-  }
-
-  @Override
-  public boolean equals(final Object o) {
-    if (this == o) return true;
-    if (!(o instanceof BundleInfo)) return false;
-    final BundleInfo that = (BundleInfo) o;
-    return this.getId().equals(that.getId());
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(this.version);
-  }
-
-  @Override
-  public String toString() {
-    return this.toJSON().toString();
-  }
+    private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
+
+    public static final String ID_BUILTIN = "builtin";
+    public static final String VERSION_UNKNOWN = "unknown";
+    public static final String DOWNLOADED_BUILTIN = "1970-01-01T00:00:00.000Z";
+
+    private final String downloaded;
+    private final String id;
+    private final String version;
+    private final String checksum;
+    private final BundleStatus status;
+
+    static {
+        sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
+    }
+
+    public BundleInfo(final BundleInfo source) {
+        this(source.id, source.version, source.status, source.downloaded, source.checksum);
+    }
+
+    public BundleInfo(final String id, final String version, final BundleStatus status, final Date downloaded, final String checksum) {
+        this(id, version, status, sdf.format(downloaded), checksum);
+    }
+
+    public BundleInfo(final String id, final String version, final BundleStatus status, final String downloaded, final String checksum) {
+        this.downloaded = downloaded.trim();
+        this.id = id;
+        this.version = version;
+        this.checksum = checksum;
+        this.status = status;
+    }
+
+    public Boolean isBuiltin() {
+        return ID_BUILTIN.equals(this.id);
+    }
+
+    public Boolean isUnknown() {
+        return VERSION_UNKNOWN.equals(this.id);
+    }
+
+    public Boolean isErrorStatus() {
+        return BundleStatus.ERROR == this.status;
+    }
+
+    public Boolean isDeleted() {
+        return BundleStatus.DELETED == this.status;
+    }
+
+    public boolean isDownloaded() {
+        return (!this.isBuiltin() && this.downloaded != null && !this.downloaded.isEmpty() && !this.isDeleted());
+    }
+
+    public String getDownloaded() {
+        return this.isBuiltin() ? DOWNLOADED_BUILTIN : this.downloaded;
+    }
+
+    public BundleInfo setDownloaded(Date downloaded) {
+        return new BundleInfo(this.id, this.version, this.status, downloaded, this.checksum);
+    }
+
+    public String getChecksum() {
+        return this.isBuiltin() ? "" : this.checksum;
+    }
+
+    public BundleInfo setChecksum(String checksum) {
+        return new BundleInfo(this.id, this.version, this.status, this.downloaded, checksum);
+    }
+
+    public String getId() {
+        return this.isBuiltin() ? ID_BUILTIN : this.id;
+    }
+
+    public BundleInfo setId(String id) {
+        return new BundleInfo(id, this.version, this.status, this.downloaded, this.checksum);
+    }
+
+    public String getVersionName() {
+        return this.version == null ? ID_BUILTIN : this.version;
+    }
+
+    public BundleInfo setVersionName(String version) {
+        return new BundleInfo(this.id, version, this.status, this.downloaded, this.checksum);
+    }
+
+    public BundleStatus getStatus() {
+        return this.isBuiltin() ? BundleStatus.SUCCESS : this.status;
+    }
+
+    public BundleInfo setStatus(BundleStatus status) {
+        return new BundleInfo(this.id, this.version, status, this.downloaded, this.checksum);
+    }
+
+    public static BundleInfo fromJSON(final JSObject json) throws JSONException {
+        return BundleInfo.fromJSON(json.toString());
+    }
+
+    public static BundleInfo fromJSON(final String jsonString) throws JSONException {
+        JSONObject json = new JSONObject(new JSONTokener(jsonString));
+        return new BundleInfo(
+            json.has("id") ? json.getString("id") : "",
+            json.has("version") ? json.getString("version") : BundleInfo.VERSION_UNKNOWN,
+            json.has("status") ? BundleStatus.fromString(json.getString("status")) : BundleStatus.PENDING,
+            json.has("downloaded") ? json.getString("downloaded") : "",
+            json.has("checksum") ? json.getString("checksum") : ""
+        );
+    }
+
+    public JSObject toJSON() {
+        final JSObject result = new JSObject();
+        result.put("id", this.getId());
+        result.put("version", this.getVersionName());
+        result.put("downloaded", this.getDownloaded());
+        result.put("checksum", this.getChecksum());
+        result.put("status", this.getStatus());
+        return result;
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (!(o instanceof BundleInfo)) return false;
+        final BundleInfo that = (BundleInfo) o;
+        return this.getId().equals(that.getId());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(this.version);
+    }
+
+    @Override
+    public String toString() {
+        return this.toJSON().toString();
+    }
 }

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

@@ -10,35 +10,35 @@ import java.util.HashMap;
 import java.util.Map;
 
 public enum BundleStatus {
-  SUCCESS("success"),
-  ERROR("error"),
-  PENDING("pending"),
-  DELETED("deleted"),
-  DOWNLOADING("downloading");
+    SUCCESS("success"),
+    ERROR("error"),
+    PENDING("pending"),
+    DELETED("deleted"),
+    DOWNLOADING("downloading");
 
-  public final String label;
+    public final String label;
 
-  private static final Map<String, BundleStatus> BY_LABEL = new HashMap<>();
+    private static final Map<String, BundleStatus> BY_LABEL = new HashMap<>();
 
-  static {
-    for (final BundleStatus e : values()) {
-      BY_LABEL.put(e.label, e);
+    static {
+        for (final BundleStatus e : values()) {
+            BY_LABEL.put(e.label, e);
+        }
     }
-  }
 
-  BundleStatus(final String label) {
-    this.label = label;
-  }
+    BundleStatus(final String label) {
+        this.label = label;
+    }
 
-  @Override
-  public String toString() {
-    return this.label;
-  }
+    @Override
+    public String toString() {
+        return this.label;
+    }
 
-  public static BundleStatus fromString(final String status) {
-    if (status == null || status.isEmpty()) {
-      return BundleStatus.PENDING;
+    public static BundleStatus fromString(final String status) {
+        if (status == null || status.isEmpty()) {
+            return BundleStatus.PENDING;
+        }
+        return BundleStatus.BY_LABEL.get(status);
     }
-    return BundleStatus.BY_LABEL.get(status);
-  }
 }

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

@@ -9,5 +9,5 @@ package ee.forgr.capacitor_updater;
 import com.getcapacitor.JSObject;
 
 public interface Callback {
-  void callback(JSObject jsoObject);
+    void callback(JSObject jsoObject);
 }