@andrew_l/pino-pretty 0.3.22 → 0.4.0

package/dist/index.d.mts

@@ -1,171 +1,170 @@
-import { Arrayable, DeepPartial } from '@andrew_l/toolkit';
-import { Transform } from 'node:stream';
-
+import { Transform } from "node:stream";
+import { Arrayable, DeepPartial } from "@andrew_l/toolkit";
+import { StringWidth } from "@cto.af/string-width";
 declare const colorDefs: {
-    reset: (string: string) => string;
-    bold: (string: string) => string;
-    dim: (string: string) => string;
-    italic: (string: string) => string;
-    underline: (string: string) => string;
-    inverse: (string: string) => string;
-    hidden: (string: string) => string;
-    strikethrough: (string: string) => string;
-    black: (string: string) => string;
-    red: (string: string) => string;
-    green: (string: string) => string;
-    yellow: (string: string) => string;
-    blue: (string: string) => string;
-    magenta: (string: string) => string;
-    cyan: (string: string) => string;
-    white: (string: string) => string;
-    gray: (string: string) => string;
-    bgBlack: (string: string) => string;
-    bgRed: (string: string) => string;
-    bgGreen: (string: string) => string;
-    bgYellow: (string: string) => string;
-    bgBlue: (string: string) => string;
-    bgMagenta: (string: string) => string;
-    bgCyan: (string: string) => string;
-    bgWhite: (string: string) => string;
-    blackBright: (string: string) => string;
-    redBright: (string: string) => string;
-    greenBright: (string: string) => string;
-    yellowBright: (string: string) => string;
-    blueBright: (string: string) => string;
-    magentaBright: (string: string) => string;
-    cyanBright: (string: string) => string;
-    whiteBright: (string: string) => string;
-    bgBlackBright: (string: string) => string;
-    bgRedBright: (string: string) => string;
-    bgGreenBright: (string: string) => string;
-    bgYellowBright: (string: string) => string;
-    bgBlueBright: (string: string) => string;
-    bgMagentaBright: (string: string) => string;
-    bgCyanBright: (string: string) => string;
-    bgWhiteBright: (string: string) => string;
-    orange: (string: string) => string;
-    purple: (string: string) => string;
-    pink: (string: string) => string;
-    lime: (string: string) => string;
-    teal: (string: string) => string;
-    indigo: (string: string) => string;
-    brown: (string: string) => string;
-    olive: (string: string) => string;
-    navy: (string: string) => string;
-    maroon: (string: string) => string;
-    silver: (string: string) => string;
-    gold: (string: string) => string;
-    bgOrange: (string: string) => string;
-    bgPurple: (string: string) => string;
-    bgPink: (string: string) => string;
-    bgLime: (string: string) => string;
-    bgTeal: (string: string) => string;
-    bgIndigo: (string: string) => string;
-    bgBrown: (string: string) => string;
-    bgOlive: (string: string) => string;
-    bgNavy: (string: string) => string;
-    bgMaroon: (string: string) => string;
-    bgSilver: (string: string) => string;
-    bgGold: (string: string) => string;
+  reset: (string: string) => string;
+  bold: (string: string) => string;
+  dim: (string: string) => string;
+  italic: (string: string) => string;
+  underline: (string: string) => string;
+  inverse: (string: string) => string;
+  hidden: (string: string) => string;
+  strikethrough: (string: string) => string;
+  black: (string: string) => string;
+  red: (string: string) => string;
+  green: (string: string) => string;
+  yellow: (string: string) => string;
+  blue: (string: string) => string;
+  magenta: (string: string) => string;
+  cyan: (string: string) => string;
+  white: (string: string) => string;
+  gray: (string: string) => string;
+  bgBlack: (string: string) => string;
+  bgRed: (string: string) => string;
+  bgGreen: (string: string) => string;
+  bgYellow: (string: string) => string;
+  bgBlue: (string: string) => string;
+  bgMagenta: (string: string) => string;
+  bgCyan: (string: string) => string;
+  bgWhite: (string: string) => string;
+  blackBright: (string: string) => string;
+  redBright: (string: string) => string;
+  greenBright: (string: string) => string;
+  yellowBright: (string: string) => string;
+  blueBright: (string: string) => string;
+  magentaBright: (string: string) => string;
+  cyanBright: (string: string) => string;
+  whiteBright: (string: string) => string;
+  bgBlackBright: (string: string) => string;
+  bgRedBright: (string: string) => string;
+  bgGreenBright: (string: string) => string;
+  bgYellowBright: (string: string) => string;
+  bgBlueBright: (string: string) => string;
+  bgMagentaBright: (string: string) => string;
+  bgCyanBright: (string: string) => string;
+  bgWhiteBright: (string: string) => string;
+  orange: (string: string) => string;
+  purple: (string: string) => string;
+  pink: (string: string) => string;
+  lime: (string: string) => string;
+  teal: (string: string) => string;
+  indigo: (string: string) => string;
+  brown: (string: string) => string;
+  olive: (string: string) => string;
+  navy: (string: string) => string;
+  maroon: (string: string) => string;
+  silver: (string: string) => string;
+  gold: (string: string) => string;
+  bgOrange: (string: string) => string;
+  bgPurple: (string: string) => string;
+  bgPink: (string: string) => string;
+  bgLime: (string: string) => string;
+  bgTeal: (string: string) => string;
+  bgIndigo: (string: string) => string;
+  bgBrown: (string: string) => string;
+  bgOlive: (string: string) => string;
+  bgNavy: (string: string) => string;
+  bgMaroon: (string: string) => string;
+  bgSilver: (string: string) => string;
+  bgGold: (string: string) => string;
 };
 type ColorName = keyof typeof colorDefs;
