@gemx-dev/clarity-visualize 0.8.62 → 0.8.63

package/build/clarity.visualize.module.js

@@ -67,105 +67,6 @@ function __generator(thisArg, body) {
     }
 }
 
-var _a$1;
-var DataHelper = /** @class */ (function () {
-    function DataHelper(state) {
-        var _this = this;
-        this.regionMap = {};
-        this.regions = {};
-        this.metrics = {};
-        this.lean = false;
-        this.reset = function () {
-            _this.metrics = {};
-            _this.lean = false;
-            _this.regions = {};
-            _this.regionMap = {};
-        };
-        this.metric = function (event) {
-            var _a;
-            if (_this.state.options.metadata) {
-                var metricMarkup = [];
-                var regionMarkup = [];
-                // Copy over metrics for future reference
-                for (var m in event.data) {
-                    var eventType = typeof event.data[m];
-                    if (eventType === "number" || (event.event === 1 /* Data.Event.Dimension */ && m === 37 /* Data.Dimension.InteractionNextPaint */.toString())) {
-                        if (!(m in _this.metrics)) {
-                            _this.metrics[m] = 0;
-                        }
-                        var key = parseInt(m, 10);
-                        var value = eventType === "object" ? Number((_a = event.data[m]) === null || _a === void 0 ? void 0 : _a[0]) : event.data[m];
-                        if (m in DataHelper.METRIC_MAP && (DataHelper.METRIC_MAP[m].unit === "html-price" || DataHelper.METRIC_MAP[m].unit === "ld-price")) {
-                            _this.metrics[m] = value;
-                        }
-                        else {
-                            _this.metrics[m] += value;
-                        }
-                        _this.lean = key === 1 /* Data.Metric.Playback */ && value === 0 ? true : _this.lean;
-                    }
-                }
-                for (var entry in _this.metrics) {
-                    if (entry in DataHelper.METRIC_MAP) {
-                        var m = _this.metrics[entry];
-                        var map = DataHelper.METRIC_MAP[entry];
-                        var unit = "unit" in map ? map.unit : "" /* Data.Constant.Empty */;
-                        metricMarkup.push("<li><h2>".concat(_this.value(m, unit), "<span>").concat(_this.key(unit), "</span></h2>").concat(map.name, "</li>"));
-                    }
-                }
-                // Append region information to metadata
-                for (var name_1 in _this.regions) {
-                    var r = _this.regions[name_1];
-                    var className = (r.visibility === 10 /* Layout.RegionVisibility.Visible */ ? "visible" : (r.interaction === 20 /* Layout.InteractionState.Clicked */ ? "clicked" : "" /* Data.Constant.Empty */));
-                    regionMarkup.push("<span class=\"".concat(className, "\">").concat(name_1, "</span>"));
-                }
-                _this.state.options.metadata.innerHTML = "<ul>".concat(metricMarkup.join("" /* Data.Constant.Empty */), "</ul><div>").concat(regionMarkup.join("" /* Data.Constant.Empty */), "</div>");
-            }
-        };
-        this.key = function (unit) {
-            switch (unit) {
-                case "html-price":
-                case "ld-price":
-                case "cls":
-                    return "" /* Data.Constant.Empty */;
-                default: return unit;
-            }
-        };
-        this.value = function (num, unit) {
-            switch (unit) {
-                case "KB": return Math.round(num / 1024);
-                case "s": return Math.round(num / 10) / 100;
-                case "cls": return num / 1000;
-                case "html-price": return num / 100;
-                default: return num;
-            }
-        };
-        this.state = state;
-    }
-    DataHelper.prototype.region = function (event) {
-        var data = event.data;
-        for (var _i = 0, data_1 = data; _i < data_1.length; _i++) {
-            var r = data_1[_i];
-            if (!(r.name in this.regions)) {
-                this.regions[r.name] = { interaction: r.interaction, visibility: r.visibility };
-            }
-            this.regionMap[r.id] = r.name;
-        }
-    };
-    DataHelper.METRIC_MAP = (_a$1 = {},
-        _a$1[2 /* Data.Metric.TotalBytes */] = { name: "Total Bytes", unit: "KB" },
-        _a$1[4 /* Data.Metric.TotalCost */] = { name: "Total Cost", unit: "ms" },
-        _a$1[3 /* Data.Metric.LayoutCost */] = { name: "Layout Cost", unit: "ms" },
-        _a$1[8 /* Data.Metric.LargestPaint */] = { name: "LCP", unit: "s" },
-        _a$1[9 /* Data.Metric.CumulativeLayoutShift */] = { name: "CLS", unit: "cls" },
-        _a$1[7 /* Data.Metric.LongTaskCount */] = { name: "Long Tasks" },
-        _a$1[24 /* Data.Metric.CartTotal */] = { name: "Cart Total", unit: "html-price" },
-        _a$1[13 /* Data.Metric.ProductPrice */] = { name: "Product Price", unit: "ld-price" },
-        _a$1[6 /* Data.Metric.ThreadBlockedTime */] = { name: "Thread Blocked", unit: "ms" },
-        _a$1[37 /* Data.Dimension.InteractionNextPaint */] = { name: "INP", unit: "ms" },
-        _a$1);
-    return DataHelper;
-}());
-
 // tslint:disable: no-bitwise
 function hash (input, precision) {
     if (precision === void 0) { precision = null; }
@@ -186,12 +87,26 @@ function hash (input, precision) {
     hash = Math.abs(hashOne + (hashTwo * 11579));
     return (precision ? hash % Math.pow(2, precision) : hash).toString(36);
 }
+
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
 
 var excludeClassNames = "load,active,fixed,visible,focus,show,collaps,animat" /* Constant.ExcludeClassNames */.split("," /* Constant.Comma */);
+var extraExcludeClassNames = [];
 var selectorMap = {};
 function reset$8() {
     selectorMap = {};
 }
+function configure(classNames) {
+    extraExcludeClassNames = classNames || [];
+}
 function get$1(input, type) {
     var a = input.attributes;
     var prefix = input.prefix ? input.prefix[type] : null;
@@ -263,7 +178,7 @@ function filter(value) {
     if (!value) {
         return false;
     } // Do not process empty strings
-    if (excludeClassNames.some(function (x) { return value.toLowerCase().indexOf(x) >= 0; })) {
+    if (getExcludeClassNames().some(function (x) { return value.toLowerCase().indexOf(x) >= 0; })) {
         return false;
     }
     for (var i = 0; i < value.length; i++) {
@@ -274,9 +189,13 @@ function filter(value) {
     }
     return true;
 }
+function getExcludeClassNames() {
+    return __spreadArray(__spreadArray([], excludeClassNames, true), extraExcludeClassNames, true);
+}
 
 var selector = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    configure: configure,
     get: get$1,
     reset: reset$8
 });
@@ -312,6 +231,105 @@ function lookup(hash) {
 
 var helper = { hash: hash, selector: selector, get: get$2, getNode: getNode, lookup: lookup };
 
+var _a$1;
+var DataHelper = /** @class */ (function () {
+    function DataHelper(state) {
+        var _this = this;
+        this.regionMap = {};
+        this.regions = {};
+        this.metrics = {};
+        this.lean = false;
+        this.reset = function () {
+            _this.metrics = {};
+            _this.lean = false;
+            _this.regions = {};
+            _this.regionMap = {};
+        };
+        this.metric = function (event) {
+            var _a;
+            if (_this.state.options.metadata) {
+                var metricMarkup = [];
+                var regionMarkup = [];
+                // Copy over metrics for future reference
+                for (var m in event.data) {
+                    var eventType = typeof event.data[m];
+                    if (eventType === "number" || (event.event === 1 /* Data.Event.Dimension */ && m === 37 /* Data.Dimension.InteractionNextPaint */.toString())) {
+                        if (!(m in _this.metrics)) {
+                            _this.metrics[m] = 0;
+                        }
+                        var key = parseInt(m, 10);
+                        var value = eventType === "object" ? Number((_a = event.data[m]) === null || _a === void 0 ? void 0 : _a[0]) : event.data[m];
+                        if (m in DataHelper.METRIC_MAP && (DataHelper.METRIC_MAP[m].unit === "html-price" || DataHelper.METRIC_MAP[m].unit === "ld-price")) {
+                            _this.metrics[m] = value;
+                        }
+                        else {
+                            _this.metrics[m] += value;
+                        }
+                        _this.lean = key === 1 /* Data.Metric.Playback */ && value === 0 ? true : _this.lean;
+                    }
+                }
+                for (var entry in _this.metrics) {
+                    if (entry in DataHelper.METRIC_MAP) {
+                        var m = _this.metrics[entry];
+                        var map = DataHelper.METRIC_MAP[entry];
+                        var unit = "unit" in map ? map.unit : "" /* Data.Constant.Empty */;
+                        metricMarkup.push("<li><h2>".concat(_this.value(m, unit), "<span>").concat(_this.key(unit), "</span></h2>").concat(map.name, "</li>"));
+                    }
+                }
+                // Append region information to metadata
+                for (var name_1 in _this.regions) {
+                    var r = _this.regions[name_1];
+                    var className = (r.visibility === 10 /* Layout.RegionVisibility.Visible */ ? "visible" : (r.interaction === 20 /* Layout.InteractionState.Clicked */ ? "clicked" : "" /* Data.Constant.Empty */));
+                    regionMarkup.push("<span class=\"".concat(className, "\">").concat(name_1, "</span>"));
+                }
+                _this.state.options.metadata.innerHTML = "<ul>".concat(metricMarkup.join("" /* Data.Constant.Empty */), "</ul><div>").concat(regionMarkup.join("" /* Data.Constant.Empty */), "</div>");
+            }
+        };
+        this.key = function (unit) {
+            switch (unit) {
+                case "html-price":
+                case "ld-price":
+                case "cls":
+                    return "" /* Data.Constant.Empty */;
+                default: return unit;
+            }
+        };
+        this.value = function (num, unit) {
+            switch (unit) {
+                case "KB": return Math.round(num / 1024);
+                case "s": return Math.round(num / 10) / 100;
+                case "cls": return num / 1000;
+                case "html-price": return num / 100;
+                default: return num;
+            }
+        };
+        this.state = state;
+    }
+    DataHelper.prototype.region = function (event) {
+        var data = event.data;
+        for (var _i = 0, data_1 = data; _i < data_1.length; _i++) {
+            var r = data_1[_i];
+            if (!(r.name in this.regions)) {
+                this.regions[r.name] = { interaction: r.interaction, visibility: r.visibility };
+            }
+            this.regionMap[r.id] = r.name;
+        }
+    };
+    DataHelper.METRIC_MAP = (_a$1 = {},
+        _a$1[2 /* Data.Metric.TotalBytes */] = { name: "Total Bytes", unit: "KB" },
+        _a$1[4 /* Data.Metric.TotalCost */] = { name: "Total Cost", unit: "ms" },
+        _a$1[3 /* Data.Metric.LayoutCost */] = { name: "Layout Cost", unit: "ms" },
+        _a$1[8 /* Data.Metric.LargestPaint */] = { name: "LCP", unit: "s" },
+        _a$1[9 /* Data.Metric.CumulativeLayoutShift */] = { name: "CLS", unit: "cls" },
+        _a$1[7 /* Data.Metric.LongTaskCount */] = { name: "Long Tasks" },
+        _a$1[24 /* Data.Metric.CartTotal */] = { name: "Cart Total", unit: "html-price" },
+        _a$1[13 /* Data.Metric.ProductPrice */] = { name: "Product Price", unit: "ld-price" },
+        _a$1[6 /* Data.Metric.ThreadBlockedTime */] = { name: "Thread Blocked", unit: "ms" },
+        _a$1[37 /* Data.Dimension.InteractionNextPaint */] = { name: "INP", unit: "ms" },
+        _a$1);
+    return DataHelper;
+}());
+
 var EnrichHelper = /** @class */ (function () {
     function EnrichHelper() {
         var _this = this;
@@ -882,12 +900,27 @@ var HeatmapHelper = /** @class */ (function () {
             var points = {};
             var localMax = 0;
             var height = _this.state.window && _this.state.window.document ? _this.state.window.document.documentElement.clientHeight : 0;
+            // DEBUG LOG
+            console.group("[Heatmap] transform \u2014 total elements: ".concat(_this.data.length, ", height: ").concat(height, ", max: ").concat(_this.max));
             for (var _i = 0, _a = _this.data; _i < _a.length; _i++) {
                 var element = _a[_i];
                 var el = _this.layout.get(element.hash);
+                if (!el) {
+                    console.warn("[Heatmap] SKIP hash=\"".concat(element.hash, "\" \u2014 element not found in DOM"));
+                    continue;
+                }
+                if (typeof el.getBoundingClientRect !== "function") {
+                    console.warn("[Heatmap] SKIP hash=\"".concat(element.hash, "\" \u2014 getBoundingClientRect not available"), el);
+                    continue;
+                }
+                var r = el.getBoundingClientRect();
+                var v = _this.visible(el, r, height);
+                if (!v && _this.max !== null) {
+                    console.warn("[Heatmap] SKIP hash=\"".concat(element.hash, "\" \u2014 not visible on re-render"), { rect: { top: r.top, left: r.left, width: r.width, height: r.height }, maxIsSet: _this.max !== null });
+                    continue;
+                }
                 if (el && typeof el.getBoundingClientRect === "function") {
-                    var r = el.getBoundingClientRect();
-                    var v = _this.visible(el, r, height);
+                    console.log("[Heatmap] PROCESS hash=\"".concat(element.hash, "\" visible=").concat(v, " points=").concat(element.points), { rect: { top: r.top, left: r.left, width: r.width, height: r.height } });
                     // Process clicks for only visible elements
                     if (_this.max === null || v) {
                         for (var i = 0; i < element.points; i++) {
@@ -896,6 +929,7 @@ var HeatmapHelper = /** @class */ (function () {
                             var k = "".concat(x).concat("X" /* Constant.Separator */).concat(y).concat("X" /* Constant.Separator */).concat(v ? 1 : 0);
                             points[k] = k in points ? points[k] + element.clicks[i] : element.clicks[i];
                             localMax = Math.max(points[k], localMax);
+                            console.log("  point[".concat(i, "] x=").concat(x, " y=").concat(y, " visible=").concat(v, " clicks=").concat(element.clicks[i]));
                         }
                     }
                 }
@@ -903,6 +937,7 @@ var HeatmapHelper = /** @class */ (function () {
             // Set the max value from the firs t
             _this.max = _this.max ? _this.max : localMax;
             // Once all points are accounted for, convert everything into absolute (x, y)
+            var skippedInvisible = 0;
             for (var _b = 0, _c = Object.keys(points); _b < _c.length; _b++) {
                 var coordinates = _c[_b];
                 var parts = coordinates.split("X" /* Constant.Separator */);
@@ -910,7 +945,12 @@ var HeatmapHelper = /** @class */ (function () {
                 if (parts[2] === "1") {
                     output.push({ x: parseInt(parts[0], 10), y: parseInt(parts[1], 10), a: alpha });
                 }
+                else {
+                    skippedInvisible++;
+                }
             }
+            console.log("[Heatmap] Result \u2014 drawn: ".concat(output.length, ", skipped invisible: ").concat(skippedInvisible, ", max: ").concat(_this.max));
+            console.groupEnd();
             return output;
         };
         this.visible = function (el, r, height) {
@@ -2310,6 +2350,11 @@ var Visualizer = /** @class */ (function () {
         this._state = null;
         this.renderTime = 0;
         this.hashFoundTime = -1;
+        this._excludeClassNames = [];
+        this.configure = function (opts) {
+            _this._excludeClassNames = opts.excludeClassNames || [];
+            helper.selector.configure(_this._excludeClassNames);
+        };
         this.dom = function (event) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -2430,6 +2475,7 @@ var Visualizer = /** @class */ (function () {
             decoded = decoded.sort(_this.sortPayloads);
             // Re-initialize enrich class if someone ends up calling merge function directly
             _this.enrich = _this.enrich || new EnrichHelper();
+            helper.selector.configure(_this._excludeClassNames);
             _this.enrich.reset();
             // Walk through payloads and generate merged payload from an array of decoded payloads
             for (var _i = 0, decoded_1 = decoded; _i < decoded_1.length; _i++) {
@@ -2468,6 +2514,10 @@ var Visualizer = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         this.reset();
+                        if (options.excludeClassNames) {
+                            this._excludeClassNames = options.excludeClassNames;
+                            helper.selector.configure(options.excludeClassNames);
+                        }
                         // Infer options
                         options.pointer = "pointer" in options ? options.pointer : true;
                         options.canvas = "canvas" in options ? options.canvas : true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gemx-dev/clarity-visualize",
-  "version": "0.8.62",
+  "version": "0.8.63",
   "description": "Clarity visualize",
   "author": "Microsoft Corp.",
   "license": "MIT",
@@ -9,7 +9,7 @@
   "unpkg": "build/clarity.visualize.min.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@gemx-dev/clarity-decode": "^0.8.62"
+    "@gemx-dev/clarity-decode": "^0.8.63"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^24.0.0",

package/src/heatmap.ts

@@ -276,11 +276,31 @@ export class HeatmapHelper {
         let points: { [key: string]: number } = {};
         let localMax = 0;
         let height = this.state.window && this.state.window.document ? this.state.window.document.documentElement.clientHeight : 0;
+
+        // DEBUG LOG
+        console.group(`[Heatmap] transform — total elements: ${this.data.length}, height: ${height}, max: ${this.max}`);
+
         for (let element of this.data) {
             let el = this.layout.get(element.hash) as HTMLElement;
+            if (!el) {
+                console.warn(`[Heatmap] SKIP hash="${element.hash}" — element not found in DOM`);
+                continue;
+            }
+            if (typeof el.getBoundingClientRect !== "function") {
+                console.warn(`[Heatmap] SKIP hash="${element.hash}" — getBoundingClientRect not available`, el);
+                continue;
+            }
+
+            let r = el.getBoundingClientRect();
+            let v = this.visible(el, r, height);
+
+            if (!v && this.max !== null) {
+                console.warn(`[Heatmap] SKIP hash="${element.hash}" — not visible on re-render`, { rect: { top: r.top, left: r.left, width: r.width, height: r.height }, maxIsSet: this.max !== null });
+                continue;
+            }
+
             if (el && typeof el.getBoundingClientRect === "function") {
-                let r = el.getBoundingClientRect();
-                let v = this.visible(el, r, height);
+                console.log(`[Heatmap] PROCESS hash="${element.hash}" visible=${v} points=${element.points}`, { rect: { top: r.top, left: r.left, width: r.width, height: r.height } });
                 // Process clicks for only visible elements
                 if (this.max === null || v) {
                     for(let i = 0; i < element.points; i++) {
@@ -289,6 +309,7 @@ export class HeatmapHelper {
                         let k = `${x}${Constant.Separator}${y}${Constant.Separator}${v ? 1 : 0}`;
                         points[k] = k in points ? points[k] + element.clicks[i] : element.clicks[i];
                         localMax = Math.max(points[k], localMax);
+                        console.log(`  point[${i}] x=${x} y=${y} visible=${v} clicks=${element.clicks[i]}`);
                     }
                 }
             }
@@ -298,12 +319,20 @@ export class HeatmapHelper {
         this.max = this.max ? this.max : localMax;
 
         // Once all points are accounted for, convert everything into absolute (x, y)
+        let skippedInvisible = 0;
         for (let coordinates of Object.keys(points)) {
             let parts = coordinates.split(Constant.Separator);
             let alpha = Math.min((points[coordinates] / this.max) + Setting.AlphaBoost, 1);
-            if (parts[2] === "1") { output.push({ x: parseInt(parts[0], 10), y: parseInt(parts[1], 10), a: alpha }); }
+            if (parts[2] === "1") {
+                output.push({ x: parseInt(parts[0], 10), y: parseInt(parts[1], 10), a: alpha });
+            } else {
+                skippedInvisible++;
+            }
         }
 
+        console.log(`[Heatmap] Result — drawn: ${output.length}, skipped invisible: ${skippedInvisible}, max: ${this.max}`);
+        console.groupEnd();
+
         return output;
     }
 

package/src/visualizer.ts

@@ -1,6 +1,7 @@
-import { Activity, Constant, ErrorLogger, LinkHandler, MergedPayload, Options, PlaybackState, ScrollMapInfo, Setting, ShortCircuitStrategy, Visualizer as VisualizerType } from "@clarity-types/visualize";
-import { Data } from "@gemx-dev/clarity-js";
 import type { Data as DecodedData, Interaction, Layout } from "@gemx-dev/clarity-decode";
+
+import { Activity, Constant, ErrorLogger, LinkHandler, MergedPayload, Options, PlaybackState, ScrollMapInfo, Setting, ShortCircuitStrategy, Visualizer as VisualizerType } from "@clarity-types/visualize";
+import { Data, helper } from "@gemx-dev/clarity-js";
 import { DataHelper } from "./data";
 import { EnrichHelper } from "./enrich";
 import { HeatmapHelper } from "./heatmap";
@@ -12,6 +13,7 @@ export class Visualizer implements VisualizerType {
     _state: PlaybackState = null;
     renderTime = 0;
     hashFoundTime = -1;
+    _excludeClassNames: string[] = [];
 
     enrich: EnrichHelper;
     layout: LayoutHelper;
@@ -23,6 +25,11 @@ export class Visualizer implements VisualizerType {
         return this._state;
     }
 
+    public configure = (opts: { excludeClassNames?: string[] }): void => {
+        this._excludeClassNames = opts.excludeClassNames || [];
+        helper.selector.configure(this._excludeClassNames);
+    }
+
     public dom = async (event: Layout.DomEvent): Promise<void> => {
         await this.layout.dom(event);
     }
@@ -116,6 +123,7 @@ export class Visualizer implements VisualizerType {
         decoded = decoded.sort(this.sortPayloads);
         // Re-initialize enrich class if someone ends up calling merge function directly
         this.enrich = this.enrich || new EnrichHelper();
+        helper.selector.configure(this._excludeClassNames);
         this.enrich.reset();
         // Walk through payloads and generate merged payload from an array of decoded payloads
         for (let payload of decoded) {
@@ -148,6 +156,10 @@ export class Visualizer implements VisualizerType {
 
     public setup = async (target: Window, options: Options): Promise<Visualizer> => {
         this.reset();
+        if (options.excludeClassNames) {
+            this._excludeClassNames = options.excludeClassNames;
+            helper.selector.configure(options.excludeClassNames);
+        }
         // Infer options
         options.pointer = "pointer" in options ? options.pointer : true;
         options.canvas = "canvas" in options ? options.canvas : true;

package/types/visualize.d.ts

@@ -27,6 +27,7 @@ export class Visualizer {
     merge: (decoded: Data.DecodedPayload[]) => MergedPayload;
     render: (events: Data.DecodedEvent[]) =>  void;
     setup: (target: Window, options: Options) => Promise<Visualizer>;
+    configure: (opts: { excludeClassNames?: string[] }) => void;
     time: () => number;
     get: (hash: string) => HTMLElement;
 }
@@ -70,6 +71,7 @@ export interface Options {
     mobile?: boolean;
     vNext?: boolean;
     locale?: string;
+    excludeClassNames?: string[];
 }
 
 export interface NodeData {