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

package/README.md

@@ -1,6 +1,6 @@
 # Crimson Education Browser Logger
 
-An abstract logger and reporting utility for browser environments.
+A structured logger and analytics reporting utility for browser environments.
 
 This library contains a number of reporters that is will send analytics to.
 
@@ -24,6 +24,7 @@ yarn add @crimson-education/browser-logger
 
 ```ts
 import * as Logger from '@crimson-education/browser-logger';
+import { config } from '../configuration';
 
 Logger.init({
   service: 'test-project',
@@ -33,22 +34,39 @@ Logger.init({
     application: 'test',
   },
 
-  datadog: {
-    applicationId: config.datadogApplicationId,
-    clientToken: config.datadogClientToken,
-    site: config.datadogSite,
-    proxyUrl: config.datadogTunnelProxyUrl,
-    version: config.datadogVersion,
-    forwardConsoleLogs: true,
-    trackInteractions: true,
-  },
+  reporters: {
+    log: true,
+
+    gtm: true,
+
+    datadog: {
+      applicationId: config.datadogApplicationId,
+      clientToken: config.datadogClientToken,
+      site: config.datadogSite,
+      proxyUrl: config.datadogTunnelProxyUrl,
+      version: config.datadogVersion,
+
+      sampleRate: config.environment === 'production' ? 50 : 0,
+      replaySampleRate: config.environment === 'production' ? 50 : 0,
 
-  amplify: {
-    region: config.awsRegion,
-    identityPoolId: config.pinpointIdentityPoolId,
-    analyticsAppId: config.pinpointAnalyticsAppId,
-    autoTrackPageViews: true,
-    autoTrackEvents: true,
+      forwardConsoleLogs: true,
+      logTransport: {
+        level: Logger.LogLevel.Info,
+      },
+      trackInteractions: true,
+      trackFrustrations: true,
+      allowedTracingOrigins: ['https://my.api.domain']
+    },
+
+    amplify: {
+      region: config.awsRegion,
+      identityPoolId: config.pinpointIdentityPoolId,
+      analyticsAppId: config.pinpointAnalyticsAppId,
+
+      autoTrackEvents: true,
+      autoTrackPageViews: true,
+      autoTrackSessions: true,
+    }
   }
 });
 
@@ -68,8 +86,7 @@ Logger.trackEvent({
   },
 });
 
-// Must init before you can create a logger.
-const logger = Logger.createLogger('app');
+export const logger = Logger.createLogger();
 
 // Attributed logging.
 logger.info('WOW!', {
@@ -77,6 +94,260 @@ logger.info('WOW!', {
 });
 ```
 
