@crimson-education/browser-logger 2.0.2-cognito.2 → 2.0.2

package/lib/types/reporter.d.ts

@@ -0,0 +1,103 @@
+import { ReporterType } from '..';
+import { LogLevel, Metadata } from './logger';
+export declare type Metrics = Record<string, number>;
+export declare type ServiceInfo = {
+    /** The Application's name. */
+    service: string;
+    /** The Application's Environment */
+    environment: string;
+    /** The Application's Version. */
+    version: string;
+    /**
+     * Default metadata to add to Reporter events.
+     */
+    defaultMetadata?: Metadata;
+};
+export declare type ReportUser = {
+    id: string;
+    email?: string;
+    username?: string;
+    name?: string;
+};
+export declare type ReportError = Error | string;
+export interface ReporterFilters {
+    /**
+     * Send only to these Reporters.
+     */
+    toReporters?: ReporterType[];
+    /**
+     * Don't send to these Reporters.
+     */
+    excludeReporters?: ReporterType[];
+}
+export interface ReporterEvent extends ReporterFilters {
+    /**
+     * The Severity of this event.
+     */
+    level?: LogLevel;
+    /**
+     * The event message/name.
+     */
+    message: string;
+    /**
+     * Event metadata.
+     */
+    metadata?: Metadata | undefined;
+    /**
+     * Event tags, if supported by the Reporter. (Otherwise, they will be added to metadata)
+     */
+    tags?: Metadata | undefined;
+    /**
+     * Event metrics, if supported by the Reporter. (Otherwise, they will be added to metadata)
+     * Metrics are numbers, and are used for aggregations.
+     */
+    metrics?: Metrics | undefined;
+}
+export interface TrackedReporterEvent extends ReporterEvent {
+    /**
+     * The time this event was created.
+     */
+    occurred: Date;
+}
+export interface ReporterBreadcrumb extends ReporterFilters {
+    /**
+     * The breadcrumb event message/name.
+     */
+    message: string;
+    /**
+     * The category of this breadcrumb (Useful for filtering out in specific reporters).
+     */
+    category?: string | undefined;
+    /**
+     * Breadcrumb metadata.
+     */
+    metadata?: Metadata | undefined;
+}
+export interface ReporterConfigBase {
+    /**
+     * Categories of breadcrumbs to ignore sending to Amplify.
+     * This is useful to prevent data of no use for amplify.
+     */
+    ignoreBreadcrumbCategories?: string[];
+    /**
+     * Ignore specific metadata keys from being sent to Amplify.
+     * This can be a regular expression, or a string to exact match.
+     * This is useful to prevent data of no use for amplify, or if the data keys are too long.
+     */
+    ignoreMetadataPatterns?: (string | RegExp)[];
+}
+/**
+ * A Reporter is a service that can receive Analytics data.
+ */
+export interface IReporter {
+    trackEvent(event: ReporterEvent): void;
+    addBreadcrumb(breadcrumb: ReporterBreadcrumb): void;
+    addMetadata(metadata: Metadata): void;
+    setUser(user: ReportUser | null): void;
+    setRouteName(routeName: string): void;
+    setPageName(pageName: string): void;
+    reportError?(error: ReportError, metadata?: Metadata): void;
+    recordSession?(): void;
+    recordSessionStop?(): void;
+}
+//# sourceMappingURL=reporter.d.ts.map

package/lib/types/reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../../src/types/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE9C,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE7C,oBAAY,WAAW,GAAG;IACxB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,CAAC;CAC5B,CAAC;AAEF,oBAAY,UAAU,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1F,oBAAY,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,EAAE,CAAC;IAC7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,EAAE,CAAC;IACtC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC,aAAa,CAAC,UAAU,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACpD,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtC,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IACvC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,WAAW,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC5D,aAAa,CAAC,IAAI,IAAI,CAAC;IACvB,iBAAiB,CAAC,IAAI,IAAI,CAAC;CAC5B"}

