@grafana/faro-core 2.0.0-beta → 2.0.2

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

@@ -1,22 +1,32 @@
 import { type TransportItem } from '../../transports';
-import { UserActionSeverity, userActionStartByApiCallEventName } from './const';
+import { type UserActionImportanceType, userActionStartByApiCallEventName } from './const';
 export declare enum UserActionState {
     Started = 0,
     Halted = 1,
     Cancelled = 2,
     Ended = 3
 }
-export type HaltPredicate = () => boolean;
+/**
+ * Public interface for the UserAction.
+ * This is the interface that is part of the public API.
+ */
 export interface UserActionInterface {
     name: string;
     parentId: string;
-    addItem(item: TransportItem): void;
-    extend(haltPredicate?: HaltPredicate): void;
+}
+/**
+ * Internal interface for the UserAction.
+ * This interface is intended for internal use only and not guaranteed to be stable.
+ */
+export interface UserActionInternalInterface extends UserActionInterface {
+    halt(): void;
     end(attributes?: Record<string, string>): void;
-    halt(reason?: string): void;
     cancel(): void;
     getState(): UserActionState;
 }
+export interface UserActionTransportItemBuffer {
+    addItem(item: TransportItem): boolean;
+}
 export type ApiUserActionEvent = {
     name: string;
     attributes?: Record<string, string>;
@@ -32,7 +42,7 @@ export type EndUserActionProps = {
 };
 export type StartUserActionOptions = {
     triggerName?: string;
-    severity?: UserActionSeverity;
+    importance?: UserActionImportanceType;
 };
 export interface UserActionsAPI {
     startUserAction: (name: string, attributes?: Record<string, string>, options?: StartUserActionOptions) => UserActionInterface | undefined;

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

@@ -1,38 +1,30 @@
 import { type TransportItem, type Transports } from '../../transports';
 import { Observable } from '../../utils';
 import { type APIEvent } from '../types';
-import { UserActionSeverity } from './const';
-import { type HaltPredicate, type UserActionInterface, UserActionState } from './types';
-export default class UserAction extends Observable implements UserActionInterface {
+import { type UserActionImportanceType } from './const';
+import { type UserActionInternalInterface, UserActionState, type UserActionTransportItemBuffer } from './types';
+export default class UserAction extends Observable implements UserActionInternalInterface, UserActionTransportItemBuffer {
     name: string;
     id: string;
     attributes?: Record<string, string>;
     parentId: string;
     trigger: string;
-    severity: UserActionSeverity;
+    importance: UserActionImportanceType;
     startTime?: number;
     trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-    cancelTimeout: number;
-    haltTimeout: number;
     private _state;
-    private _timeoutId?;
     private _itemBuffer;
     private _transports;
-    private _haltTimeoutId;
-    private _isValid;
-    constructor({ name, parentId, haltTimeout, trigger, transports, attributes, trackUserActionsExcludeItem, severity, }: {
+    constructor({ name, parentId, trigger, transports, attributes, trackUserActionsExcludeItem, importance, }: {
         name: string;
         transports: Transports;
         parentId?: string;
         trigger: string;
         attributes?: Record<string, string>;
-        haltTimeout?: number;
         trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-        severity?: UserActionSeverity;
+        importance?: UserActionImportanceType;
     });
-    addItem(item: TransportItem): void;
-    extend(haltPredicate?: HaltPredicate): void;
-    private _setFollowupActionTimeout;
+    addItem(item: TransportItem): boolean;
     private _start;
     halt(): void;
     cancel(): void;

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

@@ -134,10 +134,6 @@ export interface Config<P = APIEvent> {
      * Only resource timings for fetch and xhr requests are tracked by default. Set this to true to track all resources (default: false).
      */
     trackResources?: boolean;
-    /**
-     * Track web vitals attribution data (default: true)
-     */
-    trackWebVitalsAttribution?: boolean;
     /**
      * Configuration for the web vitals instrumentation
      */
@@ -153,12 +149,6 @@ export interface Config<P = APIEvent> {
          * for measuring these metrics in production.
          */
         reportAllChanges?: boolean;
-        /**
-         * Track web vitals attribution data (default: true)
-         *
-         * Functionally the same as setting `trackWebVitalsAttribution` to true.
-         */
-        trackAttribution?: boolean;
     };
     /**
      * Configuration for the console instrumentation
@@ -206,19 +196,19 @@ export interface Config<P = APIEvent> {
      */
     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.
+     * Configuration for the user actions instrumentation
      */
-    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;
+    userActionsInstrumentation?: {
+        /**
+         * Configure your own attribute name for tracking user actions. Default is 'data-faro-user-action-name'
+         */
+        dataAttributeName?: string;
+        /**
+         * Predicate function to exclude items from user actions.
+         * If the function returns true, the item will be excluded from user actions.
+         */
+        excludeItem?: (item: TransportItem<APIEvent>) => boolean;
+    };
     /**
      * When enabled, preserves the original Error object in the transport item for use in the beforeSend hook.
      * The original error is automatically removed before the item is sent to the transport.
@@ -232,6 +222,16 @@ export interface Config<P = APIEvent> {
      * Faro exception payload to include additional context or fix missing information.
      */
     preserveOriginalError?: boolean;
+    /**
+     * Configuration for experimental features.
+     * These features have been tested thoroughly, but it is possible that they might not work as expected in all cases.
+     */
+    experimental?: {
+        /**
+         * Track navigation events.
+         */
+        trackNavigation?: boolean;
+    };
 }
 export type Patterns = Array<string | RegExp>;
 export {};

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

@@ -7,5 +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 { UserActionImportance, type UserActionImportanceType, UserActionState, type UserActionInterface, type UserActionInternalInterface, type UserActionsAPI, userActionsMessageBus, } from './userActions';
 export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './traces';

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

@@ -1,6 +1,8 @@
 export declare const userActionStartByApiCallEventName = "faroApiCall";
 export declare const userActionStart = "user_action_start";
-export declare enum UserActionSeverity {
-    Normal = "normal",
-    Critical = "critical"
-}
+export declare const UserActionImportance: {
+    readonly Normal: "normal";
+    readonly Critical: "critical";
+};
+export type UserActionImportanceType = (typeof UserActionImportance)[keyof typeof UserActionImportance];
+export declare const userActionEventName = "faro.user.action";

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

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

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

@@ -1,10 +1,18 @@
-import { type InternalLogger, type Transports } from '../..';
+import { type InternalLogger, type TransportItem, type Transports } from '../..';
 import type { Config } from '../../config';
 import { Observable } from '../../utils/reactive';
-import { type UserActionsAPI } from './types';
+import { type UserActionInterface, 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;
+/**
+ * Adds an item to the buffer associated with the given UserAction.
+ * The item will only be added if the UserAction is in the Started state.
+ * @param userAction The UserAction instance
+ * @param item The item to add to the buffer
+ * @returns {boolean} True if the item was added, false otherwise
+ */
+export declare function addItemToUserActionBuffer(userAction: UserActionInterface | undefined, item: TransportItem): boolean;

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

@@ -1,22 +1,32 @@
 import { type TransportItem } from '../../transports';
-import { UserActionSeverity, userActionStartByApiCallEventName } from './const';
+import { type UserActionImportanceType, userActionStartByApiCallEventName } from './const';
 export declare enum UserActionState {
     Started = 0,
     Halted = 1,
     Cancelled = 2,
     Ended = 3
 }
-export type HaltPredicate = () => boolean;
+/**
+ * Public interface for the UserAction.
+ * This is the interface that is part of the public API.
+ */
 export interface UserActionInterface {
     name: string;
     parentId: string;
-    addItem(item: TransportItem): void;
-    extend(haltPredicate?: HaltPredicate): void;
+}
+/**
+ * Internal interface for the UserAction.
+ * This interface is intended for internal use only and not guaranteed to be stable.
+ */
+export interface UserActionInternalInterface extends UserActionInterface {
+    halt(): void;
     end(attributes?: Record<string, string>): void;
-    halt(reason?: string): void;
     cancel(): void;
     getState(): UserActionState;
 }
+export interface UserActionTransportItemBuffer {
+    addItem(item: TransportItem): boolean;
+}
 export type ApiUserActionEvent = {
     name: string;
     attributes?: Record<string, string>;
@@ -32,7 +42,7 @@ export type EndUserActionProps = {
 };
 export type StartUserActionOptions = {
     triggerName?: string;
-    severity?: UserActionSeverity;
+    importance?: UserActionImportanceType;
 };
 export interface UserActionsAPI {
     startUserAction: (name: string, attributes?: Record<string, string>, options?: StartUserActionOptions) => UserActionInterface | undefined;

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

@@ -1,38 +1,30 @@
 import { type TransportItem, type Transports } from '../../transports';
 import { Observable } from '../../utils';
 import { type APIEvent } from '../types';
-import { UserActionSeverity } from './const';
-import { type HaltPredicate, type UserActionInterface, UserActionState } from './types';
-export default class UserAction extends Observable implements UserActionInterface {
+import { type UserActionImportanceType } from './const';
+import { type UserActionInternalInterface, UserActionState, type UserActionTransportItemBuffer } from './types';
+export default class UserAction extends Observable implements UserActionInternalInterface, UserActionTransportItemBuffer {
     name: string;
     id: string;
     attributes?: Record<string, string>;
     parentId: string;
     trigger: string;
-    severity: UserActionSeverity;
+    importance: UserActionImportanceType;
     startTime?: number;
     trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-    cancelTimeout: number;
-    haltTimeout: number;
     private _state;
-    private _timeoutId?;
     private _itemBuffer;
     private _transports;
-    private _haltTimeoutId;
-    private _isValid;
-    constructor({ name, parentId, haltTimeout, trigger, transports, attributes, trackUserActionsExcludeItem, severity, }: {
+    constructor({ name, parentId, trigger, transports, attributes, trackUserActionsExcludeItem, importance, }: {
         name: string;
         transports: Transports;
         parentId?: string;
         trigger: string;
         attributes?: Record<string, string>;
-        haltTimeout?: number;
         trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-        severity?: UserActionSeverity;
+        importance?: UserActionImportanceType;
     });
-    addItem(item: TransportItem): void;
-    extend(haltPredicate?: HaltPredicate): void;
-    private _setFollowupActionTimeout;
+    addItem(item: TransportItem): boolean;
     private _start;
     halt(): void;
     cancel(): void;

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

@@ -134,10 +134,6 @@ export interface Config<P = APIEvent> {
      * Only resource timings for fetch and xhr requests are tracked by default. Set this to true to track all resources (default: false).
      */
     trackResources?: boolean;
-    /**
-     * Track web vitals attribution data (default: true)
-     */
-    trackWebVitalsAttribution?: boolean;
     /**
      * Configuration for the web vitals instrumentation
      */
@@ -153,12 +149,6 @@ export interface Config<P = APIEvent> {
          * for measuring these metrics in production.
          */
         reportAllChanges?: boolean;
-        /**
-         * Track web vitals attribution data (default: true)
-         *
-         * Functionally the same as setting `trackWebVitalsAttribution` to true.
-         */
-        trackAttribution?: boolean;
     };
     /**
      * Configuration for the console instrumentation
@@ -206,19 +196,19 @@ export interface Config<P = APIEvent> {
      */
     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.
+     * Configuration for the user actions instrumentation
      */
-    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;
+    userActionsInstrumentation?: {
+        /**
+         * Configure your own attribute name for tracking user actions. Default is 'data-faro-user-action-name'
+         */
+        dataAttributeName?: string;
+        /**
+         * Predicate function to exclude items from user actions.
+         * If the function returns true, the item will be excluded from user actions.
+         */
+        excludeItem?: (item: TransportItem<APIEvent>) => boolean;
+    };
     /**
      * When enabled, preserves the original Error object in the transport item for use in the beforeSend hook.
      * The original error is automatically removed before the item is sent to the transport.
@@ -232,6 +222,16 @@ export interface Config<P = APIEvent> {
      * Faro exception payload to include additional context or fix missing information.
      */
     preserveOriginalError?: boolean;
+    /**
+     * Configuration for experimental features.
+     * These features have been tested thoroughly, but it is possible that they might not work as expected in all cases.
+     */
+    experimental?: {
+        /**
+         * Track navigation events.
+         */
+        trackNavigation?: boolean;
+    };
 }
 export type Patterns = Array<string | RegExp>;
 export {};

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

@@ -1,5 +1,5 @@
-export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, UserActionSeverity, UserActionState, userActionsMessageBus, } from './api';
-export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionEventExtended, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, UserAction, UserActionInterface, } from './api';
+export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, UserActionImportance, type UserActionImportanceType, UserActionState, userActionsMessageBus, } from './api';
+export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionEventExtended, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, UserAction, UserActionInterface, UserActionInternalInterface, } from './api';
 export { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
 export { globalObject } from './globalObject';

package/dist/types/core/src/testUtils/mockTransport.d.ts

@@ -4,7 +4,7 @@ import type { Transport, TransportItem } from '../transports';
 export declare class MockTransport extends BaseTransport implements Transport {
     private ignoreURLs;
     readonly name = "@grafana/transport-mock";
-    readonly version = "2.0.0-beta";
+    readonly version = "2.0.2";
     items: TransportItem[];
     constructor(ignoreURLs?: Patterns);
     send(items: TransportItem[]): void | Promise<void>;

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

@@ -1 +1 @@
-export declare const VERSION = "2.0.0-beta";
+export declare const VERSION = "2.0.2";

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, UserActionSeverity, UserActionState, userActionsMessageBus, } from './api';
-export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionEventExtended, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, UserAction, UserActionInterface, } from './api';
+export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, UserActionImportance, type UserActionImportanceType, UserActionState, userActionsMessageBus, } from './api';
+export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionEventExtended, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, UserAction, UserActionInterface, UserActionInternalInterface, } from './api';
 export { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
 export { globalObject } from './globalObject';

package/dist/types/testUtils/mockTransport.d.ts

@@ -4,7 +4,7 @@ import type { Transport, TransportItem } from '../transports';
 export declare class MockTransport extends BaseTransport implements Transport {
     private ignoreURLs;
     readonly name = "@grafana/transport-mock";
-    readonly version = "2.0.0-beta";
+    readonly version = "2.0.2";
     items: TransportItem[];
     constructor(ignoreURLs?: Patterns);
     send(items: TransportItem[]): void | Promise<void>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.0.0-beta";
+export declare const VERSION = "2.0.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-core",
-  "version": "2.0.0-beta",
+  "version": "2.0.2",
   "description": "Core package of Faro.",
   "keywords": [
     "observability",
@@ -38,27 +38,28 @@
     "build:compile:bundle": "run-s 'build:compile:bundle:*'",
     "build:compile:bundle:create": "rollup -c ./rollup.config.js",
     "build:compile:bundle:remove-extras": "rimraf dist/bundle/dist",
-    "watch": "run-s build:version watch:compile",
-    "watch:compile": "yarn build:compile:cjs -w",
+    "watch": "run-s build:version 'watch:compile:*'",
+    "watch:compile:cjs": "yarn build:compile:cjs -w",
+    "watch:compile:esm": "yarn build:compile:esm -w",
     "clean": "rimraf dist/ yarn-error.log",
     "quality": "run-s 'quality:*'",
     "quality:test": "jest",
     "quality:format": "prettier --cache --cache-location=../../.cache/prettier/core --ignore-path ../../.prettierignore -w \"./**/*.{js,jsx,ts,tsx,css,scss,md,yaml,yml,json}\"",
     "quality:lint": "run-s 'quality:lint:*'",
-    "quality:lint:eslint": "eslint --cache --cache-location ../../.cache/eslint/core --ignore-path ../../.eslintignore \"./**/*.{js,jsx,ts,tsx}\"",
+    "quality:lint:eslint": "eslint --cache --cache-location ../../.cache/eslint/core \"./**/*.{js,jsx,ts,tsx}\"",
     "quality:lint:prettier": "prettier --cache --cache-location=../../.cache/prettier/core --ignore-path ../../.prettierignore -c \"./**/*.{js,jsx,ts,tsx,css,scss,md,yaml,yml,json}\"",
     "quality:lint:md": "markdownlint README.md",
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/otlp-transformer": "^0.203.0"
+    "@opentelemetry/otlp-transformer": "^0.208.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.1"
+    "@types/node": "24.10.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "45be1a46e697add78addde51fce36f14176afa62"
+  "gitHead": "c47ff6089dfa52b34630131ea2776910eae984ab"
 }