@grafana/faro-web-sdk 1.14.1 → 1.14.2

package/dist/cjs/instrumentations/performance/resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../../src/instrumentations/performance/resource.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAsD;AAGtD,+DAAwD;AACxD,uDAK4B;AAI5B,IAAM,uBAAuB,GAAG,EAAE,aAAa,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE,CAAC;AAE/E,SAAgB,sBAAsB,CACpC,gBAAwB,EACxB,SAAiC,EACjC,WAAmC;IAEnC,IAAM,cAAc,GAAG,gBAAI,CAAC,MAAM,CAAC,cAAc,CAAC;IAElD,IAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC,UAAC,eAAe;QACvD,IAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;QAE7C,KAA+B,UAAO,EAAP,mBAAO,EAAP,qBAAO,EAAP,IAAO,EAAE;YAAnC,IAAM,gBAAgB,gBAAA;YACzB,IAAI,IAAA,oCAAiB,EAAC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAAE;gBACzD,OAAO;aACR;YAED,IAAM,iBAAiB,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAEpD,IAAI,WAAW,GAAgB,IAAA,iDAA8B,EAAC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,YAAY,CAAC,CAAC;YAE/F,IACE,CAAC,cAAc,IAAI,IAAI,IAAI,IAAA,0CAAuB,EAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;gBAC/F,cAAc,EACd;gBACA,IAAM,iBAAiB,yBAClB,IAAA,2CAAwB,EAAC,iBAAiB,CAAC,KAC9C,gBAAgB,kBAAA,EAChB,cAAc,EAAE,IAAA,sBAAU,GAAE,GAC7B,CAAC;gBAEF,SAAS,CAAC,2BAA2B,EAAE,iBAAiB,EAAE,SAAS,EAAE;oBACnE,WAAW,aAAA;oBACX,oBAAoB,EAAE,WAAW,CAAC,UAAU,GAAG,iBAAiB,CAAC,SAAS;iBAC3E,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,CAAC;QACf,IAAI,EAAE,qCAAc;QACpB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;AACL,CAAC;AAzCD,wDAyCC","sourcesContent":["import { faro, genShortID } from '@grafana/faro-core';\nimport type { EventsAPI, PushEventOptions } from '@grafana/faro-core';\n\nimport { RESOURCE_ENTRY } from './performanceConstants';\nimport {\n  createFaroResourceTiming,\n  entryUrlIsIgnored,\n  getSpanContextFromServerTiming,\n  includePerformanceEntry,\n} from './performanceUtils';\n\ntype SpanContext = PushEventOptions['spanContext'];\n\nconst DEFAULT_TRACK_RESOURCES = { initiatorType: ['xmlhttprequest', 'fetch'] };\n\nexport function observeResourceTimings(\n  faroNavigationId: string,\n  pushEvent: EventsAPI['pushEvent'],\n  ignoredUrls: Array<string | RegExp>\n) {\n  const trackResources = faro.config.trackResources;\n\n  const observer = new PerformanceObserver((observedEntries) => {\n    const entries = observedEntries.getEntries();\n\n    for (const resourceEntryRaw of entries) {\n      if (entryUrlIsIgnored(ignoredUrls, resourceEntryRaw.name)) {\n        return;\n      }\n\n      const resourceEntryJson = resourceEntryRaw.toJSON();\n\n      let spanContext: SpanContext = getSpanContextFromServerTiming(resourceEntryJson?.serverTiming);\n\n      if (\n        (trackResources == null && includePerformanceEntry(resourceEntryJson, DEFAULT_TRACK_RESOURCES)) ||\n        trackResources\n      ) {\n        const faroResourceEntry = {\n          ...createFaroResourceTiming(resourceEntryJson),\n          faroNavigationId,\n          faroResourceId: genShortID(),\n        };\n\n        pushEvent('faro.performance.resource', faroResourceEntry, undefined, {\n          spanContext,\n          timestampOverwriteMs: performance.timeOrigin + resourceEntryJson.startTime,\n        });\n      }\n    }\n  });\n\n  observer.observe({\n    type: RESOURCE_ENTRY,\n    buffered: true,\n  });\n}\n"]}
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../../src/instrumentations/performance/resource.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAsD;AAGtD,uCAA+C;AAE/C,+DAAwD;AACxD,uDAAuH;AAKvH,IAAM,uBAAuB,GAAG,EAAE,aAAa,EAAE,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE,CAAC;AAE/E,SAAgB,sBAAsB,CACpC,gBAAwB,EACxB,SAAiC,EACjC,UAA4C;IAE5C,IAAM,cAAc,GAAG,gBAAI,CAAC,MAAM,CAAC,cAAc,CAAC;IAElD,IAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC,UAAC,eAAe;QACvD,IAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;QAE7C,KAA+B,UAAO,EAAP,mBAAO,EAAP,qBAAO,EAAP,IAAO,EAAE;YAAnC,IAAM,gBAAgB,gBAAA;YACzB,IAAI,IAAA,kBAAY,EAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE;gBACvC,OAAO;aACR;YAED,IAAM,iBAAiB,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAEpD,IAAI,WAAW,GAAgB,IAAA,iDAA8B,EAAC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,YAAY,CAAC,CAAC;YAE/F,IACE,CAAC,cAAc,IAAI,IAAI,IAAI,IAAA,0CAAuB,EAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;gBAC/F,cAAc,EACd;gBACA,IAAM,iBAAiB,yBAClB,IAAA,2CAAwB,EAAC,iBAAiB,CAAC,KAC9C,gBAAgB,kBAAA,EAChB,cAAc,EAAE,IAAA,sBAAU,GAAE,GAC7B,CAAC;gBAEF,IAAI,gBAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE;oBACvC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,CAAC;wBACjB,IAAI,EAAE,qCAAc;qBACrB,CAAC,CAAC;iBACJ;gBAED,SAAS,CAAC,2BAA2B,EAAE,iBAAiB,EAAE,SAAS,EAAE;oBACnE,WAAW,aAAA;oBACX,oBAAoB,EAAE,WAAW,CAAC,UAAU,GAAG,iBAAiB,CAAC,SAAS;iBAC3E,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,CAAC;QACf,IAAI,EAAE,qCAAc;QACpB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;AACL,CAAC;AA/CD,wDA+CC","sourcesContent":["import { faro, genShortID } from '@grafana/faro-core';\nimport type { EventsAPI, Observable, PushEventOptions } from '@grafana/faro-core';\n\nimport { isUrlIgnored } from '../../utils/url';\n\nimport { RESOURCE_ENTRY } from './performanceConstants';\nimport { createFaroResourceTiming, getSpanContextFromServerTiming, includePerformanceEntry } from './performanceUtils';\nimport type { ResourceEntryMessage } from './types';\n\ntype SpanContext = PushEventOptions['spanContext'];\n\nconst DEFAULT_TRACK_RESOURCES = { initiatorType: ['xmlhttprequest', 'fetch'] };\n\nexport function observeResourceTimings(\n  faroNavigationId: string,\n  pushEvent: EventsAPI['pushEvent'],\n  observable: Observable<ResourceEntryMessage>\n) {\n  const trackResources = faro.config.trackResources;\n\n  const observer = new PerformanceObserver((observedEntries) => {\n    const entries = observedEntries.getEntries();\n\n    for (const resourceEntryRaw of entries) {\n      if (isUrlIgnored(resourceEntryRaw.name)) {\n        return;\n      }\n\n      const resourceEntryJson = resourceEntryRaw.toJSON();\n\n      let spanContext: SpanContext = getSpanContextFromServerTiming(resourceEntryJson?.serverTiming);\n\n      if (\n        (trackResources == null && includePerformanceEntry(resourceEntryJson, DEFAULT_TRACK_RESOURCES)) ||\n        trackResources\n      ) {\n        const faroResourceEntry = {\n          ...createFaroResourceTiming(resourceEntryJson),\n          faroNavigationId,\n          faroResourceId: genShortID(),\n        };\n\n        if (faro.config.trackUserActionsPreview) {\n          observable?.notify({\n            type: RESOURCE_ENTRY,\n          });\n        }\n\n        pushEvent('faro.performance.resource', faroResourceEntry, undefined, {\n          spanContext,\n          timestampOverwriteMs: performance.timeOrigin + resourceEntryJson.startTime,\n        });\n      }\n    }\n  });\n\n  observer.observe({\n    type: RESOURCE_ENTRY,\n    buffered: true,\n  });\n}\n"]}

