react-native-uxrate 0.2.1 → 0.3.0

package/android/build.gradle

@@ -39,5 +39,5 @@ repositories {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.uxrate:uxrate-sdk:[0.2.0, 0.3.0)'
+    implementation 'com.uxrate:uxrate-sdk:[0.3.0, 0.4.0)'
 }

package/android/src/main/java/com/uxrate/reactnative/UXRateModule.kt

@@ -3,18 +3,10 @@ package com.uxrate.reactnative
 import android.app.Application
 import com.facebook.react.bridge.*
 import com.uxrate.sdk.UXRate
+import com.uxrate.sdk.models.Environment
 import com.uxrate.sdk.models.OverlapStrategy
 import com.uxrate.sdk.models.SDKTheme
 
-/**
- * React Native native module for the UXRate Android SDK.
- *
- * Exposes the same 4 methods as the iOS module:
- * - configure(apiKey, options)
- * - identify(userId, properties)
- * - track(event)
- * - setScreen(name)
- */
 class UXRateModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(reactContext) {
 
     override fun getName(): String = "UXRate"
@@ -32,9 +24,16 @@ class UXRateModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
                 options.getBoolean("autoTrackScreens")
             } else false
 
-            val useMock = if (options.hasKey("useMockService")) {
-                options.getBoolean("useMockService")
-            } else false
+            val environment = Environment.from(
+                if (options.hasKey("environment")) options.getString("environment") else null
+            )
+
+            val mockScreens: List<String>? = if (options.hasKey("mockScreens") && !options.isNull("mockScreens")) {
+                val array = options.getArray("mockScreens")
+                if (array != null) {
+                    (0 until array.size()).map { array.getString(it) }
+                } else null
+            } else null
 
             val strategy = if (options.hasKey("overlapStrategy")) {
                 OverlapStrategy.from(options.getString("overlapStrategy"))
@@ -48,8 +47,9 @@ class UXRateModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
                 UXRate.configure(
                     application = application,
                     apiKey = apiKey,
+                    environment = environment,
                     autoTrackScreens = autoTrack,
-                    useMockService = useMock,
+                    mockScreens = mockScreens,
                     overlapStrategy = strategy,
                     theme = theme
                 )
@@ -69,7 +69,6 @@ class UXRateModule(reactContext: ReactApplicationContext) : ReactContextBaseJava
                 val key = iterator.nextKey()
                 props[key] = properties.getString(key) ?: ""
             }
