@grafana/faro-web-sdk 1.14.1 → 1.14.2

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

@@ -0,0 +1,126 @@
+import { apiMessageBus, dateNow, genShortID, merge, USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE, } from '@grafana/faro-core';
+import { userActionDataAttributeParsed as userActionDataAttribute } from './const';
+import { monitorDomMutations } from './domMutationMonitor';
+import { monitorHttpRequests } from './httpRequestMonitor';
+import { monitorPerformanceEntries } from './performanceEntriesMonitor';
+import { convertDataAttributeName } from './util';
+export function getUserEventHandler(faro) {
+    const { api, config } = faro;
+    const httpMonitor = monitorHttpRequests();
+    const domMutationsMonitor = monitorDomMutations();
+    const performanceEntriesMonitor = monitorPerformanceEntries();
+    let allMonitorsSub;
+    let allMonitorsObserver;
+    let timeoutId;
+    let actionRunning = false;
+    function processUserEvent(event) {
+        var _a;
+        const userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : userActionDataAttribute);
+        if (actionRunning || userActionName == null) {
+            return;
+        }
+        actionRunning = true;
+        const startTime = dateNow();
+        let endTime;
+        const actionId = genShortID();
+        apiMessageBus.notify({
+            type: USER_ACTION_START_MESSAGE_TYPE,
+            name: userActionName,
+            startTime: startTime,
+            parentId: actionId,
+        });
+        // Triggers if no initial action happened within the first 100ms
+        timeoutId = startTimeout(timeoutId, () => {
+            endTime = dateNow();
+            // Listening for follow up activities stops once action is cancelled (set to false)
+            actionRunning = false;
+            sendUserActionCancelMessage(userActionName, actionId);
+        });
+        allMonitorsObserver = merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor);
+        allMonitorsSub = allMonitorsObserver
+            .takeWhile(() => actionRunning)
+            .subscribe(() => {
+            // 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, () => {
+                endTime = dateNow();
+                const duration = endTime - startTime;
+                const eventType = event.type;
+                // order matters, first emit the user-action-end event and then push the event
+                apiMessageBus.notify({
+                    type: USER_ACTION_END_MESSAGE_TYPE,
+                    name: userActionName,
+                    id: actionId,
+                    startTime,
+                    endTime,
+                    duration,
+                    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: (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;
+}
+function getUserActionName(element, dataAttributeName) {
+    const parsedDataAttributeName = convertDataAttributeName(dataAttributeName);
+    const dataset = element.dataset;
+    for (const key in dataset) {
+        if (key === parsedDataAttributeName) {
+            return dataset[key];
+        }
+    }
+    return undefined;
+}
+function startTimeout(timeoutId, cb) {
+    const maxTimeSpanTillUserActionEnd = 100;
+    if (timeoutId) {
+        clearTimeout(timeoutId);
+    }
+    //@ts-expect-error for some reason vscode is using the node types
+    timeoutId = setTimeout(() => {
+        cb();
+    }, maxTimeSpanTillUserActionEnd);
+    return timeoutId;
+}
+function sendUserActionCancelMessage(userActionName, actionId) {
+    apiMessageBus.notify({
+        type: USER_ACTION_CANCEL_MESSAGE_TYPE,
+        name: userActionName,
+        parentId: actionId,
+    });
+}
+function registerVisibilityChangeHandler(allMonitorsSub, allMonitorsObserver) {
+    // stop monitoring in background tabs
+    document.addEventListener('visibilitychange', () => {
+        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/esm/instrumentations/userActions/processUserActionEventHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,OAAO,EAEP,UAAU,EACV,KAAK,EAGL,+BAA+B,EAC/B,4BAA4B,EAC5B,8BAA8B,GAC/B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,6BAA6B,IAAI,uBAAuB,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAElD,MAAM,UAAU,mBAAmB,CAAC,IAAU;IAC5C,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7B,MAAM,WAAW,GAAG,mBAAmB,EAAE,CAAC;IAC1C,MAAM,mBAAmB,GAAG,mBAAmB,EAAE,CAAC;IAClD,MAAM,yBAAyB,GAAG,yBAAyB,EAAE,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,MAAM,cAAc,GAAG,iBAAiB,CACtC,KAAK,CAAC,MAAqB,EAC3B,MAAA,MAAM,CAAC,iCAAiC,mCAAI,uBAAuB,CACpE,CAAC;QAEF,IAAI,aAAa,IAAI,cAAc,IAAI,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,aAAa,GAAG,IAAI,CAAC;QAErB,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC;QAC5B,IAAI,OAA2B,CAAC;QAEhC,MAAM,QAAQ,GAAG,UAAU,EAAE,CAAC;QAE9B,aAAa,CAAC,MAAM,CAAC;YACnB,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE,GAAG,EAAE;YACvC,OAAO,GAAG,OAAO,EAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,mBAAmB,GAAG,KAAK,CAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC,CAAC;QAEzF,cAAc,GAAG,mBAAmB;aACjC,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC;aAC9B,SAAS,CAAC,GAAG,EAAE;YACd,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE,GAAG,EAAE;gBACvC,OAAO,GAAG,OAAO,EAAE,CAAC;gBAEpB,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;gBACrC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;gBAE7B,8EAA8E;gBAC9E,aAAa,CAAC,MAAM,CAAC;oBACnB,IAAI,EAAE,4BAA4B;oBAClC,IAAI,EAAE,cAAc;oBACpB,EAAE,EAAE,QAAQ;oBACZ,SAAS;oBACT,OAAO;oBACP,QAAQ;oBACR,SAAS;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,CAAC,OAAO,EAAE,EAAE;wBACpC,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;AAED,SAAS,iBAAiB,CAAC,OAAoB,EAAE,iBAAyB;IACxE,MAAM,uBAAuB,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;IAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAEhC,KAAK,MAAM,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,MAAM,4BAA4B,GAAG,GAAG,CAAC;IAEzC,IAAI,SAAS,EAAE;QACb,YAAY,CAAC,SAAS,CAAC,CAAC;KACzB;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAC1B,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,4BAA4B,CAAC,CAAC;IAEjC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,aAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,+BAA+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,GAAG,EAAE;QACjD,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/esm/instrumentations/userActions/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/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/esm/instrumentations/userActions/util.js

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+export function convertDataAttributeName(userActionDataAttribute) {
+    const withoutData = userActionDataAttribute.split('data-')[1];
+    const withUpperCase = withoutData === null || withoutData === void 0 ? void 0 : withoutData.replace(/-(.)/g, (_, char) => char.toUpperCase());
+    return withUpperCase === null || withUpperCase === void 0 ? void 0 : withUpperCase.replace(/-/g, '');
+}
+//# sourceMappingURL=util.js.map

package/dist/esm/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,MAAM,UAAU,wBAAwB,CAAC,uBAA+B;IACtE,MAAM,WAAW,GAAG,uBAAuB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACrF,OAAO,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC","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/esm/utils/index.js

@@ -1,4 +1,4 @@
-export { isLocalStorageAvailable, isSessionStorageAvailable, webStorageType, getItem, isWebStorageAvailable, removeItem, setItem, } from './webStorage';
+export { getItem, isLocalStorageAvailable, isSessionStorageAvailable, isWebStorageAvailable, removeItem, setItem, webStorageType, } from './webStorage';
 export { throttle } from './throttle';
 export { getIgnoreUrls } from './url';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,cAAc,EACd,OAAO,EACP,qBAAqB,EACrB,UAAU,EACV,OAAO,GACR,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC","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,OAAO,EACL,OAAO,EACP,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EACrB,UAAU,EACV,OAAO,EACP,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC","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/esm/utils/url.js

@@ -1,8 +1,19 @@
 import { faro } from '@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.
  */
 export function getIgnoreUrls() {
     return faro.transports.transports.flatMap((transport) => transport.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.
+ */
+export function isUrlIgnored(url = '') {
+    return getIgnoreUrls().some((ignoredUrl) => url && url.match(ignoredUrl) != null);
+}
 //# sourceMappingURL=url.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAG1C;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;AACjG,CAAC","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,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAG1C;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;AACjG,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,GAAG,GAAG,EAAE;IACnC,OAAO,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC;AACpF,CAAC","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/types/index.d.ts

@@ -2,12 +2,13 @@ export { getWebInstrumentations, makeCoreConfig } from './config';
 export type { BrowserConfig } from './config';
 export { defaultEventDomain } from './consts';
 export { initializeFaro } from './initialize';
-export { buildStackFrame, ConsoleInstrumentation, ErrorsInstrumentation, getDataFromSafariExtensions, getStackFramesFromError, parseStacktrace, ViewInstrumentation, WebVitalsInstrumentation, SessionInstrumentation, PerformanceInstrumentation, } from './instrumentations';
+export { buildStackFrame, ConsoleInstrumentation, ErrorsInstrumentation, getDataFromSafariExtensions, getStackFramesFromError, parseStacktrace, ViewInstrumentation, WebVitalsInstrumentation, SessionInstrumentation, PerformanceInstrumentation, UserActionInstrumentation, } from './instrumentations';
 export type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectionEvent } from './instrumentations';
 export { browserMeta, createSession, sdkMeta } from './metas';
 export { ConsoleTransport, FetchTransport } from './transports';
 export type { ClockFn, ConsoleTransportOptions, FetchTransportOptions, FetchTransportRequestOptions, } from './transports';
-export { faro, allLogLevels, BaseExtension, BaseInstrumentation, BaseTransport, Conventions, createInternalLogger, createPromiseBuffer, deepEqual, defaultExceptionType, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogLevel, genShortID, getCurrentTimestamp, getInternalFaroFromGlobalObject, getTransportBody, globalObject, internalGlobalObjectKey, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isInternalFaroOnGlobalObject, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, isEmpty, InternalLoggerLevel, LogLevel, noop, setInternalFaroOnGlobalObject, TransportItemType, transportItemTypeToBodyKey, VERSION, EVENT_CLICK, EVENT_NAVIGATION, EVENT_ROUTE_CHANGE, EVENT_SESSION_EXTEND, EVENT_SESSION_RESUME, EVENT_SESSION_START, EVENT_VIEW_CHANGED, } from '@grafana/faro-core';
-export type { Faro, API, APIEvent, BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BeforeSendHook, BufferItem, Config, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, Extension, GlobalObject, Instrumentation, Instrumentations, InternalLogger, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, Meta, MetaAPI, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, OTELApi, Patterns, PromiseBuffer, PromiseBufferOptions, PromiseProducer, PushErrorOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, UnpatchedConsole, } from '@grafana/faro-core';
+export { faro, allLogLevels, BaseExtension, BaseInstrumentation, BaseTransport, Conventions, createInternalLogger, createPromiseBuffer, deepEqual, defaultExceptionType, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogLevel, genShortID, getCurrentTimestamp, getInternalFaroFromGlobalObject, getTransportBody, globalObject, internalGlobalObjectKey, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isInternalFaroOnGlobalObject, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, isEmpty, InternalLoggerLevel, LogLevel, noop, setInternalFaroOnGlobalObject, TransportItemType, transportItemTypeToBodyKey, VERSION, EVENT_CLICK, EVENT_NAVIGATION, EVENT_ROUTE_CHANGE, EVENT_SESSION_EXTEND, EVENT_SESSION_RESUME, EVENT_SESSION_START, EVENT_VIEW_CHANGED, apiMessageBus, Observable, merge, USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE, } from '@grafana/faro-core';
+export type { Faro, API, APIEvent, BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BeforeSendHook, BufferItem, Config, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, Extension, GlobalObject, Instrumentation, Instrumentations, InternalLogger, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, Meta, MetaAPI, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, OTELApi, Patterns, PromiseBuffer, PromiseBufferOptions, PromiseProducer, PushErrorOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, UnpatchedConsole, ApiMessageBusMessages, UserActionStartMessage, UserActionEndMessage, UserActionCancelMessage, UserAction, } from '@grafana/faro-core';
 export { PersistentSessionsManager, VolatileSessionsManager, MAX_SESSION_PERSISTENCE_TIME, MAX_SESSION_PERSISTENCE_TIME_BUFFER, SESSION_EXPIRATION_TIME, SESSION_INACTIVITY_TIME, STORAGE_KEY, } from './instrumentations/session';
 export { getIgnoreUrls } from './utils/url';
+export { userActionDataAttribute } from './instrumentations/userActions/const';

package/dist/types/instrumentations/console/instrumentation.d.ts

@@ -3,7 +3,7 @@ import type { ConsoleInstrumentationOptions } from './types';
 export declare class ConsoleInstrumentation extends BaseInstrumentation {
     private options;
     readonly name = "@grafana/faro-web-sdk:instrumentation-console";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     static defaultDisabledLevels: LogLevel[];
     static consoleErrorPrefix: string;
     private errorSerializer;

package/dist/types/instrumentations/errors/instrumentation.d.ts

@@ -1,6 +1,6 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class ErrorsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-errors";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     initialize(): void;
 }

package/dist/types/instrumentations/index.d.ts

@@ -7,3 +7,4 @@ export { ViewInstrumentation } from './view';
 export { WebVitalsInstrumentation } from './webVitals';
 export { PersistentSessionsManager, VolatileSessionsManager, MAX_SESSION_PERSISTENCE_TIME, MAX_SESSION_PERSISTENCE_TIME_BUFFER, SESSION_EXPIRATION_TIME, SESSION_INACTIVITY_TIME, STORAGE_KEY, } from './session';
 export { PerformanceInstrumentation } from './performance';
+export { UserActionInstrumentation, userActionDataAttribute } from './userActions';

package/dist/types/instrumentations/performance/instrumentation.d.ts

@@ -1,7 +1,8 @@
-import { BaseInstrumentation } from '@grafana/faro-core';
+import { BaseInstrumentation, Observable } from '@grafana/faro-core';
+import type { ResourceEntryMessage } from './types';
+export declare const performanceEntriesSubscription: Observable<ResourceEntryMessage>;
 export declare class PerformanceInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-performance";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     initialize(): void;
-    private getIgnoreUrls;
 }

package/dist/types/instrumentations/performance/navigation.d.ts

@@ -1,3 +1,3 @@
 import type { EventsAPI } from '@grafana/faro-core';
 import type { FaroNavigationItem } from './types';
-export declare function getNavigationTimings(pushEvent: EventsAPI['pushEvent'], ignoredUrls: Array<string | RegExp>): Promise<FaroNavigationItem>;
+export declare function getNavigationTimings(pushEvent: EventsAPI['pushEvent']): Promise<FaroNavigationItem>;

package/dist/types/instrumentations/performance/performanceUtils.d.ts

@@ -3,7 +3,6 @@ import type { FaroNavigationTiming, FaroResourceTiming } from './types';
 type SpanContext = PushEventOptions['spanContext'];
 export declare function getSpanContextFromServerTiming(serverTimings?: PerformanceServerTiming[]): SpanContext | undefined;
 export declare function performanceObserverSupported(): boolean;
-export declare function entryUrlIsIgnored(ignoredUrls: (string | RegExp)[] | undefined, entryName: string): boolean;
 export declare function onDocumentReady(handleReady: () => void): void;
 type PerformanceEntryAllowProperties = Record<string, Array<string | number> | string | number>;
 export declare function includePerformanceEntry(performanceEntryJSON: Record<string, any>, allowProps?: PerformanceEntryAllowProperties): boolean;

package/dist/types/instrumentations/performance/resource.d.ts

@@ -1,2 +1,3 @@
-import type { EventsAPI } from '@grafana/faro-core';
-export declare function observeResourceTimings(faroNavigationId: string, pushEvent: EventsAPI['pushEvent'], ignoredUrls: Array<string | RegExp>): void;
+import type { EventsAPI, Observable } from '@grafana/faro-core';
+import type { ResourceEntryMessage } from './types';
+export declare function observeResourceTimings(faroNavigationId: string, pushEvent: EventsAPI['pushEvent'], observable: Observable<ResourceEntryMessage>): void;

package/dist/types/instrumentations/performance/types.d.ts

@@ -1,4 +1,5 @@
 import type { unknownString } from '@grafana/faro-core';
+import type { RESOURCE_ENTRY } from './performanceConstants';
 export type FaroNavigationTiming = Readonly<{
     duration: string;
     documentParsingTime: string;
@@ -38,3 +39,6 @@ export type FaroResourceItem = {
     faroResourceId: string;
 } & FaroResourceTiming;
 export type CacheType = 'cache' | 'conditionalFetch' | 'fullLoad';
+export type ResourceEntryMessage = {
+    type: typeof RESOURCE_ENTRY;
+};

package/dist/types/instrumentations/session/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class SessionInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-session";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     private notifiedSession;
     private sendSessionStartEvent;
     private createInitialSession;

package/dist/types/instrumentations/userActions/const.d.ts

@@ -0,0 +1,7 @@
+export declare const MESSAGE_TYPE_RESOURCE_ENTRY = "resource-entry";
+export declare const MESSAGE_TYPE_HTTP_REQUEST_START = "http-request-start";
+export declare const MESSAGE_TYPE_HTTP_REQUEST_END = "http-request-end";
+export declare const MESSAGE_TYPE_HTTP_REQUEST_PENDING = "http-request-pending";
+export declare const MESSAGE_TYPE_DOM_MUTATION = "dom-mutation";
+export declare const userActionDataAttributeParsed = "faroUserActionName";
+export declare const userActionDataAttribute = "data-faro-user-action-name";

package/dist/types/instrumentations/userActions/domMutationMonitor.d.ts

@@ -0,0 +1,2 @@
+import { Observable } from '@grafana/faro-core';
+export declare function monitorDomMutations(): Observable;

package/dist/types/instrumentations/userActions/httpRequestMonitor.d.ts

@@ -0,0 +1,5 @@
+import { Observable } from '@grafana/faro-core';
+/**
+ * Monitors if any http requests are in progress.
+ */
+export declare function monitorHttpRequests(): Observable;

package/dist/types/instrumentations/userActions/index.d.ts

@@ -0,0 +1,3 @@
+export { UserActionInstrumentation } from './instrumentation';
+export type { DomMutationMessage, HttpRequestEndMessage, HttpRequestStartMessage } from './types';
+export { MESSAGE_TYPE_DOM_MUTATION, MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START, userActionDataAttribute, } from './const';

package/dist/types/instrumentations/userActions/instrumentation.d.ts

@@ -0,0 +1,6 @@
+import { BaseInstrumentation } from '@grafana/faro-core';
+export declare class UserActionInstrumentation extends BaseInstrumentation {
+    readonly name = "@grafana/faro-web-sdk:instrumentation-user-action";
+    readonly version = "1.14.2";
+    initialize(): void;
+}

package/dist/types/instrumentations/userActions/performanceEntriesMonitor.d.ts

@@ -0,0 +1,2 @@
+import { Observable } from '@grafana/faro-core';
+export declare function monitorPerformanceEntries(): Observable;

package/dist/types/instrumentations/userActions/processUserActionEventHandler.d.ts

@@ -0,0 +1,2 @@
+import { Faro } from '@grafana/faro-core';
+export declare function getUserEventHandler(faro: Faro): (event: PointerEvent | KeyboardEvent) => void;

package/dist/types/instrumentations/userActions/types.d.ts

@@ -0,0 +1,12 @@
+import type { MESSAGE_TYPE_DOM_MUTATION, MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START } from './const';
+export type DomMutationMessage = {
+    type: typeof MESSAGE_TYPE_DOM_MUTATION;
+};
+export type HttpRequestStartMessage = {
+    type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;
+    pending: number;
+};
+export type HttpRequestEndMessage = {
+    type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;
+    pending: number;
+};

package/dist/types/instrumentations/userActions/util.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+export declare function convertDataAttributeName(userActionDataAttribute: string): string | undefined;

package/dist/types/instrumentations/view/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class ViewInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-view";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     private notifiedView;
     private sendViewChangedEvent;
     initialize(): void;

package/dist/types/instrumentations/webVitals/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class WebVitalsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-web-vitals";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     initialize(): void;
     private intializeWebVitalsInstrumentation;
 }

package/dist/types/transports/console/transport.d.ts

@@ -4,7 +4,7 @@ import type { ConsoleTransportOptions } from './types';
 export declare class ConsoleTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-console";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     constructor(options?: ConsoleTransportOptions);
     send(item: TransportItem): void;
 }

package/dist/types/transports/fetch/transport.d.ts

@@ -4,7 +4,7 @@ import type { FetchTransportOptions } from './types';
 export declare class FetchTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-fetch";
-    readonly version = "1.14.1";
+    readonly version = "1.14.2";
     promiseBuffer: PromiseBuffer<Response | void>;
     private readonly rateLimitBackoffMs;
     private readonly getNow;

package/dist/types/utils/index.d.ts

@@ -1,3 +1,3 @@
-export { isLocalStorageAvailable, isSessionStorageAvailable, webStorageType, getItem, isWebStorageAvailable, removeItem, setItem, } from './webStorage';
+export { getItem, isLocalStorageAvailable, isSessionStorageAvailable, isWebStorageAvailable, removeItem, setItem, webStorageType, } from './webStorage';
 export { throttle } from './throttle';
 export { getIgnoreUrls } from './url';

package/dist/types/utils/url.d.ts

@@ -1,4 +1,14 @@
+import type { Patterns } from '@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.
  */
-export declare function getIgnoreUrls(): (string | RegExp)[];
+export declare function getIgnoreUrls(): Patterns;
+/**
+ * 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.
+ */
+export declare function isUrlIgnored(url?: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-web-sdk",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "description": "Faro instrumentations, metas, transports for web.",
   "engines": {
     "node": ">=18.0.0"
@@ -55,7 +55,7 @@
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
-    "@grafana/faro-core": "^1.14.1",
+    "@grafana/faro-core": "^1.14.2",
     "ua-parser-js": "^1.0.32",
     "web-vitals": "^4.0.1"
   },
@@ -67,5 +67,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b44d0c2a52419786a497fbf3f47b781d27cc0982"
+  "gitHead": "b115e12fe1242e502d57ef5f8439a326a80dd6b7"
 }