@grafana/faro-react 1.4.2 → 1.5.0

package/dist/esm/router/v6/withFaroRouterInstrumentation.js

@@ -0,0 +1,28 @@
+import { EVENT_ROUTE_CHANGE, globalObject } from '@grafana/faro-web-sdk';
+import { api } from '../../dependencies';
+import { NavigationType } from '../types';
+import { isInitialized } from './routerDependencies';
+import { getRouteFromLocation } from './utils';
+/**
+ * To use with React Router 6.4 data APIs.
+ */
+export function withFaroRouterInstrumentation(router) {
+    let lastRoute = {};
+    router.subscribe((state) => {
+        var _a, _b;
+        const navigationType = state.historyAction;
+        const location = state.location;
+        const routes = router.routes;
+        if (isInitialized && (navigationType === NavigationType.Push || navigationType === NavigationType.Pop)) {
+            const route = getRouteFromLocation(routes, location);
+            const url = (_a = globalObject.location) === null || _a === void 0 ? void 0 : _a.href;
+            api.pushEvent(EVENT_ROUTE_CHANGE, Object.assign({ toRoute: route, toUrl: (_b = globalObject.location) === null || _b === void 0 ? void 0 : _b.href }, lastRoute));
+            lastRoute = {
+                fromRoute: route,
+                fromUrl: url,
+            };
+        }
+    });
+    return router;
+}
+//# sourceMappingURL=withFaroRouterInstrumentation.js.map