package/lib/types/reporter.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=reporter.js.map

package/lib/types/reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../../src/types/reporter.ts"],"names":[],"mappings":""}

package/lib/utils.d.ts

@@ -1,5 +1,9 @@
-import { ILogger, Metadata } from '.';
+import { ILogger, Metadata } from './types';
+export declare type AttributeMap = Record<string, string[] | string | null>;
 export declare function consoleLogger(name?: string, options?: {
     metadata?: Metadata;
 }): ILogger;
+export declare function filterAttributeMap(attributes: AttributeMap | Record<string, string>, ignorePatterns: (string | RegExp)[]): {
+    [k: string]: string | string[] | null;
+};
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAuC,QAAQ,EAAY,MAAM,GAAG,CAAC;AAErF,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CA6CvF"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAY,QAAQ,EAAY,MAAM,SAAS,CAAC;AAEhE,oBAAY,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AAEpE,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CA6CvF;AAED,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACjD,cAAc,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE;;EASpC"}

package/lib/utils.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.consoleLogger = void 0;
+exports.filterAttributeMap = exports.consoleLogger = void 0;
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable @typescript-eslint/no-explicit-any */
-const _1 = require(".");
+const types_1 = require("./types");
 function consoleLogger(name, options) {
     const logger = {
         startTimer() {
@@ -13,7 +13,7 @@ function consoleLogger(name, options) {
                 done: (args) => {
                     var _a, _b;
                     const duration = new Date().getTime() - start.getTime();
-                    logger[(_a = args === null || args === void 0 ? void 0 : args.level) !== null && _a !== void 0 ? _a : _1.LogLevel.Info](`${(_b = args === null || args === void 0 ? void 0 : args.message) !== null && _b !== void 0 ? _b : 'Timer'} completed in: ${duration}`);
+                    logger[(_a = args === null || args === void 0 ? void 0 : args.level) !== null && _a !== void 0 ? _a : types_1.LogLevel.Info](`${(_b = args === null || args === void 0 ? void 0 : args.message) !== null && _b !== void 0 ? _b : 'Timer'} completed in: ${duration}`);
                     return true;
                 },
             };
@@ -44,4 +44,9 @@ function consoleLogger(name, options) {
     return logger;
 }
 exports.consoleLogger = consoleLogger;
+function filterAttributeMap(attributes, ignorePatterns) {
+    const entries = Object.entries(attributes);
+    return Object.fromEntries(entries.filter(([key]) => !ignorePatterns.some((pattern) => (typeof pattern === 'string' ? pattern === key : pattern.test(key)))));
+}
+exports.filterAttributeMap = filterAttributeMap;
 //# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,uDAAuD;AACvD,wBAAqF;AAErF,SAAgB,aAAa,CAAC,IAAa,EAAE,OAAiC;IAC5E,MAAM,MAAM,GAAY;QACtB,UAAU;YACR,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;YAEzB,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;;oBACb,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;oBACxD,MAAM,CAAC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,WAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC,CAAC;oBAC9F,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,QAA8B,EAAE,IAAa;YACjD,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC3C,CAAC;QAED,GAAG,EAAE,CAAC,KAAe,EAAE,OAAe,EAAE,QAAc,EAAE,EAAE;YACxD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;QAED,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YACrB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACvB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AA7CD,sCA6CC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,uDAAuD;AACvD,mCAAgE;AAIhE,SAAgB,aAAa,CAAC,IAAa,EAAE,OAAiC;IAC5E,MAAM,MAAM,GAAY;QACtB,UAAU;YACR,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;YAEzB,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;;oBACb,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;oBACxD,MAAM,CAAC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,gBAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,OAAO,kBAAkB,QAAQ,EAAE,CAAC,CAAC;oBAC9F,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,QAA8B,EAAE,IAAa;YACjD,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC3C,CAAC;QAED,GAAG,EAAE,CAAC,KAAe,EAAE,OAAe,EAAE,QAAc,EAAE,EAAE;YACxD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;QAED,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YACrB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACvB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACtB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AA7CD,sCA6CC;AAED,SAAgB,kBAAkB,CAChC,UAAiD,EACjD,cAAmC;IAEnC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3C,OAAO,MAAM,CAAC,WAAW,CACvB,OAAO,CAAC,MAAM,CACZ,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAClH,CACF,CAAC;AACJ,CAAC;AAXD,gDAWC"}

package/lib/utils.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.test.d.ts.map

package/lib/utils.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.d.ts","sourceRoot":"","sources":["../src/utils.test.ts"],"names":[],"mappings":""}

package/lib/utils.test.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe('utils', () => {
+    describe('filterAttributeMap', () => {
+        it('should remove attributes which match the ignore patterns', () => {
+            const inputAttributeMap = {
+                includeme: '5',
+                excludeme: 'false',
+                differentProp: 'boo',
+            };
+            const filtered = (0, utils_1.filterAttributeMap)(inputAttributeMap, [/exclude/g, /Prop/g]);
+            expect(filtered['includeme']).toBeTruthy();
+            expect(filtered['excludeme']).toBeFalsy();
+            expect(filtered['differentProp']).toBeFalsy();
+        });
+    });
+});
+//# sourceMappingURL=utils.test.js.map

package/lib/utils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../src/utils.test.ts"],"names":[],"mappings":";;AAAA,mCAA6C;AAE7C,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,iBAAiB,GAAG;gBACxB,SAAS,EAAE,GAAG;gBACd,SAAS,EAAE,OAAO;gBAClB,aAAa,EAAE,KAAK;aACrB,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAA,0BAAkB,EAAC,iBAAiB,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;YAC9E,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@crimson-education/browser-logger",
-  "version": "2.0.2-cognito.2",
+  "version": "2.0.2",
   "description": "An abstract logger and reporting utility for browser environments",
   "scripts": {
     "prepack": "npm run build",
     "clean": "rimraf lib",
     "prebuild": "npm run clean",
     "build": "tsc",
+    "ts-check": "tsc --noEmit",
     "lint": "eslint src",
     "fixlint": "npm run lint -- --fix",
-    "test": "jest --config jest.config.js --passWithNoTests"
+    "test": "jest --config jest.config.js"
   },
   "repository": {
     "type": "git",
@@ -28,8 +29,8 @@
   "homepage": "https://github.com/crimson-education/browser-logger#readme",
   "dependencies": {
     "@aws-amplify/analytics": "^5.2.22",
-    "@datadog/browser-logs": "^4.4.0",
-    "@datadog/browser-rum": "^4.4.0"
+    "@datadog/browser-logs": "^4.21.0",
+    "@datadog/browser-rum": "^4.21.0"
   },
   "devDependencies": {
     "@crimson-education/eslint-config": "^2.1.0",

package/src/index.ts

@@ -1,14 +1,32 @@
-import { ILogger, Metadata, ReportError, ReportUser, ServiceInfo } from './types';
-import { IReporter, ReporterBreadcrumb, ReporterEvent, TrackedReporterEvent } from './reporters';
+import {
+  ILogger,
+  IReporter,
+  Metadata,
+  ReporterBreadcrumb,
+  ReporterEvent,
+  ReporterFilters,
+  ReportError,
+  ReportUser,
+  ServiceInfo,
+  TrackedReporterEvent,
+} from './types';
 import { consoleLogger } from './utils';
-import { datadogLogger, datadogReporter, DatadogReporterConfig } from './reporters/datadogReporter';
-import { gtmReporter } from './reporters/gtmReporter';
-import { amplifyReporter, AmplifyReporterConfig } from './reporters/amplifyReporter';
+import {
+  datadogLogger,
+  datadogReporter,
+  DatadogReporterConfig,
+  gtmReporter,
+  GTMReporterConfig,
+  amplifyReporter,
+  AmplifyReporterConfig,
+} from './reporters';
 
 export * from './types';
 
 export let logger: ILogger | null = null;
 
+export type ReporterType = 'datadog' | 'gtm' | 'amplify';
+
 export type ReporterConfig = ServiceInfo & {
   // Datadog
   datadog?: DatadogReporterConfig;
@@ -17,31 +35,35 @@ export type ReporterConfig = ServiceInfo & {
   amplify?: AmplifyReporterConfig;
 
   // Google Tag Manager
-  gtm?: boolean;
+  gtm?: true | GTMReporterConfig;
 };
 
-const reporters: IReporter[] = [];
+const reporters: Partial<Record<ReporterType, IReporter>> = {};
 let initialized = false;
 let ddInitialized = false;
 
+/**
+ * Initializes the logger and reporters.
+ * @param config Reporter config options.
+ */
 export function init(config: ReporterConfig) {
   initialized = true;
 
   if (config.datadog) {
-    reporters.push(datadogReporter(config, config.datadog));
+    reporters['datadog'] = datadogReporter(config, config.datadog);
     ddInitialized = true;
   }
 
   if (config.amplify) {
-    reporters.push(amplifyReporter(config, config.amplify));
+    reporters['amplify'] = amplifyReporter(config, config.amplify);
   }
 
   if (config.gtm) {
-    reporters.push(gtmReporter());
+    reporters['gtm'] = gtmReporter(config, typeof config.gtm === 'boolean' ? {} : config.gtm);
   }
 
   if (config.defaultMetadata) {
-    for (const reporter of reporters) {
+    for (const reporter of Object.values(reporters)) {
       reporter.addMetadata(config.defaultMetadata);
     }
   }
@@ -49,87 +71,156 @@ export function init(config: ReporterConfig) {
   logger = createLogger('Reporter');
 }
 
+/**
+ * Gets reporters, optionally with filters.
+ * @param filters Filters to remove or specify specific reporters.
+ * @returns Selected reporters, or all registered reporters.
+ */
+function getReporters(filters?: ReporterFilters) {
+  let result = Object.entries(reporters);
+  if (filters?.excludeReporters) {
+    result = result.filter(([key]) => !filters?.excludeReporters?.includes(key as ReporterType));
+  }
+  if (filters?.toReporters) {
+    result = result.filter(([key]) => filters?.toReporters?.includes(key as ReporterType));
+  }
+  return result.map(([, reporter]) => reporter);
+}
+
+/**
+ * Tracks an Analytics event.
+ */
 export function trackEvent(event: ReporterEvent): void {
-  for (const reporter of reporters) {
+  for (const reporter of getReporters(event)) {
     reporter.trackEvent(event);
   }
 }
 
+/**
+ * Tracks an Analytics event, recording the time since the last event, if available.
+ */
+export function trackEventSinceLastAction(event: ReporterEvent): void {
+  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() }));
+}
+
+/**
+ * Gets the last tracked event, if available.
+ */
+export function getLastTrackedEvent(): TrackedReporterEvent | null {
+  const eventStr = sessionStorage.getItem('loggerLastEvent');
+  if (!eventStr) return null;
+
+  const event: TrackedReporterEvent = JSON.parse(eventStr);
+  event.occurred = new Date(event.occurred);
+  return event;
+}
+
+/**
+ * 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 function addBreadcrumb(breadcrumb: ReporterBreadcrumb): void {
-  for (const reporter of reporters) {
+  for (const reporter of getReporters(breadcrumb)) {
     reporter.addBreadcrumb(breadcrumb);
   }
 }
 
-export function addMetadata(metadata: Metadata): void {
-  for (const reporter of reporters) {
+/**
+ * Adds global metadata to all events.
+ * @param metadata Metadata to add.
+ * @param filters Optional filters to specify which reporters to add metadata to.
+ */
+export function addMetadata(metadata: Metadata, filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
     reporter.addMetadata(metadata);
   }
 }
 
-export function setUser(user: ReportUser | null): void {
-  for (const reporter of reporters) {
+/**
+ * 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 function setUser(user: ReportUser | null, filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
     reporter.setUser(user);
   }
 }
 
-export function setRouteName(routeName: string): void {
-  for (const reporter of reporters) {
+/**
+ * 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 function setRouteName(routeName: string, filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
     reporter.setRouteName(routeName);
   }
 }
 
-export function setPageName(pageName: string): void {
-  for (const reporter of reporters) {
+/**
+ * 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 function setPageName(pageName: string, filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
     reporter.setPageName(pageName);
   }
 }
 
-export function reportError(error: ReportError, metadata?: Metadata): void {
-  for (const reporter of reporters) {
-    reporter.reportError(error, metadata);
+/**
+ * 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 function reportError(error: ReportError, metadata?: Metadata, filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
+    reporter.reportError?.(error, metadata);
   }
 }
 
-export function recordSession(): void {
-  for (const reporter of reporters) {
-    reporter.recordSession();
+/**
+ * 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 function recordSession(filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
+    reporter.recordSession?.();
   }
 }
 
-export function recordSessionStop(): void {
-  for (const reporter of reporters) {
-    reporter.recordSessionStop();
+/**
+ * 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 function recordSessionStop(filters?: ReporterFilters): void {
+  for (const reporter of getReporters(filters)) {
+    reporter.recordSessionStop?.();
   }
 }
 
-export function trackEventSinceLastAction(event: ReporterEvent): void {
-  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() }));
-}
-
-export function getLastTrackedEvent(): TrackedReporterEvent | null {
-  const eventStr = sessionStorage.getItem('loggerLastEvent');
-  if (!eventStr) return null;
-
-  const event: TrackedReporterEvent = JSON.parse(eventStr);
-  event.occurred = new Date(event.occurred);
-  return event;
-}
-
+/**
+ * Creates a Logger instance.
+ * @param name Name of the Logger.
+ * @param options Logger configuration options.
+ */
 export function createLogger(name?: string, options?: { metadata?: Metadata }): ILogger {
   if (!initialized) {
     throw new Error('You must call init on BrowserLogger before creating a logger');

package/src/reporters/amplifyReporter.test.ts

@@ -1,4 +1,4 @@
-import { asAttributeMap, filterAttributeMap } from './amplifyReporter';
+import { asAttributeMap } from './amplifyReporter';
 
 describe('amplifyReporter', () => {
   it('should convert all attribute values to arrays of strings', () => {
@@ -58,17 +58,4 @@ describe('amplifyReporter', () => {
     const attributeMap = asAttributeMap(testMetadata, false);
     expect(attributeMap.a).toEqual('5');
   });
-
-  it('should remove attributes which match the ignore patterns', () => {
-    const inputAttributeMap = {
-      includeme: '5',
-      excludeme: 'false',
-      differentProp: 'boo',
-    };
-
-    const filtered = filterAttributeMap(inputAttributeMap, [/exclude/g, /Prop/g]);
-    expect(filtered['includeme']).toBeTruthy();
-    expect(filtered['excludeme']).toBeFalsy();
-    expect(filtered['differentProp']).toBeFalsy();
-  });
 });

package/src/reporters/amplifyReporter.ts

@@ -1,26 +1,67 @@
-import { IReporter, ReporterBreadcrumb, ReporterEvent } from '.';
-import { Metadata, ReportUser, ServiceInfo } from '../types';
+import {
+  IReporter,
+  Metadata,
+  ReporterBreadcrumb,
+  ReporterConfigBase,
+  ReporterEvent,
+  ReportUser,
+  ServiceInfo,
+} from '../types';
 import { Auth } from '@aws-amplify/auth';
 import { Analytics } from '@aws-amplify/analytics';
+import { AttributeMap, filterAttributeMap } from '../utils';
 
-export type AmplifyReporterConfig = {
+export interface AmplifyReporterConfig extends ReporterConfigBase {
+  /**
+   * AWS Region for Amplify.
+   */
   region: string;
   /**
-   * The Identity Pool ID to use for reporting, if set to false, Auth.configure is not called.
+   * The Identity Pool Id to use for reporting, if set to false, Auth.configure is not called.
    * This must be called manually for the reporter to work.
    */
   identityPoolId: string | false;
+  /**
+   * The Pinpoint App Id to report to.
+   */
   analyticsAppId: string;
+  /**
+   * The Cognito User Pool to configure in Auth.configure.
+   * If you are using Cognito, it is better to set identityPoolId to false and configure Auth manually.
+   */
+  userPoolId?: string;
+  /**
+   * The Cognito Web Client Id to configure in Auth.configure.
+   * If you are using Cognito, it is better to set identityPoolId to false and configure Auth manually.
+   */
+  userPoolWebClientId?: string;
+
+  /**
+   * If you want to track which page/url in your webapp is the most frequently viewed one, you can use this feature.
+   * It will automatically send events containing url information when the page is visited.
+   */
   autoTrackPageViews?: boolean;
+  /**
+   * If you want to track user interactions with elements on the page, you can use this feature.
+   * All you need to do is attach the specified selectors to your dom element and turn on the auto tracking.
+   */
   autoTrackEvents?: boolean;
+  /**
+   * A web session can be defined in different ways.
+   * To keep it simple we define that the web session is active when the page is not hidden and inactive when the page is hidden.
+   */
   autoTrackSessions?: boolean;
+
+  /**
+   * The data tag prefix to use for attributing HTML elements. Defaults to data-analytics-
+   */
   selectorPrefix?: string;
-  ignoreBreadcrumbCategories?: string[];
+
+  /**
+   * Modify how the reporter sends events to Amplify.
+   */
   buffering?: AmplifyReporterBufferingConfig;
-  userPoolId?: string;
-  userPoolWebClientId?: string;
-  ignoreMetadataPatterns?: RegExp[];
-};
+}
 
 /**
  * Configuration options for the buffering behavior of Pinpoint's event tracker.
@@ -52,7 +93,7 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
     appName: info.service,
     service: info.service,
     domain: window.location.host,
-    environment: info.service,
+    environment: info.environment,
     version: info.version,
   });
 
@@ -139,24 +180,19 @@ export function amplifyReporter(info: ServiceInfo, config: AmplifyReporterConfig
     setPageName: function (pageName: string): void {
       reporter.addMetadata({ pageName });
     },
-    reportError: function (): void {},
-    recordSession: function (): void {},
-    recordSessionStop: function (): void {},
   };
 
   return reporter;
 }
 
-type AttributeMap = Record<string, string[] | string | null>;
-
 /**
  * Pinpoint has strict attribute name and value length limits
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function asAttributeMap(
-  values: Record<string, any>,
+  values: Record<string, unknown>,
   groupValues = true,
-  ignorePatterns: RegExp[] = [],
+  ignorePatterns: (string | RegExp)[] = [],
 ): AttributeMap {
   const attributeMap = buildAttributeMap(values, undefined, groupValues);
   const filteredAttributeMap = filterAttributeMap(attributeMap, ignorePatterns);
@@ -206,9 +242,3 @@ export function buildAttributeMap(
 
   return valuesWithStringArrays;
 }
-
-export function filterAttributeMap(attributes: AttributeMap | Record<string, string>, ignorePatterns: RegExp[]) {
-  const entries = Object.entries(attributes);
-
-  return Object.fromEntries(entries.filter(([key]) => !ignorePatterns.some((pattern) => pattern.test(key))));
-}