@grafana/faro-core 1.14.0 → 1.14.2

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type EventAttributes = Record<string, string>;
 export interface EventEvent {
     name: string;
@@ -7,11 +8,21 @@ export interface EventEvent {
     domain?: string;
     attributes?: EventAttributes;
     trace?: TraceContext;
+    action?: UserAction;
 }
 export interface PushEventOptions {
     skipDedupe?: boolean;
     spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
     timestampOverwriteMs?: number;
+    /**
+     * Allows manual transformation of the payload before adding it to the internal buffer.
+     *
+     * @param payload - The event payload to be transformed.
+     * @returns The transformed event payload.
+     *
+     * @remarks This should be used sparingly and only in special cases where custom payload processing cannot be deferred to the before-send hook.
+     */
+    customPayloadTransformer?: (payload: EventEvent) => EventEvent;
 }
 export interface EventsAPI {
     pushEvent: (name: string, attributes?: EventAttributes, domain?: string, options?: PushEventOptions) => void;

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

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

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type StacktraceParser = (err: ExtendedError) => Stacktrace;
 export interface ExceptionStackFrame {
     filename: string;
@@ -23,6 +24,7 @@ export interface ExceptionEvent {
     stacktrace?: Stacktrace;
     trace?: TraceContext;
     context?: ExceptionContext;
+    action?: UserAction;
 }
 export interface PushErrorOptions {
     skipDedupe?: boolean;

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

@@ -1,5 +1,5 @@
 export { initializeAPI } from './initialize';
-export type { API, APIEvent } from './types';
+export type { API, APIEvent, ApiMessageBusMessages, UserActionCancelMessage, UserActionEndMessage, UserActionStartMessage, 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, } from './exceptions';
@@ -8,3 +8,5 @@ export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions }
 export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from './measurements';
 export type { MetaAPI } from './meta';
 export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './traces';
+export { apiMessageBus } from './initialize';
+export { USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE } from './const';

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

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

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

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

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

@@ -1,13 +1,15 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { LogLevel } from '../../utils';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type LogContext = Record<string, string>;
 export interface LogEvent {
-    context: LogContext;
+    context: LogContext | undefined;
     level: LogLevel;
     message: string;
     timestamp: string;
     trace?: TraceContext;
+    action?: UserAction;
 }
 export interface PushLogOptions {
     context?: LogContext;

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

@@ -1,8 +1,20 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
+import { TransportItem } 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 { MeasurementsAPI } from './types';
-export declare function initializeMeasurementsAPI(_unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas, transports: Transports, tracesApi: TracesAPI): MeasurementsAPI;
+export declare function initializeMeasurementsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+    unpatchedConsole: UnpatchedConsole;
+    internalLogger: InternalLogger;
+    config: Config;
+    metas: Metas;
+    transports: Transports;
+    tracesApi: TracesAPI;
+    actionBuffer: ItemBuffer<TransportItem>;
+    getMessage: () => ApiMessageBusMessages | undefined;
+}): MeasurementsAPI;

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type MeasurementContext = Record<string, string>;
 export interface MeasurementEvent<V extends {
     [label: string]: number;
@@ -11,6 +12,7 @@ export interface MeasurementEvent<V extends {
     timestamp: string;
     trace?: TraceContext;
     context?: MeasurementContext;
+    action?: UserAction;
 }
 export interface PushMeasurementOptions {
     skipDedupe?: boolean;

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

@@ -1,7 +1,19 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
+import type { TransportItem, 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(_unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, _config: Config, metas: Metas, _transports: Transports): MetaAPI;
+export declare function initializeMetaAPI({ internalLogger, metas, }: {
+    unpatchedConsole: UnpatchedConsole;
+    internalLogger: InternalLogger;
+    config: Config;
+    metas: Metas;
+    transports: Transports;
+    tracesApi: TracesAPI;
+    actionBuffer: ItemBuffer<TransportItem>;
+    getMessage: () => ApiMessageBusMessages | undefined;
+}): MetaAPI;

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

@@ -1,3 +1,4 @@
+import type { USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE } from './const';
 import type { EventEvent, EventsAPI } from './events';
 import type { ExceptionEvent, ExceptionsAPI } from './exceptions';
 import type { LogEvent, LogsAPI } from './logs';
@@ -6,3 +7,39 @@ 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;
+export type UserActionMessageType = typeof USER_ACTION_START_MESSAGE_TYPE | typeof USER_ACTION_END_MESSAGE_TYPE | typeof USER_ACTION_CANCEL_MESSAGE_TYPE;
+export type UserActionStartMessage = {
+    type: typeof USER_ACTION_START_MESSAGE_TYPE;
+    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_MESSAGE_TYPE;
+    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_MESSAGE_TYPE;
+    name: string;
+    /**
+     * Unique identifier of the parent user action to which this action belongs.
+     */
+    parentId?: string;
+};
+export type UserAction = {
+    name: string;
+    id?: string;
+    parentId?: string;
+};

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

@@ -0,0 +1,13 @@
+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/api/utils.d.ts

@@ -0,0 +1,2 @@
+import type { Patterns } from '../config/types';
+export declare function shouldIgnoreEvent(patterns: Patterns, msg: string): boolean;

package/dist/types/config/types.d.ts

@@ -2,7 +2,7 @@ import type { APIEvent, LogArgsSerializer, StacktraceParser } from '../api';
 import type { Instrumentation } from '../instrumentations';
 import type { InternalLoggerLevel } from '../internalLogger';
 import type { Meta, MetaApp, MetaItem, MetaPage, MetaSession, MetaUser, MetaView } from '../metas';
-import type { BatchExecutorOptions, BeforeSendHook, Transport } from '../transports';
+import type { BatchExecutorOptions, BeforeSendHook, Transport, TransportItem } from '../transports';
 import type { UnpatchedConsole } from '../unpatchedConsole';
 import type { LogLevel } from '../utils';
 type SamplingContext = {
@@ -192,18 +192,27 @@ export interface Config<P = APIEvent> {
         generatePageId?: (location: Location) => string;
     };
     /**
-     * Configuration for the location tracking (Grafana cloud only)
+     * Enable or disable geolocation tracking.
+     * Geolocation tracking must be enabled in the Grafana Cloud settings first.
+     * It cannot be enabled solely on the client side.
+     * This option allows control over tracking on the client side to comply with user
+     * privacy requirements.
      */
-    geoLocationTracking?: {
-        /**
-         * Enable or disable geolocation tracking.
-         * Geolocation tracking must be enabled in the Grafana Cloud settings first.
-         * It cannot be enabled solely on the client side.
-         * This option allows control over tracking on the client side to comply with user
-         * privacy requirements.
-         */
-        enabled?: boolean;
-    };
+    trackGeolocation?: boolean;
+    /**
+     * This is a preview feature.
+     * We have tested it thoroughly, but it is possible that it might not work as expected in all cases.
+     */
+    trackUserActionsPreview?: boolean;
+    /**
+     * Configure your own attribute name for tracking user actions. Default is 'data-faro-user-action-name'
+     */
+    trackUserActionsDataAttributeName?: string;
+    /**
+     * Predicate function to exclude items from user actions.
+     * If the function returns true, the item will be excluded from user actions.
+     */
+    trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
 }
 export type Patterns = Array<string | RegExp>;
 export {};

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

@@ -0,0 +1,7 @@
+export declare class ItemBuffer<T> {
+    private buffer;
+    constructor();
+    addItem(item: T): void;
+    flushBuffer(cb?: (item: T) => void): void;
+    size(): number;
+}

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

@@ -0,0 +1,11 @@
+import type { Transports } from '../transports';
+import type { TracesAPI } from './traces/types';
+export declare const mockMetas: {
+    add: jest.Mock<any, any, any>;
+    remove: jest.Mock<any, any, any>;
+    addListener: jest.Mock<any, any, any>;
+    removeListener: jest.Mock<any, any, any>;
+    value: {};
+};
+export declare const mockTransports: Transports;
+export declare const mockTracesApi: TracesAPI;

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

@@ -0,0 +1,3 @@
+export declare const USER_ACTION_START_MESSAGE_TYPE = "user-action-start";
+export declare const USER_ACTION_END_MESSAGE_TYPE = "user-action-end";
+export declare const USER_ACTION_CANCEL_MESSAGE_TYPE = "user-action-cancel";

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

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

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type EventAttributes = Record<string, string>;
 export interface EventEvent {
     name: string;
@@ -7,11 +8,21 @@ export interface EventEvent {
     domain?: string;
     attributes?: EventAttributes;
     trace?: TraceContext;
+    action?: UserAction;
 }
 export interface PushEventOptions {
     skipDedupe?: boolean;
     spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
     timestampOverwriteMs?: number;
+    /**
+     * Allows manual transformation of the payload before adding it to the internal buffer.
+     *
+     * @param payload - The event payload to be transformed.
+     * @returns The transformed event payload.
+     *
+     * @remarks This should be used sparingly and only in special cases where custom payload processing cannot be deferred to the before-send hook.
+     */
+    customPayloadTransformer?: (payload: EventEvent) => EventEvent;
 }
 export interface EventsAPI {
     pushEvent: (name: string, attributes?: EventAttributes, domain?: string, options?: PushEventOptions) => void;

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

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

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type StacktraceParser = (err: ExtendedError) => Stacktrace;
 export interface ExceptionStackFrame {
     filename: string;
@@ -23,6 +24,7 @@ export interface ExceptionEvent {
     stacktrace?: Stacktrace;
     trace?: TraceContext;
     context?: ExceptionContext;
+    action?: UserAction;
 }
 export interface PushErrorOptions {
     skipDedupe?: boolean;

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

@@ -1,5 +1,5 @@
 export { initializeAPI } from './initialize';
-export type { API, APIEvent } from './types';
+export type { API, APIEvent, ApiMessageBusMessages, UserActionCancelMessage, UserActionEndMessage, UserActionStartMessage, 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, } from './exceptions';
@@ -8,3 +8,5 @@ export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions }
 export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from './measurements';
 export type { MetaAPI } from './meta';
 export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './traces';
+export { apiMessageBus } from './initialize';
+export { USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE } from './const';

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

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

package/dist/types/core/src/api/initialize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/core/src/api/itemBuffer.test.d.ts

@@ -0,0 +1 @@
+export {};

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

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

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

@@ -1,13 +1,15 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { LogLevel } from '../../utils';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type LogContext = Record<string, string>;
 export interface LogEvent {
-    context: LogContext;
+    context: LogContext | undefined;
     level: LogLevel;
     message: string;
     timestamp: string;
     trace?: TraceContext;
+    action?: UserAction;
 }
 export interface PushLogOptions {
     context?: LogContext;

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

@@ -1,8 +1,20 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
+import { TransportItem } 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 { MeasurementsAPI } from './types';
-export declare function initializeMeasurementsAPI(_unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas, transports: Transports, tracesApi: TracesAPI): MeasurementsAPI;
+export declare function initializeMeasurementsAPI({ internalLogger, config, metas, transports, tracesApi, actionBuffer, getMessage, }: {
+    unpatchedConsole: UnpatchedConsole;
+    internalLogger: InternalLogger;
+    config: Config;
+    metas: Metas;
+    transports: Transports;
+    tracesApi: TracesAPI;
+    actionBuffer: ItemBuffer<TransportItem>;
+    getMessage: () => ApiMessageBusMessages | undefined;
+}): MeasurementsAPI;

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

@@ -1,5 +1,6 @@
 import type { SpanContext } from '@opentelemetry/api';
 import type { TraceContext } from '../traces';
+import type { UserAction } from '../types';
 export type MeasurementContext = Record<string, string>;
 export interface MeasurementEvent<V extends {
     [label: string]: number;
@@ -11,6 +12,7 @@ export interface MeasurementEvent<V extends {
     timestamp: string;
     trace?: TraceContext;
     context?: MeasurementContext;
+    action?: UserAction;
 }
 export interface PushMeasurementOptions {
     skipDedupe?: boolean;

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

@@ -1,7 +1,19 @@
 import type { Config } from '../../config';
 import type { InternalLogger } from '../../internalLogger';
 import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
+import type { TransportItem, 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(_unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, _config: Config, metas: Metas, _transports: Transports): MetaAPI;
+export declare function initializeMetaAPI({ internalLogger, metas, }: {
+    unpatchedConsole: UnpatchedConsole;
+    internalLogger: InternalLogger;
+    config: Config;
+    metas: Metas;
+    transports: Transports;
+    tracesApi: TracesAPI;
+    actionBuffer: ItemBuffer<TransportItem>;
+    getMessage: () => ApiMessageBusMessages | undefined;
+}): MetaAPI;

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

@@ -1,3 +1,4 @@
+import type { USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE } from './const';
 import type { EventEvent, EventsAPI } from './events';
 import type { ExceptionEvent, ExceptionsAPI } from './exceptions';
 import type { LogEvent, LogsAPI } from './logs';
@@ -6,3 +7,39 @@ 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;
+export type UserActionMessageType = typeof USER_ACTION_START_MESSAGE_TYPE | typeof USER_ACTION_END_MESSAGE_TYPE | typeof USER_ACTION_CANCEL_MESSAGE_TYPE;
+export type UserActionStartMessage = {
+    type: typeof USER_ACTION_START_MESSAGE_TYPE;
+    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_MESSAGE_TYPE;
+    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_MESSAGE_TYPE;
+    name: string;
+    /**
+     * Unique identifier of the parent user action to which this action belongs.
+     */
+    parentId?: string;
+};
+export type UserAction = {
+    name: string;
+    id?: string;
+    parentId?: string;
+};

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

@@ -0,0 +1,13 @@
+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/userActionLifecycleHandler.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+import type { Patterns } from '../config/types';
+export declare function shouldIgnoreEvent(patterns: Patterns, msg: string): boolean;

package/dist/types/core/src/api/utils.test.d.ts

@@ -0,0 +1 @@
+export {};