mixpanel-browser 2.72.0 → 2.74.0

package/.claude/settings.local.json

@@ -1,9 +1,12 @@
 {
   "permissions": {
     "allow": [
-      "Bash(mkdir:*)"
+      "Bash(mkdir:*)",
+      "Bash(cat:*)",
+      "Bash(node --input-type=module -e \"import { expect } from 'chai'; console.log\\('works'\\);\":*)",
+      "Bash(BABEL_ENV=test node:*)"
     ],
     "deny": [],
     "ask": []
   }
-}
+}

package/.eslintrc.json

@@ -8,7 +8,9 @@
         "sourceType": "module"
     },
     "rules": {
-        "camelcase": "error",
+        "camelcase": ["error", {
+            "properties": "never"
+        }],
         "eol-last": "error",
         "eqeqeq": "error",
         "indent":
@@ -29,13 +31,14 @@
         ]
     },
     "overrides": [{
-        "files": ["tests/unit/**/*.js"],
+        "files": ["tests/unit/**/*.js", "tests/browser/**/*.js", "*.mjs"],
         "parserOptions": {
-            "ecmaVersion": 8,
+            "ecmaVersion": 9,
             "sourceType": "module"
         },
         "env": {
-            "mocha": true
+            "mocha": true,
+            "node": true
         },
         "rules": {
             "camelcase": "error",

package/.github/workflows/integration-tests.yml

@@ -0,0 +1,52 @@
+name: Integration Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      checks: write  # for dorny/test-reporter to post results
+
+    strategy:
+      fail-fast: false
+      matrix:
+        browser: [chrome-latest, edge-latest, safari-latest, firefox-latest, ios-safari-sim, android-chrome-sim]
+
+    env:
+      SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+      SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+      SAUCE_TUNNEL_NAME: ci-js-sdk-test-${{ matrix.browser }}-${{ github.run_id }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build-full
+
+      - name: Sauce test
+        # for some reason, android emulator tests don't work with localhost so we need an IP to give to the runner...
+        run: BROWSER=${{ matrix.browser }} ROOT_DIR=$(pwd) SAUCE_HOST=$(hostname -I | awk '{print $1; exit}') npm run integration-test:sauce
+
+      - name: Test Report
+        uses: dorny/test-reporter@7b7927aa7da8b82e81e755810cb51f39941a2cc7 # v2
+        if: success() || failure() # run this step even if previous step failed
+        with:
+          name: Browser Tests            # Name of the check run which will be created
+          reporter: mocha-json        # Format of test results
+          path: 'tests/browser/results/*.json'    # Path to test results
+          list-tests: 'failed'
+          fail-on-error: 'false'

package/.github/workflows/unit-tests.yml

@@ -0,0 +1,40 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      checks: write  # for dorny/test-reporter to post results
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run test:ci
+      - run: npm run build-dist
+
+      - name: Test Report
+        uses: dorny/test-reporter@7b7927aa7da8b82e81e755810cb51f39941a2cc7 # v2
+        if: success() || failure()
+        with:
+          name: Unit Tests
+          reporter: mocha-json
+          path: 'tests/unit/results/*.json'
+          list-tests: 'failed'
+          fail-on-error: 'false'
+

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+**2.74.0** (27 Jan 2026)
+- New session recording masking configuration options, including the ability to unmask inputs and allowlist-based selector masking.
+- Adds initial support for the remote settings API, allowing remote configuration of SDK config options.
+- Adds new automated browser test suite that runs in CI and locally in chrome headless. See tests/browser/README.html for more information.
+- Fixes type definitions for api_routes
+- Removes outdated examples in the examples/ dir
+
+**2.73.0** (23 Dec 2025)
+- Adds several new hooks: `before_identify`, `before_register`, `before_register_once`, `before_track`, `before_unregister`
+- Adds instance-initialization notification to allow Data Inspector browser extension to hook into SDK actions
+- Fixes and extends type definitions
+
 **2.72.0** (14 Nov 2025)
 - Adds Autocapture rage-click configuration option `interactive_elements_only`, to ignore clicks on non-interactive page elements such as text. Configure with: `mixpanel.init('<TOKEN>', {autocapture: {rage_click: {interactive_elements_only: true}}})`
 - Adds TypeScript types for Feature Flags subsystem (`mixpanel.flags`)

package/README.md

@@ -67,7 +67,7 @@ mixpanel.init('YOUR_TOKEN', {autocapture: true, debug: true, persistence: 'local
 - Install development dependencies: `npm install`
 - Run unit tests: `npm test`
 - Start test server for browser tests: `npm run integration_test`
-- Browse to [http://localhost:3000/tests/](http://localhost:3000/tests/) and choose a scenario to run
+- Browse to [http://localhost:3001/tests/](http://localhost:3001/tests/) and choose a scenario to run
 
 In the future we plan to automate the last step with a headless browser to streamline development (although
 Mixpanel production releases are tested against a large matrix of browsers and operating systems).

package/build.sh

@@ -19,15 +19,11 @@ if [ ! -z "$FULL" ]; then
     npx webpack tests/module-cjs.js tests/module-cjs.bundle.js
     npx browserify tests/module-es2015.js -t [ babelify --compact false ] --outfile tests/module-es2015.bundle.js
 
-    echo 'Bundling module-loader examples'
-    pushd examples/commonjs-browserify; npm install && npm run build; popd
-    pushd examples/es2015-babelify; npm install && npm run build; popd
-    pushd examples/umd-webpack; npm install && npm run build; popd
     pushd examples/typescript; npm install && npm run build; popd
 fi
 
 if [ ! -z "$DIST" ]; then
     echo 'Copying to dist/'
     rm -r dist
-    cp -r build dist
+    rsync -av --exclude='test' build/ dist/
 fi

package/dist/mixpanel-core.cjs.d.ts

@@ -2,10 +2,12 @@ export type Persistence = "cookie" | "localStorage";
 
 export type ApiPayloadFormat = "base64" | "json";
 
-export type PushItem = Array<string | Dict>;
+export type PushItem = Array<string | Dict | ((this: Mixpanel) => void)>;
 
 export type Query = string | Element | Element[];
 
+export type RemoteSettingType = "disabled" | "fallback" | "strict";
+
 export interface Dict {
   [key: string]: any;
 }
@@ -155,22 +157,32 @@ export interface FlagsConfig {
   context: Dict;
 }
 
+export interface BeforeSendHookPayload {
+  event: string;
+  properties: Record<string, any>;
+}
+
 export interface Config {
   api_host: string;
   api_routes: {
     track?: string;
     engage?: string;
     groups?: string;
+    record?: string;
+    flags?: string;
   };
   api_method: string;
   api_transport: string;
   app_host: string;
   api_payload_format: ApiPayloadFormat;
   autotrack: boolean;
+  batch_autostart: boolean;
+  batch_requests: boolean;
   cdn: string;
   cookie_domain: string;
   cross_site_cookie: boolean;
   cross_subdomain_cookie: boolean;
+  error_reporter: (msg: string, err?: Error) => void;
   flags: boolean | FlagsConfig;
   persistence: Persistence;
   persistence_name: string;
@@ -207,24 +219,54 @@ export interface Config {
   inapp_protocol: string;
   inapp_link_new_window: boolean;
   ignore_dnt: boolean;
-  batch_requests: boolean;
   batch_size: number;
   batch_flush_interval_ms: number;
   batch_request_timeout_ms: number;
+  recorder_src: string;
   record_block_class: string | RegExp;
   record_block_selector: string;
   record_collect_fonts: boolean;
   record_idle_timeout_ms: number;
   record_inline_images: boolean;
   record_mask_text_class: string | RegExp;
-  record_mask_text_selector: string;
+  record_mask_text_selector: string | string[];
+  record_unmask_text_selector: string | string[];
+  record_mask_all_text: boolean;
+  record_mask_input_selector: string | string[];
+  record_unmask_input_selector: string | string[];
+  record_mask_all_inputs: boolean;
   record_min_ms: number;
   record_max_ms: number;
   record_sessions_percent: number;
   record_canvas: boolean;
   record_heatmap_data: boolean;
+  remote_settings_mode: RemoteSettingType;
+  hooks: {
+    before_identify?: (new_distinct_id: string) => string | null;
+    before_register?: (
+      props: Dict,
+      days_or_options?: number | Partial<RegisterOptions>
+    ) => Dict | Array<Dict | number | Partial<RegisterOptions>> | null;
+    before_register_once?: (
+      props: Dict,
+      default_value?: any,
+      days_or_options?: number | Partial<RegisterOptions>
+    ) => Dict | Array<any | Dict | number | Partial<RegisterOptions>> | null;
+    before_send_events?: (
+      event: BeforeSendHookPayload
+    ) => BeforeSendHookPayload | null;
+    before_track?: (
+      event_name: string,
+      properties: Dict
+    ) => string | Array<string | Dict> | null;
+    before_unregister?: (
+      property: string,
+      options?: Partial<RegisterOptions>
+    ) => string | Partial<RegisterOptions> | null;
+  };
 }
 
+
 export type VerboseResponse =
   | {
       status: 1;
@@ -323,10 +365,11 @@ export interface Mixpanel {
   get_distinct_id(): any;
   get_group(group_key: string, group_id: string): Group;
   get_property(property_name: string): any;
+  get_session_replay_url(): string;
   has_opted_in_tracking(options?: Partial<HasOptedInOutOptions>): boolean;
   has_opted_out_tracking(options?: Partial<HasOptedInOutOptions>): boolean;
   identify(unique_id?: string): any;
-  init(token: string, config: Partial<Config>, name: string): Mixpanel;
+  init(token: string, config: Partial<Config>, name?: string): Mixpanel;
   opt_in_tracking(options?: Partial<InTrackingOptions>): void;
   opt_out_tracking(options?: Partial<OutTrackingOptions>): void;
   push(item: PushItem): void;
@@ -351,6 +394,7 @@ export interface Mixpanel {
     group_ids: string | string[] | number | number[],
     callback?: Callback
   ): void;
+  start_batch_senders(): void;
   time_event(event_name: string): void;
   track(
     event_name: string,
@@ -380,6 +424,7 @@ export interface Mixpanel {
   ): void;
   unregister(property: string, options?: Partial<RegisterOptions>): void;
   people: People;
+  start_batch_senders(): void;
   start_session_recording(): void;
   stop_session_recording(): void;
   get_session_recording_properties(): { $mp_replay_id?: string } | {};