@grafana/faro-web-sdk 1.15.0 → 1.16.0

package/dist/bundle/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.15.0";
+    readonly version = "1.16.0";
     constructor(options?: ConsoleTransportOptions);
     send(item: TransportItem): void;
 }

package/dist/bundle/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.15.0";
+    readonly version = "1.16.0";
     promiseBuffer: PromiseBuffer<Response | void>;
     private readonly rateLimitBackoffMs;
     private readonly getNow;

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isEventDefined = exports.isEvent = exports.isErrorEvent = exports.isErrorDefined = exports.isError = exports.isElementDefined = exports.isElement = exports.isDomException = exports.isDomError = exports.isBoolean = exports.isArray = exports.internalGlobalObjectKey = exports.globalObject = exports.getTransportBody = exports.getInternalFaroFromGlobalObject = exports.getCurrentTimestamp = exports.genShortID = exports.defaultLogLevel = exports.defaultInternalLoggerLevel = exports.defaultGlobalObjectKey = exports.defaultExceptionType = exports.deepEqual = exports.createPromiseBuffer = exports.createInternalLogger = exports.Conventions = exports.BaseTransport = exports.BaseInstrumentation = exports.BaseExtension = exports.allLogLevels = exports.faro = exports.FetchTransport = exports.ConsoleTransport = exports.sdkMeta = exports.createSession = exports.browserMeta = exports.UserActionInstrumentation = exports.PerformanceInstrumentation = exports.SessionInstrumentation = exports.WebVitalsInstrumentation = exports.ViewInstrumentation = exports.parseStacktrace = exports.getStackFramesFromError = exports.getDataFromSafariExtensions = exports.ErrorsInstrumentation = exports.ConsoleInstrumentation = exports.buildStackFrame = exports.initializeFaro = exports.defaultEventDomain = exports.makeCoreConfig = exports.getWebInstrumentations = void 0;
-exports.userActionDataAttribute = exports.getUrlFromResource = exports.getIgnoreUrls = exports.STORAGE_KEY = exports.SESSION_INACTIVITY_TIME = exports.SESSION_EXPIRATION_TIME = exports.MAX_SESSION_PERSISTENCE_TIME_BUFFER = exports.MAX_SESSION_PERSISTENCE_TIME = exports.VolatileSessionsManager = exports.PersistentSessionsManager = exports.USER_ACTION_START = exports.USER_ACTION_END = exports.USER_ACTION_CANCEL = exports.Observable = exports.apiMessageBus = exports.EVENT_VIEW_CHANGED = exports.EVENT_SESSION_START = exports.EVENT_SESSION_RESUME = exports.EVENT_SESSION_EXTEND = exports.EVENT_ROUTE_CHANGE = exports.EVENT_NAVIGATION = exports.EVENT_CLICK = exports.VERSION = exports.transportItemTypeToBodyKey = exports.TransportItemType = exports.setInternalFaroOnGlobalObject = exports.noop = exports.LogLevel = exports.InternalLoggerLevel = exports.isEmpty = exports.isUndefined = exports.isTypeof = exports.isToString = exports.isThenable = exports.isSyntheticEvent = exports.isSymbol = exports.isString = exports.isRegExp = exports.isPrimitive = exports.isObject = exports.isNumber = exports.isNull = exports.isMapDefined = exports.isMap = exports.isInternalFaroOnGlobalObject = exports.isInt = exports.isInstanceOf = exports.isFunction = void 0;
+exports.startUserAction = exports.userActionDataAttribute = exports.getUrlFromResource = exports.getIgnoreUrls = exports.STORAGE_KEY = exports.SESSION_INACTIVITY_TIME = exports.SESSION_EXPIRATION_TIME = exports.MAX_SESSION_PERSISTENCE_TIME_BUFFER = exports.MAX_SESSION_PERSISTENCE_TIME = exports.VolatileSessionsManager = exports.PersistentSessionsManager = exports.USER_ACTION_START = exports.USER_ACTION_END = exports.USER_ACTION_CANCEL = exports.Observable = exports.apiMessageBus = exports.EVENT_VIEW_CHANGED = exports.EVENT_SESSION_START = exports.EVENT_SESSION_RESUME = exports.EVENT_SESSION_EXTEND = exports.EVENT_ROUTE_CHANGE = exports.EVENT_NAVIGATION = exports.EVENT_CLICK = exports.VERSION = exports.transportItemTypeToBodyKey = exports.TransportItemType = exports.setInternalFaroOnGlobalObject = exports.noop = exports.LogLevel = exports.InternalLoggerLevel = exports.isEmpty = exports.isUndefined = exports.isTypeof = exports.isToString = exports.isThenable = exports.isSyntheticEvent = exports.isSymbol = exports.isString = exports.isRegExp = exports.isPrimitive = exports.isObject = exports.isNumber = exports.isNull = exports.isMapDefined = exports.isMap = exports.isInternalFaroOnGlobalObject = exports.isInt = exports.isInstanceOf = exports.isFunction = void 0;
 var config_1 = require("./config");
 Object.defineProperty(exports, "getWebInstrumentations", { enumerable: true, get: function () { return config_1.getWebInstrumentations; } });
 Object.defineProperty(exports, "makeCoreConfig", { enumerable: true, get: function () { return config_1.makeCoreConfig; } });
