@tsed/platform-log-request 8.0.0-alpha.10

package/lib/esm/domain/PlatformLogRequestSettings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PlatformLogRequestSettings.js.map

package/lib/esm/domain/PlatformLogRequestSettings.js.map

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

package/lib/esm/index.js

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./domain/PlatformLogRequestSettings.js";
+export * from "./services/PlatformLogRequestFactory.js";
+export * from "./utils/defaultAlterLog.js";
+export * from "./utils/defaultLogResponse.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC"}

package/lib/esm/services/PlatformLogRequestFactory.js

@@ -0,0 +1,32 @@
+import { Configuration, registerProvider } from "@tsed/di";
+import { defaultAlterLog } from "../utils/defaultAlterLog.js";
+import { defaultLogResponse } from "../utils/defaultLogResponse.js";
+function factory(configuration) {
+    const { logRequest = true, alterLog = defaultAlterLog, onLogResponse = defaultLogResponse } = configuration.get("logger");
+    return logRequest
+        ? {
+            alterLog,
+            onLogResponse
+        }
+        : null;
+}
+export const PlatformLogRequestFactory = Symbol.for("PLATFORM:LOGGER:REQUEST");
+registerProvider({
+    provide: PlatformLogRequestFactory,
+    deps: [Configuration],
+    useFactory: factory,
+    hooks: {
+        $onRequest(instance, $ctx) {
+            if (instance) {
+                $ctx.logger.alterLog((obj, level) => instance.alterLog(level, obj, $ctx));
+                $ctx.logStarted = true;
+            }
+        },
+        $onResponse(instance, $ctx) {
+            if (instance && $ctx.logStarted) {
+                instance.onLogResponse($ctx);
+            }
+        }
+    }
+});
+//# sourceMappingURL=PlatformLogRequestFactory.js.map

package/lib/esm/services/PlatformLogRequestFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformLogRequestFactory.js","sourceRoot":"","sources":["../../../src/services/PlatformLogRequestFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,aAAa,EAAE,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAE3E,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAElE,SAAS,OAAO,CAAC,aAA4B;IAC3C,MAAM,EACJ,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,eAAe,EAC1B,aAAa,GAAG,kBAAkB,EACnC,GAAG,aAAa,CAAC,GAAG,CAA2B,QAAQ,CAAC,CAAC;IAE1D,OAAO,UAAU;QACf,CAAC,CAAC;YACE,QAAQ;YACR,aAAa;SACd;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AAG/E,gBAAgB,CAAC;IACf,OAAO,EAAE,yBAAyB;IAClC,IAAI,EAAE,CAAC,aAAa,CAAC;IACrB,UAAU,EAAE,OAAO;IACnB,KAAK,EAAE;QACL,UAAU,CAAC,QAAoC,EAAE,IAAiB;YAChE,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC/E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACzB,CAAC;QACH,CAAC;QACD,WAAW,CAAC,QAAoC,EAAE,IAAiB;YACjE,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;KACF;CACF,CAAC,CAAC"}

package/lib/esm/utils/defaultAlterLog.js

@@ -0,0 +1,19 @@
+export function defaultAlterLog(level, obj, ctx) {
+    const minimalLog = {
+        method: ctx.request.method,
+        url: ctx.request.url,
+        route: ctx.request.route || ctx.request.url,
+        ...obj
+    };
+    if (level === "info") {
+        return minimalLog;
+    }
+    return {
+        ...minimalLog,
+        headers: ctx.request.headers,
+        body: ctx.request.body,
+        query: ctx.request.query,
+        params: ctx.request.params
+    };
+}
+//# sourceMappingURL=defaultAlterLog.js.map

package/lib/esm/utils/defaultAlterLog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultAlterLog.js","sourceRoot":"","sources":["../../../src/utils/defaultAlterLog.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,GAA4B,EAAE,GAAgB;IAC3F,MAAM,UAAU,GAAG;QACjB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM;QAC1B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG;QACpB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG;QAC3C,GAAG,GAAG;KACP,CAAC;IAEF,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO;QACL,GAAG,UAAU;QACb,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO;QAC5B,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI;QACtB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM;KAC3B,CAAC;AACJ,CAAC"}

