@grafana/faro-web-sdk 1.2.1 → 1.2.3

package/dist/esm/utils/webStorage.js

@@ -0,0 +1,40 @@
+import { faro } from '@grafana/faro-core';
+export function isWebStorageAvailable(type) {
+    var _a;
+    try {
+        let storage;
+        storage = window[type];
+        const testItem = '__faro_storage_test__';
+        storage.setItem(testItem, testItem);
+        storage.removeItem(testItem);
+        return true;
+    }
+    catch (error) {
+        // the above can throw
+        (_a = faro.internalLogger) === null || _a === void 0 ? void 0 : _a.info(`Web storage of type ${type} is not available. Reason: ${error}`);
+        return false;
+    }
+}
+export const isLocalStorageAvailable = isWebStorageAvailable('localStorage');
+export function getItem(key) {
+    if (isLocalStorageAvailable) {
+        return localStorage.getItem(key);
+    }
+    return null;
+}
+export function setItem(key, value) {
+    if (isLocalStorageAvailable) {
+        try {
+            localStorage.setItem(key, value);
+        }
+        catch (error) {
+            // do nothing
+        }
+    }
+}
+export function removeItem(key) {
+    if (isLocalStorageAvailable) {
+        localStorage.removeItem(key);
+    }
+}
+//# sourceMappingURL=webStorage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webStorage.js","sourceRoot":"","sources":["../../../src/utils/webStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAI1C,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,MAAM,CAAC,MAAM,uBAAuB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;AAE7E,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,IAAI,uBAAuB,EAAE;QAC3B,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAClC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,KAAa;IAChD,IAAI,uBAAuB,EAAE;QAC3B,IAAI;YACF,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAClC;QAAC,OAAO,KAAK,EAAE;YACd,aAAa;SACd;KACF;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,IAAI,uBAAuB,EAAE;QAC3B,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;KAC9B;AACH,CAAC","sourcesContent":["import { faro } from '@grafana/faro-core';\n\ntype StorageMechanism = 'sessionStorage' | 'localStorage';\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\nexport const isLocalStorageAvailable = isWebStorageAvailable('localStorage');\n\nexport function getItem(key: string): string | null {\n  if (isLocalStorageAvailable) {\n    return localStorage.getItem(key);\n  }\n\n  return null;\n}\n\nexport function setItem(key: string, value: string): void {\n  if (isLocalStorageAvailable) {\n    try {\n      localStorage.setItem(key, value);\n    } catch (error) {\n      // do nothing\n    }\n  }\n}\n\nexport function removeItem(key: string): void {\n  if (isLocalStorageAvailable) {\n    localStorage.removeItem(key);\n  }\n}\n"]}

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

@@ -5,6 +5,5 @@ export interface BrowserConfig extends Partial<Omit<Config, 'app' | 'parseStackt
 }
 export interface GetWebInstrumentationsOptions {
     captureConsole?: boolean;
-    capturePerformanceTimeline?: boolean;
     captureConsoleDisabledLevels?: LogLevel[];
 }

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.2.1";
+    readonly version = "1.2.3";
     static defaultDisabledLevels: LogLevel[];
     constructor(options?: ConsoleInstrumentationOptions);
     initialize(): void;

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.2.1";
+    readonly version = "1.2.3";
     initialize(): void;
 }

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

@@ -1 +1,2 @@
 export { SessionInstrumentation } from './instrumentation';
+export * from './sessionHandler';

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

@@ -1,8 +1,9 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class SessionInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-session";
-    readonly version = "1.2.1";
+    readonly version = "1.2.3";
     private notifiedSession;
+    private sessionUpdater;
     private sendSessionStartEvent;
     initialize(): void;
 }

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

@@ -0,0 +1,22 @@
+import { MetaSession } from '@grafana/faro-core';
+export interface FaroUserSession {
+    sessionId: string;
+    lastActivity: number;
+    started: number;
+    sessionMeta?: MetaSession;
+}
+export interface UserSessionUpdater {
+    handleUpdate: () => void;
+    init: () => void;
+}
+export declare const SESSION_EXPIRATION_TIME: number;
+export declare const SESSION_INACTIVITY_TIME: number;
+export declare const STORAGE_KEY = "__FARO_SESSION__";
+export declare function createUserSessionObject(sessionId?: string): FaroUserSession;
+export declare function removeUserSession(): void;
+export declare function storeUserSession(session: FaroUserSession): void;
+export declare function fetchUserSession(): FaroUserSession | null;
+export declare function isUserSessionValid(session: FaroUserSession | null): boolean;
+export declare function persistentUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
+export declare function inMemoryUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
+export declare function getSessionUpdater(initialSessionId?: string): UserSessionUpdater;

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.2.1";
+    readonly version = "1.2.3";
     private notifiedView;
     private sendViewChangedEvent;
     initialize(): void;

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

@@ -1,14 +1,14 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class WebVitalsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-web-vitals";
-    readonly version = "1.2.1";
+    readonly version = "1.2.3";
     static mapping: {
         cls: (onReport: import("web-vitals").CLSReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
         fcp: (onReport: import("web-vitals").FCPReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        fid: (onReport: import("web-vitals").ReportHandler, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        inp: (onReport: import("web-vitals").ReportHandler, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        lcp: (onReport: import("web-vitals").ReportHandler, opts?: import("web-vitals").ReportOpts | undefined) => void;
-        ttfb: (onReport: import("web-vitals").ReportHandler, opts?: import("web-vitals").ReportOpts | undefined) => void;
+        fid: (onReport: import("web-vitals").FIDReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
+        inp: (onReport: import("web-vitals").INPReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
+        lcp: (onReport: import("web-vitals").LCPReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
+        ttfb: (onReport: import("web-vitals").TTFBReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
     };
     initialize(): void;
 }

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

@@ -0,0 +1 @@
+export { k6Meta } from './meta';

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

@@ -0,0 +1,2 @@
+import type { Meta, MetaItem } from '@grafana/faro-core';
+export declare const k6Meta: MetaItem<Pick<Meta, 'k6'>>;

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.2.1";
+    readonly version = "1.2.3";
     constructor(options?: ConsoleTransportOptions);
     send(item: TransportItem): void;
 }

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

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

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

@@ -0,0 +1,2 @@
+export * from './webStorage';
+export * from './throttle';

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

@@ -0,0 +1,4 @@
+/**
+ * Tail based throttle which caches the args of the last call and updates
+ */
+export declare function throttle<T extends (...args: any[]) => void>(callback: T, delay: number): (...args: Parameters<T>) => void;

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

@@ -0,0 +1,7 @@
+type StorageMechanism = 'sessionStorage' | 'localStorage';
+export declare function isWebStorageAvailable(type: StorageMechanism): boolean;
+export declare const isLocalStorageAvailable: boolean;
+export declare function getItem(key: string): string | null;
+export declare function setItem(key: string, value: string): void;
+export declare function removeItem(key: string): void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-web-sdk",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Faro instrumentations, metas, transports for web.",
   "keywords": [
     "observability",
@@ -52,16 +52,16 @@
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
-    "@grafana/faro-core": "^1.2.1",
+    "@grafana/faro-core": "^1.2.3",
     "ua-parser-js": "^1.0.32",
     "web-vitals": "^3.1.1"
   },
   "devDependencies": {
     "@types/ua-parser-js": "^0.7.36",
-    "user-agent-data-types": "^0.3.1"
+    "user-agent-data-types": "^0.4.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8bc51d9bd142485d0dd5d5fbf1dfe805aa96bcc8"
+  "gitHead": "e15cdf130a4400c4e4f8d597b58a2dc7d488522a"
 }