@brainfish-ai/web-tracker 0.0.4-alpha.21 → 0.0.4-alpha.23

package/dist/src/index.d.ts

@@ -0,0 +1,22 @@
+import { TrackerSdkOptions, TrackProperties, TrackerSdk } from '@brainfish-ai/tracker-sdk';
+export type * from '@brainfish-ai/tracker-sdk';
+export type TrackerOptions = TrackerSdkOptions & {
+    trackOutgoingLinks?: boolean;
+    trackScreenViews?: boolean;
+    trackAttributes?: boolean;
+    trackHashChanges?: boolean;
+};
+export declare const VERSION: string;
+export declare class Tracker extends TrackerSdk {
+    options: TrackerOptions;
+    private lastPath;
+    private debounceTimer;
+    constructor(options: TrackerOptions);
+    private debounce;
+    private isServer;
+    trackOutgoingLinks(): void;
+    trackScreenViews(): void;
+    trackAttributes(): void;
+    screenView(properties?: TrackProperties): Promise<void>;
+    screenView(path: string, properties?: TrackProperties): Promise<void>;
+}

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

@@ -0,0 +1,6 @@
+import { ISyncRedactor } from '../types';
+export declare class NameRedactor implements ISyncRedactor {
+    private replaceWith;
+    constructor(replaceWith?: string);
+    redact(textToRedact: string): string;
+}

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

@@ -0,0 +1,10 @@
+import { ISyncRedactor } from '../types';
+export declare class SimpleRegexpRedactor implements ISyncRedactor {
+    regexpMatcher: RegExp;
+    replaceWith: string;
+    constructor({ replaceWith, regexpPattern: regexpMatcher, }: {
+        replaceWith: string;
+        regexpPattern: RegExp;
+    });
+    redact(textToRedact: string): string;
+}

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

@@ -0,0 +1,12 @@
+export declare const creditCardNumber: RegExp;
+export declare const streetAddress: RegExp;
+export declare const zipcode: RegExp;
+export declare const phoneNumber: RegExp;
+export declare const ipAddress: RegExp;
+export declare const usSocialSecurityNumber: RegExp;
+export declare const emailAddress: RegExp;
+export declare const username: RegExp;
+export declare const password: RegExp;
+export declare const credentials: RegExp;
+export declare const digits: RegExp;
+export declare const url: RegExp;

package/dist/src/redact/built-ins/well-known-names.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/dist/src/redact/composition.d.ts

@@ -0,0 +1,2 @@
+import { AsyncCustomRedactorConfig, IAsyncRedactor, CompositeRedactorOptions, SyncCustomRedactorConfig, ISyncRedactor } from './types';
+export declare function composeChildRedactors<T extends AsyncCustomRedactorConfig>(opts?: CompositeRedactorOptions<T>): T extends SyncCustomRedactorConfig ? ISyncRedactor[] : (ISyncRedactor | IAsyncRedactor)[];

package/dist/src/redact/index.d.ts

@@ -0,0 +1,10 @@
+import { CompositeRedactorOptions, ISyncRedactor, SyncCustomRedactorConfig } from './types';
+/** @public */
+export interface SyncCompositeRedactorOptions extends CompositeRedactorOptions<SyncCustomRedactorConfig> {
+}
+/** @public */
+export declare class SyncRedactor implements ISyncRedactor {
+    private childRedactors;
+    constructor(opts?: SyncCompositeRedactorOptions);
+    redact: (textToRedact: string) => string;
+}

package/{src/redact/types.ts → dist/src/redact/types.d.ts}

@@ -1,34 +1,27 @@
 import * as simpleRegexpBuiltIns from './built-ins/simple-regexp-patterns';
-
 export interface ISyncRedactor {
-  redact(textToRedact: string): string;
+    redact(textToRedact: string): string;
 }
-
 export interface IAsyncRedactor {
-  redactAsync(textToRedact: string): Promise<string>;
+    redactAsync(textToRedact: string): Promise<string>;
 }
-
 export type IRedactor = ISyncRedactor | IAsyncRedactor;
-
 export interface SimpleRegexpCustomRedactorConfig {
-  regexpPattern: RegExp;
-  replaceWith: string;
+    regexpPattern: RegExp;
+    replaceWith: string;
 }
-
 export type SyncCustomRedactorConfig = SimpleRegexpCustomRedactorConfig | ISyncRedactor;
-
 export type AsyncCustomRedactorConfig = SyncCustomRedactorConfig | IAsyncRedactor;
