@fend/firo 0.0.5 → 0.0.6

package/README.md

@@ -239,7 +239,8 @@ log.error('Payment failed', err, {
 `error()` accepts multiple call signatures:
 
 ```ts
-// Message only
+// Message only will be automatically wrapped in an Error object to intentionally capture and preserve the stack trace
+// because stack trace with a couple of extra levels of indirection is definitely better than no stack trace at all
 log.error('Something went wrong')
 
 // Message + Error object
@@ -248,6 +249,9 @@ log.error('Query failed', new Error('timeout'))
 // Error object only
 log.error(new Error('Unhandled'))
 
+// Error + extra data
+log.error(new Error('DB down'), { query: 'SELECT ...', reqId: 123 })
+
 // Anything — will be coerced to Error
 log.error(someUnknownThing)
 ```
@@ -278,9 +282,10 @@ const log = createFiro({ transport: myTransport })
 import { FiroUtils } from '@fend/firo'
 
 FiroUtils.wrapToError(value)      // coerce unknown → Error
-FiroUtils.serializeError(err)     // Error → plain object { message, stack, name }
+FiroUtils.serializeError(err)     // Error → plain object { message, stack, name, cause?, ... }
 FiroUtils.safeStringify(obj)      // JSON.stringify with bigint support + fallback
 FiroUtils.jsonReplacer            // replacer for JSON.stringify (handles bigint)
+FiroUtils.extractMessage(msg)     // extract message string from string | Error | unknown
 FiroUtils.colorize(text, idx)     // wrap text in ANSI color by palette index
 FiroUtils.colorizeLevel(level, t) // wrap text in level color (red/yellow/dim)
 ```

package/dist/index.cjs

@@ -45,6 +45,7 @@ __export(utils_exports, {
   LOG_LEVELS: () => LOG_LEVELS,
   colorize: () => colorize,
   colorizeLevel: () => colorizeLevel,
+  extractMessage: () => extractMessage,
   getColorIndex: () => getColorIndex,
   jsonReplacer: () => jsonReplacer,
   safeStringify: () => safeStringify,
@@ -122,13 +123,18 @@ var wrapToError = (obj) => {
 };
 var serializeError = (_err) => {
   const err = wrapToError(_err);
-  return {
+  const result = {
     message: err.message,
     stack: err.stack,
     name: err.name,
     ...err
   };
+  if (err.cause !== void 0) {
+    result.cause = err.cause instanceof Error ? serializeError(err.cause) : err.cause;
+  }
+  return result;
 };
+var extractMessage = (msg) => typeof msg === "string" ? msg : msg instanceof Error ? msg.message : typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
 var colorizeLevel = (level, text) => {
   if (level === "info") return text;
   switch (level) {
@@ -196,18 +202,15 @@ var createDevTransport = (config = {}) => {
 var import_node_util3 = require("util");
 var import_node_process2 = __toESM(require("process"), 1);
 var buildRecord = (level, context, msg, getTimestamp, data) => {
-  const contextObj = context.reduce((acc, item) => {
-    acc[item.key] = item.value;
-    return acc;
-  }, {});
   const logRecord = {
     timestamp: getTimestamp(),
-    level,
-    ...contextObj
+    level
   };
+  for (let i = 0, len = context.length; i < len; i++) {
+    logRecord[context[i].key] = context[i].value;
+  }
+  logRecord.message = extractMessage(msg);
   if (level === "error") {
-    const message = typeof msg === "string" ? msg : msg instanceof Error ? msg.message : typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
-    logRecord.message = message;
     if (data instanceof Error) {
       logRecord.error = serializeError(data);
     } else if (msg instanceof Error) {
@@ -218,7 +221,9 @@ var buildRecord = (level, context, msg, getTimestamp, data) => {
       if (data !== void 0) logRecord.data = data;
     }
   } else {
-    logRecord.message = typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
+    if (msg instanceof Error) {
+      logRecord.error = serializeError(msg);
+    }
     if (data !== void 0) {
       logRecord.data = data instanceof Error ? serializeError(data) : data;
     }

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 /** Available log severity levels. */
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+/** Numeric severity values for each log level, used for threshold filtering. */
 declare const LOG_LEVELS: {
     readonly debug: 20;
     readonly info: 30;
@@ -74,12 +75,21 @@ declare const FIRO_COLORS: {
     readonly tangerine: "38;5;208";
     readonly periwinkle: "38;5;147";
 };
+/** Hash a string to a stable color palette index. Similar strings land on different colors. */
 declare const getColorIndex: (str: string, useAllColors?: boolean) => number;
+/** Wrap text in an ANSI color escape sequence by palette index or raw ANSI code. */
 declare const colorize: (text: string, colorIndex: number, color?: string) => string;
+/** JSON.stringify replacer that converts BigInt values to strings. */
 declare const jsonReplacer: (_key: string, value: unknown) => unknown;
+/** Safely stringify any value to JSON with BigInt support. Falls back to `util.inspect` on circular references. */
 declare const safeStringify: (obj: unknown) => string;
+/** Coerce any value to an Error instance. If already an Error, returns as-is. */
 declare const wrapToError: (obj: unknown) => Error;
-declare const serializeError: (_err: unknown) => any;
+/** Serialize an error-like value to a plain object with `message`, `stack`, `name`, and recursively serialized `cause`. */
+declare const serializeError: (_err: unknown) => Record<string, unknown>;
+/** Extract a human-readable message string from any log input. Useful for building custom transports. */
+declare const extractMessage: (msg: string | Error | unknown) => string;
+/** Wrap text in an ANSI color based on log level: red for error, yellow for warn, dim for debug. */
 declare const colorizeLevel: (level: LogLevel, text: string) => string;
 
 type utils_ContextExtension = ContextExtension;
@@ -94,13 +104,14 @@ type utils_LogOptions = LogOptions;
 type utils_TransportFn = TransportFn;
 declare const utils_colorize: typeof colorize;
 declare const utils_colorizeLevel: typeof colorizeLevel;
+declare const utils_extractMessage: typeof extractMessage;
 declare const utils_getColorIndex: typeof getColorIndex;
 declare const utils_jsonReplacer: typeof jsonReplacer;
 declare const utils_safeStringify: typeof safeStringify;
 declare const utils_serializeError: typeof serializeError;
 declare const utils_wrapToError: typeof wrapToError;
 declare namespace utils {
-  export { type utils_ContextExtension as ContextExtension, type utils_ContextItem as ContextItem, type utils_ContextItemWithOptions as ContextItemWithOptions, type utils_ContextOptions as ContextOptions, type utils_ContextValue as ContextValue, utils_FIRO_COLORS as FIRO_COLORS, utils_LOG_LEVELS as LOG_LEVELS, type utils_LogLevel as LogLevel, type utils_LogOptions as LogOptions, type utils_TransportFn as TransportFn, utils_colorize as colorize, utils_colorizeLevel as colorizeLevel, utils_getColorIndex as getColorIndex, utils_jsonReplacer as jsonReplacer, utils_safeStringify as safeStringify, utils_serializeError as serializeError, utils_wrapToError as wrapToError };
+  export { type utils_ContextExtension as ContextExtension, type utils_ContextItem as ContextItem, type utils_ContextItemWithOptions as ContextItemWithOptions, type utils_ContextOptions as ContextOptions, type utils_ContextValue as ContextValue, utils_FIRO_COLORS as FIRO_COLORS, utils_LOG_LEVELS as LOG_LEVELS, type utils_LogLevel as LogLevel, type utils_LogOptions as LogOptions, type utils_TransportFn as TransportFn, utils_colorize as colorize, utils_colorizeLevel as colorizeLevel, utils_extractMessage as extractMessage, utils_getColorIndex as getColorIndex, utils_jsonReplacer as jsonReplacer, utils_safeStringify as safeStringify, utils_serializeError as serializeError, utils_wrapToError as wrapToError };
 }
 
 /**
@@ -174,6 +185,8 @@ interface Firo {
     warn: (msg: string, data?: unknown, opts?: LogOptions) => void;
     /** Log an error object directly. */
     error(err: Error | unknown): void;
+    /** Log an error object with additional data. */
+    error(err: Error, data?: unknown, opts?: LogOptions): void;
     /** Log a message alongside an error or custom data object. */
     error(msg: string, err?: Error | unknown, opts?: LogOptions): void;
     /**

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 /** Available log severity levels. */
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+/** Numeric severity values for each log level, used for threshold filtering. */
 declare const LOG_LEVELS: {
     readonly debug: 20;
     readonly info: 30;
@@ -74,12 +75,21 @@ declare const FIRO_COLORS: {
     readonly tangerine: "38;5;208";
     readonly periwinkle: "38;5;147";
 };
+/** Hash a string to a stable color palette index. Similar strings land on different colors. */
 declare const getColorIndex: (str: string, useAllColors?: boolean) => number;
+/** Wrap text in an ANSI color escape sequence by palette index or raw ANSI code. */
 declare const colorize: (text: string, colorIndex: number, color?: string) => string;
+/** JSON.stringify replacer that converts BigInt values to strings. */
 declare const jsonReplacer: (_key: string, value: unknown) => unknown;
+/** Safely stringify any value to JSON with BigInt support. Falls back to `util.inspect` on circular references. */
 declare const safeStringify: (obj: unknown) => string;
+/** Coerce any value to an Error instance. If already an Error, returns as-is. */
 declare const wrapToError: (obj: unknown) => Error;
-declare const serializeError: (_err: unknown) => any;
+/** Serialize an error-like value to a plain object with `message`, `stack`, `name`, and recursively serialized `cause`. */
+declare const serializeError: (_err: unknown) => Record<string, unknown>;
+/** Extract a human-readable message string from any log input. Useful for building custom transports. */
+declare const extractMessage: (msg: string | Error | unknown) => string;
+/** Wrap text in an ANSI color based on log level: red for error, yellow for warn, dim for debug. */
 declare const colorizeLevel: (level: LogLevel, text: string) => string;
 
 type utils_ContextExtension = ContextExtension;
@@ -94,13 +104,14 @@ type utils_LogOptions = LogOptions;
 type utils_TransportFn = TransportFn;
 declare const utils_colorize: typeof colorize;
 declare const utils_colorizeLevel: typeof colorizeLevel;
+declare const utils_extractMessage: typeof extractMessage;
 declare const utils_getColorIndex: typeof getColorIndex;
 declare const utils_jsonReplacer: typeof jsonReplacer;
 declare const utils_safeStringify: typeof safeStringify;
 declare const utils_serializeError: typeof serializeError;
 declare const utils_wrapToError: typeof wrapToError;
 declare namespace utils {
-  export { type utils_ContextExtension as ContextExtension, type utils_ContextItem as ContextItem, type utils_ContextItemWithOptions as ContextItemWithOptions, type utils_ContextOptions as ContextOptions, type utils_ContextValue as ContextValue, utils_FIRO_COLORS as FIRO_COLORS, utils_LOG_LEVELS as LOG_LEVELS, type utils_LogLevel as LogLevel, type utils_LogOptions as LogOptions, type utils_TransportFn as TransportFn, utils_colorize as colorize, utils_colorizeLevel as colorizeLevel, utils_getColorIndex as getColorIndex, utils_jsonReplacer as jsonReplacer, utils_safeStringify as safeStringify, utils_serializeError as serializeError, utils_wrapToError as wrapToError };
+  export { type utils_ContextExtension as ContextExtension, type utils_ContextItem as ContextItem, type utils_ContextItemWithOptions as ContextItemWithOptions, type utils_ContextOptions as ContextOptions, type utils_ContextValue as ContextValue, utils_FIRO_COLORS as FIRO_COLORS, utils_LOG_LEVELS as LOG_LEVELS, type utils_LogLevel as LogLevel, type utils_LogOptions as LogOptions, type utils_TransportFn as TransportFn, utils_colorize as colorize, utils_colorizeLevel as colorizeLevel, utils_extractMessage as extractMessage, utils_getColorIndex as getColorIndex, utils_jsonReplacer as jsonReplacer, utils_safeStringify as safeStringify, utils_serializeError as serializeError, utils_wrapToError as wrapToError };
 }
 
 /**
@@ -174,6 +185,8 @@ interface Firo {
     warn: (msg: string, data?: unknown, opts?: LogOptions) => void;
     /** Log an error object directly. */
     error(err: Error | unknown): void;
+    /** Log an error object with additional data. */
+    error(err: Error, data?: unknown, opts?: LogOptions): void;
     /** Log a message alongside an error or custom data object. */
     error(msg: string, err?: Error | unknown, opts?: LogOptions): void;
     /**

package/dist/index.js

@@ -11,6 +11,7 @@ __export(utils_exports, {
   LOG_LEVELS: () => LOG_LEVELS,
   colorize: () => colorize,
   colorizeLevel: () => colorizeLevel,
+  extractMessage: () => extractMessage,
   getColorIndex: () => getColorIndex,
   jsonReplacer: () => jsonReplacer,
   safeStringify: () => safeStringify,
@@ -88,13 +89,18 @@ var wrapToError = (obj) => {
 };
 var serializeError = (_err) => {
   const err = wrapToError(_err);
-  return {
+  const result = {
     message: err.message,
     stack: err.stack,
     name: err.name,
     ...err
   };
+  if (err.cause !== void 0) {
+    result.cause = err.cause instanceof Error ? serializeError(err.cause) : err.cause;
+  }
+  return result;
 };
+var extractMessage = (msg) => typeof msg === "string" ? msg : msg instanceof Error ? msg.message : typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
 var colorizeLevel = (level, text) => {
   if (level === "info") return text;
   switch (level) {
@@ -162,18 +168,15 @@ var createDevTransport = (config = {}) => {
 import { inspect as inspect3 } from "util";
 import process2 from "process";
 var buildRecord = (level, context, msg, getTimestamp, data) => {
-  const contextObj = context.reduce((acc, item) => {
-    acc[item.key] = item.value;
-    return acc;
-  }, {});
   const logRecord = {
     timestamp: getTimestamp(),
-    level,
-    ...contextObj
+    level
   };
+  for (let i = 0, len = context.length; i < len; i++) {
+    logRecord[context[i].key] = context[i].value;
+  }
+  logRecord.message = extractMessage(msg);
   if (level === "error") {
-    const message = typeof msg === "string" ? msg : msg instanceof Error ? msg.message : typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
-    logRecord.message = message;
     if (data instanceof Error) {
       logRecord.error = serializeError(data);
     } else if (msg instanceof Error) {
@@ -184,7 +187,9 @@ var buildRecord = (level, context, msg, getTimestamp, data) => {
       if (data !== void 0) logRecord.data = data;
     }
   } else {
-    logRecord.message = typeof msg === "object" && msg !== null ? safeStringify(msg) : String(msg);
+    if (msg instanceof Error) {
+      logRecord.error = serializeError(msg);
+    }
     if (data !== void 0) {
       logRecord.data = data instanceof Error ? serializeError(data) : data;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fend/firo",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Elegant logger for Node.js, Bun and Deno with brilliant DX.",
   "keywords": [
     "firo",
@@ -42,6 +42,7 @@
   },
   "devDependencies": {
     "@types/node": "^25.5.0",
+    "bumpp": "^11.0.1",
     "tsup": "^8.5.1",
     "tsx": "^4.0.0",
     "typescript": "^5.9.3"
@@ -52,6 +53,7 @@
     "check": "tsc --noEmit && node --import tsx --test test/*.test.ts",
     "typecheck": "tsc --noEmit",
     "demo": "tsx demo.ts",
-    "bench": "tsx benchmark/prod.ts > /dev/null"
+    "bench": "tsx benchmark/prod.ts > /dev/null",
+    "bump": "bumpp --files package.json --files jsr.json --execute \"pnpm check && pnpm build && npm publish --dry-run --access public && deno publish --dry-run\" --commit \"v%s\" --no-push"
   }
 }