-
             UiThreadUtil.runOnUiThread {
                 UXRate.identify(userId, props)
                 promise.resolve(null)

package/docs/public/api-reference.md

@@ -24,16 +24,18 @@ All methods return `Promise<void>`.
 ```ts
 interface ConfigureOptions {
   apiKey: string;
-  autoTrackScreens?: boolean; // default: false
-  useMockService?: boolean;   // default: false
+  environment?: 'production' | 'development' | 'local' | 'mock';
+  autoTrackScreens?: boolean;
+  mockScreens?: string[];
 }
 ```
 
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `apiKey` | `string` | Yes | Your UXRate API key. |
+| `environment` | `string` | No | Backend environment: `'production'` (default), `'development'`, `'local'`, or `'mock'`. |
 | `autoTrackScreens` | `boolean` | No | Enable native auto screen tracking. In React Native apps manual `setScreen` calls are preferred. |
-| `useMockService` | `boolean` | No | Use the built-in mock backend for local testing. |
+| `mockScreens` | `string[]` | No | Screen names for mock survey targeting. Only used when environment is `'mock'`. |
 
 ---
 

package/docs/public/event-tracking.md

@@ -1,24 +1,19 @@
-# Event Tracking
+# Event Tracking — React Native
 
-## Custom events
+> For concepts and best practices, see [Event Tracking](Event-Tracking).
 
-Use `UXRate.track` to record events that can trigger surveys:
+## Custom Events
 
 ```tsx
 UXRate.track({ event: 'purchase_complete' });
 UXRate.track({ event: 'onboarding_finished' });
 ```
 
-Event names are arbitrary strings. Define matching trigger rules in the UXRate
-dashboard to show a survey when a specific event fires.
+## Screen Tracking
 
-## Screen tracking
+React Native runs inside a single native view, so auto-track sees only one screen. Report screens manually.
 
-React Native apps run inside a single native ViewController (iOS) or Activity
-(Android), so the native auto-track feature sees only one screen. You should
-report screens manually using `setScreen`.
-
-### Per-screen tracking with `useFocusEffect`
+### Per-screen with `useFocusEffect`
 
 ```tsx
 import { useFocusEffect } from '@react-navigation/native';
@@ -33,13 +28,9 @@ function SettingsScreen() {
 }
 ```
 
-### Global tracking with React Navigation
-
-You can report every navigation change from a single place:
+### Global with React Navigation
 
 ```tsx
-import { NavigationContainer } from '@react-navigation/native';
-
 <NavigationContainer
   onStateChange={(state) => {
     const route = state?.routes[state.index];
@@ -49,12 +40,3 @@ import { NavigationContainer } from '@react-navigation/native';
   {/* screens */}
 </NavigationContainer>
 ```
-
-See the [React Navigation integration tutorial](../tutorials/react-navigation-integration.md) for a full walkthrough.
-
-## Best practices
-
-- Keep event names short and consistent (e.g. `snake_case`).
-- Report screens as early as possible so survey targeting is accurate.
-- Avoid tracking high-frequency events (e.g. scroll positions) -- they add
-  noise without improving targeting.

package/docs/public/quick-start.md

@@ -6,11 +6,19 @@ Get UXRate running in your React Native app in four steps.
 
 Call `configure` once at app startup, typically in your root `App.tsx`:
 
+**Quick test with mock surveys (no backend needed):**
+
+```tsx
+UXRate.configure({ apiKey: 'YOUR_API_KEY', environment: 'mock' });
+```
+
+**Production:**
+
 ```tsx
 import { UXRate } from 'react-native-uxrate';
 
 useEffect(() => {
-  UXRate.configure({ apiKey: 'YOUR_API_KEY' });
+  UXRate.configure({ apiKey: 'uxr_your_api_key' });
 }, []);
 ```
 

package/docs/public/replay-config.md

@@ -1,33 +1,19 @@
-# Session Replay Configuration
+# Session Replay — React Native
 
-## Overview
+> For concepts, quality presets, and capture modes, see [Session Replay](Session-Replay).
 
-Session replay is handled entirely by the native UXRate SDKs (iOS and Android).
-The React Native module does not expose separate replay APIs -- replay capture
-is started automatically by the native SDK when it is enabled for your project.
+Replay is handled entirely by the native UXRate SDKs (iOS and Android). The React Native module does not expose separate replay APIs.
 
-## Enabling replay
+## Enabling Replay
 
 1. Open the UXRate dashboard.
 2. Navigate to your project settings.
 3. Toggle **Session Replay** on.
-4. Configure the desired sampling rate and privacy masking options.
+4. Configure sampling rate and privacy masking.
 
-Once enabled on the dashboard the native SDKs begin capturing replay data
-without any additional code changes in your React Native app.
-
-## Privacy masking
-
-Sensitive views can be masked from replays. Masking rules are configured in
-the UXRate dashboard and applied at the native layer. Because React Native
-renders through native view hierarchies, the standard masking rules apply
-to RN-rendered content as well.
+No additional code changes are needed in your React Native app.
 
 ## Troubleshooting
 
-- **Replay not appearing**: Make sure the native SDK versions match the
-  minimum required for replay support (check the native SDK changelogs).
-- **Missing frames**: Replay capture runs at a reduced frame rate to minimise
-  performance impact. Short interactions may not produce visible frames.
-- **Large payload warnings**: If your app has complex view hierarchies,
-  consider increasing the masking scope to reduce payload size.
+- **Replay not appearing**: Check native SDK versions match minimum required for replay support.
+- **Missing frames**: Replay runs at a reduced frame rate — short interactions may not produce visible frames.

package/example/App.tsx

@@ -13,14 +13,11 @@ const Stack = createNativeStackNavigator();
 // ------------------------------------------------------------------
 function App(): React.JSX.Element {
   useEffect(() => {
+    // Mock environment — works immediately without dashboard setup.
+    // Switch to 'production' with your real API key for live surveys.
     UXRate.configure({
       apiKey: 'YOUR_API_KEY',
-      useMockService: true, // set false in production
-    });
-
-    UXRate.identify({
-      userId: 'demo-user-1',
-      properties: { plan: 'trial' },
+      environment: 'mock',
     });
   }, []);
 

package/index.d.ts

@@ -1,7 +1,8 @@
 export interface ConfigureOptions {
   apiKey: string;
+  environment?: 'production' | 'development' | 'local' | 'mock';
   autoTrackScreens?: boolean;
-  useMockService?: boolean;
+  mockScreens?: string[];
 }
 
 export interface IdentifyOptions {

package/index.js

@@ -6,7 +6,6 @@ const LINKING_ERROR =
     ? `run \`pod install\` in your iOS project directory.\n`
     : `rebuild your Android project.\n`);
 
-// Throw a helpful error if the native module is not linked
 const NativeUXRate = NativeModules.UXRate
   ? NativeModules.UXRate
   : new Proxy(
@@ -18,73 +17,31 @@ const NativeUXRate = NativeModules.UXRate
       }
     );
 
-/**
- * React Native bridge for the UXRate SDK (iOS & Android).
- *
- * @example
- * // Minimal setup (App.js / App.tsx)
- * import { UXRate } from 'react-native-uxrate';
- *
- * useEffect(() => {
- *   UXRate.configure({ apiKey: 'uxr_xxx' });
- * }, []);
- *
- * @example
- * // Manual screen tracking
- * useFocusEffect(() => {
- *   UXRate.setScreen('Home');
- * });
- */
 export const UXRate = {
   /**
    * Initialise the UXRate SDK. Call once at app startup.
    *
    * @param {string} apiKey - Your UXRate API key (required).
-   * @param {boolean} [autoTrackScreens=false] - Auto-detect screens via
-   *   UIViewController swizzle (iOS) or ActivityLifecycleCallbacks (Android).
-   *   In React Native, manual setScreen() calls are preferred.
-   * @param {boolean} [useMockService=false] - Use the built-in mock backend.
+   * @param {string} [environment='production'] - Backend environment:
+   *   'production', 'development', 'local', or 'mock'.
+   * @param {boolean} [autoTrackScreens=false] - Auto-detect screens.
+   * @param {string[]} [mockScreens] - Screen names for mock survey targeting.
    */
-  configure({ apiKey, autoTrackScreens = false, useMockService = false }) {
+  configure({ apiKey, environment = 'production', autoTrackScreens = false, mockScreens }) {
     if (Platform.OS !== 'ios' && Platform.OS !== 'android') return Promise.resolve();
-    return NativeUXRate.configure(apiKey, { autoTrackScreens, useMockService });
+    return NativeUXRate.configure(apiKey, { environment, autoTrackScreens, mockScreens });
   },
 
-  /**
-   * Identify the current user for segment-based survey targeting.
-   *
-   * @param {string} userId - A stable user identifier.
-   * @param {Object} [properties={}] - Optional key/value properties.
-   */
   identify({ userId, properties = {} }) {
     if (Platform.OS !== 'ios' && Platform.OS !== 'android') return Promise.resolve();
     return NativeUXRate.identify(userId, properties);
   },
 
-  /**
-   * Track a custom event. Used for event-based trigger rules.
-   *
-   * @param {string} event - The event name.
-   */
   track({ event }) {
     if (Platform.OS !== 'ios' && Platform.OS !== 'android') return Promise.resolve();
     return NativeUXRate.track(event);
   },
 
-  /**
-   * Report the current screen name. Call this on every navigation event.
-   *
-   * @param {string} name - The screen name to report.
-   *
-   * @example
-   * // With React Navigation
-   * <NavigationContainer
-   *   onStateChange={(state) => {
-   *     const route = state?.routes[state.index];
-   *     if (route) UXRate.setScreen(route.name);
-   *   }}
-   * >
-   */
   setScreen(name) {
     if (Platform.OS !== 'ios' && Platform.OS !== 'android') return Promise.resolve();
     return NativeUXRate.setScreen(name);

package/ios/UXRateModule.m

@@ -1,32 +1,67 @@
 #import <React/RCTBridgeModule.h>
 
-// Registers UXRateModule.swift with React Native's Objective-C bridge.
-// Each RCT_EXTERN_METHOD must match an @objc method in UXRateModule.swift.
-
-RCT_EXTERN_MODULE(UXRate, NSObject)
-
-RCT_EXTERN_METHOD(
-  configure:(NSString *)apiKey
-  options:(NSDictionary *)options
-  resolve:(RCTPromiseResolveBlock)resolve
-  reject:(RCTPromiseRejectBlock)reject
-)
-
-RCT_EXTERN_METHOD(
-  identify:(NSString *)userId
-  properties:(NSDictionary *)properties
-  resolve:(RCTPromiseResolveBlock)resolve
-  reject:(RCTPromiseRejectBlock)reject
-)
-
-RCT_EXTERN_METHOD(
-  track:(NSString *)event
-  resolve:(RCTPromiseResolveBlock)resolve
-  reject:(RCTPromiseRejectBlock)reject
-)
-
-RCT_EXTERN_METHOD(
-  setScreen:(NSString *)name
-  resolve:(RCTPromiseResolveBlock)resolve
-  reject:(RCTPromiseRejectBlock)reject
-)
+#if __has_include(<react_native_uxrate/react_native_uxrate-Swift.h>)
+#import <react_native_uxrate/react_native_uxrate-Swift.h>
+#else
+#import "react_native_uxrate-Swift.h"
+#endif
+
+@interface UXRate : NSObject <RCTBridgeModule>
+@end
+
+@implementation UXRate
+
+RCT_EXPORT_MODULE()
+
+RCT_EXPORT_METHOD(configure:(NSString *)apiKey
+                  options:(NSDictionary *)options
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+  BOOL autoTrack = [options[@"autoTrackScreens"] boolValue];
+  NSString *environment = options[@"environment"];
+  NSArray<NSString *> *mockScreens = options[@"mockScreens"];
+
+  [UXRateBridge configure:apiKey
+              environment:environment
+       autoTrackScreens:autoTrack
+            mockScreens:mockScreens];
+  resolve(nil);
+}
+
+RCT_EXPORT_METHOD(identify:(NSString *)userId
+                  properties:(NSDictionary *)properties
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+  NSMutableDictionary<NSString *, NSString *> *props = [NSMutableDictionary new];
+  [properties enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL *stop) {
+    if ([key isKindOfClass:[NSString class]] && [obj isKindOfClass:[NSString class]]) {
+      props[key] = obj;
+    }
+  }];
+  [UXRateBridge identify:userId properties:props];
+  resolve(nil);
+}
+
+RCT_EXPORT_METHOD(track:(NSString *)event
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+  [UXRateBridge track:event];
+  resolve(nil);
+}
+
+RCT_EXPORT_METHOD(setScreen:(NSString *)name
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+{
+  [UXRateBridge setScreen:name];
+  resolve(nil);
+}
+
++ (BOOL)requiresMainQueueSetup {
+  return NO;
+}
+
+@end

package/ios/UXRateModule.swift

@@ -1,91 +1,55 @@
 import Foundation
 import UXRateSDK
 
-/// React Native bridge module that exposes the UXRate iOS SDK to JavaScript.
-///
-/// Registered as `UXRate` via `RCT_EXTERN_MODULE` in `UXRateModule.m`.
-/// All methods dispatch to `MainActor` since `UXRate` is `@MainActor`-isolated.
-@objc(UXRate)
-class UXRateModule: NSObject {
+/// Implementation class for the React Native bridge.
+/// Called from the Objective-C bridge in UXRateModule.m.
+@objc(UXRateBridge)
+public class UXRateBridge: NSObject {
 
-    /// Initialise the UXRate SDK.
-    ///
-    /// - Parameters:
-    ///   - apiKey: Your UXRate API key.
-    ///   - options: Dictionary with optional keys:
-    ///     - `autoTrackScreens` (Bool, default false)
-    ///     - `useMockService` (Bool, default false)
     @objc
-    func configure(
+    public static func configure(
         _ apiKey: String,
-        options: NSDictionary,
-        resolve: @escaping RCTPromiseResolveBlock,
-        reject: @escaping RCTPromiseRejectBlock
+        environment: String?,
+        autoTrackScreens: Bool,
+        mockScreens: [String]?
     ) {
-        let autoTrack = options["autoTrackScreens"] as? Bool ?? false
-        let useMock   = options["useMockService"]   as? Bool ?? false
-        let strategy  = OverlapStrategy.from(string: options["overlapStrategy"] as? String)
-        let theme     = SDKTheme.from(string: options["theme"] as? String)
+        let env: UXRateEnvironment = {
+            switch environment {
+            case "development": return .development
+            case "local":       return .local
+            case "mock":        return .mock
+            default:            return .production
+            }
+        }()
 
         DispatchQueue.main.async {
             UXRate.configure(
                 apiKey: apiKey,
-                autoTrackScreens: autoTrack,
-                useMockService: useMock,
-                overlapStrategy: strategy,
-                theme: theme
+                environment: env,
+                autoTrackScreens: autoTrackScreens,
+                mockScreens: mockScreens
             )
-            resolve(nil)
         }
     }
 
-    /// Identify the current user.
-    ///
-    /// - Parameters:
-    ///   - userId: Stable user identifier.
-    ///   - properties: Optional `[String: String]` attributes.
     @objc
-    func identify(
-        _ userId: String,
-        properties: NSDictionary,
-        resolve: @escaping RCTPromiseResolveBlock,
-        reject: @escaping RCTPromiseRejectBlock
-    ) {
-        let props = properties as? [String: String] ?? [:]
+    public static func identify(_ userId: String, properties: [String: String]) {
         DispatchQueue.main.async {
-            UXRate.identify(userId: userId, properties: props)
-            resolve(nil)
+            UXRate.identify(userId: userId, properties: properties)
         }
     }
 
-    /// Track a custom event.
     @objc
-    func track(
-        _ event: String,
-        resolve: @escaping RCTPromiseResolveBlock,
-        reject: @escaping RCTPromiseRejectBlock
-    ) {
+    public static func track(_ event: String) {
         DispatchQueue.main.async {
             UXRate.track(event: event)
-            resolve(nil)
         }
     }
 
-    /// Report the current screen name.
     @objc
-    func setScreen(
-        _ name: String,
-        resolve: @escaping RCTPromiseResolveBlock,
-        reject: @escaping RCTPromiseRejectBlock
-    ) {
+    public static func setScreen(_ name: String) {
         DispatchQueue.main.async {
             UXRate.setScreen(name)
-            resolve(nil)
         }
     }
-
-    /// React Native requires this to declare that the module does not have
-    /// a main queue setup requirement — methods are dispatched manually.
-    @objc
-    static func requiresMainQueueSetup() -> Bool { false }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-uxrate",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "React Native module for the UXRate SDK — embed AI-powered surveys in your React Native app. Supports iOS and Android.",
   "main": "index.js",
   "types": "index.d.ts",

package/react-native-uxrate.podspec

@@ -14,5 +14,5 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/**/*.{swift,m,h}'
 
   s.dependency 'React-Core'
-  s.dependency 'UXRateSDK', '~> 0.2.0'
+  s.dependency 'UXRateSDK', '~> 0.3.0'
 end