package/dist/cjs/instrumentations/performance/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instrumentations/performance/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { unknownString } from '@grafana/faro-core';\n\nexport type FaroNavigationTiming = Readonly<\n  {\n    duration: string;\n    documentParsingTime: string;\n    domProcessingTime: string;\n    pageLoadTime: string;\n    domContentLoadHandlerTime: string;\n    onLoadTime: string;\n    type: NavigationTimingType;\n  } & FaroResourceTiming\n>;\n\nexport type FaroResourceTiming = Readonly<{\n  name: string;\n  duration: string;\n  protocol: string;\n  tcpHandshakeTime: string;\n  dnsLookupTime: string;\n  tlsNegotiationTime: string;\n  responseStatus: string;\n  redirectTime: string;\n  requestTime: string;\n  fetchTime: string;\n  responseTime: string;\n  serviceWorkerTime: string;\n  decodedBodySize: string;\n  encodedBodySize: string;\n  cacheHitStatus: 'cache' | 'conditionalFetch' | 'fullLoad';\n  renderBlockingStatus: 'blocking' | 'non-blocking' | typeof unknownString;\n  initiatorType: string;\n  // serverTiming: PerformanceServerTiming[];\n  visibilityState: DocumentVisibilityState;\n  ttfb: string;\n}>;\n\nexport type FaroNavigationItem = {\n  faroNavigationId: string;\n  faroPreviousNavigationId: string;\n} & FaroNavigationTiming &\n  FaroResourceTiming;\n\nexport type FaroResourceItem = {\n  faroNavigationId: string;\n  faroResourceId: string;\n} & FaroResourceTiming;\n\nexport type CacheType = 'cache' | 'conditionalFetch' | 'fullLoad';\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instrumentations/performance/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { unknownString } from '@grafana/faro-core';\n\nimport type { RESOURCE_ENTRY } from './performanceConstants';\n\nexport type FaroNavigationTiming = Readonly<\n  {\n    duration: string;\n    documentParsingTime: string;\n    domProcessingTime: string;\n    pageLoadTime: string;\n    domContentLoadHandlerTime: string;\n    onLoadTime: string;\n    type: NavigationTimingType;\n  } & FaroResourceTiming\n>;\n\nexport type FaroResourceTiming = Readonly<{\n  name: string;\n  duration: string;\n  protocol: string;\n  tcpHandshakeTime: string;\n  dnsLookupTime: string;\n  tlsNegotiationTime: string;\n  responseStatus: string;\n  redirectTime: string;\n  requestTime: string;\n  fetchTime: string;\n  responseTime: string;\n  serviceWorkerTime: string;\n  decodedBodySize: string;\n  encodedBodySize: string;\n  cacheHitStatus: 'cache' | 'conditionalFetch' | 'fullLoad';\n  renderBlockingStatus: 'blocking' | 'non-blocking' | typeof unknownString;\n  initiatorType: string;\n  // serverTiming: PerformanceServerTiming[];\n  visibilityState: DocumentVisibilityState;\n  ttfb: string;\n}>;\n\nexport type FaroNavigationItem = {\n  faroNavigationId: string;\n  faroPreviousNavigationId: string;\n} & FaroNavigationTiming &\n  FaroResourceTiming;\n\nexport type FaroResourceItem = {\n  faroNavigationId: string;\n  faroResourceId: string;\n} & FaroResourceTiming;\n\nexport type CacheType = 'cache' | 'conditionalFetch' | 'fullLoad';\n\nexport type ResourceEntryMessage = {\n  type: typeof RESOURCE_ENTRY;\n};\n"]}

package/dist/cjs/instrumentations/userActions/const.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userActionDataAttribute = exports.userActionDataAttributeParsed = exports.MESSAGE_TYPE_DOM_MUTATION = exports.MESSAGE_TYPE_HTTP_REQUEST_PENDING = exports.MESSAGE_TYPE_HTTP_REQUEST_END = exports.MESSAGE_TYPE_HTTP_REQUEST_START = exports.MESSAGE_TYPE_RESOURCE_ENTRY = void 0;
+exports.MESSAGE_TYPE_RESOURCE_ENTRY = 'resource-entry';
+exports.MESSAGE_TYPE_HTTP_REQUEST_START = 'http-request-start';
+exports.MESSAGE_TYPE_HTTP_REQUEST_END = 'http-request-end';
+exports.MESSAGE_TYPE_HTTP_REQUEST_PENDING = 'http-request-pending';
+exports.MESSAGE_TYPE_DOM_MUTATION = 'dom-mutation';
+exports.userActionDataAttributeParsed = 'faroUserActionName';
+exports.userActionDataAttribute = 'data-faro-user-action-name';
+//# sourceMappingURL=const.js.map

package/dist/cjs/instrumentations/userActions/const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/const.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG,gBAAgB,CAAC;AAC/C,QAAA,+BAA+B,GAAG,oBAAoB,CAAC;AACvD,QAAA,6BAA6B,GAAG,kBAAkB,CAAC;AACnD,QAAA,iCAAiC,GAAG,sBAAsB,CAAC;AAC3D,QAAA,yBAAyB,GAAG,cAAc,CAAC;AAE3C,QAAA,6BAA6B,GAAG,oBAAoB,CAAC;AACrD,QAAA,uBAAuB,GAAG,4BAA4B,CAAC","sourcesContent":["export const MESSAGE_TYPE_RESOURCE_ENTRY = 'resource-entry';\nexport const MESSAGE_TYPE_HTTP_REQUEST_START = 'http-request-start';\nexport const MESSAGE_TYPE_HTTP_REQUEST_END = 'http-request-end';\nexport const MESSAGE_TYPE_HTTP_REQUEST_PENDING = 'http-request-pending';\nexport const MESSAGE_TYPE_DOM_MUTATION = 'dom-mutation';\n\nexport const userActionDataAttributeParsed = 'faroUserActionName';\nexport const userActionDataAttribute = 'data-faro-user-action-name';\n"]}

package/dist/cjs/instrumentations/userActions/domMutationMonitor.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.monitorDomMutations = void 0;
+var faro_core_1 = require("@grafana/faro-core");
+var const_1 = require("./const");
+function monitorDomMutations() {
+    var observable = new faro_core_1.Observable();
+    var observer = new MutationObserver(function (_mutationsList, _observer) {
+        observable.notify({ type: const_1.MESSAGE_TYPE_DOM_MUTATION });
+    });
+    observer.observe(document, {
+        attributes: true,
+        childList: true,
+        subtree: true,
+        characterData: true,
+    });
+    return observable;
+}
+exports.monitorDomMutations = monitorDomMutations;
+//# sourceMappingURL=domMutationMonitor.js.map

package/dist/cjs/instrumentations/userActions/domMutationMonitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domMutationMonitor.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/domMutationMonitor.ts"],"names":[],"mappings":";;;AAAA,gDAAgD;AAEhD,iCAAoD;AAGpD,SAAgB,mBAAmB;IACjC,IAAM,UAAU,GAAG,IAAI,sBAAU,EAAsB,CAAC;IAExD,IAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAC,cAAc,EAAE,SAAS;QAC9D,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,iCAAyB,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;QACzB,UAAU,EAAE,IAAI;QAChB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;QACb,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAfD,kDAeC","sourcesContent":["import { Observable } from '@grafana/faro-core';\n\nimport { MESSAGE_TYPE_DOM_MUTATION } from './const';\nimport type { DomMutationMessage } from './types';\n\nexport function monitorDomMutations(): Observable {\n  const observable = new Observable<DomMutationMessage>();\n\n  const observer = new MutationObserver((_mutationsList, _observer) => {\n    observable.notify({ type: MESSAGE_TYPE_DOM_MUTATION });\n  });\n\n  observer.observe(document, {\n    attributes: true,\n    childList: true,\n    subtree: true,\n    characterData: true,\n  });\n\n  return observable;\n}\n"]}

package/dist/cjs/instrumentations/userActions/httpRequestMonitor.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.monitorHttpRequests = void 0;
+var faro_core_1 = require("@grafana/faro-core");
+var url_1 = require("../../utils/url");
+var const_1 = require("./const");
+/**
+ * Monitors if any http requests are in progress.
+ */
+function monitorHttpRequests() {
+    var observable = new faro_core_1.Observable();
+    var pendingXhrRequests = 0;
+    var pendingFetchRequests = 0;
+    function emitStartMessage() {
+        observable.notify({ type: const_1.MESSAGE_TYPE_HTTP_REQUEST_START, pending: pendingXhrRequests + pendingFetchRequests });
+    }
+    function emitEndMessage() {
+        observable.notify({ type: const_1.MESSAGE_TYPE_HTTP_REQUEST_END, pending: pendingXhrRequests + pendingFetchRequests });
+    }
+    monitorFetch(function () {
+        pendingFetchRequests++;
+        emitStartMessage();
+    }, function () {
+        pendingFetchRequests--;
+        emitEndMessage();
+    });
+    monitorXhr(function () {
+        pendingXhrRequests++;
+        emitStartMessage();
+    }, function () {
+        pendingXhrRequests--;
+        emitEndMessage();
+    });
+    return observable;
+}
+exports.monitorHttpRequests = monitorHttpRequests;
+function monitorXhr(onRequestStart, onRequestEnd) {
+    var originalOpen = XMLHttpRequest.prototype.open;
+    var originalSend = XMLHttpRequest.prototype.send;
+    XMLHttpRequest.prototype.open = function () {
+        var url = arguments[1];
+        var isIgnoredUrl = (0, url_1.isUrlIgnored)(url);
+        this.addEventListener('loadstart', function () {
+            if (!isIgnoredUrl) {
+                onRequestStart();
+            }
+        });
+        this.addEventListener('loadend', function () {
+            if (!isIgnoredUrl) {
+                onRequestEnd();
+            }
+        });
+        originalOpen.apply(this, arguments);
+    };
+    XMLHttpRequest.prototype.send = function () {
+        originalSend.apply(this, arguments);
+    };
+}
+function monitorFetch(onRequestsStart, onRequestEnd) {
+    var originalFetch = window.fetch;
+    window.fetch = function () {
+        var url = getUrlFromResource(arguments[0]);
+        var isIgnoredUrl = (0, url_1.isUrlIgnored)(url);
+        // fetch started
+        if (!isIgnoredUrl) {
+            onRequestsStart();
+        }
+        return originalFetch.apply(this, arguments).finally(function () {
+            // fetch ended
+            if (!isIgnoredUrl) {
+                onRequestEnd();
+            }
+        });
+    };
+}
+function getUrlFromResource(resource) {
+    if ((0, faro_core_1.isString)(resource)) {
+        return resource;
+    }
+    else if (resource instanceof URL) {
+        return resource.href;
+    }
+    else if ((0, faro_core_1.isFunction)(resource === null || resource === void 0 ? void 0 : resource.toString)) {
+        return resource.toString();
+    }
+    return undefined;
+}
+//# sourceMappingURL=httpRequestMonitor.js.map

package/dist/cjs/instrumentations/userActions/httpRequestMonitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpRequestMonitor.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/httpRequestMonitor.ts"],"names":[],"mappings":";;;AAAA,gDAAsE;AAEtE,uCAA+C;AAE/C,iCAAyF;AAGzF;;GAEG;AACH,SAAgB,mBAAmB;IACjC,IAAM,UAAU,GAAG,IAAI,sBAAU,EAAmD,CAAC;IAErF,IAAI,kBAAkB,GAAG,CAAC,CAAC;IAC3B,IAAI,oBAAoB,GAAG,CAAC,CAAC;IAE7B,SAAS,gBAAgB;QACvB,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uCAA+B,EAAE,OAAO,EAAE,kBAAkB,GAAG,oBAAoB,EAAE,CAAC,CAAC;IACnH,CAAC;IAED,SAAS,cAAc;QACrB,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,qCAA6B,EAAE,OAAO,EAAE,kBAAkB,GAAG,oBAAoB,EAAE,CAAC,CAAC;IACjH,CAAC;IAED,YAAY,CACV;QACE,oBAAoB,EAAE,CAAC;QACvB,gBAAgB,EAAE,CAAC;IACrB,CAAC,EACD;QACE,oBAAoB,EAAE,CAAC;QACvB,cAAc,EAAE,CAAC;IACnB,CAAC,CACF,CAAC;IAEF,UAAU,CACR;QACE,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,CAAC;IACrB,CAAC,EACD;QACE,kBAAkB,EAAE,CAAC;QACrB,cAAc,EAAE,CAAC;IACnB,CAAC,CACF,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AArCD,kDAqCC;AAED,SAAS,UAAU,CAAC,cAA0B,EAAE,YAAwB;IACtE,IAAM,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC;IACnD,IAAM,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC;IAEnD,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG;QAC9B,IAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACzB,IAAM,YAAY,GAAG,IAAA,kBAAY,EAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE;YACjC,IAAI,CAAC,YAAY,EAAE;gBACjB,cAAc,EAAE,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC/B,IAAI,CAAC,YAAY,EAAE;gBACjB,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,SAAgB,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG;QAC9B,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,SAAgB,CAAC,CAAC;IAC7C,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,eAA2B,EAAE,YAAwB;IACzE,IAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC;IAEnC,MAAM,CAAC,KAAK,GAAG;QACb,IAAM,GAAG,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAM,YAAY,GAAG,IAAA,kBAAY,EAAC,GAAG,CAAC,CAAC;QAEvC,gBAAgB;QAChB,IAAI,CAAC,YAAY,EAAE;YACjB,eAAe,EAAE,CAAC;SACnB;QAED,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,SAAgB,CAAC,CAAC,OAAO,CAAC;YACzD,cAAc;YACd,IAAI,CAAC,YAAY,EAAE;gBACjB,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAa;IACvC,IAAI,IAAA,oBAAQ,EAAC,QAAQ,CAAC,EAAE;QACtB,OAAO,QAAQ,CAAC;KACjB;SAAM,IAAI,QAAQ,YAAY,GAAG,EAAE;QAClC,OAAO,QAAQ,CAAC,IAAI,CAAC;KACtB;SAAM,IAAI,IAAA,sBAAU,EAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,CAAC,EAAE;QACzC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;KAC5B;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import { isFunction, isString, Observable } from '@grafana/faro-core';\n\nimport { isUrlIgnored } from '../../utils/url';\n\nimport { MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START } from './const';\nimport type { HttpRequestEndMessage, HttpRequestStartMessage } from './types';\n\n/**\n * Monitors if any http requests are in progress.\n */\nexport function monitorHttpRequests(): Observable {\n  const observable = new Observable<HttpRequestStartMessage | HttpRequestEndMessage>();\n\n  let pendingXhrRequests = 0;\n  let pendingFetchRequests = 0;\n\n  function emitStartMessage() {\n    observable.notify({ type: MESSAGE_TYPE_HTTP_REQUEST_START, pending: pendingXhrRequests + pendingFetchRequests });\n  }\n\n  function emitEndMessage() {\n    observable.notify({ type: MESSAGE_TYPE_HTTP_REQUEST_END, pending: pendingXhrRequests + pendingFetchRequests });\n  }\n\n  monitorFetch(\n    () => {\n      pendingFetchRequests++;\n      emitStartMessage();\n    },\n    () => {\n      pendingFetchRequests--;\n      emitEndMessage();\n    }\n  );\n\n  monitorXhr(\n    () => {\n      pendingXhrRequests++;\n      emitStartMessage();\n    },\n    () => {\n      pendingXhrRequests--;\n      emitEndMessage();\n    }\n  );\n\n  return observable;\n}\n\nfunction monitorXhr(onRequestStart: () => void, onRequestEnd: () => void) {\n  const originalOpen = XMLHttpRequest.prototype.open;\n  const originalSend = XMLHttpRequest.prototype.send;\n\n  XMLHttpRequest.prototype.open = function () {\n    const url = arguments[1];\n    const isIgnoredUrl = isUrlIgnored(url);\n\n    this.addEventListener('loadstart', () => {\n      if (!isIgnoredUrl) {\n        onRequestStart();\n      }\n    });\n\n    this.addEventListener('loadend', () => {\n      if (!isIgnoredUrl) {\n        onRequestEnd();\n      }\n    });\n\n    originalOpen.apply(this, arguments as any);\n  };\n\n  XMLHttpRequest.prototype.send = function () {\n    originalSend.apply(this, arguments as any);\n  };\n}\n\nfunction monitorFetch(onRequestsStart: () => void, onRequestEnd: () => void) {\n  const originalFetch = window.fetch;\n\n  window.fetch = function () {\n    const url = getUrlFromResource(arguments[0]);\n    const isIgnoredUrl = isUrlIgnored(url);\n\n    // fetch started\n    if (!isIgnoredUrl) {\n      onRequestsStart();\n    }\n\n    return originalFetch.apply(this, arguments as any).finally(() => {\n      // fetch ended\n      if (!isIgnoredUrl) {\n        onRequestEnd();\n      }\n    });\n  };\n}\n\nfunction getUrlFromResource(resource: any): string | undefined {\n  if (isString(resource)) {\n    return resource;\n  } else if (resource instanceof URL) {\n    return resource.href;\n  } else if (isFunction(resource?.toString)) {\n    return resource.toString();\n  }\n  return undefined;\n}\n"]}

package/dist/cjs/instrumentations/userActions/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userActionDataAttribute = exports.MESSAGE_TYPE_HTTP_REQUEST_START = exports.MESSAGE_TYPE_HTTP_REQUEST_END = exports.MESSAGE_TYPE_DOM_MUTATION = exports.UserActionInstrumentation = void 0;
+var instrumentation_1 = require("./instrumentation");
+Object.defineProperty(exports, "UserActionInstrumentation", { enumerable: true, get: function () { return instrumentation_1.UserActionInstrumentation; } });
+var const_1 = require("./const");
+Object.defineProperty(exports, "MESSAGE_TYPE_DOM_MUTATION", { enumerable: true, get: function () { return const_1.MESSAGE_TYPE_DOM_MUTATION; } });
+Object.defineProperty(exports, "MESSAGE_TYPE_HTTP_REQUEST_END", { enumerable: true, get: function () { return const_1.MESSAGE_TYPE_HTTP_REQUEST_END; } });
+Object.defineProperty(exports, "MESSAGE_TYPE_HTTP_REQUEST_START", { enumerable: true, get: function () { return const_1.MESSAGE_TYPE_HTTP_REQUEST_START; } });
+Object.defineProperty(exports, "userActionDataAttribute", { enumerable: true, get: function () { return const_1.userActionDataAttribute; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/instrumentations/userActions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/index.ts"],"names":[],"mappings":";;;AAAA,qDAA8D;AAArD,4HAAA,yBAAyB,OAAA;AAElC,iCAKiB;AAJf,kHAAA,yBAAyB,OAAA;AACzB,sHAAA,6BAA6B,OAAA;AAC7B,wHAAA,+BAA+B,OAAA;AAC/B,gHAAA,uBAAuB,OAAA","sourcesContent":["export { UserActionInstrumentation } from './instrumentation';\nexport type { DomMutationMessage, HttpRequestEndMessage, HttpRequestStartMessage } from './types';\nexport {\n  MESSAGE_TYPE_DOM_MUTATION,\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n  userActionDataAttribute,\n} from './const';\n"]}

package/dist/cjs/instrumentations/userActions/instrumentation.js

@@ -0,0 +1,37 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserActionInstrumentation = void 0;
+var faro_core_1 = require("@grafana/faro-core");
+var processUserActionEventHandler_1 = require("./processUserActionEventHandler");
+var UserActionInstrumentation = /** @class */ (function (_super) {
+    __extends(UserActionInstrumentation, _super);
+    function UserActionInstrumentation() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.name = '@grafana/faro-web-sdk:instrumentation-user-action';
+        _this.version = faro_core_1.VERSION;
+        return _this;
+    }
+    UserActionInstrumentation.prototype.initialize = function () {
+        var processUserEventHandler = (0, processUserActionEventHandler_1.getUserEventHandler)(faro_core_1.faro);
+        window.addEventListener('pointerdown', processUserEventHandler);
+        window.addEventListener('keydown', processUserEventHandler);
+    };
+    return UserActionInstrumentation;
+}(faro_core_1.BaseInstrumentation));
+exports.UserActionInstrumentation = UserActionInstrumentation;
+//# sourceMappingURL=instrumentation.js.map

package/dist/cjs/instrumentations/userActions/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/instrumentation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,gDAAwE;AAExE,iFAAsE;AAEtE;IAA+C,6CAAmB;IAAlE;QAAA,qEASC;QARU,UAAI,GAAG,mDAAmD,CAAC;QAC3D,aAAO,GAAG,mBAAO,CAAC;;IAO7B,CAAC;IALC,8CAAU,GAAV;QACE,IAAM,uBAAuB,GAAG,IAAA,mDAAmB,EAAC,gBAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;QAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;IAC9D,CAAC;IACH,gCAAC;AAAD,CAAC,AATD,CAA+C,+BAAmB,GASjE;AATY,8DAAyB","sourcesContent":["import { BaseInstrumentation, faro, VERSION } from '@grafana/faro-core';\n\nimport { getUserEventHandler } from './processUserActionEventHandler';\n\nexport class UserActionInstrumentation extends BaseInstrumentation {\n  readonly name = '@grafana/faro-web-sdk:instrumentation-user-action';\n  readonly version = VERSION;\n\n  initialize(): void {\n    const processUserEventHandler = getUserEventHandler(faro);\n    window.addEventListener('pointerdown', processUserEventHandler);\n    window.addEventListener('keydown', processUserEventHandler);\n  }\n}\n"]}

package/dist/cjs/instrumentations/userActions/performanceEntriesMonitor.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.monitorPerformanceEntries = void 0;
+var faro_core_1 = require("@grafana/faro-core");
+var instrumentation_1 = require("../performance/instrumentation");
+var performanceConstants_1 = require("../performance/performanceConstants");
+var const_1 = require("./const");
+function monitorPerformanceEntries() {
+    var observable = new faro_core_1.Observable();
+    instrumentation_1.performanceEntriesSubscription.subscribe(function (data) {
+        if (data.type === performanceConstants_1.RESOURCE_ENTRY) {
+            observable.notify({ type: const_1.MESSAGE_TYPE_RESOURCE_ENTRY });
+        }
+    });
+    return observable;
+}
+exports.monitorPerformanceEntries = monitorPerformanceEntries;
+//# sourceMappingURL=performanceEntriesMonitor.js.map

package/dist/cjs/instrumentations/userActions/performanceEntriesMonitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"performanceEntriesMonitor.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/performanceEntriesMonitor.ts"],"names":[],"mappings":";;;AAAA,gDAAgD;AAEhD,kEAAgF;AAChF,4EAAqE;AAErE,iCAAsD;AAEtD,SAAgB,yBAAyB;IACvC,IAAM,UAAU,GAAG,IAAI,sBAAU,EAAE,CAAC;IAEpC,gDAA8B,CAAC,SAAS,CAAC,UAAC,IAAI;QAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,qCAAc,EAAE;YAChC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mCAA2B,EAAE,CAAC,CAAC;SAC1D;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAVD,8DAUC","sourcesContent":["import { Observable } from '@grafana/faro-core';\n\nimport { performanceEntriesSubscription } from '../performance/instrumentation';\nimport { RESOURCE_ENTRY } from '../performance/performanceConstants';\n\nimport { MESSAGE_TYPE_RESOURCE_ENTRY } from './const';\n\nexport function monitorPerformanceEntries(): Observable {\n  const observable = new Observable();\n\n  performanceEntriesSubscription.subscribe((data) => {\n    if (data.type === RESOURCE_ENTRY) {\n      observable.notify({ type: MESSAGE_TYPE_RESOURCE_ENTRY });\n    }\n  });\n\n  return observable;\n}\n"]}

package/dist/cjs/instrumentations/userActions/processUserActionEventHandler.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserEventHandler = void 0;
+var faro_core_1 = require("@grafana/faro-core");
+var const_1 = require("./const");
+var domMutationMonitor_1 = require("./domMutationMonitor");
+var httpRequestMonitor_1 = require("./httpRequestMonitor");
+var performanceEntriesMonitor_1 = require("./performanceEntriesMonitor");
+var util_1 = require("./util");
+function getUserEventHandler(faro) {
+    var api = faro.api, config = faro.config;
+    var httpMonitor = (0, httpRequestMonitor_1.monitorHttpRequests)();
+    var domMutationsMonitor = (0, domMutationMonitor_1.monitorDomMutations)();
+    var performanceEntriesMonitor = (0, performanceEntriesMonitor_1.monitorPerformanceEntries)();
+    var allMonitorsSub;
+    var allMonitorsObserver;
+    var timeoutId;
+    var actionRunning = false;
+    function processUserEvent(event) {
+        var _a;
+        var userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : const_1.userActionDataAttributeParsed);
+        if (actionRunning || userActionName == null) {
+            return;
+        }
+        actionRunning = true;
+        var startTime = (0, faro_core_1.dateNow)();
+        var endTime;
+        var actionId = (0, faro_core_1.genShortID)();
+        faro_core_1.apiMessageBus.notify({
+            type: faro_core_1.USER_ACTION_START_MESSAGE_TYPE,
+            name: userActionName,
+            startTime: startTime,
+            parentId: actionId,
+        });
+        // Triggers if no initial action happened within the first 100ms
+        timeoutId = startTimeout(timeoutId, function () {
+            endTime = (0, faro_core_1.dateNow)();
+            // Listening for follow up activities stops once action is cancelled (set to false)
+            actionRunning = false;
+            sendUserActionCancelMessage(userActionName, actionId);
+        });
+        allMonitorsObserver = (0, faro_core_1.merge)(httpMonitor, domMutationsMonitor, performanceEntriesMonitor);
+        allMonitorsSub = allMonitorsObserver
+            .takeWhile(function () { return actionRunning; })
+            .subscribe(function () {
+            // A http request, a DOM mutation or a performance entry happened so we have a follow up activity and start the timeout again
+            // If timeout is triggered the user action is done and we send respective messages and events
+            timeoutId = startTimeout(timeoutId, function () {
+                endTime = (0, faro_core_1.dateNow)();
+                var duration = endTime - startTime;
+                var eventType = event.type;
+                // order matters, first emit the user-action-end event and then push the event
+                faro_core_1.apiMessageBus.notify({
+                    type: faro_core_1.USER_ACTION_END_MESSAGE_TYPE,
+                    name: userActionName,
+                    id: actionId,
+                    startTime: startTime,
+                    endTime: endTime,
+                    duration: duration,
+                    eventType: eventType,
+                });
+                // Send the final action parent event
+                api.pushEvent(userActionName, {
+                    userActionStartTime: startTime.toString(),
+                    userActionEndTime: endTime.toString(),
+                    userActionDuration: duration.toString(),
+                    userActionEventType: eventType,
+                }, undefined, {
+                    timestampOverwriteMs: startTime,
+                    customPayloadTransformer: function (payload) {
+                        payload.action = {
+                            id: actionId,
+                            name: userActionName,
+                        };
+                        return payload;
+                    },
+                });
+                // Ensure action is blocked until it is fully processed.
+                actionRunning = false;
+                allMonitorsSub === null || allMonitorsSub === void 0 ? void 0 : allMonitorsSub.unsubscribe();
+                allMonitorsObserver === null || allMonitorsObserver === void 0 ? void 0 : allMonitorsObserver.unsubscribeAll();
+            });
+        });
+    }
+    registerVisibilityChangeHandler(allMonitorsSub, allMonitorsObserver);
+    return processUserEvent;
+}
+exports.getUserEventHandler = getUserEventHandler;
+function getUserActionName(element, dataAttributeName) {
+    var parsedDataAttributeName = (0, util_1.convertDataAttributeName)(dataAttributeName);
+    var dataset = element.dataset;
+    for (var key in dataset) {
+        if (key === parsedDataAttributeName) {
+            return dataset[key];
+        }
+    }
+    return undefined;
+}
+function startTimeout(timeoutId, cb) {
+    var maxTimeSpanTillUserActionEnd = 100;
+    if (timeoutId) {
+        clearTimeout(timeoutId);
+    }
+    //@ts-expect-error for some reason vscode is using the node types
+    timeoutId = setTimeout(function () {
+        cb();
+    }, maxTimeSpanTillUserActionEnd);
+    return timeoutId;
+}
+function sendUserActionCancelMessage(userActionName, actionId) {
+    faro_core_1.apiMessageBus.notify({
+        type: faro_core_1.USER_ACTION_CANCEL_MESSAGE_TYPE,
+        name: userActionName,
+        parentId: actionId,
+    });
+}
+function registerVisibilityChangeHandler(allMonitorsSub, allMonitorsObserver) {
+    // stop monitoring in background tabs
+    document.addEventListener('visibilitychange', function () {
+        if (document.visibilityState === 'hidden') {
+            // Unsubscribe from all monitors when the tab goes into the background to free up resources (merge.unsubscribe() also unsubscribes from all inner observables)
+            // Monitors will be re-subscribed in the processEvent function when the first user action is detected
+            allMonitorsSub === null || allMonitorsSub === void 0 ? void 0 : allMonitorsSub.unsubscribe();
+            allMonitorsSub = undefined;
+            allMonitorsObserver === null || allMonitorsObserver === void 0 ? void 0 : allMonitorsObserver.unsubscribeAll();
+            allMonitorsObserver = undefined;
+        }
+    });
+}
+//# sourceMappingURL=processUserActionEventHandler.js.map

package/dist/cjs/instrumentations/userActions/processUserActionEventHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":";;;AAAA,gDAW4B;AAE5B,iCAAmF;AACnF,2DAA2D;AAC3D,2DAA2D;AAC3D,yEAAwE;AACxE,+BAAkD;AAElD,SAAgB,mBAAmB,CAAC,IAAU;IACpC,IAAA,GAAG,GAAa,IAAI,IAAjB,EAAE,MAAM,GAAK,IAAI,OAAT,CAAU;IAE7B,IAAM,WAAW,GAAG,IAAA,wCAAmB,GAAE,CAAC;IAC1C,IAAM,mBAAmB,GAAG,IAAA,wCAAmB,GAAE,CAAC;IAClD,IAAM,yBAAyB,GAAG,IAAA,qDAAyB,GAAE,CAAC;IAE9D,IAAI,cAAwC,CAAC;IAC7C,IAAI,mBAA2C,CAAC;IAEhD,IAAI,SAA6B,CAAC;IAClC,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,SAAS,gBAAgB,CAAC,KAAmC;;QAC3D,IAAM,cAAc,GAAG,iBAAiB,CACtC,KAAK,CAAC,MAAqB,EAC3B,MAAA,MAAM,CAAC,iCAAiC,mCAAI,qCAAuB,CACpE,CAAC;QAEF,IAAI,aAAa,IAAI,cAAc,IAAI,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,aAAa,GAAG,IAAI,CAAC;QAErB,IAAM,SAAS,GAAG,IAAA,mBAAO,GAAE,CAAC;QAC5B,IAAI,OAA2B,CAAC;QAEhC,IAAM,QAAQ,GAAG,IAAA,sBAAU,GAAE,CAAC;QAE9B,yBAAa,CAAC,MAAM,CAAC;YACnB,IAAI,EAAE,0CAA8B;YACpC,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE;YAClC,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,mBAAmB,GAAG,IAAA,iBAAK,EAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC,CAAC;QAEzF,cAAc,GAAG,mBAAmB;aACjC,SAAS,CAAC,cAAM,OAAA,aAAa,EAAb,CAAa,CAAC;aAC9B,SAAS,CAAC;YACT,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE;gBAClC,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;gBAEpB,IAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;gBACrC,IAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;gBAE7B,8EAA8E;gBAC9E,yBAAa,CAAC,MAAM,CAAC;oBACnB,IAAI,EAAE,wCAA4B;oBAClC,IAAI,EAAE,cAAc;oBACpB,EAAE,EAAE,QAAQ;oBACZ,SAAS,WAAA;oBACT,OAAO,SAAA;oBACP,QAAQ,UAAA;oBACR,SAAS,WAAA;iBACV,CAAC,CAAC;gBAEH,qCAAqC;gBACrC,GAAG,CAAC,SAAS,CACX,cAAc,EACd;oBACE,mBAAmB,EAAE,SAAS,CAAC,QAAQ,EAAE;oBACzC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE;oBACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE;oBACvC,mBAAmB,EAAE,SAAS;iBAC/B,EACD,SAAS,EACT;oBACE,oBAAoB,EAAE,SAAS;oBAC/B,wBAAwB,EAAE,UAAC,OAAO;wBAChC,OAAO,CAAC,MAAM,GAAG;4BACf,EAAE,EAAE,QAAQ;4BACZ,IAAI,EAAE,cAAc;yBACrB,CAAC;wBAEF,OAAO,OAAO,CAAC;oBACjB,CAAC;iBACF,CACF,CAAC;gBAEF,wDAAwD;gBACxD,aAAa,GAAG,KAAK,CAAC;gBACtB,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;gBAC9B,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,cAAc,EAAE,CAAC;YACxC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,+BAA+B,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;IAErE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAxGD,kDAwGC;AAED,SAAS,iBAAiB,CAAC,OAAoB,EAAE,iBAAyB;IACxE,IAAM,uBAAuB,GAAG,IAAA,+BAAwB,EAAC,iBAAiB,CAAC,CAAC;IAC5E,IAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAEhC,KAAK,IAAM,GAAG,IAAI,OAAO,EAAE;QACzB,IAAI,GAAG,KAAK,uBAAuB,EAAE;YACnC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;SACrB;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,SAA6B,EAAE,EAAc;IACjE,IAAM,4BAA4B,GAAG,GAAG,CAAC;IAEzC,IAAI,SAAS,EAAE;QACb,YAAY,CAAC,SAAS,CAAC,CAAC;KACzB;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC;QACrB,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,4BAA4B,CAAC,CAAC;IAEjC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,yBAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,2CAA+B;QACrC,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,+BAA+B,CACtC,cAAwC,EACxC,mBAA2C;IAE3C,qCAAqC;IACrC,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE;QAC5C,IAAI,QAAQ,CAAC,eAAe,KAAK,QAAQ,EAAE;YACzC,8JAA8J;YAC9J,qGAAqG;YACrG,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;YAC9B,cAAc,GAAG,SAAS,CAAC;YAE3B,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,cAAc,EAAE,CAAC;YACtC,mBAAmB,GAAG,SAAS,CAAC;SACjC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  apiMessageBus,\n  dateNow,\n  Faro,\n  genShortID,\n  merge,\n  Observable,\n  Subscription,\n  USER_ACTION_CANCEL_MESSAGE_TYPE,\n  USER_ACTION_END_MESSAGE_TYPE,\n  USER_ACTION_START_MESSAGE_TYPE,\n} from '@grafana/faro-core';\n\nimport { userActionDataAttributeParsed as userActionDataAttribute } from './const';\nimport { monitorDomMutations } from './domMutationMonitor';\nimport { monitorHttpRequests } from './httpRequestMonitor';\nimport { monitorPerformanceEntries } from './performanceEntriesMonitor';\nimport { convertDataAttributeName } from './util';\n\nexport function getUserEventHandler(faro: Faro) {\n  const { api, config } = faro;\n\n  const httpMonitor = monitorHttpRequests();\n  const domMutationsMonitor = monitorDomMutations();\n  const performanceEntriesMonitor = monitorPerformanceEntries();\n\n  let allMonitorsSub: Subscription | undefined;\n  let allMonitorsObserver: Observable | undefined;\n\n  let timeoutId: number | undefined;\n  let actionRunning = false;\n\n  function processUserEvent(event: PointerEvent | KeyboardEvent) {\n    const userActionName = getUserActionName(\n      event.target as HTMLElement,\n      config.trackUserActionsDataAttributeName ?? userActionDataAttribute\n    );\n\n    if (actionRunning || userActionName == null) {\n      return;\n    }\n\n    actionRunning = true;\n\n    const startTime = dateNow();\n    let endTime: number | undefined;\n\n    const actionId = genShortID();\n\n    apiMessageBus.notify({\n      type: USER_ACTION_START_MESSAGE_TYPE,\n      name: userActionName,\n      startTime: startTime,\n      parentId: actionId,\n    });\n\n    // Triggers if no initial action happened within the first 100ms\n    timeoutId = startTimeout(timeoutId, () => {\n      endTime = dateNow();\n\n      // Listening for follow up activities stops once action is cancelled (set to false)\n      actionRunning = false;\n      sendUserActionCancelMessage(userActionName, actionId);\n    });\n\n    allMonitorsObserver = merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor);\n\n    allMonitorsSub = allMonitorsObserver\n      .takeWhile(() => actionRunning)\n      .subscribe(() => {\n        // A http request, a DOM mutation or a performance entry happened so we have a follow up activity and start the timeout again\n        // If timeout is triggered the user action is done and we send respective messages and events\n        timeoutId = startTimeout(timeoutId, () => {\n          endTime = dateNow();\n\n          const duration = endTime - startTime;\n          const eventType = event.type;\n\n          // order matters, first emit the user-action-end event and then push the event\n          apiMessageBus.notify({\n            type: USER_ACTION_END_MESSAGE_TYPE,\n            name: userActionName,\n            id: actionId,\n            startTime,\n            endTime,\n            duration,\n            eventType,\n          });\n\n          // Send the final action parent event\n          api.pushEvent(\n            userActionName,\n            {\n              userActionStartTime: startTime.toString(),\n              userActionEndTime: endTime.toString(),\n              userActionDuration: duration.toString(),\n              userActionEventType: eventType,\n            },\n            undefined,\n            {\n              timestampOverwriteMs: startTime,\n              customPayloadTransformer: (payload) => {\n                payload.action = {\n                  id: actionId,\n                  name: userActionName,\n                };\n\n                return payload;\n              },\n            }\n          );\n\n          // Ensure action is blocked until it is fully processed.\n          actionRunning = false;\n          allMonitorsSub?.unsubscribe();\n          allMonitorsObserver?.unsubscribeAll();\n        });\n      });\n  }\n\n  registerVisibilityChangeHandler(allMonitorsSub, allMonitorsObserver);\n\n  return processUserEvent;\n}\n\nfunction getUserActionName(element: HTMLElement, dataAttributeName: string): string | undefined {\n  const parsedDataAttributeName = convertDataAttributeName(dataAttributeName);\n  const dataset = element.dataset;\n\n  for (const key in dataset) {\n    if (key === parsedDataAttributeName) {\n      return dataset[key];\n    }\n  }\n\n  return undefined;\n}\n\nfunction startTimeout(timeoutId: number | undefined, cb: () => void) {\n  const maxTimeSpanTillUserActionEnd = 100;\n\n  if (timeoutId) {\n    clearTimeout(timeoutId);\n  }\n\n  //@ts-expect-error for some reason vscode is using the node types\n  timeoutId = setTimeout(() => {\n    cb();\n  }, maxTimeSpanTillUserActionEnd);\n\n  return timeoutId;\n}\n\nfunction sendUserActionCancelMessage(userActionName: string, actionId: string) {\n  apiMessageBus.notify({\n    type: USER_ACTION_CANCEL_MESSAGE_TYPE,\n    name: userActionName,\n    parentId: actionId,\n  });\n}\n\nfunction registerVisibilityChangeHandler(\n  allMonitorsSub: Subscription | undefined,\n  allMonitorsObserver: Observable | undefined\n) {\n  // stop monitoring in background tabs\n  document.addEventListener('visibilitychange', () => {\n    if (document.visibilityState === 'hidden') {\n      // Unsubscribe from all monitors when the tab goes into the background to free up resources (merge.unsubscribe() also unsubscribes from all inner observables)\n      // Monitors will be re-subscribed in the processEvent function when the first user action is detected\n      allMonitorsSub?.unsubscribe();\n      allMonitorsSub = undefined;\n\n      allMonitorsObserver?.unsubscribeAll();\n      allMonitorsObserver = undefined;\n    }\n  });\n}\n"]}

package/dist/cjs/instrumentations/userActions/types.js

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

package/dist/cjs/instrumentations/userActions/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  MESSAGE_TYPE_DOM_MUTATION,\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n} from './const';\n\nexport type DomMutationMessage = {\n  type: typeof MESSAGE_TYPE_DOM_MUTATION;\n};\n\nexport type HttpRequestStartMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;\n  pending: number;\n};\n\nexport type HttpRequestEndMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;\n  pending: number;\n};\n"]}

