@thravic/react-native 0.0.0-stage → 0.2.0

package/dist/index.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Thravic = exports.assignVariant = exports.ThravicClient = void 0;
+exports.useVariant = useVariant;
+const react_1 = require("react");
+const client_1 = require("./client");
+const react_native_1 = require("./react-native");
+var client_2 = require("./client");
+Object.defineProperty(exports, "ThravicClient", { enumerable: true, get: function () { return client_2.ThravicClient; } });
+Object.defineProperty(exports, "assignVariant", { enumerable: true, get: function () { return client_2.assignVariant; } });
+/**
+ * Thravic for React Native.
+ *
+ * ```ts
+ * import { Thravic } from '@thravic/react-native';
+ *
+ * Thravic.init('TF-1A2B3C4D', { appVersion: '1.4.0', bundleId: 'com.acme.shop' });
+ * Thravic.trackNavigation(navigationRef);     // screen views, automatically
+ * Thravic.track('purchase', { amount: 49 });  // your own events
+ * const version = await Thravic.variant('new-paywall');  // A/B tests
+ * ```
+ */
+exports.Thravic = new client_1.ThravicClient(react_native_1.reactNativeEnvironment);
+/**
+ * The version of A/B test `key` to show, for use in a component: `undefined`
+ * while it loads, then a version id or null for the original.
+ *
+ * ```tsx
+ * const version = useVariant('new-paywall');
+ * if (version === undefined) return null;
+ * return version === 'b' ? <NewPaywall /> : <Paywall />;
+ * ```
+ */
+function useVariant(key) {
+    const [version, setVersion] = (0, react_1.useState)(undefined);
+    (0, react_1.useEffect)(() => {
+        let live = true;
+        setVersion(undefined);
+        void exports.Thravic.variant(key).then((id) => {
+            if (live)
+                setVersion(id);
+        });
+        return () => {
+            live = false;
+        };
+    }, [key]);
+    return version;
+}
+exports.default = exports.Thravic;

package/dist/react-native.d.ts

@@ -0,0 +1,2 @@
+import type { Environment } from './types';
+export declare const reactNativeEnvironment: Environment;

package/dist/react-native.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reactNativeEnvironment = void 0;
+const async_storage_1 = __importDefault(require("@react-native-async-storage/async-storage"));
+const react_native_1 = require("react-native");
+function language() {
+    try {
+        return Intl.DateTimeFormat().resolvedOptions().locale;
+    }
+    catch {
+        return undefined;
+    }
+}
+/** What React Native itself knows about the device, with no native module to install. */
+function device() {
+    const constants = (react_native_1.Platform.constants || {});
+    const screen = react_native_1.Dimensions.get('screen');
+    const base = {
+        screenWidth: Math.round(screen.width),
+        screenHeight: Math.round(screen.height),
+        language: language(),
+    };
+    if (react_native_1.Platform.OS === 'android') {
+        return {
+            ...base,
+            os: 'Android',
+            // `Platform.Version` is the API level on Android; Release is "14".
+            osVersion: constants.Release || String(react_native_1.Platform.Version),
+            deviceModel: [constants.Manufacturer, constants.Model].filter(Boolean).join(' ') || undefined,
+        };
+    }
+    if (react_native_1.Platform.OS === 'ios') {
+        return {
+            ...base,
+            os: 'iOS',
+            osVersion: String(react_native_1.Platform.Version),
+            // iOS does not expose the model without a native module.
+            deviceModel: constants.interfaceIdiom === 'pad' ? 'iPad' : 'iPhone',
+        };
+    }
+    return { ...base, os: react_native_1.Platform.OS };
+}
+exports.reactNativeEnvironment = {
+    storage: async_storage_1.default,
+    device,
+    fetch: (...args) => fetch(...args),
+    now: () => Date.now(),
+    onAppStateChange(listener) {
+        // 'inactive' is iOS passing through (Control Center, a call banner): not a
+        // departure. Only 'background' ends the visit and only 'active' resumes it.
+        const subscription = react_native_1.AppState.addEventListener('change', (state) => {
+            if (state === 'active')
+                listener(true);
+            else if (state === 'background')
+                listener(false);
+        });
+        return () => subscription.remove();
+    },
+    setInterval: (fn, ms) => setInterval(fn, ms),
+    clearInterval: (handle) => clearInterval(handle),
+    setTimeout: (fn, ms) => setTimeout(fn, ms),
+    log: (...args) => console.warn(...args),
+};

