@innei/pretty-logger-core 0.3.0

package/dist/index.d.mts

@@ -0,0 +1,190 @@
+import EventEmitter from 'events';
+
+interface ConsolaOptions {
+    reporters: ConsolaReporter[];
+    types: Record<LogType, InputLogObject>;
+    level: LogLevel;
+    defaults: InputLogObject;
+    throttle: number;
+    throttleMin: number;
+    stdout?: NodeJS.WriteStream;
+    stderr?: NodeJS.WriteStream;
+    mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
+    formatOptions: FormatOptions;
+}
+/**
+ * @see https://nodejs.org/api/util.html#util_util_inspect_object_showhidden_depth_colors
+ */
+interface FormatOptions {
+    columns?: number;
+    date?: boolean;
+    colors?: boolean;
+    compact?: boolean | number;
+    [key: string]: unknown;
+}
+interface InputLogObject {
+    level?: LogLevel;
+    tag?: string;
+    type?: LogType;
+    message?: string;
+    additional?: string | string[];
+    args?: any[];
+    date?: Date;
+}
+interface LogObject extends InputLogObject {
+    level: LogLevel;
+    type: LogType;
+    tag: string;
+    args: any[];
+    date: Date;
+    [key: string]: unknown;
+}
+interface ConsolaReporter {
+    log: (logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }) => void;
+}
+interface WrappedConsola extends ConsolaInstance {
+    onData: (handler: (data: string) => any) => WrappedConsola;
+    onStdOut: (handler: (data: string) => any) => WrappedConsola;
+    onStdErr: (handler: (data: string) => any) => WrappedConsola;
+}
+
+type LogLevel = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
+declare const LogLevels: Record<LogType, number>;
+type LogType = 'silent' | 'fatal' | 'error' | 'warn' | 'log' | 'info' | 'success' | 'fail' | 'ready' | 'start' | 'box' | 'debug' | 'trace' | 'verbose';
+declare const LogTypes: Record<LogType, Partial<LogObject>>;
+
+declare class Consola {
+    options: ConsolaOptions;
+    _lastLog: {
+        serialized?: string;
+        object?: LogObject;
+        count?: number;
+        time?: Date;
+        timeout?: ReturnType<typeof setTimeout>;
+    };
+    _mockFn?: ConsolaOptions['mockFn'];
+    constructor(options?: Partial<ConsolaOptions>);
+    get level(): LogLevel;
+    set level(level: LogLevel);
+    create(options: Partial<ConsolaOptions>): ConsolaInstance;
+    withDefaults(defaults: InputLogObject): ConsolaInstance;
+    withTag(tag: string): ConsolaInstance;
+    addReporter(reporter: ConsolaReporter): this;
+    removeReporter(reporter: ConsolaReporter): ConsolaReporter[] | this;
+    setReporters(reporters: ConsolaReporter[]): this;
+    wrapAll(): void;
+    restoreAll(): void;
+    wrapConsole(): void;
+    restoreConsole(): void;
+    wrapStd(): void;
+    _wrapStream(stream: NodeJS.WriteStream | undefined, type: LogType): void;
+    restoreStd(): void;
+    _restoreStream(stream?: NodeJS.WriteStream): void;
+    pauseLogs(): void;
+    resumeLogs(): void;
+    mockTypes(mockFn?: ConsolaOptions['mockFn']): void;
+    _wrapLogFn(defaults: InputLogObject, isRaw?: boolean): (...args: any[]) => false | undefined;
+    _logFn(defaults: InputLogObject, args: any[], isRaw?: boolean): false | undefined;
+    _log(logObj: LogObject): void;
+}
+interface LogFn {
+    (message: InputLogObject | any, ...args: any[]): void;
+    raw: (...args: any[]) => void;
+}
+type ConsolaInstance = Consola & Record<LogType, LogFn>;
+
+declare function createConsola(options?: Partial<ConsolaOptions & {
+    fancy: boolean;
+}>): ConsolaInstance;
+declare const consola: ConsolaInstance;
+
+declare class BasicReporter implements ConsolaReporter {
+    formatStack(stack: string, opts: FormatOptions): string;
+    formatArgs(args: any[], opts: FormatOptions): string;
+    formatDate(date: Date, opts: FormatOptions): string;
+    filterAndJoin(arr: any[]): string;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): any;
+}
+
+declare const TYPE_COLOR_MAP: {
+    [k in LogType]?: string;
+};
+declare const LEVEL_COLOR_MAP: {
+    [k in LogLevel]?: string;
+};
+declare class FancyReporter extends BasicReporter {
+    formatStack(stack: string): string;
+    formatType(logObj: LogObject, isBadge: boolean, opts: FormatOptions): any;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+}
+
+declare class LoggerReporter extends FancyReporter {
+    private latestLogTime;
+    formatDate(date: Date, opts: FormatOptions): string;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+}
+
+interface FileReporterConfig {
+    loggerDir: string;
+    /**
+     * @default 'stdout_%d%.log'
+     */
+    stdoutFileFormat?: string;
+    /**
+     * @default 'error.log'
+     */
+    stderrFileFormat?: string;
+    /**
+     * refresh logger file stream
+     * @default '0 0 * * *'
+     */
+    cron?: string;
+    /**
+     * Error log will be written to stdout and stderr
+     * @default false
+     */
+    errWriteToStdout?: boolean;
+}
+declare class FileReporter extends LoggerReporter {
+    private readonly configs;
+    constructor(configs: FileReporterConfig);
+    private stdoutStream?;
+    private stderrStream?;
+    private __job?;
+    private scheduleRefreshWriteStream;
+    teardown(): void;
+    private refreshWriteStream;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): any;
+}
+
+interface LoggerConsolaOptions extends Partial<ConsolaOptions> {
+    writeToFile?: FileReporterConfig;
+}
+declare const createLoggerConsola: (options?: LoggerConsolaOptions) => WrappedConsola;
+
+declare class BrowserReporter {
+    options: any;
+    defaultColor: string;
+    levelColorMap: Record<number, string>;
+    typeColorMap: Record<string, string>;
+    constructor(options: any);
+    _getLogFn(level: number): any;
+    log(logObj: LogObject): void;
+}
+
+declare const wrapperSubscribers: (consola: ConsolaInstance) => WrappedConsola;
+declare class SubscriberReporter extends LoggerReporter {
+    static subscriber: EventEmitter;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): void;
+}
+
+export { BasicReporter, BrowserReporter, Consola, type ConsolaInstance, type ConsolaOptions, type ConsolaReporter, FancyReporter, FileReporter, type FileReporterConfig, type FormatOptions, type InputLogObject, LEVEL_COLOR_MAP, type LogLevel, LogLevels, type LogObject, type LogType, LogTypes, type LoggerConsolaOptions, LoggerReporter, SubscriberReporter, TYPE_COLOR_MAP, type WrappedConsola, consola, createConsola, createLoggerConsola, wrapperSubscribers };

