@jiangnian520/midway-operation-log 0.0.0-stage → 1.0.1

package/dist/config/config.default.d.ts

@@ -0,0 +1,5 @@
+import type { OperationLogConfig } from '../interface';
+declare const _default: {
+    operationLog: OperationLogConfig;
+};
+export default _default;

package/dist/config/config.default.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    operationLog: {
+        enable: true,
+        useRedis: false,
+        redisQueueName: 'operation-log',
+        writeLog: async (ctx, logData) => {
+            console.log(`[OperationLog] ${logData.methodName} | ${logData.costTime}ms`, logData);
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBRUEsa0JBQWU7SUFDYixZQUFZLEVBQUU7UUFDWixNQUFNLEVBQUUsSUFBSTtRQUNaLFFBQVEsRUFBRSxLQUFLO1FBQ2YsY0FBYyxFQUFFLGVBQWU7UUFDL0IsUUFBUSxFQUFFLEtBQUssRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEVBQUU7WUFDL0IsT0FBTyxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsT0FBTyxDQUFDLFVBQVUsTUFBTSxPQUFPLENBQUMsUUFBUSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDdkYsQ0FBQztLQUNvQjtDQUN4QixDQUFDIn0=

package/dist/configuration.d.ts

@@ -0,0 +1,7 @@
+import { MidwayDecoratorService } from '@midwayjs/core';
+import type { ILifeCycle, IMidwayContainer } from '@midwayjs/core';
+export declare class OperationLogConfiguration implements ILifeCycle {
+    decoratorService: MidwayDecoratorService;
+    applicationContext: IMidwayContainer;
+    onReady(): Promise<void>;
+}

package/dist/configuration.js

@@ -0,0 +1,94 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationLogConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+const DefaultConfig = __importStar(require("./config/config.default"));
+const interface_1 = require("./interface");
+const queue_interface_1 = require("./queue/queue.interface");
+const memory_queue_1 = require("./queue/memory.queue");
+const redis_queue_1 = require("./queue/redis.queue");
+let OperationLogConfiguration = class OperationLogConfiguration {
+    async onReady() {
+        const configService = this.applicationContext.get(core_1.MidwayConfigService);
+        const config = configService.getConfiguration('operationLog');
+        if (config.useRedis) {
+            this.applicationContext.registerObject(queue_interface_1.LOG_QUEUE_TOKEN, redis_queue_1.RedisLogQueue);
+        }
+        else {
+            this.applicationContext.registerObject(queue_interface_1.LOG_QUEUE_TOKEN, memory_queue_1.MemoryLogQueue);
+        }
+        this.decoratorService.registerMethodHandler(interface_1.LOGGING_KEY, (options) => {
+            return {
+                around: async (joinPoint) => {
+                    const ctx = joinPoint.target[core_1.REQUEST_OBJ_CTX_KEY];
+                    if (ctx) {
+                        ctx.state = ctx.state || {};
+                        ctx.state.__log_meta__ = {
+                            methodName: joinPoint.methodName,
+                            options,
+                        };
+                    }
+                    return joinPoint.proceed(...joinPoint.args);
+                },
+            };
+        });
+    }
+};
+exports.OperationLogConfiguration = OperationLogConfiguration;
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayDecoratorService)
+], OperationLogConfiguration.prototype, "decoratorService", void 0);
+__decorate([
+    (0, core_1.ApplicationContext)(),
+    __metadata("design:type", Object)
+], OperationLogConfiguration.prototype, "applicationContext", void 0);
+exports.OperationLogConfiguration = OperationLogConfiguration = __decorate([
+    (0, core_1.Configuration)({
+        namespace: 'operationLog',
+        importConfigs: [{ default: DefaultConfig }],
+    })
+], OperationLogConfiguration);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlndXJhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb25maWd1cmF0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHlDQU93QjtBQUV4Qix1RUFBeUQ7QUFDekQsMkNBQTBDO0FBQzFDLDZEQUEwRDtBQUMxRCx1REFBc0Q7QUFDdEQscURBQW9EO0FBTTdDLElBQU0seUJBQXlCLEdBQS9CLE1BQU0seUJBQXlCO0lBT3BDLEtBQUssQ0FBQyxPQUFPO1FBQ1gsTUFBTSxhQUFhLEdBQUcsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEdBQUcsQ0FBQywwQkFBbUIsQ0FBQyxDQUFDO1FBQ3ZFLE1BQU0sTUFBTSxHQUFHLGFBQWEsQ0FBQyxnQkFBZ0IsQ0FBQyxjQUFjLENBQUMsQ0FBQztRQUU5RCxJQUFJLE1BQU0sQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNwQixJQUFJLENBQUMsa0JBQWtCLENBQUMsY0FBYyxDQUFDLGlDQUFlLEVBQUUsMkJBQWEsQ0FBQyxDQUFDO1FBQ3pFLENBQUM7YUFBTSxDQUFDO1lBQ04sSUFBSSxDQUFDLGtCQUFrQixDQUFDLGNBQWMsQ0FBQyxpQ0FBZSxFQUFFLDZCQUFjLENBQUMsQ0FBQztRQUMxRSxDQUFDO1FBRUQsSUFBSSxDQUFDLGdCQUFnQixDQUFDLHFCQUFxQixDQUFDLHVCQUFXLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRTtZQUNuRSxPQUFPO2dCQUNMLE1BQU0sRUFBRSxLQUFLLEVBQUUsU0FBUyxFQUFFLEVBQUU7b0JBQzFCLE1BQU0sR0FBRyxHQUFHLFNBQVMsQ0FBQyxNQUFNLENBQUMsMEJBQW1CLENBQUMsQ0FBQztvQkFFbEQsSUFBSSxHQUFHLEVBQUUsQ0FBQzt3QkFDUixHQUFHLENBQUMsS0FBSyxHQUFHLEdBQUcsQ0FBQyxLQUFLLElBQUksRUFBRSxDQUFDO3dCQUM1QixHQUFHLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRzs0QkFDdkIsVUFBVSxFQUFFLFNBQVMsQ0FBQyxVQUFVOzRCQUNoQyxPQUFPO3lCQUNSLENBQUM7b0JBQ0osQ0FBQztvQkFFRCxPQUFPLFNBQVMsQ0FBQyxPQUFRLENBQUMsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQy9DLENBQUM7YUFDRixDQUFDO1FBQ0osQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0NBQ0YsQ0FBQTtBQW5DWSw4REFBeUI7QUFFcEM7SUFEQyxJQUFBLGFBQU0sR0FBRTs4QkFDUyw2QkFBc0I7bUVBQUM7QUFHekM7SUFEQyxJQUFBLHlCQUFrQixHQUFFOztxRUFDZ0I7b0NBTDFCLHlCQUF5QjtJQUpyQyxJQUFBLG9CQUFhLEVBQUM7UUFDYixTQUFTLEVBQUUsY0FBYztRQUN6QixhQUFhLEVBQUUsQ0FBQyxFQUFFLE9BQU8sRUFBRSxhQUFhLEVBQUUsQ0FBQztLQUM1QyxDQUFDO0dBQ1cseUJBQXlCLENBbUNyQyJ9

