evlog 2.16.0 → 2.17.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.
- package/README.md +7 -7
- package/dist/adapters/axiom.d.mts +1 -1
- package/dist/adapters/axiom.mjs +4 -2
- package/dist/adapters/axiom.mjs.map +1 -1
- package/dist/adapters/better-stack.d.mts +1 -1
- package/dist/adapters/better-stack.mjs +4 -2
- package/dist/adapters/better-stack.mjs.map +1 -1
- package/dist/adapters/datadog.d.mts +1 -1
- package/dist/adapters/datadog.mjs +4 -2
- package/dist/adapters/datadog.mjs.map +1 -1
- package/dist/adapters/fs.d.mts +64 -2
- package/dist/adapters/fs.d.mts.map +1 -1
- package/dist/adapters/fs.mjs +222 -3
- package/dist/adapters/fs.mjs.map +1 -1
- package/dist/adapters/hyperdx.d.mts +1 -1
- package/dist/adapters/hyperdx.mjs +1 -1
- package/dist/adapters/otlp.d.mts +1 -1
- package/dist/adapters/otlp.mjs +6 -4
- package/dist/adapters/otlp.mjs.map +1 -1
- package/dist/adapters/posthog.d.mts +1 -1
- package/dist/adapters/posthog.mjs +4 -2
- package/dist/adapters/posthog.mjs.map +1 -1
- package/dist/adapters/sentry.d.mts +1 -1
- package/dist/adapters/sentry.mjs +5 -3
- package/dist/adapters/sentry.mjs.map +1 -1
- package/dist/ai/index.d.mts +1 -1
- package/dist/{audit-X1uUukm3.d.mts → audit-CC8nfazi.d.mts} +56 -5
- package/dist/{audit-X1uUukm3.d.mts.map → audit-CC8nfazi.d.mts.map} +1 -1
- package/dist/better-auth/index.d.mts +14 -7
- package/dist/better-auth/index.d.mts.map +1 -1
- package/dist/better-auth/index.mjs +11 -1
- package/dist/better-auth/index.mjs.map +1 -1
- package/dist/browser.d.mts +1 -1
- package/dist/{define-CuXOqecD.d.mts → define-MSdhzmXn.d.mts} +3 -3
- package/dist/{define-CuXOqecD.d.mts.map → define-MSdhzmXn.d.mts.map} +1 -1
- package/dist/{dist-BIlS38vi.mjs → dist-H3GIh-KK.mjs} +1 -1
- package/dist/{dist-BIlS38vi.mjs.map → dist-H3GIh-KK.mjs.map} +1 -1
- package/dist/{drain-ByWUeOQC.mjs → drain-X7_5szSI.mjs} +6 -49
- package/dist/drain-X7_5szSI.mjs.map +1 -0
- package/dist/elysia/index.d.mts +2 -2
- package/dist/elysia/index.mjs +2 -2
- package/dist/{enricher-DYTr9I16.d.mts → enricher-DxgML6IC.d.mts} +2 -2
- package/dist/{enricher-DYTr9I16.d.mts.map → enricher-DxgML6IC.d.mts.map} +1 -1
- package/dist/{enricher-Dy06T17G.mjs → enricher-N0erZS87.mjs} +2 -2
- package/dist/{enricher-Dy06T17G.mjs.map → enricher-N0erZS87.mjs.map} +1 -1
- package/dist/enrichers.d.mts +2 -2
- package/dist/enrichers.mjs +1 -1
- package/dist/{error-Cpc7RVz6.d.mts → error-CpbbtyXL.d.mts} +2 -2
- package/dist/{error-Cpc7RVz6.d.mts.map → error-CpbbtyXL.d.mts.map} +1 -1
- package/dist/error.d.mts +1 -1
- package/dist/{errors-prnQ3kES.d.mts → errors-DySW1F9_.d.mts} +2 -2
- package/dist/{errors-prnQ3kES.d.mts.map → errors-DySW1F9_.d.mts.map} +1 -1
- package/dist/{event-DcHmEm3O.mjs → event-1BMl7o0k.mjs} +1 -1
- package/dist/{event-DcHmEm3O.mjs.map → event-1BMl7o0k.mjs.map} +1 -1
- package/dist/express/index.d.mts +2 -2
- package/dist/express/index.d.mts.map +1 -1
- package/dist/express/index.mjs +5 -6
- package/dist/express/index.mjs.map +1 -1
- package/dist/fastify/index.d.mts +2 -2
- package/dist/fastify/index.mjs +2 -2
- package/dist/{fork-DPN8aL8O.mjs → fork-8u_zFOJq.mjs} +2 -2
- package/dist/{fork-DPN8aL8O.mjs.map → fork-8u_zFOJq.mjs.map} +1 -1
- package/dist/hono/index.d.mts +2 -2
- package/dist/hono/index.mjs +1 -1
- package/dist/http-6umVAKDW.mjs +82 -0
- package/dist/http-6umVAKDW.mjs.map +1 -0
- package/dist/http.d.mts +1 -1
- package/dist/http.mjs +1 -0
- package/dist/http.mjs.map +1 -1
- package/dist/index-o1_z4phv.d.mts +213 -0
- package/dist/index-o1_z4phv.d.mts.map +1 -0
- package/dist/index.d.mts +9 -8
- package/dist/index.mjs +209 -1
- package/dist/index.mjs.map +1 -0
- package/dist/{integration-DSZPbI9N.mjs → integration-DTZtjSqh.mjs} +2 -2
- package/dist/{integration-DSZPbI9N.mjs.map → integration-DTZtjSqh.mjs.map} +1 -1
- package/dist/{logger-U8lgdc9x.d.mts → logger-DntcxxHg.d.mts} +2 -2
- package/dist/{logger-U8lgdc9x.d.mts.map → logger-DntcxxHg.d.mts.map} +1 -1
- package/dist/logger.d.mts +1 -1
- package/dist/{middleware-CAQHJRN1.d.mts → middleware-U-lIAzHg.d.mts} +2 -2
- package/dist/{middleware-CAQHJRN1.d.mts.map → middleware-U-lIAzHg.d.mts.map} +1 -1
- package/dist/nestjs/index.d.mts +2 -2
- package/dist/nestjs/index.d.mts.map +1 -1
- package/dist/nestjs/index.mjs +4 -5
- package/dist/nestjs/index.mjs.map +1 -1
- package/dist/next/client.d.mts +1 -1
- package/dist/next/index.d.mts +4 -4
- package/dist/next/index.mjs +2 -2
- package/dist/next/instrumentation.d.mts +1 -1
- package/dist/next/stream.d.mts +29 -0
- package/dist/next/stream.d.mts.map +1 -0
- package/dist/next/stream.mjs +78 -0
- package/dist/next/stream.mjs.map +1 -0
- package/dist/nitro/errorHandler.mjs +1 -1
- package/dist/nitro/module.d.mts +2 -2
- package/dist/nitro/plugin.mjs +11 -2
- package/dist/nitro/plugin.mjs.map +1 -1
- package/dist/nitro/v3/errorHandler.mjs +2 -2
- package/dist/nitro/v3/index.d.mts +2 -2
- package/dist/nitro/v3/module.d.mts +1 -1
- package/dist/nitro/v3/plugin.mjs +3 -3
- package/dist/nitro/v3/useLogger.d.mts +1 -1
- package/dist/{nitro-DavLelNz.mjs → nitro-DErMq_Zj.mjs} +1 -1
- package/dist/{nitro-DavLelNz.mjs.map → nitro-DErMq_Zj.mjs.map} +1 -1
- package/dist/{nitro-C6Bd682U.d.mts → nitro-oZre8ab3.d.mts} +2 -2
- package/dist/{nitro-C6Bd682U.d.mts.map → nitro-oZre8ab3.d.mts.map} +1 -1
- package/dist/{nitroConfigBridge-aZ1e5upQ.mjs → nitroConfigBridge-DKk7eOn-.mjs} +1 -1
- package/dist/{nitroConfigBridge-aZ1e5upQ.mjs.map → nitroConfigBridge-DKk7eOn-.mjs.map} +1 -1
- package/dist/nodeResponse-BkkionWl.mjs +42 -0
- package/dist/nodeResponse-BkkionWl.mjs.map +1 -0
- package/dist/nuxt/module.d.mts +28 -1
- package/dist/nuxt/module.d.mts.map +1 -1
- package/dist/nuxt/module.mjs +11 -4
- package/dist/nuxt/module.mjs.map +1 -1
- package/dist/package-v_MmOZeA.mjs +7 -0
- package/dist/package-v_MmOZeA.mjs.map +1 -0
- package/dist/{parseError-B-dKF6Fd.d.mts → parseError-yVZ58wIK.d.mts} +2 -2
- package/dist/parseError-yVZ58wIK.d.mts.map +1 -0
- package/dist/react-router/index.d.mts +2 -2
- package/dist/react-router/index.mjs +2 -2
- package/dist/{routes-B48wm7Pb.mjs → routes-CnIgYWf8.mjs} +1 -1
- package/dist/{routes-B48wm7Pb.mjs.map → routes-CnIgYWf8.mjs.map} +1 -1
- package/dist/runtime/client/log.d.mts +1 -1
- package/dist/runtime/server/routes/_evlog/stream-info.get.d.mts +18 -0
- package/dist/runtime/server/routes/_evlog/stream-info.get.d.mts.map +1 -0
- package/dist/runtime/server/routes/_evlog/stream-info.get.mjs +28 -0
- package/dist/runtime/server/routes/_evlog/stream-info.get.mjs.map +1 -0
- package/dist/runtime/server/useLogger.d.mts +1 -1
- package/dist/runtime/utils/parseError.d.mts +2 -2
- package/dist/{severity-BYWZ96Sb.mjs → severity-R5Egq3qz.mjs} +1 -1
- package/dist/{severity-BYWZ96Sb.mjs.map → severity-R5Egq3qz.mjs.map} +1 -1
- package/dist/{storage-BT-3fT1-.mjs → storage-Dwinmg8P.mjs} +1 -1
- package/dist/{storage-BT-3fT1-.mjs.map → storage-Dwinmg8P.mjs.map} +1 -1
- package/dist/stream.d.mts +185 -0
- package/dist/stream.d.mts.map +1 -0
- package/dist/stream.mjs +374 -0
- package/dist/stream.mjs.map +1 -0
- package/dist/sveltekit/index.d.mts +2 -2
- package/dist/sveltekit/index.mjs +3 -3
- package/dist/toolkit.d.mts +42 -7
- package/dist/toolkit.d.mts.map +1 -1
- package/dist/toolkit.mjs +10 -9
- package/dist/types.d.mts +2 -2
- package/dist/{useLogger-CoNgTjp5.d.mts → useLogger-BsPL4AQm.d.mts} +2 -2
- package/dist/{useLogger-CoNgTjp5.d.mts.map → useLogger-BsPL4AQm.d.mts.map} +1 -1
- package/dist/{utils-Db4qhBWn.d.mts → utils-DLCeShxL.d.mts} +2 -2
- package/dist/{utils-Db4qhBWn.d.mts.map → utils-DLCeShxL.d.mts.map} +1 -1
- package/dist/utils.d.mts +1 -1
- package/dist/vite/index.d.mts +1 -1
- package/dist/workers.d.mts +1 -1
- package/package.json +17 -1
- package/dist/drain-ByWUeOQC.mjs.map +0 -1
- package/dist/parseError-B-dKF6Fd.d.mts.map +0 -1
package/dist/index.mjs
CHANGED
|
@@ -4,4 +4,212 @@ import { EvlogError, createError } from "./error.mjs";
|
|
|
4
4
|
import { useLogger } from "./runtime/server/useLogger.mjs";
|
|
5
5
|
import { parseError } from "./runtime/utils/parseError.mjs";
|
|
6
6
|
import { n as toLoggerConfig, r as toMiddlewareOptions, t as defineEvlog } from "./define-D6OJdSUH.mjs";
|
|
7
|
-
|
|
7
|
+
//#region src/catalog.ts
|
|
8
|
+
function buildEvlogError(code, entry, rawArgs) {
|
|
9
|
+
const { message: messageOverride, status, why, fix, link, cause, internal: callInternal, ...maybeParams } = rawArgs ?? {};
|
|
10
|
+
let message;
|
|
11
|
+
if (typeof messageOverride === "string") message = messageOverride;
|
|
12
|
+
else if (typeof entry.message === "function") message = entry.message(maybeParams);
|
|
13
|
+
else ({message} = entry);
|
|
14
|
+
let internal;
|
|
15
|
+
if (entry.internal || callInternal) internal = {
|
|
16
|
+
...entry.internal ?? {},
|
|
17
|
+
...callInternal ?? {}
|
|
18
|
+
};
|
|
19
|
+
return new EvlogError({
|
|
20
|
+
code,
|
|
21
|
+
message,
|
|
22
|
+
status: status ?? entry.status ?? 500,
|
|
23
|
+
why: why ?? entry.why,
|
|
24
|
+
fix: fix ?? entry.fix,
|
|
25
|
+
link: link ?? entry.link,
|
|
26
|
+
cause,
|
|
27
|
+
internal
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Define a single, standalone error factory bound to a stable `code`.
|
|
32
|
+
*
|
|
33
|
+
* Each factory produces an {@link EvlogError} with the entry's defaults
|
|
34
|
+
* applied. Call-site overrides (`cause`, `internal`, `message`, ...) are
|
|
35
|
+
* shallow-merged onto those defaults.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* import { defineError } from 'evlog'
|
|
40
|
+
*
|
|
41
|
+
* export const PaymentDeclined = defineError('billing.PAYMENT_DECLINED', {
|
|
42
|
+
* status: 402,
|
|
43
|
+
* message: 'Card declined',
|
|
44
|
+
* why: 'Issuer declined the charge',
|
|
45
|
+
* fix: 'Try another card',
|
|
46
|
+
* })
|
|
47
|
+
*
|
|
48
|
+
* throw PaymentDeclined()
|
|
49
|
+
* throw PaymentDeclined({ cause: stripeErr, internal: { ref: 'ch_x' } })
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @example Templated message with typed params
|
|
53
|
+
* ```ts
|
|
54
|
+
* export const InsufficientFunds = defineError('billing.INSUFFICIENT_FUNDS', {
|
|
55
|
+
* status: 402,
|
|
56
|
+
* message: ({ available, required }: { available: number, required: number }) =>
|
|
57
|
+
* `Insufficient funds: $${available}/$${required}`,
|
|
58
|
+
* })
|
|
59
|
+
*
|
|
60
|
+
* throw InsufficientFunds({ available: 5, required: 100 })
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
function defineError(code, entry) {
|
|
64
|
+
const factory = ((...args) => buildEvlogError(code, entry, args[0]));
|
|
65
|
+
Object.defineProperties(factory, {
|
|
66
|
+
code: {
|
|
67
|
+
value: code,
|
|
68
|
+
enumerable: true
|
|
69
|
+
},
|
|
70
|
+
status: {
|
|
71
|
+
value: entry.status ?? 500,
|
|
72
|
+
enumerable: true
|
|
73
|
+
},
|
|
74
|
+
message: {
|
|
75
|
+
value: entry.message,
|
|
76
|
+
enumerable: true
|
|
77
|
+
},
|
|
78
|
+
why: {
|
|
79
|
+
value: entry.why,
|
|
80
|
+
enumerable: true
|
|
81
|
+
},
|
|
82
|
+
fix: {
|
|
83
|
+
value: entry.fix,
|
|
84
|
+
enumerable: true
|
|
85
|
+
},
|
|
86
|
+
link: {
|
|
87
|
+
value: entry.link,
|
|
88
|
+
enumerable: true
|
|
89
|
+
},
|
|
90
|
+
tags: {
|
|
91
|
+
value: entry.tags,
|
|
92
|
+
enumerable: true
|
|
93
|
+
},
|
|
94
|
+
internal: {
|
|
95
|
+
value: entry.internal,
|
|
96
|
+
enumerable: true
|
|
97
|
+
}
|
|
98
|
+
});
|
|
99
|
+
return factory;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Define a bundle of errors that share a common prefix. The wire `code` for
|
|
103
|
+
* each entry is `${prefix}.${KEY}` (the key's casing is preserved — convention
|
|
104
|
+
* is `UPPER_SNAKE_CASE`).
|
|
105
|
+
*
|
|
106
|
+
* Pair with `declare module 'evlog'` to surface autocomplete + literal-typed
|
|
107
|
+
* `code` everywhere across the codebase.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* import { defineErrorCatalog } from 'evlog'
|
|
112
|
+
*
|
|
113
|
+
* export const billingErrors = defineErrorCatalog('billing', {
|
|
114
|
+
* PAYMENT_DECLINED: { status: 402, message: 'Card declined' },
|
|
115
|
+
* INSUFFICIENT_FUNDS: {
|
|
116
|
+
* status: 402,
|
|
117
|
+
* message: ({ available, required }: { available: number, required: number }) =>
|
|
118
|
+
* `Insufficient funds: $${available}/$${required}`,
|
|
119
|
+
* },
|
|
120
|
+
* })
|
|
121
|
+
*
|
|
122
|
+
* declare module 'evlog' {
|
|
123
|
+
* interface RegisteredErrorCatalogs {
|
|
124
|
+
* billing: typeof billingErrors
|
|
125
|
+
* }
|
|
126
|
+
* }
|
|
127
|
+
*
|
|
128
|
+
* throw billingErrors.PAYMENT_DECLINED()
|
|
129
|
+
* throw billingErrors.INSUFFICIENT_FUNDS({ available: 5, required: 100 })
|
|
130
|
+
* ```
|
|
131
|
+
*/
|
|
132
|
+
function defineErrorCatalog(prefix, map) {
|
|
133
|
+
const out = {};
|
|
134
|
+
const codes = [];
|
|
135
|
+
for (const key of Object.keys(map)) {
|
|
136
|
+
const code = `${prefix}.${key}`;
|
|
137
|
+
out[key] = defineError(code, map[key]);
|
|
138
|
+
codes.push(code);
|
|
139
|
+
}
|
|
140
|
+
Object.defineProperties(out, {
|
|
141
|
+
_prefix: {
|
|
142
|
+
value: prefix,
|
|
143
|
+
enumerable: false
|
|
144
|
+
},
|
|
145
|
+
_codes: {
|
|
146
|
+
value: Object.freeze(codes),
|
|
147
|
+
enumerable: false
|
|
148
|
+
}
|
|
149
|
+
});
|
|
150
|
+
return out;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Define a bundle of audit actions that share a common prefix. The wire
|
|
154
|
+
* `action` for each entry is `${prefix}.${KEY}`.
|
|
155
|
+
*
|
|
156
|
+
* Each entry produces a thin wrapper around {@link defineAuditAction} (target
|
|
157
|
+
* type is fixed at definition time, action name is auto-prefixed).
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* ```ts
|
|
161
|
+
* import { defineAuditCatalog } from 'evlog'
|
|
162
|
+
*
|
|
163
|
+
* export const billingAudit = defineAuditCatalog('billing', {
|
|
164
|
+
* INVOICE_REFUND: { target: 'invoice' },
|
|
165
|
+
* INVOICE_CREATE: { target: 'invoice' },
|
|
166
|
+
* })
|
|
167
|
+
*
|
|
168
|
+
* declare module 'evlog' {
|
|
169
|
+
* interface RegisteredAuditCatalogs {
|
|
170
|
+
* billing: typeof billingAudit
|
|
171
|
+
* }
|
|
172
|
+
* }
|
|
173
|
+
*
|
|
174
|
+
* log.audit(billingAudit.INVOICE_REFUND({
|
|
175
|
+
* actor: { type: 'user', id: u.id },
|
|
176
|
+
* target: { id: 'inv_889' },
|
|
177
|
+
* }))
|
|
178
|
+
* ```
|
|
179
|
+
*/
|
|
180
|
+
function defineAuditCatalog(prefix, map) {
|
|
181
|
+
const out = {};
|
|
182
|
+
const actions = [];
|
|
183
|
+
for (const key of Object.keys(map)) {
|
|
184
|
+
const action = `${prefix}.${key}`;
|
|
185
|
+
const entry = map[key];
|
|
186
|
+
const fn = defineAuditAction(action, entry.target ? { target: entry.target } : void 0);
|
|
187
|
+
Object.defineProperties(fn, {
|
|
188
|
+
action: {
|
|
189
|
+
value: action,
|
|
190
|
+
enumerable: true
|
|
191
|
+
},
|
|
192
|
+
target: {
|
|
193
|
+
value: entry.target,
|
|
194
|
+
enumerable: true
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
out[key] = fn;
|
|
198
|
+
actions.push(action);
|
|
199
|
+
}
|
|
200
|
+
Object.defineProperties(out, {
|
|
201
|
+
_prefix: {
|
|
202
|
+
value: prefix,
|
|
203
|
+
enumerable: false
|
|
204
|
+
},
|
|
205
|
+
_actions: {
|
|
206
|
+
value: Object.freeze(actions),
|
|
207
|
+
enumerable: false
|
|
208
|
+
}
|
|
209
|
+
});
|
|
210
|
+
return out;
|
|
211
|
+
}
|
|
212
|
+
//#endregion
|
|
213
|
+
export { AUDIT_SCHEMA_VERSION, AuditDeniedError, EvlogError, audit, auditDiff, auditEnricher, auditOnly, auditRedactPreset, buildAuditFields, createError, createError as createEvlogError, createLogger, createRequestLogger, defineAuditAction, defineAuditCatalog, defineError, defineErrorCatalog, defineEvlog, definePlugin, drainPlugin, enricherPlugin, getEnvironment, initLogger, isEnabled, isLevelEnabled, _log as log, mockAudit, parseError, shouldKeep, signed, toLoggerConfig, toMiddlewareOptions, useLogger, withAudit, withAuditMethods };
|
|
214
|
+
|
|
215
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/catalog.ts"],"sourcesContent":["import type { AuditInput } from './audit'\nimport type { AuditTarget } from './types'\nimport { defineAuditAction } from './audit'\nimport { EvlogError } from './error'\n\n/**\n * Static metadata for a single entry in an error catalog.\n *\n * `message` is either a constant string or a function that receives required\n * params at the call site (typed). All other fields are templated defaults\n * that can be overridden at the call site.\n */\nexport interface ErrorCatalogEntry {\n /** HTTP status code (default: 500). */\n status?: number\n /**\n * Either a constant string or a typed function whose params become required\n * arguments at the call site (`factory({ available, required })`).\n */\n message: string | ((params: never) => string)\n /** Why this error occurred (technical reason). */\n why?: string\n /** Actionable fix shown to the user. */\n fix?: string\n /** Link to documentation. */\n link?: string\n /** Free-form metadata for grouping / filtering (not surfaced on the wire). */\n tags?: readonly string[]\n /**\n * Backend-only context defaults. Merged with call-site `internal` (call-site wins).\n */\n internal?: Record<string, unknown>\n}\n\n/**\n * Subset of {@link import('./types').ErrorOptions} that callers may override\n * when invoking a catalog factory. `code` is always derived from the catalog\n * and intentionally excluded — pass `cause` here for error chaining.\n */\nexport interface ErrorFactoryOverrides {\n message?: string\n status?: number\n why?: string\n fix?: string\n link?: string\n internal?: Record<string, unknown>\n cause?: Error\n}\n\n/** @internal Extract the params object type from a templated message function. */\ntype MessageParams<TMessage> = TMessage extends (params: infer P) => string ? P : Record<string, never>\n\n/**\n * Call-site argument type for a catalog factory:\n * - if `message` is a function: required params object merged with overrides\n * - if `message` is a string: optional overrides only\n */\nexport type ErrorFactoryOpts<TEntry extends ErrorCatalogEntry> =\n TEntry['message'] extends (params: infer _P) => string\n ? MessageParams<TEntry['message']> & ErrorFactoryOverrides\n : ErrorFactoryOverrides\n\n/** @internal When message is a string, the call-site argument is optional. */\ntype FactoryArgs<TEntry extends ErrorCatalogEntry> =\n TEntry['message'] extends (params: never) => string\n ? [opts: ErrorFactoryOpts<TEntry>]\n : [opts?: ErrorFactoryOpts<TEntry>]\n\n/**\n * A factory produced by {@link defineError} or each entry of\n * {@link defineErrorCatalog}. Calling it returns a fully-formed\n * {@link EvlogError} with the catalog's defaults applied. Static metadata\n * is exposed as readonly properties for introspection / refactor-safe\n * comparisons (`err.code === MyError.code`).\n */\nexport type DefinedError<TCode extends string, TEntry extends ErrorCatalogEntry> =\n & ((...args: FactoryArgs<TEntry>) => EvlogError)\n & {\n readonly code: TCode\n readonly status: number\n readonly message: TEntry['message']\n readonly why: TEntry['why']\n readonly fix: TEntry['fix']\n readonly link: TEntry['link']\n readonly tags: TEntry['tags']\n readonly internal: TEntry['internal']\n }\n\nfunction buildEvlogError(\n code: string,\n entry: ErrorCatalogEntry,\n rawArgs: Record<string, unknown> | undefined,\n): EvlogError {\n const args = rawArgs ?? {}\n const {\n message: messageOverride,\n status,\n why,\n fix,\n link,\n cause,\n internal: callInternal,\n ...maybeParams\n } = args as ErrorFactoryOverrides & Record<string, unknown>\n\n let message: string\n if (typeof messageOverride === 'string') {\n message = messageOverride\n } else if (typeof entry.message === 'function') {\n message = (entry.message as (p: unknown) => string)(maybeParams)\n } else {\n ({ message } = entry as { message: string })\n }\n\n let internal: Record<string, unknown> | undefined\n if (entry.internal || callInternal) {\n internal = { ...(entry.internal ?? {}), ...(callInternal ?? {}) }\n }\n\n return new EvlogError({\n code,\n message,\n status: status ?? entry.status ?? 500,\n why: why ?? entry.why,\n fix: fix ?? entry.fix,\n link: link ?? entry.link,\n cause: cause as Error | undefined,\n internal,\n })\n}\n\n/**\n * Define a single, standalone error factory bound to a stable `code`.\n *\n * Each factory produces an {@link EvlogError} with the entry's defaults\n * applied. Call-site overrides (`cause`, `internal`, `message`, ...) are\n * shallow-merged onto those defaults.\n *\n * @example\n * ```ts\n * import { defineError } from 'evlog'\n *\n * export const PaymentDeclined = defineError('billing.PAYMENT_DECLINED', {\n * status: 402,\n * message: 'Card declined',\n * why: 'Issuer declined the charge',\n * fix: 'Try another card',\n * })\n *\n * throw PaymentDeclined()\n * throw PaymentDeclined({ cause: stripeErr, internal: { ref: 'ch_x' } })\n * ```\n *\n * @example Templated message with typed params\n * ```ts\n * export const InsufficientFunds = defineError('billing.INSUFFICIENT_FUNDS', {\n * status: 402,\n * message: ({ available, required }: { available: number, required: number }) =>\n * `Insufficient funds: $${available}/$${required}`,\n * })\n *\n * throw InsufficientFunds({ available: 5, required: 100 })\n * ```\n */\nexport function defineError<\n const TCode extends string,\n const TEntry extends ErrorCatalogEntry,\n>(code: TCode, entry: TEntry): DefinedError<TCode, TEntry> {\n const factory = ((...args: unknown[]) =>\n buildEvlogError(code, entry, args[0] as Record<string, unknown> | undefined)) as DefinedError<TCode, TEntry>\n\n Object.defineProperties(factory, {\n code: { value: code, enumerable: true },\n status: { value: entry.status ?? 500, enumerable: true },\n message: { value: entry.message, enumerable: true },\n why: { value: entry.why, enumerable: true },\n fix: { value: entry.fix, enumerable: true },\n link: { value: entry.link, enumerable: true },\n tags: { value: entry.tags, enumerable: true },\n internal: { value: entry.internal, enumerable: true },\n })\n\n return factory\n}\n\n/** Map of error catalog entries keyed by their (UPPER_SNAKE) name. */\nexport interface ErrorCatalogMap {\n readonly [key: string]: ErrorCatalogEntry\n}\n\n/**\n * The object returned by {@link defineErrorCatalog}. Each map key becomes a\n * dot-accessed factory whose `code` is `${prefix}.${key}` (preserved casing).\n *\n * Catalog metadata (`_prefix`, `_codes`) is exposed as non-enumerable readonly\n * properties so it does not pollute iteration but is available for typing\n * (`declare module 'evlog'`) and runtime introspection.\n */\nexport type ErrorCatalog<TPrefix extends string, TMap extends ErrorCatalogMap> =\n & { [K in keyof TMap & string]: DefinedError<`${TPrefix}.${K}`, TMap[K]> }\n & {\n readonly _prefix: TPrefix\n readonly _codes: ReadonlyArray<`${TPrefix}.${keyof TMap & string}`>\n }\n\n/**\n * Define a bundle of errors that share a common prefix. The wire `code` for\n * each entry is `${prefix}.${KEY}` (the key's casing is preserved — convention\n * is `UPPER_SNAKE_CASE`).\n *\n * Pair with `declare module 'evlog'` to surface autocomplete + literal-typed\n * `code` everywhere across the codebase.\n *\n * @example\n * ```ts\n * import { defineErrorCatalog } from 'evlog'\n *\n * export const billingErrors = defineErrorCatalog('billing', {\n * PAYMENT_DECLINED: { status: 402, message: 'Card declined' },\n * INSUFFICIENT_FUNDS: {\n * status: 402,\n * message: ({ available, required }: { available: number, required: number }) =>\n * `Insufficient funds: $${available}/$${required}`,\n * },\n * })\n *\n * declare module 'evlog' {\n * interface RegisteredErrorCatalogs {\n * billing: typeof billingErrors\n * }\n * }\n *\n * throw billingErrors.PAYMENT_DECLINED()\n * throw billingErrors.INSUFFICIENT_FUNDS({ available: 5, required: 100 })\n * ```\n */\nexport function defineErrorCatalog<\n const TPrefix extends string,\n const TMap extends ErrorCatalogMap,\n>(prefix: TPrefix, map: TMap): ErrorCatalog<TPrefix, TMap> {\n const out: Record<string, unknown> = {}\n const codes: string[] = []\n\n for (const key of Object.keys(map)) {\n const code = `${prefix}.${key}`\n out[key] = defineError(code, map[key])\n codes.push(code)\n }\n\n Object.defineProperties(out, {\n _prefix: { value: prefix, enumerable: false },\n _codes: { value: Object.freeze(codes), enumerable: false },\n })\n\n return out as ErrorCatalog<TPrefix, TMap>\n}\n\n/** Static metadata for a single entry in an audit catalog. */\nexport interface AuditCatalogEntry {\n /** Default `target.type` for every audit emitted from this action. */\n target?: string\n}\n\n/** Map of audit catalog entries keyed by their (UPPER_SNAKE) name. */\nexport interface AuditCatalogMap {\n readonly [key: string]: AuditCatalogEntry\n}\n\n/** A factory produced by an audit catalog entry. Returns an {@link AuditInput}. */\nexport type DefinedCatalogAudit<TAction extends string, TEntry extends AuditCatalogEntry> =\n & ((\n input: TEntry['target'] extends string\n ? Omit<AuditInput, 'action' | 'target'> & { target?: Omit<AuditTarget, 'type'> & { type?: TEntry['target'] } }\n : Omit<AuditInput, 'action'>,\n ) => AuditInput)\n & {\n readonly action: TAction\n readonly target: TEntry['target']\n }\n\n/**\n * The object returned by {@link defineAuditCatalog}. Mirrors\n * {@link ErrorCatalog} but each factory produces an {@link AuditInput}\n * (typically passed to `log.audit(...)`).\n */\nexport type AuditCatalog<TPrefix extends string, TMap extends AuditCatalogMap> =\n & { [K in keyof TMap & string]: DefinedCatalogAudit<`${TPrefix}.${K}`, TMap[K]> }\n & {\n readonly _prefix: TPrefix\n readonly _actions: ReadonlyArray<`${TPrefix}.${keyof TMap & string}`>\n }\n\n/**\n * Define a bundle of audit actions that share a common prefix. The wire\n * `action` for each entry is `${prefix}.${KEY}`.\n *\n * Each entry produces a thin wrapper around {@link defineAuditAction} (target\n * type is fixed at definition time, action name is auto-prefixed).\n *\n * @example\n * ```ts\n * import { defineAuditCatalog } from 'evlog'\n *\n * export const billingAudit = defineAuditCatalog('billing', {\n * INVOICE_REFUND: { target: 'invoice' },\n * INVOICE_CREATE: { target: 'invoice' },\n * })\n *\n * declare module 'evlog' {\n * interface RegisteredAuditCatalogs {\n * billing: typeof billingAudit\n * }\n * }\n *\n * log.audit(billingAudit.INVOICE_REFUND({\n * actor: { type: 'user', id: u.id },\n * target: { id: 'inv_889' },\n * }))\n * ```\n */\nexport function defineAuditCatalog<\n const TPrefix extends string,\n const TMap extends AuditCatalogMap,\n>(prefix: TPrefix, map: TMap): AuditCatalog<TPrefix, TMap> {\n const out: Record<string, unknown> = {}\n const actions: string[] = []\n\n for (const key of Object.keys(map)) {\n const action = `${prefix}.${key}`\n const entry = map[key]\n const fn = defineAuditAction(action, entry.target ? { target: entry.target } : undefined) as ((input: unknown) => AuditInput) & { action: string, target?: string }\n Object.defineProperties(fn, {\n action: { value: action, enumerable: true },\n target: { value: entry.target, enumerable: true },\n })\n out[key] = fn\n actions.push(action)\n }\n\n Object.defineProperties(out, {\n _prefix: { value: prefix, enumerable: false },\n _actions: { value: Object.freeze(actions), enumerable: false },\n })\n\n return out as AuditCatalog<TPrefix, TMap>\n}\n"],"mappings":";;;;;;;AAwFA,SAAS,gBACP,MACA,OACA,SACY;CAEZ,MAAM,EACJ,SAAS,iBACT,QACA,KACA,KACA,MACA,OACA,UAAU,cACV,GAAG,gBATQ,WAAW,EAAE;CAY1B,IAAI;AACJ,KAAI,OAAO,oBAAoB,SAC7B,WAAU;UACD,OAAO,MAAM,YAAY,WAClC,WAAW,MAAM,QAAmC,YAAY;KAEhE,EAAC,CAAE,WAAY;CAGjB,IAAI;AACJ,KAAI,MAAM,YAAY,aACpB,YAAW;EAAE,GAAI,MAAM,YAAY,EAAE;EAAG,GAAI,gBAAgB,EAAE;EAAG;AAGnE,QAAO,IAAI,WAAW;EACpB;EACA;EACA,QAAQ,UAAU,MAAM,UAAU;EAClC,KAAK,OAAO,MAAM;EAClB,KAAK,OAAO,MAAM;EAClB,MAAM,QAAQ,MAAM;EACb;EACP;EACD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCJ,SAAgB,YAGd,MAAa,OAA4C;CACzD,MAAM,YAAY,GAAG,SACnB,gBAAgB,MAAM,OAAO,KAAK,GAA0C;AAE9E,QAAO,iBAAiB,SAAS;EAC/B,MAAM;GAAE,OAAO;GAAM,YAAY;GAAM;EACvC,QAAQ;GAAE,OAAO,MAAM,UAAU;GAAK,YAAY;GAAM;EACxD,SAAS;GAAE,OAAO,MAAM;GAAS,YAAY;GAAM;EACnD,KAAK;GAAE,OAAO,MAAM;GAAK,YAAY;GAAM;EAC3C,KAAK;GAAE,OAAO,MAAM;GAAK,YAAY;GAAM;EAC3C,MAAM;GAAE,OAAO,MAAM;GAAM,YAAY;GAAM;EAC7C,MAAM;GAAE,OAAO,MAAM;GAAM,YAAY;GAAM;EAC7C,UAAU;GAAE,OAAO,MAAM;GAAU,YAAY;GAAM;EACtD,CAAC;AAEF,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDT,SAAgB,mBAGd,QAAiB,KAAwC;CACzD,MAAM,MAA+B,EAAE;CACvC,MAAM,QAAkB,EAAE;AAE1B,MAAK,MAAM,OAAO,OAAO,KAAK,IAAI,EAAE;EAClC,MAAM,OAAO,GAAG,OAAO,GAAG;AAC1B,MAAI,OAAO,YAAY,MAAM,IAAI,KAAK;AACtC,QAAM,KAAK,KAAK;;AAGlB,QAAO,iBAAiB,KAAK;EAC3B,SAAS;GAAE,OAAO;GAAQ,YAAY;GAAO;EAC7C,QAAQ;GAAE,OAAO,OAAO,OAAO,MAAM;GAAE,YAAY;GAAO;EAC3D,CAAC;AAEF,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkET,SAAgB,mBAGd,QAAiB,KAAwC;CACzD,MAAM,MAA+B,EAAE;CACvC,MAAM,UAAoB,EAAE;AAE5B,MAAK,MAAM,OAAO,OAAO,KAAK,IAAI,EAAE;EAClC,MAAM,SAAS,GAAG,OAAO,GAAG;EAC5B,MAAM,QAAQ,IAAI;EAClB,MAAM,KAAK,kBAAkB,QAAQ,MAAM,SAAS,EAAE,QAAQ,MAAM,QAAQ,GAAG,KAAA,EAAU;AACzF,SAAO,iBAAiB,IAAI;GAC1B,QAAQ;IAAE,OAAO;IAAQ,YAAY;IAAM;GAC3C,QAAQ;IAAE,OAAO,MAAM;IAAQ,YAAY;IAAM;GAClD,CAAC;AACF,MAAI,OAAO;AACX,UAAQ,KAAK,OAAO;;AAGtB,QAAO,iBAAiB,KAAK;EAC3B,SAAS;GAAE,OAAO;GAAQ,YAAY;GAAO;EAC7C,UAAU;GAAE,OAAO,OAAO,OAAO,QAAQ;GAAE,YAAY;GAAO;EAC/D,CAAC;AAEF,QAAO"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { n as extractSafeNodeHeaders, t as extractSafeHeaders } from "./headers-CU-QqnYg.mjs";
|
|
2
|
-
import { r as createMiddlewareLogger, t as attachForkToLogger } from "./fork-
|
|
2
|
+
import { r as createMiddlewareLogger, t as attachForkToLogger } from "./fork-8u_zFOJq.mjs";
|
|
3
3
|
//#region src/shared/integration.ts
|
|
4
4
|
function normalizeHeaders(headers) {
|
|
5
5
|
if (!headers) return void 0;
|
|
@@ -72,4 +72,4 @@ function defineFrameworkIntegration(spec) {
|
|
|
72
72
|
//#endregion
|
|
73
73
|
export { defineFrameworkIntegration as t };
|
|
74
74
|
|
|
75
|
-
//# sourceMappingURL=integration-
|
|
75
|
+
//# sourceMappingURL=integration-DTZtjSqh.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integration-
|
|
1
|
+
{"version":3,"file":"integration-DTZtjSqh.mjs","names":[],"sources":["../src/shared/integration.ts"],"sourcesContent":["import type { AsyncLocalStorage } from 'node:async_hooks'\nimport type { RequestLogger } from '../types'\nimport { attachForkToLogger } from './fork'\nimport { extractSafeHeaders, extractSafeNodeHeaders } from './headers'\nimport type { BaseEvlogOptions, MiddlewareLoggerOptions, MiddlewareLoggerResult } from './middleware'\nimport { createMiddlewareLogger } from './middleware'\n\n/** Request shape extracted from a framework context. */\nexport interface ExtractedRequest {\n method: string\n path: string\n /**\n * Either a Web `Headers` (Hono / Elysia / Fetch) or a Node-style\n * `IncomingHttpHeaders` record (Express / Fastify). Whichever is native\n * to the framework — it gets filtered through the safe-header helpers.\n */\n headers?: Headers | Record<string, string | string[] | undefined>\n /** Used as-is when present, otherwise auto-generated. */\n requestId?: string\n}\n\n/** Manifest passed to {@link defineFrameworkIntegration}. */\nexport interface FrameworkIntegrationSpec<TCtx> {\n /** Stable identifier used in error messages. */\n name: string\n extractRequest: (ctx: TCtx) => ExtractedRequest\n /** Attach the request logger to the framework context (`c.set('log', logger)`). */\n attachLogger: (ctx: TCtx, logger: RequestLogger) => void\n /**\n * AsyncLocalStorage instance backing `useLogger()`. Required for frameworks\n * where the logger is accessed off the request context (Express, Fastify,\n * NestJS). When set, `log.fork()` is auto-attached to the request logger.\n */\n storage?: AsyncLocalStorage<RequestLogger>\n /** Fork lifecycle hooks (only used when `storage` is set). */\n forkLifecycle?: import('./fork').ForkLifecycle\n}\n\n/** Result returned by {@link FrameworkIntegrationHelpers.start}. */\nexport interface FrameworkRequestHandle extends MiddlewareLoggerResult {\n middlewareOptions: MiddlewareLoggerOptions\n /**\n * Run the downstream handler inside the integration's storage. When no\n * storage is configured, the callback is invoked directly.\n */\n runWith: <T>(fn: () => T | Promise<T>) => Promise<T>\n}\n\n/** Helpers returned by {@link defineFrameworkIntegration}. */\nexport interface FrameworkIntegrationHelpers<TCtx> {\n start: (ctx: TCtx, options?: BaseEvlogOptions) => FrameworkRequestHandle\n}\n\nfunction normalizeHeaders(headers: ExtractedRequest['headers']): Record<string, string> | undefined {\n if (!headers) return undefined\n if (typeof (headers as Headers).forEach === 'function' && typeof (headers as Headers).get === 'function') {\n return extractSafeHeaders(headers as Headers)\n }\n return extractSafeNodeHeaders(headers as Record<string, string | string[] | undefined>)\n}\n\n/**\n * Build a manifest-driven framework integration. Captures the boilerplate\n * every middleware shares (request extraction, logger setup, attachment,\n * optional AsyncLocalStorage wrapping). The framework still owns its own\n * middleware function — it just declares *what* to extract and *where* to\n * attach the logger.\n *\n * @example\n * ```ts\n * const integration = defineFrameworkIntegration<HonoContext>({\n * name: 'hono',\n * extractRequest: (c) => ({\n * method: c.req.method,\n * path: c.req.path,\n * headers: c.req.raw.headers,\n * requestId: c.req.header('x-request-id'),\n * }),\n * attachLogger: (c, logger) => c.set('log', logger),\n * })\n *\n * export function evlog(options?: BaseEvlogOptions): MiddlewareHandler {\n * return async (c, next) => {\n * const { skipped, finish, runWith } = integration.start(c, options)\n * if (skipped) return next()\n * try {\n * await runWith(() => next())\n * await finish({ status: c.res.status })\n * } catch (error) {\n * await finish({ error: error as Error })\n * throw error\n * }\n * }\n * }\n * ```\n */\nexport function defineFrameworkIntegration<TCtx>(\n spec: FrameworkIntegrationSpec<TCtx>,\n): FrameworkIntegrationHelpers<TCtx> {\n return {\n start(ctx, options = {}) {\n const extracted = spec.extractRequest(ctx)\n const headers = normalizeHeaders(extracted.headers)\n const middlewareOptions: MiddlewareLoggerOptions = {\n method: extracted.method,\n path: extracted.path,\n requestId: extracted.requestId || crypto.randomUUID(),\n headers,\n ...options,\n }\n const result = createMiddlewareLogger(middlewareOptions)\n\n if (!result.skipped) {\n if (spec.storage) {\n attachForkToLogger(spec.storage, result.logger, middlewareOptions, spec.forkLifecycle)\n }\n spec.attachLogger(ctx, result.logger)\n }\n\n const { storage } = spec\n const runWith = async <T>(fn: () => T | Promise<T>): Promise<T> => {\n if (!storage || result.skipped) return await fn()\n return await storage.run(result.logger, fn)\n }\n\n return { ...result, middlewareOptions, runWith }\n },\n }\n}\n"],"mappings":";;;AAqDA,SAAS,iBAAiB,SAA0E;AAClG,KAAI,CAAC,QAAS,QAAO,KAAA;AACrB,KAAI,OAAQ,QAAoB,YAAY,cAAc,OAAQ,QAAoB,QAAQ,WAC5F,QAAO,mBAAmB,QAAmB;AAE/C,QAAO,uBAAuB,QAAyD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCzF,SAAgB,2BACd,MACmC;AACnC,QAAO,EACL,MAAM,KAAK,UAAU,EAAE,EAAE;EACvB,MAAM,YAAY,KAAK,eAAe,IAAI;EAC1C,MAAM,UAAU,iBAAiB,UAAU,QAAQ;EACnD,MAAM,oBAA6C;GACjD,QAAQ,UAAU;GAClB,MAAM,UAAU;GAChB,WAAW,UAAU,aAAa,OAAO,YAAY;GACrD;GACA,GAAG;GACJ;EACD,MAAM,SAAS,uBAAuB,kBAAkB;AAExD,MAAI,CAAC,OAAO,SAAS;AACnB,OAAI,KAAK,QACP,oBAAmB,KAAK,SAAS,OAAO,QAAQ,mBAAmB,KAAK,cAAc;AAExF,QAAK,aAAa,KAAK,OAAO,OAAO;;EAGvC,MAAM,EAAE,YAAY;EACpB,MAAM,UAAU,OAAU,OAAyC;AACjE,OAAI,CAAC,WAAW,OAAO,QAAS,QAAO,MAAM,IAAI;AACjD,UAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ,GAAG;;AAG7C,SAAO;GAAE,GAAG;GAAQ;GAAmB;GAAS;IAEnD"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { G as Log, I as DrainContext, R as EnvironmentContext, dt as PluginRunner, et as RequestLoggerOptions, ot as TailSamplingContext, q as LoggerConfig, u as AuditableLogger } from "./audit-CC8nfazi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/logger.d.ts
|
|
4
4
|
/**
|
|
@@ -111,4 +111,4 @@ declare function createRequestLogger<T extends object = Record<string, unknown>>
|
|
|
111
111
|
declare function getEnvironment(): EnvironmentContext;
|
|
112
112
|
//#endregion
|
|
113
113
|
export { getGlobalDrain as a, isEnabled as c, shouldKeep as d, getEnvironment as i, isLoggerLocked as l, createLogger as n, getGlobalPluginRunner as o, createRequestLogger as r, initLogger as s, _log as t, lockLogger as u };
|
|
114
|
-
//# sourceMappingURL=logger-
|
|
114
|
+
//# sourceMappingURL=logger-DntcxxHg.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger-
|
|
1
|
+
{"version":3,"file":"logger-DntcxxHg.d.mts","names":[],"sources":["../src/logger.ts"],"mappings":";;;AAgEA;;;;AAAA,iBAAgB,UAAA,CAAW,MAAA,GAAQ,YAAA;AAsCnC;;;;;AAAA,iBAAgB,qBAAA,CAAA,GAAyB,YAAA;;;;iBAOzB,SAAA,CAAA;AAShB;;;;;AAAA,iBAAgB,UAAA,CAAA;;;;iBAOA,cAAA,CAAA;AAShB;;;;;AAAA,iBAAgB,cAAA,CAAA,KAAoB,GAAA,EAAK,YAAA,YAAwB,OAAA;;;;AA8BjE;iBAAgB,UAAA,CAAW,GAAA,EAAK,mBAAA;;;;AAgB/B;;;;;AAiYqB;cAPhB,IAAA,EAAM,GAAA;;;;UA2BF,2BAAA;EASK;;;AAkBf;EAtBE,WAAA;EAsB0B;;;EAlB1B,SAAA,IAAa,OAAA,EAAS,OAAA;AAAA;;;;;;;;;;;;;;AAgNxB;;iBA9LgB,YAAA,oBAAgC,MAAA,kBAAA,CAAyB,cAAA,GAAgB,MAAA,mBAA8B,eAAA,GAAkB,2BAAA,GAA8B,eAAA,CAAgB,CAAA;;;;;;;;;;;;;;;;;;AA6MvL;;;;;;;;;;iBAfgB,mBAAA,oBAAuC,MAAA,kBAAA,CAAyB,OAAA,GAAS,oBAAA,EAA2B,eAAA,GAAkB,2BAAA,GAA8B,eAAA,CAAgB,CAAA;;;;iBAepK,cAAA,CAAA,GAAkB,kBAAA"}
|
package/dist/logger.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as getGlobalDrain, c as isEnabled, d as shouldKeep, i as getEnvironment, l as isLoggerLocked, n as createLogger, o as getGlobalPluginRunner, r as createRequestLogger, s as initLogger, t as _log, u as lockLogger } from "./logger-
|
|
1
|
+
import { a as getGlobalDrain, c as isEnabled, d as shouldKeep, i as getEnvironment, l as isLoggerLocked, n as createLogger, o as getGlobalPluginRunner, r as createRequestLogger, s as initLogger, t as _log, u as lockLogger } from "./logger-DntcxxHg.mjs";
|
|
2
2
|
export { createLogger, createRequestLogger, getEnvironment, getGlobalDrain, getGlobalPluginRunner, initLogger, isEnabled, isLoggerLocked, lockLogger, _log as log, shouldKeep };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { $ as RequestLogger, I as DrainContext, L as EnrichContext, Y as RedactConfig, ct as WideEvent, dt as PluginRunner, ot as TailSamplingContext, tt as RouteConfig, ut as EvlogPlugin } from "./audit-CC8nfazi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/shared/middleware.d.ts
|
|
4
4
|
/**
|
|
@@ -69,4 +69,4 @@ declare function runEnrichAndDrain(emittedEvent: WideEvent, options: MiddlewareL
|
|
|
69
69
|
declare function createMiddlewareLogger(options: MiddlewareLoggerOptions): MiddlewareLoggerResult;
|
|
70
70
|
//#endregion
|
|
71
71
|
export { resolveMiddlewarePluginRunner as a, createMiddlewareLogger as i, MiddlewareLoggerOptions as n, runEnrichAndDrain as o, MiddlewareLoggerResult as r, BaseEvlogOptions as t };
|
|
72
|
-
//# sourceMappingURL=middleware-
|
|
72
|
+
//# sourceMappingURL=middleware-U-lIAzHg.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware-
|
|
1
|
+
{"version":3,"file":"middleware-U-lIAzHg.d.mts","names":[],"sources":["../src/shared/middleware.ts"],"mappings":";;;;AAYA;;;UAAiB,gBAAA;EAMN;EAJT,OAAA;EAMsC;EAJtC,OAAA;EAMwC;EAJxC,MAAA,GAAS,MAAA,SAAe,WAAA;EAMoB;EAJ5C,KAAA,IAAS,GAAA,EAAK,YAAA,YAAwB,OAAA;EAW5B;EATV,MAAA,IAAU,GAAA,EAAK,aAAA,YAAyB,OAAA;EASnB;EAPrB,IAAA,IAAQ,GAAA,EAAK,mBAAA,YAA+B,OAAA;EAR5C;;;;EAaA,MAAA,aAAmB,YAAA;EATL;EAWd,OAAA,GAAU,WAAA;AAAA;;UAIK,uBAAA,SAAgC,gBAAA;EAC/C,MAAA;EACA,IAAA;EACA,SAAA;EAda;EAgBb,OAAA,GAAU,MAAA;AAAA;AAAA,UAGK,sBAAA;EACf,MAAA,EAAQ,aAAA;EACR,MAAA,GAAS,IAAA;IAAS,MAAA;IAAiB,KAAA,GAAQ,KAAA;EAAA,MAAY,OAAA,CAAQ,SAAA;EAC/D,OAAA;AAAA;;;;;iBA6Bc,6BAAA,CAA8B,OAAA;EAAW,OAAA,GAAU,WAAA;AAAA,IAAkB,YAAA;;;;AAhCrF;iBAuDsB,iBAAA,CACpB,YAAA,EAAc,SAAA,EACd,OAAA,EAAS,uBAAA,EACT,WAAA;EAAe,MAAA;EAAgB,IAAA;EAAc,SAAA;AAAA,GAC7C,cAAA,WACA,OAAA,GAAU,YAAA,GACT,OAAA;;;;;;;;;iBA8Da,sBAAA,CAAuB,OAAA,EAAS,uBAAA,GAA0B,sBAAA"}
|
package/dist/nestjs/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { t as BaseEvlogOptions } from "../middleware-
|
|
1
|
+
import { $ as RequestLogger } from "../audit-CC8nfazi.mjs";
|
|
2
|
+
import { t as BaseEvlogOptions } from "../middleware-U-lIAzHg.mjs";
|
|
3
3
|
import { DynamicModule, MiddlewareConsumer, NestModule } from "@nestjs/common";
|
|
4
4
|
|
|
5
5
|
//#region src/nestjs/index.d.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/nestjs/index.ts"],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/nestjs/index.ts"],"mappings":";;;;;cAUiB,SAAA,sBAAS,MAAA,wBAAA,aAAA,CAAA,CAAA;AAAA,KAId,kBAAA,GAAqB,gBAAA;AAAA,UAIhB,uBAAA;EANhB;EAQC,OAAA;EAVwB;EAYxB,UAAA,MAAgB,IAAA,YAAgB,kBAAA,GAAqB,OAAA,CAAQ,kBAAA;EAZrC;EAcxB,MAAA;AAAA;AAAA;EAAA,UAIU,eAAA;IACR,GAAA,GAAM,aAAA;EAAA;AAAA;AAAA;EAAA,UAKE,OAAA;IACR,GAAA,GAAM,aAAA;EAAA;AAAA;AAjBV;;;;;;;;;;;;;;;;;AAOC;;;;;;;AAPD,cA0Ea,WAAA,YAAuB,UAAA;EAAA,eAEnB,OAAA;EAjEM;AAAA;;;;;;;;;;EAAA,OA8Ed,OAAA,CAAQ,OAAA,GAAS,kBAAA,GAA0B,aAAA;EAf3B;;;;;;;;;;;;;;EAAA,OAqChB,YAAA,CAAa,YAAA,EAAc,uBAAA,GAA0B,aAAA;EAkB5D,SAAA,CAAU,QAAA,EAAU,kBAAA;AAAA"}
|
package/dist/nestjs/index.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { n as extractSafeNodeHeaders } from "../headers-CU-QqnYg.mjs";
|
|
2
|
-
import { r as createMiddlewareLogger, t as attachForkToLogger } from "../fork-
|
|
3
|
-
import { t as
|
|
2
|
+
import { r as createMiddlewareLogger, t as attachForkToLogger } from "../fork-8u_zFOJq.mjs";
|
|
3
|
+
import { t as bindNodeResponseLifecycle } from "../nodeResponse-BkkionWl.mjs";
|
|
4
|
+
import { t as createLoggerStorage } from "../storage-Dwinmg8P.mjs";
|
|
4
5
|
//#region src/nestjs/index.ts
|
|
5
6
|
const { storage, useLogger } = createLoggerStorage("middleware context. Make sure EvlogModule.forRoot() is imported in your AppModule.");
|
|
6
7
|
function createEvlogMiddleware(getOptions) {
|
|
@@ -22,9 +23,7 @@ function createEvlogMiddleware(getOptions) {
|
|
|
22
23
|
}
|
|
23
24
|
attachForkToLogger(storage, logger, middlewareOpts);
|
|
24
25
|
req.log = logger;
|
|
25
|
-
res
|
|
26
|
-
finish({ status: res.statusCode }).catch(() => {});
|
|
27
|
-
});
|
|
26
|
+
bindNodeResponseLifecycle(res, logger, finish);
|
|
28
27
|
storage.run(logger, () => next());
|
|
29
28
|
};
|
|
30
29
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/nestjs/index.ts"],"sourcesContent":["import type { ServerResponse } from 'node:http'\nimport type { Request } from 'express'\nimport type { DynamicModule, MiddlewareConsumer, NestModule } from '@nestjs/common'\nimport type { RequestLogger } from '../types'\nimport { createMiddlewareLogger, type BaseEvlogOptions } from '../shared/middleware'\nimport { attachForkToLogger } from '../shared/fork'\nimport { extractSafeNodeHeaders } from '../shared/headers'\nimport { createLoggerStorage } from '../shared/storage'\n\nconst { storage, useLogger } = createLoggerStorage(\n 'middleware context. Make sure EvlogModule.forRoot() is imported in your AppModule.',\n)\n\nexport type EvlogNestJSOptions = BaseEvlogOptions\n\nexport { useLogger }\n\nexport interface EvlogModuleAsyncOptions {\n /** Modules to import (for dependency injection into the factory) */\n imports?: any[]\n /** Factory function that returns evlog options. Can be async. */\n useFactory: (...args: any[]) => EvlogNestJSOptions | Promise<EvlogNestJSOptions>\n /** Injection tokens to resolve and pass to the factory */\n inject?: any[]\n}\n\ndeclare module 'http' {\n interface IncomingMessage {\n log?: RequestLogger\n }\n}\n\ndeclare module 'express-serve-static-core' {\n interface Request {\n log?: RequestLogger\n }\n}\n\nfunction createEvlogMiddleware(getOptions: () => EvlogNestJSOptions) {\n return (req: Request, res: ServerResponse, next: () => void) => {\n const options = getOptions()\n const headers = extractSafeNodeHeaders(req.headers)\n const url = new URL(req.originalUrl || req.url || '/', 'http://localhost')\n\n const middlewareOpts = {\n method: req.method || 'GET',\n path: url.pathname,\n requestId: headers['x-request-id'] || crypto.randomUUID(),\n headers,\n ...options,\n }\n const { logger, finish, skipped } = createMiddlewareLogger(middlewareOpts)\n\n if (skipped) {\n next()\n return\n }\n\n attachForkToLogger(storage, logger, middlewareOpts)\n req.log = logger\n\n res
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/nestjs/index.ts"],"sourcesContent":["import type { ServerResponse } from 'node:http'\nimport type { Request } from 'express'\nimport type { DynamicModule, MiddlewareConsumer, NestModule } from '@nestjs/common'\nimport type { RequestLogger } from '../types'\nimport { createMiddlewareLogger, type BaseEvlogOptions } from '../shared/middleware'\nimport { attachForkToLogger } from '../shared/fork'\nimport { extractSafeNodeHeaders } from '../shared/headers'\nimport { bindNodeResponseLifecycle } from '../shared/nodeResponse'\nimport { createLoggerStorage } from '../shared/storage'\n\nconst { storage, useLogger } = createLoggerStorage(\n 'middleware context. Make sure EvlogModule.forRoot() is imported in your AppModule.',\n)\n\nexport type EvlogNestJSOptions = BaseEvlogOptions\n\nexport { useLogger }\n\nexport interface EvlogModuleAsyncOptions {\n /** Modules to import (for dependency injection into the factory) */\n imports?: any[]\n /** Factory function that returns evlog options. Can be async. */\n useFactory: (...args: any[]) => EvlogNestJSOptions | Promise<EvlogNestJSOptions>\n /** Injection tokens to resolve and pass to the factory */\n inject?: any[]\n}\n\ndeclare module 'http' {\n interface IncomingMessage {\n log?: RequestLogger\n }\n}\n\ndeclare module 'express-serve-static-core' {\n interface Request {\n log?: RequestLogger\n }\n}\n\nfunction createEvlogMiddleware(getOptions: () => EvlogNestJSOptions) {\n return (req: Request, res: ServerResponse, next: () => void) => {\n const options = getOptions()\n const headers = extractSafeNodeHeaders(req.headers)\n const url = new URL(req.originalUrl || req.url || '/', 'http://localhost')\n\n const middlewareOpts = {\n method: req.method || 'GET',\n path: url.pathname,\n requestId: headers['x-request-id'] || crypto.randomUUID(),\n headers,\n ...options,\n }\n const { logger, finish, skipped } = createMiddlewareLogger(middlewareOpts)\n\n if (skipped) {\n next()\n return\n }\n\n attachForkToLogger(storage, logger, middlewareOpts)\n req.log = logger\n\n bindNodeResponseLifecycle(res, logger, finish)\n\n storage.run(logger, () => next())\n }\n}\n\n/**\n * NestJS module for evlog wide event logging.\n *\n * Registers a global middleware that creates a request-scoped logger\n * for every incoming request. Use `useLogger()` to access it anywhere\n * in the call stack, or `req.log` directly in controllers.\n *\n * @example\n * ```ts\n * import { Module } from '@nestjs/common'\n * import { EvlogModule } from 'evlog/nestjs'\n * import { createAxiomDrain } from 'evlog/axiom'\n *\n * @Module({\n * imports: [\n * EvlogModule.forRoot({\n * drain: createAxiomDrain(),\n * exclude: ['/health'],\n * }),\n * ],\n * })\n * export class AppModule {}\n * ```\n */\nexport class EvlogModule implements NestModule {\n\n private static options: EvlogNestJSOptions = {}\n\n /**\n * Register evlog with static configuration.\n *\n * @example\n * ```ts\n * EvlogModule.forRoot({\n * drain: createAxiomDrain(),\n * enrich: (ctx) => { ctx.event.region = process.env.FLY_REGION },\n * })\n * ```\n */\n static forRoot(options: EvlogNestJSOptions = {}): DynamicModule {\n EvlogModule.options = options\n return {\n module: EvlogModule,\n global: true,\n }\n }\n\n /**\n * Register evlog with async configuration (e.g. from `ConfigService`).\n *\n * @example\n * ```ts\n * EvlogModule.forRootAsync({\n * imports: [ConfigModule],\n * inject: [ConfigService],\n * useFactory: (config: ConfigService) => ({\n * drain: createAxiomDrain({ token: config.get('AXIOM_TOKEN') }),\n * }),\n * })\n * ```\n */\n static forRootAsync(asyncOptions: EvlogModuleAsyncOptions): DynamicModule {\n return {\n module: EvlogModule,\n imports: asyncOptions.imports || [],\n providers: [\n {\n provide: 'EVLOG_OPTIONS',\n useFactory: async (...args: any[]) => {\n EvlogModule.options = await asyncOptions.useFactory(...args)\n return EvlogModule.options\n },\n inject: asyncOptions.inject || [],\n },\n ],\n global: true,\n }\n }\n\n configure(consumer: MiddlewareConsumer): void {\n consumer\n .apply(createEvlogMiddleware(() => EvlogModule.options))\n .forRoutes('*')\n }\n\n}\n"],"mappings":";;;;;AAUA,MAAM,EAAE,SAAS,cAAc,oBAC7B,qFACD;AA2BD,SAAS,sBAAsB,YAAsC;AACnE,SAAQ,KAAc,KAAqB,SAAqB;EAC9D,MAAM,UAAU,YAAY;EAC5B,MAAM,UAAU,uBAAuB,IAAI,QAAQ;EACnD,MAAM,MAAM,IAAI,IAAI,IAAI,eAAe,IAAI,OAAO,KAAK,mBAAmB;EAE1E,MAAM,iBAAiB;GACrB,QAAQ,IAAI,UAAU;GACtB,MAAM,IAAI;GACV,WAAW,QAAQ,mBAAmB,OAAO,YAAY;GACzD;GACA,GAAG;GACJ;EACD,MAAM,EAAE,QAAQ,QAAQ,YAAY,uBAAuB,eAAe;AAE1E,MAAI,SAAS;AACX,SAAM;AACN;;AAGF,qBAAmB,SAAS,QAAQ,eAAe;AACnD,MAAI,MAAM;AAEV,4BAA0B,KAAK,QAAQ,OAAO;AAE9C,UAAQ,IAAI,cAAc,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BrC,IAAa,cAAb,MAAa,YAAkC;CAE7C,OAAe,UAA8B,EAAE;;;;;;;;;;;;CAa/C,OAAO,QAAQ,UAA8B,EAAE,EAAiB;AAC9D,cAAY,UAAU;AACtB,SAAO;GACL,QAAQ;GACR,QAAQ;GACT;;;;;;;;;;;;;;;;CAiBH,OAAO,aAAa,cAAsD;AACxE,SAAO;GACL,QAAQ;GACR,SAAS,aAAa,WAAW,EAAE;GACnC,WAAW,CACT;IACE,SAAS;IACT,YAAY,OAAO,GAAG,SAAgB;AACpC,iBAAY,UAAU,MAAM,aAAa,WAAW,GAAG,KAAK;AAC5D,YAAO,YAAY;;IAErB,QAAQ,aAAa,UAAU,EAAE;IAClC,CACF;GACD,QAAQ;GACT;;CAGH,UAAU,UAAoC;AAC5C,WACG,MAAM,4BAA4B,YAAY,QAAQ,CAAC,CACvD,UAAU,IAAI"}
|
package/dist/next/client.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { K as LogLevel, st as TransportConfig } from "../audit-CC8nfazi.mjs";
|
|
2
2
|
import { clearIdentity, log as _clientLog, setIdentity, setMinLevel } from "../runtime/client/log.mjs";
|
|
3
3
|
import * as _$react from "react";
|
|
4
4
|
|
package/dist/next/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { n as createError } from "../error-
|
|
3
|
-
import { t as _log } from "../logger-
|
|
4
|
-
import { t as BaseEvlogOptions } from "../middleware-
|
|
1
|
+
import { $ as RequestLogger, G as Log, K as LogLevel, R as EnvironmentContext, nt as SamplingConfig } from "../audit-CC8nfazi.mjs";
|
|
2
|
+
import { n as createError } from "../error-CpbbtyXL.mjs";
|
|
3
|
+
import { t as _log } from "../logger-DntcxxHg.mjs";
|
|
4
|
+
import { t as BaseEvlogOptions } from "../middleware-U-lIAzHg.mjs";
|
|
5
5
|
import { AsyncLocalStorage } from "node:async_hooks";
|
|
6
6
|
|
|
7
7
|
//#region src/next/types.d.ts
|
package/dist/next/index.mjs
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { S as isLoggerLocked, b as initLogger, g as createRequestLogger, m as _log, v as getGlobalDrain, x as isEnabled } from "../audit-pV5aLGP0.mjs";
|
|
2
2
|
import { filterSafeHeaders } from "../utils.mjs";
|
|
3
3
|
import { EvlogError, createError } from "../error.mjs";
|
|
4
|
-
import { n as shouldLog, t as getServiceForPath } from "../routes-
|
|
5
|
-
import { t as attachForkToLogger } from "../fork-
|
|
4
|
+
import { n as shouldLog, t as getServiceForPath } from "../routes-CnIgYWf8.mjs";
|
|
5
|
+
import { t as attachForkToLogger } from "../fork-8u_zFOJq.mjs";
|
|
6
6
|
import { AsyncLocalStorage } from "node:async_hooks";
|
|
7
7
|
//#region src/next/storage.ts
|
|
8
8
|
const evlogStorage = new AsyncLocalStorage();
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { I as DrainContext, K as LogLevel, R as EnvironmentContext, nt as SamplingConfig } from "../audit-CC8nfazi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/next/instrumentation.d.ts
|
|
4
4
|
/** Request payload passed to Next.js `onRequestError` (App Router). */
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { InstrumentationOptions, createInstrumentation } from "./instrumentation.mjs";
|
|
2
|
+
import { StreamServerOptions } from "../stream.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/next/stream.d.ts
|
|
5
|
+
interface StreamedInstrumentationOptions extends InstrumentationOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Live stream server.
|
|
8
|
+
*
|
|
9
|
+
* Strict opt-in — nothing starts unless this is set explicitly.
|
|
10
|
+
*
|
|
11
|
+
* - `true` — enable with defaults
|
|
12
|
+
* - `false` — off (same as omitting)
|
|
13
|
+
* - `StreamServerOptions` — full config (port, host, token, ...)
|
|
14
|
+
* - `undefined` (default) — off
|
|
15
|
+
*/
|
|
16
|
+
stream?: boolean | StreamServerOptions;
|
|
17
|
+
}
|
|
18
|
+
interface InstrumentationResult {
|
|
19
|
+
register: () => Promise<void>;
|
|
20
|
+
onRequestError: ReturnType<typeof createInstrumentation>['onRequestError'];
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Drop-in replacement for `createInstrumentation` that adds the local
|
|
24
|
+
* stream server lifecycle.
|
|
25
|
+
*/
|
|
26
|
+
declare function defineStreamedInstrumentation(options?: StreamedInstrumentationOptions): InstrumentationResult;
|
|
27
|
+
//#endregion
|
|
28
|
+
export { StreamedInstrumentationOptions, defineStreamedInstrumentation };
|
|
29
|
+
//# sourceMappingURL=stream.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream.d.mts","names":[],"sources":["../../src/next/stream.ts"],"mappings":";;;;UAkCiB,8BAAA,SAAuC,sBAAA;EAuBD;;;;;;;;;;EAZrD,MAAA,aAAmB,mBAAA;AAAA;AAAA,UAGX,qBAAA;EACR,QAAA,QAAgB,OAAA;EAChB,cAAA,EAAgB,UAAA,QAAkB,qBAAA;AAAA;;;;;iBAOpB,6BAAA,CAA8B,OAAA,GAAS,8BAAA,GAAsC,qBAAA"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { startStreamServer } from "../stream.mjs";
|
|
2
|
+
import { createInstrumentation } from "./instrumentation.mjs";
|
|
3
|
+
//#region src/next/stream.ts
|
|
4
|
+
/**
|
|
5
|
+
* Next.js helper that wires the local stream server into the standard
|
|
6
|
+
* `instrumentation.ts` pattern. Strict opt-in: nothing starts unless
|
|
7
|
+
* `stream: true` (or a config object) is passed explicitly.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* // lib/evlog.ts
|
|
12
|
+
* import { defineStreamedInstrumentation } from 'evlog/next/stream'
|
|
13
|
+
*
|
|
14
|
+
* export const { register, onRequestError } = defineStreamedInstrumentation({
|
|
15
|
+
* service: 'my-app',
|
|
16
|
+
* stream: true, // opt in to the local SSE stream server
|
|
17
|
+
* })
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* ```ts
|
|
21
|
+
* // instrumentation.ts
|
|
22
|
+
* import { defineNodeInstrumentation } from 'evlog/next/instrumentation'
|
|
23
|
+
*
|
|
24
|
+
* export const { register, onRequestError } = defineNodeInstrumentation(() =>
|
|
25
|
+
* import('./lib/evlog')
|
|
26
|
+
* )
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* When enabled, the mini server boots on first `register()` call and prints
|
|
30
|
+
* `[evlog] Stream → http://127.0.0.1:<port>`. Without `stream`, this is a
|
|
31
|
+
* straight pass-through to `createInstrumentation()`.
|
|
32
|
+
*/
|
|
33
|
+
/**
|
|
34
|
+
* Drop-in replacement for `createInstrumentation` that adds the local
|
|
35
|
+
* stream server lifecycle.
|
|
36
|
+
*/
|
|
37
|
+
function defineStreamedInstrumentation(options = {}) {
|
|
38
|
+
const { stream: streamOpt, drain: userDrain, ...rest } = options;
|
|
39
|
+
function shouldStartServer() {
|
|
40
|
+
if (streamOpt === true) return true;
|
|
41
|
+
if (streamOpt && typeof streamOpt === "object") return true;
|
|
42
|
+
return false;
|
|
43
|
+
}
|
|
44
|
+
const start = shouldStartServer();
|
|
45
|
+
let serverDrain = null;
|
|
46
|
+
async function register() {
|
|
47
|
+
if (start) {
|
|
48
|
+
const cfg = streamOpt && typeof streamOpt === "object" ? streamOpt : {};
|
|
49
|
+
try {
|
|
50
|
+
const server = await startStreamServer(cfg);
|
|
51
|
+
serverDrain = (ctx) => server.drain(ctx);
|
|
52
|
+
} catch (err) {
|
|
53
|
+
console.error("[evlog/next] failed to start stream server:", err);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
const composedDrain = composeDrains(userDrain, serverDrain);
|
|
57
|
+
createInstrumentation({
|
|
58
|
+
...rest,
|
|
59
|
+
drain: composedDrain
|
|
60
|
+
}).register();
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
register,
|
|
64
|
+
onRequestError: createInstrumentation({ ...rest }).onRequestError
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
function composeDrains(user, server) {
|
|
68
|
+
if (!user && !server) return void 0;
|
|
69
|
+
if (!user) return server;
|
|
70
|
+
if (!server) return user;
|
|
71
|
+
return async (ctx) => {
|
|
72
|
+
await Promise.all([Promise.resolve(user(ctx)), Promise.resolve(server(ctx))]);
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
//#endregion
|
|
76
|
+
export { defineStreamedInstrumentation };
|
|
77
|
+
|
|
78
|
+
//# sourceMappingURL=stream.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream.mjs","names":[],"sources":["../../src/next/stream.ts"],"sourcesContent":["/**\n * Next.js helper that wires the local stream server into the standard\n * `instrumentation.ts` pattern. Strict opt-in: nothing starts unless\n * `stream: true` (or a config object) is passed explicitly.\n *\n * @example\n * ```ts\n * // lib/evlog.ts\n * import { defineStreamedInstrumentation } from 'evlog/next/stream'\n *\n * export const { register, onRequestError } = defineStreamedInstrumentation({\n * service: 'my-app',\n * stream: true, // opt in to the local SSE stream server\n * })\n * ```\n *\n * ```ts\n * // instrumentation.ts\n * import { defineNodeInstrumentation } from 'evlog/next/instrumentation'\n *\n * export const { register, onRequestError } = defineNodeInstrumentation(() =>\n * import('./lib/evlog')\n * )\n * ```\n *\n * When enabled, the mini server boots on first `register()` call and prints\n * `[evlog] Stream → http://127.0.0.1:<port>`. Without `stream`, this is a\n * straight pass-through to `createInstrumentation()`.\n */\n\nimport { startStreamServer, type StreamServerOptions } from '../stream'\nimport type { DrainContext } from '../types'\nimport { createInstrumentation, type InstrumentationOptions } from './instrumentation'\n\nexport interface StreamedInstrumentationOptions extends InstrumentationOptions {\n /**\n * Live stream server.\n *\n * Strict opt-in — nothing starts unless this is set explicitly.\n *\n * - `true` — enable with defaults\n * - `false` — off (same as omitting)\n * - `StreamServerOptions` — full config (port, host, token, ...)\n * - `undefined` (default) — off\n */\n stream?: boolean | StreamServerOptions\n}\n\ninterface InstrumentationResult {\n register: () => Promise<void>\n onRequestError: ReturnType<typeof createInstrumentation>['onRequestError']\n}\n\n/**\n * Drop-in replacement for `createInstrumentation` that adds the local\n * stream server lifecycle.\n */\nexport function defineStreamedInstrumentation(options: StreamedInstrumentationOptions = {}): InstrumentationResult {\n const { stream: streamOpt, drain: userDrain, ...rest } = options\n\n function shouldStartServer(): boolean {\n if (streamOpt === true) return true\n if (streamOpt && typeof streamOpt === 'object') return true\n return false\n }\n\n const start: boolean = shouldStartServer()\n let serverDrain: ((ctx: DrainContext) => void | Promise<void>) | null = null\n\n async function register(): Promise<void> {\n if (start) {\n const cfg: StreamServerOptions = streamOpt && typeof streamOpt === 'object' ? streamOpt : {}\n try {\n const server = await startStreamServer(cfg)\n serverDrain = ctx => server.drain(ctx)\n } catch (err) {\n console.error('[evlog/next] failed to start stream server:', err)\n }\n }\n\n const composedDrain = composeDrains(userDrain, serverDrain)\n const inner = createInstrumentation({ ...rest, drain: composedDrain })\n inner.register()\n }\n\n // We intentionally instantiate a \"zero-time\" inner just for onRequestError —\n // it wires `log.error` which doesn't depend on the drain.\n const errorOnly = createInstrumentation({ ...rest })\n\n return {\n register,\n onRequestError: errorOnly.onRequestError,\n }\n}\n\nfunction composeDrains(\n user: ((ctx: DrainContext) => void | Promise<void>) | undefined,\n server: ((ctx: DrainContext) => void | Promise<void>) | null,\n): ((ctx: DrainContext) => void | Promise<void>) | undefined {\n if (!user && !server) return undefined\n if (!user) return server!\n if (!server) return user\n return async (ctx) => {\n await Promise.all([\n Promise.resolve(user(ctx)),\n Promise.resolve(server(ctx)),\n ])\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDA,SAAgB,8BAA8B,UAA0C,EAAE,EAAyB;CACjH,MAAM,EAAE,QAAQ,WAAW,OAAO,WAAW,GAAG,SAAS;CAEzD,SAAS,oBAA6B;AACpC,MAAI,cAAc,KAAM,QAAO;AAC/B,MAAI,aAAa,OAAO,cAAc,SAAU,QAAO;AACvD,SAAO;;CAGT,MAAM,QAAiB,mBAAmB;CAC1C,IAAI,cAAoE;CAExE,eAAe,WAA0B;AACvC,MAAI,OAAO;GACT,MAAM,MAA2B,aAAa,OAAO,cAAc,WAAW,YAAY,EAAE;AAC5F,OAAI;IACF,MAAM,SAAS,MAAM,kBAAkB,IAAI;AAC3C,mBAAc,QAAO,OAAO,MAAM,IAAI;YAC/B,KAAK;AACZ,YAAQ,MAAM,+CAA+C,IAAI;;;EAIrE,MAAM,gBAAgB,cAAc,WAAW,YAAY;AAC7C,wBAAsB;GAAE,GAAG;GAAM,OAAO;GAAe,CAChE,CAAC,UAAU;;AAOlB,QAAO;EACL;EACA,gBAJgB,sBAAsB,EAAE,GAAG,MAAM,CAIxB,CAAC;EAC3B;;AAGH,SAAS,cACP,MACA,QAC2D;AAC3D,KAAI,CAAC,QAAQ,CAAC,OAAQ,QAAO,KAAA;AAC7B,KAAI,CAAC,KAAM,QAAO;AAClB,KAAI,CAAC,OAAQ,QAAO;AACpB,QAAO,OAAO,QAAQ;AACpB,QAAM,QAAQ,IAAI,CAChB,QAAQ,QAAQ,KAAK,IAAI,CAAC,EAC1B,QAAQ,QAAQ,OAAO,IAAI,CAAC,CAC7B,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { t as extractErrorStatus } from "../errors-BQgyQ9xe.mjs";
|
|
2
|
-
import { n as serializeEvlogErrorResponse, t as resolveEvlogError } from "../nitro-
|
|
2
|
+
import { n as serializeEvlogErrorResponse, t as resolveEvlogError } from "../nitro-DErMq_Zj.mjs";
|
|
3
3
|
import { getRequestURL, send, setResponseHeader, setResponseStatus } from "h3";
|
|
4
4
|
import { defineNitroErrorHandler } from "nitropack/runtime/internal/error/utils";
|
|
5
5
|
//#region src/nitro/errorHandler.ts
|
package/dist/nitro/module.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { t as useLogger } from "../useLogger-
|
|
2
|
-
import { t as NitroModuleOptions } from "../nitro-
|
|
1
|
+
import { t as useLogger } from "../useLogger-BsPL4AQm.mjs";
|
|
2
|
+
import { t as NitroModuleOptions } from "../nitro-oZre8ab3.mjs";
|
|
3
3
|
import { Nitro } from "nitropack";
|
|
4
4
|
|
|
5
5
|
//#region src/nitro/module.d.ts
|
package/dist/nitro/plugin.mjs
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { A as normalizeRedactConfig, b as initLogger, g as createRequestLogger, x as isEnabled, y as getGlobalPluginRunner } from "../audit-pV5aLGP0.mjs";
|
|
2
2
|
import { filterSafeHeaders } from "../utils.mjs";
|
|
3
3
|
import { t as extractErrorStatus } from "../errors-BQgyQ9xe.mjs";
|
|
4
|
-
import { n as shouldLog, t as getServiceForPath } from "../routes-
|
|
5
|
-
import { n as resolveEvlogConfigForNitroPlugin } from "../nitroConfigBridge-
|
|
4
|
+
import { n as shouldLog, t as getServiceForPath } from "../routes-CnIgYWf8.mjs";
|
|
5
|
+
import { n as resolveEvlogConfigForNitroPlugin } from "../nitroConfigBridge-DKk7eOn-.mjs";
|
|
6
|
+
import { startStreamServer } from "../stream.mjs";
|
|
6
7
|
import { defineNitroPlugin } from "nitropack/runtime/internal/plugin";
|
|
7
8
|
import { getHeaders } from "h3";
|
|
8
9
|
//#region src/nitro/plugin.ts
|
|
@@ -83,6 +84,14 @@ var plugin_default = defineNitroPlugin(async (nitroApp) => {
|
|
|
83
84
|
redact,
|
|
84
85
|
_suppressDrainWarning: true
|
|
85
86
|
});
|
|
87
|
+
const streamSetting = evlogConfig?.stream;
|
|
88
|
+
if (streamSetting === true || streamSetting && typeof streamSetting === "object") startStreamServer(streamSetting === true ? {} : streamSetting).then((server) => {
|
|
89
|
+
nitroApp.hooks.hook("evlog:drain", (ctx) => {
|
|
90
|
+
if (ctx?.event) server.drain(ctx);
|
|
91
|
+
});
|
|
92
|
+
}).catch((err) => {
|
|
93
|
+
console.error("[evlog] failed to start stream server:", err);
|
|
94
|
+
});
|
|
86
95
|
if (!isEnabled()) {
|
|
87
96
|
nitroApp.hooks.hook("request", (event) => {
|
|
88
97
|
const e = event;
|