@kubesense/kubesense-browser-rum 1.0.0

package/cjs/domain/record/mutationBatch.d.ts

@@ -0,0 +1,12 @@
+import type { RumMutationRecord } from '@kubesense/kubesense-browser-rum-core';
+/**
+ * Minimum duration to wait before processing mutations. This is used to batch mutations together
+ * and be able to deduplicate them to save processing time and bandwidth.
+ * 16ms is the duration of a frame at 60fps that ensure fluid UI.
+ */
+export declare const MUTATION_PROCESS_MIN_DELAY = 16;
+export declare function createMutationBatch(processMutationBatch: (mutations: RumMutationRecord[]) => void): {
+    addMutations: (mutations: RumMutationRecord[]) => void;
+    flush: () => void;
+    stop: () => void;
+};

package/cjs/domain/record/mutationBatch.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MUTATION_PROCESS_MIN_DELAY = void 0;
+exports.createMutationBatch = createMutationBatch;
+const kubesense_browser_core_1 = require("@kubesense/kubesense-browser-core");
+/**
+ * Maximum duration to wait before processing mutations. If the browser is idle, mutations will be
+ * processed more quickly. If the browser is busy executing small tasks (ex: rendering frames), the
+ * mutations will wait MUTATION_PROCESS_MAX_DELAY milliseconds before being processed. If the
+ * browser is busy executing a longer task, mutations will be processed after this task.
+ */
+const MUTATION_PROCESS_MAX_DELAY = 100;
+/**
+ * Minimum duration to wait before processing mutations. This is used to batch mutations together
+ * and be able to deduplicate them to save processing time and bandwidth.
+ * 16ms is the duration of a frame at 60fps that ensure fluid UI.
+ */
+exports.MUTATION_PROCESS_MIN_DELAY = 16;
+function createMutationBatch(processMutationBatch) {
+    let cancelScheduledFlush = kubesense_browser_core_1.noop;
+    let pendingMutations = [];
+    function flush() {
+        cancelScheduledFlush();
+        processMutationBatch(pendingMutations);
+        pendingMutations = [];
+    }
+    const { throttled: throttledFlush, cancel: cancelThrottle } = (0, kubesense_browser_core_1.throttle)(flush, exports.MUTATION_PROCESS_MIN_DELAY, {
+        leading: false,
+    });
+    return {
+        addMutations: (mutations) => {
+            if (pendingMutations.length === 0) {
+                cancelScheduledFlush = (0, kubesense_browser_core_1.requestIdleCallback)(throttledFlush, { timeout: MUTATION_PROCESS_MAX_DELAY });
+            }
+            pendingMutations.push(...mutations);
+        },
+        flush,
+        stop: () => {
+            cancelScheduledFlush();
+            cancelThrottle();
+        },
+    };
+}
+//# sourceMappingURL=mutationBatch.js.map

package/cjs/domain/record/mutationBatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutationBatch.js","sourceRoot":"","sources":["../../../src/domain/record/mutationBatch.ts"],"names":[],"mappings":";;;AAiBA,kDA6BC;AA9CD,8EAAuF;AAGvF;;;;;GAKG;AACH,MAAM,0BAA0B,GAAG,GAAG,CAAA;AACtC;;;;GAIG;AACU,QAAA,0BAA0B,GAAG,EAAE,CAAA;AAE5C,SAAgB,mBAAmB,CAAC,oBAA8D;IAChG,IAAI,oBAAoB,GAAG,6BAAI,CAAA;IAC/B,IAAI,gBAAgB,GAAwB,EAAE,CAAA;IAE9C,SAAS,KAAK;QACZ,oBAAoB,EAAE,CAAA;QACtB,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;QACtC,gBAAgB,GAAG,EAAE,CAAA;IACvB,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAA,iCAAQ,EAAC,KAAK,EAAE,kCAA0B,EAAE;QACxG,OAAO,EAAE,KAAK;KACf,CAAC,CAAA;IAEF,OAAO;QACL,YAAY,EAAE,CAAC,SAA8B,EAAE,EAAE;YAC/C,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,oBAAoB,GAAG,IAAA,4CAAmB,EAAC,cAAc,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAA;YACrG,CAAC;YACD,gBAAgB,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAA;QACrC,CAAC;QAED,KAAK;QAEL,IAAI,EAAE,GAAG,EAAE;YACT,oBAAoB,EAAE,CAAA;YACtB,cAAc,EAAE,CAAA;QAClB,CAAC;KACF,CAAA;AACH,CAAC"}

package/cjs/domain/record/nodeIds.d.ts

@@ -0,0 +1,15 @@
+export type NodeWithSerializedNode = Node & {
+    __brand: 'NodeWithSerializedNode';
+};
+export type NodeId = number & {
+    __brand: 'NodeId';
+};
+export declare const enum NodeIdConstants {
+    FIRST_ID = 0
+}
+export interface NodeIds {
+    assign(node: Node): NodeId;
+    get(node: Node): NodeId | undefined;
+    areAssignedForNodeAndAncestors(node: Node): node is NodeWithSerializedNode;
+}
+export declare function createNodeIds(): NodeIds;