package/dist/cjs/instrumentations/userActions/util.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertDataAttributeName = void 0;
+/**
+ * Parses the action attribute name by removing the 'data-' prefix and converting
+ * the remaining string to camelCase.
+ *
+ * This is needed because the browser will remove the 'data-' prefix and the dashes from
+ * data attributes and make then camelCase.
+ */
+function convertDataAttributeName(userActionDataAttribute) {
+    var withoutData = userActionDataAttribute.split('data-')[1];
+    var withUpperCase = withoutData === null || withoutData === void 0 ? void 0 : withoutData.replace(/-(.)/g, function (_, char) { return char.toUpperCase(); });
+    return withUpperCase === null || withUpperCase === void 0 ? void 0 : withUpperCase.replace(/-/g, '');
+}
+exports.convertDataAttributeName = convertDataAttributeName;
+//# sourceMappingURL=util.js.map

package/dist/cjs/instrumentations/userActions/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/util.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,uBAA+B;IACtE,IAAM,WAAW,GAAG,uBAAuB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,IAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,OAAO,EAAE,UAAC,CAAC,EAAE,IAAI,IAAK,OAAA,IAAI,CAAC,WAAW,EAAE,EAAlB,CAAkB,CAAC,CAAC;IACrF,OAAO,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAJD,4DAIC","sourcesContent":["/**\n * Parses the action attribute name by removing the 'data-' prefix and converting\n * the remaining string to camelCase.\n *\n * This is needed because the browser will remove the 'data-' prefix and the dashes from\n * data attributes and make then camelCase.\n */\nexport function convertDataAttributeName(userActionDataAttribute: string) {\n  const withoutData = userActionDataAttribute.split('data-')[1];\n  const withUpperCase = withoutData?.replace(/-(.)/g, (_, char) => char.toUpperCase());\n  return withUpperCase?.replace(/-/g, '');\n}\n"]}

