@grafana/faro-core 1.12.3 → 1.13.0

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

@@ -1,10 +1,20 @@
-import type { MetaSession, MetaUser, MetaView } from '../../metas';
+import type { MetaOverrides, MetaPage, MetaSession, MetaUser, MetaView } from '../../metas';
 export interface MetaAPI {
     setUser: (user?: MetaUser | undefined) => void;
     resetUser: () => void;
-    setSession: (session?: MetaSession | undefined) => void;
+    setSession: (session?: MetaSession | undefined, options?: {
+        overrides: MetaOverrides;
+    }) => void;
     resetSession: () => void;
     getSession: () => MetaSession | undefined;
-    setView: (view?: MetaView | undefined) => void;
+    setView: (view?: MetaView | undefined, options?: {
+        overrides: MetaOverrides;
+    }) => void;
     getView: () => MetaView | undefined;
+    /**
+     * If a string is provided, it will be used as the page id.
+     * @returns
+     */
+    setPage: (page?: MetaPage | string | undefined) => void;
+    getPage: () => MetaPage | undefined;
 }

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

@@ -1,7 +1,7 @@
 import type { APIEvent, LogArgsSerializer, StacktraceParser } from '../api';
 import type { Instrumentation } from '../instrumentations';
 import type { InternalLoggerLevel } from '../internalLogger';
-import type { Meta, MetaApp, MetaItem, MetaSession, MetaUser, MetaView } from '../metas';
+import type { Meta, MetaApp, MetaItem, MetaPage, MetaSession, MetaUser, MetaView } from '../metas';
 import type { BatchExecutorOptions, BeforeSendHook, Transport } from '../transports';
 import type { UnpatchedConsole } from '../unpatchedConsole';
 import type { LogLevel } from '../utils';
@@ -151,6 +151,26 @@ export interface Config<P = APIEvent> {
          */
         disabledLevels?: LogLevel[];
         consoleErrorAsLog?: boolean;
+        /**
+         * If true, use the default Faro error serializer for console.error calls. If false, simply call toString() on the error arguments.
+         * If enabled, payloads containing serialized errors may become very large. If left disabled, some error details may be lost.
+         * (default: false)
+         */
+        serializeErrors?: boolean;
+        /**
+         * Custom function to serialize Error arguments
+         */
+        errorSerializer?: LogArgsSerializer;
+    };
+    pageTracking?: {
+        /**
+         * The page meta for initial page settings
+         */
+        page?: MetaPage;
+        /**
+         * Allows to provide a template for the page id
+         */
+        generatePageId?: (location: Location) => string;
     };
 }
 export type Patterns = Array<string | RegExp>;

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

@@ -1 +1,2 @@
 export declare const defaultExceptionType = "Error";
+export declare const defaultErrorArgsSerializer: (args: [any?, ...any[]]) => string;

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

@@ -1,3 +1,3 @@
-export { defaultExceptionType } from './const';
+export { defaultExceptionType, defaultErrorArgsSerializer } from './const';
 export { initializeExceptionsAPI } from './initialize';
 export type { ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, PushErrorOptions, Stacktrace, StacktraceParser, ErrorWithIndexProperties, } from './types';

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

@@ -1,7 +1,7 @@
 export { initializeAPI } from './initialize';
 export type { API, APIEvent } from './types';
 export type { EventAttributes, EventEvent, EventsAPI, PushEventOptions } from './events';
-export { defaultExceptionType } from './exceptions';
+export { defaultExceptionType, defaultErrorArgsSerializer } from './exceptions';
 export type { ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, PushErrorOptions, Stacktrace, StacktraceParser, } from './exceptions';
 export { defaultLogArgsSerializer } from './logs';
 export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions } from './logs';

package/dist/types/core/src/api/meta/initilialize.test.d.ts

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

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

@@ -1,10 +1,20 @@
-import type { MetaSession, MetaUser, MetaView } from '../../metas';
+import type { MetaOverrides, MetaPage, MetaSession, MetaUser, MetaView } from '../../metas';
 export interface MetaAPI {
     setUser: (user?: MetaUser | undefined) => void;
     resetUser: () => void;
-    setSession: (session?: MetaSession | undefined) => void;
+    setSession: (session?: MetaSession | undefined, options?: {
+        overrides: MetaOverrides;
+    }) => void;
     resetSession: () => void;
     getSession: () => MetaSession | undefined;
-    setView: (view?: MetaView | undefined) => void;
+    setView: (view?: MetaView | undefined, options?: {
+        overrides: MetaOverrides;
+    }) => void;
     getView: () => MetaView | undefined;
+    /**
+     * If a string is provided, it will be used as the page id.
+     * @returns
+     */
+    setPage: (page?: MetaPage | string | undefined) => void;
+    getPage: () => MetaPage | undefined;
 }

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