package/cjs/domain/record/nodeIds.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodeIds = createNodeIds;
+const kubesense_browser_rum_core_1 = require("@kubesense/kubesense-browser-rum-core");
+function createNodeIds() {
+    const nodeIds = new WeakMap();
+    let nextNodeId = 0 /* NodeIdConstants.FIRST_ID */;
+    const get = (node) => nodeIds.get(node);
+    return {
+        assign: (node) => {
+            // Try to reuse any existing id.
+            let nodeId = get(node);
+            if (nodeId === undefined) {
+                nodeId = nextNodeId++;
+                nodeIds.set(node, nodeId);
+            }
+            return nodeId;
+        },
+        get,
+        areAssignedForNodeAndAncestors: (node) => {
+            let current = node;
+            while (current) {
+                if (get(current) === undefined && !(0, kubesense_browser_rum_core_1.isNodeShadowRoot)(current)) {
+                    return false;
+                }
+                current = (0, kubesense_browser_rum_core_1.getParentNode)(current);
+            }
+            return true;
+        },
+    };
+}
+//# sourceMappingURL=nodeIds.js.map

package/cjs/domain/record/nodeIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeIds.js","sourceRoot":"","sources":["../../../src/domain/record/nodeIds.ts"],"names":[],"mappings":";;AAeA,sCA8BC;AA7CD,sFAAuF;AAevF,SAAgB,aAAa;IAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAgB,CAAA;IAC3C,IAAI,UAAU,mCAA2B,CAAA;IAEzC,MAAM,GAAG,GAAG,CAAC,IAAU,EAAsB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEjE,OAAO;QACL,MAAM,EAAE,CAAC,IAAU,EAAU,EAAE;YAC7B,gCAAgC;YAChC,IAAI,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;YACtB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,UAAU,EAAY,CAAA;gBAC/B,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAC3B,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,GAAG;QAEH,8BAA8B,EAAE,CAAC,IAAU,EAAkC,EAAE;YAC7E,IAAI,OAAO,GAAgB,IAAI,CAAA;YAC/B,OAAO,OAAO,EAAE,CAAC;gBACf,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,IAAA,6CAAgB,EAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,OAAO,KAAK,CAAA;gBACd,CAAC;gBACD,OAAO,GAAG,IAAA,0CAAa,EAAC,OAAO,CAAC,CAAA;YAClC,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;KACF,CAAA;AACH,CAAC"}

package/cjs/domain/record/record.d.ts

@@ -0,0 +1,16 @@
+import type { LifeCycle, RumConfiguration, ViewHistory } from '@kubesense/kubesense-browser-rum-core';
+import type { ShadowRootsController } from './shadowRootsController';
+import type { EmitRecordCallback, EmitStatsCallback } from './record.types';
+export interface RecordOptions {
+    emitRecord: EmitRecordCallback;
+    emitStats: EmitStatsCallback;
+    configuration: RumConfiguration;
+    lifeCycle: LifeCycle;
+    viewHistory: ViewHistory;
+}
+export interface RecordAPI {
+    stop: () => void;
+    flushMutations: () => void;
+    shadowRootsController: ShadowRootsController;
+}
+export declare function record(options: RecordOptions): RecordAPI;

package/cjs/domain/record/record.js

@@ -0,0 +1,90 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = record;
+const kubesense_browser_core_1 = require("@kubesense/kubesense-browser-core");
+const replayStats = __importStar(require("../replayStats"));
+const trackers_1 = require("./trackers");
+const elementsScrollPositions_1 = require("./elementsScrollPositions");
+const shadowRootsController_1 = require("./shadowRootsController");
+const startFullSnapshots_1 = require("./startFullSnapshots");
+const eventIds_1 = require("./eventIds");
+const nodeIds_1 = require("./nodeIds");
+const recordingScope_1 = require("./recordingScope");
+function record(options) {
+    const { emitRecord, emitStats, configuration, lifeCycle } = options;
+    // runtime checks for user options
+    if (!emitRecord || !emitStats) {
+        throw new Error('emit functions are required');
+    }
+    const processRecord = (record) => {
+        emitRecord(record);
+        (0, kubesense_browser_core_1.sendToExtension)('record', { record });
+        const view = options.viewHistory.findView();
+        replayStats.addRecord(view.id);
+    };
+    const shadowRootsController = (0, shadowRootsController_1.initShadowRootsController)(processRecord, emitStats);
+    const scope = (0, recordingScope_1.createRecordingScope)(configuration, (0, elementsScrollPositions_1.createElementsScrollPositions)(), (0, eventIds_1.createEventIds)(), (0, nodeIds_1.createNodeIds)(), shadowRootsController);
+    const { stop: stopFullSnapshots } = (0, startFullSnapshots_1.startFullSnapshots)(lifeCycle, processRecord, emitStats, flushMutations, scope);
+    function flushMutations() {
+        shadowRootsController.flush();
+        mutationTracker.flush();
+    }
+    const mutationTracker = (0, trackers_1.trackMutation)(document, processRecord, emitStats, scope);
+    const trackers = [
+        mutationTracker,
+        (0, trackers_1.trackMove)(processRecord, scope),
+        (0, trackers_1.trackMouseInteraction)(processRecord, scope),
+        (0, trackers_1.trackScroll)(document, processRecord, scope),
+        (0, trackers_1.trackViewportResize)(processRecord, scope),
+        (0, trackers_1.trackInput)(document, processRecord, scope),
+        (0, trackers_1.trackMediaInteraction)(processRecord, scope),
+        (0, trackers_1.trackStyleSheet)(processRecord, scope),
+        (0, trackers_1.trackFocus)(processRecord, scope),
+        (0, trackers_1.trackVisualViewportResize)(processRecord, scope),
+        (0, trackers_1.trackFrustration)(lifeCycle, processRecord, scope),
+        (0, trackers_1.trackViewEnd)(lifeCycle, processRecord, flushMutations),
+    ];
+    return {
+        stop: () => {
+            shadowRootsController.stop();
+            trackers.forEach((tracker) => tracker.stop());
+            stopFullSnapshots();
+        },
+        flushMutations,
+        shadowRootsController,
+    };
+}
+//# sourceMappingURL=record.js.map

