@grafana/faro-core 1.19.0 → 2.0.0-beta

package/dist/esm/api/const.js

@@ -1,5 +0,0 @@
-export const USER_ACTION_START = 'user-action-start';
-export const USER_ACTION_END = 'user-action-end';
-export const USER_ACTION_CANCEL = 'user-action-cancel';
-export const USER_ACTION_HALT = 'user-action-halt';
-//# sourceMappingURL=const.js.map

package/dist/esm/api/const.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../src/api/const.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,CAAC;AACjD,MAAM,CAAC,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AACvD,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC","sourcesContent":["export const USER_ACTION_START = 'user-action-start';\nexport const USER_ACTION_END = 'user-action-end';\nexport const USER_ACTION_CANCEL = 'user-action-cancel';\nexport const USER_ACTION_HALT = 'user-action-halt';\n"]}

package/dist/esm/api/userActionLifecycleHandler.js

@@ -1,43 +0,0 @@
-import { TransportItemType } from '../transports';
-import { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START } from './const';
-import { ItemBuffer } from './ItemBuffer';
-export function createUserActionLifecycleHandler({ apiMessageBus, transports, config, }) {
-    const actionBuffer = new ItemBuffer();
-    const trackUserActionsExcludeItem = config.trackUserActionsExcludeItem;
-    let message;
-    apiMessageBus.subscribe((msg) => {
-        if (USER_ACTION_START === msg.type || USER_ACTION_HALT === msg.type) {
-            message = msg;
-            return;
-        }
-        if (msg.type === USER_ACTION_END) {
-            const { id, name } = msg;
-            actionBuffer.flushBuffer((item) => {
-                if (isExcludeFromUserAction(item, trackUserActionsExcludeItem)) {
-                    transports.execute(item);
-                    return;
-                }
-                const userActionItem = Object.assign(Object.assign({}, item), { payload: Object.assign(Object.assign({}, item.payload), { action: {
-                            parentId: id,
-                            name,
-                        } }) });
-                transports.execute(userActionItem);
-            });
-            message = undefined;
-            return;
-        }
-        if (msg.type === USER_ACTION_CANCEL) {
-            message = undefined;
-            actionBuffer.flushBuffer((item) => {
-                transports.execute(item);
-            });
-        }
-    });
-    const getMessage = () => message;
-    return { actionBuffer, getMessage };
-}
-function isExcludeFromUserAction(item, trackUserActionsExcludeItem) {
-    return ((trackUserActionsExcludeItem === null || trackUserActionsExcludeItem === void 0 ? void 0 : trackUserActionsExcludeItem(item)) ||
-        (item.type === TransportItemType.MEASUREMENT && item.payload.type === 'web-vitals'));
-}
-//# sourceMappingURL=userActionLifecycleHandler.js.map

