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

package/src/redact/composition.ts

@@ -0,0 +1,54 @@
+import { NameRedactor } from './built-ins/NameRedactor';
+import * as simpleRegexpBuiltIns from './built-ins/simple-regexp-patterns';
+import { SimpleRegexpRedactor } from './built-ins/SimpleRegexpRedactor';
+import {
+  AsyncCustomRedactorConfig,
+  IAsyncRedactor,
+  CompositeRedactorOptions,
+  SyncCustomRedactorConfig,
+  ISyncRedactor,
+} from './types';
+import { isSimpleRegexpCustomRedactorConfig, snakeCase } from './utils';
+
+function normalizeCustomRedactorConfig(redactorConfig: any) {
+  return isSimpleRegexpCustomRedactorConfig(redactorConfig)
+    ? new SimpleRegexpRedactor({
+        regexpPattern: redactorConfig.regexpPattern,
+        replaceWith: redactorConfig.replaceWith,
+      })
+    : redactorConfig;
+}
+
+export function composeChildRedactors<T extends AsyncCustomRedactorConfig>(opts: CompositeRedactorOptions<T> = {}) {
+  const childRedactors: T extends SyncCustomRedactorConfig
+    ? Array<ISyncRedactor>
+    : Array<IAsyncRedactor | ISyncRedactor> = [] as any;
+
+  if (opts.customRedactors && opts.customRedactors.before) {
+    opts.customRedactors.before.map(normalizeCustomRedactorConfig).forEach((redactor) => childRedactors.push(redactor));
+  }
+
+  for (const regexpName of Object.keys(simpleRegexpBuiltIns)) {
+    if (
+      !opts.builtInRedactors ||
+      !(opts.builtInRedactors as any)[regexpName] ||
+      (opts.builtInRedactors as any)[regexpName].enabled !== false
+    ) {
+      childRedactors.push(
+        new SimpleRegexpRedactor({
+          regexpPattern: (simpleRegexpBuiltIns as any)[regexpName],
+          replaceWith: opts.globalReplaceWith || snakeCase(regexpName).toUpperCase(),
+        })
+      );
+    }
+  }
+
+  if (!opts.builtInRedactors || !opts.builtInRedactors.names || opts.builtInRedactors.names.enabled !== false) {
+    childRedactors.push(new NameRedactor(opts.globalReplaceWith));
+  }
+
+  if (opts.customRedactors && opts.customRedactors.after) {
+    opts.customRedactors.after.map(normalizeCustomRedactorConfig).forEach((redactor) => childRedactors.push(redactor));
+  }
+  return childRedactors;
+}

package/src/redact/index.ts

@@ -0,0 +1,21 @@
+import { composeChildRedactors } from './composition';
+import { CompositeRedactorOptions, ISyncRedactor, SyncCustomRedactorConfig } from './types';
+
+/** @public */
+export interface SyncCompositeRedactorOptions extends CompositeRedactorOptions<SyncCustomRedactorConfig> {}
+
+/** @public */
+export class SyncRedactor implements ISyncRedactor {
+  private childRedactors: ISyncRedactor[] = [];
+
+  constructor(opts?: SyncCompositeRedactorOptions) {
+    this.childRedactors = composeChildRedactors(opts);
+  }
+
+  redact = (textToRedact: string) => {
+    for (const redactor of this.childRedactors) {
+      textToRedact = redactor.redact(textToRedact);
+    }
+    return textToRedact;
+  };
+}

package/src/redact/types.ts

@@ -0,0 +1,34 @@
+import * as simpleRegexpBuiltIns from './built-ins/simple-regexp-patterns';
+
+export interface ISyncRedactor {
+  redact(textToRedact: string): string;
+}
+
+export interface IAsyncRedactor {
+  redactAsync(textToRedact: string): Promise<string>;
+}
+
+export type IRedactor = ISyncRedactor | IAsyncRedactor;
+
+export interface SimpleRegexpCustomRedactorConfig {
+  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;
+    };
+  };
+  customRedactors?: {
+    before?: Array<T>;
+    after?: Array<T>;
+  };
+}

package/src/redact/utils.ts

@@ -0,0 +1,15 @@
+import { SimpleRegexpCustomRedactorConfig, AsyncCustomRedactorConfig, ISyncRedactor, IRedactor } from './types';
+
+export function isSimpleRegexpCustomRedactorConfig(
+  redactor: AsyncCustomRedactorConfig
+): redactor is SimpleRegexpCustomRedactorConfig {
+  return typeof (redactor as SimpleRegexpCustomRedactorConfig).regexpPattern !== 'undefined';
+}
+
+export function isSyncRedactor(redactor: IRedactor): redactor is ISyncRedactor {
+  return typeof (redactor as ISyncRedactor).redact === 'function';
+}
+
+export function snakeCase(str: string) {
+  return str.replace(/[A-Z]/g, (letter, index) => (index !== 0 ? `_${letter.toLowerCase()}` : letter.toLowerCase()));
+}

