@grafana/faro-web-sdk 1.14.3 → 1.16.0

package/dist/esm/utils/webStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"webStorage.js","sourceRoot":"","sources":["../../../src/utils/webStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE1C,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,gBAAgB;IACzB,KAAK,EAAE,cAAc;CACb,CAAC;AAIX;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAsB;;IAC1D,IAAI;QACF,IAAI,OAAO,CAAC;QACZ,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvB,MAAM,QAAQ,GAAG,uBAAuB,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;KACb;IAAC,OAAO,KAAK,EAAE;QACd,sBAAsB;QACtB,MAAA,IAAI,CAAC,cAAc,0CAAE,IAAI,CAAC,uBAAuB,IAAI,8BAA8B,KAAK,EAAE,CAAC,CAAC;QAC5F,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,mBAAqC;IACxE,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE;QAClD,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KACjD;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,mBAAqC;IACvF,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE;QAClD,IAAI;YACF,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACd,aAAa;SACd;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,mBAAqC;IAC3E,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE;QAClD,MAAM,CAAC,mBAAmB,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;KAC7C;AACH,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,qBAAqB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,qBAAqB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAEvF,SAAS,yBAAyB,CAAC,mBAAqC;IACtE,IAAI,mBAAmB,KAAK,cAAc,CAAC,KAAK,EAAE;QAChD,OAAO,uBAAuB,CAAC;KAChC;IAED,IAAI,mBAAmB,KAAK,cAAc,CAAC,OAAO,EAAE;QAClD,OAAO,yBAAyB,CAAC;KAClC;IAED,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { faro } from '@grafana/faro-core';\n\nexport const webStorageType = {\n  session: 'sessionStorage',\n  local: 'localStorage',\n} as const;\n\ntype StorageMechanism = (typeof webStorageType)[keyof typeof webStorageType];\n\n/**\n * Check if selected web storage mechanism is available.\n * @param type storage mechanism to test availability for.\n * @returns\n */\nexport function isWebStorageAvailable(type: StorageMechanism): boolean {\n  try {\n    let storage;\n    storage = window[type];\n\n    const testItem = '__faro_storage_test__';\n    storage.setItem(testItem, testItem);\n    storage.removeItem(testItem);\n    return true;\n  } catch (error) {\n    // the above can throw\n    faro.internalLogger?.info(`Web storage of type ${type} is not available. Reason: ${error}`);\n    return false;\n  }\n}\n\n/**\n * Get item from SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function getItem(key: string, webStorageMechanism: StorageMechanism): string | null {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    return window[webStorageMechanism].getItem(key);\n  }\n\n  return null;\n}\n\n/**\n * Store item in SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param value: the item data.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function setItem(key: string, value: string, webStorageMechanism: StorageMechanism): void {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    try {\n      window[webStorageMechanism].setItem(key, value);\n    } catch (error) {\n      // do nothing\n    }\n  }\n}\n\n/**\n * Remove item from SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function removeItem(key: string, webStorageMechanism: StorageMechanism): void {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    window[webStorageMechanism].removeItem(key);\n  }\n}\n\nexport const isLocalStorageAvailable = isWebStorageAvailable(webStorageType.local);\nexport const isSessionStorageAvailable = isWebStorageAvailable(webStorageType.session);\n\nfunction isWebStorageTypeAvailable(webStorageMechanism: StorageMechanism) {\n  if (webStorageMechanism === webStorageType.local) {\n    return isLocalStorageAvailable;\n  }\n\n  if (webStorageMechanism === webStorageType.session) {\n    return isSessionStorageAvailable;\n  }\n\n  return false;\n}\n"]}
+{"version":3,"file":"webStorage.js","sourceRoot":"","sources":["../../../src/utils/webStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE1C,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,gBAAgB;IACzB,KAAK,EAAE,cAAc;CACb,CAAC;AAIX;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAsB;;IAC1D,IAAI,CAAC;QACH,IAAI,OAAO,CAAC;QACZ,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvB,MAAM,QAAQ,GAAG,uBAAuB,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,sBAAsB;QACtB,MAAA,IAAI,CAAC,cAAc,0CAAE,IAAI,CAAC,uBAAuB,IAAI,8BAA8B,KAAK,EAAE,CAAC,CAAC;QAC5F,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,mBAAqC;IACxE,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACnD,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,mBAAqC;IACvF,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa;QACf,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,mBAAqC;IAC3E,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACnD,MAAM,CAAC,mBAAmB,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,qBAAqB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,qBAAqB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAEvF,SAAS,yBAAyB,CAAC,mBAAqC;IACtE,IAAI,mBAAmB,KAAK,cAAc,CAAC,KAAK,EAAE,CAAC;QACjD,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,IAAI,mBAAmB,KAAK,cAAc,CAAC,OAAO,EAAE,CAAC;QACnD,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { faro } from '@grafana/faro-core';\n\nexport const webStorageType = {\n  session: 'sessionStorage',\n  local: 'localStorage',\n} as const;\n\ntype StorageMechanism = (typeof webStorageType)[keyof typeof webStorageType];\n\n/**\n * Check if selected web storage mechanism is available.\n * @param type storage mechanism to test availability for.\n * @returns\n */\nexport function isWebStorageAvailable(type: StorageMechanism): boolean {\n  try {\n    let storage;\n    storage = window[type];\n\n    const testItem = '__faro_storage_test__';\n    storage.setItem(testItem, testItem);\n    storage.removeItem(testItem);\n    return true;\n  } catch (error) {\n    // the above can throw\n    faro.internalLogger?.info(`Web storage of type ${type} is not available. Reason: ${error}`);\n    return false;\n  }\n}\n\n/**\n * Get item from SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function getItem(key: string, webStorageMechanism: StorageMechanism): string | null {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    return window[webStorageMechanism].getItem(key);\n  }\n\n  return null;\n}\n\n/**\n * Store item in SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param value: the item data.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function setItem(key: string, value: string, webStorageMechanism: StorageMechanism): void {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    try {\n      window[webStorageMechanism].setItem(key, value);\n    } catch (error) {\n      // do nothing\n    }\n  }\n}\n\n/**\n * Remove item from SessionStorage or LocalStorage.\n * @param key: the item key.\n * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.\n */\nexport function removeItem(key: string, webStorageMechanism: StorageMechanism): void {\n  if (isWebStorageTypeAvailable(webStorageMechanism)) {\n    window[webStorageMechanism].removeItem(key);\n  }\n}\n\nexport const isLocalStorageAvailable = isWebStorageAvailable(webStorageType.local);\nexport const isSessionStorageAvailable = isWebStorageAvailable(webStorageType.session);\n\nfunction isWebStorageTypeAvailable(webStorageMechanism: StorageMechanism) {\n  if (webStorageMechanism === webStorageType.local) {\n    return isLocalStorageAvailable;\n  }\n\n  if (webStorageMechanism === webStorageType.session) {\n    return isSessionStorageAvailable;\n  }\n\n  return false;\n}\n"]}

