respectlytics-react-native 2.0.1 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "respectlytics-react-native",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Official Respectlytics SDK for React Native. Privacy-first analytics with automatic session management, offline event queuing, and zero device identifier collection.",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -38,7 +38,7 @@
     "url": "git+https://github.com/respectlytics/respectlytics-react-native.git"
   },
   "author": "Respectlytics <respectlytics@loheden.com>",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/respectlytics/respectlytics-react-native/issues"
   },
@@ -47,11 +47,14 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
     "@react-native-async-storage/async-storage": "^2.0.0",
     "@react-native-community/netinfo": "^11.3.0",
     "@types/jest": "^29.5.12",
     "@types/react": "^18.2.0",
     "@types/react-native": "^0.72.0",
+    "babel-jest": "^30.2.0",
     "eslint": "^8.56.0",
     "jest": "^29.7.0",
     "react": "^18.2.0",

package/src/EventQueue.ts

@@ -1,10 +1,10 @@
 /**
  * EventQueue.ts
  * Respectlytics React Native SDK
- * 
+ *
  * Manages event batching, persistence, and automatic flushing.
  * Events are NEVER lost - they are persisted immediately and retried on failure.
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
 import { AppState, AppStateStatus } from 'react-native';
@@ -65,10 +65,10 @@ export class EventQueue {
    */
   async add(event: Event): Promise<void> {
     this.events.push(event);
-    
+
     // IMMEDIATELY persist before any async operations
     await this.persistQueue();
-    
+
     // Check if we should flush
     if (this.events.length >= MAX_QUEUE_SIZE) {
       this.flush();

package/src/NetworkClient.ts

@@ -1,14 +1,14 @@
 /**
  * NetworkClient.ts
  * Respectlytics React Native SDK
- * 
+ *
  * Handles HTTP communication with the Respectlytics API.
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
 import { Event } from './types';
 
-const API_ENDPOINT = 'https://respectlytics.com/api/v1/events/';
+const DEFAULT_API_ENDPOINT = 'https://respectlytics.com/api/v1/events/';
 const MAX_RETRIES = 3;
 const TIMEOUT_MS = 30000;
 
@@ -25,12 +25,16 @@ export enum NetworkError {
 
 export class NetworkClient {
   private apiKey: string | null = null;
+  private apiEndpoint: string = DEFAULT_API_ENDPOINT;
 
   /**
-   * Configure the network client with an API key
+   * Configure the network client with an API key and optional custom endpoint
    */
-  configure(apiKey: string): void {
+  configure(apiKey: string, apiEndpoint?: string): void {
     this.apiKey = apiKey;
+    if (apiEndpoint) {
+      this.apiEndpoint = apiEndpoint;
+    }
   }
 
   /**
@@ -65,7 +69,7 @@ export class NetworkClient {
     const timeoutId = setTimeout(() => controller.abort(), TIMEOUT_MS);
 
     try {
-      const response = await fetch(API_ENDPOINT, {
+      const response = await fetch(this.apiEndpoint, {
         method: 'POST',
         headers: {
           'Content-Type': 'application/json',
@@ -137,20 +141,15 @@ export class NetworkClient {
   }
 
   /**
-   * Convert Event object to API payload format
-   * Note: As of v2.0.0, no user_id field is sent (session-based analytics only)
+   * Convert Event object to API payload format.
+   * The SDK sends 4 fields; the API stores 5 (adding country derived from IP).
    */
   private eventToPayload(event: Event): Record<string, unknown> {
     return {
       event_name: event.eventName,
       timestamp: event.timestamp,
       session_id: event.sessionId,
-      screen: event.screen || undefined,
       platform: event.platform,
-      os_version: event.osVersion,
-      app_version: event.appVersion,
-      locale: event.locale,
-      device_type: event.deviceType,
     };
   }
 

package/src/Respectlytics.ts

@@ -1,12 +1,12 @@
 /**
  * Respectlytics.ts
  * Respectlytics React Native SDK
- * 
+ *
  * Main entry point for the SDK.
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
-import { Platform, Dimensions, NativeModules } from 'react-native';
+import { Platform } from 'react-native';
 import { Event } from './types';
 import { SessionManager } from './SessionManager';
 import { NetworkClient } from './NetworkClient';
@@ -14,21 +14,23 @@ import { EventQueue } from './EventQueue';
 
 /**
  * Main entry point for the Respectlytics SDK.
- * 
- * v2.0.0 uses session-based analytics only:
+ *
+ * v2.1.0 uses session-based analytics only:
  * - Session IDs are generated automatically in RAM
  * - Sessions rotate every 2 hours
  * - New session on every app restart
- * - No persistent user tracking (GDPR/ePrivacy compliant)
- * 
+ * - Only 4 fields sent by SDK; 5 stored (country derived server-side)
+ *
  * Usage:
  * ```typescript
  * // 1. Configure at app launch
  * Respectlytics.configure('your-api-key');
- * 
+ *
+ * // For self-hosted instances:
+ * Respectlytics.configure('your-api-key', { apiEndpoint: 'https://your-server.com/api/v1/events/' });
+ *
  * // 2. Track events
  * Respectlytics.track('purchase');
- * Respectlytics.track('view_product', 'ProductScreen');
  * ```
  */
 class RespectlyticsSDK {
@@ -36,42 +38,44 @@ class RespectlyticsSDK {
   private networkClient: NetworkClient;
   private eventQueue: EventQueue;
   private sessionManager: SessionManager;
+  private platform: string;
 
   constructor() {
     this.networkClient = new NetworkClient();
     this.eventQueue = new EventQueue(this.networkClient);
     this.sessionManager = new SessionManager();
+    this.platform = Platform.OS === 'ios' ? 'iOS' : 'Android';
   }
 
   /**
    * Initialize the SDK with your API key.
    * Call once at app startup.
-   * 
+   *
    * @param apiKey Your Respectlytics API key from the dashboard
+   * @param options Optional configuration (e.g., apiEndpoint for self-hosted instances)
    */
-  configure(apiKey: string): void {
+  configure(apiKey: string, options?: { apiEndpoint?: string }): void {
     if (!apiKey || apiKey.trim() === '') {
       console.log('[Respectlytics] ⚠️ API key cannot be empty');
       return;
     }
 
-    this.networkClient.configure(apiKey);
+    this.networkClient.configure(apiKey, options?.apiEndpoint);
     this.eventQueue.start();
     this.isConfigured = true;
 
-    console.log('[Respectlytics] ✓ SDK configured');
+    console.log('[Respectlytics] ✓ SDK configured (v2.2.0)');
   }
 
   /**
-   * Track an event with an optional screen name.
-   * 
-   * The SDK automatically collects privacy-safe metadata:
-   * - timestamp, session_id, platform, os_version, app_version, locale
-   * 
+   * Track an event.
+   *
+   * Custom properties are NOT supported - this is by design for privacy.
+   * The API stores 5 fields (these 4 plus country derived server-side).
+   *
    * @param eventName Name of the event (e.g., "purchase", "button_clicked")
-   * @param screen Optional screen name where the event occurred
    */
-  track(eventName: string, screen?: string): void {
+  track(eventName: string): void {
     if (!this.isConfigured) {
       console.log('[Respectlytics] ⚠️ SDK not configured. Call configure(apiKey) first.');
       return;
@@ -87,7 +91,13 @@ class RespectlyticsSDK {
       return;
     }
 
-    const event = this.createEvent(eventName, screen);
+    const event: Event = {
+      eventName,
+      timestamp: new Date().toISOString(),
+      sessionId: this.sessionManager.getSessionId(),
+      platform: this.platform,
+    };
+
     this.eventQueue.add(event);
   }
 
@@ -98,77 +108,6 @@ class RespectlyticsSDK {
   async flush(): Promise<void> {
     await this.eventQueue.flush();
   }
-
-  // MARK: - Private Helpers
-
-  private createEvent(eventName: string, screen?: string): Event {
-    const metadata = this.collectMetadata();
-    
-    return {
-      eventName,
-      timestamp: new Date().toISOString(),
-      sessionId: this.sessionManager.getSessionId(),
-      screen: screen || null,
-      ...metadata,
-    };
-  }
-
-  private collectMetadata(): {
-    platform: string;
-    osVersion: string;
-    appVersion: string;
-    locale: string;
-    deviceType: string;
-  } {
-    // Determine platform
-    const platform = Platform.OS === 'ios' ? 'iOS' : 'Android';
-
-    // Get OS version
-    const osVersion = String(Platform.Version);
-
-    // Get app version - try to get from native modules
-    let appVersion = 'unknown';
-    try {
-      // React Native provides app info through different native modules
-      const { PlatformConstants } = NativeModules;
-      if (PlatformConstants?.reactNativeVersion) {
-        // This is React Native version, not app version
-        // App version should come from the host app
-      }
-      // For now, use 'unknown' as we can't reliably get app version without additional dependencies
-      // In a real app, the developer would configure this
-    } catch {
-      appVersion = 'unknown';
-    }
-
-    // Get locale
-    let locale = 'en_US';
-    try {
-      // React Native doesn't expose locale directly, but we can get it from platform
-      if (Platform.OS === 'ios') {
-        locale = NativeModules.SettingsManager?.settings?.AppleLocale || 
-                 NativeModules.SettingsManager?.settings?.AppleLanguages?.[0] || 
-                 'en_US';
-      } else {
-        locale = NativeModules.I18nManager?.localeIdentifier || 'en_US';
-      }
-    } catch {
-      locale = 'en_US';
-    }
-
-    // Determine device type based on screen size
-    const { width, height } = Dimensions.get('window');
-    const minDimension = Math.min(width, height);
-    const deviceType = minDimension >= 600 ? 'tablet' : 'phone';
-
-    return {
-      platform,
-      osVersion,
-      appVersion,
-      locale,
-      deviceType,
-    };
-  }
 }
 
 // Export singleton instance

package/src/SessionManager.ts

@@ -3,10 +3,10 @@
  * Respectlytics React Native SDK
  *
  * Manages session ID generation and rotation.
- * Sessions are stored in RAM only (never persisted) for GDPR/ePrivacy compliance.
+ * Sessions are stored in RAM only (never persisted to disk).
  * Sessions automatically rotate every 2 hours.
  *
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
 /**
@@ -22,15 +22,15 @@ function generateUUID(): string {
 
 /**
  * Manages session ID generation and rotation.
- * 
+ *
  * Session IDs are:
  * - Generated immediately when the SDK initializes
  * - Stored in RAM only (never persisted to AsyncStorage)
  * - Rotated automatically every 2 hours
  * - Regenerated on every app restart (new instance = new session)
- * 
- * This RAM-only approach ensures GDPR/ePrivacy compliance:
- * - No device storage = No consent required under ePrivacy Directive Article 5(3)
+ *
+ * This RAM-only approach means session data never touches device storage:
+ * - Sessions exist only in memory and are lost on app restart
  * - Each app launch creates a fresh, unlinked session
  */
 export class SessionManager {

package/src/Storage.ts

@@ -4,7 +4,7 @@
  *
  * Wrapper around AsyncStorage for persisting SDK data.
  *
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
 import AsyncStorage from '@react-native-async-storage/async-storage';

package/src/index.ts

@@ -1,17 +1,16 @@
 /**
  * Respectlytics React Native SDK
- * 
+ *
  * Official SDK for privacy-first, session-based analytics.
- * 
+ *
  * v2.0.0 Features:
  * - Session-based analytics (no persistent user tracking)
- * - RAM-only session storage (GDPR/ePrivacy compliant)
+ * - RAM-only session storage (never persisted to disk)
  * - Automatic 2-hour session rotation
  * - New session on every app restart
- * 
- * Copyright (c) 2025 Respectlytics. All rights reserved.
+ *
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
-
 import Respectlytics from './Respectlytics';
 
 // Default export - the main SDK instance

package/src/types.ts

@@ -2,37 +2,33 @@
  * types.ts
  * Respectlytics React Native SDK
  *
- * Copyright (c) 2025 Respectlytics. All rights reserved.
- * This SDK is provided under a proprietary license.
- * See LICENSE file for details.
+ * Copyright (c) 2025 Respectlytics. Licensed under MIT.
  */
 
 /**
  * Represents an analytics event - flat structure matching API payload
  *
- * This interface only contains fields accepted by the Respectlytics API.
- * The API uses a strict allowlist for privacy protection.
- * Custom properties are NOT supported - this is by design for privacy.
- * 
- * Note: As of v2.0.0, there is no userId field. Session-based analytics only.
+ * The SDK sends these 4 fields. The API stores 5 total
+ * (adding country, derived server-side from IP which is immediately discarded):
+ * - event_name (required)
+ * - timestamp
+ * - session_id
+ * - platform
+ *
+ * Country is derived server-side from IP (which is immediately discarded).
  */
 export interface Event {
   eventName: string;
   timestamp: string;
   sessionId: string;
-  screen: string | null;
   platform: string;
-  osVersion: string;
-  appVersion: string;
-  locale: string;
-  deviceType: string;
 }
 
 /**
  * Storage keys used by the SDK
- * 
- * Note: As of v2.0.0, we only persist the event queue.
- * Session IDs are RAM-only for GDPR/ePrivacy compliance.
+ *
+ * Note: Only the event queue is persisted.
+ * Session IDs are RAM-only for privacy.
  */
 export const STORAGE_KEYS = {
   EVENT_QUEUE: 'com.respectlytics.eventQueue',