@capgo/capacitor-updater 7.51.15 → 7.51.18

package/dist/docs.json

@@ -4631,7 +4631,7 @@
               "name": "example"
             }
           ],
-          "docs": "Configure how the plugin checks for, downloads, and applies live updates.\n\nThe plugin checks for updates when the app moves to the foreground. When\n{@link periodCheckDelay} is greater than 0, it also checks on a repeating timer\nwhile the app stays open.\n\nBoolean values keep their existing behavior:\n- `true`: Same as `\"atBackground\"`.\n- `false`: Same as `\"off\"`.\n\nString values merge the previous Auto Update and Direct Update configuration:\n- `\"off\"`: Disable automatic update checks.\n- `\"atBackground\"`: Check and download automatically on each foreground check, then apply the update the next time the app moves to background.\n- `\"atInstall\"`: Apply immediately only after a fresh install or native app store update; otherwise use `\"atBackground\"` behavior.\n- `\"onLaunch\"`: Apply immediately only when the app is brought to the foreground from a killed state (cold start). After that first check, fall back to `\"atBackground\"` behavior.\n- `\"always\"`: Check on every foreground transition and apply immediately whenever an update is available.\n- `\"onlyDownload\"`: Check and download automatically, emit `updateAvailable`, and never set the next bundle or apply an update automatically.\n\nOnly available for Android and iOS.",
+          "docs": "Configure how the plugin checks for, downloads, and applies live updates.\n\nThe plugin checks for updates when the app moves to the foreground. When\n{@link periodCheckDelay} is greater than 0, it also checks on a repeating timer\nwhile the app stays open.\n\nBoolean values keep their existing behavior:\n- `true`: Same as `\"atBackground\"`.\n- `false`: Same as `\"off\"`.\n\nString values merge the previous Auto Update and Direct Update configuration:\n- `\"off\"`: Disable automatic update checks.\n- `\"atBackground\"`: Check and download automatically on each foreground check, then apply the update the next time the app moves to background.\n- `\"atInstall\"`: Apply immediately only after a fresh install or native app store update; otherwise use `\"atBackground\"` behavior.\n- `\"onLaunch\"`: Apply immediately only when the app is brought to the foreground from a killed state (cold start). After that first check, fall back to `\"atBackground\"` behavior.\n- `\"always\"`: Check on every foreground transition and apply immediately whenever an update is available.\n- `\"onlyDownload\"`: Check and download automatically, emit `updateAvailable`, and never set the next bundle or apply an update automatically.\n\nInstant apply modes (`\"atInstall\"`, `\"onLaunch\"`, `\"always\"`) apply while the user is waiting.\nUpload with `npx @capgo/cli@latest bundle upload --delta` so only changed files download. A full zip upload slows the user experience.\nThese modes require `autoSplashscreen: true` and `@capacitor/splash-screen` installed with `launchAutoHide: false`.\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "boolean | 'always' | 'off' | 'atBackground' | 'atInstall' | 'onLaunch' | 'onlyDownload' | undefined"
         },
@@ -4735,7 +4735,7 @@
           "name": "directUpdate",
           "tags": [
             {
-              "text": "Use {@link PluginsConfig.CapacitorUpdater.autoUpdate} string modes instead.\nWorks well for apps less than 10MB and with uploads done using --delta flag.\nZip or apps more than 10MB will be relatively slow for users to update.\n- false: Never do direct updates\n- atInstall: Same as `\"atInstall\"` for {@link autoUpdate}\n- onLaunch: Same as `\"onLaunch\"` for {@link autoUpdate}\n- always: Same as `\"always\"` for {@link autoUpdate}\n- true: (deprecated) Same as \"always\" for backward compatibility\n\nActivate this flag will automatically make the CLI upload delta in CICD envs and will ask for confirmation in local uploads.\nOnly available for Android and iOS.",
+              "text": "Use {@link PluginsConfig.CapacitorUpdater.autoUpdate} string modes instead.\n\nOnly available for Android and iOS.",
               "name": "deprecated"
             },
             {
@@ -4747,7 +4747,7 @@
               "name": "since"
             }
           ],
