@capgo/capacitor-updater 8.47.9 → 8.47.11

package/dist/docs.json

@@ -1431,7 +1431,7 @@
             "text": "7.5.0"
           }
         ],
-        "docs": "Enable or disable the shake gesture menu.\n\nDuring preview sessions, users can shake their device to:\n- Reload the current preview\n- Leave the test app and return to the fallback bundle\n- Switch update channel, when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is also enabled\n\nOutside preview sessions, this preview menu is ignored. The channel selector can still be\nshown outside preview sessions when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.\n\n**Important:** Disable this in production builds or only enable for internal testers.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.",
+        "docs": "Enable or disable the native preview menu gesture.\n\nDuring preview sessions, users can use the configured native gesture to:\n- Reload the current preview\n- Leave the test app and return to the fallback bundle\n- Switch update channel, when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is also enabled\n\nOutside preview sessions, this preview menu is ignored. The channel selector can still be\nshown outside preview sessions when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.\n\n**Important:** Disable this in production builds or only enable for internal testers.\n\nThis can also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.\nThe native gesture can be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}\nor `options.gesture`.",
         "complexTypes": [
           "SetShakeMenuOptions"
         ],
@@ -1445,7 +1445,7 @@
         "tags": [
           {
             "name": "returns",
-            "text": "Object with `enabled: true` or `enabled: false`."
+            "text": "Object with the current enabled state and gesture."
           },
           {
             "name": "throws",
@@ -1456,7 +1456,7 @@
             "text": "7.5.0"
           }
         ],
-        "docs": "Check if the shake gesture debug menu is currently enabled.\n\nReturns the current state of the shake menu feature that can be toggled via\n{@link setShakeMenu} or configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.\n\nUse this to:\n- Check if debug features are enabled\n- Show/hide debug settings UI\n- Verify configuration during testing",
+        "docs": "Check if the native preview menu gesture is currently enabled.\n\nReturns the current state of the shake menu feature that can be toggled via\n{@link setShakeMenu} or configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.\n\nUse this to:\n- Check if debug features are enabled\n- Show/hide debug settings UI\n- Verify configuration during testing",
         "complexTypes": [
           "ShakeMenuEnabled"
         ],
@@ -1495,7 +1495,7 @@
             "text": "8.43.0"
           }
         ],
-        "docs": "Enable or disable the shake channel selector at runtime.\n\nWhen enabled, shaking the device can show a channel selector, including outside preview sessions.\nIf {@link setShakeMenu} is also enabled while a preview session is active, the shake menu includes\nboth preview actions and channel switching.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.",
+        "docs": "Enable or disable the channel selector menu gesture at runtime.\n\nWhen enabled, the configured native gesture can show a channel selector, including outside preview sessions.\nIf {@link setShakeMenu} is also enabled while a preview session is active, the shake menu includes\nboth preview actions and channel switching.\n\nThis can also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.\nThe native gesture can be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}\nor {@link setShakeMenu}.",
         "complexTypes": [
           "SetShakeChannelSelectorOptions"
         ],
@@ -3442,6 +3442,20 @@
           "docs": "",
           "complexTypes": [],
           "type": "boolean"
+        },
+        {
+          "name": "gesture",
+          "tags": [
+            {
+              "text": "'shake'",
+              "name": "default"
+            }
+          ],
+          "docs": "Native gesture used to open the preview/channel menu.",
+          "complexTypes": [
+            "ShakeMenuGesture"
+          ],
+          "type": "ShakeMenuGesture"
         }
       ]
     },
@@ -3458,6 +3472,20 @@
           "docs": "",
           "complexTypes": [],
           "type": "boolean"
+        },
+        {
+          "name": "gesture",
+          "tags": [
+            {
+              "text": "8.48.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The currently configured native gesture used to open the preview/channel menu.\nUndefined means consumers should treat the gesture as the default `shake` behavior.",
+          "complexTypes": [
+            "ShakeMenuGesture"
+          ],
+          "type": "ShakeMenuGesture"
         }
       ]
     },
@@ -3986,6 +4014,21 @@
           ]
         }
       ]