-
 type LevelConfig = {
-    /**
-     * Icon symbol displayed before the log message.
-     * @example '🔥' - Fire emoji for error level
-     * @example '✅' - Checkmark for success level
-     */
-    icon: string;
-    color: ColorValue;
-    /**
-     * Level badge name displayed in log output.
-     * Typically uppercase abbreviation of the level name.
-     * @example 'INFO' - Information level
-     * @example 'ERROR' - Error level
-     * @example 'WARN' - Warning level
-     */
-    badge: string;
+  /**
+   * Icon symbol displayed before the log message.
+   * @example '🔥' - Fire emoji for error level
+   * @example '✅' - Checkmark for success level
+   */
+  icon: string;
+  color: ColorValue;
+  /**
+   * Level badge name displayed in log output.
+   * Typically uppercase abbreviation of the level name.
+   * @example 'INFO' - Information level
+   * @example 'ERROR' - Error level
+   * @example 'WARN' - Warning level
+   */
+  badge: string;
 };
 type TypeConfig = {
-    color: ColorValue;
+  color: ColorValue;
 };
 interface PrettyOptions {
-    /**
-     * Pino message key.
-     * @default 'regular'
-     */
-    inspect: 'regular' | 'compact' | InspectFunction;
-    /**
-     * Pino message key.
-     */
-    messageKey: string;
-    /**
-     * Pino nested key.
-     */
-    nestedKey?: string;
-    /**
-     * The maximum number of columns to output, affects formatting and line wrapping.
-     * Should typically match the terminal width for optimal display.
-     * @example process.stdout.columns
-     * @default 80
-     */
-    columns: number;
-    /**
-     * Quote style for string values in log output.
-     * @default 'single'
-     * @example 'single' - Uses single quotes: 'hello world'
-     * @example 'double' - Uses double quotes: "hello world"
-     */
-    quoteStyle: 'single' | 'double';
-    /**
-     * Comma-separated list of log message fields to ignore/hide from output.
-     * Useful for reducing noise by hiding standard fields like hostname or PID.
-     * @example 'time,name' - Hides timestamp and logger name
-     * @default 'hostname,pid'
-     */
-    ignore: string;
-    /**
-     * Number of spaces to use for indentation when formatting nested objects.
-     * @default 2
-     */
-    indent: number;
-    /**
-     * Maximum depth to recurse when formatting nested objects and arrays.
-     * @default 5
-     */
-    depth: number;
-    /**
-     * Minimum log level value at which to show the level badge.
-     * Levels below this threshold will not display their badge text.
-     * @default 40
-     * @example 30 - Show badges for levels 30 and above (info, warn, error, fatal)
-     * @example 50 - Show badges only for levels 50 and above (error, fatal)
-     */
-    badgeMinLevel: number;
-    /**
-     * Maximum length for string values before they are truncated with ellipsis.
-     * @default 400
-     */
-    maxStringLength: number;
-    /**
-     * When enabled, formats numbers like 1234567 as 1_234_567.
-     * @default false
-     */
-    numericSeparator: boolean;
-    /**
-     * Whether to use ANSI colors in the output.
-     * @default true
-     */
-    colorize: boolean;
-    /**
-     * Configuration mapping for log levels.
-     */
-    levels: Record<number, LevelConfig>;
-    /**
-     * Configuration mapping for data types.
-     */
-    types: Record<TypeName, TypeConfig>;
+  /**
+   * Pino message key.
+   * @default 'regular'
+   */
+  inspect: 'regular' | 'compact' | InspectFunction;
+  /**
+   * Pino message key.
+   */
+  messageKey: string;
+  /**
+   * Pino nested key.
+   */
+  nestedKey?: string;
+  /**
+   * The maximum number of columns to output, affects formatting and line wrapping.
+   * Should typically match the terminal width for optimal display.
+   * @example process.stdout.columns
+   * @default 80
+   */
+  columns: number;
+  /**
+   * Quote style for string values in log output.
+   * @default 'single'
+   * @example 'single' - Uses single quotes: 'hello world'
+   * @example 'double' - Uses double quotes: "hello world"
+   */
+  quoteStyle: 'single' | 'double';
+  /**
+   * Comma-separated list of log message fields to ignore/hide from output.
+   * Useful for reducing noise by hiding standard fields like hostname or PID.
+   * @example 'time,name' - Hides timestamp and logger name
+   * @default 'hostname,pid'
+   */
+  ignore: string;
+  /**
+   * Number of spaces to use for indentation when formatting nested objects.
+   * @default 2
+   */
+  indent: number;
+  /**
+   * Maximum depth to recurse when formatting nested objects and arrays.
+   * @default 5
+   */
+  depth: number;
+  /**
+   * Minimum log level value at which to show the level badge.
+   * Levels below this threshold will not display their badge text.
+   * @default 40
+   * @example 30 - Show badges for levels 30 and above (info, warn, error, fatal)
+   * @example 50 - Show badges only for levels 50 and above (error, fatal)
+   */
+  badgeMinLevel: number;
+  /**
+   * Maximum length for string values before they are truncated with ellipsis.
+   * @default 400
+   */
+  maxStringLength: number;
+  /**
+   * When enabled, formats numbers like 1234567 as 1_234_567.
+   * @default false
+   */
+  numericSeparator: boolean;
+  /**
+   * Whether to use ANSI colors in the output.
+   * @default true
+   */
+  colorize: boolean;
+  /**
+   * Configuration mapping for log levels.
+   */
+  levels: Record<number, LevelConfig>;
+  /**
+   * Configuration mapping for data types.
+   */
+  types: Record<TypeName, TypeConfig>;
 }
 type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorStack' | 'time' | 'name';
 /**
@@ -175,32 +174,31 @@ type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorSta
 type ColorValue = 'rand' | Arrayable<ColorName>;
 type InspectFunction = (obj: any, opts: InspectOptions) => string;
 interface InspectOptions {
-    /** Maximum depth of the inspection @default 5 */
-    depth: number;
-    /** Quote style for strings @default 'single' */
-    quoteStyle: 'single' | 'double';
-    /** Maximum string length before truncation @default Infinity */
-    maxStringLength: number;
-    /** Indentation spaces @default 2 */
-    indent: number;
-    /** Add numeric separators (1_234.567_8) @default false */
-    numericSeparator: boolean;
-    /** Custom stringify functions for different types */
-    customStringify: {
-        [x: string]: InspectCustomStringify;
-    };
-    /** Available width columns */
-    columns: number;
+  /** Maximum depth of the inspection @default 5 */
+  depth: number;
+  /** Quote style for strings @default 'single' */
+  quoteStyle: 'single' | 'double';
+  /** Maximum string length before truncation @default Infinity */
+  maxStringLength: number;
+  /** Indentation spaces @default 2 */
+  indent: number;
+  /** Add numeric separators (1_234.567_8) @default false */
+  numericSeparator: boolean;
+  /** Custom stringify functions for different types */
+  customStringify: {
+    [x: string]: InspectCustomStringify;
+  };
+  /** Available width columns */
+  columns: number;
 }
 type InspectCustomStringify = (value: any) => string;
