@crimson-education/browser-logger 1.4.3 → 1.5.0

package/lib/index.d.ts

@@ -1,30 +1,30 @@
-import { ILogger, Metadata, ReportError, ReportUser, ServiceInfo } from './types';
-import { ReporterBreadcrumb, ReporterEvent, TrackedReporterEvent } from './reporters';
-import { DatadogReporterConfig } from './reporters/datadogReporter';
-import { SentryReporterConfig } from './reporters/sentryReporter';
-import { AmplifyReporterConfig } from './reporters/amplifyReporter';
-export * from './types';
-export declare let logger: ILogger | null;
-export declare type ReporterConfig = ServiceInfo & {
-    sentry?: SentryReporterConfig;
-    datadog?: DatadogReporterConfig;
-    amplify?: AmplifyReporterConfig;
-    gtm?: boolean;
-    newrelic?: boolean;
-};
-export declare function init(config: ReporterConfig): void;
-export declare function trackEvent(event: ReporterEvent): void;
-export declare function addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
-export declare function addMetadata(metadata: Metadata): void;
-export declare function setUser(user: ReportUser | null): void;
-export declare function setRouteName(routeName: string): void;
-export declare function setPageName(pageName: string): void;
-export declare function reportError(error: ReportError, metadata?: Metadata): void;
-export declare function recordSession(): void;
-export declare function recordSessionStop(): void;
-export declare function trackEventSinceLastAction(event: ReporterEvent): void;
-export declare function getLastTrackedEvent(): TrackedReporterEvent | null;
-export declare function createLogger(name?: string, options?: {
-    metadata?: Metadata;
-}): ILogger;
+import { ILogger, Metadata, ReportError, ReportUser, ServiceInfo } from './types';
+import { ReporterBreadcrumb, ReporterEvent, TrackedReporterEvent } from './reporters';
+import { DatadogReporterConfig } from './reporters/datadogReporter';
+import { SentryReporterConfig } from './reporters/sentryReporter';
+import { AmplifyReporterConfig } from './reporters/amplifyReporter';
+export * from './types';
+export declare let logger: ILogger | null;
+export declare type ReporterConfig = ServiceInfo & {
+    sentry?: SentryReporterConfig;
+    datadog?: DatadogReporterConfig;
+    amplify?: AmplifyReporterConfig;
+    gtm?: boolean;
+    newrelic?: boolean;
+};
+export declare function init(config: ReporterConfig): void;
+export declare function trackEvent(event: ReporterEvent): void;
+export declare function addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
+export declare function addMetadata(metadata: Metadata): void;
+export declare function setUser(user: ReportUser | null): void;
+export declare function setRouteName(routeName: string): void;
+export declare function setPageName(pageName: string): void;
+export declare function reportError(error: ReportError, metadata?: Metadata): void;
+export declare function recordSession(): void;
+export declare function recordSessionStop(): void;
+export declare function trackEventSinceLastAction(event: ReporterEvent): void;
+export declare function getLastTrackedEvent(): TrackedReporterEvent | null;
+export declare function createLogger(name?: string, options?: {
+    metadata?: Metadata;
+}): ILogger;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,145 +1,145 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLogger = exports.getLastTrackedEvent = exports.trackEventSinceLastAction = exports.recordSessionStop = exports.recordSession = exports.reportError = exports.setPageName = exports.setRouteName = exports.setUser = exports.addMetadata = exports.addBreadcrumb = exports.trackEvent = exports.init = exports.logger = void 0;
-const utils_1 = require("./utils");
-const datadogReporter_1 = require("./reporters/datadogReporter");
-const sentryReporter_1 = require("./reporters/sentryReporter");
-const gtmReporter_1 = require("./reporters/gtmReporter");
-const newrelicReporter_1 = require("./reporters/newrelicReporter");
-const amplifyReporter_1 = require("./reporters/amplifyReporter");
-__exportStar(require("./types"), exports);
-exports.logger = null;
-const reporters = [];
-let initialized = false;
-let ddInitialized = false;
-function init(config) {
-    initialized = true;
-    if (config.sentry) {
-        reporters.push(sentryReporter_1.sentryReporter(config, config.sentry));
-    }
-    if (config.datadog) {
-        reporters.push(datadogReporter_1.datadogReporter(config, config.datadog));
-        ddInitialized = true;
-    }
-    if (config.amplify) {
-        reporters.push(amplifyReporter_1.amplifyReporter(config, config.amplify));
-    }
-    if (config.gtm) {
-        reporters.push(gtmReporter_1.gtmReporter());
-    }
-    if (config.newrelic) {
-        reporters.push(newrelicReporter_1.newrelicReporter(config));
-    }
-    if (config.defaultMetadata) {
-        for (const reporter of reporters) {
-            reporter.addMetadata(config.defaultMetadata);
-        }
-    }
-    exports.logger = createLogger('Reporter');
-}
-exports.init = init;
-function trackEvent(event) {
-    for (const reporter of reporters) {
-        reporter.trackEvent(event);
-    }
-}
-exports.trackEvent = trackEvent;
-function addBreadcrumb(breadcrumb) {
-    for (const reporter of reporters) {
-        reporter.addBreadcrumb(breadcrumb);
-    }
-}
-exports.addBreadcrumb = addBreadcrumb;
-function addMetadata(metadata) {
-    for (const reporter of reporters) {
-        reporter.addMetadata(metadata);
-    }
-}
-exports.addMetadata = addMetadata;
-function setUser(user) {
-    for (const reporter of reporters) {
-        reporter.setUser(user);
-    }
-}
-exports.setUser = setUser;
-function setRouteName(routeName) {
-    for (const reporter of reporters) {
-        reporter.setRouteName(routeName);
-    }
-}
-exports.setRouteName = setRouteName;
-function setPageName(pageName) {
-    for (const reporter of reporters) {
-        reporter.setPageName(pageName);
-    }
-}
-exports.setPageName = setPageName;
-function reportError(error, metadata) {
-    for (const reporter of reporters) {
-        reporter.reportError(error, metadata);
-    }
-}
-exports.reportError = reportError;
-function recordSession() {
-    for (const reporter of reporters) {
-        reporter.recordSession();
-    }
-}
-exports.recordSession = recordSession;
-function recordSessionStop() {
-    for (const reporter of reporters) {
-        reporter.recordSessionStop();
-    }
-}
-exports.recordSessionStop = recordSessionStop;
-function trackEventSinceLastAction(event) {
-    const lastEvent = getLastTrackedEvent();
-    if (lastEvent) {
-        const duration = new Date().getTime() - lastEvent.occurred.getTime();
-        trackEvent({
-            ...event,
-            metadata: {
-                ...event.metadata,
-                lastEventName: lastEvent.message,
-                timeSinceLastEvent: duration,
-            },
-        });
-    }
-    else {
-        trackEvent(event);
-    }
-    sessionStorage.setItem('loggerLastEvent', JSON.stringify({ ...event, occurred: new Date() }));
-}
-exports.trackEventSinceLastAction = trackEventSinceLastAction;
-function getLastTrackedEvent() {
-    const eventStr = sessionStorage.getItem('loggerLastEvent');
-    if (!eventStr)
-        return null;
-    const event = JSON.parse(eventStr);
-    event.occurred = new Date(event.occurred);
-    return event;
-}
-exports.getLastTrackedEvent = getLastTrackedEvent;
-function createLogger(name, options) {
-    if (!initialized) {
-        throw new Error('You must call init on BrowserLogger before creating a logger');
-    }
-    if (ddInitialized) {
-        return datadogReporter_1.datadogLogger(name, options);
-    }
-    else {
-        return utils_1.consoleLogger(name, options);
-    }
-}
-exports.createLogger = createLogger;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = exports.getLastTrackedEvent = exports.trackEventSinceLastAction = exports.recordSessionStop = exports.recordSession = exports.reportError = exports.setPageName = exports.setRouteName = exports.setUser = exports.addMetadata = exports.addBreadcrumb = exports.trackEvent = exports.init = exports.logger = void 0;
+const utils_1 = require("./utils");
+const datadogReporter_1 = require("./reporters/datadogReporter");
+const sentryReporter_1 = require("./reporters/sentryReporter");
+const gtmReporter_1 = require("./reporters/gtmReporter");
+const newrelicReporter_1 = require("./reporters/newrelicReporter");
+const amplifyReporter_1 = require("./reporters/amplifyReporter");
+__exportStar(require("./types"), exports);
+exports.logger = null;
+const reporters = [];
+let initialized = false;
+let ddInitialized = false;
+function init(config) {
+    initialized = true;
+    if (config.sentry) {
+        reporters.push(sentryReporter_1.sentryReporter(config, config.sentry));
+    }
+    if (config.datadog) {
+        reporters.push(datadogReporter_1.datadogReporter(config, config.datadog));
+        ddInitialized = true;
+    }
+    if (config.amplify) {
+        reporters.push(amplifyReporter_1.amplifyReporter(config, config.amplify));
+    }
+    if (config.gtm) {
+        reporters.push(gtmReporter_1.gtmReporter());
+    }
+    if (config.newrelic) {
+        reporters.push(newrelicReporter_1.newrelicReporter(config));
+    }
+    if (config.defaultMetadata) {
+        for (const reporter of reporters) {
+            reporter.addMetadata(config.defaultMetadata);
+        }
+    }
+    exports.logger = createLogger('Reporter');
+}
+exports.init = init;
+function trackEvent(event) {
+    for (const reporter of reporters) {
+        reporter.trackEvent(event);
+    }
+}
+exports.trackEvent = trackEvent;
+function addBreadcrumb(breadcrumb) {
+    for (const reporter of reporters) {
+        reporter.addBreadcrumb(breadcrumb);
+    }
+}
+exports.addBreadcrumb = addBreadcrumb;
+function addMetadata(metadata) {
+    for (const reporter of reporters) {
+        reporter.addMetadata(metadata);
+    }
+}
+exports.addMetadata = addMetadata;
+function setUser(user) {
+    for (const reporter of reporters) {
+        reporter.setUser(user);
+    }
+}
+exports.setUser = setUser;
+function setRouteName(routeName) {
+    for (const reporter of reporters) {
+        reporter.setRouteName(routeName);
+    }
+}
+exports.setRouteName = setRouteName;
+function setPageName(pageName) {
+    for (const reporter of reporters) {
+        reporter.setPageName(pageName);
+    }
+}
+exports.setPageName = setPageName;
+function reportError(error, metadata) {
+    for (const reporter of reporters) {
+        reporter.reportError(error, metadata);
+    }
+}
+exports.reportError = reportError;
+function recordSession() {
+    for (const reporter of reporters) {
+        reporter.recordSession();
+    }
+}
+exports.recordSession = recordSession;
+function recordSessionStop() {
+    for (const reporter of reporters) {
+        reporter.recordSessionStop();
+    }
+}
+exports.recordSessionStop = recordSessionStop;
+function trackEventSinceLastAction(event) {
+    const lastEvent = getLastTrackedEvent();
+    if (lastEvent) {
+        const duration = new Date().getTime() - lastEvent.occurred.getTime();
+        trackEvent({
+            ...event,
+            metadata: {
+                ...event.metadata,
+                lastEventName: lastEvent.message,
+                timeSinceLastEvent: duration,
+            },
+        });
+    }
+    else {
+        trackEvent(event);
+    }
+    sessionStorage.setItem('loggerLastEvent', JSON.stringify({ ...event, occurred: new Date() }));
+}
+exports.trackEventSinceLastAction = trackEventSinceLastAction;
+function getLastTrackedEvent() {
+    const eventStr = sessionStorage.getItem('loggerLastEvent');
+    if (!eventStr)
+        return null;
+    const event = JSON.parse(eventStr);
+    event.occurred = new Date(event.occurred);
+    return event;
+}
+exports.getLastTrackedEvent = getLastTrackedEvent;
+function createLogger(name, options) {
+    if (!initialized) {
+        throw new Error('You must call init on BrowserLogger before creating a logger');
+    }
+    if (ddInitialized) {
+        return datadogReporter_1.datadogLogger(name, options);
+    }
+    else {
+        return utils_1.consoleLogger(name, options);
+    }
+}
+exports.createLogger = createLogger;
 //# sourceMappingURL=index.js.map

