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

package/src/utils.ts

@@ -1,50 +1,40 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ILogger, Profiler, LogMethod, LogLevelMethod, Metadata, LogLevel } from '.';
-
-export function consoleLogger(name?: string, options?: { metadata?: Metadata }): ILogger {
-  const logger: ILogger = {
-    startTimer(): Profiler {
-      const start = new Date();
-
-      return {
-        logger: this,
-        done: (args) => {
-          const duration = new Date().getTime() - start.getTime();
-          logger[args?.level ?? LogLevel.Info](`${args?.message ?? 'Timer'} completed in: ${duration}`);
-          return true;
-        },
-      };
-    },
-
-    child(metadata?: Record<string, any>, name?: string): ILogger {
-      return consoleLogger(name, { metadata });
-    },
-
-    log: (level: LogLevel, message: string, metadata?: any) => {
-      return logger[level](message, message);
-    },
-
-    debug: (...args: any[]) => {
-      console.debug(...args);
-      return logger;
-    },
-
-    info: (...args: any[]) => {
-      console.log(...args);
-      return logger;
-    },
-
-    warn: (...args: any[]) => {
-      console.warn(...args);
-      return logger;
-    },
-
-    error: (...args: any[]) => {
-      console.error(...args);
-      return logger;
-    },
-  };
-
-  return logger;
+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 function filterReporterMetadata<TMetadata extends Metadata | undefined>(
+  metadata: TMetadata,
+  reporter: Pick<IReporter, 'ignoreMetadataPatterns'>,
+  prefix?: string,
+): TMetadata {
+  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];
+      }),
+  ) as TMetadata;
 }

package/lib/types.d.ts

@@ -1,48 +0,0 @@
-export declare type Metadata = Record<string, any>;
-export declare type Metrics = Record<string, number>;
-export declare type ServiceInfo = {
-    service: string;
-    environment: string;
-    version: string;
-    defaultMetadata?: Metadata;
-};
-export declare type ReportUser = {
-    id: string;
-    email?: string;
-    username?: string;
-    name?: string;
-};
-export declare type ReportError = Error | string;
-export declare enum LogLevel {
-    Debug = "debug",
-    Info = "info",
-    Warn = "warn",
-    Error = "error"
-}
-export interface LogLevelMethod {
-    (message: string, metadata?: any): ILogger;
-    (message: string, ...meta: any[]): ILogger;
-    (message: any): ILogger;
-}
-export interface LogMethod {
-    (level: LogLevel, message: string, metadata?: any): ILogger;
-    (level: LogLevel, message: string, ...meta: any[]): ILogger;
-    (level: LogLevel, message: any): ILogger;
-}
-export interface Profiler {
-    logger: ILogger;
-    done(info?: {
-        message?: string;
-        level?: LogLevel;
-    }): boolean;
-}
-export interface ILogger {
-    startTimer(): Profiler;
-    child(metadata?: Metadata, name?: string): ILogger;
-    log: LogMethod;
-    debug: LogLevelMethod;
-    info: LogLevelMethod;
-    warn: LogLevelMethod;
-    error: LogLevelMethod;
-}
-//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,oBAAY,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE7C,oBAAY,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,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,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IAC3C,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAC3C,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IAC5D,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAC5D,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC;CAC9D;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,IAAI,QAAQ,CAAC;IACvB,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnD,GAAG,EAAE,SAAS,CAAC;IACf,KAAK,EAAE,cAAc,CAAC;IACtB,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,cAAc,CAAC;CACvB"}

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAgBA,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB"}

package/src/types.ts

@@ -1,50 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export type Metadata = Record<string, any>;
-
-export type Metrics = Record<string, number>;
-
-export type ServiceInfo = {
-  service: string;
-  environment: string;
-  version: string;
-  defaultMetadata?: Metadata;
-};
-
-export type ReportUser = { id: string; email?: string; username?: string; name?: string };
-
-export type ReportError = Error | string;
-
-export enum LogLevel {
-  Debug = 'debug',
-  Info = 'info',
-  Warn = 'warn',
-  Error = 'error',
-}
-
-export interface LogLevelMethod {
-  (message: string, metadata?: any): ILogger;
-  (message: string, ...meta: any[]): ILogger;
-  (message: any): ILogger;
-}
-
-export interface LogMethod {
-  (level: LogLevel, message: string, metadata?: any): ILogger;
-  (level: LogLevel, message: string, ...meta: any[]): ILogger;
-  (level: LogLevel, message: any): ILogger;
-}
-
-export interface Profiler {
-  logger: ILogger;
-  done(info?: { message?: string; level?: LogLevel }): boolean;
-}
-
-export interface ILogger {
-  startTimer(): Profiler;
-  child(metadata?: Metadata, name?: string): ILogger;
-
-  log: LogMethod;
-  debug: LogLevelMethod;
-  info: LogLevelMethod;
-  warn: LogLevelMethod;
-  error: LogLevelMethod;
-}