@otakit/capacitor-updater 2.0.0 → 2.1.0

package/ios/Sources/UpdaterPlugin/UpdaterPlugin.swift

@@ -19,15 +19,12 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   public let identifier = "UpdaterPlugin"
   public let jsName = "OtaKit"
   public let pluginMethods: [CAPPluginMethod] = [
+    CAPPluginMethod(name: "getState", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "check", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "download", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "apply", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugGetState", returnType: CAPPluginReturnPromise),
     CAPPluginMethod(name: "notifyAppReady", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugReset", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugListBundles", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugDeleteBundle", returnType: CAPPluginReturnPromise),
-    CAPPluginMethod(name: "debugGetLastFailure", returnType: CAPPluginReturnPromise),
+    CAPPluginMethod(name: "getLastFailure", returnType: CAPPluginReturnPromise),
   ]
 
   private let store = BundleStore()
@@ -38,7 +35,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private var appReadyTimeoutMs = 10_000
   private var allowInsecureUrls = false
   private var updateMode: UpdateMode = .nextLaunch
-  private var updateUrl = UpdaterPlugin.defaultUpdateURL
+  private var ingestUrl = UpdaterPlugin.defaultIngestURL
   private var cdnUrl = UpdaterPlugin.defaultCdnURL
   private var appId: String?
   private var channel: String?
@@ -49,22 +46,21 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
   private let isCheckInProgress = NSLock()
   private var checkInProgress = false
   private var foregroundObserver: NSObjectProtocol?
-  private static let defaultUpdateURL = "https://www.otakit.app/api/v1"
+  private static let defaultIngestURL = "https://ingest.otakit.app/v1"
   private static let defaultCdnURL = "https://cdn.otakit.app"
-  private static let apiPathSuffix = "/api/v1"
+  private static let ingestPathSuffix = "/v1"
   private static let lastCheckTimestampKey = "otakit_last_check_timestamp"
 
   public override func load() {
-    let envUpdateUrl = ProcessInfo.processInfo.environment["OTAKIT_SERVER_URL"]
+    let envIngestUrl = ProcessInfo.processInfo.environment["OTAKIT_INGEST_URL"]
     let envCdnUrl = ProcessInfo.processInfo.environment["OTAKIT_CDN_URL"]
-    updateUrl = resolveUpdateUrl(
-      configured: getConfig().getString("serverUrl"),
-      env: envUpdateUrl
+    ingestUrl = resolveIngestUrl(
+      configured: getConfig().getString("ingestUrl"),
+      env: envIngestUrl
     )
     cdnUrl = resolveCdnUrl(
       configured: getConfig().getString("cdnUrl"),
-      env: envCdnUrl,
-      resolvedUpdateUrl: updateUrl
+      env: envCdnUrl
     )
     appId = getConfig().getString("appId")
     channel = trimToNil(getConfig().getString("channel"))
@@ -86,11 +82,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         return (kid: kid, key: keyData)
       }
       if manifestKeys.isEmpty && !rawKeys.isEmpty {
-        print("[UpdateKit] ERROR: manifestKeys configured but all entries are invalid. Manifest verification will reject all updates.")
+        print("[OtaKit] ERROR: manifestKeys configured but all entries are invalid. Manifest verification will reject all updates.")
         manifestKeys = [(kid: "_invalid_", key: Data())]
       }
     } else if rawKeysValue != nil {
-      print("[UpdateKit] ERROR: manifestKeys has wrong format (expected array of {kid, key}). Manifest verification will reject all updates.")
+      print("[OtaKit] ERROR: manifestKeys has wrong format (expected array of {kid, key}). Manifest verification will reject all updates.")
       manifestKeys = [(kid: "_invalid_", key: Data())]
     }
 
@@ -269,7 +265,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     }
   }
 
