@capgo/capacitor-updater 8.0.0-alpha → 8.0.0-alpha.2

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

@@ -968,115 +968,41 @@ public class CapgoUpdater {
         makeJsonRequest(updateUrl, json, callback);
     }
 
-    public void unsetChannel(final Callback callback) {
-        // Check if rate limit was exceeded
-        if (rateLimitExceeded) {
-            logger.debug("Skipping unsetChannel due to rate limit (429). Requests will resume after app restart.");
-            final Map<String, Object> retError = new HashMap<>();
-            retError.put("message", "Rate limit exceeded");
-            retError.put("error", "rate_limit_exceeded");
-            callback.callback(retError);
-            return;
-        }
+    public void unsetChannel(
+        final SharedPreferences.Editor editor,
+        final String defaultChannelKey,
+        final String configDefaultChannel,
+        final Callback callback
+    ) {
+        // Clear persisted defaultChannel and revert to config value
+        editor.remove(defaultChannelKey);
+        editor.apply();
+        this.defaultChannel = configDefaultChannel;
+        logger.info("Persisted defaultChannel cleared, reverted to config value: " + configDefaultChannel);
+
+        Map<String, Object> ret = new HashMap<>();
+        ret.put("status", "ok");
+        ret.put("message", "Channel override removed");
+        callback.callback(ret);
+    }
 
-        String channelUrl = this.channelUrl;
-        if (channelUrl == null || channelUrl.isEmpty()) {
-            logger.error("Channel URL is not set");
-            final Map<String, Object> retError = new HashMap<>();
-            retError.put("message", "channelUrl missing");
-            retError.put("error", "missing_config");
-            callback.callback(retError);
-            return;
-        }
-        JSONObject json;
-        try {
-            json = this.createInfoObject();
-        } catch (JSONException e) {
-            logger.error("Error unsetChannel JSONException " + e.getMessage());
+    public void setChannel(
+        final String channel,
+        final SharedPreferences.Editor editor,
+        final String defaultChannelKey,
+        final boolean allowSetDefaultChannel,
+        final Callback callback
+    ) {
+        // Check if setting defaultChannel is allowed
+        if (!allowSetDefaultChannel) {
+            logger.error("setChannel is disabled by allowSetDefaultChannel config");
             final Map<String, Object> retError = new HashMap<>();
-            retError.put("message", "Cannot get info: " + e);
-            retError.put("error", "json_error");
+            retError.put("message", "setChannel is disabled by configuration");
+            retError.put("error", "disabled_by_config");
             callback.callback(retError);
             return;
         }
 
-        Request request = new Request.Builder()
-            .url(channelUrl)
-            .delete(RequestBody.create(json.toString(), MediaType.get("application/json")))
-            .build();
-
-        DownloadService.sharedClient
-            .newCall(request)
-            .enqueue(
-                new okhttp3.Callback() {
-                    @Override
-                    public void onFailure(@NonNull Call call, @NonNull IOException e) {
-                        Map<String, Object> retError = new HashMap<>();
-                        retError.put("message", "Request failed: " + e.getMessage());
-                        retError.put("error", "network_error");
-                        callback.callback(retError);
-                    }
-
-                    @Override
-                    public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {
-                        try (ResponseBody responseBody = response.body()) {
-                            // Check for 429 rate limit
-                            if (checkAndHandleRateLimitResponse(response)) {
-                                Map<String, Object> retError = new HashMap<>();
-                                retError.put("message", "Rate limit exceeded");
-                                retError.put("error", "rate_limit_exceeded");
-                                callback.callback(retError);
-                                return;
-                            }
-
-                            if (!response.isSuccessful()) {
-                                Map<String, Object> retError = new HashMap<>();
-                                retError.put("message", "Server error: " + response.code());
-                                retError.put("error", "response_error");
-                                callback.callback(retError);
-                                return;
-                            }
-
-                            assert responseBody != null;
-                            String responseData = responseBody.string();
-                            JSONObject jsonResponse = new JSONObject(responseData);
-
-                            // Check for server-side errors first
-                            if (jsonResponse.has("error")) {
-                                Map<String, Object> retError = new HashMap<>();
-                                retError.put("error", jsonResponse.getString("error"));
-                                if (jsonResponse.has("message")) {
-                                    retError.put("message", jsonResponse.getString("message"));
-                                } else {
-                                    retError.put("message", "server did not provide a message");
-                                }
-                                callback.callback(retError);
-                                return;
-                            }
-
-                            Map<String, Object> ret = new HashMap<>();
-
-                            Iterator<String> keys = jsonResponse.keys();
-                            while (keys.hasNext()) {
-                                String key = keys.next();
-                                if (jsonResponse.has(key)) {
-                                    ret.put(key, jsonResponse.get(key));
-                                }
-                            }
-                            logger.info("Channel unset");
-                            callback.callback(ret);
-                        } catch (JSONException e) {
-                            Map<String, Object> retError = new HashMap<>();
-                            retError.put("message", "JSON parse error: " + e.getMessage());
-                            retError.put("error", "parse_error");
-                            callback.callback(retError);
-                        }
-                    }
-                }
-            );
-    }
-
-    public void setChannel(final String channel, final Callback callback) {
         // Check if rate limit was exceeded
         if (rateLimitExceeded) {
             logger.debug("Skipping setChannel due to rate limit (429). Requests will resume after app restart.");
@@ -1109,7 +1035,18 @@ public class CapgoUpdater {
             return;
         }
 
-        makeJsonRequest(channelUrl, json, callback);
+        makeJsonRequest(channelUrl, json, (res) -> {
+            if (res.containsKey("error")) {
+                callback.callback(res);
+            } else {
+                // Success - persist defaultChannel
+                this.defaultChannel = channel;
+                editor.putString(defaultChannelKey, channel);
+                editor.apply();
+                logger.info("defaultChannel persisted locally: " + channel);
+                callback.callback(res);
+            }
+        });
     }
 
     public void getChannel(final Callback callback) {

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

@@ -302,7 +302,12 @@ public class DownloadService extends Worker {
                 }
 
                 final String finalFileHash = fileHash;
-                File targetFile = new File(destFolder, fileName);
+
+                // Check if file is a Brotli file and remove .br extension from target
+                boolean isBrotli = fileName.endsWith(".br");
+                String targetFileName = isBrotli ? fileName.substring(0, fileName.length() - 3) : fileName;
+
+                File targetFile = new File(destFolder, targetFileName);
                 File cacheFile = new File(cacheFolder, finalFileHash + "_" + new File(fileName).getName());
                 File builtinFile = new File(builtinFolder, fileName);
 
@@ -313,6 +318,7 @@ public class DownloadService extends Worker {
                     continue;
                 }
 
+                final boolean finalIsBrotli = isBrotli;
                 Future<?> future = executor.submit(() -> {
                     try {
                         if (builtinFile.exists() && verifyChecksum(builtinFile, finalFileHash)) {
@@ -322,7 +328,7 @@ public class DownloadService extends Worker {
                             copyFile(cacheFile, targetFile);
                             logger.debug("already cached " + fileName);
                         } else {
-                            downloadAndVerify(downloadUrl, targetFile, cacheFile, finalFileHash, sessionKey, publicKey);
+                            downloadAndVerify(downloadUrl, targetFile, cacheFile, finalFileHash, sessionKey, publicKey, finalIsBrotli);
                         }
 
                         long completed = completedFiles.incrementAndGet();
@@ -572,100 +578,103 @@ public class DownloadService extends Worker {
         File cacheFile,
         String expectedHash,
         String sessionKey,
-        String publicKey
+        String publicKey,
+        boolean isBrotli
     ) throws Exception {
         logger.debug("downloadAndVerify " + downloadUrl);
 
         Request request = new Request.Builder().url(downloadUrl).build();
 
-        // Check if file is a Brotli file
-        boolean isBrotli = targetFile.getName().endsWith(".br");
-
-        // Create final target file with .br extension removed if it's a Brotli file
-        File finalTargetFile = isBrotli
-            ? new File(targetFile.getParentFile(), targetFile.getName().substring(0, targetFile.getName().length() - 3))
-            : targetFile;
+        // targetFile is already the final destination without .br extension
+        File finalTargetFile = targetFile;
 
         // Create a temporary file for the compressed data
         File compressedFile = new File(getApplicationContext().getCacheDir(), "temp_" + targetFile.getName() + ".tmp");
 
-        try (Response response = sharedClient.newCall(request).execute()) {
-            if (!response.isSuccessful()) {
-                sendStatsAsync("download_manifest_file_fail", getInputData().getString(VERSION) + ":" + finalTargetFile.getName());
-                throw new IOException("Unexpected response code: " + response.code());
-            }
+        try {
+            try (Response response = sharedClient.newCall(request).execute()) {
+                if (!response.isSuccessful()) {
+                    sendStatsAsync("download_manifest_file_fail", getInputData().getString(VERSION) + ":" + finalTargetFile.getName());
+                    throw new IOException("Unexpected response code: " + response.code());
+                }
 
-            // Download compressed file atomically
-            ResponseBody responseBody = response.body();
-            if (responseBody == null) {
-                throw new IOException("Response body is null");
-            }
+                // Download compressed file atomically
+                ResponseBody responseBody = response.body();
+                if (responseBody == null) {
+                    throw new IOException("Response body is null");
+                }
 
-            // Use OkIO for atomic write
-            writeFileAtomic(compressedFile, responseBody.byteStream(), null);
+                // Use OkIO for atomic write
+                writeFileAtomic(compressedFile, responseBody.byteStream(), null);
 
-            if (!publicKey.isEmpty() && sessionKey != null && !sessionKey.isEmpty()) {
-                logger.debug("Decrypting file " + targetFile.getName());
-                CryptoCipher.decryptFile(compressedFile, publicKey, sessionKey);
-            }
+                if (!publicKey.isEmpty() && sessionKey != null && !sessionKey.isEmpty()) {
+                    logger.debug("Decrypting file " + targetFile.getName());
+                    CryptoCipher.decryptFile(compressedFile, publicKey, sessionKey);
+                }
 
-            // Only decompress if file has .br extension
-            if (isBrotli) {
-                // Use new decompression method with atomic write
-                try (FileInputStream fis = new FileInputStream(compressedFile)) {
-                    byte[] compressedData = new byte[(int) compressedFile.length()];
-                    fis.read(compressedData);
-                    byte[] decompressedData;
-                    try {
-                        decompressedData = decompressBrotli(compressedData, targetFile.getName());
-                    } catch (IOException e) {
-                        sendStatsAsync(
-                            "download_manifest_brotli_fail",
-                            getInputData().getString(VERSION) + ":" + finalTargetFile.getName()
-                        );
-                        throw e;
-                    }
+                // Only decompress if file has .br extension
+                if (isBrotli) {
+                    // Use new decompression method with atomic write
+                    try (FileInputStream fis = new FileInputStream(compressedFile)) {
+                        byte[] compressedData = new byte[(int) compressedFile.length()];
+                        fis.read(compressedData);
+                        byte[] decompressedData;
+                        try {
+                            decompressedData = decompressBrotli(compressedData, targetFile.getName());
+                        } catch (IOException e) {
+                            sendStatsAsync(
+                                "download_manifest_brotli_fail",
+                                getInputData().getString(VERSION) + ":" + finalTargetFile.getName()
+                            );
+                            throw e;
+                        }
 
-                    // Write decompressed data atomically
-                    try (java.io.ByteArrayInputStream bais = new java.io.ByteArrayInputStream(decompressedData)) {
-                        writeFileAtomic(finalTargetFile, bais, null);
+                        // Write decompressed data atomically
+                        try (java.io.ByteArrayInputStream bais = new java.io.ByteArrayInputStream(decompressedData)) {
+                            writeFileAtomic(finalTargetFile, bais, null);
+                        }
+                    }
+                } else {
+                    // Just copy the file without decompression using atomic operation
+                    try (FileInputStream fis = new FileInputStream(compressedFile)) {
+                        writeFileAtomic(finalTargetFile, fis, null);
                     }
                 }
-            } else {
-                // Just copy the file without decompression using atomic operation
-                try (FileInputStream fis = new FileInputStream(compressedFile)) {
-                    writeFileAtomic(finalTargetFile, fis, null);
-                }
-            }
 
-            // Delete the compressed file
-            compressedFile.delete();
-            String calculatedHash = CryptoCipher.calcChecksum(finalTargetFile);
-            CryptoCipher.logChecksumInfo("Calculated checksum", calculatedHash);
-            CryptoCipher.logChecksumInfo("Expected checksum", expectedHash);
-
-            // Verify checksum
-            if (calculatedHash.equals(expectedHash)) {
-                // Only cache if checksum is correct - use atomic copy
-                try (FileInputStream fis = new FileInputStream(finalTargetFile)) {
-                    writeFileAtomic(cacheFile, fis, expectedHash);
+                // Delete the compressed file
+                compressedFile.delete();
+                String calculatedHash = CryptoCipher.calcChecksum(finalTargetFile);
+                CryptoCipher.logChecksumInfo("Calculated checksum", calculatedHash);
+                CryptoCipher.logChecksumInfo("Expected checksum", expectedHash);
+
+                // Verify checksum
+                if (calculatedHash.equals(expectedHash)) {
+                    // Only cache if checksum is correct - use atomic copy
+                    try (FileInputStream fis = new FileInputStream(finalTargetFile)) {
+                        writeFileAtomic(cacheFile, fis, expectedHash);
+                    }
+                } else {
+                    finalTargetFile.delete();
+                    sendStatsAsync("download_manifest_checksum_fail", getInputData().getString(VERSION) + ":" + finalTargetFile.getName());
+                    throw new IOException(
+                        "Checksum verification failed for: " +
+                            downloadUrl +
+                            " " +
+                            targetFile.getName() +
+                            " expected: " +
+                            expectedHash +
+                            " calculated: " +
+                            calculatedHash
+                    );
                 }
-            } else {
-                finalTargetFile.delete();
-                sendStatsAsync("download_manifest_checksum_fail", getInputData().getString(VERSION) + ":" + finalTargetFile.getName());
-                throw new IOException(
-                    "Checksum verification failed for: " +
-                        downloadUrl +
-                        " " +
-                        targetFile.getName() +
-                        " expected: " +
-                        expectedHash +
-                        " calculated: " +
-                        calculatedHash
-                );
             }
         } catch (Exception e) {
             throw new IOException("Error in downloadAndVerify: " + e.getMessage());
+        } finally {
+            // Always cleanup the compressed temp file if it still exists
+            if (compressedFile.exists()) {
+                compressedFile.delete();
+            }
         }
     }
 

package/dist/docs.json

@@ -492,14 +492,14 @@
           },
           {
             "name": "throws",
-            "text": "{Error} If the request fails or the server returns an error."
+            "text": "{Error} Always throws when no new version is available (`error: \"no_new_version_available\"`), or when the request fails."
           },
           {
             "name": "since",
             "text": "4.0.0"
           }
         ],
-        "docs": "Check the update server for the latest available bundle version.\n\nThis queries your configured update URL (or Capgo backend) to see if a newer bundle\nis available for download. It does NOT download the bundle automatically.\n\nThe response includes:\n- `version`: The latest available version identifier\n- `url`: Download URL for the bundle (if available)\n- `breaking`: Whether this update is marked as incompatible (requires native app update)\n- `message`: Optional message from the server\n- `manifest`: File list for partial updates (if using multi-file downloads)\n\nAfter receiving the latest version info, you can:\n1. Compare it with your current version\n2. Download it using {@link download}\n3. Apply it using {@link next} or {@link set}",
+        "docs": "Check the update server for the latest available bundle version.\n\nThis queries your configured update URL (or Capgo backend) to see if a newer bundle\nis available for download. It does NOT download the bundle automatically.\n\nThe response includes:\n- `version`: The latest available version identifier\n- `url`: Download URL for the bundle (if available)\n- `breaking`: Whether this update is marked as incompatible (requires native app update)\n- `message`: Optional message from the server\n- `manifest`: File list for partial updates (if using multi-file downloads)\n\nAfter receiving the latest version info, you can:\n1. Compare it with your current version\n2. Download it using {@link download}\n3. Apply it using {@link next} or {@link set}\n\n**Important: Error handling for \"no new version available\"**\n\nWhen the device's current version matches the latest version on the server (i.e., the device is already\nup-to-date), the server returns a 200 response with `error: \"no_new_version_available\"` and\n`message: \"No new version available\"`. **This causes `getLatest()` to throw an error**, even though\nthis is a normal, expected condition.\n\nYou should catch this specific error to handle it gracefully:\n\n```typescript\ntry {\n  const latest = await CapacitorUpdater.getLatest();\n  // New version is available, proceed with download\n} catch (error) {\n  if (error.message === 'No new version available') {\n    // Device is already on the latest version - this is normal\n    console.log('Already up to date');\n  } else {\n    // Actual error occurred\n    console.error('Failed to check for updates:', error);\n  }\n}\n```\n\nIn this scenario, the server:\n- Logs the request with a \"No new version available\" message\n- Sends a \"noNew\" stat action to track that the device checked for updates but was already current (done on the backend)",
         "complexTypes": [
           "LatestVersion",
           "GetLatestOptions"
@@ -535,7 +535,7 @@
             "text": "4.7.0"
           }
         ],
-        "docs": "Assign this device to a specific update channel at runtime.\n\nChannels allow you to distribute different bundle versions to different groups of users\n(e.g., \"production\", \"beta\", \"staging\"). This method switches the device to a new channel.\n\n**Requirements:**\n- The target channel must allow self-assignment (configured in your Capgo dashboard or backend)\n- The backend may accept or reject the request based on channel settings\n\n**When to use:**\n- After the app is ready and the user has interacted (e.g., opted into beta program)\n- To implement in-app channel switching (beta toggle, tester access, etc.)\n- For user-driven channel changes\n\n**When NOT to use:**\n- At app boot/initialization - use {@link PluginsConfig.CapacitorUpdater.defaultChannel} config instead\n- Before user interaction\n\nThis sends a request to the Capgo backend linking your device ID to the specified channel.",
+        "docs": "Assign this device to a specific update channel at runtime.\n\nChannels allow you to distribute different bundle versions to different groups of users\n(e.g., \"production\", \"beta\", \"staging\"). This method switches the device to a new channel.\n\n**Requirements:**\n- The target channel must allow self-assignment (configured in your Capgo dashboard or backend)\n- The backend may accept or reject the request based on channel settings\n\n**When to use:**\n- After the app is ready and the user has interacted (e.g., opted into beta program)\n- To implement in-app channel switching (beta toggle, tester access, etc.)\n- For user-driven channel changes\n\n**When NOT to use:**\n- At app boot/initialization - use {@link PluginsConfig.CapacitorUpdater.defaultChannel} config instead\n- Before user interaction\n\n**Important: Listen for the `channelPrivate` event**\n\nWhen a user attempts to set a channel that doesn't allow device self-assignment, the method will\nthrow an error AND fire a {@link addListener}('channelPrivate') event. You should listen to this event\nto provide appropriate feedback to users:\n\n```typescript\nCapacitorUpdater.addListener('channelPrivate', (data) => {\n  console.warn(`Cannot access channel \"${data.channel}\": ${data.message}`);\n  // Show user-friendly message\n});\n```\n\nThis sends a request to the Capgo backend linking your device ID to the specified channel.",
         "complexTypes": [
           "ChannelRes",
           "SetChannelOptions"
@@ -1062,6 +1062,35 @@
         ],
         "slug": "addlistenerappready-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'channelPrivate', listenerFunc: (state: ChannelPrivateEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'channelPrivate'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(state: ChannelPrivateEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.34.0"
+          }
+        ],
+        "docs": "Listen for channel private event, fired when attempting to set a channel that doesn't allow device self-assignment.\n\nThis event is useful for:\n- Informing users they don't have permission to switch to a specific channel\n- Implementing custom error handling for channel restrictions\n- Logging unauthorized channel access attempts",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ChannelPrivateEvent"
+        ],
+        "slug": "addlistenerchannelprivate-"
+      },
       {
         "name": "isAutoUpdateAvailable",
         "signature": "() => Promise<AutoUpdateAvailable>",
@@ -1690,7 +1719,7 @@
         {
           "name": "message",
           "tags": [],
-          "docs": "",
+          "docs": "Optional message from the server.\nWhen no new version is available, this will be \"No new version available\".",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -1704,21 +1733,21 @@
         {
           "name": "error",
           "tags": [],
-          "docs": "",
+          "docs": "Error code from the server, if any.\nCommon values:\n- `\"no_new_version_available\"`: Device is already on the latest version (not a failure)\n- Other error codes indicate actual failures in the update process",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "old",
           "tags": [],
-          "docs": "",
+          "docs": "The previous/current version name (provided for reference).",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "url",
           "tags": [],
-          "docs": "",
+          "docs": "Download URL for the bundle (when a new version is available).",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -1730,11 +1759,35 @@
               "name": "since"
             }
           ],
-          "docs": "",
+          "docs": "File list for partial updates (when using multi-file downloads).",
           "complexTypes": [
             "ManifestEntry"
           ],
           "type": "ManifestEntry[] | undefined"
+        },
+        {
+          "name": "link",
+          "tags": [
+            {
+              "text": "7.35.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional link associated with this bundle version (e.g., release notes URL, changelog, GitHub release).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "comment",
+          "tags": [
+            {
+              "text": "7.35.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional comment or description for this bundle version.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -2260,6 +2313,34 @@
         }
       ]
     },
+    {
+      "name": "ChannelPrivateEvent",
+      "slug": "channelprivateevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "7.34.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Emitted when attempting to set a channel that doesn't allow device self-assignment.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "AutoUpdateAvailable",
       "slug": "autoupdateavailable",
@@ -2860,6 +2941,22 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "allowSetDefaultChannel",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "7.34.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow or disallow the {@link CapacitorUpdaterPlugin.setChannel} method to modify the defaultChannel.\nWhen set to `false`, calling `setChannel()` will return an error with code `disabled_by_config`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "defaultChannel",
           "tags": [