react-native-nitro-version-check 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,168 @@
+import type { UpdateLevel } from "./semver";
+import { compareVersions } from "./semver";
+/**
+ * Returns the device's current 2-letter ISO country code.
+ *
+ * @example
+ * ```ts
+ * getCountry() // "US"
+ * ```
+ */
+export declare const getCountry: () => string;
+/**
+ * Returns the store URL for this app.
+ *
+ * Automatically resolves to the App Store on iOS and Play Store on Android.
+ *
+ * @example
+ * ```ts
+ * const url = await getStoreUrl();
+ * Linking.openURL(url);
+ * ```
+ */
+export declare const getStoreUrl: () => Promise<string>;
+/**
+ * Fetches the latest version of this app available in the store.
+ *
+ * @example
+ * ```ts
+ * const latest = await getLatestVersion(); // "1.3.0"
+ * ```
+ */
+export declare const getLatestVersion: () => Promise<string>;
+/**
+ * Checks whether an app update is available.
+ *
+ * Uses semantic version comparison. By default checks for any version
+ * increase, but you can filter by granularity:
+ *
+ * - `"major"` — only returns `true` for major bumps (1.x → 2.x)
+ * - `"minor"` — returns `true` for major or minor bumps
+ * - `"patch"` — returns `true` for any version increase (default)
+ *
+ * @example
+ * ```ts
+ * if (await needsUpdate()) {
+ *   const url = await getStoreUrl();
+ *   Linking.openURL(url);
+ * }
+ *
+ * // Only prompt for major updates
+ * const majorUpdate = await needsUpdate({ level: "major" });
+ * ```
+ */
+export declare const needsUpdate: (options?: {
+    level?: UpdateLevel;
+}) => Promise<boolean>;
+/**
+ * All version-check APIs in one object.
+ *
+ * @example
+ * ```ts
+ * VersionCheck.version      // "1.2.0"
+ * VersionCheck.buildNumber  // "42"
+ * VersionCheck.packageName  // "com.example.app"
+ * VersionCheck.getCountry() // "US"
+ *
+ * const url = await VersionCheck.getStoreUrl();
+ * ```
+ */
+export declare const VersionCheck: {
+    /**
+     * The current app version string.
+     *
+     * Read from `CFBundleShortVersionString` on iOS and `versionName` on Android.
+     * Cached at module init, so repeated reads have zero native overhead.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.version // "1.2.0"
+     * ```
+     */
+    readonly version: string;
+    /**
+     * The current build number.
+     *
+     * Read from `CFBundleVersion` on iOS and `versionCode` on Android.
+     * Cached at module init.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.buildNumber // "42"
+     * ```
+     */
+    readonly buildNumber: string;
+    /**
+     * The app's unique identifier.
+     *
+     * This is the Bundle ID on iOS and the Application ID on Android.
+     * Cached at module init.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.packageName // "com.example.app"
+     * ```
+     */
+    readonly packageName: string;
+    /**
+     * Where the app was installed from, or `undefined` for dev/sideloaded builds.
+     *
+     * - iOS: `"appstore"` | `"testflight"` | `undefined`
+     * - Android: `"playstore"` | `undefined`
+     *
+     * @example
+     * ```ts
+     * if (VersionCheck.installSource === "testflight") {
+     *   // running a TestFlight build
+     * }
+     * ```
+     */
+    readonly installSource: string | undefined;
+    /**
+     * Returns the device's current 2-letter ISO country code.
+     *
+     * This is a synchronous Nitro call, no `await` needed.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.getCountry() // "US"
+     * ```
+     */
+    readonly getCountry: () => string;
+    /**
+     * Returns the App Store (iOS) or Play Store (Android) URL for this app.
+     *
+     * @example
+     * ```ts
+     * const url = await VersionCheck.getStoreUrl();
+     * Linking.openURL(url);
+     * ```
+     */
+    readonly getStoreUrl: () => Promise<string>;
+    /**
+     * Fetches the latest version of this app available in the store.
+     *
+     * Queries the iTunes API on iOS and the Play Store on Android.
+     *
+     * @example
+     * ```ts
+     * const latest = await VersionCheck.getLatestVersion(); // "1.3.0"
+     * ```
+     */
+    readonly getLatestVersion: () => Promise<string>;
+    /**
+     * Checks whether an app update is available by comparing the current
+     * version against the latest store version.
+     *
+     * @example
+     * ```ts
+     * if (await VersionCheck.needsUpdate()) {
+     *   const url = await VersionCheck.getStoreUrl();
+     *   Linking.openURL(url);
+     * }
+     * ```
+     */
+    readonly needsUpdate: () => Promise<boolean>;
+};
+export { compareVersions };
+export type { UpdateLevel };

