@hestjs/logger 0.1.0

package/dist/transports.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConsoleTransport = createConsoleTransport;
+exports.createFileTransport = createFileTransport;
+exports.createRotatingFileTransport = createRotatingFileTransport;
+exports.createJsonFileTransport = createJsonFileTransport;
+exports.createMultiTransport = createMultiTransport;
+exports.createDevelopmentTransport = createDevelopmentTransport;
+exports.createProductionTransport = createProductionTransport;
+exports.getEnvironmentTransport = getEnvironmentTransport;
+/**
+ * 控制台传输配置
+ */
+function createConsoleTransport(options = {}) {
+    return {
+        type: "console",
+        target: "pino-pretty",
+        options: {
+            colorize: options.colorize ?? true,
+            translateTime: options.translateTime ?? "yyyy-mm-dd HH:MM:ss.l",
+            ignore: options.ignore ?? "pid,hostname",
+            singleLine: options.singleLine ?? false,
+            hideObject: options.hideObject ?? false,
+            messageFormat: "{end}{msg}",
+            ...options,
+        },
+    };
+}
+/**
+ * 文件传输配置
+ */
+function createFileTransport(options = { destination: "./logs/app.log" }) {
+    const { destination, ...restOptions } = options;
+    return {
+        type: "file",
+        target: "pino/file",
+        options: {
+            destination,
+            mkdir: true,
+            append: true,
+            ...restOptions,
+        },
+    };
+}
+/**
+ * 滚动文件传输配置
+ */
+function createRotatingFileTransport(options = { filename: "./logs/app-%DATE%.log" }) {
+    return {
+        type: "custom",
+        target: "pino-roll",
+        options: {
+            file: options.filename,
+            frequency: options.frequency ?? "daily",
+            size: options.maxSize ?? "10M",
+            limit: options.maxFiles ?? "7",
+            dateFormat: options.dateFormat ?? "YYYY-MM-DD",
+            ...options,
+        },
+    };
+}
+/**
+ * JSON 文件传输配置
+ */
+function createJsonFileTransport(options = { destination: "./logs/app.json" }) {
+    return {
+        type: "file",
+        target: "pino/file",
+        options: {
+            destination: options.destination,
+            mkdir: options.mkdir ?? true,
+            append: options.append ?? true,
+        },
+    };
+}
+/**
+ * 多传输配置
+ */
+function createMultiTransport(transports) {
+    return {
+        targets: transports.map((transport) => ({
+            target: transport.target,
+            options: transport.options,
+            level: transport.options?.level,
+        })),
+    };
+}
+/**
+ * 开发环境传输
+ */
+function createDevelopmentTransport() {
+    return createConsoleTransport({
+        colorize: true,
+        translateTime: "yy-mm-dd HH:MM:ss.l",
+        ignore: "pid,hostname",
+        singleLine: false,
+    });
+}
+/**
+ * 生产环境传输
+ */
+function createProductionTransport() {
+    return createMultiTransport([
+        createJsonFileTransport({
+            destination: "./logs/app.json",
+        }),
+        createFileTransport({
+            destination: "./logs/error.log",
+        }),
+    ]);
+}
+/**
+ * 根据环境获取传输配置
+ */
+function getEnvironmentTransport(env) {
+    const environment = env || process.env.NODE_ENV || "development";
+    switch (environment) {
+        case "production":
+        case "prod":
+            return createProductionTransport();
+        case "test":
+        case "testing":
+            return undefined; // 测试环境通常不需要传输
+        case "development":
+        case "dev":
+        default:
+            return createDevelopmentTransport();
+    }
+}
+//# sourceMappingURL=transports.js.map

