@apinecka/logs-client 1.0.0 → 1.1.0

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 (61) hide show
  1. package/README.md +133 -14
  2. package/dist/client.d.ts +60 -1
  3. package/dist/client.js +345 -2
  4. package/dist/client.js.map +1 -1
  5. package/dist/conform.d.ts +39 -0
  6. package/dist/conform.js +187 -0
  7. package/dist/conform.js.map +1 -0
  8. package/dist/context.d.ts +60 -0
  9. package/dist/context.js +118 -0
  10. package/dist/context.js.map +1 -0
  11. package/dist/error.d.ts +8 -0
  12. package/dist/error.js +58 -0
  13. package/dist/error.js.map +1 -0
  14. package/dist/index.d.ts +2 -0
  15. package/dist/index.js +2 -0
  16. package/dist/index.js.map +1 -1
  17. package/dist/nest/logs.logger.d.ts +25 -2
  18. package/dist/nest/logs.logger.js +154 -18
  19. package/dist/nest/logs.logger.js.map +1 -1
  20. package/dist/schema/models/createLog.d.ts +31 -0
  21. package/dist/schema/models/createLogBatch.d.ts +15 -0
  22. package/dist/schema/models/createLogBatch.js +3 -0
  23. package/dist/schema/models/createLogBatch.js.map +1 -0
  24. package/dist/schema/models/createLogBatchResult.d.ts +13 -0
  25. package/dist/schema/models/createLogBatchResult.js +10 -0
  26. package/dist/schema/models/createLogBatchResult.js.map +1 -0
  27. package/dist/schema/models/createLogMeta.d.ts +13 -0
  28. package/dist/schema/models/createLogMeta.js +10 -0
  29. package/dist/schema/models/createLogMeta.js.map +1 -0
  30. package/dist/schema/models/createLogTags.d.ts +13 -0
  31. package/dist/schema/models/createLogTags.js +10 -0
  32. package/dist/schema/models/createLogTags.js.map +1 -0
  33. package/dist/schema/models/index.d.ts +12 -0
  34. package/dist/schema/models/index.js +12 -0
  35. package/dist/schema/models/index.js.map +1 -1
  36. package/dist/schema/models/logContexts.d.ts +15 -0
  37. package/dist/schema/models/logContexts.js +3 -0
  38. package/dist/schema/models/logContexts.js.map +1 -0
  39. package/dist/schema/models/logError.d.ts +21 -0
  40. package/dist/schema/models/logError.js +3 -0
  41. package/dist/schema/models/logError.js.map +1 -0
  42. package/dist/schema/models/logRequestContext.d.ts +28 -0
  43. package/dist/schema/models/logRequestContext.js +3 -0
  44. package/dist/schema/models/logRequestContext.js.map +1 -0
  45. package/dist/schema/models/logRequestContextHeaders.d.ts +13 -0
  46. package/dist/schema/models/logRequestContextHeaders.js +10 -0
  47. package/dist/schema/models/logRequestContextHeaders.js.map +1 -0
  48. package/dist/schema/models/logRequestContextQuery.d.ts +13 -0
  49. package/dist/schema/models/logRequestContextQuery.js +10 -0
  50. package/dist/schema/models/logRequestContextQuery.js.map +1 -0
  51. package/dist/schema/models/logRuntimeContext.d.ts +20 -0
  52. package/dist/schema/models/logRuntimeContext.js +10 -0
  53. package/dist/schema/models/logRuntimeContext.js.map +1 -0
  54. package/dist/schema/models/logStackFrame.d.ts +17 -0
  55. package/dist/schema/models/logStackFrame.js +10 -0
  56. package/dist/schema/models/logStackFrame.js.map +1 -0
  57. package/dist/schema/models/logUser.d.ts +13 -0
  58. package/dist/schema/models/logUser.js +10 -0
  59. package/dist/schema/models/logUser.js.map +1 -0
  60. package/dist/types.d.ts +50 -0
  61. package/package.json +1 -1