package/src/{utils → screenshot}/redact.ts

@@ -1,4 +1,4 @@
-import { SyncRedactor } from "redact-pii";
+import { SyncRedactor } from "./../redact/index";
 
 const customRedactors = {
     before: [

package/src/tracker.ts

@@ -2,7 +2,7 @@ import { Tracker } from './index';
 
 declare global {
   interface Window {
-    tracker: {
+    BrainfishAnalytics: {
       q?: [string, ...any[]];
       (method: string, ...args: any[]): void;
     };
@@ -10,8 +10,8 @@ declare global {
 }
 
 ((window) => {
-  if (window.tracker && 'q' in window.tracker) {
-    const queue = window.tracker.q || [];
+  if (window.BrainfishAnalytics && 'q' in window.BrainfishAnalytics) {
+    const queue = window.BrainfishAnalytics.q || [];
     const tracker = new Tracker(queue.shift()[1]) as any;
     queue.forEach((item) => {
       if (item[0] in tracker) {
@@ -19,12 +19,12 @@ declare global {
       }
     });
 
-    window.tracker = (t, ...args) => {
+    window.BrainfishAnalytics = (t, ...args) => {
       const fn = tracker[t] ? tracker[t].bind(tracker) : undefined;
       if (typeof fn === 'function') {
         fn(...args);
       } else {
-        console.warn(`tracker.js: ${t} is not a function`);
+        console.warn(`Method ${t} does not exist on BrainfishAnalytics`);
       }
     };
   }

package/src/vite-env.d.ts

@@ -1 +1,7 @@
-declare const __PACKAGE_VERSION__: string;
+interface ImportMetaEnv {
+    readonly PACKAGE_VERSION: string;
+}
+
+interface ImportMeta {
+    readonly env: ImportMetaEnv;
+}

package/tsconfig.json

@@ -8,8 +8,9 @@
     "esModuleInterop": true,
     "types": ["vite/client", "jest"],
     "baseUrl": ".",
-    "declaration": true
+    "declaration": true,
+    "resolveJsonModule": true
   },
-  "include": ["src"],
+  "include": ["src", "./package.json"],
   "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts", "src/**/tests/**"]
 }

package/vite.config.ts

@@ -4,7 +4,6 @@ import dts from 'vite-plugin-dts';
 import compression from 'vite-plugin-compression';
 import { visualizer } from 'rollup-plugin-visualizer';
 import tsconfigPaths from 'vite-tsconfig-paths';
-import { replaceCodePlugin } from 'vite-plugin-replace';
 import { version } from './package.json';
 
 export default defineConfig({
@@ -17,24 +16,17 @@ export default defineConfig({
     }),
     compression(),
     visualizer(),
-    replaceCodePlugin({
-      replacements: [
-        {
-          from: "__PACKAGE_VERSION__",
-          to: `"${version}"`,
-        },
-      ],
-    }),
   ],
   build: {
-    target: 'esnext',
-    sourcemap: false,
+    target: 'es2015',
+    sourcemap: true,
     lib: {
-      entry: ['index.ts', 'src/tracker.ts'],
-      formats: ['es'],
-      fileName: (format, entryName) => `${entryName}.js`,
+      entry: 'index.ts',
+      name: 'BrainfishAnalytics',
+      formats: ['es', 'cjs'],
+      fileName: (format, entry) => `${entry}${format === 'es' ? '' : '.cjs'}.js`,
     },
-    minify: false,
+    minify: true,
     terserOptions: {
       compress: {
         drop_console: true,
@@ -45,15 +37,19 @@ export default defineConfig({
       treeshake: true,
       plugins: [terser()],
       external: ['@google-cloud/dlp'],
+      output: {
+        inlineDynamicImports: true, // Ensures all imports are inlined into the main bundle
+        manualChunks: undefined, // Disables code splitting
+      },
     },
   },
   test: {
     environment: 'jsdom',
   },
   define: {
-    __PACKAGE_VERSION__: version,
+    'import.meta.env.PACKAGE_VERSION': JSON.stringify(version),
   },
   optimizeDeps: {
     include: ['@brainfish-ai/tracker-sdk'],
-  }
+  },
 });