package/dist/cjs/utils/index.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIgnoreUrls = exports.throttle = exports.setItem = exports.removeItem = exports.isWebStorageAvailable = exports.getItem = exports.webStorageType = exports.isSessionStorageAvailable = exports.isLocalStorageAvailable = void 0;
+exports.getIgnoreUrls = exports.throttle = exports.webStorageType = exports.setItem = exports.removeItem = exports.isWebStorageAvailable = exports.isSessionStorageAvailable = exports.isLocalStorageAvailable = exports.getItem = void 0;
 var webStorage_1 = require("./webStorage");
+Object.defineProperty(exports, "getItem", { enumerable: true, get: function () { return webStorage_1.getItem; } });
 Object.defineProperty(exports, "isLocalStorageAvailable", { enumerable: true, get: function () { return webStorage_1.isLocalStorageAvailable; } });
 Object.defineProperty(exports, "isSessionStorageAvailable", { enumerable: true, get: function () { return webStorage_1.isSessionStorageAvailable; } });
-Object.defineProperty(exports, "webStorageType", { enumerable: true, get: function () { return webStorage_1.webStorageType; } });
-Object.defineProperty(exports, "getItem", { enumerable: true, get: function () { return webStorage_1.getItem; } });
 Object.defineProperty(exports, "isWebStorageAvailable", { enumerable: true, get: function () { return webStorage_1.isWebStorageAvailable; } });
 Object.defineProperty(exports, "removeItem", { enumerable: true, get: function () { return webStorage_1.removeItem; } });
 Object.defineProperty(exports, "setItem", { enumerable: true, get: function () { return webStorage_1.setItem; } });