-
 export interface CompositeRedactorOptions<T extends AsyncCustomRedactorConfig> {
-  globalReplaceWith?: string;
-  builtInRedactors?: {
-    [RedactorName in keyof typeof simpleRegexpBuiltIns | 'names']?: {
-      enabled?: boolean;
-      replaceWith?: string;
+    globalReplaceWith?: string;
+    builtInRedactors?: {
+        [RedactorName in keyof typeof simpleRegexpBuiltIns | 'names']?: {
+            enabled?: boolean;
+            replaceWith?: string;
+        };
     };
-  };
-  customRedactors?: {
-    before?: Array<T>;
-    after?: Array<T>;
-  };
-}
+    customRedactors?: {
+        before?: Array<T>;
+        after?: Array<T>;
+    };
+}

package/dist/src/redact/utils.d.ts

@@ -0,0 +1,4 @@
+import { SimpleRegexpCustomRedactorConfig, AsyncCustomRedactorConfig, ISyncRedactor, IRedactor } from './types';
+export declare function isSimpleRegexpCustomRedactorConfig(redactor: AsyncCustomRedactorConfig): redactor is SimpleRegexpCustomRedactorConfig;
+export declare function isSyncRedactor(redactor: IRedactor): redactor is ISyncRedactor;
+export declare function snakeCase(str: string): string;

package/dist/src/screenshot/capture.d.ts

@@ -0,0 +1,2 @@
+declare function captureScreenshot(domBody: HTMLElement): Promise<string>;
+export { captureScreenshot };

package/dist/src/screenshot/redact.d.ts

@@ -0,0 +1,3 @@
+declare function redactTextContent(text: string): string;
+declare function redactPIIInDOM(element: Element): void;
+export { redactPIIInDOM, redactTextContent };

package/dist/src/screenshot/snapshot.d.ts

@@ -0,0 +1,2 @@
+declare function screenshot(): Promise<string | undefined>;
+export { screenshot };

package/dist/src/tracker.d.ts

@@ -0,0 +1,9 @@
+declare global {
+    interface Window {
+        BrainfishAnalytics: {
+            q?: [string, ...any[]];
+            (method: string, ...args: any[]): void;
+        };
+    }
+}
+export {};

package/dist/tracker.cjs.js

@@ -0,0 +1,2 @@
+"use strict";const a=require("./index.cjs.js");(n=>{if(n.BrainfishAnalytics&&"q"in n.BrainfishAnalytics){const t=n.BrainfishAnalytics.q||[],s=new a.Tracker(t.shift()[1]);t.forEach(i=>{i[0]in s&&s[i[0]](...i.slice(1))}),n.BrainfishAnalytics=(i,...o)=>{const c=s[i]?s[i].bind(s):void 0;typeof c=="function"?c(...o):console.warn(`Method ${i} does not exist on BrainfishAnalytics`)}}})(window);
+//# sourceMappingURL=tracker.cjs.js.map

package/dist/tracker.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracker.cjs.js","sources":["../src/tracker.ts"],"sourcesContent":["import { Tracker } from './index';\n\ndeclare global {\n  interface Window {\n    BrainfishAnalytics: {\n      q?: [string, ...any[]];\n      (method: string, ...args: any[]): void;\n    };\n  }\n}\n\n((window) => {\n  if (window.BrainfishAnalytics && 'q' in window.BrainfishAnalytics) {\n    const queue = window.BrainfishAnalytics.q || [];\n    const tracker = new Tracker(queue.shift()[1]) as any;\n    queue.forEach((item) => {\n      if (item[0] in tracker) {\n        tracker[item[0]](...item.slice(1));\n      }\n    });\n\n    window.BrainfishAnalytics = (t, ...args) => {\n      const fn = tracker[t] ? tracker[t].bind(tracker) : undefined;\n      if (typeof fn === 'function') {\n        fn(...args);\n      } else {\n        console.warn(`Method ${t} does not exist on BrainfishAnalytics`);\n      }\n    };\n  }\n})(window);\n"],"names":["window","BrainfishAnalytics","queue","q","tracker","Tracker","shift","forEach","item","slice","t","args","fn","bind","console","warn"],"mappings":"gDAWEA,GAAAA,CACA,GAAIA,EAAOC,oBAAsB,MAAOD,EAAOC,mBAAoB,CACjE,MAAMC,EAAQF,EAAOC,mBAAmBE,GAAK,CAAA,EACvCC,EAAU,IAAIC,UAAQH,EAAMI,MAAAA,EAAQ,CACpCJ,CAAAA,EAAAA,EAAAK,QAASC,GAAAA,CACTA,EAAK,CAAMJ,IAAAA,GACLA,EAAAI,EAAK,CAAOA,CAAAA,EAAAA,GAAAA,EAAKC,MAAM,CAAA,CAAA,CACjC,CAGFT,EAAAA,EAAOC,mBAAqB,CAACS,KAAMC,IAAAA,CAC3B,MAAAC,EAAKR,EAAQM,CAAKN,EAAAA,EAAQM,CAAGG,EAAAA,KAAKT,CAAW,EAAA,OACxCQ,OAAAA,GAAO,WAChBA,EAAMD,GAAAA,CAAAA,EAEEG,QAAAC,KAAK,UAAUL,CAAAA,uCAAAA,CACzB,CAEJ,CACF,GAAGV,MAAAA"}

