@capgo/capacitor-updater 7.3.3 → 7.5.1

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

@@ -0,0 +1,169 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+package ee.forgr.capacitor_updater;
+
+import android.app.Activity;
+import android.app.AlertDialog;
+import android.content.DialogInterface;
+import android.hardware.SensorManager;
+import com.getcapacitor.Bridge;
+import com.getcapacitor.BridgeActivity;
+
+public class ShakeMenu implements ShakeDetector.Listener {
+
+    private CapacitorUpdaterPlugin plugin;
+    private BridgeActivity activity;
+    private ShakeDetector shakeDetector;
+    private boolean isShowing = false;
+    private Logger logger;
+
+    public ShakeMenu(CapacitorUpdaterPlugin plugin, BridgeActivity activity, Logger logger) {
+        this.plugin = plugin;
+        this.activity = activity;
+        this.logger = logger;
+
+        SensorManager sensorManager = (SensorManager) activity.getSystemService(Activity.SENSOR_SERVICE);
+        this.shakeDetector = new ShakeDetector(this);
+        this.shakeDetector.start(sensorManager);
+    }
+
+    public void stop() {
+        if (shakeDetector != null) {
+            shakeDetector.stop();
+        }
+    }
+
+    @Override
+    public void onShakeDetected() {
+        logger.info("Shake detected");
+
+        // Check if shake menu is enabled
+        if (!plugin.shakeMenuEnabled) {
+            logger.info("Shake menu is disabled");
+            return;
+        }
+
+        // Prevent multiple dialogs
+        if (isShowing) {
+            logger.info("Dialog already showing");
+            return;
+        }
+
+        isShowing = true;
+        showShakeMenu();
+    }
+
+    private void showShakeMenu() {
+        activity.runOnUiThread(() -> {
+            try {
+                String appName = activity.getPackageManager().getApplicationLabel(activity.getApplicationInfo()).toString();
+                String title = "Preview " + appName + " Menu";
+                String message = "What would you like to do?";
+                String okButtonTitle = "Go Home";
+                String reloadButtonTitle = "Reload app";
+                String cancelButtonTitle = "Close menu";
+
+                CapgoUpdater updater = plugin.implementation;
+                Bridge bridge = activity.getBridge();
+
+                AlertDialog.Builder builder = new AlertDialog.Builder(activity);
+                builder.setTitle(title);
+                builder.setMessage(message);
+
+                // Go Home button
+                builder.setPositiveButton(
+                    okButtonTitle,
+                    new DialogInterface.OnClickListener() {
+                        public void onClick(DialogInterface dialog, int id) {
+                            try {
+                                BundleInfo current = updater.getCurrentBundle();
+                                logger.info("Current bundle: " + current.toString());
+
+                                BundleInfo next = updater.getNextBundle();
+                                logger.info("Next bundle: " + (next != null ? next.toString() : "null"));
+
+                                if (next != null && !next.isBuiltin()) {
+                                    logger.info("Setting bundle to: " + next.toString());
+                                    updater.set(next);
+                                    String path = updater.getCurrentBundlePath();
+                                    logger.info("Setting server path: " + path);
+                                    if (updater.isUsingBuiltin()) {
+                                        bridge.setServerAssetPath(path);
+                                    } else {
+                                        bridge.setServerBasePath(path);
+                                    }
+                                } else {
+                                    logger.info("Resetting to builtin");
+                                    updater.reset();
+                                    String path = updater.getCurrentBundlePath();
+                                    bridge.setServerAssetPath(path);
+                                }
+
+                                // Try to delete the current bundle
+                                try {
+                                    updater.delete(current.getId());
+                                } catch (Exception err) {
+                                    logger.warn("Cannot delete version " + current.getId() + ": " + err.getMessage());
+                                }
+
+                                logger.info("Reload app done");
+                            } catch (Exception e) {
+                                logger.error("Error in Go Home action: " + e.getMessage());
+                            } finally {
+                                dialog.dismiss();
+                                isShowing = false;
+                            }
+                        }
+                    }
+                );
+
+                // Reload button
+                builder.setNeutralButton(
+                    reloadButtonTitle,
+                    new DialogInterface.OnClickListener() {
+                        public void onClick(DialogInterface dialog, int id) {
+                            try {
+                                logger.info("Reloading webview");
+                                String pathHot = updater.getCurrentBundlePath();
+                                bridge.setServerBasePath(pathHot);
+                                activity.runOnUiThread(() -> {
+                                    if (bridge.getWebView() != null) {
+                                        bridge.getWebView().reload();
+                                    }
+                                });
+                            } catch (Exception e) {
+                                logger.error("Error in Reload action: " + e.getMessage());
+                            } finally {
+                                dialog.dismiss();
+                                isShowing = false;
+                            }
+                        }
+                    }
+                );
+
+                // Cancel button
+                builder.setNegativeButton(
+                    cancelButtonTitle,
+                    new DialogInterface.OnClickListener() {
+                        public void onClick(DialogInterface dialog, int id) {
+                            logger.info("Shake menu cancelled");
+                            dialog.dismiss();
+                            isShowing = false;
+                        }
+                    }
+                );
+
+                AlertDialog dialog = builder.create();
+                dialog.setOnDismissListener(dialogInterface -> isShowing = false);
+                dialog.show();
+            } catch (Exception e) {
+                logger.error("Error showing shake menu: " + e.getMessage());
+                isShowing = false;
+            }
+        });
+    }
+}