@@ -0,0 +1,39 @@
1
+ import type { CreateLogRequest } from './types';
2
+ /**
3
+ * Limits of the ingest DTOs - keep in sync with `LogsDto` (apps/logs-api/src/logs/logs.dto.ts) and
4
+ * `EnvsTypes` (apps/logs-api/src/envs/envs.types.ts). The server validates a whole batch at once, so one
5
+ * invalid entry would reject all of them; entries are conformed here to never trip it.
6
+ */
7
+ export declare const LOG_LIMITS: {
8
+ appName: number;
9
+ context: number;
10
+ release: number;
11
+ traceId: number;
12
+ envPattern: RegExp;
13
+ traceIdPattern: RegExp;
14
+ fingerprintItems: number;
15
+ fingerprintItem: number;
16
+ tagKeys: number;
17
+ tagKeyPattern: RegExp;
18
+ tagValue: number;
19
+ userId: number;
20
+ userEmail: number;
21
+ username: number;
22
+ errorType: number;
23
+ frames: number;
24
+ errors: number;
25
+ errorDepth: number;
26
+ frameFunction: number;
27
+ frameModule: number;
28
+ method: number;
29
+ url: number;
30
+ route: number;
31
+ headerKeys: number;
32
+ headerValue: number;
33
+ userAgent: number;
34
+ ip: number;
35
+ hostname: number;
36
+ runtimeString: number;
37
+ };
38
+ /** Returns a copy of the entry that satisfies the server's validation; invalid optional fields are omitted or cut. */
39
+ export declare function conformEntry(entry: CreateLogRequest): CreateLogRequest;
@@ -0,0 +1,187 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.LOG_LIMITS = void 0;
4
+ exports.conformEntry = conformEntry;
5
+ /**
6
+ * Limits of the ingest DTOs - keep in sync with `LogsDto` (apps/logs-api/src/logs/logs.dto.ts) and
7
+ * `EnvsTypes` (apps/logs-api/src/envs/envs.types.ts). The server validates a whole batch at once, so one
8
+ * invalid entry would reject all of them; entries are conformed here to never trip it.
9
+ */
10
+ exports.LOG_LIMITS = {
11
+ appName: 50,
12
+ context: 255,
13
+ release: 100,
14
+ traceId: 64,
15
+ envPattern: /^[a-z0-9][a-z0-9_-]{0,29}$/,
16
+ traceIdPattern: /^[A-Za-z0-9._:-]+$/,
17
+ fingerprintItems: 10,
18
+ fingerprintItem: 200,
19
+ tagKeys: 50,
20
+ tagKeyPattern: /^[A-Za-z0-9._-]{1,32}$/,
21
+ tagValue: 200,
22
+ userId: 128,
23
+ userEmail: 255,
24
+ username: 128,
25
+ errorType: 200,
26
+ frames: 200,
27
+ errors: 100,
28
+ errorDepth: 10,
29
+ frameFunction: 500,
30
+ frameModule: 1000,
31
+ method: 20,
32
+ url: 4000,
33
+ route: 500,
34
+ headerKeys: 100,
35
+ headerValue: 2000,
36
+ userAgent: 500,
37
+ ip: 64,
38
+ hostname: 255,
39
+ runtimeString: 50,
40
+ };
41
+ const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
42
+ function str(value, max) {
43
+ return typeof value === 'string' ? value.slice(0, max) : undefined;
44
+ }
45
+ function text(value) {
46
+ if (typeof value === 'string')
47
+ return value;
48
+ if (value === undefined || value === null)
49
+ return '';
50
+ if (typeof value === 'number' || typeof value === 'boolean' || typeof value === 'bigint')
51
+ return String(value);
52
+ return JSON.stringify(value) ?? '';
53
+ }
54
+ function int(value) {
55
+ return typeof value === 'number' && Number.isFinite(value) ? Math.trunc(value) : undefined;
56
+ }
57
+ function num(value) {
58
+ return typeof value === 'number' && Number.isFinite(value) ? value : undefined;
59
+ }
60
+ function scalarString(value, max) {
61
+ return typeof value === 'number' || typeof value === 'boolean' ? String(value).slice(0, max) : str(value, max);
62
+ }
63
+ /** Drops the undefined values so the JSON stays small and `toEqual` friendly. */
64
+ function defined(value) {
65
+ return Object.fromEntries(Object.entries(value).filter(([, item]) => item !== undefined));
66
+ }
67
+ function conformFrame(frame) {
68
+ if (!isObject(frame))
69
+ return undefined;
70
+ return defined({
71
+ function: str(frame.function, exports.LOG_LIMITS.frameFunction),
72
+ module: str(frame.module, exports.LOG_LIMITS.frameModule),
73
+ line: int(frame.line),
74
+ column: int(frame.column),
75
+ inApp: typeof frame.inApp === 'boolean' ? frame.inApp : undefined,
76
+ });
77
+ }
78
+ function conformError(error, depth) {
79
+ if (!isObject(error) || depth > exports.LOG_LIMITS.errorDepth)
80
+ return undefined;
81
+ const frames = Array.isArray(error.frames)
82
+ ? error.frames.slice(0, exports.LOG_LIMITS.frames).map(conformFrame).filter((frame) => frame !== undefined)
83
+ : undefined;
84
+ const errors = Array.isArray(error.errors)
85
+ ? error.errors.slice(0, exports.LOG_LIMITS.errors).map((item) => conformError(item, depth + 1)).filter((item) => item !== undefined)
86
+ : undefined;
87
+ return defined({
88
+ type: str(error.type, exports.LOG_LIMITS.errorType) ?? 'Error',
89
+ message: text(error.message),
90
+ stack: str(error.stack, Infinity),
91
+ frames,
92
+ cause: conformError(error.cause, depth + 1),
93
+ errors,
94
+ });
95
+ }
96
+ function conformStringMap(value, maxKeys, maxValue, keyPattern) {
97
+ if (!isObject(value))
98
+ return undefined;
99
+ const result = {};
100
+ for (const [key, item] of Object.entries(value)) {
101
+ if (Object.keys(result).length >= maxKeys)
102
+ break;
103
+ if (keyPattern && !keyPattern.test(key))
104
+ continue;
105
+ const text = scalarString(item, maxValue);
106
+ if (text !== undefined)
107
+ result[key] = text;
108
+ }
109
+ return result;
110
+ }
111
+ function conformRequest(request) {
112
+ if (!isObject(request))
113
+ return undefined;
114
+ return defined({
115
+ method: str(request.method, exports.LOG_LIMITS.method),
116
+ url: str(request.url, exports.LOG_LIMITS.url),
117
+ route: str(request.route, exports.LOG_LIMITS.route),
118
+ query: isObject(request.query) ? request.query : undefined,
119
+ headers: conformStringMap(request.headers, exports.LOG_LIMITS.headerKeys, exports.LOG_LIMITS.headerValue),
120
+ userAgent: str(request.userAgent, exports.LOG_LIMITS.userAgent),
121
+ ip: str(request.ip, exports.LOG_LIMITS.ip),
122
+ statusCode: int(request.statusCode),
123
+ durationMs: num(request.durationMs),
124
+ });
125
+ }
126
+ function conformRuntime(runtime) {
127
+ if (!isObject(runtime))
128
+ return undefined;
129
+ return defined({
130
+ hostname: str(runtime.hostname, exports.LOG_LIMITS.hostname),
131
+ pid: int(runtime.pid),
132
+ nodeVersion: str(runtime.nodeVersion, exports.LOG_LIMITS.runtimeString),
133
+ platform: str(runtime.platform, exports.LOG_LIMITS.runtimeString),
134
+ arch: str(runtime.arch, exports.LOG_LIMITS.runtimeString),
135
+ memoryRssBytes: int(runtime.memoryRssBytes),
136
+ heapUsedBytes: int(runtime.heapUsedBytes),
137
+ uptimeSeconds: num(runtime.uptimeSeconds),
138
+ });
139
+ }
140
+ function conformTimestamp(value) {
141
+ if (typeof value !== 'string')
142
+ return value instanceof Date && !Number.isNaN(value.getTime()) ? value.toISOString() : undefined;
143
+ if (/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2})$/.test(value) && !Number.isNaN(Date.parse(value)))
144
+ return value;
145
+ const parsed = Date.parse(value);
146
+ return Number.isNaN(parsed) ? undefined : new Date(parsed).toISOString();
147
+ }
148
+ /** Returns a copy of the entry that satisfies the server's validation; invalid optional fields are omitted or cut. */
149
+ function conformEntry(entry) {
150
+ const raw = entry;
151
+ const env = typeof raw.env === 'string' ? raw.env.trim().toLowerCase() : undefined;
152
+ const traceId = str(raw.traceId, Infinity);
153
+ const user = isObject(raw.user)
154
+ ? defined({
155
+ id: scalarString(raw.user.id, exports.LOG_LIMITS.userId),
156
+ email: str(raw.user.email, exports.LOG_LIMITS.userEmail),
157
+ username: str(raw.user.username, exports.LOG_LIMITS.username),
158
+ })
159
+ : undefined;
160
+ const contexts = isObject(raw.contexts)
161
+ ? defined({ request: conformRequest(raw.contexts.request), runtime: conformRuntime(raw.contexts.runtime) })
162
+ : undefined;
163
+ const fingerprint = Array.isArray(raw.fingerprint)
164
+ ? raw.fingerprint
165
+ .filter((item) => typeof item === 'string')
166
+ .slice(0, exports.LOG_LIMITS.fingerprintItems)
167
+ .map((item) => item.slice(0, exports.LOG_LIMITS.fingerprintItem))
168
+ : undefined;
169
+ const tags = conformStringMap(raw.tags, exports.LOG_LIMITS.tagKeys, exports.LOG_LIMITS.tagValue, exports.LOG_LIMITS.tagKeyPattern);
170
+ return defined({
171
+ level: raw.level,
172
+ message: text(raw.message),
173
+ context: str(raw.context, exports.LOG_LIMITS.context),
174
+ appName: (str(raw.appName, Infinity)?.trim().slice(0, exports.LOG_LIMITS.appName)) || 'unknown',
175
+ timestamp: conformTimestamp(raw.timestamp),
176
+ env: env !== undefined && exports.LOG_LIMITS.envPattern.test(env) ? env : undefined,
177
+ meta: isObject(raw.meta) ? raw.meta : undefined,
178
+ error: conformError(raw.error, 0),
179
+ fingerprint,
180
+ release: str(raw.release, exports.LOG_LIMITS.release),
181
+ traceId: traceId !== undefined && traceId.length <= exports.LOG_LIMITS.traceId && exports.LOG_LIMITS.traceIdPattern.test(traceId) ? traceId : undefined,
182
+ user: user && Object.keys(user).length > 0 ? user : undefined,
183
+ tags: tags && Object.keys(tags).length > 0 ? tags : undefined,
184
+ contexts: contexts && Object.keys(contexts).length > 0 ? contexts : undefined,
185
+ });
186
+ }
187
+ //# sourceMappingURL=conform.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"conform.js","sourceRoot":"","sources":["../src/conform.ts"],"names":[],"mappings":";;;AAqJA,oCAsCC;AAzLD;;;;GAIG;AACU,QAAA,UAAU,GAAG;IACzB,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,GAAG;IACZ,OAAO,EAAE,GAAG;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,4BAA4B;IACxC,cAAc,EAAE,oBAAoB;IACpC,gBAAgB,EAAE,EAAE;IACpB,eAAe,EAAE,GAAG;IACpB,OAAO,EAAE,EAAE;IACX,aAAa,EAAE,wBAAwB;IACvC,QAAQ,EAAE,GAAG;IACb,MAAM,EAAE,GAAG;IACX,SAAS,EAAE,GAAG;IACd,QAAQ,EAAE,GAAG;IACb,SAAS,EAAE,GAAG;IACd,MAAM,EAAE,GAAG;IACX,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,EAAE;IACd,aAAa,EAAE,GAAG;IAClB,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,EAAE;IACV,GAAG,EAAE,IAAI;IACT,KAAK,EAAE,GAAG;IACV,UAAU,EAAE,GAAG;IACf,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,GAAG;IACd,EAAE,EAAE,EAAE;IACN,QAAQ,EAAE,GAAG;IACb,aAAa,EAAE,EAAE;CACjB,CAAA;AAID,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAgB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAEvH,SAAS,GAAG,CAAC,KAAc,EAAE,GAAW;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AACnE,CAAC;AAED,SAAS,IAAI,CAAC,KAAc;IAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,CAAA;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IAC9G,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;AACnC,CAAC;AAED,SAAS,GAAG,CAAC,KAAc;IAC1B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAC3F,CAAC;AAED,SAAS,GAAG,CAAC,KAAc;IAC1B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AAC/E,CAAC;AAED,SAAS,YAAY,CAAC,KAAc,EAAE,GAAW;IAChD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AAC/G,CAAC;AAED,iFAAiF;AACjF,SAAS,OAAO,CAAgB,KAAQ;IACvC,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAM,CAAA;AAC/F,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IACtC,OAAO,OAAO,CAAC;QACd,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAU,CAAC,aAAa,CAAC;QACvD,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAU,CAAC,WAAW,CAAC;QACjD,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QACrB,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;QACzB,KAAK,EAAE,OAAO,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KACjE,CAAC,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAc,EAAE,KAAa;IAClD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,kBAAU,CAAC,UAAU;QAAE,OAAO,SAAS,CAAA;IACvE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;QACzC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAU,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;QACnG,CAAC,CAAC,SAAS,CAAA;IACZ,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;QACzC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAU,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC;QAC5H,CAAC,CAAC,SAAS,CAAA;IACZ,OAAO,OAAO,CAAC;QACd,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAU,CAAC,SAAS,CAAC,IAAI,OAAO;QACtD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5B,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC;QACjC,MAAM;QACN,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC;QAC3C,MAAM;KACN,CAAC,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc,EAAE,OAAe,EAAE,QAAgB,EAAE,UAAmB;IAC/F,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IACtC,MAAM,MAAM,GAA2B,EAAE,CAAA;IACzC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,IAAI,OAAO;YAAE,MAAK;QAChD,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,SAAQ;QACjD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACzC,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAC3C,CAAC;IACD,OAAO,MAAM,CAAA;AACd,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB;IACvC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAA;IACxC,OAAO,OAAO,CAAC;QACd,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAU,CAAC,MAAM,CAAC;QAC9C,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAU,CAAC,GAAG,CAAC;QACrC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAU,CAAC,KAAK,CAAC;QAC3C,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QAC1D,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,kBAAU,CAAC,UAAU,EAAE,kBAAU,CAAC,WAAW,CAAC;QACzF,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,kBAAU,CAAC,SAAS,CAAC;QACvD,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,kBAAU,CAAC,EAAE,CAAC;QAClC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC;QACnC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC;KACnC,CAAC,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB;IACvC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAA;IACxC,OAAO,OAAO,CAAC;QACd,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,kBAAU,CAAC,QAAQ,CAAC;QACpD,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;QACrB,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,kBAAU,CAAC,aAAa,CAAC;QAC/D,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,kBAAU,CAAC,aAAa,CAAC;QACzD,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAU,CAAC,aAAa,CAAC;QACjD,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC;QAC3C,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;QACzC,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;KACzC,CAAC,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAC/H,IAAI,sEAAsE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACxI,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAChC,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;AACzE,CAAC;AAED,sHAAsH;AACtH,SAAgB,YAAY,CAAC,KAAuB;IACnD,MAAM,GAAG,GAAG,KAAuB,CAAA;IACnC,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAClF,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;QAC9B,CAAC,CAAC,OAAO,CAAC;YACT,EAAE,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,kBAAU,CAAC,MAAM,CAAC;YAChD,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAU,CAAC,SAAS,CAAC;YAChD,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAU,CAAC,QAAQ,CAAC;SACrD,CAAC;QACF,CAAC,CAAC,SAAS,CAAA;IACZ,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC;QACtC,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3G,CAAC,CAAC,SAAS,CAAA;IACZ,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;QACjD,CAAC,CAAC,GAAG,CAAC,WAAW;aACf,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC;aAC1D,KAAK,CAAC,CAAC,EAAE,kBAAU,CAAC,gBAAgB,CAAC;aACrC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAU,CAAC,eAAe,CAAC,CAAC;QAC1D,CAAC,CAAC,SAAS,CAAA;IACZ,MAAM,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,kBAAU,CAAC,OAAO,EAAE,kBAAU,CAAC,QAAQ,EAAE,kBAAU,CAAC,aAAa,CAAC,CAAA;IAE1G,OAAO,OAAO,CAAC;QACd,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAU,CAAC,OAAO,CAAC;QAC7C,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAU,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS;QACvF,SAAS,EAAE,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC;QAC1C,GAAG,EAAE,GAAG,KAAK,SAAS,IAAI,kBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;QAC3E,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC/C,KAAK,EAAE,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,WAAW;QACX,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAU,CAAC,OAAO,CAAC;QAC7C,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,IAAI,kBAAU,CAAC,OAAO,IAAI,kBAAU,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QACvI,IAAI,EAAE,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC7D,IAAI,EAAE,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC7D,QAAQ,EAAE,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;KAC7E,CAAgC,CAAA;AAClC,CAAC"}
@@ -0,0 +1,60 @@
1
+ import type { LogRequestContext, LogUser } from './schema/models';
2
+ /** Data attached to every entry enqueued while it is active (the entry's own fields win). */
3
+ export interface LogContext {
4
+ traceId?: string;
5
+ user?: LogUser;
6
+ tags?: Record<string, string>;
7
+ meta?: Record<string, unknown>;
8
+ /** Evaluated lazily when an entry is enqueued, so it can include data known only later (route, status). */
9
+ request?: () => LogRequestContext | undefined;
10
+ }
11
+ /**
12
+ * Runs `fn` with a log context that follows its async calls. Nested contexts inherit the outer one
13
+ * (tags and meta are merged). Use it in jobs and queue consumers:
14
+ * `runWithLogContext({ traceId: id, tags: { job: 'sync' } }, () => handle())`.
15
+ */
16
+ export declare function runWithLogContext<T>(ctx: LogContext, fn: () => T): T;
17
+ /** The active log context, if any. */
18
+ export declare function getLogContext(): LogContext | undefined;
19
+ /** Sets the user of the active context (no-op outside one). */
20
+ export declare function setLogUser(user: LogUser): void;
21
+ /** Merges tags into the active context (no-op outside one). */
22
+ export declare function setLogTags(tags: Record<string, string>): void;
23
+ /** Merges meta into the active context (no-op outside one). */
24
+ export declare function addLogMeta(meta: Record<string, unknown>): void;
25
+ type HeaderValue = string | string[] | undefined;
26
+ export type HeadersLike = Record<string, HeaderValue>;
27
+ /**
28
+ * A trace id for a request: the trace-id of the W3C `traceparent` header, else `x-request-id` /
29
+ * `x-correlation-id` (when valid for the server), else a fresh UUID.
30
+ */
31
+ export declare function traceIdFromHeaders(headers: HeadersLike): string;
32
+ export interface LogsContextMiddlewareOptions {
33
+ /** Send the trace id back as the `x-request-id` response header. Default true. */
34
+ setResponseHeader?: boolean;
35
+ }
36
+ /** The slice of an Express/Node request the middleware reads (typed loosely so express is no dependency). */
37
+ interface RequestLike {
38
+ method?: string;
39
+ url?: string;
40
+ originalUrl?: string;
41
+ baseUrl?: string;
42
+ route?: {
43
+ path?: unknown;
44
+ };
45
+ query?: unknown;
46
+ headers?: HeadersLike;
47
+ ip?: string;
48
+ }
49
+ interface ResponseLike {
50
+ statusCode?: number;
51
+ setHeader?: (name: string, value: string) => unknown;
52
+ once?: (event: string, listener: () => void) => unknown;
53
+ }
54
+ /**
55
+ * Express-compatible middleware (also usable as Nest middleware via `consumer.apply(...)`): opens a log
56
+ * context per request with a trace id and a lazily built request context (method, url, route, query,
57
+ * headers without credentials, user agent, ip, and status + duration once the response finished).
58
+ */
59
+ export declare function logsContextMiddleware(options?: LogsContextMiddlewareOptions): (req: RequestLike, res: ResponseLike, next: (err?: unknown) => void) => void;
60
+ export {};
@@ -0,0 +1,118 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.runWithLogContext = runWithLogContext;
4
+ exports.getLogContext = getLogContext;
5
+ exports.setLogUser = setLogUser;
6
+ exports.setLogTags = setLogTags;
7
+ exports.addLogMeta = addLogMeta;
8
+ exports.traceIdFromHeaders = traceIdFromHeaders;
9
+ exports.logsContextMiddleware = logsContextMiddleware;
10
+ const async_hooks_1 = require("async_hooks");
11
+ const crypto_1 = require("crypto");
12
+ const storage = new async_hooks_1.AsyncLocalStorage();
13
+ /**
14
+ * Runs `fn` with a log context that follows its async calls. Nested contexts inherit the outer one
15
+ * (tags and meta are merged). Use it in jobs and queue consumers:
16
+ * `runWithLogContext({ traceId: id, tags: { job: 'sync' } }, () => handle())`.
17
+ */
18
+ function runWithLogContext(ctx, fn) {
19
+ const parent = storage.getStore();
20
+ const merged = {
21
+ ...parent,
22
+ ...ctx,
23
+ tags: { ...parent?.tags, ...ctx.tags },
24
+ meta: { ...parent?.meta, ...ctx.meta },
25
+ };
26
+ return storage.run(merged, fn);
27
+ }
28
+ /** The active log context, if any. */
29
+ function getLogContext() {
30
+ return storage.getStore();
31
+ }
32
+ /** Sets the user of the active context (no-op outside one). */
33
+ function setLogUser(user) {
34
+ const store = storage.getStore();
35
+ if (store)
36
+ store.user = user;
37
+ }
38
+ /** Merges tags into the active context (no-op outside one). */
39
+ function setLogTags(tags) {
40
+ const store = storage.getStore();
41
+ if (store)
42
+ store.tags = { ...store.tags, ...tags };
43
+ }
44
+ /** Merges meta into the active context (no-op outside one). */
45
+ function addLogMeta(meta) {
46
+ const store = storage.getStore();
47
+ if (store)
48
+ store.meta = { ...store.meta, ...meta };
49
+ }
50
+ const TRACE_ID_PATTERN = /^[A-Za-z0-9._:-]+$/;
51
+ const TRACEPARENT_PATTERN = /^[0-9a-f]{2}-([0-9a-f]{32})-[0-9a-f]{16}-[0-9a-f]{2}$/;
52
+ function headerValue(headers, name) {
53
+ const value = headers[name];
54
+ return Array.isArray(value) ? value[0] : value;
55
+ }
56
+ /**
57
+ * A trace id for a request: the trace-id of the W3C `traceparent` header, else `x-request-id` /
58
+ * `x-correlation-id` (when valid for the server), else a fresh UUID.
59
+ */
60
+ function traceIdFromHeaders(headers) {
61
+ const traceparent = headerValue(headers, 'traceparent')?.trim().toLowerCase().match(TRACEPARENT_PATTERN)?.[1];
62
+ if (traceparent && !/^0+$/.test(traceparent))
63
+ return traceparent;
64
+ for (const name of ['x-request-id', 'x-correlation-id']) {
65
+ const value = headerValue(headers, name)?.trim();
66
+ if (value && value.length <= 64 && TRACE_ID_PATTERN.test(value))
67
+ return value;
68
+ }
69
+ return (0, crypto_1.randomUUID)();
70
+ }
71
+ const SENSITIVE_HEADERS = new Set(['authorization', 'cookie', 'set-cookie', 'x-api-key', 'proxy-authorization']);
72
+ function pickHeaders(headers) {
73
+ const result = {};
74
+ for (const [name, value] of Object.entries(headers)) {
75
+ if (SENSITIVE_HEADERS.has(name.toLowerCase()) || value === undefined)
76
+ continue;
77
+ result[name] = Array.isArray(value) ? value.join(', ') : value;
78
+ }
79
+ return result;
80
+ }
81
+ function describeRequest(req, res, startedAt, finishedAt) {
82
+ const headers = req.headers ?? {};
83
+ const route = typeof req.route?.path === 'string' ? `${req.baseUrl ?? ''}${req.route.path}` : undefined;
84
+ const ended = finishedAt();
85
+ const query = req.query && typeof req.query === 'object' ? { ...req.query } : undefined;
86
+ const context = {
87
+ method: req.method,
88
+ url: req.originalUrl ?? req.url,
89
+ route,
90
+ query,
91
+ headers: pickHeaders(headers),
92
+ userAgent: headerValue(headers, 'user-agent'),
93
+ ip: req.ip,
94
+ };
95
+ if (ended !== undefined) {
96
+ context.statusCode = res.statusCode;
97
+ context.durationMs = ended - startedAt;
98
+ }
99
+ return context;
100
+ }
101
+ /**
102
+ * Express-compatible middleware (also usable as Nest middleware via `consumer.apply(...)`): opens a log
103
+ * context per request with a trace id and a lazily built request context (method, url, route, query,
104
+ * headers without credentials, user agent, ip, and status + duration once the response finished).
105
+ */
106
+ function logsContextMiddleware(options = {}) {
107
+ return (req, res, next) => {
108
+ const startedAt = Date.now();
109
+ let finishedAt;
110
+ res.once?.('finish', () => (finishedAt ??= Date.now()));
111
+ res.once?.('close', () => (finishedAt ??= Date.now()));
112
+ const traceId = traceIdFromHeaders(req.headers ?? {});
113
+ if (options.setResponseHeader !== false)
114
+ res.setHeader?.('x-request-id', traceId);
115
+ runWithLogContext({ traceId, request: () => describeRequest(req, res, startedAt, () => finishedAt) }, () => next());
116
+ };
117
+ }
118
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;AAsBA,8CASC;AAGD,sCAEC;AAGD,gCAGC;AAGD,gCAGC;AAGD,gCAGC;AAiBD,gDAQC;AA8DD,sDAYC;AAzJD,6CAA+C;AAC/C,mCAAmC;AAcnC,MAAM,OAAO,GAAG,IAAI,+BAAiB,EAAc,CAAA;AAEnD;;;;GAIG;AACH,SAAgB,iBAAiB,CAAI,GAAe,EAAE,EAAW;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,MAAM,MAAM,GAAe;QAC1B,GAAG,MAAM;QACT,GAAG,GAAG;QACN,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE;QACtC,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE;KACtC,CAAA;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAC/B,CAAC;AAED,sCAAsC;AACtC,SAAgB,aAAa;IAC5B,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC;AAED,+DAA+D;AAC/D,SAAgB,UAAU,CAAC,IAAa;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;IAChC,IAAI,KAAK;QAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;AAC7B,CAAC;AAED,+DAA+D;AAC/D,SAAgB,UAAU,CAAC,IAA4B;IACtD,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;IAChC,IAAI,KAAK;QAAE,KAAK,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAA;AACnD,CAAC;AAED,+DAA+D;AAC/D,SAAgB,UAAU,CAAC,IAA6B;IACvD,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;IAChC,IAAI,KAAK;QAAE,KAAK,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAA;AACnD,CAAC;AAKD,MAAM,gBAAgB,GAAG,oBAAoB,CAAA;AAC7C,MAAM,mBAAmB,GAAG,uDAAuD,CAAA;AAEnF,SAAS,WAAW,CAAC,OAAoB,EAAE,IAAY;IACtD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AAC/C,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,OAAoB;IACtD,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC7G,IAAI,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;QAAE,OAAO,WAAW,CAAA;IAChE,KAAK,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;QAChD,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAA;IAC9E,CAAC;IACD,OAAO,IAAA,mBAAU,GAAE,CAAA;AACpB,CAAC;AAyBD,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAA;AAEhH,SAAS,WAAW,CAAC,OAAoB;IACxC,MAAM,MAAM,GAA2B,EAAE,CAAA;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,KAAK,KAAK,SAAS;YAAE,SAAQ;QAC9E,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAC/D,CAAC;IACD,OAAO,MAAM,CAAA;AACd,CAAC;AAED,SAAS,eAAe,CAAC,GAAgB,EAAE,GAAiB,EAAE,SAAiB,EAAE,UAAoC;IACpH,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAA;IACjC,MAAM,KAAK,GAAG,OAAO,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IACvG,MAAM,KAAK,GAAG,UAAU,EAAE,CAAA;IAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAI,GAAG,CAAC,KAAiC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IACpH,MAAM,OAAO,GAAsB;QAClC,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG;QAC/B,KAAK;QACL,KAAK;QACL,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAC7B,SAAS,EAAE,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;QAC7C,EAAE,EAAE,GAAG,CAAC,EAAE;KACV,CAAA;IACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;QACnC,OAAO,CAAC,UAAU,GAAG,KAAK,GAAG,SAAS,CAAA;IACvC,CAAC;IACD,OAAO,OAAO,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,UAAwC,EAAE;IAC/E,OAAO,CAAC,GAAgB,EAAE,GAAiB,EAAE,IAA6B,EAAQ,EAAE;QACnF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,IAAI,UAA8B,CAAA;QAClC,GAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QACvD,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QAEtD,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QACrD,IAAI,OAAO,CAAC,iBAAiB,KAAK,KAAK;YAAE,GAAG,CAAC,SAAS,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QAEjF,iBAAiB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;IACpH,CAAC,CAAA;AACF,CAAC"}
@@ -0,0 +1,8 @@
1
+ import type { LogError } from './schema/models';
2
+ /**
3
+ * Converts a thrown value to the `error` field of a log entry: type, message, raw stack (the server parses
4
+ * the frames), the `cause` chain and the errors of an `AggregateError`. Axios request config and headers
5
+ * (credentials) are never included - only `METHOD url -> status` is appended to the message.
6
+ * Returns `undefined` for values that are not errors (a string becomes an `Error` with that message).
7
+ */
8
+ export declare function serializeError(err: unknown): LogError | undefined;
package/dist/error.js ADDED
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.serializeError = serializeError;
4
+ const axios_1 = require("axios");
5
+ const MAX_DEPTH = 5;
6
+ const MAX_AGGREGATED = 10;
7
+ /**
8
+ * Converts a thrown value to the `error` field of a log entry: type, message, raw stack (the server parses
9
+ * the frames), the `cause` chain and the errors of an `AggregateError`. Axios request config and headers
10
+ * (credentials) are never included - only `METHOD url -> status` is appended to the message.
11
+ * Returns `undefined` for values that are not errors (a string becomes an `Error` with that message).
12
+ */
13
+ function serializeError(err) {
14
+ return serialize(err, 0, new WeakSet());
15
+ }
16
+ function serialize(err, depth, seen) {
17
+ if (typeof err === 'string')
18
+ return { type: 'Error', message: err };
19
+ if (!(err instanceof Error))
20
+ return undefined;
21
+ if (seen.has(err))
22
+ return undefined;
23
+ seen.add(err);
24
+ const result = { type: errorType(err), message: errorMessage(err) };
25
+ if (err.stack)
26
+ result.stack = err.stack;
27
+ if (depth + 1 < MAX_DEPTH) {
28
+ const cause = err.cause;
29
+ if (cause !== undefined && cause !== null) {
30
+ const serialized = serialize(cause, depth + 1, seen);
31
+ if (serialized)
32
+ result.cause = serialized;
33
+ }
34
+ const nested = err.errors;
35
+ if (Array.isArray(nested)) {
36
+ const errors = nested
37
+ .slice(0, MAX_AGGREGATED)
38
+ .map((item) => serialize(item, depth + 1, seen))
39
+ .filter((item) => item !== undefined);
40
+ if (errors.length > 0)
41
+ result.errors = errors;
42
+ }
43
+ }
44
+ return result;
45
+ }
46
+ function errorType(err) {
47
+ if (err.name && err.name !== 'Error')
48
+ return err.name;
49
+ return err.constructor?.name || 'Error';
50
+ }
51
+ function errorMessage(err) {
52
+ if (!(0, axios_1.isAxiosError)(err))
53
+ return err.message;
54
+ const method = err.config?.method?.toUpperCase() ?? '';
55
+ const request = `${method} ${err.config?.url ?? ''}`.trim();
56
+ return `${err.message} [${request} -> ${err.response?.status ?? err.code ?? 'no response'}]`;
57
+ }
58
+ //# sourceMappingURL=error.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;AAaA,wCAEC;AAfD,iCAAoC;AAIpC,MAAM,SAAS,GAAG,CAAC,CAAA;AACnB,MAAM,cAAc,GAAG,EAAE,CAAA;AAEzB;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,GAAY;IAC1C,OAAO,SAAS,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;AACxC,CAAC;AAED,SAAS,SAAS,CAAC,GAAY,EAAE,KAAa,EAAE,IAAqB;IACpE,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAA;IACnE,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAA;IACnC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAEb,MAAM,MAAM,GAAa,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,CAAA;IAC7E,IAAI,GAAG,CAAC,KAAK;QAAE,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAA;IACvC,IAAI,KAAK,GAAG,CAAC,GAAG,SAAS,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAI,GAA2B,CAAC,KAAK,CAAA;QAChD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;YACpD,IAAI,UAAU;gBAAE,MAAM,CAAC,KAAK,GAAG,UAAU,CAAA;QAC1C,CAAC;QACD,MAAM,MAAM,GAAI,GAA4B,CAAC,MAAM,CAAA;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM;iBACnB,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC;iBACxB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;iBAC/C,MAAM,CAAC,CAAC,IAAI,EAAoB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;YACxD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;QAC9C,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAA;AACd,CAAC;AAED,SAAS,SAAS,CAAC,GAAU;IAC5B,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,GAAG,CAAC,IAAI,CAAA;IACrD,OAAO,GAAG,CAAC,WAAW,EAAE,IAAI,IAAI,OAAO,CAAA;AACxC,CAAC;AAED,SAAS,YAAY,CAAC,GAAU;IAC/B,IAAI,CAAC,IAAA,oBAAY,EAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,OAAO,CAAA;IAC1C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;IACtD,MAAM,OAAO,GAAG,GAAG,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IAC3D,OAAO,GAAG,GAAG,CAAC,OAAO,KAAK,OAAO,OAAO,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,aAAa,GAAG,CAAA;AAC7F,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,3 +1,5 @@
1
1
  export * from './client';
