@grafana/faro-core 1.19.0 → 2.0.0-beta-2

package/dist/spec/core/src/api/userActions/userAction.js

@@ -0,0 +1,165 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 });
+var registerFaro_1 = require("../../sdk/registerFaro");
+var transports_1 = require("../../transports");
+var utils_1 = require("../../utils");
+var ItemBuffer_1 = require("../ItemBuffer");
+var const_1 = require("./const");
+var types_1 = require("./types");
+var defaultFollowUpActionTimeRange = 100;
+var defaultHaltTimeout = 10 * 1000;
+var UserAction = /** @class */ (function (_super) {
+    __extends(UserAction, _super);
+    function UserAction(_a) {
+        var name = _a.name, parentId = _a.parentId, haltTimeout = _a.haltTimeout, trigger = _a.trigger, transports = _a.transports, attributes = _a.attributes, trackUserActionsExcludeItem = _a.trackUserActionsExcludeItem, _b = _a.severity, severity = _b === void 0 ? const_1.UserActionSeverity.Normal : _b;
+        var _this = _super.call(this) || this;
+        _this.name = name;
+        _this.attributes = attributes;
+        _this.id = (0, utils_1.genShortID)();
+        _this.trigger = trigger;
+        _this.cancelTimeout = defaultFollowUpActionTimeRange;
+        _this.haltTimeout = haltTimeout !== null && haltTimeout !== void 0 ? haltTimeout : defaultHaltTimeout;
+        _this.parentId = parentId !== null && parentId !== void 0 ? parentId : _this.id;
+        _this.trackUserActionsExcludeItem = trackUserActionsExcludeItem;
+        _this.severity = severity;
+        _this._itemBuffer = new ItemBuffer_1.ItemBuffer();
+        _this._transports = transports;
+        _this._haltTimeoutId = -1;
+        _this._state = types_1.UserActionState.Started;
+        _this._isValid = false;
+        _this._start();
+        return _this;
+    }
+    UserAction.prototype.addItem = function (item) {
+        this._itemBuffer.addItem(item);
+    };
+    UserAction.prototype.extend = function (haltPredicate) {
+        if (!this._isValid) {
+            this._isValid = true;
+        }
+        this._setFollowupActionTimeout(haltPredicate);
+    };
+    UserAction.prototype._setFollowupActionTimeout = function (haltPredicate) {
+        var _this = this;
+        this._timeoutId = startTimeout(this._timeoutId, function () {
+            if (_this._state === types_1.UserActionState.Started && (haltPredicate === null || haltPredicate === void 0 ? void 0 : haltPredicate())) {
+                _this.halt();
+            }
+            else if (_this._isValid) {
+                _this.end();
+            }
+            else {
+                _this.cancel();
+            }
+        }, defaultFollowUpActionTimeRange);
+    };
+    UserAction.prototype._start = function () {
+        this._state = types_1.UserActionState.Started;
+        if (this._state === types_1.UserActionState.Started) {
+            this.startTime = (0, utils_1.dateNow)();
+        }
+        this._setFollowupActionTimeout();
+    };
+    UserAction.prototype.halt = function () {
+        var _this = this;
+        if (this._state !== types_1.UserActionState.Started) {
+            return;
+        }
+        this._state = types_1.UserActionState.Halted;
+        // If the halt timeout fires, we end the user action as
+        // it is still a valid one.
+        this._haltTimeoutId = setTimeout(function () {
+            _this.end();
+        }, this.haltTimeout);
+        this.notify(this._state);
+    };
+    UserAction.prototype.cancel = function () {
+        if (this._state === types_1.UserActionState.Started) {
+            // Empty the buffer
+            this._itemBuffer.flushBuffer();
+        }
+        this._state = types_1.UserActionState.Cancelled;
+        this.notify(this._state);
+    };
+    UserAction.prototype.end = function () {
+        var _this = this;
+        if (this._state === types_1.UserActionState.Cancelled) {
+            return;
+        }
+        // Make sure we don't end the user action twice
+        clearTimeout(this._haltTimeoutId);
+        clearTimeout(this._timeoutId);
+        var endTime = (0, utils_1.dateNow)();
+        var duration = endTime - this.startTime;
+        this._state = types_1.UserActionState.Ended;
+        this._itemBuffer.flushBuffer(function (item) {
+            if (isExcludeFromUserAction(item, _this.trackUserActionsExcludeItem)) {
+                _this._transports.execute(item);
+                return;
+            }
+            var userActionItem = __assign(__assign({}, item), { payload: __assign(__assign({}, item.payload), { action: {
+                        parentId: _this.id,
+                        name: _this.name,
+                    } }) });
+            _this._transports.execute(userActionItem);
+        });
+        this._state = types_1.UserActionState.Ended;
+        this.notify(this._state);
+        registerFaro_1.faro.api.pushEvent(this.name, __assign({ userActionStartTime: this.startTime.toString(), userActionEndTime: endTime.toString(), userActionDuration: duration.toString(), userActionTrigger: this.trigger, userActionSeverity: this.severity }, (0, utils_1.stringifyObjectValues)(this.attributes)), undefined, {
+            timestampOverwriteMs: this.startTime,
+            customPayloadTransformer: function (payload) {
+                payload.action = {
+                    id: _this.id,
+                    name: _this.name,
+                };
+                return payload;
+            },
+        });
+    };
+    UserAction.prototype.getState = function () {
+        return this._state;
+    };
+    return UserAction;
+}(utils_1.Observable));
+exports.default = UserAction;
+function isExcludeFromUserAction(item, trackUserActionsExcludeItem) {
+    return ((trackUserActionsExcludeItem === null || trackUserActionsExcludeItem === void 0 ? void 0 : trackUserActionsExcludeItem(item)) ||
+        (item.type === transports_1.TransportItemType.MEASUREMENT && item.payload.type === 'web-vitals'));
+}
+function startTimeout(timeoutId, cb, delay) {
+    if (timeoutId) {
+        clearTimeout(timeoutId);
+    }
+    //@ts-expect-error for some reason vscode is using the node types
+    timeoutId = setTimeout(function () {
+        cb();
+    }, delay);
+    return timeoutId;
+}
+//# sourceMappingURL=userAction.js.map

