solo-analytics 0.1.1 → 0.2.0

package/README.md

@@ -54,6 +54,10 @@ const analytics = useSoloAnalytics({
   refreshInterval: 10000,
   // Track page visibility changes
   trackVisibility: true,
+  // Skip expensive async probes (incognito, battery, media, permissions)
+  detectFeatures: true,
+  // Defer async probes to idle time (default: true, recommended)
+  lazyFeatures: true,
 });
 ```
 
@@ -345,13 +349,36 @@ Some advanced features may not be available in older browsers but the library in
 # Install dependencies
 npm install
 
-# Run development server
+# Run development server (demo playground)
 npm run dev
 
-# Build for production
+# Type-check and build for production
 npm run build
+
+# Run tests
+npm test
+
+# Watch tests during development
+npm run test:watch
 ```
 
+## Performance
+
+Solo Analytics is designed to stay off the critical path:
+
+| Metric | Value |
+|--------|-------|
+| ESM bundle (gzip) | ~3.5 KB |
+| UMD bundle (gzip) | ~3.1 KB |
+| `sideEffects` | `false` (tree-shakeable) |
+
+**Recommendations:**
+
+- Use `lazyFeatures: true` (default) so async probes run during idle time
+- Set `detectFeatures: false` if you only need UA, screen, and network data
+- Call `destroy()` when unmounting in SPAs to clear timers and listeners
+- Initialize client-side only (`onMounted` in Vue/Nuxt, `useEffect` in React)
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/composables/useSoloAnalytics.d.ts

@@ -0,0 +1,46 @@
+import { SoloAnalyticsInfo } from '../types/analytics';
+/**
+ * Type definition for analytics options
+ */
+export interface SoloAnalyticsOptions {
+    /** Automatically refresh dynamic data (network, performance) */
+    autoRefresh?: boolean;
+    /** Refresh interval in milliseconds (default: 30000) */
+    refreshInterval?: number;
+    /** Track page visibility changes */
+    trackVisibility?: boolean;
+    /**
+     * Run expensive async probes (incognito, battery, media, permissions).
+     * Set to `false` to skip entirely and reduce main-thread work.
+     * @default true
+     */
+    detectFeatures?: boolean;
+    /**
+     * Defer async feature probes to idle time via requestIdleCallback.
+     * Sync data (UA, screen, network) is collected immediately.
+     * @default true
+     */
+    lazyFeatures?: boolean;
+}
+/**
+ * Type definition for the return value of useSoloAnalytics
+ */
+export interface SoloAnalyticsReturn {
+    data: SoloAnalyticsInfo;
+    refresh: () => Promise<void>;
+    isMobile: boolean;
+    isTablet: boolean;
+    isDesktop: boolean;
+    isOnline: boolean;
+    isVisible: boolean;
+    browserName: string;
+    osName: string;
+    destroy: () => void;
+}
+/**
+ * A function that provides comprehensive browser, device, and performance analytics.
+ * @param options Configuration options
+ * @returns Object with analytics data and helper methods
+ */
+export declare function useSoloAnalytics(options?: SoloAnalyticsOptions): SoloAnalyticsReturn;
+//# sourceMappingURL=useSoloAnalytics.d.ts.map

package/dist/composables/useSoloAnalytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSoloAnalytics.d.ts","sourceRoot":"","sources":["../../src/composables/useSoloAnalytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAevD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oCAAoC;IACpC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AA8ED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA6JxF"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { useSoloAnalytics } from './composables/useSoloAnalytics';
+export type { SoloAnalyticsOptions, SoloAnalyticsReturn } from './composables/useSoloAnalytics';
+export type { SoloAnalyticsInfo, BrowserInfo, OSInfo, DeviceInfo, NetworkInfo, ScreenInfo, PerformanceInfo, LocationInfo } from './types/analytics';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAGhG,YAAY,EACV,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,UAAU,EACV,WAAW,EACX,UAAU,EACV,eAAe,EACf,YAAY,EACb,MAAM,mBAAmB,CAAC"}