@capgo/capacitor-updater 8.47.6 → 8.47.8

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

@@ -26,6 +26,10 @@ import org.json.JSONArray;
 
 public class ShakeMenu implements ShakeDetector.Listener {
 
+    private interface PreviewMenuAction {
+        boolean run();
+    }
+
     private CapacitorUpdaterPlugin plugin;
     private BridgeActivity activity;
     private ShakeDetector shakeDetector;
@@ -52,9 +56,14 @@ public class ShakeMenu implements ShakeDetector.Listener {
     public void onShakeDetected() {
         logger.info("Shake detected");
 
-        // Check if shake menu is enabled
-        if (!plugin.shakeMenuEnabled) {
-            logger.info("Shake menu is disabled");
+        boolean canShowPreviewMenu = Boolean.TRUE.equals(plugin.shakeMenuEnabled) && plugin.hasActivePreviewSession();
+        boolean canShowChannelSelector = Boolean.TRUE.equals(plugin.shakeChannelSelectorEnabled);
+        if (!canShowPreviewMenu && !canShowChannelSelector) {
+            if (Boolean.TRUE.equals(plugin.shakeMenuEnabled)) {
+                logger.info("Shake preview menu ignored because no preview session is active");
+            } else {
+                logger.info("Shake menu is disabled");
+            }
             return;
         }
 
@@ -66,12 +75,10 @@ public class ShakeMenu implements ShakeDetector.Listener {
 
         isShowing = true;
 
-        if (plugin.hasActivePreviewSession()) {
+        if (canShowPreviewMenu) {
             showDefaultMenu();
-        } else if (plugin.shakeChannelSelectorEnabled) {
-            showChannelSelector();
         } else {
-            showDefaultMenu();
+            showChannelSelector();
         }
     }
 
@@ -79,7 +86,12 @@ public class ShakeMenu implements ShakeDetector.Listener {
         activity.runOnUiThread(() -> {
             try {
                 if (!plugin.hasActivePreviewSession()) {
-                    showConfiguredDefaultMenu();
+                    logger.info("Shake preview menu ignored because no preview session is active");
+                    isShowing = false;
+                    return;
+                }
+                if (Boolean.TRUE.equals(plugin.shakeChannelSelectorEnabled)) {
+                    showCombinedPreviewMenu();
                     return;
                 }
                 String appName = activity.getPackageManager().getApplicationLabel(activity.getApplicationInfo()).toString();
@@ -113,40 +125,16 @@ public class ShakeMenu implements ShakeDetector.Listener {
                 dialog.show();
                 dialog.getButton(AlertDialog.BUTTON_POSITIVE).setOnClickListener((view) -> {
                     setPreviewMenuButtonsEnabled(dialog, false);
-                    new Thread(() -> {
-                        try {
-                            if (!plugin.leavePreviewSessionFromShakeMenu()) {
-                                activity.runOnUiThread(() -> showError("Could not leave the test app."));
-                            }
-                        } catch (Exception e) {
-                            logger.error("Error leaving test app: " + e.getMessage());
-                            activity.runOnUiThread(() -> showError("Error leaving test app: " + e.getMessage()));
-                        } finally {
-                            activity.runOnUiThread(() -> {
-                                dialog.dismiss();
-                                isShowing = false;
-                            });
-                        }
-                    }).start();
+                    runPreviewMenuAction(dialog, "Could not leave the test app.", "Error leaving test app: ", () ->
+                        plugin.leavePreviewSessionFromShakeMenu()
+                    );
                 });
                 dialog.getButton(AlertDialog.BUTTON_NEUTRAL).setOnClickListener((view) -> {
                     setPreviewMenuButtonsEnabled(dialog, false);
-                    new Thread(() -> {
-                        try {
-                            logger.info("Reloading webview");
-                            if (!plugin.reloadPreviewSessionFromShakeMenu()) {
-                                activity.runOnUiThread(() -> showError("Could not reload the test app."));
-                            }
-                        } catch (Exception e) {
-                            logger.error("Error in Reload action: " + e.getMessage());
-                            activity.runOnUiThread(() -> showError("Error reloading test app: " + e.getMessage()));
-                        } finally {
-                            activity.runOnUiThread(() -> {
-                                dialog.dismiss();
-                                isShowing = false;
-                            });
-                        }
-                    }).start();
+                    logger.info("Reloading webview");
+                    runPreviewMenuAction(dialog, "Could not reload the test app.", "Error reloading test app: ", () ->
+                        plugin.reloadPreviewSessionFromShakeMenu()
+                    );
                 });
             } catch (Exception e) {
                 logger.error("Error showing shake menu: " + e.getMessage());
@@ -155,6 +143,74 @@ public class ShakeMenu implements ShakeDetector.Listener {
         });
     }
 
+    private void showCombinedPreviewMenu() {
+        try {
+            String appName = activity.getPackageManager().getApplicationLabel(activity.getApplicationInfo()).toString();
+            String title = "Preview " + appName + " Menu";
+            String message = "Reload or leave the current preview, or switch update channel.";
+            String[] actions = { "Reload preview", "Leave test app", "Switch channel" };
+            final boolean[] openingChannelSelector = { false };
+            final boolean[] previewActionRunning = { false };
+
+            AlertDialog.Builder builder = new AlertDialog.Builder(activity);
+            builder.setTitle(title);
+            builder.setMessage(message);
+            builder.setItems(actions, (dialogInterface, which) -> {
+                AlertDialog dialog = (AlertDialog) dialogInterface;
+                if (which == 0) {
+                    previewActionRunning[0] = true;
+                    logger.info("Reloading webview");
+                    runPreviewMenuAction(dialog, "Could not reload the test app.", "Error reloading test app: ", () ->
+                        plugin.reloadPreviewSessionFromShakeMenu()
+                    );
+                } else if (which == 1) {
+                    previewActionRunning[0] = true;
+                    runPreviewMenuAction(dialog, "Could not leave the test app.", "Error leaving test app: ", () ->
+                        plugin.leavePreviewSessionFromShakeMenu()
+                    );
+                } else {
+                    openingChannelSelector[0] = true;
+                    dialog.dismiss();
+                    showChannelSelector();
+                }
+            });
+            builder.setNegativeButton("Close menu", (dialog, id) -> {
+                logger.info("Shake menu cancelled");
+                dialog.dismiss();
+                isShowing = false;
+            });
+
+            AlertDialog dialog = builder.create();
+            dialog.setOnDismissListener((dialogInterface) -> {
+                if (!openingChannelSelector[0] && !previewActionRunning[0]) {
+                    isShowing = false;
+                }
+            });
+            dialog.show();
+        } catch (Exception e) {
+            logger.error("Error showing combined shake menu: " + e.getMessage());
+            isShowing = false;
+        }
+    }
+
+    private void runPreviewMenuAction(AlertDialog dialog, String failureMessage, String errorPrefix, PreviewMenuAction action) {
+        new Thread(() -> {
+            try {
+                if (!action.run()) {
+                    activity.runOnUiThread(() -> showError(failureMessage));
+                }
+            } catch (Exception e) {
+                logger.error(errorPrefix + e.getMessage());
+                activity.runOnUiThread(() -> showError(errorPrefix + e.getMessage()));
+            } finally {
+                activity.runOnUiThread(() -> {
+                    dialog.dismiss();
+                    isShowing = false;
+                });
+            }
+        }).start();
+    }
+
     private void setPreviewMenuButtonsEnabled(AlertDialog dialog, boolean enabled) {
         dialog.getButton(AlertDialog.BUTTON_POSITIVE).setEnabled(enabled);
         dialog.getButton(AlertDialog.BUTTON_NEUTRAL).setEnabled(enabled);

package/dist/docs.json

@@ -1431,7 +1431,7 @@
             "text": "7.5.0"
           }
         ],
-        "docs": "Enable or disable the shake gesture menu for debugging and testing.\n\nWhen enabled, users can shake their device to open a debug menu that shows:\n- Current bundle information\n- Available bundles\n- Options to switch bundles manually\n- Update status\n\nThis is useful during development and testing to:\n- Quickly test different bundle versions\n- Debug update flows\n- Switch between production and test bundles\n- Verify bundle installations\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 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}.",
         "complexTypes": [
           "SetShakeMenuOptions"
         ],
@@ -1495,7 +1495,7 @@
             "text": "8.43.0"
           }
         ],
-        "docs": "Enable or disable the shake channel selector at runtime.\n\nWhen enabled AND shakeMenu is true, shaking the device shows a channel\nselector instead of the debug menu. This allows users to switch between\nupdate channels by shaking their device.\n\nAfter selecting a channel, the app automatically checks for updates\nand downloads if available.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.",
+        "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}.",
         "complexTypes": [
           "SetShakeChannelSelectorOptions"
         ],
@@ -2868,7 +2868,7 @@
           ],
           "docs": "The channel ID",
           "complexTypes": [],
-          "type": "string"
+          "type": "number"
         },
         {
           "name": "name",
@@ -4573,7 +4573,7 @@
               "name": "since"
             }
           ],
-          "docs": "Enable shake gesture to show update menu for debugging/testing purposes",
+          "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.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -4589,7 +4589,7 @@
               "name": "since"
             }
           ],