package/dist/spec/core/src/api/userActions/userAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAction.js","sourceRoot":"","sources":["../../../../../../src/api/userActions/userAction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,uDAA8C;AAC9C,+CAA0F;AAC1F,qCAAqF;AACrF,4CAA2C;AAI3C,iCAA6C;AAC7C,iCAAwF;AAExF,IAAM,8BAA8B,GAAG,GAAG,CAAC;AAC3C,IAAM,kBAAkB,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC;IAAwC,8BAAU;IAmBhD,oBAAY,EAkBX;YAjBC,IAAI,UAAA,EACJ,QAAQ,cAAA,EACR,WAAW,iBAAA,EACX,OAAO,aAAA,EACP,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,2BAA2B,iCAAA,EAC3B,gBAAoC,EAApC,QAAQ,mBAAG,0BAAkB,CAAC,MAAM,KAAA;QAWpC,YAAA,MAAK,WAAE,SAAC;QACR,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,KAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,KAAI,CAAC,EAAE,GAAG,IAAA,kBAAU,GAAE,CAAC;QACvB,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,KAAI,CAAC,aAAa,GAAG,8BAA8B,CAAC;QACpD,KAAI,CAAC,WAAW,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,kBAAkB,CAAC;QACrD,KAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,KAAI,CAAC,EAAE,CAAC;QACpC,KAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;QAC/D,KAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,KAAI,CAAC,WAAW,GAAG,IAAI,uBAAU,EAAiB,CAAC;QACnD,KAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,KAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACzB,KAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,OAAO,CAAC;QACtC,KAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,KAAI,CAAC,MAAM,EAAE,CAAC;;IAChB,CAAC;IAED,4BAAO,GAAP,UAAQ,IAAmB;QACzB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,2BAAM,GAAN,UAAO,aAA6B;QAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;IAEO,8CAAyB,GAAjC,UAAkC,aAA6B;QAA/D,iBAcC;QAbC,IAAI,CAAC,UAAU,GAAG,YAAY,CAC5B,IAAI,CAAC,UAAU,EACf;YACE,IAAI,KAAI,CAAC,MAAM,KAAK,uBAAe,CAAC,OAAO,KAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,EAAI,CAAA,EAAE,CAAC;gBACjE,KAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC;iBAAM,IAAI,KAAI,CAAC,QAAQ,EAAE,CAAC;gBACzB,KAAI,CAAC,GAAG,EAAE,CAAC;YACb,CAAC;iBAAM,CAAC;gBACN,KAAI,CAAC,MAAM,EAAE,CAAC;YAChB,CAAC;QACH,CAAC,EACD,8BAA8B,CAC/B,CAAC;IACJ,CAAC;IAEO,2BAAM,GAAd;QACE,IAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,OAAO,CAAC;QACtC,IAAI,IAAI,CAAC,MAAM,KAAK,uBAAe,CAAC,OAAO,EAAE,CAAC;YAC5C,IAAI,CAAC,SAAS,GAAG,IAAA,eAAO,GAAE,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACnC,CAAC;IAED,yBAAI,GAAJ;QAAA,iBAYC;QAXC,IAAI,IAAI,CAAC,MAAM,KAAK,uBAAe,CAAC,OAAO,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,MAAM,CAAC;QAErC,uDAAuD;QACvD,2BAA2B;QAC3B,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC;YAC/B,KAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,2BAAM,GAAN;QACE,IAAI,IAAI,CAAC,MAAM,KAAK,uBAAe,CAAC,OAAO,EAAE,CAAC;YAC5C,mBAAmB;YACnB,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QACjC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,wBAAG,GAAH;QAAA,iBA0DC;QAzDC,IAAI,IAAI,CAAC,MAAM,KAAK,uBAAe,CAAC,SAAS,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,+CAA+C;QAC/C,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9B,IAAM,OAAO,GAAG,IAAA,eAAO,GAAE,CAAC;QAC1B,IAAM,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC,SAAU,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,KAAK,CAAC;QACpC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI;YAChC,IAAI,uBAAuB,CAAC,IAAI,EAAE,KAAI,CAAC,2BAA2B,CAAC,EAAE,CAAC;gBACpE,KAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO;YACT,CAAC;YAED,IAAM,cAAc,GAAG,sBAClB,IAAI,KACP,OAAO,wBACF,IAAI,CAAC,OAAO,KACf,MAAM,EAAE;wBACN,QAAQ,EAAE,KAAI,CAAC,EAAE;wBACjB,IAAI,EAAE,KAAI,CAAC,IAAI;qBAChB,MAEa,CAAC;YAEnB,KAAI,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,uBAAe,CAAC,KAAK,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzB,mBAAI,CAAC,GAAG,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,aAEP,mBAAmB,EAAE,IAAI,CAAC,SAAU,CAAC,QAAQ,EAAE,EAC/C,iBAAiB,EAAE,OAAO,CAAC,QAAQ,EAAE,EACrC,kBAAkB,EAAE,QAAQ,CAAC,QAAQ,EAAE,EACvC,iBAAiB,EAAE,IAAI,CAAC,OAAQ,EAChC,kBAAkB,EAAE,IAAI,CAAC,QAAQ,IAC9B,IAAA,6BAAqB,EAAC,IAAI,CAAC,UAAU,CAAC,GAE3C,SAAS,EACT;YACE,oBAAoB,EAAE,IAAI,CAAC,SAAS;YACpC,wBAAwB,EAAE,UAAC,OAAO;gBAChC,OAAO,CAAC,MAAM,GAAG;oBACf,EAAE,EAAE,KAAI,CAAC,EAAE;oBACX,IAAI,EAAE,KAAI,CAAC,IAAI;iBAChB,CAAC;gBAEF,OAAO,OAAO,CAAC;YACjB,CAAC;SACF,CACF,CAAC;IACJ,CAAC;IAED,6BAAQ,GAAR;QACE,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACH,iBAAC;AAAD,CAAC,AAnLD,CAAwC,kBAAU,GAmLjD;;AAED,SAAS,uBAAuB,CAC9B,IAA6B,EAC7B,2BAAkE;IAElE,OAAO,CACL,CAAA,2BAA2B,aAA3B,2BAA2B,uBAA3B,2BAA2B,CAAG,IAAI,CAAC;QACnC,CAAC,IAAI,CAAC,IAAI,KAAK,8BAAiB,CAAC,WAAW,IAAK,IAAI,CAAC,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC,CAC1G,CAAC;AACJ,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","sourcesContent":["import { type Config } from '../../config';\nimport { faro } from '../../sdk/registerFaro';\nimport { type TransportItem, TransportItemType, type Transports } from '../../transports';\nimport { dateNow, genShortID, Observable, stringifyObjectValues } from '../../utils';\nimport { ItemBuffer } from '../ItemBuffer';\nimport { type MeasurementEvent } from '../measurements';\nimport { type APIEvent } from '../types';\n\nimport { UserActionSeverity } from './const';\nimport { type HaltPredicate, type UserActionInterface, UserActionState } from './types';\n\nconst defaultFollowUpActionTimeRange = 100;\nconst defaultHaltTimeout = 10 * 1000;\n\nexport default class UserAction extends Observable implements UserActionInterface {\n  name: string;\n  id: string;\n  attributes?: Record<string, string>;\n  parentId: string;\n  trigger: string;\n  severity: UserActionSeverity;\n  startTime?: number;\n  trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;\n  cancelTimeout: number;\n  haltTimeout: number;\n\n  private _state: UserActionState;\n  private _timeoutId?: number;\n  private _itemBuffer: ItemBuffer<TransportItem>;\n  private _transports: Transports;\n  private _haltTimeoutId: any;\n  private _isValid: boolean;\n\n  constructor({\n    name,\n    parentId,\n    haltTimeout,\n    trigger,\n    transports,\n    attributes,\n    trackUserActionsExcludeItem,\n    severity = UserActionSeverity.Normal,\n  }: {\n    name: string;\n    transports: Transports;\n    parentId?: string;\n    trigger: string;\n    attributes?: Record<string, string>;\n    haltTimeout?: number;\n    trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;\n    severity?: UserActionSeverity;\n  }) {\n    super();\n    this.name = name;\n    this.attributes = attributes;\n    this.id = genShortID();\n    this.trigger = trigger;\n    this.cancelTimeout = defaultFollowUpActionTimeRange;\n    this.haltTimeout = haltTimeout ?? defaultHaltTimeout;\n    this.parentId = parentId ?? this.id;\n    this.trackUserActionsExcludeItem = trackUserActionsExcludeItem;\n    this.severity = severity;\n\n    this._itemBuffer = new ItemBuffer<TransportItem>();\n    this._transports = transports;\n    this._haltTimeoutId = -1;\n    this._state = UserActionState.Started;\n    this._isValid = false;\n    this._start();\n  }\n\n  addItem(item: TransportItem) {\n    this._itemBuffer.addItem(item);\n  }\n\n  extend(haltPredicate?: HaltPredicate) {\n    if (!this._isValid) {\n      this._isValid = true;\n    }\n    this._setFollowupActionTimeout(haltPredicate);\n  }\n\n  private _setFollowupActionTimeout(haltPredicate?: HaltPredicate) {\n    this._timeoutId = startTimeout(\n      this._timeoutId,\n      () => {\n        if (this._state === UserActionState.Started && haltPredicate?.()) {\n          this.halt();\n        } else if (this._isValid) {\n          this.end();\n        } else {\n          this.cancel();\n        }\n      },\n      defaultFollowUpActionTimeRange\n    );\n  }\n\n  private _start(): void {\n    this._state = UserActionState.Started;\n    if (this._state === UserActionState.Started) {\n      this.startTime = dateNow();\n    }\n    this._setFollowupActionTimeout();\n  }\n\n  halt() {\n    if (this._state !== UserActionState.Started) {\n      return;\n    }\n    this._state = UserActionState.Halted;\n\n    // If the halt timeout fires, we end the user action as\n    // it is still a valid one.\n    this._haltTimeoutId = setTimeout(() => {\n      this.end();\n    }, this.haltTimeout);\n    this.notify(this._state);\n  }\n\n  cancel() {\n    if (this._state === UserActionState.Started) {\n      // Empty the buffer\n      this._itemBuffer.flushBuffer();\n    }\n\n    this._state = UserActionState.Cancelled;\n    this.notify(this._state);\n  }\n\n  end() {\n    if (this._state === UserActionState.Cancelled) {\n      return;\n    }\n\n    // Make sure we don't end the user action twice\n    clearTimeout(this._haltTimeoutId);\n    clearTimeout(this._timeoutId);\n\n    const endTime = dateNow();\n    const duration = endTime - this.startTime!;\n    this._state = UserActionState.Ended;\n    this._itemBuffer.flushBuffer((item) => {\n      if (isExcludeFromUserAction(item, this.trackUserActionsExcludeItem)) {\n        this._transports.execute(item);\n        return;\n      }\n\n      const userActionItem = {\n        ...item,\n        payload: {\n          ...item.payload,\n          action: {\n            parentId: this.id,\n            name: this.name,\n          },\n        },\n      } as TransportItem;\n\n      this._transports.execute(userActionItem);\n    });\n\n    this._state = UserActionState.Ended;\n    this.notify(this._state);\n\n    faro.api.pushEvent(\n      this.name,\n      {\n        userActionStartTime: this.startTime!.toString(),\n        userActionEndTime: endTime.toString(),\n        userActionDuration: duration.toString(),\n        userActionTrigger: this.trigger!,\n        userActionSeverity: this.severity,\n        ...stringifyObjectValues(this.attributes),\n      },\n      undefined,\n      {\n        timestampOverwriteMs: this.startTime,\n        customPayloadTransformer: (payload) => {\n          payload.action = {\n            id: this.id,\n            name: this.name,\n          };\n\n          return payload;\n        },\n      }\n    );\n  }\n\n  getState(): UserActionState {\n    return this._state;\n  }\n}\n\nfunction isExcludeFromUserAction(\n  item: TransportItem<APIEvent>,\n  trackUserActionsExcludeItem: Config['trackUserActionsExcludeItem']\n) {\n  return (\n    trackUserActionsExcludeItem?.(item) ||\n    (item.type === TransportItemType.MEASUREMENT && (item.payload as MeasurementEvent).type === 'web-vitals')\n  );\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"]}

package/dist/spec/core/src/api/userActions/userAction.test.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var globals_1 = require("@jest/globals");
+var __1 = require("../..");
+var apiTestHelpers_1 = require("../apiTestHelpers");
+var ItemBuffer_1 = require("../ItemBuffer");
+var types_1 = require("./types");
+var userAction_1 = __importDefault(require("./userAction"));
+globals_1.jest.useFakeTimers();
+globals_1.jest.mock('../../sdk/registerFaro', function () { return ({
+    faro: {
+        api: {
+            pushEvent: globals_1.jest.fn(),
+        },
+    },
+}); });
+describe('UserAction', function () {
+    var transports;
+    beforeEach(function () {
+        transports = apiTestHelpers_1.mockTransports;
+        globals_1.jest.spyOn(ItemBuffer_1.ItemBuffer.prototype, 'flushBuffer').mockImplementation(function (cb) {
+            if (cb) {
+                var dummyItem = { type: __1.TransportItemType.EVENT, payload: {}, meta: {} };
+                cb(dummyItem);
+            }
+        });
+    });
+    afterEach(function () {
+        globals_1.jest.clearAllMocks();
+        globals_1.jest.clearAllTimers();
+    });
+    it('initializes in Started state and sets startTime', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        expect(ua.getState()).toBe(types_1.UserActionState.Started);
+        expect(typeof ua.startTime).toBe('number');
+        expect(ua.startTime > 0).toBe(true);
+    });
+    it('cancel() flushes the buffer and goes to Cancelled', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        ua.cancel();
+        expect(ua.getState()).toBe(types_1.UserActionState.Cancelled);
+        expect(ItemBuffer_1.ItemBuffer.prototype.flushBuffer).toHaveBeenCalled();
+        expect(transports.execute).not.toHaveBeenCalled();
+    });
+    it('halt() is no-op if user action is not started', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        ua.cancel();
+        ua.halt();
+        expect(ua.getState()).toBe(types_1.UserActionState.Cancelled);
+    });
+    it('halt() will end() after halt timeoute time', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        ua.extend(function () { return true; });
+        globals_1.jest.advanceTimersByTime(ua.cancelTimeout);
+        expect(ua.getState()).toBe(types_1.UserActionState.Halted);
+        globals_1.jest.advanceTimersByTime(ua.haltTimeout);
+        expect(ua.getState()).toBe(types_1.UserActionState.Ended);
+    });
+    it('end() will not fire if action is cancelled', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        ua.cancel();
+        ua.end();
+        expect(ua.getState()).toBe(types_1.UserActionState.Cancelled);
+    });
+    it('end() will send items with action payload', function () {
+        var ua = new userAction_1.default({ name: 'foo', transports: transports, trigger: 'foo' });
+        ua.end();
+        expect(ua.getState()).toBe(types_1.UserActionState.Ended);
+        expect(transports.execute).not.toHaveBeenCalledWith('koko');
+    });
+});
+//# sourceMappingURL=userAction.test.js.map