package/lib/index.js

@@ -0,0 +1,174 @@
+import { NitroModules } from "react-native-nitro-modules";
+import { compareVersions, isNewerVersion } from "./semver";
+const HybridVersionCheck = NitroModules.createHybridObject("VersionCheck");
+// Cached at module init — plain JS values, no JSI overhead on repeated access.
+const version = HybridVersionCheck.version;
+const buildNumber = HybridVersionCheck.buildNumber;
+const packageName = HybridVersionCheck.packageName;
+const installSource = HybridVersionCheck.installSource;
+/**
+ * Returns the device's current 2-letter ISO country code.
+ *
+ * @example
+ * ```ts
+ * getCountry() // "US"
+ * ```
+ */
+export const getCountry = () => HybridVersionCheck.getCountry();
+/**
+ * Returns the store URL for this app.
+ *
+ * Automatically resolves to the App Store on iOS and Play Store on Android.
+ *
+ * @example
+ * ```ts
+ * const url = await getStoreUrl();
+ * Linking.openURL(url);
+ * ```
+ */
+export const getStoreUrl = () => HybridVersionCheck.getStoreUrl();
+/**
+ * Fetches the latest version of this app available in the store.
+ *
+ * @example
+ * ```ts
+ * const latest = await getLatestVersion(); // "1.3.0"
+ * ```
+ */
+export const getLatestVersion = () => HybridVersionCheck.getLatestVersion();
+/**
+ * Checks whether an app update is available.
+ *
+ * Uses semantic version comparison. By default checks for any version
+ * increase, but you can filter by granularity:
+ *
+ * - `"major"` — only returns `true` for major bumps (1.x → 2.x)
+ * - `"minor"` — returns `true` for major or minor bumps
+ * - `"patch"` — returns `true` for any version increase (default)
+ *
+ * @example
+ * ```ts
+ * if (await needsUpdate()) {
+ *   const url = await getStoreUrl();
+ *   Linking.openURL(url);
+ * }
+ *
+ * // Only prompt for major updates
+ * const majorUpdate = await needsUpdate({ level: "major" });
+ * ```
+ */
+export const needsUpdate = async (options) => {
+    const latest = await HybridVersionCheck.getLatestVersion();
+    return isNewerVersion(version, latest, options?.level ?? "patch");
+};
+/**
+ * All version-check APIs in one object.
+ *
+ * @example
+ * ```ts
+ * VersionCheck.version      // "1.2.0"
+ * VersionCheck.buildNumber  // "42"
+ * VersionCheck.packageName  // "com.example.app"
+ * VersionCheck.getCountry() // "US"
+ *
+ * const url = await VersionCheck.getStoreUrl();
+ * ```
+ */
+export const VersionCheck = {
+    /**
+     * The current app version string.
+     *
+     * Read from `CFBundleShortVersionString` on iOS and `versionName` on Android.
+     * Cached at module init, so repeated reads have zero native overhead.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.version // "1.2.0"
+     * ```
+     */
+    version,
+    /**
+     * The current build number.
+     *
+     * Read from `CFBundleVersion` on iOS and `versionCode` on Android.
+     * Cached at module init.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.buildNumber // "42"
+     * ```
+     */
+    buildNumber,
+    /**
+     * The app's unique identifier.
+     *
+     * This is the Bundle ID on iOS and the Application ID on Android.
+     * Cached at module init.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.packageName // "com.example.app"
+     * ```
+     */
+    packageName,
+    /**
+     * Where the app was installed from, or `undefined` for dev/sideloaded builds.
+     *
+     * - iOS: `"appstore"` | `"testflight"` | `undefined`
+     * - Android: `"playstore"` | `undefined`
+     *
+     * @example
+     * ```ts
+     * if (VersionCheck.installSource === "testflight") {
+     *   // running a TestFlight build
+     * }
+     * ```
+     */
+    installSource,
+    /**
+     * Returns the device's current 2-letter ISO country code.
+     *
+     * This is a synchronous Nitro call, no `await` needed.
+     *
+     * @example
+     * ```ts
+     * VersionCheck.getCountry() // "US"
+     * ```
+     */
+    getCountry,
+    /**
+     * Returns the App Store (iOS) or Play Store (Android) URL for this app.
+     *
+     * @example
+     * ```ts
+     * const url = await VersionCheck.getStoreUrl();
+     * Linking.openURL(url);
+     * ```
+     */
+    getStoreUrl,
+    /**
+     * Fetches the latest version of this app available in the store.
+     *
+     * Queries the iTunes API on iOS and the Play Store on Android.
+     *
+     * @example
+     * ```ts
+     * const latest = await VersionCheck.getLatestVersion(); // "1.3.0"
+     * ```
+     */
+    getLatestVersion,
+    /**
+     * Checks whether an app update is available by comparing the current
+     * version against the latest store version.
+     *
+     * @example
+     * ```ts
+     * if (await VersionCheck.needsUpdate()) {
+     *   const url = await VersionCheck.getStoreUrl();
+     *   Linking.openURL(url);
+     * }
+     * ```
+     */
+    needsUpdate: () => HybridVersionCheck.needsUpdate(),
+};
+export { compareVersions };

