@kosmojs/api 0.0.11 → 0.0.20
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/package.json +8 -4
- package/pkg/errors/index.js +19 -0
- package/pkg/errors/index.js.map +7 -0
- package/pkg/index.js +47 -20
- package/pkg/index.js.map +4 -4
- package/pkg/src/app.d.ts +3 -2
- package/pkg/src/{errors.d.ts → errors/index.d.ts} +2 -3
- package/pkg/src/router.d.ts +4 -3
- package/pkg/src/types.d.ts +3 -6
- package/pkg/test/index.d.ts +2 -0
- /package/pkg/test/{routerRoutesFactory → createRouterRoutes}/params.test.d.ts +0 -0
- /package/pkg/test/{routerRoutesFactory → createRouterRoutes}/routeMiddleware.test.d.ts +0 -0
- /package/pkg/test/{routerRoutesFactory → createRouterRoutes}/useWrappers.test.d.ts +0 -0
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"type": "module",
|
|
3
3
|
"name": "@kosmojs/api",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.20",
|
|
5
5
|
"author": "Slee Woo",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"publishConfig": {
|
|
@@ -22,6 +22,10 @@
|
|
|
22
22
|
"./queryparser": {
|
|
23
23
|
"types": "./pkg/src/queryparser/index.d.ts",
|
|
24
24
|
"default": "./pkg/queryparser/index.js"
|
|
25
|
+
},
|
|
26
|
+
"./errors": {
|
|
27
|
+
"types": "./pkg/src/errors/index.d.ts",
|
|
28
|
+
"default": "./pkg/errors/index.js"
|
|
25
29
|
}
|
|
26
30
|
},
|
|
27
31
|
"dependencies": {
|
|
@@ -35,13 +39,13 @@
|
|
|
35
39
|
"devDependencies": {
|
|
36
40
|
"@types/formidable": "^3.4.6",
|
|
37
41
|
"@types/koa": "^3.0.1",
|
|
42
|
+
"@types/koa-compose": "^3.2.9",
|
|
38
43
|
"@types/picomatch": "^4.0.2",
|
|
39
44
|
"@types/qs": "^6.14.0",
|
|
40
|
-
"
|
|
41
|
-
"@kosmojs/devlib": "^0.0.11"
|
|
45
|
+
"koa-compose": "^4.1.0"
|
|
42
46
|
},
|
|
43
47
|
"scripts": {
|
|
44
|
-
"build": "esbuilder src/index.ts src/bodyparser/index.ts src/queryparser/index.ts",
|
|
48
|
+
"build": "esbuilder src/index.ts src/bodyparser/index.ts src/queryparser/index.ts src/errors/index.ts",
|
|
45
49
|
"test": "vitest --root ../../.. --project core/api"
|
|
46
50
|
}
|
|
47
51
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// src/errors/index.ts
|
|
2
|
+
var ValidationError = class extends Error {
|
|
3
|
+
scope;
|
|
4
|
+
errors = [];
|
|
5
|
+
errorMessage;
|
|
6
|
+
errorSummary;
|
|
7
|
+
constructor([scope, { errors, errorMessage, errorSummary }]) {
|
|
8
|
+
super(JSON.stringify(errors, null, 2));
|
|
9
|
+
this.name = `${scope}ValidationError`;
|
|
10
|
+
this.scope = scope;
|
|
11
|
+
this.errors = errors;
|
|
12
|
+
this.errorMessage = errorMessage;
|
|
13
|
+
this.errorSummary = errorSummary;
|
|
14
|
+
}
|
|
15
|
+
};
|
|
16
|
+
export {
|
|
17
|
+
ValidationError
|
|
18
|
+
};
|
|
19
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/errors/index.ts"],
|
|
4
|
+
"sourcesContent": ["import type {\n ValidationErrorData,\n ValidationErrorEntry,\n ValidationErrorScope,\n} from \"@/types\";\n\n/**\n * Standardized error wrapper used by validation generators.\n *\n * Instances of this class are thrown whenever validation fails,\n * carrying both the error scope (e.g. `\"params\"`, `\"payload\"`)\n * and the list of validation error details.\n * */\nexport class ValidationError extends Error {\n public scope: ValidationErrorScope;\n public errors: Array<ValidationErrorEntry> = [];\n public errorMessage: string;\n public errorSummary: string;\n\n constructor([scope, { errors, errorMessage, errorSummary }]: [\n ValidationErrorScope,\n ValidationErrorData,\n ]) {\n super(JSON.stringify(errors, null, 2));\n this.name = `${scope}ValidationError`;\n this.scope = scope;\n this.errors = errors;\n this.errorMessage = errorMessage;\n this.errorSummary = errorSummary;\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAaO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAClC;AAAA,EACA,SAAsC,CAAC;AAAA,EACvC;AAAA,EACA;AAAA,EAEP,YAAY,CAAC,OAAO,EAAE,QAAQ,cAAc,aAAa,CAAC,GAGvD;AACD,UAAM,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC;AACrC,SAAK,OAAO,GAAG,KAAK;AACpB,SAAK,QAAQ;AACb,SAAK,SAAS;AACd,SAAK,eAAe;AACpB,SAAK,eAAe;AAAA,EACtB;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/pkg/index.js
CHANGED
|
@@ -1,11 +1,46 @@
|
|
|
1
1
|
// src/app.ts
|
|
2
2
|
import Koa from "koa";
|
|
3
|
-
|
|
3
|
+
|
|
4
|
+
// src/queryparser/index.ts
|
|
5
|
+
import { parse, stringify } from "qs";
|
|
6
|
+
var queryparser_default = (app, _parseOptions = {}, _stringifyOptions = {}) => {
|
|
7
|
+
const parseOptions = {
|
|
8
|
+
ignoreQueryPrefix: true,
|
|
9
|
+
parseArrays: true,
|
|
10
|
+
arrayLimit: 100,
|
|
11
|
+
parameterLimit: 100,
|
|
12
|
+
depth: 5,
|
|
13
|
+
..._parseOptions
|
|
14
|
+
};
|
|
15
|
+
const stringifyOptions = {
|
|
16
|
+
encodeValuesOnly: true,
|
|
17
|
+
arrayFormat: "brackets",
|
|
18
|
+
..._stringifyOptions
|
|
19
|
+
};
|
|
20
|
+
const obj = {
|
|
21
|
+
get query() {
|
|
22
|
+
return parse(this.querystring || "", parseOptions);
|
|
23
|
+
},
|
|
24
|
+
set query(obj2) {
|
|
25
|
+
this.querystring = stringify(obj2, stringifyOptions);
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
const entries = Object.getOwnPropertyNames(obj).map((name) => [
|
|
29
|
+
name,
|
|
30
|
+
Object.getOwnPropertyDescriptor(obj, name)
|
|
31
|
+
]);
|
|
32
|
+
for (const [name, desc] of entries) {
|
|
33
|
+
Object.defineProperty(app.request, name, desc);
|
|
34
|
+
}
|
|
35
|
+
return app;
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
// src/app.ts
|
|
4
39
|
var createApp = (options) => {
|
|
5
|
-
return
|
|
40
|
+
return queryparser_default(new Koa(options));
|
|
6
41
|
};
|
|
7
42
|
|
|
8
|
-
// src/errors.ts
|
|
43
|
+
// src/errors/index.ts
|
|
9
44
|
var ValidationError = class extends Error {
|
|
10
45
|
scope;
|
|
11
46
|
errors = [];
|
|
@@ -20,7 +55,6 @@ var ValidationError = class extends Error {
|
|
|
20
55
|
this.errorSummary = errorSummary;
|
|
21
56
|
}
|
|
22
57
|
};
|
|
23
|
-
var createErrorHandler = (handler) => handler;
|
|
24
58
|
|
|
25
59
|
// src/router.ts
|
|
26
60
|
import Router from "@koa/router";
|
|
@@ -109,9 +143,6 @@ var use = (middleware, options) => {
|
|
|
109
143
|
};
|
|
110
144
|
|
|
111
145
|
// src/router.ts
|
|
112
|
-
var createRouter = (options) => {
|
|
113
|
-
return new Router(options);
|
|
114
|
-
};
|
|
115
146
|
var defineRoute = (factory) => {
|
|
116
147
|
return factory({
|
|
117
148
|
use(middleware, options) {
|
|
@@ -172,24 +203,21 @@ var defineRoute = (factory) => {
|
|
|
172
203
|
}
|
|
173
204
|
});
|
|
174
205
|
};
|
|
175
|
-
var
|
|
206
|
+
var createRouter = (options) => {
|
|
207
|
+
return new Router(options);
|
|
208
|
+
};
|
|
209
|
+
var createRouterRoutes = (routeSources, {
|
|
176
210
|
// Global middleware applied to every route (e.g., logging)
|
|
177
211
|
coreMiddleware
|
|
178
212
|
}) => {
|
|
179
213
|
const prioritizedSlots = [
|
|
180
214
|
"errorHandler",
|
|
181
215
|
"params",
|
|
182
|
-
// Path params processing
|
|
183
216
|
"validateParams",
|
|
184
|
-
// Path params validation
|
|
185
217
|
"bodyparser",
|
|
186
|
-
// Raw request body parsing
|
|
187
218
|
"payload",
|
|
188
|
-
// Set ctx.payload
|
|
189
219
|
"validatePayload",
|
|
190
|
-
// Payload validation
|
|
191
220
|
"validateResponse"
|
|
192
|
-
// Response validation
|
|
193
221
|
];
|
|
194
222
|
const stack = [];
|
|
195
223
|
for (const { name, path, file, ...rest } of routeSources) {
|
|
@@ -201,8 +229,8 @@ var routerRoutesFactory = (routeSources, {
|
|
|
201
229
|
(e) => e.kind === "middleware"
|
|
202
230
|
);
|
|
203
231
|
const middlewareStack = [
|
|
204
|
-
...
|
|
205
|
-
...
|
|
232
|
+
...createParamsMiddleware(rest.params, rest.numericParams),
|
|
233
|
+
...createValidationMiddleware(rest.validationSchemas),
|
|
206
234
|
// core middleware overrides builtin middleware (of same slot)
|
|
207
235
|
...coreMiddleware,
|
|
208
236
|
// route middleware overrides core middleware (of same slot)
|
|
@@ -275,7 +303,7 @@ var routerRoutesFactory = (routeSources, {
|
|
|
275
303
|
}
|
|
276
304
|
return stack;
|
|
277
305
|
};
|
|
278
|
-
var
|
|
306
|
+
var createParamsMiddleware = (params, numericParams) => [
|
|
279
307
|
use(
|
|
280
308
|
function useParams(ctx, next) {
|
|
281
309
|
ctx.typedParams = params.reduce(
|
|
@@ -299,7 +327,7 @@ var paramsMiddlewareFactory = (params, numericParams) => [
|
|
|
299
327
|
{ slot: "params" }
|
|
300
328
|
)
|
|
301
329
|
];
|
|
302
|
-
var
|
|
330
|
+
var createValidationMiddleware = (validationSchemas) => [
|
|
303
331
|
use(
|
|
304
332
|
function useValidateParams(ctx, next) {
|
|
305
333
|
validationSchemas.params?.validate(ctx.typedParams);
|
|
@@ -348,10 +376,9 @@ export {
|
|
|
348
376
|
HTTPMethods,
|
|
349
377
|
ValidationError,
|
|
350
378
|
createApp,
|
|
351
|
-
createErrorHandler,
|
|
352
379
|
createRouter,
|
|
380
|
+
createRouterRoutes,
|
|
353
381
|
defineRoute,
|
|
354
|
-
routerRoutesFactory,
|
|
355
382
|
use
|
|
356
383
|
};
|
|
357
384
|
//# sourceMappingURL=index.js.map
|
package/pkg/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
|
-
"sources": ["../src/app.ts", "../src/errors.ts", "../src/router.ts", "../src/debug.ts", "../src/use.ts", "../src/types.ts"],
|
|
4
|
-
"sourcesContent": ["import Koa from \"koa\";\n\nimport withQueryparser from \"@kosmojs/api/queryparser\";\n\nimport type { CreateApp } from \"./types\";\n\nexport const createApp: CreateApp = (options) => {\n return withQueryparser(new Koa(options));\n};\n", "import type {\n ParameterizedMiddleware,\n ValidationErrorData,\n ValidationErrorEntry,\n ValidationErrorScope,\n} from \"./types\";\n\n/**\n * Standardized error wrapper used by validation generators.\n *\n * Instances of this class are thrown whenever validation fails,\n * carrying both the error scope (e.g. `\"params\"`, `\"payload\"`)\n * and the list of validation error details.\n */\nexport class ValidationError extends Error {\n public scope: ValidationErrorScope;\n public errors: Array<ValidationErrorEntry> = [];\n public errorMessage: string;\n public errorSummary: string;\n\n constructor([scope, { errors, errorMessage, errorSummary }]: [\n ValidationErrorScope,\n ValidationErrorData,\n ]) {\n super(JSON.stringify(errors, null, 2));\n this.name = `${scope}ValidationError`;\n this.scope = scope;\n this.errors = errors;\n this.errorMessage = errorMessage;\n this.errorSummary = errorSummary;\n }\n}\n\nexport const createErrorHandler = (handler: ParameterizedMiddleware) => handler;\n", "import Router, { type RouterMiddleware } from \"@koa/router\";\n\nimport debugRouteEntry from \"./debug\";\nimport type {\n CreateRouter,\n DefineRoute,\n HandlerDefinition,\n MiddlewareDefinition,\n RouterRoute,\n RouterRouteSource,\n UseSlots,\n ValidationSchemas,\n} from \"./types\";\nimport { use } from \"./use\";\n\nexport const createRouter: CreateRouter = (options) => {\n return new Router(options);\n};\n\nexport const defineRoute: DefineRoute = (factory) => {\n return factory({\n use(middleware, options) {\n return {\n kind: \"middleware\",\n middleware: [middleware as never].flat(),\n options,\n };\n },\n HEAD(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"HEAD\",\n };\n },\n OPTIONS(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"OPTIONS\",\n };\n },\n GET(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"GET\",\n };\n },\n POST(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"POST\",\n };\n },\n PUT(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"PUT\",\n };\n },\n PATCH(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"PATCH\",\n };\n },\n DELETE(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"DELETE\",\n };\n },\n });\n};\n\nexport const routerRoutesFactory = (\n routeSources: Array<RouterRouteSource>,\n {\n // Global middleware applied to every route (e.g., logging)\n coreMiddleware,\n }: {\n coreMiddleware: Array<MiddlewareDefinition>;\n },\n): Array<RouterRoute> => {\n // WARN:: prioritized middleware must run in this exact order!\n const prioritizedSlots: Array<keyof UseSlots> = [\n \"errorHandler\",\n \"params\", // Path params processing\n \"validateParams\", // Path params validation\n \"bodyparser\", // Raw request body parsing\n \"payload\", // Set ctx.payload\n \"validatePayload\", // Payload validation\n \"validateResponse\", // Response validation\n ];\n\n const stack: Array<RouterRoute> = [];\n\n // Iterate over each route definition\n for (const { name, path, file, ...rest } of routeSources) {\n // Include both middleware and HTTP method handlers\n const definitionItems = [\n ...rest.useWrappers,\n ...rest.definitionItems,\n ].flat();\n\n const routeMiddleware: Array<MiddlewareDefinition> = definitionItems.filter(\n (e) => e.kind === \"middleware\",\n );\n\n // WARN: the order is critical!\n // the last defined middleware will take precedence.\n const middlewareStack: Array<MiddlewareDefinition> = [\n ...paramsMiddlewareFactory(rest.params, rest.numericParams),\n ...validationMiddlewareFactory(rest.validationSchemas),\n // core middleware overrides builtin middleware (of same slot)\n ...coreMiddleware,\n // route middleware overrides core middleware (of same slot)\n ...routeMiddleware,\n ];\n\n const routeStack: Array<MiddlewareDefinition | HandlerDefinition> = [\n ...prioritizedSlots.flatMap((slot) => {\n const middleware = middlewareStack.findLast(\n // Using findLast to pick the latest entry,\n // ensuring later entries override earlier ones.\n (e) => e.options?.slot === slot,\n );\n return middleware //\n ? [middleware]\n : [];\n }),\n\n ...coreMiddleware.flatMap((entry) => {\n if (!entry.options?.slot) {\n // no slot, including regardless\n return [entry];\n }\n if (prioritizedSlots.includes(entry.options?.slot)) {\n // already picked when inserted prioritized middleware, excluding\n return [];\n }\n const override = routeMiddleware.findLast(\n // Using findLast to pick the latest entry,\n // ensuring later entries override earlier ones.\n (e) => e.options?.slot === entry.options?.slot,\n );\n return [override || entry];\n }),\n\n ...definitionItems.flatMap((entry) => {\n const slot =\n entry.kind === \"middleware\" //\n ? entry.options?.slot\n : undefined;\n\n if (slot) {\n if (prioritizedSlots.includes(slot)) {\n // already picked when inserted prioritized middleware, excluding\n return [];\n }\n if (coreMiddleware.some((e) => e.options?.slot === slot)) {\n // already picked when inserted core middleware, excluding\n return [];\n }\n }\n\n return [entry];\n }),\n ];\n\n for (const entry of routeStack) {\n if (entry.kind === \"handler\") {\n const middleware = routeStack.flatMap((e) => {\n if (e.kind === \"middleware\") {\n return !e.options?.on || e.options.on.includes(entry.method)\n ? [e]\n : [];\n }\n return [];\n });\n stack.push({\n name,\n path,\n file,\n methods: [entry.method],\n middleware: [\n ...middleware.flatMap((e) => e.middleware),\n ...entry.middleware,\n ] as unknown as Array<RouterMiddleware>,\n debug: debugRouteEntry({\n name,\n path,\n file,\n methods: [entry.method],\n middleware,\n handler: entry,\n }),\n });\n }\n }\n }\n\n return stack;\n};\n\nconst paramsMiddlewareFactory = (\n params: RouterRouteSource[\"params\"],\n numericParams: RouterRouteSource[\"numericParams\"],\n) => [\n use(\n function useParams(ctx, next) {\n ctx.typedParams = params.reduce(\n (map: Record<string, unknown>, [name, isRest]) => {\n const value = ctx.params[name];\n if (value) {\n if (isRest) {\n map[name] = numericParams.includes(name)\n ? value.split(\"/\").map(Number)\n : value.split(\"/\");\n } else {\n map[name] = numericParams.includes(name) ? Number(value) : value;\n }\n } else {\n map[name] = value;\n }\n return map;\n },\n {},\n ) as never;\n return next();\n },\n { slot: \"params\" },\n ),\n];\n\nconst validationMiddlewareFactory = (validationSchemas: ValidationSchemas) => [\n use(\n function useValidateParams(ctx, next) {\n validationSchemas.params?.validate(ctx.typedParams);\n return next();\n },\n { slot: \"validateParams\" },\n ),\n\n use(\n function useValidatePayload(ctx, next) {\n validationSchemas.payload?.[ctx.method]?.validate(ctx.payload);\n return next();\n },\n {\n slot: \"validatePayload\",\n on: Object.keys(validationSchemas.payload || {}) as never,\n },\n ),\n\n use(\n async function useValidateResponse(ctx, next) {\n if (validationSchemas.response?.[ctx.method]) {\n await next();\n validationSchemas.response?.[ctx.method]?.validate(ctx.body);\n } else {\n return next();\n }\n },\n {\n slot: \"validateResponse\",\n on: Object.keys(validationSchemas.response || {}) as never,\n },\n ),\n];\n", "import { styleText } from \"node:util\";\n\nimport stringWidth from \"string-width\";\n\nimport type {\n HandlerDefinition,\n MiddlewareDefinition,\n RouterRoute,\n} from \"./types\";\n\nconst colorizeMethod = (method: string): string => {\n const color = (\n {\n HEAD: \"gray\",\n GET: \"green\",\n POST: \"blue\",\n PATCH: \"blue\",\n PUT: \"blue\",\n DELETE: \"red\",\n } as const\n )[method];\n return color ? styleText(color, method) : method;\n};\n\nexport default (entry: {\n name: string;\n path: string;\n file: string;\n methods: Array<string>;\n middleware: Array<MiddlewareDefinition>;\n handler: HandlerDefinition;\n}): RouterRoute[\"debug\"] => {\n const { path, file } = entry;\n\n const methodLines = entry.methods.flatMap((method) => {\n const coloredMethod = colorizeMethod(method);\n return method === \"GET\"\n ? [coloredMethod + styleText(\"gray\", \"|HEAD\")]\n : [coloredMethod];\n });\n\n const middlewareLines = entry.middleware\n .map(({ options, middleware }) => {\n const lines: Array<string> = [];\n\n if (options?.slot) {\n lines.push(\n `${styleText(\"dim\", \"slot:\")} ${styleText(\"blue\", options.slot)};`,\n );\n }\n\n const funcNames = middleware.map((fn) => {\n return styleText(\"magenta\", funcName(fn));\n });\n\n lines.push(`${styleText(\"dim\", \"exec:\")} ${funcNames.join(\"; \")}`);\n\n return lines.join(\" \");\n })\n .join(`\\n${Array(12).fill(\" \").join(\"\")}`);\n\n const handlerLines = entry.handler.middleware.map((fn) => {\n return styleText(\"yellow\", funcName(fn));\n });\n\n const headline = `${styleText(\"bgBlue\", styleText(\"black\", ` ${path} `))} ${styleText(\"gray\", `[ ${file} ]`)}`;\n const methods = `${styleText(\"dim\", \" methods:\")} ${methodLines.join(\" \")}`;\n const middleware = `${styleText(\"dim\", \"middleware:\")} ${middlewareLines}`;\n const handler = `${styleText(\"dim\", \" handler:\")} ${handlerLines.join(Array(7).fill(\" \").join(\"\"))}`;\n\n const maxColumns = process.stdout.isTTY\n ? Number(process.stdout.columns || 80)\n : 80;\n\n const debugEntries = [\n [\"headline\", headline],\n [\"methods\", methods],\n [\"middleware\", middleware],\n [\"handler\", handler],\n ] as const;\n\n const lineMapper = (line: string) => {\n const freeColumns = maxColumns - stringWidth(line);\n return freeColumns > 0\n ? [\n line,\n styleText(\n \"dim\",\n styleText(\"gray\", Array(freeColumns).fill(\"\u00B7\").join(\"\")),\n ),\n ].join(\"\")\n : line;\n };\n\n const debug = debugEntries.reduce(\n (map, [key, line]) => {\n map[key] = line.split(\"\\n\").map(lineMapper).join(\"\\n\");\n return map;\n },\n {} as RouterRoute[\"debug\"],\n );\n\n return {\n ...debug,\n full: Object.values(debug).join(\"\\n\"),\n };\n};\n\nconst funcName = (fn: Function) => {\n return fn.name || fn.toString().split(\"\\n\")[0].slice(0, 30);\n};\n", "import type { Use } from \"./types\";\n\nexport const use: Use = (middleware, options) => {\n return {\n kind: \"middleware\",\n middleware: [middleware].flat() as never,\n options,\n };\n};\n", "import type {\n RouterContext,\n RouterMiddleware,\n RouterOptions,\n} from \"@koa/router\";\nimport type { Next } from \"koa\";\n\ndeclare module \"koa\" {\n interface Request {\n body?: unknown;\n rawBody: string;\n }\n}\n\nexport interface DefaultState {}\nexport interface DefaultContext {}\n\nexport enum HTTPMethods {\n HEAD = \"HEAD\",\n OPTIONS = \"OPTIONS\",\n GET = \"GET\",\n PUT = \"PUT\",\n PATCH = \"PATCH\",\n POST = \"POST\",\n DELETE = \"DELETE\",\n}\n\nexport type HTTPMethod = keyof typeof HTTPMethods;\n\nexport type ParameterizedContext<\n ParamsT,\n StateT,\n ContextT,\n PayloadT = unknown,\n ResponseT = unknown,\n> = RouterContext<\n DefaultState & StateT,\n DefaultContext &\n ContextT & {\n typedParams: ParamsT;\n payload: PayloadT;\n },\n ResponseT\n>;\n\nexport type ParameterizedMiddleware<\n ParamsT = {},\n StateT = {},\n ContextT = {},\n> = (\n ctx: ParameterizedContext<ParamsT, StateT, ContextT>,\n next: Next,\n) => Promise<void> | void;\n\nexport type RouteHandler<\n ParamsT,\n StateT,\n ContextT,\n PayloadT = unknown,\n ResponseT = unknown,\n> = (\n ctx: ParameterizedContext<ParamsT, StateT, ContextT, PayloadT, ResponseT>,\n next: Next,\n) => Promise<void> | void;\n\nexport type MiddlewareDefinition = {\n kind: \"middleware\";\n middleware: Array<ParameterizedMiddleware>;\n options?: UseOptions | undefined;\n};\n\nexport type HandlerDefinition = {\n kind: \"handler\";\n middleware: Array<ParameterizedMiddleware>;\n method: HTTPMethod;\n};\n\nexport type RouteDefinitionItem = MiddlewareDefinition | HandlerDefinition;\n\nexport type DefineRouteHelpers<\n ParamsT,\n StateT,\n ContextT,\n OptionalHandlers = undefined,\n> = {\n // INFO: The `use` helper intentionally does not accept type parameters.\n // PayloadT and ResponseT are only relevant to route handlers,\n // as different request methods receive different payloads and return different responses.\n // Allowing these type parameters on `use` would be misleading,\n // since middleware operates across multiple request methods with varying types.\n use: (\n middleware:\n | ParameterizedMiddleware<ParamsT, StateT, ContextT>\n | Array<ParameterizedMiddleware<ParamsT, StateT, ContextT>>,\n options?: UseOptions,\n ) => RouteDefinitionItem;\n} & {\n [M in HTTPMethod]: M extends OptionalHandlers\n ? <PayloadT = unknown, ResponseT = unknown>(\n handler?:\n | RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>\n | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>,\n ) => RouteDefinitionItem\n : <PayloadT = unknown, ResponseT = unknown>(\n handler:\n | RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>\n | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>,\n ) => RouteDefinitionItem;\n};\n\nexport type DefineRoute = <\n ParamsT = Record<string, string>,\n StateT = object,\n ContextT = object,\n>(\n factory: (\n helpers: DefineRouteHelpers<ParamsT, StateT, ContextT>,\n ) => Array<RouteDefinitionItem>,\n) => Array<RouteDefinitionItem>;\n\nexport interface UseSlots {\n errorHandler: string;\n params: string;\n validateParams: string;\n bodyparser: string;\n payload: string;\n validatePayload: string;\n validateResponse: string;\n}\n\nexport type UseOptions = {\n on?: Array<HTTPMethod>;\n slot?: keyof UseSlots;\n debug?: string | undefined;\n};\n\nexport type Use = <StateT = DefaultState, ContextT = DefaultContext>(\n middleware:\n | ParameterizedMiddleware<Record<string, string>, StateT, ContextT>\n | Array<ParameterizedMiddleware<Record<string, string>, StateT, ContextT>>,\n options?: UseOptions,\n) => MiddlewareDefinition;\n\nexport type RouterRouteSource = {\n name: string;\n path: string;\n file: string;\n // useWrappers is same as defining middleware inside route definition,\n // just automatically imported from use.ts files\n useWrappers: [...a: Array<MiddlewareDefinition>];\n definitionItems: Array<RouteDefinitionItem>;\n params: Array<[name: string, isRest?: boolean]>;\n numericParams: Array<string>;\n validationSchemas: ValidationSchemas;\n meta?: Record<string, unknown>;\n};\n\nexport type RouterRoute = {\n name: string;\n path: string;\n file: string;\n methods: Array<string>;\n middleware: Array<RouterMiddleware>;\n debug: {\n headline: string;\n methods: string;\n middleware: string;\n handler: string;\n full: string;\n };\n};\n\nimport type Koa from \"koa\";\nexport type App = Koa<DefaultState, DefaultContext>;\nexport type AppOptions = ConstructorParameters<typeof import(\"koa\")>[0];\nexport type CreateApp = (options?: AppOptions) => App;\n\nimport type KoaRouter from \"@koa/router\";\nexport type Router = KoaRouter<DefaultState, DefaultContext>;\nexport type { RouterOptions };\nexport type CreateRouter = (options?: RouterOptions) => Router;\n\nexport type DevMiddlewareFactory = (\n app: App,\n) => (\n req: import(\"node:http\").IncomingMessage,\n res: import(\"node:http\").ServerResponse,\n next: () => Promise<void>,\n) => Promise<void>;\nexport type TeardownHandler = (app: App) => void | Promise<void>;\n\nexport type ValidationSchema = {\n check: (data: unknown) => boolean;\n errors: (data: unknown) => Array<ValidationErrorEntry>;\n errorMessage: (data: unknown) => string;\n errorSummary: (data: unknown) => string;\n validate: (data: unknown) => void;\n};\n\nexport type ValidationSchemas<Extend = object> = {\n params?: ValidationSchema & Extend;\n payload?: Record<string, ValidationSchema & Extend>;\n response?: Record<string, ValidationSchema & Extend>;\n};\n\nexport type ValidationErrorScope = \"params\" | \"payload\" | \"response\";\n\n/**\n * Shape of individual validation errors emitted by generators.\n */\nexport type ValidationErrorEntry = {\n /** JSON Schema keyword that triggered the error (e.g. `format`, `maxItems`, `maxLength`). */\n keyword: string;\n /** JSON Pointer\u2013style path to the invalid field (matches JSON Schema `instancePath`). */\n path: string;\n /** Human-readable error message. */\n message: string;\n /** Constraint parameters (e.g. `{ limit: 5 }`, `{ format: \"email\" }`). */\n params?: Record<string, unknown>;\n /** Optional error code for i18n/l10n or custom handling. */\n code?: string;\n};\n\nexport type ValidationErrorData = {\n errors: Array<ValidationErrorEntry>;\n /**\n * Formats errors into a single human-readable message.\n * @example: Validation failed: user: missing required properties: \"email\", \"name\"; password: must be at least 8 characters long\n */\n errorMessage: string;\n /**\n * Gets a simple error summary for quick feedback.\n * @example: 2 validation errors found across 2 fields\n */\n errorSummary: string;\n};\n"],
|
|
5
|
-
"mappings": ";AAAA,OAAO,SAAS
|
|
6
|
-
"names": ["middleware", "HTTPMethods"]
|
|
3
|
+
"sources": ["../src/app.ts", "../src/queryparser/index.ts", "../src/errors/index.ts", "../src/router.ts", "../src/debug.ts", "../src/use.ts", "../src/types.ts"],
|
|
4
|
+
"sourcesContent": ["import Koa from \"koa\";\n\nimport withQueryparser from \"@/queryparser\";\n\nimport type { AppOptions } from \"./types\";\n\nexport const createApp = (options?: AppOptions) => {\n return withQueryparser(new Koa(options));\n};\n", "import type Koa from \"koa\";\nimport type { IParseOptions, IStringifyOptions } from \"qs\";\nimport { parse, stringify } from \"qs\";\n\nimport type { DefaultContext, DefaultState } from \"@/types\";\n\nexport default <\n T extends InstanceType<typeof Koa<DefaultState, DefaultContext>> = never,\n>(\n app: T,\n _parseOptions: IParseOptions = {},\n _stringifyOptions: IStringifyOptions = {},\n) => {\n const parseOptions = {\n ignoreQueryPrefix: true,\n parseArrays: true,\n arrayLimit: 100,\n parameterLimit: 100,\n depth: 5,\n ..._parseOptions,\n };\n\n const stringifyOptions = {\n encodeValuesOnly: true,\n arrayFormat: \"brackets\",\n ..._stringifyOptions,\n } as const;\n\n const obj = {\n get query() {\n return parse((this as Koa.Request).querystring || \"\", parseOptions);\n },\n\n set query(obj: object) {\n (this as Koa.Request).querystring = stringify(obj, stringifyOptions);\n },\n };\n\n const entries = Object.getOwnPropertyNames(obj).map((name) => [\n name,\n Object.getOwnPropertyDescriptor(obj, name),\n ]) as [name: string, desc: PropertyDescriptor][];\n\n for (const [name, desc] of entries) {\n Object.defineProperty(app.request, name, desc);\n }\n\n return app;\n};\n", "import type {\n ValidationErrorData,\n ValidationErrorEntry,\n ValidationErrorScope,\n} from \"@/types\";\n\n/**\n * Standardized error wrapper used by validation generators.\n *\n * Instances of this class are thrown whenever validation fails,\n * carrying both the error scope (e.g. `\"params\"`, `\"payload\"`)\n * and the list of validation error details.\n * */\nexport class ValidationError extends Error {\n public scope: ValidationErrorScope;\n public errors: Array<ValidationErrorEntry> = [];\n public errorMessage: string;\n public errorSummary: string;\n\n constructor([scope, { errors, errorMessage, errorSummary }]: [\n ValidationErrorScope,\n ValidationErrorData,\n ]) {\n super(JSON.stringify(errors, null, 2));\n this.name = `${scope}ValidationError`;\n this.scope = scope;\n this.errors = errors;\n this.errorMessage = errorMessage;\n this.errorSummary = errorSummary;\n }\n}\n", "import Router, { type RouterMiddleware } from \"@koa/router\";\n\nimport debugRouteEntry from \"./debug\";\nimport type {\n DefineRoute,\n HandlerDefinition,\n MiddlewareDefinition,\n RouterOptions,\n RouterRoute,\n RouterRouteSource,\n UseSlots,\n ValidationSchemas,\n} from \"./types\";\nimport { use } from \"./use\";\n\nexport const defineRoute: DefineRoute = (factory) => {\n return factory({\n use(middleware, options) {\n return {\n kind: \"middleware\",\n middleware: [middleware as never].flat(),\n options,\n };\n },\n HEAD(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"HEAD\",\n };\n },\n OPTIONS(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"OPTIONS\",\n };\n },\n GET(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"GET\",\n };\n },\n POST(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"POST\",\n };\n },\n PUT(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"PUT\",\n };\n },\n PATCH(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"PATCH\",\n };\n },\n DELETE(middleware) {\n return {\n kind: \"handler\",\n middleware: [middleware as never].flat(),\n method: \"DELETE\",\n };\n },\n });\n};\n\nexport const createRouter = (options?: RouterOptions) => {\n return new Router(options);\n};\n\nexport const createRouterRoutes = (\n routeSources: Array<RouterRouteSource>,\n {\n // Global middleware applied to every route (e.g., logging)\n coreMiddleware,\n }: {\n coreMiddleware: Array<MiddlewareDefinition>;\n },\n): Array<RouterRoute> => {\n // NOTE:: prioritized middleware must run in this exact order!\n const prioritizedSlots: Array<keyof UseSlots> = [\n \"errorHandler\",\n \"params\",\n \"validateParams\",\n \"bodyparser\",\n \"payload\",\n \"validatePayload\",\n \"validateResponse\",\n ];\n\n const stack: Array<RouterRoute> = [];\n\n // Iterate over each route definition\n for (const { name, path, file, ...rest } of routeSources) {\n // Include both middleware and HTTP method handlers\n const definitionItems = [\n ...rest.useWrappers,\n ...rest.definitionItems,\n ].flat();\n\n const routeMiddleware: Array<MiddlewareDefinition> = definitionItems.filter(\n (e) => e.kind === \"middleware\",\n );\n\n const middlewareStack: Array<MiddlewareDefinition> = [\n ...createParamsMiddleware(rest.params, rest.numericParams),\n ...createValidationMiddleware(rest.validationSchemas),\n // core middleware overrides builtin middleware (of same slot)\n ...coreMiddleware,\n // route middleware overrides core middleware (of same slot)\n ...routeMiddleware,\n ];\n\n // NOTE: later defined middleware should override previous middleware of same slot\n const routeStack: Array<MiddlewareDefinition | HandlerDefinition> = [\n ...prioritizedSlots.flatMap((slot) => {\n const middleware = middlewareStack.findLast(\n // Using findLast to pick the latest entry,\n // ensuring later entries override earlier ones.\n (e) => e.options?.slot === slot,\n );\n return middleware //\n ? [middleware]\n : [];\n }),\n\n ...coreMiddleware.flatMap((entry) => {\n if (!entry.options?.slot) {\n // no slot, including regardless\n return [entry];\n }\n if (prioritizedSlots.includes(entry.options?.slot)) {\n // already picked when inserted prioritized middleware, excluding\n return [];\n }\n const override = routeMiddleware.findLast(\n // Using findLast to pick the latest entry,\n // ensuring later entries override earlier ones.\n (e) => e.options?.slot === entry.options?.slot,\n );\n return [override || entry];\n }),\n\n ...definitionItems.flatMap((entry) => {\n const slot =\n entry.kind === \"middleware\" //\n ? entry.options?.slot\n : undefined;\n\n if (slot) {\n if (prioritizedSlots.includes(slot)) {\n // already picked when inserted prioritized middleware, excluding\n return [];\n }\n if (coreMiddleware.some((e) => e.options?.slot === slot)) {\n // already picked when inserted core middleware, excluding\n return [];\n }\n }\n\n return [entry];\n }),\n ];\n\n for (const entry of routeStack) {\n if (entry.kind === \"handler\") {\n const middleware = routeStack.flatMap((e) => {\n if (e.kind === \"middleware\") {\n return !e.options?.on || e.options.on.includes(entry.method)\n ? [e]\n : [];\n }\n return [];\n });\n stack.push({\n name,\n path,\n file,\n methods: [entry.method],\n middleware: [\n ...middleware.flatMap((e) => e.middleware),\n ...entry.middleware,\n ] as unknown as Array<RouterMiddleware>,\n debug: debugRouteEntry({\n name,\n path,\n file,\n methods: [entry.method],\n middleware,\n handler: entry,\n }),\n });\n }\n }\n }\n\n return stack;\n};\n\nconst createParamsMiddleware = (\n params: RouterRouteSource[\"params\"],\n numericParams: RouterRouteSource[\"numericParams\"],\n) => [\n use(\n function useParams(ctx, next) {\n ctx.typedParams = params.reduce(\n (map: Record<string, unknown>, [name, isRest]) => {\n const value = ctx.params[name];\n if (value) {\n if (isRest) {\n map[name] = numericParams.includes(name)\n ? value.split(\"/\").map(Number)\n : value.split(\"/\");\n } else {\n map[name] = numericParams.includes(name) ? Number(value) : value;\n }\n } else {\n map[name] = value;\n }\n return map;\n },\n {},\n ) as never;\n return next();\n },\n { slot: \"params\" },\n ),\n];\n\nconst createValidationMiddleware = (validationSchemas: ValidationSchemas) => [\n use(\n function useValidateParams(ctx, next) {\n validationSchemas.params?.validate(ctx.typedParams);\n return next();\n },\n { slot: \"validateParams\" },\n ),\n\n use(\n function useValidatePayload(ctx, next) {\n validationSchemas.payload?.[ctx.method]?.validate(ctx.payload);\n return next();\n },\n {\n slot: \"validatePayload\",\n on: Object.keys(validationSchemas.payload || {}) as never,\n },\n ),\n\n use(\n async function useValidateResponse(ctx, next) {\n if (validationSchemas.response?.[ctx.method]) {\n await next();\n validationSchemas.response?.[ctx.method]?.validate(ctx.body);\n } else {\n return next();\n }\n },\n {\n slot: \"validateResponse\",\n on: Object.keys(validationSchemas.response || {}) as never,\n },\n ),\n];\n", "import { styleText } from \"node:util\";\n\nimport stringWidth from \"string-width\";\n\nimport type {\n HandlerDefinition,\n MiddlewareDefinition,\n RouterRoute,\n} from \"./types\";\n\nconst colorizeMethod = (method: string): string => {\n const color = (\n {\n HEAD: \"gray\",\n GET: \"green\",\n POST: \"blue\",\n PATCH: \"blue\",\n PUT: \"blue\",\n DELETE: \"red\",\n } as const\n )[method];\n return color ? styleText(color, method) : method;\n};\n\nexport default (entry: {\n name: string;\n path: string;\n file: string;\n methods: Array<string>;\n middleware: Array<MiddlewareDefinition>;\n handler: HandlerDefinition;\n}): RouterRoute[\"debug\"] => {\n const { path, file } = entry;\n\n const methodLines = entry.methods.flatMap((method) => {\n const coloredMethod = colorizeMethod(method);\n return method === \"GET\"\n ? [coloredMethod + styleText(\"gray\", \"|HEAD\")]\n : [coloredMethod];\n });\n\n const middlewareLines = entry.middleware\n .map(({ options, middleware }) => {\n const lines: Array<string> = [];\n\n if (options?.slot) {\n lines.push(\n `${styleText(\"dim\", \"slot:\")} ${styleText(\"blue\", options.slot)};`,\n );\n }\n\n const funcNames = middleware.map((fn) => {\n return styleText(\"magenta\", funcName(fn));\n });\n\n lines.push(`${styleText(\"dim\", \"exec:\")} ${funcNames.join(\"; \")}`);\n\n return lines.join(\" \");\n })\n .join(`\\n${Array(12).fill(\" \").join(\"\")}`);\n\n const handlerLines = entry.handler.middleware.map((fn) => {\n return styleText(\"yellow\", funcName(fn));\n });\n\n const headline = `${styleText(\"bgBlue\", styleText(\"black\", ` ${path} `))} ${styleText(\"gray\", `[ ${file} ]`)}`;\n const methods = `${styleText(\"dim\", \" methods:\")} ${methodLines.join(\" \")}`;\n const middleware = `${styleText(\"dim\", \"middleware:\")} ${middlewareLines}`;\n const handler = `${styleText(\"dim\", \" handler:\")} ${handlerLines.join(Array(7).fill(\" \").join(\"\"))}`;\n\n const maxColumns = process.stdout.isTTY\n ? Number(process.stdout.columns || 80)\n : 80;\n\n const debugEntries = [\n [\"headline\", headline],\n [\"methods\", methods],\n [\"middleware\", middleware],\n [\"handler\", handler],\n ] as const;\n\n const lineMapper = (line: string) => {\n const freeColumns = maxColumns - stringWidth(line);\n return freeColumns > 0\n ? [\n line,\n styleText(\n \"dim\",\n styleText(\"gray\", Array(freeColumns).fill(\"\u00B7\").join(\"\")),\n ),\n ].join(\"\")\n : line;\n };\n\n const debug = debugEntries.reduce(\n (map, [key, line]) => {\n map[key] = line.split(\"\\n\").map(lineMapper).join(\"\\n\");\n return map;\n },\n {} as RouterRoute[\"debug\"],\n );\n\n return {\n ...debug,\n full: Object.values(debug).join(\"\\n\"),\n };\n};\n\nconst funcName = (fn: Function) => {\n return fn.name || fn.toString().split(\"\\n\")[0].slice(0, 30);\n};\n", "import type { Use } from \"./types\";\n\nexport const use: Use = (middleware, options) => {\n return {\n kind: \"middleware\",\n middleware: [middleware].flat() as never,\n options,\n };\n};\n", "import type { RouterContext, RouterMiddleware } from \"@koa/router\";\nimport type { Next } from \"koa\";\n\ndeclare module \"koa\" {\n interface Request {\n body?: unknown;\n rawBody: string;\n }\n}\n\nexport interface DefaultState {}\nexport interface DefaultContext {}\n\nexport enum HTTPMethods {\n HEAD = \"HEAD\",\n OPTIONS = \"OPTIONS\",\n GET = \"GET\",\n PUT = \"PUT\",\n PATCH = \"PATCH\",\n POST = \"POST\",\n DELETE = \"DELETE\",\n}\n\nexport type HTTPMethod = keyof typeof HTTPMethods;\n\nexport type ParameterizedContext<\n ParamsT,\n StateT,\n ContextT,\n PayloadT = unknown,\n ResponseT = unknown,\n> = RouterContext<\n DefaultState & StateT,\n DefaultContext &\n ContextT & {\n typedParams: ParamsT;\n payload: PayloadT;\n },\n ResponseT\n>;\n\nexport type ParameterizedMiddleware<\n ParamsT = {},\n StateT = {},\n ContextT = {},\n> = (\n ctx: ParameterizedContext<ParamsT, StateT, ContextT>,\n next: Next,\n) => Promise<void> | void;\n\nexport type RouteHandler<\n ParamsT,\n StateT,\n ContextT,\n PayloadT = unknown,\n ResponseT = unknown,\n> = (\n ctx: ParameterizedContext<ParamsT, StateT, ContextT, PayloadT, ResponseT>,\n next: Next,\n) => Promise<void> | void;\n\nexport type MiddlewareDefinition = {\n kind: \"middleware\";\n middleware: Array<ParameterizedMiddleware>;\n options?: UseOptions | undefined;\n};\n\nexport type HandlerDefinition = {\n kind: \"handler\";\n middleware: Array<ParameterizedMiddleware>;\n method: HTTPMethod;\n};\n\nexport type RouteDefinitionItem = MiddlewareDefinition | HandlerDefinition;\n\nexport type DefineRouteHelpers<\n ParamsT,\n StateT,\n ContextT,\n OptionalHandlers = undefined,\n> = {\n // INFO: The `use` helper intentionally does not accept type parameters.\n // PayloadT and ResponseT are only relevant to route handlers,\n // as different request methods receive different payloads and return different responses.\n // Allowing these type parameters on `use` would be misleading,\n // since middleware operates across multiple request methods with varying types.\n use: (\n middleware:\n | ParameterizedMiddleware<ParamsT, StateT, ContextT>\n | Array<ParameterizedMiddleware<ParamsT, StateT, ContextT>>,\n options?: UseOptions,\n ) => RouteDefinitionItem;\n} & {\n [M in HTTPMethod]: M extends OptionalHandlers\n ? <PayloadT = unknown, ResponseT = unknown>(\n handler?:\n | RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>\n | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>,\n ) => RouteDefinitionItem\n : <PayloadT = unknown, ResponseT = unknown>(\n handler:\n | RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>\n | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>,\n ) => RouteDefinitionItem;\n};\n\nexport type DefineRoute = <\n ParamsT = Record<string, string>,\n StateT = object,\n ContextT = object,\n>(\n factory: (\n helpers: DefineRouteHelpers<ParamsT, StateT, ContextT>,\n ) => Array<RouteDefinitionItem>,\n) => Array<RouteDefinitionItem>;\n\nexport interface UseSlots {\n errorHandler: string;\n params: string;\n validateParams: string;\n bodyparser: string;\n payload: string;\n validatePayload: string;\n validateResponse: string;\n}\n\nexport type UseOptions = {\n on?: Array<HTTPMethod>;\n slot?: keyof UseSlots;\n debug?: string | undefined;\n};\n\nexport type Use = <StateT = DefaultState, ContextT = DefaultContext>(\n middleware:\n | ParameterizedMiddleware<Record<string, string>, StateT, ContextT>\n | Array<ParameterizedMiddleware<Record<string, string>, StateT, ContextT>>,\n options?: UseOptions,\n) => MiddlewareDefinition;\n\nexport type RouterRouteSource = {\n name: string;\n path: string;\n file: string;\n // useWrappers is same as defining middleware inside route definition,\n // just automatically imported from use.ts files\n useWrappers: [...a: Array<MiddlewareDefinition>];\n definitionItems: Array<RouteDefinitionItem>;\n params: Array<[name: string, isRest?: boolean]>;\n numericParams: Array<string>;\n validationSchemas: ValidationSchemas;\n meta?: Record<string, unknown>;\n};\n\nexport type RouterRoute = {\n name: string;\n path: string;\n file: string;\n methods: Array<string>;\n middleware: Array<RouterMiddleware>;\n debug: {\n headline: string;\n methods: string;\n middleware: string;\n handler: string;\n full: string;\n };\n};\n\nimport type Koa from \"koa\";\nexport type App = Koa<DefaultState, DefaultContext>;\nexport type AppOptions = ConstructorParameters<typeof import(\"koa\")>[0];\n\nexport type Router = import(\"@koa/router\").Router<DefaultState, DefaultContext>;\nexport type RouterOptions = import(\"@koa/router\").RouterOptions;\n\nexport type DevMiddlewareFactory = (\n app: App,\n) => (\n req: import(\"node:http\").IncomingMessage,\n res: import(\"node:http\").ServerResponse,\n next: () => Promise<void>,\n) => Promise<void>;\nexport type TeardownHandler = (app: App) => void | Promise<void>;\n\nexport type ValidationSchema = {\n check: (data: unknown) => boolean;\n errors: (data: unknown) => Array<ValidationErrorEntry>;\n errorMessage: (data: unknown) => string;\n errorSummary: (data: unknown) => string;\n validate: (data: unknown) => void;\n};\n\nexport type ValidationSchemas<Extend = object> = {\n params?: ValidationSchema & Extend;\n payload?: Record<string, ValidationSchema & Extend>;\n response?: Record<string, ValidationSchema & Extend>;\n};\n\nexport type ValidationErrorScope = \"params\" | \"payload\" | \"response\";\n\n/**\n * Shape of individual validation errors emitted by generators.\n */\nexport type ValidationErrorEntry = {\n /** JSON Schema keyword that triggered the error (e.g. `format`, `maxItems`, `maxLength`). */\n keyword: string;\n /** JSON Pointer\u2013style path to the invalid field (matches JSON Schema `instancePath`). */\n path: string;\n /** Human-readable error message. */\n message: string;\n /** Constraint parameters (e.g. `{ limit: 5 }`, `{ format: \"email\" }`). */\n params?: Record<string, unknown>;\n /** Optional error code for i18n/l10n or custom handling. */\n code?: string;\n};\n\nexport type ValidationErrorData = {\n errors: Array<ValidationErrorEntry>;\n /**\n * Formats errors into a single human-readable message.\n * @example: Validation failed: user: missing required properties: \"email\", \"name\"; password: must be at least 8 characters long\n */\n errorMessage: string;\n /**\n * Gets a simple error summary for quick feedback.\n * @example: 2 validation errors found across 2 fields\n */\n errorSummary: string;\n};\n"],
|
|
5
|
+
"mappings": ";AAAA,OAAO,SAAS;;;ACEhB,SAAS,OAAO,iBAAiB;AAIjC,IAAO,sBAAQ,CAGb,KACA,gBAA+B,CAAC,GAChC,oBAAuC,CAAC,MACrC;AACH,QAAM,eAAe;AAAA,IACnB,mBAAmB;AAAA,IACnB,aAAa;AAAA,IACb,YAAY;AAAA,IACZ,gBAAgB;AAAA,IAChB,OAAO;AAAA,IACP,GAAG;AAAA,EACL;AAEA,QAAM,mBAAmB;AAAA,IACvB,kBAAkB;AAAA,IAClB,aAAa;AAAA,IACb,GAAG;AAAA,EACL;AAEA,QAAM,MAAM;AAAA,IACV,IAAI,QAAQ;AACV,aAAO,MAAO,KAAqB,eAAe,IAAI,YAAY;AAAA,IACpE;AAAA,IAEA,IAAI,MAAMA,MAAa;AACrB,MAAC,KAAqB,cAAc,UAAUA,MAAK,gBAAgB;AAAA,IACrE;AAAA,EACF;AAEA,QAAM,UAAU,OAAO,oBAAoB,GAAG,EAAE,IAAI,CAAC,SAAS;AAAA,IAC5D;AAAA,IACA,OAAO,yBAAyB,KAAK,IAAI;AAAA,EAC3C,CAAC;AAED,aAAW,CAAC,MAAM,IAAI,KAAK,SAAS;AAClC,WAAO,eAAe,IAAI,SAAS,MAAM,IAAI;AAAA,EAC/C;AAEA,SAAO;AACT;;;AD1CO,IAAM,YAAY,CAAC,YAAyB;AACjD,SAAO,oBAAgB,IAAI,IAAI,OAAO,CAAC;AACzC;;;AEKO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAClC;AAAA,EACA,SAAsC,CAAC;AAAA,EACvC;AAAA,EACA;AAAA,EAEP,YAAY,CAAC,OAAO,EAAE,QAAQ,cAAc,aAAa,CAAC,GAGvD;AACD,UAAM,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC;AACrC,SAAK,OAAO,GAAG,KAAK;AACpB,SAAK,QAAQ;AACb,SAAK,SAAS;AACd,SAAK,eAAe;AACpB,SAAK,eAAe;AAAA,EACtB;AACF;;;AC9BA,OAAO,YAAuC;;;ACA9C,SAAS,iBAAiB;AAE1B,OAAO,iBAAiB;AAQxB,IAAM,iBAAiB,CAAC,WAA2B;AACjD,QAAM,QACJ;AAAA,IACE,MAAM;AAAA,IACN,KAAK;AAAA,IACL,MAAM;AAAA,IACN,OAAO;AAAA,IACP,KAAK;AAAA,IACL,QAAQ;AAAA,EACV,EACA,MAAM;AACR,SAAO,QAAQ,UAAU,OAAO,MAAM,IAAI;AAC5C;AAEA,IAAO,gBAAQ,CAAC,UAOY;AAC1B,QAAM,EAAE,MAAM,KAAK,IAAI;AAEvB,QAAM,cAAc,MAAM,QAAQ,QAAQ,CAAC,WAAW;AACpD,UAAM,gBAAgB,eAAe,MAAM;AAC3C,WAAO,WAAW,QACd,CAAC,gBAAgB,UAAU,QAAQ,OAAO,CAAC,IAC3C,CAAC,aAAa;AAAA,EACpB,CAAC;AAED,QAAM,kBAAkB,MAAM,WAC3B,IAAI,CAAC,EAAE,SAAS,YAAAC,YAAW,MAAM;AAChC,UAAM,QAAuB,CAAC;AAE9B,QAAI,SAAS,MAAM;AACjB,YAAM;AAAA,QACJ,GAAG,UAAU,OAAO,OAAO,CAAC,IAAI,UAAU,QAAQ,QAAQ,IAAI,CAAC;AAAA,MACjE;AAAA,IACF;AAEA,UAAM,YAAYA,YAAW,IAAI,CAAC,OAAO;AACvC,aAAO,UAAU,WAAW,SAAS,EAAE,CAAC;AAAA,IAC1C,CAAC;AAED,UAAM,KAAK,GAAG,UAAU,OAAO,OAAO,CAAC,IAAI,UAAU,KAAK,IAAI,CAAC,EAAE;AAEjE,WAAO,MAAM,KAAK,GAAG;AAAA,EACvB,CAAC,EACA,KAAK;AAAA,EAAK,MAAM,EAAE,EAAE,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE;AAE3C,QAAM,eAAe,MAAM,QAAQ,WAAW,IAAI,CAAC,OAAO;AACxD,WAAO,UAAU,UAAU,SAAS,EAAE,CAAC;AAAA,EACzC,CAAC;AAED,QAAM,WAAW,GAAG,UAAU,UAAU,UAAU,SAAS,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,UAAU,QAAQ,KAAK,IAAI,IAAI,CAAC;AAC5G,QAAM,UAAU,GAAG,UAAU,OAAO,aAAa,CAAC,IAAI,YAAY,KAAK,GAAG,CAAC;AAC3E,QAAM,aAAa,GAAG,UAAU,OAAO,aAAa,CAAC,IAAI,eAAe;AACxE,QAAM,UAAU,GAAG,UAAU,OAAO,aAAa,CAAC,IAAI,aAAa,KAAK,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;AAEpG,QAAM,aAAa,QAAQ,OAAO,QAC9B,OAAO,QAAQ,OAAO,WAAW,EAAE,IACnC;AAEJ,QAAM,eAAe;AAAA,IACnB,CAAC,YAAY,QAAQ;AAAA,IACrB,CAAC,WAAW,OAAO;AAAA,IACnB,CAAC,cAAc,UAAU;AAAA,IACzB,CAAC,WAAW,OAAO;AAAA,EACrB;AAEA,QAAM,aAAa,CAAC,SAAiB;AACnC,UAAM,cAAc,aAAa,YAAY,IAAI;AACjD,WAAO,cAAc,IACjB;AAAA,MACE;AAAA,MACA;AAAA,QACE;AAAA,QACA,UAAU,QAAQ,MAAM,WAAW,EAAE,KAAK,MAAG,EAAE,KAAK,EAAE,CAAC;AAAA,MACzD;AAAA,IACF,EAAE,KAAK,EAAE,IACT;AAAA,EACN;AAEA,QAAM,QAAQ,aAAa;AAAA,IACzB,CAAC,KAAK,CAAC,KAAK,IAAI,MAAM;AACpB,UAAI,GAAG,IAAI,KAAK,MAAM,IAAI,EAAE,IAAI,UAAU,EAAE,KAAK,IAAI;AACrD,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM,OAAO,OAAO,KAAK,EAAE,KAAK,IAAI;AAAA,EACtC;AACF;AAEA,IAAM,WAAW,CAAC,OAAiB;AACjC,SAAO,GAAG,QAAQ,GAAG,SAAS,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,MAAM,GAAG,EAAE;AAC5D;;;AC5GO,IAAM,MAAW,CAAC,YAAY,YAAY;AAC/C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,YAAY,CAAC,UAAU,EAAE,KAAK;AAAA,IAC9B;AAAA,EACF;AACF;;;AFOO,IAAM,cAA2B,CAAC,YAAY;AACnD,SAAO,QAAQ;AAAA,IACb,IAAI,YAAY,SAAS;AACvB,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC;AAAA,MACF;AAAA,IACF;AAAA,IACA,KAAK,YAAY;AACf,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,QAAQ,YAAY;AAClB,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,IAAI,YAAY;AACd,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,KAAK,YAAY;AACf,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,IAAI,YAAY;AACd,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,MAAM,YAAY;AAChB,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,OAAO,YAAY;AACjB,aAAO;AAAA,QACL,MAAM;AAAA,QACN,YAAY,CAAC,UAAmB,EAAE,KAAK;AAAA,QACvC,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAEO,IAAM,eAAe,CAAC,YAA4B;AACvD,SAAO,IAAI,OAAO,OAAO;AAC3B;AAEO,IAAM,qBAAqB,CAChC,cACA;AAAA;AAAA,EAEE;AACF,MAGuB;AAEvB,QAAM,mBAA0C;AAAA,IAC9C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,QAA4B,CAAC;AAGnC,aAAW,EAAE,MAAM,MAAM,MAAM,GAAG,KAAK,KAAK,cAAc;AAExD,UAAM,kBAAkB;AAAA,MACtB,GAAG,KAAK;AAAA,MACR,GAAG,KAAK;AAAA,IACV,EAAE,KAAK;AAEP,UAAM,kBAA+C,gBAAgB;AAAA,MACnE,CAAC,MAAM,EAAE,SAAS;AAAA,IACpB;AAEA,UAAM,kBAA+C;AAAA,MACnD,GAAG,uBAAuB,KAAK,QAAQ,KAAK,aAAa;AAAA,MACzD,GAAG,2BAA2B,KAAK,iBAAiB;AAAA;AAAA,MAEpD,GAAG;AAAA;AAAA,MAEH,GAAG;AAAA,IACL;AAGA,UAAM,aAA8D;AAAA,MAClE,GAAG,iBAAiB,QAAQ,CAAC,SAAS;AACpC,cAAM,aAAa,gBAAgB;AAAA;AAAA;AAAA,UAGjC,CAAC,MAAM,EAAE,SAAS,SAAS;AAAA,QAC7B;AACA,eAAO,aACH,CAAC,UAAU,IACX,CAAC;AAAA,MACP,CAAC;AAAA,MAED,GAAG,eAAe,QAAQ,CAAC,UAAU;AACnC,YAAI,CAAC,MAAM,SAAS,MAAM;AAExB,iBAAO,CAAC,KAAK;AAAA,QACf;AACA,YAAI,iBAAiB,SAAS,MAAM,SAAS,IAAI,GAAG;AAElD,iBAAO,CAAC;AAAA,QACV;AACA,cAAM,WAAW,gBAAgB;AAAA;AAAA;AAAA,UAG/B,CAAC,MAAM,EAAE,SAAS,SAAS,MAAM,SAAS;AAAA,QAC5C;AACA,eAAO,CAAC,YAAY,KAAK;AAAA,MAC3B,CAAC;AAAA,MAED,GAAG,gBAAgB,QAAQ,CAAC,UAAU;AACpC,cAAM,OACJ,MAAM,SAAS,eACX,MAAM,SAAS,OACf;AAEN,YAAI,MAAM;AACR,cAAI,iBAAiB,SAAS,IAAI,GAAG;AAEnC,mBAAO,CAAC;AAAA,UACV;AACA,cAAI,eAAe,KAAK,CAAC,MAAM,EAAE,SAAS,SAAS,IAAI,GAAG;AAExD,mBAAO,CAAC;AAAA,UACV;AAAA,QACF;AAEA,eAAO,CAAC,KAAK;AAAA,MACf,CAAC;AAAA,IACH;AAEA,eAAW,SAAS,YAAY;AAC9B,UAAI,MAAM,SAAS,WAAW;AAC5B,cAAM,aAAa,WAAW,QAAQ,CAAC,MAAM;AAC3C,cAAI,EAAE,SAAS,cAAc;AAC3B,mBAAO,CAAC,EAAE,SAAS,MAAM,EAAE,QAAQ,GAAG,SAAS,MAAM,MAAM,IACvD,CAAC,CAAC,IACF,CAAC;AAAA,UACP;AACA,iBAAO,CAAC;AAAA,QACV,CAAC;AACD,cAAM,KAAK;AAAA,UACT;AAAA,UACA;AAAA,UACA;AAAA,UACA,SAAS,CAAC,MAAM,MAAM;AAAA,UACtB,YAAY;AAAA,YACV,GAAG,WAAW,QAAQ,CAAC,MAAM,EAAE,UAAU;AAAA,YACzC,GAAG,MAAM;AAAA,UACX;AAAA,UACA,OAAO,cAAgB;AAAA,YACrB;AAAA,YACA;AAAA,YACA;AAAA,YACA,SAAS,CAAC,MAAM,MAAM;AAAA,YACtB;AAAA,YACA,SAAS;AAAA,UACX,CAAC;AAAA,QACH,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAEA,IAAM,yBAAyB,CAC7B,QACA,kBACG;AAAA,EACH;AAAA,IACE,SAAS,UAAU,KAAK,MAAM;AAC5B,UAAI,cAAc,OAAO;AAAA,QACvB,CAAC,KAA8B,CAAC,MAAM,MAAM,MAAM;AAChD,gBAAM,QAAQ,IAAI,OAAO,IAAI;AAC7B,cAAI,OAAO;AACT,gBAAI,QAAQ;AACV,kBAAI,IAAI,IAAI,cAAc,SAAS,IAAI,IACnC,MAAM,MAAM,GAAG,EAAE,IAAI,MAAM,IAC3B,MAAM,MAAM,GAAG;AAAA,YACrB,OAAO;AACL,kBAAI,IAAI,IAAI,cAAc,SAAS,IAAI,IAAI,OAAO,KAAK,IAAI;AAAA,YAC7D;AAAA,UACF,OAAO;AACL,gBAAI,IAAI,IAAI;AAAA,UACd;AACA,iBAAO;AAAA,QACT;AAAA,QACA,CAAC;AAAA,MACH;AACA,aAAO,KAAK;AAAA,IACd;AAAA,IACA,EAAE,MAAM,SAAS;AAAA,EACnB;AACF;AAEA,IAAM,6BAA6B,CAAC,sBAAyC;AAAA,EAC3E;AAAA,IACE,SAAS,kBAAkB,KAAK,MAAM;AACpC,wBAAkB,QAAQ,SAAS,IAAI,WAAW;AAClD,aAAO,KAAK;AAAA,IACd;AAAA,IACA,EAAE,MAAM,iBAAiB;AAAA,EAC3B;AAAA,EAEA;AAAA,IACE,SAAS,mBAAmB,KAAK,MAAM;AACrC,wBAAkB,UAAU,IAAI,MAAM,GAAG,SAAS,IAAI,OAAO;AAC7D,aAAO,KAAK;AAAA,IACd;AAAA,IACA;AAAA,MACE,MAAM;AAAA,MACN,IAAI,OAAO,KAAK,kBAAkB,WAAW,CAAC,CAAC;AAAA,IACjD;AAAA,EACF;AAAA,EAEA;AAAA,IACE,eAAe,oBAAoB,KAAK,MAAM;AAC5C,UAAI,kBAAkB,WAAW,IAAI,MAAM,GAAG;AAC5C,cAAM,KAAK;AACX,0BAAkB,WAAW,IAAI,MAAM,GAAG,SAAS,IAAI,IAAI;AAAA,MAC7D,OAAO;AACL,eAAO,KAAK;AAAA,MACd;AAAA,IACF;AAAA,IACA;AAAA,MACE,MAAM;AAAA,MACN,IAAI,OAAO,KAAK,kBAAkB,YAAY,CAAC,CAAC;AAAA,IAClD;AAAA,EACF;AACF;;;AGpQO,IAAK,cAAL,kBAAKC,iBAAL;AACL,EAAAA,aAAA,UAAO;AACP,EAAAA,aAAA,aAAU;AACV,EAAAA,aAAA,SAAM;AACN,EAAAA,aAAA,SAAM;AACN,EAAAA,aAAA,WAAQ;AACR,EAAAA,aAAA,UAAO;AACP,EAAAA,aAAA,YAAS;AAPC,SAAAA;AAAA,GAAA;",
|
|
6
|
+
"names": ["obj", "middleware", "HTTPMethods"]
|
|
7
7
|
}
|
package/pkg/src/app.d.ts
CHANGED
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import Koa from "koa";
|
|
2
|
+
import type { AppOptions } from "./types";
|
|
3
|
+
export declare const createApp: (options?: AppOptions) => Koa<Koa.DefaultState, Koa.DefaultContext>;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ValidationErrorData, ValidationErrorEntry, ValidationErrorScope } from "../types";
|
|
2
2
|
/**
|
|
3
3
|
* Standardized error wrapper used by validation generators.
|
|
4
4
|
*
|
|
5
5
|
* Instances of this class are thrown whenever validation fails,
|
|
6
6
|
* carrying both the error scope (e.g. `"params"`, `"payload"`)
|
|
7
7
|
* and the list of validation error details.
|
|
8
|
-
*/
|
|
8
|
+
* */
|
|
9
9
|
export declare class ValidationError extends Error {
|
|
10
10
|
scope: ValidationErrorScope;
|
|
11
11
|
errors: Array<ValidationErrorEntry>;
|
|
@@ -16,4 +16,3 @@ export declare class ValidationError extends Error {
|
|
|
16
16
|
ValidationErrorData
|
|
17
17
|
]);
|
|
18
18
|
}
|
|
19
|
-
export declare const createErrorHandler: (handler: ParameterizedMiddleware) => ParameterizedMiddleware;
|
package/pkg/src/router.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import Router from "@koa/router";
|
|
2
|
+
import type { DefineRoute, MiddlewareDefinition, RouterOptions, RouterRoute, RouterRouteSource } from "./types";
|
|
3
3
|
export declare const defineRoute: DefineRoute;
|
|
4
|
-
export declare const
|
|
4
|
+
export declare const createRouter: (options?: RouterOptions) => Router<import("koa").DefaultState, import("koa").DefaultContext>;
|
|
5
|
+
export declare const createRouterRoutes: (routeSources: Array<RouterRouteSource>, { coreMiddleware, }: {
|
|
5
6
|
coreMiddleware: Array<MiddlewareDefinition>;
|
|
6
7
|
}) => Array<RouterRoute>;
|
package/pkg/src/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { RouterContext, RouterMiddleware
|
|
1
|
+
import type { RouterContext, RouterMiddleware } from "@koa/router";
|
|
2
2
|
import type { Next } from "koa";
|
|
3
3
|
declare module "koa" {
|
|
4
4
|
interface Request {
|
|
@@ -86,11 +86,8 @@ export type RouterRoute = {
|
|
|
86
86
|
import type Koa from "koa";
|
|
87
87
|
export type App = Koa<DefaultState, DefaultContext>;
|
|
88
88
|
export type AppOptions = ConstructorParameters<typeof import("koa")>[0];
|
|
89
|
-
export type
|
|
90
|
-
|
|
91
|
-
export type Router = KoaRouter<DefaultState, DefaultContext>;
|
|
92
|
-
export type { RouterOptions };
|
|
93
|
-
export type CreateRouter = (options?: RouterOptions) => Router;
|
|
89
|
+
export type Router = import("@koa/router").Router<DefaultState, DefaultContext>;
|
|
90
|
+
export type RouterOptions = import("@koa/router").RouterOptions;
|
|
94
91
|
export type DevMiddlewareFactory = (app: App) => (req: import("node:http").IncomingMessage, res: import("node:http").ServerResponse, next: () => Promise<void>) => Promise<void>;
|
|
95
92
|
export type TeardownHandler = (app: App) => void | Promise<void>;
|
|
96
93
|
export type ValidationSchema = {
|
package/pkg/test/index.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import Koa, { type Context, type Next } from "koa";
|
|
1
2
|
import { type MiddlewareDefinition, type RouterRouteSource } from "../src/types";
|
|
2
3
|
export declare const defaultMethods: string[];
|
|
3
4
|
export declare const middlewareStackBuilder: (a: Array<Partial<RouterRouteSource>>, b: {
|
|
4
5
|
coreMiddleware?: Array<MiddlewareDefinition>;
|
|
5
6
|
}) => import("../src/types").RouterRoute[];
|
|
7
|
+
export declare const runMiddleware: <T = any>(middleware: Array<(ctx: T, next: Next) => void | Promise<void>>, ctxOverrides?: Partial<Context>) => Promise<Koa.ParameterizedContext<Koa.DefaultState, Koa.DefaultContext, unknown>>;
|
|
File without changes
|
|
File without changes
|
|
File without changes
|