package/dist/spec/core/src/api/userActions/userAction.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAction.test.js","sourceRoot":"","sources":["../../../../../../src/api/userActions/userAction.test.ts"],"names":[],"mappings":";;;;;AAAA,yCAAqC;AAErC,2BAA0E;AAC1E,oDAAmD;AACnD,4CAA2C;AAE3C,iCAA0C;AAC1C,4DAAsC;AAEtC,cAAI,CAAC,aAAa,EAAE,CAAC;AACrB,cAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,cAAM,OAAA,CAAC;IACzC,IAAI,EAAE;QACJ,GAAG,EAAE;YACH,SAAS,EAAE,cAAI,CAAC,EAAE,EAAE;SACrB;KACF;CACF,CAAC,EANwC,CAMxC,CAAC,CAAC;AAEJ,QAAQ,CAAC,YAAY,EAAE;IACrB,IAAI,UAAsB,CAAC;IAE3B,UAAU,CAAC;QACT,UAAU,GAAG,+BAAc,CAAC;QAE5B,cAAI,CAAC,KAAK,CAAC,uBAAU,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,kBAAkB,CAAC,UAAC,EAAkC;YACpG,IAAI,EAAE,EAAE,CAAC;gBACP,IAAM,SAAS,GAAG,EAAE,IAAI,EAAE,qBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;gBAC3E,EAAE,CAAC,SAAS,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC;QACR,cAAI,CAAC,aAAa,EAAE,CAAC;QACrB,cAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE;QACpD,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,CAAC,EAAE,CAAC,SAAU,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE;QACtD,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,EAAE,CAAC,MAAM,EAAE,CAAC;QAEZ,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,uBAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAC5D,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE;QAClD,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,EAAE,CAAC,MAAM,EAAE,CAAC;QACZ,EAAE,CAAC,IAAI,EAAE,CAAC;QAEV,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE;QAC/C,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,EAAE,CAAC,MAAM,CAAC,cAAM,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;QACtB,cAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;QAC3C,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,MAAM,CAAC,CAAC;QACnD,cAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE;QAC/C,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,EAAE,CAAC,MAAM,EAAE,CAAC;QACZ,EAAE,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE;QAC9C,IAAM,EAAE,GAAG,IAAI,oBAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,YAAA,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvE,EAAE,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { jest } from '@jest/globals';\n\nimport { type TransportItem, TransportItemType, Transports } from '../..';\nimport { mockTransports } from '../apiTestHelpers';\nimport { ItemBuffer } from '../ItemBuffer';\n\nimport { UserActionState } from './types';\nimport UserAction from './userAction';\n\njest.useFakeTimers();\njest.mock('../../sdk/registerFaro', () => ({\n  faro: {\n    api: {\n      pushEvent: jest.fn(),\n    },\n  },\n}));\n\ndescribe('UserAction', () => {\n  let transports: Transports;\n\n  beforeEach(() => {\n    transports = mockTransports;\n\n    jest.spyOn(ItemBuffer.prototype, 'flushBuffer').mockImplementation((cb?: (item: TransportItem) => void) => {\n      if (cb) {\n        const dummyItem = { type: TransportItemType.EVENT, payload: {}, meta: {} };\n        cb(dummyItem);\n      }\n    });\n  });\n\n  afterEach(() => {\n    jest.clearAllMocks();\n    jest.clearAllTimers();\n  });\n\n  it('initializes in Started state and sets startTime', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    expect(ua.getState()).toBe(UserActionState.Started);\n    expect(typeof ua.startTime).toBe('number');\n    expect(ua.startTime! > 0).toBe(true);\n  });\n\n  it('cancel() flushes the buffer and goes to Cancelled', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    ua.cancel();\n\n    expect(ua.getState()).toBe(UserActionState.Cancelled);\n    expect(ItemBuffer.prototype.flushBuffer).toHaveBeenCalled();\n    expect(transports.execute).not.toHaveBeenCalled();\n  });\n\n  it('halt() is no-op if user action is not started', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    ua.cancel();\n    ua.halt();\n\n    expect(ua.getState()).toBe(UserActionState.Cancelled);\n  });\n\n  it('halt() will end() after halt timeoute time', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    ua.extend(() => true);\n    jest.advanceTimersByTime(ua.cancelTimeout);\n    expect(ua.getState()).toBe(UserActionState.Halted);\n    jest.advanceTimersByTime(ua.haltTimeout);\n    expect(ua.getState()).toBe(UserActionState.Ended);\n  });\n\n  it('end() will not fire if action is cancelled', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    ua.cancel();\n    ua.end();\n    expect(ua.getState()).toBe(UserActionState.Cancelled);\n  });\n\n  it('end() will send items with action payload', () => {\n    const ua = new UserAction({ name: 'foo', transports, trigger: 'foo' });\n    ua.end();\n    expect(ua.getState()).toBe(UserActionState.Ended);\n    expect(transports.execute).not.toHaveBeenCalledWith('koko');\n  });\n});\n"]}

