@visulima/pail 4.0.0-alpha.10 → 4.0.0-alpha.12

package/dist/reporter/pretty/index.browser.d.ts

@@ -1,2 +1,106 @@
-export type { PrettyStyleOptions } from "./abstract-pretty-reporter.d.ts";
-export { default as PrettyReporter } from "./pretty-reporter.d.ts";
+import { LiteralUnion } from 'type-fest';
+import { D as DefaultLogTypes, L as LoggerTypesConfig, R as ReadonlyMeta, a as LoggerTypesAwareReporter } from "../../packem_shared/types.d-C51XNfQz.js";
+import '@visulima/colorize';
+import '@visulima/interactive-manager';
+/**
+* Abstract Pretty Reporter.
+*
+* Base class for pretty-printing reporters that format log messages with colors,
+* styles, and structured layout. Provides common functionality for styling options
+* and logger type configuration.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* class CustomPrettyReporter extends AbstractPrettyReporter {
+*   public log(meta: ReadonlyMeta) {
+*     const formatted = this.formatMessage(meta);
+*     console.log(formatted);
+*   }
+* }
+* ```
+*/
+declare abstract class AbstractPrettyReporter<T extends string = string, L extends string = string> implements LoggerTypesAwareReporter<T, L> {
+  /** Styling options for pretty formatting */
+  protected readonly styles: PrettyStyleOptions;
+  /** Logger type configurations for styling */
+  protected loggerTypes: LoggerTypesConfig<LiteralUnion<DefaultLogTypes, T>, L>;
+  /**
+  * Creates a new AbstractPrettyReporter instance.
+  * @param options Styling options for pretty formatting
+  * @protected
+  */
+  protected constructor(options: Partial<PrettyStyleOptions>);
+  /**
+  * Sets the logger types configuration for styling.
+  * @param types Logger type configurations with colors and labels
+  */
+  setLoggerTypes(types: LoggerTypesConfig<LiteralUnion<DefaultLogTypes, T>, L>): void;
+  /**
+  * Logs a message with pretty formatting.
+  * @param meta The log metadata to format and output
+  * @abstract
+  */
+  abstract log(meta: ReadonlyMeta<L>): void;
+}
+/**
+* Options for configuring pretty reporter styling.
+*/
+type PrettyStyleOptions = {
+  /** Bold styling options */
+  bold: {
+    /** Whether to bold the label text */
+    label: boolean;
+  };
+  /** Function to format dates in log output */
+  dateFormatter: (date: Date) => string;
+  /** Maximum length of message before line break (optional) */
+  messageLength: number | undefined;
+  /** Underline styling options */
+  underline: {
+    /** Whether to underline the label */
+    label: boolean;
+    /** Whether to underline prefixes */
+    prefix: boolean;
+    /** Whether to underline suffixes */
+    suffix: boolean;
+  };
+  /** Uppercase styling options */
+  uppercase: {
+    /** Whether to uppercase the label text */
+    label: boolean;
+  };
+};
+/**
+* Browser Pretty Reporter.
+*
+* A pretty-printing reporter for browser environments that formats log messages
+* with colors and structured layout for console output. Uses browser-compatible
+* color formatting and console APIs.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* import { createPail } from "@visulima/pail";
+*
+* const logger = createPail({
+*   reporters: [new PrettyReporter({
+*     bold: { label: true },
+*     uppercase: { label: true }
+*   })]
+* });
+*
+* logger.info("Application started");
+* logger.error("Something went wrong", error);
+* ```
+*/
+declare class PrettyReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> {
+  #private;
+  /**
+  * Creates a new Browser Pretty Reporter instance.
+  * @param options Styling options for pretty formatting
+  */
+  constructor(options?: Partial<PrettyStyleOptions>);
+  log(meta: ReadonlyMeta<L>): void;
+}
+export { PrettyReporter, type PrettyStyleOptions };

package/dist/reporter/pretty/index.browser.js

@@ -1 +1 @@
-export { default as PrettyReporter } from '../../packem_shared/PrettyReporter-C2dCzIaf.js';
+export { default as PrettyReporter } from '../../packem_shared/PrettyReporter-CIbrmjUV.js';