@@ -108,6 +108,7 @@ Object.defineProperty(exports, "STORAGE_KEY", { enumerable: true, get: function
 var url_1 = require("./utils/url");
 Object.defineProperty(exports, "getIgnoreUrls", { enumerable: true, get: function () { return url_1.getIgnoreUrls; } });
 Object.defineProperty(exports, "getUrlFromResource", { enumerable: true, get: function () { return url_1.getUrlFromResource; } });
-var const_1 = require("./instrumentations/userActions/const");
-Object.defineProperty(exports, "userActionDataAttribute", { enumerable: true, get: function () { return const_1.userActionDataAttribute; } });
+var userActions_1 = require("./instrumentations/userActions");
+Object.defineProperty(exports, "userActionDataAttribute", { enumerable: true, get: function () { return userActions_1.userActionDataAttribute; } });
+Object.defineProperty(exports, "startUserAction", { enumerable: true, get: function () { return userActions_1.startUserAction; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAAkE;AAAzD,gHAAA,sBAAsB,OAAA;AAAE,wGAAA,cAAc,OAAA;AAG/C,mCAA8C;AAArC,4GAAA,kBAAkB,OAAA;AAE3B,2CAA8C;AAArC,4GAAA,cAAc,OAAA;AAEvB,uDAY4B;AAX1B,mHAAA,eAAe,OAAA;AACf,0HAAA,sBAAsB,OAAA;AACtB,yHAAA,qBAAqB,OAAA;AACrB,+HAAA,2BAA2B,OAAA;AAC3B,2HAAA,uBAAuB,OAAA;AACvB,mHAAA,eAAe,OAAA;AACf,uHAAA,mBAAmB,OAAA;AACnB,4HAAA,wBAAwB,OAAA;AACxB,0HAAA,sBAAsB,OAAA;AACtB,8HAAA,0BAA0B,OAAA;AAC1B,6HAAA,yBAAyB,OAAA;AAI3B,iCAA8D;AAArD,oGAAA,WAAW,OAAA;AAAE,sGAAA,aAAa,OAAA;AAAE,gGAAA,OAAO,OAAA;AAE5C,2CAAgE;AAAvD,8GAAA,gBAAgB,OAAA;AAAE,4GAAA,cAAc,OAAA;AAQzC,gDAqE4B;AApE1B,iGAAA,IAAI,OAAA;AACJ,yGAAA,YAAY,OAAA;AACZ,0GAAA,aAAa,OAAA;AACb,gHAAA,mBAAmB,OAAA;AACnB,0GAAA,aAAa,OAAA;AACb,wGAAA,WAAW,OAAA;AACX,iHAAA,oBAAoB,OAAA;AACpB,gHAAA,mBAAmB,OAAA;AACnB,sGAAA,SAAS,OAAA;AACT,iHAAA,oBAAoB,OAAA;AACpB,mHAAA,sBAAsB,OAAA;AACtB,uHAAA,0BAA0B,OAAA;AAC1B,4GAAA,eAAe,OAAA;AACf,uGAAA,UAAU,OAAA;AACV,gHAAA,mBAAmB,OAAA;AACnB,4HAAA,+BAA+B,OAAA;AAC/B,6GAAA,gBAAgB,OAAA;AAChB,yGAAA,YAAY,OAAA;AACZ,oHAAA,uBAAuB,OAAA;AACvB,oGAAA,OAAO,OAAA;AACP,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AACV,2GAAA,cAAc,OAAA;AACd,sGAAA,SAAS,OAAA;AACT,6GAAA,gBAAgB,OAAA;AAChB,oGAAA,OAAO,OAAA;AACP,2GAAA,cAAc,OAAA;AACd,yGAAA,YAAY,OAAA;AACZ,oGAAA,OAAO,OAAA;AACP,2GAAA,cAAc,OAAA;AACd,uGAAA,UAAU,OAAA;AACV,yGAAA,YAAY,OAAA;AACZ,kGAAA,KAAK,OAAA;AACL,yHAAA,4BAA4B,OAAA;AAC5B,kGAAA,KAAK,OAAA;AACL,yGAAA,YAAY,OAAA;AACZ,mGAAA,MAAM,OAAA;AACN,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,wGAAA,WAAW,OAAA;AACX,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,6GAAA,gBAAgB,OAAA;AAChB,uGAAA,UAAU,OAAA;AACV,uGAAA,UAAU,OAAA;AACV,qGAAA,QAAQ,OAAA;AACR,wGAAA,WAAW,OAAA;AACX,oGAAA,OAAO,OAAA;AACP,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,iGAAA,IAAI,OAAA;AACJ,0HAAA,6BAA6B,OAAA;AAC7B,8GAAA,iBAAiB,OAAA;AACjB,uHAAA,0BAA0B,OAAA;AAC1B,oGAAA,OAAO,OAAA;AACP,wGAAA,WAAW,OAAA;AACX,6GAAA,gBAAgB,OAAA;AAChB,+GAAA,kBAAkB,OAAA;AAClB,iHAAA,oBAAoB,OAAA;AACpB,iHAAA,oBAAoB,OAAA;AACpB,gHAAA,mBAAmB,OAAA;AACnB,+GAAA,kBAAkB,OAAA;AAClB,0GAAA,aAAa,OAAA;AACb,uGAAA,UAAU,OAAA;AACV,+GAAA,kBAAkB,OAAA;AAClB,4GAAA,eAAe,OAAA;AACf,8GAAA,iBAAiB,OAAA;AAuEnB,sDAQoC;AAPlC,oHAAA,yBAAyB,OAAA;AACzB,kHAAA,uBAAuB,OAAA;AACvB,uHAAA,4BAA4B,OAAA;AAC5B,8HAAA,mCAAmC,OAAA;AACnC,kHAAA,uBAAuB,OAAA;AACvB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AAGb,mCAAgE;AAAvD,oGAAA,aAAa,OAAA;AAAE,yGAAA,kBAAkB,OAAA;AAE1C,8DAA+E;AAAtE,gHAAA,uBAAuB,OAAA","sourcesContent":["export { getWebInstrumentations, makeCoreConfig } from './config';\nexport type { BrowserConfig } from './config';\n\nexport { defaultEventDomain } from './consts';\n\nexport { initializeFaro } from './initialize';\n\nexport {\n  buildStackFrame,\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n  SessionInstrumentation,\n  PerformanceInstrumentation,\n  UserActionInstrumentation,\n} from './instrumentations';\nexport type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectionEvent } from './instrumentations';\n\nexport { browserMeta, createSession, sdkMeta } from './metas';\n\nexport { ConsoleTransport, FetchTransport } from './transports';\nexport type {\n  ClockFn,\n  ConsoleTransportOptions,\n  FetchTransportOptions,\n  FetchTransportRequestOptions,\n} from './transports';\n\nexport {\n  faro,\n  allLogLevels,\n  BaseExtension,\n  BaseInstrumentation,\n  BaseTransport,\n  Conventions,\n  createInternalLogger,\n  createPromiseBuffer,\n  deepEqual,\n  defaultExceptionType,\n  defaultGlobalObjectKey,\n  defaultInternalLoggerLevel,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\n  getInternalFaroFromGlobalObject,\n  getTransportBody,\n  globalObject,\n  internalGlobalObjectKey,\n  isArray,\n  isBoolean,\n  isDomError,\n  isDomException,\n  isElement,\n  isElementDefined,\n  isError,\n  isErrorDefined,\n  isErrorEvent,\n  isEvent,\n  isEventDefined,\n  isFunction,\n  isInstanceOf,\n  isInt,\n  isInternalFaroOnGlobalObject,\n  isMap,\n  isMapDefined,\n  isNull,\n  isNumber,\n  isObject,\n  isPrimitive,\n  isRegExp,\n  isString,\n  isSymbol,\n  isSyntheticEvent,\n  isThenable,\n  isToString,\n  isTypeof,\n  isUndefined,\n  isEmpty,\n  InternalLoggerLevel,\n  LogLevel,\n  noop,\n  setInternalFaroOnGlobalObject,\n  TransportItemType,\n  transportItemTypeToBodyKey,\n  VERSION,\n  EVENT_CLICK,\n  EVENT_NAVIGATION,\n  EVENT_ROUTE_CHANGE,\n  EVENT_SESSION_EXTEND,\n  EVENT_SESSION_RESUME,\n  EVENT_SESSION_START,\n  EVENT_VIEW_CHANGED,\n  apiMessageBus,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\n\nexport type {\n  Faro,\n  API,\n  APIEvent,\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BeforeSendHook,\n  BufferItem,\n  Config,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  Extension,\n  GlobalObject,\n  Instrumentation,\n  Instrumentations,\n  InternalLogger,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  Meta,\n  MetaAPI,\n  MetaApp,\n  MetaAttributes,\n  MetaBrowser,\n  MetaGetter,\n  MetaItem,\n  MetaPage,\n  Metas,\n  MetaSDK,\n  MetaSDKIntegration,\n  MetaSession,\n  MetaUser,\n  MetaView,\n  OTELApi,\n  Patterns,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  PushErrorOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n  UnpatchedConsole,\n  ApiMessageBusMessages,\n  UserActionStartMessage,\n  UserActionEndMessage,\n  UserActionCancelMessage,\n  UserAction,\n} from '@grafana/faro-core';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './instrumentations/session';\n\nexport { getIgnoreUrls, getUrlFromResource } from './utils/url';\n\nexport { userActionDataAttribute } from './instrumentations/userActions/const';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAAkE;AAAzD,gHAAA,sBAAsB,OAAA;AAAE,wGAAA,cAAc,OAAA;AAG/C,mCAA8C;AAArC,4GAAA,kBAAkB,OAAA;AAE3B,2CAA8C;AAArC,4GAAA,cAAc,OAAA;AAEvB,uDAY4B;AAX1B,mHAAA,eAAe,OAAA;AACf,0HAAA,sBAAsB,OAAA;AACtB,yHAAA,qBAAqB,OAAA;AACrB,+HAAA,2BAA2B,OAAA;AAC3B,2HAAA,uBAAuB,OAAA;AACvB,mHAAA,eAAe,OAAA;AACf,uHAAA,mBAAmB,OAAA;AACnB,4HAAA,wBAAwB,OAAA;AACxB,0HAAA,sBAAsB,OAAA;AACtB,8HAAA,0BAA0B,OAAA;AAC1B,6HAAA,yBAAyB,OAAA;AAI3B,iCAA8D;AAArD,oGAAA,WAAW,OAAA;AAAE,sGAAA,aAAa,OAAA;AAAE,gGAAA,OAAO,OAAA;AAE5C,2CAAgE;AAAvD,8GAAA,gBAAgB,OAAA;AAAE,4GAAA,cAAc,OAAA;AAQzC,gDAqE4B;AApE1B,iGAAA,IAAI,OAAA;AACJ,yGAAA,YAAY,OAAA;AACZ,0GAAA,aAAa,OAAA;AACb,gHAAA,mBAAmB,OAAA;AACnB,0GAAA,aAAa,OAAA;AACb,wGAAA,WAAW,OAAA;AACX,iHAAA,oBAAoB,OAAA;AACpB,gHAAA,mBAAmB,OAAA;AACnB,sGAAA,SAAS,OAAA;AACT,iHAAA,oBAAoB,OAAA;AACpB,mHAAA,sBAAsB,OAAA;AACtB,uHAAA,0BAA0B,OAAA;AAC1B,4GAAA,eAAe,OAAA;AACf,uGAAA,UAAU,OAAA;AACV,gHAAA,mBAAmB,OAAA;AACnB,4HAAA,+BAA+B,OAAA;AAC/B,6GAAA,gBAAgB,OAAA;AAChB,yGAAA,YAAY,OAAA;AACZ,oHAAA,uBAAuB,OAAA;AACvB,oGAAA,OAAO,OAAA;AACP,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AACV,2GAAA,cAAc,OAAA;AACd,sGAAA,SAAS,OAAA;AACT,6GAAA,gBAAgB,OAAA;AAChB,oGAAA,OAAO,OAAA;AACP,2GAAA,cAAc,OAAA;AACd,yGAAA,YAAY,OAAA;AACZ,oGAAA,OAAO,OAAA;AACP,2GAAA,cAAc,OAAA;AACd,uGAAA,UAAU,OAAA;AACV,yGAAA,YAAY,OAAA;AACZ,kGAAA,KAAK,OAAA;AACL,yHAAA,4BAA4B,OAAA;AAC5B,kGAAA,KAAK,OAAA;AACL,yGAAA,YAAY,OAAA;AACZ,mGAAA,MAAM,OAAA;AACN,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,wGAAA,WAAW,OAAA;AACX,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,6GAAA,gBAAgB,OAAA;AAChB,uGAAA,UAAU,OAAA;AACV,uGAAA,UAAU,OAAA;AACV,qGAAA,QAAQ,OAAA;AACR,wGAAA,WAAW,OAAA;AACX,oGAAA,OAAO,OAAA;AACP,gHAAA,mBAAmB,OAAA;AACnB,qGAAA,QAAQ,OAAA;AACR,iGAAA,IAAI,OAAA;AACJ,0HAAA,6BAA6B,OAAA;AAC7B,8GAAA,iBAAiB,OAAA;AACjB,uHAAA,0BAA0B,OAAA;AAC1B,oGAAA,OAAO,OAAA;AACP,wGAAA,WAAW,OAAA;AACX,6GAAA,gBAAgB,OAAA;AAChB,+GAAA,kBAAkB,OAAA;AAClB,iHAAA,oBAAoB,OAAA;AACpB,iHAAA,oBAAoB,OAAA;AACpB,gHAAA,mBAAmB,OAAA;AACnB,+GAAA,kBAAkB,OAAA;AAClB,0GAAA,aAAa,OAAA;AACb,uGAAA,UAAU,OAAA;AACV,+GAAA,kBAAkB,OAAA;AAClB,4GAAA,eAAe,OAAA;AACf,8GAAA,iBAAiB,OAAA;AAuEnB,sDAQoC;AAPlC,oHAAA,yBAAyB,OAAA;AACzB,kHAAA,uBAAuB,OAAA;AACvB,uHAAA,4BAA4B,OAAA;AAC5B,8HAAA,mCAAmC,OAAA;AACnC,kHAAA,uBAAuB,OAAA;AACvB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AAGb,mCAAgE;AAAvD,oGAAA,aAAa,OAAA;AAAE,yGAAA,kBAAkB,OAAA;AAE1C,8DAA0F;AAAjF,sHAAA,uBAAuB,OAAA;AAAE,8GAAA,eAAe,OAAA","sourcesContent":["export { getWebInstrumentations, makeCoreConfig } from './config';\nexport type { BrowserConfig } from './config';\n\nexport { defaultEventDomain } from './consts';\n\nexport { initializeFaro } from './initialize';\n\nexport {\n  buildStackFrame,\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n  SessionInstrumentation,\n  PerformanceInstrumentation,\n  UserActionInstrumentation,\n} from './instrumentations';\nexport type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectionEvent } from './instrumentations';\n\nexport { browserMeta, createSession, sdkMeta } from './metas';\n\nexport { ConsoleTransport, FetchTransport } from './transports';\nexport type {\n  ClockFn,\n  ConsoleTransportOptions,\n  FetchTransportOptions,\n  FetchTransportRequestOptions,\n} from './transports';\n\nexport {\n  faro,\n  allLogLevels,\n  BaseExtension,\n  BaseInstrumentation,\n  BaseTransport,\n  Conventions,\n  createInternalLogger,\n  createPromiseBuffer,\n  deepEqual,\n  defaultExceptionType,\n  defaultGlobalObjectKey,\n  defaultInternalLoggerLevel,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\n  getInternalFaroFromGlobalObject,\n  getTransportBody,\n  globalObject,\n  internalGlobalObjectKey,\n  isArray,\n  isBoolean,\n  isDomError,\n  isDomException,\n  isElement,\n  isElementDefined,\n  isError,\n  isErrorDefined,\n  isErrorEvent,\n  isEvent,\n  isEventDefined,\n  isFunction,\n  isInstanceOf,\n  isInt,\n  isInternalFaroOnGlobalObject,\n  isMap,\n  isMapDefined,\n  isNull,\n  isNumber,\n  isObject,\n  isPrimitive,\n  isRegExp,\n  isString,\n  isSymbol,\n  isSyntheticEvent,\n  isThenable,\n  isToString,\n  isTypeof,\n  isUndefined,\n  isEmpty,\n  InternalLoggerLevel,\n  LogLevel,\n  noop,\n  setInternalFaroOnGlobalObject,\n  TransportItemType,\n  transportItemTypeToBodyKey,\n  VERSION,\n  EVENT_CLICK,\n  EVENT_NAVIGATION,\n  EVENT_ROUTE_CHANGE,\n  EVENT_SESSION_EXTEND,\n  EVENT_SESSION_RESUME,\n  EVENT_SESSION_START,\n  EVENT_VIEW_CHANGED,\n  apiMessageBus,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\n\nexport type {\n  Faro,\n  API,\n  APIEvent,\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BeforeSendHook,\n  BufferItem,\n  Config,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  Extension,\n  GlobalObject,\n  Instrumentation,\n  Instrumentations,\n  InternalLogger,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  Meta,\n  MetaAPI,\n  MetaApp,\n  MetaAttributes,\n  MetaBrowser,\n  MetaGetter,\n  MetaItem,\n  MetaPage,\n  Metas,\n  MetaSDK,\n  MetaSDKIntegration,\n  MetaSession,\n  MetaUser,\n  MetaView,\n  OTELApi,\n  Patterns,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  PushErrorOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n  UnpatchedConsole,\n  ApiMessageBusMessages,\n  UserActionStartMessage,\n  UserActionEndMessage,\n  UserActionCancelMessage,\n  UserAction,\n} from '@grafana/faro-core';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './instrumentations/session';\n\nexport { getIgnoreUrls, getUrlFromResource } from './utils/url';\n\nexport { userActionDataAttribute, startUserAction } from './instrumentations/userActions';\n"]}

package/dist/cjs/instrumentations/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.userActionDataAttribute = exports.UserActionInstrumentation = exports.PerformanceInstrumentation = exports.STORAGE_KEY = exports.SESSION_INACTIVITY_TIME = exports.SESSION_EXPIRATION_TIME = exports.MAX_SESSION_PERSISTENCE_TIME_BUFFER = exports.MAX_SESSION_PERSISTENCE_TIME = exports.VolatileSessionsManager = exports.PersistentSessionsManager = exports.WebVitalsInstrumentation = exports.ViewInstrumentation = exports.parseStacktrace = exports.getStackFramesFromError = exports.getDataFromSafariExtensions = exports.ErrorsInstrumentation = exports.buildStackFrame = exports.ConsoleInstrumentation = exports.SessionInstrumentation = void 0;
+exports.startUserAction = exports.userActionDataAttribute = exports.UserActionInstrumentation = exports.PerformanceInstrumentation = exports.STORAGE_KEY = exports.SESSION_INACTIVITY_TIME = exports.SESSION_EXPIRATION_TIME = exports.MAX_SESSION_PERSISTENCE_TIME_BUFFER = exports.MAX_SESSION_PERSISTENCE_TIME = exports.VolatileSessionsManager = exports.PersistentSessionsManager = exports.WebVitalsInstrumentation = exports.ViewInstrumentation = exports.parseStacktrace = exports.getStackFramesFromError = exports.getDataFromSafariExtensions = exports.ErrorsInstrumentation = exports.buildStackFrame = exports.ConsoleInstrumentation = exports.SessionInstrumentation = void 0;
 var session_1 = require("./session");
 Object.defineProperty(exports, "SessionInstrumentation", { enumerable: true, get: function () { return session_1.SessionInstrumentation; } });
 var console_1 = require("./console");
@@ -28,4 +28,5 @@ Object.defineProperty(exports, "PerformanceInstrumentation", { enumerable: true,
 var userActions_1 = require("./userActions");
 Object.defineProperty(exports, "UserActionInstrumentation", { enumerable: true, get: function () { return userActions_1.UserActionInstrumentation; } });
 Object.defineProperty(exports, "userActionDataAttribute", { enumerable: true, get: function () { return userActions_1.userActionDataAttribute; } });
+Object.defineProperty(exports, "startUserAction", { enumerable: true, get: function () { return userActions_1.startUserAction; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/instrumentations/index.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAA1C,iHAAA,sBAAsB,OAAA;AAE/B,qCAAmD;AAA1C,iHAAA,sBAAsB,OAAA;AAG/B,mCAMkB;AALhB,yGAAA,eAAe,OAAA;AACf,+GAAA,qBAAqB,OAAA;AACrB,qHAAA,2BAA2B,OAAA;AAC3B,iHAAA,uBAAuB,OAAA;AACvB,yGAAA,eAAe,OAAA;AAIjB,+BAA6C;AAApC,2GAAA,mBAAmB,OAAA;AAE5B,yCAAuD;AAA9C,qHAAA,wBAAwB,OAAA;AAEjC,qCAQmB;AAPjB,oHAAA,yBAAyB,OAAA;AACzB,kHAAA,uBAAuB,OAAA;AACvB,uHAAA,4BAA4B,OAAA;AAC5B,8HAAA,mCAAmC,OAAA;AACnC,kHAAA,uBAAuB,OAAA;AACvB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AAGb,6CAA2D;AAAlD,yHAAA,0BAA0B,OAAA;AAEnC,6CAAmF;AAA1E,wHAAA,yBAAyB,OAAA;AAAE,sHAAA,uBAAuB,OAAA","sourcesContent":["export { SessionInstrumentation } from './session';\n\nexport { ConsoleInstrumentation } from './console';\nexport type { ConsoleInstrumentationOptions } from './console';\n\nexport {\n  buildStackFrame,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n} from './errors';\nexport type { ErrorEvent, ExtendedPromiseRejectionEvent } from './errors';\n\nexport { ViewInstrumentation } from './view';\n\nexport { WebVitalsInstrumentation } from './webVitals';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './session';\n\nexport { PerformanceInstrumentation } from './performance';\n\nexport { UserActionInstrumentation, userActionDataAttribute } from './userActions';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/instrumentations/index.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAA1C,iHAAA,sBAAsB,OAAA;AAE/B,qCAAmD;AAA1C,iHAAA,sBAAsB,OAAA;AAG/B,mCAMkB;AALhB,yGAAA,eAAe,OAAA;AACf,+GAAA,qBAAqB,OAAA;AACrB,qHAAA,2BAA2B,OAAA;AAC3B,iHAAA,uBAAuB,OAAA;AACvB,yGAAA,eAAe,OAAA;AAIjB,+BAA6C;AAApC,2GAAA,mBAAmB,OAAA;AAE5B,yCAAuD;AAA9C,qHAAA,wBAAwB,OAAA;AAEjC,qCAQmB;AAPjB,oHAAA,yBAAyB,OAAA;AACzB,kHAAA,uBAAuB,OAAA;AACvB,uHAAA,4BAA4B,OAAA;AAC5B,8HAAA,mCAAmC,OAAA;AACnC,kHAAA,uBAAuB,OAAA;AACvB,kHAAA,uBAAuB,OAAA;AACvB,sGAAA,WAAW,OAAA;AAGb,6CAA2D;AAAlD,yHAAA,0BAA0B,OAAA;AAEnC,6CAAoG;AAA3F,wHAAA,yBAAyB,OAAA;AAAE,sHAAA,uBAAuB,OAAA;AAAE,8GAAA,eAAe,OAAA","sourcesContent":["export { SessionInstrumentation } from './session';\n\nexport { ConsoleInstrumentation } from './console';\nexport type { ConsoleInstrumentationOptions } from './console';\n\nexport {\n  buildStackFrame,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n} from './errors';\nexport type { ErrorEvent, ExtendedPromiseRejectionEvent } from './errors';\n\nexport { ViewInstrumentation } from './view';\n\nexport { WebVitalsInstrumentation } from './webVitals';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './session';\n\nexport { PerformanceInstrumentation } from './performance';\n\nexport { UserActionInstrumentation, userActionDataAttribute, startUserAction } from './userActions';\n"]}

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

@@ -1,8 +1,9 @@
 "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;
+exports.userActionDataAttribute = exports.MESSAGE_TYPE_HTTP_REQUEST_START = exports.MESSAGE_TYPE_HTTP_REQUEST_END = exports.MESSAGE_TYPE_DOM_MUTATION = exports.startUserAction = exports.UserActionInstrumentation = void 0;
 var instrumentation_1 = require("./instrumentation");
 Object.defineProperty(exports, "UserActionInstrumentation", { enumerable: true, get: function () { return instrumentation_1.UserActionInstrumentation; } });
+Object.defineProperty(exports, "startUserAction", { enumerable: true, get: function () { return instrumentation_1.startUserAction; } });
 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; } });

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/index.ts"],"names":[],"mappings":";;;AAAA,qDAA8D;AAArD,4HAAA,yBAAyB,OAAA;AAOlC,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 {\n  DomMutationMessage,\n  HttpRequestEndMessage,\n  HttpRequestStartMessage,\n  HttpRequestMessagePayload,\n} 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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/index.ts"],"names":[],"mappings":";;;AAAA,qDAA+E;AAAtE,4HAAA,yBAAyB,OAAA;AAAE,kHAAA,eAAe,OAAA;AASnD,iCAKiB;AAJf,kHAAA,yBAAyB,OAAA;AACzB,sHAAA,6BAA6B,OAAA;AAC7B,wHAAA,+BAA+B,OAAA;AAC/B,gHAAA,uBAAuB,OAAA","sourcesContent":["export { UserActionInstrumentation, startUserAction } from './instrumentation';\n\nexport type {\n  DomMutationMessage,\n  HttpRequestEndMessage,\n  HttpRequestStartMessage,\n  HttpRequestMessagePayload,\n} from './types';\n\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

@@ -16,8 +16,10 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserActionInstrumentation = void 0;
+exports.startUserAction = startUserAction;
 var faro_core_1 = require("@grafana/faro-core");
 var processUserActionEventHandler_1 = require("./processUserActionEventHandler");
+var processUserEventHandler;
 var UserActionInstrumentation = /** @class */ (function (_super) {
     __extends(UserActionInstrumentation, _super);
     function UserActionInstrumentation() {
@@ -27,11 +29,21 @@ var UserActionInstrumentation = /** @class */ (function (_super) {
         return _this;
     }
     UserActionInstrumentation.prototype.initialize = function () {
-        var processUserEventHandler = (0, processUserActionEventHandler_1.getUserEventHandler)(faro_core_1.faro);
+        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;
+function startUserAction(name, attributes) {
+    processUserEventHandler === null || processUserEventHandler === void 0 ? void 0 : processUserEventHandler(createUserActionApiEvent(name, attributes));
+}
+function createUserActionApiEvent(name, attributes) {
+    return {
+        name: name,
+        attributes: attributes,
+        type: 'apiEvent',
+    };
+}
 //# sourceMappingURL=instrumentation.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/instrumentation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,gDAAwE;AAExE,iFAAsE;AAEtE;IAA+C,6CAAmB;IAAlE;;QACW,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"]}
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/instrumentation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,0CAEC;AApBD,gDAAwE;AAExE,iFAAsE;AAGtE,IAAI,uBAA2E,CAAC;AAEhF;IAA+C,6CAAmB;IAAlE;;QACW,UAAI,GAAG,mDAAmD,CAAC;QAC3D,aAAO,GAAG,mBAAO,CAAC;;IAO7B,CAAC;IALC,8CAAU,GAAV;QACE,uBAAuB,GAAG,IAAA,mDAAmB,EAAC,gBAAI,CAAC,CAAC;QACpD,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;AAWtC,SAAgB,eAAe,CAAC,IAAY,EAAE,UAAmC;IAC/E,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,wBAAwB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAY,EAAE,UAAmC;IACjF,OAAO;QACL,IAAI,MAAA;QACJ,UAAU,YAAA;QACV,IAAI,EAAE,UAAU;KACjB,CAAC;AACJ,CAAC","sourcesContent":["import { BaseInstrumentation, faro, VERSION } from '@grafana/faro-core';\n\nimport { getUserEventHandler } from './processUserActionEventHandler';\nimport type { ApiEvent } from './types';\n\nlet processUserEventHandler: ReturnType<typeof getUserEventHandler> | undefined;\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    processUserEventHandler = getUserEventHandler(faro);\n    window.addEventListener('pointerdown', processUserEventHandler);\n    window.addEventListener('keydown', processUserEventHandler);\n  }\n}\n\nexport function startUserAction(name: string, attributes?: Record<string, string>) {\n  processUserEventHandler?.(createUserActionApiEvent(name, attributes));\n}\n\nfunction createUserActionApiEvent(name: string, attributes?: Record<string, string>): ApiEvent {\n  return {\n    name,\n    attributes,\n    type: 'apiEvent',\n  };\n}\n"]}

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

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserEventHandler = getUserEventHandler;
 var faro_core_1 = require("@grafana/faro-core");
@@ -17,7 +28,14 @@ function getUserEventHandler(faro) {
     var actionRunning = false;
     function processUserEvent(event) {
         var _a;
-        var userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : const_1.userActionDataAttributeParsed);
+        var userActionName;
+        var isApiEventDetected = isApiEvent(event);
+        if (isApiEventDetected) {
+            userActionName = event.name;
+        }
+        else {
+            userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : const_1.userActionDataAttributeParsed);
+        }
         if (actionRunning || userActionName == null) {
             return;
         }
@@ -67,7 +85,7 @@ function getUserEventHandler(faro) {
             // 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 userActionParentEventProps = { api: api, userActionName: userActionName, startTime: startTime, endTime: endTime, actionId: actionId, event: event };
+                var userActionParentEventProps = __assign({ api: api, userActionName: userActionName, startTime: startTime, endTime: endTime, actionId: actionId, event: event }, (isApiEventDetected ? { attributes: event.attributes } : {}));
                 var hasPendingRequests = runningRequests.size > 0;
                 var isAllPendingRequestsResolved = isHalted && !hasPendingRequests;
                 if (isAllPendingRequestsResolved) {
@@ -105,7 +123,7 @@ function getUserEventHandler(faro) {
  * User action was successfully completed and we send the final event(s)
  */
 function endUserAction(props) {
-    var api = props.api, userActionName = props.userActionName, startTime = props.startTime, endTime = props.endTime, actionId = props.actionId, event = props.event;
+    var api = props.api, userActionName = props.userActionName, startTime = props.startTime, endTime = props.endTime, actionId = props.actionId, event = props.event, attributes = props.attributes;
     var duration = endTime - startTime;
     var eventType = event.type;
     // order matters, first emit the user-action-end event and afterwards push the parent event
@@ -119,12 +137,7 @@ function endUserAction(props) {
         eventType: eventType,
     });
     // Send the final action parent event
-    api.pushEvent(userActionName, {
-        userActionStartTime: startTime.toString(),
-        userActionEndTime: endTime.toString(),
-        userActionDuration: duration.toString(),
-        userActionEventType: eventType,
-    }, undefined, {
+    api.pushEvent(userActionName, __assign({ userActionStartTime: startTime.toString(), userActionEndTime: endTime.toString(), userActionDuration: duration.toString(), userActionEventType: eventType }, (0, faro_core_1.stringifyObjectValues)(attributes)), undefined, {
         timestampOverwriteMs: startTime,
         customPayloadTransformer: function (payload) {
             payload.action = {
@@ -172,4 +185,7 @@ function isRequestStartMessage(msg) {
 function isRequestEndMessage(msg) {
     return msg.type === const_1.MESSAGE_TYPE_HTTP_REQUEST_END;
 }
+function isApiEvent(apiEvent) {
+    return apiEvent.type === 'apiEvent' && typeof apiEvent.name === 'string';
+}
 //# sourceMappingURL=processUserActionEventHandler.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":";;AAyBA,kDA8HC;AAvJD,gDAS4B;AAG5B,iCAIiB;AACjB,2DAA2D;AAC3D,2DAA2D;AAC3D,yEAAwE;AAExE,+BAAkD;AAElD,IAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC,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,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,CAAC;YAC5C,OAAO;QACT,CAAC;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,6BAAiB;YACvB,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CACtB,SAAS,EACT;YACE,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,EACD,0BAA0B,CAC3B,CAAC;QAEF,IAAM,eAAe,GAAG,IAAI,GAAG,EAAqC,CAAC;QACrE,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,sBAA0C,CAAC;QAE/C,IAAM,cAAc,GAAG,IAAI,sBAAU,EAAE;aACpC,KAAK,CAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC;aAClE,SAAS,CAAC,cAAM,OAAA,aAAa,EAAb,CAAa,CAAC;aAC9B,MAAM,CAAC,UAAC,GAAG;YACV,qFAAqF;YACrF,IAAI,QAAQ,IAAI,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,SAAS,CAAC,UAAC,GAAG;YACb,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,4EAA4E;gBAC5E,8EAA8E;gBAC9E,+GAA+G;gBAC/G,iCAAiC;gBACjC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,4CAA4C;gBAC5C,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;YAED,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CACtB,SAAS,EACT;gBACE,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;gBAEpB,IAAM,0BAA0B,GAAG,EAAE,GAAG,KAAA,EAAE,cAAc,gBAAA,EAAE,SAAS,WAAA,EAAE,OAAO,EAAE,OAAQ,EAAE,QAAQ,UAAA,EAAE,KAAK,OAAA,EAAE,CAAC;gBAE1G,IAAM,kBAAkB,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;gBACpD,IAAM,4BAA4B,GAAG,QAAQ,IAAI,CAAC,kBAAkB,CAAC;gBAErE,IAAI,4BAA4B,EAAE,CAAC;oBACjC,YAAY,CAAC,sBAAsB,CAAC,CAAC;oBACrC,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;gBAED,IAAI,kBAAkB,EAAE,CAAC;oBACvB,QAAQ,GAAG,IAAI,CAAC;oBAEhB,yBAAa,CAAC,MAAM,CAAC;wBACnB,IAAI,EAAE,4BAAgB;wBACtB,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,QAAQ;wBAClB,MAAM,EAAE,kBAAkB;wBAC1B,QAAQ,EAAE,IAAA,mBAAO,GAAE;qBACpB,CAAC,CAAC;oBAEH,sBAAsB,GAAG,YAAY,CACnC,SAAS,EACT;wBACE,sBAAsB,CAAC,cAAc,CAAC,CAAC;wBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;wBAC1C,aAAa,GAAG,KAAK,CAAC;wBACtB,QAAQ,GAAG,KAAK,CAAC;oBACnB,CAAC,EACD,IAAI,GAAG,EAAE,CACV,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,sBAAsB,CAAC,cAAc,CAAC,CAAC;oBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;oBAC1C,aAAa,GAAG,KAAK,CAAC;oBACtB,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;YACH,CAAC,EACD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAOtB;IACS,IAAA,GAAG,GAA0D,KAAK,IAA/D,EAAE,cAAc,GAA0C,KAAK,eAA/C,EAAE,SAAS,GAA+B,KAAK,UAApC,EAAE,OAAO,GAAsB,KAAK,QAA3B,EAAE,QAAQ,GAAY,KAAK,SAAjB,EAAE,KAAK,GAAK,KAAK,MAAV,CAAW;IAC3E,IAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IACrC,IAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAE7B,2FAA2F;IAC3F,yBAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,2BAAe;QACrB,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,QAAQ;QACZ,SAAS,WAAA;QACT,OAAO,SAAA;QACP,QAAQ,UAAA;QACR,SAAS,WAAA;KACV,CAAC,CAAC;IAEH,qCAAqC;IACrC,GAAG,CAAC,SAAS,CACX,cAAc,EACd;QACE,mBAAmB,EAAE,SAAS,CAAC,QAAQ,EAAE;QACzC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE;QACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE;QACvC,mBAAmB,EAAE,SAAS;KAC/B,EACD,SAAS,EACT;QACE,oBAAoB,EAAE,SAAS;QAC/B,wBAAwB,EAAE,UAAC,OAAO;YAChC,OAAO,CAAC,MAAM,GAAG;gBACf,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,cAAc;aACrB,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CACF,CAAC;AACJ,CAAC;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,CAAC;QAC1B,IAAI,GAAG,KAAK,uBAAuB,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,SAA6B,EAAE,EAAc,EAAE,KAAa;IAChF,IAAI,SAAS,EAAE,CAAC;QACd,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC;QACrB,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,KAAK,CAAC,CAAC;IAEV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,yBAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,8BAAkB;QACxB,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwC;IACtE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;IAC9B,cAAc,GAAG,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,uCAA+B,CAAC;AACtD,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAQ;IACnC,OAAO,GAAG,CAAC,IAAI,KAAK,qCAA6B,CAAC;AACpD,CAAC","sourcesContent":["import {\n  apiMessageBus,\n  dateNow,\n  genShortID,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_HALT,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\nimport type { Faro, Subscription } from '@grafana/faro-core';\n\nimport {\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n  userActionDataAttributeParsed as userActionDataAttribute,\n} from './const';\nimport { monitorDomMutations } from './domMutationMonitor';\nimport { monitorHttpRequests } from './httpRequestMonitor';\nimport { monitorPerformanceEntries } from './performanceEntriesMonitor';\nimport type { HttpRequestEndMessage, HttpRequestMessagePayload, HttpRequestStartMessage } from './types';\nimport { convertDataAttributeName } from './util';\n\nconst maxFollowUpActionTimeRange = 100;\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 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,\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(\n      timeoutId,\n      () => {\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      maxFollowUpActionTimeRange\n    );\n\n    const runningRequests = new Map<string, HttpRequestMessagePayload>();\n    let isHalted = false;\n    let pendingActionTimeoutId: number | undefined;\n\n    const allMonitorsSub = new Observable()\n      .merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor)\n      .takeWhile(() => actionRunning)\n      .filter((msg) => {\n        // If the user action is in halt state, we only keep listening to ended http requests\n        if (isHalted && !(isRequestEndMessage(msg) && runningRequests.has(msg.request.requestId))) {\n          return false;\n        }\n\n        return true;\n      })\n      .subscribe((msg) => {\n        if (isRequestStartMessage(msg)) {\n          // An action is on halt if it has pending items, like pending HTTP requests.\n          // In this case we start a separate timeout to wait for the requests to finish\n          // If in the halt state, we stop adding Faro signals to the action's buffer (see userActionLifecycleHandler.ts)\n          // But we are still subscribed to\n          runningRequests.set(msg.request.requestId, msg.request);\n        }\n        if (isRequestEndMessage(msg)) {\n          // console.log('request end msg :>> ', msg);\n          runningRequests.delete(msg.request.requestId);\n        }\n\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(\n          timeoutId,\n          () => {\n            endTime = dateNow();\n\n            const userActionParentEventProps = { api, userActionName, startTime, endTime: endTime!, actionId, event };\n\n            const hasPendingRequests = runningRequests.size > 0;\n            const isAllPendingRequestsResolved = isHalted && !hasPendingRequests;\n\n            if (isAllPendingRequestsResolved) {\n              clearTimeout(pendingActionTimeoutId);\n              isHalted = false;\n            }\n\n            if (hasPendingRequests) {\n              isHalted = true;\n\n              apiMessageBus.notify({\n                type: USER_ACTION_HALT,\n                name: userActionName,\n                parentId: actionId,\n                reason: 'pending-requests',\n                haltTime: dateNow(),\n              });\n\n              pendingActionTimeoutId = startTimeout(\n                undefined,\n                () => {\n                  unsubscribeAllMonitors(allMonitorsSub);\n                  endUserAction(userActionParentEventProps);\n                  actionRunning = false;\n                  isHalted = false;\n                },\n                1000 * 10\n              );\n            } else {\n              unsubscribeAllMonitors(allMonitorsSub);\n              endUserAction(userActionParentEventProps);\n              actionRunning = false;\n              isHalted = false;\n            }\n          },\n          maxFollowUpActionTimeRange\n        );\n      });\n  }\n\n  return processUserEvent;\n}\n\n/**\n * User action was successfully completed and we send the final event(s)\n */\nfunction endUserAction(props: {\n  api: Faro['api'];\n  userActionName: string;\n  startTime: number;\n  endTime: number;\n  actionId: string;\n  event: PointerEvent | KeyboardEvent;\n}) {\n  const { api, userActionName, startTime, endTime, actionId, event } = props;\n  const duration = endTime - startTime;\n  const eventType = event.type;\n\n  // order matters, first emit the user-action-end event and afterwards push the parent event\n  apiMessageBus.notify({\n    type: USER_ACTION_END,\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\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, delay: number) {\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  }, delay);\n\n  return timeoutId;\n}\n\nfunction sendUserActionCancelMessage(userActionName: string, actionId: string) {\n  apiMessageBus.notify({\n    type: USER_ACTION_CANCEL,\n    name: userActionName,\n    parentId: actionId,\n  });\n}\n\nfunction unsubscribeAllMonitors(allMonitorsSub: Subscription | undefined) {\n  allMonitorsSub?.unsubscribe();\n  allMonitorsSub = undefined;\n}\n\nfunction isRequestStartMessage(msg: any): msg is HttpRequestStartMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_START;\n}\n\nfunction isRequestEndMessage(msg: any): msg is HttpRequestEndMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_END;\n}\n"]}
+{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;AA0BA,kDA6IC;AAvKD,gDAU4B;AAG5B,iCAIiB;AACjB,2DAA2D;AAC3D,2DAA2D;AAC3D,yEAAwE;AAExE,+BAAkD;AAElD,IAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC,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,SAA6B,CAAC;IAClC,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,SAAS,gBAAgB,CAAC,KAA8C;;QACtE,IAAI,cAAkC,CAAC;QAEvC,IAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,kBAAkB,EAAE,CAAC;YACvB,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,cAAc,GAAG,iBAAiB,CAChC,KAAK,CAAC,MAAqB,EAC3B,MAAA,MAAM,CAAC,iCAAiC,mCAAI,qCAAuB,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;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,6BAAiB;YACvB,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CACtB,SAAS,EACT;YACE,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,EACD,0BAA0B,CAC3B,CAAC;QAEF,IAAM,eAAe,GAAG,IAAI,GAAG,EAAqC,CAAC;QACrE,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,sBAA0C,CAAC;QAE/C,IAAM,cAAc,GAAG,IAAI,sBAAU,EAAE;aACpC,KAAK,CAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC;aAClE,SAAS,CAAC,cAAM,OAAA,aAAa,EAAb,CAAa,CAAC;aAC9B,MAAM,CAAC,UAAC,GAAG;YACV,qFAAqF;YACrF,IAAI,QAAQ,IAAI,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,SAAS,CAAC,UAAC,GAAG;YACb,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,4EAA4E;gBAC5E,8EAA8E;gBAC9E,+GAA+G;gBAC/G,iCAAiC;gBACjC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,4CAA4C;gBAC5C,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;YAED,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CACtB,SAAS,EACT;gBACE,OAAO,GAAG,IAAA,mBAAO,GAAE,CAAC;gBAEpB,IAAM,0BAA0B,cAC9B,GAAG,KAAA,EACH,cAAc,gBAAA,EACd,SAAS,WAAA,EACT,OAAO,EAAE,OAAQ,EACjB,QAAQ,UAAA,EACR,KAAK,OAAA,IACF,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChE,CAAC;gBAEF,IAAM,kBAAkB,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;gBACpD,IAAM,4BAA4B,GAAG,QAAQ,IAAI,CAAC,kBAAkB,CAAC;gBAErE,IAAI,4BAA4B,EAAE,CAAC;oBACjC,YAAY,CAAC,sBAAsB,CAAC,CAAC;oBACrC,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;gBAED,IAAI,kBAAkB,EAAE,CAAC;oBACvB,QAAQ,GAAG,IAAI,CAAC;oBAEhB,yBAAa,CAAC,MAAM,CAAC;wBACnB,IAAI,EAAE,4BAAgB;wBACtB,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,QAAQ;wBAClB,MAAM,EAAE,kBAAkB;wBAC1B,QAAQ,EAAE,IAAA,mBAAO,GAAE;qBACpB,CAAC,CAAC;oBAEH,sBAAsB,GAAG,YAAY,CACnC,SAAS,EACT;wBACE,sBAAsB,CAAC,cAAc,CAAC,CAAC;wBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;wBAC1C,aAAa,GAAG,KAAK,CAAC;wBACtB,QAAQ,GAAG,KAAK,CAAC;oBACnB,CAAC,EACD,IAAI,GAAG,EAAE,CACV,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,sBAAsB,CAAC,cAAc,CAAC,CAAC;oBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;oBAC1C,aAAa,GAAG,KAAK,CAAC;oBACtB,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;YACH,CAAC,EACD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAQtB;IACS,IAAA,GAAG,GAAsE,KAAK,IAA3E,EAAE,cAAc,GAAsD,KAAK,eAA3D,EAAE,SAAS,GAA2C,KAAK,UAAhD,EAAE,OAAO,GAAkC,KAAK,QAAvC,EAAE,QAAQ,GAAwB,KAAK,SAA7B,EAAE,KAAK,GAAiB,KAAK,MAAtB,EAAE,UAAU,GAAK,KAAK,WAAV,CAAW;IACvF,IAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IACrC,IAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAE7B,2FAA2F;IAC3F,yBAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,2BAAe;QACrB,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,QAAQ;QACZ,SAAS,WAAA;QACT,OAAO,SAAA;QACP,QAAQ,UAAA;QACR,SAAS,WAAA;KACV,CAAC,CAAC;IAEH,qCAAqC;IACrC,GAAG,CAAC,SAAS,CACX,cAAc,aAEZ,mBAAmB,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE,EACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE,EACvC,mBAAmB,EAAE,SAAS,IAC3B,IAAA,iCAAqB,EAAC,UAAU,CAAC,GAEtC,SAAS,EACT;QACE,oBAAoB,EAAE,SAAS;QAC/B,wBAAwB,EAAE,UAAC,OAAO;YAChC,OAAO,CAAC,MAAM,GAAG;gBACf,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,cAAc;aACrB,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CACF,CAAC;AACJ,CAAC;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,CAAC;QAC1B,IAAI,GAAG,KAAK,uBAAuB,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,SAA6B,EAAE,EAAc,EAAE,KAAa;IAChF,IAAI,SAAS,EAAE,CAAC;QACd,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC;QACrB,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,KAAK,CAAC,CAAC;IAEV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,yBAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,8BAAkB;QACxB,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwC;IACtE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;IAC9B,cAAc,GAAG,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,uCAA+B,CAAC;AACtD,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAQ;IACnC,OAAO,GAAG,CAAC,IAAI,KAAK,qCAA6B,CAAC;AACpD,CAAC;AAED,SAAS,UAAU,CAAC,QAAa;IAC/B,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC3E,CAAC","sourcesContent":["import {\n  apiMessageBus,\n  dateNow,\n  genShortID,\n  Observable,\n  stringifyObjectValues,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_HALT,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\nimport type { Faro, Subscription } from '@grafana/faro-core';\n\nimport {\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n  userActionDataAttributeParsed as userActionDataAttribute,\n} from './const';\nimport { monitorDomMutations } from './domMutationMonitor';\nimport { monitorHttpRequests } from './httpRequestMonitor';\nimport { monitorPerformanceEntries } from './performanceEntriesMonitor';\nimport type { ApiEvent, HttpRequestEndMessage, HttpRequestMessagePayload, HttpRequestStartMessage } from './types';\nimport { convertDataAttributeName } from './util';\n\nconst maxFollowUpActionTimeRange = 100;\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 timeoutId: number | undefined;\n  let actionRunning = false;\n\n  function processUserEvent(event: PointerEvent | KeyboardEvent | ApiEvent) {\n    let userActionName: string | undefined;\n\n    const isApiEventDetected = isApiEvent(event);\n    if (isApiEventDetected) {\n      userActionName = event.name;\n    } else {\n      userActionName = getUserActionName(\n        event.target as HTMLElement,\n        config.trackUserActionsDataAttributeName ?? userActionDataAttribute\n      );\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,\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(\n      timeoutId,\n      () => {\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      maxFollowUpActionTimeRange\n    );\n\n    const runningRequests = new Map<string, HttpRequestMessagePayload>();\n    let isHalted = false;\n    let pendingActionTimeoutId: number | undefined;\n\n    const allMonitorsSub = new Observable()\n      .merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor)\n      .takeWhile(() => actionRunning)\n      .filter((msg) => {\n        // If the user action is in halt state, we only keep listening to ended http requests\n        if (isHalted && !(isRequestEndMessage(msg) && runningRequests.has(msg.request.requestId))) {\n          return false;\n        }\n\n        return true;\n      })\n      .subscribe((msg) => {\n        if (isRequestStartMessage(msg)) {\n          // An action is on halt if it has pending items, like pending HTTP requests.\n          // In this case we start a separate timeout to wait for the requests to finish\n          // If in the halt state, we stop adding Faro signals to the action's buffer (see userActionLifecycleHandler.ts)\n          // But we are still subscribed to\n          runningRequests.set(msg.request.requestId, msg.request);\n        }\n        if (isRequestEndMessage(msg)) {\n          // console.log('request end msg :>> ', msg);\n          runningRequests.delete(msg.request.requestId);\n        }\n\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(\n          timeoutId,\n          () => {\n            endTime = dateNow();\n\n            const userActionParentEventProps = {\n              api,\n              userActionName,\n              startTime,\n              endTime: endTime!,\n              actionId,\n              event,\n              ...(isApiEventDetected ? { attributes: event.attributes } : {}),\n            };\n\n            const hasPendingRequests = runningRequests.size > 0;\n            const isAllPendingRequestsResolved = isHalted && !hasPendingRequests;\n\n            if (isAllPendingRequestsResolved) {\n              clearTimeout(pendingActionTimeoutId);\n              isHalted = false;\n            }\n\n            if (hasPendingRequests) {\n              isHalted = true;\n\n              apiMessageBus.notify({\n                type: USER_ACTION_HALT,\n                name: userActionName,\n                parentId: actionId,\n                reason: 'pending-requests',\n                haltTime: dateNow(),\n              });\n\n              pendingActionTimeoutId = startTimeout(\n                undefined,\n                () => {\n                  unsubscribeAllMonitors(allMonitorsSub);\n                  endUserAction(userActionParentEventProps);\n                  actionRunning = false;\n                  isHalted = false;\n                },\n                1000 * 10\n              );\n            } else {\n              unsubscribeAllMonitors(allMonitorsSub);\n              endUserAction(userActionParentEventProps);\n              actionRunning = false;\n              isHalted = false;\n            }\n          },\n          maxFollowUpActionTimeRange\n        );\n      });\n  }\n\n  return processUserEvent;\n}\n\n/**\n * User action was successfully completed and we send the final event(s)\n */\nfunction endUserAction(props: {\n  api: Faro['api'];\n  userActionName: string;\n  startTime: number;\n  endTime: number;\n  actionId: string;\n  event: PointerEvent | KeyboardEvent | ApiEvent;\n  attributes?: Record<string, string>;\n}) {\n  const { api, userActionName, startTime, endTime, actionId, event, attributes } = props;\n  const duration = endTime - startTime;\n  const eventType = event.type;\n\n  // order matters, first emit the user-action-end event and afterwards push the parent event\n  apiMessageBus.notify({\n    type: USER_ACTION_END,\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      ...stringifyObjectValues(attributes),\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\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, delay: number) {\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  }, delay);\n\n  return timeoutId;\n}\n\nfunction sendUserActionCancelMessage(userActionName: string, actionId: string) {\n  apiMessageBus.notify({\n    type: USER_ACTION_CANCEL,\n    name: userActionName,\n    parentId: actionId,\n  });\n}\n\nfunction unsubscribeAllMonitors(allMonitorsSub: Subscription | undefined) {\n  allMonitorsSub?.unsubscribe();\n  allMonitorsSub = undefined;\n}\n\nfunction isRequestStartMessage(msg: any): msg is HttpRequestStartMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_START;\n}\n\nfunction isRequestEndMessage(msg: any): msg is HttpRequestEndMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_END;\n}\n\nfunction isApiEvent(apiEvent: any): apiEvent is { name: string; attributes?: Record<string, string> } {\n  return apiEvent.type === 'apiEvent' && typeof apiEvent.name === 'string';\n}\n"]}

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

@@ -1 +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\ntype RequestApiType = 'xhr' | 'fetch';\n\nexport type HttpRequestMessagePayload = {\n  requestId: string;\n  url: string;\n  method: string;\n  apiType: RequestApiType;\n};\n\nexport type HttpRequestStartMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;\n  request: HttpRequestMessagePayload;\n};\n\nexport type HttpRequestEndMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;\n  request: HttpRequestMessagePayload;\n};\n"]}
+{"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\ntype RequestApiType = 'xhr' | 'fetch';\n\nexport type HttpRequestMessagePayload = {\n  requestId: string;\n  url: string;\n  method: string;\n  apiType: RequestApiType;\n};\n\nexport type HttpRequestStartMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;\n  request: HttpRequestMessagePayload;\n};\n\nexport type HttpRequestEndMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;\n  request: HttpRequestMessagePayload;\n};\n\nexport type ApiEvent = {\n  name: string;\n  attributes?: Record<string, string>;\n  type: 'apiEvent';\n};\n"]}

package/dist/esm/index.js

@@ -7,5 +7,5 @@ export { ConsoleTransport, FetchTransport } 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, apiMessageBus, Observable, USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_START, } 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, getUrlFromResource } from './utils/url';
-export { userActionDataAttribute } from './instrumentations/userActions/const';
+export { userActionDataAttribute, startUserAction } from './instrumentations/userActions';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAGlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,eAAe,EACf,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAQhE,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,SAAS,EACT,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,+BAA+B,EAC/B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,OAAO,EACP,SAAS,EACT,UAAU,EACV,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,OAAO,EACP,cAAc,EACd,YAAY,EACZ,OAAO,EACP,cAAc,EACd,UAAU,EACV,YAAY,EACZ,KAAK,EACL,4BAA4B,EAC5B,KAAK,EACL,YAAY,EACZ,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,IAAI,EACJ,6BAA6B,EAC7B,iBAAiB,EACjB,0BAA0B,EAC1B,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAsE5B,OAAO,EACL,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,mCAAmC,EACnC,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,GACZ,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC","sourcesContent":["export { getWebInstrumentations, makeCoreConfig } from './config';\nexport type { BrowserConfig } from './config';\n\nexport { defaultEventDomain } from './consts';\n\nexport { initializeFaro } from './initialize';\n\nexport {\n  buildStackFrame,\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n  SessionInstrumentation,\n  PerformanceInstrumentation,\n  UserActionInstrumentation,\n} from './instrumentations';\nexport type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectionEvent } from './instrumentations';\n\nexport { browserMeta, createSession, sdkMeta } from './metas';\n\nexport { ConsoleTransport, FetchTransport } from './transports';\nexport type {\n  ClockFn,\n  ConsoleTransportOptions,\n  FetchTransportOptions,\n  FetchTransportRequestOptions,\n} from './transports';\n\nexport {\n  faro,\n  allLogLevels,\n  BaseExtension,\n  BaseInstrumentation,\n  BaseTransport,\n  Conventions,\n  createInternalLogger,\n  createPromiseBuffer,\n  deepEqual,\n  defaultExceptionType,\n  defaultGlobalObjectKey,\n  defaultInternalLoggerLevel,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\n  getInternalFaroFromGlobalObject,\n  getTransportBody,\n  globalObject,\n  internalGlobalObjectKey,\n  isArray,\n  isBoolean,\n  isDomError,\n  isDomException,\n  isElement,\n  isElementDefined,\n  isError,\n  isErrorDefined,\n  isErrorEvent,\n  isEvent,\n  isEventDefined,\n  isFunction,\n  isInstanceOf,\n  isInt,\n  isInternalFaroOnGlobalObject,\n  isMap,\n  isMapDefined,\n  isNull,\n  isNumber,\n  isObject,\n  isPrimitive,\n  isRegExp,\n  isString,\n  isSymbol,\n  isSyntheticEvent,\n  isThenable,\n  isToString,\n  isTypeof,\n  isUndefined,\n  isEmpty,\n  InternalLoggerLevel,\n  LogLevel,\n  noop,\n  setInternalFaroOnGlobalObject,\n  TransportItemType,\n  transportItemTypeToBodyKey,\n  VERSION,\n  EVENT_CLICK,\n  EVENT_NAVIGATION,\n  EVENT_ROUTE_CHANGE,\n  EVENT_SESSION_EXTEND,\n  EVENT_SESSION_RESUME,\n  EVENT_SESSION_START,\n  EVENT_VIEW_CHANGED,\n  apiMessageBus,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\n\nexport type {\n  Faro,\n  API,\n  APIEvent,\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BeforeSendHook,\n  BufferItem,\n  Config,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  Extension,\n  GlobalObject,\n  Instrumentation,\n  Instrumentations,\n  InternalLogger,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  Meta,\n  MetaAPI,\n  MetaApp,\n  MetaAttributes,\n  MetaBrowser,\n  MetaGetter,\n  MetaItem,\n  MetaPage,\n  Metas,\n  MetaSDK,\n  MetaSDKIntegration,\n  MetaSession,\n  MetaUser,\n  MetaView,\n  OTELApi,\n  Patterns,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  PushErrorOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n  UnpatchedConsole,\n  ApiMessageBusMessages,\n  UserActionStartMessage,\n  UserActionEndMessage,\n  UserActionCancelMessage,\n  UserAction,\n} from '@grafana/faro-core';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './instrumentations/session';\n\nexport { getIgnoreUrls, getUrlFromResource } from './utils/url';\n\nexport { userActionDataAttribute } from './instrumentations/userActions/const';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAGlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,eAAe,EACf,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAQhE,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,SAAS,EACT,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,+BAA+B,EAC/B,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,EACvB,OAAO,EACP,SAAS,EACT,UAAU,EACV,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,OAAO,EACP,cAAc,EACd,YAAY,EACZ,OAAO,EACP,cAAc,EACd,UAAU,EACV,YAAY,EACZ,KAAK,EACL,4BAA4B,EAC5B,KAAK,EACL,YAAY,EACZ,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,IAAI,EACJ,6BAA6B,EAC7B,iBAAiB,EACjB,0BAA0B,EAC1B,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAsE5B,OAAO,EACL,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,mCAAmC,EACnC,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,GACZ,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["export { getWebInstrumentations, makeCoreConfig } from './config';\nexport type { BrowserConfig } from './config';\n\nexport { defaultEventDomain } from './consts';\n\nexport { initializeFaro } from './initialize';\n\nexport {\n  buildStackFrame,\n  ConsoleInstrumentation,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n  ViewInstrumentation,\n  WebVitalsInstrumentation,\n  SessionInstrumentation,\n  PerformanceInstrumentation,\n  UserActionInstrumentation,\n} from './instrumentations';\nexport type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectionEvent } from './instrumentations';\n\nexport { browserMeta, createSession, sdkMeta } from './metas';\n\nexport { ConsoleTransport, FetchTransport } from './transports';\nexport type {\n  ClockFn,\n  ConsoleTransportOptions,\n  FetchTransportOptions,\n  FetchTransportRequestOptions,\n} from './transports';\n\nexport {\n  faro,\n  allLogLevels,\n  BaseExtension,\n  BaseInstrumentation,\n  BaseTransport,\n  Conventions,\n  createInternalLogger,\n  createPromiseBuffer,\n  deepEqual,\n  defaultExceptionType,\n  defaultGlobalObjectKey,\n  defaultInternalLoggerLevel,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\n  getInternalFaroFromGlobalObject,\n  getTransportBody,\n  globalObject,\n  internalGlobalObjectKey,\n  isArray,\n  isBoolean,\n  isDomError,\n  isDomException,\n  isElement,\n  isElementDefined,\n  isError,\n  isErrorDefined,\n  isErrorEvent,\n  isEvent,\n  isEventDefined,\n  isFunction,\n  isInstanceOf,\n  isInt,\n  isInternalFaroOnGlobalObject,\n  isMap,\n  isMapDefined,\n  isNull,\n  isNumber,\n  isObject,\n  isPrimitive,\n  isRegExp,\n  isString,\n  isSymbol,\n  isSyntheticEvent,\n  isThenable,\n  isToString,\n  isTypeof,\n  isUndefined,\n  isEmpty,\n  InternalLoggerLevel,\n  LogLevel,\n  noop,\n  setInternalFaroOnGlobalObject,\n  TransportItemType,\n  transportItemTypeToBodyKey,\n  VERSION,\n  EVENT_CLICK,\n  EVENT_NAVIGATION,\n  EVENT_ROUTE_CHANGE,\n  EVENT_SESSION_EXTEND,\n  EVENT_SESSION_RESUME,\n  EVENT_SESSION_START,\n  EVENT_VIEW_CHANGED,\n  apiMessageBus,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\n\nexport type {\n  Faro,\n  API,\n  APIEvent,\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BeforeSendHook,\n  BufferItem,\n  Config,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  Extension,\n  GlobalObject,\n  Instrumentation,\n  Instrumentations,\n  InternalLogger,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  Meta,\n  MetaAPI,\n  MetaApp,\n  MetaAttributes,\n  MetaBrowser,\n  MetaGetter,\n  MetaItem,\n  MetaPage,\n  Metas,\n  MetaSDK,\n  MetaSDKIntegration,\n  MetaSession,\n  MetaUser,\n  MetaView,\n  OTELApi,\n  Patterns,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  PushErrorOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n  UnpatchedConsole,\n  ApiMessageBusMessages,\n  UserActionStartMessage,\n  UserActionEndMessage,\n  UserActionCancelMessage,\n  UserAction,\n} from '@grafana/faro-core';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './instrumentations/session';\n\nexport { getIgnoreUrls, getUrlFromResource } from './utils/url';\n\nexport { userActionDataAttribute, startUserAction } from './instrumentations/userActions';\n"]}

package/dist/esm/instrumentations/index.js

@@ -5,5 +5,5 @@ 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';
+export { UserActionInstrumentation, userActionDataAttribute, startUserAction } from './userActions';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/instrumentations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,eAAe,GAChB,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,OAAO,EACL,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,mCAAmC,EACnC,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,GACZ,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC","sourcesContent":["export { SessionInstrumentation } from './session';\n\nexport { ConsoleInstrumentation } from './console';\nexport type { ConsoleInstrumentationOptions } from './console';\n\nexport {\n  buildStackFrame,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n} from './errors';\nexport type { ErrorEvent, ExtendedPromiseRejectionEvent } from './errors';\n\nexport { ViewInstrumentation } from './view';\n\nexport { WebVitalsInstrumentation } from './webVitals';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './session';\n\nexport { PerformanceInstrumentation } from './performance';\n\nexport { UserActionInstrumentation, userActionDataAttribute } from './userActions';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/instrumentations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,eAAe,GAChB,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,OAAO,EACL,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,mCAAmC,EACnC,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,GACZ,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC","sourcesContent":["export { SessionInstrumentation } from './session';\n\nexport { ConsoleInstrumentation } from './console';\nexport type { ConsoleInstrumentationOptions } from './console';\n\nexport {\n  buildStackFrame,\n  ErrorsInstrumentation,\n  getDataFromSafariExtensions,\n  getStackFramesFromError,\n  parseStacktrace,\n} from './errors';\nexport type { ErrorEvent, ExtendedPromiseRejectionEvent } from './errors';\n\nexport { ViewInstrumentation } from './view';\n\nexport { WebVitalsInstrumentation } from './webVitals';\n\nexport {\n  PersistentSessionsManager,\n  VolatileSessionsManager,\n  MAX_SESSION_PERSISTENCE_TIME,\n  MAX_SESSION_PERSISTENCE_TIME_BUFFER,\n  SESSION_EXPIRATION_TIME,\n  SESSION_INACTIVITY_TIME,\n  STORAGE_KEY,\n} from './session';\n\nexport { PerformanceInstrumentation } from './performance';\n\nexport { UserActionInstrumentation, userActionDataAttribute, startUserAction } from './userActions';\n"]}

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

@@ -1,3 +1,3 @@
-export { UserActionInstrumentation } from './instrumentation';
+export { UserActionInstrumentation, startUserAction } from './instrumentation';
 export { MESSAGE_TYPE_DOM_MUTATION, MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START, userActionDataAttribute, } from './const';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAO9D,OAAO,EACL,yBAAyB,EACzB,6BAA6B,EAC7B,+BAA+B,EAC/B,uBAAuB,GACxB,MAAM,SAAS,CAAC","sourcesContent":["export { UserActionInstrumentation } from './instrumentation';\nexport type {\n  DomMutationMessage,\n  HttpRequestEndMessage,\n  HttpRequestStartMessage,\n  HttpRequestMessagePayload,\n} 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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAS/E,OAAO,EACL,yBAAyB,EACzB,6BAA6B,EAC7B,+BAA+B,EAC/B,uBAAuB,GACxB,MAAM,SAAS,CAAC","sourcesContent":["export { UserActionInstrumentation, startUserAction } from './instrumentation';\n\nexport type {\n  DomMutationMessage,\n  HttpRequestEndMessage,\n  HttpRequestStartMessage,\n  HttpRequestMessagePayload,\n} from './types';\n\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/esm/instrumentations/userActions/instrumentation.js

@@ -1,5 +1,6 @@
 import { BaseInstrumentation, faro, VERSION } from '@grafana/faro-core';
 import { getUserEventHandler } from './processUserActionEventHandler';
+let processUserEventHandler;
 export class UserActionInstrumentation extends BaseInstrumentation {
     constructor() {
         super(...arguments);
@@ -7,9 +8,19 @@ export class UserActionInstrumentation extends BaseInstrumentation {
         this.version = VERSION;
     }
     initialize() {
-        const processUserEventHandler = getUserEventHandler(faro);
+        processUserEventHandler = getUserEventHandler(faro);
         window.addEventListener('pointerdown', processUserEventHandler);
         window.addEventListener('keydown', processUserEventHandler);
     }
 }
+export function startUserAction(name, attributes) {
+    processUserEventHandler === null || processUserEventHandler === void 0 ? void 0 : processUserEventHandler(createUserActionApiEvent(name, attributes));
+}
+function createUserActionApiEvent(name, attributes) {
+    return {
+        name,
+        attributes,
+        type: 'apiEvent',
+    };
+}
 //# sourceMappingURL=instrumentation.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/instrumentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAExE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,MAAM,OAAO,yBAA0B,SAAQ,mBAAmB;IAAlE;;QACW,SAAI,GAAG,mDAAmD,CAAC;QAC3D,YAAO,GAAG,OAAO,CAAC;IAO7B,CAAC;IALC,UAAU;QACR,MAAM,uBAAuB,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;QAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;IAC9D,CAAC;CACF","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"]}
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/instrumentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAExE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGtE,IAAI,uBAA2E,CAAC;AAEhF,MAAM,OAAO,yBAA0B,SAAQ,mBAAmB;IAAlE;;QACW,SAAI,GAAG,mDAAmD,CAAC;QAC3D,YAAO,GAAG,OAAO,CAAC;IAO7B,CAAC;IALC,UAAU;QACR,uBAAuB,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;QAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,UAAmC;IAC/E,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAG,wBAAwB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAY,EAAE,UAAmC;IACjF,OAAO;QACL,IAAI;QACJ,UAAU;QACV,IAAI,EAAE,UAAU;KACjB,CAAC;AACJ,CAAC","sourcesContent":["import { BaseInstrumentation, faro, VERSION } from '@grafana/faro-core';\n\nimport { getUserEventHandler } from './processUserActionEventHandler';\nimport type { ApiEvent } from './types';\n\nlet processUserEventHandler: ReturnType<typeof getUserEventHandler> | undefined;\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    processUserEventHandler = getUserEventHandler(faro);\n    window.addEventListener('pointerdown', processUserEventHandler);\n    window.addEventListener('keydown', processUserEventHandler);\n  }\n}\n\nexport function startUserAction(name: string, attributes?: Record<string, string>) {\n  processUserEventHandler?.(createUserActionApiEvent(name, attributes));\n}\n\nfunction createUserActionApiEvent(name: string, attributes?: Record<string, string>): ApiEvent {\n  return {\n    name,\n    attributes,\n    type: 'apiEvent',\n  };\n}\n"]}

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

@@ -1,4 +1,4 @@
-import { apiMessageBus, dateNow, genShortID, Observable, USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START, } from '@grafana/faro-core';
+import { apiMessageBus, dateNow, genShortID, Observable, stringifyObjectValues, USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START, } from '@grafana/faro-core';
 import { MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START, userActionDataAttributeParsed as userActionDataAttribute, } from './const';
 import { monitorDomMutations } from './domMutationMonitor';
 import { monitorHttpRequests } from './httpRequestMonitor';
@@ -14,7 +14,14 @@ export function getUserEventHandler(faro) {
     let actionRunning = false;
     function processUserEvent(event) {
         var _a;
-        const userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : userActionDataAttribute);
+        let userActionName;
+        const isApiEventDetected = isApiEvent(event);
+        if (isApiEventDetected) {
+            userActionName = event.name;
+        }
+        else {
+            userActionName = getUserActionName(event.target, (_a = config.trackUserActionsDataAttributeName) !== null && _a !== void 0 ? _a : userActionDataAttribute);
+        }
         if (actionRunning || userActionName == null) {
             return;
         }
@@ -64,7 +71,10 @@ export function getUserEventHandler(faro) {
             // If timeout is triggered the user action is done and we send respective messages and events
             timeoutId = startTimeout(timeoutId, () => {
                 endTime = dateNow();
-                const userActionParentEventProps = { api, userActionName, startTime, endTime: endTime, actionId, event };
+                const userActionParentEventProps = Object.assign({ api,
+                    userActionName,
+                    startTime, endTime: endTime, actionId,
+                    event }, (isApiEventDetected ? { attributes: event.attributes } : {}));
                 const hasPendingRequests = runningRequests.size > 0;
                 const isAllPendingRequestsResolved = isHalted && !hasPendingRequests;
                 if (isAllPendingRequestsResolved) {
@@ -102,7 +112,7 @@ export function getUserEventHandler(faro) {
  * User action was successfully completed and we send the final event(s)
  */
 function endUserAction(props) {
-    const { api, userActionName, startTime, endTime, actionId, event } = props;
+    const { api, userActionName, startTime, endTime, actionId, event, attributes } = props;
     const duration = endTime - startTime;
     const eventType = event.type;
     // order matters, first emit the user-action-end event and afterwards push the parent event
@@ -116,12 +126,7 @@ function endUserAction(props) {
         eventType,
     });
     // Send the final action parent event
-    api.pushEvent(userActionName, {
-        userActionStartTime: startTime.toString(),
-        userActionEndTime: endTime.toString(),
-        userActionDuration: duration.toString(),
-        userActionEventType: eventType,
-    }, undefined, {
+    api.pushEvent(userActionName, Object.assign({ userActionStartTime: startTime.toString(), userActionEndTime: endTime.toString(), userActionDuration: duration.toString(), userActionEventType: eventType }, stringifyObjectValues(attributes)), undefined, {
         timestampOverwriteMs: startTime,
         customPayloadTransformer: (payload) => {
             payload.action = {
@@ -169,4 +174,7 @@ function isRequestStartMessage(msg) {
 function isRequestEndMessage(msg) {
     return msg.type === MESSAGE_TYPE_HTTP_REQUEST_END;
 }
+function isApiEvent(apiEvent) {
+    return apiEvent.type === 'apiEvent' && typeof apiEvent.name === 'string';
+}
 //# sourceMappingURL=processUserActionEventHandler.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,OAAO,EACP,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,6BAA6B,IAAI,uBAAuB,GACzD,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAElD,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC,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,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,CAAC;YAC5C,OAAO;QACT,CAAC;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,iBAAiB;YACvB,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CACtB,SAAS,EACT,GAAG,EAAE;YACH,OAAO,GAAG,OAAO,EAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,EACD,0BAA0B,CAC3B,CAAC;QAEF,MAAM,eAAe,GAAG,IAAI,GAAG,EAAqC,CAAC;QACrE,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,sBAA0C,CAAC;QAE/C,MAAM,cAAc,GAAG,IAAI,UAAU,EAAE;aACpC,KAAK,CAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC;aAClE,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC;aAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YACd,qFAAqF;YACrF,IAAI,QAAQ,IAAI,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YACjB,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,4EAA4E;gBAC5E,8EAA8E;gBAC9E,+GAA+G;gBAC/G,iCAAiC;gBACjC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,4CAA4C;gBAC5C,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;YAED,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CACtB,SAAS,EACT,GAAG,EAAE;gBACH,OAAO,GAAG,OAAO,EAAE,CAAC;gBAEpB,MAAM,0BAA0B,GAAG,EAAE,GAAG,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAE,OAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;gBAE1G,MAAM,kBAAkB,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;gBACpD,MAAM,4BAA4B,GAAG,QAAQ,IAAI,CAAC,kBAAkB,CAAC;gBAErE,IAAI,4BAA4B,EAAE,CAAC;oBACjC,YAAY,CAAC,sBAAsB,CAAC,CAAC;oBACrC,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;gBAED,IAAI,kBAAkB,EAAE,CAAC;oBACvB,QAAQ,GAAG,IAAI,CAAC;oBAEhB,aAAa,CAAC,MAAM,CAAC;wBACnB,IAAI,EAAE,gBAAgB;wBACtB,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,QAAQ;wBAClB,MAAM,EAAE,kBAAkB;wBAC1B,QAAQ,EAAE,OAAO,EAAE;qBACpB,CAAC,CAAC;oBAEH,sBAAsB,GAAG,YAAY,CACnC,SAAS,EACT,GAAG,EAAE;wBACH,sBAAsB,CAAC,cAAc,CAAC,CAAC;wBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;wBAC1C,aAAa,GAAG,KAAK,CAAC;wBACtB,QAAQ,GAAG,KAAK,CAAC;oBACnB,CAAC,EACD,IAAI,GAAG,EAAE,CACV,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,sBAAsB,CAAC,cAAc,CAAC,CAAC;oBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;oBAC1C,aAAa,GAAG,KAAK,CAAC;oBACtB,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;YACH,CAAC,EACD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAOtB;IACC,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAC3E,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IACrC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAE7B,2FAA2F;IAC3F,aAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,QAAQ;QACZ,SAAS;QACT,OAAO;QACP,QAAQ;QACR,SAAS;KACV,CAAC,CAAC;IAEH,qCAAqC;IACrC,GAAG,CAAC,SAAS,CACX,cAAc,EACd;QACE,mBAAmB,EAAE,SAAS,CAAC,QAAQ,EAAE;QACzC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE;QACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE;QACvC,mBAAmB,EAAE,SAAS;KAC/B,EACD,SAAS,EACT;QACE,oBAAoB,EAAE,SAAS;QAC/B,wBAAwB,EAAE,CAAC,OAAO,EAAE,EAAE;YACpC,OAAO,CAAC,MAAM,GAAG;gBACf,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,cAAc;aACrB,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CACF,CAAC;AACJ,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,CAAC;QAC1B,IAAI,GAAG,KAAK,uBAAuB,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,SAA6B,EAAE,EAAc,EAAE,KAAa;IAChF,IAAI,SAAS,EAAE,CAAC;QACd,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAC1B,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,KAAK,CAAC,CAAC;IAEV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,aAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwC;IACtE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;IAC9B,cAAc,GAAG,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,+BAA+B,CAAC;AACtD,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAQ;IACnC,OAAO,GAAG,CAAC,IAAI,KAAK,6BAA6B,CAAC;AACpD,CAAC","sourcesContent":["import {\n  apiMessageBus,\n  dateNow,\n  genShortID,\n  Observable,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_HALT,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\nimport type { Faro, Subscription } from '@grafana/faro-core';\n\nimport {\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n  userActionDataAttributeParsed as userActionDataAttribute,\n} from './const';\nimport { monitorDomMutations } from './domMutationMonitor';\nimport { monitorHttpRequests } from './httpRequestMonitor';\nimport { monitorPerformanceEntries } from './performanceEntriesMonitor';\nimport type { HttpRequestEndMessage, HttpRequestMessagePayload, HttpRequestStartMessage } from './types';\nimport { convertDataAttributeName } from './util';\n\nconst maxFollowUpActionTimeRange = 100;\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 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,\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(\n      timeoutId,\n      () => {\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      maxFollowUpActionTimeRange\n    );\n\n    const runningRequests = new Map<string, HttpRequestMessagePayload>();\n    let isHalted = false;\n    let pendingActionTimeoutId: number | undefined;\n\n    const allMonitorsSub = new Observable()\n      .merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor)\n      .takeWhile(() => actionRunning)\n      .filter((msg) => {\n        // If the user action is in halt state, we only keep listening to ended http requests\n        if (isHalted && !(isRequestEndMessage(msg) && runningRequests.has(msg.request.requestId))) {\n          return false;\n        }\n\n        return true;\n      })\n      .subscribe((msg) => {\n        if (isRequestStartMessage(msg)) {\n          // An action is on halt if it has pending items, like pending HTTP requests.\n          // In this case we start a separate timeout to wait for the requests to finish\n          // If in the halt state, we stop adding Faro signals to the action's buffer (see userActionLifecycleHandler.ts)\n          // But we are still subscribed to\n          runningRequests.set(msg.request.requestId, msg.request);\n        }\n        if (isRequestEndMessage(msg)) {\n          // console.log('request end msg :>> ', msg);\n          runningRequests.delete(msg.request.requestId);\n        }\n\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(\n          timeoutId,\n          () => {\n            endTime = dateNow();\n\n            const userActionParentEventProps = { api, userActionName, startTime, endTime: endTime!, actionId, event };\n\n            const hasPendingRequests = runningRequests.size > 0;\n            const isAllPendingRequestsResolved = isHalted && !hasPendingRequests;\n\n            if (isAllPendingRequestsResolved) {\n              clearTimeout(pendingActionTimeoutId);\n              isHalted = false;\n            }\n\n            if (hasPendingRequests) {\n              isHalted = true;\n\n              apiMessageBus.notify({\n                type: USER_ACTION_HALT,\n                name: userActionName,\n                parentId: actionId,\n                reason: 'pending-requests',\n                haltTime: dateNow(),\n              });\n\n              pendingActionTimeoutId = startTimeout(\n                undefined,\n                () => {\n                  unsubscribeAllMonitors(allMonitorsSub);\n                  endUserAction(userActionParentEventProps);\n                  actionRunning = false;\n                  isHalted = false;\n                },\n                1000 * 10\n              );\n            } else {\n              unsubscribeAllMonitors(allMonitorsSub);\n              endUserAction(userActionParentEventProps);\n              actionRunning = false;\n              isHalted = false;\n            }\n          },\n          maxFollowUpActionTimeRange\n        );\n      });\n  }\n\n  return processUserEvent;\n}\n\n/**\n * User action was successfully completed and we send the final event(s)\n */\nfunction endUserAction(props: {\n  api: Faro['api'];\n  userActionName: string;\n  startTime: number;\n  endTime: number;\n  actionId: string;\n  event: PointerEvent | KeyboardEvent;\n}) {\n  const { api, userActionName, startTime, endTime, actionId, event } = props;\n  const duration = endTime - startTime;\n  const eventType = event.type;\n\n  // order matters, first emit the user-action-end event and afterwards push the parent event\n  apiMessageBus.notify({\n    type: USER_ACTION_END,\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\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, delay: number) {\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  }, delay);\n\n  return timeoutId;\n}\n\nfunction sendUserActionCancelMessage(userActionName: string, actionId: string) {\n  apiMessageBus.notify({\n    type: USER_ACTION_CANCEL,\n    name: userActionName,\n    parentId: actionId,\n  });\n}\n\nfunction unsubscribeAllMonitors(allMonitorsSub: Subscription | undefined) {\n  allMonitorsSub?.unsubscribe();\n  allMonitorsSub = undefined;\n}\n\nfunction isRequestStartMessage(msg: any): msg is HttpRequestStartMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_START;\n}\n\nfunction isRequestEndMessage(msg: any): msg is HttpRequestEndMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_END;\n}\n"]}
+{"version":3,"file":"processUserActionEventHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/userActions/processUserActionEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,OAAO,EACP,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,6BAA6B,IAAI,uBAAuB,GACzD,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAElD,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC,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,SAA6B,CAAC;IAClC,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,SAAS,gBAAgB,CAAC,KAA8C;;QACtE,IAAI,cAAkC,CAAC;QAEvC,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,kBAAkB,EAAE,CAAC;YACvB,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,cAAc,GAAG,iBAAiB,CAChC,KAAK,CAAC,MAAqB,EAC3B,MAAA,MAAM,CAAC,iCAAiC,mCAAI,uBAAuB,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;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,iBAAiB;YACvB,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,GAAG,YAAY,CACtB,SAAS,EACT,GAAG,EAAE;YACH,OAAO,GAAG,OAAO,EAAE,CAAC;YAEpB,mFAAmF;YACnF,aAAa,GAAG,KAAK,CAAC;YACtB,2BAA2B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC,EACD,0BAA0B,CAC3B,CAAC;QAEF,MAAM,eAAe,GAAG,IAAI,GAAG,EAAqC,CAAC;QACrE,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,sBAA0C,CAAC;QAE/C,MAAM,cAAc,GAAG,IAAI,UAAU,EAAE;aACpC,KAAK,CAAC,WAAW,EAAE,mBAAmB,EAAE,yBAAyB,CAAC;aAClE,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC;aAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YACd,qFAAqF;YACrF,IAAI,QAAQ,IAAI,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YACjB,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,4EAA4E;gBAC5E,8EAA8E;gBAC9E,+GAA+G;gBAC/G,iCAAiC;gBACjC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,4CAA4C;gBAC5C,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;YAED,6HAA6H;YAC7H,6FAA6F;YAC7F,SAAS,GAAG,YAAY,CACtB,SAAS,EACT,GAAG,EAAE;gBACH,OAAO,GAAG,OAAO,EAAE,CAAC;gBAEpB,MAAM,0BAA0B,mBAC9B,GAAG;oBACH,cAAc;oBACd,SAAS,EACT,OAAO,EAAE,OAAQ,EACjB,QAAQ;oBACR,KAAK,IACF,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChE,CAAC;gBAEF,MAAM,kBAAkB,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;gBACpD,MAAM,4BAA4B,GAAG,QAAQ,IAAI,CAAC,kBAAkB,CAAC;gBAErE,IAAI,4BAA4B,EAAE,CAAC;oBACjC,YAAY,CAAC,sBAAsB,CAAC,CAAC;oBACrC,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;gBAED,IAAI,kBAAkB,EAAE,CAAC;oBACvB,QAAQ,GAAG,IAAI,CAAC;oBAEhB,aAAa,CAAC,MAAM,CAAC;wBACnB,IAAI,EAAE,gBAAgB;wBACtB,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,QAAQ;wBAClB,MAAM,EAAE,kBAAkB;wBAC1B,QAAQ,EAAE,OAAO,EAAE;qBACpB,CAAC,CAAC;oBAEH,sBAAsB,GAAG,YAAY,CACnC,SAAS,EACT,GAAG,EAAE;wBACH,sBAAsB,CAAC,cAAc,CAAC,CAAC;wBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;wBAC1C,aAAa,GAAG,KAAK,CAAC;wBACtB,QAAQ,GAAG,KAAK,CAAC;oBACnB,CAAC,EACD,IAAI,GAAG,EAAE,CACV,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,sBAAsB,CAAC,cAAc,CAAC,CAAC;oBACvC,aAAa,CAAC,0BAA0B,CAAC,CAAC;oBAC1C,aAAa,GAAG,KAAK,CAAC;oBACtB,QAAQ,GAAG,KAAK,CAAC;gBACnB,CAAC;YACH,CAAC,EACD,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAQtB;IACC,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IACvF,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IACrC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAE7B,2FAA2F;IAC3F,aAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,QAAQ;QACZ,SAAS;QACT,OAAO;QACP,QAAQ;QACR,SAAS;KACV,CAAC,CAAC;IAEH,qCAAqC;IACrC,GAAG,CAAC,SAAS,CACX,cAAc,kBAEZ,mBAAmB,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE,EACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE,EACvC,mBAAmB,EAAE,SAAS,IAC3B,qBAAqB,CAAC,UAAU,CAAC,GAEtC,SAAS,EACT;QACE,oBAAoB,EAAE,SAAS;QAC/B,wBAAwB,EAAE,CAAC,OAAO,EAAE,EAAE;YACpC,OAAO,CAAC,MAAM,GAAG;gBACf,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,cAAc;aACrB,CAAC;YAEF,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CACF,CAAC;AACJ,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,CAAC;QAC1B,IAAI,GAAG,KAAK,uBAAuB,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,SAA6B,EAAE,EAAc,EAAE,KAAa;IAChF,IAAI,SAAS,EAAE,CAAC;QACd,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,iEAAiE;IACjE,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAC1B,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,KAAK,CAAC,CAAC;IAEV,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,2BAA2B,CAAC,cAAsB,EAAE,QAAgB;IAC3E,aAAa,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwC;IACtE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE,CAAC;IAC9B,cAAc,GAAG,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,+BAA+B,CAAC;AACtD,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAQ;IACnC,OAAO,GAAG,CAAC,IAAI,KAAK,6BAA6B,CAAC;AACpD,CAAC;AAED,SAAS,UAAU,CAAC,QAAa;IAC/B,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC3E,CAAC","sourcesContent":["import {\n  apiMessageBus,\n  dateNow,\n  genShortID,\n  Observable,\n  stringifyObjectValues,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_HALT,\n  USER_ACTION_START,\n} from '@grafana/faro-core';\nimport type { Faro, Subscription } from '@grafana/faro-core';\n\nimport {\n  MESSAGE_TYPE_HTTP_REQUEST_END,\n  MESSAGE_TYPE_HTTP_REQUEST_START,\n  userActionDataAttributeParsed as userActionDataAttribute,\n} from './const';\nimport { monitorDomMutations } from './domMutationMonitor';\nimport { monitorHttpRequests } from './httpRequestMonitor';\nimport { monitorPerformanceEntries } from './performanceEntriesMonitor';\nimport type { ApiEvent, HttpRequestEndMessage, HttpRequestMessagePayload, HttpRequestStartMessage } from './types';\nimport { convertDataAttributeName } from './util';\n\nconst maxFollowUpActionTimeRange = 100;\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 timeoutId: number | undefined;\n  let actionRunning = false;\n\n  function processUserEvent(event: PointerEvent | KeyboardEvent | ApiEvent) {\n    let userActionName: string | undefined;\n\n    const isApiEventDetected = isApiEvent(event);\n    if (isApiEventDetected) {\n      userActionName = event.name;\n    } else {\n      userActionName = getUserActionName(\n        event.target as HTMLElement,\n        config.trackUserActionsDataAttributeName ?? userActionDataAttribute\n      );\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,\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(\n      timeoutId,\n      () => {\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      maxFollowUpActionTimeRange\n    );\n\n    const runningRequests = new Map<string, HttpRequestMessagePayload>();\n    let isHalted = false;\n    let pendingActionTimeoutId: number | undefined;\n\n    const allMonitorsSub = new Observable()\n      .merge(httpMonitor, domMutationsMonitor, performanceEntriesMonitor)\n      .takeWhile(() => actionRunning)\n      .filter((msg) => {\n        // If the user action is in halt state, we only keep listening to ended http requests\n        if (isHalted && !(isRequestEndMessage(msg) && runningRequests.has(msg.request.requestId))) {\n          return false;\n        }\n\n        return true;\n      })\n      .subscribe((msg) => {\n        if (isRequestStartMessage(msg)) {\n          // An action is on halt if it has pending items, like pending HTTP requests.\n          // In this case we start a separate timeout to wait for the requests to finish\n          // If in the halt state, we stop adding Faro signals to the action's buffer (see userActionLifecycleHandler.ts)\n          // But we are still subscribed to\n          runningRequests.set(msg.request.requestId, msg.request);\n        }\n        if (isRequestEndMessage(msg)) {\n          // console.log('request end msg :>> ', msg);\n          runningRequests.delete(msg.request.requestId);\n        }\n\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(\n          timeoutId,\n          () => {\n            endTime = dateNow();\n\n            const userActionParentEventProps = {\n              api,\n              userActionName,\n              startTime,\n              endTime: endTime!,\n              actionId,\n              event,\n              ...(isApiEventDetected ? { attributes: event.attributes } : {}),\n            };\n\n            const hasPendingRequests = runningRequests.size > 0;\n            const isAllPendingRequestsResolved = isHalted && !hasPendingRequests;\n\n            if (isAllPendingRequestsResolved) {\n              clearTimeout(pendingActionTimeoutId);\n              isHalted = false;\n            }\n\n            if (hasPendingRequests) {\n              isHalted = true;\n\n              apiMessageBus.notify({\n                type: USER_ACTION_HALT,\n                name: userActionName,\n                parentId: actionId,\n                reason: 'pending-requests',\n                haltTime: dateNow(),\n              });\n\n              pendingActionTimeoutId = startTimeout(\n                undefined,\n                () => {\n                  unsubscribeAllMonitors(allMonitorsSub);\n                  endUserAction(userActionParentEventProps);\n                  actionRunning = false;\n                  isHalted = false;\n                },\n                1000 * 10\n              );\n            } else {\n              unsubscribeAllMonitors(allMonitorsSub);\n              endUserAction(userActionParentEventProps);\n              actionRunning = false;\n              isHalted = false;\n            }\n          },\n          maxFollowUpActionTimeRange\n        );\n      });\n  }\n\n  return processUserEvent;\n}\n\n/**\n * User action was successfully completed and we send the final event(s)\n */\nfunction endUserAction(props: {\n  api: Faro['api'];\n  userActionName: string;\n  startTime: number;\n  endTime: number;\n  actionId: string;\n  event: PointerEvent | KeyboardEvent | ApiEvent;\n  attributes?: Record<string, string>;\n}) {\n  const { api, userActionName, startTime, endTime, actionId, event, attributes } = props;\n  const duration = endTime - startTime;\n  const eventType = event.type;\n\n  // order matters, first emit the user-action-end event and afterwards push the parent event\n  apiMessageBus.notify({\n    type: USER_ACTION_END,\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      ...stringifyObjectValues(attributes),\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\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, delay: number) {\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  }, delay);\n\n  return timeoutId;\n}\n\nfunction sendUserActionCancelMessage(userActionName: string, actionId: string) {\n  apiMessageBus.notify({\n    type: USER_ACTION_CANCEL,\n    name: userActionName,\n    parentId: actionId,\n  });\n}\n\nfunction unsubscribeAllMonitors(allMonitorsSub: Subscription | undefined) {\n  allMonitorsSub?.unsubscribe();\n  allMonitorsSub = undefined;\n}\n\nfunction isRequestStartMessage(msg: any): msg is HttpRequestStartMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_START;\n}\n\nfunction isRequestEndMessage(msg: any): msg is HttpRequestEndMessage {\n  return msg.type === MESSAGE_TYPE_HTTP_REQUEST_END;\n}\n\nfunction isApiEvent(apiEvent: any): apiEvent is { name: string; attributes?: Record<string, string> } {\n  return apiEvent.type === 'apiEvent' && typeof apiEvent.name === 'string';\n}\n"]}

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

@@ -1 +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\ntype RequestApiType = 'xhr' | 'fetch';\n\nexport type HttpRequestMessagePayload = {\n  requestId: string;\n  url: string;\n  method: string;\n  apiType: RequestApiType;\n};\n\nexport type HttpRequestStartMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;\n  request: HttpRequestMessagePayload;\n};\n\nexport type HttpRequestEndMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;\n  request: HttpRequestMessagePayload;\n};\n"]}
+{"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\ntype RequestApiType = 'xhr' | 'fetch';\n\nexport type HttpRequestMessagePayload = {\n  requestId: string;\n  url: string;\n  method: string;\n  apiType: RequestApiType;\n};\n\nexport type HttpRequestStartMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;\n  request: HttpRequestMessagePayload;\n};\n\nexport type HttpRequestEndMessage = {\n  type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;\n  request: HttpRequestMessagePayload;\n};\n\nexport type ApiEvent = {\n  name: string;\n  attributes?: Record<string, string>;\n  type: 'apiEvent';\n};\n"]}

package/dist/types/index.d.ts

@@ -11,4 +11,4 @@ export { faro, allLogLevels, BaseExtension, BaseInstrumentation, BaseTransport,
 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, getUrlFromResource } from './utils/url';
-export { userActionDataAttribute } from './instrumentations/userActions/const';
+export { userActionDataAttribute, startUserAction } from './instrumentations/userActions';

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.15.0";
+    readonly version = "1.16.0";
     static defaultDisabledLevels: LogLevel[];
     static consoleErrorPrefix: string;
     private errorSerializer;