@geekmidas/logger 0.2.0 → 0.4.0

package/src/types.ts

@@ -12,10 +12,10 @@
  * ```
  */
 export type LogFn = {
-  /** Structured logging with context object, optional message, and additional arguments */
-  <T extends object>(obj: T, msg?: string, ...args: any[]): void;
-  /** Simple string logging */
-  (msg: string): void;
+	/** Structured logging with context object, optional message, and additional arguments */
+	<T extends object>(obj: T, msg?: string, ...args: any[]): void;
+	/** Simple string logging */
+	(msg: string): void;
 };
 
 /**
@@ -25,26 +25,26 @@ export type LogFn = {
  * @interface Logger
  */
 export interface Logger {
-  /** Debug level logging - verbose information for debugging */
-  debug: LogFn;
-  /** Info level logging - general informational messages */
-  info: LogFn;
-  /** Warning level logging - potentially harmful situations */
-  warn: LogFn;
-  /** Error level logging - error events that might still allow the application to continue */
-  error: LogFn;
-  /** Fatal level logging - severe errors that will likely cause the application to abort */
-  fatal: LogFn;
-  /** Trace level logging - most detailed information */
-  trace: LogFn;
-  /**
-   * Creates a child logger with additional context.
-   * Child loggers inherit parent context and add their own.
-   *
-   * @param obj - Additional context to include in all child logger calls
-   * @returns A new Logger instance with merged context
-   */
-  child: (obj: object) => Logger;
+	/** Debug level logging - verbose information for debugging */
+	debug: LogFn;
+	/** Info level logging - general informational messages */
+	info: LogFn;
+	/** Warning level logging - potentially harmful situations */
+	warn: LogFn;
+	/** Error level logging - error events that might still allow the application to continue */
+	error: LogFn;
+	/** Fatal level logging - severe errors that will likely cause the application to abort */
+	fatal: LogFn;
+	/** Trace level logging - most detailed information */
+	trace: LogFn;
+	/**
+	 * Creates a child logger with additional context.
+	 * Child loggers inherit parent context and add their own.
+	 *
+	 * @param obj - Additional context to include in all child logger calls
+	 * @returns A new Logger instance with merged context
+	 */
+	child: (obj: object) => Logger;
 }
 
 /**
@@ -65,13 +65,13 @@ export interface Logger {
  * ```
  */
 export enum LogLevel {
-  Trace = 'trace',
-  Debug = 'debug',
-  Info = 'info',
-  Warn = 'warn',
-  Error = 'error',
-  Fatal = 'fatal',
-  Silent = 'silent',
+	Trace = 'trace',
+	Debug = 'debug',
+	Info = 'info',
+	Warn = 'warn',
+	Error = 'error',
+	Fatal = 'fatal',
+	Silent = 'silent',
 }
 
 /**
@@ -106,62 +106,62 @@ export enum LogLevel {
  * ```
  */
 export type RedactOptions =
-  | string[]
-  | {
-      /** Paths to redact using dot notation or bracket notation for special chars */
-      paths: string[];
-      /** Custom replacement text (default: '[REDACTED]') */
-      censor?: string | ((value: unknown, path: string[]) => unknown);
-      /** Remove the field entirely instead of replacing (default: false) */
-      remove?: boolean;
-      /**
-       * How to combine custom paths with default sensitive paths.
-       * - 'merge': Custom paths are added to default paths (default)
-       * - 'override': Only custom paths are used, defaults are ignored
-       */
-      resolution?: 'merge' | 'override';
-    };
+	| string[]
+	| {
+			/** Paths to redact using dot notation or bracket notation for special chars */
+			paths: string[];
+			/** Custom replacement text (default: '[REDACTED]') */
+			censor?: string | ((value: unknown, path: string[]) => unknown);
+			/** Remove the field entirely instead of replacing (default: false) */
+			remove?: boolean;
+			/**
+			 * How to combine custom paths with default sensitive paths.
+			 * - 'merge': Custom paths are added to default paths (default)
+			 * - 'override': Only custom paths are used, defaults are ignored
+			 */
+			resolution?: 'merge' | 'override';
+	  };
 
 export type CreateLoggerOptions = {
-  /** Enable pretty printing with colors (disabled in production) */
-  pretty?: boolean;
-  /** Minimum log level to output */
-  level?: LogLevel;
-  /**
-   * Redaction configuration for masking sensitive data.
-   *
-   * - `true`: Uses default sensitive paths (password, token, secret, etc.)
-   * - `false` or `undefined`: No redaction applied
-   * - `string[]`: Custom paths merged with defaults
-   * - `object`: Advanced config with paths, censor, remove, and resolution options
-   *
-   * By default, custom paths are **merged** with the default sensitive paths.
-   * Use `resolution: 'override'` to disable defaults and use only your paths.
-   *
-   * @example
-   * ```typescript
-   * // Use defaults only
-   * createLogger({ redact: true });
-   *
-   * // Add custom paths (merged with defaults)
-   * createLogger({ redact: ['user.ssn', 'custom.field'] });
-   *
-   * // Override defaults completely
-   * createLogger({
-   *   redact: {
-   *     paths: ['only.these.paths'],
-   *     resolution: 'override',
-   *   }
-   * });
-   *
-   * // Merge with custom censor
-   * createLogger({
-   *   redact: {
-   *     paths: ['extra.secret'],
-   *     censor: '***',
-   *   }
-   * });
-   * ```
-   */
-  redact?: boolean | RedactOptions;
+	/** Enable pretty printing with colors (disabled in production) */
+	pretty?: boolean;
+	/** Minimum log level to output */
+	level?: LogLevel;
+	/**
+	 * Redaction configuration for masking sensitive data.
+	 *
+	 * - `true`: Uses default sensitive paths (password, token, secret, etc.)
+	 * - `false` or `undefined`: No redaction applied
+	 * - `string[]`: Custom paths merged with defaults
+	 * - `object`: Advanced config with paths, censor, remove, and resolution options
+	 *
+	 * By default, custom paths are **merged** with the default sensitive paths.
+	 * Use `resolution: 'override'` to disable defaults and use only your paths.
+	 *
+	 * @example
+	 * ```typescript
+	 * // Use defaults only
+	 * createLogger({ redact: true });
+	 *
+	 * // Add custom paths (merged with defaults)
+	 * createLogger({ redact: ['user.ssn', 'custom.field'] });
+	 *
+	 * // Override defaults completely
+	 * createLogger({
+	 *   redact: {
+	 *     paths: ['only.these.paths'],
+	 *     resolution: 'override',
+	 *   }
+	 * });
+	 *
+	 * // Merge with custom censor
+	 * createLogger({
+	 *   redact: {
+	 *     paths: ['extra.secret'],
+	 *     censor: '***',
+	 *   }
+	 * });
+	 * ```
+	 */
+	redact?: boolean | RedactOptions;
 };

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "composite": true
+  },
+  "include": ["src/**/*"]
+}