+Object.defineProperty(exports, "webStorageType", { enumerable: true, get: function () { return webStorage_1.webStorageType; } });
 var throttle_1 = require("./throttle");
 Object.defineProperty(exports, "throttle", { enumerable: true, get: function () { return throttle_1.throttle; } });
 var url_1 = require("./url");

package/dist/cjs/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,2CAQsB;AAPpB,qHAAA,uBAAuB,OAAA;AACvB,uHAAA,yBAAyB,OAAA;AACzB,4GAAA,cAAc,OAAA;AACd,qGAAA,OAAO,OAAA;AACP,mHAAA,qBAAqB,OAAA;AACrB,wGAAA,UAAU,OAAA;AACV,qGAAA,OAAO,OAAA;AAGT,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AAEjB,6BAAsC;AAA7B,oGAAA,aAAa,OAAA","sourcesContent":["export {\n  isLocalStorageAvailable,\n  isSessionStorageAvailable,\n  webStorageType,\n  getItem,\n  isWebStorageAvailable,\n  removeItem,\n  setItem,\n} from './webStorage';\n\nexport { throttle } from './throttle';\n\nexport { getIgnoreUrls } from './url';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,2CAQsB;AAPpB,qGAAA,OAAO,OAAA;AACP,qHAAA,uBAAuB,OAAA;AACvB,uHAAA,yBAAyB,OAAA;AACzB,mHAAA,qBAAqB,OAAA;AACrB,wGAAA,UAAU,OAAA;AACV,qGAAA,OAAO,OAAA;AACP,4GAAA,cAAc,OAAA;AAGhB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AAEjB,6BAAsC;AAA7B,oGAAA,aAAa,OAAA","sourcesContent":["export {\n  getItem,\n  isLocalStorageAvailable,\n  isSessionStorageAvailable,\n  isWebStorageAvailable,\n  removeItem,\n  setItem,\n  webStorageType,\n} from './webStorage';\n\nexport { throttle } from './throttle';\n\nexport { getIgnoreUrls } from './url';\n"]}