2
+ export * from './context';
3
+ export * from './error';
2
4
  export * from './schema/models';
3
5
  export * from './types';
package/dist/index.js CHANGED
@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./client"), exports);
18
+ __exportStar(require("./context"), exports);
19
+ __exportStar(require("./error"), exports);
18
20
  __exportStar(require("./schema/models"), exports);
19
21
  __exportStar(require("./types"), exports);
20
22
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,kDAA+B;AAC/B,0CAAuB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,4CAAyB;AACzB,0CAAuB;AACvB,kDAA+B;AAC/B,0CAAuB"}
@@ -1,7 +1,22 @@
1
1
  import { ConsoleLogger, ConsoleLoggerOptions } from '@nestjs/common';
2
2
  import type { LogsClient } from '../client';
3
- /** What the logger needs from a client - `LogsClient` (or `ApiLogsClient`) fits. */
4
- export type LogsPublisher = Pick<LogsClient, 'create'>;
3
+ import { LogError, LogUser } from '../schema/models';
4
+ /** What the logger needs from a client - `LogsClient` fits; a publisher with only `create` is sent fire-and-forget. */
5
+ export type LogsPublisher = Pick<LogsClient, 'create'> & Partial<Pick<LogsClient, 'enqueue'>>;
6
+ /**
7
+ * Extra data for an entry, passed as a param of a logger call (it is not printed to the console):
8
+ * `logger.error(err, { meta, tags, user, fingerprint })` or `new Logger('Ctx').error('Failed', { meta: { orderId } })`.
9
+ * A plain object whose keys are all among these is taken as `LogOptions`; any other object param goes to `meta`.
10
+ */
11
+ export interface LogOptions {
12
+ meta?: Record<string, unknown>;
13
+ tags?: Record<string, string>;
14
+ user?: LogUser;
15
+ /** Custom grouping key parts; `{{ default }}` stands for the default fingerprint. */
16
+ fingerprint?: string[];
17
+ traceId?: string;
18
+ error?: LogError;
19
+ }
5
20
  export declare class LogsApiLogger extends ConsoleLogger {
6
21
  private readonly apiLogsClient;
7
22
  constructor(options: ConsoleLoggerOptions, apiLogsClient: LogsPublisher);
@@ -12,5 +27,13 @@ export declare class LogsApiLogger extends ConsoleLogger {
12
27
  verbose(message: unknown, ...optionalParams: unknown[]): void;
13
28
  fatal(message: unknown, ...optionalParams: unknown[]): void;
14
29
  private compact;
30
+ private isPlainObject;
31
+ private isLogOptions;
32
+ private splitOptions;
33
+ private parseCall;
34
+ private looksLikeStack;
35
+ private stringify;
15
36
  private publish;
37
+ private buildEntry;
38
+ private send;
16
39
  }