swetrix 2.2.1 → 2.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swetrix",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "The JavaScript analytics client for Swetrix Analytics",
   "main": "dist/swetrix.cjs.js",
   "module": "dist/swetrix.es5.js",
@@ -8,6 +8,13 @@
   "origbrowser": "dist/swetrix.orig.js",
   "esnext": "dist/esnext/index.js",
   "typings": "dist/esnext/index.d.ts",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "prepublish": "npm run build",
+    "build": "rollup -c && tsc -p tsconfig.esnext.json",
+    "start": "rollup -c -w",
+    "tsc": "tsc -p tsconfig.esnext.json"
+  },
   "keywords": [
     "swetrix",
     "analytics",
@@ -27,25 +34,18 @@
   },
   "homepage": "https://swetrix.com/docs",
   "dependencies": {
-    "@types/node": "^18.16.1",
-    "tslib": "^2.5.0"
+    "@types/node": "^20.8.6",
+    "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.1.0",
-    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-commonjs": "^25.0.5",
+    "@rollup/plugin-node-resolve": "^15.2.3",
     "rimraf": "^4.4.1",
     "rollup": "^2.79.1",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "rollup-plugin-typescript2": "^0.34.1",
+    "rollup-plugin-typescript2": "^0.36.0",
     "rollup-plugin-uglify": "^6.0.4",
-    "typescript": "^5.0.4"
-  },
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "prepublish": "npm run build",
-    "build": "rollup -c && tsc -p tsconfig.esnext.json",
-    "start": "rollup -c -w",
-    "tsc": "tsc -p tsconfig.esnext.json"
+    "typescript": "^5.2.2"
   }
-}
+}

package/src/Lib.ts

@@ -30,6 +30,11 @@ export interface TrackEventOptions {
 
   /** If set to `true`, only 1 event with the same ID will be saved per user session. */
   unique?: boolean
+
+  /** Event-related metadata object with string values. */
+  meta?: {
+    [key: string]: string
+  }
 }
 
 /**
@@ -58,6 +63,9 @@ export interface PageViewsOptions {
   /** A list of Regular Expressions or string pathes to ignore. */
   ignore?: Array<string | RegExp>
 
+  /** Do not send paths from ignore list to API. If set to `false`, the page view information will be sent to the Swetrix API, but the page will be displayed as a 'Redacted page' in the dashboard. */
+  doNotAnonymise?: boolean
+
   /** Do not send Heartbeat requests to the server. */
   noHeartbeat?: boolean
 
@@ -178,7 +186,6 @@ export class Lib {
     }
   }
 
-
   private heartbeat(): void {
     if (!this.pageViewsOptions?.heartbeatOnBackground && document.visibilityState === 'hidden') {
       return
@@ -219,11 +226,13 @@ export class Lib {
     // Assuming that this function is called in trackPage and this.activePage is not overwritten by new value yet
     // That method of getting previous page works for SPA websites
     if (this.activePage) {
-      if (this.checkIgnore(this.activePage)) {
+      const shouldIgnore = this.checkIgnore(this.activePage)
+
+      if (shouldIgnore && this.pageViewsOptions?.doNotAnonymise) {
         return null
       }
 
-      return this.activePage
+      return shouldIgnore ? null : this.activePage
     }
 
     // Checking if URL is supported by the browser (for example, IE11 does not support it)
@@ -245,11 +254,13 @@ export class Lib {
           return null
         }
 
-        if (this.checkIgnore(pathname)) {
+        const shouldIgnore = this.checkIgnore(pathname)
+
+        if (shouldIgnore && this.pageViewsOptions?.doNotAnonymise) {
           return null
         }
 
-        return pathname
+        return shouldIgnore ? null : pathname
       } catch {
         return null
       }
@@ -262,7 +273,9 @@ export class Lib {
     if (!this.pageData) return
     this.pageData.path = pg
 
-    if (this.checkIgnore(pg)) return
+    const shouldIgnore = this.checkIgnore(pg)
+
+    if (shouldIgnore && this.pageViewsOptions?.doNotAnonymise) return
 
     const perf = this.getPerformanceStats()
 
@@ -281,7 +294,7 @@ export class Lib {
       me: getUTMMedium(),
       ca: getUTMCampaign(),
       unique,
-      pg,
+      pg: shouldIgnore ? null : pg,
       perf,
       prev,
     }