package/dist/types/index.d.ts

@@ -7,8 +7,8 @@ export type { ConsoleInstrumentationOptions, ErrorEvent, ExtendedPromiseRejectio
 export { browserMeta, createSession, sdkMeta } from './metas';
 export { ConsoleTransport, FetchTransport } from './transports';
 export type { ClockFn, ConsoleTransportOptions, FetchTransportOptions, FetchTransportRequestOptions, } from './transports';
-export { faro, allLogLevels, BaseExtension, BaseInstrumentation, BaseTransport, Conventions, createInternalLogger, createPromiseBuffer, deepEqual, defaultExceptionType, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogLevel, genShortID, getCurrentTimestamp, getInternalFaroFromGlobalObject, getTransportBody, globalObject, internalGlobalObjectKey, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isInternalFaroOnGlobalObject, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, isEmpty, InternalLoggerLevel, LogLevel, noop, setInternalFaroOnGlobalObject, TransportItemType, transportItemTypeToBodyKey, VERSION, EVENT_CLICK, EVENT_NAVIGATION, EVENT_ROUTE_CHANGE, EVENT_SESSION_EXTEND, EVENT_SESSION_RESUME, EVENT_SESSION_START, EVENT_VIEW_CHANGED, apiMessageBus, Observable, merge, USER_ACTION_CANCEL_MESSAGE_TYPE, USER_ACTION_END_MESSAGE_TYPE, USER_ACTION_START_MESSAGE_TYPE, } from '@grafana/faro-core';
+export { faro, allLogLevels, BaseExtension, BaseInstrumentation, BaseTransport, Conventions, createInternalLogger, createPromiseBuffer, deepEqual, defaultExceptionType, defaultGlobalObjectKey, defaultInternalLoggerLevel, defaultLogLevel, genShortID, getCurrentTimestamp, getInternalFaroFromGlobalObject, getTransportBody, globalObject, internalGlobalObjectKey, isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isInternalFaroOnGlobalObject, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, isEmpty, InternalLoggerLevel, LogLevel, noop, setInternalFaroOnGlobalObject, TransportItemType, transportItemTypeToBodyKey, VERSION, EVENT_CLICK, EVENT_NAVIGATION, EVENT_ROUTE_CHANGE, EVENT_SESSION_EXTEND, EVENT_SESSION_RESUME, EVENT_SESSION_START, EVENT_VIEW_CHANGED, apiMessageBus, Observable, USER_ACTION_CANCEL, USER_ACTION_END, USER_ACTION_START, } from '@grafana/faro-core';
 export type { Faro, API, APIEvent, BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue, BeforeSendHook, BufferItem, Config, EventAttributes, EventEvent, EventsAPI, ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, Extension, GlobalObject, Instrumentation, Instrumentations, InternalLogger, LogContext, LogEvent, LogsAPI, MeasurementEvent, MeasurementsAPI, Meta, MetaAPI, MetaApp, MetaAttributes, MetaBrowser, MetaGetter, MetaItem, MetaPage, Metas, MetaSDK, MetaSDKIntegration, MetaSession, MetaUser, MetaView, OTELApi, Patterns, PromiseBuffer, PromiseBufferOptions, PromiseProducer, PushErrorOptions, PushLogOptions, PushMeasurementOptions, Stacktrace, StacktraceParser, TraceContext, TraceEvent, TracesAPI, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, UnpatchedConsole, ApiMessageBusMessages, UserActionStartMessage, UserActionEndMessage, UserActionCancelMessage, UserAction, } from '@grafana/faro-core';
 export { PersistentSessionsManager, VolatileSessionsManager, MAX_SESSION_PERSISTENCE_TIME, MAX_SESSION_PERSISTENCE_TIME_BUFFER, SESSION_EXPIRATION_TIME, SESSION_INACTIVITY_TIME, STORAGE_KEY, } from './instrumentations/session';
-export { getIgnoreUrls } from './utils/url';
-export { userActionDataAttribute } from './instrumentations/userActions/const';
+export { getIgnoreUrls, getUrlFromResource } from './utils/url';
+export { userActionDataAttribute, startUserAction } from './instrumentations/userActions';

package/dist/types/instrumentations/console/instrumentation.d.ts

@@ -3,7 +3,7 @@ import type { ConsoleInstrumentationOptions } from './types';
 export declare class ConsoleInstrumentation extends BaseInstrumentation {
     private options;
     readonly name = "@grafana/faro-web-sdk:instrumentation-console";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     static defaultDisabledLevels: LogLevel[];
     static consoleErrorPrefix: string;
     private errorSerializer;

package/dist/types/instrumentations/errors/instrumentation.d.ts

@@ -1,6 +1,6 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class ErrorsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-errors";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     initialize(): void;
 }

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

@@ -7,4 +7,4 @@ export { ViewInstrumentation } from './view';
 export { WebVitalsInstrumentation } from './webVitals';
 export { PersistentSessionsManager, VolatileSessionsManager, MAX_SESSION_PERSISTENCE_TIME, MAX_SESSION_PERSISTENCE_TIME_BUFFER, SESSION_EXPIRATION_TIME, SESSION_INACTIVITY_TIME, STORAGE_KEY, } from './session';
 export { PerformanceInstrumentation } from './performance';
-export { UserActionInstrumentation, userActionDataAttribute } from './userActions';
+export { UserActionInstrumentation, userActionDataAttribute, startUserAction } from './userActions';

package/dist/types/instrumentations/performance/instrumentation.d.ts

@@ -3,6 +3,6 @@ import type { ResourceEntryMessage } from './types';
 export declare const performanceEntriesSubscription: Observable<ResourceEntryMessage>;
 export declare class PerformanceInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-performance";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     initialize(): void;
 }

