@otakit/capacitor-updater 2.0.0 → 2.1.0

package/{UpdatekitUpdater.podspec → OtaKitUpdater.podspec}

@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name = 'UpdatekitUpdater'
+  s.name = 'OtaKitUpdater'
   s.version = package['version']
   s.summary = package['description']
   s.license = package['license']

package/README.md

@@ -40,9 +40,6 @@ For manual mode, `getState()` tells you if something is already staged,
 `check()` tells you whether a newer update exists, `download()` stages it, and
 `update()` is the one-shot helper that downloads and applies the newest update.
 
-Manual inspection and support methods like state inspection and reset live under
-`OtaKit.debug`.
-
 ## Hosted config
 
 ```ts
@@ -63,11 +60,12 @@ plugins: {
 Advanced overrides for self-hosting or custom trust only:
 
 - `cdnUrl` for manifest and bundle delivery
-- `serverUrl` for stats and control-plane requests
+- `ingestUrl` for event ingest requests
+- `serverUrl` for self-hosted control-plane tooling such as the CLI. The native runtime uses `cdnUrl` and `ingestUrl` instead.
 - `manifestKeys`
 - `allowInsecureUrls`
 
-Hosted OtaKit already points at the managed control-plane API and CDN and already
+Hosted OtaKit already points at the managed ingest service and CDN and already
 trusts the managed manifest signing keys.
 
 ## Channels vs runtimeVersion
@@ -121,7 +119,7 @@ resume**.
   no automatic checks, no automatic staged activation.
   the app integration drives everything via `check()`, `download()`, `apply()`, or `update()`.
 
-### Dev/debug mode
+### Development mode
 
 - `immediate`
   checks, downloads, and activates in one shot as soon as possible on cold start and resume (the user may briefly see the previous version before a reload).
@@ -212,7 +210,6 @@ always live, and `immediate` mode ignores the interval entirely.
 - the builtin, current, fallback, and staged bundles are protected
 - superseded staged bundles are deleted automatically
 - failed trial bundles are deleted during rollback
-- `debug.deleteBundle()` only works for downloaded bundles outside runtime state
 
 ## Source areas
 
@@ -220,7 +217,7 @@ always live, and `immediate` mode ignores the interval entirely.
 - `src/index.ts`: Capacitor registration and JS wrapper
 - `src/web.ts`: web fallback implementation
 - `ios/Sources/UpdaterPlugin/*`: iOS implementation
-- `android/src/main/java/com/updatekit/updater/*`: Android implementation
+- `android/src/main/java/com/otakit/updater/*`: Android implementation
 
 ## Build locally
 

package/android/build.gradle

@@ -17,7 +17,7 @@ buildscript {
 apply plugin: 'com.android.library'
 
 android {
-    namespace "com.updatekit.updater"
+    namespace "com.otakit.updater"
     compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
     defaultConfig {
         minSdk project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23

package/android/src/main/java/com/{updatekit → otakit}/updater/BundleInfo.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import com.getcapacitor.JSObject;
 import org.json.JSONException;

package/android/src/main/java/com/{updatekit → otakit}/updater/BundleStatus.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 enum BundleStatus {
   BUILTIN("builtin"),

package/android/src/main/java/com/{updatekit → otakit}/updater/BundleStore.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import android.content.Context;
 import android.content.SharedPreferences;

package/android/src/main/java/com/{updatekit → otakit}/updater/DateUtils.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import java.text.SimpleDateFormat;
 import java.util.Date;

package/android/src/main/java/com/{updatekit/updater/StatsClient.java → otakit/updater/DeviceEventClient.java}

@@ -1,55 +1,60 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import java.io.OutputStream;
 import java.net.HttpURLConnection;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Locale;
+import java.util.TimeZone;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
+import java.util.UUID;
 import org.json.JSONObject;
 
-final class StatsClient {
+final class DeviceEventClient {
 
   private static final ExecutorService executor = Executors.newSingleThreadExecutor();
 
-  private StatsClient() {}
+  private DeviceEventClient() {}
 
   static void send(
-    String updateUrl,
+    String ingestUrl,
     String appId,
     String platform,
     String action,
     String bundleVersion,
     String channel,
+    String runtimeVersion,
     String releaseId,
     String nativeBuild,
-    String errorMessage
+    String detail
   ) {
     executor.execute(() -> {
       HttpURLConnection connection = null;
       try {
-        String base = updateUrl.replaceAll("/+$", "");
-        URL url = new URL(base + "/stats");
+        String base = ingestUrl.replaceAll("/+$", "");
+        URL url = new URL(base + "/events");
 
         JSONObject payload = new JSONObject();
+        payload.put("eventId", UUID.randomUUID().toString());
+        payload.put("sentAt", iso8601Now());
         payload.put("platform", platform);
         payload.put("action", action);
-        if (bundleVersion != null) {
-          payload.put("bundleVersion", bundleVersion);
-        }
+        payload.put("bundleVersion", bundleVersion);
         if (channel != null && !channel.isEmpty()) {
           payload.put("channel", channel);
         }
-        if (releaseId != null && !releaseId.isEmpty()) {
-          payload.put("releaseId", releaseId);
-        }
-        if (nativeBuild != null) {
-          payload.put("nativeBuild", nativeBuild);
+        if (runtimeVersion != null && !runtimeVersion.isEmpty()) {
+          payload.put("runtimeVersion", runtimeVersion);
         }
-        if (errorMessage != null) {
+        payload.put("releaseId", releaseId);
+        payload.put("nativeBuild", nativeBuild);
+        if (detail != null) {
           String truncated =
-            errorMessage.length() > 500 ? errorMessage.substring(0, 500) : errorMessage;
-          payload.put("errorMessage", truncated);
+            detail.length() > 500 ? detail.substring(0, 500) : detail;
+          payload.put("detail", truncated);
         }
 
         byte[] body = payload.toString().getBytes(StandardCharsets.UTF_8);
@@ -66,10 +71,10 @@ final class StatsClient {
           output.write(body);
         }
 
-        // Fire and forget - just trigger the request
+        // Device events are best-effort and should never block the update flow.
         connection.getResponseCode();
       } catch (Exception ignored) {
-        // Stats are best-effort, don't fail on errors
+        // Device events are best-effort, don't fail on errors
       } finally {
         if (connection != null) {
           connection.disconnect();
@@ -77,4 +82,10 @@ final class StatsClient {
       }
     });
   }
+
+  private static String iso8601Now() {
+    SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.US);
+    formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
+    return formatter.format(new Date());
+  }
 }

package/android/src/main/java/com/{updatekit → otakit}/updater/HashUtils.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import java.io.File;
 import java.io.FileInputStream;

package/android/src/main/java/com/{updatekit → otakit}/updater/HostedManifestKeys.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import android.util.Base64;
 import java.util.ArrayList;

package/android/src/main/java/com/{updatekit → otakit}/updater/ManifestClient.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
@@ -123,14 +123,20 @@ final class ManifestClient {
 
       String releaseId = null;
       if (json.has("releaseId") && !json.isNull("releaseId")) {
-        releaseId = json.getString("releaseId");
+        releaseId = json.getString("releaseId").trim();
+      }
+      if (releaseId != null && releaseId.isEmpty()) {
+        releaseId = null;
+      }
+      if (releaseId == null) {
+        throw new IllegalStateException("Manifest response missing required releaseId");
       }
 
       requireHTTPS(new URL(downloadUrl), allowInsecureUrls);
 
       if (manifestKeys == null || manifestKeys.isEmpty()) {
         android.util.Log.w(
-          "UpdateKit",
+          "OtaKit",
           "No manifest signing keys configured — signature verification is disabled for this request."
         );
       }
@@ -188,11 +194,15 @@ final class ManifestClient {
     if (!sigObj.has("kid") || !sigObj.has("sig") || !sigObj.has("iat") || !sigObj.has("exp")) {
       return null;
     }
-    return new ManifestSignature(
-      sigObj.getString("kid"),
-      sigObj.getString("sig"),
-      sigObj.getInt("iat"),
-      sigObj.getInt("exp")
-    );
+    try {
+      return new ManifestSignature(
+        sigObj.getString("kid"),
+        sigObj.getString("sig"),
+        sigObj.getInt("iat"),
+        sigObj.getInt("exp")
+      );
+    } catch (org.json.JSONException e) {
+      return null;
+    }
   }
 }

package/android/src/main/java/com/{updatekit → otakit}/updater/ManifestVerifier.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import android.util.Base64;
 import java.security.KeyFactory;

package/android/src/main/java/com/{updatekit → otakit}/updater/UpdaterPlugin.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
@@ -36,7 +36,7 @@ public class UpdaterPlugin extends Plugin {
   private int appReadyTimeoutMs = 10_000;
   private boolean allowInsecureUrls = false;
   private String updateMode = UPDATE_MODE_NEXT_LAUNCH;
-  private String updateUrl;
+  private String ingestUrl;
   private String cdnUrl;
   private String appId;
   private String channel;
@@ -44,9 +44,9 @@ public class UpdaterPlugin extends Plugin {
   private java.util.List<ManifestVerifier.KeyEntry> manifestKeys = new java.util.ArrayList<>();
   private long checkIntervalMs = 600_000;
   private final AtomicBoolean checkInProgress = new AtomicBoolean(false);
-  private static final String DEFAULT_UPDATE_URL = "https://www.otakit.app/api/v1";
+  private static final String DEFAULT_INGEST_URL = "https://ingest.otakit.app/v1";
   private static final String DEFAULT_CDN_URL = "https://cdn.otakit.app";
-  private static final String API_PATH_SUFFIX = "/api/v1";
+  private static final String INGEST_PATH_SUFFIX = "/v1";
   private static final String UPDATE_MODE_MANUAL = "manual";
   private static final String UPDATE_MODE_NEXT_LAUNCH = "next-launch";
   private static final String UPDATE_MODE_NEXT_RESUME = "next-resume";
@@ -74,14 +74,13 @@ public class UpdaterPlugin extends Plugin {
       }
     } catch (PackageManager.NameNotFoundException ignored) {}
 
-    this.updateUrl = resolveUpdateUrl(
-      getConfig().getString("serverUrl"),
-      System.getenv("OTAKIT_SERVER_URL")
+    this.ingestUrl = resolveIngestUrl(
+      getConfig().getString("ingestUrl"),
+      System.getenv("OTAKIT_INGEST_URL")
     );
     this.cdnUrl = resolveCdnUrl(
       getConfig().getString("cdnUrl"),
-      System.getenv("OTAKIT_CDN_URL"),
-      this.updateUrl
+      System.getenv("OTAKIT_CDN_URL")
     );
     this.appId = getConfig().getString("appId");
     this.channel = trimToNull(getConfig().getString("channel"));
@@ -108,7 +107,7 @@ public class UpdaterPlugin extends Plugin {
         }
         if (manifestKeys.isEmpty()) {
           android.util.Log.e(
-            "UpdateKit",
+            "OtaKit",
             "manifestKeys configured but all entries are invalid. Manifest verification will reject all updates."
           );
           manifestKeys.add(new ManifestVerifier.KeyEntry("_invalid_", new byte[0]));
@@ -116,7 +115,7 @@ public class UpdaterPlugin extends Plugin {
       }
     } catch (Exception e) {
       android.util.Log.e(
-        "UpdateKit",
+        "OtaKit",
         "Failed to parse manifestKeys. Manifest verification will reject all updates.",
         e
       );
@@ -274,7 +273,7 @@ public class UpdaterPlugin extends Plugin {
   }
 
   @PluginMethod
-  public void debugGetState(PluginCall call) {
+  public void getState(PluginCall call) {
     JSObject result = new JSObject();
     result.put("current", store.getCurrentBundle().toJSObject());
     result.put("fallback", store.getFallbackBundle().toJSObject());
@@ -402,7 +401,14 @@ public class UpdaterPlugin extends Plugin {
       BundleInfo updated = store.getBundle(current.id);
       notifyListeners("appReady", updated != null ? updated.toJSObject() : current.toJSObject());
 
-      sendStats("applied", current.version, current.channel, current.releaseId, null);
+      sendDeviceEvent(
+        "applied",
+        current.version,
+        current.runtimeVersion,
+        current.channel,
+        current.releaseId,
+        null
+      );
 
       if (!oldFallback.isBuiltin() && !oldFallback.id.equals(current.id)) {
         try {
@@ -415,65 +421,7 @@ public class UpdaterPlugin extends Plugin {
   }
 
   @PluginMethod
-  public void debugReset(PluginCall call) {
-    cancelTrialTimeout();
-    store.setCurrentBundleId(null);
-    store.setStagedBundleId(null);
-    store.setFallbackBundleId(null);
-    store.setFailedBundle(null);
-    applyServerBasePath(null);
-    call.resolve();
-    reloadWebView();
-  }
-
-  @PluginMethod
-  public void debugListBundles(PluginCall call) {
-    JSObject result = new JSObject();
-    JSArray bundles = store.listDownloadedBundles();
-    result.put("bundles", bundles);
-    call.resolve(result);
-  }
-
-  @PluginMethod
-  public void debugDeleteBundle(PluginCall call) {
-    String bundleId = call.getString("bundleId");
-    if (bundleId == null) {
-      call.reject("Missing bundleId");
-      return;
-    }
-    if (!store.bundleExists(bundleId)) {
-      call.reject("Bundle not found");
-      return;
-    }
-
-    BundleInfo current = store.getCurrentBundle();
-    if (bundleId.equals(current.id)) {
-      call.reject("Cannot delete current bundle");
-      return;
-    }
-
-    BundleInfo fallback = store.getFallbackBundle();
-    if (bundleId.equals(fallback.id)) {
-      call.reject("Cannot delete fallback bundle");
-      return;
-    }
-
-    String stagedId = store.getStagedBundleId();
-    if (bundleId.equals(stagedId)) {
-      call.reject("Cannot delete staged bundle");
-      return;
-    }
-
-    try {
-      store.deleteBundle(bundleId);
-      call.resolve();
-    } catch (Exception e) {
-      call.reject("Delete failed: " + e.getMessage());
-    }
-  }
-
-  @PluginMethod
-  public void debugGetLastFailure(PluginCall call) {
+  public void getLastFailure(PluginCall call) {
     BundleInfo failed = store.getFailedBundle();
     if (failed == null) {
       call.resolve((JSObject) null);
@@ -589,7 +537,14 @@ public class UpdaterPlugin extends Plugin {
       long requiredSpace = (long) (expectedSize * 2.5); // zip + extracted + buffer
       long availableSpace = getFreeDiskSpace();
       if (availableSpace < requiredSpace) {
-        sendStats("download_error", version, channel, releaseId, "insufficient_disk_space");
+        sendDeviceEvent(
+          "download_error",
+          version,
+          runtimeVersion,
+          channel,
+          releaseId,
+          "insufficient_disk_space"
+        );
         throw new IllegalStateException("Insufficient disk space");
       }
     }
@@ -609,7 +564,7 @@ public class UpdaterPlugin extends Plugin {
 
       extractedDirectory = new File(
         getContext().getCacheDir(),
-        "updatekit-extract-" + System.currentTimeMillis()
+        "otakit-extract-" + System.currentTimeMillis()
       );
       if (!extractedDirectory.exists() && !extractedDirectory.mkdirs()) {
         throw new IllegalStateException("Cannot create temporary extraction directory");
@@ -642,14 +597,14 @@ public class UpdaterPlugin extends Plugin {
       cleanupSupersededStagedBundle(previousStagedId, bundleId);
 
       notifyListeners("downloadComplete", info.toJSObject());
-      sendStats("downloaded", version, channel, releaseId, null);
+      sendDeviceEvent("downloaded", version, runtimeVersion, channel, releaseId, null);
       return info;
     } catch (Exception e) {
       JSObject failed = new JSObject();
       failed.put("version", version);
       failed.put("error", e.getMessage());
       notifyListeners("downloadFailed", failed);
-      sendStats("download_error", version, channel, releaseId, e.getMessage());
+      sendDeviceEvent("download_error", version, runtimeVersion, channel, releaseId, e.getMessage());
       throw e;
     } finally {
       if (downloadedZip != null && downloadedZip.exists()) {
@@ -677,7 +632,7 @@ public class UpdaterPlugin extends Plugin {
         throw new IllegalStateException("Download failed with HTTP " + status);
       }
 
-      File destination = File.createTempFile("updatekit-", ".zip", getContext().getCacheDir());
+      File destination = File.createTempFile("otakit-", ".zip", getContext().getCacheDir());
 
       try (
         InputStream input = connection.getInputStream();
@@ -803,7 +758,14 @@ public class UpdaterPlugin extends Plugin {
     store.setFailedBundle(failed);
     store.setStagedBundleId(null);
 
-    sendStats("rollback", current.version, current.channel, current.releaseId, reason);
+    sendDeviceEvent(
+      "rollback",
+      current.version,
+      current.runtimeVersion,
+      current.channel,
+      current.releaseId,
+      reason
+    );
 
     BundleInfo fallback = store.getFallbackBundle();
     JSObject payload = new JSObject();
@@ -883,9 +845,7 @@ public class UpdaterPlugin extends Plugin {
     if (latest.runtimeVersion != null) {
       object.put("runtimeVersion", latest.runtimeVersion);
     }
-    if (latest.releaseId != null) {
-      object.put("releaseId", latest.releaseId);
-    }
+    object.put("releaseId", latest.releaseId);
     return object;
   }
 
@@ -1043,21 +1003,21 @@ public class UpdaterPlugin extends Plugin {
     return normalized + "-" + suffix;
   }
 
-  private String resolveUpdateUrl(String configured, String env) {
+  private String resolveIngestUrl(String configured, String env) {
     String configuredValue = trimToNull(configured);
     if (configuredValue != null) {
-      return normalizeUpdateUrl(configuredValue);
+      return normalizeIngestUrl(configuredValue);
     }
 
     String envValue = trimToNull(env);
     if (envValue != null) {
-      return normalizeUpdateUrl(envValue);
+      return normalizeIngestUrl(envValue);
     }
 
-    return DEFAULT_UPDATE_URL;
+    return DEFAULT_INGEST_URL;
   }
 
-  private String resolveCdnUrl(String configured, String env, String resolvedUpdateUrl) {
+  private String resolveCdnUrl(String configured, String env) {
     String configuredValue = trimToNull(configured);
     if (configuredValue != null) {
       return normalizeCdnUrl(configuredValue);
@@ -1068,23 +1028,15 @@ public class UpdaterPlugin extends Plugin {
       return normalizeCdnUrl(envValue);
     }
 
-    if (
-      resolvedUpdateUrl != null &&
-      !DEFAULT_UPDATE_URL.equalsIgnoreCase(resolvedUpdateUrl) &&
-      resolvedUpdateUrl.toLowerCase(java.util.Locale.ROOT).endsWith(API_PATH_SUFFIX)
-    ) {
-      return resolvedUpdateUrl.substring(0, resolvedUpdateUrl.length() - API_PATH_SUFFIX.length());
-    }
-
     return DEFAULT_CDN_URL;
   }
 
-  private String normalizeUpdateUrl(String raw) {
+  private String normalizeIngestUrl(String raw) {
     String trimmed = raw.trim().replaceAll("/+$", "");
-    if (trimmed.toLowerCase(java.util.Locale.ROOT).endsWith(API_PATH_SUFFIX)) {
+    if (trimmed.toLowerCase(java.util.Locale.ROOT).endsWith(INGEST_PATH_SUFFIX)) {
       return trimmed;
     }
-    return trimmed + API_PATH_SUFFIX;
+    return trimmed + INGEST_PATH_SUFFIX;
   }
 
   private String normalizeCdnUrl(String raw) {
@@ -1105,26 +1057,43 @@ public class UpdaterPlugin extends Plugin {
     return resolved != null ? resolved : this.channel;
   }
 
-  private void sendStats(
+  private void sendDeviceEvent(
     String action,
     String bundleVersion,
+    String runtimeVersion,
     String channel,
     String releaseId,
-    String errorMessage
+    String detail
   ) {
     if (appId == null) {
       return;
     }
-    StatsClient.send(
-      updateUrl,
+    String normalizedBundleVersion = trimToNull(bundleVersion);
+    if (normalizedBundleVersion == null) {
+      android.util.Log.w("OtaKit", "Skipping device event without bundleVersion");
+      return;
+    }
+    String normalizedReleaseId = trimToNull(releaseId);
+    if (normalizedReleaseId == null) {
+      android.util.Log.w("OtaKit", "Skipping device event without releaseId");
+      return;
+    }
+    String nativeBuild = trimToNull(store.getNativeBuild());
+    if (nativeBuild == null) {
+      android.util.Log.w("OtaKit", "Skipping device event without nativeBuild");
+      return;
+    }
+    DeviceEventClient.send(
+      ingestUrl,
       appId,
       "android",
       action,
-      bundleVersion,
+      normalizedBundleVersion,
       channel,
-      releaseId,
-      store.getNativeBuild(),
-      errorMessage
+      trimToNull(runtimeVersion),
+      normalizedReleaseId,
+      nativeBuild,
+      detail
     );
   }
 

package/android/src/main/java/com/{updatekit → otakit}/updater/ZipUtils.java

@@ -1,4 +1,4 @@
-package com.updatekit.updater;
+package com.otakit.updater;
 
 import java.io.File;
 import java.io.FileInputStream;