-          "docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.",
+          "docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.\nInstant apply (`atInstall`, `onLaunch`, `always`) should be uploaded with `--delta` so the update does not slow the user experience. A full zip, especially over 10MB, is relatively slow for users.\nThese modes require `autoSplashscreen: true` and `@capacitor/splash-screen` installed with `launchAutoHide: false`.\nThis flag makes the CLI upload delta in CI and ask for confirmation in local uploads.\n- false: Never do direct updates\n- atInstall: Same as `\"atInstall\"` for {@link autoUpdate}\n- onLaunch: Same as `\"onLaunch\"` for {@link autoUpdate}\n- always: Same as `\"always\"` for {@link autoUpdate}\n- true: (deprecated) Same as \"always\" for backward compatibility",
           "complexTypes": [],
           "type": "boolean | 'always' | 'atInstall' | 'onLaunch' | undefined"
         },
@@ -4763,7 +4763,7 @@
               "name": "since"
             }
           ],
-          "docs": "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.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\nOnly works when autoUpdate is set to \"atInstall\", \"always\", or \"onLaunch\", or when the deprecated directUpdate option is set to \"atInstall\", \"always\", \"onLaunch\", or true.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\nRequires Auto Update and Direct Update behavior to be enabled.\n\nOnly available for Android and iOS.",
+          "docs": "Automatically hide the splashscreen after instant apply updates finish, or when no update is needed.\nRequired when using instant apply modes (`\"atInstall\"`, `\"onLaunch\"`, `\"always\"`), including the deprecated `directUpdate` values `\"atInstall\"`, `\"onLaunch\"`, `\"always\"`, and `true`.\n`@capacitor/splash-screen` must be installed and configured with `launchAutoHide: false`.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },

package/dist/esm/definitions.d.ts

@@ -63,6 +63,10 @@ declare module '@capacitor/cli' {
              * - `"always"`: Check on every foreground transition and apply immediately whenever an update is available.
              * - `"onlyDownload"`: Check and download automatically, emit `updateAvailable`, and never set the next bundle or apply an update automatically.
              *
+             * Instant apply modes (`"atInstall"`, `"onLaunch"`, `"always"`) apply while the user is waiting.
+             * Upload with `npx @capgo/cli@latest bundle upload --delta` so only changed files download. A full zip upload slows the user experience.
+             * These modes require `autoSplashscreen: true` and `@capacitor/splash-screen` installed with `launchAutoHide: false`.
+             *
              * Only available for Android and iOS.
              *
              * @default true
@@ -131,17 +135,17 @@ declare module '@capacitor/cli' {
             version?: string;
             /**
              * Configure when the plugin should direct install updates. Only for autoUpdate mode.
-             *
-             * @deprecated Use {@link PluginsConfig.CapacitorUpdater.autoUpdate} string modes instead.
-             * Works well for apps less than 10MB and with uploads done using --delta flag.
-             * Zip or apps more than 10MB will be relatively slow for users to update.
+             * Instant apply (`atInstall`, `onLaunch`, `always`) should be uploaded with `--delta` so the update does not slow the user experience. A full zip, especially over 10MB, is relatively slow for users.
+             * These modes require `autoSplashscreen: true` and `@capacitor/splash-screen` installed with `launchAutoHide: false`.
+             * This flag makes the CLI upload delta in CI and ask for confirmation in local uploads.
              * - false: Never do direct updates
              * - atInstall: Same as `"atInstall"` for {@link autoUpdate}
              * - onLaunch: Same as `"onLaunch"` for {@link autoUpdate}
              * - always: Same as `"always"` for {@link autoUpdate}
              * - true: (deprecated) Same as "always" for backward compatibility
              *
-             * Activate this flag will automatically make the CLI upload delta in CICD envs and will ask for confirmation in local uploads.
+             * @deprecated Use {@link PluginsConfig.CapacitorUpdater.autoUpdate} string modes instead.
+             *
              * Only available for Android and iOS.
              *
              * @default false
@@ -149,11 +153,10 @@ declare module '@capacitor/cli' {
              */
             directUpdate?: boolean | 'atInstall' | 'always' | 'onLaunch';
             /**
-             * 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.
+             * Automatically hide the splashscreen after instant apply updates finish, or when no update is needed.
+             * Required when using instant apply modes (`"atInstall"`, `"onLaunch"`, `"always"`), including the deprecated `directUpdate` values `"atInstall"`, `"onLaunch"`, `"always"`, and `true`.
+             * `@capacitor/splash-screen` must be installed and configured with `launchAutoHide: false`.
              * This removes the need to manually listen for appReady events and call SplashScreen.hide().
-             * Only works when autoUpdate is set to "atInstall", "always", or "onLaunch", or when the deprecated directUpdate option is set to "atInstall", "always", "onLaunch", or true.
-             * Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.
-             * Requires Auto Update and Direct Update behavior to be enabled.
              *
              * Only available for Android and iOS.
              *