package/dist/transports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transports.js","sourceRoot":"","sources":["../src/transports.ts"],"names":[],"mappings":";;AAKA,wDAsBC;AAKD,kDAoBC;AAKD,kEAqBC;AAKD,0DAgBC;AAKD,oDAQC;AAKD,gEAOC;AAKD,8DASC;AAKD,0DAeC;AA5JD;;GAEG;AACH,SAAgB,sBAAsB,CACpC,UAMI,EAAE;IAEN,OAAO;QACL,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE;YACP,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;YAClC,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,uBAAuB;YAC/D,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,cAAc;YACxC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,aAAa,EAAE,YAAY;YAC3B,GAAG,OAAO;SACX;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,UAMI,EAAE,WAAW,EAAE,gBAAgB,EAAE;IAErC,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IAChD,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,WAAW;QACnB,OAAO,EAAE;YACP,WAAW;YACX,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,GAAG,WAAW;SACf;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CACzC,UAMI,EAAE,QAAQ,EAAE,uBAAuB,EAAE;IAEzC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,WAAW;QACnB,OAAO,EAAE;YACP,IAAI,EAAE,OAAO,CAAC,QAAQ;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO;YACvC,IAAI,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;YAC9B,KAAK,EAAE,OAAO,CAAC,QAAQ,IAAI,GAAG;YAC9B,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,YAAY;YAC9C,GAAG,OAAO;SACX;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CACrC,UAII,EAAE,WAAW,EAAE,iBAAiB,EAAE;IAEtC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,WAAW;QACnB,OAAO,EAAE;YACP,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;SAC/B;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,UAA6B;IAChE,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACtC,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK;SAChC,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B;IACxC,OAAO,sBAAsB,CAAC;QAC5B,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,qBAAqB;QACpC,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB;IACvC,OAAO,oBAAoB,CAAC;QAC1B,uBAAuB,CAAC;YACtB,WAAW,EAAE,iBAAiB;SAC/B,CAAC;QACF,mBAAmB,CAAC;YAClB,WAAW,EAAE,kBAAkB;SAChC,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CAAC,GAAY;IAClD,MAAM,WAAW,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;IAEjE,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY,CAAC;QAClB,KAAK,MAAM;YACT,OAAO,yBAAyB,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,CAAC,cAAc;QAClC,KAAK,aAAa,CAAC;QACnB,KAAK,KAAK,CAAC;QACX;YACE,OAAO,0BAA0B,EAAE,CAAC;IACxC,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,123 @@
+import type { Logger as PinoLogger } from 'pino';
+/**
+ * 日志级别枚举
+ */
+export declare enum LogLevel {
+    FATAL = "fatal",
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    DEBUG = "debug",
+    TRACE = "trace"
+}
+/**
+ * 日志配置接口
+ */
+export interface LoggerConfig {
+    /** 日志级别 */
+    level?: LogLevel | string;
+    /** 日志名称 */
+    name?: string;
+    /** 是否启用时间戳 */
+    timestamp?: boolean;
+    /** 序列化器配置 */
+    serializers?: Record<string, (value: any) => any>;
+    /** 自定义格式化器 */
+    formatters?: {
+        level?: (label: string, number: number) => object;
+        bindings?: (bindings: Record<string, any>) => Record<string, any>;
+        log?: (object: Record<string, any>) => Record<string, any>;
+    };
+    /** 传输配置 */
+    transport?: any;
+    /** 重新定义配置 */
+    redact?: string[] | {
+        paths: string[];
+        censor?: string;
+    };
+    /** 基础配置 */
+    base?: Record<string, any> | null;
+    /** 钩子函数 */
+    hooks?: {
+        logMethod?: (inputArgs: any[], method: any, level: number) => void;
+    };
+    /** 自定义错误序列化器 */
+    customLevels?: Record<string, number>;
+    /** 使用仅级别标签 */
+    useOnlyCustomLevels?: boolean;
+    /** 混合函数 */
+    mixin?: () => Record<string, any>;
+    /** 消息键 */
+    messageKey?: string;
+    /** 错误键 */
+    errorKey?: string;
+    /** 换行符 */
+    nestedKey?: string;
+}
+/**
+ * 日志上下文接口
+ */
+export interface LogContext {
+    /** 请求ID */
+    requestId?: string;
+    /** 用户ID */
+    userId?: string;
+    /** 跟踪ID */
+    traceId?: string;
+    /** 额外的上下文数据 */
+    [key: string]: any;
+}
+/**
+ * HestJS Logger 接口
+ */
+export interface Logger {
+    /** 原始 Pino Logger 实例 */
+    readonly pino: PinoLogger;
+    /** 设置上下文 */
+    setContext(context: LogContext): Logger;
+    /** 获取子 Logger */
+    child(bindings: Record<string, any>): Logger;
+    /** Fatal 级别日志 */
+    fatal(message: string, ...args: any[]): void;
+    fatal(obj: object, message?: string, ...args: any[]): void;
+    /** Error 级别日志 */
+    error(message: string, ...args: any[]): void;
+    error(obj: object, message?: string, ...args: any[]): void;
+    /** Warn 级别日志 */
+    warn(message: string, ...args: any[]): void;
+    warn(obj: object, message?: string, ...args: any[]): void;
+    /** Info 级别日志 */
+    info(message: string, ...args: any[]): void;
+    info(obj: object, message?: string, ...args: any[]): void;
+    /** Debug 级别日志 */
+    debug(message: string, ...args: any[]): void;
+    debug(obj: object, message?: string, ...args: any[]): void;
+    /** Trace 级别日志 */
+    trace(message: string, ...args: any[]): void;
+    trace(obj: object, message?: string, ...args: any[]): void;
+    /** 刷新日志 */
+    flush(): void;
+    /** 检查是否启用了指定级别 */
+    isLevelEnabled(level: LogLevel | string): boolean;
+}
+/**
+ * 传输类型
+ */
+export type TransportType = 'console' | 'file' | 'stream' | 'custom';
+/**
+ * 传输配置
+ */
+export interface TransportConfig {
+    type: TransportType;
+    target?: string;
+    options?: Record<string, any>;
+}
+/**
+ * 环境变量
+ */
+export interface LoggerEnvironment {
+    NODE_ENV?: string;
+    LOG_LEVEL?: string;
+    LOG_NAME?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAEjD;;GAEG;AACH,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,WAAW;IACX,KAAK,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC1B,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa;IACb,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;IAClD,cAAc;IACd,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;QAClD,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClE,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC5D,CAAC;IACF,WAAW;IACX,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAClC,WAAW;IACX,KAAK,CAAC,EAAE;QACN,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;KACpE,CAAC;IACF,gBAAgB;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,cAAc;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,WAAW;IACX,KAAK,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClC,UAAU;IACV,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU;IACV,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,WAAW;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,wBAAwB;IACxB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAE1B,YAAY;IACZ,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC;IAExC,iBAAiB;IACjB,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IAE7C,iBAAiB;IACjB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3D,iBAAiB;IACjB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3D,gBAAgB;IAChB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE1D,gBAAgB;IAChB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE1D,iBAAiB;IACjB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3D,iBAAiB;IACjB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC7C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3D,WAAW;IACX,KAAK,IAAI,IAAI,CAAC;IAEd,kBAAkB;IAClB,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+/**
+ * 日志级别枚举
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["FATAL"] = "fatal";
+    LogLevel["ERROR"] = "error";
+    LogLevel["WARN"] = "warn";
+    LogLevel["INFO"] = "info";
+    LogLevel["DEBUG"] = "debug";
+    LogLevel["TRACE"] = "trace";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;AACjB,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@hestjs/logger",
+  "version": "0.1.0",
+  "description": "HestJS Logger - A powerful logging solution based on Pino",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "check-types": "tsc --noEmit",
+    "prepublishOnly": "npm run clean && npm run build",
+    "publish:npm": "npm publish --access public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aqz236/hest-logger.git"
+  },
+  "homepage": "https://github.com/aqz236/hest-logger#readme",
+  "bugs": {
+    "url": "https://github.com/aqz236/hest-logger/issues"
+  },
+  "author": "aqz236",
+  "license": "MIT",
+  "dependencies": {
+    "pino": "^9.7.0",
+    "pino-pretty": "^13.0.0",
+    "pino-std-serializers": "^7.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.1.0",
+    "typescript": "5.8.3"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "keywords": [
+    "hestjs",
+    "logger",
+    "pino",
+    "logging",
+    "structured-logging"
+  ]
+}