@forinda/kickjs 3.2.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -212
- package/dist/adapter-6Pp4kFdM.d.mts +296 -0
- package/dist/adapter-6Pp4kFdM.d.mts.map +1 -0
- package/dist/{app-module-ERR9jhow.d.mts → app-module-Blgz4Rti.d.mts} +4 -4
- package/dist/app-module-Blgz4Rti.d.mts.map +1 -0
- package/dist/application-Bepa-pFw.d.mts +302 -0
- package/dist/application-Bepa-pFw.d.mts.map +1 -0
- package/dist/{application-x8CXLOlv.mjs → application-DvmPMUgF.mjs} +28 -9
- package/dist/application-DvmPMUgF.mjs.map +1 -0
- package/dist/bootstrap-B4T3X2B6.d.mts +28 -0
- package/dist/bootstrap-B4T3X2B6.d.mts.map +1 -0
- package/dist/{bootstrap-CYnxozL_.mjs → bootstrap-THfr8phJ.mjs} +6 -6
- package/dist/{bootstrap-CYnxozL_.mjs.map → bootstrap-THfr8phJ.mjs.map} +1 -1
- package/dist/{cache-V91BNTIM.d.mts → cache-XrNWj1KQ.d.mts} +3 -3
- package/dist/{cache-V91BNTIM.d.mts.map → cache-XrNWj1KQ.d.mts.map} +1 -1
- package/dist/config/index.d.mts +1 -1
- package/dist/config/index.mjs +3 -3
- package/dist/{config-aWxKLk4A.mjs → config-BEjgF1fI.mjs} +4 -4
- package/dist/{config-aWxKLk4A.mjs.map → config-BEjgF1fI.mjs.map} +1 -1
- package/dist/{container-Dnk43k54.mjs → container-BYuMSnqW.mjs} +314 -9
- package/dist/container-BYuMSnqW.mjs.map +1 -0
- package/dist/{container-fIS1uLx-.d.mts → container-CnWDsxi-.d.mts} +9 -7
- package/dist/container-CnWDsxi-.d.mts.map +1 -0
- package/dist/{context-OktlOQBQ.mjs → context-CyQbqSz-.mjs} +33 -41
- package/dist/context-CyQbqSz-.mjs.map +1 -0
- package/dist/context-Ymvv-85x.d.mts +260 -0
- package/dist/context-Ymvv-85x.d.mts.map +1 -0
- package/dist/{context-decorator-GA8-hDLe.d.mts → context-decorator-DrPvQ9Ag.d.mts} +62 -12
- package/dist/context-decorator-DrPvQ9Ag.d.mts.map +1 -0
- 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.d.mts +1 -1
- package/dist/core/cache.mjs +3 -3
- package/dist/core/cache.mjs.map +1 -1
- package/dist/core/container.d.mts +1 -1
- package/dist/core/container.mjs +2 -2
- package/dist/core/cron.d.mts +1 -1
- package/dist/core/cron.mjs +3 -3
- package/dist/core/cron.mjs.map +1 -1
- package/dist/core/decorators.d.mts +2 -2
- package/dist/core/decorators.mjs +48 -16
- package/dist/core/decorators.mjs.map +1 -1
- package/dist/core/errors.d.mts +1 -1
- package/dist/core/errors.mjs +1 -1
- package/dist/core/interfaces.d.mts +1 -1
- package/dist/core/interfaces.mjs +35 -18
- package/dist/core/interfaces.mjs.map +1 -1
- package/dist/core/logger.d.mts +2 -2
- package/dist/core/logger.mjs +2 -4
- package/dist/core/logger.mjs.map +1 -1
- package/dist/core/path.d.mts +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.d.mts +1 -1
- package/dist/core/reactivity.mjs +1 -1
- package/dist/{core-DANnH5-e.mjs → core-Dj3iVQ3t.mjs} +305 -8
- package/dist/core-Dj3iVQ3t.mjs.map +1 -0
- package/dist/cors-BfgqfLPd.d.mts +48 -0
- package/dist/cors-BfgqfLPd.d.mts.map +1 -0
- package/dist/{cron-CfsPdi7R.d.mts → cron-GNoYydfg.d.mts} +2 -2
- package/dist/cron-GNoYydfg.d.mts.map +1 -0
- package/dist/csrf-DiK9zept.d.mts +52 -0
- package/dist/csrf-DiK9zept.d.mts.map +1 -0
- package/dist/{decorators-H42oPg0m.d.mts → decorators-BMvaLliz.d.mts} +147 -12
- package/dist/decorators-BMvaLliz.d.mts.map +1 -0
- package/dist/{env-Cs8Wt8A_.mjs → env-DMqv56Bb.mjs} +3 -4
- package/dist/{env-Cs8Wt8A_.mjs.map → env-DMqv56Bb.mjs.map} +1 -1
- package/dist/error-handler-Xud_3Lah.d.mts +20 -0
- package/dist/error-handler-Xud_3Lah.d.mts.map +1 -0
- package/dist/{errors-D_CWI7Bl.d.mts → errors-uaHCeXRz.d.mts} +1 -1
- package/dist/{errors-D_CWI7Bl.d.mts.map → errors-uaHCeXRz.d.mts.map} +1 -1
- package/dist/{execution-context-Dl2CKqSo.d.mts → execution-context-DKnt61pY.d.mts} +1 -1
- package/dist/{execution-context-Dl2CKqSo.d.mts.map → execution-context-DKnt61pY.d.mts.map} +1 -1
- package/dist/helmet-CaMbjzBG.d.mts +41 -0
- package/dist/helmet-CaMbjzBG.d.mts.map +1 -0
- package/dist/http/application.d.mts +2 -293
- package/dist/http/application.mjs +2 -2
- package/dist/http/bootstrap.d.mts +2 -27
- package/dist/http/bootstrap.mjs +2 -2
- package/dist/http/context.d.mts +3 -251
- package/dist/http/context.mjs +2 -2
- package/dist/http/middleware/cors.d.mts +2 -47
- package/dist/http/middleware/cors.mjs +1 -1
- package/dist/http/middleware/csrf.d.mts +2 -51
- package/dist/http/middleware/csrf.mjs +2 -2
- package/dist/http/middleware/csrf.mjs.map +1 -1
- package/dist/http/middleware/error-handler.d.mts +2 -19
- package/dist/http/middleware/error-handler.mjs +2 -2
- package/dist/http/middleware/helmet.d.mts +2 -40
- package/dist/http/middleware/helmet.mjs +1 -1
- package/dist/http/middleware/rate-limit.d.mts +2 -55
- package/dist/http/middleware/rate-limit.mjs +2 -2
- package/dist/http/middleware/rate-limit.mjs.map +1 -1
- package/dist/http/middleware/request-id.d.mts +2 -9
- package/dist/http/middleware/request-id.mjs +12 -3
- package/dist/http/middleware/request-id.mjs.map +1 -1
- package/dist/http/middleware/request-logger.d.mts +2 -31
- package/dist/http/middleware/request-logger.mjs +2 -2
- package/dist/http/middleware/session.d.mts +2 -69
- package/dist/http/middleware/session.mjs +1 -1
- package/dist/http/middleware/spa.d.mts +2 -100
- package/dist/http/middleware/spa.mjs +5 -5
- package/dist/http/middleware/spa.mjs.map +1 -1
- package/dist/http/middleware/upload.d.mts +2 -78
- package/dist/http/middleware/upload.mjs +1 -1
- package/dist/http/middleware/validate.d.mts +2 -22
- package/dist/http/middleware/validate.mjs +2 -2
- package/dist/http/middleware/views.d.mts +2 -61
- package/dist/http/middleware/views.mjs +16 -15
- package/dist/http/middleware/views.mjs.map +1 -1
- package/dist/http/query/index.d.mts +1 -1
- package/dist/http/query/index.mjs +2 -2
- package/dist/http/router-builder.d.mts +2 -32
- package/dist/http/router-builder.mjs +10 -14
- package/dist/http/router-builder.mjs.map +1 -1
- package/dist/{index-RNK41JPE.d.mts → index-B9cyOQAe.d.mts} +1 -1
- package/dist/{index-RNK41JPE.d.mts.map → index-B9cyOQAe.d.mts.map} +1 -1
- package/dist/{index-Cf-MGrqT.d.mts → index-D-qhXg9M.d.mts} +3 -3
- package/dist/{index-Cf-MGrqT.d.mts.map → index-D-qhXg9M.d.mts.map} +1 -1
- package/dist/{index-BQM9pJrV.d.mts → index-Yhs9sTMW.d.mts} +241 -5
- package/dist/index-Yhs9sTMW.d.mts.map +1 -0
- package/dist/index.d.mts +34 -152
- package/dist/index.mjs +50 -14
- package/dist/index.mjs.map +1 -1
- package/dist/interfaces-B50n7dwl.d.mts +71 -0
- package/dist/{interfaces-CwcdqfNq.d.mts.map → interfaces-B50n7dwl.d.mts.map} +1 -1
- package/dist/{logger-GK8yT0BD.d.mts → logger-CLVRZf2N.d.mts} +2 -4
- package/dist/{logger-GK8yT0BD.d.mts.map → logger-CLVRZf2N.d.mts.map} +1 -1
- package/dist/{metadata-BFuoSEX6.mjs → metadata-BF1WDBOh.mjs} +2 -2
- package/dist/{metadata-BFuoSEX6.mjs.map → metadata-BF1WDBOh.mjs.map} +1 -1
- package/dist/{path-Bj3vZMUY.d.mts → path-Diviu6hv.d.mts} +1 -1
- package/dist/path-Diviu6hv.d.mts.map +1 -0
- package/dist/{plugin-3rKA0Loy.d.mts → plugin-DDjoN4XI.d.mts} +46 -8
- package/dist/plugin-DDjoN4XI.d.mts.map +1 -0
- package/dist/{query-BcYEjYyX.mjs → query-BrYRQMa5.mjs} +2 -2
- package/dist/{query-BcYEjYyX.mjs.map → query-BrYRQMa5.mjs.map} +1 -1
- package/dist/rate-limit-DUwoICtI.d.mts +56 -0
- package/dist/rate-limit-DUwoICtI.d.mts.map +1 -0
- package/dist/{reactivity-CczHu3R-.d.mts → reactivity-CfJceo4H.d.mts} +1 -1
- package/dist/{reactivity-CczHu3R-.d.mts.map → reactivity-CfJceo4H.d.mts.map} +1 -1
- package/dist/request-id-BgglvZHN.d.mts +19 -0
- package/dist/request-id-BgglvZHN.d.mts.map +1 -0
- package/dist/request-logger-CWHbAzTE.d.mts +32 -0
- package/dist/request-logger-CWHbAzTE.d.mts.map +1 -0
- package/dist/router-builder-zsX4Oq7c.d.mts +31 -0
- package/dist/router-builder-zsX4Oq7c.d.mts.map +1 -0
- package/dist/session-N0hActOO.d.mts +70 -0
- package/dist/session-N0hActOO.d.mts.map +1 -0
- package/dist/spa-CwIbdvPc.d.mts +101 -0
- package/dist/spa-CwIbdvPc.d.mts.map +1 -0
- package/dist/upload-BueOnnLw.d.mts +79 -0
- package/dist/upload-BueOnnLw.d.mts.map +1 -0
- package/dist/validate-HwAyWTwH.d.mts +23 -0
- package/dist/validate-HwAyWTwH.d.mts.map +1 -0
- package/dist/views-v05_dP1I.d.mts +181 -0
- package/dist/views-v05_dP1I.d.mts.map +1 -0
- package/package.json +6 -9
- package/dist/adapter-DLEHb0K6.d.mts +0 -151
- package/dist/adapter-DLEHb0K6.d.mts.map +0 -1
- package/dist/app-module-ERR9jhow.d.mts.map +0 -1
- package/dist/application-x8CXLOlv.mjs.map +0 -1
- package/dist/chunk-Bt-rz0Tp.mjs +0 -15
- package/dist/container-Dnk43k54.mjs.map +0 -1
- package/dist/container-fIS1uLx-.d.mts.map +0 -1
- package/dist/context-OktlOQBQ.mjs.map +0 -1
- package/dist/context-decorator-GA8-hDLe.d.mts.map +0 -1
- package/dist/core-DANnH5-e.mjs.map +0 -1
- package/dist/cron-CfsPdi7R.d.mts.map +0 -1
- package/dist/decorators-H42oPg0m.d.mts.map +0 -1
- package/dist/http/application.d.mts.map +0 -1
- package/dist/http/bootstrap.d.mts.map +0 -1
- package/dist/http/context.d.mts.map +0 -1
- package/dist/http/middleware/cors.d.mts.map +0 -1
- package/dist/http/middleware/csrf.d.mts.map +0 -1
- package/dist/http/middleware/error-handler.d.mts.map +0 -1
- package/dist/http/middleware/helmet.d.mts.map +0 -1
- package/dist/http/middleware/rate-limit.d.mts.map +0 -1
- package/dist/http/middleware/request-id.d.mts.map +0 -1
- package/dist/http/middleware/request-logger.d.mts.map +0 -1
- package/dist/http/middleware/session.d.mts.map +0 -1
- package/dist/http/middleware/spa.d.mts.map +0 -1
- package/dist/http/middleware/upload.d.mts.map +0 -1
- package/dist/http/middleware/validate.d.mts.map +0 -1
- package/dist/http/middleware/views.d.mts.map +0 -1
- package/dist/http/router-builder.d.mts.map +0 -1
- package/dist/index-BQM9pJrV.d.mts.map +0 -1
- package/dist/index.d.mts.map +0 -1
- package/dist/interfaces-CwcdqfNq.d.mts +0 -54
- package/dist/path-Bj3vZMUY.d.mts.map +0 -1
- package/dist/plugin-3rKA0Loy.d.mts.map +0 -1
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/core/interfaces.d.ts
|
|
3
|
+
/** Lifecycle scope for DI registrations */
|
|
4
|
+
declare enum Scope {
|
|
5
|
+
SINGLETON = "singleton",
|
|
6
|
+
TRANSIENT = "transient",
|
|
7
|
+
/** One instance per HTTP request, cached in AsyncLocalStorage. Throws outside request context. */
|
|
8
|
+
REQUEST = "request"
|
|
9
|
+
}
|
|
10
|
+
/** Generic constructor type */
|
|
11
|
+
type Constructor<T = any> = new (...args: any[]) => T;
|
|
12
|
+
/** A value that may or may not be wrapped in a Promise */
|
|
13
|
+
type MaybePromise<T = void> = T | Promise<T>;
|
|
14
|
+
/** Options for @Service, @Repository, @Component decorators */
|
|
15
|
+
interface ServiceOptions {
|
|
16
|
+
scope?: Scope;
|
|
17
|
+
}
|
|
18
|
+
/** Fluent builder type */
|
|
19
|
+
type BuilderOf<T> = { [K in keyof T as T[K] extends Function ? never : K]-?: (value: T[K]) => BuilderOf<T> } & {
|
|
20
|
+
build(): T;
|
|
21
|
+
};
|
|
22
|
+
/** Class with static builder() method */
|
|
23
|
+
interface Buildable<T> {
|
|
24
|
+
builder(): BuilderOf<T>;
|
|
25
|
+
}
|
|
26
|
+
/** Decorator class kind for devtools introspection */
|
|
27
|
+
type ClassKind = 'service' | 'controller' | 'repository' | 'component' | 'injectable' | 'factory' | 'instance' | 'unknown';
|
|
28
|
+
/** PostConstruct lifecycle status */
|
|
29
|
+
type PostConstructStatus = 'pending' | 'completed' | 'failed' | 'skipped';
|
|
30
|
+
/**
|
|
31
|
+
* String metadata keys for the DI system + decorator subsystem. Every
|
|
32
|
+
* key starts with the `kick:` prefix; the suffix is a short identifier
|
|
33
|
+
* that may itself contain `:`, `-`, or `_` separators (historical —
|
|
34
|
+
* keys grew alongside the framework). The §22 v4 convention is "no
|
|
35
|
+
* Symbols", not "use a strict naming scheme" — Symbols don't survive
|
|
36
|
+
* JSON serialisation, can't be addressed by string from worker
|
|
37
|
+
* threads, and don't show up in DevTools snapshots.
|
|
38
|
+
*
|
|
39
|
+
* `reflect-metadata` accepts both Symbol and string keys identically,
|
|
40
|
+
* so the consumer-side change is internal — references go through the
|
|
41
|
+
* `METADATA` enum's named members (e.g. `METADATA.INJECT`), not the
|
|
42
|
+
* underlying string.
|
|
43
|
+
*
|
|
44
|
+
* The `design:*` entries match what TypeScript's
|
|
45
|
+
* `emitDecoratorMetadata` writes; those names are fixed by the
|
|
46
|
+
* compiler + must stay as-is.
|
|
47
|
+
*/
|
|
48
|
+
declare const METADATA: {
|
|
49
|
+
readonly INJECTABLE: "kick:injectable";
|
|
50
|
+
readonly SCOPE: "kick:scope";
|
|
51
|
+
readonly CLASS_KIND: "kick:class-kind";
|
|
52
|
+
readonly AUTOWIRED: "kick:autowired";
|
|
53
|
+
readonly INJECT: "kick:inject";
|
|
54
|
+
readonly POST_CONSTRUCT: "kick:post_construct";
|
|
55
|
+
readonly BUILDER: "kick:builder";
|
|
56
|
+
readonly QUERY_PARAMS: "kick:query:params";
|
|
57
|
+
readonly ROUTES: "kick:routes";
|
|
58
|
+
readonly CLASS_MIDDLEWARES: "kick:class:middlewares";
|
|
59
|
+
readonly METHOD_MIDDLEWARES: "kick:method:middlewares";
|
|
60
|
+
readonly CLASS_CONTRIBUTORS: "kick:class:contributors";
|
|
61
|
+
readonly METHOD_CONTRIBUTORS: "kick:method:contributors";
|
|
62
|
+
readonly FILE_UPLOAD: "kick:file:upload";
|
|
63
|
+
readonly VALUE: "kick:value";
|
|
64
|
+
readonly ASSET: "kick:asset";
|
|
65
|
+
readonly PARAM_TYPES: "design:paramtypes";
|
|
66
|
+
readonly PROPERTY_TYPE: "design:type";
|
|
67
|
+
readonly RETURN_TYPE: "design:returntype";
|
|
68
|
+
};
|
|
69
|
+
//#endregion
|
|
70
|
+
export { METADATA as a, Scope as c, Constructor as i, ServiceOptions as l, BuilderOf as n, MaybePromise as o, ClassKind as r, PostConstructStatus as s, Buildable as t };
|
|
71
|
+
//# sourceMappingURL=interfaces-B50n7dwl.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"interfaces-
|
|
1
|
+
{"version":3,"file":"interfaces-B50n7dwl.d.mts","names":[],"sources":["../src/core/interfaces.ts"],"mappings":";;;aAGY,KAAA;EACV,SAAA;EACA,SAAA;;EAEA,OAAA;AAAA;;KAIU,WAAA,oBAA+B,IAAA,YAAgB,CAAA;;KAG/C,YAAA,aAAyB,CAAA,GAAI,OAAA,CAAQ,CAAA;AAHjD;AAAA,UAMiB,cAAA;EACf,KAAA,GAAQ,KAAA;AAAA;;KAIE,SAAA,oBACE,CAAA,IAAK,CAAA,CAAE,CAAA,UAAW,QAAA,WAAmB,CAAA,MAAO,KAAA,EAAO,CAAA,CAAE,CAAA,MAAO,SAAA,CAAU,CAAA;EAC9E,KAAA,IAAS,CAAA;AAAA;;UAGE,SAAA;EACf,OAAA,IAAW,SAAA,CAAU,CAAA;AAAA;;KAIX,SAAA;;KAWA,mBAAA;;;;;;AA1BZ;;;;;AAKA;;;;;;;;cAyCa,QAAA;EAAA"}
|
|
@@ -112,8 +112,6 @@ declare class Logger {
|
|
|
112
112
|
}
|
|
113
113
|
/** Shorthand for Logger.for(name) */
|
|
114
114
|
declare function createLogger(name: string): Logger;
|
|
115
|
-
/** @deprecated Use rootLogger instead */
|
|
116
|
-
declare const logger: pino.Logger<never, boolean>;
|
|
117
115
|
//#endregion
|
|
118
|
-
export {
|
|
119
|
-
//# sourceMappingURL=logger-
|
|
116
|
+
export { rootLogger as a, createLogger as i, Logger as n, LoggerProvider as r, ConsoleLoggerProvider as t };
|
|
117
|
+
//# sourceMappingURL=logger-CLVRZf2N.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger-
|
|
1
|
+
{"version":3,"file":"logger-CLVRZf2N.d.mts","names":[],"sources":["../src/core/logger.ts"],"mappings":";;;;;cAKa,UAAA,EAAU,IAAA,CAAA,MAAA;AAAvB;;;;;AA0BA;AA1BA,UA0BiB,cAAA;EACf,IAAA,CAAK,GAAA,aAAgB,IAAA;EACrB,IAAA,CAAK,GAAA,aAAgB,IAAA;EACrB,KAAA,CAAM,GAAA,aAAgB,IAAA;EACtB,KAAA,CAAM,GAAA,aAAgB,IAAA;EACtB,KAAA,EAAO,GAAA,aAAgB,IAAA;EACvB,KAAA,EAAO,GAAA,aAAgB,IAAA;EAJlB;EAML,KAAA,CAAM,QAAA;IAAY,SAAA;EAAA,IAAsB,cAAA;AAAA;;;;;cA0C7B,qBAAA,YAAiC,cAAA;EAAA,QACpC,MAAA;cAEI,MAAA;EAAA,QAIJ,GAAA;EAIR,IAAA,CAAK,GAAA,aAAgB,IAAA;EAGrB,IAAA,CAAK,GAAA,aAAgB,IAAA;EAGrB,KAAA,CAAM,GAAA,aAAgB,IAAA;EAGtB,KAAA,CAAM,GAAA,aAAgB,IAAA;EAGtB,KAAA,CAAM,GAAA,aAAgB,IAAA;EAGtB,KAAA,CAAM,GAAA,aAAgB,IAAA;EAGtB,KAAA,CAAM,QAAA;IAAY,SAAA;EAAA,IAAsB,cAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;cAoC7B,MAAA;EAAA,QACH,SAAA;EAAA,QACA,gBAAA;EAAA,QACA,KAAA;EAvC8C;;AAoCxD;;;EApCwD,OA8C/C,gBAAA,SAAyB,MAAA;EA8BH;EAAA,eA3Bd,gBAAA;cAEH,IAAA;EAyDS;EAAA,YAlDT,QAAA,CAAA;EAkDe;;;;;;;;;;EAAA,OAhCpB,WAAA,CAAY,QAAA,EAAU,cAAA;EAAA;EAAA,OAOtB,WAAA,CAAA,GAAe,cAAA;EAAf;;;;EAAA,OAQA,aAAA,CAAA;EAOmB;EAAA,OAAnB,GAAA,CAAI,IAAA,WAAe,MAAA;EAUpB;EAAN,KAAA,CAAM,IAAA,WAAe,MAAA;EAKb;EAAA,QAAA,GAAA;EAIR,IAAA,CAAK,GAAA,aAAgB,IAAA;EAIrB,IAAA,CAAK,GAAA,aAAgB,IAAA;EAIrB,KAAA,CAAM,QAAA,OAAe,GAAA,cAAiB,IAAA;EAUtC,KAAA,CAAM,GAAA,aAAgB,IAAA;EAItB,KAAA,CAAM,GAAA,aAAgB,IAAA;EAItB,KAAA,CAAM,GAAA,aAAgB,IAAA;AAAA;;iBAMR,YAAA,CAAa,IAAA,WAAe,MAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs
|
|
2
|
+
* @forinda/kickjs v4.1.0
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -73,4 +73,4 @@ function getMetaRecord(key, target) {
|
|
|
73
73
|
//#endregion
|
|
74
74
|
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 };
|
|
75
75
|
|
|
76
|
-
//# sourceMappingURL=metadata-
|
|
76
|
+
//# sourceMappingURL=metadata-BF1WDBOh.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata-
|
|
1
|
+
{"version":3,"file":"metadata-BF1WDBOh.mjs","names":[],"sources":["../src/core/metadata.ts"],"sourcesContent":["import 'reflect-metadata'\nimport type { InjectionToken } from './token'\n\n/**\n * Typed utilities for reflect-metadata operations.\n *\n * Replaces scattered Reflect.defineMetadata/getMetadata calls with a single\n * source of truth. If we later move to Stage 3 decorators or a WeakMap-based\n * store, only this file changes — all 24+ consumer files stay untouched.\n *\n * Keys may be symbols, strings, or `InjectionToken<T>` objects produced by\n * `createToken()`. Using `createToken` is the preferred pattern because the\n * token's phantom type flows through the helpers, enabling type-safe reads.\n */\n\ntype MetaKey = symbol | string | InjectionToken<unknown>\n\n// ── Setters ─────────────────────────────────────────────────────\n\n/** Set metadata on a class (or prototype for property decorators) */\nexport function setClassMeta<T>(key: MetaKey, value: T, target: object): void {\n Reflect.defineMetadata(key, value, target)\n}\n\n/** Set metadata on a specific method */\nexport function setMethodMeta<T>(key: MetaKey, value: T, target: object, method: string): void {\n Reflect.defineMetadata(key, value, target, method)\n}\n\n// ── Getters ─────────────────────────────────────────────────────\n\n/** Get metadata from a class, returning `fallback` if not set */\nexport function getClassMeta<T>(key: MetaKey, target: object, fallback: T): T {\n return (Reflect.getMetadata(key, target) as T) ?? fallback\n}\n\n/** Get metadata from a specific method, returning `fallback` if not set */\nexport function getMethodMeta<T>(key: MetaKey, target: object, method: string, fallback: T): T {\n return (Reflect.getMetadata(key, target, method) as T) ?? fallback\n}\n\n/** Check if metadata exists on a class */\nexport function hasClassMeta(key: MetaKey, target: object): boolean {\n return Reflect.hasMetadata(key, target)\n}\n\n/** Get metadata from a class with no default (returns undefined if absent) */\nexport function getClassMetaOrUndefined<T>(key: MetaKey, target: object): T | undefined {\n return Reflect.getMetadata(key, target) as T | undefined\n}\n\n/** Get metadata from a method with no default (returns undefined if absent) */\nexport function getMethodMetaOrUndefined<T>(\n key: MetaKey,\n target: object,\n method: string,\n): T | undefined {\n return Reflect.getMetadata(key, target, method) as T | undefined\n}\n\n// ── Accumulate: Arrays ──────────────────────────────────────────\n\n/** Append items to an array stored in class metadata */\nexport function pushClassMeta<T>(key: MetaKey, target: object, ...items: T[]): void {\n const existing: T[] = Reflect.getOwnMetadata(key, target) ?? []\n Reflect.defineMetadata(key, [...existing, ...items], target)\n}\n\n/** Append items to an array stored in method metadata */\nexport function pushMethodMeta<T>(\n key: MetaKey,\n target: object,\n method: string,\n ...items: T[]\n): void {\n const existing: T[] = Reflect.getOwnMetadata(key, target, method) ?? []\n Reflect.defineMetadata(key, [...existing, ...items], target, method)\n}\n\n// ── Accumulate: Maps ────────────────────────────────────────────\n\n/** Set a key/value in a Map stored in class metadata */\nexport function setInMetaMap<K, V>(key: MetaKey, target: object, mapKey: K, mapValue: V): void {\n const inherited: Map<K, V> | undefined = Reflect.getOwnMetadata(key, target)\n const map = inherited ? new Map(inherited) : new Map<K, V>()\n map.set(mapKey, mapValue)\n Reflect.defineMetadata(key, map, target)\n}\n\n/** Get a Map from class metadata (returns empty Map if absent) */\nexport function getMetaMap<K, V>(key: MetaKey, target: object): Map<K, V> {\n return Reflect.getMetadata(key, target) ?? new Map()\n}\n\n// ── Accumulate: Records ─────────────────────────────────────────\n\n/** Set a key/value in a Record stored in class metadata */\nexport function setInMetaRecord<V>(\n key: MetaKey,\n target: object,\n recKey: string | number,\n recValue: V,\n): void {\n const inherited: Record<string | number, V> | undefined = Reflect.getOwnMetadata(key, target)\n const rec = inherited ? { ...inherited } : {}\n rec[recKey] = recValue\n Reflect.defineMetadata(key, rec, target)\n}\n\n/** Get a Record from class metadata (returns empty object if absent) */\nexport function getMetaRecord<V>(key: MetaKey, target: object): Record<string | number, V> {\n return Reflect.getMetadata(key, target) ?? {}\n}\n"],"mappings":";;;;;;;;;;;;;AAoBA,SAAgB,aAAgB,KAAc,OAAU,QAAsB;AAC5E,SAAQ,eAAe,KAAK,OAAO,OAAO;;;AAI5C,SAAgB,cAAiB,KAAc,OAAU,QAAgB,QAAsB;AAC7F,SAAQ,eAAe,KAAK,OAAO,QAAQ,OAAO;;;AAMpD,SAAgB,aAAgB,KAAc,QAAgB,UAAgB;AAC5E,QAAQ,QAAQ,YAAY,KAAK,OAAO,IAAU;;;AAIpD,SAAgB,cAAiB,KAAc,QAAgB,QAAgB,UAAgB;AAC7F,QAAQ,QAAQ,YAAY,KAAK,QAAQ,OAAO,IAAU;;;AAI5D,SAAgB,aAAa,KAAc,QAAyB;AAClE,QAAO,QAAQ,YAAY,KAAK,OAAO;;;AAIzC,SAAgB,wBAA2B,KAAc,QAA+B;AACtF,QAAO,QAAQ,YAAY,KAAK,OAAO;;;AAIzC,SAAgB,yBACd,KACA,QACA,QACe;AACf,QAAO,QAAQ,YAAY,KAAK,QAAQ,OAAO;;;AAMjD,SAAgB,cAAiB,KAAc,QAAgB,GAAG,OAAkB;CAClF,MAAM,WAAgB,QAAQ,eAAe,KAAK,OAAO,IAAI,EAAE;AAC/D,SAAQ,eAAe,KAAK,CAAC,GAAG,UAAU,GAAG,MAAM,EAAE,OAAO;;;AAI9D,SAAgB,eACd,KACA,QACA,QACA,GAAG,OACG;CACN,MAAM,WAAgB,QAAQ,eAAe,KAAK,QAAQ,OAAO,IAAI,EAAE;AACvE,SAAQ,eAAe,KAAK,CAAC,GAAG,UAAU,GAAG,MAAM,EAAE,QAAQ,OAAO;;;AAMtE,SAAgB,aAAmB,KAAc,QAAgB,QAAW,UAAmB;CAC7F,MAAM,YAAmC,QAAQ,eAAe,KAAK,OAAO;CAC5E,MAAM,MAAM,YAAY,IAAI,IAAI,UAAU,mBAAG,IAAI,KAAW;AAC5D,KAAI,IAAI,QAAQ,SAAS;AACzB,SAAQ,eAAe,KAAK,KAAK,OAAO;;;AAI1C,SAAgB,WAAiB,KAAc,QAA2B;AACxE,QAAO,QAAQ,YAAY,KAAK,OAAO,oBAAI,IAAI,KAAK;;;AAMtD,SAAgB,gBACd,KACA,QACA,QACA,UACM;CACN,MAAM,YAAoD,QAAQ,eAAe,KAAK,OAAO;CAC7F,MAAM,MAAM,YAAY,EAAE,GAAG,WAAW,GAAG,EAAE;AAC7C,KAAI,UAAU;AACd,SAAQ,eAAe,KAAK,KAAK,OAAO;;;AAI1C,SAAgB,cAAiB,KAAc,QAA4C;AACzF,QAAO,QAAQ,YAAY,KAAK,OAAO,IAAI,EAAE"}
|
|
@@ -22,4 +22,4 @@ declare function normalizePath(path?: string): string;
|
|
|
22
22
|
declare function joinPaths(...segments: (string | undefined)[]): string;
|
|
23
23
|
//#endregion
|
|
24
24
|
export { normalizePath as n, joinPaths as t };
|
|
25
|
-
//# sourceMappingURL=path-
|
|
25
|
+
//# sourceMappingURL=path-Diviu6hv.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"path-Diviu6hv.d.mts","names":[],"sources":["../src/core/path.ts"],"mappings":";;;AAOA;;;;;AAsBA;iBAtBgB,aAAA,CAAc,IAAA;;;;;;;;;;;;iBAsBd,SAAA,CAAA,GAAa,QAAA"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
|
|
2
|
-
import { t as Container } from "./container-
|
|
3
|
-
import {
|
|
4
|
-
import { r as AppAdapter } from "./adapter-
|
|
5
|
-
import { n as AppModuleClass } from "./app-module-
|
|
2
|
+
import { t as Container } from "./container-CnWDsxi-.mjs";
|
|
3
|
+
import { o as ContributorRegistrations } from "./context-decorator-DrPvQ9Ag.mjs";
|
|
4
|
+
import { r as AppAdapter, s as KickJsPluginName } from "./adapter-6Pp4kFdM.mjs";
|
|
5
|
+
import { n as AppModuleClass } from "./app-module-Blgz4Rti.mjs";
|
|
6
6
|
|
|
7
7
|
//#region src/core/plugin.d.ts
|
|
8
8
|
/**
|
|
@@ -14,7 +14,7 @@ import { n as AppModuleClass } from "./app-module-ERR9jhow.mjs";
|
|
|
14
14
|
*
|
|
15
15
|
* @example
|
|
16
16
|
* ```ts
|
|
17
|
-
* import type { KickPlugin } from '@forinda/kickjs
|
|
17
|
+
* import type { KickPlugin } from '@forinda/kickjs'
|
|
18
18
|
*
|
|
19
19
|
* export class CorsPlugin implements KickPlugin {
|
|
20
20
|
* name = 'CorsPlugin'
|
|
@@ -58,8 +58,27 @@ import { n as AppModuleClass } from "./app-module-ERR9jhow.mjs";
|
|
|
58
58
|
* ```
|
|
59
59
|
*/
|
|
60
60
|
interface KickPlugin {
|
|
61
|
-
/** Human-readable name for logging and
|
|
61
|
+
/** Human-readable name for logging, debugging, and `dependsOn` resolution. */
|
|
62
62
|
name: string;
|
|
63
|
+
/**
|
|
64
|
+
* Other plugin names that must mount before this one. The framework
|
|
65
|
+
* topologically sorts plugins at boot — cycles or unknown names throw
|
|
66
|
+
* via {@link MountCycleError} / {@link MissingMountDepError} so bad
|
|
67
|
+
* configurations fail boot rather than corrupt live traffic.
|
|
68
|
+
*
|
|
69
|
+
* Plugins with no `dependsOn` retain their declaration order, so
|
|
70
|
+
* existing apps that don't use this field see no behaviour change.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* class MonitoringPlugin implements KickPlugin {
|
|
75
|
+
* name = 'MonitoringPlugin'
|
|
76
|
+
* // OTel must initialize traces before request logger reads them
|
|
77
|
+
* dependsOn = ['OtelPlugin']
|
|
78
|
+
* }
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
dependsOn?: readonly KickJsPluginName[];
|
|
63
82
|
/**
|
|
64
83
|
* Register DI bindings before modules load.
|
|
65
84
|
* Use this to provide services that modules depend on.
|
|
@@ -110,7 +129,7 @@ interface KickPlugin {
|
|
|
110
129
|
* }
|
|
111
130
|
* ```
|
|
112
131
|
*/
|
|
113
|
-
contributors?():
|
|
132
|
+
contributors?(): ContributorRegistrations;
|
|
114
133
|
/**
|
|
115
134
|
* Called after the application has fully bootstrapped.
|
|
116
135
|
* Use for post-startup logic like logging, health registration, etc.
|
|
@@ -121,7 +140,26 @@ interface KickPlugin {
|
|
|
121
140
|
* Clean up plugin resources (connections, intervals, etc.).
|
|
122
141
|
*/
|
|
123
142
|
shutdown?(): void | Promise<void>;
|
|
143
|
+
/**
|
|
144
|
+
* Optional DevTools introspection hook (architecture.md §23). Returns
|
|
145
|
+
* a snapshot describing this plugin's current state, metrics, and DI
|
|
146
|
+
* tokens. DevTools awaits the result, so async work is fine — but keep
|
|
147
|
+
* the implementation cheap (counters + flags, no DB round trips) since
|
|
148
|
+
* the topology endpoint polls on a short interval.
|
|
149
|
+
*
|
|
150
|
+
* The return type is intentionally untyped at this layer to avoid
|
|
151
|
+
* `@forinda/kickjs` taking on a runtime dep on `@forinda/kickjs-devtools-kit`.
|
|
152
|
+
* Plugin authors should import and return `IntrospectionSnapshot`
|
|
153
|
+
* from `@forinda/kickjs-devtools-kit` directly.
|
|
154
|
+
*/
|
|
155
|
+
introspect?(): unknown | Promise<unknown>;
|
|
156
|
+
/**
|
|
157
|
+
* Optional DevTools tabs this plugin contributes (architecture.md §23).
|
|
158
|
+
* Same shape as {@link AppAdapter.devtoolsTabs}; the kit's
|
|
159
|
+
* `DevtoolsTabDescriptor` types it for plugin authors.
|
|
160
|
+
*/
|
|
161
|
+
devtoolsTabs?(): readonly unknown[];
|
|
124
162
|
}
|
|
125
163
|
//#endregion
|
|
126
164
|
export { KickPlugin as t };
|
|
127
|
-
//# sourceMappingURL=plugin-
|
|
165
|
+
//# sourceMappingURL=plugin-DDjoN4XI.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-DDjoN4XI.d.mts","names":[],"sources":["../src/core/plugin.ts"],"mappings":";;;;;;;;AA0DA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAAiB,UAAA;;EAEf,IAAA;;;;;;;;;;;;;;;;;;;EAoBA,SAAA,YAAqB,gBAAA;;;;;EAMrB,QAAA,EAAU,SAAA,EAAW,SAAA;;;;;EAMrB,OAAA,KAAY,cAAA;;;;;EAMZ,QAAA,KAAa,UAAA;;;;;EAMb,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCA,YAAA,KAAiB,wBAAA;;;;;EAMjB,OAAA,EAAS,SAAA,EAAW,SAAA,UAAmB,OAAA;;;;;EAMvC,QAAA,YAAoB,OAAA;;;;;;;;;;;;;EAcpB,UAAA,eAAyB,OAAA;;;;;;EAOzB,YAAA;AAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @forinda/kickjs
|
|
2
|
+
* @forinda/kickjs v4.1.0
|
|
3
3
|
*
|
|
4
4
|
* Copyright (c) Felix Orinda
|
|
5
5
|
*
|
|
@@ -161,4 +161,4 @@ function buildQueryParams(parsed) {
|
|
|
161
161
|
//#endregion
|
|
162
162
|
export { parseSearchQuery as a, parseQuery as i, parseFilters as n, parseSort as o, parsePagination as r, FILTER_OPERATORS as s, buildQueryParams as t };
|
|
163
163
|
|
|
164
|
-
//# sourceMappingURL=query-
|
|
164
|
+
//# sourceMappingURL=query-BrYRQMa5.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-BcYEjYyX.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\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\nconst MAX_SEARCH_LENGTH = 200\nconst DEFAULT_PAGE = 1\nconst DEFAULT_LIMIT = 20\nconst MAX_LIMIT = 100\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): 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\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)) continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, operator: operator as FilterOperator, value })\n }\n\n return results\n}\n\n/** Parse sort strings like \"firstName:asc\" into structured objects */\nexport function parseSort(\n sortParam: string | string[] | undefined,\n allowedFields?: string[],\n): SortItem[] {\n if (!sortParam) return []\n\n const items = Array.isArray(sortParam) ? sortParam : [sortParam]\n const results: SortItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on last colon so field names with colons work\n const lastColon = item.lastIndexOf(':')\n if (lastColon === -1) continue\n\n const field = item.slice(0, lastColon)\n const dir = item.slice(lastColon + 1).toLowerCase()\n\n if (!field) continue\n if (dir !== 'asc' && dir !== 'desc') continue\n if (allowed && !allowed.has(field)) continue\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(params: {\n page?: string | number\n limit?: string | number\n}): PaginationParams {\n let page =\n typeof params.page === 'string'\n ? Number.parseInt(params.page, 10)\n : (params.page ?? DEFAULT_PAGE)\n let limit =\n typeof params.limit === 'string'\n ? Number.parseInt(params.limit, 10)\n : (params.limit ?? DEFAULT_LIMIT)\n\n if (Number.isNaN(page) || page < 1) page = DEFAULT_PAGE\n if (Number.isNaN(limit) || limit < 1) limit = DEFAULT_LIMIT\n if (limit > MAX_LIMIT) limit = MAX_LIMIT\n\n return { page, limit, offset: (page - 1) * limit }\n}\n\n/** Sanitize and truncate search query */\nexport function parseSearchQuery(q: string | undefined): string {\n if (!q) return ''\n return q.trim().slice(0, MAX_SEARCH_LENGTH)\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 *\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` (repeatable)\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): TypedParsedQuery<TConfig> {\n const normalized = normalizeFieldConfig(fieldConfig)\n return {\n filters: parseFilters(query.filter, normalized?.filterable),\n sort: parseSort(query.sort, normalized?.sortable),\n pagination: parsePagination({ page: query.page, limit: query.limit }),\n search: parseSearchQuery(query.q),\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,mBAAmB,IAAI,IAAY;CAC9C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;ACdF,MAAM,oBAAoB;AAC1B,MAAM,eAAe;AACrB,MAAM,gBAAgB;AACtB,MAAM,YAAY;;AAKlB,SAAgB,aACd,aACA,eACc;AACd,KAAI,CAAC,YAAa,QAAO,EAAE;CAE3B,MAAM,QAAQ,MAAM,QAAQ,YAAY,GAAG,cAAc,CAAC,YAAY;CACtE,MAAM,UAAwB,EAAE;CAChC,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,aAAa,KAAK,QAAQ,IAAI;AACpC,MAAI,eAAe,GAAI;EAEvB,MAAM,cAAc,KAAK,QAAQ,KAAK,aAAa,EAAE;AACrD,MAAI,gBAAgB,GAAI;EAExB,MAAM,QAAQ,KAAK,MAAM,GAAG,WAAW;EACvC,MAAM,WAAW,KAAK,MAAM,aAAa,GAAG,YAAY;EACxD,MAAM,QAAQ,KAAK,MAAM,cAAc,EAAE;AAEzC,MAAI,CAAC,SAAS,CAAC,MAAO;AACtB,MAAI,CAAC,iBAAiB,IAAI,SAAS,CAAE;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAiB;GAA4B;GAAO,CAAC;;AAGtE,QAAO;;;AAIT,SAAgB,UACd,WACA,eACY;AACZ,KAAI,CAAC,UAAW,QAAO,EAAE;CAEzB,MAAM,QAAQ,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;CAChE,MAAM,UAAsB,EAAE;CAC9B,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,KAAK,YAAY,IAAI;AACvC,MAAI,cAAc,GAAI;EAEtB,MAAM,QAAQ,KAAK,MAAM,GAAG,UAAU;EACtC,MAAM,MAAM,KAAK,MAAM,YAAY,EAAE,CAAC,aAAa;AAEnD,MAAI,CAAC,MAAO;AACZ,MAAI,QAAQ,SAAS,QAAQ,OAAQ;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAO,WAAW;GAAK,CAAC;;AAGzC,QAAO;;;AAIT,SAAgB,gBAAgB,QAGX;CACnB,IAAI,OACF,OAAO,OAAO,SAAS,WACnB,OAAO,SAAS,OAAO,MAAM,GAAG,GAC/B,OAAO,QAAQ;CACtB,IAAI,QACF,OAAO,OAAO,UAAU,WACpB,OAAO,SAAS,OAAO,OAAO,GAAG,GAChC,OAAO,SAAS;AAEvB,KAAI,OAAO,MAAM,KAAK,IAAI,OAAO,EAAG,QAAO;AAC3C,KAAI,OAAO,MAAM,MAAM,IAAI,QAAQ,EAAG,SAAQ;AAC9C,KAAI,QAAQ,UAAW,SAAQ;AAE/B,QAAO;EAAE;EAAM;EAAO,SAAS,OAAO,KAAK;EAAO;;;AAIpD,SAAgB,iBAAiB,GAA+B;AAC9D,KAAI,CAAC,EAAG,QAAO;AACf,QAAO,EAAE,MAAM,CAAC,MAAM,GAAG,kBAAkB;;;;;;;AAU7C,SAAS,qBAAqB,QAA+D;AAC3F,KAAI,CAAC,OAAQ,QAAO,KAAA;AAGpB,KAAI,aAAa,UAAU,OAAO,WAAW,OAAO,OAAO,YAAY,SACrE,QAAO;EACL,YAAY,OAAO,KAAK,OAAO,QAAQ;EACvC,UAAU,OAAO,WAAW,OAAO,KAAK,OAAO,SAAS,GAAG,KAAA;EAC3D,YAAY,KAAA;EACb;AAIH,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCT,SAAgB,WACd,OACA,aAC2B;CAC3B,MAAM,aAAa,qBAAqB,YAAY;AACpD,QAAO;EACL,SAAS,aAAa,MAAM,QAAQ,YAAY,WAAW;EAC3D,MAAM,UAAU,MAAM,MAAM,YAAY,SAAS;EACjD,YAAY,gBAAgB;GAAE,MAAM,MAAM;GAAM,OAAO,MAAM;GAAO,CAAC;EACrE,QAAQ,iBAAiB,MAAM,EAAE;EAClC;;;AAMH,SAAgB,iBACd,QAC4C;CAC5C,MAAM,SAAqD,EAAE;AAE7D,KAAI,OAAO,SAAS,OAClB,QAAO,SAAS,OAAO,QAAQ,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,SAAS,GAAG,EAAE,QAAQ;AAGlF,KAAI,OAAO,MAAM,OACf,QAAO,OAAO,OAAO,KAAK,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,YAAY;AAGnE,KAAI,OAAO,YAAY;AACrB,SAAO,OAAO,OAAO,WAAW;AAChC,SAAO,QAAQ,OAAO,WAAW;;AAGnC,KAAI,OAAO,OACT,QAAO,IAAI,OAAO;AAGpB,QAAO"}
|
|
1
|
+
{"version":3,"file":"query-BrYRQMa5.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\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\nconst MAX_SEARCH_LENGTH = 200\nconst DEFAULT_PAGE = 1\nconst DEFAULT_LIMIT = 20\nconst MAX_LIMIT = 100\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): 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\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)) continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, operator: operator as FilterOperator, value })\n }\n\n return results\n}\n\n/** Parse sort strings like \"firstName:asc\" into structured objects */\nexport function parseSort(\n sortParam: string | string[] | undefined,\n allowedFields?: string[],\n): SortItem[] {\n if (!sortParam) return []\n\n const items = Array.isArray(sortParam) ? sortParam : [sortParam]\n const results: SortItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on last colon so field names with colons work\n const lastColon = item.lastIndexOf(':')\n if (lastColon === -1) continue\n\n const field = item.slice(0, lastColon)\n const dir = item.slice(lastColon + 1).toLowerCase()\n\n if (!field) continue\n if (dir !== 'asc' && dir !== 'desc') continue\n if (allowed && !allowed.has(field)) continue\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(params: {\n page?: string | number\n limit?: string | number\n}): PaginationParams {\n let page =\n typeof params.page === 'string'\n ? Number.parseInt(params.page, 10)\n : (params.page ?? DEFAULT_PAGE)\n let limit =\n typeof params.limit === 'string'\n ? Number.parseInt(params.limit, 10)\n : (params.limit ?? DEFAULT_LIMIT)\n\n if (Number.isNaN(page) || page < 1) page = DEFAULT_PAGE\n if (Number.isNaN(limit) || limit < 1) limit = DEFAULT_LIMIT\n if (limit > MAX_LIMIT) limit = MAX_LIMIT\n\n return { page, limit, offset: (page - 1) * limit }\n}\n\n/** Sanitize and truncate search query */\nexport function parseSearchQuery(q: string | undefined): string {\n if (!q) return ''\n return q.trim().slice(0, MAX_SEARCH_LENGTH)\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 *\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` (repeatable)\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): TypedParsedQuery<TConfig> {\n const normalized = normalizeFieldConfig(fieldConfig)\n return {\n filters: parseFilters(query.filter, normalized?.filterable),\n sort: parseSort(query.sort, normalized?.sortable),\n pagination: parsePagination({ page: query.page, limit: query.limit }),\n search: parseSearchQuery(query.q),\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,mBAAmB,IAAI,IAAY;CAC9C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;ACdF,MAAM,oBAAoB;AAC1B,MAAM,eAAe;AACrB,MAAM,gBAAgB;AACtB,MAAM,YAAY;;AAKlB,SAAgB,aACd,aACA,eACc;AACd,KAAI,CAAC,YAAa,QAAO,EAAE;CAE3B,MAAM,QAAQ,MAAM,QAAQ,YAAY,GAAG,cAAc,CAAC,YAAY;CACtE,MAAM,UAAwB,EAAE;CAChC,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,aAAa,KAAK,QAAQ,IAAI;AACpC,MAAI,eAAe,GAAI;EAEvB,MAAM,cAAc,KAAK,QAAQ,KAAK,aAAa,EAAE;AACrD,MAAI,gBAAgB,GAAI;EAExB,MAAM,QAAQ,KAAK,MAAM,GAAG,WAAW;EACvC,MAAM,WAAW,KAAK,MAAM,aAAa,GAAG,YAAY;EACxD,MAAM,QAAQ,KAAK,MAAM,cAAc,EAAE;AAEzC,MAAI,CAAC,SAAS,CAAC,MAAO;AACtB,MAAI,CAAC,iBAAiB,IAAI,SAAS,CAAE;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAiB;GAA4B;GAAO,CAAC;;AAGtE,QAAO;;;AAIT,SAAgB,UACd,WACA,eACY;AACZ,KAAI,CAAC,UAAW,QAAO,EAAE;CAEzB,MAAM,QAAQ,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;CAChE,MAAM,UAAsB,EAAE;CAC9B,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,KAAK,YAAY,IAAI;AACvC,MAAI,cAAc,GAAI;EAEtB,MAAM,QAAQ,KAAK,MAAM,GAAG,UAAU;EACtC,MAAM,MAAM,KAAK,MAAM,YAAY,EAAE,CAAC,aAAa;AAEnD,MAAI,CAAC,MAAO;AACZ,MAAI,QAAQ,SAAS,QAAQ,OAAQ;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAO,WAAW;GAAK,CAAC;;AAGzC,QAAO;;;AAIT,SAAgB,gBAAgB,QAGX;CACnB,IAAI,OACF,OAAO,OAAO,SAAS,WACnB,OAAO,SAAS,OAAO,MAAM,GAAG,GAC/B,OAAO,QAAQ;CACtB,IAAI,QACF,OAAO,OAAO,UAAU,WACpB,OAAO,SAAS,OAAO,OAAO,GAAG,GAChC,OAAO,SAAS;AAEvB,KAAI,OAAO,MAAM,KAAK,IAAI,OAAO,EAAG,QAAO;AAC3C,KAAI,OAAO,MAAM,MAAM,IAAI,QAAQ,EAAG,SAAQ;AAC9C,KAAI,QAAQ,UAAW,SAAQ;AAE/B,QAAO;EAAE;EAAM;EAAO,SAAS,OAAO,KAAK;EAAO;;;AAIpD,SAAgB,iBAAiB,GAA+B;AAC9D,KAAI,CAAC,EAAG,QAAO;AACf,QAAO,EAAE,MAAM,CAAC,MAAM,GAAG,kBAAkB;;;;;;;AAU7C,SAAS,qBAAqB,QAA+D;AAC3F,KAAI,CAAC,OAAQ,QAAO,KAAA;AAGpB,KAAI,aAAa,UAAU,OAAO,WAAW,OAAO,OAAO,YAAY,SACrE,QAAO;EACL,YAAY,OAAO,KAAK,OAAO,QAAQ;EACvC,UAAU,OAAO,WAAW,OAAO,KAAK,OAAO,SAAS,GAAG,KAAA;EAC3D,YAAY,KAAA;EACb;AAIH,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCT,SAAgB,WACd,OACA,aAC2B;CAC3B,MAAM,aAAa,qBAAqB,YAAY;AACpD,QAAO;EACL,SAAS,aAAa,MAAM,QAAQ,YAAY,WAAW;EAC3D,MAAM,UAAU,MAAM,MAAM,YAAY,SAAS;EACjD,YAAY,gBAAgB;GAAE,MAAM,MAAM;GAAM,OAAO,MAAM;GAAO,CAAC;EACrE,QAAQ,iBAAiB,MAAM,EAAE;EAClC;;;AAMH,SAAgB,iBACd,QAC4C;CAC5C,MAAM,SAAqD,EAAE;AAE7D,KAAI,OAAO,SAAS,OAClB,QAAO,SAAS,OAAO,QAAQ,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,SAAS,GAAG,EAAE,QAAQ;AAGlF,KAAI,OAAO,MAAM,OACf,QAAO,OAAO,OAAO,KAAK,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,YAAY;AAGnE,KAAI,OAAO,YAAY;AACrB,SAAO,OAAO,OAAO,WAAW;AAChC,SAAO,QAAQ,OAAO,WAAW;;AAGnC,KAAI,OAAO,OACT,QAAO,IAAI,OAAO;AAGpB,QAAO"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
|
|
2
|
+
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
|
|
4
|
+
//#region src/http/middleware/rate-limit.d.ts
|
|
5
|
+
interface RateLimitStore {
|
|
6
|
+
increment(key: string): Promise<{
|
|
7
|
+
totalHits: number;
|
|
8
|
+
resetTime: Date;
|
|
9
|
+
}>;
|
|
10
|
+
decrement(key: string): Promise<void>;
|
|
11
|
+
reset(key: string): Promise<void>;
|
|
12
|
+
}
|
|
13
|
+
interface RateLimitOptions {
|
|
14
|
+
/** Maximum number of requests per window (default: 100) */
|
|
15
|
+
max?: number;
|
|
16
|
+
/** Time window in milliseconds (default: 60_000) */
|
|
17
|
+
windowMs?: number;
|
|
18
|
+
/** Response message when rate limit is exceeded (default: 'Too Many Requests') */
|
|
19
|
+
message?: string;
|
|
20
|
+
/** HTTP status code when rate limit is exceeded (default: 429) */
|
|
21
|
+
statusCode?: number;
|
|
22
|
+
/** Function to generate the key for rate limiting (default: req.ip) */
|
|
23
|
+
keyGenerator?: (req: Request) => string;
|
|
24
|
+
/** Whether to send rate limit headers (default: true) */
|
|
25
|
+
headers?: boolean;
|
|
26
|
+
/** Custom store implementation (default: in-memory Map) */
|
|
27
|
+
store?: RateLimitStore;
|
|
28
|
+
/** Function to skip rate limiting for certain requests */
|
|
29
|
+
skip?: (req: Request) => boolean;
|
|
30
|
+
/** Paths to exclude from rate limiting */
|
|
31
|
+
skipPaths?: string[];
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Rate limiting middleware.
|
|
35
|
+
*
|
|
36
|
+
* Limits the number of requests a client can make within a time window.
|
|
37
|
+
* Uses an in-memory store by default, but accepts a custom store for
|
|
38
|
+
* distributed deployments (e.g. Redis).
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* import { rateLimit } from '@forinda/kickjs'
|
|
43
|
+
*
|
|
44
|
+
* bootstrap({
|
|
45
|
+
* modules,
|
|
46
|
+
* middleware: [
|
|
47
|
+
* rateLimit({ max: 100, windowMs: 60_000 }),
|
|
48
|
+
* // ... other middleware
|
|
49
|
+
* ],
|
|
50
|
+
* })
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
declare function rateLimit(options?: RateLimitOptions): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
|
|
54
|
+
//#endregion
|
|
55
|
+
export { RateLimitStore as n, rateLimit as r, RateLimitOptions as t };
|
|
56
|
+
//# sourceMappingURL=rate-limit-DUwoICtI.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rate-limit-DUwoICtI.d.mts","names":[],"sources":["../src/http/middleware/rate-limit.ts"],"mappings":";;;;UAEiB,cAAA;EACf,SAAA,CAAU,GAAA,WAAc,OAAA;IAAU,SAAA;IAAmB,SAAA,EAAW,IAAA;EAAA;EAChE,SAAA,CAAU,GAAA,WAAc,OAAA;EACxB,KAAA,CAAM,GAAA,WAAc,OAAA;AAAA;AAAA,UAGL,gBAAA;EAHY;EAK3B,GAAA;EAPA;EASA,QAAA;EATwB;EAWxB,OAAA;EAXqD;EAarD,UAAA;EAZA;EAcA,YAAA,IAAgB,GAAA,EAAK,OAAA;EAdG;EAgBxB,OAAA;EAfM;EAiBN,KAAA,GAAQ,cAAA;EAjBmB;EAmB3B,IAAA,IAAQ,GAAA,EAAK,OAAA;EAhBE;EAkBf,SAAA;AAAA;;;;;;;;;;;;;;;;;;;;;iBA4Ec,SAAA,CAAU,OAAA,GAAS,gBAAA,IAWnB,GAAA,EAAK,OAAA,EAAS,GAAA,EAAK,QAAA,EAAU,IAAA,EAAM,YAAA,KAAY,OAAA,QAAA,QAAA,MAAA,MAAA"}
|
|
@@ -81,4 +81,4 @@ declare function unref<T>(value: Ref<T> | T): T;
|
|
|
81
81
|
declare function toRefs<T extends Record<string, any>>(obj: T): { [K in keyof T]: Ref<T[K]> };
|
|
82
82
|
//#endregion
|
|
83
83
|
export { isRef as a, toRefs as c, computed as i, unref as l, Ref as n, reactive as o, WatchOptions as r, ref as s, ComputedRef as t, watch as u };
|
|
84
|
-
//# sourceMappingURL=reactivity-
|
|
84
|
+
//# sourceMappingURL=reactivity-CfJceo4H.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reactivity-
|
|
1
|
+
{"version":3,"file":"reactivity-CfJceo4H.d.mts","names":[],"sources":["../src/core/reactivity.ts"],"mappings":";;;AAuCA;;;;UAAiB,GAAA;EACf,KAAA,EAAO,CAAA;EAEgC;EAAvC,SAAA,CAAU,EAAA,GAAK,QAAA,EAAU,CAAA,EAAG,QAAA,EAAU,CAAA;AAAA;;;;;;;;;;;iBAaxB,GAAA,GAAA,CAAO,YAAA,EAAc,CAAA,GAAI,GAAA,CAAI,CAAA;AAAA,UA2B5B,WAAA;EAAA,SACN,KAAA,EAAO,CAAA;AAAA;;;;;;;;;;;;AADlB;iBAgBgB,QAAA,GAAA,CAAY,MAAA,QAAc,CAAA,GAAI,WAAA,CAAY,CAAA;AAAA,UA+BzC,YAAA;EA9CE;EAgDjB,SAAA;AAAA;AAAA,KAGG,WAAA,MAAiB,GAAA,CAAI,CAAA,IAAK,WAAA,CAAY,CAAA,WAAY,CAAA;;;AApCvD;;;;;;;;;;;;iBAoDgB,KAAA,GAAA,CACd,MAAA,EAAQ,WAAA,CAAY,CAAA,GACpB,QAAA,GAAW,QAAA,EAAU,CAAA,EAAG,QAAA,EAAU,CAAA,WAClC,OAAA,GAAU,YAAA;;;AAxBZ;;;;;AAGC;;;;;;;;iBAwEe,QAAA,WAAmB,MAAA,cAAA,CAAqB,MAAA,EAAQ,CAAA,GAAI,CAAA;;iBA0BpD,KAAA,CAAM,KAAA,QAAa,KAAA,IAAS,GAAA;;iBAK5B,KAAA,GAAA,CAAS,KAAA,EAAO,GAAA,CAAI,CAAA,IAAK,CAAA,GAAI,CAAA;;iBAK7B,MAAA,WAAiB,MAAA,cAAA,CAAqB,GAAA,EAAK,CAAA,iBAAkB,CAAA,GAAI,GAAA,CAAI,CAAA,CAAE,CAAA"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
|
|
2
|
+
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
|
|
4
|
+
//#region src/http/middleware/request-id.d.ts
|
|
5
|
+
declare const REQUEST_ID_HEADER = "x-request-id";
|
|
6
|
+
/**
|
|
7
|
+
* Middleware that generates or propagates a unique request ID.
|
|
8
|
+
*
|
|
9
|
+
* Idempotent: if `req.requestId` is already set (e.g. by
|
|
10
|
+
* `requestScopeMiddleware` earlier in the pipeline), this middleware reuses
|
|
11
|
+
* it instead of generating a divergent second value. Keeps the
|
|
12
|
+
* X-Request-Id response header, the ALS store's `requestId`, and
|
|
13
|
+
* `RequestContext.requestId` in agreement for every request, regardless of
|
|
14
|
+
* mounting order.
|
|
15
|
+
*/
|
|
16
|
+
declare function requestId(): (req: Request, res: Response, next: NextFunction) => void;
|
|
17
|
+
//#endregion
|
|
18
|
+
export { requestId as n, REQUEST_ID_HEADER as t };
|
|
19
|
+
//# sourceMappingURL=request-id-BgglvZHN.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-id-BgglvZHN.d.mts","names":[],"sources":["../src/http/middleware/request-id.ts"],"mappings":";;;;cAGa,iBAAA;;AAAb;;;;;AAYA;;;;iBAAgB,SAAA,CAAA,IACN,GAAA,EAAK,OAAA,EAAS,GAAA,EAAK,QAAA,EAAU,IAAA,EAAM,YAAA"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
|
|
2
|
+
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
|
|
4
|
+
//#region src/http/middleware/request-logger.d.ts
|
|
5
|
+
interface RequestLoggerOptions {
|
|
6
|
+
/** Logger name (default: 'HTTP') */
|
|
7
|
+
name?: string;
|
|
8
|
+
/** Log level for successful requests (default: 'info') */
|
|
9
|
+
level?: 'info' | 'debug' | 'trace';
|
|
10
|
+
/** Skip logging for paths matching these prefixes (e.g. ['/health', '/_debug']) */
|
|
11
|
+
skip?: string[];
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Middleware that logs every request with method, URL, status, duration, and request ID.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* bootstrap({
|
|
19
|
+
* middleware: [requestId(), requestLogger(), express.json()],
|
|
20
|
+
* })
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* Output:
|
|
24
|
+
* ```
|
|
25
|
+
* [HTTP] GET /api/v1/users 200 12ms req-abc123
|
|
26
|
+
* [HTTP] POST /api/v1/users 201 45ms req-def456
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
declare function requestLogger(options?: RequestLoggerOptions): (req: Request, res: Response, next: NextFunction) => void;
|
|
30
|
+
//#endregion
|
|
31
|
+
export { requestLogger as n, RequestLoggerOptions as t };
|
|
32
|
+
//# sourceMappingURL=request-logger-CWHbAzTE.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-logger-CWHbAzTE.d.mts","names":[],"sources":["../src/http/middleware/request-logger.ts"],"mappings":";;;;UAGiB,oBAAA;;EAEf,IAAA;EAFmC;EAInC,KAAA;EAJmC;EAMnC,IAAA;AAAA;;;;AAmBF;;;;;;;;;;;;;iBAAgB,aAAA,CAAc,OAAA,GAAS,oBAAA,IAK7B,GAAA,EAAK,OAAA,EAAS,GAAA,EAAK,QAAA,EAAU,IAAA,EAAM,YAAA"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
|
|
2
|
+
import { x as SourcedRegistration } from "./index-Yhs9sTMW.mjs";
|
|
3
|
+
import { Router } from "express";
|
|
4
|
+
|
|
5
|
+
//#region src/http/router-builder.d.ts
|
|
6
|
+
/** @internal — set by Application.setup() before each `mod.routes()` call. */
|
|
7
|
+
declare function _setExternalContributorSources(sources: readonly SourcedRegistration[]): void;
|
|
8
|
+
interface BuildRoutesOptions {
|
|
9
|
+
/**
|
|
10
|
+
* Extra contributors to merge into the per-route pipeline at their declared
|
|
11
|
+
* precedence levels. Pass explicitly when calling buildRoutes outside the
|
|
12
|
+
* Application route-mount loop (typically in tests). When omitted, falls
|
|
13
|
+
* back to the slot set by Application.setup().
|
|
14
|
+
*/
|
|
15
|
+
externalSources?: readonly SourcedRegistration[];
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Build an Express Router from a controller class decorated with @Get, @Post, etc.
|
|
19
|
+
* Resolves the controller from the DI container, wraps handlers in RequestContext,
|
|
20
|
+
* and applies class-level and method-level middleware.
|
|
21
|
+
*
|
|
22
|
+
* Routes are registered using only the method-level decorator paths (e.g. @Get('/me') → '/me').
|
|
23
|
+
* The @Controller path is NOT baked into the router — it serves as metadata only
|
|
24
|
+
* (used by Swagger and other adapters for introspection).
|
|
25
|
+
* The module's routes().path is the single source of truth for the mount prefix,
|
|
26
|
+
* which avoids path doubling when both the module and controller specify the same path.
|
|
27
|
+
*/
|
|
28
|
+
declare function buildRoutes(controllerClass: any, options?: BuildRoutesOptions): Router;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { _setExternalContributorSources as n, buildRoutes as r, BuildRoutesOptions as t };
|
|
31
|
+
//# sourceMappingURL=router-builder-zsX4Oq7c.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"router-builder-zsX4Oq7c.d.mts","names":[],"sources":["../src/http/router-builder.ts"],"mappings":";;;;;;iBAoCgB,8BAAA,CAA+B,OAAA,WAAkB,mBAAA;AAAA,UAIhD,kBAAA;EAJ6B;;;;AAI9C;;EAOE,eAAA,YAA2B,mBAAA;AAAA;;AAc7B;;;;;;;;;;iBAAgB,WAAA,CAAY,eAAA,OAAsB,OAAA,GAAS,kBAAA,GAA0B,MAAA"}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
|
|
2
|
+
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
|
|
4
|
+
//#region src/http/middleware/session.d.ts
|
|
5
|
+
interface SessionData {
|
|
6
|
+
[key: string]: unknown;
|
|
7
|
+
}
|
|
8
|
+
interface SessionStore {
|
|
9
|
+
get(sid: string): Promise<SessionData | null>;
|
|
10
|
+
set(sid: string, data: SessionData, maxAge: number): Promise<void>;
|
|
11
|
+
destroy(sid: string): Promise<void>;
|
|
12
|
+
touch?(sid: string, maxAge: number): Promise<void>;
|
|
13
|
+
}
|
|
14
|
+
interface Session {
|
|
15
|
+
id: string;
|
|
16
|
+
data: SessionData;
|
|
17
|
+
regenerate(): Promise<void>;
|
|
18
|
+
destroy(): Promise<void>;
|
|
19
|
+
save(): Promise<void>;
|
|
20
|
+
}
|
|
21
|
+
interface SessionOptions {
|
|
22
|
+
/** Secret used to sign the session cookie (required) */
|
|
23
|
+
secret: string;
|
|
24
|
+
/** Cookie name (default: 'kick.sid') */
|
|
25
|
+
cookieName?: string;
|
|
26
|
+
/** Session max age in milliseconds (default: 86400000 = 24h) */
|
|
27
|
+
maxAge?: number;
|
|
28
|
+
/** Reset maxAge on every response (default: false) */
|
|
29
|
+
rolling?: boolean;
|
|
30
|
+
/** Save new sessions that have not been modified (default: true) */
|
|
31
|
+
saveUninitialized?: boolean;
|
|
32
|
+
/** Cookie options */
|
|
33
|
+
cookie?: {
|
|
34
|
+
httpOnly?: boolean;
|
|
35
|
+
secure?: boolean;
|
|
36
|
+
sameSite?: 'strict' | 'lax' | 'none';
|
|
37
|
+
path?: string;
|
|
38
|
+
domain?: string;
|
|
39
|
+
};
|
|
40
|
+
/** Custom session store (default: in-memory store with TTL cleanup) */
|
|
41
|
+
store?: SessionStore;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Session management middleware.
|
|
45
|
+
*
|
|
46
|
+
* Attaches a `req.session` object with `id`, `data`, `regenerate()`,
|
|
47
|
+
* `destroy()`, and `save()` methods. Session IDs are signed with
|
|
48
|
+
* HMAC-SHA256 to prevent cookie tampering.
|
|
49
|
+
*
|
|
50
|
+
* Reads the session cookie from `req.cookies` when an upstream cookie
|
|
51
|
+
* parser is present; otherwise parses `req.headers.cookie` directly, so
|
|
52
|
+
* no cookie parser is required upstream.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* import { session } from '@forinda/kickjs'
|
|
57
|
+
*
|
|
58
|
+
* bootstrap({
|
|
59
|
+
* modules,
|
|
60
|
+
* middleware: [
|
|
61
|
+
* session({ secret: process.env.SESSION_SECRET! }),
|
|
62
|
+
* // ... other middleware
|
|
63
|
+
* ],
|
|
64
|
+
* })
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
declare function session(options: SessionOptions): (req: Request, res: Response, next: NextFunction) => Promise<void>;
|
|
68
|
+
//#endregion
|
|
69
|
+
export { session as a, SessionStore as i, SessionData as n, SessionOptions as r, Session as t };
|
|
70
|
+
//# sourceMappingURL=session-N0hActOO.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"session-N0hActOO.d.mts","names":[],"sources":["../src/http/middleware/session.ts"],"mappings":";;;;UAGiB,WAAA;EAAA,CACd,GAAA;AAAA;AAAA,UAGc,YAAA;EACf,GAAA,CAAI,GAAA,WAAc,OAAA,CAAQ,WAAA;EAC1B,GAAA,CAAI,GAAA,UAAa,IAAA,EAAM,WAAA,EAAa,MAAA,WAAiB,OAAA;EACrD,OAAA,CAAQ,GAAA,WAAc,OAAA;EACtB,KAAA,EAAO,GAAA,UAAa,MAAA,WAAiB,OAAA;AAAA;AAAA,UAGtB,OAAA;EACf,EAAA;EACA,IAAA,EAAM,WAAA;EACN,UAAA,IAAc,OAAA;EACd,OAAA,IAAW,OAAA;EACX,IAAA,IAAQ,OAAA;AAAA;AAAA,UAGO,cAAA;EAX6B;EAa5C,MAAA;EAhBI;EAkBJ,UAAA;EAlB0B;EAoB1B,MAAA;EAnBI;EAqBJ,OAAA;EArBiB;EAuBjB,iBAAA;EAvBqD;EAyBrD,MAAA;IACE,QAAA;IACA,MAAA;IACA,QAAA;IACA,IAAA;IACA,MAAA;EAAA;EA5B0C;EA+B5C,KAAA,GAAQ,YAAA;AAAA;;;;;;;;;;;;;;;;;;;;AApBV;;;;;iBAiJgB,OAAA,CAAQ,OAAA,EAAS,cAAA,IAoBjB,GAAA,EAAK,OAAA,EAAS,GAAA,EAAK,QAAA,EAAU,IAAA,EAAM,YAAA,KAAY,OAAA"}
|