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

package/dist/wide-event.d.ts

@@ -1,300 +1,5 @@
-import type { PailBrowserImpl } from "./pail.d.ts";
-import type { DefaultLogTypes, LoggerFunction } from "./types.d.ts";
-/**
- * A pail instance with dynamically generated log methods.
- * This is the minimal interface WideEvent needs from a pail logger.
- */
-type PailLike<T extends string = string> = PailBrowserImpl<T> & Record<DefaultLogTypes | T, LoggerFunction>;
-/**
- * Makes all properties in T optional recursively.
- */
-type DeepPartial<T> = {
-    [K in keyof T]?: T[K] extends Record<string, unknown> ? DeepPartial<T[K]> : T[K];
-};
-/**
- * Severity levels for wide events.
- */
-export type WideEventLevel = "debug" | "error" | "info" | "warn";
-/**
- * An entry in the request lifecycle log.
- */
-export interface RequestLogEntry {
-    /**
-     * Additional structured context for this log entry.
-     */
-    context?: Record<string, unknown>;
-    /**
-     * Severity level of this entry.
-     */
-    level: WideEventLevel;
-    /**
-     * Human-readable message describing what happened.
-     */
-    message: string;
-    /**
-     * ISO 8601 timestamp of when this entry was recorded.
-     */
-    timestamp: string;
-}
-/**
- * Serialized error information included in the emitted wide event.
- */
-export interface SerializedError {
-    cause?: SerializedError;
-    data?: unknown;
-    message: string;
-    name: string;
-    stack?: string;
-    status?: number;
-}
-/**
- * Options for finishing a wide event with HTTP context.
- */
-export interface WideEventFinishOptions {
-    /**
-     * An error that occurred during the operation.
-     * Will be serialized and included in the emitted event.
-     */
-    error?: Error;
-    /**
-     * HTTP response status code.
-     */
-    status?: number;
-}
-/**
- * Options for creating a WideEvent instance.
- * @template T - Custom logger type names
- */
-export interface WideEventOptions<T extends string = string> {
-    /**
-     * Auto-emit the event when disposed via `Symbol.dispose`.
-     * Works with TC39 Explicit Resource Management (`using`).
-     * @default true
-     */
-    autoEmit?: boolean;
-    /**
-     * Event name identifying this wide event, e.g. "api.checkout", "worker.send-email".
-     */
-    name: string;
-    /**
-     * The pail logger instance to use for emission.
-     */
-    pail: PailLike<T>;
-    /**
-     * Service name for this event. Overrides any service name from pail's scope.
-     */
-    service?: string;
-    /**
-     * Base log type to use when emitting. Defaults to "info".
-     * The actual type may be escalated based on logged warnings/errors.
-     */
-    type?: DefaultLogTypes | T;
-}
-/**
- * A wide event logger that accumulates context incrementally and emits
- * a single comprehensive log event through pail.
- *
- * Instead of scattering multiple log calls throughout an operation,
- * use `set()` to build up context as information becomes available,
- * then emit once at the end. Lifecycle methods (`info()`, `warn()`, `error()`,
- * `debug()`) record timestamped entries in a `requestLogs` array and
- * automatically escalate the event's severity level.
- *
- * Implements `Disposable` for use with TC39 Explicit Resource Management.
- * @template TData - Shape of the accumulated event data
- * @template T - Custom logger type names from the pail instance
- * @example
- * ```typescript
- * // Manual finish
- * const ev = createWideEvent({ pail: logger, name: "api.checkout" });
- * ev.set({ user: { id: 1 } });
- * ev.info("Validated cart");
- * ev.set({ cart: { items: 3, total: 9999 } });
- * ev.finish({ status: 200 });
- *
- * // Auto-emit with Explicit Resource Management
- * using ev = createWideEvent({ pail: logger, name: "api.checkout" });
- * ev.set({ user: { id: 1 } });
- * // emits automatically when scope exits
- *
- * // Typed data shape
- * interface CheckoutData {
- *   user: { id: number; plan: string };
- *   cart: { items: number; total: number };
- * }
- * const ev = createWideEvent<CheckoutData>({ pail: logger, name: "api.checkout" });
- * ev.set({ user: { id: 1, plan: "pro" } }); // fully typed
- * ```
- */
-export declare class WideEvent<TData extends Record<string, unknown> = Record<string, unknown>, T extends string = string> implements Disposable {
-    [Symbol.dispose]: () => void;
-    readonly name: string;
-    private readonly autoEmit;
-    private data;
-    private emitted;
-    private attachedError?;
-    private level;
-    private readonly pail;
-    private readonly requestLogs;
-    private readonly service;
-    private readonly startTime;
-    private status;
-    private readonly timestamp;
-    private readonly _type;
-    constructor(options: WideEventOptions<T>);
-    /**
-     * Record a debug-level lifecycle log entry.
-     * Does not escalate the event level.
-     * @param message Description of what happened
-     * @param context Optional structured context
-     * @returns `this` for chaining
-     */
-    debug(message: string, context?: Record<string, unknown>): this;
-    /**
-     * Emit the wide event through the pail logger. Can only be called once;
-     * subsequent calls are no-ops.
-     *
-     * Automatically calculates duration, determines the log type based on
-     * the highest severity level reached, and serializes any attached error.
-     *
-     * Prefer `finish()` for HTTP request contexts where you have a status code.
-     * @param typeOverride Override the log type for this emission
-     */
-    emit(typeOverride?: DefaultLogTypes | T): void;
-    /**
-     * Record an error-level lifecycle log entry and attach the error.
-     * Escalates the event level to "error".
-     * @param message Description of what went wrong
-     * @param error The error that occurred
-     * @param context Optional structured context
-     * @returns `this` for chaining
-     */
-    error(message: string, error?: Error, context?: Record<string, unknown>): this;
-    /**
-     * Finish and emit the wide event with HTTP context.
-     * Sets the response status and optional error before emitting.
-     * @example
-     * ```typescript
-     * ev.finish({ status: 200 });
-     * ev.finish({ status: 500, error: new Error("DB timeout") });
-     * ```
-     * @param options Status code and/or error
-     */
-    finish(options?: WideEventFinishOptions): void;
-    /**
-     * Get a read-only snapshot of the accumulated data.
-     */
-    getData(): Readonly<TData>;
-    /**
-     * Get the current severity level of the event.
-     * The level auto-escalates as `warn()` or `error()` entries are added.
-     */
-    getLevel(): WideEventLevel;
-    /**
-     * Get a read-only copy of the request lifecycle log entries.
-     */
-    getRequestLogs(): ReadonlyArray<RequestLogEntry>;
-    /**
-     * Record an info-level lifecycle log entry.
-     * Does not escalate the event level.
-     * @param message Description of what happened
-     * @param context Optional structured context
-     * @returns `this` for chaining
-     */
-    info(message: string, context?: Record<string, unknown>): this;
-    /**
-     * Accumulate context into the wide event via deep merge.
-     * Call as many times as needed throughout the operation.
-     * @example
-     * ```typescript
-     * ev.set({ user: { id: 1 } });
-     * ev.set({ user: { plan: "pro" } });
-     * // data = { user: { id: 1, plan: "pro" } }
-     * ```
-     * @param data Partial data to merge into the event
-     * @returns `this` for chaining
-     */
-    set(data: DeepPartial<TData>): this;
-    /**
-     * Attach an error to the event. Automatically escalates the event
-     * level to "error".
-     * @param error The error to attach
-     * @returns `this` for chaining
-     */
-    setError(error: Error): this;
-    /**
-     * Set the HTTP response status code.
-     * @param status HTTP status code
-     * @returns `this` for chaining
-     */
-    setStatus(status: number): this;
-    /**
-     * Record a warn-level lifecycle log entry.
-     * Escalates the event level to "warn" (unless already "error").
-     * @param message Description of the warning
-     * @param context Optional structured context
-     * @returns `this` for chaining
-     */
-    warn(message: string, context?: Record<string, unknown>): this;
-    /**
-     * Disposable implementation. Auto-emits the event if `autoEmit` is true
-     * and the event hasn't been manually emitted yet.
-     *
-     * Enables usage with TC39 Explicit Resource Management:
-     * ```typescript
-     * using ev = createWideEvent({ pail: logger, name: "api.checkout" });
-     * ev.set({ user: { id: 1 } });
-     * // auto-emits here when scope exits
-     * ```
-     */
-    [Symbol.dispose](): void;
-    /**
-     * Add an entry to the request lifecycle log and escalate level if needed.
-     */
-    private addLogEntry;
-    /**
-     * Escalate the event level if the new level has higher severity.
-     */
-    private escalateLevel;
-}
-/**
- * Create a wide event logger that accumulates context and emits a single
- * comprehensive log event through pail.
- * @template TData - Shape of the accumulated event data
- * @template T - Custom logger type names from the pail instance
- * @param options Configuration options
- * @returns A new WideEvent instance
- * @example
- * ```typescript
- * import { createPail } from "@visulima/pail";
- * import { createWideEvent } from "@visulima/pail/wide-event";
- *
- * const logger = createPail();
- *
- * // In a request handler:
- * const ev = createWideEvent({ pail: logger, name: "api.checkout" });
- *
- * ev.set({ user: { id: 1, plan: "pro" } });
- * ev.info("Validated cart", { itemCount: 3 });
- * ev.set({ cart: { id: 42, items: 3, total: 9999 } });
- * ev.info("Payment processed");
- * ev.finish({ status: 200 });
- *
- * // Emits a single structured log:
- * // {
- * //   event: "api.checkout",
- * //   timestamp: "2025-01-24T10:23:45.612Z",
- * //   duration: "127ms",
- * //   duration_ms: 127,
- * //   status: 200,
- * //   user: { id: 1, plan: "pro" },
- * //   cart: { id: 42, items: 3, total: 9999 },
- * //   requestLogs: [
- * //     { level: "info", message: "Validated cart", timestamp: "...", context: { itemCount: 3 } },
- * //     { level: "info", message: "Payment processed", timestamp: "..." }
- * //   ]
- * // }
- * ```
- */
-export declare const createWideEvent: <TData extends Record<string, unknown> = Record<string, unknown>, T extends string = string>(options: WideEventOptions<T>) => WideEvent<TData, T>;
-export {};
+export { R as RequestLogEntry, S as SerializedError, W as WideEvent, a as WideEventFinishOptions, b as WideEventLevel, c as WideEventOptions, d as createWideEvent } from "./packem_shared/wide-event.d-B-t8ZnhI.js";
+import "./packem_shared/types.d-BeLumqgD.js";
+import 'safe-stable-stringify';
+import '@visulima/colorize';
+import '@visulima/interactive-manager';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@visulima/pail",
-  "version": "4.0.0-alpha.11",
+  "version": "4.0.0-alpha.12",
   "description": "Highly configurable Logger for Node.js, Edge and Browser.",
   "keywords": [
-    "ansi",
     "anolilab",
+    "ansi",
     "browser",
     "browser-logger",
     "callsite",
@@ -27,8 +27,8 @@
     "json",
     "json-logger",
     "json-logging",
-    "log level",
     "log",
+    "log level",
     "log-cleaner",
     "log-rotation",
     "log4j",
@@ -37,11 +37,10 @@
     "logger",
     "logging",
     "node",
-    "stream",
-    "pretty",
     "node-logger",
     "pail",
     "pino",
+    "pretty",
     "pretty-error",
     "pretty-log",
     "print",
@@ -49,6 +48,7 @@
     "redact",
     "rotating-log",
     "show error",
+    "stream",
     "timer",
     "universal",
     "visulima",
@@ -232,8 +232,7 @@
   ],
   "dependencies": {
     "@visulima/colorize": "2.0.0-alpha.10",
-    "@visulima/interactive-manager": "1.0.0-alpha.2",
-    "type-fest": "5.6.0"
+    "@visulima/interactive-manager": "1.0.0-alpha.2"
   },
   "peerDependencies": {
     "@opentelemetry/api": "1.9.1",

package/dist/constants.d.ts

@@ -1,37 +0,0 @@
-import type { DefaultLoggerTypes } from "./types.d.ts";
-/**
- * Extended RFC 5424 Log Levels
- *
- * The log levels pail uses are those defined in the syslog protocol.
- * Each level is assigned a numeric priority where lower numbers indicate higher priority.
- * @see https://datatracker.ietf.org/doc/html/rfc5424#page-36
- * @example
- * ```typescript
- * import { EXTENDED_RFC_5424_LOG_LEVELS } from "@visulima/pail";
- *
- * console.log(EXTENDED_RFC_5424_LOG_LEVELS.error); // 5
- * ```
- */
-export declare const EXTENDED_RFC_5424_LOG_LEVELS: Record<string, number>;
-/**
- * Default Logger Types Configuration
- *
- * Predefined logger types with their associated colors, labels, and log levels.
- * These types provide semantic meaning to different kinds of log messages.
- * @example
- * ```typescript
- * import { LOG_TYPES } from "@visulima/pail";
- *
- * console.log(LOG_TYPES.error.color); // "red"
- * console.log(LOG_TYPES.success.label); // "success"
- * ```
- */
-export declare const LOG_TYPES: DefaultLoggerTypes;
-/**
- * Empty Symbol
- *
- * A unique symbol used internally to represent empty or undefined message values.
- * This helps distinguish between intentional empty messages and undefined values.
- * @internal
- */
-export declare const EMPTY_SYMBOL: symbol;

package/dist/middleware/next/middleware.d.ts

@@ -1,59 +0,0 @@
-/**
- * Minimal type definitions to avoid requiring next as a dependency.
- */
-interface NextRequest {
-    headers: Headers;
-    nextUrl: {
-        pathname: string;
-    };
-}
-interface NextResponse {
-    headers: Headers;
-}
-interface NextResponseConstructor {
-    next: (options?: {
-        request?: {
-            headers?: Headers;
-        };
-    }) => NextResponse;
-}
-/**
- * Options for the Next.js pail middleware.
- */
-interface PailNextMiddlewareOptions {
-    /**
-     * Glob patterns for paths to exclude from logging.
-     * Excluded paths won't get request IDs or timing headers.
-     * @example ["/_next/**", "/favicon.ico"]
-     */
-    exclude?: string[];
-    /**
-     * Glob patterns for paths to include in logging.
-     * If not set, all non-excluded paths are included.
-     */
-    include?: string[];
-}
-/**
- * Create a Next.js edge middleware that sets `x-request-id` and `x-pail-start`
- * headers on the request for downstream use by `withPail()`.
- *
- * This middleware runs at the edge and prepares request metadata.
- * The actual wide event logging happens in `withPail()`.
- * @param NextResponseClass The NextResponse class from "next/server.d.ts";
- * @param options Middleware configuration
- * @returns A middleware function
- * @example
- * ```typescript
- * // middleware.ts
- * import { NextResponse } from "next/server.d.ts";
- * import { pailMiddleware } from "@visulima/pail/middleware/next";
- *
- * const middleware = pailMiddleware(NextResponse, {
- *   exclude: ["/_next/**", "/favicon.ico"],
- * });
- *
- * export default middleware;
- * ```
- */
-export declare const pailMiddleware: (NextResponseClass: NextResponseConstructor, options?: PailNextMiddlewareOptions) => ((request: NextRequest) => NextResponse);
-export type { PailNextMiddlewareOptions };

package/dist/middleware/next/storage.d.ts

@@ -1,14 +0,0 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-import type { WideEvent } from "../../wide-event.d.ts";
-/**
- * AsyncLocalStorage instance used to propagate the WideEvent logger
- * through Next.js server actions, route handlers, and server components.
- */
-export declare const pailStorage: AsyncLocalStorage<WideEvent>;
-/**
- * Retrieve the request-scoped WideEvent logger from AsyncLocalStorage.
- * Must be called within a `withPail()` wrapped handler or server action.
- * @returns The request-scoped WideEvent logger
- * @throws Error if called outside of a withPail context
- */
-export declare const useLogger: () => WideEvent;

package/dist/middleware/shared/create-middleware-logger.d.ts

@@ -1,82 +0,0 @@
-import type { PailBrowserImpl } from "../../pail.d.ts";
-import type { DefaultLogTypes, LoggerFunction } from "../../types.d.ts";
-import type { WideEventFinishOptions } from "../../wide-event.d.ts";
-import { WideEvent } from "../../wide-event.d.ts";
-import type { RouteConfig } from "./routes.d.ts";
-/**
- * A pail instance with dynamically generated log methods.
- */
-type PailLike<T extends string = string> = PailBrowserImpl<T> & Record<DefaultLogTypes | T, LoggerFunction>;
-/**
- * Base options shared by all framework middleware adapters.
- * @template T - Custom logger type names from the pail instance
- */
-export interface PailMiddlewareOptions<T extends string = string> {
-    /**
-     * Glob patterns for paths to exclude from logging.
-     * Exclusions take precedence over inclusions.
-     * @example ["/health", "/api/_internal/**"]
-     */
-    exclude?: string[];
-    /**
-     * Glob patterns for paths to include in logging.
-     * If not set, all non-excluded paths are logged.
-     * @example ["/api/**"]
-     */
-    include?: string[];
-    /**
-     * The pail logger instance to use for wide event emission.
-     */
-    pail: PailLike<T>;
-    /**
-     * Route-specific configuration. Maps glob patterns to config.
-     * First matching route wins.
-     * @example { "/api/auth/**": { service: "auth-service" } }
-     */
-    routes?: Record<string, RouteConfig>;
-    /**
-     * Default service name for all wide events.
-     * Can be overridden per-route via `routes`.
-     */
-    service?: string;
-}
-/**
- * Result of creating a middleware logger for a request.
- */
-export interface MiddlewareLoggerResult {
-    /**
-     * Finalize and emit the wide event. Sets status/error before emitting.
-     * Safe to call multiple times — only the first call emits.
-     */
-    finish: (options?: WideEventFinishOptions) => void;
-    /**
-     * The request-scoped WideEvent logger.
-     * Use `set()`, `info()`, `warn()`, `error()`, `debug()` to accumulate context.
-     */
-    logger: WideEvent;
-    /**
-     * Whether this request was skipped (excluded from logging).
-     * When true, `logger` and `finish` should not be used.
-     */
-    skipped: boolean;
-}
-/**
- * Core factory function used by all framework middleware adapters.
- *
- * Creates a WideEvent for the given request, checks route inclusion/exclusion,
- * resolves the service name, and returns a logger + finish callback.
- * @param options Middleware options including pail instance and route config
- * @param request Request metadata for the current HTTP request
- * @param request.headers Safe headers extracted from the request
- * @param request.method The HTTP method (GET, POST, etc.)
- * @param request.path The URL path of the request
- * @param request.requestId A unique identifier for this request
- * @returns A result object with logger, finish callback, and skipped flag
- */
-export declare const createMiddlewareLogger: <T extends string = string>(options: PailMiddlewareOptions<T>, request: {
-    headers?: Record<string, string>;
-    method: string;
-    path: string;
-    requestId: string;
-}) => MiddlewareLoggerResult;
-export {};

package/dist/middleware/shared/headers.d.ts

@@ -1,14 +0,0 @@
-/**
- * Extract safe headers from a Web API Headers object, filtering out
- * sensitive headers like Authorization, Cookie, and API keys.
- * @param headers Web API Headers object
- * @returns Plain object of safe header key-value pairs
- */
-export declare const extractSafeHeaders: (headers: Headers) => Record<string, string>;
-/**
- * Extract safe headers from a Node.js IncomingHttpHeaders object,
- * filtering out sensitive headers.
- * @param headers Node.js IncomingHttpHeaders-like object
- * @returns Plain object of safe header key-value pairs
- */
-export declare const extractSafeNodeHeaders: (headers: Record<string, string | string[] | undefined>) => Record<string, string>;

package/dist/middleware/shared/routes.d.ts

@@ -1,30 +0,0 @@
-/**
- * Check if a path matches a glob pattern.
- */
-export declare const matchesPattern: (path: string, pattern: string) => boolean;
-/**
- * Route configuration for a specific path pattern.
- */
-export interface RouteConfig {
-    /** Override the service name for requests matching this route. */
-    service?: string;
-}
-/**
- * Determine whether a request path should be logged based on include/exclude patterns.
- *
- * - Exclusions take precedence over inclusions.
- * - If no include patterns are provided, all non-excluded paths are logged.
- * @param path The request path
- * @param include Glob patterns of paths to include
- * @param exclude Glob patterns of paths to exclude
- * @returns Whether the path should be logged
- */
-export declare const shouldLog: (path: string, include?: string[], exclude?: string[]) => boolean;
-/**
- * Get the service name override for a given path based on route configuration.
- * Returns the first matching route's service name, or undefined if no match.
- * @param path The request path
- * @param routes Route configuration map (pattern → config)
- * @returns The service name override, or undefined
- */
-export declare const getServiceForPath: (path: string, routes?: Record<string, RouteConfig>) => string | undefined;

package/dist/middleware/shared/storage.d.ts

@@ -1,29 +0,0 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-import type { WideEvent } from "../../wide-event.d.ts";
-/**
- * Create an isolated AsyncLocalStorage instance and a `useLogger` accessor
- * for retrieving the request-scoped WideEvent from anywhere in the call stack.
- *
- * Each framework adapter should call this once at module level to get its own
- * isolated storage instance.
- * @param contextHint A description of the expected context, used in the
- * error message when `useLogger` is called outside of a request scope.
- * @returns An object with `storage` and `useLogger`
- * @example
- * ```typescript
- * const { storage, useLogger } = createLoggerStorage(
- *   "Express middleware context. Make sure evlog middleware is registered."
- * );
- *
- * // In middleware:
- * storage.run(wideEvent, () => next());
- *
- * // In handler:
- * const log = useLogger();
- * log.set({ user: { id: 1 } });
- * ```
- */
-export declare const createLoggerStorage: (contextHint: string) => {
-    storage: AsyncLocalStorage<WideEvent>;
-    useLogger: () => WideEvent;
-};