@openreplay/tracker 17.1.0 → 17.1.2

package/dist/cjs/main/modules/analytics/batcher.d.ts

@@ -1,4 +1,3 @@
-import { categories } from './types';
 interface PeopleEvent {
     type: string;
     timestamp: number;
@@ -25,8 +24,8 @@ declare class Batcher {
     constructor(backendUrl: string, getToken: () => string | null, init: () => Promise<void>);
     getBatches(): {
         data: {
-            [categories.people]: PeopleEvent[];
-            [categories.events]: Event[];
+            user_actions: PeopleEvent[];
+            events: Event[];
         };
     };
     addEvent(event: any): void;

package/dist/cjs/main/modules/analytics/types.d.ts

@@ -8,11 +8,11 @@ export declare const mutationTypes: {
     incrementProperty: string;
 };
 export declare const categories: {
-    people: string;
-    events: string;
+    readonly people: "user_actions";
+    readonly events: "events";
 };
 export declare const createEvent: (category: (typeof categories)[keyof typeof categories], type?: (typeof mutationTypes)[keyof typeof mutationTypes], timestamp?: number, payload?: Record<string, any>) => {
-    category: string;
+    category: "user_actions";
     data: {
         type: string | undefined;
         user_id: any;
@@ -21,7 +21,7 @@ export declare const createEvent: (category: (typeof categories)[keyof typeof ca
         name?: undefined;
     };
 } | {
-    category: string;
+    category: "events";
     data: {
         name: any;
         payload: any;

package/dist/cjs/main/modules/viewport.d.ts

@@ -2,5 +2,12 @@ import type App from '../app/index.js';
 export interface Options {
     urlSanitizer?: (url: string) => string;
     titleSanitizer?: (title: string) => string;
+    /** if present, tracker will remove given symbol to present url as regular router url on replay level;
+     *
+     * applied BEFORE sanitizers.
+     *
+     * @example passing '#/' will result in 'site.com/#/path' -> 'site.com/path'
+     */
+    replaceHashSymbol?: string;
 }
 export default function (app: App, options?: Options): void;

package/dist/lib/entry.js

@@ -4398,7 +4398,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '17.1.0'; // TODO: version compatability check inside each plugin.
+        this.version = '17.1.2'; // TODO: version compatability check inside each plugin.
         this.socketMode = false;
         this.compressionThreshold = 24 * 1000;
         this.bc = null;
@@ -5505,6 +5505,7 @@ class App {
                     assistOnly: startOpts.assistOnly ?? this.socketMode,
                     width: window.screen.width,
                     height: window.screen.height,
+                    referrer: document.referrer,
                 }),
             });
             if (r.status !== 200) {
@@ -7001,11 +7002,21 @@ function Viewport (app, options) {
     const urlSanitizer = options?.urlSanitizer || ((u) => u);
     const titleSanitizer = options?.titleSanitizer || ((t) => t);
     const sendSetPageLocation = app.safe(() => {
-        const { URL } = document;
-        if (URL !== url) {
-            url = URL;
+        const currURL = document.URL;
+        if (currURL !== url) {
+            url = currURL;
+            if (options?.replaceHashSymbol) {
+                // replace hash router symbol if needed without affecting pathname of the url
+                const u = new URL(currURL);
+                const hashRoute = u.hash.startsWith("#/") ? u.hash.slice(2) : "";
+                const routePath = hashRoute ? "/" + hashRoute.replace(/^\/+/, "") : "";
+                const cleaned = u.origin + u.pathname.replace(/\/$/, "") + routePath + u.search;
+                url = cleaned;
+            }
             const sanitized = urlSanitizer(url);
-            const safeTitle = app.sanitizer.privateMode ? stringWiper(document.title) : titleSanitizer(document.title);
+            const safeTitle = app.sanitizer.privateMode
+                ? stringWiper(document.title)
+                : titleSanitizer(document.title);
             const safeUrl = app.sanitizer.privateMode ? stringWiper(sanitized) : sanitized;
             const safeReferrer = app.sanitizer.privateMode ? stringWiper(referrer) : referrer;
             app.send(SetPageLocation(safeUrl, safeReferrer, navigationStart, safeTitle));
@@ -9217,7 +9228,7 @@ class ConstantProperties {
             user_id: this.user_id,
             distinct_id: this.deviceId,
             sdk_edition: 'web',
-            sdk_version: '17.1.0',
+            sdk_version: '17.1.2',
             timezone: getUTCOffsetString(),
             search_engine: this.searchEngine,
         };
@@ -9861,7 +9872,7 @@ class API {
         this.signalStartIssue = (reason, missingApi) => {
             const doNotTrack = this.checkDoNotTrack();
             console.log("Tracker couldn't start due to:", JSON.stringify({
-                trackerVersion: '17.1.0',
+                trackerVersion: '17.1.2',
                 projectKey: this.options.projectKey,
                 doNotTrack,
                 reason: missingApi.length ? `missing api: ${missingApi.join(',')}` : reason,