feat!: replace undefined installSource with explicit "sideloaded" enum value

Author: AlshehriAli0

bun.lock

@@ -20,7 +20,7 @@ import { VersionCheck } from 'react-native-nitro-version-check'
 | `version` | `string` | App version (`CFBundleShortVersionString` on iOS, `versionName` on Android) |
 | `buildNumber` | `string` | Build number (`CFBundleVersion` on iOS, `versionCode` on Android) |
 | `packageName` | `string` | Bundle ID (iOS) / Application ID (Android) |
-| `installSource` | `string \| undefined` | `"appstore"`, `"testflight"`, `"playstore"`, or `undefined` for dev/sideloaded builds |
+| `installSource` | `string` | `"appstore"`, `"testflight"`, `"playstore"`, or `"sideloaded"`. On iOS, `"sideloaded"` indicates a dev build. On Android, it means the app was installed via APK/ADB (dev or release). |
 
 ### Methods
 

docs/docs/api-reference.md

@@ -40,7 +40,7 @@ import { VersionCheck } from 'react-native-nitro-version-check'
 console.log(VersionCheck.version)       // "1.2.0"
 console.log(VersionCheck.buildNumber)   // "42"
 console.log(VersionCheck.packageName)   // "com.example.app"
-console.log(VersionCheck.installSource) // "appstore" | "testflight" | "playstore" | undefined
+console.log(VersionCheck.installSource) // "appstore" | "testflight" | "playstore" | "sideloaded"
 console.log(VersionCheck.getCountry())  // "US"
 
 // Or destructure properties

docs/docs/getting-started.md

@@ -17,7 +17,7 @@ const info = {
   version: VersionCheck.version,         // "1.2.0"
   build: VersionCheck.buildNumber,       // "42"
   package: VersionCheck.packageName,     // "com.example.app"
-  source: VersionCheck.installSource,    // "appstore" | undefined
+  source: VersionCheck.installSource,    // "appstore" | "sideloaded"
   country: VersionCheck.getCountry(),    // "US"
 }
 