-
 declare namespace PinoPretty {
-    type Options = DeepPartial<PrettyOptions>;
+  type Options = DeepPartial<PrettyOptions>;
 }
 /**
  * Constructs a of stream to which the produced
  * prettified log data will be written.
  */
 declare function build(opts?: PinoPretty.Options): Promise<Transform>;
-
 export { PinoPretty, build, build as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":["reset","string","bold","dim","italic","underline","inverse","hidden","strikethrough","black","red","green","yellow","blue","magenta","cyan","white","gray","bgBlack","bgRed","bgGreen","bgYellow","bgBlue","bgMagenta","bgCyan","bgWhite","blackBright","redBright","greenBright","yellowBright","blueBright","magentaBright","cyanBright","whiteBright","bgBlackBright","bgRedBright","bgGreenBright","bgYellowBright","bgBlueBright","bgMagentaBright","bgCyanBright","bgWhiteBright","orange","purple","pink","lime","teal","indigo","brown","olive","navy","maroon","silver","gold","bgOrange","bgPurple","bgPink","bgLime","bgTeal","bgIndigo","bgBrown","bgOlive","bgNavy","bgMaroon","bgSilver","bgGold","Readonly","ColorName","colorDefs","text","Record","ColorFunction","color","fallback","icon","color","ColorValue","badge","inspect","InspectFunction","messageKey","nestedKey","columns","quoteStyle","ignore","indent","depth","badgeMinLevel","maxStringLength","numericSeparator","colorize","levels","Record","LevelConfig","types","TypeName","TypeConfig","Omit","PrettyOptions","sw","StringWidth","Set","ignoreAdditional","LevelConfigParsed","TypeConfigParsed","inspectFn","inspectOptions","InspectOptions","colorFallback","ColorizeFn","Arrayable","ColorName","value","colorBadge","level","time","msg","pid","hostname","key","obj","opts","customStringify","x","InspectCustomStringify","Options","DeepPartial","PinoPretty","opts","Promise","Transform"],"sources":["../src/utils/getColor.d.ts","../src/types.d.ts","../src/index.d.ts"],"mappings":";;;cAAc,SAAA;EACVA,KAAAA,GAAQC,MAAAA;EACRC,IAAAA,GAAOD,MAAAA;EACPE,GAAAA,GAAMF,MAAAA;EACNG,MAAAA,GAASH,MAAAA;EACTI,SAAAA,GAAYJ,MAAAA;EACZK,OAAAA,GAAUL,MAAAA;EACVM,MAAAA,GAASN,MAAAA;EACTO,aAAAA,GAAgBP,MAAAA;EAChBQ,KAAAA,GAAQR,MAAAA;EACRS,GAAAA,GAAMT,MAAAA;EACNU,KAAAA,GAAQV,MAAAA;EACRW,MAAAA,GAASX,MAAAA;EACTY,IAAAA,GAAOZ,MAAAA;EACPa,OAAAA,GAAUb,MAAAA;EACVc,IAAAA,GAAOd,MAAAA;EACPe,KAAAA,GAAQf,MAAAA;EACRgB,IAAAA,GAAOhB,MAAAA;EACPiB,OAAAA,GAAUjB,MAAAA;EACVkB,KAAAA,GAAQlB,MAAAA;EACRmB,OAAAA,GAAUnB,MAAAA;EACVoB,QAAAA,GAAWpB,MAAAA;EACXqB,MAAAA,GAASrB,MAAAA;EACTsB,SAAAA,GAAYtB,MAAAA;EACZuB,MAAAA,GAASvB,MAAAA;EACTwB,OAAAA,GAAUxB,MAAAA;EACVyB,WAAAA,GAAczB,MAAAA;EACd0B,SAAAA,GAAY1B,MAAAA;EACZ2B,WAAAA,GAAc3B,MAAAA;EACd4B,YAAAA,GAAe5B,MAAAA;EACf6B,UAAAA,GAAa7B,MAAAA;EACb8B,aAAAA,GAAgB9B,MAAAA;EAChB+B,UAAAA,GAAa/B,MAAAA;EACbgC,WAAAA,GAAchC,MAAAA;EACdiC,aAAAA,GAAgBjC,MAAAA;EAChBkC,WAAAA,GAAclC,MAAAA;EACdmC,aAAAA,GAAgBnC,MAAAA;EAChBoC,cAAAA,GAAiBpC,MAAAA;EACjBqC,YAAAA,GAAerC,MAAAA;EACfsC,eAAAA,GAAkBtC,MAAAA;EAClBuC,YAAAA,GAAevC,MAAAA;EACfwC,aAAAA,GAAgBxC,MAAAA;EAChByC,MAAAA,GAASzC,MAAAA;EACT0C,MAAAA,GAAS1C,MAAAA;EACT2C,IAAAA,GAAO3C,MAAAA;EACP4C,IAAAA,GAAO5C,MAAAA;EACP6C,IAAAA,GAAO7C,MAAAA;EACP8C,MAAAA,GAAS9C,MAAAA;EACT+C,KAAAA,GAAQ/C,MAAAA;EACRgD,KAAAA,GAAQhD,MAAAA;EACRiD,IAAAA,GAAOjD,MAAAA;EACPkD,MAAAA,GAASlD,MAAAA;EACTmD,MAAAA,GAASnD,MAAAA;EACToD,IAAAA,GAAOpD,MAAAA;EACPqD,QAAAA,GAAWrD,MAAAA;EACXsD,QAAAA,GAAWtD,MAAAA;EACXuD,MAAAA,GAASvD,MAAAA;EACTwD,MAAAA,GAASxD,MAAAA;EACTyD,MAAAA,GAASzD,MAAAA;EACT0D,QAAAA,GAAW1D,MAAAA;EACX2D,OAAAA,GAAU3D,MAAAA;EACV4D,OAAAA,GAAU5D,MAAAA;EACV6D,MAAAA,GAAS7D,MAAAA;EACT8D,QAAAA,GAAW9D,MAAAA;EACX+D,QAAAA,GAAW/D,MAAAA;EACXgE,MAAAA,GAAShE,MAAAA;AAAAA;AAAAA,KAGD,SAAA,gBAAyB,SAAS;AAAA,KCjElC,WAAA;EDHE;;;;;ECSVyE,IAAAA;EACAC,KAAAA,EAAO,UAAU;EDRV1E;;;;;;;ECgBP4E,KAAAA;AAAAA;AAAAA,KAEQ,UAAA;EACRF,KAAAA,EAAO,UAAU;AAAA;AAAA,UAEJ,aAAA;EDdblE;;;;ECmBAqE,OAAAA,0BAAiC,eAAA;EDjBzB7E;;;ECqBR+E,UAAAA;EDnBO/E;;;ECuBPgF,SAAAA;EDrBOhF;;;;;;EC4BPiF,OAAAA;EDxBA/D;;;;;;EC+BAgE,UAAAA;ED5BSlF;;;;;;ECmCTmF,MAAAA;ED/BA1D;;;;ECoCA2D,MAAAA;EDlCcpF;;;;ECuCdqF,KAAAA;EDpCAvD;;;;;;;EC4CAwD,aAAAA;EDxCApD;;;;EC6CAqD,eAAAA;ED3CiBvF;;;;ECgDjBwF,gBAAAA;ED7CAjD;;;;ECkDAkD,QAAAA;EDhDSzF;;;ECoDT0F,MAAAA,EAAQ,MAAA,SAAe,WAAA;EDlDhB1F;;;ECsDP6F,KAAAA,EAAO,MAAA,CAAO,QAAA,EAAU,UAAA;AAAA;AAAA,KAEhB,QAAA;;;;;KAeA,UAAA,YAAsB,SAAS,CAAC,SAAA;AAAA,KAiBhC,eAAA,IAAmB0B,GAAAA,OAAUC,IAAAA,EAAM,cAAc;AAAA,UAC5C,cAAA;EDrEbzD;ECuEAsB,KAAAA;EDtEArB;ECwEAkB,UAAAA;EDxEuB;EC0EvBK,eAAAA;EDvEQ;ECyERH,MAAAA;;EAEAI,gBAAAA;ED3E0C;EC6E1CiC,eAAAA;IAAAA,CACKC,CAAAA,WAAY,sBAAsB;EAAA;;EAGvCzC,OAAAA;AAAAA;AAAAA,KAEC,sBAAA,IAA0B8B,KAAU;AAAA,kBCrJhB,UAAA;EAAA,KAChBa,OAAAA,GAAU,WAAW,CADK,aAAA;AAAA;;;;;iBAOX,KAAA,CAAMG,IAAAA,GAAO,UAAA,CAAW,OAAA,GAAU,OAAA,CAAQ,SAAA"}