package/dist/decorator/log.decorator.d.ts

@@ -0,0 +1,24 @@
+import type { LogOptions } from '../interface';
+/**
+ * # 操作日志装饰器
+ *
+ * 标记在 Controller 的方法上，自动收集请求参数、耗时、响应结果并异步写入日志。
+ * 注意：只有在被该装饰器标记的方法，且全局配置了 `writeLog` 的情况下才会生效。
+ *
+ * @param options 日志记录配置项（标题、业务类型、记录模式等）
+ *
+ * @example
+ * ```typescript
+ * @Post('/create')
+ * @Log({
+ *   title: '新增物料',
+ *   businessType: 1,
+ *   logMode: 'summary',
+ *   collectSource: ['body', 'query']
+ * })
+ * async createMaterial(@Body() body: any) {
+ *   return { code: 200, message: 'success' };
+ * }
+ * ```
+ */
+export declare function Log(options?: LogOptions): MethodDecorator;

package/dist/decorator/log.decorator.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Log = Log;
+const core_1 = require("@midwayjs/core");
+const interface_1 = require("../interface");
+function resolveFileName() {
+    const originalPrepare = Error.prepareStackTrace;
+    let callSites = [];
+    try {
+        Error.prepareStackTrace = (_, stack) => stack;
+        callSites = new Error().stack;
+    }
+    catch {
+        return 'unknown';
+    }
+    finally {
+        Error.prepareStackTrace = originalPrepare;
+    }
+    const selfFile = __filename;
+    for (const frame of callSites) {
+        const file = frame.getFileName();
+        if (!file)
+            continue;
+        if (file === selfFile)
+            continue;
+        if (file.includes('node_modules'))
+            continue;
+        if (/[\\/](tslib|@midwayjs)[\\/]/.test(file))
+            continue;
+        return file;
+    }
+    return 'unknown';
+}
+/**
+ * # 操作日志装饰器
+ *
+ * 标记在 Controller 的方法上，自动收集请求参数、耗时、响应结果并异步写入日志。
+ * 注意：只有在被该装饰器标记的方法，且全局配置了 `writeLog` 的情况下才会生效。
+ *
+ * @param options 日志记录配置项（标题、业务类型、记录模式等）
+ *
+ * @example
+ * ```typescript
+ * @Post('/create')
+ * @Log({
+ *   title: '新增物料',
+ *   businessType: 1,
+ *   logMode: 'summary',
+ *   collectSource: ['body', 'query']
+ * })
+ * async createMaterial(@Body() body: any) {
+ *   return { code: 200, message: 'success' };
+ * }
+ * ```
+ */
+function Log(options = {}) {
+    const defaultOptions = {
+        businessType: 0,
+        needLog: true,
+        logResult: true,
+        logMode: 'summary',
+        maxSampleCount: 3,
+        maxRawLength: 8000,
+        collectSource: ['body', 'query', 'params'],
+        ...options,
+    };
+    return core_1.DecoratorManager.createCustomMethodDecorator(interface_1.LOGGING_KEY, {
+        fileName: resolveFileName(),
+        log: defaultOptions,
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nLmRlY29yYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZWNvcmF0b3IvbG9nLmRlY29yYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQWtEQSxrQkFnQkM7QUFsRUQseUNBQWtEO0FBRWxELDRDQUEyQztBQUUzQyxTQUFTLGVBQWU7SUFDcEIsTUFBTSxlQUFlLEdBQUcsS0FBSyxDQUFDLGlCQUFpQixDQUFDO0lBQ2hELElBQUksU0FBUyxHQUFzQixFQUFFLENBQUM7SUFDdEMsSUFBSSxDQUFDO1FBQ0QsS0FBSyxDQUFDLGlCQUFpQixHQUFHLENBQUMsQ0FBQyxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsS0FBWSxDQUFDO1FBQ3JELFNBQVMsR0FBRyxJQUFJLEtBQUssRUFBRSxDQUFDLEtBQXFDLENBQUM7SUFDbEUsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNMLE9BQU8sU0FBUyxDQUFDO0lBQ3JCLENBQUM7WUFBUyxDQUFDO1FBQ1AsS0FBSyxDQUFDLGlCQUFpQixHQUFHLGVBQWUsQ0FBQztJQUM5QyxDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQUcsVUFBVSxDQUFDO0lBQzVCLEtBQUssTUFBTSxLQUFLLElBQUksU0FBUyxFQUFFLENBQUM7UUFDNUIsTUFBTSxJQUFJLEdBQUcsS0FBSyxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ2pDLElBQUksQ0FBQyxJQUFJO1lBQUUsU0FBUztRQUNwQixJQUFJLElBQUksS0FBSyxRQUFRO1lBQUUsU0FBUztRQUNoQyxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsY0FBYyxDQUFDO1lBQUUsU0FBUztRQUM1QyxJQUFJLDZCQUE2QixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7WUFBRSxTQUFTO1FBQ3ZELE9BQU8sSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFDRCxPQUFPLFNBQVMsQ0FBQztBQUNyQixDQUFDO0FBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXFCRztBQUNILFNBQWdCLEdBQUcsQ0FBQyxVQUFzQixFQUFFO0lBQ3hDLE1BQU0sY0FBYyxHQUFlO1FBQy9CLFlBQVksRUFBRSxDQUFDO1FBQ2YsT0FBTyxFQUFFLElBQUk7UUFDYixTQUFTLEVBQUUsSUFBSTtRQUNmLE9BQU8sRUFBRSxTQUFTO1FBQ2xCLGNBQWMsRUFBRSxDQUFDO1FBQ2pCLFlBQVksRUFBRSxJQUFJO1FBQ2xCLGFBQWEsRUFBRSxDQUFDLE1BQU0sRUFBRSxPQUFPLEVBQUUsUUFBUSxDQUFDO1FBQzFDLEdBQUcsT0FBTztLQUNiLENBQUM7SUFFRixPQUFPLHVCQUFnQixDQUFDLDJCQUEyQixDQUFDLHVCQUFXLEVBQUU7UUFDN0QsUUFBUSxFQUFFLGVBQWUsRUFBRTtRQUMzQixHQUFHLEVBQUUsY0FBYztLQUN0QixDQUFDLENBQUM7QUFDUCxDQUFDIn0=

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { OperationLogConfiguration as Configuration } from './configuration';
+export { Log } from './decorator/log.decorator';
+export { ReportMiddleware } from './middleware/report.middleware';
+export type { LogOptions, CollectedLogData, OperationLogConfig } from './interface';

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportMiddleware = exports.Log = exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.OperationLogConfiguration; } });
+var log_decorator_1 = require("./decorator/log.decorator");
+Object.defineProperty(exports, "Log", { enumerable: true, get: function () { return log_decorator_1.Log; } });
+var report_middleware_1 = require("./middleware/report.middleware");
+Object.defineProperty(exports, "ReportMiddleware", { enumerable: true, get: function () { return report_middleware_1.ReportMiddleware; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsaURBQTZFO0FBQXBFLDhHQUFBLHlCQUF5QixPQUFpQjtBQUNuRCwyREFBZ0Q7QUFBdkMsb0dBQUEsR0FBRyxPQUFBO0FBQ1osb0VBQWtFO0FBQXpELHFIQUFBLGdCQUFnQixPQUFBIn0=

package/dist/interface.d.ts

@@ -0,0 +1,130 @@
+import type { Context } from '@midwayjs/koa';
+export declare const LOGGING_KEY = "decorator:logging_key";
+/**
+ * 收集好的标准日志数据（用户在 writeLog 方法的参数中拿到）
+ */
+export interface CollectedLogData {
+    /** 日志标题，取自装饰器配置（如：新增物料） */
+    title: string;
+    /** 业务类型编码，取自装饰器配置 */
+    businessType: number;
+    /** 执行的方法名，如 'MaterialController.createMaterial' */
+    methodName?: string;
+    /** HTTP 请求方法，如 'POST', 'GET' */
+    requestMethod: string;
+    /** 完整的请求 URL 地址 */
+    url: string;
+    /** 客户端 IP 地址 */
+    ip: string;
+    /**
+     * 请求参数（JSON 字符串格式）。
+     * 注意：内部已经自动处理了 Map、BigInt 等复杂类型，并自动脱敏了 password、token 等敏感字段。
+     */
+    operParam: string | null;
+    /**
+     * 响应结果（JSON 字符串格式）。
+     * 注意：根据 maxRawLength 自动截断防止撑爆数据库；根据 logMode 自动摘要。
+     */
+    jsonResult: string | null;
+    /** 操作状态：0 表示成功，1 表示发生异常失败 */
+    operStatus: number;
+    /** 失败时的错误信息，成功时为 null */
+    errorMsg: string | null;
+    /** 请求开始时间 */
+    startTime: Date;
+    /** 请求结束时间 */
+    endTime: Date;
+    /** 接口总耗时（毫秒） */
+    costTime: number;
+}
+/**
+ * 装饰器入参配置（用户在使用 @Log() 时看到的提示）
+ */
+export interface LogOptions {
+    /**
+     * 日志标题（将写入数据库的 title 字段）。
+     * @example '新增物料'
+     */
+    title?: string;
+    /**
+     * 业务类型编码（可选），用于区分不同类型的操作。
+     * @example 1
+     */
+    businessType?: number;
+    /**
+     * 是否记录本次请求日志。
+     * - 设置为 `false` 时，请求成功不记日志，但**发生报错时依然会记录**（保证审计底线）。
+     * @default true
+     */
+    needLog?: boolean;
+    /**
+     * 是否记录接口的返回结果（jsonResult 字段）。
+     * - 设置为 `false` 时，成功时记录 `"[已按配置省略]"`，失败时依然记录错误响应。
+     * @default true
+     */
+    logResult?: boolean;
+    /**
+     * 日志记录模式：
+     * - `'full'`：原样记录完整返回结果（可能很大）。
+     * - `'summary'`：智能摘要模式，如果返回的是数组，只记录前 N 条（由 maxSampleCount 决定）。
+     * @default 'summary'
+     */
+    logMode?: 'full' | 'summary';
+    /**
+     * 当 `logMode: 'summary'` 时生效。数组超过此条数时进行截断摘要。
+     * @default 3
+     */
+    maxSampleCount?: number;
+    /**
+     * 结果序列化后，超过此字符数时进行截断保护，防止数据库字段超长。
+     * @default 8000
+     */
+    maxRawLength?: number;
+    /**
+     * 需要采集哪些参数源（body、query、params）。
+     * @example ['body', 'query']
+     * @default ['body', 'query', 'params']
+     */
+    collectSource?: Array<'body' | 'query' | 'params'>;
+}
+/**
+ * 业务方全局配置（在 config.default.ts 中配置）
+ */
+export interface OperationLogConfig {
+    /**
+     * 是否启用操作日志全局开关。
+     * @default true
+     */
+    enable?: boolean;
+    /**
+     * 是否使用 Redis (BullMQ) 队列。
+     * - `false`：使用内置内存队列（速度快，重启可能丢失少量日志）。
+     * - `true`：使用 Redis 持久化队列（高可靠，需额外安装 `@midwayjs/bullmq`）。
+     * @default false
+     */
+    useRedis?: boolean;
+    /**
+     * Redis 队列的名称。
+     * @default 'operation-log'
+     */
+    redisQueueName?: string;
+    /**
+     * ⭐️ 核心：业务方必须在此实现自己的写库逻辑。
+     * @param ctx 当前请求的 Koa Context
+     * @param logData 组件为你准备好的、脱敏且安全的日志数据
+     * @example
+     * ```typescript
+     * writeLog: async (ctx, logData) => {
+     *   await prisma.materialcode_oper_log.create({
+     *     data: {
+     *       title: logData.title,
+     *       method: logData.methodName,
+     *       params: logData.operParam,
+     *       // ... 其他字段映射
+     *     }
+     *   });
+     * }
+     * ```
+     */
+    writeLog: (ctx: Context, logData: CollectedLogData) => Promise<void> | void;
+}

package/dist/interface.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOGGING_KEY = void 0;
+exports.LOGGING_KEY = 'decorator:logging_key';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2ludGVyZmFjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFYSxRQUFBLFdBQVcsR0FBRyx1QkFBdUIsQ0FBQyJ9

package/dist/middleware/report.middleware.d.ts

@@ -0,0 +1,10 @@
+import type { IMiddleware } from '@midwayjs/core';
+import type { NextFunction, Context } from '@midwayjs/koa';
+import type { OperationLogConfig } from '../interface';
+import type { LogQueue } from '../queue/queue.interface';
+export declare class ReportMiddleware implements IMiddleware<Context, NextFunction> {
+    logConfig: OperationLogConfig;
+    logQueue: LogQueue;
+    resolve(): (ctx: Context, next: NextFunction) => Promise<any>;
+    static getName(): string;
+}

package/dist/middleware/report.middleware.js

@@ -0,0 +1,93 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportMiddleware = void 0;
+const core_1 = require("@midwayjs/core");
+const index_1 = require("../utils/index");
+const queue_interface_1 = require("../queue/queue.interface");
+let ReportMiddleware = class ReportMiddleware {
+    resolve() {
+        return async (ctx, next) => {
+            if (this.logConfig?.enable === false) {
+                return next();
+            }
+            const startTime = new Date();
+            const st = Date.now();
+            let operStatus = 0;
+            let errorMsg = null;
+            try {
+                await next();
+            }
+            catch (error) {
+                operStatus = 1;
+                errorMsg = error?.message || String(error);
+                throw error;
+            }
+            finally {
+                const logMeta = ctx.state?.__log_meta__;
+                if (logMeta) {
+                    const logCfg = (logMeta.options?.metadata?.log ?? {});
+                    const methodName = logMeta.methodName;
+                    const decoratorOn = logCfg.needLog !== false;
+                    if ((decoratorOn || operStatus === 1) && this.logQueue) {
+                        const network = (0, index_1.getNetworkInfo)(ctx);
+                        let jsonResult = null;
+                        if (logCfg.logResult !== false || operStatus === 1) {
+                            if (logCfg.logMode === 'summary') {
+                                jsonResult = (0, index_1.safeStringify)((0, index_1.summarize)(ctx.body, logCfg.maxSampleCount), logCfg.maxRawLength);
+                            }
+                            else {
+                                jsonResult = (0, index_1.safeStringify)(ctx.body, logCfg.maxRawLength);
+                            }
+                        }
+                        else {
+                            jsonResult = '[已按配置省略]';
+                        }
+                        const logData = {
+                            title: logCfg.title ?? '未命名操作',
+                            businessType: logCfg.businessType ?? 0,
+                            methodName: methodName,
+                            requestMethod: ctx.method,
+                            url: network.url,
+                            ip: network.ip,
+                            operParam: (0, index_1.sanitizeParams)(ctx, logCfg.collectSource ?? ['body', 'query', 'params']),
+                            jsonResult: jsonResult,
+                            operStatus,
+                            errorMsg,
+                            startTime,
+                            endTime: new Date(),
+                            costTime: Date.now() - st,
+                        };
+                        this.logQueue.push(ctx, logData).catch((err) => {
+                            ctx.logger.error('[OperationLog] 入队失败', err);
+                        });
+                    }
+                }
+            }
+        };
+    }
+    static getName() {
+        return 'reportMiddleware';
+    }
+};
+exports.ReportMiddleware = ReportMiddleware;
+__decorate([
+    (0, core_1.Config)('operationLog'),
+    __metadata("design:type", Object)
+], ReportMiddleware.prototype, "logConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(queue_interface_1.LOG_QUEUE_TOKEN),
+    __metadata("design:type", Object)
+], ReportMiddleware.prototype, "logQueue", void 0);
+exports.ReportMiddleware = ReportMiddleware = __decorate([
+    (0, core_1.Middleware)()
+], ReportMiddleware);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVwb3J0Lm1pZGRsZXdhcmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbWlkZGxld2FyZS9yZXBvcnQubWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSx5Q0FBNEQ7QUFJNUQsMENBQTBGO0FBQzFGLDhEQUEyRDtBQUlwRCxJQUFNLGdCQUFnQixHQUF0QixNQUFNLGdCQUFnQjtJQU96QixPQUFPO1FBQ0gsT0FBTyxLQUFLLEVBQUUsR0FBWSxFQUFFLElBQWtCLEVBQUUsRUFBRTtZQUM5QyxJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUUsTUFBTSxLQUFLLEtBQUssRUFBRSxDQUFDO2dCQUNuQyxPQUFPLElBQUksRUFBRSxDQUFDO1lBQ2xCLENBQUM7WUFFRCxNQUFNLFNBQVMsR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1lBQzdCLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUN0QixJQUFJLFVBQVUsR0FBRyxDQUFDLENBQUM7WUFDbkIsSUFBSSxRQUFRLEdBQWtCLElBQUksQ0FBQztZQUVuQyxJQUFJLENBQUM7Z0JBQ0QsTUFBTSxJQUFJLEVBQUUsQ0FBQztZQUNqQixDQUFDO1lBQUMsT0FBTyxLQUFVLEVBQUUsQ0FBQztnQkFDbEIsVUFBVSxHQUFHLENBQUMsQ0FBQztnQkFDZixRQUFRLEdBQUcsS0FBSyxFQUFFLE9BQU8sSUFBSSxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7Z0JBQzNDLE1BQU0sS0FBSyxDQUFDO1lBQ2hCLENBQUM7b0JBQVMsQ0FBQztnQkFDUCxNQUFNLE9BQU8sR0FBRyxHQUFHLENBQUMsS0FBSyxFQUFFLFlBQVksQ0FBQztnQkFDeEMsSUFBSSxPQUFPLEVBQUUsQ0FBQztvQkFDVixNQUFNLE1BQU0sR0FBRyxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLEdBQUcsSUFBSSxFQUFFLENBQWUsQ0FBQztvQkFDcEUsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQztvQkFDdEMsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLE9BQU8sS0FBSyxLQUFLLENBQUM7b0JBRTdDLElBQUksQ0FBQyxXQUFXLElBQUksVUFBVSxLQUFLLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQzt3QkFDckQsTUFBTSxPQUFPLEdBQUcsSUFBQSxzQkFBYyxFQUFDLEdBQUcsQ0FBQyxDQUFDO3dCQUNwQyxJQUFJLFVBQVUsR0FBRyxJQUFJLENBQUM7d0JBRXRCLElBQUksTUFBTSxDQUFDLFNBQVMsS0FBSyxLQUFLLElBQUksVUFBVSxLQUFLLENBQUMsRUFBRSxDQUFDOzRCQUNqRCxJQUFJLE1BQU0sQ0FBQyxPQUFPLEtBQUssU0FBUyxFQUFFLENBQUM7Z0NBQy9CLFVBQVUsR0FBRyxJQUFBLHFCQUFhLEVBQUMsSUFBQSxpQkFBUyxFQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLGNBQWMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQzs0QkFDaEcsQ0FBQztpQ0FBTSxDQUFDO2dDQUNKLFVBQVUsR0FBRyxJQUFBLHFCQUFhLEVBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7NEJBQzlELENBQUM7d0JBQ0wsQ0FBQzs2QkFBTSxDQUFDOzRCQUNKLFVBQVUsR0FBRyxVQUFVLENBQUM7d0JBQzVCLENBQUM7d0JBRUQsTUFBTSxPQUFPLEdBQXFCOzRCQUM5QixLQUFLLEVBQUUsTUFBTSxDQUFDLEtBQUssSUFBSSxPQUFPOzRCQUM5QixZQUFZLEVBQUUsTUFBTSxDQUFDLFlBQVksSUFBSSxDQUFDOzRCQUN0QyxVQUFVLEVBQUUsVUFBVTs0QkFDdEIsYUFBYSxFQUFFLEdBQUcsQ0FBQyxNQUFNOzRCQUN6QixHQUFHLEVBQUUsT0FBTyxDQUFDLEdBQUc7NEJBQ2hCLEVBQUUsRUFBRSxPQUFPLENBQUMsRUFBRTs0QkFDZCxTQUFTLEVBQUUsSUFBQSxzQkFBYyxFQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsYUFBYSxJQUFJLENBQUMsTUFBTSxFQUFFLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQzs0QkFDbkYsVUFBVSxFQUFFLFVBQVU7NEJBQ3RCLFVBQVU7NEJBQ1YsUUFBUTs0QkFDUixTQUFTOzRCQUNULE9BQU8sRUFBRSxJQUFJLElBQUksRUFBRTs0QkFDbkIsUUFBUSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFO3lCQUM1QixDQUFDO3dCQUVGLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFHLEVBQUUsRUFBRTs0QkFDM0MsR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMscUJBQXFCLEVBQUUsR0FBRyxDQUFDLENBQUM7d0JBQ2pELENBQUMsQ0FBQyxDQUFDO29CQUNQLENBQUM7Z0JBQ0wsQ0FBQztZQUNMLENBQUM7UUFDTCxDQUFDLENBQUM7SUFDTixDQUFDO0lBRUQsTUFBTSxDQUFDLE9BQU87UUFDVixPQUFPLGtCQUFrQixDQUFDO0lBQzlCLENBQUM7Q0FDSixDQUFBO0FBekVZLDRDQUFnQjtBQUV6QjtJQURDLElBQUEsYUFBTSxFQUFDLGNBQWMsQ0FBQzs7bURBQ087QUFHOUI7SUFEQyxJQUFBLGFBQU0sRUFBQyxpQ0FBZSxDQUFDOztrREFDTDsyQkFMVixnQkFBZ0I7SUFENUIsSUFBQSxpQkFBVSxHQUFFO0dBQ0EsZ0JBQWdCLENBeUU1QiJ9

package/dist/queue/memory.queue.d.ts

@@ -0,0 +1,14 @@
+import type { ILogger } from '@midwayjs/core';
+import { type LogQueue } from './queue.interface';
+import type { CollectedLogData, OperationLogConfig } from '../interface';
+export declare class MemoryLogQueue implements LogQueue {
+    logConfig: OperationLogConfig;
+    logger: ILogger;
+    private tasks;
+    private isProcessing;
+    private timer;
+    init(): Promise<void>;
+    push(ctx: any, logData: CollectedLogData): Promise<void>;
+    private process;
+    destroy(): Promise<void>;
+}

package/dist/queue/memory.queue.js

@@ -0,0 +1,80 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryLogQueue = void 0;
+const core_1 = require("@midwayjs/core");
+const queue_interface_1 = require("./queue.interface");
+let MemoryLogQueue = class MemoryLogQueue {
+    constructor() {
+        this.tasks = [];
+        this.isProcessing = false;
+    }
+    async init() {
+        this.timer = setInterval(() => this.process(), 1000);
+    }
+    async push(ctx, logData) {
+        this.tasks.push({ ctx, data: logData });
+        this.process();
+    }
+    async process() {
+        if (this.isProcessing || this.tasks.length === 0)
+            return;
+        this.isProcessing = true;
+        const batch = this.tasks.splice(0, 50);
+        try {
+            for (const item of batch) {
+                if (typeof this.logConfig.writeLog === 'function') {
+                    await this.logConfig.writeLog(item.ctx, item.data);
+                }
+            }
+        }
+        catch (err) {
+            this.logger.error('[OperationLog] 内存队列写入日志失败', err);
+        }
+        finally {
+            this.isProcessing = false;
+            if (this.tasks.length > 0)
+                setImmediate(() => this.process());
+        }
+    }
+    async destroy() {
+        clearInterval(this.timer);
+        while (this.tasks.length > 0) {
+            await this.process();
+        }
+    }
+};
+exports.MemoryLogQueue = MemoryLogQueue;
+__decorate([
+    (0, core_1.Config)('operationLog'),
+    __metadata("design:type", Object)
+], MemoryLogQueue.prototype, "logConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", Object)
+], MemoryLogQueue.prototype, "logger", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], MemoryLogQueue.prototype, "init", null);
+__decorate([
+    (0, core_1.Destroy)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], MemoryLogQueue.prototype, "destroy", null);
+exports.MemoryLogQueue = MemoryLogQueue = __decorate([
+    (0, core_1.Provide)(queue_interface_1.LOG_QUEUE_TOKEN),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], MemoryLogQueue);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWVtb3J5LnF1ZXVlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXVlL21lbW9yeS5xdWV1ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSx5Q0FBMEY7QUFFMUYsdURBQW1FO0FBSzVELElBQU0sY0FBYyxHQUFwQixNQUFNLGNBQWM7SUFBcEI7UUFPSyxVQUFLLEdBQWdELEVBQUUsQ0FBQztRQUN4RCxpQkFBWSxHQUFHLEtBQUssQ0FBQztJQXNDakMsQ0FBQztJQWxDUyxBQUFOLEtBQUssQ0FBQyxJQUFJO1FBQ04sSUFBSSxDQUFDLEtBQUssR0FBRyxXQUFXLENBQUMsR0FBRyxFQUFFLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3pELENBQUM7SUFFRCxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQVEsRUFBRSxPQUF5QjtRQUMxQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQztRQUN4QyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDbkIsQ0FBQztJQUVPLEtBQUssQ0FBQyxPQUFPO1FBQ2pCLElBQUksSUFBSSxDQUFDLFlBQVksSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDO1lBQUUsT0FBTztRQUN6RCxJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksQ0FBQztRQUN6QixNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDdkMsSUFBSSxDQUFDO1lBQ0QsS0FBSyxNQUFNLElBQUksSUFBSSxLQUFLLEVBQUUsQ0FBQztnQkFDdkIsSUFBSSxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsUUFBUSxLQUFLLFVBQVUsRUFBRSxDQUFDO29CQUNoRCxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUN2RCxDQUFDO1lBQ0wsQ0FBQztRQUNMLENBQUM7UUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1lBQ1gsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsMkJBQTJCLEVBQUUsR0FBRyxDQUFDLENBQUM7UUFDeEQsQ0FBQztnQkFBUyxDQUFDO1lBQ1AsSUFBSSxDQUFDLFlBQVksR0FBRyxLQUFLLENBQUM7WUFDMUIsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDO2dCQUFFLFlBQVksQ0FBQyxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztRQUNsRSxDQUFDO0lBQ0wsQ0FBQztJQUdLLEFBQU4sS0FBSyxDQUFDLE9BQU87UUFDVCxhQUFhLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzFCLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDM0IsTUFBTSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDekIsQ0FBQztJQUNMLENBQUM7Q0FDSixDQUFBO0FBOUNZLHdDQUFjO0FBRXZCO0lBREMsSUFBQSxhQUFNLEVBQUMsY0FBYyxDQUFDOztpREFDTztBQUc5QjtJQURDLElBQUEsYUFBTSxHQUFFOzs4Q0FDTztBQU9WO0lBREwsSUFBQSxXQUFJLEdBQUU7Ozs7MENBR047QUEwQks7SUFETCxJQUFBLGNBQU8sR0FBRTs7Ozs2Q0FNVDt5QkE3Q1EsY0FBYztJQUYxQixJQUFBLGNBQU8sRUFBQyxpQ0FBZSxDQUFDO0lBQ3hCLElBQUEsWUFBSyxFQUFDLGdCQUFTLENBQUMsU0FBUyxDQUFDO0dBQ2QsY0FBYyxDQThDMUIifQ==

