@visulima/pail 4.0.0-alpha.11 → 4.0.0-alpha.13
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/CHANGELOG.md +33 -0
- package/LICENSE.md +131 -900
- package/dist/error.d.ts +95 -96
- package/dist/error.js +5 -76
- package/dist/index.browser.d.ts +557 -47
- package/dist/index.browser.js +19 -1499
- package/dist/index.server.d.ts +722 -61
- package/dist/index.server.js +31 -2803
- package/dist/middleware/elysia.d.ts +65 -63
- package/dist/middleware/elysia.js +1 -70
- package/dist/middleware/express.d.ts +73 -71
- package/dist/middleware/express.js +1 -29
- package/dist/middleware/fastify.d.ts +69 -67
- package/dist/middleware/fastify.js +1 -46
- package/dist/middleware/hono.d.ts +74 -72
- package/dist/middleware/hono.js +1 -33
- package/dist/middleware/next/handler.d.ts +101 -34
- package/dist/middleware/next/handler.js +1 -53
- package/dist/middleware/sveltekit.d.ts +100 -98
- package/dist/middleware/sveltekit.js +1 -43
- package/dist/object-tree.d.ts +67 -70
- package/dist/object-tree.js +2 -89
- package/dist/packem_shared/AbstractJsonReporter-BawNFYxI.js +1 -0
- package/dist/packem_shared/AbstractJsonReporter-Dt5-5x2R.js +1 -0
- package/dist/packem_shared/JsonReporter-15ln04rX.js +2 -0
- package/dist/packem_shared/JsonReporter-CerNvhg-.js +1 -0
- package/dist/packem_shared/PrettyReporter-Br5njEEy.js +5 -0
- package/dist/packem_shared/PrettyReporter-CgXnwIip.js +44 -0
- package/dist/packem_shared/abstract-json-reporter.d-Bz3lZEDi.d.ts +61 -0
- package/dist/packem_shared/abstract-pretty-reporter-BiHgKxG_.js +33 -0
- package/dist/packem_shared/constants-DKfCaSUR.js +1 -0
- package/dist/packem_shared/constants-ep2nsfdy.js +1 -0
- package/dist/packem_shared/create-middleware-logger.d-DeNLii5l.d.ts +47 -0
- package/dist/packem_shared/createPailError-53jAfQ-T.js +5 -0
- package/dist/packem_shared/headers-S8WyX-2m.js +1 -0
- package/dist/packem_shared/index-Bzp4LnJ5.js +1 -0
- package/dist/packem_shared/pailMiddleware-CWOJRmJq.js +1 -0
- package/dist/packem_shared/storage-DHM1EP2P.js +1 -0
- package/dist/packem_shared/types.d-ByY2ZuYG.d.ts +246 -0
- package/dist/packem_shared/types.d-C51XNfQz.d.ts +194 -0
- package/dist/packem_shared/types.d-CM5ie2qm.d.ts +236 -0
- package/dist/packem_shared/useLogger-qyZrjy4D.js +1 -0
- package/dist/packem_shared/wide-event.d-Ke44zirU.d.ts +704 -0
- package/dist/packem_shared/write-console-log-based-on-level-DfD64owL.js +1 -0
- package/dist/packem_shared/write-stream-Dd4_PTcm.js +1 -0
- package/dist/processor/caller/caller-processor.d.ts +49 -47
- package/dist/processor/caller/caller-processor.js +1 -59
- package/dist/processor/environment-processor.d.ts +113 -113
- package/dist/processor/environment-processor.js +1 -89
- package/dist/processor/message-formatter-processor.d.ts +51 -49
- package/dist/processor/message-formatter-processor.js +1 -715
- package/dist/processor/opentelemetry-processor.d.ts +69 -66
- package/dist/processor/opentelemetry-processor.js +1 -52
- package/dist/processor/redact-processor.d.ts +60 -41
- package/dist/processor/redact-processor.js +1 -31
- package/dist/processor/sampling-processor.d.ts +102 -101
- package/dist/processor/sampling-processor.js +1 -59
- package/dist/reporter/file/json-file-reporter.d.ts +91 -42
- package/dist/reporter/file/json-file-reporter.js +2 -136
- package/dist/reporter/http/abstract-http-reporter.d.ts +213 -211
- package/dist/reporter/http/abstract-http-reporter.js +2 -432
- package/dist/reporter/http/http-reporter.d.ts +40 -36
- package/dist/reporter/http/http-reporter.edge-light.d.ts +430 -38
- package/dist/reporter/http/http-reporter.edge-light.js +2 -728
- package/dist/reporter/http/http-reporter.js +1 -13
- package/dist/reporter/json/index.browser.d.ts +99 -3
- package/dist/reporter/json/index.browser.js +1 -2
- package/dist/reporter/json/index.d.ts +51 -3
- package/dist/reporter/json/index.js +1 -2
- package/dist/reporter/pretty/index.browser.d.ts +106 -2
- package/dist/reporter/pretty/index.browser.js +1 -1
- package/dist/reporter/pretty/index.d.ts +186 -2
- package/dist/reporter/pretty/index.js +1 -1
- package/dist/reporter/simple/simple-reporter.server.d.ts +168 -18
- package/dist/reporter/simple/simple-reporter.server.js +8 -182
- package/dist/wide-event.d.ts +5 -300
- package/dist/wide-event.js +1 -284
- package/package.json +29 -30
- package/dist/constants.d.ts +0 -37
- package/dist/middleware/next/middleware.d.ts +0 -59
- package/dist/middleware/next/storage.d.ts +0 -14
- package/dist/middleware/shared/create-middleware-logger.d.ts +0 -82
- package/dist/middleware/shared/headers.d.ts +0 -14
- package/dist/middleware/shared/routes.d.ts +0 -30
- package/dist/middleware/shared/storage.d.ts +0 -29
- package/dist/packem_shared/AbstractJsonReporter-BO8Calb4.js +0 -284
- package/dist/packem_shared/AbstractJsonReporter-nOj0Ft1F.js +0 -284
- package/dist/packem_shared/JsonReporter-CCmj7oYL.js +0 -28
- package/dist/packem_shared/JsonReporter-Ck2PIAEw.js +0 -58
- package/dist/packem_shared/PrettyReporter-BCvyNzXO.js +0 -2720
- package/dist/packem_shared/PrettyReporter-BtTr13Ha.js +0 -213
- package/dist/packem_shared/abstract-pretty-reporter-CXAKYCb8.js +0 -2635
- package/dist/packem_shared/constants-B1RjD_ps.js +0 -99
- package/dist/packem_shared/constants-omsTHUWB.js +0 -119
- package/dist/packem_shared/createPailError-B_sgL0nF.js +0 -76
- package/dist/packem_shared/headers-BxHWM6KI.js +0 -127
- package/dist/packem_shared/index-Bx3-C0j9.js +0 -658
- package/dist/packem_shared/pailMiddleware-Ci88geIF.js +0 -24
- package/dist/packem_shared/storage-D0vqz8OX.js +0 -36
- package/dist/packem_shared/useLogger-D0rU3lcX.js +0 -33
- package/dist/packem_shared/write-console-log-based-on-level-ree2lDPw.js +0 -15
- package/dist/packem_shared/write-stream-MDqyXmc_.js +0 -6
- package/dist/pail.browser.d.ts +0 -412
- package/dist/pail.server.d.ts +0 -158
- package/dist/processor/caller/get-caller-filename.d.ts +0 -23
- package/dist/reporter/file/utils/rotating-file-stream.d.ts +0 -48
- package/dist/reporter/http/utils/compression.d.ts +0 -7
- package/dist/reporter/http/utils/log-size-error.d.ts +0 -30
- package/dist/reporter/http/utils/retry.d.ts +0 -27
- package/dist/reporter/json/abstract-json-reporter.d.ts +0 -61
- package/dist/reporter/json/json-reporter.browser.d.ts +0 -40
- package/dist/reporter/json/json-reporter.server.d.ts +0 -50
- package/dist/reporter/pretty/abstract-pretty-reporter.d.ts +0 -83
- package/dist/reporter/pretty/pretty-reporter.browser.d.ts +0 -36
- package/dist/reporter/pretty/pretty-reporter.server.d.ts +0 -70
- package/dist/reporter/raw/raw-reporter.browser.d.ts +0 -5
- package/dist/reporter/raw/raw-reporter.server.d.ts +0 -13
- package/dist/reporter/utils/default-inspector-config.d.ts +0 -3
- package/dist/reporter/utils/format-label.d.ts +0 -3
- package/dist/types.d.ts +0 -241
- package/dist/utils/arrayify.d.ts +0 -2
- package/dist/utils/get-longest-badge.d.ts +0 -4
- package/dist/utils/get-longest-label.d.ts +0 -4
- package/dist/utils/merge-types.d.ts +0 -4
- package/dist/utils/stream/safe-stream-handler.d.ts +0 -21
- package/dist/utils/write-console-log-based-on-level.d.ts +0 -4
- package/dist/utils/write-stream.d.ts +0 -2
|
@@ -1,85 +1,87 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { W as WideEvent } from "../packem_shared/wide-event.d-Ke44zirU.js";
|
|
2
|
+
import { P as PailMiddlewareOptions } from "../packem_shared/create-middleware-logger.d-DeNLii5l.js";
|
|
3
|
+
import 'safe-stable-stringify';
|
|
4
|
+
import "../packem_shared/types.d-ByY2ZuYG.js";
|
|
5
|
+
import '@visulima/colorize';
|
|
6
|
+
import '@visulima/interactive-manager';
|
|
3
7
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
8
|
+
* A Hono-like context object with access to the pail logger.
|
|
9
|
+
*
|
|
10
|
+
* Use `c.get("log")` or `useLogger(c)` to access the WideEvent logger.
|
|
11
|
+
* @example
|
|
12
|
+
* ```typescript
|
|
13
|
+
* import type { PailHonoContext } from "@visulima/pail/middleware/hono";
|
|
14
|
+
*
|
|
15
|
+
* app.get("/api/users", (c: PailHonoContext) => {
|
|
16
|
+
* const log = c.get("log");
|
|
17
|
+
* log.set({ user: { id: 1 } });
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
17
21
|
interface PailHonoContext {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
};
|
|
22
|
+
[key: string]: unknown;
|
|
23
|
+
get: (key: string) => unknown;
|
|
24
|
+
req: {
|
|
25
|
+
header: (name: string) => string | undefined;
|
|
26
|
+
method: string;
|
|
27
|
+
path: string;
|
|
28
|
+
raw: {
|
|
29
|
+
headers: Headers;
|
|
27
30
|
};
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
31
|
+
};
|
|
32
|
+
res: {
|
|
33
|
+
status: number;
|
|
34
|
+
};
|
|
35
|
+
set: (key: string, value: unknown) => void;
|
|
32
36
|
}
|
|
33
37
|
/**
|
|
34
|
-
|
|
35
|
-
|
|
38
|
+
* Hono-compatible next function.
|
|
39
|
+
*/
|
|
36
40
|
type PailHonoNext = () => Promise<void>;
|
|
37
41
|
/**
|
|
38
|
-
|
|
39
|
-
|
|
42
|
+
* The Hono middleware function signature returned by `pailMiddleware()`.
|
|
43
|
+
*/
|
|
40
44
|
type PailHonoMiddleware = (c: PailHonoContext, next: PailHonoNext) => Promise<void>;
|
|
41
45
|
/**
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
46
|
+
* Configuration options for the Hono pail middleware.
|
|
47
|
+
* @template T - Custom logger type names from the pail instance
|
|
48
|
+
*/
|
|
45
49
|
type HonoMiddlewareOptions<T extends string = string> = PailMiddlewareOptions<T>;
|
|
46
50
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
* Retrieve the WideEvent logger from Hono context.
|
|
52
|
+
* Must be called within a request handler where pail middleware is active.
|
|
53
|
+
* @param c The Hono context object
|
|
54
|
+
* @returns The request-scoped WideEvent logger
|
|
55
|
+
* @throws Error if the middleware is not registered
|
|
56
|
+
*/
|
|
53
57
|
declare const useLogger: (c: PailHonoContext) => WideEvent;
|
|
54
58
|
/**
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
export { useLogger };
|
|
84
|
-
export type { HonoMiddlewareOptions, PailHonoContext, PailHonoMiddleware, PailHonoNext };
|
|
85
|
-
export type { WideEvent } from "../wide-event.d.ts";
|
|
59
|
+
* Create Hono middleware that attaches a WideEvent logger to each request.
|
|
60
|
+
*
|
|
61
|
+
* The logger is available via:
|
|
62
|
+
* - `c.get("log")` on the Hono context
|
|
63
|
+
* - `useLogger(c)` helper function
|
|
64
|
+
*
|
|
65
|
+
* The wide event is automatically emitted when the handler completes or throws.
|
|
66
|
+
* @param options Middleware configuration
|
|
67
|
+
* @returns Hono middleware function
|
|
68
|
+
* @example
|
|
69
|
+
* ```typescript
|
|
70
|
+
* import { Hono } from "hono";
|
|
71
|
+
* import { createPail } from "@visulima/pail";
|
|
72
|
+
* import { pailMiddleware, useLogger } from "@visulima/pail/middleware/hono";
|
|
73
|
+
*
|
|
74
|
+
* const app = new Hono();
|
|
75
|
+
* const logger = createPail();
|
|
76
|
+
*
|
|
77
|
+
* app.use("*", pailMiddleware({ pail: logger }));
|
|
78
|
+
*
|
|
79
|
+
* app.get("/api/users", (c) => {
|
|
80
|
+
* const log = useLogger(c);
|
|
81
|
+
* log.set({ user: { id: 1 } });
|
|
82
|
+
* return c.json({ ok: true });
|
|
83
|
+
* });
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
declare const pailMiddleware: <T extends string = string>(options: HonoMiddlewareOptions<T>) => PailHonoMiddleware;
|
|
87
|
+
export { type HonoMiddlewareOptions, type PailHonoContext, type PailHonoMiddleware, type PailHonoNext, type WideEvent, pailMiddleware, useLogger };
|
package/dist/middleware/hono.js
CHANGED
|
@@ -1,33 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
const useLogger = (c) => {
|
|
4
|
-
const logger = c.get("log");
|
|
5
|
-
if (!logger) {
|
|
6
|
-
throw new Error("[pail] useLogger() called but pail middleware is not registered.");
|
|
7
|
-
}
|
|
8
|
-
return logger;
|
|
9
|
-
};
|
|
10
|
-
const pailMiddleware = (options) => async (c, next) => {
|
|
11
|
-
const requestId = c.req.header("x-request-id") ?? crypto.randomUUID();
|
|
12
|
-
const safeHeaders = extractSafeHeaders(c.req.raw.headers);
|
|
13
|
-
const { finish, logger, skipped } = createMiddlewareLogger(options, {
|
|
14
|
-
headers: safeHeaders,
|
|
15
|
-
method: c.req.method,
|
|
16
|
-
path: c.req.path,
|
|
17
|
-
requestId
|
|
18
|
-
});
|
|
19
|
-
if (skipped) {
|
|
20
|
-
await next();
|
|
21
|
-
return;
|
|
22
|
-
}
|
|
23
|
-
c.set("log", logger);
|
|
24
|
-
try {
|
|
25
|
-
await next();
|
|
26
|
-
finish({ status: c.res.status });
|
|
27
|
-
} catch (error) {
|
|
28
|
-
finish({ error: error instanceof Error ? error : new Error(String(error)) });
|
|
29
|
-
throw error;
|
|
30
|
-
}
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
export { pailMiddleware, useLogger };
|
|
1
|
+
var c=Object.defineProperty;var s=(r,e)=>c(r,"name",{value:e,configurable:!0});import{a as u,c as p}from"../packem_shared/headers-S8WyX-2m.js";var h=Object.defineProperty,d=s((r,e)=>h(r,"name",{value:e,configurable:!0}),"o");const m=d(r=>{const e=r.get("log");if(!e)throw new Error("[pail] useLogger() called but pail middleware is not registered.");return e},"useLogger"),q=d(r=>async(e,t)=>{const i=e.req.header("x-request-id")??crypto.randomUUID(),n=u(e.req.raw.headers),{finish:o,logger:g,skipped:l}=p(r,{headers:n,method:e.req.method,path:e.req.path,requestId:i});if(l){await t();return}e.set("log",g);try{await t(),o({status:e.res.status})}catch(a){throw o({error:a instanceof Error?a:new Error(String(a))}),a}},"pailMiddleware");export{q as pailMiddleware,m as useLogger};
|
|
@@ -1,36 +1,103 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { P as PailMiddlewareOptions } from "../../packem_shared/create-middleware-logger.d-DeNLii5l.js";
|
|
2
|
+
import { W as WideEvent } from "../../packem_shared/wide-event.d-Ke44zirU.js";
|
|
3
|
+
import 'node:async_hooks';
|
|
4
|
+
import "../../packem_shared/types.d-ByY2ZuYG.js";
|
|
5
|
+
import '@visulima/colorize';
|
|
6
|
+
import '@visulima/interactive-manager';
|
|
7
|
+
import 'safe-stable-stringify';
|
|
8
|
+
/**
|
|
9
|
+
* Minimal type definitions to avoid requiring next as a dependency.
|
|
10
|
+
*/
|
|
11
|
+
interface NextRequest {
|
|
12
|
+
headers: Headers;
|
|
13
|
+
nextUrl: {
|
|
14
|
+
pathname: string;
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
interface NextResponse {
|
|
18
|
+
headers: Headers;
|
|
19
|
+
}
|
|
20
|
+
interface NextResponseConstructor {
|
|
21
|
+
next: (options?: {
|
|
22
|
+
request?: {
|
|
23
|
+
headers?: Headers;
|
|
24
|
+
};
|
|
25
|
+
}) => NextResponse;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Options for the Next.js pail middleware.
|
|
29
|
+
*/
|
|
30
|
+
interface PailNextMiddlewareOptions {
|
|
31
|
+
/**
|
|
32
|
+
* Glob patterns for paths to exclude from logging.
|
|
33
|
+
* Excluded paths won't get request IDs or timing headers.
|
|
34
|
+
* @example ["/_next/**", "/favicon.ico"]
|
|
35
|
+
*/
|
|
36
|
+
exclude?: string[];
|
|
37
|
+
/**
|
|
38
|
+
* Glob patterns for paths to include in logging.
|
|
39
|
+
* If not set, all non-excluded paths are included.
|
|
40
|
+
*/
|
|
41
|
+
include?: string[];
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Create a Next.js edge middleware that sets `x-request-id` and `x-pail-start`
|
|
45
|
+
* headers on the request for downstream use by `withPail()`.
|
|
46
|
+
*
|
|
47
|
+
* This middleware runs at the edge and prepares request metadata.
|
|
48
|
+
* The actual wide event logging happens in `withPail()`.
|
|
49
|
+
* @param NextResponseClass The NextResponse class from "next/server.js"
|
|
50
|
+
* @param options Middleware configuration
|
|
51
|
+
* @returns A middleware function
|
|
52
|
+
* @example
|
|
53
|
+
* ```typescript
|
|
54
|
+
* // middleware.ts
|
|
55
|
+
* import { NextResponse } from "next/server.js";
|
|
56
|
+
* import { pailMiddleware } from "@visulima/pail/middleware/next";
|
|
57
|
+
*
|
|
58
|
+
* const middleware = pailMiddleware(NextResponse, {
|
|
59
|
+
* exclude: ["/_next/**", "/favicon.ico"],
|
|
60
|
+
* });
|
|
61
|
+
*
|
|
62
|
+
* export default middleware;
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
declare const pailMiddleware: (NextResponseClass: NextResponseConstructor, options?: PailNextMiddlewareOptions) => ((request: NextRequest) => NextResponse);
|
|
66
|
+
/**
|
|
67
|
+
* Retrieve the request-scoped WideEvent logger from AsyncLocalStorage.
|
|
68
|
+
* Must be called within a `withPail()` wrapped handler or server action.
|
|
69
|
+
* @returns The request-scoped WideEvent logger
|
|
70
|
+
* @throws Error if called outside of a withPail context
|
|
71
|
+
*/
|
|
72
|
+
declare const useLogger: () => WideEvent;
|
|
2
73
|
type NextPailOptions<T extends string = string> = PailMiddlewareOptions<T>;
|
|
3
74
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
export type
|
|
33
|
-
export type { WideEvent } from "../../wide-event.d.ts";
|
|
34
|
-
export type { PailNextMiddlewareOptions } from "./middleware/next/middleware.d.ts";
|
|
35
|
-
export { pailMiddleware } from "./middleware/next/middleware.d.ts";
|
|
36
|
-
export { useLogger } from "./storage.d.ts";
|
|
75
|
+
* Create a `withPail` wrapper function for Next.js route handlers and server actions.
|
|
76
|
+
*
|
|
77
|
+
* Wraps handler execution in AsyncLocalStorage so that `useLogger()` works
|
|
78
|
+
* anywhere in the async call stack. The wide event is automatically emitted
|
|
79
|
+
* when the handler completes or throws.
|
|
80
|
+
* @param options Configuration options
|
|
81
|
+
* @returns A `withPail` wrapper function
|
|
82
|
+
* @example
|
|
83
|
+
* ```typescript
|
|
84
|
+
* // lib/pail.ts
|
|
85
|
+
* import { createPail } from "@visulima/pail";
|
|
86
|
+
* import { createWithPail } from "@visulima/pail/middleware/next";
|
|
87
|
+
*
|
|
88
|
+
* const logger = createPail();
|
|
89
|
+
* export const withPail = createWithPail({ pail: logger });
|
|
90
|
+
*
|
|
91
|
+
* // app/api/users/route.ts
|
|
92
|
+
* import { withPail } from "@/lib/pail";
|
|
93
|
+
* import { useLogger } from "@visulima/pail/middleware/next";
|
|
94
|
+
*
|
|
95
|
+
* export const GET = withPail(async (request: Request) => {
|
|
96
|
+
* const log = useLogger();
|
|
97
|
+
* log.set({ user: { id: 1 } });
|
|
98
|
+
* return Response.json({ ok: true });
|
|
99
|
+
* });
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
declare const createWithPail: <T extends string = string>(options: NextPailOptions<T>) => <TArgs extends unknown[], TReturn>(handler: (...args: TArgs) => Promise<TReturn> | TReturn) => ((...args: TArgs) => Promise<TReturn>);
|
|
103
|
+
export { type NextPailOptions, type PailNextMiddlewareOptions, type WideEvent, createWithPail, pailMiddleware, useLogger };
|
|
@@ -1,53 +1 @@
|
|
|
1
|
-
|
|
2
|
-
import { pailStorage } from '../../packem_shared/useLogger-D0rU3lcX.js';
|
|
3
|
-
export { useLogger } from '../../packem_shared/useLogger-D0rU3lcX.js';
|
|
4
|
-
export { pailMiddleware } from '../../packem_shared/pailMiddleware-Ci88geIF.js';
|
|
5
|
-
|
|
6
|
-
const createWithPail = (options) => (
|
|
7
|
-
/**
|
|
8
|
-
* Wrap a Next.js route handler or server action with wide event logging.
|
|
9
|
-
* @returns A wrapped handler that creates and emits a WideEvent
|
|
10
|
-
*/
|
|
11
|
-
(handler) => async (...args) => {
|
|
12
|
-
const [firstArgument] = args;
|
|
13
|
-
const isRequest = firstArgument instanceof Request;
|
|
14
|
-
let method = "UNKNOWN";
|
|
15
|
-
let path = "/";
|
|
16
|
-
let requestId = crypto.randomUUID();
|
|
17
|
-
let headers = {};
|
|
18
|
-
if (isRequest) {
|
|
19
|
-
const request = firstArgument;
|
|
20
|
-
const url = new URL(request.url);
|
|
21
|
-
method = request.method;
|
|
22
|
-
path = url.pathname;
|
|
23
|
-
headers = extractSafeHeaders(request.headers);
|
|
24
|
-
const middlewareRequestId = request.headers.get("x-request-id");
|
|
25
|
-
if (middlewareRequestId) {
|
|
26
|
-
requestId = middlewareRequestId;
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
const { finish, logger, skipped } = createMiddlewareLogger(options, {
|
|
30
|
-
headers,
|
|
31
|
-
method,
|
|
32
|
-
path,
|
|
33
|
-
requestId
|
|
34
|
-
});
|
|
35
|
-
if (skipped) {
|
|
36
|
-
return handler(...args);
|
|
37
|
-
}
|
|
38
|
-
try {
|
|
39
|
-
const result = await pailStorage.run(logger, () => handler(...args));
|
|
40
|
-
const status = result instanceof Response ? result.status : 200;
|
|
41
|
-
finish({ status });
|
|
42
|
-
return result;
|
|
43
|
-
} catch (error) {
|
|
44
|
-
const errorInstance = error instanceof Error ? error : new Error(String(error));
|
|
45
|
-
const errorStatus = errorInstance.status ?? errorInstance.statusCode ?? 500;
|
|
46
|
-
finish({ error: errorInstance });
|
|
47
|
-
logger.setStatus(errorStatus);
|
|
48
|
-
throw error;
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
);
|
|
52
|
-
|
|
53
|
-
export { createWithPail };
|
|
1
|
+
var g=Object.defineProperty;var h=(a,r)=>g(a,"name",{value:r,configurable:!0});import{a as w,c as x}from"../../packem_shared/headers-S8WyX-2m.js";import{pailStorage as y}from"../../packem_shared/useLogger-qyZrjy4D.js";import{useLogger as W}from"../../packem_shared/useLogger-qyZrjy4D.js";import{pailMiddleware as E}from"../../packem_shared/pailMiddleware-CWOJRmJq.js";var S=Object.defineProperty,U=h((a,r)=>S(a,"name",{value:r,configurable:!0}),"c");const N=U(a=>r=>async(...o)=>{const[n]=o,l=n instanceof Request;let i="UNKNOWN",c="/",d=crypto.randomUUID(),u={};if(l){const e=n,t=new URL(e.url);i=e.method,c=t.pathname,u=w(e.headers);const s=e.headers.get("x-request-id");s&&(d=s)}const{finish:p,logger:f,skipped:m}=x(a,{headers:u,method:i,path:c,requestId:d});if(m)return r(...o);try{const e=await y.run(f,()=>r(...o)),t=e instanceof Response?e.status:200;return p({status:t}),e}catch(e){const t=e instanceof Error?e:new Error(String(e)),s=t.status??t.statusCode??500;throw p({error:t}),f.setStatus(s),e}},"createWithPail");export{N as createWithPail,E as pailMiddleware,W as useLogger};
|
|
@@ -1,123 +1,125 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { W as WideEvent } from "../packem_shared/wide-event.d-Ke44zirU.js";
|
|
2
|
+
import { P as PailMiddlewareOptions } from "../packem_shared/create-middleware-logger.d-DeNLii5l.js";
|
|
3
|
+
import 'safe-stable-stringify';
|
|
4
|
+
import "../packem_shared/types.d-ByY2ZuYG.js";
|
|
5
|
+
import '@visulima/colorize';
|
|
6
|
+
import '@visulima/interactive-manager';
|
|
3
7
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
* A SvelteKit-like event object with access to the pail logger via `locals.log`.
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* // In a SvelteKit load function or action:
|
|
12
|
+
* import type { PailSvelteKitEvent } from "@visulima/pail/middleware/sveltekit";
|
|
13
|
+
*
|
|
14
|
+
* export const load = async (event: PailSvelteKitEvent) => {
|
|
15
|
+
* event.locals.log?.set({ user: { id: 1 } });
|
|
16
|
+
* };
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
15
19
|
interface PailSvelteKitEvent {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
20
|
+
[key: string]: unknown;
|
|
21
|
+
locals: Record<string, unknown> & {
|
|
22
|
+
log?: WideEvent;
|
|
23
|
+
};
|
|
24
|
+
request: Request;
|
|
25
|
+
url: URL;
|
|
22
26
|
}
|
|
23
27
|
/**
|
|
24
|
-
|
|
25
|
-
|
|
28
|
+
* Options passed to SvelteKit's resolve function.
|
|
29
|
+
*/
|
|
26
30
|
interface PailSvelteKitResolveOptions {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
31
|
+
filterSerializedResponseHeaders?: (name: string) => boolean;
|
|
32
|
+
preload?: (input: {
|
|
33
|
+
type: string;
|
|
34
|
+
}) => boolean;
|
|
35
|
+
transformPageChunk?: (input: {
|
|
36
|
+
html: string;
|
|
37
|
+
}) => string;
|
|
34
38
|
}
|
|
35
39
|
/**
|
|
36
|
-
|
|
37
|
-
|
|
40
|
+
* SvelteKit resolve function type.
|
|
41
|
+
*/
|
|
38
42
|
type PailSvelteKitResolve = (event: PailSvelteKitEvent, options?: PailSvelteKitResolveOptions) => Promise<Response>;
|
|
39
43
|
/**
|
|
40
|
-
|
|
41
|
-
|
|
44
|
+
* Input for the SvelteKit handle hook.
|
|
45
|
+
*/
|
|
42
46
|
interface PailSvelteKitHandleInput {
|
|
43
|
-
|
|
44
|
-
|
|
47
|
+
event: PailSvelteKitEvent;
|
|
48
|
+
resolve: PailSvelteKitResolve;
|
|
45
49
|
}
|
|
46
50
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
51
|
+
* SvelteKit handle hook function type returned by `pailHandle()`.
|
|
52
|
+
*/
|
|
49
53
|
type PailSvelteKitHandle = (input: PailSvelteKitHandleInput) => Promise<Response>;
|
|
50
54
|
/**
|
|
51
|
-
|
|
52
|
-
|
|
55
|
+
* Input for the SvelteKit handleError hook.
|
|
56
|
+
*/
|
|
53
57
|
interface PailSvelteKitHandleErrorInput {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
+
error: unknown;
|
|
59
|
+
event: PailSvelteKitEvent;
|
|
60
|
+
message: string;
|
|
61
|
+
status: number;
|
|
58
62
|
}
|
|
59
63
|
/**
|
|
60
|
-
|
|
61
|
-
|
|
64
|
+
* SvelteKit handleError hook function type returned by `pailHandleError()`.
|
|
65
|
+
*/
|
|
62
66
|
type PailSvelteKitHandleError = (input: PailSvelteKitHandleErrorInput) => void;
|
|
63
67
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
68
|
+
* Retrieve the request-scoped WideEvent logger from AsyncLocalStorage.
|
|
69
|
+
* Must be called within a request handled by the pail SvelteKit handle hook.
|
|
70
|
+
* @returns The request-scoped WideEvent logger
|
|
71
|
+
* @throws Error if called outside of the hook context
|
|
72
|
+
*/
|
|
69
73
|
declare const useLogger: () => WideEvent;
|
|
70
74
|
type SvelteKitHandleOptions<T extends string = string> = PailMiddlewareOptions<T>;
|
|
71
75
|
/**
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
76
|
+
* Create a SvelteKit `handle` hook that attaches a WideEvent logger to each request.
|
|
77
|
+
*
|
|
78
|
+
* The logger is available via:
|
|
79
|
+
* - `event.locals.log` in server load functions and actions
|
|
80
|
+
* - `useLogger()` from anywhere in the async call stack
|
|
81
|
+
*
|
|
82
|
+
* The wide event is automatically emitted when the response is sent or an error occurs.
|
|
83
|
+
* @param options Hook configuration
|
|
84
|
+
* @returns SvelteKit handle hook function
|
|
85
|
+
* @example
|
|
86
|
+
* ```typescript
|
|
87
|
+
* // src/hooks.server.ts
|
|
88
|
+
* import { createPail } from "@visulima/pail";
|
|
89
|
+
* import { pailHandle, pailHandleError } from "@visulima/pail/middleware/sveltekit";
|
|
90
|
+
*
|
|
91
|
+
* const logger = createPail();
|
|
92
|
+
*
|
|
93
|
+
* export const handle = pailHandle({ pail: logger });
|
|
94
|
+
* export const handleError = pailHandleError();
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
declare const pailHandle: <T extends string = string>(options: SvelteKitHandleOptions<T>) => PailSvelteKitHandle;
|
|
94
98
|
/**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
99
|
+
* Create a SvelteKit `handleError` hook that captures errors into the WideEvent logger.
|
|
100
|
+
*
|
|
101
|
+
* Should be used alongside `pailHandle` to ensure errors are recorded in the wide event.
|
|
102
|
+
* @returns SvelteKit handleError hook function
|
|
103
|
+
*/
|
|
104
|
+
declare const pailHandleError: () => PailSvelteKitHandleError;
|
|
101
105
|
/**
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
106
|
+
* Convenience function that returns both handle and handleError hooks.
|
|
107
|
+
* @param options Hook configuration
|
|
108
|
+
* @returns Object with `handle` and `handleError` hooks
|
|
109
|
+
* @example
|
|
110
|
+
* ```typescript
|
|
111
|
+
* // src/hooks.server.ts
|
|
112
|
+
* import { createPail } from "@visulima/pail";
|
|
113
|
+
* import { createPailHooks } from "@visulima/pail/middleware/sveltekit";
|
|
114
|
+
*
|
|
115
|
+
* const logger = createPail();
|
|
116
|
+
* const { handle, handleError } = createPailHooks({ pail: logger });
|
|
117
|
+
*
|
|
118
|
+
* export { handle, handleError };
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
declare const createPailHooks: <T extends string = string>(options: SvelteKitHandleOptions<T>) => {
|
|
122
|
+
handle: PailSvelteKitHandle;
|
|
123
|
+
handleError: PailSvelteKitHandleError;
|
|
120
124
|
};
|
|
121
|
-
export { useLogger };
|
|
122
|
-
export type { PailSvelteKitEvent, PailSvelteKitHandle, PailSvelteKitHandleError, PailSvelteKitHandleErrorInput, PailSvelteKitHandleInput, PailSvelteKitResolve, PailSvelteKitResolveOptions, SvelteKitHandleOptions, };
|
|
123
|
-
export type { WideEvent } from "../wide-event.d.ts";
|
|
125
|
+
export { type PailSvelteKitEvent, type PailSvelteKitHandle, type PailSvelteKitHandleError, type PailSvelteKitHandleErrorInput, type PailSvelteKitHandleInput, type PailSvelteKitResolve, type PailSvelteKitResolveOptions, type SvelteKitHandleOptions, type WideEvent, createPailHooks, pailHandle, pailHandleError, useLogger };
|
|
@@ -1,43 +1 @@
|
|
|
1
|
-
|
|
2
|
-
import { c as createLoggerStorage } from '../packem_shared/storage-D0vqz8OX.js';
|
|
3
|
-
|
|
4
|
-
const loggerStorage = createLoggerStorage("SvelteKit handle hook context. Make sure pailHandle is added to your hooks.server.ts.");
|
|
5
|
-
const useLogger = () => loggerStorage.useLogger();
|
|
6
|
-
const pailHandle = (options) => async ({ event, resolve }) => {
|
|
7
|
-
const requestId = event.request.headers.get("x-request-id") ?? crypto.randomUUID();
|
|
8
|
-
const safeHeaders = extractSafeHeaders(event.request.headers);
|
|
9
|
-
const { finish, logger, skipped } = createMiddlewareLogger(options, {
|
|
10
|
-
headers: safeHeaders,
|
|
11
|
-
method: event.request.method,
|
|
12
|
-
path: event.url.pathname,
|
|
13
|
-
requestId
|
|
14
|
-
});
|
|
15
|
-
if (skipped) {
|
|
16
|
-
return resolve(event);
|
|
17
|
-
}
|
|
18
|
-
event.locals.log = logger;
|
|
19
|
-
return loggerStorage.storage.run(logger, async () => {
|
|
20
|
-
try {
|
|
21
|
-
const response = await resolve(event);
|
|
22
|
-
finish({ status: response.status });
|
|
23
|
-
return response;
|
|
24
|
-
} catch (error) {
|
|
25
|
-
finish({ error: error instanceof Error ? error : new Error(String(error)) });
|
|
26
|
-
throw error;
|
|
27
|
-
}
|
|
28
|
-
});
|
|
29
|
-
};
|
|
30
|
-
const pailHandleError = () => ({ error, event }) => {
|
|
31
|
-
const logger = event.locals.log;
|
|
32
|
-
if (logger && error instanceof Error) {
|
|
33
|
-
logger.error(error.message, error);
|
|
34
|
-
}
|
|
35
|
-
};
|
|
36
|
-
const createPailHooks = (options) => {
|
|
37
|
-
return {
|
|
38
|
-
handle: pailHandle(options),
|
|
39
|
-
handleError: pailHandleError()
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
export { createPailHooks, pailHandle, pailHandleError, useLogger };
|
|
1
|
+
var u=Object.defineProperty;var l=(r,e)=>u(r,"name",{value:e,configurable:!0});import{a as h,c as p}from"../packem_shared/headers-S8WyX-2m.js";import{c as m}from"../packem_shared/storage-DHM1EP2P.js";var v=Object.defineProperty,t=l((r,e)=>v(r,"name",{value:e,configurable:!0}),"n");const d=m("SvelteKit handle hook context. Make sure pailHandle is added to your hooks.server.ts."),q=t(()=>d.useLogger(),"useLogger"),f=t(r=>async({event:e,resolve:o})=>{const c=e.request.headers.get("x-request-id")??crypto.randomUUID(),i=h(e.request.headers),{finish:s,logger:n,skipped:g}=p(r,{headers:i,method:e.request.method,path:e.url.pathname,requestId:c});return g?o(e):(e.locals.log=n,d.storage.run(n,async()=>{try{const a=await o(e);return s({status:a.status}),a}catch(a){throw s({error:a instanceof Error?a:new Error(String(a))}),a}}))},"pailHandle"),H=t(()=>({error:r,event:e})=>{const o=e.locals.log;o&&r instanceof Error&&o.error(r.message,r)},"pailHandleError"),L=t(r=>({handle:f(r),handleError:H()}),"createPailHooks");export{L as createPailHooks,f as pailHandle,H as pailHandleError,q as useLogger};
|