react-native-nitro-version-check 0.0.1

package/nitrogen/generated/shared/c++/HybridVersionCheckSpec.hpp

@@ -0,0 +1,70 @@
+///
+/// HybridVersionCheckSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <string>
+#include <optional>
+#include <NitroModules/Promise.hpp>
+
+namespace margelo::nitro::nitroversioncheck {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `VersionCheck`
+   * Inherit this class to create instances of `HybridVersionCheckSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridVersionCheck: public HybridVersionCheckSpec {
+   * public:
+   *   HybridVersionCheck(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridVersionCheckSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridVersionCheckSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridVersionCheckSpec() override = default;
+
+    public:
+      // Properties
+      virtual std::string getVersion() = 0;
+      virtual std::string getBuildNumber() = 0;
+      virtual std::string getPackageName() = 0;
+      virtual std::optional<std::string> getInstallSource() = 0;
+
+    public:
+      // Methods
+      virtual std::string getCountry() = 0;
+      virtual std::shared_ptr<Promise<std::string>> getStoreUrl() = 0;
+      virtual std::shared_ptr<Promise<std::string>> getLatestVersion() = 0;
+      virtual std::shared_ptr<Promise<bool>> needsUpdate() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "VersionCheck";
+  };
+
+} // namespace margelo::nitro::nitroversioncheck

package/package.json

@@ -0,0 +1,116 @@
+{
+  "name": "react-native-nitro-version-check",
+  "version": "0.0.1",
+  "description": "react-native-nitro-version-check",
+  "main": "lib/index",
+  "module": "lib/index",
+  "types": "lib/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
+    "android/build.gradle",
+    "android/gradle.properties",
+    "android/fix-prefab.gradle",
+    "android/CMakeLists.txt",
+    "android/src",
+    "cpp",
+    "ios/**/*.h",
+    "ios/**/*.m",
+    "ios/**/*.mm",
+    "ios/**/*.cpp",
+    "ios/**/*.swift",
+    "app.plugin.js",
+    "nitro.json",
+    "*.podspec",
+    "README.md"
+  ],
+  "scripts": {
+    "prepack": "cp ../README.md ./README.md",
+    "postpack": "rm ./README.md",
+    "release": "release-it",
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
+    "specs": "tsc --noEmit false && nitrogen --logLevel=\"debug\"",
+    "start": "cd ../example && bun start",
+    "pods": "cd ../example && cd ios && bundle exec pod install",
+    "bootstrap": "cd .. && bun install && cd example && bun pods",
+    "clean": "rm -rf android/build node_modules/**/android/build lib",
+    "clean:ios": "cd ../example && rm -rf ios/build ios/Pods ios/DerivedData",
+    "clean:android": "cd ../example && rm -rf android/build android/app/build android/.gradle",
+    "clean:all": "bun clean && bun clean:ios && bun clean:android && rm -rf node_modules ../example/node_modules"
+  },
+  "keywords": [
+    "react-native",
+    "nitro",
+    "version-check",
+    "version",
+    "react-native-nitro-version-check",
+    "react-native-version",
+    "react-native-version-check",
+    "expo",
+    "expo-version-check",
+    "expo-version",
+    "nitro-modules",
+    "nitro-modules-version-check",
+    "nitro-modules-version",
+    "app store version",
+    "play store version",
+    "market version"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlshehriAli0/react-native-nitro-version-check.git"
+  },
+  "author": "AlshehriAli0 (https://github.com/AlshehriAli0)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/AlshehriAli0/react-native-nitro-version-check/issues"
+  },
+  "homepage": "https://github.com/AlshehriAli0/react-native-nitro-version-check#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release v${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "hooks": {
+      "before:init": "bun run build"
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "conventionalcommits",
+        "infile": "../CHANGELOG.md"
+      }
+    }
+  },
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^10.0.5",
+    "@types/react": "^19.1.03",
+    "nitrogen": "*",
+    "react": "19.2.0",
+    "react-native": "0.83.0",
+    "react-native-nitro-modules": "*",
+    "release-it": "^19.2.4",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "*"
+  }
+}

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {},
+    },
+  },
+};

package/src/index.ts

@@ -0,0 +1,185 @@
+import { NitroModules } from "react-native-nitro-modules";
+import type { UpdateLevel } from "./semver";
+import { compareVersions, isNewerVersion } from "./semver";
+import type { VersionCheck as VersionCheckType } from "./specs/Version.nitro";
+
+const HybridVersionCheck = NitroModules.createHybridObject<VersionCheckType>("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?: { level?: UpdateLevel }): Promise<boolean> => {
+  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(),
+} as const;
+
+export { compareVersions };
+export type { UpdateLevel };

package/src/semver.ts

@@ -0,0 +1,54 @@
+export type UpdateLevel = "major" | "minor" | "patch";
+
+type SemVer = [major: number, minor: number, patch: number];
+
+function parseVersion(version: string): SemVer {
+  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: string, v2: string): -1 | 0 | 1 {
+  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: string, latest: string, level: UpdateLevel = "patch"): boolean {
+  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/src/specs/Version.nitro.ts

@@ -0,0 +1,16 @@
+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>;
+}