package/dist/esm/router/v6/withFaroRouterInstrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withFaroRouterInstrumentation.js","sourceRoot":"","sources":["../../../../src/router/v6/withFaroRouterInstrumentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAEzE,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,cAAc,EAAuB,MAAM,UAAU,CAAC;AAE/D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAa/C;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAA4B,MAAS;IAChF,IAAI,SAAS,GAAmC,EAAE,CAAC;IAEnD,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;;QACzB,MAAM,cAAc,GAAmB,KAAK,CAAC,aAAa,CAAC;QAC3D,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE7B,IAAI,aAAa,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,IAAI,cAAc,KAAK,cAAc,CAAC,GAAG,CAAC,EAAE;YACtG,MAAM,KAAK,GAAG,oBAAoB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,MAAA,YAAY,CAAC,QAAQ,0CAAE,IAAI,CAAC;YAExC,GAAG,CAAC,SAAS,CAAC,kBAAkB,kBAC9B,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,MAAA,YAAY,CAAC,QAAQ,0CAAE,IAAI,IAC/B,SAAS,EACZ,CAAC;YAEH,SAAS,GAAG;gBACV,SAAS,EAAE,KAAK;gBAChB,OAAO,EAAE,GAAG;aACb,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { EVENT_ROUTE_CHANGE, globalObject } from '@grafana/faro-web-sdk';\n\nimport { api } from '../../dependencies';\nimport { NavigationType, ReactRouterLocation } from '../types';\n\nimport { isInitialized } from './routerDependencies';\nimport type { EventRouteTransitionAttributes, ReactRouterV6RouteObject } from './types';\nimport { getRouteFromLocation } from './utils';\n\ninterface RouterState {\n  historyAction: NavigationType | any;\n  location: ReactRouterLocation;\n}\n\ninterface Router {\n  state: RouterState;\n  routes: ReactRouterV6RouteObject[];\n  subscribe(fn: (state: RouterState) => void): () => void;\n}\n\n/**\n * To use with React Router 6.4 data APIs.\n */\nexport function withFaroRouterInstrumentation<R extends Router = Router>(router: R) {\n  let lastRoute: EventRouteTransitionAttributes = {};\n\n  router.subscribe((state) => {\n    const navigationType: NavigationType = state.historyAction;\n    const location = state.location;\n    const routes = router.routes;\n\n    if (isInitialized && (navigationType === NavigationType.Push || navigationType === NavigationType.Pop)) {\n      const route = getRouteFromLocation(routes, location);\n      const url = globalObject.location?.href;\n\n      api.pushEvent(EVENT_ROUTE_CHANGE, {\n        toRoute: route,\n        toUrl: globalObject.location?.href,\n        ...lastRoute,\n      });\n\n      lastRoute = {\n        fromRoute: route,\n        fromUrl: url,\n      };\n    }\n  });\n\n  return router;\n}\n"]}

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ReactRouterV4V5Dependencies, ReactRouterV6Dependencies, ReactRouterVersion } from './router';\n\nexport interface ReactRouterV4V5Config {\n  version: ReactRouterVersion.V4 | ReactRouterVersion.V5;\n  dependencies: ReactRouterV4V5Dependencies;\n}\n\nexport interface ReactRouterV6Config {\n  version: ReactRouterVersion.V6;\n  dependencies: ReactRouterV6Dependencies;\n}\n\nexport interface ReactIntegrationConfig {\n  router?: ReactRouterV4V5Config | ReactRouterV6Config;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  ReactRouterV4V5Dependencies,\n  ReactRouterV6DataRouterDependencies,\n  ReactRouterV6Dependencies,\n  ReactRouterVersion,\n} from './router';\n\nexport interface ReactRouterV4V5Config {\n  version: ReactRouterVersion.V4 | ReactRouterVersion.V5;\n  dependencies: ReactRouterV4V5Dependencies;\n}\n\nexport interface ReactRouterV6Config {\n  version: ReactRouterVersion.V6;\n  dependencies: ReactRouterV6Dependencies;\n}\n\nexport interface ReactRouterV6DataRouterConfig {\n  version: ReactRouterVersion.V6_data_router;\n  dependencies: ReactRouterV6DataRouterDependencies;\n}\n\nexport interface ReactIntegrationConfig {\n  router?: ReactRouterV4V5Config | ReactRouterV6Config | ReactRouterV6DataRouterConfig;\n}\n"]}

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ export type { FaroErrorBoundaryFallbackRender, FaroErrorBoundaryProps, FaroError
 export { ReactIntegration } from './instrumentation';
 export { FaroProfiler, withFaroProfiler } from './profiler';
 export type { FaroProfilerProps } from './profiler';
-export { FaroRoute, FaroRoutes, NavigationType, ReactRouterVersion, setReactRouterV4V5SSRDependencies, setReactRouterV6SSRDependencies, } from './router';
+export { FaroRoute, FaroRoutes, NavigationType, ReactRouterVersion, setReactRouterV4V5SSRDependencies, setReactRouterV6SSRDependencies, withFaroRouterInstrumentation, } from './router';
 export type { ReactRouterHistory, ReactRouterLocation, ReactRouterV4V5ActiveEvent, ReactRouterV4V5Dependencies, ReactRouterV4V5RouteShape, ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6Params, ReactRouterV6RouteMatch, ReactRouterV6RouteObject, ReactRouterV6RoutesProps, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType, } from './router';
 export type { ReactIntegrationConfig, ReactRouterV4V5Config, ReactRouterV6Config } from './types';
 export { getMajorReactVersion, isReactVersionAtLeast, isReactVersionAtLeast16, isReactVersionAtLeast17, isReactVersionAtLeast18, reactVersion, reactVersionMajor, } from './utils';

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

@@ -3,5 +3,5 @@ export { NavigationType, ReactRouterVersion } from './types';
 export type { ReactRouterLocation, ReactRouterHistory } from './types';
 export { FaroRoute, setReactRouterV4V5SSRDependencies } from './v4v5';
 export type { ReactRouterV4V5ActiveEvent, ReactRouterV4V5Dependencies, ReactRouterV4V5RouteShape } from './v4v5';
-export { FaroRoutes, setReactRouterV6SSRDependencies } from './v6';
-export type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6Params, ReactRouterV6RouteMatch, ReactRouterV6RouteObject, ReactRouterV6RoutesProps, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType, } from './v6';
+export { FaroRoutes, setReactRouterV6SSRDependencies, withFaroRouterInstrumentation } from './v6';
+export type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6Params, ReactRouterV6RouteMatch, ReactRouterV6RouteObject, ReactRouterV6RoutesProps, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType, ReactRouterV6DataRouterDependencies, } from './v6';

package/dist/types/router/types.d.ts

@@ -12,7 +12,8 @@ export interface ReactRouterHistory extends Record<string, any> {
 export declare enum ReactRouterVersion {
     V4 = "v4",
     V5 = "v5",
-    V6 = "v6"
+    V6 = "v6",
+    V6_data_router = "v6_data_router"
 }
 export declare enum NavigationType {
     Pop = "POP",

package/dist/types/router/v6/index.d.ts

@@ -1,4 +1,5 @@
 export { FaroRoutes } from './FaroRoutes';
-export { initializeReactRouterV6Instrumentation } from './initialize';
+export { initializeReactRouterV6Instrumentation, initializeReactRouterV6DataRouterInstrumentation } from './initialize';
 export { setReactRouterV6SSRDependencies } from './routerDependencies';
-export type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6Params, ReactRouterV6RouteMatch, ReactRouterV6RouteObject, ReactRouterV6RoutesProps, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType, } from './types';
+export { withFaroRouterInstrumentation } from './withFaroRouterInstrumentation';
+export type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6Params, ReactRouterV6RouteMatch, ReactRouterV6RouteObject, ReactRouterV6RoutesProps, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType, ReactRouterV6DataRouterDependencies, } from './types';