package/dist/types/instrumentations/session/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class SessionInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-session";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     private notifiedSession;
     private sendSessionStartEvent;
     private createInitialSession;

package/dist/types/instrumentations/session/sessionManager/sessionManagerUtils.d.ts

@@ -1,4 +1,4 @@
-import { Meta } from '@grafana/faro-core';
+import type { Meta } from '@grafana/faro-core';
 import type { FaroUserSession } from './types';
 type CreateUserSessionObjectParams = {
     sessionId?: string;

package/dist/types/instrumentations/userActions/const.d.ts

@@ -1,7 +1,6 @@
 export declare const MESSAGE_TYPE_RESOURCE_ENTRY = "resource-entry";
 export declare const MESSAGE_TYPE_HTTP_REQUEST_START = "http-request-start";
 export declare const MESSAGE_TYPE_HTTP_REQUEST_END = "http-request-end";
-export declare const MESSAGE_TYPE_HTTP_REQUEST_PENDING = "http-request-pending";
 export declare const MESSAGE_TYPE_DOM_MUTATION = "dom-mutation";
 export declare const userActionDataAttributeParsed = "faroUserActionName";
 export declare const userActionDataAttribute = "data-faro-user-action-name";

package/dist/types/instrumentations/userActions/httpRequestMonitor.d.ts

@@ -1,5 +1,6 @@
 import { Observable } from '@grafana/faro-core';
+import type { HttpRequestEndMessage, HttpRequestStartMessage } from './types';
 /**
  * Monitors if any http requests are in progress.
  */
-export declare function monitorHttpRequests(): Observable;
+export declare function monitorHttpRequests(): Observable<HttpRequestStartMessage | HttpRequestEndMessage>;

package/dist/types/instrumentations/userActions/index.d.ts

@@ -1,3 +1,3 @@
-export { UserActionInstrumentation } from './instrumentation';
-export type { DomMutationMessage, HttpRequestEndMessage, HttpRequestStartMessage } from './types';
+export { UserActionInstrumentation, startUserAction } from './instrumentation';
+export type { DomMutationMessage, HttpRequestEndMessage, HttpRequestStartMessage, HttpRequestMessagePayload, } from './types';
 export { MESSAGE_TYPE_DOM_MUTATION, MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_TYPE_HTTP_REQUEST_START, userActionDataAttribute, } from './const';

package/dist/types/instrumentations/userActions/instrumentation.d.ts

@@ -1,6 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class UserActionInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-user-action";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     initialize(): void;
 }