-          "docs": "Enable the shake gesture to show a channel selector menu for switching between update channels.\nWhen enabled AND `shakeMenu` is true, the shake gesture shows a channel selector\ninstead of the default debug menu (Go Home/Reload/Close).\n\nAfter selecting a channel, the app automatically checks for updates and downloads if available.\nOnly works if channels have `allow_self_set` enabled on the backend.\n\nOnly available for Android and iOS.",
+          "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.",
           "complexTypes": [],
           "type": "boolean | undefined"
         }

package/dist/esm/definitions.d.ts

@@ -352,7 +352,9 @@ declare module '@capacitor/cli' {
              */
             osLogging?: boolean;
             /**
-             * Enable shake gesture to show update menu for debugging/testing purposes
+             * Enable the shake gesture while a preview session is active.
+             * Outside preview sessions this preview menu is ignored, unless
+             * {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.
              *
              * @default false
              * @since  7.5.0
@@ -360,11 +362,8 @@ declare module '@capacitor/cli' {
             shakeMenu?: boolean;
             /**
              * Enable the shake gesture to show a channel selector menu for switching between update channels.
-             * When enabled AND `shakeMenu` is true, the shake gesture shows a channel selector
-             * instead of the default debug menu (Go Home/Reload/Close).
-             *
-             * After selecting a channel, the app automatically checks for updates and downloads if available.
-             * Only works if channels have `allow_self_set` enabled on the backend.
+             * If {@link PluginsConfig.CapacitorUpdater.shakeMenu} is also enabled while a preview session is active,
+             * the shake menu includes both preview actions and channel switching.
              *
              * Only available for Android and iOS.
              *
@@ -1257,19 +1256,15 @@ export interface CapacitorUpdaterPlugin {
      */
     getFailedUpdate(): Promise<UpdateFailedEvent | null>;
     /**
-     * Enable or disable the shake gesture menu for debugging and testing.
+     * Enable or disable the shake gesture menu.
      *
-     * When enabled, users can shake their device to open a debug menu that shows:
-     * - Current bundle information
-     * - Available bundles
-     * - Options to switch bundles manually
-     * - Update status
+     * During preview sessions, users can shake their device 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
      *
-     * This is useful during development and testing to:
-     * - Quickly test different bundle versions
-     * - Debug update flows
-     * - Switch between production and test bundles
-     * - Verify bundle installations
+     * Outside preview sessions, this preview menu is ignored. The channel selector can still be
+     * shown outside preview sessions when {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector} is enabled.
      *
      * **Important:** Disable this in production builds or only enable for internal testers.
      *
@@ -1300,12 +1295,9 @@ export interface CapacitorUpdaterPlugin {
     /**
      * Enable or disable the shake channel selector at runtime.
      *
-     * When enabled AND shakeMenu is true, shaking the device shows a channel
-     * selector instead of the debug menu. This allows users to switch between
-     * update channels by shaking their device.
-     *
-     * After selecting a channel, the app automatically checks for updates
-     * and downloads if available.
+     * When enabled, shaking the device 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}.
      *
@@ -1587,7 +1579,7 @@ export interface ChannelInfo {
      *
      * @since 7.5.0
      */
-    id: string;
+    id: number;
     /**
      * The channel name
      *