-  @objc func debugGetState(_ call: CAPPluginCall) {
+  @objc func getState(_ call: CAPPluginCall) {
     let current = store.getCurrentBundle()
     let staged: [String: Any]? = {
       guard let stagedId = store.getStagedBundleId() else {
@@ -394,9 +390,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         notifyListeners("appReady", data: current.toDictionary())
       }
 
-      sendStats(
+      sendDeviceEvent(
         action: .applied,
         bundleVersion: current.version,
+        runtimeVersion: current.runtimeVersion,
         channel: current.channel,
         releaseId: current.releaseId
       )
@@ -410,58 +407,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     call.resolve()
   }
 
-  @objc func debugReset(_ call: CAPPluginCall) {
-    cancelTrialTimeout()
-    store.setCurrentBundleId(nil)
-    store.setStagedBundleId(nil)
-    store.setFallbackBundleId(nil)
-    store.setFailedBundle(nil)
-    applyServerBasePath(nil)
-    call.resolve()
-    reloadWebView()
-  }
-
-  @objc func debugListBundles(_ call: CAPPluginCall) {
-    let bundles = store.listDownloadedBundles().map { $0.toDictionary() }
-    call.resolve(["bundles": bundles])
-  }
-
-  @objc func debugDeleteBundle(_ call: CAPPluginCall) {
-    guard let bundleId = call.getString("bundleId") else {
-      call.reject("Missing bundleId")
-      return
-    }
-    guard store.bundleExists(id: bundleId) else {
-      call.reject("Bundle not found")
-      return
-    }
-
-    let current = store.getCurrentBundle()
-    if current.id == bundleId {
-      call.reject("Cannot delete current bundle")
-      return
-    }
-
-    let fallback = store.getFallbackBundle()
-    if fallback.id == bundleId {
-      call.reject("Cannot delete fallback bundle")
-      return
-    }
-
-    if store.getStagedBundleId() == bundleId {
-      call.reject("Cannot delete staged bundle")
-      return
-    }
-
-    do {
-      try store.deleteBundle(id: bundleId)
-      call.resolve()
-    } catch {
-      call.reject("Failed to delete bundle: \(error.localizedDescription)")
-    }
-  }
-
-  @objc func debugGetLastFailure(_ call: CAPPluginCall) {
+  @objc func getLastFailure(_ call: CAPPluginCall) {
     guard let failed = store.getFailedBundle() else {
       call.resolve()
       return
@@ -593,12 +539,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
           code: 1,
           userInfo: [NSLocalizedDescriptionKey: "Insufficient disk space"]
         )
-        sendStats(
+        sendDeviceEvent(
           action: .downloadError,
           bundleVersion: version,
+          runtimeVersion: runtimeVersion,
           channel: channel,
           releaseId: releaseId,
-          errorMessage: "insufficient_disk_space"
+          detail: "insufficient_disk_space"
         )
         throw error
       }
@@ -608,7 +555,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     let zipURL = try await downloader.download(from: url)
 
     let extractDirectory = fileManager.temporaryDirectory
-      .appendingPathComponent("updatekit-extract-\(UUID().uuidString)", isDirectory: true)
+      .appendingPathComponent("otakit-extract-\(UUID().uuidString)", isDirectory: true)
     defer {
       try? fileManager.removeItem(at: zipURL)
       try? fileManager.removeItem(at: extractDirectory)
@@ -659,9 +606,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       cleanupSupersededStagedBundle(previousStagedId: previousStagedId, replacementId: bundleId)
 
       notifyListeners("downloadComplete", data: info.toDictionary())
-      sendStats(
+      sendDeviceEvent(
         action: .downloaded,
         bundleVersion: version,
+        runtimeVersion: runtimeVersion,
         channel: channel,
         releaseId: releaseId
       )
@@ -671,12 +619,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
         "version": version,
         "error": error.localizedDescription,
       ])
-      sendStats(
+      sendDeviceEvent(
         action: .downloadError,
         bundleVersion: version,
+        runtimeVersion: runtimeVersion,
         channel: channel,
         releaseId: releaseId,
-        errorMessage: error.localizedDescription
+        detail: error.localizedDescription
       )
       throw error
     }
@@ -808,12 +757,13 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     store.setFailedBundle(failed)
     store.setStagedBundleId(nil)
 
-    sendStats(
+    sendDeviceEvent(
       action: .rollback,
       bundleVersion: current.version,
+      runtimeVersion: current.runtimeVersion,
       channel: current.channel,
       releaseId: current.releaseId,
-      errorMessage: reason
+      detail: reason
     )
 
     let fallback = store.getFallbackBundle()
@@ -906,9 +856,7 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     if let runtimeVersion = latest.runtimeVersion {
       payload["runtimeVersion"] = runtimeVersion
     }
-    if let releaseId = latest.releaseId {
-      payload["releaseId"] = releaseId
-    }
+    payload["releaseId"] = latest.releaseId
     return payload
   }
 
@@ -932,9 +880,8 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       return false
     }
 
-    if let latestReleaseId = latest.releaseId,
-       let bundleReleaseId = bundle.releaseId,
-       latestReleaseId == bundleReleaseId {
+    if let bundleReleaseId = bundle.releaseId,
+       latest.releaseId == bundleReleaseId {
       return true
     }
 
@@ -1023,26 +970,41 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return "\(normalized)-\(suffix)"
   }
 
-  private func sendStats(
-    action: StatsAction,
+  private func sendDeviceEvent(
+    action: DeviceEventAction,
     bundleVersion: String? = nil,
+    runtimeVersion: String? = nil,
     channel: String? = nil,
     releaseId: String? = nil,
-    errorMessage: String? = nil
+    detail: String? = nil
   ) {
     guard let appId else {
       return
     }
-    StatsClient.send(
-      updateUrl: updateUrl,
+    guard let bundleVersion = trimToNil(bundleVersion) else {
+      print("[OtaKit] Skipping device event without bundleVersion")
+      return
+    }
+    guard let releaseId = trimToNil(releaseId) else {
+      print("[OtaKit] Skipping device event without releaseId")
+      return
+    }
+    let nativeBuild = store.nativeBuild.trimmingCharacters(in: .whitespacesAndNewlines)
+    guard !nativeBuild.isEmpty else {
+      print("[OtaKit] Skipping device event without nativeBuild")
+      return
+    }
+    DeviceEventClient.send(
+      ingestUrl: ingestUrl,
       appId: appId,
       platform: "ios",
       action: action,
       bundleVersion: bundleVersion,
       channel: channel,
+      runtimeVersion: trimToNil(runtimeVersion),
       releaseId: releaseId,
-      nativeBuild: store.nativeBuild,
-      errorMessage: errorMessage
+      nativeBuild: nativeBuild,
+      detail: detail
     )
   }
 
@@ -1061,21 +1023,27 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
     return trimmed.isEmpty ? nil : trimmed
   }
 
-  private func resolveUpdateUrl(configured: String?, env: String?) -> String {
+  private func resolveIngestUrl(
+    configured: String?,
+    env: String?
+  ) -> String {
     let configuredValue = configured?.trimmingCharacters(in: .whitespacesAndNewlines)
     if let configuredValue, !configuredValue.isEmpty {
-      return normalizeUpdateUrl(configuredValue)
+      return normalizeIngestUrl(configuredValue)
     }
 
     let envValue = env?.trimmingCharacters(in: .whitespacesAndNewlines)
     if let envValue, !envValue.isEmpty {
-      return normalizeUpdateUrl(envValue)
+      return normalizeIngestUrl(envValue)
     }
 
-    return UpdaterPlugin.defaultUpdateURL
+    return UpdaterPlugin.defaultIngestURL
   }
 
-  private func resolveCdnUrl(configured: String?, env: String?, resolvedUpdateUrl: String) -> String {
+  private func resolveCdnUrl(
+    configured: String?,
+    env: String?
+  ) -> String {
     let configuredValue = configured?.trimmingCharacters(in: .whitespacesAndNewlines)
     if let configuredValue, !configuredValue.isEmpty {
       return normalizeCdnUrl(configuredValue)
@@ -1086,15 +1054,10 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       return normalizeCdnUrl(envValue)
     }
 
-    if resolvedUpdateUrl.lowercased() != UpdaterPlugin.defaultUpdateURL.lowercased(),
-       resolvedUpdateUrl.lowercased().hasSuffix(UpdaterPlugin.apiPathSuffix) {
-      return String(resolvedUpdateUrl.dropLast(UpdaterPlugin.apiPathSuffix.count))
-    }
-
     return UpdaterPlugin.defaultCdnURL
   }
 
-  private func normalizeUpdateUrl(_ raw: String) -> String {
+  private func normalizeIngestUrl(_ raw: String) -> String {
     let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
     let withoutTrailingSlash = trimmed.replacingOccurrences(
       of: "/+$",
@@ -1102,11 +1065,11 @@ public class UpdaterPlugin: CAPPlugin, CAPBridgedPlugin {
       options: .regularExpression
     )
 
-    if withoutTrailingSlash.lowercased().hasSuffix(UpdaterPlugin.apiPathSuffix) {
+    if withoutTrailingSlash.lowercased().hasSuffix(UpdaterPlugin.ingestPathSuffix) {
       return withoutTrailingSlash
     }
 
-    return withoutTrailingSlash + UpdaterPlugin.apiPathSuffix
+    return withoutTrailingSlash + UpdaterPlugin.ingestPathSuffix
   }
 
   private func normalizeCdnUrl(_ raw: String) -> String {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@otakit/capacitor-updater",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Capacitor plugin for OTA updates",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -16,7 +16,7 @@
     "dist/",
     "ios/Sources/",
     "ios/Tests/",
-    "UpdatekitUpdater.podspec"
+    "OtaKitUpdater.podspec"
   ],
   "author": "OtaKit",
   "license": "MIT",