@mks2508/better-logger 0.0.1 → 0.0.2-alpha.2

package/dist/types/core.d.ts

@@ -0,0 +1,211 @@
+export declare const addHandler: (handler: ILogHandler) => void;
+
+/**
+ * Banner types for different visual approaches
+ */
+declare type BannerType = 'simple' | 'ascii' | 'unicode' | 'svg' | 'animated';
+
+/**
+ * Minimal Logger class with core functionality only
+ *
+ * @example
+ * ```typescript
+ * import { CoreLogger } from '@mks2508/better-logger/core';
+ *
+ * const logger = new CoreLogger();
+ * logger.info('Hello world');
+ * logger.error('Something went wrong', error);
+ * ```
+ */
+export declare class CoreLogger {
+    private config;
+    private scopedPrefix?;
+    private handlers;
+    private timers;
+    private groupDepth;
+    /**
+     * Creates a new CoreLogger instance
+     * @param config - Optional configuration
+     */
+    constructor(config?: Partial<LoggerConfig>);
+    /**
+     * Get current configuration
+     */
+    getConfig(): LoggerConfig;
+    /**
+     * Sets the global prefix for all log messages
+     */
+    setGlobalPrefix(prefix: string): void;
+    /**
+     * Sets the verbosity level for filtering log output
+     */
+    setVerbosity(level: Verbosity): void;
+    /**
+     * Creates a scoped logger with a specific prefix
+     */
+    createScopedLogger(prefix: string): CoreLogger;
+    /**
+     * Adds a custom log handler for extensibility
+     */
+    addHandler(handler: ILogHandler): void;
+    /**
+     * Checks if a log level should be output based on current verbosity
+     */
+    private shouldLog;
+    /**
+     * Gets the effective prefix (global + scoped)
+     */
+    private getEffectivePrefix;
+    /**
+     * Core logging method with minimal formatting
+     */
+    private log;
+    /**
+     * Logs debug information (lowest priority)
+     */
+    debug(...args: any[]): void;
+    /**
+     * Logs informational messages
+     */
+    info(...args: any[]): void;
+    /**
+     * Logs warning messages
+     */
+    warn(...args: any[]): void;
+    /**
+     * Logs error messages
+     */
+    error(...args: any[]): void;
+    /**
+     * Logs critical errors (highest priority)
+     */
+    critical(...args: any[]): void;
+    /**
+     * Logs trace information (detailed debugging)
+     */
+    trace(...args: any[]): void;
+    /**
+     * Displays data in a table format
+     */
+    table(data: any, columns?: string[]): void;
+    /**
+     * Starts a collapsible group in the console
+     */
+    group(label: string, collapsed?: boolean): void;
+    /**
+     * Ends the current console group
+     */
+    groupEnd(): void;
+    /**
+     * Starts a timer with the given label
+     */
+    time(label: string): void;
+    /**
+     * Ends a timer and logs the elapsed time
+     */
+    timeEnd(label: string): void;
+}
+
+declare const coreLogger: CoreLogger;
+export default coreLogger;
+
+export declare const createScopedLogger: (prefix: string) => CoreLogger;
+
+export declare const critical: (...args: any[]) => void;
+
+/**
+ * Export individual methods for convenience (with proper binding)
+ */
+export declare const debug: (...args: any[]) => void;
+
+export declare const error: (...args: any[]) => void;
+
+export declare const group: (label: string, collapsed?: boolean) => void;
+
+export declare const groupEnd: () => void;
+
+/**
+ * Interface for custom log handlers (extensibility)
+ */
+export declare interface ILogHandler {
+    handle(level: LogLevel, message: string, args: any[], metadata: LogMetadata): void;
+}
+
+export declare const info: (...args: any[]) => void;
+
+/**
+ * Supported log levels in hierarchical order (debug < info < warn < error < critical)
+ */
+declare const LOG_LEVELS: {
+    readonly debug: 0;
+    readonly info: 1;
+    readonly warn: 2;
+    readonly error: 3;
+    readonly critical: 4;
+};
+
+/**
+ * Configuration interface for logger instances
+ */
+export declare interface LoggerConfig {
+    globalPrefix?: string;
+    verbosity: Verbosity;
+    enableColors: boolean;
+    enableTimestamps: boolean;
+    enableStackTrace: boolean;
+    theme?: ThemeVariant;
+    bannerType?: BannerType;
+    bufferSize?: number;
+}
+
+/**
+ * Log level type derived from LOG_LEVELS keys
+ */
+export declare type LogLevel = keyof typeof LOG_LEVELS;
+
+/**
+ * Metadata associated with each log entry
+ */
+export declare interface LogMetadata {
+    timestamp: string;
+    level: LogLevel;
+    prefix?: string;
+    stackInfo?: StackInfo;
+    group?: string;
+}
+
+export declare const setGlobalPrefix: (prefix: string) => void;
+
+export declare const setVerbosity: (level: Verbosity) => void;
+
+/**
+ * Parsed stack trace information
+ */
+declare interface StackInfo {
+    file: string;
+    line: number;
+    column: number;
+    function?: string;
+}
+
+export declare const table: (data: any, columns?: string[]) => void;
+
+/**
+ * Theme variants for different visual styles
+ */
+declare type ThemeVariant = 'default' | 'dark' | 'light' | 'neon' | 'minimal' | 'cyberpunk';
+
+export declare const time: (label: string) => void;
+
+export declare const timeEnd: (label: string) => void;
+
+export declare const trace: (...args: any[]) => void;
+
+/**
+ * Verbosity level type for filtering logs
+ */
+export declare type Verbosity = LogLevel | 'silent';
+
+export declare const warn: (...args: any[]) => void;
+
+export { }