package/cjs/domain/record/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../../src/domain/record/record.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,wBAuDC;AAjGD,8EAAmE;AAEnE,4DAA6C;AAG7C,yCAamB;AACnB,uEAAyE;AAEzE,mEAAmE;AACnE,6DAAyD;AACzD,yCAA2C;AAC3C,uCAAyC;AAEzC,qDAAuD;AAgBvD,SAAgB,MAAM,CAAC,OAAsB;IAC3C,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IACnE,kCAAkC;IAClC,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAChD,CAAC;IAED,MAAM,aAAa,GAAuB,CAAC,MAAqB,EAAE,EAAE;QAClE,UAAU,CAAC,MAAM,CAAC,CAAA;QAClB,IAAA,wCAAe,EAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAG,CAAA;QAC5C,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAChC,CAAC,CAAA;IAED,MAAM,qBAAqB,GAAG,IAAA,iDAAyB,EAAC,aAAa,EAAE,SAAS,CAAC,CAAA;IACjF,MAAM,KAAK,GAAG,IAAA,qCAAoB,EAChC,aAAa,EACb,IAAA,uDAA6B,GAAE,EAC/B,IAAA,yBAAc,GAAE,EAChB,IAAA,uBAAa,GAAE,EACf,qBAAqB,CACtB,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAA,uCAAkB,EAAC,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,CAAA;IAElH,SAAS,cAAc;QACrB,qBAAqB,CAAC,KAAK,EAAE,CAAA;QAC7B,eAAe,CAAC,KAAK,EAAE,CAAA;IACzB,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAa,EAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;IAChF,MAAM,QAAQ,GAAc;QAC1B,eAAe;QACf,IAAA,oBAAS,EAAC,aAAa,EAAE,KAAK,CAAC;QAC/B,IAAA,gCAAqB,EAAC,aAAa,EAAE,KAAK,CAAC;QAC3C,IAAA,sBAAW,EAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,CAAC;QAC3C,IAAA,8BAAmB,EAAC,aAAa,EAAE,KAAK,CAAC;QACzC,IAAA,qBAAU,EAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,CAAC;QAC1C,IAAA,gCAAqB,EAAC,aAAa,EAAE,KAAK,CAAC;QAC3C,IAAA,0BAAe,EAAC,aAAa,EAAE,KAAK,CAAC;QACrC,IAAA,qBAAU,EAAC,aAAa,EAAE,KAAK,CAAC;QAChC,IAAA,oCAAyB,EAAC,aAAa,EAAE,KAAK,CAAC;QAC/C,IAAA,2BAAgB,EAAC,SAAS,EAAE,aAAa,EAAE,KAAK,CAAC;QACjD,IAAA,uBAAY,EAAC,SAAS,EAAE,aAAa,EAAE,cAAc,CAAC;KACvD,CAAA;IAED,OAAO;QACL,IAAI,EAAE,GAAG,EAAE;YACT,qBAAqB,CAAC,IAAI,EAAE,CAAA;YAC5B,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YAC7C,iBAAiB,EAAE,CAAA;QACrB,CAAC;QACD,cAAc;QACd,qBAAqB;KACtB,CAAA;AACH,CAAC"}

package/cjs/domain/record/record.types.d.ts

@@ -0,0 +1,4 @@
+import type { BrowserRecord } from '../../types';
+import type { SerializationStats } from './serialization';
+export type EmitRecordCallback<Record extends BrowserRecord = BrowserRecord> = (record: Record) => void;
+export type EmitStatsCallback = (stats: SerializationStats) => void;