package/lib/semver.d.ts

@@ -0,0 +1,22 @@
+export type UpdateLevel = "major" | "minor" | "patch";
+/**
+ * Compares two version strings.
+ *
+ * @returns `-1` if `v1 < v2`, `0` if equal, `1` if `v1 > v2`
+ *
+ * @example
+ * ```ts
+ * compareVersions("1.2.0", "1.3.0") // -1
+ * compareVersions("2.0.0", "1.9.9") //  1
+ * compareVersions("1.0.0", "1.0.0") //  0
+ * ```
+ */
+export declare function compareVersions(v1: string, v2: string): -1 | 0 | 1;
+/**
+ * Checks whether `latest` is newer than `current` at the given granularity.
+ *
+ * - `"major"` — only returns `true` for major bumps (1.x → 2.x)
+ * - `"minor"` — returns `true` for major or minor bumps
+ * - `"patch"` — returns `true` for any version increase (default)
+ */
+export declare function isNewerVersion(current: string, latest: string, level?: UpdateLevel): boolean;

package/lib/semver.js

@@ -0,0 +1,51 @@
+function parseVersion(version) {
+    const parts = version.split(".");
+    return [Number(parts[0]) || 0, Number(parts[1]) || 0, Number(parts[2]) || 0];
+}
+/**
+ * Compares two version strings.
+ *
+ * @returns `-1` if `v1 < v2`, `0` if equal, `1` if `v1 > v2`
+ *
+ * @example
+ * ```ts
+ * compareVersions("1.2.0", "1.3.0") // -1
+ * compareVersions("2.0.0", "1.9.9") //  1
+ * compareVersions("1.0.0", "1.0.0") //  0
+ * ```
+ */
+export function compareVersions(v1, v2) {
+    const a = parseVersion(v1);
+    const b = parseVersion(v2);
+    for (let i = 0; i < 3; i++) {
+        if (a[i] > b[i])
+            return 1;
+        if (a[i] < b[i])
+            return -1;
+    }
+    return 0;
+}
+/**
+ * Checks whether `latest` is newer than `current` at the given granularity.
+ *
+ * - `"major"` — only returns `true` for major bumps (1.x → 2.x)
+ * - `"minor"` — returns `true` for major or minor bumps
+ * - `"patch"` — returns `true` for any version increase (default)
+ */
+export function isNewerVersion(current, latest, level = "patch") {
+    const [curMajor, curMinor, curPatch] = parseVersion(current);
+    const [latMajor, latMinor, latPatch] = parseVersion(latest);
+    if (latMajor > curMajor)
+        return true;
+    if (latMajor < curMajor)
+        return false;
+    if (level === "major")
+        return false;
+    if (latMinor > curMinor)
+        return true;
+    if (latMinor < curMinor)
+        return false;
+    if (level === "minor")
+        return false;
+    return latPatch > curPatch;
+}

package/lib/specs/Version.nitro.d.ts

@@ -0,0 +1,14 @@
+import type { HybridObject } from "react-native-nitro-modules";
+export interface VersionCheck extends HybridObject<{
+    ios: "swift";
+    android: "kotlin";
+}> {
+    readonly version: string;
+    readonly buildNumber: string;
+    readonly packageName: string;
+    readonly installSource: string | undefined;
+    getCountry(): string;
+    getStoreUrl(): Promise<string>;
+    getLatestVersion(): Promise<string>;
+    needsUpdate(): Promise<boolean>;
+}