package/dist/spec/core/src/index.js

@@ -14,17 +14,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNull = exports.isMapDefined = exports.isMap = exports.isInt = exports.isInstanceOf = exports.isFunction = exports.isEventDefined = exports.isEvent = exports.isErrorEvent = exports.isErrorDefined = exports.isError = exports.isElementDefined = exports.isElement = exports.isDomException = exports.isDomError = exports.isBoolean = exports.isArray = exports.getCurrentTimestamp = exports.genShortID = exports.defaultLogLevel = exports.deepEqual = exports.createPromiseBuffer = exports.allLogLevels = exports.defaultUnpatchedConsole = exports.transportItemTypeToBodyKey = exports.TransportItemType = exports.getTransportBody = exports.BaseTransport = exports.setInternalFaroOnGlobalObject = exports.isInternalFaroOnGlobalObject = exports.internalGlobalObjectKey = exports.getInternalFaroFromGlobalObject = exports.faro = exports.InternalLoggerLevel = exports.defaultInternalLoggerLevel = exports.createInternalLogger = exports.BaseInstrumentation = exports.defaultGlobalObjectKey = exports.defaultBatchingConfig = exports.initializeFaro = exports.globalObject = exports.BaseExtension = exports.USER_ACTION_HALT = exports.USER_ACTION_START = exports.USER_ACTION_END = exports.USER_ACTION_CANCEL = exports.apiMessageBus = exports.defaultErrorArgsSerializer = exports.defaultLogArgsSerializer = exports.defaultExceptionType = void 0;
-exports.unknownString = exports.VERSION = exports.Observable = exports.stringifyObjectValues = exports.stringifyExternalJson = exports.getCircularDependencyReplacer = exports.isEmpty = exports.dateNow = exports.noop = exports.LogLevel = exports.isUndefined = exports.isTypeof = exports.isToString = exports.isThenable = exports.isSyntheticEvent = exports.isSymbol = exports.isString = exports.isRegExp = exports.isPrimitive = exports.isObject = exports.isNumber = void 0;
+exports.isObject = exports.isNumber = exports.isNull = exports.isMapDefined = exports.isMap = exports.isInt = exports.isInstanceOf = exports.isFunction = exports.isEventDefined = exports.isEvent = exports.isErrorEvent = exports.isErrorDefined = exports.isError = exports.isElementDefined = exports.isElement = exports.isDomException = exports.isDomError = exports.isBoolean = exports.isArray = exports.getCurrentTimestamp = exports.genShortID = exports.defaultLogLevel = exports.deepEqual = exports.createPromiseBuffer = exports.allLogLevels = exports.defaultUnpatchedConsole = exports.transportItemTypeToBodyKey = exports.TransportItemType = exports.getTransportBody = exports.BaseTransport = exports.setInternalFaroOnGlobalObject = exports.isInternalFaroOnGlobalObject = exports.internalGlobalObjectKey = exports.getInternalFaroFromGlobalObject = exports.faro = exports.InternalLoggerLevel = exports.defaultInternalLoggerLevel = exports.createInternalLogger = exports.BaseInstrumentation = exports.defaultGlobalObjectKey = exports.defaultBatchingConfig = exports.initializeFaro = exports.globalObject = exports.BaseExtension = exports.userActionsMessageBus = exports.UserActionState = exports.UserActionSeverity = exports.defaultErrorArgsSerializer = exports.defaultLogArgsSerializer = exports.defaultExceptionType = void 0;
+exports.unknownString = exports.VERSION = exports.Observable = exports.stringifyObjectValues = exports.stringifyExternalJson = exports.getCircularDependencyReplacer = exports.isEmpty = exports.dateNow = exports.noop = exports.LogLevel = exports.isUndefined = exports.isTypeof = exports.isToString = exports.isThenable = exports.isSyntheticEvent = exports.isSymbol = exports.isString = exports.isRegExp = exports.isPrimitive = void 0;
 var api_1 = require("./api");
 Object.defineProperty(exports, "defaultExceptionType", { enumerable: true, get: function () { return api_1.defaultExceptionType; } });
 Object.defineProperty(exports, "defaultLogArgsSerializer", { enumerable: true, get: function () { return api_1.defaultLogArgsSerializer; } });
 Object.defineProperty(exports, "defaultErrorArgsSerializer", { enumerable: true, get: function () { return api_1.defaultErrorArgsSerializer; } });
