@crimson-education/browser-logger 3.0.2 → 3.0.3-pinpoint-proxy.0

package/README.md

@@ -157,7 +157,7 @@ These will only send to the log reporter, it is recommended to use `toReporters`
 
 #### Filtering out metadata
 
-You can filter what metadata gets sent to each reporter in the reporter config. 
+You can filter what metadata gets sent to each reporter in the reporter config.
 This accepts a string for exact match metadata keys, or a RegExp.
 You can use `.` to traverse metadata.
 
@@ -199,6 +199,12 @@ Logger.addBreadcrumb({
 
 ### Configure Reporters
 
+### Proxies
+
+Some reporters support taking a `proxyUrl` parameter in their config. When provided, the reporter will send events to the `proxyUrl` instead of the default destination. This can be useful to get around ad blockers users might have installed. Typically, `proxyUrl` should point to our internal proxy service--a shared service that forwards requests it receives to a third-party system.
+
+Our internal proxy service is defined in our [crimson-infrastructure](https://github.com/crimson-education/crimson-infrastructure) repository.
+
 #### Log
 
 By default, the log reporter is enabled. This adds all reporter functions to logs. Set `reporters.log` to `false` to disable reporter logging.
@@ -262,7 +268,7 @@ This automatically adds a Datadog Log Transport that transmits Log data to Datad
 To configure Amplify, this requires at least `region`, `identityPoolId` and `analyticsAppId`.
 
 > **Note**: If you are setting up Browser Logger in a project that uses AWS Cognito or other AWS Amplify Features, you will want to set `identityPoolId` to false. This disables the reporter's call to Auth.configure, as you will have used that to configure your App already.
->  
+>
 > You will need to set identityPoolId in your Auth.configure function yourself, otherwise Pinpoint won't work.
 
 Auto `Auth.configure`:

package/lib/index.d.ts

@@ -1,13 +1,13 @@
-import { ReporterConfigurations, ServiceInfo } from './types';
-export * from './types';
-export * from './reporters';
-export * from './logger';
-export declare type LoggerConfig = ServiceInfo & {
-    reporters?: ReporterConfigurations;
-};
-/**
- * Initializes the logger and reporters.
- * @param config Reporter config options.
- */
-export declare function init(config: LoggerConfig): void;
+import { ReporterConfigurations, ServiceInfo } from './types';
+export * from './types';
+export * from './reporters';
+export * from './logger';
+export declare type LoggerConfig = ServiceInfo & {
+    reporters?: ReporterConfigurations;
+};
+/**
+ * Initializes the logger and reporters.
+ * @param config Reporter config options.
+ */
+export declare function init(config: LoggerConfig): void;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,70 +1,70 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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.init = void 0;
-const logger_1 = require("./logger");
-const reporters_1 = require("./reporters");
-const gtmReporter_1 = require("./reporters/gtmReporter");
-const amplifyReporter_1 = require("./reporters/amplifyReporter");
-const datadogReporter_1 = require("./reporters/datadogReporter");
-const logReporter_1 = require("./reporters/logReporter");
-__exportStar(require("./types"), exports);
-__exportStar(require("./reporters"), exports);
-__exportStar(require("./logger"), exports);
-let initialized = false;
-/**
- * Initializes the logger and reporters.
- * @param config Reporter config options.
- */
-function init(config) {
-    var _a, _b, _c, _d, _e, _f;
-    // Some reporters don't like being initialized multiple times.
-    if (initialized) {
-        return;
-    }
-    initialized = true;
-    // Log Reporter enabled by default.
-    const logReporterConfig = (_b = (_a = config.reporters) === null || _a === void 0 ? void 0 : _a.log) !== null && _b !== void 0 ? _b : true;
-    if (logReporterConfig !== false) {
-        reporters_1.reporters['log'] = (0, logReporter_1.logReporter)(config, typeof logReporterConfig === 'boolean' ? {} : logReporterConfig);
-    }
-    if ((_c = config.reporters) === null || _c === void 0 ? void 0 : _c.datadog) {
-        reporters_1.reporters['datadog'] = (0, datadogReporter_1.datadogReporter)(config, config.reporters.datadog);
-    }
-    if ((_d = config.reporters) === null || _d === void 0 ? void 0 : _d.amplify) {
-        reporters_1.reporters['amplify'] = (0, amplifyReporter_1.amplifyReporter)(config, config.reporters.amplify);
-    }
-    if ((_e = config.reporters) === null || _e === void 0 ? void 0 : _e.gtm) {
-        reporters_1.reporters['gtm'] = (0, gtmReporter_1.gtmReporter)(config, typeof config.reporters.gtm === 'boolean' ? {} : config.reporters.gtm);
-    }
-    const defaultMetadata = {
-        ...((_f = config.defaultMetadata) !== null && _f !== void 0 ? _f : {}),
-        service: config.service,
-        environment: config.environment,
-        version: config.version,
-    };
-    // Sets the global log level, if specified.
-    if (config.logLevel) {
-        (0, logger_1.setLogLevel)(config.logLevel);
-    }
-    // Sets the global event level, if specified.
-    if (config.eventLevel) {
-        (0, reporters_1.setEventLevel)(config.eventLevel);
-    }
-    (0, reporters_1.addMetadata)(defaultMetadata);
-}
-exports.init = init;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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.init = void 0;
+const logger_1 = require("./logger");
+const reporters_1 = require("./reporters");
+const gtmReporter_1 = require("./reporters/gtmReporter");
+const amplifyReporter_1 = require("./reporters/amplifyReporter");
+const datadogReporter_1 = require("./reporters/datadogReporter");
+const logReporter_1 = require("./reporters/logReporter");
+__exportStar(require("./types"), exports);
+__exportStar(require("./reporters"), exports);
+__exportStar(require("./logger"), exports);
+let initialized = false;
+/**
+ * Initializes the logger and reporters.
+ * @param config Reporter config options.
+ */
+function init(config) {
+    var _a, _b, _c, _d, _e, _f;
+    // Some reporters don't like being initialized multiple times.
+    if (initialized) {
+        return;
+    }
+    initialized = true;
+    // Log Reporter enabled by default.
+    const logReporterConfig = (_b = (_a = config.reporters) === null || _a === void 0 ? void 0 : _a.log) !== null && _b !== void 0 ? _b : true;
+    if (logReporterConfig !== false) {
+        reporters_1.reporters['log'] = (0, logReporter_1.logReporter)(config, typeof logReporterConfig === 'boolean' ? {} : logReporterConfig);
+    }
+    if ((_c = config.reporters) === null || _c === void 0 ? void 0 : _c.datadog) {
+        reporters_1.reporters['datadog'] = (0, datadogReporter_1.datadogReporter)(config, config.reporters.datadog);
+    }
+    if ((_d = config.reporters) === null || _d === void 0 ? void 0 : _d.amplify) {
+        reporters_1.reporters['amplify'] = (0, amplifyReporter_1.amplifyReporter)(config, config.reporters.amplify);
+    }
+    if ((_e = config.reporters) === null || _e === void 0 ? void 0 : _e.gtm) {
+        reporters_1.reporters['gtm'] = (0, gtmReporter_1.gtmReporter)(config, typeof config.reporters.gtm === 'boolean' ? {} : config.reporters.gtm);
+    }
+    const defaultMetadata = {
+        ...((_f = config.defaultMetadata) !== null && _f !== void 0 ? _f : {}),
+        service: config.service,
+        environment: config.environment,
+        version: config.version,
+    };
+    // Sets the global log level, if specified.
+    if (config.logLevel) {
+        (0, logger_1.setLogLevel)(config.logLevel);
+    }
+    // Sets the global event level, if specified.
+    if (config.eventLevel) {
+        (0, reporters_1.setEventLevel)(config.eventLevel);
+    }
+    (0, reporters_1.addMetadata)(defaultMetadata);
+}
+exports.init = init;
 //# sourceMappingURL=index.js.map

package/lib/logger/consoleTransport.d.ts

@@ -1,37 +1,37 @@
-import { ILogTransport, LogLevel, LogTransportConfigBase } from '../types';
-declare const colors: {
-    bold: number[];
-    italic: number[];
-    underline: number[];
-    inverse: number[];
-    white: number[];
-    grey: number[];
-    black: number[];
-    blue: number[];
-    cyan: number[];
-    green: number[];
-    magenta: number[];
-    red: number[];
-    yellow: number[];
-};
-export declare type ColorizeColor = keyof typeof colors;
-/**
- * Colorize a string with a specified color.
- * @param str String to colorize
- * @param color Color to colorize the string with
- * @returns Colorized string
- */
-export declare function colorize(str: string, color: ColorizeColor): string;
-export interface ConsoleLogTransportConfig extends LogTransportConfigBase {
-    /**
-     * Add colors to log messages.
-     */
-    colorize?: false | typeof colorize;
-    /**
-     * Gets the color for the log level.
-     */
-    getLogLevelColor?: (level: LogLevel) => ColorizeColor;
-}
-export declare function consoleTransport(config?: ConsoleLogTransportConfig): ILogTransport & ConsoleLogTransportConfig;
-export {};
+import { ILogTransport, LogLevel, LogTransportConfigBase } from '../types';
+declare const colors: {
+    bold: number[];
+    italic: number[];
+    underline: number[];
+    inverse: number[];
+    white: number[];
+    grey: number[];
+    black: number[];
+    blue: number[];
+    cyan: number[];
+    green: number[];
+    magenta: number[];
+    red: number[];
+    yellow: number[];
+};
+export declare type ColorizeColor = keyof typeof colors;
+/**
+ * Colorize a string with a specified color.
+ * @param str String to colorize
+ * @param color Color to colorize the string with
+ * @returns Colorized string
+ */
+export declare function colorize(str: string, color: ColorizeColor): string;
+export interface ConsoleLogTransportConfig extends LogTransportConfigBase {
+    /**
+     * Add colors to log messages.
+     */
+    colorize?: false | typeof colorize;
+    /**
+     * Gets the color for the log level.
+     */
+    getLogLevelColor?: (level: LogLevel) => ColorizeColor;
+}
+export declare function consoleTransport(config?: ConsoleLogTransportConfig): ILogTransport & ConsoleLogTransportConfig;
+export {};
 //# sourceMappingURL=consoleTransport.d.ts.map

package/lib/logger/consoleTransport.js

@@ -1,81 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.consoleTransport = exports.colorize = void 0;
-// from browser-util-inspect
-const colors = {
-    bold: [1, 22],
-    italic: [3, 23],
-    underline: [4, 24],
-    inverse: [7, 27],
-    white: [37, 39],
-    grey: [90, 39],
-    black: [30, 39],
-    blue: [34, 39],
-    cyan: [36, 39],
-    green: [32, 39],
-    magenta: [35, 39],
-    red: [31, 39],
-    yellow: [33, 39],
-};
-/**
- * Colorize a string with a specified color.
- * @param str String to colorize
- * @param color Color to colorize the string with
- * @returns Colorized string
- */
-function colorize(str, color) {
-    const colorData = colors[color];
-    return '\u001b[' + colorData[0] + 'm' + str + '\u001b[' + colorData[1] + 'm';
-}
-exports.colorize = colorize;
-/**
- * Gets a stack trace from metadata or accompanying error.
- */
-function getStackTrace(data) {
-    var _a;
-    const stack = ((_a = data === null || data === void 0 ? void 0 : data.err) === null || _a === void 0 ? void 0 : _a.stack) || data.stack || data['error.stack'];
-    delete data.stack;
-    return stack !== null && stack !== void 0 ? stack : '';
-}
-function consoleTransport(config = {}) {
-    var _a, _b, _c;
-    // Default ignore patterns
-    (_a = config.ignoreMetadataPatterns) !== null && _a !== void 0 ? _a : (config.ignoreMetadataPatterns = ['application', 'service', 'environment', 'version']);
-    // Get the colorizer function, or a no-op if not enabled.
-    const colorizer = config.colorize !== false ? (_b = config.colorize) !== null && _b !== void 0 ? _b : colorize : (str) => str;
-    // Get the log level color function, or use the default colors.
-    const getLogLevelColor = (_c = config.getLogLevelColor) !== null && _c !== void 0 ? _c : ((level) => {
-        return {
-            error: 'red',
-            warn: 'yellow',
-            info: 'cyan',
-            debug: 'green',
-        }[level];
-    });
-    const transport = {
-        ...config,
-        log: ({ level, message, timestamp, splat, ...metadata }) => {
-            let splatData = splat !== null && splat !== void 0 ? splat : [];
-            const stackTrace = getStackTrace(metadata);
-            const strippedInfo = { ...metadata };
-            delete strippedInfo['level'];
-            delete strippedInfo['message'];
-            delete strippedInfo['splat'];
-            delete strippedInfo['timestamp'];
-            delete strippedInfo['stack'];
-            if (Object.keys(strippedInfo).length > 0) {
-                splatData = [strippedInfo, ...splatData];
-            }
-            if (message) {
-                splatData = [message, ...splatData];
-            }
-            if (stackTrace) {
-                splatData = [...splatData, stackTrace];
-            }
-            console.log(`${colorizer(timestamp, 'magenta')} ${colorizer(level, getLogLevelColor(level))}: `, ...splatData);
-        },
-    };
-    return transport;
-}
-exports.consoleTransport = consoleTransport;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.consoleTransport = exports.colorize = void 0;
+// from browser-util-inspect
+const colors = {
+    bold: [1, 22],
+    italic: [3, 23],
+    underline: [4, 24],
+    inverse: [7, 27],
+    white: [37, 39],
+    grey: [90, 39],
+    black: [30, 39],
+    blue: [34, 39],
+    cyan: [36, 39],
+    green: [32, 39],
+    magenta: [35, 39],
+    red: [31, 39],
+    yellow: [33, 39],
+};
+/**
+ * Colorize a string with a specified color.
+ * @param str String to colorize
+ * @param color Color to colorize the string with
+ * @returns Colorized string
+ */
+function colorize(str, color) {
+    const colorData = colors[color];
+    return '\u001b[' + colorData[0] + 'm' + str + '\u001b[' + colorData[1] + 'm';
+}
+exports.colorize = colorize;
+/**
+ * Gets a stack trace from metadata or accompanying error.
+ */
+function getStackTrace(data) {
+    var _a;
+    const stack = ((_a = data === null || data === void 0 ? void 0 : data.err) === null || _a === void 0 ? void 0 : _a.stack) || data.stack || data['error.stack'];
+    delete data.stack;
+    return stack !== null && stack !== void 0 ? stack : '';
+}
+function consoleTransport(config = {}) {
+    var _a, _b, _c;
+    // Default ignore patterns
+    (_a = config.ignoreMetadataPatterns) !== null && _a !== void 0 ? _a : (config.ignoreMetadataPatterns = ['application', 'service', 'environment', 'version']);
+    // Get the colorizer function, or a no-op if not enabled.
+    const colorizer = config.colorize !== false ? (_b = config.colorize) !== null && _b !== void 0 ? _b : colorize : (str) => str;
+    // Get the log level color function, or use the default colors.
+    const getLogLevelColor = (_c = config.getLogLevelColor) !== null && _c !== void 0 ? _c : ((level) => {
+        return {
+            error: 'red',
+            warn: 'yellow',
+            info: 'cyan',
+            debug: 'green',
+        }[level];
+    });
+    const transport = {
+        ...config,
+        log: ({ level, message, timestamp, splat, ...metadata }) => {
+            let splatData = splat !== null && splat !== void 0 ? splat : [];
+            const stackTrace = getStackTrace(metadata);
+            const strippedInfo = { ...metadata };
+            delete strippedInfo['level'];
+            delete strippedInfo['message'];
+            delete strippedInfo['splat'];
+            delete strippedInfo['timestamp'];
+            delete strippedInfo['stack'];
+            if (Object.keys(strippedInfo).length > 0) {
+                splatData = [strippedInfo, ...splatData];
+            }
+            if (message) {
+                splatData = [message, ...splatData];
+            }
+            if (stackTrace) {
+                splatData = [...splatData, stackTrace];
+            }
+            console.log(`${colorizer(timestamp, 'magenta')} ${colorizer(level, getLogLevelColor(level))}: `, ...splatData);
+        },
+    };
+    return transport;
+}
+exports.consoleTransport = consoleTransport;
 //# sourceMappingURL=consoleTransport.js.map

package/lib/logger/datadogTransport.d.ts

@@ -1,8 +1,8 @@
-import { ILogTransport, LogTransportConfigBase } from '../types';
-export declare type DatadogLogTransportConfig = LogTransportConfigBase;
-/**
- * A transport that sends logs to Datadog.
- * Note: This requires the datadog reporter to be initialized for it to work.
- */
-export declare function datadogTransport(config?: DatadogLogTransportConfig): ILogTransport;
+import { ILogTransport, LogTransportConfigBase } from '../types';
+export declare type DatadogLogTransportConfig = LogTransportConfigBase;
+/**
+ * A transport that sends logs to Datadog.
+ * Note: This requires the datadog reporter to be initialized for it to work.
+ */
+export declare function datadogTransport(config?: DatadogLogTransportConfig): ILogTransport;
 //# sourceMappingURL=datadogTransport.d.ts.map

package/lib/logger/datadogTransport.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.datadogTransport = void 0;
-const utils_1 = require("./utils");
-const browser_logs_1 = require("@datadog/browser-logs");
-/**
- * A transport that sends logs to Datadog.
- * Note: This requires the datadog reporter to be initialized for it to work.
- */
-function datadogTransport(config = {}) {
-    const transport = {
-        ...config,
-        log: ({ level, message, ...metadata }) => {
-            // Datadog expects a string message.
-            browser_logs_1.datadogLogs.logger[level]((0, utils_1.getLogMessage)(message), metadata);
-        },
-    };
-    return transport;
-}
-exports.datadogTransport = datadogTransport;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.datadogTransport = void 0;
+const utils_1 = require("./utils");
+const browser_logs_1 = require("@datadog/browser-logs");
+/**
+ * A transport that sends logs to Datadog.
+ * Note: This requires the datadog reporter to be initialized for it to work.
+ */
+function datadogTransport(config = {}) {
+    const transport = {
+        ...config,
+        log: ({ level, message, ...metadata }) => {
+            // Datadog expects a string message.
+            browser_logs_1.datadogLogs.logger[level]((0, utils_1.getLogMessage)(message), metadata);
+        },
+    };
+    return transport;
+}
+exports.datadogTransport = datadogTransport;
 //# sourceMappingURL=datadogTransport.js.map

package/lib/logger/index.d.ts

@@ -1,16 +1,16 @@
-import { ILogger, ILogTransport, LoggerOptions, LogLevel, Metadata } from '../types';
-export * from './consoleTransport';
-export * from './datadogTransport';
-export declare const globalMetadata: Metadata;
-export declare const logTransports: ILogTransport[];
-export declare let globalLogLevel: LogLevel | undefined;
-/**
- * Sets the global log level.
- */
-export declare function setLogLevel(level: LogLevel | null): void;
-/**
- * Creates a Logger Instance.
- */
-export declare function createLogger(options?: LoggerOptions): ILogger;
-export declare const logger: ILogger;
+import { ILogger, ILogTransport, LoggerOptions, LogLevel, Metadata } from '../types';
+export * from './consoleTransport';
+export * from './datadogTransport';
+export declare const globalMetadata: Metadata;
+export declare const logTransports: ILogTransport[];
+export declare let globalLogLevel: LogLevel | undefined;
+/**
+ * Sets the global log level.
+ */
+export declare function setLogLevel(level: LogLevel | null): void;
+/**
+ * Creates a Logger Instance.
+ */
+export declare function createLogger(options?: LoggerOptions): ILogger;
+export declare const logger: ILogger;
 //# sourceMappingURL=index.d.ts.map