@capgo/capacitor-updater 6.13.2 → 6.14.2

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

@@ -16,98 +16,86 @@ import java.util.concurrent.TimeUnit;
 
 public class DownloadWorkerManager {
 
-  private static final String TAG = "DownloadWorkerManager";
-  private static volatile boolean isInitialized = false;
-  private static final Set<String> activeVersions = new HashSet<>();
+    private static final String TAG = "DownloadWorkerManager";
+    private static volatile boolean isInitialized = false;
+    private static final Set<String> activeVersions = new HashSet<>();
 
-  private static synchronized void initializeIfNeeded(Context context) {
-    if (!isInitialized) {
-      try {
-        Configuration config = new Configuration.Builder()
-          .setMinimumLoggingLevel(android.util.Log.INFO)
-          .build();
-        WorkManager.initialize(context, config);
-        isInitialized = true;
-      } catch (IllegalStateException e) {
-        // WorkManager was already initialized, ignore
-      }
+    private static synchronized void initializeIfNeeded(Context context) {
+        if (!isInitialized) {
+            try {
+                Configuration config = new Configuration.Builder().setMinimumLoggingLevel(android.util.Log.INFO).build();
+                WorkManager.initialize(context, config);
+                isInitialized = true;
+            } catch (IllegalStateException e) {
+                // WorkManager was already initialized, ignore
+            }
+        }
     }
-  }
 
-  public static synchronized boolean isVersionDownloading(String version) {
-    return activeVersions.contains(version);
-  }
+    public static synchronized boolean isVersionDownloading(String version) {
+        return activeVersions.contains(version);
+    }
 
-  public static void enqueueDownload(
-    Context context,
-    String url,
-    String id,
-    String documentsDir,
-    String dest,
-    String version,
-    String sessionKey,
-    String checksum,
-    String publicKey,
-    boolean isManifest
-  ) {
-    initializeIfNeeded(context.getApplicationContext());
+    public static void enqueueDownload(
+        Context context,
+        String url,
+        String id,
+        String documentsDir,
+        String dest,
+        String version,
+        String sessionKey,
+        String checksum,
+        String publicKey,
+        boolean isManifest
+    ) {
+        initializeIfNeeded(context.getApplicationContext());
 
-    // If version is already downloading, don't start another one
-    if (isVersionDownloading(version)) {
-      Log.i(TAG, "Version " + version + " is already downloading");
-      return;
-    }
-    activeVersions.add(version);
+        // If version is already downloading, don't start another one
+        if (isVersionDownloading(version)) {
+            Log.i(TAG, "Version " + version + " is already downloading");
+            return;
+        }
+        activeVersions.add(version);
 
-    // Create input data
-    Data inputData = new Data.Builder()
-      .putString(DownloadService.URL, url)
-      .putString(DownloadService.ID, id)
-      .putString(DownloadService.DOCDIR, documentsDir)
-      .putString(DownloadService.FILEDEST, dest)
-      .putString(DownloadService.VERSION, version)
-      .putString(DownloadService.SESSIONKEY, sessionKey)
-      .putString(DownloadService.CHECKSUM, checksum)
-      .putBoolean(DownloadService.IS_MANIFEST, isManifest)
-      .putString(DownloadService.PUBLIC_KEY, publicKey)
-      .build();
+        // Create input data
+        Data inputData = new Data.Builder()
+            .putString(DownloadService.URL, url)
+            .putString(DownloadService.ID, id)
+            .putString(DownloadService.DOCDIR, documentsDir)
+            .putString(DownloadService.FILEDEST, dest)
+            .putString(DownloadService.VERSION, version)
+            .putString(DownloadService.SESSIONKEY, sessionKey)
+            .putString(DownloadService.CHECKSUM, checksum)
+            .putBoolean(DownloadService.IS_MANIFEST, isManifest)
+            .putString(DownloadService.PUBLIC_KEY, publicKey)
+            .build();
 
-    // Create network constraints
-    Constraints constraints = new Constraints.Builder()
-      .setRequiredNetworkType(NetworkType.CONNECTED)
-      .build();
+        // Create network constraints
+        Constraints constraints = new Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build();
 
-    // Create work request with tags for tracking
-    OneTimeWorkRequest workRequest = new OneTimeWorkRequest.Builder(
-      DownloadService.class
-    )
-      .setConstraints(constraints)
-      .setInputData(inputData)
-      .addTag(id)
-      .addTag(version) // Add version tag for tracking
-      .addTag("capacitor_updater_download")
-      .setBackoffCriteria(
-        BackoffPolicy.LINEAR,
-        WorkRequest.MIN_BACKOFF_MILLIS,
-        TimeUnit.MILLISECONDS
-      )
-      .build();
+        // Create work request with tags for tracking
+        OneTimeWorkRequest workRequest = new OneTimeWorkRequest.Builder(DownloadService.class)
+            .setConstraints(constraints)
+            .setInputData(inputData)
+            .addTag(id)
+            .addTag(version) // Add version tag for tracking
+            .addTag("capacitor_updater_download")
+            .setBackoffCriteria(BackoffPolicy.LINEAR, WorkRequest.MIN_BACKOFF_MILLIS, TimeUnit.MILLISECONDS)
+            .build();
 
-    // Enqueue work
-    WorkManager.getInstance(context).enqueue(workRequest);
-  }
+        // Enqueue work
+        WorkManager.getInstance(context).enqueue(workRequest);
+    }
 
-  public static void cancelVersionDownload(Context context, String version) {
-    initializeIfNeeded(context.getApplicationContext());
-    WorkManager.getInstance(context).cancelAllWorkByTag(version);
-    activeVersions.remove(version);
-  }
+    public static void cancelVersionDownload(Context context, String version) {
+        initializeIfNeeded(context.getApplicationContext());
+        WorkManager.getInstance(context).cancelAllWorkByTag(version);
+        activeVersions.remove(version);
+    }
 
-  public static void cancelAllDownloads(Context context) {
-    initializeIfNeeded(context.getApplicationContext());
-    WorkManager.getInstance(context).cancelAllWorkByTag(
-      "capacitor_updater_download"
-    );
-    activeVersions.clear();
-  }
+    public static void cancelAllDownloads(Context context) {
+        initializeIfNeeded(context.getApplicationContext());
+        WorkManager.getInstance(context).cancelAllWorkByTag("capacitor_updater_download");
+        activeVersions.clear();
+    }
 }

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

@@ -6,36 +6,27 @@ import android.os.Build;
 
 public class InternalUtils {
 
-  public static String getPackageName(PackageManager pm, String packageName) {
-    try {
-      PackageInfo pInfo = getPackageInfoInternal(pm, packageName);
-      return (pInfo != null) ? pInfo.packageName : null;
-    } catch (PackageManager.NameNotFoundException e) {
-      // Exception is handled internally, and null is returned to indicate the package name could not be retrieved
-      return null;
+    public static String getPackageName(PackageManager pm, String packageName) {
+        try {
+            PackageInfo pInfo = getPackageInfoInternal(pm, packageName);
+            return (pInfo != null) ? pInfo.packageName : null;
+        } catch (PackageManager.NameNotFoundException e) {
+            // Exception is handled internally, and null is returned to indicate the package name could not be retrieved
+            return null;
+        }
     }
-  }
 
-  private static PackageInfo getPackageInfoInternal(
-    PackageManager pm,
-    String packageName
-  ) throws PackageManager.NameNotFoundException {
-    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-      return pm.getPackageInfo(
-        packageName,
-        PackageManager.PackageInfoFlags.of(0)
-      );
-    } else {
-      return getPackageInfoLegacy(pm, packageName, (int) (long) 0);
+    private static PackageInfo getPackageInfoInternal(PackageManager pm, String packageName) throws PackageManager.NameNotFoundException {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+            return pm.getPackageInfo(packageName, PackageManager.PackageInfoFlags.of(0));
+        } else {
+            return getPackageInfoLegacy(pm, packageName, (int) (long) 0);
+        }
     }
-  }
 
-  @SuppressWarnings("deprecation")
-  private static PackageInfo getPackageInfoLegacy(
-    PackageManager pm,
-    String packageName,
-    int flags
-  ) throws PackageManager.NameNotFoundException {
-    return pm.getPackageInfo(packageName, flags);
-  }
+    @SuppressWarnings("deprecation")
+    private static PackageInfo getPackageInfoLegacy(PackageManager pm, String packageName, int flags)
+        throws PackageManager.NameNotFoundException {
+        return pm.getPackageInfo(packageName, flags);
+    }
 }

package/dist/docs.json

@@ -255,14 +255,24 @@
       },
       {
         "name": "list",
-        "signature": "() => Promise<BundleListResult>",
-        "parameters": [],
+        "signature": "(options?: ListOptions | undefined) => Promise<BundleListResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The {@link ListOptions} for listing bundles",
+            "type": "ListOptions | undefined"
+          }
+        ],
         "returns": "Promise<BundleListResult>",
         "tags": [
           {
             "name": "returns",
             "text": "A Promise containing the {@link BundleListResult.bundles}"
           },
+          {
+            "name": "param",
+            "text": "options The {@link ListOptions} for listing bundles"
+          },
           {
             "name": "throws",
             "text": "{Error}"
@@ -270,7 +280,8 @@
         ],
         "docs": "Get all locally downloaded bundles in your app",
         "complexTypes": [
-          "BundleListResult"
+          "BundleListResult",
+          "ListOptions"
         ],
         "slug": "list"
       },
