@grafana/faro-core 1.13.3 → 1.14.1

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

@@ -1,20 +1,21 @@
 import type { MetaOverrides, MetaPage, MetaSession, MetaUser, MetaView } from '../../metas';
+type OverridesAvailableThroughApi = Pick<MetaOverrides, 'serviceName'>;
 export interface MetaAPI {
     setUser: (user?: MetaUser | undefined) => void;
     resetUser: () => void;
     setSession: (session?: MetaSession | undefined, options?: {
-        overrides: MetaOverrides;
+        overrides: OverridesAvailableThroughApi;
     }) => void;
     resetSession: () => void;
     getSession: () => MetaSession | undefined;
     setView: (view?: MetaView | undefined, options?: {
-        overrides: MetaOverrides;
+        overrides: OverridesAvailableThroughApi;
     }) => 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;
 }
+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 {};

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

@@ -138,12 +138,28 @@ export interface Config<P = APIEvent> {
      * Track web vitals attribution data (default: false)
      */
     trackWebVitalsAttribution?: boolean;
+    /**
+     * Configuration for the web vitals instrumentation
+     */
+    webVitalsInstrumentation?: {
+        /**
+         * Report all changes for web vitals (default: false)
+         *
+         * In most cases, you only want the callback function to be called when the metric is ready to be reported.
+         * However, it is possible to report every change (e.g. each larger layout shift as it happens)
+         * by setting reportAllChanges to true.
+         *
+         * This can be useful when debugging, but in general using reportAllChanges is not needed (or recommended)
+         * for measuring these metrics in production.
+         */
+        reportAllChanges?: boolean;
+    };
     /**
      * Configuration for the console instrumentation
      */
     consoleInstrumentation?: {
         /**
-         * Configure what console levels should be captured by Faro. By default the follwoing levels
+         * Configure what console levels should be captured by Faro. By default the following levels
          * are disabled: console.debug, console.trace, console.log
          *
          * If you want to collect all levels set captureConsoleDisabledLevels: [];
@@ -162,6 +178,9 @@ export interface Config<P = APIEvent> {
          */
         errorSerializer?: LogArgsSerializer;
     };
+    /**
+     * Configuration for the page tracking
+     */
     pageTracking?: {
         /**
          * The page meta for initial page settings
@@ -172,6 +191,19 @@ export interface Config<P = APIEvent> {
          */
         generatePageId?: (location: Location) => string;
     };
+    /**
+     * Configuration for the location tracking (Grafana cloud only)
+     */
+    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;
+    };
 }
 export type Patterns = Array<string | RegExp>;
 export {};

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

@@ -27,9 +27,33 @@ export interface MetaApp {
     bundleId?: string;
 }
 export interface MetaUser {
+    /**
+     * User email address.
+     */
     email?: string;
+    /**
+     * Unique identifier
+     */
     id?: string;
+    /**
+     * Short name or login/username of the user.
+     */
     username?: string;
+    /**
+     * User’s full name
+     */
+    fullName?: string;
+    /**
+     * comma separated list of user roles. "admin",editor" etc.
+     */
+    roles?: string;
+    /**
+     * Unique user hash to correlate information for a user in anonymized form.
+     */
+    hash?: string;
+    /**
+     * arbitrary user attributes, must be of type string.
+     */
     attributes?: MetaAttributes;
 }
 export interface MetaSession {
@@ -75,9 +99,20 @@ export interface Meta {
     k6?: MetaK6;
 }
 /**
- * Overrides are instructions that allow the receiver to override certain properties.
+ * MetaOverrides are instructions that allow the receiver to override certain properties (Grafana Cloud only).
  */
 export type MetaOverrides = {
+    /**
+     * New service name (Grafana Cloud only)
+     */
     serviceName?: string;
+    /**
+     * Enable or disable geolocation tracking (Grafana Cloud only).
+     * 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.
+     */
+    geoLocationTrackingEnabled?: boolean;
 };
 export {};

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.13.3";
+    readonly version = "1.14.1";
     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/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.13.3";
+export declare const VERSION = "1.14.1";

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

@@ -27,9 +27,33 @@ export interface MetaApp {
     bundleId?: string;
 }
 export interface MetaUser {
+    /**
+     * User email address.
+     */
     email?: string;
+    /**
+     * Unique identifier
+     */
     id?: string;
+    /**
+     * Short name or login/username of the user.
+     */
     username?: string;
+    /**
+     * User’s full name
+     */
+    fullName?: string;
+    /**
+     * comma separated list of user roles. "admin",editor" etc.
+     */
+    roles?: string;
+    /**
+     * Unique user hash to correlate information for a user in anonymized form.
+     */
+    hash?: string;
+    /**
+     * arbitrary user attributes, must be of type string.
+     */
     attributes?: MetaAttributes;
 }
 export interface MetaSession {
@@ -75,9 +99,20 @@ export interface Meta {
     k6?: MetaK6;
 }
 /**
- * Overrides are instructions that allow the receiver to override certain properties.
+ * MetaOverrides are instructions that allow the receiver to override certain properties (Grafana Cloud only).
  */
 export type MetaOverrides = {
+    /**
+     * New service name (Grafana Cloud only)
+     */
     serviceName?: string;
+    /**
+     * Enable or disable geolocation tracking (Grafana Cloud only).
+     * 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.
+     */
+    geoLocationTrackingEnabled?: boolean;
 };
 export {};

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.13.3";
+    readonly version = "1.14.1";
     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/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.13.3";
+export declare const VERSION = "1.14.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-core",
-  "version": "1.13.3",
+  "version": "1.14.1",
   "description": "Core package of Faro.",
   "engines": {
     "node": ">=18.0.0"
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4b4b38438abc72a7992bac93c7f23ac1793a9285"
+  "gitHead": "b44d0c2a52419786a497fbf3f47b781d27cc0982"
 }