package/dist/esm/api/userActionLifecycleHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userActionLifecycleHandler.js","sourceRoot":"","sources":["../../../src/api/userActionLifecycleHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,iBAAiB,EAAmB,MAAM,eAAe,CAAC;AAGvF,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACnG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C,MAAM,UAAU,gCAAgC,CAAC,EAC/C,aAAa,EACb,UAAU,EACV,MAAM,GAKP;IACC,MAAM,YAAY,GAAG,IAAI,UAAU,EAAiB,CAAC;IACrD,MAAM,2BAA2B,GAAG,MAAM,CAAC,2BAA2B,CAAC;IACvE,IAAI,OAA0C,CAAC;IAE/C,aAAa,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9B,IAAI,iBAAiB,KAAK,GAAG,CAAC,IAAI,IAAI,gBAAgB,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;YACpE,OAAO,GAAG,GAAG,CAAC;YACd,OAAO;QACT,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YACjC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;YAEzB,YAAY,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,IAAI,uBAAuB,CAAC,IAAI,EAAE,2BAA2B,CAAC,EAAE,CAAC;oBAC/D,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACzB,OAAO;gBACT,CAAC;gBAED,MAAM,cAAc,GAAG,gCAClB,IAAI,KACP,OAAO,kCACF,IAAI,CAAC,OAAO,KACf,MAAM,EAAE;4BACN,QAAQ,EAAE,EAAE;4BACZ,IAAI;yBACL,MAEa,CAAC;gBAEnB,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YAEH,OAAO,GAAG,SAAS,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACpC,OAAO,GAAG,SAAS,CAAC;YACpB,YAAY,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,GAAmB,EAAE,CAAC,OAAO,CAAC;IACjD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AACtC,CAAC;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,iBAAiB,CAAC,WAAW,IAAK,IAAI,CAAC,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC,CAC1G,CAAC;AACJ,CAAC","sourcesContent":["import type { Config } from '../config';\nimport { type TransportItem, TransportItemType, type Transports } from '../transports';\nimport type { Observable } from '../utils';\n\nimport { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START } from './const';\nimport { ItemBuffer } from './ItemBuffer';\nimport type { MeasurementEvent } from './measurements';\nimport type { APIEvent, ApiMessageBusMessages } from './types';\n\nexport function createUserActionLifecycleHandler({\n  apiMessageBus,\n  transports,\n  config,\n}: {\n  apiMessageBus: Observable<ApiMessageBusMessages>;\n  transports: Transports;\n  config: Config;\n}) {\n  const actionBuffer = new ItemBuffer<TransportItem>();\n  const trackUserActionsExcludeItem = config.trackUserActionsExcludeItem;\n  let message: ApiMessageBusMessages | undefined;\n\n  apiMessageBus.subscribe((msg) => {\n    if (USER_ACTION_START === msg.type || USER_ACTION_HALT === msg.type) {\n      message = msg;\n      return;\n    }\n\n    if (msg.type === USER_ACTION_END) {\n      const { id, name } = msg;\n\n      actionBuffer.flushBuffer((item) => {\n        if (isExcludeFromUserAction(item, trackUserActionsExcludeItem)) {\n          transports.execute(item);\n          return;\n        }\n\n        const userActionItem = {\n          ...item,\n          payload: {\n            ...item.payload,\n            action: {\n              parentId: id,\n              name,\n            },\n          },\n        } as TransportItem;\n\n        transports.execute(userActionItem);\n      });\n\n      message = undefined;\n      return;\n    }\n\n    if (msg.type === USER_ACTION_CANCEL) {\n      message = undefined;\n      actionBuffer.flushBuffer((item) => {\n        transports.execute(item);\n      });\n    }\n  });\n\n  const getMessage = (): typeof message => message;\n  return { actionBuffer, getMessage };\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"]}

package/dist/spec/core/src/api/const.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_ACTION_HALT = exports.USER_ACTION_CANCEL = exports.USER_ACTION_END = exports.USER_ACTION_START = void 0;
-exports.USER_ACTION_START = 'user-action-start';
-exports.USER_ACTION_END = 'user-action-end';
-exports.USER_ACTION_CANCEL = 'user-action-cancel';
-exports.USER_ACTION_HALT = 'user-action-halt';
-//# sourceMappingURL=const.js.map

package/dist/spec/core/src/api/const.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../../../src/api/const.ts"],"names":[],"mappings":";;;AAAa,QAAA,iBAAiB,GAAG,mBAAmB,CAAC;AACxC,QAAA,eAAe,GAAG,iBAAiB,CAAC;AACpC,QAAA,kBAAkB,GAAG,oBAAoB,CAAC;AAC1C,QAAA,gBAAgB,GAAG,kBAAkB,CAAC","sourcesContent":["export const USER_ACTION_START = 'user-action-start';\nexport const USER_ACTION_END = 'user-action-end';\nexport const USER_ACTION_CANCEL = 'user-action-cancel';\nexport const USER_ACTION_HALT = 'user-action-halt';\n"]}

package/dist/spec/core/src/api/userActionLifecycleHandler.js

@@ -1,58 +0,0 @@
-"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.createUserActionLifecycleHandler = createUserActionLifecycleHandler;
-var transports_1 = require("../transports");
-var const_1 = require("./const");
-var ItemBuffer_1 = require("./ItemBuffer");
-function createUserActionLifecycleHandler(_a) {
-    var apiMessageBus = _a.apiMessageBus, transports = _a.transports, config = _a.config;
-    var actionBuffer = new ItemBuffer_1.ItemBuffer();
-    var trackUserActionsExcludeItem = config.trackUserActionsExcludeItem;
-    var message;
-    apiMessageBus.subscribe(function (msg) {
-        if (const_1.USER_ACTION_START === msg.type || const_1.USER_ACTION_HALT === msg.type) {
-            message = msg;
-            return;
-        }
-        if (msg.type === const_1.USER_ACTION_END) {
-            var id_1 = msg.id, name_1 = msg.name;
-            actionBuffer.flushBuffer(function (item) {
-                if (isExcludeFromUserAction(item, trackUserActionsExcludeItem)) {
-                    transports.execute(item);
-                    return;
-                }
-                var userActionItem = __assign(__assign({}, item), { payload: __assign(__assign({}, item.payload), { action: {
-                            parentId: id_1,
-                            name: name_1,
-                        } }) });
-                transports.execute(userActionItem);
-            });
-            message = undefined;
-            return;
-        }
-        if (msg.type === const_1.USER_ACTION_CANCEL) {
-            message = undefined;
-            actionBuffer.flushBuffer(function (item) {
-                transports.execute(item);
-            });
-        }
-    });
-    var getMessage = function () { return message; };
-    return { actionBuffer: actionBuffer, getMessage: getMessage };
-}
-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'));
-}
-//# sourceMappingURL=userActionLifecycleHandler.js.map

