@capgo/capacitor-updater 6.14.0 → 6.14.3

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

@@ -683,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",
@@ -712,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",
@@ -741,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",
@@ -770,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",
@@ -799,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",
@@ -828,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",
@@ -857,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",
@@ -886,7 +886,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"appReloaded\", listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -914,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",
@@ -1892,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": []
         }
       ]
@@ -1915,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:
@@ -439,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).
      *
@@ -505,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.

package/dist/esm/definitions.js.map

@@ -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       * 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   * @param options The {@link ListOptions} for listing bundles\n   * @throws {Error}\n   */\n  list(options?: ListOptions): 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 ListOptions {\n  /**\n   * 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.\n   * @since 6.14.0\n   * @default false\n   */\n  raw?: 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"]}
+{"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   * @param options The {@link ListOptions} for listing bundles\n   * @throws {Error}\n   */\n  list(options?: ListOptions): 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(eventName: 'download', listenerFunc: (state: DownloadEvent) => void): 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(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void): 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(eventName: 'appReloaded', listenerFunc: () => void): 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(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void): 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 ListOptions {\n  /**\n   * 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.\n   * @since 6.14.0\n   * @default false\n   */\n  raw?: 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/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import type { CapacitorUpdaterPlugin } from "./definitions";
+import type { CapacitorUpdaterPlugin } from './definitions';
 declare const CapacitorUpdater: CapacitorUpdaterPlugin;
-export * from "./definitions";
+export * from './definitions';
 export { CapacitorUpdater };

package/dist/esm/index.js

@@ -3,10 +3,10 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { registerPlugin } from "@capacitor/core";
-const CapacitorUpdater = registerPlugin("CapacitorUpdater", {
-    web: () => import("./web").then((m) => new m.CapacitorUpdaterWeb()),
+import { registerPlugin } from '@capacitor/core';
+const CapacitorUpdater = registerPlugin('CapacitorUpdater', {
+    web: () => import('./web').then((m) => new m.CapacitorUpdaterWeb()),
 });
-export * from "./definitions";
+export * from './definitions';
 export { CapacitorUpdater };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,gBAAgB,GAAG,cAAc,CACrC,kBAAkB,EAClB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;CACpE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,CAAC","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\nimport { registerPlugin } from \"@capacitor/core\";\n\nimport type { CapacitorUpdaterPlugin } from \"./definitions\";\n\nconst CapacitorUpdater = registerPlugin<CapacitorUpdaterPlugin>(\n  \"CapacitorUpdater\",\n  {\n    web: () => import(\"./web\").then((m) => new m.CapacitorUpdaterWeb()),\n  },\n);\n\nexport * from \"./definitions\";\nexport { CapacitorUpdater };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,gBAAgB,GAAG,cAAc,CAAyB,kBAAkB,EAAE;IAClF,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;CACpE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,CAAC","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\nimport { registerPlugin } from '@capacitor/core';\n\nimport type { CapacitorUpdaterPlugin } from './definitions';\n\nconst CapacitorUpdater = registerPlugin<CapacitorUpdaterPlugin>('CapacitorUpdater', {\n  web: () => import('./web').then((m) => new m.CapacitorUpdaterWeb()),\n});\n\nexport * from './definitions';\nexport { CapacitorUpdater };\n"]}

package/dist/esm/web.d.ts

@@ -1,5 +1,5 @@
-import { WebPlugin } from "@capacitor/core";
-import type { CapacitorUpdaterPlugin, BundleInfo, LatestVersion, DelayCondition, ChannelRes, SetChannelOptions, GetChannelRes, SetCustomIdOptions, UnsetChannelOptions, StatsUrl, UpdateUrl, ChannelUrl, DownloadOptions, BundleId, AutoUpdateEnabled, DeviceId, BuiltinVersion, PluginVersion, BundleListResult, ResetOptions, CurrentBundleResult, AppReadyResult, MultiDelayConditions, AutoUpdateAvailable } from "./definitions";
+import { WebPlugin } from '@capacitor/core';
+import type { CapacitorUpdaterPlugin, BundleInfo, LatestVersion, DelayCondition, ChannelRes, SetChannelOptions, GetChannelRes, SetCustomIdOptions, UnsetChannelOptions, StatsUrl, UpdateUrl, ChannelUrl, DownloadOptions, BundleId, AutoUpdateEnabled, DeviceId, BuiltinVersion, PluginVersion, BundleListResult, ResetOptions, CurrentBundleResult, AppReadyResult, MultiDelayConditions, AutoUpdateAvailable } from './definitions';
 export declare class CapacitorUpdaterWeb extends WebPlugin implements CapacitorUpdaterPlugin {
     setStatsUrl(options: StatsUrl): Promise<void>;
     setUpdateUrl(options: UpdateUrl): Promise<void>;