logixlysia 6.9.2 → 6.9.4

package/dist/index.d.ts

@@ -242,7 +242,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 +312,10 @@ 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, enrichers and formatting).
 	*/
 	onError?: (context: SinkErrorContext) => void;
 	transports?: Transport[];
@@ -350,7 +351,7 @@ interface RequestTrackingConfig {
 	* into the request context, so the fields reach the console tree, file logs,
 	* and every transport at once.
 	*
-	* Each entry is either an {@link Enricher} (a `request` phase, a `response`
+	* Each entry is either an `Enricher` (a `request` phase, a `response`
 	* phase, or both) or a bare function, which is treated as the request phase.
 	* Ready-made ones — traceparent, user agent, geo, sizes — live in
 	* `logixlysia/enrichers`.
@@ -372,7 +373,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,6 +422,7 @@ interface WebSocketLike {
 		};
 	};
 	readonly id?: string;
+	readonly raw?: object;
 }
 interface WsHandlerHooks<
 	TMessage = unknown,
@@ -511,7 +514,7 @@ interface SamplingRuntime {
 *
 * @param random Injectable for deterministic tests; defaults to `Math.random`.
 */
-declare const resolveSampling: (config: SamplingConfig | undefined, random?: () => number) => SamplingRuntime | undefined;
+declare const resolveSampling: (config?: SamplingConfig, random?: () => number) => SamplingRuntime | undefined;
 /**
 * Empty singleton slots must not use `Record<string, never>`: intersecting that with Elysia's `Context`
 * makes every key (including `store`) become `never` because each key is merged with `never`.
@@ -536,7 +539,7 @@ type LogixlysiaPlugin<TFields extends object = LogFields> = Logixlysia<TFields>
 	wrapWs: ReturnType<typeof createWsHandlerWrapper>;
 };
 /**
-* @typeParam TFields - Field bag for the request-scoped `log`. Supply your own
+* @template TFields - Field bag for the request-scoped `log`. Supply your own
 * interface to have TypeScript reject misspelled context keys; the default
 * allows any key, so untyped usage is unchanged.
 */