npm - @capgo/capacitor-updater - Versions diffs - 6.14.25 → 6.14.29 - Mend

@capgo/capacitor-updater 6.14.25 → 6.14.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

package/dist/esm/definitions.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@ declare module '@capacitor/cli' {
              */
             appReadyTimeout?: number;
             /**
-             * Configure the number of milliseconds the native plugin should wait before considering API timeout.
+             * Configure the number of seconds the native plugin should wait before considering API timeout.
              *
              * Only available for Android and iOS.
              *
@@ -89,9 +89,11 @@ declare module '@capacitor/cli' {
             /**
              * Configure the private key for end to end live update encryption.
              *
-             * Only available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.
+             * Only available for Android and iOS. Deprecated in version 6.2.0 in favor of publicKey.
+             * Still supported for backwards compatibility.
              *
              * @default undefined
+             * @deprecated Use publicKey instead
              */
             privateKey?: string;
             /**
@@ -114,21 +116,66 @@ declare module '@capacitor/cli' {
              */
             version?: string;
             /**
-             * Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.
+             * Configure when the plugin should direct install updates. Only for autoUpdate mode.
+             * Works well for apps less than 10MB and with uploads done using --partial flag.
+             * Zip or apps more than 10MB will be relatively slow for users to update.
+             * - false: Never do direct updates (default behavior)
+             * - atInstall: Direct update only when app is installed/updated from store, otherwise use normal background update
+             * - always: Always do direct updates immediately when available
+             * - true: (deprecated) Same as "always" for backward compatibility
              *
              * Only available for Android and iOS.
              *
-             * @default undefined
+             * @default false
              * @since  5.1.0
              */
-            directUpdate?: boolean;
+            directUpdate?: boolean | 'atInstall' | 'always';
+            /**
+             * Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.
+             * This removes the need to manually listen for appReady events and call SplashScreen.hide().
+             * Only works when directUpdate is set to "atInstall", "always", or true.
+             * Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.
+             * Requires autoUpdate and directUpdate to be enabled.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default false
+             * @since  7.6.0
+             */
+            autoSplashscreen?: boolean;
+            /**
+             * Display a native loading indicator on top of the splashscreen while automatic direct updates are running.
+             * Only takes effect when {@link autoSplashscreen} is enabled.
+             * Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default false
+             * @since  7.19.0
+             */
+            autoSplashscreenLoader?: boolean;
+            /**
+             * Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.
+             * If the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.
+             * Set to `0` (zero) to disable the timeout.
+             * When the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.
+             * Requires {@link autoSplashscreen} to be enabled.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default 10000 // (10 seconds)
+             * @since  7.19.0
+             */
+            autoSplashscreenTimeout?: number;
             /**
              * Configure the delay period for period update check. the unit is in seconds.
              *
              * Only available for Android and iOS.
              * Cannot be less than 600 seconds (10 minutes).
              *
-             * @default 600 // (10 minutes)
+             * @default 0 (disabled)
+             * @example 3600 (1 hour)
+             * @example 86400 (24 hours)
              */
             periodCheckDelay?: number;
             /**
@@ -196,8 +243,44 @@ declare module '@capacitor/cli' {
              */
             allowModifyUrl?: boolean;
             /**
-             * Set the default channel for the app in the config.
+             * Allow the plugin to modify the appId dynamically from the JavaScript side.
+             *
+             *
+             * @default false
+             * @since  7.14.0
+             */
+            allowModifyAppId?: boolean;
+            /**
+             * Allow marking bundles as errored from JavaScript while using manual update flows.
+             * When enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.
+             *
+             * @default false
+             * @since 7.20.0
+             */
+            allowManualBundleError?: boolean;
+            /**
+             * Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.
              *
+             * Only available for Android and iOS.
+             *
+             * @default false (will be true by default in a future major release v8.x.x)
+             * @since  7.17.3
+             */
+            persistCustomId?: boolean;
+            /**
+             * Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},
+             * {@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default false
+             * @since  7.20.0
+             */
+            persistModifyUrl?: boolean;
+            /**
+             * Set the default channel for the app in the config. Case sensitive.
+             * This will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.
+             * This requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options
              *
              *
              * @default undefined
@@ -219,6 +302,20 @@ declare module '@capacitor/cli' {
              * @since  6.8.0
              */
             keepUrlPathAfterReload?: boolean;
+            /**
+             * Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done
+             *
+             * @default false
+             * @since  7.3.0
+             */
+            disableJSLogging?: boolean;
+            /**
+             * Enable shake gesture to show update menu for debugging/testing purposes
+             *
+             * @default false
+             * @since  7.5.0
+             */
+            shakeMenu?: boolean;
         };
     }
 }