package/lib/esm/utils/defaultLogResponse.js

@@ -0,0 +1,29 @@
+import { cleanObject } from "@tsed/core";
+export function defaultLogResponse($ctx) {
+    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",
+            ...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 {
+        $ctx.logger.info({
+            event: "request.end",
+            status: $ctx.response.statusCode,
+            status_code: String($ctx.response.statusCode),
+            state: "OK"
+        });
+    }
+}
+//# sourceMappingURL=defaultLogResponse.js.map

package/lib/esm/utils/defaultLogResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultLogResponse.js","sourceRoot":"","sources":["../../../src/utils/defaultLogResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAGvC,MAAM,UAAU,kBAAkB,CAAC,IAAiB;IAClD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAwB,CAAC;QAE5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAChB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;YAChC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC7C,KAAK,EAAE,IAAI;YACX,GAAG,WAAW,CAAC;gBACb,UAAU,EAAE,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,IAAI;gBACtC,aAAa,EAAE,KAAK,EAAE,OAAO;gBAC7B,YAAY,EAAE,KAAK,EAAE,MAAM;gBAC3B,WAAW,EAAE,KAAK,EAAE,KAAK;gBACzB,UAAU,EAAE,KAAK,EAAE,IAAI;gBACvB,aAAa,EAAE,KAAK,EAAE,OAAO;aAC9B,CAAC;SACH,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACf,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;YAChC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC7C,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/lib/types/domain/PlatformLogRequestSettings.d.ts

@@ -0,0 +1,22 @@
+import type { BaseContext } from "@tsed/di";
+export type AlterLogCallback = (level: "debug" | "info" | "warn" | "error" | "all", obj: Record<string, unknown>, ctx: BaseContext) => Record<string, unknown>;
+export interface PlatformLogRequestSettings {
+    /**
+     * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
+     */
+    logRequest?: boolean;
+    /**
+     * A function to alter the log object before it's logged.
+     */
+    alterLog?: AlterLogCallback;
+    /**
+     * A function to log the server response.
+     */
+    onLogResponse?: ($ctx: BaseContext) => void;
+}
+declare global {
+    namespace TsED {
+        interface LoggerConfiguration extends Partial<PlatformLogRequestSettings> {
+        }
+    }
+}

package/lib/types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./domain/PlatformLogRequestSettings.js";
+export * from "./services/PlatformLogRequestFactory.js";
+export * from "./utils/defaultAlterLog.js";
+export * from "./utils/defaultLogResponse.js";

package/lib/types/services/PlatformLogRequestFactory.d.ts

@@ -0,0 +1,9 @@
+import { type BaseContext, Configuration } from "@tsed/di";
+import { defaultAlterLog } from "../utils/defaultAlterLog.js";
+declare function factory(configuration: Configuration): {
+    alterLog: import("../index.js").AlterLogCallback | typeof defaultAlterLog;
+    onLogResponse: ($ctx: BaseContext) => void;
+} | null;
+export declare const PlatformLogRequestFactory: unique symbol;
+export type PlatformLogRequestFactory = ReturnType<typeof factory>;
+export {};

package/lib/types/utils/defaultAlterLog.d.ts

@@ -0,0 +1,14 @@
+import type { BaseContext } from "@tsed/di";
+export declare function defaultAlterLog(level: string, obj: Record<string, unknown>, ctx: BaseContext): {
+    method: any;
+    url: any;
+    route: any;
+} | {
+    headers: any;
+    body: any;
+    query: any;
+    params: any;
+    method: any;
+    url: any;
+    route: any;
+};

package/lib/types/utils/defaultLogResponse.d.ts