package/lib/reporters/amplifyReporter.d.ts

@@ -1,42 +1,44 @@
-import { IReporter } from '.';
-import { ServiceInfo } from '../types';
-export declare type AmplifyReporterConfig = {
-    region: string;
-    identityPoolId: string;
-    analyticsAppId: string;
-    autoTrackPageViews?: boolean;
-    autoTrackEvents?: boolean;
-    autoTrackSessions?: boolean;
-    selectorPrefix?: string;
-    ignoreBreadcrumbCategories?: string[];
-    buffering?: AmplifyReporterBufferingConfig;
-};
-/**
- * Configuration options for the buffering behavior of Pinpoint's event tracker.
- *
- * @see https://docs.amplify.aws/lib/analytics/getting-started/q/platform/js/#set-up-existing-analytics-backend
- */
-declare type AmplifyReporterBufferingConfig = {
-    /** Number of items to buffer for sending. */
-    bufferSize?: number;
-    /** Number of events sent each time Pinpoint flushes. */
-    flushSize?: number;
-    /** Interval Pinpoint flushes analytics events. Measured in milliseconds. */
-    flushInterval?: number;
-    /** The maximum number of times Pinpoint will retry to send an event. */
-    resendLimit?: number;
-};
-export declare function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig): IReporter;
-declare type AttributeMap = Record<string, string[] | string | null>;
-/**
- * Pinpoint has strict attribute name and value length limits
- */
-export declare function asAttributeMap(values: Record<string, any>, groupValues?: boolean): AttributeMap;
-/**
- * Pinpoint expects `endpoint.attributes` and `endpoint.userAttributes` to have
- * values which are string arrays. This function takes in an object and ensures
- * all of its values are of type `string[]` to appease Pinpoint.
- */
-export declare function buildAttributeMap(values: Record<string, any>, parentKey?: string | undefined, groupValues?: boolean): AttributeMap;
-export {};
+import { IReporter } from '.';
+import { ServiceInfo } from '../types';
+export declare type AmplifyReporterConfig = {
+    region: string;
+    identityPoolId: string;
+    analyticsAppId: string;
+    autoTrackPageViews?: boolean;
+    autoTrackEvents?: boolean;
+    autoTrackSessions?: boolean;
+    selectorPrefix?: string;
+    ignoreBreadcrumbCategories?: string[];
+    buffering?: AmplifyReporterBufferingConfig;
+    userPoolId?: string;
+    userPoolWebClientId?: string;
+};
+/**
+ * Configuration options for the buffering behavior of Pinpoint's event tracker.
+ *
+ * @see https://docs.amplify.aws/lib/analytics/getting-started/q/platform/js/#set-up-existing-analytics-backend
+ */
+declare type AmplifyReporterBufferingConfig = {
+    /** Number of items to buffer for sending. */
+    bufferSize?: number;
+    /** Number of events sent each time Pinpoint flushes. */
+    flushSize?: number;
+    /** Interval Pinpoint flushes analytics events. Measured in milliseconds. */
+    flushInterval?: number;
+    /** The maximum number of times Pinpoint will retry to send an event. */
+    resendLimit?: number;
+};
+export declare function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig): IReporter;
+declare type AttributeMap = Record<string, string[] | string | null>;
+/**
+ * Pinpoint has strict attribute name and value length limits
+ */
+export declare function asAttributeMap(values: Record<string, any>, groupValues?: boolean): AttributeMap;
+/**
+ * Pinpoint expects `endpoint.attributes` and `endpoint.userAttributes` to have
+ * values which are string arrays. This function takes in an object and ensures
+ * all of its values are of type `string[]` to appease Pinpoint.
+ */
+export declare function buildAttributeMap(values: Record<string, any>, parentKey?: string | undefined, groupValues?: boolean): AttributeMap;
+export {};
 //# sourceMappingURL=amplifyReporter.d.ts.map