@@ -291,6 +388,15 @@ export interface CapacitorUpdaterPlugin {
      * @throws {Error}
      */
     delete(options: BundleId): Promise<void>;
+    /**
+     * Mark an installed bundle as errored. Only available when {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} is true.
+     *
+     * @param options A {@link BundleId} object containing the bundle id to mark as errored.
+     * @returns {Promise<BundleInfo>} The updated {@link BundleInfo} for the bundle.
+     * @throws {Error} When the bundle does not exist or the feature is disabled.
+     * @since 7.20.0
+     */
+    setBundleError(options: BundleId): Promise<BundleInfo>;
     /**
      * Get all locally downloaded bundles in your app
      *
@@ -363,8 +469,9 @@ export interface CapacitorUpdaterPlugin {
     getLatest(options?: GetLatestOptions): Promise<LatestVersion>;
     /**
      * Sets the channel for this device. The channel has to allow for self assignment for this to work.
-     * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.
-     * This method is to set the channel after the app is ready.
+     * Do not use this method to set the channel at boot.
+     * This method is to set the channel after the app is ready, and user interacted.
+     * If you want to set the channel at boot, use the {@link PluginsConfig} to set the default channel.
      * 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.
      *
      *
@@ -391,9 +498,20 @@ export interface CapacitorUpdaterPlugin {
      * @since 4.8.0
      */
     getChannel(): Promise<GetChannelRes>;
+    /**
+     * List all channels available for this device that allow self-assignment
+     *
+     * @returns {Promise<ListChannelsResult>} A Promise that resolves with the available channels
+     * @throws {Error}
+     * @since 7.5.0
+     */
+    listChannels(): Promise<ListChannelsResult>;
     /**
      * Set a custom ID for this device
      *
+     * When {@link PluginsConfig.CapacitorUpdater.persistCustomId} is true, the value will be stored natively and restored on the next app launch.
+     * Pass an empty string to remove any previously stored customId.
+     *
      * @param options is the {@link SetCustomIdOptions} customId to set
      * @returns {Promise<void>} an Promise resolved instantly
      * @throws {Error}
@@ -408,7 +526,7 @@ export interface CapacitorUpdaterPlugin {
      */
     getBuiltinVersion(): Promise<BuiltinVersion>;
     /**
-     * Get unique ID used to identify device (sent to auto update server)
+     * Get unique ID used to identify device (sent to auto update server), this ID is made following Apple and Google privacy best practices, and not persisted between installs
      *
      * @returns {Promise<DeviceId>} A Promise with id for this device
      * @throws {Error}
@@ -436,6 +554,7 @@ export interface CapacitorUpdaterPlugin {
     removeAllListeners(): Promise<void>;
     /**
      * Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.
+     * This will return you all download percent during the download
      *
      * @since 2.0.11
      */
@@ -458,9 +577,17 @@ export interface CapacitorUpdaterPlugin {
      * @since 4.0.0
      */
     addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for breaking update events when the backend flags an update as incompatible with the current app.
+     * Emits the same payload as the legacy `majorAvailable` listener.
+     *
+     * @since 7.22.0
+     */
+    addListener(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
      *
+     * @deprecated Deprecated alias for {@link addListener} with `breakingAvailable`. Emits the same payload. will be removed in v8
      * @since 2.3.0
      */
     addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void): Promise<PluginListenerHandle>;
@@ -483,7 +610,7 @@ export interface CapacitorUpdaterPlugin {
      */
     addListener(eventName: 'appReloaded', listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
-     * Listen for app ready event in the App, let you know when app is ready to use
+     * Listen for app ready event in the App, let you know when app is ready to use, this event is retain till consumed.
      *
      * @since 5.1.0
      */
@@ -504,7 +631,55 @@ export interface CapacitorUpdaterPlugin {
      * @since 6.8.0
      */
     getNextBundle(): Promise<BundleInfo | null>;
+    /**
+     * Get the most recent update that failed to install, if any. The stored value is cleared after it is retrieved once.
+     *
+     * @returns {Promise<UpdateFailedEvent | null>} The last failed update or null when no failure has been recorded. Value is cleared after it is returned once.
+     * @throws {Error}
+     * @since 7.22.0
+     */
+    getFailedUpdate(): Promise<UpdateFailedEvent | null>;
+    /**
+     * Enable or disable the shake menu for debugging/testing purposes
+     *
+     * @param options Contains enabled boolean to enable or disable shake menu
+     * @returns {Promise<void>}
+     * @throws {Error}
+     * @since 7.5.0
+     */
+    setShakeMenu(options: SetShakeMenuOptions): Promise<void>;
+    /**
+     * Get the current state of the shake menu
+     *
+     * @returns {Promise<ShakeMenuEnabled>} The current state of shake menu
+     * @throws {Error}
+     * @since 7.5.0
+     */
+    isShakeMenuEnabled(): Promise<ShakeMenuEnabled>;
+    /**
+     * Get the configured App ID
+     *
+     * @returns {Promise<GetAppIdRes>} The current App ID
+     * @throws {Error}
+     * @since 7.14.0
+     */
+    getAppId(): Promise<GetAppIdRes>;
+    /**
+     * Set the App ID for the app (requires allowModifyAppId to be true in config)
+     *
+     * @param options The new App ID to set
+     * @returns {Promise<void>}
+     * @throws {Error} If allowModifyAppId is false or if the operation fails
+     * @since 7.14.0
+     */
+    setAppId(options: SetAppIdOptions): Promise<void>;
 }
+/**
+ * pending: The bundle is pending to be **SET** as the next bundle.
+ * downloading: The bundle is being downloaded.
+ * success: The bundle has been downloaded and is ready to be **SET** as the next bundle.
+ * error: The bundle has failed to download.
+ */
 export type BundleStatus = 'success' | 'error' | 'pending' | 'downloading';
 export type DelayUntilNext = 'background' | 'kill' | 'nativeVersion' | 'date';
 export interface NoNeedEvent {
@@ -545,6 +720,40 @@ export interface GetChannelRes {
     status?: string;
     allowSet?: boolean;
 }
+export interface ChannelInfo {
+    /**
+     * The channel ID
+     *
+     * @since 7.5.0
+     */
+    id: string;
+    /**
+     * The channel name
+     *
+     * @since 7.5.0
+     */
+    name: string;
+    /**
+     * Whether this is a public channel
+     *
+     * @since 7.5.0
+     */
+    public: boolean;
+    /**
+     * Whether devices can self-assign to this channel
+     *
+     * @since 7.5.0
+     */
+    allow_self_set: boolean;
+}
+export interface ListChannelsResult {
+    /**
+     * List of available channels
+     *
+     * @since 7.5.0
+     */
+    channels: ChannelInfo[];
+}
 export interface DownloadEvent {
     /**
      * Current status of download, between 0 and 100.
@@ -556,12 +765,19 @@ export interface DownloadEvent {
 }
 export interface MajorAvailableEvent {
     /**
-     * Emit when a new major bundle is available.
+     * Emit when a breaking update is available.
      *
+     * @deprecated Deprecated alias for {@link BreakingAvailableEvent}. Receives the same payload.
      * @since  4.0.0
      */
     version: string;
 }
+/**
+ * Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.
+ *
+ * @since 7.22.0
+ */
+export type BreakingAvailableEvent = MajorAvailableEvent;
 export interface DownloadFailedEvent {
     /**
      * Emit when a download fail.
@@ -611,6 +827,15 @@ export interface LatestVersion {
      * @since 6
      */
     checksum?: string;
+    /**
+     * Indicates whether the update was flagged as breaking by the backend.
+     *
+     * @since 7.22.0
+     */
+    breaking?: boolean;
+    /**
+     * @deprecated Use {@link LatestVersion.breaking} instead.
+     */
     major?: boolean;
     message?: string;
     sessionKey?: string;
@@ -637,6 +862,9 @@ export interface UnsetChannelOptions {
     triggerAutoUpdate?: boolean;
 }
 export interface SetCustomIdOptions {
+    /**
+     * Custom identifier to associate with the device. Use an empty string to clear any saved value.
+     */
     customId: string;
 }
 export interface DelayCondition {
@@ -668,27 +896,37 @@ export interface StatsUrl {
 export interface ChannelUrl {
     url: string;
 }
+/**
+ * This URL and versions are used to download the bundle from the server, If you use backend all information will be gived by the method getLatest.
+ * If you don't use backend, you need to provide the URL and version of the bundle. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.
+ */
 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
      */
     version: string;
     /**
-     * The session key for the update
+     * The session key for the update, when the bundle is encrypted with a session key
      * @since 4.0.0
      * @default undefined
      */
     sessionKey?: string;
     /**
-     * The checksum for the update
+     * The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted
      * @since 4.0.0
      * @default undefined
      */
     checksum?: string;
+    /**
+     * The manifest for multi-file downloads
+     * @since 6.1.0
+     * @default undefined
+     */
+    manifest?: ManifestEntry[];
 }
 export interface BundleId {
     id: string;
@@ -729,3 +967,15 @@ export interface AutoUpdateEnabled {
 export interface AutoUpdateAvailable {
     available: boolean;
 }
+export interface SetShakeMenuOptions {
+    enabled: boolean;
+}
+export interface ShakeMenuEnabled {
+    enabled: boolean;
+}
+export interface GetAppIdRes {
+    appId: string;
+}
+export interface SetAppIdOptions {
+    appId: string;
+}

package/dist/esm/definitions.js.map CHANGED Viewed

	@@ -1 +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(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"]}
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 seconds 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 in favor of publicKey.\n * Still supported for backwards compatibility.\n \n @default undefined\n * @deprecated Use publicKey instead\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 Configure when the plugin should direct install updates. Only for autoUpdate mode.\n * Works well for apps less than 10MB and with uploads done using --partial flag.\n * Zip or apps more than 10MB will be relatively slow for users to update.\n * - false: Never do direct updates (default behavior)\n * - atInstall: Direct update only when app is installed/updated from store, otherwise use normal background update\n * - always: Always do direct updates immediately when available\n * - true: (deprecated) Same as \"always\" for backward compatibility\n \n Only available for Android and iOS.\n \n @default false\n * @since 5.1.0\n /\n directUpdate?: boolean \| 'atInstall' \| 'always';\n\n /\n Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.\n * This removes the need to manually listen for appReady events and call SplashScreen.hide().\n * Only works when directUpdate is set to \"atInstall\", \"always\", or true.\n * Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n * Requires autoUpdate and directUpdate to be enabled.\n \n Only available for Android and iOS.\n \n @default false\n * @since 7.6.0\n /\n autoSplashscreen?: boolean;\n\n /\n Display a native loading indicator on top of the splashscreen while automatic direct updates are running.\n * Only takes effect when {@link autoSplashscreen} is enabled.\n * Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n \n Only available for Android and iOS.\n \n @default false\n * @since 7.19.0\n /\n autoSplashscreenLoader?: boolean;\n\n /\n Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.\n * If the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.\n * Set to `0` (zero) to disable the timeout.\n * When the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.\n * Requires {@link autoSplashscreen} to be enabled.\n \n Only available for Android and iOS.\n \n @default 10000 // (10 seconds)\n * @since 7.19.0\n /\n autoSplashscreenTimeout?: number;\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 0 (disabled)\n * @example 3600 (1 hour)\n * @example 86400 (24 hours)\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 Allow the plugin to modify the appId dynamically from the JavaScript side.\n \n \n * @default false\n * @since 7.14.0\n /\n allowModifyAppId?: boolean;\n\n /\n Allow marking bundles as errored from JavaScript while using manual update flows.\n * When enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.\n \n @default false\n * @since 7.20.0\n /\n allowManualBundleError?: boolean;\n\n /\n Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n \n Only available for Android and iOS.\n \n @default false (will be true by default in a future major release v8.x.x)\n * @since 7.17.3\n /\n persistCustomId?: boolean;\n\n /\n Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},\n * {@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.\n \n Only available for Android and iOS.\n \n @default false\n * @since 7.20.0\n /\n persistModifyUrl?: boolean;\n\n /\n Set the default channel for the app in the config. Case sensitive.\n * This will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.\n * This requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options\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 Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done\n \n @default false\n * @since 7.3.0\n /\n disableJSLogging?: boolean;\n /\n Enable shake gesture to show update menu for debugging/testing purposes\n \n @default false\n * @since 7.5.0\n /\n shakeMenu?: 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 Mark an installed bundle as errored. Only available when {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} is true.\n \n @param options A {@link BundleId} object containing the bundle id to mark as errored.\n * @returns {Promise<BundleInfo>} The updated {@link BundleInfo} for the bundle.\n * @throws {Error} When the bundle does not exist or the feature is disabled.\n * @since 7.20.0\n /\n setBundleError(options: BundleId): Promise<BundleInfo>;\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.\n * This method is to set the channel after the app is ready, and user interacted.\n * If you want to set the channel at boot, use the {@link PluginsConfig} to set the default channel.\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 List all channels available for this device that allow self-assignment\n \n @returns {Promise<ListChannelsResult>} A Promise that resolves with the available channels\n * @throws {Error}\n * @since 7.5.0\n /\n listChannels(): Promise<ListChannelsResult>;\n\n /\n Set a custom ID for this device\n \n When {@link PluginsConfig.CapacitorUpdater.persistCustomId} is true, the value will be stored natively and restored on the next app launch.\n * Pass an empty string to remove any previously stored customId.\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), this ID is made following Apple and Google privacy best practices, and not persisted between installs\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 * This will return you all download percent during the download\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 breaking update events when the backend flags an update as incompatible with the current app.\n * Emits the same payload as the legacy `majorAvailable` listener.\n \n @since 7.22.0\n /\n addListener(\n eventName: 'breakingAvailable',\n listenerFunc: (state: BreakingAvailableEvent) => 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 @deprecated Deprecated alias for {@link addListener} with `breakingAvailable`. Emits the same payload. will be removed in v8\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, this event is retain till consumed.\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 /\n Get the most recent update that failed to install, if any. The stored value is cleared after it is retrieved once.\n \n @returns {Promise<UpdateFailedEvent \| null>} The last failed update or null when no failure has been recorded. Value is cleared after it is returned once.\n * @throws {Error}\n * @since 7.22.0\n /\n getFailedUpdate(): Promise<UpdateFailedEvent \| null>;\n\n /\n Enable or disable the shake menu for debugging/testing purposes\n \n @param options Contains enabled boolean to enable or disable shake menu\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 7.5.0\n /\n setShakeMenu(options: SetShakeMenuOptions): Promise<void>;\n\n /\n Get the current state of the shake menu\n \n @returns {Promise<ShakeMenuEnabled>} The current state of shake menu\n * @throws {Error}\n * @since 7.5.0\n /\n isShakeMenuEnabled(): Promise<ShakeMenuEnabled>;\n\n /\n Get the configured App ID\n \n @returns {Promise<GetAppIdRes>} The current App ID\n * @throws {Error}\n * @since 7.14.0\n /\n getAppId(): Promise<GetAppIdRes>;\n\n /\n Set the App ID for the app (requires allowModifyAppId to be true in config)\n \n @param options The new App ID to set\n * @returns {Promise<void>}\n * @throws {Error} If allowModifyAppId is false or if the operation fails\n * @since 7.14.0\n /\n setAppId(options: SetAppIdOptions): Promise<void>;\n}\n\n/\n pending: The bundle is pending to be SET as the next bundle.\n * downloading: The bundle is being downloaded.\n * success: The bundle has been downloaded and is ready to be SET as the next bundle.\n * error: The bundle has failed to download.\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 ChannelInfo {\n /\n The channel ID\n \n @since 7.5.0\n /\n id: string;\n /\n The channel name\n \n @since 7.5.0\n /\n name: string;\n /\n Whether this is a public channel\n \n @since 7.5.0\n /\n public: boolean;\n /\n Whether devices can self-assign to this channel\n \n @since 7.5.0\n /\n allow_self_set: boolean;\n}\n\nexport interface ListChannelsResult {\n /\n List of available channels\n \n @since 7.5.0\n /\n channels: ChannelInfo[];\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 breaking update is available.\n \n @deprecated Deprecated alias for {@link BreakingAvailableEvent}. Receives the same payload.\n * @since 4.0.0\n /\n version: string;\n}\n\n/\n Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.\n \n @since 7.22.0\n /\nexport type BreakingAvailableEvent = MajorAvailableEvent;\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 /\n Indicates whether the update was flagged as breaking by the backend.\n \n @since 7.22.0\n /\n breaking?: boolean;\n /\n @deprecated Use {@link LatestVersion.breaking} instead.\n /\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 /\n Custom identifier to associate with the device. Use an empty string to clear any saved value.\n /\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\n/\n This URL and versions are used to download the bundle from the server, If you use backend all information will be gived by the method getLatest.\n * If you don't use backend, you need to provide the URL and version of the bundle. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.\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, when the bundle is encrypted with a session key\n * @since 4.0.0\n * @default undefined\n /\n sessionKey?: string;\n /\n The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted\n * @since 4.0.0\n * @default undefined\n /\n checksum?: string;\n /\n The manifest for multi-file downloads\n * @since 6.1.0\n * @default undefined\n /\n manifest?: ManifestEntry[];\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\nexport interface SetShakeMenuOptions {\n enabled: boolean;\n}\n\nexport interface ShakeMenuEnabled {\n enabled: boolean;\n}\n\nexport interface GetAppIdRes {\n appId: string;\n}\n\nexport interface SetAppIdOptions {\n appId: string;\n}\n"]}

package/dist/esm/history.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};