package/dist/spec/core/src/api/userActionLifecycleHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userActionLifecycleHandler.js","sourceRoot":"","sources":["../../../../../src/api/userActionLifecycleHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;AASA,4EAwDC;AAhED,4CAAuF;AAGvF,iCAAmG;AACnG,2CAA0C;AAI1C,SAAgB,gCAAgC,CAAC,EAQhD;QAPC,aAAa,mBAAA,EACb,UAAU,gBAAA,EACV,MAAM,YAAA;IAMN,IAAM,YAAY,GAAG,IAAI,uBAAU,EAAiB,CAAC;IACrD,IAAM,2BAA2B,GAAG,MAAM,CAAC,2BAA2B,CAAC;IACvE,IAAI,OAA0C,CAAC;IAE/C,aAAa,CAAC,SAAS,CAAC,UAAC,GAAG;QAC1B,IAAI,yBAAiB,KAAK,GAAG,CAAC,IAAI,IAAI,wBAAgB,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;YACpE,OAAO,GAAG,GAAG,CAAC;YACd,OAAO;QACT,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,uBAAe,EAAE,CAAC;YACzB,IAAA,IAAE,GAAW,GAAG,GAAd,EAAE,MAAI,GAAK,GAAG,KAAR,CAAS;YAEzB,YAAY,CAAC,WAAW,CAAC,UAAC,IAAI;gBAC5B,IAAI,uBAAuB,CAAC,IAAI,EAAE,2BAA2B,CAAC,EAAE,CAAC;oBAC/D,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACzB,OAAO;gBACT,CAAC;gBAED,IAAM,cAAc,GAAG,sBAClB,IAAI,KACP,OAAO,wBACF,IAAI,CAAC,OAAO,KACf,MAAM,EAAE;4BACN,QAAQ,EAAE,IAAE;4BACZ,IAAI,QAAA;yBACL,MAEa,CAAC;gBAEnB,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YAEH,OAAO,GAAG,SAAS,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,0BAAkB,EAAE,CAAC;YACpC,OAAO,GAAG,SAAS,CAAC;YACpB,YAAY,CAAC,WAAW,CAAC,UAAC,IAAI;gBAC5B,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAM,UAAU,GAAG,cAAsB,OAAA,OAAO,EAAP,CAAO,CAAC;IACjD,OAAO,EAAE,YAAY,cAAA,EAAE,UAAU,YAAA,EAAE,CAAC;AACtC,CAAC;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","sourcesContent":["import type { Config } from '../config';\nimport { type TransportItem, TransportItemType, type Transports } from '../transports';\nimport type { Observable } from '../utils';\n\nimport { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_HALT, USER_ACTION_START } from './const';\nimport { ItemBuffer } from './ItemBuffer';\nimport type { MeasurementEvent } from './measurements';\nimport type { APIEvent, ApiMessageBusMessages } from './types';\n\nexport function createUserActionLifecycleHandler({\n  apiMessageBus,\n  transports,\n  config,\n}: {\n  apiMessageBus: Observable<ApiMessageBusMessages>;\n  transports: Transports;\n  config: Config;\n}) {\n  const actionBuffer = new ItemBuffer<TransportItem>();\n  const trackUserActionsExcludeItem = config.trackUserActionsExcludeItem;\n  let message: ApiMessageBusMessages | undefined;\n\n  apiMessageBus.subscribe((msg) => {\n    if (USER_ACTION_START === msg.type || USER_ACTION_HALT === msg.type) {\n      message = msg;\n      return;\n    }\n\n    if (msg.type === USER_ACTION_END) {\n      const { id, name } = msg;\n\n      actionBuffer.flushBuffer((item) => {\n        if (isExcludeFromUserAction(item, trackUserActionsExcludeItem)) {\n          transports.execute(item);\n          return;\n        }\n\n        const userActionItem = {\n          ...item,\n          payload: {\n            ...item.payload,\n            action: {\n              parentId: id,\n              name,\n            },\n          },\n        } as TransportItem;\n\n        transports.execute(userActionItem);\n      });\n\n      message = undefined;\n      return;\n    }\n\n    if (msg.type === USER_ACTION_CANCEL) {\n      message = undefined;\n      actionBuffer.flushBuffer((item) => {\n        transports.execute(item);\n      });\n    }\n  });\n\n  const getMessage = (): typeof message => message;\n  return { actionBuffer, getMessage };\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"]}

package/dist/spec/core/src/api/userActionLifecycleHandler.test.js

@@ -1,169 +0,0 @@
-"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 });
-var __1 = require("..");
-var reactive_1 = require("../utils/reactive");
-var apiTestHelpers_1 = require("./apiTestHelpers");
-var const_1 = require("./const");
-var userActionLifecycleHandler_1 = require("./userActionLifecycleHandler");
-describe('userActionLifecycleHandler', function () {
-    it('assigns the user-action-start message to the message variable when it receives it', function () {
-        var apiMessageBus = new reactive_1.Observable();
-        var getMessage = (0, userActionLifecycleHandler_1.createUserActionLifecycleHandler)({
-            apiMessageBus: apiMessageBus,
-            transports: apiTestHelpers_1.mockTransports,
-            config: {},
-        }).getMessage;
-        var message = {
-            type: const_1.USER_ACTION_START,
-            name: 'start-test',
-            startTime: 0,
-            parentId: '123',
-        };
-        apiMessageBus.notify(message);
-        expect(getMessage()).toEqual(message);
-    });
-    it('assigns the user-action-halt message to the message variable when it receives it', function () {
-        var apiMessageBus = new reactive_1.Observable();
-        var getMessage = (0, userActionLifecycleHandler_1.createUserActionLifecycleHandler)({
-            apiMessageBus: apiMessageBus,
-            transports: apiTestHelpers_1.mockTransports,
-            config: {},
-        }).getMessage;
-        var message = {
-            type: __1.USER_ACTION_HALT,
-            name: 'halt-test',
-            haltTime: 0,
-            reason: 'pending-requests',
-            parentId: '123',
-        };
-        apiMessageBus.notify(message);
-        expect(getMessage()).toEqual(message);
-    });
-    it('When it receives a user-action-cancel message, it resets the cached message flushes the buffer and sends the items to the transports', function () {
-        var apiMessageBus = new reactive_1.Observable();
-        var mockExecute = jest.fn();
-        var _a = (0, userActionLifecycleHandler_1.createUserActionLifecycleHandler)({
-            apiMessageBus: apiMessageBus,
-            transports: __assign(__assign({}, apiTestHelpers_1.mockTransports), { execute: mockExecute }),
-            config: {},
-        }), actionBuffer = _a.actionBuffer, getMessage = _a.getMessage;
-        var message = {
-            type: const_1.USER_ACTION_START,
-            name: '',
-            startTime: 0,
-            parentId: '',
-        };
-        apiMessageBus.notify(message);
-        var item = { type: __1.TransportItemType.EVENT, payload: {}, meta: {} };
-        actionBuffer.addItem(item);
-        var cancelMessage = {
-            type: const_1.USER_ACTION_CANCEL,
-            name: 'pointerdown',
-        };
-        apiMessageBus.notify(cancelMessage);
-        expect(getMessage()).toBeUndefined();
-        expect(mockExecute).toHaveBeenCalledTimes(1);
-        expect(mockExecute).toHaveBeenCalledWith(item);
-        expect(actionBuffer.size()).toEqual(0);
-    });
-    it('When it receives a user-action-end message, it sends the items to the transports with the action parentId and name', function () {
-        var apiMessageBus = new reactive_1.Observable();
-        var mockExecute = jest.fn();
-        var actionBuffer = (0, userActionLifecycleHandler_1.createUserActionLifecycleHandler)({
-            apiMessageBus: apiMessageBus,
-            transports: __assign(__assign({}, apiTestHelpers_1.mockTransports), { execute: mockExecute }),
-            config: {},
-        }).actionBuffer;
-        var message = {
-            type: const_1.USER_ACTION_START,
-            name: 'pointerdown',
-            startTime: 0,
-            parentId: '123',
-        };
-        apiMessageBus.notify(message);
-        var item = { type: __1.TransportItemType.EVENT, payload: {}, meta: {} };
-        actionBuffer.addItem(item);
-        var endMessage = {
-            type: const_1.USER_ACTION_END,
-            id: '123',
-            name: 'pointerdown',
-            startTime: 100,
-            endTime: 120,
-            duration: 20,
-            eventType: 'keydown',
-        };
-        apiMessageBus.notify(endMessage);
-        expect(mockExecute).toHaveBeenCalledTimes(1);
-        expect(mockExecute).toHaveBeenCalledWith(__assign(__assign({}, item), { payload: __assign(__assign({}, item.payload), { action: {
-                    parentId: '123',
-                    name: 'pointerdown',
-                } }) }));
-    });
-    it('excludes items defined by the isExcludeFromUserAction function from the user actions', function () {
-        var apiMessageBus = new reactive_1.Observable();
-        var mockExecute = jest.fn();
-        var _a = (0, userActionLifecycleHandler_1.createUserActionLifecycleHandler)({
-            apiMessageBus: apiMessageBus,
-            transports: __assign(__assign({}, apiTestHelpers_1.mockTransports), { execute: mockExecute }),
-            config: {
-                trackUserActionsExcludeItem: function (item) {
-                    return item.type === __1.TransportItemType.EVENT && item.payload.name === 'i-am-excluded';
-                },
-            },
-        }), actionBuffer = _a.actionBuffer, getMessage = _a.getMessage;
-        var message = {
-            type: const_1.USER_ACTION_START,
-            name: 'pointerdown',
-            startTime: 0,
-            parentId: '123',
-        };
-        apiMessageBus.notify(message);
-        var itemEvent = { type: __1.TransportItemType.EVENT, payload: {}, meta: {} };
-        actionBuffer.addItem(itemEvent);
-        var itemMeasurement = {
-            type: __1.TransportItemType.MEASUREMENT,
-            payload: { type: 'web-vitals', values: {}, timestamp: (0, __1.dateNow)().toString() },
-            meta: {},
-        };
-        actionBuffer.addItem(itemMeasurement);
-        var itemEventExcluded = {
-            type: __1.TransportItemType.EVENT,
-            payload: {
-                timestamp: (0, __1.dateNow)().toString(),
-                name: 'i-am-excluded',
-            },
-            meta: {},
-        };
-        actionBuffer.addItem(itemEventExcluded);
-        var endMessage = {
-            type: const_1.USER_ACTION_END,
-            id: '123',
-            name: 'pointerdown',
-            startTime: 100,
-            endTime: 120,
-            duration: 20,
-            eventType: 'keydown',
-        };
-        apiMessageBus.notify(endMessage);
-        expect(mockExecute).toHaveBeenCalledTimes(3);
-        expect(mockExecute).toHaveBeenNthCalledWith(1, __assign(__assign({}, itemEvent), { payload: __assign(__assign({}, itemEvent.payload), { action: {
-                    parentId: '123',
-                    name: 'pointerdown',
-                } }) }));
-        expect(mockExecute).toHaveBeenNthCalledWith(2, itemMeasurement);
-        expect(mockExecute).toHaveBeenNthCalledWith(3, itemEventExcluded);
-        expect(getMessage()).toBeUndefined();
-    });
-});
-//# sourceMappingURL=userActionLifecycleHandler.test.js.map

package/dist/spec/core/src/api/userActionLifecycleHandler.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userActionLifecycleHandler.test.js","sourceRoot":"","sources":["../../../../../src/api/userActionLifecycleHandler.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,wBAWY;AACZ,8CAA+C;AAE/C,mDAAkD;AAClD,iCAAiF;AAEjF,2EAAgF;AAEhF,QAAQ,CAAC,4BAA4B,EAAE;IACrC,EAAE,CAAC,mFAAmF,EAAE;QACtF,IAAM,aAAa,GAAG,IAAI,qBAAU,EAAyB,CAAC;QAEtD,IAAA,UAAU,GAAK,IAAA,6DAAgC,EAAC;YACtD,aAAa,eAAA;YACb,UAAU,EAAE,+BAAc;YAC1B,MAAM,EAAE,EAAY;SACrB,CAAC,WAJgB,CAIf;QAEH,IAAM,OAAO,GAA2B;YACtC,IAAI,EAAE,yBAAiB;YACvB,IAAI,EAAE,YAAY;YAClB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE;QACrF,IAAM,aAAa,GAAG,IAAI,qBAAU,EAAyB,CAAC;QAEtD,IAAA,UAAU,GAAK,IAAA,6DAAgC,EAAC;YACtD,aAAa,eAAA;YACb,UAAU,EAAE,+BAAc;YAC1B,MAAM,EAAE,EAAY;SACrB,CAAC,WAJgB,CAIf;QAEH,IAAM,OAAO,GAA0B;YACrC,IAAI,EAAE,oBAAgB;YACtB,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,kBAAkB;YAC1B,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sIAAsI,EAAE;QACzI,IAAM,aAAa,GAAG,IAAI,qBAAU,EAAyB,CAAC;QAE9D,IAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACxB,IAAA,KAA+B,IAAA,6DAAgC,EAAC;YACpE,aAAa,eAAA;YACb,UAAU,wBACL,+BAAc,KACjB,OAAO,EAAE,WAAW,GACrB;YACD,MAAM,EAAE,EAAY;SACrB,CAAC,EAPM,YAAY,kBAAA,EAAE,UAAU,gBAO9B,CAAC;QAEH,IAAM,OAAO,GAA2B;YACtC,IAAI,EAAE,yBAAiB;YACvB,IAAI,EAAE,EAAE;YACR,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,EAAE;SACb,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,IAAM,IAAI,GAAG,EAAE,IAAI,EAAE,qBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAU,EAAE,CAAC;QAC9E,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3B,IAAM,aAAa,GAA0B;YAC3C,IAAI,EAAE,0BAAkB;YACxB,IAAI,EAAE,aAAa;SACpB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,aAAa,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oHAAoH,EAAE;QACvH,IAAM,aAAa,GAAG,IAAI,qBAAU,EAAyB,CAAC;QAE9D,IAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACtB,IAAA,YAAY,GAAK,IAAA,6DAAgC,EAAC;YACxD,aAAa,eAAA;YACb,UAAU,wBACL,+BAAc,KACjB,OAAO,EAAE,WAAW,GACrB;YACD,MAAM,EAAE,EAAY;SACrB,CAAC,aAPkB,CAOjB;QAEH,IAAM,OAAO,GAA2B;YACtC,IAAI,EAAE,yBAAiB;YACvB,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,IAAM,IAAI,GAAG,EAAE,IAAI,EAAE,qBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAU,EAAE,CAAC;QAC9E,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3B,IAAM,UAAU,GAA0B;YACxC,IAAI,EAAE,uBAAe;YACrB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,GAAG;YACZ,QAAQ,EAAE,EAAE;YACZ,SAAS,EAAE,SAAS;SACrB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,uBACnC,IAAI,KACP,OAAO,wBACF,IAAI,CAAC,OAAO,KACf,MAAM,EAAE;oBACN,QAAQ,EAAE,KAAK;oBACf,IAAI,EAAE,aAAa;iBACpB,OAEH,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE;QACzF,IAAM,aAAa,GAAG,IAAI,qBAAU,EAAyB,CAAC;QAE9D,IAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACxB,IAAA,KAA+B,IAAA,6DAAgC,EAAC;YACpE,aAAa,eAAA;YACb,UAAU,wBACL,+BAAc,KACjB,OAAO,EAAE,WAAW,GACrB;YACD,MAAM,EAAE;gBACN,2BAA2B,YAAC,IAAI;oBAC9B,OAAO,IAAI,CAAC,IAAI,KAAK,qBAAiB,CAAC,KAAK,IAAK,IAAI,CAAC,OAAsB,CAAC,IAAI,KAAK,eAAe,CAAC;gBACxG,CAAC;aACQ;SACZ,CAAC,EAXM,YAAY,kBAAA,EAAE,UAAU,gBAW9B,CAAC;QAEH,IAAM,OAAO,GAA2B;YACtC,IAAI,EAAE,yBAAiB;YACvB,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,IAAM,SAAS,GAAG,EAAE,IAAI,EAAE,qBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAU,EAAE,CAAC;QACnF,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEhC,IAAM,eAAe,GAA4B;YAC/C,IAAI,EAAE,qBAAiB,CAAC,WAAW;YACnC,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,IAAA,WAAO,GAAE,CAAC,QAAQ,EAAE,EAAE;YAC5E,IAAI,EAAE,EAAU;SACjB,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEtC,IAAM,iBAAiB,GAA8B;YACnD,IAAI,EAAE,qBAAiB,CAAC,KAAK;YAC7B,OAAO,EAAE;gBACP,SAAS,EAAE,IAAA,WAAO,GAAE,CAAC,QAAQ,EAAE;gBAC/B,IAAI,EAAE,eAAe;aACtB;YACD,IAAI,EAAE,EAAU;SACjB,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAExC,IAAM,UAAU,GAA0B;YACxC,IAAI,EAAE,uBAAe;YACrB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,GAAG;YACZ,QAAQ,EAAE,EAAE;YACZ,SAAS,EAAE,SAAS;SACrB,CAAC;QAEF,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,wBACxC,SAAS,KACZ,OAAO,wBACF,SAAS,CAAC,OAAO,KACpB,MAAM,EAAE;oBACN,QAAQ,EAAE,KAAK;oBACf,IAAI,EAAE,aAAa;iBACpB,OAEH,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;QAChE,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAClE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import {\n  type APIEvent,\n  ApiMessageBusMessages,\n  type Config,\n  dateNow,\n  EventEvent,\n  type Meta,\n  TransportItem,\n  TransportItemType,\n  USER_ACTION_HALT,\n  UserActionStartMessage,\n} from '..';\nimport { Observable } from '../utils/reactive';\n\nimport { mockTransports } from './apiTestHelpers';\nimport { USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_START } from './const';\nimport type { UserActionHaltMessage } from './types';\nimport { createUserActionLifecycleHandler } from './userActionLifecycleHandler';\n\ndescribe('userActionLifecycleHandler', () => {\n  it('assigns the user-action-start message to the message variable when it receives it', () => {\n    const apiMessageBus = new Observable<ApiMessageBusMessages>();\n\n    const { getMessage } = createUserActionLifecycleHandler({\n      apiMessageBus,\n      transports: mockTransports,\n      config: {} as Config,\n    });\n\n    const message: UserActionStartMessage = {\n      type: USER_ACTION_START,\n      name: 'start-test',\n      startTime: 0,\n      parentId: '123',\n    };\n\n    apiMessageBus.notify(message);\n\n    expect(getMessage()).toEqual(message);\n  });\n\n  it('assigns the user-action-halt message to the message variable when it receives it', () => {\n    const apiMessageBus = new Observable<ApiMessageBusMessages>();\n\n    const { getMessage } = createUserActionLifecycleHandler({\n      apiMessageBus,\n      transports: mockTransports,\n      config: {} as Config,\n    });\n\n    const message: UserActionHaltMessage = {\n      type: USER_ACTION_HALT,\n      name: 'halt-test',\n      haltTime: 0,\n      reason: 'pending-requests',\n      parentId: '123',\n    };\n\n    apiMessageBus.notify(message);\n\n    expect(getMessage()).toEqual(message);\n  });\n\n  it('When it receives a user-action-cancel message, it resets the cached message flushes the buffer and sends the items to the transports', () => {\n    const apiMessageBus = new Observable<ApiMessageBusMessages>();\n\n    const mockExecute = jest.fn();\n    const { actionBuffer, getMessage } = createUserActionLifecycleHandler({\n      apiMessageBus,\n      transports: {\n        ...mockTransports,\n        execute: mockExecute,\n      },\n      config: {} as Config,\n    });\n\n    const message: UserActionStartMessage = {\n      type: USER_ACTION_START,\n      name: '',\n      startTime: 0,\n      parentId: '',\n    };\n\n    apiMessageBus.notify(message);\n\n    const item = { type: TransportItemType.EVENT, payload: {}, meta: {} as Meta };\n    actionBuffer.addItem(item);\n\n    const cancelMessage: ApiMessageBusMessages = {\n      type: USER_ACTION_CANCEL,\n      name: 'pointerdown',\n    };\n\n    apiMessageBus.notify(cancelMessage);\n\n    expect(getMessage()).toBeUndefined();\n    expect(mockExecute).toHaveBeenCalledTimes(1);\n    expect(mockExecute).toHaveBeenCalledWith(item);\n    expect(actionBuffer.size()).toEqual(0);\n  });\n\n  it('When it receives a user-action-end message, it sends the items to the transports with the action parentId and name', () => {\n    const apiMessageBus = new Observable<ApiMessageBusMessages>();\n\n    const mockExecute = jest.fn();\n    const { actionBuffer } = createUserActionLifecycleHandler({\n      apiMessageBus,\n      transports: {\n        ...mockTransports,\n        execute: mockExecute,\n      },\n      config: {} as Config,\n    });\n\n    const message: UserActionStartMessage = {\n      type: USER_ACTION_START,\n      name: 'pointerdown',\n      startTime: 0,\n      parentId: '123',\n    };\n\n    apiMessageBus.notify(message);\n\n    const item = { type: TransportItemType.EVENT, payload: {}, meta: {} as Meta };\n    actionBuffer.addItem(item);\n\n    const endMessage: ApiMessageBusMessages = {\n      type: USER_ACTION_END,\n      id: '123',\n      name: 'pointerdown',\n      startTime: 100,\n      endTime: 120,\n      duration: 20,\n      eventType: 'keydown',\n    };\n\n    apiMessageBus.notify(endMessage);\n\n    expect(mockExecute).toHaveBeenCalledTimes(1);\n    expect(mockExecute).toHaveBeenCalledWith({\n      ...item,\n      payload: {\n        ...item.payload,\n        action: {\n          parentId: '123',\n          name: 'pointerdown',\n        },\n      },\n    });\n  });\n\n  it('excludes items defined by the isExcludeFromUserAction function from the user actions', () => {\n    const apiMessageBus = new Observable<ApiMessageBusMessages>();\n\n    const mockExecute = jest.fn();\n    const { actionBuffer, getMessage } = createUserActionLifecycleHandler({\n      apiMessageBus,\n      transports: {\n        ...mockTransports,\n        execute: mockExecute,\n      },\n      config: {\n        trackUserActionsExcludeItem(item) {\n          return item.type === TransportItemType.EVENT && (item.payload as EventEvent).name === 'i-am-excluded';\n        },\n      } as Config,\n    });\n\n    const message: UserActionStartMessage = {\n      type: USER_ACTION_START,\n      name: 'pointerdown',\n      startTime: 0,\n      parentId: '123',\n    };\n\n    apiMessageBus.notify(message);\n\n    const itemEvent = { type: TransportItemType.EVENT, payload: {}, meta: {} as Meta };\n    actionBuffer.addItem(itemEvent);\n\n    const itemMeasurement: TransportItem<APIEvent> = {\n      type: TransportItemType.MEASUREMENT,\n      payload: { type: 'web-vitals', values: {}, timestamp: dateNow().toString() },\n      meta: {} as Meta,\n    };\n    actionBuffer.addItem(itemMeasurement);\n\n    const itemEventExcluded: TransportItem<EventEvent> = {\n      type: TransportItemType.EVENT,\n      payload: {\n        timestamp: dateNow().toString(),\n        name: 'i-am-excluded',\n      },\n      meta: {} as Meta,\n    };\n    actionBuffer.addItem(itemEventExcluded);\n\n    const endMessage: ApiMessageBusMessages = {\n      type: USER_ACTION_END,\n      id: '123',\n      name: 'pointerdown',\n      startTime: 100,\n      endTime: 120,\n      duration: 20,\n      eventType: 'keydown',\n    };\n\n    apiMessageBus.notify(endMessage);\n\n    expect(mockExecute).toHaveBeenCalledTimes(3);\n    expect(mockExecute).toHaveBeenNthCalledWith(1, {\n      ...itemEvent,\n      payload: {\n        ...itemEvent.payload,\n        action: {\n          parentId: '123',\n          name: 'pointerdown',\n        },\n      },\n    });\n    expect(mockExecute).toHaveBeenNthCalledWith(2, itemMeasurement);\n    expect(mockExecute).toHaveBeenNthCalledWith(3, itemEventExcluded);\n    expect(getMessage()).toBeUndefined();\n  });\n});\n"]}

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

@@ -1,4 +0,0 @@
-export declare const USER_ACTION_START = "user-action-start";
-export declare const USER_ACTION_END = "user-action-end";
-export declare const USER_ACTION_CANCEL = "user-action-cancel";
-export declare const USER_ACTION_HALT = "user-action-halt";

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

@@ -1,13 +0,0 @@
-import type { Config } from '../config';
-import { type TransportItem, type Transports } from '../transports';
-import type { Observable } from '../utils';
-import { ItemBuffer } from './ItemBuffer';
-import type { APIEvent, ApiMessageBusMessages } from './types';
-export declare function createUserActionLifecycleHandler({ apiMessageBus, transports, config, }: {
-    apiMessageBus: Observable<ApiMessageBusMessages>;
-    transports: Transports;
-    config: Config;
-}): {
-    actionBuffer: ItemBuffer<TransportItem<APIEvent>>;
-    getMessage: () => ApiMessageBusMessages | undefined;
-};

package/dist/types/core/src/api/const.d.ts

@@ -1,4 +0,0 @@
-export declare const USER_ACTION_START = "user-action-start";
-export declare const USER_ACTION_END = "user-action-end";
-export declare const USER_ACTION_CANCEL = "user-action-cancel";
-export declare const USER_ACTION_HALT = "user-action-halt";

package/dist/types/core/src/api/userActionLifecycleHandler.d.ts

@@ -1,13 +0,0 @@
-import type { Config } from '../config';
-import { type TransportItem, type Transports } from '../transports';
-import type { Observable } from '../utils';
-import { ItemBuffer } from './ItemBuffer';
-import type { APIEvent, ApiMessageBusMessages } from './types';
-export declare function createUserActionLifecycleHandler({ apiMessageBus, transports, config, }: {
-    apiMessageBus: Observable<ApiMessageBusMessages>;
-    transports: Transports;
-    config: Config;
-}): {
-    actionBuffer: ItemBuffer<TransportItem<APIEvent>>;
-    getMessage: () => ApiMessageBusMessages | undefined;
-};