package/dist/types.d.ts

@@ -0,0 +1,86 @@
+/** Options for `Thravic.init`. */
+export interface ThravicOptions {
+    /** Where the Thravic API lives. The dashboard's install snippet fills this in. */
+    apiUrl?: string;
+    /** Your app's version, e.g. `Application.nativeApplicationVersion` (Expo) or
+     *  `DeviceInfo.getVersion()` (react-native-device-info). Shown under Versions. */
+    appVersion?: string;
+    /** Your app's bundle ID, used as the host of screen URLs (`app://<bundleId>/Home`). */
+    bundleId?: string;
+    /** Minutes in the background after which the next open starts a new session. */
+    sessionTimeoutMinutes?: number;
+    /** Seconds between automatic sends of queued events. */
+    flushIntervalSeconds?: number;
+    /** Log what the SDK does to the console. */
+    debug?: boolean;
+}
+/** One event as `POST /api/collect/{trackingId}/batch` takes it. */
+export interface CollectEvent {
+    eventId: string;
+    type: 'pageview' | 'custom' | 'session_end';
+    url: string;
+    visitorId: string;
+    sessionId: string;
+    screenWidth?: number;
+    screenHeight?: number;
+    language?: string;
+    os?: string;
+    osVersion?: string;
+    appVersion?: string;
+    deviceModel?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    data?: Record<string, unknown>;
+}
+/** A running A/B test, as `GET /api/collect/{trackingId}/config` lists it. */
+export interface Experiment {
+    id: string;
+    /** What the app asks for: `Thravic.variant(key)`. */
+    key: string;
+    /** Share of users in the test, 0–100. */
+    traffic: number;
+    variants: Array<{
+        id: string;
+        weight: number;
+    }>;
+}
+/** What the device reports about itself. */
+export interface DeviceInfo {
+    os: string;
+    osVersion?: string;
+    deviceModel?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+    language?: string;
+}
+/** Key-value storage that survives app restarts (AsyncStorage's shape). */
+export interface Storage {
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    removeItem(key: string): Promise<void>;
+}
+/** Everything the client needs from its platform, so it can run outside React Native. */
+export interface Environment {
+    storage: Storage;
+    device: () => DeviceInfo;
+    fetch: typeof fetch;
+    now: () => number;
+    /** Calls `listener(true)` when the app comes to the foreground and `listener(false)`
+     *  when it leaves; returns an unsubscribe. */
+    onAppStateChange: (listener: (active: boolean) => void) => () => void;
+    setInterval: (fn: () => void, ms: number) => unknown;
+    clearInterval: (handle: unknown) => void;
+    setTimeout: (fn: () => void, ms: number) => unknown;
+    log: (...args: unknown[]) => void;
+}
+/** The parts of a React Navigation container ref the screen tracker uses. Expo
+ *  Router's `useNavigationContainerRef()` returns one too. */
+export interface NavigationRefLike {
+    addListener(event: 'state', listener: () => void): () => void;
+    getCurrentRoute(): {
+        name: string;
+        params?: object;
+    } | undefined;
+    isReady?(): boolean;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@thravic/react-native",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Thravic analytics for React Native and Expo apps: screens, sessions, custom events and A/B tests.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "react-native": "src/index.ts",
+  "files": [
+    "dist",
+    "src",
+    "!src/**/__tests__",
+    "README.md"
+  ],
+  "keywords": [
+    "analytics",
+    "react-native",
+    "expo",
+    "thravic"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "peerDependencies": {
+    "@react-native-async-storage/async-storage": ">=1.17.0",
+    "react": ">=17.0.0",
+    "react-native": ">=0.70.0"
+  },
+  "devDependencies": {
+    "@react-native-async-storage/async-storage": "^2.1.0",
+    "@types/react": "^18.3.31",
+    "react-native": "^0.76.0",
+    "typescript": "^5.6.0",
+    "vitest": "^4.0.18"
+  }
+}