@@ -1,7 +1,7 @@
 import type { APIEvent, LogArgsSerializer, StacktraceParser } from '../api';
 import type { Instrumentation } from '../instrumentations';
 import type { InternalLoggerLevel } from '../internalLogger';
-import type { Meta, MetaApp, MetaItem, MetaSession, MetaUser, MetaView } from '../metas';
+import type { Meta, MetaApp, MetaItem, MetaPage, MetaSession, MetaUser, MetaView } from '../metas';
 import type { BatchExecutorOptions, BeforeSendHook, Transport } from '../transports';
 import type { UnpatchedConsole } from '../unpatchedConsole';
 import type { LogLevel } from '../utils';
@@ -151,6 +151,26 @@ export interface Config<P = APIEvent> {
          */
         disabledLevels?: LogLevel[];
         consoleErrorAsLog?: boolean;
+        /**
+         * If true, use the default Faro error serializer for console.error calls. If false, simply call toString() on the error arguments.
+         * If enabled, payloads containing serialized errors may become very large. If left disabled, some error details may be lost.
+         * (default: false)
+         */
+        serializeErrors?: boolean;
+        /**
+         * Custom function to serialize Error arguments
+         */
+        errorSerializer?: LogArgsSerializer;
+    };
+    pageTracking?: {
+        /**
+         * The page meta for initial page settings
+         */
+        page?: MetaPage;
+        /**
+         * Allows to provide a template for the page id
+         */
+        generatePageId?: (location: Location) => string;
     };
 }
 export type Patterns = Array<string | RegExp>;

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

@@ -1,4 +1,4 @@
-export { defaultExceptionType, defaultLogArgsSerializer } from './api';
+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 { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
@@ -11,7 +11,7 @@ export { BaseInstrumentation } from './instrumentations';
 export type { Instrumentation, Instrumentations } from './instrumentations';
 export { createInternalLogger, defaultInternalLoggerLevel, InternalLoggerLevel } from './internalLogger';
 export type { InternalLogger } from './internalLogger';
-export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, } from './metas';
+export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, MetaOverrides, } from './metas';
 export { faro, getInternalFaroFromGlobalObject, internalGlobalObjectKey, isInternalFaroOnGlobalObject, setInternalFaroOnGlobalObject, } from './sdk';
 export type { Faro } from './sdk';
 export * from './semantic';
@@ -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, } 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, } from './utils';
 export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, } from './utils';
 export { VERSION } from './version';
 export { unknownString } from './consts';

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

@@ -1,3 +1,3 @@
 export { initializeMetas } from './initialize';
 export { registerInitialMetas } from './registerInitial';
-export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaK6, MetaPage, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, Metas, } from './types';
+export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaK6, MetaPage, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, Metas, MetaOverrides, } from './types';

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

@@ -35,6 +35,7 @@ export interface MetaUser {
 export interface MetaSession {
     id?: string;
     attributes?: MetaAttributes;
+    overrides?: MetaOverrides;
 }
 export interface MetaPage {
     id?: string;
@@ -73,4 +74,10 @@ export interface Meta {
     view?: MetaView;
     k6?: MetaK6;
 }
+/**
+ * Overrides are instructions that allow the receiver to override certain properties.
+ */
+export type MetaOverrides = {
+    serviceName?: string;
+};
 export {};

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

@@ -18,4 +18,5 @@ export declare const EVENT_VIEW_CHANGED = "view_changed";
 export declare const EVENT_SESSION_START = "session_start";
 export declare const EVENT_SESSION_RESUME = "session_resume";
 export declare const EVENT_SESSION_EXTEND = "session_extend";
+export declare const EVENT_OVERRIDES_SERVICE_NAME = "service_name_override";
 export declare const EVENT_ROUTE_CHANGE = "route_change";

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

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

@@ -1,7 +1,7 @@
 export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue } from './baseObject';
 export { deepEqual } from './deepEqual';
 export { getCurrentTimestamp } from './date';
-export { 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, } from './is';
+export { 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, isEmpty, } from './is';
 export type { IsFnHelper } from './is';
 export { allLogLevels, defaultLogLevel, LogLevel } from './logLevels';
 export { noop } from './noop';
@@ -10,3 +10,4 @@ export type { BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer }
 export { genShortID } from './shortId';
 export { getBundleId } from './sourceMaps';
 export { dateNow } from './date';
+export { getCircularDependencyReplacer, stringifyExternalJson } from './json';

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

@@ -29,3 +29,4 @@ export declare const isElement: IsFnHelper<Element>;
 export declare const isMapDefined: boolean;
 export declare const isMap: IsFnHelper<Map<any, any>>;
 export declare const isSyntheticEvent: IsFnHelper<Event>;
+export declare function isEmpty(value: any): boolean;

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

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

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

@@ -0,0 +1,2 @@
+export declare function getCircularDependencyReplacer(): (_key: string | Symbol, value: unknown) => unknown;
+export declare function stringifyExternalJson(json?: any): string;

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

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

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

@@ -1 +1 @@
-export declare const VERSION = "1.12.3";
+export declare const VERSION = "1.13.0";

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { defaultExceptionType, defaultLogArgsSerializer } from './api';
+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 { BaseExtension } from './extensions';
 export type { Extension } from './extensions';
@@ -11,7 +11,7 @@ export { BaseInstrumentation } from './instrumentations';
 export type { Instrumentation, Instrumentations } from './instrumentations';
 export { createInternalLogger, defaultInternalLoggerLevel, InternalLoggerLevel } from './internalLogger';
 export type { InternalLogger } from './internalLogger';
-export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, } from './metas';
+export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, MetaOverrides, } from './metas';
 export { faro, getInternalFaroFromGlobalObject, internalGlobalObjectKey, isInternalFaroOnGlobalObject, setInternalFaroOnGlobalObject, } from './sdk';
 export type { Faro } from './sdk';
 export * from './semantic';
