@lark-apaas/nestjs-logger 0.1.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/LICENSE +13 -0
  2. package/dist/index.cjs +15026 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +62 -0
  5. package/dist/index.d.ts +62 -0
  6. package/dist/index.js +15015 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +53 -0
package/dist/index.d.cts ADDED
@@ -0,0 +1,62 @@
1
+ import { LoggerService, LogLevel, NestMiddleware } from '@nestjs/common';
2
+ import { Logger } from 'pino';
3
+ import { Request, Response, NextFunction } from 'express';
4
+
5
+ interface RequestContextState {
6
+ requestId: string;
7
+ path?: string;
8
+ method?: string;
9
+ userId?: string;
10
+ appId?: string;
11
+ tenantId?: string;
12
+ ip?: string;
13
+ [key: string]: unknown;
14
+ }
15
+ declare class RequestContextService {
16
+ private readonly storage;
17
+ run<T>(context: RequestContextState, callback: () => T): T;
18
+ setContext(partial: Partial<RequestContextState>): void;
19
+ getContext(): RequestContextState | undefined;
20
+ get<K extends keyof RequestContextState>(key: K): RequestContextState[K] | undefined;
21
+ }
22
+
23
+ declare abstract class BasePinoLogger implements LoggerService {
24
+ protected readonly logger: Logger;
25
+ protected readonly contextStore: RequestContextService;
26
+ private readonly levelState;
27
+ constructor(logger: Logger, contextStore: RequestContextService);
28
+ setLogLevels(levels: LogLevel[]): void;
29
+ log(message: unknown, ...optionalParams: unknown[]): void;
30
+ error(message: unknown, ...optionalParams: unknown[]): void;
31
+ warn(message: unknown, ...optionalParams: unknown[]): void;
32
+ debug?(message: unknown, ...optionalParams: unknown[]): void;
33
+ verbose?(message: unknown, ...optionalParams: unknown[]): void;
34
+ fatal?(message: unknown, ...optionalParams: unknown[]): void;
35
+ protected write(level: LogLevel, message: unknown, optionalParams: unknown[], treatStack?: boolean): void;
36
+ private extractOptionalParams;
37
+ private buildMessagePayload;
38
+ private static looksLikeStack;
39
+ }
40
+ declare class AppLogger extends BasePinoLogger {
41
+ constructor(logger: Logger, requestContext: RequestContextService);
42
+ }
43
+
44
+ declare class LoggerModule {
45
+ }
46
+
47
+ type RequestWithUserContext = Request & {
48
+ userContext?: {
49
+ userId?: string;
50
+ tenantId?: string;
51
+ appId?: string;
52
+ };
53
+ };
54
+ declare class LoggerContextMiddleware implements NestMiddleware {
55
+ private readonly requestContext;
56
+ constructor(requestContext: RequestContextService);
57
+ use(req: RequestWithUserContext, _res: Response, next: NextFunction): void;
58
+ }
59
+
60
+ declare const TRACE_LOGGER: unique symbol;
61
+
62
+ export { AppLogger, LoggerContextMiddleware, LoggerModule, TRACE_LOGGER };
package/dist/index.d.ts ADDED
@@ -0,0 +1,62 @@
1
+ import { LoggerService, LogLevel, NestMiddleware } from '@nestjs/common';
2
+ import { Logger } from 'pino';
3
+ import { Request, Response, NextFunction } from 'express';
4
+
5
+ interface RequestContextState {
6
+ requestId: string;
7
+ path?: string;
8
+ method?: string;
9
+ userId?: string;
10
+ appId?: string;
11
+ tenantId?: string;
12
+ ip?: string;
13
+ [key: string]: unknown;
14
+ }
15
+ declare class RequestContextService {
16
+ private readonly storage;
17
+ run<T>(context: RequestContextState, callback: () => T): T;
18
+ setContext(partial: Partial<RequestContextState>): void;
19
+ getContext(): RequestContextState | undefined;
20
+ get<K extends keyof RequestContextState>(key: K): RequestContextState[K] | undefined;
21
+ }
22
+
23
+ declare abstract class BasePinoLogger implements LoggerService {
24
+ protected readonly logger: Logger;
25
+ protected readonly contextStore: RequestContextService;
26
+ private readonly levelState;
27
+ constructor(logger: Logger, contextStore: RequestContextService);
28
+ setLogLevels(levels: LogLevel[]): void;
29
+ log(message: unknown, ...optionalParams: unknown[]): void;
30
+ error(message: unknown, ...optionalParams: unknown[]): void;
31
+ warn(message: unknown, ...optionalParams: unknown[]): void;
32
+ debug?(message: unknown, ...optionalParams: unknown[]): void;
33
+ verbose?(message: unknown, ...optionalParams: unknown[]): void;
34
+ fatal?(message: unknown, ...optionalParams: unknown[]): void;
35
+ protected write(level: LogLevel, message: unknown, optionalParams: unknown[], treatStack?: boolean): void;
36
+ private extractOptionalParams;
37
+ private buildMessagePayload;
38
+ private static looksLikeStack;
39
+ }
40
+ declare class AppLogger extends BasePinoLogger {
41
+ constructor(logger: Logger, requestContext: RequestContextService);
42
+ }
43
+
44
+ declare class LoggerModule {
45
+ }
46
+
47
+ type RequestWithUserContext = Request & {
48
+ userContext?: {
49
+ userId?: string;
50
+ tenantId?: string;
51
+ appId?: string;
52
+ };
53
+ };
54
+ declare class LoggerContextMiddleware implements NestMiddleware {
55
+ private readonly requestContext;
56
+ constructor(requestContext: RequestContextService);
57
+ use(req: RequestWithUserContext, _res: Response, next: NextFunction): void;
58
+ }
59
+
60
+ declare const TRACE_LOGGER: unique symbol;
61
+
62
+ export { AppLogger, LoggerContextMiddleware, LoggerModule, TRACE_LOGGER };