package/dist/cjs/utils/url.js

@@ -1,12 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIgnoreUrls = void 0;
+exports.isUrlIgnored = exports.getIgnoreUrls = void 0;
 var faro_core_1 = require("@grafana/faro-core");
 /**
- * Get all configured ignore URLs.
+ * Retrieves a list of URLs to be ignored by aggregating the ignore URLs from all transports.
+ *
+ * @returns {string[]} An array of URLs to be ignored.
  */
 function getIgnoreUrls() {
     return faro_core_1.faro.transports.transports.flatMap(function (transport) { return transport.getIgnoreUrls(); });
 }
 exports.getIgnoreUrls = getIgnoreUrls;
+/**
+ * Checks if the given URL should be ignored based on a list of ignored URLs.
+ *
+ * @param url - The URL to check.
+ * @returns `true` if the URL is in the list of ignored URLs, `false` otherwise.
+ */
+function isUrlIgnored(url) {
+    if (url === void 0) { url = ''; }
+    return getIgnoreUrls().some(function (ignoredUrl) { return url && url.match(ignoredUrl) != null; });
+}
+exports.isUrlIgnored = isUrlIgnored;
 //# sourceMappingURL=url.js.map

package/dist/cjs/utils/url.js.map

@@ -1 +1 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":";;;AAAA,gDAA0C;AAG1C;;GAEG;AACH,SAAgB,aAAa;IAC3B,OAAO,gBAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,SAAoB,IAAK,OAAA,SAAS,CAAC,aAAa,EAAE,EAAzB,CAAyB,CAAC,CAAC;AACjG,CAAC;AAFD,sCAEC","sourcesContent":["import { faro } from '@grafana/faro-core';\nimport type { Transport } from '@grafana/faro-core';\n\n/**\n * Get all configured ignore URLs.\n */\nexport function getIgnoreUrls() {\n  return faro.transports.transports.flatMap((transport: Transport) => transport.getIgnoreUrls());\n}\n"]}
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":";;;AAAA,gDAA0C;AAG1C;;;;GAIG;AACH,SAAgB,aAAa;IAC3B,OAAO,gBAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,SAAoB,IAAK,OAAA,SAAS,CAAC,aAAa,EAAE,EAAzB,CAAyB,CAAC,CAAC;AACjG,CAAC;AAFD,sCAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,GAAQ;IAAR,oBAAA,EAAA,QAAQ;IACnC,OAAO,aAAa,EAAE,CAAC,IAAI,CAAC,UAAC,UAAU,IAAK,OAAA,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,EAApC,CAAoC,CAAC,CAAC;AACpF,CAAC;AAFD,oCAEC","sourcesContent":["import { faro } from '@grafana/faro-core';\nimport type { Patterns, Transport } from '@grafana/faro-core';\n\n/**\n * Retrieves a list of URLs to be ignored by aggregating the ignore URLs from all transports.\n *\n * @returns {string[]} An array of URLs to be ignored.\n */\nexport function getIgnoreUrls(): Patterns {\n  return faro.transports.transports.flatMap((transport: Transport) => transport.getIgnoreUrls());\n}\n\n/**\n * Checks if the given URL should be ignored based on a list of ignored URLs.\n *\n * @param url - The URL to check.\n * @returns `true` if the URL is in the list of ignored URLs, `false` otherwise.\n */\nexport function isUrlIgnored(url = ''): boolean {\n  return getIgnoreUrls().some((ignoredUrl) => url && url.match(ignoredUrl) != null);\n}\n"]}