@@ -89,8 +89,11 @@ switch (VersionCheck.installSource) {
   case 'playstore':
     console.log('Running Play Store build')
     break
-  default:
-    console.log('Development or sideloaded build')
+  case 'sideloaded':
+    // iOS: dev build (e.g. Xcode)
+    // Android: installed via APK/ADB (dev or release)
+    console.log('Sideloaded build')
+    break
 }
 ```
 

docs/docs/usage-examples.md

@@ -51,7 +51,7 @@ export default function App() {
       <Text style={styles.label}>Build: {VersionCheck.buildNumber}</Text>
       <Text style={styles.label}>Package: {VersionCheck.packageName}</Text>
       <Text style={styles.label}>Country: {VersionCheck.getCountry()}</Text>
-      <Text style={styles.label}>Install: {VersionCheck.installSource ?? "Dev Build"}</Text>
+      <Text style={styles.label}>Install: {VersionCheck.installSource}</Text>
 
       <View style={styles.divider} />
 

example/App.tsx

@@ -1,5 +1,5 @@
 import { useCallback, useState } from "react";
-import { ActivityIndicator, Platform, ScrollView, StyleSheet, Text, TouchableOpacity, View } from "react-native";
+import { Platform, ScrollView, StyleSheet, Text, TouchableOpacity, View } from "react-native";
 import { VersionCheck as NitroVC } from "react-native-nitro-version-check";
 import RNVersionCheck from "react-native-version-check";
 
@@ -10,7 +10,7 @@ type BenchmarkResult = {
   id: string;
   name: string;
   nitroMs: number;
-  bridgeMs: number;
+  bridgeMs: number | null;
   note?: string;
   section?: string;
 };
@@ -44,6 +44,9 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
     setRunning(true);
     setResults([]);
 
+    // Yield to let React render the "Running..." state before blocking the thread
+    await new Promise(resolve => requestAnimationFrame(resolve));
+
     const benchmarks: BenchmarkResult[] = [];
     const iter = ITERATIONS.toLocaleString();
 
@@ -63,6 +66,7 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
       nitro.packageName;
       nitro.version;
       nitro.buildNumber;
+      nitro.installSource;
       nitro.getCountry();
       bridge.getPackageName();
       bridge.getCurrentVersion();
@@ -78,6 +82,7 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
         nitro.packageName;
         nitro.version;
         nitro.buildNumber;
+        nitro.installSource;
         nitro.getCountry();
       }
       nitroAllTotal += performance.now() - ns;
@@ -97,7 +102,7 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
       name: `getAllInfo (${iter}x)`,
       nitroMs: nitroAllTotal / RUNS,
       bridgeMs: bridgeAllTotal / RUNS,
-      note: `pkg + version + build + country (avg of ${RUNS} runs)`,
+      note: `pkg + version + build + installSource + country (avg of ${RUNS} runs)`,
       section: "Real-world Usage",
     });
 
@@ -132,6 +137,14 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
       note: `Nitro: property | Bridge: fn call (avg of ${RUNS} runs)`,
     });
 
+    benchmarks.push({
+      id: "install-source",
+      name: `installSource (${iter}x)`,
+      nitroMs: averageSync(() => nitro.installSource, ITERATIONS, RUNS),
+      bridgeMs: null,
+      note: `Nitro: property | Bridge: not supported (avg of ${RUNS} runs)`,
+    });
+
     // getCountry — average over RUNS
     const nitroCountry = averageSync(() => nitro.getCountry(), ITERATIONS, RUNS);
     let bridgeCountryTotal = 0;
@@ -165,15 +178,15 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
         <View style={{ width: 40 }} />
       </View>
 
-      <Text style={styles.subtitle}>Nitro (JSI) vs react-native-version-check (Bridge) — up to 3.7x faster</Text>
+      <Text style={styles.subtitle}>Nitro (JSI) vs react-native-version-check (Bridge) </Text>
 
       <TouchableOpacity
         style={[styles.runButton, running && styles.runButtonDisabled]}
         onPress={runBenchmark}
         disabled={running}
       >
         {running ? (
-          <ActivityIndicator color="#fff" size="small" />
+          <Text style={styles.runButtonText}>Running...</Text>
         ) : (
           <Text style={styles.runButtonText}>Run Benchmark</Text>
         )}
@@ -188,7 +201,7 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
         </View>
 
         {results.map(r => {
-          const speedup = r.bridgeMs > 0 && r.nitroMs > 0 ? r.bridgeMs / r.nitroMs : null;
+          const speedup = r.bridgeMs != null && r.bridgeMs > 0 && r.nitroMs > 0 ? r.bridgeMs / r.nitroMs : null;
 
           return (
             <View key={r.id}>
@@ -200,17 +213,17 @@ export default function BenchmarkScreen({ onBack }: { onBack: () => void }) {
                 <Text style={[styles.cell, styles.cellValue]}>
                   {r.nitroMs < 0 ? "err" : `${r.nitroMs.toFixed(1)}ms`}
                 </Text>
-                <Text style={[styles.cell, styles.cellValue]}>
-                  {r.bridgeMs < 0 ? "err" : `${r.bridgeMs.toFixed(1)}ms`}
+                <Text style={[styles.cell, styles.cellValue, r.bridgeMs == null && styles.naText]}>
+                  {r.bridgeMs == null ? "N/A" : r.bridgeMs < 0 ? "err" : `${r.bridgeMs.toFixed(1)}ms`}
                 </Text>
                 <Text
                   style={[
                     styles.cell,
                     styles.cellSpeed,
-                    speedup != null && speedup > 1 ? styles.faster : styles.slower,
+                    speedup != null && speedup > 1 ? styles.faster : speedup != null ? styles.slower : styles.naText,
                   ]}
                 >
-                  {speedup != null ? `${speedup.toFixed(1)}x` : "-"}
+                  {speedup != null ? `${speedup.toFixed(1)}x` : r.bridgeMs == null ? "N/A" : "-"}
                 </Text>
               </View>
               {r.note && <Text style={styles.note}>{r.note}</Text>}
@@ -330,6 +343,10 @@ const styles = StyleSheet.create({
   slower: {
     color: "#FF3B30",
   },
+  naText: {
+    color: "#ccc",
+    fontStyle: "italic",
+  },
   note: {
     fontSize: 11,
     color: "#aaa",

example/BenchmarkScreen.tsx

@@ -30,14 +30,14 @@ class HybridVersionCheck : HybridVersionCheckSpec() {
 
     public override val packageName = packageInfo?.packageName
         ?: error("[VersionCheck] Failed to read 'packageName' from PackageInfo")
-    public override val installSource: InstallSource? = run {
+    public override val installSource: InstallSource = run {
         val installer = if (android.os.Build.VERSION.SDK_INT >= 30) {
             context?.packageManager?.getInstallSourceInfo(context.packageName)?.installingPackageName
         } else {
             @Suppress("DEPRECATION")
             context?.packageManager?.getInstallerPackageName(context.packageName)
         }
-        if (installer != null) InstallSource.PLAYSTORE else null
+        if (installer != null) InstallSource.PLAYSTORE else InstallSource.SIDELOADED
     }
 
     override fun getCountry(): String {

package/android/src/main/java/com/margelo/nitro/nitroversioncheck/HybridVersionCheck.kt

@@ -15,10 +15,10 @@ class HybridVersionCheck: HybridVersionCheckSpec {
         ?? { fatalError("[VersionCheck] Failed to read 'buildNumber' (CFBundleVersion) from Info.plist") }()
     var packageName = Bundle.main.infoDictionary?["CFBundleIdentifier"] as? String
         ?? { fatalError("[VersionCheck] Failed to read 'packageName' (CFBundleIdentifier) from Info.plist") }()
-    var installSource: InstallSource? = {
+    var installSource: InstallSource = {
         guard let receiptURL = Bundle.main.appStoreReceiptURL,
               FileManager.default.fileExists(atPath: receiptURL.path) else {
-            return nil
+            return .sideloaded
         }
         if receiptURL.lastPathComponent == "sandboxReceipt" {
             return .testflight