@@ -0,0 +1,2 @@
+import type { BaseContext } from "@tsed/di";
+export declare function defaultLogResponse($ctx: BaseContext): void;

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@tsed/platform-log-request",
+  "description": "Log request module for Ts.ED Framework (Express, Koa, Serverless)",
+  "type": "module",
+  "version": "8.0.0-alpha.10",
+  "source": "./src/index.ts",
+  "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",
+      "default": "./lib/cjs/index.js"
+    }
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn build:ts",
+    "barrels": "barrels",
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
+  },
+  "dependencies": {
+    "tslib": "2.7.0"
+  },
+  "devDependencies": {
+    "@tsed/barrels": "8.0.0-alpha.10",
+    "@tsed/di": "8.0.0-alpha.10",
+    "@tsed/platform-middlewares": "8.0.0-alpha.10",
+    "@tsed/platform-params": "8.0.0-alpha.10",
+    "@tsed/typescript": "8.0.0-alpha.10",
+    "eslint": "9.12.0",
+    "typescript": "5.4.5",
+    "vitest": "2.1.2"
+  },
+  "peerDependencies": {
+    "@tsed/di": "8.0.0-alpha.10",
+    "@tsed/platform-middlewares": "8.0.0-alpha.10",
+    "@tsed/platform-params": "8.0.0-alpha.10"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/platform-middlewares": {
+      "optional": false
+    },
+    "@tsed/platform-params": {
+      "optional": false
+    }
+  },
+  "repository": "https://github.com/tsedio/tsed",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/platform-log-request",
+  "author": "Romain Lenzotti",
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "alpha"
+  }
+}

package/readme.md

@@ -0,0 +1,184 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>@tsed/platform-log-request</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io/
+
+# Installation
+
+```bash
+npm install --save @tsed/platform-log-request
+```
+
+## Configuration
+
+```ts
+import {Configuration} from "@tsed/di";
+import "@tsed/platform-log-request";
+import {levels} from "@tsed/logger";
+
+@Configuration({
+  /**
+   * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
+   * @optional
+   */
+  // logRequest: true,
+  /**
+   * A function to alter the log object before it's logged.
+   * @optional
+   */
+  // alterLog: (level, data, $ctx) => {
+  //   /// see example above
+  // },
+  /**
+   * A function to alter the log object before it's logged.
+   * @optional
+   */
+  // onLogEnd? : ($ctx: BaseContext) => void;
+})
+class Server {}
+```
+
+## Alter log request
+
+By default, Ts.ED provide a default log object. You can alter this object by providing a function to the `alterLog` property.
+
+Here his the default implementation:
+
+```typescript
+export function defaultAlterLog(level: string, obj: Record<string, unknown>, ctx: BaseContext) {
+  const minimalLog = {
+    method: ctx.request.method,
+    url: ctx.request.url,
+    route: ctx.request.route || ctx.request.url,
+    ...obj
+  };
+
+  if (level === "info") {
+    return minimalLog;
+  }
+
+  return {
+    ...minimalLog,
+    headers: ctx.request.headers,
+    body: ctx.request.body,
+    query: ctx.request.query,
+    params: ctx.request.params
+  };
+}
+```
+
+Just give your own implementation to the `alterLog` property.
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/platform-log-request";
+import {customAlterLog} from "./utils/customAlterLog.js";
+
+@Configuration({
+  alterLog: customAlterLog
+})
+class Server {}
+```
+
+## Customize log response
+
+By default, Ts.ED provide a default log response implementation.
+
+Here his the default implementation:
+
+```typescript
+export function defaultLogResponse($ctx: BaseContext) {
+  if ($ctx.response.statusCode >= 400) {
+    const error = $ctx.error as any | undefined;
+
+    $ctx.logger.error({
+      event: "request.end",
+      status: $ctx.response.statusCode,
+      status_code: String($ctx.response.statusCode),
+      state: "KO",
+      ...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 {
+    $ctx.logger.info({
+      event: "request.end",
+      status: $ctx.response.statusCode,
+      status_code: String($ctx.response.statusCode),
+      state: "OK"
+    });
+  }
+}
+```
+
+Just give your own implementation to the `onLogResponse` property.
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/platform-log-request";
+import {customOnLogResponse} from "./utils/customOnLogResponse.js";
+
+@Configuration({
+  onLogResponse: customOnLogResponse
+})
+class Server {}
+```
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.io/contributing.html).
+
+<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2022 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 100,
+          branches: 100,
+          functions: 100,
+          lines: 100
+        }
+      }
+    }
+  }
+);