@crimson-education/browser-logger 3.0.5 → 3.0.6-beta.1

package/lib/reporters/gtmReporter.js

@@ -1,57 +1,57 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gtmReporter = void 0;
-function gtmReporter(info, config) {
-    let loadedDataLayer = !!window.dataLayer;
-    const baseMetadata = {
-        service: info.service,
-        domain: window.location.host,
-        environment: info.environment,
-        version: info.version,
-    };
-    const reporter = {
-        ...config,
-        addMetadata: function (metadata) {
-            if (window.dataLayer) {
-                // Lazy load base metadata, e.g. if GTM isn't ready yet.
-                if (!loadedDataLayer) {
-                    window.dataLayer.push(baseMetadata);
-                    loadedDataLayer = true;
-                }
-                window.dataLayer.push(metadata);
-            }
-        },
-        trackEvent: function (event) {
-            reporter.addMetadata({
-                ...event.metadata,
-                ...event.tags,
-                ...event.metrics,
-                event: event.message,
-                level: event.level,
-            });
-        },
-        addBreadcrumb: function (breadcrumb) {
-            reporter.addMetadata({
-                ...breadcrumb.metadata,
-                event: breadcrumb.message,
-            });
-        },
-        setUser: function (user) {
-            if (user) {
-                reporter.addMetadata({ user });
-            }
-        },
-        setRouteName: function (routeName) {
-            reporter.addMetadata({ routeName });
-        },
-        setPageName: function (pageName) {
-            reporter.addMetadata({ pageName });
-        },
-    };
-    if (loadedDataLayer) {
-        reporter.addMetadata(baseMetadata);
-    }
-    return reporter;
-}
-exports.gtmReporter = gtmReporter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gtmReporter = void 0;
+function gtmReporter(info, config) {
+    let loadedDataLayer = !!window.dataLayer;
+    const baseMetadata = {
+        service: info.service,
+        domain: window.location.host,
+        environment: info.environment,
+        version: info.version,
+    };
+    const reporter = {
+        ...config,
+        addMetadata: function (metadata) {
+            if (window.dataLayer) {
+                // Lazy load base metadata, e.g. if GTM isn't ready yet.
+                if (!loadedDataLayer) {
+                    window.dataLayer.push(baseMetadata);
+                    loadedDataLayer = true;
+                }
+                window.dataLayer.push(metadata);
+            }
+        },
+        trackEvent: function (event) {
+            reporter.addMetadata({
+                ...event.metadata,
+                ...event.tags,
+                ...event.metrics,
+                event: event.message,
+                level: event.level,
+            });
+        },
+        addBreadcrumb: function (breadcrumb) {
+            reporter.addMetadata({
+                ...breadcrumb.metadata,
+                event: breadcrumb.message,
+            });
+        },
+        setUser: function (user) {
+            if (user) {
+                reporter.addMetadata({ user });
+            }
+        },
+        setRouteName: function (routeName) {
+            reporter.addMetadata({ routeName });
+        },
+        setPageName: function (pageName) {
+            reporter.addMetadata({ pageName });
+        },
+    };
+    if (loadedDataLayer) {
+        reporter.addMetadata(baseMetadata);
+    }
+    return reporter;
+}
+exports.gtmReporter = gtmReporter;
 //# sourceMappingURL=gtmReporter.js.map

package/lib/reporters/index.d.ts