package/lib/reporters/amplifyReporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"amplifyReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/amplifyReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqC,MAAM,GAAG,CAAC;AACjE,OAAO,EAAwB,WAAW,EAAE,MAAM,UAAU,CAAC;AAG7D,oBAAY,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B,CAAC,EAAE,MAAM,EAAE,CAAC;IACtC,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,aAAK,8BAA8B,GAAG;IACpC,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,CA8F3F;AAED,aAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AAE7D;;GAEG;AAEH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,WAAW,UAAO,GAAG,YAAY,CAa5F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAE/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,SAAS,GAAE,MAAM,GAAG,SAAqB,EACzC,WAAW,UAAO,GACjB,YAAY,CAsBd"}
+{"version":3,"file":"amplifyReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/amplifyReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqC,MAAM,GAAG,CAAC;AACjE,OAAO,EAAwB,WAAW,EAAE,MAAM,UAAU,CAAC;AAI7D,oBAAY,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B,CAAC,EAAE,MAAM,EAAE,CAAC;IACtC,SAAS,CAAC,EAAE,8BAA8B,CAAC;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,aAAK,8BAA8B,GAAG;IACpC,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAkG3F;AAED,aAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AAE7D;;GAEG;AAEH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,WAAW,UAAO,GAAG,YAAY,CAa5F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAE/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,SAAS,GAAE,MAAM,GAAG,SAAqB,EACzC,WAAW,UAAO,GACjB,YAAY,CAsBd"}