@@ -672,7 +683,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"download\", listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -701,7 +712,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"noNeedUpdate\", listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -730,7 +741,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"updateAvailable\", listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -759,7 +770,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"downloadComplete\", listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -788,7 +799,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"majorAvailable\", listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -817,7 +828,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"updateFailed\", listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -846,7 +857,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"downloadFailed\", listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -875,7 +886,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"appReloaded\", listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -903,7 +914,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"appReady\", listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1104,7 +1115,7 @@
           "tags": [],
           "docs": "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.)",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "version",
@@ -1181,6 +1192,31 @@
         }
       ]
     },
+    {
+      "name": "ListOptions",
+      "slug": "listoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "raw",
+          "tags": [
+            {
+              "text": "6.14.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "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.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
     {
       "name": "ResetOptions",
       "slug": "resetoptions",
@@ -1856,19 +1892,19 @@
       "docs": "",
       "types": [
         {
-          "text": "\"success\"",
+          "text": "'success'",
           "complexTypes": []
         },
         {
-          "text": "\"error\"",
+          "text": "'error'",
           "complexTypes": []
         },
         {
-          "text": "\"pending\"",
+          "text": "'pending'",
           "complexTypes": []
         },
         {
-          "text": "\"downloading\"",
+          "text": "'downloading'",
           "complexTypes": []
         }
       ]
@@ -1879,19 +1915,19 @@
       "docs": "",
       "types": [
         {
-          "text": "\"background\"",
+          "text": "'background'",
           "complexTypes": []
         },
         {
-          "text": "\"kill\"",
+          "text": "'kill'",
           "complexTypes": []
         },
         {
-          "text": "\"nativeVersion\"",
+          "text": "'nativeVersion'",
           "complexTypes": []
         },
         {
-          "text": "\"date\"",
+          "text": "'date'",
           "complexTypes": []
         }
       ]

package/dist/esm/definitions.d.ts

@@ -1,5 +1,5 @@
-import type { PluginListenerHandle } from "@capacitor/core";
-declare module "@capacitor/cli" {
+import type { PluginListenerHandle } from '@capacitor/core';
+declare module '@capacitor/cli' {
     interface PluginsConfig {
         /**
          * CapacitorUpdater can be configured with these options:
@@ -295,9 +295,10 @@ export interface CapacitorUpdaterPlugin {
      * Get all locally downloaded bundles in your app
      *
      * @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}
+     * @param options The {@link ListOptions} for listing bundles
      * @throws {Error}
      */
-    list(): Promise<BundleListResult>;
+    list(options?: ListOptions): Promise<BundleListResult>;
     /**
      * Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.
      *
@@ -438,55 +439,55 @@ export interface CapacitorUpdaterPlugin {
      *
      * @since 2.0.11
      */
-    addListener(eventName: "download", listenerFunc: (state: DownloadEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for no need to update event, useful when you want force check every time the app is launched
      *
      * @since 4.0.0
      */
-    addListener(eventName: "noNeedUpdate", listenerFunc: (state: NoNeedEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for available update event, useful when you want to force check every time the app is launched
      *
      * @since 4.0.0
      */
-    addListener(eventName: "updateAvailable", listenerFunc: (state: UpdateAvailableEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for downloadComplete events.
      *
      * @since 4.0.0
      */
-    addListener(eventName: "downloadComplete", listenerFunc: (state: DownloadCompleteEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
      *
      * @since 2.3.0
      */
-    addListener(eventName: "majorAvailable", listenerFunc: (state: MajorAvailableEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for update fail event in the App, let you know when update has fail to install at next app start
      *
      * @since 2.3.0
      */
-    addListener(eventName: "updateFailed", listenerFunc: (state: UpdateFailedEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for download fail event in the App, let you know when a bundle download has failed
      *
      * @since 4.0.0
      */
-    addListener(eventName: "downloadFailed", listenerFunc: (state: DownloadFailedEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void): Promise<PluginListenerHandle>;
     /**
      *  Listen for reload event in the App, let you know when reload has happened
      *
      * @since 4.3.0
      */
-    addListener(eventName: "appReloaded", listenerFunc: () => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'appReloaded', listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
      * Listen for app ready event in the App, let you know when app is ready to use
      *
      * @since 5.1.0
      */
-    addListener(eventName: "appReady", listenerFunc: (state: AppReadyEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Get if auto update is available (not disabled by serverUrl).
      *
@@ -504,8 +505,8 @@ export interface CapacitorUpdaterPlugin {
      */
     getNextBundle(): Promise<BundleInfo | null>;
 }
-export type BundleStatus = "success" | "error" | "pending" | "downloading";
-export type DelayUntilNext = "background" | "kill" | "nativeVersion" | "date";
+export type BundleStatus = 'success' | 'error' | 'pending' | 'downloading';
+export type DelayUntilNext = 'background' | 'kill' | 'nativeVersion' | 'date';
 export interface NoNeedEvent {
     /**
      * Current status of download, between 0 and 100.
@@ -671,7 +672,7 @@ export interface DownloadOptions {
     /**
      * 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.)
      */
-    url: string;
+    url?: string;
     /**
      * The version code/name of this bundle/version
      */
@@ -698,6 +699,14 @@ export interface BundleListResult {
 export interface ResetOptions {
     toLastSuccessful: boolean;
 }
+export interface ListOptions {
+    /**
+     * 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.
+     * @since 6.14.0
+     * @default false
+     */
+    raw?: boolean;
+}
 export interface CurrentBundleResult {
     bundle: BundleInfo;
     native: string;