halua 1.1.0 → 2.0.1

package/lib/index.d.cts

@@ -1,18 +1,3 @@
-interface Handler {
-    skipDeepCopyWhenSendingLog?: boolean;
-    level?: LogLevel;
-    exact?: Array<LogLevel>;
-    log: (log: Log) => void;
-}
-interface Log {
-    timestamp: number | string;
-    level: LogLevel;
-    leveling?: [Level, number];
-    args: Array<any>;
-    messageFormat?: string;
-    assertion?: boolean;
-    withArgs?: null | Array<any>;
-}
 declare enum Level {
     Trace = "TRACE",
     Debug = "DEBUG",
@@ -24,22 +9,50 @@ declare enum Level {
 }
 type LogLevel = string;
 
-interface HaluaOptions {
+interface HandlerExecuteMeta {
+    timestamp: number;
+    level: LogLevel;
+}
+interface Handler {
+    /** indicates min level to log */
+    level: LogLevel | undefined;
+    /** indicates exact levels to log */
+    exact: Array<LogLevel> | null;
+    /** indicates if objects should contain spaces and tabs */
+    spacing?: boolean;
+    printTimestamp?: boolean;
+    printLevel?: boolean;
+    execute: (meta: HandlerExecuteMeta) => Generator<YieldMessage, void, NextMessage>;
+    formatArg?: (value: any) => any;
+    formatTimestamp?: (value: number) => string;
+}
+interface BaseHandlerOptions {
     level?: LogLevel;
-    withArgs?: Array<any>;
-    messageFormat?: string;
-    errorPolicy?: "throw" | "pass";
+    exact?: LogLevel | Array<LogLevel>;
+    spacing?: boolean;
+    printTimestamp?: boolean;
+    printLevel?: boolean;
 }
+interface NextMessage {
+    type: NextMessageType;
+    value: any;
+    prev?: string;
+}
+interface YieldMessage {
+    type: YieldMessageType;
+}
+type YieldMessageType = "pass" | "done" | "init";
+type NextMessageType = "arg" | "done" | "init";
+
 interface HaluaLogger {
     New: {
         (handler: PassedHandler): HaluaLogger;
         (options: HaluaOptions): HaluaLogger;
-        (arg1?: PassedHandler | HaluaOptions, arg2?: HaluaOptions): HaluaLogger;
+        (arg1?: PassedHandler | HaluaOptions, options?: HaluaOptions): HaluaLogger;
     };
     With: (...args: any[]) => HaluaLogger;
-    withMessageFormat: (format: string) => HaluaLogger;
-    setHandler: (handler: PassedHandler) => void;
-    appendHandler: (handler: () => Handler) => void;
+    setHandlers: (handler: PassedHandler) => void;
+    appendHandlers: (handler: PassedHandler) => void;
     logTo: (level: LogLevel, ...args: any[]) => void;
     trace: (...args: any[]) => void;
     debug: (...args: any[]) => void;
@@ -50,19 +63,22 @@ interface HaluaLogger {
     fatal: (...args: any[]) => void;
     assert: (assertion: boolean, ...args: any[]) => void;
 }
+interface HaluaOptions {
+    level?: LogLevel;
+    withArgs?: Array<any>;
+}
 type PassedHandler = (() => Handler) | Array<() => Handler>;
 
 declare class Halua implements HaluaLogger {
     private options;
-    private handlers;
     private readonly passedHandlers;
+    private handlers;
     private balancer;
     constructor(passed: PassedHandler, options?: HaluaOptions);
     New(arg1?: PassedHandler | HaluaOptions, arg2?: HaluaOptions | undefined): HaluaLogger;
     With(...args: any[]): HaluaLogger;
-    withMessageFormat(f: string): HaluaLogger;
-    setHandler(handler: PassedHandler): void;
-    appendHandler(handler: () => Handler): void;
+    setHandlers(handler: PassedHandler): void;
+    appendHandlers(handler: PassedHandler): void;
     logTo(level: LogLevel, ...args: any[]): void;
     trace(...args: any[]): void;
     debug(...args: any[]): void;
@@ -73,76 +89,69 @@ declare class Halua implements HaluaLogger {
     fatal(...args: any[]): void;
     assert(assertion: boolean, ...args: any[]): void;
     private updateBalancer;
-    private sendToHandler;
-    private composeLog;
-    private validateHandlers;
+    private sendToBalancer;
     private supposeIsHandler;
-    private unlinkInheritance;
     private buildHandlers;
+    private bindMethods;
 }
 
-type ColorKey = "grey" | "green" | "blue" | "purple" | "orange" | "red";
-type Colors = Map<ColorKey, string>;
+type SendMethod = (data: string) => void;
 
-interface WebConsoleLogHandler extends Handler {
-    setDateGetter: (getter: (timestamp: number) => string) => void;
-    messageFormat: Array<string>;
-}
-interface ConsoleLogHandlerConsole {
+interface OutputConsole {
     debug: (...args: any[]) => void;
     info: (...args: any[]) => void;
     warn: (...args: any[]) => void;
     error: (...args: any[]) => void;
 }
-interface WebConsoleHandlerOptions {
-    /** customize date output */
-    dateGetter?: (timestamp: number) => string;
-    /** turn prettification on, adds colors to console output */
-    pretty?: boolean;
-    linkArguments?: boolean;
-    /** default: true, get browser theme with window.matchMedia */
-    fetchBrowserThemeOnInstanceCreation?: boolean;
-    /** provide custom colors map */
-    customColors?: Colors;
-    messageFormat?: string;
-    useWarn?: boolean;
-    useError?: boolean;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface ConsoleHandlerOptions extends Omit<BaseHandlerOptions, "spacing"> {
 }
-declare function NewWebConsoleHandler(c?: ConsoleLogHandlerConsole, options?: WebConsoleHandlerOptions): () => WebConsoleLogHandler;
+declare function NewConsoleHandler(console: OutputConsole, options?: ConsoleHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly console: OutputConsole;
+    readonly formatArg: (arg: any) => any;
+    applyOptionalOptions(options: ConsoleHandlerOptions): void;
+    execute(meta: {
+        timestamp: number;
+        level: string;
+    }): Generator<YieldMessage, void, NextMessage>;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+    formatTimestamp(t: number): string;
+};
 
-interface JSONLogHandler extends Handler {
-    setDateGetter: (getter: (timestamp: number) => string) => void;
-}
-interface JSONLogHandlerOptions {
-    /** change timestamp output */
-    dateGetter?: (timestamp: number) => string;
-    /** replace value during stringify, return null to fallback on JSONHandler replacer */
-    replaceBeforeStringify?: (value: any) => any;
-    stringifier?: (value: any, replace: (value: any) => any) => string;
-    linkArguments?: boolean;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface JSONLogHandlerOptions extends BaseHandlerOptions {
 }
-declare function NewJSONHandler(send: (data: string) => void, options?: JSONLogHandlerOptions): () => JSONLogHandler;
+declare function NewJSONHandler(send: (data: string) => void, options?: JSONLogHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly formatArg: (arg: any) => string;
+    execute(meta: HandlerExecuteMeta): Generator<YieldMessage, void, NextMessage>;
+    formatTimestamp(t: number): string;
+    applyOptionalOptions(options: JSONLogHandlerOptions): void;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+};
 
-interface TextLogHandler extends Handler {
-}
-interface TextLogHandlerOptions {
-    linkArguments?: boolean;
-    dateGetter?: (t: number) => string;
-    /** @deprecated will be removed in version 2.0.0 */
-    messageFormat?: string;
-    /** replace value during stringify, return null to fallback on JSONHandler replacer */
-    replaceBeforeStringify?: (value: any) => any;
-    /** func to stringify a value */
-    stringifier?: (value: any) => string;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface TextLogHandlerOptions extends BaseHandlerOptions {
 }
-declare function NewTextHandler(send: (data: string) => void, options?: TextLogHandlerOptions): () => TextLogHandler;
+declare function NewTextHandler(send: (data: string) => void, options?: TextLogHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly formatArg: (value: any) => string;
+    applyOptionalOptions(options: TextLogHandlerOptions): void;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+    execute(meta: {
+        timestamp: number;
+        level: string;
+    }): Generator<YieldMessage, void, NextMessage>;
+    formatTimestamp(t: number): string;
+};
 
 declare const halua: Halua;
 
-export { type HaluaLogger, type Handler, Level, type Log, NewJSONHandler, NewTextHandler, NewWebConsoleHandler, halua };
+export { type HaluaLogger, type Handler, Level, NewConsoleHandler, NewJSONHandler, NewTextHandler, halua };

package/lib/index.d.ts

@@ -1,18 +1,3 @@
-interface Handler {
-    skipDeepCopyWhenSendingLog?: boolean;
-    level?: LogLevel;
-    exact?: Array<LogLevel>;
-    log: (log: Log) => void;
-}
-interface Log {
-    timestamp: number | string;
-    level: LogLevel;
-    leveling?: [Level, number];
-    args: Array<any>;
-    messageFormat?: string;
-    assertion?: boolean;
-    withArgs?: null | Array<any>;
-}
 declare enum Level {
     Trace = "TRACE",
     Debug = "DEBUG",
@@ -24,22 +9,50 @@ declare enum Level {
 }
 type LogLevel = string;
 
-interface HaluaOptions {
+interface HandlerExecuteMeta {
+    timestamp: number;
+    level: LogLevel;
+}
+interface Handler {
+    /** indicates min level to log */
+    level: LogLevel | undefined;
+    /** indicates exact levels to log */
+    exact: Array<LogLevel> | null;
+    /** indicates if objects should contain spaces and tabs */
+    spacing?: boolean;
+    printTimestamp?: boolean;
+    printLevel?: boolean;
+    execute: (meta: HandlerExecuteMeta) => Generator<YieldMessage, void, NextMessage>;
+    formatArg?: (value: any) => any;
+    formatTimestamp?: (value: number) => string;
+}
+interface BaseHandlerOptions {
     level?: LogLevel;
-    withArgs?: Array<any>;
-    messageFormat?: string;
-    errorPolicy?: "throw" | "pass";
+    exact?: LogLevel | Array<LogLevel>;
+    spacing?: boolean;
+    printTimestamp?: boolean;
+    printLevel?: boolean;
 }
+interface NextMessage {
+    type: NextMessageType;
+    value: any;
+    prev?: string;
+}
+interface YieldMessage {
+    type: YieldMessageType;
+}
+type YieldMessageType = "pass" | "done" | "init";
+type NextMessageType = "arg" | "done" | "init";
+
 interface HaluaLogger {
     New: {
         (handler: PassedHandler): HaluaLogger;
         (options: HaluaOptions): HaluaLogger;
-        (arg1?: PassedHandler | HaluaOptions, arg2?: HaluaOptions): HaluaLogger;
+        (arg1?: PassedHandler | HaluaOptions, options?: HaluaOptions): HaluaLogger;
     };
     With: (...args: any[]) => HaluaLogger;
-    withMessageFormat: (format: string) => HaluaLogger;
-    setHandler: (handler: PassedHandler) => void;
-    appendHandler: (handler: () => Handler) => void;
+    setHandlers: (handler: PassedHandler) => void;
+    appendHandlers: (handler: PassedHandler) => void;
     logTo: (level: LogLevel, ...args: any[]) => void;
     trace: (...args: any[]) => void;
     debug: (...args: any[]) => void;
@@ -50,19 +63,22 @@ interface HaluaLogger {
     fatal: (...args: any[]) => void;
     assert: (assertion: boolean, ...args: any[]) => void;
 }
+interface HaluaOptions {
+    level?: LogLevel;
+    withArgs?: Array<any>;
+}
 type PassedHandler = (() => Handler) | Array<() => Handler>;
 
 declare class Halua implements HaluaLogger {
     private options;
-    private handlers;
     private readonly passedHandlers;
+    private handlers;
     private balancer;
     constructor(passed: PassedHandler, options?: HaluaOptions);
     New(arg1?: PassedHandler | HaluaOptions, arg2?: HaluaOptions | undefined): HaluaLogger;
     With(...args: any[]): HaluaLogger;
-    withMessageFormat(f: string): HaluaLogger;
-    setHandler(handler: PassedHandler): void;
-    appendHandler(handler: () => Handler): void;
+    setHandlers(handler: PassedHandler): void;
+    appendHandlers(handler: PassedHandler): void;
     logTo(level: LogLevel, ...args: any[]): void;
     trace(...args: any[]): void;
     debug(...args: any[]): void;
@@ -73,76 +89,69 @@ declare class Halua implements HaluaLogger {
     fatal(...args: any[]): void;
     assert(assertion: boolean, ...args: any[]): void;
     private updateBalancer;
-    private sendToHandler;
-    private composeLog;
-    private validateHandlers;
+    private sendToBalancer;
     private supposeIsHandler;
-    private unlinkInheritance;
     private buildHandlers;
+    private bindMethods;
 }
 
-type ColorKey = "grey" | "green" | "blue" | "purple" | "orange" | "red";
-type Colors = Map<ColorKey, string>;
+type SendMethod = (data: string) => void;
 
-interface WebConsoleLogHandler extends Handler {
-    setDateGetter: (getter: (timestamp: number) => string) => void;
-    messageFormat: Array<string>;
-}
-interface ConsoleLogHandlerConsole {
+interface OutputConsole {
     debug: (...args: any[]) => void;
     info: (...args: any[]) => void;
     warn: (...args: any[]) => void;
     error: (...args: any[]) => void;
 }
-interface WebConsoleHandlerOptions {
-    /** customize date output */
-    dateGetter?: (timestamp: number) => string;
-    /** turn prettification on, adds colors to console output */
-    pretty?: boolean;
-    linkArguments?: boolean;
-    /** default: true, get browser theme with window.matchMedia */
-    fetchBrowserThemeOnInstanceCreation?: boolean;
-    /** provide custom colors map */
-    customColors?: Colors;
-    messageFormat?: string;
-    useWarn?: boolean;
-    useError?: boolean;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface ConsoleHandlerOptions extends Omit<BaseHandlerOptions, "spacing"> {
 }
-declare function NewWebConsoleHandler(c?: ConsoleLogHandlerConsole, options?: WebConsoleHandlerOptions): () => WebConsoleLogHandler;
+declare function NewConsoleHandler(console: OutputConsole, options?: ConsoleHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly console: OutputConsole;
+    readonly formatArg: (arg: any) => any;
+    applyOptionalOptions(options: ConsoleHandlerOptions): void;
+    execute(meta: {
+        timestamp: number;
+        level: string;
+    }): Generator<YieldMessage, void, NextMessage>;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+    formatTimestamp(t: number): string;
+};
 
-interface JSONLogHandler extends Handler {
-    setDateGetter: (getter: (timestamp: number) => string) => void;
-}
-interface JSONLogHandlerOptions {
-    /** change timestamp output */
-    dateGetter?: (timestamp: number) => string;
-    /** replace value during stringify, return null to fallback on JSONHandler replacer */
-    replaceBeforeStringify?: (value: any) => any;
-    stringifier?: (value: any, replace: (value: any) => any) => string;
-    linkArguments?: boolean;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface JSONLogHandlerOptions extends BaseHandlerOptions {
 }
-declare function NewJSONHandler(send: (data: string) => void, options?: JSONLogHandlerOptions): () => JSONLogHandler;
+declare function NewJSONHandler(send: (data: string) => void, options?: JSONLogHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly formatArg: (arg: any) => string;
+    execute(meta: HandlerExecuteMeta): Generator<YieldMessage, void, NextMessage>;
+    formatTimestamp(t: number): string;
+    applyOptionalOptions(options: JSONLogHandlerOptions): void;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+};
 
-interface TextLogHandler extends Handler {
-}
-interface TextLogHandlerOptions {
-    linkArguments?: boolean;
-    dateGetter?: (t: number) => string;
-    /** @deprecated will be removed in version 2.0.0 */
-    messageFormat?: string;
-    /** replace value during stringify, return null to fallback on JSONHandler replacer */
-    replaceBeforeStringify?: (value: any) => any;
-    /** func to stringify a value */
-    stringifier?: (value: any) => string;
-    level?: LogLevel;
-    exact?: LogLevel | Array<LogLevel>;
+interface TextLogHandlerOptions extends BaseHandlerOptions {
 }
-declare function NewTextHandler(send: (data: string) => void, options?: TextLogHandlerOptions): () => TextLogHandler;
+declare function NewTextHandler(send: (data: string) => void, options?: TextLogHandlerOptions): () => {
+    level: LogLevel | undefined;
+    exact: Array<LogLevel> | null;
+    readonly formatArg: (value: any) => string;
+    applyOptionalOptions(options: TextLogHandlerOptions): void;
+    sendMethod: SendMethod;
+    printTimestamp: boolean;
+    printLevel: boolean;
+    execute(meta: {
+        timestamp: number;
+        level: string;
+    }): Generator<YieldMessage, void, NextMessage>;
+    formatTimestamp(t: number): string;
+};
 
 declare const halua: Halua;
 
-export { type HaluaLogger, type Handler, Level, type Log, NewJSONHandler, NewTextHandler, NewWebConsoleHandler, halua };
+export { type HaluaLogger, type Handler, Level, NewConsoleHandler, NewJSONHandler, NewTextHandler, halua };