@brainfish-ai/web-tracker 0.0.4-alpha.8 → 0.0.4-aplha.19

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@brainfish-ai/web-tracker",
-  "version": "0.0.4-alpha.8",
-  "module": "index.ts",
+  "version": "0.0.4-aplha.19",
+  "main": "dist/index.js",
   "description": "Brainfish Tracker for Web",
   "private": false,
   "scripts": {
     "start": "vite",
     "dev": "vite",
-    "build": "vite build",
+    "set-version": "node set-version.js",
+    "build": "npm run set-version && vite build",
     "serve": "vite preview --port 6006",
     "test": "vitest"
   },
@@ -22,11 +23,9 @@
     "vite-tsconfig-paths": "^4.2.0"
   },
   "dependencies": {
-    "@brainfish-ai/tracker-sdk": "0.0.1-alpha.2",
+    "@brainfish-ai/tracker-sdk": "0.0.1-alpha.3",
     "html-to-image": "^1.11.11",
-    "redact-pii": "^3.4.0",
-    "rrweb": "^2.0.0-alpha.4",
-    "vite-plugin-replace": "^0.1.1"
+    "rrweb": "^2.0.0-alpha.4"
   },
   "keywords": [
     "typescript",

package/set-version.js

@@ -0,0 +1,13 @@
+const fs = require('fs');
+const packageJson = require('./package.json');
+
+// Get the version from package.json
+const version = packageJson.version;
+
+// Prepare the .env content
+const envContent = `PACKAGE_VERSION=${version}\n`;
+
+// Write the version to .env file
+fs.writeFileSync('.env', envContent);
+
+console.log(`Set PACKAGE_VERSION to ${version} in .env file`);

package/src/index.ts

@@ -5,7 +5,7 @@ import type {
   TrackProperties,
 } from '@brainfish-ai/tracker-sdk';
 import { TrackerSdk } from '@brainfish-ai/tracker-sdk';
-import { screenshot } from './utils/snapshot';
+import { screenshot } from './screenshot/snapshot';
 
 export type * from '@brainfish-ai/tracker-sdk';
 
@@ -18,19 +18,20 @@ export type TrackerOptions = TrackerSdkOptions & {
 
 function toCamelCase(str: string) {
   return str.replace(/([-_][a-z])/gi, ($1) =>
-    $1.toUpperCase().replace('-', '').replace('_', ''),
+    $1.toUpperCase().replace('-', '').replace('_', '')
   );
 }
 
+export const VERSION = import.meta.env.PACKAGE_VERSION as string;
+
 export class Tracker extends TrackerSdk {
   private lastPath = '';
   private debounceTimer: ReturnType<typeof setTimeout> | null = null;
-    static mock: any;
 
   constructor(public options: TrackerOptions) {
     super({
       sdk: 'web',
-      sdkVersion: __PACKAGE_VERSION__,
+      sdkVersion: VERSION,
       ...options,
     });
 
@@ -134,8 +135,8 @@ export class Tracker extends TrackerSdk {
       const element = btn?.getAttribute('data-track')
         ? btn
         : anchor?.getAttribute('data-track')
-          ? anchor
-          : null;
+        ? anchor
+        : null;
       if (element) {
         const properties: Record<string, unknown> = {};
         for (const attr of element.attributes) {
@@ -156,7 +157,7 @@ export class Tracker extends TrackerSdk {
   async screenView(path: string, properties?: TrackProperties): Promise<void>;
   async screenView(
     pathOrProperties?: string | TrackProperties,
-    propertiesOrUndefined?: TrackProperties,
+    propertiesOrUndefined?: TrackProperties
   ): Promise<void> {
     if (this.isServer()) {
       return;
@@ -183,7 +184,7 @@ export class Tracker extends TrackerSdk {
     this.lastPath = path;
     super.track('screen_view', {
       ...(properties ?? {}),
-      screenshot: snapshot,
+      __screenshot: snapshot,
       __path: path,
       __title: document.title,
     });

package/src/redact/built-ins/NameRedactor.ts

@@ -0,0 +1,41 @@
+import { ISyncRedactor } from '../types';
+import _wellKnownNames from './well-known-names';
+
+const greetingRegex = /(^|\.\s+)(dear|hi|hello|greetings|hey|hey there)/gi;
+const closingRegex =
+  /(thx|thanks|thank you|regards|best|[a-z]+ly|[a-z]+ regards|all the best|happy [a-z]+ing|take care|have a [a-z]+ (weekend|night|day))/gi;
+
+const greetingOrClosing = new RegExp(
+  '(((' + greetingRegex.source + ')|(' + closingRegex.source + '\\s*[,.!]*))[\\s-]*)',
+  'gi'
+);
+const genericName = new RegExp('( ?(([A-Z][a-z]+)|([A-Z]\\.)))+([,.]|[,.]?$)', 'gm');
+
+const wellKnownNames = new RegExp('\\b(\\s*)(\\s*(' + _wellKnownNames.join('|') + '))+\\b', 'gim');
+
+export class NameRedactor implements ISyncRedactor {
+  constructor(private replaceWith = 'PERSON_NAME') {}
+
+  redact(textToRedact: string) {
+    greetingOrClosing.lastIndex = 0;
+    genericName.lastIndex = 0;
+    let greetingOrClosingMatch = greetingOrClosing.exec(textToRedact);
+    while (greetingOrClosingMatch !== null) {
+      genericName.lastIndex = greetingOrClosing.lastIndex;
+      let genericNameMatch = genericName.exec(textToRedact);
+      if (genericNameMatch !== null && genericNameMatch.index === greetingOrClosing.lastIndex) {
+        let suffix = genericNameMatch[5] === null ? '' : genericNameMatch[5];
+        textToRedact =
+          textToRedact.slice(0, genericNameMatch.index) +
+          this.replaceWith +
+          suffix +
+          textToRedact.slice(genericNameMatch.index + genericNameMatch[0].length);
+      }
+      greetingOrClosingMatch = greetingOrClosing.exec(textToRedact);
+    }
+
+    textToRedact = textToRedact.replace(wellKnownNames, '$1' + this.replaceWith);
+
+    return textToRedact;
+  }
+}

package/src/redact/built-ins/SimpleRegexpRedactor.ts

@@ -0,0 +1,22 @@
+import { ISyncRedactor } from '../types';
+import { snakeCase } from '../utils';
+
+export class SimpleRegexpRedactor implements ISyncRedactor {
+  regexpMatcher: RegExp;
+  replaceWith: string;
+
+  constructor({
+    replaceWith = snakeCase('default').toUpperCase(),
+    regexpPattern: regexpMatcher,
+  }: {
+    replaceWith: string;
+    regexpPattern: RegExp;
+  }) {
+    this.replaceWith = replaceWith;
+    this.regexpMatcher = regexpMatcher;
+  }
+
+  redact(textToRedact: string) {
+    return textToRedact.replace(this.regexpMatcher, this.replaceWith);
+  }
+}

package/src/redact/built-ins/simple-regexp-patterns.ts

@@ -0,0 +1,20 @@
+const aptRegex = /(apt|bldg|dept|fl|hngr|lot|pier|rm|ste|slip|trlr|unit|#)\.? *[a-z0-9-]+\b/gi;
+const poBoxRegex = /P\.? ?O\.? *Box +\d+/gi;
+const roadRegex = /(street|st|road|rd|avenue|ave|drive|dr|loop|court|ct|circle|cir|lane|ln|boulevard|blvd|way)\.?\b/gi;
+
+export const creditCardNumber = /\d{4}[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}|\d{4}[ -]?\d{6}[ -]?\d{4}\d?/g;
+export const streetAddress = new RegExp(
+  '(\\d+\\s*(\\w+ ){1,2}' + roadRegex.source + '(\\s+' + aptRegex.source + ')?)|(' + poBoxRegex.source + ')',
+  'gi'
+);
+export const zipcode = /\b\d{5}\b(-\d{4})?\b/g;
+export const phoneNumber =
+  /(\(?\+?[0-9]{1,2}\)?[-. ]?)?(\(?[0-9]{3}\)?|[0-9]{3})[-. ]?([0-9]{3}[-. ]?[0-9]{4}|\b[A-Z0-9]{7}\b)/g;
+export const ipAddress = /(\d{1,3}(\.\d{1,3}){3}|[0-9A-F]{4}(:[0-9A-F]{4}){5}(::|(:0000)+))/gi;
+export const usSocialSecurityNumber = /\b\d{3}[ -.]\d{2}[ -.]\d{4}\b/g;
+export const emailAddress = /([a-z0-9_\-.+]+)@\w+(\.\w+)*/gi;
+export const username = /(user( ?name)?|login): \S+/gi;
+export const password = /(pass(word|phrase)?|secret): \S+/gi;
+export const credentials = /(login( cred(ential)?s| info(rmation)?)?|cred(ential)?s) ?:\s*\S+\s+\/?\s*\S+/gi;
+export const digits = /\b\d{4,}\b/g;
+export const url = /([^\s:/?#]+):\/\/([^/?#\s]*)([^?#\s]*)(\?([^#\s]*))?(#([^\s]*))?/g;