package/lib/specs/Version.nitro.js

@@ -0,0 +1 @@
+export {};

package/lib/types/UpdateResult.d.ts

@@ -0,0 +1,6 @@
+export interface UpdateResult {
+    isNeeded: boolean;
+    storeUrl: string;
+    currentVersion: string;
+    latestVersion: string;
+}

package/lib/types/UpdateResult.js

@@ -0,0 +1 @@
+export {};

package/nitro.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://nitro.margelo.com/nitro.schema.json",
+  "cxxNamespace": ["nitroversioncheck"],
+  "ios": {
+    "iosModuleName": "NitroVersionCheck"
+  },
+  "android": {
+    "androidNamespace": ["nitroversioncheck"],
+    "androidCxxLibName": "NitroVersionCheck"
+  },
+  "autolinking": {
+    "VersionCheck": {
+      "swift": "HybridVersionCheck",
+      "kotlin": "HybridVersionCheck"
+    }
+  },
+  "ignorePaths": ["**/node_modules"]
+}

package/nitrogen/generated/.gitattributes

@@ -0,0 +1 @@
+** linguist-generated=true

package/nitrogen/generated/android/NitroVersionCheck+autolinking.cmake

@@ -0,0 +1,81 @@
+#
+# NitroVersionCheck+autolinking.cmake
+# This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+# https://github.com/mrousavy/nitro
+# Copyright © Marc Rousavy @ Margelo
+#
+
+# This is a CMake file that adds all files generated by Nitrogen
+# to the current CMake project.
+#
+# To use it, add this to your CMakeLists.txt:
+# ```cmake
+# include(${CMAKE_SOURCE_DIR}/../nitrogen/generated/android/NitroVersionCheck+autolinking.cmake)
+# ```
+
+# Define a flag to check if we are building properly
+add_definitions(-DBUILDING_NITROVERSIONCHECK_WITH_GENERATED_CMAKE_PROJECT)
+
+# Enable Raw Props parsing in react-native (for Nitro Views)
+add_definitions(-DRN_SERIALIZABLE_STATE)
+
+# Add all headers that were generated by Nitrogen
+include_directories(
+  "../nitrogen/generated/shared/c++"
+  "../nitrogen/generated/android/c++"
+  "../nitrogen/generated/android/"
+)
+
+# Add all .cpp sources that were generated by Nitrogen
+target_sources(
+  # CMake project name (Android C++ library name)
+  NitroVersionCheck PRIVATE
+  # Autolinking Setup
+  ../nitrogen/generated/android/NitroVersionCheckOnLoad.cpp
+  # Shared Nitrogen C++ sources
+  ../nitrogen/generated/shared/c++/HybridVersionCheckSpec.cpp
+  # Android-specific Nitrogen C++ sources
+  ../nitrogen/generated/android/c++/JHybridVersionCheckSpec.cpp
+)
+
+# From node_modules/react-native/ReactAndroid/cmake-utils/folly-flags.cmake
+# Used in node_modules/react-native/ReactAndroid/cmake-utils/ReactNative-application.cmake
+target_compile_definitions(
+  NitroVersionCheck PRIVATE
+  -DFOLLY_NO_CONFIG=1
+  -DFOLLY_HAVE_CLOCK_GETTIME=1
+  -DFOLLY_USE_LIBCPP=1
+  -DFOLLY_CFG_NO_COROUTINES=1
+  -DFOLLY_MOBILE=1
+  -DFOLLY_HAVE_RECVMMSG=1
+  -DFOLLY_HAVE_PTHREAD=1
+  # Once we target android-23 above, we can comment
+  # the following line. NDK uses GNU style stderror_r() after API 23.
+  -DFOLLY_HAVE_XSI_STRERROR_R=1
+)
+
+# Add all libraries required by the generated specs
+find_package(fbjni REQUIRED) # <-- Used for communication between Java <-> C++
+find_package(ReactAndroid REQUIRED) # <-- Used to set up React Native bindings (e.g. CallInvoker/TurboModule)
+find_package(react-native-nitro-modules REQUIRED) # <-- Used to create all HybridObjects and use the Nitro core library
+
+# Link all libraries together
+target_link_libraries(
+        NitroVersionCheck
+        fbjni::fbjni                              # <-- Facebook C++ JNI helpers
+        ReactAndroid::jsi                         # <-- RN: JSI
+        react-native-nitro-modules::NitroModules  # <-- NitroModules Core :)
+)
+
+# Link react-native (different prefab between RN 0.75 and RN 0.76)
+if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
+    target_link_libraries(
+        NitroVersionCheck
+        ReactAndroid::reactnative                 # <-- RN: Native Modules umbrella prefab
+    )
+else()
+    target_link_libraries(
+        NitroVersionCheck
+        ReactAndroid::react_nativemodule_core     # <-- RN: TurboModules Core
+    )
+endif()