+### Structured Logging
+
+Structured logging in this library is loosely based on Winston, and follows roughly the same interface as `@crimson-education/node-logger`.
+
+Call `Logger.createLogger()` to create a logger instance, it is recommended to re-use this as a global logger everywhere, and then call `.child()` to reuse metadata.
+
+Global metadata about the service will be added for transport usage after calling `Logger.init()`.
+
+You can add more Global Metadata at any time by calling `addMetadata()`.
+
+
+```ts
+export const logger = Logger.createLogger();
+
+const log = logger.child({
+  from: 'childLog',
+});
+
+log.info('My Log', { jobCount: jobs.length });
+
+const timer = log.startTimer();
+
+const result = await job(jobs);
+
+timer.done({ message: 'Job Completed', metadata: { id: result.id } });
+```
+
+### Reporting
+
+#### Opting out of events
+
+You can opt out of sending events to reporters on a global, or per call basis using the endpoints config.
+
+E.g. On calls
+
+```ts
+Logger.trackEvent({
+  message: 'my-event',
+  toReporters: ['log', 'datadog'],
+  excludeReporters: ['datadog']
+});
+```
+
+E.g. Globally
+
+```ts
+Logger.init({
+  reporters: {
+    log: true,
+    datadog: {
+      ...
+      endpoints: {
+        trackEvent: false,
+      }
+    }
+  }
+});
+```
+
+These will only send to the log reporter, it is recommended to use `toReporters` or `excludeReporters` separately as they overlap.
+
+#### Filtering out metadata
+
+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.
+
+```ts
+Logger.init({
+  reporters: {
+    log: {
+      ignoreMetadataPatterns: [
+        'internalError',
+        'user.email',
+        /error\.stack.*/g
+      ]
+    }
+  }
+});
+```
+
+### Filtering out Breadcrumb categories
+
+You can filter what breadcrumbs get sent to reports in the reporter config.
+
+```ts
+Logger.init({
+  reporters: {
+    log: {
+      ignoreBreadcrumbCategories: [
+        'fetch'
+      ]
+    }
+  }
+});
+
+// Not sent to the log reporter.
+Logger.addBreadcrumb({
+  ...
+  category: 'fetch',
+});
+```
+
+### Configure Reporters
+
+#### Log
+
+By default, the log reporter is enabled. This adds all reporter functions to logs. Set `reporters.log` to `false` to disable reporter logging.
+
+```ts
+import { config } from '../configuration';
+import * as Logger from '@crimson-education/browser-logger';
+
+Logger.init({
+  reporters: {
+    log: {
+      trackEventLevel: Logger.LogInfo.Debug,
+      endpoints: {
+        recordSession: false,
+        recordSessionStop: false,
+      }
+    }
+  }
+});
+```
+
+Check out the [`DatadogReporterConfig`](https://github.com/crimson-education/browser-logger/blob/main/src/reporters/datadogReporter.ts) for all of the configuration you can apply to Datadog reporting.
+
+#### Datadog
+
+To configure Datadog, this requires at least `applicationId`, `clientToken` and `site` (As we use an EU instance).
+
+```ts
+import { config } from '../configuration';
+import * as Logger from '@crimson-education/browser-logger';
+
+Logger.init({
+  reporters: {
+    datadog: {
+      applicationId: config.datadogApplicationId,
+      clientToken: config.datadogClientToken,
+      site: config.datadogSite,
+      proxyUrl: config.datadogTunnelProxyUrl,
+      version: config.datadogVersion,
+
+      sampleRate: config.environment === 'production' ? 50 : 0,
+      replaySampleRate: config.environment === 'production' ? 50 : 0,
+
+      forwardConsoleLogs: true,
+      logTransport: {
+        level: Logger.LogLevel.Info,
+      },
+      trackInteractions: true,
+      allowedTracingOrigins: ['https://my.api.domain']
+    }
+  }
+});
+```
+
+Check out the [`DatadogReporterConfig`](https://github.com/crimson-education/browser-logger/blob/main/src/reporters/datadogReporter.ts) for all of the configuration you can apply to Datadog reporting.
+
+This automatically adds a Datadog Log Transport that transmits Log data to Datadog, this can be customized in `DatadogReporterConfig` with `logTransport`, or disabled by setting `logTransport` to `false`.
+
+#### Amplify/Pinpoint
+
+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`:
+```ts
+import { config } from '../configuration';
+import * as Logger from '@crimson-education/browser-logger';
+
+Logger.init({
+  reporters: {
+    amplify: {
+      region: config.amplifyAwsRegion,
+      analyticsAppId: config.pinpointAnalyticsAppId,
+      identityPoolId: config.amplifyIdentityPoolId,
+
+      autoTrackEvents: true,
+      autoTrackPageViews: true,
+      autoTrackSessions: true,
+    }
+  }
+});
+```
+
+Manual `Auth.configure`:
+```ts
+import { Auth } from '@aws-amplify/auth';
+import { config } from '../configuration';
+import * as Logger from '@crimson-education/browser-logger';
+
+Auth.configure({
+  region: config.cognitoRegion,
+  userPoolId: config.cognitoUserPoolId,
+  userPoolWebClientId: config.cognitoClientId,
+  identityPoolId: config.amplifyIdentityPoolId,
+});
+
+Logger.init({
+  reporters: {
+    amplify: {
+      region: config.amplifyAwsRegion,
+      analyticsAppId: config.pinpointAnalyticsAppId,
+      identityPoolId: false,
+
+      autoTrackEvents: true,
+      autoTrackPageViews: true,
+      autoTrackSessions: true,
+    }
+  }
+});
+```
+
+Check out the [`AmplifyReporterConfig`](https://github.com/crimson-education/browser-logger/blob/main/src/reporters/amplifyReporter.ts) for all of the configuration you can apply to Amplify reporting.
+
+#### Google Tag Manager
+
+To configure GTM, you will need to have loaded the GTM script into your App.
+See: https://support.google.com/tagmanager/answer/6103696?hl=en
+
+```ts
+import { config } from '../configuration';
+import * as Logger from '@crimson-education/browser-logger';
+
+// No configuration
+Logger.init({
+  reporters: {
+    gtm: true,
+  }
+});
+
+// With configuration
+Logger.init({
+  reporters: {
+    gtm: {
+      ignoreBreadcrumbCategories: ['fetch']
+    }
+  }
+});
+```
+
+Check out the [`GTMReporterConfig`](https://github.com/crimson-education/browser-logger/blob/main/src/reporters/gtmReporter.ts) for all of the configuration you can apply to Google Tag Manager reporting.
+
+### Functions
+
+See the [src/logger/index.ts](./src/logger/index.ts) file for all exported functions of the Logger.
+See the [src/reporter/index.ts](./src/reporter/index.ts) file for all exported functions of the Reporter.
+
 ### Improve Session Tracking with Component names
 
 You can improve the name of components in analytics tools like Datadog and Amplify use, instead of the content of a component.

package/lib/index.d.ts

@@ -1,27 +1,13 @@
-import { ILogger, Metadata, ReportError, ReportUser, ServiceInfo } from './types';
-import { ReporterBreadcrumb, ReporterEvent, TrackedReporterEvent } from './reporters';
-import { DatadogReporterConfig } from './reporters/datadogReporter';
-import { AmplifyReporterConfig } from './reporters/amplifyReporter';
+import { ReporterConfigurations, ServiceInfo } from './types';
 export * from './types';
-export declare let logger: ILogger | null;
-export declare type ReporterConfig = ServiceInfo & {
-    datadog?: DatadogReporterConfig;
-    amplify?: AmplifyReporterConfig;
-    gtm?: boolean;
+export * from './reporters';
+export * from './logger';
+export declare type LoggerConfig = ServiceInfo & {
+    reporters?: ReporterConfigurations;
 };
-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;
+/**
+ * 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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAClF,OAAO,EAAa,kBAAkB,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEjG,OAAO,EAAkC,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpG,OAAO,EAAmB,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAErF,cAAc,SAAS,CAAC;AAExB,eAAO,IAAI,MAAM,EAAE,OAAO,GAAG,IAAW,CAAC;AAEzC,oBAAY,cAAc,GAAG,WAAW,GAAG;IAEzC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAGhC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAGhC,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAMF,wBAAgB,IAAI,CAAC,MAAM,EAAE,cAAc,QAuB1C;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAIrD;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,kBAAkB,GAAG,IAAI,CAIlE;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAIpD;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,GAAG,IAAI,CAIrD;AAED,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAIpD;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAIzE;AAED,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,wBAAgB,iBAAiB,IAAI,IAAI,CAIxC;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAgBpE;AAED,wBAAgB,mBAAmB,IAAI,oBAAoB,GAAG,IAAI,CAOjE;AAED,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CAUtF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAQ9D,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AAEzB,oBAAY,YAAY,GAAG,WAAW,GAAG;IAAE,SAAS,CAAC,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAIhF;;;GAGG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,YAAY,QA2CxC"}

package/lib/index.js

@@ -14,128 +14,57 @@ 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");
+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);
-exports.logger = null;
-const reporters = [];
+__exportStar(require("./reporters"), exports);
+__exportStar(require("./logger"), exports);
 let initialized = false;
-let ddInitialized = false;
+/**
+ * Initializes the logger and reporters.
+ * @param config Reporter config options.
+ */
 function init(config) {
-    initialized = true;
-    if (config.datadog) {
-        reporters.push((0, datadogReporter_1.datadogReporter)(config, config.datadog));
-        ddInitialized = true;
-    }
-    if (config.amplify) {
-        reporters.push((0, amplifyReporter_1.amplifyReporter)(config, config.amplify));
-    }
-    if (config.gtm) {
-        reporters.push((0, gtmReporter_1.gtmReporter)());
+    var _a, _b, _c, _d, _e, _f;
+    // Some reporters don't like being initialized multiple times.
+    if (initialized) {
+        return;
     }
-    if (config.defaultMetadata) {
-        for (const reporter of reporters) {
-            reporter.addMetadata(config.defaultMetadata);
-        }
-    }
-    exports.logger = createLogger('Reporter');
+    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;
-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 (0, datadogReporter_1.datadogLogger)(name, options);
-    }
-    else {
-        return (0, utils_1.consoleLogger)(name, options);
-    }
-}
-exports.createLogger = createLogger;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,mCAAwC;AACxC,iEAAoG;AACpG,yDAAsD;AACtD,iEAAqF;AAErF,0CAAwB;AAEb,QAAA,MAAM,GAAmB,IAAI,CAAC;AAazC,MAAM,SAAS,GAAgB,EAAE,CAAC;AAClC,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B,SAAgB,IAAI,CAAC,MAAsB;IACzC,WAAW,GAAG,IAAI,CAAC;IAEnB,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,SAAS,CAAC,IAAI,CAAC,IAAA,iCAAe,EAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,aAAa,GAAG,IAAI,CAAC;KACtB;IAED,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,SAAS,CAAC,IAAI,CAAC,IAAA,iCAAe,EAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;KACzD;IAED,IAAI,MAAM,CAAC,GAAG,EAAE;QACd,SAAS,CAAC,IAAI,CAAC,IAAA,yBAAW,GAAE,CAAC,CAAC;KAC/B;IAED,IAAI,MAAM,CAAC,eAAe,EAAE;QAC1B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SAC9C;KACF;IAED,cAAM,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;AACpC,CAAC;AAvBD,oBAuBC;AAED,SAAgB,UAAU,CAAC,KAAoB;IAC7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;KAC5B;AACH,CAAC;AAJD,gCAIC;AAED,SAAgB,aAAa,CAAC,UAA8B;IAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;KACpC;AACH,CAAC;AAJD,sCAIC;AAED,SAAgB,WAAW,CAAC,QAAkB;IAC5C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;KAChC;AACH,CAAC;AAJD,kCAIC;AAED,SAAgB,OAAO,CAAC,IAAuB;IAC7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACxB;AACH,CAAC;AAJD,0BAIC;AAED,SAAgB,YAAY,CAAC,SAAiB;IAC5C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;KAClC;AACH,CAAC;AAJD,oCAIC;AAED,SAAgB,WAAW,CAAC,QAAgB;IAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;KAChC;AACH,CAAC;AAJD,kCAIC;AAED,SAAgB,WAAW,CAAC,KAAkB,EAAE,QAAmB;IACjE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;KACvC;AACH,CAAC;AAJD,kCAIC;AAED,SAAgB,aAAa;IAC3B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,aAAa,EAAE,CAAC;KAC1B;AACH,CAAC;AAJD,sCAIC;AAED,SAAgB,iBAAiB;IAC/B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;KAC9B;AACH,CAAC;AAJD,8CAIC;AAED,SAAgB,yBAAyB,CAAC,KAAoB;IAC5D,MAAM,SAAS,GAAG,mBAAmB,EAAE,CAAC;IACxC,IAAI,SAAS,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrE,UAAU,CAAC;YACT,GAAG,KAAK;YACR,QAAQ,EAAE;gBACR,GAAG,KAAK,CAAC,QAAQ;gBACjB,aAAa,EAAE,SAAS,CAAC,OAAO;gBAChC,kBAAkB,EAAE,QAAQ;aAC7B;SACF,CAAC,CAAC;KACJ;SAAM;QACL,UAAU,CAAC,KAAK,CAAC,CAAC;KACnB;IACD,cAAc,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAChG,CAAC;AAhBD,8DAgBC;AAED,SAAgB,mBAAmB;IACjC,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3D,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3B,MAAM,KAAK,GAAyB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzD,KAAK,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,kDAOC;AAED,SAAgB,YAAY,CAAC,IAAa,EAAE,OAAiC;IAC3E,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;KACjF;IAED,IAAI,aAAa,EAAE;QACjB,OAAO,IAAA,+BAAa,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KACrC;SAAM;QACL,OAAO,IAAA,qBAAa,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KACrC;AACH,CAAC;AAVD,oCAUC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,qCAAuC;AACvC,2CAAoE;AACpE,yDAAsD;AACtD,iEAA8D;AAC9D,iEAA8D;AAC9D,yDAAsD;AAEtD,0CAAwB;AACxB,8CAA4B;AAC5B,2CAAyB;AAIzB,IAAI,WAAW,GAAG,KAAK,CAAC;AAExB;;;GAGG;AACH,SAAgB,IAAI,CAAC,MAAoB;;IACvC,8DAA8D;IAC9D,IAAI,WAAW,EAAE;QACf,OAAO;KACR;IACD,WAAW,GAAG,IAAI,CAAC;IAEnB,mCAAmC;IACnC,MAAM,iBAAiB,GAAG,MAAA,MAAA,MAAM,CAAC,SAAS,0CAAE,GAAG,mCAAI,IAAI,CAAC;IACxD,IAAI,iBAAiB,KAAK,KAAK,EAAE;QAC/B,qBAAS,CAAC,KAAK,CAAC,GAAG,IAAA,yBAAW,EAAC,MAAM,EAAE,OAAO,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;KACzG;IAED,IAAI,MAAA,MAAM,CAAC,SAAS,0CAAE,OAAO,EAAE;QAC7B,qBAAS,CAAC,SAAS,CAAC,GAAG,IAAA,iCAAe,EAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KAC1E;IAED,IAAI,MAAA,MAAM,CAAC,SAAS,0CAAE,OAAO,EAAE;QAC7B,qBAAS,CAAC,SAAS,CAAC,GAAG,IAAA,iCAAe,EAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KAC1E;IAED,IAAI,MAAA,MAAM,CAAC,SAAS,0CAAE,GAAG,EAAE;QACzB,qBAAS,CAAC,KAAK,CAAC,GAAG,IAAA,yBAAW,EAAC,MAAM,EAAE,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC/G;IAED,MAAM,eAAe,GAAG;QACtB,GAAG,CAAC,MAAA,MAAM,CAAC,eAAe,mCAAI,EAAE,CAAC;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC;IAEF,2CAA2C;IAC3C,IAAI,MAAM,CAAC,QAAQ,EAAE;QACnB,IAAA,oBAAW,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;KAC9B;IAED,6CAA6C;IAC7C,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,IAAA,yBAAa,EAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KAClC;IAED,IAAA,uBAAW,EAAC,eAAe,CAAC,CAAC;AAC/B,CAAC;AA3CD,oBA2CC"}

package/lib/logger/consoleTransport.d.ts

@@ -0,0 +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 {};
+//# sourceMappingURL=consoleTransport.d.ts.map

package/lib/logger/consoleTransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleTransport.d.ts","sourceRoot":"","sources":["../../src/logger/consoleTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAG3E,QAAA,MAAM,MAAM;;;;;;;;;;;;;;CAcX,CAAC;AACF,oBAAY,aAAa,GAAG,MAAM,OAAO,MAAM,CAAC;AAEhD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,UAGzD;AAWD,MAAM,WAAW,yBAA0B,SAAQ,sBAAsB;IACvE;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,OAAO,QAAQ,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,aAAa,CAAC;CACvD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,GAAE,yBAA8B,6CAgDtE"}