user-analytics-tracker 4.1.2 → 4.3.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [4.3.0](https://github.com/Switch-org/analytics-tracker/compare/v4.2.0...v4.3.0) (2026-01-30)
+
+
+### Features
+
+* updated api_key flow for consumers ([#35](https://github.com/Switch-org/analytics-tracker/issues/35)) ([b5ce7de](https://github.com/Switch-org/analytics-tracker/commit/b5ce7de0201b69f085faf0c003427a961a4ec471))
+
+# [4.2.0](https://github.com/Switch-org/analytics-tracker/compare/v4.1.2...v4.2.0) (2026-01-21)
+
+
+### Features
+
+* update geo-location , essential data ([#28](https://github.com/Switch-org/analytics-tracker/issues/28)) ([fc63298](https://github.com/Switch-org/analytics-tracker/commit/fc63298f1ccfdeea36348d85ff9fc6a2b95c6211))
+* update geo-location , essential dataa ([#29](https://github.com/Switch-org/analytics-tracker/issues/29)) ([0f9c493](https://github.com/Switch-org/analytics-tracker/commit/0f9c49329c2e638688ffca8be5819107ff657a28))
+* updated essential logs ([bdb718a](https://github.com/Switch-org/analytics-tracker/commit/bdb718a3944a2399f9461f96edb589ffa40d5b07))
+* updated geo-locations, event validator for essential tracking + custom ip conf ([ec84f67](https://github.com/Switch-org/analytics-tracker/commit/ec84f67e2891df1d78fd99939a793cefdf0885ad))
+* updated logs for essential case ([553da62](https://github.com/Switch-org/analytics-tracker/commit/553da62ee45aad416e912fe76cc7436b3c15a456))
+* updated security ([7502d6e](https://github.com/Switch-org/analytics-tracker/commit/7502d6e3b45b26912cf48b83ab843a56b50373e5))
+
 ## [4.1.2](https://github.com/Switch-org/analytics-tracker/compare/v4.1.1...v4.1.2) (2025-12-31)
 
 

package/README.md

@@ -95,6 +95,12 @@ const analytics = useAnalytics({
     // Metrics configuration
     enableMetrics: false,       // Enable metrics collection (default: false)
     
+    // IP Geolocation (ipwho.is) - optional; use your own API key for higher rate limits
+    ipGeolocation: {
+      apiKey: import.meta.env.VITE_IPWHOIS_API_KEY, // Use env var; omit for free tier
+      timeout: 5000,
+    },
+    
     // Field storage configuration (optional) - control which fields are stored
     fieldStorage: {
       ipLocation: { mode: 'essential' },    // IP location fields (includes connection data)
@@ -156,13 +162,20 @@ Use environment variables for different environments:
 ```tsx
 // .env.local (development)
 // NEXT_PUBLIC_ANALYTICS_API=https://api-dev.yourcompany.com/analytics
+// NEXT_PUBLIC_IPWHOIS_API_KEY=your-ipwho-is-key  // optional, for higher rate limits
 
 // .env.production
 // NEXT_PUBLIC_ANALYTICS_API=https://api.yourcompany.com/analytics
+// NEXT_PUBLIC_IPWHOIS_API_KEY=your-ipwho-is-key
 
 const analytics = useAnalytics({
   config: {
     apiEndpoint: process.env.NEXT_PUBLIC_ANALYTICS_API || '/api/analytics',
+    // Optional: your own ipwho.is API key (use env var; omit for free tier)
+    ipGeolocation: {
+      apiKey: process.env.NEXT_PUBLIC_IPWHOIS_API_KEY,
+      timeout: 5000,
+    },
   },
 });
 ```
@@ -341,6 +354,12 @@ interface AnalyticsConfig {
   logLevel?: LogLevel;       // 'silent' | 'error' | 'warn' | 'info' | 'debug' (default: 'warn')
   // Metrics options
   enableMetrics?: boolean;   // Enable metrics collection (default: false)
+  // IP Geolocation (ipwho.is) - pass your own API key via env var for higher rate limits
+  ipGeolocation?: {
+    apiKey?: string;   // Use env var, e.g. VITE_IPWHOIS_API_KEY or REACT_APP_IPWHOIS_API_KEY
+    baseUrl?: string;  // Default: 'https://ipwho.is'
+    timeout?: number; // Default: 5000
+  };
   // Existing options
   autoSend?: boolean;
   enableLocation?: boolean;
@@ -981,7 +1000,7 @@ MIT © [Switch Org](https://github.com/switch-org)
 
 ## 🙏 Acknowledgments
 
-- Uses [ipwho.is](https://ipwho.is/) for free IP geolocation and accurate connection data
+- Uses [ipwho.is](https://ipwho.is/) for IP geolocation and connection data (free tier; consumers can pass their own API key via `config.ipGeolocation.apiKey` for higher rate limits)
 - Built with modern web APIs (User-Agent Client Hints, Geolocation API)
 
 <!-- ## 📞 Support