@@ -1,67 +1,67 @@
-import { IReporter, LogLevel, Metadata, ReporterBreadcrumb, ReporterEvent, ReporterFilters, ReportError, ReporterType, ReportUser, TrackedReporterEvent } from '../types';
-export declare const reporters: Partial<Record<ReporterType, IReporter>>;
-export declare let globalEventLevel: LogLevel | undefined;
-/**
- * Sets the global event level.
- */
-export declare function setEventLevel(level: LogLevel | null): void;
-/**
- * Tracks an Analytics event.
- */
-export declare function trackEvent(event: ReporterEvent): void;
-/**
- * Tracks an Analytics event, recording the time since the last event, if available.
- */
-export declare function trackEventSinceLastAction(event: ReporterEvent): void;
-/**
- * Gets the last tracked event, if available.
- */
-export declare function getLastTrackedEvent(): TrackedReporterEvent | null;
-/**
- * Breadcrumbs to create a trail of events that happened prior to an issue.
- * These events are very similar to traditional logs, but can record more rich structured data.
- */
-export declare function addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
-/**
- * Adds global metadata to all events and logs.
- * @param metadata Metadata to add.
- * @param filters Optional filters to specify which reporters to add metadata to.
- */
-export declare function addMetadata(metadata: Metadata, filters?: ReporterFilters): void;
-/**
- * Sets the user information in Analytics.
- * @param user User information, or null to clear.
- * @param filters Optional filters to specify which reporters to set the user for.
- */
-export declare function setUser(user: ReportUser | null, filters?: ReporterFilters): void;
-/**
- * Sets the route name in Analytics.
- * Some Analytics services use this differentiate SPA Route vs Page changes.
- * @param routeName Name of the Route.
- * @param filters Optional filters to specify which reporters to set the route name for.
- */
-export declare function setRouteName(routeName: string, filters?: ReporterFilters): void;
-/**
- * Sets the page name in Analytics.
- * @param pageName Name of the Page.
- * @param filters Optional filters to specify which reporters to set the page name for.
- */
-export declare function setPageName(pageName: string, filters?: ReporterFilters): void;
-/**
- * Reports an Error in Reporters that support error tracking.
- * @param error Error data.
- * @param metadata Metadata to add to the error.
- * @param filters Optional filters to specify which reporters to report the error to.
- */
-export declare function reportError(error: ReportError, metadata?: Metadata, filters?: ReporterFilters): void;
-/**
- * Starts a session recording in Analytics, e.g. RUM Session Replay
- * @param filters Optional filters to specify which reporters to start a session recording for.
- */
-export declare function recordSession(filters?: ReporterFilters): void;
-/**
- * Stops a session recording in Analytics, e.g. RUM Session Replay
- * @param filters Optional filters to specify which reporters to stop a session recording for.
- */
-export declare function recordSessionStop(filters?: ReporterFilters): void;
+import { IReporter, LogLevel, Metadata, ReporterBreadcrumb, ReporterEvent, ReporterFilters, ReportError, ReporterType, ReportUser, TrackedReporterEvent } from '../types';
+export declare const reporters: Partial<Record<ReporterType, IReporter>>;
+export declare let globalEventLevel: LogLevel | undefined;
+/**
+ * Sets the global event level.
+ */
+export declare function setEventLevel(level: LogLevel | null): void;
+/**
+ * Tracks an Analytics event.
+ */
+export declare function trackEvent(event: ReporterEvent): void;
+/**
+ * Tracks an Analytics event, recording the time since the last event, if available.
+ */
+export declare function trackEventSinceLastAction(event: ReporterEvent): void;
+/**
+ * Gets the last tracked event, if available.
+ */
+export declare function getLastTrackedEvent(): TrackedReporterEvent | null;
+/**
+ * Breadcrumbs to create a trail of events that happened prior to an issue.
+ * These events are very similar to traditional logs, but can record more rich structured data.
+ */
+export declare function addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
+/**
+ * Adds global metadata to all events and logs.
+ * @param metadata Metadata to add.
+ * @param filters Optional filters to specify which reporters to add metadata to.
+ */
+export declare function addMetadata(metadata: Metadata, filters?: ReporterFilters): void;
+/**
+ * Sets the user information in Analytics.
+ * @param user User information, or null to clear.
+ * @param filters Optional filters to specify which reporters to set the user for.
+ */
+export declare function setUser(user: ReportUser | null, filters?: ReporterFilters): void;
+/**
+ * Sets the route name in Analytics.
+ * Some Analytics services use this differentiate SPA Route vs Page changes.
+ * @param routeName Name of the Route.
+ * @param filters Optional filters to specify which reporters to set the route name for.
+ */
+export declare function setRouteName(routeName: string, filters?: ReporterFilters): void;
+/**
+ * Sets the page name in Analytics.
+ * @param pageName Name of the Page.
+ * @param filters Optional filters to specify which reporters to set the page name for.
+ */
+export declare function setPageName(pageName: string, filters?: ReporterFilters): void;
+/**
+ * Reports an Error in Reporters that support error tracking.
+ * @param error Error data.
+ * @param metadata Metadata to add to the error.
+ * @param filters Optional filters to specify which reporters to report the error to.
+ */
+export declare function reportError(error: ReportError, metadata?: Metadata, filters?: ReporterFilters): void;
+/**
+ * Starts a session recording in Analytics, e.g. RUM Session Replay
+ * @param filters Optional filters to specify which reporters to start a session recording for.
+ */
+export declare function recordSession(filters?: ReporterFilters): void;
+/**
+ * Stops a session recording in Analytics, e.g. RUM Session Replay
+ * @param filters Optional filters to specify which reporters to stop a session recording for.
+ */
+export declare function recordSessionStop(filters?: ReporterFilters): void;
 //# sourceMappingURL=index.d.ts.map