@milkinteractive/react-native-age-range 1.0.0

package/package.json

@@ -0,0 +1,198 @@
+{
+  "name": "@milkinteractive/react-native-age-range",
+  "version": "1.0.0",
+  "description": "A React Native Native Module (Legacy Architecture) that provides access to store-level age signals, including Android Play Age Range and iOS Declared Age, to assist with state-level age verification compliance (e.g., Texas).",
+  "source": "./src/index.tsx",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/typescript/src/index.d.ts",
+      "import": "./lib/module/index.js",
+      "require": "./lib/commonjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace @milkinteractive/react-native-age-range-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "age-verification",
+    "age-gate",
+    "texas-sb2420",
+    "parental-controls",
+    "coppa",
+    "compliance",
+    "google-play-age-signals",
+    "declared-age-range",
+    "app-store",
+    "child-safety",
+    "privacy",
+    "age-appropriate"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/milkinteractive/react-native-age-range.git"
+  },
+  "author": "Naga sai charan gubba <nagasaicharan7@gmail.com> (https://github.com/nagasaicharan)",
+  "contributors": [
+    "Christoph Eck <christoph@milkinteractive.ch>"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/milkinteractive/react-native-age-range/issues"
+  },
+  "homepage": "https://github.com/milkinteractive/react-native-age-range#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.6.0",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native/eslint-config": "^0.73.1",
+    "@release-it/conventional-changelog": "^9.0.2",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^19.1.1",
+    "commitlint": "^19.6.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": "19.1.1",
+    "react-native": "0.82.1",
+    "react-native-builder-bob": "0.38.0",
+    "release-it": "^17.10.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "rules": {
+      "react/react-in-jsx-scope": "off",
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "type": "legacy-module",
+    "languages": "kotlin-swift",
+    "version": "0.48.9"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,234 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+  `The package '@milkinteractive/react-native-age-range' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n';
+
+const StoreAgeSignalsNativeModules = NativeModules.StoreAgeSignalsNativeModules
+  ? NativeModules.StoreAgeSignalsNativeModules
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+// Android Types
+
+/**
+ * User verification status from Google Play Age Signals API.
+ * - OVER_AGE: User is verified as an adult (18+)
+ * - UNDER_AGE: User has a supervised account (child/teen)
+ * - UNDER_AGE_APPROVAL_PENDING: Supervised user, parent hasn't approved pending significant changes
+ * - UNDER_AGE_APPROVAL_DENIED: Supervised user, parent denied approval for significant changes
+ * - UNKNOWN: Status could not be determined
+ */
+export type AndroidUserStatus =
+  | 'OVER_AGE'
+  | 'UNDER_AGE'
+  | 'UNDER_AGE_APPROVAL_PENDING'
+  | 'UNDER_AGE_APPROVAL_DENIED'
+  | 'UNKNOWN';
+
+export interface PlayAgeRangeStatusResult {
+  installId: string | null;
+  userStatus: AndroidUserStatus | null;
+  error: string | null;
+  /**
+   * The (inclusive) lower bound of a supervised user's age range.
+   * 0 to 18.
+   */
+  ageLower?: number | null;
+  /**
+   * The (inclusive) upper bound of a supervised user's age range.
+   * 2 to 18.
+   */
+  ageUpper?: number | null;
+  /**
+   * The effective from date of the most recent significant change that was approved.
+   * ISO string format.
+   */
+  mostRecentApprovalDate?: string | null;
+  /**
+   * The numerical error code if the request failed.
+   * e.g., -1 (API_NOT_AVAILABLE), -2 (PLAY_STORE_NOT_FOUND), etc.
+   */
+  errorCode?: number | null;
+}
+
+// iOS Types
+
+/**
+ * How the age range was declared/verified.
+ * - selfDeclared: User declared their own age
+ * - guardianDeclared: Guardian set the age (for children in iCloud family)
+ * - checkedByOtherMethod: Verified by another method
+ * - guardianCheckedByOtherMethod: Guardian verified by another method
+ * - governmentIDChecked: Verified via government ID
+ * - guardianGovernmentIDChecked: Guardian verified via government ID
+ * - paymentChecked: Verified via payment method (credit card)
+ * - guardianPaymentChecked: Guardian verified via payment method
+ */
+export type AgeRangeDeclarationType =
+  | 'selfDeclared'
+  | 'guardianDeclared'
+  | 'checkedByOtherMethod'
+  | 'guardianCheckedByOtherMethod'
+  | 'governmentIDChecked'
+  | 'guardianGovernmentIDChecked'
+  | 'paymentChecked'
+  | 'guardianPaymentChecked'
+  | 'unknown';
+
+/**
+ * Parental control settings active for the user.
+ */
+export interface ParentalControlsInfo {
+  /** Whether communication limits are enabled (e.g., contact restrictions) */
+  communicationLimits?: boolean;
+  /** Whether significant app changes require parental approval */
+  significantAppChangeApprovalRequired?: boolean;
+}
+
+export interface DeclaredAgeRangeResult {
+  status: 'sharing' | 'declined' | null;
+  lowerBound: number | null;
+  upperBound: number | null;
+  /**
+   * How the age range was declared/verified (iOS 26+).
+   * For children: always 'guardianDeclared'
+   * For teens in iCloud family: 'guardianDeclared'
+   * For teens not in family: 'selfDeclared'
+   * For adults: 'selfDeclared'
+   */
+  ageRangeDeclaration?: AgeRangeDeclarationType | null;
+  /**
+   * Parental control settings active for the user (if under age of majority).
+   */
+  parentalControls?: ParentalControlsInfo | null;
+  error: string | null;
+}
+
+// Eligibility Result
+export interface DeclaredAgeEligibilityResult {
+  isEligible: boolean;
+  error: string | null;
+}
+
+export interface AndroidAgeRangeConfig {
+  /**
+   * Enable mock mode to simulate results without calling Google Play API.
+   * Useful for development and testing.
+   */
+  isMock?: boolean;
+  /**
+   * The status to return when isMock is true.
+   * Default: 'OVER_AGE'
+   */
+  mockStatus?: AndroidUserStatus;
+  /**
+   * (Mock Only) Lower bound of the age range (e.g. 13).
+   * Relevant when mockStatus is 'UNDER_AGE' (Supervised).
+   */
+  mockAgeLower?: number;
+  /**
+   * (Mock Only) Upper bound of the age range (e.g. 17).
+   * Relevant when mockStatus is 'UNDER_AGE' (Supervised).
+   */
+  mockAgeUpper?: number;
+  /**
+   * (Mock Only) The numerical error code to throw.
+   * e.g., -1 for API_NOT_AVAILABLE.
+   */
+  mockErrorCode?: number;
+  /**
+   * (Mock Only) ISO date string for most recent approval.
+   */
+  mockMostRecentApprovalDate?: string;
+}
+
+/**
+ * Retrieves the age range declaration status from Google Play's Age Signals API.
+ * @platform android
+ */
+export function getAndroidPlayAgeRangeStatus(
+  config?: AndroidAgeRangeConfig
+): Promise<PlayAgeRangeStatusResult> {
+  if (Platform.OS !== 'android') {
+    return Promise.resolve({
+      installId: null,
+      userStatus: null,
+      error: 'This method is only available on Android',
+    });
+  }
+  return StoreAgeSignalsNativeModules.getAndroidPlayAgeRangeStatus(
+    config || {}
+  );
+}
+
+/**
+ * Requests age range declaration from iOS Declared Age Range API.
+ * @platform ios
+ * @param firstThresholdAge First age threshold (e.g., 13)
+ * @param secondThresholdAge Second age threshold (e.g., 17)
+ * @param thirdThresholdAge Third age threshold (e.g., 21)
+ */
+export function requestIOSDeclaredAgeRange(
+  firstThresholdAge: number,
+  secondThresholdAge: number,
+  thirdThresholdAge: number
+): Promise<DeclaredAgeRangeResult> {
+  if (Platform.OS !== 'ios') {
+    return Promise.resolve({
+      status: null,
+      lowerBound: null,
+      upperBound: null,
+      ageRangeDeclaration: null,
+      parentalControls: null,
+      error: 'This method is only available on iOS',
+    });
+  }
+  return StoreAgeSignalsNativeModules.requestIOSDeclaredAgeRange(
+    firstThresholdAge,
+    secondThresholdAge,
+    thirdThresholdAge
+  );
+}
+
+/**
+ * Checks if the current user is eligible for age verification features on iOS.
+ * This determines if age checks need to be applied (e.g., user is in an applicable region like Texas).
+ * @platform ios
+ * @returns Promise<DeclaredAgeEligibilityResult> - Object containing isEligible boolean and error string
+ * @remarks Requires iOS 26.0+. Returns isEligible: false with error message if not available.
+ */
+export function isIOSEligibleForAgeFeatures(): Promise<DeclaredAgeEligibilityResult> {
+  if (Platform.OS !== 'ios') {
+    return Promise.resolve({
+      isEligible: false,
+      error: 'This method is only available on iOS',
+    });
+  }
+  return StoreAgeSignalsNativeModules.isEligibleForAgeFeatures();
+}
+
+/**
+ * Checks if the current user is eligible for age verification features on Android.
+ * This determines if age checks need to be applied (e.g., user is in an applicable region like Texas, Utah, Louisiana).
+ * @platform android
+ * @returns Promise<DeclaredAgeEligibilityResult> - Object containing isEligible boolean and error string
+ * @remarks Makes a lightweight API call to determine eligibility. Returns isEligible: false with error message if not available.
+ */
+export function isAndroidEligibleForAgeFeatures(): Promise<DeclaredAgeEligibilityResult> {
+  if (Platform.OS !== 'android') {
+    return Promise.resolve({
+      isEligible: false,
+      error: 'This method is only available on Android',
+    });
+  }
+  return StoreAgeSignalsNativeModules.isEligibleForAgeFeatures();
+}