@tsed/platform-log-middleware 8.0.0-alpha.5 → 8.0.0-alpha.6

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@tsed/platform-log-middleware",
   "description": "Log request middleware module for Ts.ED Framework",
-  "type": "commonjs",
-  "version": "8.0.0-alpha.5",
+  "type": "module",
+  "version": "8.0.0-alpha.6",
   "source": "./src/index.ts",
-  "main": "./lib/cjs/index.js",
+  "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
-      "require": "./lib/cjs/index.js",
       "default": "./lib/cjs/index.js"
     }
   },
@@ -26,19 +25,19 @@
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.0.0-alpha.5",
-    "@tsed/di": "8.0.0-alpha.5",
-    "@tsed/platform-middlewares": "8.0.0-alpha.5",
-    "@tsed/platform-params": "8.0.0-alpha.5",
-    "@tsed/typescript": "8.0.0-alpha.5",
+    "@tsed/barrels": "8.0.0-alpha.6",
+    "@tsed/di": "8.0.0-alpha.6",
+    "@tsed/platform-middlewares": "8.0.0-alpha.6",
+    "@tsed/platform-params": "8.0.0-alpha.6",
+    "@tsed/typescript": "8.0.0-alpha.6",
     "eslint": "^8.57.0",
     "typescript": "4.9.5",
     "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/di": "8.0.0-alpha.5",