+export declare function startUserAction(name: string, attributes?: Record<string, string>): void;

package/dist/types/instrumentations/userActions/processUserActionEventHandler.d.ts

@@ -1,2 +1,3 @@
-import { Faro } from '@grafana/faro-core';
-export declare function getUserEventHandler(faro: Faro): (event: PointerEvent | KeyboardEvent) => void;
+import type { Faro } from '@grafana/faro-core';
+import type { ApiEvent } from './types';
+export declare function getUserEventHandler(faro: Faro): (event: PointerEvent | KeyboardEvent | ApiEvent) => void;

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

@@ -2,11 +2,24 @@ import type { MESSAGE_TYPE_DOM_MUTATION, MESSAGE_TYPE_HTTP_REQUEST_END, MESSAGE_
 export type DomMutationMessage = {
     type: typeof MESSAGE_TYPE_DOM_MUTATION;
 };
+type RequestApiType = 'xhr' | 'fetch';
+export type HttpRequestMessagePayload = {
+    requestId: string;
+    url: string;
+    method: string;
+    apiType: RequestApiType;
+};
 export type HttpRequestStartMessage = {
     type: typeof MESSAGE_TYPE_HTTP_REQUEST_START;
-    pending: number;
+    request: HttpRequestMessagePayload;
 };
 export type HttpRequestEndMessage = {
     type: typeof MESSAGE_TYPE_HTTP_REQUEST_END;
-    pending: number;
+    request: HttpRequestMessagePayload;
+};
+export type ApiEvent = {
+    name: string;
+    attributes?: Record<string, string>;
+    type: 'apiEvent';
 };
+export {};

package/dist/types/instrumentations/view/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class ViewInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-view";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     private notifiedView;
     private sendViewChangedEvent;
     initialize(): void;

package/dist/types/instrumentations/webVitals/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class WebVitalsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-web-vitals";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     initialize(): void;
     private intializeWebVitalsInstrumentation;
 }

package/dist/types/instrumentations/webVitals/webVitalsBasic.d.ts