-Object.defineProperty(exports, "apiMessageBus", { enumerable: true, get: function () { return api_1.apiMessageBus; } });
-Object.defineProperty(exports, "USER_ACTION_CANCEL", { enumerable: true, get: function () { return api_1.USER_ACTION_CANCEL; } });
-Object.defineProperty(exports, "USER_ACTION_END", { enumerable: true, get: function () { return api_1.USER_ACTION_END; } });
-Object.defineProperty(exports, "USER_ACTION_START", { enumerable: true, get: function () { return api_1.USER_ACTION_START; } });
-Object.defineProperty(exports, "USER_ACTION_HALT", { enumerable: true, get: function () { return api_1.USER_ACTION_HALT; } });
+Object.defineProperty(exports, "UserActionSeverity", { enumerable: true, get: function () { return api_1.UserActionSeverity; } });
+Object.defineProperty(exports, "UserActionState", { enumerable: true, get: function () { return api_1.UserActionState; } });
+Object.defineProperty(exports, "userActionsMessageBus", { enumerable: true, get: function () { return api_1.userActionsMessageBus; } });
 var extensions_1 = require("./extensions");
 Object.defineProperty(exports, "BaseExtension", { enumerable: true, get: function () { return extensions_1.BaseExtension; } });
 var globalObject_1 = require("./globalObject");