package/cjs/domain/record/record.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=record.types.js.map

package/cjs/domain/record/record.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.types.js","sourceRoot":"","sources":["../../../src/domain/record/record.types.ts"],"names":[],"mappings":""}

package/cjs/domain/record/recordingScope.d.ts

@@ -0,0 +1,19 @@
+import type { RumConfiguration } from '@kubesense/kubesense-browser-rum-core';
+import type { ElementsScrollPositions } from './elementsScrollPositions';
+import type { EventIds } from './eventIds';
+import type { NodeIds } from './nodeIds';
+import type { ShadowRootsController } from './shadowRootsController';
+/**
+ * State associated with a stream of session replay records. When a new stream of records
+ * starts (e.g. because recording has shut down and restarted), a new RecordingScope
+ * object must be created; this ensures that we don't generate records that reference ids
+ * or data which aren't present in the current stream.
+ */
+export interface RecordingScope {
+    configuration: RumConfiguration;
+    elementsScrollPositions: ElementsScrollPositions;
+    eventIds: EventIds;
+    nodeIds: NodeIds;
+    shadowRootsController: ShadowRootsController;
+}
+export declare function createRecordingScope(configuration: RumConfiguration, elementsScrollPositions: ElementsScrollPositions, eventIds: EventIds, nodeIds: NodeIds, shadowRootsController: ShadowRootsController): RecordingScope;

package/cjs/domain/record/recordingScope.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRecordingScope = createRecordingScope;
+function createRecordingScope(configuration, elementsScrollPositions, eventIds, nodeIds, shadowRootsController) {
+    return {
+        configuration,
+        elementsScrollPositions,
+        eventIds,
+        nodeIds,
+        shadowRootsController,
+    };
+}
+//# sourceMappingURL=recordingScope.js.map

package/cjs/domain/record/recordingScope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordingScope.js","sourceRoot":"","sources":["../../../src/domain/record/recordingScope.ts"],"names":[],"mappings":";;AAqBA,oDAcC;AAdD,SAAgB,oBAAoB,CAClC,aAA+B,EAC/B,uBAAgD,EAChD,QAAkB,EAClB,OAAgB,EAChB,qBAA4C;IAE5C,OAAO;QACL,aAAa;QACb,uBAAuB;QACvB,QAAQ;QACR,OAAO;QACP,qBAAqB;KACtB,CAAA;AACH,CAAC"}

package/cjs/domain/record/serialization/index.d.ts

@@ -0,0 +1,8 @@
+export { getElementInputValue } from './serializationUtils';
+export { serializeDocument } from './serializeDocument';
+export { serializeNode } from './serializeNode';
+export { serializeAttribute } from './serializeAttribute';
+export { createSerializationStats, updateSerializationStats, aggregateSerializationStats } from './serializationStats';
+export type { SerializationMetric, SerializationStats } from './serializationStats';
+export { serializeInTransaction, SerializationKind } from './serializationTransaction';
+export type { SerializationTransaction, SerializationTransactionCallback } from './serializationTransaction';

package/cjs/domain/record/serialization/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeInTransaction = exports.aggregateSerializationStats = exports.updateSerializationStats = exports.createSerializationStats = exports.serializeAttribute = exports.serializeNode = exports.serializeDocument = exports.getElementInputValue = void 0;
+var serializationUtils_1 = require("./serializationUtils");
+Object.defineProperty(exports, "getElementInputValue", { enumerable: true, get: function () { return serializationUtils_1.getElementInputValue; } });
+var serializeDocument_1 = require("./serializeDocument");
+Object.defineProperty(exports, "serializeDocument", { enumerable: true, get: function () { return serializeDocument_1.serializeDocument; } });
+var serializeNode_1 = require("./serializeNode");
+Object.defineProperty(exports, "serializeNode", { enumerable: true, get: function () { return serializeNode_1.serializeNode; } });
+var serializeAttribute_1 = require("./serializeAttribute");
+Object.defineProperty(exports, "serializeAttribute", { enumerable: true, get: function () { return serializeAttribute_1.serializeAttribute; } });
+var serializationStats_1 = require("./serializationStats");
+Object.defineProperty(exports, "createSerializationStats", { enumerable: true, get: function () { return serializationStats_1.createSerializationStats; } });
+Object.defineProperty(exports, "updateSerializationStats", { enumerable: true, get: function () { return serializationStats_1.updateSerializationStats; } });
+Object.defineProperty(exports, "aggregateSerializationStats", { enumerable: true, get: function () { return serializationStats_1.aggregateSerializationStats; } });
+var serializationTransaction_1 = require("./serializationTransaction");
+Object.defineProperty(exports, "serializeInTransaction", { enumerable: true, get: function () { return serializationTransaction_1.serializeInTransaction; } });
+//# sourceMappingURL=index.js.map