-    "@tsed/platform-middlewares": "8.0.0-alpha.5",
-    "@tsed/platform-params": "8.0.0-alpha.5"
+    "@tsed/di": "8.0.0-alpha.6",
+    "@tsed/platform-middlewares": "8.0.0-alpha.6",
+    "@tsed/platform-params": "8.0.0-alpha.6"
   },
   "peerDependenciesMeta": {
     "@tsed/di": {

package/lib/cjs/domain/PlatformLogMiddlewareSettings.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=PlatformLogMiddlewareSettings.js.map

package/lib/cjs/domain/PlatformLogMiddlewareSettings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformLogMiddlewareSettings.js","sourceRoot":"","sources":["../../../src/domain/PlatformLogMiddlewareSettings.ts"],"names":[],"mappings":""}

package/lib/cjs/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-tslib_1.__exportStar(require("./domain/PlatformLogMiddlewareSettings.js"), exports);
-tslib_1.__exportStar(require("./middlewares/PlatformLogMiddleware.js"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,oFAA0D;AAC1D,iFAAuD"}

package/lib/cjs/middlewares/PlatformLogMiddleware.js

@@ -1,166 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlatformLogMiddleware = void 0;
-const tslib_1 = require("tslib");
-const core_1 = require("@tsed/core");
-const di_1 = require("@tsed/di");
-const platform_middlewares_1 = require("@tsed/platform-middlewares");
-const platform_params_1 = require("@tsed/platform-params");
-/**
- * @middleware
- * @platform
- */
-let PlatformLogMiddleware = class PlatformLogMiddleware {
-    get settings() {
-        return this;
-    }
-    /**
-     * Handle the request.
-     */
-    use(ctx) {
-        this.configureRequest(ctx);
-        this.onLogStart(ctx);
-        ctx.response.onEnd(() => this.onLogEnd(ctx));
-    }
-    /**
-     * Called when the `$onResponse` is called by Ts.ED (through Express.end).
-     */
-    onLogEnd(ctx) {
-        const { logRequest, logEnd, logLevel } = this.settings;
-        const started = ctx.logStarted;
-        if (logEnd && started) {
-            if (ctx.response.statusCode >= 400) {
-                const error = ctx.error;
-                ctx.logger.error({
-                    event: "request.end",
-                    status: ctx.response.statusCode,
-                    status_code: String(ctx.response.statusCode),
-                    state: "KO",
-                    ...(0, core_1.cleanObject)({
-                        error_name: error?.name || error?.code,
-                        error_message: error?.message,
-                        error_errors: error?.errors,
-                        error_stack: error?.stack,
-                        error_body: error?.body,
-                        error_headers: error?.headers
-                    })
-                });
-            }
-            else {
-                if (logLevel === "debug") {
-                    ctx.logger.debug({
-                        event: "request.end",
-                        status: ctx.response.statusCode,
-                        status_code: String(ctx.response.statusCode),
-                        data: ctx.data,
-                        state: "OK"
-                    });
-                }
-                else if (logRequest) {
-                    ctx.logger.info({
-                        event: "request.end",
-                        status: ctx.response.statusCode,
-                        status_code: String(ctx.response.statusCode),
-                        state: "OK"
-                    });
-                }
-            }
-        }
-    }
-    /**
-     * The separate onLogStart() function will allow developer to overwrite the initial request log.
-     * @param ctx
-     */
-    onLogStart(ctx) {
-        const { logRequest, logLevel, logStart } = this.settings;
-        ctx.logStarted = true;
-        if (logStart) {
-            if (logLevel === "debug") {
-                ctx.logger.debug({
-                    event: "request.start"
-                });
-            }
-            else if (logRequest) {
-                ctx.logger.info({
-                    event: "request.start"
-                });
-            }
-        }
-    }
-    /**
-     * Attach all information that will be necessary to log the request. Attach a new `request.log` object.
-     */
-    configureRequest(ctx) {
-        ctx.logger.alterLog((obj, level, withRequest) => {
-            switch (level) {
-                case "info":
-                    return { ...this.minimalRequestPicker(ctx), ...obj };
-                case "debug":
-                    return withRequest ? { ...this.requestToObject(ctx), ...obj } : obj;
-                default:
-                    return { ...this.requestToObject(ctx), ...obj };
-            }
-        });
-    }
-    /**
-     * Return complete request info.
-     * @returns {Object}
-     * @param ctx
-     */
-    requestToObject(ctx) {
-        const { request } = ctx;
-        return {
-            method: request.method,
-            url: request.url,
-            route: request.route || request.url,
-            headers: request.headers,
-            body: request.body,
-            query: request.query,
-            params: request.params
-        };
-    }
-    /**
-     * Return a filtered request from global configuration.
-     * @returns {Object}
-     * @param ctx
-     */
-    minimalRequestPicker(ctx) {
-        const { requestFields } = this;
-        const info = this.requestToObject(ctx);
-        return requestFields.reduce((acc, key) => {
-            acc[key] = info[key];
-            return acc;
-        }, {});
-    }
-};
-tslib_1.__decorate([
-    (0, di_1.Constant)("logger.requestFields", ["reqId", "method", "url", "duration", "route"]),
-    tslib_1.__metadata("design:type", Array)
-], PlatformLogMiddleware.prototype, "requestFields", void 0);
-tslib_1.__decorate([
-    (0, di_1.Constant)("logger.logRequest", true),
-    tslib_1.__metadata("design:type", Boolean)
-], PlatformLogMiddleware.prototype, "logRequest", void 0);
-tslib_1.__decorate([
-    (0, di_1.Constant)("logger.logStart", true),
-    tslib_1.__metadata("design:type", Boolean)
-], PlatformLogMiddleware.prototype, "logStart", void 0);
-tslib_1.__decorate([
-    (0, di_1.Constant)("logger.logEnd", true),
-    tslib_1.__metadata("design:type", Boolean)
-], PlatformLogMiddleware.prototype, "logEnd", void 0);
-tslib_1.__decorate([
-    (0, di_1.Constant)("logger.level"),
-    tslib_1.__metadata("design:type", String)
-], PlatformLogMiddleware.prototype, "logLevel", void 0);
-tslib_1.__decorate([
-    tslib_1.__param(0, (0, platform_params_1.Context)()),
-    tslib_1.__metadata("design:type", Function),
-    tslib_1.__metadata("design:paramtypes", [Object]),
-    tslib_1.__metadata("design:returntype", void 0)
-], PlatformLogMiddleware.prototype, "use", null);
-PlatformLogMiddleware = tslib_1.__decorate([
-    (0, platform_middlewares_1.Middleware)()
-], PlatformLogMiddleware);
-exports.PlatformLogMiddleware = PlatformLogMiddleware;
-//# sourceMappingURL=PlatformLogMiddleware.js.map

package/lib/cjs/middlewares/PlatformLogMiddleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformLogMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/PlatformLogMiddleware.ts"],"names":[],"mappings":";;;;AAAA,qCAAuC;AACvC,iCAAkC;AAClC,qEAAyE;AACzE,2DAA8C;AAG9C;;;GAGG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAgBhC,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,GAAG,CAAY,GAAY;QAChC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAErB,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,GAAY;QACnB,MAAM,EAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACrD,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,CAAC;QAE/B,IAAI,MAAM,IAAI,OAAO,EAAE;YACrB,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE;gBAClC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAwB,CAAC;gBAC3C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;oBACf,KAAK,EAAE,aAAa;oBACpB,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,UAAU;oBAC/B,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;oBAC5C,KAAK,EAAE,IAAI;oBACX,GAAG,IAAA,kBAAW,EAAC;wBACb,UAAU,EAAE,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,IAAI;wBACtC,aAAa,EAAE,KAAK,EAAE,OAAO;wBAC7B,YAAY,EAAE,KAAK,EAAE,MAAM;wBAC3B,WAAW,EAAE,KAAK,EAAE,KAAK;wBACzB,UAAU,EAAE,KAAK,EAAE,IAAI;wBACvB,aAAa,EAAE,KAAK,EAAE,OAAO;qBAC9B,CAAC;iBACH,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,QAAQ,KAAK,OAAO,EAAE;oBACxB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;wBACf,KAAK,EAAE,aAAa;wBACpB,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,UAAU;wBAC/B,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;wBAC5C,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAC;iBACJ;qBAAM,IAAI,UAAU,EAAE;oBACrB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;wBACd,KAAK,EAAE,aAAa;wBACpB,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,UAAU;wBAC/B,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;wBAC5C,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAC;iBACJ;aACF;SACF;IACH,CAAC;IAED;;;OAGG;IACO,UAAU,CAAC,GAAY;QAC/B,MAAM,EAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEvD,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEtB,IAAI,QAAQ,EAAE;YACZ,IAAI,QAAQ,KAAK,OAAO,EAAE;gBACxB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;oBACf,KAAK,EAAE,eAAe;iBACvB,CAAC,CAAC;aACJ;iBAAM,IAAI,UAAU,EAAE;gBACrB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;oBACd,KAAK,EAAE,eAAe;iBACvB,CAAC,CAAC;aACJ;SACF;IACH,CAAC;IAED;;OAEG;IACO,gBAAgB,CAAC,GAAY;QACrC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;YACnD,QAAQ,KAAK,EAAE;gBACb,KAAK,MAAM;oBACT,OAAO,EAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAC,CAAC;gBACrD,KAAK,OAAO;oBACV,OAAO,WAAW,CAAC,CAAC,CAAC,EAAC,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAC,CAAC,CAAC,CAAC,GAAG,CAAC;gBACpE;oBACE,OAAO,EAAC,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAC,CAAC;aACjD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACO,eAAe,CAAC,GAAY;QACpC,MAAM,EAAC,OAAO,EAAC,GAAG,GAAG,CAAC;QAEtB,OAAO;YACL,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG;YACnC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,GAAY;QACzC,MAAM,EAAC,aAAa,EAAC,GAAG,IAAI,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAEvC,OAAO,aAAc,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAW,EAAE,EAAE;YACrD,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YAErB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF,CAAA;AAlJC;IAAC,IAAA,aAAQ,EAAC,sBAAsB,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;;4DACrC;AAE7C;IAAC,IAAA,aAAQ,EAAC,mBAAmB,EAAE,IAAI,CAAC;;yDACN;AAE9B;IAAC,IAAA,aAAQ,EAAC,iBAAiB,EAAE,IAAI,CAAC;;uDACN;AAE5B;IAAC,IAAA,aAAQ,EAAC,eAAe,EAAE,IAAI,CAAC;;qDACN;AAE1B;IAAC,IAAA,aAAQ,EAAC,cAAc,CAAC;;uDACE;AAS3B;IAAY,mBAAA,IAAA,yBAAO,GAAE,CAAA;;;;gDAKpB;AA5BU,qBAAqB;IADjC,IAAA,iCAAU,GAAE;GACA,qBAAqB,CAmJjC;AAnJY,sDAAqB"}

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/lib/types-esm/domain/PlatformLogMiddlewareSettings.d.ts

@@ -1,25 +0,0 @@
-export type LoggerRequestFields = ("reqId" | "method" | "url" | "headers" | "body" | "query" | "params" | "duration" | string)[];
-export interface PlatformLogMiddlewareSettings {
-    /**
-     * Fields displayed when a request is logged. Possible values: `reqId`, `method`, `url`, `headers`, `body`, `query`,`params`, `duration`.
-     */
-    requestFields?: LoggerRequestFields;
-    /**
-     * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
-     */
-    logRequest?: boolean;
-    /**
-     * Log start of all incoming request. By default, is false
-     */
-    logStart?: boolean;
-    /**
-     * Log end of all incoming request. By default, is true
-     */
-    logEnd?: boolean;
-}
-declare global {
-    namespace TsED {
-        interface LoggerConfiguration extends Partial<PlatformLogMiddlewareSettings> {
-        }
-    }
-}

package/lib/types-esm/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./domain/PlatformLogMiddlewareSettings.js";
-export * from "./middlewares/PlatformLogMiddleware.js";

package/lib/types-esm/middlewares/PlatformLogMiddleware.d.ts

@@ -1,44 +0,0 @@
-import { MiddlewareMethods } from "@tsed/platform-middlewares";
-import { Context } from "@tsed/platform-params";
-import type { LoggerRequestFields } from "../domain/PlatformLogMiddlewareSettings.js";
-/**
- * @middleware
- * @platform
- */
-export declare class PlatformLogMiddleware implements MiddlewareMethods {
-    protected requestFields: LoggerRequestFields;
-    protected logRequest: boolean;
-    protected logStart: boolean;
-    protected logEnd: boolean;
-    protected logLevel: string;
-    get settings(): this;
-    /**
-     * Handle the request.
-     */
-    use(ctx: Context): void;
-    /**
-     * Called when the `$onResponse` is called by Ts.ED (through Express.end).
-     */
-    onLogEnd(ctx: Context): void;
-    /**
-     * The separate onLogStart() function will allow developer to overwrite the initial request log.
-     * @param ctx
-     */
-    protected onLogStart(ctx: Context): void;
-    /**
-     * Attach all information that will be necessary to log the request. Attach a new `request.log` object.
-     */
-    protected configureRequest(ctx: Context): void;
-    /**
-     * Return complete request info.
-     * @returns {Object}
-     * @param ctx
-     */
-    protected requestToObject(ctx: Context): any;
-    /**
-     * Return a filtered request from global configuration.
-     * @returns {Object}
-     * @param ctx
-     */
-    protected minimalRequestPicker(ctx: Context): any;
-}