package/dist/esm/config/getWebInstrumentations.js

@@ -1,6 +1,7 @@
-import { ConsoleInstrumentation, ErrorsInstrumentation, PerformanceInstrumentation, SessionInstrumentation, ViewInstrumentation, WebVitalsInstrumentation, } from '../instrumentations';
+import { ConsoleInstrumentation, ErrorsInstrumentation, PerformanceInstrumentation, SessionInstrumentation, UserActionInstrumentation, ViewInstrumentation, WebVitalsInstrumentation, } from '../instrumentations';
 export function getWebInstrumentations(options = {}) {
     const instrumentations = [
+        new UserActionInstrumentation(),
         new ErrorsInstrumentation(),
         new WebVitalsInstrumentation(),
         new SessionInstrumentation(),

package/dist/esm/config/getWebInstrumentations.js.map

@@ -1 +1 @@
-{"version":3,"file":"getWebInstrumentations.js","sourceRoot":"","sources":["../../../src/config/getWebInstrumentations.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAI7B,MAAM,UAAU,sBAAsB,CAAC,UAAyC,EAAE;IAChF,MAAM,gBAAgB,GAAsB;QAC1C,IAAI,qBAAqB,EAAE;QAC3B,IAAI,wBAAwB,EAAE;QAC9B,IAAI,sBAAsB,EAAE;QAC5B,IAAI,mBAAmB,EAAE;KAC1B,CAAC;IAEF,IAAI,OAAO,CAAC,gCAAgC,KAAK,KAAK,EAAE;QACtD,iFAAiF;QACjF,gBAAgB,CAAC,OAAO,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;KAC5D;IAED,IAAI,OAAO,CAAC,cAAc,KAAK,KAAK,EAAE;QACpC,gBAAgB,CAAC,IAAI,CACnB,IAAI,sBAAsB,CAAC;YACzB,cAAc,EAAE,OAAO,CAAC,4BAA4B;SACrD,CAAC,CACH,CAAC;KACH;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["import type { Instrumentation } from '@grafana/faro-core';\n\nimport {\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  PerformanceInstrumentation,\n  SessionInstrumentation,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n} from '../instrumentations';\n\nimport type { GetWebInstrumentationsOptions } from './types';\n\nexport function getWebInstrumentations(options: GetWebInstrumentationsOptions = {}): Instrumentation[] {\n  const instrumentations: Instrumentation[] = [\n    new ErrorsInstrumentation(),\n    new WebVitalsInstrumentation(),\n    new SessionInstrumentation(),\n    new ViewInstrumentation(),\n  ];\n\n  if (options.enablePerformanceInstrumentation !== false) {\n    // unshift to ensure that initialization starts before the other instrumentations\n    instrumentations.unshift(new PerformanceInstrumentation());\n  }\n\n  if (options.captureConsole !== false) {\n    instrumentations.push(\n      new ConsoleInstrumentation({\n        disabledLevels: options.captureConsoleDisabledLevels,\n      })\n    );\n  }\n\n  return instrumentations;\n}\n"]}
+{"version":3,"file":"getWebInstrumentations.js","sourceRoot":"","sources":["../../../src/config/getWebInstrumentations.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAI7B,MAAM,UAAU,sBAAsB,CAAC,UAAyC,EAAE;IAChF,MAAM,gBAAgB,GAAsB;QAC1C,IAAI,yBAAyB,EAAE;QAC/B,IAAI,qBAAqB,EAAE;QAC3B,IAAI,wBAAwB,EAAE;QAC9B,IAAI,sBAAsB,EAAE;QAC5B,IAAI,mBAAmB,EAAE;KAC1B,CAAC;IAEF,IAAI,OAAO,CAAC,gCAAgC,KAAK,KAAK,EAAE;QACtD,iFAAiF;QACjF,gBAAgB,CAAC,OAAO,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;KAC5D;IAED,IAAI,OAAO,CAAC,cAAc,KAAK,KAAK,EAAE;QACpC,gBAAgB,CAAC,IAAI,CACnB,IAAI,sBAAsB,CAAC;YACzB,cAAc,EAAE,OAAO,CAAC,4BAA4B;SACrD,CAAC,CACH,CAAC;KACH;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["import type { Instrumentation } from '@grafana/faro-core';\n\nimport {\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  PerformanceInstrumentation,\n  SessionInstrumentation,\n  UserActionInstrumentation,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n} from '../instrumentations';\n\nimport type { GetWebInstrumentationsOptions } from './types';\n\nexport function getWebInstrumentations(options: GetWebInstrumentationsOptions = {}): Instrumentation[] {\n  const instrumentations: Instrumentation[] = [\n    new UserActionInstrumentation(),\n    new ErrorsInstrumentation(),\n    new WebVitalsInstrumentation(),\n    new SessionInstrumentation(),\n    new ViewInstrumentation(),\n  ];\n\n  if (options.enablePerformanceInstrumentation !== false) {\n    // unshift to ensure that initialization starts before the other instrumentations\n    instrumentations.unshift(new PerformanceInstrumentation());\n  }\n\n  if (options.captureConsole !== false) {\n    instrumentations.push(\n      new ConsoleInstrumentation({\n        disabledLevels: options.captureConsoleDisabledLevels,\n      })\n    );\n  }\n\n  return instrumentations;\n}\n"]}

package/dist/esm/config/makeCoreConfig.js

@@ -1,7 +1,8 @@
-import { createInternalLogger, defaultBatchingConfig, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogArgsSerializer, defaultUnpatchedConsole, isEmpty, isObject, } from '@grafana/faro-core';
+import { createInternalLogger, defaultBatchingConfig, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogArgsSerializer, defaultUnpatchedConsole, isBoolean, isEmpty, isObject, } from '@grafana/faro-core';
 import { defaultEventDomain } from '../consts';
 import { parseStacktrace } from '../instrumentations';
 import { defaultSessionTrackingConfig } from '../instrumentations/session';
+import { userActionDataAttribute } from '../instrumentations/userActions/const';
 import { browserMeta } from '../metas';
 import { k6Meta } from '../metas/k6';
 import { createPageMeta } from '../metas/page';
@@ -26,15 +27,15 @@ export function makeCoreConfig(browserConfig) {
     else {
         internalLogger.error('either "url" or "transports" must be defined');
     }
-    const { app, batching, beforeSend, consoleInstrumentation, ignoreErrors, sessionTracking, trackResources, trackWebVitalsAttribution, user, view, geoLocationTracking, 
+    const { app, batching, beforeSend, consoleInstrumentation, ignoreErrors, sessionTracking, trackResources, trackWebVitalsAttribution, user, view, trackGeolocation, 
     // properties with default values
-    dedupe = true, eventDomain = defaultEventDomain, globalObjectKey = defaultGlobalObjectKey, instrumentations = getWebInstrumentations(), internalLoggerLevel = defaultInternalLoggerLevel, isolate = false, logArgsSerializer = defaultLogArgsSerializer, metas = createDefaultMetas(browserConfig), paused = false, preventGlobalExposure = false, unpatchedConsole = defaultUnpatchedConsole, webVitalsInstrumentation, } = browserConfig;
+    dedupe = true, eventDomain = defaultEventDomain, globalObjectKey = defaultGlobalObjectKey, instrumentations = getWebInstrumentations(), internalLoggerLevel = defaultInternalLoggerLevel, isolate = false, logArgsSerializer = defaultLogArgsSerializer, metas = createDefaultMetas(browserConfig), paused = false, preventGlobalExposure = false, unpatchedConsole = defaultUnpatchedConsole, webVitalsInstrumentation, trackUserActionsPreview = false, trackUserActionsDataAttributeName = userActionDataAttribute, trackUserActionsExcludeItem, } = browserConfig;
     return {
         app,
         batching: Object.assign(Object.assign({}, defaultBatchingConfig), batching),
         dedupe: dedupe,
         globalObjectKey,
-        instrumentations,
+        instrumentations: getFilteredInstrumentations(instrumentations, browserConfig),
         internalLoggerLevel,
         isolate,
         logArgsSerializer,
@@ -49,15 +50,26 @@ export function makeCoreConfig(browserConfig) {
         ignoreErrors,
         // ignore cloud collector urls by default. These are URLs ending with /collect or /collect/ followed by alphanumeric characters.
         ignoreUrls: ((_a = browserConfig.ignoreUrls) !== null && _a !== void 0 ? _a : []).concat([/\/collect(?:\/[\w]*)?$/]),
-        sessionTracking: Object.assign(Object.assign(Object.assign({}, defaultSessionTrackingConfig), sessionTracking), crateSessionMeta({ geoLocationTracking, sessionTracking })),
+        sessionTracking: Object.assign(Object.assign(Object.assign({}, defaultSessionTrackingConfig), sessionTracking), crateSessionMeta({ trackGeolocation, sessionTracking })),
         user,
         view,
         trackResources,
         trackWebVitalsAttribution,
         consoleInstrumentation,
         webVitalsInstrumentation,
+        trackUserActionsPreview,
+        trackUserActionsDataAttributeName,
+        trackUserActionsExcludeItem,
     };
 }
+function getFilteredInstrumentations(instrumentations, { trackUserActionsPreview }) {
+    return instrumentations.filter((instr) => {
+        if (instr.name === '@grafana/faro-web-sdk:instrumentation-user-action' && !trackUserActionsPreview) {
+            return false;
+        }
+        return true;
+    });
+}
 function createDefaultMetas(browserConfig) {
     var _a, _b;
     const { page, generatePageId } = (_a = browserConfig === null || browserConfig === void 0 ? void 0 : browserConfig.pageTracking) !== null && _a !== void 0 ? _a : {};
@@ -72,11 +84,11 @@ function createDefaultMetas(browserConfig) {
     }
     return initialMetas;
 }
-function crateSessionMeta({ geoLocationTracking, sessionTracking, }) {
+function crateSessionMeta({ trackGeolocation, sessionTracking, }) {
     var _a;
     const overrides = {};
-    if ((geoLocationTracking === null || geoLocationTracking === void 0 ? void 0 : geoLocationTracking.enabled) != null) {
-        overrides.geoLocationTrackingEnabled = geoLocationTracking.enabled;
+    if (isBoolean(trackGeolocation)) {
+        overrides.geoLocationTrackingEnabled = trackGeolocation;
     }
     if (isEmpty(overrides)) {
         return {};