package/dist/queue/queue.interface.d.ts

@@ -0,0 +1,5 @@
+import type { CollectedLogData } from '../interface';
+export declare const LOG_QUEUE_TOKEN = "LOG_QUEUE_TOKEN";
+export interface LogQueue {
+    push(ctx: any, logData: CollectedLogData): Promise<void>;
+}

package/dist/queue/queue.interface.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG_QUEUE_TOKEN = void 0;
+exports.LOG_QUEUE_TOKEN = 'LOG_QUEUE_TOKEN';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuaW50ZXJmYWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXVlL3F1ZXVlLmludGVyZmFjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFYSxRQUFBLGVBQWUsR0FBRyxpQkFBaUIsQ0FBQyJ9

package/dist/queue/redis.queue.d.ts

@@ -0,0 +1,8 @@
+import type { LogQueue } from './queue.interface';
+import type { CollectedLogData, OperationLogConfig } from '../interface';
+import * as bullmq from '@midwayjs/bullmq';
+export declare class RedisLogQueue implements LogQueue {
+    logConfig: OperationLogConfig;
+    bullmqFramework: bullmq.Framework;
+    push(ctx: any, logData: CollectedLogData): Promise<void>;
+}

package/dist/queue/redis.queue.js

@@ -0,0 +1,75 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisLogQueue = void 0;
+const core_1 = require("@midwayjs/core");
+const bullmq = __importStar(require("@midwayjs/bullmq"));
+let RedisLogQueue = class RedisLogQueue {
+    ;
+    async push(ctx, logData) {
+        if (!this.bullmqFramework) {
+            throw new Error('请安装并配置 @midwayjs/bullmq 以使用 Redis 模式');
+        }
+        const queueName = this.logConfig.redisQueueName || 'operation-log';
+        const queue = this.bullmqFramework.getQueue(queueName);
+        await queue.add('write-log', logData, {
+            attempts: 3,
+            backoff: { type: 'exponential', delay: 1000 },
+        });
+    }
+};
+exports.RedisLogQueue = RedisLogQueue;
+__decorate([
+    (0, core_1.Config)('operationLog'),
+    __metadata("design:type", Object)
+], RedisLogQueue.prototype, "logConfig", void 0);
+__decorate([
+    (0, core_1.Inject)('bullmqFramework'),
+    __metadata("design:type", bullmq.Framework)
+], RedisLogQueue.prototype, "bullmqFramework", void 0);
+exports.RedisLogQueue = RedisLogQueue = __decorate([
+    (0, core_1.Provide)('RedisLogQueue'),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], RedisLogQueue);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkaXMucXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcXVldWUvcmVkaXMucXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEseUNBQTJFO0FBRzNFLHlEQUEyQztBQUlwQyxJQUFNLGFBQWEsR0FBbkIsTUFBTSxhQUFhO0lBS1ksQ0FBQztJQUVuQyxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQVEsRUFBRSxPQUF5QjtRQUMxQyxJQUFJLENBQUMsSUFBSSxDQUFDLGVBQWUsRUFBRSxDQUFDO1lBQ3hCLE1BQU0sSUFBSSxLQUFLLENBQUMsc0NBQXNDLENBQUMsQ0FBQztRQUM1RCxDQUFDO1FBQ0QsTUFBTSxTQUFTLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLElBQUksZUFBZSxDQUFDO1FBQ25FLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBRXZELE1BQU0sS0FBSyxDQUFDLEdBQUcsQ0FBQyxXQUFXLEVBQUUsT0FBTyxFQUFFO1lBQ2xDLFFBQVEsRUFBRSxDQUFDO1lBQ1gsT0FBTyxFQUFFLEVBQUUsSUFBSSxFQUFFLGFBQWEsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFO1NBQ2hELENBQUMsQ0FBQztJQUNQLENBQUM7Q0FDSixDQUFBO0FBbkJZLHNDQUFhO0FBRXRCO0lBREMsSUFBQSxhQUFNLEVBQUMsY0FBYyxDQUFDOztnREFDTztBQUc5QjtJQURDLElBQUEsYUFBTSxFQUFDLGlCQUFpQixDQUFDOzhCQUNULE1BQU0sQ0FBQyxTQUFTO3NEQUFDO3dCQUx6QixhQUFhO0lBRnpCLElBQUEsY0FBTyxFQUFDLGVBQWUsQ0FBQztJQUN4QixJQUFBLFlBQUssRUFBQyxnQkFBUyxDQUFDLFNBQVMsQ0FBQztHQUNkLGFBQWEsQ0FtQnpCIn0=