package/dist/spec/core/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,6BASe;AARb,2GAAA,oBAAoB,OAAA;AACpB,+GAAA,wBAAwB,OAAA;AACxB,iHAAA,0BAA0B,OAAA;AAC1B,oGAAA,aAAa,OAAA;AACb,yGAAA,kBAAkB,OAAA;AAClB,sGAAA,eAAe,OAAA;AACf,wGAAA,iBAAiB,OAAA;AACjB,uGAAA,gBAAgB,OAAA;AAsClB,2CAA6C;AAApC,2GAAA,aAAa,OAAA;AAGtB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AAGrB,2CAA8C;AAArC,4GAAA,cAAc,OAAA;AAEvB,mCAAyE;AAAhE,+GAAA,qBAAqB,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AAGtD,uDAAyD;AAAhD,uHAAA,mBAAmB,OAAA;AAG5B,mDAAyG;AAAhG,sHAAA,oBAAoB,OAAA;AAAE,4HAAA,0BAA0B,OAAA;AAAE,qHAAA,mBAAmB,OAAA;AAoB9E,6BAMe;AALb,2FAAA,IAAI,OAAA;AACJ,sHAAA,+BAA+B,OAAA;AAC/B,8GAAA,uBAAuB,OAAA;AACvB,mHAAA,4BAA4B,OAAA;AAC5B,oHAAA,6BAA6B,OAAA;AAI/B,6CAA2B;AAE3B,2CAA8G;AAArG,2GAAA,aAAa,OAAA;AAAE,8GAAA,gBAAgB,OAAA;AAAE,+GAAA,iBAAiB,OAAA;AAAE,wHAAA,0BAA0B,OAAA;AAWvF,uDAA6D;AAApD,2HAAA,uBAAuB,OAAA;AAGhC,iCA2CiB;AA1Cf,qGAAA,YAAY,OAAA;AACZ,4GAAA,mBAAmB,OAAA;AACnB,kGAAA,SAAS,OAAA;AACT,wGAAA,eAAe,OAAA;AACf,mGAAA,UAAU,OAAA;AACV,4GAAA,mBAAmB,OAAA;AACnB,gGAAA,OAAO,OAAA;AACP,kGAAA,SAAS,OAAA;AACT,mGAAA,UAAU,OAAA;AACV,uGAAA,cAAc,OAAA;AACd,kGAAA,SAAS,OAAA;AACT,yGAAA,gBAAgB,OAAA;AAChB,gGAAA,OAAO,OAAA;AACP,uGAAA,cAAc,OAAA;AACd,qGAAA,YAAY,OAAA;AACZ,gGAAA,OAAO,OAAA;AACP,uGAAA,cAAc,OAAA;AACd,mGAAA,UAAU,OAAA;AACV,qGAAA,YAAY,OAAA;AACZ,8FAAA,KAAK,OAAA;AACL,8FAAA,KAAK,OAAA;AACL,qGAAA,YAAY,OAAA;AACZ,+FAAA,MAAM,OAAA;AACN,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,yGAAA,gBAAgB,OAAA;AAChB,mGAAA,UAAU,OAAA;AACV,mGAAA,UAAU,OAAA;AACV,iGAAA,QAAQ,OAAA;AACR,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,6FAAA,IAAI,OAAA;AACJ,gGAAA,OAAO,OAAA;AACP,gGAAA,OAAO,OAAA;AACP,sHAAA,6BAA6B,OAAA;AAC7B,8GAAA,qBAAqB,OAAA;AACrB,8GAAA,qBAAqB,OAAA;AACrB,mGAAA,UAAU,OAAA;AAcZ,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAEhB,mCAAyC;AAAhC,uGAAA,aAAa,OAAA","sourcesContent":["export {\n  defaultExceptionType,\n  defaultLogArgsSerializer,\n  defaultErrorArgsSerializer,\n  apiMessageBus,\n  USER_ACTION_CANCEL,\n  USER_ACTION_END,\n  USER_ACTION_START,\n  USER_ACTION_HALT,\n} from './api';\nexport type {\n  API,\n  APIEvent,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionEventExtended,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  LogArgsSerializer,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  MetaAPI,\n  OTELApi,\n  PushErrorOptions,\n  PushEventOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  ApiMessageBusMessages,\n  UserActionStartMessage,\n  UserActionEndMessage,\n  UserActionCancelMessage,\n  UserActionHaltMessage,\n  UserAction,\n} from './api';\n\nexport { BaseExtension } from './extensions';\nexport type { Extension } from './extensions';\n\nexport { globalObject } from './globalObject';\nexport type { GlobalObject } from './globalObject';\n\nexport { initializeFaro } from './initialize';\n\nexport { defaultBatchingConfig, defaultGlobalObjectKey } from './config';\nexport type { Config, Patterns } from './config';\n\nexport { BaseInstrumentation } from './instrumentations';\nexport type { Instrumentation, Instrumentations } from './instrumentations';\n\nexport { createInternalLogger, defaultInternalLoggerLevel, InternalLoggerLevel } from './internalLogger';\nexport type { InternalLogger } from './internalLogger';\n\nexport type {\n  Meta,\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  MetaOverrides,\n} from './metas';\n\nexport {\n  faro,\n  getInternalFaroFromGlobalObject,\n  internalGlobalObjectKey,\n  isInternalFaroOnGlobalObject,\n  setInternalFaroOnGlobalObject,\n} from './sdk';\nexport type { Faro } from './sdk';\n\nexport * from './semantic';\n\nexport { BaseTransport, getTransportBody, TransportItemType, transportItemTypeToBodyKey } from './transports';\nexport type {\n  BeforeSendHook,\n  SendFn,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n} from './transports';\n\nexport { defaultUnpatchedConsole } from './unpatchedConsole';\nexport type { UnpatchedConsole } from './unpatchedConsole';\n\nexport {\n  allLogLevels,\n  createPromiseBuffer,\n  deepEqual,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\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  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  LogLevel,\n  noop,\n  dateNow,\n  isEmpty,\n  getCircularDependencyReplacer,\n  stringifyExternalJson,\n  stringifyObjectValues,\n  Observable,\n} from './utils';\nexport type {\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BufferItem,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  Subscription,\n} from './utils';\n\nexport { VERSION } from './version';\n\nexport { unknownString } from './consts';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,6BAOe;AANb,2GAAA,oBAAoB,OAAA;AACpB,+GAAA,wBAAwB,OAAA;AACxB,iHAAA,0BAA0B,OAAA;AAC1B,yGAAA,kBAAkB,OAAA;AAClB,sGAAA,eAAe,OAAA;AACf,4GAAA,qBAAqB,OAAA;AAkCvB,2CAA6C;AAApC,2GAAA,aAAa,OAAA;AAGtB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AAGrB,2CAA8C;AAArC,4GAAA,cAAc,OAAA;AAEvB,mCAAyE;AAAhE,+GAAA,qBAAqB,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AAGtD,uDAAyD;AAAhD,uHAAA,mBAAmB,OAAA;AAG5B,mDAAyG;AAAhG,sHAAA,oBAAoB,OAAA;AAAE,4HAAA,0BAA0B,OAAA;AAAE,qHAAA,mBAAmB,OAAA;AAoB9E,6BAMe;AALb,2FAAA,IAAI,OAAA;AACJ,sHAAA,+BAA+B,OAAA;AAC/B,8GAAA,uBAAuB,OAAA;AACvB,mHAAA,4BAA4B,OAAA;AAC5B,oHAAA,6BAA6B,OAAA;AAI/B,6CAA2B;AAE3B,2CAA8G;AAArG,2GAAA,aAAa,OAAA;AAAE,8GAAA,gBAAgB,OAAA;AAAE,+GAAA,iBAAiB,OAAA;AAAE,wHAAA,0BAA0B,OAAA;AAWvF,uDAA6D;AAApD,2HAAA,uBAAuB,OAAA;AAGhC,iCA2CiB;AA1Cf,qGAAA,YAAY,OAAA;AACZ,4GAAA,mBAAmB,OAAA;AACnB,kGAAA,SAAS,OAAA;AACT,wGAAA,eAAe,OAAA;AACf,mGAAA,UAAU,OAAA;AACV,4GAAA,mBAAmB,OAAA;AACnB,gGAAA,OAAO,OAAA;AACP,kGAAA,SAAS,OAAA;AACT,mGAAA,UAAU,OAAA;AACV,uGAAA,cAAc,OAAA;AACd,kGAAA,SAAS,OAAA;AACT,yGAAA,gBAAgB,OAAA;AAChB,gGAAA,OAAO,OAAA;AACP,uGAAA,cAAc,OAAA;AACd,qGAAA,YAAY,OAAA;AACZ,gGAAA,OAAO,OAAA;AACP,uGAAA,cAAc,OAAA;AACd,mGAAA,UAAU,OAAA;AACV,qGAAA,YAAY,OAAA;AACZ,8FAAA,KAAK,OAAA;AACL,8FAAA,KAAK,OAAA;AACL,qGAAA,YAAY,OAAA;AACZ,+FAAA,MAAM,OAAA;AACN,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,iGAAA,QAAQ,OAAA;AACR,yGAAA,gBAAgB,OAAA;AAChB,mGAAA,UAAU,OAAA;AACV,mGAAA,UAAU,OAAA;AACV,iGAAA,QAAQ,OAAA;AACR,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,6FAAA,IAAI,OAAA;AACJ,gGAAA,OAAO,OAAA;AACP,gGAAA,OAAO,OAAA;AACP,sHAAA,6BAA6B,OAAA;AAC7B,8GAAA,qBAAqB,OAAA;AACrB,8GAAA,qBAAqB,OAAA;AACrB,mGAAA,UAAU,OAAA;AAcZ,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAEhB,mCAAyC;AAAhC,uGAAA,aAAa,OAAA","sourcesContent":["export {\n  defaultExceptionType,\n  defaultLogArgsSerializer,\n  defaultErrorArgsSerializer,\n  UserActionSeverity,\n  UserActionState,\n  userActionsMessageBus,\n} from './api';\nexport type {\n  API,\n  APIEvent,\n  EventAttributes,\n  EventEvent,\n  EventsAPI,\n  ExceptionEvent,\n  ExceptionEventExtended,\n  ExceptionStackFrame,\n  ExceptionsAPI,\n  ExtendedError,\n  LogArgsSerializer,\n  LogContext,\n  LogEvent,\n  LogsAPI,\n  MeasurementEvent,\n  MeasurementsAPI,\n  MetaAPI,\n  OTELApi,\n  PushErrorOptions,\n  PushEventOptions,\n  PushLogOptions,\n  PushMeasurementOptions,\n  Stacktrace,\n  StacktraceParser,\n  TraceContext,\n  TraceEvent,\n  TracesAPI,\n  UserAction,\n  UserActionInterface,\n} from './api';\n\nexport { BaseExtension } from './extensions';\nexport type { Extension } from './extensions';\n\nexport { globalObject } from './globalObject';\nexport type { GlobalObject } from './globalObject';\n\nexport { initializeFaro } from './initialize';\n\nexport { defaultBatchingConfig, defaultGlobalObjectKey } from './config';\nexport type { Config, Patterns } from './config';\n\nexport { BaseInstrumentation } from './instrumentations';\nexport type { Instrumentation, Instrumentations } from './instrumentations';\n\nexport { createInternalLogger, defaultInternalLoggerLevel, InternalLoggerLevel } from './internalLogger';\nexport type { InternalLogger } from './internalLogger';\n\nexport type {\n  Meta,\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  MetaOverrides,\n} from './metas';\n\nexport {\n  faro,\n  getInternalFaroFromGlobalObject,\n  internalGlobalObjectKey,\n  isInternalFaroOnGlobalObject,\n  setInternalFaroOnGlobalObject,\n} from './sdk';\nexport type { Faro } from './sdk';\n\nexport * from './semantic';\n\nexport { BaseTransport, getTransportBody, TransportItemType, transportItemTypeToBodyKey } from './transports';\nexport type {\n  BeforeSendHook,\n  SendFn,\n  Transport,\n  TransportBody,\n  TransportItem,\n  TransportItemPayload,\n  Transports,\n} from './transports';\n\nexport { defaultUnpatchedConsole } from './unpatchedConsole';\nexport type { UnpatchedConsole } from './unpatchedConsole';\n\nexport {\n  allLogLevels,\n  createPromiseBuffer,\n  deepEqual,\n  defaultLogLevel,\n  genShortID,\n  getCurrentTimestamp,\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  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  LogLevel,\n  noop,\n  dateNow,\n  isEmpty,\n  getCircularDependencyReplacer,\n  stringifyExternalJson,\n  stringifyObjectValues,\n  Observable,\n} from './utils';\nexport type {\n  BaseObject,\n  BaseObjectKey,\n  BaseObjectPrimitiveValue,\n  BaseObjectValue,\n  BufferItem,\n  PromiseBuffer,\n  PromiseBufferOptions,\n  PromiseProducer,\n  Subscription,\n} from './utils';\n\nexport { VERSION } from './version';\n\nexport { unknownString } from './consts';\n"]}