+    },
+    {
+      "name": "ShakeMenuGesture",
+      "slug": "shakemenugesture",
+      "docs": "Native gesture options that open the shake menu.\n\nSupported values are `shake` and `threeFingerPinch`.",
+      "types": [
+        {
+          "text": "'shake'",
+          "complexTypes": []
+        },
+        {
+          "text": "'threeFingerPinch'",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": [
@@ -4573,10 +4616,28 @@
               "name": "since"
             }
           ],
-          "docs": "Enable the shake gesture while a preview session is active.\nOutside preview sessions this preview menu is ignored, unless\n{@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.",
+          "docs": "Enable the native preview menu gesture while a preview session is active.\nOutside preview sessions this preview menu is ignored, unless\n{@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "shakeMenuGesture",
+          "tags": [
+            {
+              "text": "'shake'",
+              "name": "default"
+            },
+            {
+              "text": "8.48.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Choose which native gesture opens the preview/channel menu.\nThis applies to both {@link PluginsConfig.CapacitorUpdater.shakeMenu}\nand {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.\n\nOnly available for Android and iOS.",
+          "complexTypes": [
+            "ShakeMenuGesture"
+          ],
+          "type": "ShakeMenuGesture"
+        },
         {
           "name": "allowShakeChannelSelector",
           "tags": [
@@ -4589,7 +4650,7 @@
               "name": "since"
             }
           ],
-          "docs": "Enable the shake gesture to show a channel selector menu for switching between update channels.\nIf {@link PluginsConfig.CapacitorUpdater.shakeMenu} is also enabled while a preview session is active,\nthe shake menu includes both preview actions and channel switching.\n\nOnly available for Android and iOS.",
+          "docs": "Enable the native menu gesture to show a channel selector menu for switching between update channels.\nIf {@link PluginsConfig.CapacitorUpdater.shakeMenu} is also enabled while a preview session is active,\nthe shake menu includes both preview actions and channel switching.\nThe native gesture can be changed with {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}.\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "boolean | undefined"
         }

package/dist/esm/definitions.d.ts

@@ -352,7 +352,7 @@ declare module '@capacitor/cli' {
              */
             osLogging?: boolean;
             /**
-             * Enable the shake gesture while a preview session is active.
+             * Enable the native preview menu gesture while a preview session is active.
              * Outside preview sessions this preview menu is ignored, unless
              * {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.
              *
@@ -361,9 +361,21 @@ declare module '@capacitor/cli' {
              */
             shakeMenu?: boolean;
             /**
-             * Enable the shake gesture to show a channel selector menu for switching between update channels.
+             * Choose which native gesture opens the preview/channel menu.
+             * This applies to both {@link PluginsConfig.CapacitorUpdater.shakeMenu}
+             * and {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default 'shake'
+             * @since  8.48.0
+             */
+            shakeMenuGesture?: ShakeMenuGesture;
+            /**
+             * Enable the native menu gesture to show a channel selector menu for switching between update channels.
              * If {@link PluginsConfig.CapacitorUpdater.shakeMenu} is also enabled while a preview session is active,
              * the shake menu includes both preview actions and channel switching.
+             * The native gesture can be changed with {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}.
              *
              * Only available for Android and iOS.
              *
@@ -1264,9 +1276,9 @@ export interface CapacitorUpdaterPlugin {
      */
     getFailedUpdate(): Promise<UpdateFailedEvent | null>;
     /**
-     * Enable or disable the shake gesture menu.
+     * Enable or disable the native preview menu gesture.
      *
-     * During preview sessions, users can shake their device to:
+     * During preview sessions, users can use the configured native gesture to:
      * - Reload the current preview
      * - Leave the test app and return to the fallback bundle
      * - Switch update channel, when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is also enabled
@@ -1276,7 +1288,9 @@ export interface CapacitorUpdaterPlugin {
      *
      * **Important:** Disable this in production builds or only enable for internal testers.
      *
-     * Can also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.
+     * This can also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.
+     * The native gesture can be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}
+     * or `options.gesture`.
      *
      * @param options {@link SetShakeMenuOptions} with `enabled: true` to enable or `enabled: false` to disable.
      * @returns {Promise<void>} Resolves when the setting is applied.
@@ -1285,7 +1299,7 @@ export interface CapacitorUpdaterPlugin {
      */
     setShakeMenu(options: SetShakeMenuOptions): Promise<void>;
     /**
-     * Check if the shake gesture debug menu is currently enabled.
+     * Check if the native preview menu gesture is currently enabled.
      *
      * Returns the current state of the shake menu feature that can be toggled via
      * {@link setShakeMenu} or configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.
@@ -1295,19 +1309,21 @@ export interface CapacitorUpdaterPlugin {
      * - Show/hide debug settings UI
      * - Verify configuration during testing
      *
-     * @returns {Promise<ShakeMenuEnabled>} Object with `enabled: true` or `enabled: false`.
+     * @returns {Promise<ShakeMenuEnabled>} Object with the current enabled state and gesture.
      * @throws {Error} If the operation fails.
      * @since 7.5.0
      */
     isShakeMenuEnabled(): Promise<ShakeMenuEnabled>;
     /**
-     * Enable or disable the shake channel selector at runtime.
+     * Enable or disable the channel selector menu gesture at runtime.
      *
-     * When enabled, shaking the device can show a channel selector, including outside preview sessions.
+     * When enabled, the configured native gesture can show a channel selector, including outside preview sessions.
      * If {@link setShakeMenu} is also enabled while a preview session is active, the shake menu includes
      * both preview actions and channel switching.
      *
-     * Can also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.
+     * This can also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.
+     * The native gesture can be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenuGesture}
+     * or {@link setShakeMenu}.
      *
      * @param options {@link SetShakeChannelSelectorOptions} with `enabled: true` to enable or `enabled: false` to disable.
      * @returns {Promise<void>} Resolves when the setting is applied.
@@ -2100,11 +2116,32 @@ export interface TriggerUpdateCheckResult {
      */
     queued: boolean;
 }
+/**
+ * Native gesture options that open the shake menu.
+ *
+ * Supported values are `shake` and `threeFingerPinch`.
+ *
+ * @public
+ */
+export type ShakeMenuGesture = 'shake' | 'threeFingerPinch';
 export interface SetShakeMenuOptions {
     enabled: boolean;
+    /**
+     * Native gesture used to open the preview/channel menu.
+     *
+     * @default 'shake'
+     */
+    gesture?: ShakeMenuGesture;
 }
 export interface ShakeMenuEnabled {
     enabled: boolean;
+    /**
+     * The currently configured native gesture used to open the preview/channel menu.
+     * Undefined means consumers should treat the gesture as the default `shake` behavior.
+     *
+     * @since 8.48.0
+     */
+    gesture?: ShakeMenuGesture;
 }
 export interface SetShakeChannelSelectorOptions {
     enabled: boolean;