@forinda/kickjs 10.3.0 → 10.4.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/dist/adapter-BZ1WzN1z.d.mts +2354 -0
- package/dist/adapter-BZ1WzN1z.d.mts.map +1 -0
- package/dist/{app-module-Ftz6m7SO.d.mts → app-module-Cuu-Ma_E.d.mts} +5 -4
- package/dist/app-module-Cuu-Ma_E.d.mts.map +1 -0
- package/dist/{application-B2e5XYHm.mjs → application-Bs30gJF1.mjs} +4 -4
- package/dist/application-Bs30gJF1.mjs.map +1 -0
- package/dist/application-D5Iiy7rt.d.mts +1996 -0
- package/dist/application-D5Iiy7rt.d.mts.map +1 -0
- package/dist/bootstrap-B_sGJNSz.mjs +12 -0
- package/dist/{bootstrap-BmALF-1Y.mjs.map → bootstrap-B_sGJNSz.mjs.map} +1 -1
- package/dist/{bounded-counters-aA3iI_Ei.mjs → bounded-counters-DS-IbDW9.mjs} +2 -2
- package/dist/{bounded-counters-aA3iI_Ei.mjs.map → bounded-counters-DS-IbDW9.mjs.map} +1 -1
- package/dist/{client-ip-D2dsx8RG.mjs → client-ip-BLkoQTIR.mjs} +2 -2
- package/dist/{client-ip-D2dsx8RG.mjs.map → client-ip-BLkoQTIR.mjs.map} +1 -1
- package/dist/config/index.d.mts +1 -1
- package/dist/config/index.mjs +2 -2
- package/dist/{config-B77LTW_E.mjs → config-B6EeAw4P.mjs} +3 -3
- package/dist/{config-B77LTW_E.mjs.map → config-B6EeAw4P.mjs.map} +1 -1
- package/dist/container-4iJdDkRH.d.mts +3 -0
- package/dist/context-CRJzl_Mj.mjs +12 -0
- package/dist/context-CRJzl_Mj.mjs.map +1 -0
- package/dist/{context-errors-CPqYYhl0.mjs → context-errors-CR5NCXfl.mjs} +2 -2
- package/dist/{context-errors-CPqYYhl0.mjs.map → context-errors-CR5NCXfl.mjs.map} +1 -1
- package/dist/{contributor-runner-Cl5yZZy1.mjs → contributor-runner--ofCRZ0d.mjs} +3 -3
- package/dist/{contributor-runner-Cl5yZZy1.mjs.map → contributor-runner--ofCRZ0d.mjs.map} +1 -1
- package/dist/core/adapter.d.mts +1 -1
- package/dist/core/adapter.mjs +1 -1
- package/dist/core/app-module.d.mts +1 -1
- package/dist/core/app-module.mjs +1 -1
- package/dist/core/cache.mjs +1 -1
- package/dist/core/container.d.mts +2 -2
- package/dist/core/container.mjs +2 -2
- package/dist/core/cron.mjs +2 -2
- package/dist/core/decorators.d.mts +2 -2
- package/dist/core/decorators.mjs +2 -2
- package/dist/core/decorators.mjs.map +1 -1
- package/dist/core/errors.mjs +1 -1
- package/dist/core/interfaces.d.mts +2 -2
- package/dist/core/interfaces.mjs +2 -2
- package/dist/core/interfaces.mjs.map +1 -1
- package/dist/core/logger.mjs +1 -1
- package/dist/core/path.mjs +1 -1
- package/dist/core/plugin.d.mts +1 -1
- package/dist/core/plugin.mjs +1 -1
- package/dist/core/reactivity.mjs +1 -1
- package/dist/core-CsMDdzNE.mjs +12 -0
- package/dist/{core-D1AV-Tvd.mjs.map → core-CsMDdzNE.mjs.map} +1 -1
- package/dist/{csrf-Cy1meSpf.d.mts → csrf-BDAZK2mm.d.mts} +2 -2
- package/dist/{csrf-Cy1meSpf.d.mts.map → csrf-BDAZK2mm.d.mts.map} +1 -1
- package/dist/decorate-CLeX6hbL.mjs +13 -0
- package/dist/{decorate-BiXL-9e9.mjs.map → decorate-CLeX6hbL.mjs.map} +1 -1
- package/dist/{decorators-DaQUNXOn.d.mts → decorators-Dvy0JZ5L.d.mts} +8 -200
- package/dist/decorators-Dvy0JZ5L.d.mts.map +1 -0
- package/dist/{define-adapter-D22SDe0U.mjs → define-adapter-RbKRSG3i.mjs} +2 -2
- package/dist/{define-adapter-D22SDe0U.mjs.map → define-adapter-RbKRSG3i.mjs.map} +1 -1
- package/dist/di-hooks-CiNaIu12.mjs +132 -0
- package/dist/di-hooks-CiNaIu12.mjs.map +1 -0
- package/dist/disposables-DYTkgNiG.mjs +11 -0
- package/dist/error-handler-CbP7hKdJ.d.mts +63 -0
- package/dist/error-handler-CbP7hKdJ.d.mts.map +1 -0
- package/dist/{handler-gW_h2miq.mjs → handler-Cw4mr3ls.mjs} +3 -3
- package/dist/{handler-gW_h2miq.mjs.map → handler-Cw4mr3ls.mjs.map} +1 -1
- package/dist/{host-D__uZPyz.mjs → host-H7CIkHNB.mjs} +2 -2
- package/dist/{host-D__uZPyz.mjs.map → host-H7CIkHNB.mjs.map} +1 -1
- package/dist/http/application.d.mts +2 -2
- package/dist/http/application.mjs +2 -2
- package/dist/http/bootstrap.d.mts +1 -1
- package/dist/http/bootstrap.mjs +2 -2
- package/dist/http/context.d.mts +2 -2
- package/dist/http/context.mjs +2 -2
- package/dist/http/middleware/allowed-hosts.mjs +2 -2
- package/dist/http/middleware/breach-padding.mjs +1 -1
- package/dist/http/middleware/cors.mjs +1 -1
- package/dist/http/middleware/csrf.d.mts +1 -1
- package/dist/http/middleware/csrf.mjs +3 -2
- package/dist/http/middleware/csrf.mjs.map +1 -0
- package/dist/http/middleware/error-handler.d.mts +1 -1
- package/dist/http/middleware/error-handler.mjs +2 -2
- package/dist/http/middleware/error-handler.mjs.map +1 -1
- package/dist/http/middleware/helmet.mjs +1 -1
- package/dist/http/middleware/rate-limit.mjs +2 -2
- package/dist/http/middleware/request-id.mjs +1 -1
- package/dist/http/middleware/request-logger.mjs +2 -2
- package/dist/http/middleware/session.mjs +2 -2
- package/dist/http/middleware/spa.d.mts +1 -1
- package/dist/http/middleware/spa.mjs +2 -2
- package/dist/http/middleware/upload.d.mts +1 -1
- package/dist/http/middleware/upload.mjs +2 -2
- package/dist/http/middleware/validate.mjs +1 -1
- package/dist/http/middleware/views.d.mts +1 -1
- package/dist/http/middleware/views.mjs +2 -2
- package/dist/http/query/index.d.mts +2 -2
- package/dist/http/query/index.mjs +2 -2
- package/dist/http/router-builder.d.mts +1 -1
- package/dist/http/router-builder.mjs +2 -2
- package/dist/http/runtimes/fastify.d.mts +1 -1
- package/dist/http/runtimes/fastify.mjs +2 -2
- package/dist/http/runtimes/h3-web.mjs +1 -1
- package/dist/http/runtimes/h3.d.mts +1 -1
- package/dist/http/runtimes/h3.mjs +2 -2
- package/dist/{index-CuiWSnZL.d.mts → index-B4aOLoId.d.mts} +4 -4
- package/dist/{index-CuiWSnZL.d.mts.map → index-B4aOLoId.d.mts.map} +1 -1
- package/dist/{index-BfT5KZ-M.d.mts → index-Blgka75E.d.mts} +63 -4
- package/dist/index-Blgka75E.d.mts.map +1 -0
- package/dist/index.d.mts +17 -11
- package/dist/index.mjs +4 -4
- package/dist/index.mjs.map +1 -1
- package/dist/interfaces-C6LHcYsg.d.mts +34 -0
- package/dist/interfaces-C6LHcYsg.d.mts.map +1 -0
- package/dist/is-production-BTroGhp5.mjs +12 -0
- package/dist/is-production-BTroGhp5.mjs.map +1 -0
- package/dist/jobs-xqoMmdr4.mjs +12 -0
- package/dist/{jobs-s4__kZLr.mjs.map → jobs-xqoMmdr4.mjs.map} +1 -1
- package/dist/{kv-stores-Cjel_Dkc.mjs → kv-stores-0-6blGzh.mjs} +3 -3
- package/dist/{kv-stores-Cjel_Dkc.mjs.map → kv-stores-0-6blGzh.mjs.map} +1 -1
- package/dist/kv-stores-DXFBEYYu.d.mts +390 -0
- package/dist/kv-stores-DXFBEYYu.d.mts.map +1 -0
- package/dist/{lazy-serve-static-w94Xs3wQ.mjs → lazy-serve-static-D94xvah5.mjs} +2 -2
- package/dist/{lazy-serve-static-w94Xs3wQ.mjs.map → lazy-serve-static-D94xvah5.mjs.map} +1 -1
- package/dist/metadata-Bm65Y-5O.mjs +11 -0
- package/dist/{observers-boPE9XGi.mjs → observers-BAXkwMx0.mjs} +2 -2
- package/dist/{observers-boPE9XGi.mjs.map → observers-BAXkwMx0.mjs.map} +1 -1
- package/dist/query-CGyw7vNi.mjs +12 -0
- package/dist/query-CGyw7vNi.mjs.map +1 -0
- package/dist/{reply-CYY_CzRf.mjs → reply-tlUaowib.mjs} +3 -3
- package/dist/{reply-CYY_CzRf.mjs.map → reply-tlUaowib.mjs.map} +1 -1
- package/dist/{respond-Dc18G0X7.mjs → respond-BOlh-baJ.mjs} +2 -2
- package/dist/{respond-Dc18G0X7.mjs.map → respond-BOlh-baJ.mjs.map} +1 -1
- package/dist/{route-flag-BOQZs2Wn.mjs → route-flag-BPSq2JCs.mjs} +3 -3
- package/dist/{route-flag-BOQZs2Wn.mjs.map → route-flag-BPSq2JCs.mjs.map} +1 -1
- package/dist/{route-policy-B8c6QfiU.mjs → route-policy-DDszB6dQ.mjs} +2 -2
- package/dist/{route-policy-B8c6QfiU.mjs.map → route-policy-DDszB6dQ.mjs.map} +1 -1
- package/dist/router-builder-BewIsj7V.d.mts +56 -0
- package/dist/router-builder-BewIsj7V.d.mts.map +1 -0
- package/dist/router-builder-DoaDAmK8.mjs +12 -0
- package/dist/{router-builder-DoWOIGmG.mjs.map → router-builder-DoaDAmK8.mjs.map} +1 -1
- package/dist/{settings-C8VKewNS.d.mts → settings-BnE75hnr.d.mts} +2 -2
- package/dist/{settings-C8VKewNS.d.mts.map → settings-BnE75hnr.d.mts.map} +1 -1
- package/dist/settings-CRkMOwcz.mjs +14 -0
- package/dist/{settings-DcytOCC6.mjs.map → settings-CRkMOwcz.mjs.map} +1 -1
- package/dist/token-2CJq89za.mjs +11 -0
- package/dist/token-D6jfTQLA.d.mts +3 -0
- package/dist/upload-DkT2p1gd.d.mts +104 -0
- package/dist/upload-DkT2p1gd.d.mts.map +1 -0
- package/dist/{upload-config-CzxbJALL.mjs → upload-config-Be7w0Dfx.mjs} +2 -2
- package/dist/{upload-config-CzxbJALL.mjs.map → upload-config-Be7w0Dfx.mjs.map} +1 -1
- package/dist/url-for-EQsmb3yi.mjs +12 -0
- package/dist/url-for-EQsmb3yi.mjs.map +1 -0
- package/dist/web-crypto-G-m6c6w2.mjs +12 -0
- package/dist/web-crypto-G-m6c6w2.mjs.map +1 -0
- package/dist/web.d.mts +6 -5
- package/dist/web.d.mts.map +1 -1
- package/dist/web.mjs +2 -2
- package/dist/web.mjs.map +1 -1
- package/package.json +2 -1
- package/dist/adapter-BYdxuKiM.d.mts +0 -4916
- package/dist/adapter-BYdxuKiM.d.mts.map +0 -1
- package/dist/app-module-Ftz6m7SO.d.mts.map +0 -1
- package/dist/application-B2e5XYHm.mjs.map +0 -1
- package/dist/bootstrap-BmALF-1Y.mjs +0 -12
- package/dist/container-Dpvd66Yt.d.mts +0 -298
- package/dist/container-Dpvd66Yt.d.mts.map +0 -1
- package/dist/container-mvaAYThX.mjs +0 -132
- package/dist/container-mvaAYThX.mjs.map +0 -1
- package/dist/context-GbQnJB-L.mjs +0 -12
- package/dist/context-GbQnJB-L.mjs.map +0 -1
- package/dist/core-D1AV-Tvd.mjs +0 -12
- package/dist/csrf-D3prC4FK.mjs +0 -12
- package/dist/csrf-D3prC4FK.mjs.map +0 -1
- package/dist/decorate-BiXL-9e9.mjs +0 -13
- package/dist/decorators-DaQUNXOn.d.mts.map +0 -1
- package/dist/disposables-CJD_gWlA.mjs +0 -12
- package/dist/disposables-CJD_gWlA.mjs.map +0 -1
- package/dist/index-BfT5KZ-M.d.mts.map +0 -1
- package/dist/interfaces-C1hCSoLD.d.mts +0 -75
- package/dist/interfaces-C1hCSoLD.d.mts.map +0 -1
- package/dist/is-production-Dbm13WNL.mjs +0 -12
- package/dist/is-production-Dbm13WNL.mjs.map +0 -1
- package/dist/jobs-s4__kZLr.mjs +0 -12
- package/dist/metadata-C2GK_17k.mjs +0 -12
- package/dist/metadata-C2GK_17k.mjs.map +0 -1
- package/dist/query-DjTeF1d4.mjs +0 -12
- package/dist/query-DjTeF1d4.mjs.map +0 -1
- package/dist/router-builder-DoWOIGmG.mjs +0 -12
- package/dist/settings-DcytOCC6.mjs +0 -14
- package/dist/url-for-DGSrVfdD.mjs +0 -12
- package/dist/url-for-DGSrVfdD.mjs.map +0 -1
|
@@ -0,0 +1,390 @@
|
|
|
1
|
+
|
|
2
|
+
import { x as MiddlewareHandler } from "./decorators-Dvy0JZ5L.mjs";
|
|
3
|
+
import { C as RuntimeResponse, O as RequestContext } from "./adapter-BZ1WzN1z.mjs";
|
|
4
|
+
import { d as RouteFlagTest } from "./route-flag-B1lQht6v.mjs";
|
|
5
|
+
import { a as SessionStore, r as SessionData } from "./session-ChXx7jG5.mjs";
|
|
6
|
+
import { r as RateLimitStore } from "./rate-limit-BgoeahE5.mjs";
|
|
7
|
+
//#region src/core/jobs.d.ts
|
|
8
|
+
/** Metadata keys — the same ones `@forinda/kickjs-queue` used, so existing readers keep working. */
|
|
9
|
+
declare const JOB_META: {
|
|
10
|
+
readonly JOB: 'kick/queue/job';
|
|
11
|
+
readonly PROCESS: 'kick/queue/process';
|
|
12
|
+
};
|
|
13
|
+
/** What a `@Process` method records. */
|
|
14
|
+
interface ProcessDefinition {
|
|
15
|
+
/** Method name on the class. */
|
|
16
|
+
handlerName: string;
|
|
17
|
+
/** Job name it handles; `undefined` handles every job in the queue. */
|
|
18
|
+
jobName?: string;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* The least a job tool hands over. Runners pass their own job object through
|
|
22
|
+
* unchanged — BullMQ's `Job`, a Cloudflare message — so a handler can still
|
|
23
|
+
* reach tool-specific fields (`job.attemptsMade`, `job.updateProgress()`).
|
|
24
|
+
*/
|
|
25
|
+
interface JobLike<Data = unknown> {
|
|
26
|
+
name: string;
|
|
27
|
+
data: Data;
|
|
28
|
+
id?: string;
|
|
29
|
+
}
|
|
30
|
+
/** Mark a class as handling jobs on `queue`. The class is a DI singleton. */
|
|
31
|
+
declare function Job(queue: string): ClassDecorator;
|
|
32
|
+
/** Mark a method as handling `jobName` — or, without a name, every job its queue gets. */
|
|
33
|
+
declare function Process(jobName?: string): MethodDecorator;
|
|
34
|
+
/** One handler: its queue, job name (absent for a catch-all), class and method. */
|
|
35
|
+
interface JobHandler extends ProcessDefinition {
|
|
36
|
+
queue: string;
|
|
37
|
+
target: Function;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Every `@Process` method of a `@Job` class the container can resolve.
|
|
41
|
+
* Classes it doesn't know (not in a module, or from before an HMR reload)
|
|
42
|
+
* are skipped.
|
|
43
|
+
*/
|
|
44
|
+
declare function listJobHandlers(container: {
|
|
45
|
+
has(token: unknown): boolean;
|
|
46
|
+
}): JobHandler[];
|
|
47
|
+
/** The queues something handles — what a runner subscribes to. */
|
|
48
|
+
declare function listJobQueues(container: {
|
|
49
|
+
has(token: unknown): boolean;
|
|
50
|
+
}): string[];
|
|
51
|
+
/** Thrown when a queue receives a job no `@Process` method handles. */
|
|
52
|
+
declare class NoJobHandlerError extends Error {
|
|
53
|
+
readonly queue: string;
|
|
54
|
+
readonly jobName: string;
|
|
55
|
+
constructor(queue: string, jobName: string);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Run one job: pick the `@Process` method for `job.name` (or the queue's
|
|
59
|
+
* catch-all), resolve its class from the container and call it with `job`
|
|
60
|
+
* as given. A failure is reported to the error observers (`source: 'job'`)
|
|
61
|
+
* and rethrown, so the tool's own retry and dead-letter handling still
|
|
62
|
+
* applies. A job nothing handles throws {@link NoJobHandlerError} rather
|
|
63
|
+
* than being acknowledged and lost.
|
|
64
|
+
*/
|
|
65
|
+
declare function runJob(container: {
|
|
66
|
+
has(token: unknown): boolean;
|
|
67
|
+
resolve(token: unknown): unknown;
|
|
68
|
+
}, queue: string, job: JobLike,
|
|
69
|
+
/** Extra fields for the error report — e.g. the tool's attempt count. */
|
|
70
|
+
report?: Record<string, unknown>): Promise<unknown>;
|
|
71
|
+
/**
|
|
72
|
+
* Something about where a job was dispatched from that its handler should
|
|
73
|
+
* run with — the tenant, a trace id, the acting user. Captured when the job
|
|
74
|
+
* is dispatched, carried in its data, and restored around the handler.
|
|
75
|
+
*/
|
|
76
|
+
interface JobContextCarrier<T = unknown> {
|
|
77
|
+
/** Unique: the field it travels under. */
|
|
78
|
+
key: string;
|
|
79
|
+
/** The value to carry, or `undefined` for nothing. */
|
|
80
|
+
capture(): T | undefined;
|
|
81
|
+
/** Run the handler with the value back in place. */
|
|
82
|
+
restore<R>(value: T, run: () => R): R;
|
|
83
|
+
}
|
|
84
|
+
/** The field a job's data carries its context in. Removed before the handler sees the data. */
|
|
85
|
+
declare const JOB_CONTEXT_FIELD = "__kickContext";
|
|
86
|
+
/** Carry a value from dispatch to handler for every job. Registering a key again replaces it. */
|
|
87
|
+
declare function registerJobContext<T>(carrier: JobContextCarrier<T>): void;
|
|
88
|
+
/**
|
|
89
|
+
* `data` with the current job context added — for a {@link JobDispatcher}
|
|
90
|
+
* implementation to call before enqueueing. Any `__kickContext` already in
|
|
91
|
+
* `data` is removed first: only this call may set it, so a dispatcher that
|
|
92
|
+
* enqueues caller-supplied data without it lets that data choose the context. Only plain-object data can carry
|
|
93
|
+
* it; anything else, or nothing to carry, is returned as is.
|
|
94
|
+
*/
|
|
95
|
+
declare function stampJobContext<Data>(data: Data): Data;
|
|
96
|
+
/** Enqueue a job — implemented by whichever adapter runs the jobs. */
|
|
97
|
+
interface JobDispatcher {
|
|
98
|
+
dispatch<Data = unknown>(queue: string, name: string, data: Data, options?: Record<string, unknown>): Promise<unknown>;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* The active job dispatcher. Inject it to enqueue without naming the tool:
|
|
102
|
+
* `@Inject(JOB_DISPATCHER) private jobs!: JobDispatcher`.
|
|
103
|
+
*/
|
|
104
|
+
declare const JOB_DISPATCHER: import("@forinda/kickjs-di").InjectionToken<JobDispatcher>;
|
|
105
|
+
//#endregion
|
|
106
|
+
//#region src/http/reply.d.ts
|
|
107
|
+
declare const REPLY_BRAND: unique symbol;
|
|
108
|
+
/**
|
|
109
|
+
* A status-carrying response payload for return-value handlers. Create via
|
|
110
|
+
* {@link reply} — the brand is what runtimes detect, and the generics are
|
|
111
|
+
* what the `kick/routes` response typegen unwraps (`Reply<S, T>` → `T`).
|
|
112
|
+
*/
|
|
113
|
+
interface Reply<S extends number = number, T = unknown> {
|
|
114
|
+
readonly [REPLY_BRAND]: true;
|
|
115
|
+
readonly status: S;
|
|
116
|
+
readonly body: T;
|
|
117
|
+
/** Response headers set before the body is sent. */
|
|
118
|
+
readonly headers?: ReplyHeaders;
|
|
119
|
+
}
|
|
120
|
+
/** Header name → value, as `ctx.setHeader` takes them. */
|
|
121
|
+
type ReplyHeaders = Readonly<Record<string, string | number | readonly string[]>>;
|
|
122
|
+
/** Options for {@link reply}. */
|
|
123
|
+
interface ReplyOptions {
|
|
124
|
+
/** Response headers set before the body is sent. */
|
|
125
|
+
headers?: ReplyHeaders;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Wrap a return-value handler's payload with an explicit status code:
|
|
129
|
+
*
|
|
130
|
+
* ```ts
|
|
131
|
+
* @Post('/')
|
|
132
|
+
* async create(ctx: RequestContext) {
|
|
133
|
+
* return reply(201, await this.tasks.create(ctx.body))
|
|
134
|
+
* }
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
* `options.headers` are set on the response before it is sent:
|
|
138
|
+
* `reply(202, job, { headers: { 'Retry-After': 5 } })`.
|
|
139
|
+
*/
|
|
140
|
+
declare function reply<S extends number, T>(status: S, body: T, options?: ReplyOptions): Reply<S, T>;
|
|
141
|
+
declare namespace reply {
|
|
142
|
+
var ok: <T>(body: T) => Reply<200, T>;
|
|
143
|
+
var created: <T>(body: T, options?: ReplyOptions & {
|
|
144
|
+
location?: string;
|
|
145
|
+
}) => Reply<201, T>;
|
|
146
|
+
var accepted: <T>(body: T) => Reply<202, T>;
|
|
147
|
+
var noContent: () => Reply<204, undefined>;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* The statically-inferred response type of a controller handler — what
|
|
151
|
+
* `kick typegen` emits into `KickRoutes[...].response`:
|
|
152
|
+
*
|
|
153
|
+
* - `Awaited<ReturnType>` of the method
|
|
154
|
+
* - `Reply<S, T>` unwraps to `T`
|
|
155
|
+
* - `void`/`undefined` members are dropped (imperative `ctx.json` branches);
|
|
156
|
+
* a handler that never returns a value stays `unknown`, matching the
|
|
157
|
+
* pre-inference emission
|
|
158
|
+
*
|
|
159
|
+
* ```ts
|
|
160
|
+
* type R = InferHandlerResponse<UsersController['get']> // → User
|
|
161
|
+
* ```
|
|
162
|
+
*/
|
|
163
|
+
type InferHandlerResponse<H> = H extends ((...args: never[]) => infer R) ? [Exclude<Awaited<R>, void | undefined>] extends [never] ? unknown : UnwrapReply<Exclude<Awaited<R>, void | undefined>> : unknown;
|
|
164
|
+
type UnwrapReply<A> = A extends Reply<number, infer B> ? B : A extends RuntimeResponse ? unknown : A;
|
|
165
|
+
declare function isReply(value: unknown): value is Reply;
|
|
166
|
+
/**
|
|
167
|
+
* Key of the method a self-sending result carries. A returned value with
|
|
168
|
+
* `[RESPOND](ctx)` writes its own response — how an integration (an Inertia
|
|
169
|
+
* page, a rendered view) works as a return value without the framework
|
|
170
|
+
* knowing its format. Registry symbol, so a second copy of the package still
|
|
171
|
+
* matches.
|
|
172
|
+
*/
|
|
173
|
+
declare const RESPOND: unique symbol;
|
|
174
|
+
/** A handler return value that writes its own response. */
|
|
175
|
+
interface Respondable {
|
|
176
|
+
[RESPOND](ctx: RequestContext): void | PromiseLike<void>;
|
|
177
|
+
}
|
|
178
|
+
declare function isRespondable(value: unknown): value is Respondable;
|
|
179
|
+
/**
|
|
180
|
+
* Send a handler's RETURN value when the pipeline finished without anything
|
|
181
|
+
* having written a response. Callers guard on "driver/response unsettled" —
|
|
182
|
+
* this only decides how to send:
|
|
183
|
+
*
|
|
184
|
+
* - `undefined` → not handled (returns false; runtime keeps today's behavior)
|
|
185
|
+
* - `Respondable` → its `[RESPOND](ctx)` writes the response (may be async)
|
|
186
|
+
* - `Reply` wrapper → status + body (204 → `ctx.noContent()`)
|
|
187
|
+
* - anything else → `ctx.json(value)` (200)
|
|
188
|
+
*
|
|
189
|
+
* Returns true when a response was produced — a promise of it for an async
|
|
190
|
+
* `Respondable`, which callers await so its errors reach the error handler.
|
|
191
|
+
*/
|
|
192
|
+
declare function applyHandlerResult(ctx: RequestContext, result: unknown): boolean | Promise<boolean>;
|
|
193
|
+
//#endregion
|
|
194
|
+
//#region src/http/background.d.ts
|
|
195
|
+
/**
|
|
196
|
+
* Keep `promise` alive past the response. A rejection is logged (with the
|
|
197
|
+
* request id when called during a request), never left unhandled.
|
|
198
|
+
*
|
|
199
|
+
* @example
|
|
200
|
+
* ```ts
|
|
201
|
+
* @Post('/')
|
|
202
|
+
* async create(ctx: RequestContext) {
|
|
203
|
+
* const order = await this.orders.create(ctx.body)
|
|
204
|
+
* ctx.waitUntil(this.mailer.sendReceipt(order)) // or waitUntil(...) outside a handler
|
|
205
|
+
* return order
|
|
206
|
+
* }
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
declare function waitUntil(promise: Promise<unknown>): void;
|
|
210
|
+
/**
|
|
211
|
+
* Resolve once every registered promise has settled — including work
|
|
212
|
+
* registered while waiting. Never rejects.
|
|
213
|
+
*/
|
|
214
|
+
declare function settleBackgroundWork(): Promise<void>;
|
|
215
|
+
/**
|
|
216
|
+
* The platform hook `createHandler()` and the web entry forward background
|
|
217
|
+
* work to. Cloudflare Workers' `ctx`, Netlify's `context`, and `{ waitUntil }`
|
|
218
|
+
* from `@vercel/functions` all have this shape.
|
|
219
|
+
*/
|
|
220
|
+
interface PlatformContext {
|
|
221
|
+
waitUntil?(promise: Promise<unknown>): void;
|
|
222
|
+
}
|
|
223
|
+
//#endregion
|
|
224
|
+
//#region src/core/web-crypto.d.ts
|
|
225
|
+
/**
|
|
226
|
+
* Constant-time check of an `Authorization: Bearer <secret>` header against a
|
|
227
|
+
* shared secret — a cron trigger, a metrics scrape, a webhook. `false` for a
|
|
228
|
+
* missing or non-string header, and for an empty secret (an unset env var
|
|
229
|
+
* must not let `Authorization: Bearer ` through). Pass
|
|
230
|
+
* `ctx.headers.authorization` as is.
|
|
231
|
+
*/
|
|
232
|
+
declare function matchesBearer(header: unknown, secret: string): boolean;
|
|
233
|
+
//#endregion
|
|
234
|
+
//#region src/http/middleware/rate-limit-guard.d.ts
|
|
235
|
+
interface RateLimitGuardOptions {
|
|
236
|
+
/** Maximum number of requests per window (default: 100). */
|
|
237
|
+
max?: number;
|
|
238
|
+
/** Time window in milliseconds (default: 60_000). */
|
|
239
|
+
windowMs?: number;
|
|
240
|
+
/** Response message when the limit is exceeded (default: 'Too Many Requests'). */
|
|
241
|
+
message?: string;
|
|
242
|
+
/** HTTP status code when the limit is exceeded (default: 429). */
|
|
243
|
+
statusCode?: number;
|
|
244
|
+
/**
|
|
245
|
+
* Rate-limit key per request. Defaults to `ctx.ip`, falling back to
|
|
246
|
+
* `'global'`. Return a user/tenant id here for authenticated quotas.
|
|
247
|
+
*
|
|
248
|
+
* ::: warning Behind a proxy, configure `trustProxy` or every client shares
|
|
249
|
+
* one bucket
|
|
250
|
+
* On a node runtime `ctx.ip` is the runtime's vetted client address —
|
|
251
|
+
* Express derives it from `trust proxy`, Fastify from `trustProxy`. Without
|
|
252
|
+
* that setting it is the SOCKET address, which behind a load balancer or
|
|
253
|
+
* Cloudflare is the proxy's, so every caller lands in the same bucket and one
|
|
254
|
+
* noisy client exhausts the allowance for everyone.
|
|
255
|
+
*
|
|
256
|
+
* `bootstrap({ trustProxy: true })` is the fix. Forwarded headers are
|
|
257
|
+
* deliberately not consulted here: `x-forwarded-for` is client-controllable
|
|
258
|
+
* unless a proxy overwrites it, so trusting it unconditionally would let a
|
|
259
|
+
* direct caller mint a fresh allowance per request by varying the header —
|
|
260
|
+
* evading the limit rather than enforcing it. The header chain
|
|
261
|
+
* (`cf-connecting-ip` → `x-forwarded-for` → `x-real-ip`) applies only on the
|
|
262
|
+
* `@forinda/kickjs/web` edge entry, where there is no socket and the platform
|
|
263
|
+
* has already terminated the connection.
|
|
264
|
+
* :::
|
|
265
|
+
*/
|
|
266
|
+
keyGenerator?: (ctx: RequestContext) => string;
|
|
267
|
+
/** Send `X-RateLimit-*` / `Retry-After` headers (default: true). */
|
|
268
|
+
headers?: boolean;
|
|
269
|
+
/**
|
|
270
|
+
* Counter backend. Defaults to a per-isolate in-memory map — fine for a
|
|
271
|
+
* single node process, useless on edge where isolates recycle: pass a
|
|
272
|
+
* `KvRateLimitStore` (or Redis-backed store) there.
|
|
273
|
+
*/
|
|
274
|
+
store?: RateLimitStore;
|
|
275
|
+
/** Skip limiting for a request (health checks, allowlists). */
|
|
276
|
+
skip?: (ctx: RequestContext) => boolean;
|
|
277
|
+
/**
|
|
278
|
+
* Skip limiting on routes carrying a route flag — a name, a list of names
|
|
279
|
+
* (any-of), or a predicate. Declared on the route rather than restated as a
|
|
280
|
+
* path here, so it cannot drift when `apiPrefix` or a module's `version`
|
|
281
|
+
* changes:
|
|
282
|
+
*
|
|
283
|
+
* ```ts
|
|
284
|
+
* const Public = defineRouteFlag('auth.public')
|
|
285
|
+
* rateLimitGuard({ max: 60, exemptWhen: 'auth.public' })
|
|
286
|
+
* ```
|
|
287
|
+
*
|
|
288
|
+
* Only meaningful where a route has been matched — as `@Middleware()` on a
|
|
289
|
+
* class or method, or in `createWebApp({ middleware })`. Mounted app-wide
|
|
290
|
+
* ahead of routing there is no route to read, and nothing is exempted.
|
|
291
|
+
*/
|
|
292
|
+
exemptWhen?: RouteFlagTest;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Rate limiting as a `(ctx, next)` middleware.
|
|
296
|
+
*
|
|
297
|
+
* ```ts
|
|
298
|
+
* // Edge (Cloudflare Workers) — app-wide:
|
|
299
|
+
* const app = createWebApp({
|
|
300
|
+
* h3, modules,
|
|
301
|
+
* middlewares: [rateLimitGuard({ max: 60, windowMs: 60_000, store: new KvRateLimitStore(env.KV, { windowMs: 60_000 }) })],
|
|
302
|
+
* })
|
|
303
|
+
*
|
|
304
|
+
* // Any runtime — per controller/route:
|
|
305
|
+
* @Middleware(rateLimitGuard({ max: 10 }))
|
|
306
|
+
* @Post('/login')
|
|
307
|
+
* ```
|
|
308
|
+
*/
|
|
309
|
+
declare function rateLimitGuard(options?: RateLimitGuardOptions): MiddlewareHandler;
|
|
310
|
+
//#endregion
|
|
311
|
+
//#region src/http/middleware/kv-stores.d.ts
|
|
312
|
+
/**
|
|
313
|
+
* The minimal async KV surface both stores need. Structurally compatible
|
|
314
|
+
* with a Cloudflare Workers `KVNamespace` binding — pass it straight in:
|
|
315
|
+
*
|
|
316
|
+
* ```ts
|
|
317
|
+
* export default {
|
|
318
|
+
* fetch(req: Request, env: Env) {
|
|
319
|
+
* const store = new KvRateLimitStore(env.MY_KV, { windowMs: 60_000 })
|
|
320
|
+
* // ...
|
|
321
|
+
* },
|
|
322
|
+
* }
|
|
323
|
+
* ```
|
|
324
|
+
*
|
|
325
|
+
* Anything with the same shape works too (Deno KV wrapper, Upstash Redis
|
|
326
|
+
* REST client adapter, a Map-backed fake in tests).
|
|
327
|
+
*/
|
|
328
|
+
interface KvLike {
|
|
329
|
+
get(key: string): Promise<string | null>;
|
|
330
|
+
put(key: string, value: string, options?: {
|
|
331
|
+
expirationTtl?: number;
|
|
332
|
+
}): Promise<void>;
|
|
333
|
+
delete(key: string): Promise<void>;
|
|
334
|
+
}
|
|
335
|
+
interface KvRateLimitStoreOptions {
|
|
336
|
+
/** Window length in ms — must match the `windowMs` given to the limiter. */
|
|
337
|
+
windowMs: number;
|
|
338
|
+
/** Key prefix in the KV namespace (default `'rl:'`). */
|
|
339
|
+
prefix?: string;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* {@link RateLimitStore} over a {@link KvLike} namespace, for edge deployments
|
|
343
|
+
* where in-memory counters reset on every isolate.
|
|
344
|
+
*
|
|
345
|
+
* KV is eventually consistent and this is a read-modify-write counter, so
|
|
346
|
+
* limiting is **approximate** under concurrency — bursts racing across
|
|
347
|
+
* isolates can each read the same count. That is the accepted trade-off for
|
|
348
|
+
* abuse throttling; use a Durable Object / Redis store when you need an
|
|
349
|
+
* exact ceiling (billing quotas, strict per-key locks).
|
|
350
|
+
*/
|
|
351
|
+
declare class KvRateLimitStore implements RateLimitStore {
|
|
352
|
+
private readonly kv;
|
|
353
|
+
private readonly prefix;
|
|
354
|
+
private readonly windowMs;
|
|
355
|
+
constructor(kv: KvLike, options: KvRateLimitStoreOptions);
|
|
356
|
+
increment(key: string): Promise<{
|
|
357
|
+
totalHits: number;
|
|
358
|
+
resetTime: Date;
|
|
359
|
+
}>;
|
|
360
|
+
decrement(key: string): Promise<void>;
|
|
361
|
+
reset(key: string): Promise<void>;
|
|
362
|
+
private read;
|
|
363
|
+
private write;
|
|
364
|
+
}
|
|
365
|
+
interface KvSessionStoreOptions {
|
|
366
|
+
/** Key prefix in the KV namespace (default `'sess:'`). */
|
|
367
|
+
prefix?: string;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* {@link SessionStore} over a {@link KvLike} namespace. Plug into the node
|
|
371
|
+
* `session()` middleware today (e.g. backed by Upstash/Cloudflare KV via
|
|
372
|
+
* REST) so sessions survive restarts and horizontal scaling; TTL expiry is
|
|
373
|
+
* delegated to the KV layer via `expirationTtl`.
|
|
374
|
+
*
|
|
375
|
+
* Cost note: `touch()` is a get + put round-trip (KvLike has no TTL-only
|
|
376
|
+
* refresh), so `session({ rolling: true })` doubles KV operations per
|
|
377
|
+
* request — per-operation-billed platforms may prefer `rolling: false`.
|
|
378
|
+
*/
|
|
379
|
+
declare class KvSessionStore implements SessionStore {
|
|
380
|
+
private readonly kv;
|
|
381
|
+
private readonly prefix;
|
|
382
|
+
constructor(kv: KvLike, options?: KvSessionStoreOptions);
|
|
383
|
+
get(sid: string): Promise<SessionData | null>;
|
|
384
|
+
set(sid: string, data: SessionData, maxAge: number): Promise<void>;
|
|
385
|
+
destroy(sid: string): Promise<void>;
|
|
386
|
+
touch(sid: string, maxAge: number): Promise<void>;
|
|
387
|
+
}
|
|
388
|
+
//#endregion
|
|
389
|
+
export { NoJobHandlerError as A, JOB_DISPATCHER as C, JobDispatcher as D, JobContextCarrier as E, registerJobContext as F, runJob as I, stampJobContext as L, ProcessDefinition as M, listJobHandlers as N, JobHandler as O, listJobQueues as P, JOB_CONTEXT_FIELD as S, Job as T, Respondable as _, KvSessionStoreOptions as a, isRespondable as b, matchesBearer as c, waitUntil as d, InferHandlerResponse as f, ReplyOptions as g, ReplyHeaders as h, KvSessionStore as i, Process as j, JobLike as k, PlatformContext as l, Reply as m, KvRateLimitStore as n, RateLimitGuardOptions as o, RESPOND as p, KvRateLimitStoreOptions as r, rateLimitGuard as s, KvLike as t, settleBackgroundWork as u, applyHandlerResult as v, JOB_META as w, reply as x, isReply as y };
|
|
390
|
+
//# sourceMappingURL=kv-stores-DXFBEYYu.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"kv-stores-DXFBEYYu.d.mts","names":[],"sources":["../src/core/jobs.ts","../src/http/reply.ts","../src/http/background.ts","../src/core/web-crypto.ts","../src/http/middleware/rate-limit-guard.ts","../src/http/middleware/kv-stores.ts"],"mappings":";;;;;;;;cA6Ba;WACX;WACA;;;UAIe;;EAEf;;EAEA;;;;;;;UAQe,QAAQ;EACvB;EACA,MAAM;EACN;;;iBAUc,IAAI,gBAAgB;;iBASpB,QAAQ,mBAAmB;;UAU1B,mBAAmB;EAClC;EACA,QAAQ;;;;;;;iBAQM,gBAAgB;EAAa,IAAI;IAA6B;;iBAgB9D,cAAc;EAAa,IAAI;;;cAKlC,0BAA0B;WAE1B;WACA;EAFX,YACW,eACA;;;;;;;;;;iBAeS,OACpB;EAAa,IAAI;EAA0B,QAAQ;GACnD,eACA,KAAK;;AAEL,SAAQ,0BACP;;;;;;UAoBc,kBAAkB;;EAEjC;;EAEA,WAAW;;EAEX,QAAQ,GAAG,OAAO,GAAG,WAAW,IAAI;;;cAIzB;;iBAKG,mBAAmB,GAAG,SAAS,kBAAkB;;;;;;;;iBAcjD,gBAAgB,MAAM,MAAM,OAAO;;UAiClC;EACf,SAAS,gBACP,eACA,cACA,MAAM,MACN,UAAU,0BACT;;;;;;cAOQ,6CAAc,eAAA;;;cCrNrB;;;;;;UAOW,MAAM,2BAA2B;YACtC;WACD,QAAQ;WACR,MAAM;;WAEN,UAAU;;;KAIT,eAAe,SAAS;;UAGnB;;EAEf,UAAU;;;;;;;;;;;;;;;iBAgBI,MAAM,kBAAkB,GACtC,QAAQ,GACR,MAAM,GACN,UAAU,eACT,MAAM,GAAG;kBAJI;MAWJ,KAAA,GAAC,MAAQ,MAAI,WAAW;MAUnB,UAAA,GAAC,MAAQ,GAAC,UAAY;IAAiB;QAAsB,WAAW;MASvE,WAAA,GAAC,MAAQ,MAAI,WAAW;MAEpB,iBAAA;;;;;;;;;;;;;;;;KAgBV,qBAAqB,KAAK,eAAc,wBAAwB,MACvE,QAAQ,QAAQ,mDAEf,YAAY,QAAQ,QAAQ;KAG7B,YAAY,KACf,UAAU,oBAAoB,KAC1B,IACA,UAAU,4BAWR;iBAEQ,QAAQ,iBAAiB,SAAS;;;;;;;;cAerC;;UAGI;GACd,SAAS,KAAK,wBAAwB;;iBAGzB,cAAc,iBAAiB,SAAS;;;;;;;;;;;;;;iBAqBxC,mBACd,KAAK,gBACL,4BACW;;;;;;;;;;;;;;;;;iBClIG,UAAU,SAAS;;;;;iBAiBb,wBAAwB;;;;;;UAc7B;EACf,WAAW,SAAS;;;;;;;;;;;iBCrCN,cAAc,iBAAiB;;;UCvB9B;;EAEf;;EAEA;;EAEA;;EAEA;;;;;;;;;;;;;;;;;;;;;;;EAuBA,gBAAgB,KAAK;;EAErB;;;;;;EAMA,QAAQ;;EAER,QAAQ,KAAK;;;;;;;;;;;;;;;;EAgBb,aAAa;;;;;;;;;;;;;;;;;iBAoDC,eAAe,UAAS,wBAA6B;;;;;;;;;;;;;;;;;;;UCnGpD;EACf,IAAI,cAAc;EAClB,IAAI,aAAa,eAAe;IAAY;MAA2B;EACvE,OAAO,cAAc;;UAQN;;EAEf;;EAEA;;;;;;;;;;;;cAaW,4BAA4B;mBAKpB;mBAJF;mBACA;EAEjB,YACmB,IAAI,QACrB,SAAS;EAML,UAAU,cAAc;IAAU;IAAmB,WAAW;;EAahE,UAAU,cAAc;EAQxB,MAAM,cAAc;UAIZ;UAUA;;UAOC;;EAEf;;;;;;;;;;;;cAaW,0BAA0B;mBAIlB;mBAHF;EAEjB,YACmB,IAAI,QACrB,UAAS;EAKL,IAAI,cAAc,QAAQ;EAU1B,IAAI,aAAa,MAAM,aAAa,iBAAiB;EAMrD,QAAQ,cAAc;EAItB,MAAM,aAAa,iBAAiB"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs v10.
|
|
2
|
+
* @forinda/kickjs v10.4.0
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -9,4 +9,4 @@
|
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
11
|
function lazyServeStatic(dir){let serve;return(req,res,next)=>{serve??=import(`serve-static`).then(mod=>(mod.default??mod)(dir)),serve.then(handler=>handler(req,res,next),next)}}export{lazyServeStatic as t};
|
|
12
|
-
//# sourceMappingURL=lazy-serve-static-
|
|
12
|
+
//# sourceMappingURL=lazy-serve-static-D94xvah5.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lazy-serve-static-
|
|
1
|
+
{"version":3,"file":"lazy-serve-static-D94xvah5.mjs","names":[],"sources":["../src/http/runtimes/lazy-serve-static.ts"],"sourcesContent":["import type { RequestHandler } from 'express'\n\n/**\n * `serve-static` as connect middleware, imported on the first request. Only\n * some apps serve files (SpaAdapter), and an `import()`, unlike\n * `createRequire`, is one a bundler follows — so a Netlify or Vercel\n * function carries the package instead of failing to find it.\n */\nexport function lazyServeStatic(dir: string): RequestHandler {\n let serve: Promise<RequestHandler> | undefined\n return (req, res, next) => {\n serve ??= import('serve-static').then((mod) => {\n const factory = ((mod as { default?: unknown }).default ?? mod) as (\n root: string,\n ) => RequestHandler\n return factory(dir)\n })\n serve.then((handler) => handler(req, res, next), next)\n }\n}\n"],"mappings":";;;;;;;;;;AAQA,SAAgB,gBAAgB,IAA6B,CAC3D,IAAI,MACJ,OAAQ,IAAK,IAAK,OAAS,CACzB,QAAU,OAAO,eAAe,CAAC,KAAM,MACnB,IAA8B,SAAW,IAAA,CAG5C,GAAG,CACnB,EACD,MAAM,KAAM,SAAY,QAAQ,IAAK,IAAK,IAAI,EAAG,IAAI,CACvD,CACF"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @forinda/kickjs v10.4.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) Felix Orinda
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
export{getMethodMeta as a,pushClassMeta as c,setInMetaMap as d,setInMetaRecord as f,getMetaRecord as i,pushMethodMeta as l,getClassMetaOrUndefined as n,getMethodMetaOrUndefined as o,setMethodMeta as p,getMetaMap as r,hasClassMeta as s,getClassMeta as t,setClassMeta as u}from"@forinda/kickjs-di";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs v10.
|
|
2
|
+
* @forinda/kickjs v10.4.0
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -9,4 +9,4 @@
|
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
11
|
import{createLogger}from"./core/logger.mjs";const log=createLogger(`Observers`);let observers=[],publisher,publisherWantsResponses=()=>!1;function setObservers(list){return observers=list.filter(o=>o.onError||o.onResponse),observers}function releaseObservers(installed){observers===installed&&(observers=[])}function setObserverPublisher(next,wantsResponses=()=>!1){publisher=next,publisherWantsResponses=wantsResponses}function hasResponseObservers(){return observers.some(o=>o.onResponse)||publisherWantsResponses()}function notify(pick,what){for(let observer of publisher?[...observers,publisher]:observers)try{let result=pick(observer);result&&typeof result.catch==`function`&&result.catch(err=>failed(observer,what,err))}catch(err){failed(observer,what,err)}}function failed(observer,what,err){try{log.error({err},`${observer.name??`observer`}.${what} threw — skipped`)}catch{}}function reportError(error,info){notify(o=>o.onError?.(error,info),`onError`)}function reportResponse(info){notify(o=>o.onResponse?.(info),`onResponse`)}export{setObserverPublisher as a,reportResponse as i,releaseObservers as n,setObservers as o,reportError as r,hasResponseObservers as t};
|
|
12
|
-
//# sourceMappingURL=observers-
|
|
12
|
+
//# sourceMappingURL=observers-BAXkwMx0.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"observers-
|
|
1
|
+
{"version":3,"file":"observers-BAXkwMx0.mjs","names":[],"sources":["../src/core/observers.ts"],"sourcesContent":["/**\n * One place every error and every response is reported to — so an error\n * tracker, a metrics exporter, or an APM integration hooks in once instead of\n * replacing the error handler and patching each source.\n *\n * Observers are adapters and plugins with `onError` / `onResponse`, plus\n * whatever the Node server's tracing channels publish (see `http/tracing.ts`).\n * Observe-only: they cannot change the response, and one that throws is\n * logged and skipped — it never breaks a request or another observer.\n *\n * Free of `node:` imports: `waitUntil` (shared with the web entry) reports\n * through here.\n *\n * @module @forinda/kickjs/core/observers\n */\nimport { createLogger } from './logger'\n\nconst log = createLogger('Observers')\n\n/** Where an error came from. Integrations may report their own sources. */\nexport type ErrorSource =\n | 'request'\n | 'uncaught'\n | 'unhandled-rejection'\n | 'background'\n | 'job'\n | (string & {})\n\nexport interface ErrorInfo {\n source: ErrorSource\n requestId?: string\n method?: string\n /** The request URL path, as received. */\n path?: string\n /** The matched route pattern, e.g. `/api/v1/users/:id`, when one matched. */\n route?: string\n /** The status the error was answered with, for request errors. */\n status?: number\n /** Anything else the reporter knows — a queue and job name, a cron schedule. */\n context?: Record<string, unknown>\n}\n\nexport interface ResponseInfo {\n method: string\n path: string\n /** The matched route pattern, or undefined when no route matched (404s). */\n route?: string\n status: number\n durationMs: number\n requestId?: string\n}\n\nexport interface Observer {\n name?: string\n onError?(error: unknown, info: ErrorInfo): void | Promise<void>\n onResponse?(info: ResponseInfo): void | Promise<void>\n}\n\nlet observers: readonly Observer[] = []\nlet publisher: Observer | undefined\nlet publisherWantsResponses: () => boolean = () => false\n\n/**\n * Replace the observer set — called by the Application from its adapters and\n * plugins. Returns the installed set, so its owner can later release exactly\n * that set (see {@link releaseObservers}).\n */\nexport function setObservers(list: readonly Observer[]): readonly Observer[] {\n observers = list.filter((o) => o.onError || o.onResponse)\n return observers\n}\n\n/**\n * Clear the observer set — but only if it is still the one `installed`. The\n * set is process-wide: a newer Application may have replaced it, and an older\n * one shutting down must not clear the newer one's observers.\n */\nexport function releaseObservers(installed: readonly Observer[]): void {\n if (observers === installed) observers = []\n}\n\n/**\n * The Node server's tracing channels, fed from the same reports. `wantsResponses`\n * is checked per request: a channel can gain a subscriber at any time.\n */\nexport function setObserverPublisher(\n next: Observer | undefined,\n wantsResponses: () => boolean = () => false,\n): void {\n publisher = next\n publisherWantsResponses = wantsResponses\n}\n\n/** Whether anything is listening for responses — lets the server skip timing work. */\nexport function hasResponseObservers(): boolean {\n return observers.some((o) => o.onResponse) || publisherWantsResponses()\n}\n\nfunction notify(pick: (o: Observer) => void | Promise<void> | undefined, what: string): void {\n for (const observer of publisher ? [...observers, publisher] : observers) {\n try {\n const result = pick(observer)\n if (result && typeof (result as Promise<void>).catch === 'function') {\n ;(result as Promise<void>).catch((err: unknown) => failed(observer, what, err))\n }\n } catch (err) {\n failed(observer, what, err)\n }\n }\n}\n\nfunction failed(observer: Observer, what: string, err: unknown): void {\n // Logged directly, never re-reported: an observer failing inside onError\n // must not loop back into onError. Guarded too: a custom LoggerProvider that\n // throws would otherwise escape reportError() — or, from an async\n // observer, become an unhandled rejection that bootstrap reports right back\n // here.\n try {\n log.error({ err }, `${observer.name ?? 'observer'}.${what} threw — skipped`)\n } catch {\n // Nothing left to tell; reportError's \"never throws\" contract wins.\n }\n}\n\n/**\n * Report an error to every observer. The framework calls this for request\n * errors, uncaught exceptions, unhandled rejections, `waitUntil` failures and\n * queue job failures; call it from your own integrations too (a cron runner,\n * a message consumer). Never throws.\n */\nexport function reportError(error: unknown, info: ErrorInfo): void {\n notify((o) => o.onError?.(error, info), 'onError')\n}\n\n/** Report a finished response to every observer. Never throws. */\nexport function reportResponse(info: ResponseInfo): void {\n notify((o) => o.onResponse?.(info), 'onResponse')\n}\n"],"mappings":";;;;;;;;;;4CAiBA,MAAM,IAAM,aAAa,WAAW,EAyCpC,IAAI,UAAiC,CAAC,EAClC,UACA,4BAA+C,GAOnD,SAAgB,aAAa,KAAgD,CAE3E,MADA,WAAY,KAAK,OAAQ,GAAM,EAAE,SAAW,EAAE,UAAU,EACjD,SACT,CAOA,SAAgB,iBAAiB,UAAsC,CACjE,YAAc,YAAW,UAAY,CAAC,EAC5C,CAMA,SAAgB,qBACd,KACA,mBAAsC,GAChC,CACN,UAAY,KACZ,wBAA0B,cAC5B,CAGA,SAAgB,sBAAgC,CAC9C,OAAO,UAAU,KAAM,GAAM,EAAE,UAAU,GAAK,wBAAwB,CACxE,CAEA,SAAS,OAAO,KAAyD,KAAoB,CAC3F,IAAK,IAAM,YAAY,UAAY,CAAC,GAAG,UAAW,SAAS,EAAI,UAC7D,GAAI,CACF,IAAM,OAAS,KAAK,QAAQ,EACxB,QAAU,OAAQ,OAAyB,OAAU,YACtD,OAA0B,MAAO,KAAiB,OAAO,SAAU,KAAM,GAAG,CAAC,CAElF,OAAS,IAAK,CACZ,OAAO,SAAU,KAAM,GAAG,CAC5B,CAEJ,CAEA,SAAS,OAAO,SAAoB,KAAc,IAAoB,CAMpE,GAAI,CACF,IAAI,MAAM,CAAE,GAAI,EAAG,GAAG,SAAS,MAAQ,WAAW,GAAG,KAAK,iBAAiB,CAC7E,MAAQ,CAER,CACF,CAQA,SAAgB,YAAY,MAAgB,KAAuB,CACjE,OAAQ,GAAM,EAAE,UAAU,MAAO,IAAI,EAAG,SAAS,CACnD,CAGA,SAAgB,eAAe,KAA0B,CACvD,OAAQ,GAAM,EAAE,aAAa,IAAI,EAAG,YAAY,CAClD"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @forinda/kickjs v10.4.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) Felix Orinda
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
const FILTER_OPERATORS=/* @__PURE__ */ new Set([`eq`,`neq`,`gt`,`gte`,`lt`,`lte`,`between`,`in`,`contains`,`starts`,`ends`]),BUILTIN_DEFAULTS={maxLimit:100,defaultLimit:20,maxSearchLength:200,defaultPage:1},defaults={...BUILTIN_DEFAULTS};function setQueryParsingDefaults(partial){partial.maxLimit!==void 0&&(defaults.maxLimit=partial.maxLimit),partial.defaultLimit!==void 0&&(defaults.defaultLimit=partial.defaultLimit),partial.maxSearchLength!==void 0&&(defaults.maxSearchLength=partial.maxSearchLength)}function getQueryParsingDefaults(){return{...defaults}}function resetQueryParsingDefaults(){Object.assign(defaults,BUILTIN_DEFAULTS)}function parseFilters(filterParam,allowedFields,options){if(!filterParam)return[];let items=Array.isArray(filterParam)?filterParam:[filterParam],results=[],allowed=allowedFields?new Set(allowedFields):null,onReject=options?.onReject;for(let item of items){let firstColon=item.indexOf(`:`);if(firstColon===-1)continue;let secondColon=item.indexOf(`:`,firstColon+1);if(secondColon===-1)continue;let field=item.slice(0,firstColon),operator=item.slice(firstColon+1,secondColon),value=item.slice(secondColon+1);field&&value&&(FILTER_OPERATORS.has(operator)?allowed&&!allowed.has(field)?onReject?.({kind:`filter`,field,reason:`field-not-allowed`}):results.push({field,operator,value}):onReject?.({kind:`filter`,field,reason:`unknown-operator`}))}return results}function parseSort(sortParam,allowedFields,options){if(!sortParam)return[];let items=(Array.isArray(sortParam)?sortParam:[sortParam]).flatMap(s=>s.split(`,`)),results=[],allowed=allowedFields?new Set(allowedFields):null,onReject=options?.onReject;for(let raw of items){let item=raw.trim();if(!item)continue;let field,dir,lastColon=item.lastIndexOf(`:`);lastColon===-1?item.startsWith(`-`)?(field=item.slice(1),dir=`desc`):(field=item.startsWith(`+`)?item.slice(1):item,dir=`asc`):(field=item.slice(0,lastColon),dir=item.slice(lastColon+1).toLowerCase()),field&&(dir===`asc`||dir===`desc`)&&(allowed&&!allowed.has(field)?onReject?.({kind:`sort`,field,reason:`field-not-allowed`}):results.push({field,direction:dir}))}return results}function parsePagination(params,options){let defaultLimit=options?.defaultLimit??defaults.defaultLimit,maxLimit=options?.maxLimit??defaults.maxLimit,page=typeof params.page==`string`?Number.parseInt(params.page,10):params.page??defaults.defaultPage,limit=typeof params.limit==`string`?Number.parseInt(params.limit,10):params.limit??defaultLimit;return(Number.isNaN(page)||page<1)&&(page=defaults.defaultPage),(Number.isNaN(limit)||limit<1)&&(limit=defaultLimit),limit>maxLimit&&(limit=maxLimit),{page,limit,offset:(page-1)*limit}}function parseSearchQuery(q,options){if(!q)return``;let maxLen=options?.maxSearchLength??defaults.maxSearchLength,trimmed=q.trim();return trimmed.length>maxLen?(options?.onReject?.({kind:`search`,field:`q`,reason:`truncated`}),trimmed.slice(0,maxLen)):trimmed}function normalizeFieldConfig(config){if(config)return`columns`in config&&config.columns&&typeof config.columns==`object`?{filterable:Object.keys(config.columns),sortable:config.sortable?Object.keys(config.sortable):void 0,searchable:void 0}:config}function parseQuery(query,fieldConfig,options){let normalized=normalizeFieldConfig(fieldConfig),rejectOpts=options?.onReject?{onReject:options.onReject}:void 0;return{filters:parseFilters(query.filter,normalized?.filterable,rejectOpts),sort:parseSort(query.sort,normalized?.sortable,rejectOpts),pagination:parsePagination({page:query.page,limit:query.limit},options),search:parseSearchQuery(query.q,options)}}function buildQueryParams(parsed){let params={};return parsed.filters?.length&&(params.filter=parsed.filters.map(f=>`${f.field}:${f.operator}:${f.value}`)),parsed.sort?.length&&(params.sort=parsed.sort.map(s=>`${s.field}:${s.direction}`)),parsed.pagination&&(params.page=parsed.pagination.page,params.limit=parsed.pagination.limit),parsed.search&&(params.q=parsed.search),params}export{parseQuery as a,resetQueryParsingDefaults as c,parsePagination as i,setQueryParsingDefaults as l,getQueryParsingDefaults as n,parseSearchQuery as o,parseFilters as r,parseSort as s,buildQueryParams as t,FILTER_OPERATORS as u};
|
|
12
|
+
//# sourceMappingURL=query-CGyw7vNi.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query-CGyw7vNi.mjs","names":[],"sources":["../src/http/query/types.ts","../src/http/query/parse-query.ts"],"sourcesContent":["/** Supported filter operators for query string parsing */\nexport type FilterOperator =\n | 'eq'\n | 'neq'\n | 'gt'\n | 'gte'\n | 'lt'\n | 'lte'\n | 'between'\n | 'in'\n | 'contains'\n | 'starts'\n | 'ends'\n\nexport const FILTER_OPERATORS = new Set<string>([\n 'eq',\n 'neq',\n 'gt',\n 'gte',\n 'lt',\n 'lte',\n 'between',\n 'in',\n 'contains',\n 'starts',\n 'ends',\n])\n\nexport interface FilterItem {\n field: string\n operator: FilterOperator\n value: string\n}\n\nexport interface SortItem {\n field: string\n direction: 'asc' | 'desc'\n}\n\nexport interface PaginationParams {\n page: number\n limit: number\n offset: number\n}\n\n/**\n * The result of parsing a query string. ORM-agnostic — pass this to\n * a query builder adapter (Drizzle, Prisma, Sequelize, etc.) to produce\n * database-specific query objects.\n */\nexport interface ParsedQuery {\n filters: FilterItem[]\n sort: SortItem[]\n pagination: PaginationParams\n search: string\n}\n\n/**\n * Helper that extracts the literal field union from a `QueryFieldConfig`\n * key. When the user passes `{ filterable: ['status', 'category'] } as const`,\n * `FieldsOf<typeof config, 'filterable'>` resolves to `'status' | 'category'`.\n *\n * Without `as const`, the arrays widen to `string[]` and the union falls\n * back to `string`. This is the documented escape hatch.\n */\nexport type FieldsOf<\n TConfig extends QueryFieldConfig | undefined,\n K extends 'filterable' | 'sortable' | 'searchable',\n> = TConfig extends { readonly [P in K]: readonly (infer F)[] }\n ? F extends string\n ? F\n : string\n : TConfig extends { columns: infer C }\n ? K extends 'filterable'\n ? keyof C & string\n : string\n : string\n\n/**\n * Narrowed `ParsedQuery` whose `filters[].field` and `sort[].field`\n * unions are constrained to the literal whitelist passed to\n * `ctx.qs()` / `parseQuery()`. Extends `ParsedQuery`, so any function\n * accepting `ParsedQuery` accepts a `TypedParsedQuery<X>` automatically\n * (subtype assignment, no codegen, backward compatible).\n *\n * @example\n * ```ts\n * const parsed = ctx.qs({\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt'],\n * } as const)\n * parsed.filters[0]?.field // 'status' | 'priority'\n * parsed.sort[0]?.field // 'createdAt'\n * ```\n */\nexport interface TypedParsedQuery<\n TConfig extends QueryFieldConfig | undefined,\n> extends ParsedQuery {\n filters: Array<FilterItem & { field: FieldsOf<TConfig, 'filterable'> }>\n sort: Array<SortItem & { field: FieldsOf<TConfig, 'sortable'> }>\n}\n\n/**\n * Restrict which fields can be filtered, sorted, or searched.\n * Fields not in the allow-list are silently ignored.\n *\n * Accepts two forms:\n * 1. **String arrays** (standard): `{ filterable: ['name', 'status'], sortable: ['createdAt'] }`\n * 2. **Column-object maps** (Drizzle-style): `{ columns: { name: col, status: col }, sortable: { createdAt: col } }`\n *\n * When column-object maps are provided, `Object.keys()` is used to derive the field names.\n */\nexport type QueryFieldConfig = StringQueryFieldConfig | ColumnQueryFieldConfig\n\nexport interface StringQueryFieldConfig {\n filterable?: string[]\n sortable?: string[]\n searchable?: string[]\n}\n\n/**\n * Column-object-based field config (e.g., from DrizzleQueryParamsConfig).\n * Keys are the field names used in query strings; values are ORM column references.\n */\nexport interface ColumnQueryFieldConfig {\n columns: Record<string, any>\n sortable?: Record<string, any>\n searchColumns?: any[]\n [key: string]: any\n}\n\n/** Standardized paginated response shape */\nexport interface PaginatedResponse<T = any> {\n data: T[]\n meta: {\n page: number\n limit: number\n total: number\n totalPages: number\n hasNext: boolean\n hasPrev: boolean\n }\n /**\n * Relative links (path + query, never a host) to this page and its\n * neighbours. `next` / `prev` are `null` at the ends.\n */\n links: { self: string; next: string | null; prev: string | null }\n}\n\n/** A JSON primitive stored in a cursor. Dates arrive as ISO strings. */\nexport type CursorValue = string | number | boolean | null\n\n/**\n * Where the previous page ended: the last row's values for the active sort\n * fields plus the id tie-breaker, keyed by field name — e.g.\n * `{ createdAt: '2026-01-01T00:00:00.000Z', id: 'u7' }`.\n *\n * Decoded from a client-supplied cursor and NOT signed: treat it as untrusted\n * input. Bind the values as query parameters and keep filters / authorization\n * scoping in the fetcher, so a forged cursor can only move the position,\n * never widen what the caller may see.\n */\nexport type CursorPosition = Readonly<Record<string, CursorValue>>\n\n/** What `ctx.paginateCursor()` hands its fetcher. */\nexport interface CursorQuery<TConfig extends QueryFieldConfig | undefined = undefined> extends Omit<\n TypedParsedQuery<TConfig>,\n 'pagination'\n> {\n /** `null` on the first page. */\n cursor: CursorPosition | null\n /** Page size. Fetch `limit + 1` rows — the extra one tells whether a next page exists. */\n limit: number\n}\n\n/** Options for `ctx.paginateCursor()`. */\nexport interface CursorPaginateOptions<T = any> {\n /** Unique, stable tie-breaker field read off each row. Default `'id'`. */\n idField?: string\n /**\n * Build the cursor values from a row yourself, instead of reading the sort\n * fields + `idField` off it (e.g. when the row shape differs from the\n * sortable field names). Values must be JSON primitives.\n */\n cursorKey?: (row: T) => Record<string, CursorValue>\n}\n\n/** Standardized cursor (keyset) paginated response shape */\nexport interface CursorPaginatedResponse<T = any> {\n data: T[]\n meta: {\n limit: number\n hasNext: boolean\n /** Opaque; pass back as `?cursor=` for the next page. `null` on the last page. */\n nextCursor: string | null\n }\n /** Relative links (path + query, never a host); `next` is `null` on the last page. */\n links: { self: string; next: string | null }\n}\n\n/**\n * Interface for ORM-specific query builder adapters.\n * Implement this to translate a `ParsedQuery` into your ORM's query format.\n *\n * @example\n * ```ts\n * // Drizzle adapter\n * class DrizzleQueryAdapter implements QueryBuilderAdapter<DrizzleQueryResult> {\n * build(parsed: ParsedQuery, config: DrizzleConfig): DrizzleQueryResult {\n * // Convert filters → Drizzle SQL conditions\n * // Convert sort → Drizzle orderBy\n * return { where, orderBy, limit, offset }\n * }\n * }\n *\n * // Prisma adapter\n * class PrismaQueryAdapter implements QueryBuilderAdapter<PrismaQueryResult> {\n * build(parsed: ParsedQuery, config: PrismaConfig): PrismaQueryResult {\n * return { where, orderBy, skip, take }\n * }\n * }\n * ```\n */\nexport interface QueryBuilderAdapter<TResult = any, TConfig = any> {\n /** Human-readable name for debugging */\n readonly name: string\n\n /**\n * Convert a ParsedQuery into an ORM-specific query object.\n * @param parsed - The ORM-agnostic parsed query\n * @param config - ORM-specific configuration (column maps, search columns, etc.)\n */\n build(parsed: ParsedQuery, config: TConfig): TResult\n}\n","import {\n FILTER_OPERATORS,\n type FilterItem,\n type FilterOperator,\n type SortItem,\n type PaginationParams,\n type ParsedQuery,\n type QueryFieldConfig,\n type StringQueryFieldConfig,\n type TypedParsedQuery,\n} from './types'\n\n// ── Configurable defaults ───────────────────────────────────────────────\n\n/**\n * Why a rejected field/value was dropped. Surfaced through\n * {@link ParseQueryOptions.onReject} so a caller can warn, count, or\n * return a 400 instead of the historical silent drop.\n */\nexport type QueryRejectReason = 'field-not-allowed' | 'unknown-operator' | 'truncated'\n\nexport interface QueryRejection {\n kind: 'filter' | 'sort' | 'search'\n field: string\n reason: QueryRejectReason\n}\n\nexport interface ParseQueryOptions {\n /** Hard cap on `limit`. Default: global (100, override via {@link setQueryParsingDefaults}). */\n maxLimit?: number\n /** `limit` when the query omits one. Default: global (20). */\n defaultLimit?: number\n /** Max `q` length before truncation. Default: global (200). */\n maxSearchLength?: number\n /**\n * Called once per dropped filter/sort field or truncated search.\n * The historical behaviour is a silent drop; wire this to a logger or\n * a 400 to make over-broad / typo'd queries visible.\n */\n onReject?: (rejection: QueryRejection) => void\n}\n\ninterface QueryParsingDefaults {\n maxLimit: number\n defaultLimit: number\n maxSearchLength: number\n defaultPage: number\n}\n\nconst BUILTIN_DEFAULTS: QueryParsingDefaults = {\n maxLimit: 100,\n defaultLimit: 20,\n maxSearchLength: 200,\n defaultPage: 1,\n}\n\nconst defaults: QueryParsingDefaults = { ...BUILTIN_DEFAULTS }\n\n/**\n * Globally override the query-parsing limits — call once at bootstrap.\n * Per-call {@link ParseQueryOptions} still take precedence over these.\n */\nexport function setQueryParsingDefaults(\n partial: Partial<Omit<QueryParsingDefaults, 'defaultPage'>>,\n): void {\n if (partial.maxLimit !== undefined) defaults.maxLimit = partial.maxLimit\n if (partial.defaultLimit !== undefined) defaults.defaultLimit = partial.defaultLimit\n if (partial.maxSearchLength !== undefined) defaults.maxSearchLength = partial.maxSearchLength\n}\n\n/** Read the current global query-parsing defaults (a copy). */\nexport function getQueryParsingDefaults(): Readonly<QueryParsingDefaults> {\n return { ...defaults }\n}\n\n/**\n * Restore the built-in query-parsing defaults (maxLimit 100, defaultLimit\n * 20, maxSearchLength 200). Useful in test teardown after a\n * {@link setQueryParsingDefaults} override so global state can't leak\n * between tests.\n */\nexport function resetQueryParsingDefaults(): void {\n Object.assign(defaults, BUILTIN_DEFAULTS)\n}\n\n// ── Individual parsers ──────────────────────────────────────────────────\n\n/** Parse filter strings like \"status:eq:active\" into structured objects */\nexport function parseFilters(\n filterParam: string | string[] | undefined,\n allowedFields?: string[],\n options?: Pick<ParseQueryOptions, 'onReject'>,\n): FilterItem[] {\n if (!filterParam) return []\n\n const items = Array.isArray(filterParam) ? filterParam : [filterParam]\n const results: FilterItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n const onReject = options?.onReject\n\n for (const item of items) {\n // Split on first two colons only — value may contain colons (e.g. timestamps)\n const firstColon = item.indexOf(':')\n if (firstColon === -1) continue\n\n const secondColon = item.indexOf(':', firstColon + 1)\n if (secondColon === -1) continue\n\n const field = item.slice(0, firstColon)\n const operator = item.slice(firstColon + 1, secondColon)\n const value = item.slice(secondColon + 1)\n\n if (!field || !value) continue\n if (!FILTER_OPERATORS.has(operator)) {\n onReject?.({ kind: 'filter', field, reason: 'unknown-operator' })\n continue\n }\n if (allowed && !allowed.has(field)) {\n onReject?.({ kind: 'filter', field, reason: 'field-not-allowed' })\n continue\n }\n\n results.push({ field, operator: operator as FilterOperator, value })\n }\n\n return results\n}\n\n/**\n * Parse sort into structured items. Accepts `field:asc|desc`, `-field`\n * (descending), and `field` / `+field` (ascending), repeated or\n * comma-separated: `?sort=-featured,price` = `?sort=featured:desc&sort=price:asc`.\n */\nexport function parseSort(\n sortParam: string | string[] | undefined,\n allowedFields?: string[],\n options?: Pick<ParseQueryOptions, 'onReject'>,\n): SortItem[] {\n if (!sortParam) return []\n\n const items = (Array.isArray(sortParam) ? sortParam : [sortParam]).flatMap((s) => s.split(','))\n const results: SortItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n const onReject = options?.onReject\n\n for (const raw of items) {\n // `+` in a query string arrives as a space; trim covers `+field` too.\n const item = raw.trim()\n if (!item) continue\n let field: string\n let dir: string\n const lastColon = item.lastIndexOf(':')\n if (lastColon !== -1) {\n // Split on the last colon so field names with colons work.\n field = item.slice(0, lastColon)\n dir = item.slice(lastColon + 1).toLowerCase()\n } else if (item.startsWith('-')) {\n field = item.slice(1)\n dir = 'desc'\n } else {\n field = item.startsWith('+') ? item.slice(1) : item\n dir = 'asc'\n }\n\n if (!field) continue\n if (dir !== 'asc' && dir !== 'desc') continue\n if (allowed && !allowed.has(field)) {\n onReject?.({ kind: 'sort', field, reason: 'field-not-allowed' })\n continue\n }\n\n results.push({ field, direction: dir })\n }\n\n return results\n}\n\n/** Parse page/limit into pagination with computed offset */\nexport function parsePagination(\n params: {\n page?: string | number\n limit?: string | number\n },\n options?: Pick<ParseQueryOptions, 'maxLimit' | 'defaultLimit'>,\n): PaginationParams {\n const defaultLimit = options?.defaultLimit ?? defaults.defaultLimit\n const maxLimit = options?.maxLimit ?? defaults.maxLimit\n\n let page =\n typeof params.page === 'string'\n ? Number.parseInt(params.page, 10)\n : (params.page ?? defaults.defaultPage)\n let limit =\n typeof params.limit === 'string'\n ? Number.parseInt(params.limit, 10)\n : (params.limit ?? defaultLimit)\n\n if (Number.isNaN(page) || page < 1) page = defaults.defaultPage\n if (Number.isNaN(limit) || limit < 1) limit = defaultLimit\n if (limit > maxLimit) limit = maxLimit\n\n return { page, limit, offset: (page - 1) * limit }\n}\n\n/** Sanitize and truncate search query */\nexport function parseSearchQuery(\n q: string | undefined,\n options?: Pick<ParseQueryOptions, 'maxSearchLength' | 'onReject'>,\n): string {\n if (!q) return ''\n const maxLen = options?.maxSearchLength ?? defaults.maxSearchLength\n const trimmed = q.trim()\n if (trimmed.length > maxLen) {\n options?.onReject?.({ kind: 'search', field: 'q', reason: 'truncated' })\n return trimmed.slice(0, maxLen)\n }\n return trimmed\n}\n\n// ── Config normalizer ───────────────────────────────────────────────────\n\n/**\n * Normalize a QueryFieldConfig into the string-based form.\n * Detects column-object-based configs (DrizzleQueryParamsConfig) by checking\n * for a `columns` property and extracts `Object.keys()`.\n */\nfunction normalizeFieldConfig(config?: QueryFieldConfig): StringQueryFieldConfig | undefined {\n if (!config) return undefined\n\n // Column-object-based config (e.g., DrizzleQueryParamsConfig)\n if ('columns' in config && config.columns && typeof config.columns === 'object') {\n return {\n filterable: Object.keys(config.columns),\n sortable: config.sortable ? Object.keys(config.sortable) : undefined,\n searchable: undefined, // searchColumns are Column objects, not used for string filtering\n }\n }\n\n // Already string-based\n return config as StringQueryFieldConfig\n}\n\n// ── Combined parser ─────────────────────────────────────────────────────\n\n/**\n * Parse a raw Express query object into a structured, ORM-agnostic ParsedQuery.\n *\n * @param query - Raw query string object from `req.query` or Zod-validated object\n * @param fieldConfig - Optional field restrictions (whitelist filterable/sortable/searchable).\n * Accepts both string-based configs (`{ filterable, sortable, searchable }`) and\n * column-object configs (`{ columns, sortable, searchColumns }`).\n * @param options - Limits + an `onReject` hook for dropped/truncated input.\n *\n * @example\n * ```ts\n * // String-based config\n * const parsed = parseQuery(ctx.query, {\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt', 'title'],\n * })\n *\n * // Column-object config (DrizzleQueryParamsConfig)\n * const parsed = parseQuery(ctx.query, TASK_QUERY_CONFIG)\n * ```\n *\n * Query string format:\n * - Filters: `?filter=field:operator:value` (repeatable)\n * - Sort: `?sort=field:asc|desc`, `-field` / `field`, repeatable or comma-separated\n * - Pagination: `?page=1&limit=20`\n * - Search: `?q=search+term`\n *\n * Filter operators: eq, neq, gt, gte, lt, lte, between, in, contains, starts, ends\n */\nexport function parseQuery<TConfig extends QueryFieldConfig | undefined = undefined>(\n query: Record<string, any>,\n fieldConfig?: TConfig,\n options?: ParseQueryOptions,\n): TypedParsedQuery<TConfig> {\n const normalized = normalizeFieldConfig(fieldConfig)\n const rejectOpts = options?.onReject ? { onReject: options.onReject } : undefined\n return {\n filters: parseFilters(query.filter, normalized?.filterable, rejectOpts),\n sort: parseSort(query.sort, normalized?.sortable, rejectOpts),\n pagination: parsePagination({ page: query.page, limit: query.limit }, options),\n search: parseSearchQuery(query.q, options),\n } as TypedParsedQuery<TConfig>\n}\n\n// ── Query URL builder (for client-side or testing) ──────────────────────\n\n/** Convert ParsedQuery back into query string parameters */\nexport function buildQueryParams(\n parsed: Partial<ParsedQuery>,\n): Record<string, string | string[] | number> {\n const params: Record<string, string | string[] | number> = {}\n\n if (parsed.filters?.length) {\n params.filter = parsed.filters.map((f) => `${f.field}:${f.operator}:${f.value}`)\n }\n\n if (parsed.sort?.length) {\n params.sort = parsed.sort.map((s) => `${s.field}:${s.direction}`)\n }\n\n if (parsed.pagination) {\n params.page = parsed.pagination.page\n params.limit = parsed.pagination.limit\n }\n\n if (parsed.search) {\n params.q = parsed.search\n }\n\n return params\n}\n"],"mappings":";;;;;;;;;;AAcA,MAAa,iCAAmB,IAAI,IAAY,CAC9C,KACA,MACA,KACA,MACA,KACA,MACA,UACA,KACA,WACA,SACA,MACF,CAAC,ECuBK,iBAAyC,CAC7C,SAAU,IACV,aAAc,GACd,gBAAiB,IACjB,YAAa,CACf,EAEM,SAAiC,CAAE,GAAG,gBAAiB,EAM7D,SAAgB,wBACd,QACM,CACF,QAAQ,WAAa,IAAA,KAAW,SAAS,SAAW,QAAQ,UAC5D,QAAQ,eAAiB,IAAA,KAAW,SAAS,aAAe,QAAQ,cACpE,QAAQ,kBAAoB,IAAA,KAAW,SAAS,gBAAkB,QAAQ,gBAChF,CAGA,SAAgB,yBAA0D,CACxE,MAAO,CAAE,GAAG,QAAS,CACvB,CAQA,SAAgB,2BAAkC,CAChD,OAAO,OAAO,SAAU,gBAAgB,CAC1C,CAKA,SAAgB,aACd,YACA,cACA,QACc,CACd,GAAI,CAAC,YAAa,MAAO,CAAC,EAE1B,IAAM,MAAQ,MAAM,QAAQ,WAAW,EAAI,YAAc,CAAC,WAAW,EAC/D,QAAwB,CAAC,EACzB,QAAU,cAAgB,IAAI,IAAI,aAAa,EAAI,KACnD,SAAW,SAAS,SAE1B,IAAK,IAAM,QAAQ,MAAO,CAExB,IAAM,WAAa,KAAK,QAAQ,GAAG,EACnC,GAAI,aAAe,GAAI,SAEvB,IAAM,YAAc,KAAK,QAAQ,IAAK,WAAa,CAAC,EACpD,GAAI,cAAgB,GAAI,SAExB,IAAM,MAAQ,KAAK,MAAM,EAAG,UAAU,EAChC,SAAW,KAAK,MAAM,WAAa,EAAG,WAAW,EACjD,MAAQ,KAAK,MAAM,YAAc,CAAC,EAEnC,OAAU,QACV,iBAAiB,IAAI,QAAQ,EAI9B,SAAW,CAAC,QAAQ,IAAI,KAAK,EAC/B,WAAW,CAAE,KAAM,SAAU,MAAO,OAAQ,mBAAoB,CAAC,EAInE,QAAQ,KAAK,CAAE,MAAiB,SAA4B,KAAM,CAAC,EARjE,WAAW,CAAE,KAAM,SAAU,MAAO,OAAQ,kBAAmB,CAAC,EASpE,CAEA,OAAO,OACT,CAOA,SAAgB,UACd,UACA,cACA,QACY,CACZ,GAAI,CAAC,UAAW,MAAO,CAAC,EAExB,IAAM,OAAS,MAAM,QAAQ,SAAS,EAAI,UAAY,CAAC,SAAS,EAAA,CAAG,QAAS,GAAM,EAAE,MAAM,GAAG,CAAC,EACxF,QAAsB,CAAC,EACvB,QAAU,cAAgB,IAAI,IAAI,aAAa,EAAI,KACnD,SAAW,SAAS,SAE1B,IAAK,IAAM,OAAO,MAAO,CAEvB,IAAM,KAAO,IAAI,KAAK,EACtB,GAAI,CAAC,KAAM,SACX,IAAI,MACA,IACE,UAAY,KAAK,YAAY,GAAG,EAClC,YAAc,GAIP,KAAK,WAAW,GAAG,GAC5B,MAAQ,KAAK,MAAM,CAAC,EACpB,IAAM,SAEN,MAAQ,KAAK,WAAW,GAAG,EAAI,KAAK,MAAM,CAAC,EAAI,KAC/C,IAAM,QAPN,MAAQ,KAAK,MAAM,EAAG,SAAS,EAC/B,IAAM,KAAK,MAAM,UAAY,CAAC,CAAC,CAAC,YAAY,GASzC,QACD,MAAQ,OAAS,MAAQ,UACzB,SAAW,CAAC,QAAQ,IAAI,KAAK,EAC/B,WAAW,CAAE,KAAM,OAAQ,MAAO,OAAQ,mBAAoB,CAAC,EAIjE,QAAQ,KAAK,CAAE,MAAO,UAAW,GAAI,CAAC,EACxC,CAEA,OAAO,OACT,CAGA,SAAgB,gBACd,OAIA,QACkB,CAClB,IAAM,aAAe,SAAS,cAAgB,SAAS,aACjD,SAAW,SAAS,UAAY,SAAS,SAE3C,KACF,OAAO,OAAO,MAAS,SACnB,OAAO,SAAS,OAAO,KAAM,EAAE,EAC9B,OAAO,MAAQ,SAAS,YAC3B,MACF,OAAO,OAAO,OAAU,SACpB,OAAO,SAAS,OAAO,MAAO,EAAE,EAC/B,OAAO,OAAS,aAMvB,OAJI,OAAO,MAAM,IAAI,GAAK,KAAO,KAAG,KAAO,SAAS,cAChD,OAAO,MAAM,KAAK,GAAK,MAAQ,KAAG,MAAQ,cAC1C,MAAQ,WAAU,MAAQ,UAEvB,CAAE,KAAM,MAAO,QAAS,KAAO,GAAK,KAAM,CACnD,CAGA,SAAgB,iBACd,EACA,QACQ,CACR,GAAI,CAAC,EAAG,MAAO,GACf,IAAM,OAAS,SAAS,iBAAmB,SAAS,gBAC9C,QAAU,EAAE,KAAK,EAKvB,OAJI,QAAQ,OAAS,QACnB,SAAS,WAAW,CAAE,KAAM,SAAU,MAAO,IAAK,OAAQ,WAAY,CAAC,EAChE,QAAQ,MAAM,EAAG,MAAM,GAEzB,OACT,CASA,SAAS,qBAAqB,OAA+D,CAC3F,GAAK,OAYL,MATI,YAAa,QAAU,OAAO,SAAW,OAAO,OAAO,SAAY,SAC9D,CACL,WAAY,OAAO,KAAK,OAAO,OAAO,EACtC,SAAU,OAAO,SAAW,OAAO,KAAK,OAAO,QAAQ,EAAI,IAAA,GAC3D,WAAY,IAAA,EACd,EAIK,MACT,CAiCA,SAAgB,WACd,MACA,YACA,QAC2B,CAC3B,IAAM,WAAa,qBAAqB,WAAW,EAC7C,WAAa,SAAS,SAAW,CAAE,SAAU,QAAQ,QAAS,EAAI,IAAA,GACxE,MAAO,CACL,QAAS,aAAa,MAAM,OAAQ,YAAY,WAAY,UAAU,EACtE,KAAM,UAAU,MAAM,KAAM,YAAY,SAAU,UAAU,EAC5D,WAAY,gBAAgB,CAAE,KAAM,MAAM,KAAM,MAAO,MAAM,KAAM,EAAG,OAAO,EAC7E,OAAQ,iBAAiB,MAAM,EAAG,OAAO,CAC3C,CACF,CAKA,SAAgB,iBACd,OAC4C,CAC5C,IAAM,OAAqD,CAAC,EAmB5D,OAjBI,OAAO,SAAS,SAClB,OAAO,OAAS,OAAO,QAAQ,IAAK,GAAM,GAAG,EAAE,MAAM,GAAG,EAAE,SAAS,GAAG,EAAE,OAAO,GAG7E,OAAO,MAAM,SACf,OAAO,KAAO,OAAO,KAAK,IAAK,GAAM,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,GAG9D,OAAO,aACT,OAAO,KAAO,OAAO,WAAW,KAChC,OAAO,MAAQ,OAAO,WAAW,OAG/B,OAAO,SACT,OAAO,EAAI,OAAO,QAGb,MACT"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs v10.
|
|
2
|
+
* @forinda/kickjs v10.4.0
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
*
|
|
9
9
|
* @license MIT
|
|
10
10
|
*/
|
|
11
|
-
import{METADATA}from"./core/interfaces.mjs";import{createLogger}from"./core/logger.mjs";import{n as getClassMetaOrUndefined}from"./metadata-
|
|
12
|
-
//# sourceMappingURL=reply-
|
|
11
|
+
import{METADATA}from"./core/interfaces.mjs";import{createLogger}from"./core/logger.mjs";import{n as getClassMetaOrUndefined}from"./metadata-Bm65Y-5O.mjs";import{HttpException}from"./core/errors.mjs";import{f as requestStore}from"./context-CRJzl_Mj.mjs";function normalizeMediaType(contentType){return((Array.isArray(contentType)?contentType[0]:contentType)??``).split(`;`)[0].trim().toLowerCase()}function isJsonMediaType(mediaType){return mediaType===`application/json`||/^application\/[\w.+-]+\+json$/.test(mediaType)}function classifyMediaType(contentType){let mediaType=normalizeMediaType(contentType);return mediaType?isJsonMediaType(mediaType)?`json`:mediaType===`application/x-www-form-urlencoded`?`urlencoded`:mediaType.startsWith(`multipart/`)?`multipart`:mediaType.startsWith(`text/`)?`text`:`unsupported`:`unsupported`}const EXPRESS_JSON_TYPES=[`application/json`,`application/*+json`],SUPPORTED_BODY_TYPES=[`application/json`,`application/*+json`,`application/x-www-form-urlencoded`,`text/*`,`multipart/form-data`];function unsupportedMediaTypeError(contentType){let mediaType=normalizeMediaType(contentType);return new HttpException(415,mediaType?`Unsupported Media Type: ${mediaType}`:`Unsupported Media Type: request has a body but no Content-Type`,void 0,{Accept:SUPPORTED_BODY_TYPES.join(`, `)})}const BODY_METHODS=/* @__PURE__ */ new Set([`POST`,`PUT`,`PATCH`,`DELETE`]),RAW_BODY=Symbol.for(`kick/http/raw-body`);function rejectUnsupportedBody(){return(req,_res,next)=>{if(!BODY_METHODS.has((req.method??`GET`).toUpperCase())||req[RAW_BODY]||classifyMediaType(req.headers?.[`content-type`])!==`unsupported`)return next();let reject=()=>next(unsupportedMediaTypeError(req.headers?.[`content-type`])),length=req.headers?.[`content-length`];if(length!==void 0)return length===`0`?next():reject();if(req.headers?.[`transfer-encoding`]===void 0)return next();let decided=!1,settle=fn=>()=>{decided||(decided=!0,req.off?.(`data`,onData),req.off?.(`end`,onEnd),fn())},onData=settle(reject),onEnd=settle(()=>next());req.on?.(`data`,onData),req.on?.(`end`,onEnd)}}const BYTE_UNITS={b:1,kb:1024,mb:1024**2,gb:1024**3};function parseByteSize(value){if(typeof value==`number`)return value;let match=/^\s*(\d+(?:\.\d+)?)\s*(b|kb|mb|gb)?\s*$/i.exec(value);if(!match)throw Error(`Invalid body size limit: '${value}'`);return Math.floor(Number(match[1])*BYTE_UNITS[(match[2]??`b`).toLowerCase()])}function tooLarge(limit){return new HttpException(413,`Request body is larger than the ${limit}-byte limit`)}async function readBodyText(request,limit){if(Number(request.headers.get(`content-length`))>limit)throw tooLarge(limit);if(!request.body)return``;let reader=request.body.getReader(),decoder=new TextDecoder,size=0,text=``;for(;;){let{done,value}=await reader.read();if(done)break;if(size+=value.byteLength,size>limit)throw await reader.cancel().catch(()=>{}),tooLarge(limit);text+=decoder.decode(value,{stream:!0})}return text+decoder.decode()}function parseForm(raw){let fields=/* @__PURE__ */ new Map;for(let[key,value]of new URLSearchParams(raw)){let prev=fields.get(key);prev===void 0?fields.set(key,value):Array.isArray(prev)?prev.push(value):fields.set(key,[prev,value])}return Object.fromEntries(fields)}const log=createLogger(`RequestScope`),preDestroyCache=/* @__PURE__ */ new Map;function preDestroyMethod(ctor){let method=preDestroyCache.get(ctor);return method===void 0&&(method=getClassMetaOrUndefined(METADATA.PRE_DESTROY,ctor.prototype)??null,preDestroyCache.set(ctor,method)),method}function disposeRequestStore(store){if(!store.disposed&&(store.disposed=!0,store.instances.size!==0)){for(let instance of store.instances.values()){if(typeof instance!=`object`||!instance)continue;let method=preDestroyMethod(instance.constructor);if(method&&typeof instance[method]==`function`)try{let result=instance[method]();result&&typeof result.then==`function`&&result.catch(err=>log.error(err,`@PreDestroy on ${instance.constructor.name} rejected`))}catch(err){log.error(err,`@PreDestroy on ${instance.constructor.name} threw`)}}store.instances.clear()}}const REQUEST_SCOPE_MIDDLEWARE_MARKER=Symbol.for(`@kickjs/requestScopeMiddleware`);function createRequestStore(requestId){return{requestId:requestId||crypto.randomUUID(),instances:/* @__PURE__ */ new Map,values:/* @__PURE__ */ new Map}}function requestScopeMiddleware(){let mw=(req,res,next)=>{let requestIdHeader=req.headers[`x-request-id`],requestId=req.requestId||(Array.isArray(requestIdHeader)?requestIdHeader[0]:requestIdHeader)||crypto.randomUUID(),store=createRequestStore(requestId);req.requestId=requestId,!res.headersSent&&!res.getHeader(`x-request-id`)&&res.setHeader(`x-request-id`,requestId),res.once(`close`,()=>disposeRequestStore(store)),requestStore.run(store,next)};return mw[REQUEST_SCOPE_MIDDLEWARE_MARKER]=!0,mw}function isRequestScopeMiddleware(value){return typeof value==`function`&&value[REQUEST_SCOPE_MIDDLEWARE_MARKER]===!0}const REPLY_BRAND=Symbol.for(`kickjs.reply`);function reply(status,body,options){return options?.headers?{[REPLY_BRAND]:!0,status,body,headers:options.headers}:{[REPLY_BRAND]:!0,status,body}}reply.ok=body=>reply(200,body),reply.created=(body,options)=>reply(201,body,options?.location===void 0?options:{headers:{...options.headers,Location:options.location}}),reply.accepted=body=>reply(202,body),reply.noContent=()=>reply(204,void 0);function isReply(value){return typeof value==`object`&&!!value&&value[REPLY_BRAND]===!0}const RESPOND=Symbol.for(`kickjs.respond`);function isRespondable(value){return typeof value==`object`&&!!value&&typeof value[RESPOND]==`function`}function applyHandlerResult(ctx,result){if(result===void 0)return!1;if(isRespondable(result)){let sent=result[RESPOND](ctx);return typeof sent?.then!=`function`||Promise.resolve(sent).then(()=>!0)}if(isReply(result)){if(result.headers)for(let[name,value]of Object.entries(result.headers))ctx.setHeader(name,value);return result.status===204?(ctx.noContent(),!0):(ctx.json(result.body,result.status),!0)}return ctx.json(result),!0}export{unsupportedMediaTypeError as _,reply as a,isRequestScopeMiddleware as c,RAW_BODY as d,classifyMediaType as f,rejectUnsupportedBody as g,readBodyText as h,isRespondable as i,requestScopeMiddleware as l,parseForm as m,applyHandlerResult as n,createRequestStore as o,parseByteSize as p,isReply as r,disposeRequestStore as s,RESPOND as t,EXPRESS_JSON_TYPES as u};
|
|
12
|
+
//# sourceMappingURL=reply-tlUaowib.mjs.map
|