@crimson-education/browser-logger 3.0.5 → 3.0.6

package/lib/types/index.js

@@ -1,19 +1,19 @@
-"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 });
-__exportStar(require("./logger"), exports);
-__exportStar(require("./reporter"), exports);
+"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 });
+__exportStar(require("./logger"), exports);
+__exportStar(require("./reporter"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/logger.d.ts

@@ -1,78 +1,78 @@
-export declare type Metadata = Record<string, any>;
-/**
- * Options to Customize the Logger
- */
-export declare type LoggerOptions = {
-    /**
-     * The min log level for events to be sent to the logger.
-     */
-    logLevel?: LogLevel;
-    /**
-     * Metadata to add to all logs.
-     */
-    metadata?: Metadata;
-};
-export declare enum LogLevel {
-    Debug = "debug",
-    Info = "info",
-    Warn = "warn",
-    Error = "error"
-}
-export interface LogLevelMethod {
-    (message: string, metadata?: Metadata): ILogger;
-    (message: string, ...meta: any[]): ILogger;
-    (message: any): ILogger;
-}
-export interface LogMethod {
-    (level: LogLevel, message: string, metadata?: Metadata): ILogger;
-    (level: LogLevel, message: string, ...meta: any[]): ILogger;
-    (level: LogLevel, message: any): ILogger;
-    (message: Record<string, any>): ILogger;
-}
-export interface Profiler {
-    logger: ILogger;
-    done(info?: {
-        message?: string;
-        level?: LogLevel;
-        metadata?: Metadata;
-    }): boolean;
-}
-export declare type StructuredLog = {
-    level: LogLevel;
-    message: any;
-    [key: string]: any;
-};
-export interface LogTransportConfigBase {
-    /**
-     * The min log level for logs to be sent.
-     */
-    logLevel?: LogLevel;
-    /**
-     * Ignore specific metadata keys from being sent.
-     * This can be a regular expression, or a string to exact match.
-     * This is useful to prevent data of no use for the logger, or if the data keys are too long.
-     */
-    ignoreMetadataPatterns?: (string | RegExp)[];
-}
-/**
- * A logger interface that is used to transport logs to a destination
- */
-export interface ILogTransport extends LogTransportConfigBase {
-    /**
-     * Inbound log event to transport.
-     */
-    log: (logInfo: StructuredLog) => void;
-}
-/**
- * A Logger is a service that can receive log messages.
- */
-export interface ILogger {
-    startTimer(): Profiler;
-    child(metadata?: Metadata, name?: string): ILogger;
-    log: LogMethod;
-    debug: LogLevelMethod;
-    info: LogLevelMethod;
-    warn: LogLevelMethod;
-    error: LogLevelMethod;
-}
+export declare type Metadata = Record<string, any>;
+/**
+ * Options to Customize the Logger
+ */
+export declare type LoggerOptions = {
+    /**
+     * The min log level for events to be sent to the logger.
+     */
+    logLevel?: LogLevel;
+    /**
+     * Metadata to add to all logs.
+     */
+    metadata?: Metadata;
+};
+export declare enum LogLevel {
+    Debug = "debug",
+    Info = "info",
+    Warn = "warn",
+    Error = "error"
+}
+export interface LogLevelMethod {
+    (message: string, metadata?: Metadata): ILogger;
+    (message: string, ...meta: any[]): ILogger;
+    (message: any): ILogger;
+}
+export interface LogMethod {
+    (level: LogLevel, message: string, metadata?: Metadata): ILogger;
+    (level: LogLevel, message: string, ...meta: any[]): ILogger;
+    (level: LogLevel, message: any): ILogger;
+    (message: Record<string, any>): ILogger;
+}
+export interface Profiler {
+    logger: ILogger;
+    done(info?: {
+        message?: string;
+        level?: LogLevel;
+        metadata?: Metadata;
+    }): boolean;
+}
+export declare type StructuredLog = {
+    level: LogLevel;
+    message: any;
+    [key: string]: any;
+};
+export interface LogTransportConfigBase {
+    /**
+     * The min log level for logs to be sent.
+     */
+    logLevel?: LogLevel;
+    /**
+     * Ignore specific metadata keys from being sent.
+     * This can be a regular expression, or a string to exact match.
+     * This is useful to prevent data of no use for the logger, or if the data keys are too long.
+     */
+    ignoreMetadataPatterns?: (string | RegExp)[];
+}
+/**
+ * A logger interface that is used to transport logs to a destination
+ */
+export interface ILogTransport extends LogTransportConfigBase {
+    /**
+     * Inbound log event to transport.
+     */
+    log: (logInfo: StructuredLog) => void;
+}
+/**
+ * A Logger is a service that can receive log messages.
+ */
+export interface ILogger {
+    startTimer(): Profiler;
+    child(metadata?: Metadata, name?: string): ILogger;
+    log: LogMethod;
+    debug: LogLevelMethod;
+    info: LogLevelMethod;
+    warn: LogLevelMethod;
+    error: LogLevelMethod;
+}
 //# sourceMappingURL=logger.d.ts.map

package/lib/types/logger.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = void 0;
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["Debug"] = "debug";
-    LogLevel["Info"] = "info";
-    LogLevel["Warn"] = "warn";
-    LogLevel["Error"] = "error";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["Debug"] = "debug";
+    LogLevel["Info"] = "info";
+    LogLevel["Warn"] = "warn";
+    LogLevel["Error"] = "error";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 //# sourceMappingURL=logger.js.map

package/lib/types/reporter.d.ts

@@ -1,155 +1,155 @@
-import { AmplifyReporterConfig } from '../reporters/amplifyReporter';
-import { DatadogReporterConfig } from '../reporters/datadogReporter';
-import { GTMReporterConfig } from '../reporters/gtmReporter';
-import { LogReporterConfig } from '../reporters/logReporter';
-import { LogLevel, Metadata } from './logger';
-export declare type ReporterConfigurations = {
-    /**
-     * Log reporter configuration.
-     * If not set, it will default to everything enabled.
-     */
-    log?: boolean | LogReporterConfig;
-    /**
-     * Datadog reporter configuration.
-     * If not set, the datadog reporter will not be used.
-     */
-    datadog?: DatadogReporterConfig;
-    /**
-     * Amplify/Pinpoint reporter configuration.
-     * If not set, the amplify reporter will not be used.
-     */
-    amplify?: AmplifyReporterConfig;
-    /**
-     *  Google Tag Manager reporter configuration.
-     * If not set, the gtm reporter will not be used.
-     */
-    gtm?: true | GTMReporterConfig;
-};
-export declare type ReporterType = keyof ReporterConfigurations;
-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;
-    /**
-     * The min log level for logs to be sent to the logger.
-     */
-    logLevel?: LogLevel;
-    /**
-     * The min event level for events to be sent to reporters.
-     */
-    eventLevel?: LogLevel;
-};
-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 {
-    /**
-     * Enable/Disable reporter endpoints from being called.
-     */
-    endpoints?: {
-        trackEvent?: boolean;
-        addMetadata?: boolean;
-        addBreadcrumb?: boolean;
-        setUser?: boolean;
-        setRouteName?: boolean;
-        setPageName?: boolean;
-        reportError?: boolean;
-        recordSession?: boolean;
-        recordSessionStop?: boolean;
-    };
-    /**
-     * The min event level for events to be sent to the reporter.
-     */
-    eventLevel?: LogLevel;
-    /**
-     * Categories of breadcrumbs to ignore sending to the reporter.
-     * This is useful to prevent data of no use for that reporter.
-     */
-    ignoreBreadcrumbCategories?: string[];
-    /**
-     * Ignore specific metadata keys from being sent to the reporter.
-     * This can be a regular expression, or a string to exact match.
-     * This is useful to prevent data of no use for the reporter, or if the data keys are too long.
-     */
-    ignoreMetadataPatterns?: (string | RegExp)[];
-}
-/**
- * A Reporter is a service that can receive Analytics data.
- */
-export interface IReporter extends ReporterConfigBase {
-    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;
-}
+import { AmplifyReporterConfig } from '../reporters/amplifyReporter';
+import { DatadogReporterConfig } from '../reporters/datadogReporter';
+import { GTMReporterConfig } from '../reporters/gtmReporter';
+import { LogReporterConfig } from '../reporters/logReporter';
+import { LogLevel, Metadata } from './logger';
+export declare type ReporterConfigurations = {
+    /**
+     * Log reporter configuration.
+     * If not set, it will default to everything enabled.
+     */
+    log?: boolean | LogReporterConfig;
+    /**
+     * Datadog reporter configuration.
+     * If not set, the datadog reporter will not be used.
+     */
+    datadog?: DatadogReporterConfig;
+    /**
+     * Amplify/Pinpoint reporter configuration.
+     * If not set, the amplify reporter will not be used.
+     */
+    amplify?: AmplifyReporterConfig;
+    /**
+     *  Google Tag Manager reporter configuration.
+     * If not set, the gtm reporter will not be used.
+     */
+    gtm?: true | GTMReporterConfig;
+};
+export declare type ReporterType = keyof ReporterConfigurations;
+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;
+    /**
+     * The min log level for logs to be sent to the logger.
+     */
+    logLevel?: LogLevel;
+    /**
+     * The min event level for events to be sent to reporters.
+     */
+    eventLevel?: LogLevel;
+};
+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 {
+    /**
+     * Enable/Disable reporter endpoints from being called.
+     */
+    endpoints?: {
+        trackEvent?: boolean;
+        addMetadata?: boolean;
+        addBreadcrumb?: boolean;
+        setUser?: boolean;
+        setRouteName?: boolean;
+        setPageName?: boolean;
+        reportError?: boolean;
+        recordSession?: boolean;
+        recordSessionStop?: boolean;
+    };
+    /**
+     * The min event level for events to be sent to the reporter.
+     */
+    eventLevel?: LogLevel;
+    /**
+     * Categories of breadcrumbs to ignore sending to the reporter.
+     * This is useful to prevent data of no use for that reporter.
+     */
+    ignoreBreadcrumbCategories?: string[];
+    /**
+     * Ignore specific metadata keys from being sent to the reporter.
+     * This can be a regular expression, or a string to exact match.
+     * This is useful to prevent data of no use for the reporter, or if the data keys are too long.
+     */
+    ignoreMetadataPatterns?: (string | RegExp)[];
+}
+/**
+ * A Reporter is a service that can receive Analytics data.
+ */
+export interface IReporter extends ReporterConfigBase {
+    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.js

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

package/lib/utils.d.ts

@@ -1,10 +1,10 @@
-import { IReporter, Metadata } from './types';
-/**
- * Recursively filter reporter metadata.
- * @param metadata Deep Metadata to filter.
- * @param reporter Reporter with filter config.
- * @param prefix Prefix for recusring nested metadata.
- * @returns Filtered metadata.
- */
-export declare function filterReporterMetadata<TMetadata extends Metadata | undefined>(metadata: TMetadata, reporter: Pick<IReporter, 'ignoreMetadataPatterns'>, prefix?: string): TMetadata;
+import { IReporter, Metadata } from './types';
+/**
+ * Recursively filter reporter metadata.
+ * @param metadata Deep Metadata to filter.
+ * @param reporter Reporter with filter config.
+ * @param prefix Prefix for recusring nested metadata.
+ * @returns Filtered metadata.
+ */
+export declare function filterReporterMetadata<TMetadata extends Metadata | undefined>(metadata: TMetadata, reporter: Pick<IReporter, 'ignoreMetadataPatterns'>, prefix?: string): TMetadata;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.js

@@ -1,32 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterReporterMetadata = void 0;
-/**
- * Recursively filter reporter metadata.
- * @param metadata Deep Metadata to filter.
- * @param reporter Reporter with filter config.
- * @param prefix Prefix for recusring nested metadata.
- * @returns Filtered metadata.
- */
-function filterReporterMetadata(metadata, reporter, prefix) {
-    const ignorePatterns = reporter.ignoreMetadataPatterns;
-    // No metadata, or no patterns.
-    if (metadata === undefined || !ignorePatterns) {
-        return metadata;
-    }
-    const entries = Object.entries(metadata);
-    return Object.fromEntries(entries
-        .filter(([key]) => {
-        const fullKey = prefix ? prefix + key : key;
-        return !ignorePatterns.some((pattern) => typeof pattern === 'string' ? pattern === fullKey : pattern.test(fullKey));
-    })
-        .map(([key, value]) => {
-        if (typeof value === 'object' && value !== null) {
-            const fullKey = prefix ? prefix + key : key;
-            return [key, filterReporterMetadata(value, reporter, `${fullKey}.`)];
-        }
-        return [key, value];
-    }));
-}
-exports.filterReporterMetadata = filterReporterMetadata;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterReporterMetadata = void 0;
+/**
+ * Recursively filter reporter metadata.
+ * @param metadata Deep Metadata to filter.
+ * @param reporter Reporter with filter config.
+ * @param prefix Prefix for recusring nested metadata.
+ * @returns Filtered metadata.
+ */
+function filterReporterMetadata(metadata, reporter, prefix) {
+    const ignorePatterns = reporter.ignoreMetadataPatterns;
+    // No metadata, or no patterns.
+    if (metadata === undefined || !ignorePatterns) {
+        return metadata;
+    }
+    const entries = Object.entries(metadata);
+    return Object.fromEntries(entries
+        .filter(([key]) => {
+        const fullKey = prefix ? prefix + key : key;
+        return !ignorePatterns.some((pattern) => typeof pattern === 'string' ? pattern === fullKey : pattern.test(fullKey));
+    })
+        .map(([key, value]) => {
+        if (typeof value === 'object' && value !== null) {
+            const fullKey = prefix ? prefix + key : key;
+            return [key, filterReporterMetadata(value, reporter, `${fullKey}.`)];
+        }
+        return [key, value];
+    }));
+}
+exports.filterReporterMetadata = filterReporterMetadata;
 //# sourceMappingURL=utils.js.map

package/lib/utils.test.d.ts

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