package/dist/docs.json

@@ -547,6 +547,31 @@
         ],
         "slug": "getchannel"
       },
+      {
+        "name": "listChannels",
+        "signature": "() => Promise<ListChannelsResult>",
+        "parameters": [],
+        "returns": "Promise<ListChannelsResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A Promise that resolves with the available channels"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "List all channels available for this device that allow self-assignment",
+        "complexTypes": [
+          "ListChannelsResult"
+        ],
+        "slug": "listchannels"
+      },
       {
         "name": "setCustomId",
         "signature": "(options: SetCustomIdOptions) => Promise<void>",
@@ -986,6 +1011,65 @@
           "BundleInfo"
         ],
         "slug": "getnextbundle"
+      },
+      {
+        "name": "setShakeMenu",
+        "signature": "(options: SetShakeMenuOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Contains enabled boolean to enable or disable shake menu",
+            "type": "SetShakeMenuOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Contains enabled boolean to enable or disable shake menu"
+          },
+          {
+            "name": "returns"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "Enable or disable the shake menu for debugging/testing purposes",
+        "complexTypes": [
+          "SetShakeMenuOptions"
+        ],
+        "slug": "setshakemenu"
+      },
+      {
+        "name": "isShakeMenuEnabled",
+        "signature": "() => Promise<ShakeMenuEnabled>",
+        "parameters": [],
+        "returns": "Promise<ShakeMenuEnabled>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The current state of shake menu"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "Get the current state of the shake menu",
+        "complexTypes": [
+          "ShakeMenuEnabled"
+        ],
+        "slug": "isshakemenuenabled"
       }
     ],
     "properties": []
@@ -1155,6 +1239,54 @@
           "docs": "The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "manifest",
+          "tags": [
+            {
+              "text": "6.1.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "The manifest for multi-file downloads",
+          "complexTypes": [
+            "ManifestEntry"
+          ],
+          "type": "ManifestEntry[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ManifestEntry",
+      "slug": "manifestentry",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "file_name",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "file_hash",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "download_url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
         }
       ]
     },
@@ -1399,36 +1531,6 @@
         }
       ]
     },
-    {
-      "name": "ManifestEntry",
-      "slug": "manifestentry",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "file_name",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        },
-        {
-          "name": "file_hash",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        },
-        {
-          "name": "download_url",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        }
-      ]
-    },
     {
       "name": "GetLatestOptions",
       "slug": "getlatestoptions",
@@ -1577,6 +1679,86 @@
         }
       ]
     },
+    {
+      "name": "ListChannelsResult",
+      "slug": "listchannelsresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channels",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "List of available channels",
+          "complexTypes": [
+            "ChannelInfo"
+          ],
+          "type": "ChannelInfo[]"
+        }
+      ]
+    },
+    {
+      "name": "ChannelInfo",
+      "slug": "channelinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The channel ID",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The channel name",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "public",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether this is a public channel",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "allow_self_set",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether devices can self-assign to this channel",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "SetCustomIdOptions",
       "slug": "setcustomidoptions",
@@ -1882,6 +2064,38 @@
           "type": "boolean"
         }
       ]
+    },
+    {
+      "name": "SetShakeMenuOptions",
+      "slug": "setshakemenuoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ShakeMenuEnabled",
+      "slug": "shakemenuenabled",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -2333,6 +2547,22 @@
           "docs": "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",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "shakeMenu",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enable shake gesture to show update menu for debugging/testing purposes",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ],
       "docs": "CapacitorUpdater can be configured with these options:"

package/dist/esm/definitions.d.ts

@@ -218,6 +218,13 @@ declare module '@capacitor/cli' {
              * @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;
         };
     }
 }
@@ -391,6 +398,14 @@ 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
      *
@@ -505,6 +520,23 @@ export interface CapacitorUpdaterPlugin {
      * @since 6.8.0
      */
     getNextBundle(): Promise<BundleInfo | 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>;
 }
 /**
  * pending: The bundle is pending to be **SET** as the next bundle.
@@ -552,6 +584,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.
@@ -700,6 +766,12 @@ export interface DownloadOptions {
      * @default undefined
      */
     checksum?: string;
+    /**
+     * The manifest for multi-file downloads
+     * @since 6.1.0
+     * @default undefined
+     */
+    manifest?: ManifestEntry[];
 }
 export interface BundleId {
     id: string;
@@ -740,3 +812,9 @@ export interface AutoUpdateEnabled {
 export interface AutoUpdateAvailable {
     available: boolean;
 }
+export interface SetShakeMenuOptions {
+    enabled: boolean;
+}
+export interface ShakeMenuEnabled {
+    enabled: boolean;
+}