@pori15/logixlysia 0.0.1 → 6.0.2

package/README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <h1><code>🦊</code> Logixlysia</h1>
   <strong>Logixlysia is a logging library for ElysiaJS</strong>
-  <img src="../../apps/docs/app/opengraph-image.png" alt="Logixlysia" width="100%" height="auto" />
+  <img src="https://github.com/PunGrumpy/logixlysia/blob/main/apps/docs/app/opengraph-image.png?raw=true" alt="Logixlysia" width="100%" height="auto" />
 </div>
 
 ## `📩` Installation

package/dist/index.d.ts

@@ -36,9 +36,34 @@ declare class ProblemError extends Error {
 	constructor(type: string | undefined, title: string, status: number, detail?: string, instance?: string, extensions?: Record<string, unknown>);
 	toJSON(): ProblemDocument;
 }
+declare const HttpError: {};
 type Code = number | "PROBLEM_ERROR" | "UNKNOWN" | "VALIDATION" | "NOT_FOUND" | "PARSE" | "INTERNAL_SERVER_ERROR" | "INVALID_COOKIE_SIGNATURE" | "INVALID_FILE_TYPE";
+type HttpErrorType = keyof typeof HttpError;
+interface ErrorContext {
+	request: Request;
+	path: string;
+	code: string | number;
+	error: unknown;
+}
+interface HttpProblemJsonOptions {
+	/**
+	* 自定义错误类型的 Base URL
+	* @example "https://api.mysite.com/errors"
+	*/
+	typeBaseUrl?: string;
+	/**
+	* 🪝 Transform Hook
+	* 将未知错误转换为 HttpError。
+	* 返回 undefined/null 表示不处理（走默认逻辑）。
+	*/
+	transform?: (error: unknown, context: ErrorContext) => ProblemError | undefined | null;
+	/**
+	* 📢 Listen Hook
+	* 在响应发送前触发（用于日志）。
+	*/
+	onBeforeRespond?: (problem: ProblemError, context: ErrorContext) => void | Promise<void>;
+}
 type Pino = PinoLogger<never, boolean>;
-type Request2 = Request2;
 type LogLevel = "DEBUG" | "INFO" | "WARNING" | "ERROR";
 interface StoreData {
 	beforeTime: bigint;
@@ -68,6 +93,13 @@ interface LogRotationConfig {
 	compress?: boolean;
 	compression?: "gzip";
 }
+interface LogFilter {
+	/**
+	* Array of log levels to allow. If specified, only logs with these levels will be processed.
+	* If not specified, all log levels will be allowed.
+	*/
+	level?: LogLevel[];
+}
 interface Options {
 	config?: {
 		showStartupMessage?: boolean;
@@ -78,6 +110,7 @@ interface Options {
 			translateTime?: string;
 		};
 		customLogFormat?: string;
+		logFilter?: LogFilter;
 		transports?: Transport[];
 		useTransportsOnly?: boolean;
 		disableInternalLogger?: boolean;
@@ -94,27 +127,25 @@ interface Options {
 		};
 	};
 	transform?: (error: unknown, context: {
-		request: Request2;
+		request: Request;
 		code: Code;
+		path: string;
 	}) => ProblemError | unknown;
 }
-declare class HttpError2 extends Error {
-	readonly status: number;
-	constructor(status: number, message: string);
-}
 interface Logger {
 	pino: Pino;
-	log: (level: LogLevel, request: Request2, data: Record<string, unknown>, store: StoreData) => void;
-	handleHttpError: (request: Request2, error: ProblemError, store: StoreData, options: Options) => void;
-	debug: (request: Request2, message: string, context?: Record<string, unknown>) => void;
-	info: (request: Request2, message: string, context?: Record<string, unknown>) => void;
-	warn: (request: Request2, message: string, context?: Record<string, unknown>) => void;
-	error: (request: Request2, message: string, context?: Record<string, unknown>) => void;
+	log: (level: LogLevel, request: Request, data: Record<string, unknown>, store: StoreData) => void;
+	handleHttpError: (request: Request, error: ProblemError, store: StoreData, options: Options) => void;
+	debug: (request: Request, message: string, context?: Record<string, unknown>) => void;
+	info: (request: Request, message: string, context?: Record<string, unknown>) => void;
+	warn: (request: Request, message: string, context?: Record<string, unknown>) => void;
+	error: (request: Request, message: string, context?: Record<string, unknown>) => void;
 }
 interface LogixlysiaContext {
-	request: Request2;
+	request: Request;
 	store: LogixlysiaStore;
 }
+declare const normalizeToProblem: (error: any, code: Code, path: string, typeBaseUrl?: string) => ProblemError;
 interface ProblemJson {
 	type?: string;
 	title: string;
@@ -151,4 +182,4 @@ type Logixlysia = Elysia<"Logixlysia", SingletonBase & {
 	store: LogixlysiaStore;
 }>;
 declare const logixlysia: (options?: Options) => Logixlysia;
-export { toProblemJson, logixlysia, formatProblemJsonLog, logixlysia as default, Transport, StoreData, ProblemJson, Pino, Options, LogixlysiaStore, LogixlysiaContext, Logixlysia, Logger, LogLevel, HttpError2 as HttpError };
+export { toProblemJson, normalizeToProblem, logixlysia, formatProblemJsonLog, logixlysia as default, Transport, StoreData, ProblemJsonOptions, ProblemJson, ProblemError, ProblemDocument, Pino, Options, LogixlysiaStore, LogixlysiaContext, Logixlysia, Logger, LogLevel, HttpProblemJsonOptions, HttpErrorType, HttpError, ErrorContext, Code };