package/dist/utils/index.d.ts

@@ -0,0 +1,8 @@
+import type { Context } from '@midwayjs/koa';
+export declare function getNetworkInfo(ctx: Context): {
+    ip: any;
+    url: string;
+};
+export declare function safeStringify(obj: any, maxLen?: number): string | null;
+export declare function sanitizeParams(ctx: Context, sources: string[]): string | null;
+export declare function summarize(data: any, maxSample?: number): any;

package/dist/utils/index.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetworkInfo = getNetworkInfo;
+exports.safeStringify = safeStringify;
+exports.sanitizeParams = sanitizeParams;
+exports.summarize = summarize;
+function getNetworkInfo(ctx) {
+    const protocol = ctx.get('X-Forwarded-Proto') || ctx.protocol;
+    const host = ctx.get('X-Forwarded-Host') || ctx.host;
+    return {
+        ip: ctx.request.ip || ctx.ip || 'unknown',
+        url: `${protocol}://${host}${ctx.originalUrl}`,
+    };
+}
+function safeStringify(obj, maxLen = 8000) {
+    if (obj === undefined || obj === null)
+        return null;
+    const cache = new Set();
+    try {
+        const str = JSON.stringify(obj, (key, value) => {
+            if (typeof value === 'bigint')
+                return value.toString();
+            if (value instanceof Map)
+                return Object.fromEntries(value);
+            if (value instanceof Date)
+                return value.toISOString();
+            if (typeof value === 'object' && value !== null) {
+                if (cache.has(value))
+                    return '[Circular]';
+                cache.add(value);
+            }
+            return value;
+        });
+        return str.length > maxLen ? str.slice(0, maxLen) + '...' : str;
+    }
+    catch (e) {
+        return '[序列化失败]';
+    }
+}
+function sanitizeParams(ctx, sources) {
+    const combined = {};
+    if (sources.includes('params'))
+        combined.params = { ...ctx.params };
+    if (sources.includes('query'))
+        combined.query = { ...ctx.query };
+    if (sources.includes('body'))
+        combined.body = ctx.request.body ?? null;
+    const SENSITIVE = ['password', 'token', 'secret', 'authorization', 'cvv'];
+    const mask = (obj) => {
+        if (!obj || typeof obj !== 'object')
+            return;
+        for (const key of Object.keys(obj)) {
+            if (SENSITIVE.includes(key.toLowerCase()))
+                obj[key] = '******';
+            else if (typeof obj[key] === 'object')
+                mask(obj[key]);
+        }
+    };
+    mask(combined);
+    return safeStringify(combined);
+}
+function summarize(data, maxSample = 3) {
+    if (Array.isArray(data)) {
+        if (data.length <= maxSample)
+            return data.map(v => summarize(v, maxSample));
+        return {
+            __summarized__: true,
+            total: data.length,
+            sample: data.slice(0, maxSample).map(v => summarize(v, maxSample)),
+        };
+    }
+    if (data && typeof data === 'object') {
+        const out = {};
+        for (const k of Object.keys(data))
+            out[k] = summarize(data[k], maxSample);
+        return out;
+    }
+    return data;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQSx3Q0FPQztBQUVELHNDQWtCQztBQUVELHdDQWdCQztBQUVELDhCQWVDO0FBOURELFNBQWdCLGNBQWMsQ0FBQyxHQUFZO0lBQ3ZDLE1BQU0sUUFBUSxHQUFHLEdBQUcsQ0FBQyxHQUFHLENBQUMsbUJBQW1CLENBQUMsSUFBSSxHQUFHLENBQUMsUUFBUSxDQUFDO0lBQzlELE1BQU0sSUFBSSxHQUFHLEdBQUcsQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsSUFBSSxHQUFHLENBQUMsSUFBSSxDQUFDO0lBQ3JELE9BQU87UUFDSCxFQUFFLEVBQUcsR0FBRyxDQUFDLE9BQWUsQ0FBQyxFQUFFLElBQUksR0FBRyxDQUFDLEVBQUUsSUFBSSxTQUFTO1FBQ2xELEdBQUcsRUFBRSxHQUFHLFFBQVEsTUFBTSxJQUFJLEdBQUcsR0FBRyxDQUFDLFdBQVcsRUFBRTtLQUNqRCxDQUFDO0FBQ04sQ0FBQztBQUVELFNBQWdCLGFBQWEsQ0FBQyxHQUFRLEVBQUUsTUFBTSxHQUFHLElBQUk7SUFDakQsSUFBSSxHQUFHLEtBQUssU0FBUyxJQUFJLEdBQUcsS0FBSyxJQUFJO1FBQUUsT0FBTyxJQUFJLENBQUM7SUFDbkQsTUFBTSxLQUFLLEdBQUcsSUFBSSxHQUFHLEVBQUUsQ0FBQztJQUN4QixJQUFJLENBQUM7UUFDRCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLEdBQUcsRUFBRSxDQUFDLEdBQUcsRUFBRSxLQUFLLEVBQUUsRUFBRTtZQUMzQyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVE7Z0JBQUUsT0FBTyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDdkQsSUFBSSxLQUFLLFlBQVksR0FBRztnQkFBRSxPQUFPLE1BQU0sQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDM0QsSUFBSSxLQUFLLFlBQVksSUFBSTtnQkFBRSxPQUFPLEtBQUssQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUN0RCxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxLQUFLLEtBQUssSUFBSSxFQUFFLENBQUM7Z0JBQzlDLElBQUksS0FBSyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUM7b0JBQUUsT0FBTyxZQUFZLENBQUM7Z0JBQzFDLEtBQUssQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDckIsQ0FBQztZQUNELE9BQU8sS0FBSyxDQUFDO1FBQ2pCLENBQUMsQ0FBQyxDQUFDO1FBQ0gsT0FBTyxHQUFHLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsTUFBTSxDQUFDLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7SUFDcEUsQ0FBQztJQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7UUFDVCxPQUFPLFNBQVMsQ0FBQztJQUNyQixDQUFDO0FBQ0wsQ0FBQztBQUVELFNBQWdCLGNBQWMsQ0FBQyxHQUFZLEVBQUUsT0FBaUI7SUFDMUQsTUFBTSxRQUFRLEdBQXdCLEVBQUUsQ0FBQztJQUN6QyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDO1FBQUUsUUFBUSxDQUFDLE1BQU0sR0FBRyxFQUFFLEdBQUcsR0FBRyxDQUFDLE1BQU0sRUFBRSxDQUFDO0lBQ3BFLElBQUksT0FBTyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUM7UUFBRSxRQUFRLENBQUMsS0FBSyxHQUFHLEVBQUUsR0FBRyxHQUFHLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDakUsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQztRQUFFLFFBQVEsQ0FBQyxJQUFJLEdBQUcsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksSUFBSSxDQUFDO0lBRXZFLE1BQU0sU0FBUyxHQUFHLENBQUMsVUFBVSxFQUFFLE9BQU8sRUFBRSxRQUFRLEVBQUUsZUFBZSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQzFFLE1BQU0sSUFBSSxHQUFHLENBQUMsR0FBUSxFQUFFLEVBQUU7UUFDdEIsSUFBSSxDQUFDLEdBQUcsSUFBSSxPQUFPLEdBQUcsS0FBSyxRQUFRO1lBQUUsT0FBTztRQUM1QyxLQUFLLE1BQU0sR0FBRyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNqQyxJQUFJLFNBQVMsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLFdBQVcsRUFBRSxDQUFDO2dCQUFFLEdBQUcsQ0FBQyxHQUFHLENBQUMsR0FBRyxRQUFRLENBQUM7aUJBQzFELElBQUksT0FBTyxHQUFHLENBQUMsR0FBRyxDQUFDLEtBQUssUUFBUTtnQkFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7UUFDMUQsQ0FBQztJQUNMLENBQUMsQ0FBQztJQUNGLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNmLE9BQU8sYUFBYSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ25DLENBQUM7QUFFRCxTQUFnQixTQUFTLENBQUMsSUFBUyxFQUFFLFNBQVMsR0FBRyxDQUFDO0lBQzlDLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQ3RCLElBQUksSUFBSSxDQUFDLE1BQU0sSUFBSSxTQUFTO1lBQUUsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsU0FBUyxDQUFDLENBQUMsRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO1FBQzVFLE9BQU87WUFDSCxjQUFjLEVBQUUsSUFBSTtZQUNwQixLQUFLLEVBQUUsSUFBSSxDQUFDLE1BQU07WUFDbEIsTUFBTSxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLFNBQVMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLFNBQVMsQ0FBQyxDQUFDLEVBQUUsU0FBUyxDQUFDLENBQUM7U0FDckUsQ0FBQztJQUNOLENBQUM7SUFDRCxJQUFJLElBQUksSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUNuQyxNQUFNLEdBQUcsR0FBUSxFQUFFLENBQUM7UUFDcEIsS0FBSyxNQUFNLENBQUMsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUFFLEdBQUcsQ0FBQyxDQUFDLENBQUMsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBQzFFLE9BQU8sR0FBRyxDQUFDO0lBQ2YsQ0FBQztJQUNELE9BQU8sSUFBSSxDQUFDO0FBQ2hCLENBQUMifQ==

package/index.d.ts

@@ -0,0 +1,7 @@
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    operationLog?: import('./dist/interface').OperationLogConfig;
+  }
+}

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@jiangnian520/midway-operation-log",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "mwtsc --cleanOutDir"
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@midwayjs/core": ">=4.0.0",
+    "@midwayjs/koa": ">=4.0.0",
+    "@midwayjs/bullmq": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@midwayjs/bullmq": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@midwayjs/core": "^4.0.0",
+    "@midwayjs/koa": "^4.0.0",
+    "@midwayjs/bullmq": "^4.0.0",
+    "@types/node": "^20.0.0",
+    "mwtsc": "^1.4.0",
+    "typescript": "^5.3.0"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.