package/cjs/domain/record/serialization/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/record/serialization/index.ts"],"names":[],"mappings":";;;AAAA,2DAA2D;AAAlD,0HAAA,oBAAoB,OAAA;AAC7B,yDAAuD;AAA9C,sHAAA,iBAAiB,OAAA;AAC1B,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AACtB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,2DAAsH;AAA7G,8HAAA,wBAAwB,OAAA;AAAE,8HAAA,wBAAwB,OAAA;AAAE,iIAAA,2BAA2B,OAAA;AAExF,uEAAsF;AAA7E,kIAAA,sBAAsB,OAAA"}

package/cjs/domain/record/serialization/serialization.types.d.ts

@@ -0,0 +1,28 @@
+import type { NodePrivacyLevel } from '@kubesense/kubesense-browser-rum-core';
+export type ParentNodePrivacyLevel = typeof NodePrivacyLevel.ALLOW | typeof NodePrivacyLevel.MASK | typeof NodePrivacyLevel.MASK_USER_INPUT | typeof NodePrivacyLevel.MASK_UNLESS_ALLOWLISTED;
+/**
+ * Virtual attributes. These attributes appear in the serialized attribute map of
+ * elements, but they're not actually derived from the DOM; they're used to represent
+ * metadata about the element they're attached to.
+ */
+export interface VirtualAttributes {
+    /**
+     * For <style> and <link> elements, the rules in the element's stylesheet, extracted
+     * from the CSSOM.
+     */
+    _cssText?: string;
+    /** For <audio> and <video> elements, the playback state of the element's media. */
+    rr_mediaState?: 'paused' | 'played';
+    /** For elements which are scroll containers, the element's X scroll position, if non-zero. */
+    rr_scrollLeft?: number;
+    /** For elements which are scroll containers, the element's Y scroll position, if non-zero. */
+    rr_scrollTop?: number;
+    /** For HIDDEN elements, the width of the element's bounding client rect. */
+    rr_width?: string;
+    /** For HIDDEN elements, the height of the element's bounding client rect. */
+    rr_height?: string;
+}
+export interface SerializeOptions {
+    /** For HIDDEN elements, the height of the element's bounding client rect. */
+    rr_height?: string;
+}

package/cjs/domain/record/serialization/serialization.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=serialization.types.js.map

package/cjs/domain/record/serialization/serialization.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialization.types.js","sourceRoot":"","sources":["../../../../src/domain/record/serialization/serialization.types.ts"],"names":[],"mappings":""}

package/cjs/domain/record/serialization/serializationStats.d.ts

@@ -0,0 +1,12 @@
+export interface SerializationMetric {
+    count: number;
+    max: number;
+    sum: number;
+}
+export interface SerializationStats {
+    cssText: SerializationMetric;
+    serializationDuration: SerializationMetric;
+}
+export declare function createSerializationStats(): SerializationStats;
+export declare function updateSerializationStats(stats: SerializationStats, metric: keyof SerializationStats, value: number): void;
+export declare function aggregateSerializationStats(aggregateStats: SerializationStats, stats: SerializationStats): void;

package/cjs/domain/record/serialization/serializationStats.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSerializationStats = createSerializationStats;
+exports.updateSerializationStats = updateSerializationStats;
+exports.aggregateSerializationStats = aggregateSerializationStats;
+function createSerializationStats() {
+    return {
+        cssText: {
+            count: 0,
+            max: 0,
+            sum: 0,
+        },
+        serializationDuration: {
+            count: 0,
+            max: 0,
+            sum: 0,
+        },
+    };
+}
+function updateSerializationStats(stats, metric, value) {
+    stats[metric].count += 1;
+    stats[metric].max = Math.max(stats[metric].max, value);
+    stats[metric].sum += value;
+}
+function aggregateSerializationStats(aggregateStats, stats) {
+    for (const metric of ['cssText', 'serializationDuration']) {
+        aggregateStats[metric].count += stats[metric].count;
+        aggregateStats[metric].max = Math.max(aggregateStats[metric].max, stats[metric].max);
+        aggregateStats[metric].sum += stats[metric].sum;
+    }
+}
+//# sourceMappingURL=serializationStats.js.map

package/cjs/domain/record/serialization/serializationStats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializationStats.js","sourceRoot":"","sources":["../../../../src/domain/record/serialization/serializationStats.ts"],"names":[],"mappings":";;AAWA,4DAaC;AAED,4DAQC;AAED,kEAMC;AA/BD,SAAgB,wBAAwB;IACtC,OAAO;QACL,OAAO,EAAE;YACP,KAAK,EAAE,CAAC;YACR,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,CAAC;SACP;QACD,qBAAqB,EAAE;YACrB,KAAK,EAAE,CAAC;YACR,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,CAAC;SACP;KACF,CAAA;AACH,CAAC;AAED,SAAgB,wBAAwB,CACtC,KAAyB,EACzB,MAAgC,EAChC,KAAa;IAEb,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,CAAC,CAAA;IACxB,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IACtD,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,KAAK,CAAA;AAC5B,CAAC;AAED,SAAgB,2BAA2B,CAAC,cAAkC,EAAE,KAAyB;IACvG,KAAK,MAAM,MAAM,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAU,EAAE,CAAC;QACnE,cAAc,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAA;QACnD,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAA;QACpF,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAA;IACjD,CAAC;AACH,CAAC"}