package/dist/reporter/pretty/index.d.ts

@@ -1,2 +1,219 @@
-export type { PrettyReporterOptions } from "./pretty-reporter.d.ts";
-export { PrettyReporter } from "./pretty-reporter.d.ts";
+import { InteractiveManager } from '@visulima/interactive-manager';
+import { D as DefaultLogTypes, L as LiteralUnion$1, c as LoggerTypesConfig, R as ReadonlyMeta, f as LoggerTypesAwareReporter, E as ExtendedRfc5424LogLevels, I as InteractiveStreamReporter } from "../../packem_shared/types.d-BeLumqgD.js";
+import '@visulima/colorize';
+type ColorizeMethod = (value: string) => string;
+type CodeFrameOptions = {
+  color?: {
+    gutter?: ColorizeMethod;
+    marker?: ColorizeMethod;
+    message?: ColorizeMethod;
+  };
+  linesAbove?: number;
+  linesBelow?: number;
+  message?: string;
+  prefix?: string;
+  showGutter?: boolean;
+  showLineNumbers?: boolean;
+  tabWidth?: number | false;
+};
+type Options$1 = Omit<CodeFrameOptions, "message | prefix"> & {
+  color: CodeFrameOptions["color"] & {
+    fileLine: ColorizeMethod;
+    hint: ColorizeMethod;
+    method: ColorizeMethod;
+    title: ColorizeMethod;
+  };
+  cwd: string;
+  displayShortPath: boolean;
+  filterStacktrace: ((line: string) => boolean) | undefined;
+  framesMaxLimit: number;
+  hideErrorCauseCodeView: boolean;
+  hideErrorCodeView: boolean;
+  hideErrorErrorsCodeView: boolean;
+  hideErrorTitle: boolean;
+  hideMessage: boolean;
+  indentation: number | "	";
+  prefix: string;
+};
+/**
+Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+@category Type
+*/
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+/**
+Create a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
+
+Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
+
+This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+// Before
+
+type Pet = 'dog' | 'cat' | string;
+
+const petWithoutAutocomplete: Pet = '';
+// Start typing in your TypeScript-enabled IDE.
+// You **will not** get auto-completion for `dog` and `cat` literals.
+
+// After
+
+type Pet2 = LiteralUnion<'dog' | 'cat', string>;
+
+const petWithAutoComplete: Pet2 = '';
+// You **will** get auto-completion for `dog` and `cat` literals.
+```
+
+@category Type
+*/
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+interface Options {
+  breakLength: number;
+  customInspect: boolean;
+  depth: number;
+  indent: number | "	" | undefined;
+  maxArrayLength: number;
+  numericSeparator: boolean;
+  quoteStyle: "double" | "single";
+  showHidden: boolean;
+  showProxy: boolean;
+  stylize: (value: string, styleType: LiteralUnion<"bigint" | "boolean" | "date" | "null" | "number" | "regexp" | "special" | "string" | "symbol" | "undefined", string>) => string;
+  truncate: number;
+}
+/**
+* Abstract Pretty Reporter.
+*
+* Base class for pretty-printing reporters that format log messages with colors,
+* styles, and structured layout. Provides common functionality for styling options
+* and logger type configuration.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* class CustomPrettyReporter extends AbstractPrettyReporter {
+*   public log(meta: ReadonlyMeta) {
+*     const formatted = this.formatMessage(meta);
+*     console.log(formatted);
+*   }
+* }
+* ```
+*/
+declare abstract class AbstractPrettyReporter<T extends string = string, L extends string = string> implements LoggerTypesAwareReporter<T, L> {
+  /** Styling options for pretty formatting */
+  protected readonly styles: PrettyStyleOptions;
+  /** Logger type configurations for styling */
+  protected loggerTypes: LoggerTypesConfig<LiteralUnion$1<DefaultLogTypes, T>, L>;
+  /**
+  * Creates a new AbstractPrettyReporter instance.
+  * @param options Styling options for pretty formatting
+  * @protected
+  */
+  protected constructor(options: Partial<PrettyStyleOptions>);
+  /**
+  * Sets the logger types configuration for styling.
+  * @param types Logger type configurations with colors and labels
+  */
+  setLoggerTypes(types: LoggerTypesConfig<LiteralUnion$1<DefaultLogTypes, T>, L>): void;
+  /**
+  * Logs a message with pretty formatting.
+  * @param meta The log metadata to format and output
+  * @abstract
+  */
+  abstract log(meta: ReadonlyMeta<L>): void;
+}
+/**
+* Options for configuring pretty reporter styling.
+*/
+type PrettyStyleOptions = {
+  /** Bold styling options */
+  bold: {
+    /** Whether to bold the label text */
+    label: boolean;
+  };
+  /** Function to format dates in log output */
+  dateFormatter: (date: Date) => string;
+  /** Maximum length of message before line break (optional) */
+  messageLength: number | undefined;
+  /** Underline styling options */
+  underline: {
+    /** Whether to underline the label */
+    label: boolean;
+    /** Whether to underline prefixes */
+    prefix: boolean;
+    /** Whether to underline suffixes */
+    suffix: boolean;
+  };
+  /** Uppercase styling options */
+  uppercase: {
+    /** Whether to uppercase the label text */
+    label: boolean;
+  };
+};
+/**
+* Options for configuring the Server Pretty Reporter.
+*/
+type PrettyReporterOptions = PrettyStyleOptions & {
+  /** Error rendering options */
+  error: Partial<Omit<Options$1, "color" | "prefix" | "indentation">>;
+  /** Object inspection options */
+  inspect: Partial<Options>;
+};
+/**
+* Server Pretty Reporter.
+*
+* A comprehensive pretty-printing reporter for Node.js server environments that
+* formats log messages with colors, structured layout, and advanced features like
+* error rendering, object inspection, and interactive terminal support.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* import { createPail } from "@visulima/pail";
+*
+* const logger = createPail({
+*   reporters: [new PrettyReporter({
+*     bold: { label: true },
+*     error: { color: { title: 'red' } }
+*   })]
+* });
+*
+* logger.info("Server started on port 3000");
+* logger.error("Database error", dbError);
+* ```
+*/
+declare class PrettyReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> implements InteractiveStreamReporter<L> {
+  #private;
+  /**
+  * Creates a new Server Pretty Reporter instance.
+  * @param options Configuration options for styling, error rendering, and object inspection
+  */
+  constructor(options?: Partial<PrettyReporterOptions>);
+  /**
+  * Sets the stdout stream for the reporter.
+  * @param stdout_ The writable stream to use for standard output
+  */
+  setStdout(stdout_: NodeJS.WriteStream): void;
+  /**
+  * Sets the stderr stream for the reporter.
+  * @param stderr_ The writable stream to use for error output
+  */
+  setStderr(stderr_: NodeJS.WriteStream): void;
+  /**
+  * Sets the interactive manager for handling interactive output.
+  * @param manager The interactive manager instance, or undefined to disable
+  */
+  setInteractiveManager(manager?: InteractiveManager): void;
+  /**
+  * Enables or disables interactive mode.
+  * @param interactive Whether to enable interactive terminal features
+  */
+  setIsInteractive(interactive: boolean): void;
+  log(meta: ReadonlyMeta<L>): void;
+  protected _formatMessage(data: ReadonlyMeta<L>): string;
+  protected _log(message: string, logLevel: LiteralUnion$1<ExtendedRfc5424LogLevels, L>): void;
+}
+export { PrettyReporter, type PrettyReporterOptions };