@@ -1,17 +1,15 @@
-import type { MeasurementsAPI } from '@grafana/faro-core';
+import type { Config, MeasurementsAPI } from '@grafana/faro-core';
 export declare class WebVitalsBasic {
     private pushMeasurement;
     private webVitalConfig?;
     static mapping: {
-        cls: (onReport: (metric: import("web-vitals").CLSMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        fcp: (onReport: (metric: import("web-vitals").FCPMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        fid: (onReport: (metric: import("web-vitals").FIDMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        inp: (onReport: (metric: import("web-vitals").INPMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        lcp: (onReport: (metric: import("web-vitals").LCPMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        ttfb: (onReport: (metric: import("web-vitals").TTFBMetric) => void, opts?: import("web-vitals").ReportOpts | undefined) => void;
+        cls: (onReport: (metric: import("web-vitals").CLSMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
+        fcp: (onReport: (metric: import("web-vitals").FCPMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
+        fid: (onReport: (metric: import("web-vitals").FIDMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
+        inp: (onReport: (metric: import("web-vitals").INPMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
+        lcp: (onReport: (metric: import("web-vitals").LCPMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
+        ttfb: (onReport: (metric: import("web-vitals").TTFBMetric) => void, opts?: import("web-vitals").ReportOpts) => void;
     };
-    constructor(pushMeasurement: MeasurementsAPI['pushMeasurement'], webVitalConfig?: {
-        reportAllChanges?: boolean | undefined;
-    } | undefined);
+    constructor(pushMeasurement: MeasurementsAPI['pushMeasurement'], webVitalConfig?: Config['webVitalsInstrumentation']);
     initialize(): void;
 }

package/dist/types/instrumentations/webVitals/webVitalsWithAttribution.d.ts

@@ -1,10 +1,8 @@
-import type { MeasurementsAPI } from '@grafana/faro-core';
+import type { Config, MeasurementsAPI } from '@grafana/faro-core';
 export declare class WebVitalsWithAttribution {
     private corePushMeasurement;
     private webVitalConfig?;
-    constructor(corePushMeasurement: MeasurementsAPI['pushMeasurement'], webVitalConfig?: {
-        reportAllChanges?: boolean | undefined;
-    } | undefined);
+    constructor(corePushMeasurement: MeasurementsAPI['pushMeasurement'], webVitalConfig?: Config['webVitalsInstrumentation']);
     initialize(): void;
     private measureCLS;
     private measureFCP;

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

@@ -4,7 +4,7 @@ import type { ConsoleTransportOptions } from './types';
 export declare class ConsoleTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-console";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     constructor(options?: ConsoleTransportOptions);
     send(item: TransportItem): void;
 }

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

@@ -1,10 +1,10 @@
-import { BaseTransport, PromiseBuffer } from '@grafana/faro-core';
-import type { Patterns, TransportItem } from '@grafana/faro-core';
+import { BaseTransport } from '@grafana/faro-core';
+import type { Patterns, PromiseBuffer, TransportItem } from '@grafana/faro-core';
 import type { FetchTransportOptions } from './types';
 export declare class FetchTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-fetch";
-    readonly version = "1.14.3";
+    readonly version = "1.16.0";
     promiseBuffer: PromiseBuffer<Response | void>;
     private readonly rateLimitBackoffMs;
     private readonly getNow;

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

@@ -1,3 +1,3 @@
 export { getItem, isLocalStorageAvailable, isSessionStorageAvailable, isWebStorageAvailable, removeItem, setItem, webStorageType, } from './webStorage';
 export { throttle } from './throttle';
-export { getIgnoreUrls } from './url';
+export { getIgnoreUrls, getUrlFromResource } from './url';

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

@@ -12,3 +12,11 @@ export declare function getIgnoreUrls(): Patterns;
  * @returns `true` if the URL is in the list of ignored URLs, `false` otherwise.
  */
 export declare function isUrlIgnored(url?: string): boolean;
+/**
+ * Extracts a URL string from the given resource.
+ *
+ * @param resource - The input resource which can be a string, a URL object, or an object with a `toString` method.
+ * @returns The URL as a string if the resource is a valid URL-like object, or `undefined` if the resource is not valid.
+ *
+ */
+export declare function getUrlFromResource(resource: any): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-web-sdk",
-  "version": "1.14.3",
+  "version": "1.16.0",
   "description": "Faro instrumentations, metas, transports for web.",
   "engines": {
     "node": ">=18.0.0"
@@ -55,7 +55,7 @@
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
-    "@grafana/faro-core": "^1.14.3",
+    "@grafana/faro-core": "^1.16.0",
     "ua-parser-js": "^1.0.32",
     "web-vitals": "^4.0.1"
   },
@@ -67,5 +67,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "eaad1e4e4889aaa9a5a3539e169edc025d993ab0"
+  "gitHead": "4b902517e4f28c703ac3db1154209abe25e5216b"
 }