package/cjs/domain/record/serialization/serializationTransaction.d.ts

@@ -0,0 +1,45 @@
+import type { BrowserRecord } from '../../../types';
+import type { NodeId } from '../nodeIds';
+import type { EmitRecordCallback, EmitStatsCallback } from '../record.types';
+import type { RecordingScope } from '../recordingScope';
+import type { SerializationStats } from './serializationStats';
+export type SerializationTransactionCallback = (transaction: SerializationTransaction) => void;
+export declare const enum SerializationKind {
+    INITIAL_FULL_SNAPSHOT = 0,
+    SUBSEQUENT_FULL_SNAPSHOT = 1,
+    INCREMENTAL_SNAPSHOT = 2
+}
+/**
+ * A serialization transaction is used to build and emit a sequence of session replay
+ * records containing a serialized snapshot of the DOM.
+ */
+export interface SerializationTransaction {
+    /** Add a record to the transaction. It will be emitted when the transaction ends. */
+    add(record: BrowserRecord): void;
+    /**
+     * Add a metric to the transaction's statistics. The aggregated statistics will be
+     * emitted when the transaction ends.
+     */
+    addMetric(metric: keyof SerializationStats, value: number): void;
+    /**
+     * Assign and return an id to the given node. If the node has previously been assigned
+     * an id, the existing id will be reused.
+     */
+    assignId(node: Node): NodeId;
+    /** The kind of serialization being performed in this transaction. */
+    kind: SerializationKind;
+    /**
+     * A set used to track nodes which have been serialized in the current transaction. If
+     * undefined, this feature is disabled; this is the default state in new transactions
+     * for performance reasons. Set the property to a non-undefined value if you need this
+     * capability.
+     */
+    serializedNodeIds?: Set<NodeId>;
+    /** The recording scope in which this transaction is occurring. */
+    scope: RecordingScope;
+}
+/**
+ * Perform serialization within a transaction. At the end of the transaction, the
+ * generated records and statistics will be emitted.
+ */
+export declare function serializeInTransaction(kind: SerializationKind, emitRecord: EmitRecordCallback, emitStats: EmitStatsCallback, scope: RecordingScope, serialize: SerializationTransactionCallback): void;

package/cjs/domain/record/serialization/serializationTransaction.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeInTransaction = serializeInTransaction;
+const kubesense_browser_core_1 = require("@kubesense/kubesense-browser-core");
+const serializationStats_1 = require("./serializationStats");
+/**
+ * Perform serialization within a transaction. At the end of the transaction, the
+ * generated records and statistics will be emitted.
+ */
+function serializeInTransaction(kind, emitRecord, emitStats, scope, serialize) {
+    const records = [];
+    const stats = (0, serializationStats_1.createSerializationStats)();
+    const transaction = {
+        add(record) {
+            records.push(record);
+        },
+        addMetric(metric, value) {
+            (0, serializationStats_1.updateSerializationStats)(stats, metric, value);
+        },
+        assignId(node) {
+            const id = scope.nodeIds.assign(node);
+            if (transaction.serializedNodeIds) {
+                transaction.serializedNodeIds.add(id);
+            }
+            return id;
+        },
+        kind,
+        scope,
+    };
+    const start = (0, kubesense_browser_core_1.timeStampNow)();
+    serialize(transaction);
+    (0, serializationStats_1.updateSerializationStats)(stats, 'serializationDuration', (0, kubesense_browser_core_1.elapsed)(start, (0, kubesense_browser_core_1.timeStampNow)()));
+    for (const record of records) {
+        emitRecord(record);
+    }
+    emitStats(stats);
+}
+//# sourceMappingURL=serializationTransaction.js.map

package/cjs/domain/record/serialization/serializationTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializationTransaction.js","sourceRoot":"","sources":["../../../../src/domain/record/serialization/serializationTransaction.ts"],"names":[],"mappings":";;AAwDA,wDAqCC;AA7FD,8EAAyE;AAOzE,6DAAyF;AA6CzF;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,IAAuB,EACvB,UAA8B,EAC9B,SAA4B,EAC5B,KAAqB,EACrB,SAA2C;IAE3C,MAAM,OAAO,GAAoB,EAAE,CAAA;IACnC,MAAM,KAAK,GAAG,IAAA,6CAAwB,GAAE,CAAA;IAExC,MAAM,WAAW,GAA6B;QAC5C,GAAG,CAAC,MAAqB;YACvB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACtB,CAAC;QACD,SAAS,CAAC,MAAgC,EAAE,KAAa;YACvD,IAAA,6CAAwB,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;QAChD,CAAC;QACD,QAAQ,CAAC,IAAU;YACjB,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACrC,IAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC;gBAClC,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACvC,CAAC;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QACD,IAAI;QACJ,KAAK;KACN,CAAA;IAED,MAAM,KAAK,GAAG,IAAA,qCAAY,GAAE,CAAA;IAC5B,SAAS,CAAC,WAAW,CAAC,CAAA;IACtB,IAAA,6CAAwB,EAAC,KAAK,EAAE,uBAAuB,EAAE,IAAA,gCAAO,EAAC,KAAK,EAAE,IAAA,qCAAY,GAAE,CAAC,CAAC,CAAA;IAExF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,UAAU,CAAC,MAAM,CAAC,CAAA;IACpB,CAAC;IAED,SAAS,CAAC,KAAK,CAAC,CAAA;AAClB,CAAC"}