package/nitrogen/generated/android/NitroVersionCheck+autolinking.gradle

@@ -0,0 +1,27 @@
+///
+/// NitroVersionCheck+autolinking.gradle
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+/// This is a Gradle file that adds all files generated by Nitrogen
+/// to the current Gradle project.
+///
+/// To use it, add this to your build.gradle:
+/// ```gradle
+/// apply from: '../nitrogen/generated/android/NitroVersionCheck+autolinking.gradle'
+/// ```
+
+logger.warn("[NitroModules] 🔥 NitroVersionCheck is boosted by nitro!")
+
+android {
+  sourceSets {
+    main {
+      java.srcDirs += [
+        // Nitrogen files
+        "${project.projectDir}/../nitrogen/generated/android/kotlin"
+      ]
+    }
+  }
+}

package/nitrogen/generated/android/NitroVersionCheckOnLoad.cpp

@@ -0,0 +1,47 @@
+///
+/// NitroVersionCheckOnLoad.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#ifndef BUILDING_NITROVERSIONCHECK_WITH_GENERATED_CMAKE_PROJECT
+#error NitroVersionCheckOnLoad.cpp is not being built with the autogenerated CMakeLists.txt project. Is a different CMakeLists.txt building this?
+#endif
+
+#include "NitroVersionCheckOnLoad.hpp"
+
+#include <jni.h>
+#include <fbjni/fbjni.h>
+#include <NitroModules/HybridObjectRegistry.hpp>
+
+#include "JHybridVersionCheckSpec.hpp"
+#include <NitroModules/DefaultConstructableObject.hpp>
+
+namespace margelo::nitro::nitroversioncheck {
+
+int initialize(JavaVM* vm) {
+  return facebook::jni::initialize(vm, []() {
+    ::margelo::nitro::nitroversioncheck::registerAllNatives();
+  });
+}
+
+void registerAllNatives() {
+  using namespace margelo::nitro;
+  using namespace margelo::nitro::nitroversioncheck;
+
+  // Register native JNI methods
+  margelo::nitro::nitroversioncheck::JHybridVersionCheckSpec::registerNatives();
+
+  // Register Nitro Hybrid Objects
+  HybridObjectRegistry::registerHybridObjectConstructor(
+    "VersionCheck",
+    []() -> std::shared_ptr<HybridObject> {
+      static DefaultConstructableObject<JHybridVersionCheckSpec::javaobject> object("com/margelo/nitro/nitroversioncheck/HybridVersionCheck");
+      auto instance = object.create();
+      return instance->cthis()->shared();
+    }
+  );
+}
+
+} // namespace margelo::nitro::nitroversioncheck

package/nitrogen/generated/android/NitroVersionCheckOnLoad.hpp

@@ -0,0 +1,34 @@
+///
+/// NitroVersionCheckOnLoad.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include <jni.h>
+#include <functional>
+#include <NitroModules/NitroDefines.hpp>
+
+namespace margelo::nitro::nitroversioncheck {
+
+  [[deprecated("Use registerNatives() instead.")]]
+  int initialize(JavaVM* vm);
+
+  /**
+   * Register the native (C++) part of NitroVersionCheck, and autolinks all Hybrid Objects.
+   * Call this in your `JNI_OnLoad` function (probably inside `cpp-adapter.cpp`),
+   * inside a `facebook::jni::initialize(vm, ...)` call.
+   * Example:
+   * ```cpp (cpp-adapter.cpp)
+   * JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void*) {
+   *   return facebook::jni::initialize(vm, []() {
+   *     // register all NitroVersionCheck HybridObjects
+   *     margelo::nitro::nitroversioncheck::registerNatives();
+   *     // any other custom registrations go here.
+   *   });
+   * }
+   * ```
+   */
+  void registerAllNatives();
+
+} // namespace margelo::nitro::nitroversioncheck