package/dist/types/router/v6/initialize.d.ts

@@ -1,2 +1,3 @@
-import type { ReactRouterV6Dependencies } from './types';
+import type { ReactRouterV6DataRouterDependencies, ReactRouterV6Dependencies } from './types';
 export declare function initializeReactRouterV6Instrumentation(dependencies: ReactRouterV6Dependencies): void;
+export declare function initializeReactRouterV6DataRouterInstrumentation(dependencies: ReactRouterV6DataRouterDependencies): void;

package/dist/types/router/v6/routerDependencies.d.ts

@@ -1,4 +1,4 @@
-import type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType } from './types';
+import type { ReactRouterV6CreateRoutesFromChildren, ReactRouterV6DataRouterDependencies, ReactRouterV6Dependencies, ReactRouterV6MatchRoutes, ReactRouterV6RoutesShape, ReactRouterV6UseLocation, ReactRouterV6UseNavigationType } from './types';
 export declare let isInitialized: boolean;
 export declare let createRoutesFromChildren: ReactRouterV6CreateRoutesFromChildren;
 export declare let matchRoutes: ReactRouterV6MatchRoutes;
@@ -7,3 +7,4 @@ export declare let useLocation: ReactRouterV6UseLocation;
 export declare let useNavigationType: ReactRouterV6UseNavigationType;
 export declare function setReactRouterV6Dependencies(newDependencies: ReactRouterV6Dependencies): void;
 export declare function setReactRouterV6SSRDependencies(newDependencies: Pick<ReactRouterV6Dependencies, 'Routes'>): void;
+export declare function setReactRouterV6DataRouterDependencies(newDependencies: ReactRouterV6DataRouterDependencies): void;

package/dist/types/router/v6/types.d.ts

@@ -43,6 +43,9 @@ export interface ReactRouterV6Dependencies {
     useLocation: ReactRouterV6UseLocation;
     useNavigationType: ReactRouterV6UseNavigationType;
 }
+export interface ReactRouterV6DataRouterDependencies {
+    matchRoutes: ReactRouterV6MatchRoutes;
+}
 export type EventRouteTransitionAttributes = {
     fromRoute?: string;
     fromUrl?: string;

package/dist/types/router/v6/withFaroRouterInstrumentation.d.ts

@@ -0,0 +1,16 @@
+import { NavigationType, ReactRouterLocation } from '../types';
+import type { ReactRouterV6RouteObject } from './types';
+interface RouterState {
+    historyAction: NavigationType | any;
+    location: ReactRouterLocation;
+}
+interface Router {
+    state: RouterState;
+    routes: ReactRouterV6RouteObject[];
+    subscribe(fn: (state: RouterState) => void): () => void;
+}
+/**
+ * To use with React Router 6.4 data APIs.
+ */
+export declare function withFaroRouterInstrumentation<R extends Router = Router>(router: R): R;
+export {};

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import type { ReactRouterV4V5Dependencies, ReactRouterV6Dependencies, ReactRouterVersion } from './router';
+import type { ReactRouterV4V5Dependencies, ReactRouterV6DataRouterDependencies, ReactRouterV6Dependencies, ReactRouterVersion } from './router';
 export interface ReactRouterV4V5Config {
     version: ReactRouterVersion.V4 | ReactRouterVersion.V5;
     dependencies: ReactRouterV4V5Dependencies;
@@ -7,6 +7,10 @@ export interface ReactRouterV6Config {
     version: ReactRouterVersion.V6;
     dependencies: ReactRouterV6Dependencies;
 }
+export interface ReactRouterV6DataRouterConfig {
+    version: ReactRouterVersion.V6_data_router;
+    dependencies: ReactRouterV6DataRouterDependencies;
+}
 export interface ReactIntegrationConfig {
-    router?: ReactRouterV4V5Config | ReactRouterV6Config;
+    router?: ReactRouterV4V5Config | ReactRouterV6Config | ReactRouterV6DataRouterConfig;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-react",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Faro package that enables easier integration in projects built with React.",
   "keywords": [
     "observability",
@@ -52,8 +52,8 @@
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
-    "@grafana/faro-web-sdk": "^1.4.2",
-    "@grafana/faro-web-tracing": "^1.4.2",
+    "@grafana/faro-web-sdk": "^1.5.0",
+    "@grafana/faro-web-tracing": "^1.5.0",
     "hoist-non-react-statics": "^3.3.2"
   },
   "devDependencies": {
@@ -71,5 +71,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2a3f66ca914dd4ffa1a15a0c1091268adacb01f5"
+  "gitHead": "d986f24a192207f16a04dc63f366f2fe5c570d06"
 }