package/dist/index.d.ts

@@ -0,0 +1,190 @@
+import EventEmitter from 'events';
+
+interface ConsolaOptions {
+    reporters: ConsolaReporter[];
+    types: Record<LogType, InputLogObject>;
+    level: LogLevel;
+    defaults: InputLogObject;
+    throttle: number;
+    throttleMin: number;
+    stdout?: NodeJS.WriteStream;
+    stderr?: NodeJS.WriteStream;
+    mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
+    formatOptions: FormatOptions;
+}
+/**
+ * @see https://nodejs.org/api/util.html#util_util_inspect_object_showhidden_depth_colors
+ */
+interface FormatOptions {
+    columns?: number;
+    date?: boolean;
+    colors?: boolean;
+    compact?: boolean | number;
+    [key: string]: unknown;
+}
+interface InputLogObject {
+    level?: LogLevel;
+    tag?: string;
+    type?: LogType;
+    message?: string;
+    additional?: string | string[];
+    args?: any[];
+    date?: Date;
+}
+interface LogObject extends InputLogObject {
+    level: LogLevel;
+    type: LogType;
+    tag: string;
+    args: any[];
+    date: Date;
+    [key: string]: unknown;
+}
+interface ConsolaReporter {
+    log: (logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }) => void;
+}
+interface WrappedConsola extends ConsolaInstance {
+    onData: (handler: (data: string) => any) => WrappedConsola;
+    onStdOut: (handler: (data: string) => any) => WrappedConsola;
+    onStdErr: (handler: (data: string) => any) => WrappedConsola;
+}
+
+type LogLevel = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
+declare const LogLevels: Record<LogType, number>;
+type LogType = 'silent' | 'fatal' | 'error' | 'warn' | 'log' | 'info' | 'success' | 'fail' | 'ready' | 'start' | 'box' | 'debug' | 'trace' | 'verbose';
+declare const LogTypes: Record<LogType, Partial<LogObject>>;
+
+declare class Consola {
+    options: ConsolaOptions;
+    _lastLog: {
+        serialized?: string;
+        object?: LogObject;
+        count?: number;
+        time?: Date;
+        timeout?: ReturnType<typeof setTimeout>;
+    };
+    _mockFn?: ConsolaOptions['mockFn'];
+    constructor(options?: Partial<ConsolaOptions>);
+    get level(): LogLevel;
+    set level(level: LogLevel);
+    create(options: Partial<ConsolaOptions>): ConsolaInstance;
+    withDefaults(defaults: InputLogObject): ConsolaInstance;
+    withTag(tag: string): ConsolaInstance;
+    addReporter(reporter: ConsolaReporter): this;
+    removeReporter(reporter: ConsolaReporter): ConsolaReporter[] | this;
+    setReporters(reporters: ConsolaReporter[]): this;
+    wrapAll(): void;
+    restoreAll(): void;
+    wrapConsole(): void;
+    restoreConsole(): void;
+    wrapStd(): void;
+    _wrapStream(stream: NodeJS.WriteStream | undefined, type: LogType): void;
+    restoreStd(): void;
+    _restoreStream(stream?: NodeJS.WriteStream): void;
+    pauseLogs(): void;
+    resumeLogs(): void;
+    mockTypes(mockFn?: ConsolaOptions['mockFn']): void;
+    _wrapLogFn(defaults: InputLogObject, isRaw?: boolean): (...args: any[]) => false | undefined;
+    _logFn(defaults: InputLogObject, args: any[], isRaw?: boolean): false | undefined;
+    _log(logObj: LogObject): void;
+}
+interface LogFn {
+    (message: InputLogObject | any, ...args: any[]): void;
+    raw: (...args: any[]) => void;
+}
+type ConsolaInstance = Consola & Record<LogType, LogFn>;
+
+declare function createConsola(options?: Partial<ConsolaOptions & {
+    fancy: boolean;
+}>): ConsolaInstance;
+declare const consola: ConsolaInstance;
+
+declare class BasicReporter implements ConsolaReporter {
+    formatStack(stack: string, opts: FormatOptions): string;
+    formatArgs(args: any[], opts: FormatOptions): string;
+    formatDate(date: Date, opts: FormatOptions): string;
+    filterAndJoin(arr: any[]): string;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): any;
+}
+
+declare const TYPE_COLOR_MAP: {
+    [k in LogType]?: string;
+};
+declare const LEVEL_COLOR_MAP: {
+    [k in LogLevel]?: string;
+};
+declare class FancyReporter extends BasicReporter {
+    formatStack(stack: string): string;
+    formatType(logObj: LogObject, isBadge: boolean, opts: FormatOptions): any;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+}
+
+declare class LoggerReporter extends FancyReporter {
+    private latestLogTime;
+    formatDate(date: Date, opts: FormatOptions): string;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+}
+
+interface FileReporterConfig {
+    loggerDir: string;
+    /**
+     * @default 'stdout_%d%.log'
+     */
+    stdoutFileFormat?: string;
+    /**
+     * @default 'error.log'
+     */
+    stderrFileFormat?: string;
+    /**
+     * refresh logger file stream
+     * @default '0 0 * * *'
+     */
+    cron?: string;
+    /**
+     * Error log will be written to stdout and stderr
+     * @default false
+     */
+    errWriteToStdout?: boolean;
+}
+declare class FileReporter extends LoggerReporter {
+    private readonly configs;
+    constructor(configs: FileReporterConfig);
+    private stdoutStream?;
+    private stderrStream?;
+    private __job?;
+    private scheduleRefreshWriteStream;
+    teardown(): void;
+    private refreshWriteStream;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): any;
+}
+
+interface LoggerConsolaOptions extends Partial<ConsolaOptions> {
+    writeToFile?: FileReporterConfig;
+}
+declare const createLoggerConsola: (options?: LoggerConsolaOptions) => WrappedConsola;
+
+declare class BrowserReporter {
+    options: any;
+    defaultColor: string;
+    levelColorMap: Record<number, string>;
+    typeColorMap: Record<string, string>;
+    constructor(options: any);
+    _getLogFn(level: number): any;
+    log(logObj: LogObject): void;
+}
+
+declare const wrapperSubscribers: (consola: ConsolaInstance) => WrappedConsola;
+declare class SubscriberReporter extends LoggerReporter {
+    static subscriber: EventEmitter;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): void;
+}
+
+export { BasicReporter, BrowserReporter, Consola, type ConsolaInstance, type ConsolaOptions, type ConsolaReporter, FancyReporter, FileReporter, type FileReporterConfig, type FormatOptions, type InputLogObject, LEVEL_COLOR_MAP, type LogLevel, LogLevels, type LogObject, type LogType, LogTypes, type LoggerConsolaOptions, LoggerReporter, SubscriberReporter, TYPE_COLOR_MAP, type WrappedConsola, consola, createConsola, createLoggerConsola, wrapperSubscribers };