refactor: improve types and exports

src/consola.ts

@@ -1,22 +1,30 @@
-import { LogTypes, LogType } from "./constants";
+import { LogTypes, LogType, LogLevel } from "./constants";
 import { isLogObj } from "./utils/index";
-import type {
-  ConsolaOptions,
-  ConsolaReporter,
-  ConsolaLogObject,
-  ConsolaReporterLogObject,
-} from "./types";
+import type { ConsolaReporter, InputLogObject, LogObject } from "./types";
 import type { PromptOptions } from "./prompt";
 
 let paused = false;
 const queue: any[] = [];
 
+export interface ConsolaOptions {
+  reporters: ConsolaReporter[];
+  types: Record<LogType, InputLogObject>;
+  level: LogLevel;
+  defaults: InputLogObject;
+  throttle: number;
+  throttleMin: number;
+  stdout?: NodeJS.WritableStream;
+  stderr?: NodeJS.WritableStream;
+  mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
+  prompt?: typeof import("./prompt").prompt | undefined;
+}
+
 export class Consola {
   options: ConsolaOptions;
 
   _lastLog: {
     serialized?: string;
-    object?: ConsolaReporterLogObject;
+    object?: LogObject;
     count?: number;
     time?: Date;
     timeout?: ReturnType<typeof setTimeout>;
@@ -40,7 +48,7 @@ export class Consola {
 
     // Create logger functions for current instance
     for (const type in types) {
-      const defaults: ConsolaLogObject = {
+      const defaults: InputLogObject = {
         type: type as LogType,
         ...types[type as LogType],
         ...this.options.defaults,
@@ -94,7 +102,7 @@ export class Consola {
     }) as ConsolaInstance;
   }
 
-  withDefaults(defaults: ConsolaLogObject): ConsolaInstance {
+  withDefaults(defaults: InputLogObject): ConsolaInstance {
     return this.create({
       ...this.options,
       defaults: {
@@ -233,7 +241,7 @@ export class Consola {
     }
   }
 
-  _wrapLogFn(defaults: ConsolaLogObject, isRaw?: boolean) {
+  _wrapLogFn(defaults: InputLogObject, isRaw?: boolean) {
     return (...args: any[]) => {
       if (paused) {
         queue.push([this, defaults, args, isRaw]);
@@ -243,16 +251,17 @@ export class Consola {
     };
   }
 
-  _logFn(defaults: ConsolaLogObject, args: any[], isRaw?: boolean) {
+  _logFn(defaults: InputLogObject, args: any[], isRaw?: boolean) {
     if (((defaults.level as number) || 0) > this.level) {
       return false;
     }
 
     // Construct a new log object
-    const logObj: ConsolaReporterLogObject | ConsolaLogObject = {
+    const logObj: Partial<LogObject> = {
       date: new Date(),
       args: [],
       ...defaults,
+      level: _normalizeLogLevel(defaults.level, this.options.types),
     };
 
     // Consume arguments
@@ -279,7 +288,7 @@ export class Consola {
 
     // Normalize type and tag to lowercase
     logObj.type = (
-      typeof logObj.type === "string" ? logObj.type.toLowerCase() : ""
+      typeof logObj.type === "string" ? logObj.type.toLowerCase() : "log"
     ) as LogType;
     logObj.tag = typeof logObj.tag === "string" ? logObj.tag.toLowerCase() : "";
 
@@ -301,8 +310,8 @@ export class Consola {
 
       // Log
       if (newLog) {
-        this._lastLog.object = logObj as ConsolaReporterLogObject;
-        this._log(logObj as ConsolaReporterLogObject);
+        this._lastLog.object = logObj as LogObject;
+        this._log(logObj as LogObject);
       }
     };
 
@@ -341,7 +350,7 @@ export class Consola {
     resolveLog(true);
   }
 
-  _log(logObj: ConsolaReporterLogObject) {
+  _log(logObj: LogObject) {
     for (const reporter of this.options.reporters) {
       reporter.log(logObj, {
         stdout: this.stdout,
@@ -351,7 +360,11 @@ export class Consola {
   }
 }
 
-function _normalizeLogLevel(input: any, types: any = {}, defaultLevel = 3) {
+function _normalizeLogLevel(
+  input: LogLevel | LogType | undefined,
+  types: any = {},
+  defaultLevel = 3
+) {
   if (input === undefined) {
     return defaultLevel;
   }
@@ -364,18 +377,8 @@ function _normalizeLogLevel(input: any, types: any = {}, defaultLevel = 3) {
   return defaultLevel;
 }
 
-export interface ConsolaInstance extends Consola {
-  fatal(message: ConsolaLogObject | any, ...args: any[]): void;
-  error(message: ConsolaLogObject | any, ...args: any[]): void;
-  warn(message: ConsolaLogObject | any, ...args: any[]): void;
-  log(message: ConsolaLogObject | any, ...args: any[]): void;
-  info(message: ConsolaLogObject | any, ...args: any[]): void;
-  start(message: ConsolaLogObject | any, ...args: any[]): void;
-  success(message: ConsolaLogObject | any, ...args: any[]): void;
-  ready(message: ConsolaLogObject | any, ...args: any[]): void;
-  debug(message: ConsolaLogObject | any, ...args: any[]): void;
-  trace(message: ConsolaLogObject | any, ...args: any[]): void;
-}
+export type ConsolaInstance = Consola &
+  Record<LogType, (message: InputLogObject | any, ...args: any[]) => void>;
 
 // Legacy support
 // @ts-expect-error

src/constants.ts

@@ -1,4 +1,4 @@
-import { ConsolaLogObject } from "./types";
+import { LogObject } from "./types";
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 export type LogLevel = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
@@ -37,63 +37,61 @@ export type LogType =
   // Verbose
   | "debug"
   | "trace"
-  | "verbose"
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  | (string & {});
+  | "verbose";
 
-export const LogTypes: Record<LogType, ConsolaLogObject> = {
+export const LogTypes: Record<LogType, Partial<LogObject>> = {
   // Silent
   silent: {
     level: -1,
   },
 
   // Level 0
   fatal: {
-    level: LogLevels.Fatal,
+    level: LogLevels.fatal,
   },
   error: {
-    level: LogLevels.Error,
+    level: LogLevels.error,
   },
 
   // Level 1
   warn: {
-    level: LogLevels.Warn,
+    level: LogLevels.warn,
   },
 
   // Level 2
   log: {
-    level: LogLevels.Log,
+    level: LogLevels.log,
   },
 
   // Level 3
   info: {
-    level: LogLevels.Info,
+    level: LogLevels.info,
   },
   success: {
-    level: LogLevels.Success,
+    level: LogLevels.success,
   },
   fail: {
-    level: LogLevels.Fail,
+    level: LogLevels.fail,
   },
   ready: {
-    level: LogLevels.Info,
+    level: LogLevels.info,
   },
   start: {
-    level: LogLevels.Info,
+    level: LogLevels.info,
   },
 
   // Level 4
   debug: {
-    level: LogLevels.Debug,
+    level: LogLevels.debug,
   },
 
   // Level 5
   trace: {
-    level: LogLevels.Trace,
+    level: LogLevels.trace,
   },
 
   // Verbose
   verbose: {
-    level: LogLevels.Verbose,
+    level: LogLevels.verbose,
   },
 };

src/index.browser.ts

@@ -1,6 +1,6 @@
 import BrowserReporter from "./reporters/browser";
 import { createConsola as _createConsola } from "./consola";
-import type { ConsolaOptions } from "./types";
+import type { ConsolaOptions } from "./consola";
 
 export * from "./index.shared";
 

src/index.node.ts

@@ -1,6 +1,6 @@
 import { isDebug, isTest, isCI } from "std-env";
 import { LogLevels, LogLevel } from "./constants";
-import type { ConsolaOptions } from "./types";
+import type { ConsolaOptions } from "./consola";
 import { BasicReporter, FancyReporter } from "./reporters";
 import { createConsola as _createConsola } from "./consola";
 
@@ -29,12 +29,12 @@ export function createConsola(options: Partial<ConsolaOptions> = {}) {
 
 function _getDefaultLogLevel() {
   if (isDebug) {
-    return LogLevels.Debug;
+    return LogLevels.debug;
   }
   if (isTest) {
-    return LogLevels.Warn;
+    return LogLevels.warn;
   }
-  return LogLevels.Info;
+  return LogLevels.info;
 }
 
 export const consola = createConsola();

src/index.shared.ts

@@ -1,4 +1,6 @@
 export { Consola } from "./consola";
 export { LogLevels, LogTypes } from "./constants";
+
+export type { ConsolaInstance, ConsolaOptions } from "./consola";
 export type { LogLevel, LogType } from "./constants";
-export { isLogObj } from "./utils";
+export type * from "./types";

src/reporters/basic.ts

@@ -1,5 +1,5 @@
 import util from "node:util";
-import { ConsolaReporterLogObject } from "../types";
+import { LogObject } from "../types";
 import { parseStack } from "../utils/error";
 import { writeStream } from "../utils/stream";
 
@@ -47,7 +47,7 @@ export default class BasicReporter {
     return arr.filter(Boolean).join(" ");
   }
 
-  formatLogObj(logObj: ConsolaReporterLogObject, _opts: any) {
+  formatLogObj(logObj: LogObject, _opts: any) {
     const message = this.formatArgs(logObj.args);
 
     return this.filterAndJoin([
@@ -57,7 +57,7 @@ export default class BasicReporter {
     ]);
   }
 
-  log(logObj: ConsolaReporterLogObject, { stdout, stderr }: any = {}) {
+  log(logObj: LogObject, { stdout, stderr }: any = {}) {
     const line = this.formatLogObj(logObj, {
       width: stdout.columns || 0,
     });

src/reporters/browser.ts

@@ -1,4 +1,4 @@
-import { ConsolaReporterLogObject } from "../types";
+import { LogObject } from "../types";
 
 export default class BrowserReporter {
   options: any;
@@ -30,7 +30,7 @@ export default class BrowserReporter {
     return (console as any).__log || console.log;
   }
 
-  log(logObj: ConsolaReporterLogObject) {
+  log(logObj: LogObject) {
     const consoleLogFn = this._getLogFn(logObj.level);
 
     // Type

src/reporters/fancy.ts

@@ -3,7 +3,7 @@ import { mainSymbols } from "figures";
 import * as colors from "colorette";
 import { parseStack } from "../utils/error";
 import { TYPE_COLOR_MAP, LEVEL_COLOR_MAP } from "../utils/fancy";
-import { ConsolaReporterLogObject } from "../types";
+import { LogObject } from "../types";
 import BasicReporter from "./basic";
 
 const DEFAULTS = {
@@ -43,7 +43,7 @@ export default class FancyReporter extends BasicReporter {
     );
   }
 
-  formatType(logObj: ConsolaReporterLogObject, isBadge: boolean) {
+  formatType(logObj: LogObject, isBadge: boolean) {
     const typeColor =
       (TYPE_COLOR_MAP as any)[logObj.type] ||
       (LEVEL_COLOR_MAP as any)[logObj.level] ||
@@ -62,7 +62,7 @@ export default class FancyReporter extends BasicReporter {
     return _type ? getColor(typeColor)(_type) : "";
   }
 
-  formatLogObj(logObj: ConsolaReporterLogObject, opts: { width: number }) {
+  formatLogObj(logObj: LogObject, opts: { width: number }) {
     const [message, ...additional] = this.formatArgs(logObj.args).split("\n");
 
     const isBadge =