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

package/dist/types/exports.d.ts

@@ -1,600 +0,0 @@
-export declare const addHandler: (handler: ILogHandler) => void;
-
-/**
- * Remote logging functionality
- */
-export declare const addRemoteHandler: (endpoint: string, apiKey?: string) => void;
-
-/**
- * Banner types for different visual approaches
- */
-declare type BannerType = 'simple' | 'ascii' | 'unicode' | 'svg' | 'animated';
-
-/**
- * Buffer statistics for log management
- */
-declare interface BufferStats {
-    size: number;
-    maxSize: number;
-    usage: number;
-    oldestLog?: Date;
-    newestLog?: Date;
-    levelCounts: Record<LogLevel, number>;
-}
-
-export declare const clearLogs: () => void;
-
-export declare const clearRemoteHandlers: () => void;
-
-export declare const createScopedLogger: (prefix: string) => Logger;
-
-export declare const critical: (...args: any[]) => void;
-
-/**
- * Export individual logging methods with export capabilities
- */
-export declare const debug: (...args: any[]) => void;
-
-export declare const error: (...args: any[]) => void;
-
-/**
- * Export filter options
- */
-declare interface ExportFilters {
-    levels?: LogLevel[];
-    since?: Date | string | number;
-    until?: Date | string | number;
-    prefixes?: string[];
-    excludePrefixes?: string[];
-    withStackTrace?: boolean;
-    errorsOnly?: boolean;
-    last?: number;
-    first?: number;
-    search?: string;
-    groupBy?: 'level' | 'prefix' | 'hour' | 'date';
-}
-
-/**
- * Export formats for log data
- */
-declare type ExportFormat = 'json' | 'csv' | 'markdown' | 'plain' | 'html';
-
-/**
- * Logger with export and remote capabilities
- *
- * @example
- * ```typescript
- * import { ExportLogger } from '@mks2508/better-logger/exports';
- *
- * const logger = new ExportLogger({ bufferSize: 1000 });
- *
- * // Log some data
- * logger.info('User logged in', { userId: 123 });
- * logger.error('Failed to process', { error: 'timeout' });
- *
- * // Export logs
- * const csvData = await logger.exportLogs('csv');
- * const jsonData = await logger.exportLogs('json');
- *
- * // Setup remote logging
- * logger.addRemoteHandler('https://api.myapp.com/logs', 'api-key');
- * ```
- */
-export declare class ExportLogger extends Logger {
-    private exportLogHandler?;
-    private remoteHandlers;
-    constructor(config?: {
-        bufferSize?: number;
-    } & any);
-    /**
-     * Export logs in specified format
-     *
-     * @param format - Export format (csv, json, xml)
-     * @param options - Export options
-     * @returns Promise resolving to exported data
-     *
-     * @example
-     * ```typescript
-     * const csvData = await logger.exportLogs('csv');
-     * const jsonData = await logger.exportLogs('json', {
-     *   filter: { level: 'error' },
-     *   limit: 100
-     * });
-     * ```
-     */
-    exportLogs(format: 'csv' | 'json' | 'xml', options?: {
-        filter?: {
-            level?: LogLevel;
-            from?: Date;
-            to?: Date;
-        };
-        limit?: number;
-    }): Promise<string>;
-    /**
-     * Get current log buffer
-     *
-     * @returns Array of log entries
-     *
-     * @example
-     * ```typescript
-     * const logs = logger.getLogs();
-     * console.log(`Buffered ${logs.length} log entries`);
-     * ```
-     */
-    getLogs(): any[];
-    /**
-     * Clear the log buffer
-     *
-     * @example
-     * ```typescript
-     * logger.clearLogs();
-     * ```
-     */
-    clearLogs(): void;
-    /**
-     * Get log statistics
-     *
-     * @returns Statistics object with counts by level
-     *
-     * @example
-     * ```typescript
-     * const stats = logger.getLogStats();
-     * console.log(`Errors: ${stats.error}, Warnings: ${stats.warn}`);
-     * ```
-     */
-    getLogStats(): Record<string, number>;
-    /**
-     * Add remote logging handler
-     *
-     * @param endpoint - Remote endpoint URL
-     * @param apiKey - Optional API key for authentication
-     *
-     * @example
-     * ```typescript
-     * logger.addRemoteHandler('https://logs.myservice.com/api', 'secret-key');
-     * ```
-     */
-    addRemoteHandler(endpoint: string, apiKey?: string): void;
-    /**
-     * Remove all remote handlers
-     *
-     * @example
-     * ```typescript
-     * logger.clearRemoteHandlers();
-     * ```
-     */
-    clearRemoteHandlers(): void;
-    /**
-     * Flush all remote handlers (force send pending logs)
-     *
-     * @example
-     * ```typescript
-     * await logger.flushRemoteHandlers();
-     * ```
-     */
-    flushRemoteHandlers(): Promise<void>;
-}
-
-declare const exportLogger: ExportLogger;
-export default exportLogger;
-
-/**
- * Export log handler with circular buffer and multiple export formats
- */
-export declare class ExportLogHandler implements ILogHandler {
-    private buffer;
-    private maxSize;
-    private groupDepth;
-    private currentGroup?;
-    constructor(maxSize?: number);
-    /**
-     * Handle incoming log and store in buffer
-     */
-    handle(level: LogLevel, message: string, args: any[], metadata: LogMetadata): void;
-    /**
-     * Set group tracking for nested logs
-     */
-    setGroupInfo(depth: number, groupName?: string): void;
-    /**
-     * Get buffer statistics
-     */
-    getBufferStats(): BufferStats;
-    /**
-     * Clear the buffer
-     */
-    clearBuffer(): void;
-    /**
-     * Set buffer size (with limits)
-     */
-    setBufferSize(size: number): void;
-    /**
-     * Filter logs based on criteria
-     */
-    private filterLogs;
-    /**
-     * Export logs in JSON format
-     */
-    private exportJSON;
-    /**
-     * Export logs in CSV format
-     */
-    private exportCSV;
-    /**
-     * Export logs in Markdown format
-     */
-    private exportMarkdown;
-    /**
-     * Export logs in plain text format
-     */
-    private exportPlain;
-    /**
-     * Export logs in HTML format
-     */
-    private exportHTML;
-    /**
-     * Get emoji for log level
-     */
-    private getLevelEmoji;
-    /**
-     * Main export function
-     */
-    export(format: ExportFormat, filters?: ExportFilters, options?: ExportOptions): ExportResult;
-    /**
-     * Copy to clipboard with fallback
-     */
-    copyToClipboard(format: ExportFormat, filters?: ExportFilters, options?: ExportOptions): Promise<boolean>;
-    /**
-     * Get all logs (for debugging)
-     */
-    getAllLogs(): LogEntry[];
-}
-
-/**
- * Export functionality
- */
-export declare const exportLogs: (format: "csv" | "json" | "xml", options?: any) => Promise<string>;
-
-/**
- * Export options for different formats
- */
-declare interface ExportOptions {
-    minimal?: boolean;
-    compact?: boolean;
-    styled?: boolean;
-    includeMetadata?: boolean;
-    groupBy?: ExportFilters['groupBy'];
-}
-
-/**
- * Export result with metadata
- */
-declare interface ExportResult {
-    format: string;
-    data: string;
-    metadata: {
-        totalLogs: number;
-        filteredLogs: number;
-        exportedAt: string;
-        filters?: ExportFilters;
-        options?: ExportOptions;
-    };
-}
-
-/**
- * Export management utilities
- */
-export declare const exportUtils: {
-    /**
-     * Export current logs as CSV
-     */
-    exportCSV(options?: any): Promise<string>;
-    /**
-     * Export current logs as JSON
-     */
-    exportJSON(options?: any): Promise<string>;
-    /**
-     * Export current logs as XML
-     */
-    exportXML(options?: any): Promise<string>;
-    /**
-     * Get log statistics
-     */
-    getStats(): Record<string, number>;
-    /**
-     * Clear all logs
-     */
-    clear(): void;
-};
-
-export declare const flushRemoteHandlers: () => Promise<void>;
-
-export declare const getLogs: () => any[];
-
-export declare const getLogStats: () => Record<string, number>;
-
-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;
-};
-
-/**
- * Stored log entry for export functionality
- */
-declare interface LogEntry {
-    id: string;
-    timestamp: string;
-    level: LogLevel;
-    prefix?: string;
-    message: string;
-    args: any[];
-    location?: StackInfo;
-    groupInfo?: {
-        depth: number;
-        groupName?: string;
-    };
-}
-
-/**
- * Main Logger class implementing state-of-the-art logging capabilities
- */
-declare class Logger {
-    private config;
-    private scopedPrefix?;
-    private handlers;
-    private timers;
-    private groupDepth;
-    private exportHandler?;
-    private cliProcessor?;
-    /**
-     * Creates a new Logger instance
-     */
-    constructor(config?: Partial<LoggerConfig>);
-    /**
-     * Get current configuration
-     */
-    getConfig(): LoggerConfig;
-    /**
-     * Update configuration
-     */
-    updateConfig(updates: Partial<LoggerConfig>): void;
-    /**
-     * Sets the global prefix for all log messages
-     */
-    setGlobalPrefix(prefix: string): void;
-    /**
-     * Sets the verbosity level for filtering log output
-     */
-    setVerbosity(level: Verbosity): void;
-    /**
-     * Sets the logger theme
-     */
-    setTheme(theme: ThemeVariant): void;
-    /**
-     * Set banner type for initialization display
-     */
-    setBannerType(bannerType: BannerType): void;
-    /**
-     * Reset logger to default configuration
-     */
-    resetConfig(): void;
-    /**
-     * Creates a scoped logger with a specific prefix
-     */
-    createScopedLogger(prefix: string): Logger;
-    /**
-     * Adds a custom log handler for extensibility
-     */
-    addHandler(handler: ILogHandler): void;
-    /**
-     * Get all registered handlers
-     */
-    getHandlers(): ILogHandler[];
-    /**
-     * Get export handler if available
-     */
-    getExportHandler(): ExportLogHandler | undefined;
-    /**
-     * 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 that handles styling and 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 success messages (special info level)
-     */
-    success(...args: any[]): void;
-    /**
-     * Logs trace information (detailed debugging)
-     */
-    trace(...args: any[]): void;
-    /**
-     * Logs critical errors (highest priority)
-     */
-    critical(...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;
-    /**
-     * Display banner with specified or configured type
-     */
-    showBanner(bannerType?: BannerType): void;
-    /**
-     * Log with SVG background image
-     */
-    logWithSVG(message: string, svgContent?: string, options?: StyleOptions): void;
-    /**
-     * Log with animated background gradient
-     */
-    logAnimated(message: string, duration?: number): void;
-    /**
-     * Groups logs by a specific property using modern Object.groupBy (when available)
-     */
-    logGrouped<T>(items: T[], groupBy: (item: T) => string): void;
-    /**
-     * CLI command processor for logger configuration and export
-     */
-    cli(command: string): Promise<void>;
-}
-
-/**
- * Configuration interface for logger instances
- */
-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
- */
-declare type LogLevel = keyof typeof LOG_LEVELS;
-
-/**
- * Metadata associated with each log entry
- */
-declare interface LogMetadata {
-    timestamp: string;
-    level: LogLevel;
-    prefix?: string;
-    stackInfo?: StackInfo;
-    group?: string;
-}
-
-/**
- * Remote log handler for sending logs to external services
- */
-export declare class RemoteLogHandler implements ILogHandler {
-    private endpoint;
-    private apiKey?;
-    constructor(endpoint: string, apiKey?: string);
-    handle(level: LogLevel, message: string, args: any[], metadata: LogMetadata): Promise<void>;
-}
-
-/**
- * Remote logging utilities
- */
-export declare const remoteUtils: {
-    /**
-     * Add remote logging endpoint
-     */
-    addEndpoint(url: string, apiKey?: string): void;
-    /**
-     * Clear all remote endpoints
-     */
-    clearEndpoints(): void;
-    /**
-     * Flush all remote logs
-     */
-    flush(): Promise<void>;
-};
-
-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;
-}
-
-/**
- * Options for styling components
- */
-declare interface StyleOptions {
-    width?: number;
-    height?: number;
-    padding?: string;
-}
-
-export declare const success: (...args: any[]) => void;
-
-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
- */
-declare type Verbosity = LogLevel | 'silent';
-
-export declare const warn: (...args: any[]) => void;
-
-export { }