@@ -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, } 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, } from './utils';
 export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer, } from './utils';
 export { VERSION } from './version';
 export { unknownString } from './consts';

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

@@ -1,3 +1,3 @@
 export { initializeMetas } from './initialize';
 export { registerInitialMetas } from './registerInitial';
-export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaK6, MetaPage, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, Metas, } from './types';
+export type { Meta, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaK6, MetaPage, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, Metas, MetaOverrides, } from './types';

package/dist/types/metas/types.d.ts

@@ -35,6 +35,7 @@ export interface MetaUser {
 export interface MetaSession {
     id?: string;
     attributes?: MetaAttributes;
+    overrides?: MetaOverrides;
 }
 export interface MetaPage {
     id?: string;
@@ -73,4 +74,10 @@ export interface Meta {
     view?: MetaView;
     k6?: MetaK6;
 }
+/**
+ * Overrides are instructions that allow the receiver to override certain properties.
+ */
+export type MetaOverrides = {
+    serviceName?: string;
+};
 export {};

package/dist/types/semantic.d.ts

@@ -18,4 +18,5 @@ export declare const EVENT_VIEW_CHANGED = "view_changed";
 export declare const EVENT_SESSION_START = "session_start";
 export declare const EVENT_SESSION_RESUME = "session_resume";
 export declare const EVENT_SESSION_EXTEND = "session_extend";
+export declare const EVENT_OVERRIDES_SERVICE_NAME = "service_name_override";
 export declare const EVENT_ROUTE_CHANGE = "route_change";

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

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

@@ -1,7 +1,7 @@
 export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue } from './baseObject';
 export { deepEqual } from './deepEqual';
 export { getCurrentTimestamp } from './date';
-export { 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, } from './is';
+export { 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, isEmpty, } from './is';
 export type { IsFnHelper } from './is';
 export { allLogLevels, defaultLogLevel, LogLevel } from './logLevels';
 export { noop } from './noop';
@@ -10,3 +10,4 @@ export type { BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer }
 export { genShortID } from './shortId';
 export { getBundleId } from './sourceMaps';
 export { dateNow } from './date';
+export { getCircularDependencyReplacer, stringifyExternalJson } from './json';

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

@@ -29,3 +29,4 @@ export declare const isElement: IsFnHelper<Element>;
 export declare const isMapDefined: boolean;
 export declare const isMap: IsFnHelper<Map<any, any>>;
 export declare const isSyntheticEvent: IsFnHelper<Event>;
+export declare function isEmpty(value: any): boolean;

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

@@ -0,0 +1,2 @@
+export declare function getCircularDependencyReplacer(): (_key: string | Symbol, value: unknown) => unknown;
+export declare function stringifyExternalJson(json?: any): string;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.12.3";
+export declare const VERSION = "1.13.0";

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@grafana/faro-core",
-  "version": "1.12.3",
+  "version": "1.13.0",
   "description": "Core package of Faro.",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "keywords": [
     "observability",
     "apm",
@@ -60,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a0caa5a8c08398394e3a140465d6f9007754be2e"
+  "gitHead": "6cd423ffab2f4218c81d624577958d3140a438ba"
 }