package/dist/tracker.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/tracker.js

@@ -0,0 +1,13 @@
+import { Tracker as c } from "./index.js";
+((s) => {
+  if (s.BrainfishAnalytics && "q" in s.BrainfishAnalytics) {
+    const o = s.BrainfishAnalytics.q || [], n = new c(o.shift()[1]);
+    o.forEach((i) => {
+      i[0] in n && n[i[0]](...i.slice(1));
+    }), s.BrainfishAnalytics = (i, ...t) => {
+      const a = n[i] ? n[i].bind(n) : void 0;
+      typeof a == "function" ? a(...t) : console.warn(`Method ${i} does not exist on BrainfishAnalytics`);
+    };
+  }
+})(window);
+//# sourceMappingURL=tracker.js.map

package/dist/tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracker.js","sources":["../src/tracker.ts"],"sourcesContent":["import { Tracker } from './index';\n\ndeclare global {\n  interface Window {\n    BrainfishAnalytics: {\n      q?: [string, ...any[]];\n      (method: string, ...args: any[]): void;\n    };\n  }\n}\n\n((window) => {\n  if (window.BrainfishAnalytics && 'q' in window.BrainfishAnalytics) {\n    const queue = window.BrainfishAnalytics.q || [];\n    const tracker = new Tracker(queue.shift()[1]) as any;\n    queue.forEach((item) => {\n      if (item[0] in tracker) {\n        tracker[item[0]](...item.slice(1));\n      }\n    });\n\n    window.BrainfishAnalytics = (t, ...args) => {\n      const fn = tracker[t] ? tracker[t].bind(tracker) : undefined;\n      if (typeof fn === 'function') {\n        fn(...args);\n      } else {\n        console.warn(`Method ${t} does not exist on BrainfishAnalytics`);\n      }\n    };\n  }\n})(window);\n"],"names":["window","BrainfishAnalytics","queue","q","tracker","Tracker","shift","forEach","item","slice","t","args","fn","bind","console","warn"],"mappings":";CAWEA,CAAAA,MACA;AAAA,MAAIA,EAAOC,sBAAsB,OAAOD,EAAOC,oBAAoB;AACjE,UAAMC,IAAQF,EAAOC,mBAAmBE,KAAK,CAAA,GACvCC,IAAU,IAAIC,EAAQH,EAAMI,MAAQ,EAAA,CAAA,CAAA;AACpCJ,IAAAA,EAAAK,QAASC,OACTA;AAAAA,QAAK,CAAMJ,KAAAA,KACLA,EAAAI,EAAK,CAAOA,CAAAA,EAAAA,GAAAA,EAAKC,MAAM,CAAA,CAAA;AAAA,IACjC,CAGFT,GAAAA,EAAOC,qBAAqB,CAACS,MAAMC,MAAAA;AAC3B,YAAAC,IAAKR,EAAQM,CAAAA,IAAKN,EAAQM,CAAAA,EAAGG,KAAKT,CAAAA,IAAAA;AACtB,MAAA,OAAPQ,KAAO,aAChBA,EAAAA,GAAMD,CAEEG,IAAAA,QAAAC,KAAK,UAAUL,CACzB,uCAAA;AAAA,IAAA;AAAA,EAEJ;AACF,GAAGV,MAAAA;"}

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@brainfish-ai/web-tracker",
-  "version": "0.0.4-alpha.21",
+  "version": "0.0.4-alpha.23",
   "main": "dist/index.js",
   "description": "Brainfish Tracker for Web",
   "private": false,
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "start": "vite",
     "dev": "vite",

package/index.ts

@@ -1,2 +0,0 @@
-export * from './src/index';
-export * from './src/types.d';

package/postcss.config.cjs

@@ -1,6 +0,0 @@
-module.exports = {
-  plugins: {
-    tailwindcss: {},
-    autoprefixer: {},
-  },
-}

package/set-version.js

@@ -1,13 +0,0 @@
-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

