@wxt-dev/analytics 0.2.6 → 0.2.8

package/README.md

@@ -40,11 +40,12 @@ export default defineAppConfig({
 Then use the `analytics` import to report events:
 
 ```ts
-import { analytics } from '@wxt-dev/analytics';
+import { analytics } from '#analytics';
 
 await analytics.track('some-event');
 await analytics.page();
 await analytics.identify('some-user-id');
+analytics.autoTrack(document.body);
 ```
 
 ## Providers

package/dist/client.d.mts

@@ -1,4 +1,4 @@
-import { A as AnalyticsConfig, a as Analytics } from './shared/analytics.079e9952.mjs';
+import { A as AnalyticsConfig, a as Analytics } from './shared/analytics.2893a879.mjs';
 
 declare function createAnalytics(config?: AnalyticsConfig): Analytics;
 

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { A as AnalyticsConfig, a as Analytics } from './shared/analytics.079e9952.js';
+import { A as AnalyticsConfig, a as Analytics } from './shared/analytics.2893a879.js';
 
 declare function createAnalytics(config?: AnalyticsConfig): Analytics;
 

package/dist/client.mjs

@@ -13,7 +13,7 @@ function createAnalytics(config) {
   }
   if (location.pathname === "/background.js")
     return createBackgroundAnalytics(config);
-  return createFrontendAnalytics(config);
+  return createFrontendAnalytics();
 }
 function createBackgroundAnalytics(config) {
   const userIdStorage = config?.userId ?? defineStorageItem("wxt-analytics:user-id");
@@ -29,7 +29,7 @@ function createBackgroundAnalytics(config) {
   );
   let userProperties = userPropertiesStorage.getValue();
   const manifest = chrome.runtime.getManifest();
-  const getBaseEvent = async (meta = {
+  const getBackgroundMeta = () => ({
     timestamp: Date.now(),
     // Don't track sessions for the background, it can be running
     // indefinitely, and will inflate session duration stats.
@@ -39,17 +39,11 @@ function createBackgroundAnalytics(config) {
     screen: void 0,
     url: location.href,
     title: void 0
-  }) => {
+  });
+  const getBaseEvent = async (meta) => {
     const platform = await platformInfo;
     return {
-      meta: {
-        sessionId: meta.sessionId,
-        timestamp: meta.timestamp,
-        screen: meta.screen,
-        referrer: meta.referrer,
-        language: meta.language,
-        url: meta.url
-      },
+      meta,
       user: {
         id: await userId,
         properties: {
@@ -66,14 +60,14 @@ function createBackgroundAnalytics(config) {
     };
   };
   const analytics = {
-    identify: async (newUserId, newUserProperties = {}, forwardMeta) => {
+    identify: async (newUserId, newUserProperties = {}, meta = getBackgroundMeta()) => {
       userId = Promise.resolve(newUserId);
       userProperties = Promise.resolve(newUserProperties);
       await Promise.all([
         userIdStorage.setValue?.(newUserId),
         userPropertiesStorage.setValue?.(newUserProperties)
       ]);
-      const event = await getBaseEvent(forwardMeta);
+      const event = await getBaseEvent(meta);
       if (config?.debug)
         console.debug("[analytics] identify", event);
       if (await enabled.getValue()) {
@@ -86,14 +80,14 @@ function createBackgroundAnalytics(config) {
         );
       }
     },
-    page: async (location2, forwardMeta) => {
-      const baseEvent = await getBaseEvent(forwardMeta);
+    page: async (location2, meta = getBackgroundMeta()) => {
+      const baseEvent = await getBaseEvent(meta);
       const event = {
         ...baseEvent,
         page: {
-          url: forwardMeta?.url ?? globalThis.location?.href,
+          url: meta?.url ?? globalThis.location?.href,
           location: location2,
-          title: forwardMeta?.title ?? globalThis.document?.title
+          title: meta?.title ?? globalThis.document?.title
         }
       };
       if (config?.debug)
@@ -106,8 +100,8 @@ function createBackgroundAnalytics(config) {
         console.debug("[analytics] Analytics disabled, page() not uploaded");
       }
     },
-    track: async (eventName, eventProperties, forwardMeta) => {
-      const baseEvent = await getBaseEvent(forwardMeta);
+    track: async (eventName, eventProperties, meta = getBackgroundMeta()) => {
+      const baseEvent = await getBaseEvent(meta);
       const event = {
         ...baseEvent,
         event: { name: eventName, properties: eventProperties }
@@ -140,10 +134,10 @@ function createBackgroundAnalytics(config) {
   });
   return analytics;
 }
-function createFrontendAnalytics(config) {
+function createFrontendAnalytics() {
   const port = chrome.runtime.connect({ name: ANALYTICS_PORT });
   const sessionId = Date.now();
-  const getMetadata = () => ({
+  const getFrontendMetadata = () => ({
     sessionId,
     timestamp: Date.now(),
     language: navigator.language,
@@ -153,13 +147,7 @@ function createFrontendAnalytics(config) {
     title: document.title || void 0
   });
   const methodForwarder = (fn) => (...args) => {
-    if (config?.debug) {
-      console.debug(
-        `[analytics] Sending ${fn} to background for upload`,
-        ...args
-      );
-    }
-    port.postMessage({ fn, args: [...args, getMetadata()] });
+    port.postMessage({ fn, args: [...args, getFrontendMetadata()] });
   };
   const analytics = {
     identify: methodForwarder("identify"),
@@ -167,14 +155,8 @@ function createFrontendAnalytics(config) {
     track: methodForwarder("track"),
     setEnabled: methodForwarder("setEnabled"),
     autoTrack: (root) => {
-      if (config?.debug) {
-        console.debug("[analytics] autoTrack() called!");
-      }
       const onClick = (event) => {
         const element = event.target;
-        if (config?.debug) {
-          console.debug("[analytics] autoTrack() element clicked", element);
-        }
         if (!element || !INTERACTIVE_TAGS.has(element.tagName) && !INTERACTIVE_ROLES.has(element.getAttribute("role")))
           return;
         void analytics.track("click", {

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as wxt from 'wxt';
-import { A as AnalyticsConfig } from './shared/analytics.079e9952.mjs';
+import { A as AnalyticsConfig } from './shared/analytics.2893a879.mjs';
 
 declare module 'wxt/sandbox' {
     interface WxtAppConfig {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as wxt from 'wxt';
-import { A as AnalyticsConfig } from './shared/analytics.079e9952.js';
+import { A as AnalyticsConfig } from './shared/analytics.2893a879.js';
 
 declare module 'wxt/sandbox' {
     interface WxtAppConfig {

package/dist/providers/google-analytics-4.d.mts

@@ -1,4 +1,4 @@
-import { b as AnalyticsProvider } from '../shared/analytics.079e9952.mjs';
+import { b as AnalyticsProvider } from '../shared/analytics.2893a879.mjs';
 
 interface GoogleAnalyticsProviderOptions {
     apiSecret: string;

package/dist/providers/google-analytics-4.d.ts

@@ -1,4 +1,4 @@
-import { b as AnalyticsProvider } from '../shared/analytics.079e9952.js';
+import { b as AnalyticsProvider } from '../shared/analytics.2893a879.js';
 
 interface GoogleAnalyticsProviderOptions {
     apiSecret: string;

package/dist/providers/umami.d.mts

@@ -1,4 +1,4 @@
-import { b as AnalyticsProvider } from '../shared/analytics.079e9952.mjs';
+import { b as AnalyticsProvider } from '../shared/analytics.2893a879.mjs';
 
 interface UmamiProviderOptions {
     baseUrl: string;

package/dist/providers/umami.d.ts

@@ -1,4 +1,4 @@
-import { b as AnalyticsProvider } from '../shared/analytics.079e9952.js';
+import { b as AnalyticsProvider } from '../shared/analytics.2893a879.js';
 
 interface UmamiProviderOptions {
     baseUrl: string;

package/dist/shared/{analytics.079e9952.d.mts → analytics.2893a879.d.mts}

@@ -49,25 +49,28 @@ type AnalyticsProvider = (analytics: Analytics, config: AnalyticsConfig) => {
     identify: (event: BaseAnalyticsEvent) => Promise<void>;
 };
 interface BaseAnalyticsEvent {
-    meta: {
-        /** Identifier of the session the event was fired from */
-        sessionId: number | undefined;
-        /** `Date.now()` of when the event was reported */
-        timestamp: number;
-        /** `"1920x1080"` */
-        screen: string | undefined;
-        /** `document.referrer` */
-        referrer: string | undefined;
-        /** `navigator.language` */
-        language: string | undefined;
-        /** `location.href` */
-        url: string | undefined;
-    };
+    meta: AnalyticsEventMetadata;
     user: {
         id: string;
         properties: Record<string, string | undefined>;
     };
 }
+interface AnalyticsEventMetadata {
+    /** Identifier of the session the event was fired from */
+    sessionId: number | undefined;
+    /** `Date.now()` of when the event was reported */
+    timestamp: number;
+    /** `"1920x1080"` */
+    screen: string | undefined;
+    /** `document.referrer` */
+    referrer: string | undefined;
+    /** `navigator.language` */
+    language: string | undefined;
+    /** `location.href` */
+    url: string | undefined;
+    /** `document.title` */
+    title: string | undefined;
+}
 interface AnalyticsPageInfo {
     url: string;
     title: string | undefined;

package/dist/shared/{analytics.079e9952.d.ts → analytics.2893a879.d.ts}

@@ -49,25 +49,28 @@ type AnalyticsProvider = (analytics: Analytics, config: AnalyticsConfig) => {
     identify: (event: BaseAnalyticsEvent) => Promise<void>;
 };
 interface BaseAnalyticsEvent {
-    meta: {
-        /** Identifier of the session the event was fired from */
-        sessionId: number | undefined;
-        /** `Date.now()` of when the event was reported */
-        timestamp: number;
-        /** `"1920x1080"` */
-        screen: string | undefined;
-        /** `document.referrer` */
-        referrer: string | undefined;
-        /** `navigator.language` */
-        language: string | undefined;
-        /** `location.href` */
-        url: string | undefined;
-    };
+    meta: AnalyticsEventMetadata;
     user: {
         id: string;
         properties: Record<string, string | undefined>;
     };
 }
+interface AnalyticsEventMetadata {
+    /** Identifier of the session the event was fired from */
+    sessionId: number | undefined;
+    /** `Date.now()` of when the event was reported */
+    timestamp: number;
+    /** `"1920x1080"` */
+    screen: string | undefined;
+    /** `document.referrer` */
+    referrer: string | undefined;
+    /** `navigator.language` */
+    language: string | undefined;
+    /** `location.href` */
+    url: string | undefined;
+    /** `document.title` */
+    title: string | undefined;
+}
 interface AnalyticsPageInfo {
     url: string;
     title: string | undefined;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@wxt-dev/analytics",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Add analytics to your web extension",
   "repository": {
     "type": "git",
-    "url": "https://github.com/wxt-dev/wxt.git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
     "directory": "packages/analytics"
   },
   "license": "MIT",
@@ -33,7 +33,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "wxt": ">=0.18.14"
+    "wxt": ">=0.19.9"
   },
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",