@grafana/faro-core 1.14.0 → 1.14.2

package/dist/types/core/src/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/index.d.ts

@@ -1,5 +1,5 @@
-export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer } from './api';
-export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, } from './api';
+export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, apiMessageBus, USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE, } from './api';
+export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, ApiMessageBusMessages, UserActionStartMessage, UserActionEndMessage, UserActionCancelMessage, UserAction, } from './api';
 export { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
 export { globalObject } from './globalObject';
@@ -19,7 +19,7 @@ export { BaseTransport, getTransportBody, TransportItemType, transportItemTypeTo
 export type { BeforeSendHook, SendFn, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './transports';
 export { defaultUnpatchedConsole } from './unpatchedConsole';
 export type { UnpatchedConsole } from './unpatchedConsole';
-export { allLogLevels, createPromiseBuffer, deepEqual, defaultLogLevel, genShortID, getCurrentTimestamp, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, LogLevel, noop, dateNow, isEmpty, getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues, } from './utils';
-export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, } from './utils';
+export { allLogLevels, createPromiseBuffer, deepEqual, defaultLogLevel, genShortID, getCurrentTimestamp, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, LogLevel, noop, dateNow, isEmpty, getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues, Observable, merge, } from './utils';
+export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, Subscription, } from './utils';
 export { VERSION } from './version';
 export { unknownString } from './consts';

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 = "1.14.0";
+    readonly version = "1.14.2";
     items: TransportItem[];
     constructor(ignoreURLs?: Patterns);
     send(items: TransportItem[]): void | Promise<void>;

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

@@ -1,8 +1,6 @@
-import type { Config, Patterns } from '../config';
+import type { Config } from '../config';
 import type { InternalLogger } from '../internalLogger';
 import type { Metas } from '../metas';
 import type { UnpatchedConsole } from '../unpatchedConsole';
-import type { BeforeSendHook, Transports } from './types';
-export declare function shouldIgnoreEvent(patterns: Patterns, msg: string): boolean;
-export declare function createBeforeSendHookFromIgnorePatterns(patterns: Patterns): BeforeSendHook;
+import type { Transports } from './types';
 export declare function initializeTransports(unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas): Transports;

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

@@ -28,7 +28,6 @@ export interface TransportBody {
 export interface Transports {
     add: (...transports: Transport[]) => void;
     addBeforeSendHooks: (...hooks: Array<BeforeSendHook | undefined>) => void;
-    addIgnoreErrorsPatterns: (...ignoreErrorsPatterns: Array<Patterns | undefined>) => void;
     execute: (transportItem: TransportItem) => void;
     getBeforeSendHooks: () => BeforeSendHook[];
     isPaused: () => boolean;

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

@@ -11,3 +11,5 @@ export { genShortID } from './shortId';
 export { getBundleId } from './sourceMaps';
 export { dateNow } from './date';
 export { getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues } from './json';
+export { Observable, merge } from './reactive';
+export type { Subscription } from './reactive';

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

@@ -0,0 +1,46 @@
+export interface Subscription {
+    unsubscribe: () => void;
+}
+export declare class Observable<T = any> {
+    private subscribers;
+    constructor();
+    /**
+     * Subscribes a callback function to the observable.
+     * @param callback - The function to call when the observable emits a value.
+     * @returns A subscription object with an unsubscribe method to cancel the subscription.
+     */
+    subscribe(callback: (data: T) => void): Subscription;
+    /**
+     * Notifies all subscribers with the given data.
+     * @param data - The data to emit to all subscribers.
+     */
+    notify(data: T): void;
+    /**
+     * Subscribes a callback function to the observable and automatically unsubscribes after the first emission.
+     * @param callback - The function to call when the observable emits a value.
+     * @returns A subscription object with an unsubscribe method to cancel the subscription.
+     */
+    first(callback: (data: T) => void): Subscription;
+    /**
+     * Emits values from the source observable until the provided predicate function returns false.
+     * @param predicate - A function that evaluates each value emitted by the source observable.
+     * @returns A new observable that emits values from the source observable while the predicate returns true.
+     */
+    takeWhile(predicate: (value: T) => boolean): Observable<T>;
+    /**
+     * Unsubscribes all subscribers by clearing the subscribers array.
+     *
+     * @remarks
+     * This method sets the `subscribers` array to an empty array, effectively removing all current subscribers.
+     */
+    unsubscribeAll(): void;
+    private unsubscribe;
+}
+/**
+ * Merges multiple observables into a single observable.
+ *
+ * @template T - The type of the values emitted by the observables.
+ * @param {...Observable[]} observables - The observables to merge.
+ * @returns {Observable} A new observable that emits values from all input observables.
+ */
+export declare function merge<T>(...observables: Array<Observable<T>>): Observable<T>;

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

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

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

@@ -1 +1 @@
-export declare const VERSION = "1.14.0";
+export declare const VERSION = "1.14.2";

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer } from './api';
-export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, } from './api';
+export { defaultExceptionType, defaultLogArgsSerializer, defaultErrorArgsSerializer, apiMessageBus, USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE, } from './api';
+export type { API, APIEvent, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, LogArgsSerializer, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, MetaAPI, OTELApi, PushErrorOptions, PushEventOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, ApiMessageBusMessages, UserActionStartMessage, UserActionEndMessage, UserActionCancelMessage, UserAction, } from './api';
 export { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
 export { globalObject } from './globalObject';
@@ -19,7 +19,7 @@ export { BaseTransport, getTransportBody, TransportItemType, transportItemTypeTo
 export type { BeforeSendHook, SendFn, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './transports';
 export { defaultUnpatchedConsole } from './unpatchedConsole';
 export type { UnpatchedConsole } from './unpatchedConsole';
-export { allLogLevels, createPromiseBuffer, deepEqual, defaultLogLevel, genShortID, getCurrentTimestamp, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, LogLevel, noop, dateNow, isEmpty, getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues, } from './utils';
-export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, } from './utils';
+export { allLogLevels, createPromiseBuffer, deepEqual, defaultLogLevel, genShortID, getCurrentTimestamp, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, LogLevel, noop, dateNow, isEmpty, getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues, Observable, merge, } from './utils';
+export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, Subscription, } from './utils';
 export { VERSION } from './version';
 export { unknownString } from './consts';

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 = "1.14.0";
+    readonly version = "1.14.2";
     items: TransportItem[];
     constructor(ignoreURLs?: Patterns);
     send(items: TransportItem[]): void | Promise<void>;

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

@@ -1,8 +1,6 @@
-import type { Config, Patterns } from '../config';
+import type { Config } from '../config';
 import type { InternalLogger } from '../internalLogger';
 import type { Metas } from '../metas';
 import type { UnpatchedConsole } from '../unpatchedConsole';
-import type { BeforeSendHook, Transports } from './types';
-export declare function shouldIgnoreEvent(patterns: Patterns, msg: string): boolean;
-export declare function createBeforeSendHookFromIgnorePatterns(patterns: Patterns): BeforeSendHook;
+import type { Transports } from './types';
 export declare function initializeTransports(unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas): Transports;

package/dist/types/transports/types.d.ts

@@ -28,7 +28,6 @@ export interface TransportBody {
 export interface Transports {
     add: (...transports: Transport[]) => void;
     addBeforeSendHooks: (...hooks: Array<BeforeSendHook | undefined>) => void;
-    addIgnoreErrorsPatterns: (...ignoreErrorsPatterns: Array<Patterns | undefined>) => void;
     execute: (transportItem: TransportItem) => void;
     getBeforeSendHooks: () => BeforeSendHook[];
     isPaused: () => boolean;

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

@@ -11,3 +11,5 @@ export { genShortID } from './shortId';
 export { getBundleId } from './sourceMaps';
 export { dateNow } from './date';
 export { getCircularDependencyReplacer, stringifyExternalJson, stringifyObjectValues } from './json';
+export { Observable, merge } from './reactive';
+export type { Subscription } from './reactive';

package/dist/types/utils/reactive.d.ts

@@ -0,0 +1,46 @@
+export interface Subscription {
+    unsubscribe: () => void;
+}
+export declare class Observable<T = any> {
+    private subscribers;
+    constructor();
+    /**
+     * Subscribes a callback function to the observable.
+     * @param callback - The function to call when the observable emits a value.
+     * @returns A subscription object with an unsubscribe method to cancel the subscription.
+     */
+    subscribe(callback: (data: T) => void): Subscription;
+    /**
+     * Notifies all subscribers with the given data.
+     * @param data - The data to emit to all subscribers.
+     */
+    notify(data: T): void;
+    /**
+     * Subscribes a callback function to the observable and automatically unsubscribes after the first emission.
+     * @param callback - The function to call when the observable emits a value.
+     * @returns A subscription object with an unsubscribe method to cancel the subscription.
+     */
+    first(callback: (data: T) => void): Subscription;
+    /**
+     * Emits values from the source observable until the provided predicate function returns false.
+     * @param predicate - A function that evaluates each value emitted by the source observable.
+     * @returns A new observable that emits values from the source observable while the predicate returns true.
+     */
+    takeWhile(predicate: (value: T) => boolean): Observable<T>;
+    /**
+     * Unsubscribes all subscribers by clearing the subscribers array.
+     *
+     * @remarks
+     * This method sets the `subscribers` array to an empty array, effectively removing all current subscribers.
+     */
+    unsubscribeAll(): void;
+    private unsubscribe;
+}
+/**
+ * Merges multiple observables into a single observable.
+ *
+ * @template T - The type of the values emitted by the observables.
+ * @param {...Observable[]} observables - The observables to merge.
+ * @returns {Observable} A new observable that emits values from all input observables.
+ */
+export declare function merge<T>(...observables: Array<Observable<T>>): Observable<T>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.14.0";
+export declare const VERSION = "1.14.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-core",
-  "version": "1.14.0",
+  "version": "1.14.2",
   "description": "Core package of Faro.",
   "engines": {
     "node": ">=18.0.0"
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "27e390456e4449ca286a70b9d74022b0e960074e"
+  "gitHead": "b115e12fe1242e502d57ef5f8439a326a80dd6b7"
 }