logixlysia 6.9.3 → 6.10.0

package/dist/index.d.ts

@@ -110,6 +110,8 @@ type RequestInfo = Request;
 type LogLevel = "DEBUG" | "INFO" | "WARNING" | "ERROR";
 interface StoreData {
 	beforeTime: bigint;
+	/** The status the client received, when the caller resolved it. `handleHttpError` prefers it over the thrown value. */
+	status?: number;
 }
 interface LogixlysiaStore {
 	beforeTime?: bigint;
@@ -242,7 +244,7 @@ type LogPreset = "dev" | "prod" | "json";
 /** Context passed to {@link Options.config.onError} when a sink fails. */
 interface SinkErrorContext {
 	error: unknown;
-	sink: "enricher" | "file" | "rotation" | "shutdown" | "transport";
+	sink: "enricher" | "file" | "format" | "rotation" | "shutdown" | "transport";
 }
 interface RequestIdConfig {
 	/**
@@ -312,9 +314,11 @@ interface OutputConfig {
 	logFilePath?: string;
 	logRotation?: LogRotationConfig;
 	/**
-	* Called when a sink (transport, file, rotation) or an enricher fails.
-	* Errors thrown by the hook itself are swallowed. When absent, failures go
-	* to stderr (rate-limited for transports and enrichers).
+	* Called when a sink (transport, file, rotation) or an enricher fails, or
+	* when building or printing a log record fails (`sink: 'format'`). Errors
+	* thrown by the hook itself are swallowed. When absent, failures go to
+	* stderr (rate-limited for transports, file writes, rotation, enrichers
+	* and formatting).
 	*/
 	onError?: (context: SinkErrorContext) => void;
 	transports?: Transport[];
@@ -372,7 +376,8 @@ interface RequestTrackingConfig {
 	requestId?: boolean | RequestIdConfig;
 	/**
 	* Enable request-scoped logger propagation via AsyncLocalStorage.
-	* When enabled, a request-scoped logger `log` is also derived on the Elysia context.
+	* When enabled, `useLogger()` returns the current request's logger anywhere in the request's async call chain.
+	* The handler context's `log` is available either way.
 	* @default false
 	*/
 	useAsyncLocalStorage?: boolean;
@@ -420,14 +425,15 @@ interface WebSocketLike {
 		};
 	};
 	readonly id?: string;
+	readonly raw?: object;
 }
 interface WsHandlerHooks<
 	TMessage = unknown,
 	TWs extends WebSocketLike = WebSocketLike
 > {
-	close?: (ws: TWs, code?: number, reason?: string) => void;
-	message?: (ws: TWs, message: TMessage) => void;
-	open?: (ws: TWs) => void;
+	close?: (ws: TWs, code?: number, reason?: string) => unknown;
+	message?: (ws: TWs, message: TMessage) => unknown;
+	open?: (ws: TWs) => unknown;
 }
 declare const createWsHandlerWrapper: (options: Options, logger: Logger, contextStore: RequestContextStore) => <
 	TMessage,
@@ -451,6 +457,7 @@ interface ResolvedRequestIdConfig {
 	enabled: boolean;
 	generator: () => string;
 	header: string;
+	onError?: (context: SinkErrorContext) => void;
 }
 /**
 * Normalises the `requestId` option into a concrete config object.
@@ -459,7 +466,7 @@ interface ResolvedRequestIdConfig {
 * - `true` → default config
 * - `RequestIdConfig` → merged with defaults; `enabled: false` inside the object disables the feature
 */
-declare const resolveRequestIdConfig: (raw?: boolean | RequestIdConfig) => ResolvedRequestIdConfig | null;
+declare const resolveRequestIdConfig: (raw?: boolean | RequestIdConfig, onError?: (context: SinkErrorContext) => void) => ResolvedRequestIdConfig | null;
 /**
 * Reads an existing request ID from the incoming request header, or generates a
 * new one using the configured generator.
@@ -468,6 +475,10 @@ declare const resolveRequestIdConfig: (raw?: boolean | RequestIdConfig) => Resol
 * `.`, `_`, `-`, 1-128 chars) before being trusted — request IDs flow into log
 * lines, response headers, and context trees, so malformed or oversized
 * values are replaced with a freshly generated one rather than echoed back.
+*
+* Generated values must pass the same check. This runs in `onRequest`, where
+* a throw would log an error for every request, so a generator that throws
+* or returns an invalid id is reported and replaced with a random UUID.
 */
 declare const getOrCreateRequestId: (request: Request, config: ResolvedRequestIdConfig) => string;
 /**
@@ -550,4 +561,4 @@ declare const flushLogixlysia: (options: Options, { close }?: {
 	close?: boolean;
 }) => Promise<void>;
 declare const logixlysia: typeof createLogixlysiaPlugin;
-export { useLogger, resolveSampling, resolveRequestIdConfig, resolveOptions, logixlysia, getOrCreateRequestId, flushLogixlysia, createLogixlysiaPlugin as default, createWsHandlerWrapper, createPluginLogger, createLogger, WsHandlerHooks, Transport, TailSamplingConfig, StoreData, SamplingRuntime, SamplingDecision, SamplingConfig, ResolvedRequestIdConfig, RequestScopedLogger, RequestOutcome, RequestIdConfig, Pino, Options, LogixlysiaStore, LogixlysiaSingleton, LogixlysiaPlugin, LogixlysiaContext, Logixlysia, Logger, LogPreset, LogLevel, LogFields, HttpErrorPayload, HttpErrorInit, HttpError, HeadSamplingConfig, EnricherResponseInput, EnricherLike, EnricherFields, Enricher, EmptyElysiaSlot };
+export { useLogger, resolveSampling, resolveRequestIdConfig, resolveOptions, logixlysia, getOrCreateRequestId, flushLogixlysia, createLogixlysiaPlugin as default, createWsHandlerWrapper, createPluginLogger, createLogger, WsHandlerHooks, WebSocketLike, Transport, TailSamplingConfig, StoreData, SinkErrorContext, SamplingRuntime, SamplingDecision, SamplingConfig, ResolvedRequestIdConfig, RequestScopedLogger, RequestOutcome, RequestIdConfig, Pino, Options, LogixlysiaStore, LogixlysiaSingleton, LogixlysiaPlugin, LogixlysiaContext, LogixlysiaConfig, Logixlysia, Logger, LogRotationConfig, LogPreset, LogLevel, LogFilter, LogFields, HttpErrorPayload, HttpErrorInit, HttpError, HeadSamplingConfig, EnricherResponseInput, EnricherLike, EnricherFields, Enricher, EmptyElysiaSlot };