package/dist/spec/core/src/semantic.js

@@ -1,20 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVENT_ROUTE_CHANGE = exports.EVENT_OVERRIDES_SERVICE_NAME = exports.EVENT_SESSION_EXTEND = exports.EVENT_SESSION_RESUME = exports.EVENT_SESSION_START = exports.EVENT_VIEW_CHANGED = exports.EVENT_NAVIGATION = exports.EVENT_CLICK = exports.Conventions = void 0;
-/**
- * @deprecated The conventions object will be removed in a future version
- */
-exports.Conventions = {
-    /**
-     * @deprecated The event names object will be removed in a future version
-     */
-    EventNames: {
-        CLICK: 'click',
-        NAVIGATION: 'navigation',
-        SESSION_START: 'session_start',
-        VIEW_CHANGED: 'view_changed',
-    },
-};
+exports.EVENT_ROUTE_CHANGE = exports.EVENT_OVERRIDES_SERVICE_NAME = exports.EVENT_SESSION_EXTEND = exports.EVENT_SESSION_RESUME = exports.EVENT_SESSION_START = exports.EVENT_VIEW_CHANGED = exports.EVENT_NAVIGATION = exports.EVENT_CLICK = void 0;
 exports.EVENT_CLICK = 'click';
 exports.EVENT_NAVIGATION = 'navigation';
 exports.EVENT_VIEW_CHANGED = 'view_changed';

package/dist/spec/core/src/semantic.js.map

@@ -1 +1 @@
-{"version":3,"file":"semantic.js","sourceRoot":"","sources":["../../../../src/semantic.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB;;OAEG;IACH,UAAU,EAAE;QACV,KAAK,EAAE,OAAO;QACd,UAAU,EAAE,YAAY;QACxB,aAAa,EAAE,eAAe;QAC9B,YAAY,EAAE,cAAc;KAC7B;CACO,CAAC;AAEE,QAAA,WAAW,GAAG,OAAO,CAAC;AACtB,QAAA,gBAAgB,GAAG,YAAY,CAAC;AAChC,QAAA,kBAAkB,GAAG,cAAc,CAAC;AACpC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AACtC,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AACxC,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AACxC,QAAA,4BAA4B,GAAG,uBAAuB,CAAC;AACvD,QAAA,kBAAkB,GAAG,cAAc,CAAC","sourcesContent":["/**\n * @deprecated The conventions object will be removed in a future version\n */\nexport const Conventions = {\n  /**\n   * @deprecated The event names object will be removed in a future version\n   */\n  EventNames: {\n    CLICK: 'click',\n    NAVIGATION: 'navigation',\n    SESSION_START: 'session_start',\n    VIEW_CHANGED: 'view_changed',\n  },\n} as const;\n\nexport const EVENT_CLICK = 'click';\nexport const EVENT_NAVIGATION = 'navigation';\nexport const EVENT_VIEW_CHANGED = 'view_changed';\nexport const EVENT_SESSION_START = 'session_start';\nexport const EVENT_SESSION_RESUME = 'session_resume';\nexport const EVENT_SESSION_EXTEND = 'session_extend';\nexport const EVENT_OVERRIDES_SERVICE_NAME = 'service_name_override';\nexport const EVENT_ROUTE_CHANGE = 'route_change';\n"]}
+{"version":3,"file":"semantic.js","sourceRoot":"","sources":["../../../../src/semantic.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,OAAO,CAAC;AACtB,QAAA,gBAAgB,GAAG,YAAY,CAAC;AAChC,QAAA,kBAAkB,GAAG,cAAc,CAAC;AACpC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AACtC,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AACxC,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AACxC,QAAA,4BAA4B,GAAG,uBAAuB,CAAC;AACvD,QAAA,kBAAkB,GAAG,cAAc,CAAC","sourcesContent":["export const EVENT_CLICK = 'click';\nexport const EVENT_NAVIGATION = 'navigation';\nexport const EVENT_VIEW_CHANGED = 'view_changed';\nexport const EVENT_SESSION_START = 'session_start';\nexport const EVENT_SESSION_RESUME = 'session_resume';\nexport const EVENT_SESSION_EXTEND = 'session_extend';\nexport const EVENT_OVERRIDES_SERVICE_NAME = 'service_name_override';\nexport const EVENT_ROUTE_CHANGE = 'route_change';\n"]}

package/dist/spec/core/src/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // auto-generated by bin/genVersion.ts
-exports.VERSION = '1.19.0';
+exports.VERSION = '2.0.0-beta-2';
 //# sourceMappingURL=version.js.map

package/dist/spec/core/src/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../src/version.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACzB,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["// auto-generated by bin/genVersion.ts\nexport const VERSION = '1.19.0';\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../src/version.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACzB,QAAA,OAAO,GAAG,cAAc,CAAC","sourcesContent":["// auto-generated by bin/genVersion.ts\nexport const VERSION = '2.0.0-beta-2';\n"]}

package/dist/types/api/apiTestHelpers.d.ts

@@ -1,5 +1,6 @@
 import type { Transports } from '../transports';
 import type { TracesAPI } from './traces/types';
+import type { UserActionsAPI } from './userActions/types';
 export declare const mockMetas: {
     add: jest.Mock<any, any, any>;
     remove: jest.Mock<any, any, any>;
@@ -9,3 +10,4 @@ export declare const mockMetas: {
 };
 export declare const mockTransports: Transports;
 export declare const mockTracesApi: TracesAPI;
+export declare const mockUserActionsApi: UserActionsAPI;

package/dist/types/api/events/initialize.d.ts

@@ -1,19 +1,17 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { TransportItem, Transports } from '../../transports';
+import type { Transports } from '../../transports';
 import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { ItemBuffer } from '../ItemBuffer';
 import type { TracesAPI } from '../traces';
-import type { ApiMessageBusMessages } from '../types';
+import type { UserActionsAPI } from '../userActions';
 import type { EventsAPI } from './types';
-export declare function initializeEventsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+export declare function initializeEventsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
     unpatchedConsole: UnpatchedConsole;
     internalLogger: InternalLogger;
     config: Config;
     metas: Metas;
     transports: Transports;
     tracesApi: TracesAPI;
-    actionBuffer: ItemBuffer<TransportItem>;
-    getMessage: () => ApiMessageBusMessages | undefined;
+    userActionsApi: UserActionsAPI;
 }): EventsAPI;

package/dist/types/api/exceptions/initialize.d.ts

@@ -1,19 +1,17 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { TransportItem, Transports } from '../../transports';
+import type { Transports } from '../../transports';
 import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { ItemBuffer } from '../ItemBuffer';
 import type { TracesAPI } from '../traces';
-import type { ApiMessageBusMessages } from '../types';
+import type { UserActionsAPI } from '../userActions';
 import type { ExceptionsAPI } from './types';
-export declare function initializeExceptionsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+export declare function initializeExceptionsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
     unpatchedConsole: UnpatchedConsole;
     internalLogger: InternalLogger;
     config: Config;
     metas: Metas;
     transports: Transports;
     tracesApi: TracesAPI;
-    actionBuffer: ItemBuffer<TransportItem>;
-    getMessage: () => ApiMessageBusMessages | undefined;
+    userActionsApi: UserActionsAPI;
 }): ExceptionsAPI;

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

@@ -1,5 +1,5 @@
 export { initializeAPI } from './initialize';