package/dist/reporter/pretty/index.js

@@ -1 +1 @@
-export { PrettyReporter } from '../../packem_shared/PrettyReporter-gMqa7j_m.js';
+export { PrettyReporter } from '../../packem_shared/PrettyReporter-CNJEO9g7.js';

package/dist/reporter/simple/simple-reporter.server.d.ts

@@ -1,20 +1,170 @@
-import type { RenderErrorOptions } from "@visulima/error";
-import type { Options as InspectorOptions } from "@visulima/inspector";
-import type InteractiveManager from "../../interactive/interactive-manager.d.ts";
-import type { InteractiveStreamReporter, ReadonlyMeta } from "../../types.d.ts";
-import type { PrettyStyleOptions } from "../pretty/abstract-pretty-reporter.d.ts";
-import { AbstractPrettyReporter } from "../pretty/abstract-pretty-reporter.d.ts";
-export type SimpleReporterOptions = PrettyStyleOptions & {
-    error: Partial<Omit<RenderErrorOptions, "color | prefix | indentation">>;
-    inspect: Partial<InspectorOptions>;
+import { InteractiveManager } from '@visulima/interactive-manager';
+import { D as DefaultLogTypes, L as LiteralUnion$1, a as LoggerTypesConfig, g as ReadonlyMeta, e as LoggerTypesAwareReporter, I as InteractiveStreamReporter } from "../../packem_shared/types.d-CM5ie2qm.js";
+import '@visulima/colorize';
+type ColorizeMethod = (value: string) => string;
+type CodeFrameOptions = {
+  color?: {
+    gutter?: ColorizeMethod;
+    marker?: ColorizeMethod;
+    message?: ColorizeMethod;
+  };
+  linesAbove?: number;
+  linesBelow?: number;
+  message?: string;
+  prefix?: string;
+  showGutter?: boolean;
+  showLineNumbers?: boolean;
+  tabWidth?: number | false;
 };
-export declare class SimpleReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> implements InteractiveStreamReporter<L> {
-    #private;
-    constructor(options?: Partial<SimpleReporterOptions>);
-    setStdout(stdout_: NodeJS.WriteStream): void;
-    setStderr(stderr_: NodeJS.WriteStream): void;
-    setInteractiveManager(manager?: InteractiveManager): void;
-    setIsInteractive(interactive: boolean): void;
-    log(meta: ReadonlyMeta<L>): void;
-    protected formatMessage(data: ReadonlyMeta<L>): string;
+type Options$1 = Omit<CodeFrameOptions, "message | prefix"> & {
+  color: CodeFrameOptions["color"] & {
+    fileLine: ColorizeMethod;
+    hint: ColorizeMethod;
+    method: ColorizeMethod;
+    title: ColorizeMethod;
+  };
+  cwd: string;
+  displayShortPath: boolean;
+  filterStacktrace: ((line: string) => boolean) | undefined;
+  framesMaxLimit: number;
+  hideErrorCauseCodeView: boolean;
+  hideErrorCodeView: boolean;
+  hideErrorErrorsCodeView: boolean;
+  hideErrorTitle: boolean;
+  hideMessage: boolean;
+  indentation: number | "	";
+  prefix: string;
+};
+/**
+Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+@category Type
+*/
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+/**
+Create a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
+
+Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
+
+This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+// Before
+
+type Pet = 'dog' | 'cat' | string;
+
+const petWithoutAutocomplete: Pet = '';
+// Start typing in your TypeScript-enabled IDE.
+// You **will not** get auto-completion for `dog` and `cat` literals.
+
+// After
+
+type Pet2 = LiteralUnion<'dog' | 'cat', string>;
+
+const petWithAutoComplete: Pet2 = '';
+// You **will** get auto-completion for `dog` and `cat` literals.
+```
+
+@category Type
+*/
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+interface Options {
+  breakLength: number;
+  customInspect: boolean;
+  depth: number;
+  indent: number | "	" | undefined;
+  maxArrayLength: number;
+  numericSeparator: boolean;
+  quoteStyle: "double" | "single";
+  showHidden: boolean;
+  showProxy: boolean;
+  stylize: (value: string, styleType: LiteralUnion<"bigint" | "boolean" | "date" | "null" | "number" | "regexp" | "special" | "string" | "symbol" | "undefined", string>) => string;
+  truncate: number;
+}
+/**
+* Abstract Pretty Reporter.
+*
+* Base class for pretty-printing reporters that format log messages with colors,
+* styles, and structured layout. Provides common functionality for styling options
+* and logger type configuration.
+* @template T - Custom logger type names
+* @template L - Log level types
+* @example
+* ```typescript
+* class CustomPrettyReporter extends AbstractPrettyReporter {
+*   public log(meta: ReadonlyMeta) {
+*     const formatted = this.formatMessage(meta);
+*     console.log(formatted);
+*   }
+* }
+* ```
+*/
+declare abstract class AbstractPrettyReporter<T extends string = string, L extends string = string> implements LoggerTypesAwareReporter<T, L> {
+  /** Styling options for pretty formatting */
+  protected readonly styles: PrettyStyleOptions;
+  /** Logger type configurations for styling */
+  protected loggerTypes: LoggerTypesConfig<LiteralUnion$1<DefaultLogTypes, T>, L>;
+  /**
+  * Creates a new AbstractPrettyReporter instance.
+  * @param options Styling options for pretty formatting
+  * @protected
+  */
+  protected constructor(options: Partial<PrettyStyleOptions>);
+  /**
+  * Sets the logger types configuration for styling.
+  * @param types Logger type configurations with colors and labels
+  */
+  setLoggerTypes(types: LoggerTypesConfig<LiteralUnion$1<DefaultLogTypes, T>, L>): void;
+  /**
+  * Logs a message with pretty formatting.
+  * @param meta The log metadata to format and output
+  * @abstract
+  */
+  abstract log(meta: ReadonlyMeta<L>): void;
+}
+/**
+* Options for configuring pretty reporter styling.
+*/
+type PrettyStyleOptions = {
+  /** Bold styling options */
+  bold: {
+    /** Whether to bold the label text */
+    label: boolean;
+  };
+  /** Function to format dates in log output */
+  dateFormatter: (date: Date) => string;
+  /** Maximum length of message before line break (optional) */
+  messageLength: number | undefined;
+  /** Underline styling options */
+  underline: {
+    /** Whether to underline the label */
+    label: boolean;
+    /** Whether to underline prefixes */
+    prefix: boolean;
+    /** Whether to underline suffixes */
+    suffix: boolean;
+  };
+  /** Uppercase styling options */
+  uppercase: {
+    /** Whether to uppercase the label text */
+    label: boolean;
+  };
+};
+type SimpleReporterOptions = PrettyStyleOptions & {
+  error: Partial<Omit<Options$1, "color | prefix | indentation">>;
+  inspect: Partial<Options>;
+};
+declare class SimpleReporter<T extends string = string, L extends string = string> extends AbstractPrettyReporter<T, L> implements InteractiveStreamReporter<L> {
+  #private;
+  constructor(options?: Partial<SimpleReporterOptions>);
+  setStdout(stdout_: NodeJS.WriteStream): void;
+  setStderr(stderr_: NodeJS.WriteStream): void;
+  setInteractiveManager(manager?: InteractiveManager): void;
+  setIsInteractive(interactive: boolean): void;
+  log(meta: ReadonlyMeta<L>): void;
+  protected formatMessage(data: ReadonlyMeta<L>): string;
 }
+export { SimpleReporter, SimpleReporterOptions };

package/dist/reporter/simple/simple-reporter.server.js

@@ -8,9 +8,10 @@ const {
   stdout,
   stderr
 } = __cjs_getProcess;
-import colorize, { red, greenBright, cyan, green, grey, bold, bgGrey, underline, white } from '@visulima/colorize';
-import { A as AbstractPrettyReporter, d as defaultInspectorConfig, b as writeStream, t as terminalSize, c as getLongestBadge, g as getLongestLabel, e as getStringWidth, f as formatLabel, a as EMPTY_SYMBOL, i as inspect, w as wordWrap, r as renderError, W as WrapMode } from '../../packem_shared/abstract-pretty-reporter-szQO-IgK.js';
+import colorize from '@visulima/colorize';
+import { A as AbstractPrettyReporter, d as defaultInspectorConfig, w as writeStream, t as terminalSize, b as getLongestBadge, g as getLongestLabel, c as getStringWidth, f as formatLabel, a as EMPTY_SYMBOL, i as inspect, e as wordWrap, r as renderError, W as WrapMode } from '../../packem_shared/abstract-pretty-reporter-CkqCt5hg.js';
 
+const { bgGrey, bold, cyan, green, greenBright, grey, red, underline, white } = colorize;
 const PAIL_DIST_REGEX = /[\\/]pail[\\/]dist/;
 const pailFileFilter = (line) => !PAIL_DIST_REGEX.test(line);
 class SimpleReporter extends AbstractPrettyReporter {