package/cjs/domain/record/serialization/serializationUtils.d.ts

@@ -0,0 +1,18 @@
+import type { NodePrivacyLevel } from '@kubesense/kubesense-browser-rum-core';
+/**
+ * Get the element "value" to be serialized as an attribute or an input update record. It respects
+ * the input privacy mode of the element.
+ * PERFROMANCE OPTIMIZATION: Assumes that privacy level `HIDDEN` is never encountered because of earlier checks.
+ */
+export declare function getElementInputValue(element: Element, nodePrivacyLevel: NodePrivacyLevel): string | undefined;
+export declare const URL_IN_CSS_REF: RegExp;
+export declare const ABSOLUTE_URL: RegExp;
+export declare const DATA_URI: RegExp;
+export declare function switchToAbsoluteUrl(cssText: string, cssHref: string | null): string;
+export declare function getValidTagName(tagName: string): string;
+/**
+ * Returns the tag name of the given element, normalized to ensure a consistent lowercase
+ * representation regardless of whether the element is HTML, XHTML, or SVG.
+ */
+export declare function normalizedTagName(element: Element): string;
+export declare function censoredImageForSize(width: number, height: number): string;

package/cjs/domain/record/serialization/serializationUtils.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DATA_URI = exports.ABSOLUTE_URL = exports.URL_IN_CSS_REF = void 0;
+exports.getElementInputValue = getElementInputValue;
+exports.switchToAbsoluteUrl = switchToAbsoluteUrl;
+exports.getValidTagName = getValidTagName;
+exports.normalizedTagName = normalizedTagName;
+exports.censoredImageForSize = censoredImageForSize;
+const kubesense_browser_core_1 = require("@kubesense/kubesense-browser-core");
+const kubesense_browser_rum_core_1 = require("@kubesense/kubesense-browser-rum-core");
+/**
+ * Get the element "value" to be serialized as an attribute or an input update record. It respects
+ * the input privacy mode of the element.
+ * PERFROMANCE OPTIMIZATION: Assumes that privacy level `HIDDEN` is never encountered because of earlier checks.
+ */
+function getElementInputValue(element, nodePrivacyLevel) {
+    /*
+     BROWSER SPEC NOTE: <input>, <select>
+     For some <input> elements, the `value` is an exceptional property/attribute that has the
+     value synced between el.value and el.getAttribute()
+     input[type=button,checkbox,hidden,image,radio,reset,submit]
+     */
+    const tagName = element.tagName;
+    const value = element.value;
+    if ((0, kubesense_browser_rum_core_1.shouldMaskNode)(element, nodePrivacyLevel)) {
+        const type = element.type;
+        if (tagName === 'INPUT' && (type === 'button' || type === 'submit' || type === 'reset')) {
+            // Overrule `MASK` privacy level for button-like element values, as they are used during replay
+            // to display their label. They can still be hidden via the "hidden" privacy attribute or class name.
+            return value;
+        }
+        else if (!value || tagName === 'OPTION') {
+            // <Option> value provides no benefit
+            return;
+        }
+        return kubesense_browser_rum_core_1.CENSORED_STRING_MARK;
+    }
+    if (tagName === 'OPTION' || tagName === 'SELECT') {
+        return element.value;
+    }
+    if (tagName !== 'INPUT' && tagName !== 'TEXTAREA') {
+        return;
+    }
+    return value;
+}
+exports.URL_IN_CSS_REF = /url\((?:(')([^']*)'|(")([^"]*)"|([^)]*))\)/gm;
+exports.ABSOLUTE_URL = /^[A-Za-z]+:|^\/\//;
+exports.DATA_URI = /^["']?data:.*,/i;
+function switchToAbsoluteUrl(cssText, cssHref) {
+    return cssText.replace(exports.URL_IN_CSS_REF, (matchingSubstring, singleQuote, urlWrappedInSingleQuotes, doubleQuote, urlWrappedInDoubleQuotes, urlNotWrappedInQuotes) => {
+        const url = urlWrappedInSingleQuotes || urlWrappedInDoubleQuotes || urlNotWrappedInQuotes;
+        if (!cssHref || !url || exports.ABSOLUTE_URL.test(url) || exports.DATA_URI.test(url)) {
+            return matchingSubstring;
+        }
+        const quote = singleQuote || doubleQuote || '';
+        return `url(${quote}${makeUrlAbsolute(url, cssHref)}${quote})`;
+    });
+}
+function makeUrlAbsolute(url, baseUrl) {
+    try {
+        return (0, kubesense_browser_core_1.buildUrl)(url, baseUrl).href;
+    }
+    catch (_a) {
+        return url;
+    }
+}
+const TAG_NAME_REGEX = /[^a-z1-6-_]/;
+function getValidTagName(tagName) {
+    const processedTagName = tagName.toLowerCase().trim();
+    if (TAG_NAME_REGEX.test(processedTagName)) {
+        // if the tag name is odd and we cannot extract
+        // anything from the string, then we return a
+        // generic div
+        return 'div';
+    }
+    return processedTagName;
+}
+/**
+ * Returns the tag name of the given element, normalized to ensure a consistent lowercase
+ * representation regardless of whether the element is HTML, XHTML, or SVG.
+ */
+function normalizedTagName(element) {
+    return element.tagName.toLowerCase();
+}
+function censoredImageForSize(width, height) {
+    return `data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='${width}' height='${height}' style='background-color:silver'%3E%3C/svg%3E`;
+}
+//# sourceMappingURL=serializationUtils.js.map

package/cjs/domain/record/serialization/serializationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializationUtils.js","sourceRoot":"","sources":["../../../../src/domain/record/serialization/serializationUtils.ts"],"names":[],"mappings":";;;AASA,oDAgCC;AAMD,kDAqBC;AAWD,0CAWC;AAMD,8CAEC;AAED,oDAEC;AAtGD,8EAA4D;AAC5D,sFAA4F;AAG5F;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,OAAgB,EAAE,gBAAkC;IACvF;;;;;OAKG;IACH,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAC/B,MAAM,KAAK,GAAI,OAAkD,CAAC,KAAK,CAAA;IAEvE,IAAI,IAAA,2CAAc,EAAC,OAAO,EAAE,gBAAgB,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAI,OAAkD,CAAC,IAAI,CAAA;QACrE,IAAI,OAAO,KAAK,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;YACxF,+FAA+F;YAC/F,qGAAqG;YACrG,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC1C,qCAAqC;YACrC,OAAM;QACR,CAAC;QACD,OAAO,iDAAoB,CAAA;IAC7B,CAAC;IAED,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjD,OAAQ,OAAiD,CAAC,KAAK,CAAA;IACjE,CAAC;IAED,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAClD,OAAM;IACR,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAEY,QAAA,cAAc,GAAG,8CAA8C,CAAA;AAC/D,QAAA,YAAY,GAAG,mBAAmB,CAAA;AAClC,QAAA,QAAQ,GAAG,iBAAiB,CAAA;AAEzC,SAAgB,mBAAmB,CAAC,OAAe,EAAE,OAAsB;IACzE,OAAO,OAAO,CAAC,OAAO,CACpB,sBAAc,EACd,CACE,iBAAyB,EACzB,WAA+B,EAC/B,wBAA4C,EAC5C,WAA+B,EAC/B,wBAA4C,EAC5C,qBAAyC,EACzC,EAAE;QACF,MAAM,GAAG,GAAG,wBAAwB,IAAI,wBAAwB,IAAI,qBAAqB,CAAA;QAEzF,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,oBAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,gBAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACrE,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,MAAM,KAAK,GAAG,WAAW,IAAI,WAAW,IAAI,EAAE,CAAA;QAC9C,OAAO,OAAO,KAAK,GAAG,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,KAAK,GAAG,CAAA;IAChE,CAAC,CACF,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,CAAC;QACH,OAAO,IAAA,iCAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;IACpC,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,GAAG,CAAA;IACZ,CAAC;AACH,CAAC;AAED,MAAM,cAAc,GAAG,aAAa,CAAA;AACpC,SAAgB,eAAe,CAAC,OAAe;IAC7C,MAAM,gBAAgB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAA;IAErD,IAAI,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC1C,+CAA+C;QAC/C,6CAA6C;QAC7C,cAAc;QACd,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,gBAAgB,CAAA;AACzB,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAgB;IAChD,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;AACtC,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAa,EAAE,MAAc;IAChE,OAAO,uEAAuE,KAAK,aAAa,MAAM,gDAAgD,CAAA;AACxJ,CAAC"}

package/cjs/domain/record/serialization/serializeAttribute.d.ts

@@ -0,0 +1,4 @@
+import { NodePrivacyLevel } from '@kubesense/kubesense-browser-rum-core';
+import type { RumConfiguration } from '@kubesense/kubesense-browser-rum-core';
+export declare const MAX_ATTRIBUTE_VALUE_CHAR_LENGTH = 1000000;
+export declare function serializeAttribute(element: Element, nodePrivacyLevel: NodePrivacyLevel, attributeName: string, configuration: RumConfiguration): string | null;