-export type { API, APIEvent, ApiMessageBusMessages, UserActionCancelMessage, UserActionEndMessage, UserActionStartMessage, UserActionHaltMessage, UserAction, } from './types';
+export type { API, APIEvent, UserAction } from './types';
 export type { EventAttributes, EventEvent, EventsAPI, PushEventOptions } from './events';
 export { defaultExceptionType, defaultErrorArgsSerializer } from './exceptions';
 export type { ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, PushErrorOptions, Stacktrace, StacktraceParser, ExceptionEventExtended, } from './exceptions';
@@ -7,6 +7,5 @@ export { defaultLogArgsSerializer } from './logs';
 export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions } from './logs';
 export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from './measurements';
 export type { MetaAPI } from './meta';
+export { UserActionSeverity, UserActionState, type UserActionInterface, type UserActionsAPI, userActionsMessageBus, } from './userActions';
 export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './traces';
-export { apiMessageBus } from './initialize';
-export { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_START, USER_ACTION_HALT } from './const';

package/dist/types/api/initialize.d.ts

@@ -3,7 +3,5 @@ import type { InternalLogger } from '../internalLogger';
 import type { Metas } from '../metas';
 import type { Transports } from '../transports';
 import type { UnpatchedConsole } from '../unpatchedConsole';
-import { Observable } from '../utils';
-import type { API, ApiMessageBusMessages } from './types';
-export declare const apiMessageBus: Observable<ApiMessageBusMessages>;
+import type { API } from './types';
 export declare function initializeAPI(unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas, transports: Transports): API;

package/dist/types/api/logs/initialize.d.ts

@@ -1,19 +1,17 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { TransportItem, Transports } from '../../transports';
+import type { Transports } from '../../transports';
 import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { ItemBuffer } from '../ItemBuffer';
 import type { TracesAPI } from '../traces';
-import type { ApiMessageBusMessages } from '../types';
+import type { UserActionsAPI } from '../userActions';
 import type { LogsAPI } from './types';
-export declare function initializeLogsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+export declare function initializeLogsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
     unpatchedConsole: UnpatchedConsole;
     internalLogger: InternalLogger;
     config: Config;
     metas: Metas;
     transports: Transports;
     tracesApi: TracesAPI;
-    actionBuffer: ItemBuffer<TransportItem>;
-    getMessage: () => ApiMessageBusMessages | undefined;
+    userActionsApi: UserActionsAPI;
 }): LogsAPI;

package/dist/types/api/measurements/initialize.d.ts

@@ -1,19 +1,17 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { TransportItem, Transports } from '../../transports';
+import type { Transports } from '../../transports';
 import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { ItemBuffer } from '../ItemBuffer';
 import type { TracesAPI } from '../traces';
-import type { ApiMessageBusMessages } from '../types';
+import type { UserActionsAPI } from '../userActions';
 import type { MeasurementsAPI } from './types';
-export declare function initializeMeasurementsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+export declare function initializeMeasurementsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
     unpatchedConsole: UnpatchedConsole;
     internalLogger: InternalLogger;
     config: Config;
     metas: Metas;
     transports: Transports;
     tracesApi: TracesAPI;
-    actionBuffer: ItemBuffer<TransportItem>;
-    getMessage: () => ApiMessageBusMessages | undefined;
+    userActionsApi: UserActionsAPI;
 }): MeasurementsAPI;

package/dist/types/api/meta/initialize.d.ts

@@ -1,11 +1,9 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { TransportItem, Transports } from '../../transports';
+import type { Transports } from '../../transports';
 import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { ItemBuffer } from '../ItemBuffer';
 import type { TracesAPI } from '../traces';
-import type { ApiMessageBusMessages } from '../types';
 import type { MetaAPI } from './types';
 export declare function initializeMetaAPI({ internalLogger, metas, }: {
     unpatchedConsole: UnpatchedConsole;
@@ -14,6 +12,4 @@ export declare function initializeMetaAPI({ internalLogger, metas, }: {
     metas: Metas;
     transports: Transports;
     tracesApi: TracesAPI;
-    actionBuffer: ItemBuffer<TransportItem>;
-    getMessage: () => ApiMessageBusMessages | undefined;
 }): MetaAPI;

package/dist/types/api/types.d.ts

@@ -1,55 +1,14 @@
-import type { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START } from './const';
 import type { EventEvent, EventsAPI } from './events';
 import type { ExceptionEvent, ExceptionsAPI } from './exceptions';
 import type { LogEvent, LogsAPI } from './logs';
 import type { MeasurementEvent, MeasurementsAPI } from './measurements';
 import type { MetaAPI } from './meta';
 import type { TraceEvent, TracesAPI } from './traces';
-export type APIEvent = LogEvent | ExceptionEvent | MeasurementEvent | TraceEvent | EventEvent;
-export type API = LogsAPI & ExceptionsAPI & MeasurementsAPI & TracesAPI & MetaAPI & EventsAPI;
-export type ApiMessageBusMessages = UserActionStartMessage | UserActionEndMessage | UserActionCancelMessage | UserActionHaltMessage;
-export type UserActionMessageType = typeof USER_ACTION_START | typeof USER_ACTION_END | typeof USER_ACTION_CANCEL | typeof USER_ACTION_HALT;
-export type UserActionStartMessage = {
-    type: typeof USER_ACTION_START;
-    name: string;
-    startTime: number;
-    /**
-     * Unique identifier of the parent user action to which this action belongs.
-     */
-    parentId: string;
-};
-export type UserActionEndMessage = {
-    type: typeof USER_ACTION_END;
-    name: string;
-    startTime: number;
-    endTime: number;
-    duration: number;
-    eventType: string;
-    /**
-     * Unique identifier for the user action. Will be undefined for messages related to child actions.
-     */
-    id: string;
-};
-export type UserActionCancelMessage = {
-    type: typeof USER_ACTION_CANCEL;
-    name: string;
-    /**
-     * Unique identifier of the parent user action to which this action belongs.
-     */
-    parentId?: string;
-};
-export type UserActionHaltMessage = {
-    type: typeof USER_ACTION_HALT;
-    name: string;
-    reason: 'pending-requests';
-    haltTime: number;
-    /**
-     * Unique identifier of the parent user action to which this action belongs.
-     */
-    parentId?: string;
-};
+import type { UserActionsAPI } from './userActions';
 export type UserAction = {
     name: string;
     id?: string;
     parentId?: string;
 };
+export type APIEvent = LogEvent | ExceptionEvent | MeasurementEvent | TraceEvent | EventEvent;
+export type API = LogsAPI & ExceptionsAPI & MeasurementsAPI & TracesAPI & MetaAPI & EventsAPI & UserActionsAPI;

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

@@ -0,0 +1,6 @@
+export declare const userActionStartByApiCallEventName = "faroApiCall";
+export declare const userActionStart = "user_action_start";
+export declare enum UserActionSeverity {
+    Normal = "normal",
+    Critical = "critical"
+}

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

@@ -0,0 +1,3 @@
+export { type UserActionsAPI, UserActionState, type UserActionInterface } from './types';
+export { UserActionSeverity } from './const';
+export { initializeUserActionsAPI, userActionsMessageBus } from './initialize';

package/dist/types/api/userActions/initialize.d.ts

@@ -0,0 +1,10 @@
+import { type InternalLogger, type Transports } from '../..';
+import type { Config } from '../../config';
+import { Observable } from '../../utils/reactive';
+import { type UserActionsAPI } from './types';
+export declare const userActionsMessageBus: Observable<import("./types").UserActionStart>;
+export declare function initializeUserActionsAPI({ transports, internalLogger, config, }: {
+    transports: Transports;
+    config: Config;
+    internalLogger: InternalLogger;
+}): UserActionsAPI;