@@ -1,192 +0,0 @@
-/* eslint-disable @typescript-eslint/unbound-method */
-
-import type {
-  TrackerSdkOptions,
-  TrackProperties,
-} from '@brainfish-ai/tracker-sdk';
-import { TrackerSdk } from '@brainfish-ai/tracker-sdk';
-import { screenshot } from './screenshot/snapshot';
-
-export type * from '@brainfish-ai/tracker-sdk';
-
-export type TrackerOptions = TrackerSdkOptions & {
-  trackOutgoingLinks?: boolean;
-  trackScreenViews?: boolean;
-  trackAttributes?: boolean;
-  trackHashChanges?: boolean;
-};
-
-function toCamelCase(str: string) {
-  return str.replace(/([-_][a-z])/gi, ($1) =>
-    $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;
-
-  constructor(public options: TrackerOptions) {
-    super({
-      sdk: 'web',
-      sdkVersion: VERSION,
-      ...options,
-    });
-
-    if (!this.isServer()) {
-      this.setGlobalProperties({
-        __referrer: document.referrer,
-      });
-
-      if (this.options.trackOutgoingLinks) {
-        this.trackOutgoingLinks();
-      }
-
-      if (this.options.trackScreenViews) {
-        this.trackScreenViews();
-      }
-
-      if (this.options.trackAttributes) {
-        this.trackAttributes();
-      }
-    }
-  }
-
-  private debounce(func: () => void, delay: number) {
-    this.debounceTimer && clearTimeout(this.debounceTimer);
-    this.debounceTimer = setTimeout(func, delay);
-  }
-
-  private isServer() {
-    return typeof document === 'undefined';
-  }
-
-  public trackOutgoingLinks() {
-    if (this.isServer()) {
-      return;
-    }
-
-    document.addEventListener('click', (event) => {
-      const target = event.target as HTMLElement;
-      const link = target.closest('a');
-      if (link && target) {
-        const href = link.getAttribute('href');
-        if (href?.startsWith('http')) {
-          super.track('link_out', {
-            href,
-            text:
-              link.innerText ||
-              link.getAttribute('title') ||
-              target.getAttribute('alt') ||
-              target.getAttribute('title'),
-          });
-        }
-      }
-    });
-  }
-
-  public trackScreenViews() {
-    if (this.isServer()) {
-      return;
-    }
-
-    this.screenView();
-
-    const oldPushState = history.pushState;
-    history.pushState = function pushState(...args) {
-      const ret = oldPushState.apply(this, args);
-      window.dispatchEvent(new Event('pushstate'));
-      window.dispatchEvent(new Event('locationchange'));
-      return ret;
-    };
-
-    const oldReplaceState = history.replaceState;
-    history.replaceState = function replaceState(...args) {
-      const ret = oldReplaceState.apply(this, args);
-      window.dispatchEvent(new Event('replacestate'));
-      window.dispatchEvent(new Event('locationchange'));
-      return ret;
-    };
-
-    window.addEventListener('popstate', function () {
-      window.dispatchEvent(new Event('locationchange'));
-    });
-
-    const eventHandler = () => this.debounce(() => this.screenView(), 50);
-
-    if (this.options.trackHashChanges) {
-      window.addEventListener('hashchange', eventHandler);
-    } else {
-      window.addEventListener('locationchange', eventHandler);
-    }
-  }
-
-  public trackAttributes() {
-    if (this.isServer()) {
-      return;
-    }
-
-    document.addEventListener('click', (event) => {
-      const target = event.target as HTMLElement;
-      const btn = target.closest('button');
-      const anchor = target.closest('a');
-      const element = btn?.getAttribute('data-track')
-        ? btn
-        : anchor?.getAttribute('data-track')
-        ? anchor
-        : null;
-      if (element) {
-        const properties: Record<string, unknown> = {};
-        for (const attr of element.attributes) {
-          if (attr.name.startsWith('data-') && attr.name !== 'data-track') {
-            properties[toCamelCase(attr.name.replace(/^data-/, ''))] =
-              attr.value;
-          }
-        }
-        const name = element.getAttribute('data-track');
-        if (name) {
-          super.track(name, properties);
-        }
-      }
-    });
-  }
-
-  async screenView(properties?: TrackProperties): Promise<void>;
-  async screenView(path: string, properties?: TrackProperties): Promise<void>;
-  async screenView(
-    pathOrProperties?: string | TrackProperties,
-    propertiesOrUndefined?: TrackProperties
-  ): Promise<void> {
-    if (this.isServer()) {
-      return;
-    }
-
-    let path: string;
-    let properties: TrackProperties | undefined;
-
-    if (typeof pathOrProperties === 'string') {
-      path = pathOrProperties;
-      properties = propertiesOrUndefined;
-    } else {
-      path = window.location.href;
-      properties = pathOrProperties;
-    }
-
-    if (this.lastPath === path) {
-      return;
-    }
-
-    // capture screenshot
-    const snapshot = await screenshot();
-
-    this.lastPath = path;
-    super.track('screen_view', {
-      ...(properties ?? {}),
-      __screenshot: snapshot,
-      __path: path,
-      __title: document.title,
-    });
-  }
-}

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

@@ -1,41 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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;