@kamaalio/hono-standard-openapi 0.0.17 → 0.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app.d.ts +26 -9
- package/dist/app.d.ts.map +1 -1
- package/dist/app.js +38 -6
- package/dist/app.js.map +1 -1
- package/dist/route.d.ts +25 -9
- package/dist/route.d.ts.map +1 -1
- package/dist/route.js.map +1 -1
- package/dist/type-inference.d.ts +44 -15
- package/dist/type-inference.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/app.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { type Hook } from '@hono/standard-validator';
|
|
2
|
-
import { type Env, Hono, type Schema } from 'hono';
|
|
2
|
+
import { type Env, Hono, type Schema, type ToSchema } from 'hono';
|
|
3
|
+
import type { MergePath, MergeSchemaPath } from 'hono/types';
|
|
3
4
|
import type { OpenAPIObject } from 'openapi3-ts/oas31';
|
|
4
5
|
import { type DocumentConfig, type GeneratorOptions } from './generator.ts';
|
|
5
6
|
import { OpenAPIRegistry } from './registry.ts';
|
|
6
|
-
import type { OpenAPIRoute, RouteConfig } from './route.ts';
|
|
7
|
-
import type { RouteHandler } from './type-inference.ts';
|
|
7
|
+
import type { OpenAPIRoute, RouteConfig, RouteHook } from './route.ts';
|
|
8
|
+
import type { RouteEnv, RouteHandler, RoutesToSchema, RouteToSchema } from './type-inference.ts';
|
|
8
9
|
import { PARAMETER_SOURCES } from './types.ts';
|
|
9
10
|
export interface StandardOpenAPIHonoOptions<E extends Env> {
|
|
10
11
|
/** Runs for every validation on this app, and on apps mounted under it that define none. */
|
|
@@ -23,19 +24,35 @@ type StandardOpenAPIHonoParent<E extends Env> = {
|
|
|
23
24
|
*/
|
|
24
25
|
export declare class StandardOpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
|
|
25
26
|
#private;
|
|
26
|
-
readonly openAPIRegistry: OpenAPIRegistry;
|
|
27
27
|
readonly defaultHook: StandardOpenAPIHonoOptions<E>['defaultHook'];
|
|
28
28
|
constructor(init?: HonoInit<E>);
|
|
29
|
+
/** Everything recorded for the document so far. Shared with apps derived by `basePath()`. */
|
|
30
|
+
get openAPIRegistry(): OpenAPIRegistry;
|
|
29
31
|
/** Registers a route: mounts it, validates its request, and records it in the document. */
|
|
30
|
-
openapi<R extends RouteConfig
|
|
31
|
-
/**
|
|
32
|
-
|
|
32
|
+
openapi<R extends RouteConfig>(route: R, handler: RouteHandler<R, RouteEnv<R['middleware'], E>>, hook?: RouteHook<R, E>): StandardOpenAPIHono<E, S & RouteToSchema<R, BasePath>, BasePath>;
|
|
33
|
+
/**
|
|
34
|
+
* Registers reusable route definitions, mounting and documenting each one.
|
|
35
|
+
*
|
|
36
|
+
* The configs are inferred as a tuple and each entry is checked against its own route, so a
|
|
37
|
+
* handler still sees exactly the request and responses its own route declares.
|
|
38
|
+
*/
|
|
39
|
+
openapiRoutes<const Configs extends readonly RouteConfig[]>(routes: {
|
|
40
|
+
readonly [K in keyof Configs]: OpenAPIRoute<E, Configs[K]>;
|
|
41
|
+
}): StandardOpenAPIHono<E, S & RoutesToSchema<Configs, BasePath>, BasePath>;
|
|
33
42
|
/** Mounts another app, taking its documented routes along with its handlers. */
|
|
34
|
-
route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>):
|
|
43
|
+
route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>): StandardOpenAPIHono<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> & S, BasePath>;
|
|
44
|
+
/**
|
|
45
|
+
* Narrows the app to a path prefix, the way Hono's own `basePath` does.
|
|
46
|
+
*
|
|
47
|
+
* Hono clones into a plain `Hono`, which would drop both the registry and `openapi()`, so the
|
|
48
|
+
* derived app is rebuilt here. It shares the router, the routes and the registry, so either app
|
|
49
|
+
* serves and documents the whole surface.
|
|
50
|
+
*/
|
|
51
|
+
basePath<SubPath extends string>(path: SubPath): StandardOpenAPIHono<E, S, MergePath<BasePath, SubPath>>;
|
|
35
52
|
/** Builds the document for everything registered so far. */
|
|
36
53
|
getOpenAPIDocument(config: DocumentConfig, generatorConfig?: GeneratorOptions): OpenAPIObject;
|
|
37
54
|
/** Serves the document as JSON at `path`. */
|
|
38
|
-
doc(path:
|
|
55
|
+
doc<P extends string>(path: P, config: DocumentConfig, generatorConfig?: GeneratorOptions): StandardOpenAPIHono<E, S & ToSchema<'get', MergePath<BasePath, P>, {}, {}>, BasePath>;
|
|
39
56
|
/** The nearest hook, preferring this app's own and falling back to the app it is mounted under. */
|
|
40
57
|
getDefaultHook(visited?: Set<StandardOpenAPIHonoParent<E>>): Hook<unknown, E, string> | undefined;
|
|
41
58
|
}
|
package/dist/app.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAc,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,KAAK,GAAG,EAAE,IAAI,
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAc,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,KAAK,GAAG,EAAE,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAA0B,MAAM,MAAM,CAAC;AAC1F,OAAO,KAAK,EAAc,SAAS,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,gBAAgB,EAAoB,MAAM,gBAAgB,CAAC;AAC9F,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAuB,MAAM,YAAY,CAAC;AAE5F,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjG,OAAO,EAAsB,iBAAiB,EAAqB,MAAM,YAAY,CAAC;AAEtF,MAAM,WAAW,0BAA0B,CAAC,CAAC,SAAS,GAAG;IACvD,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;CACjD;AAED,KAAK,QAAQ,CAAC,CAAC,SAAS,GAAG,IAAI,qBAAqB,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,CAAC;AAErG,0FAA0F;AAC1F,KAAK,yBAAyB,CAAC,CAAC,SAAS,GAAG,IAAI;IAC9C,cAAc,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACnG,CAAC;AAMF;;;;;GAKG;AACH,qBAAa,mBAAmB,CAC9B,CAAC,SAAS,GAAG,GAAG,GAAG,EACnB,CAAC,SAAS,MAAM,GAAG,EAAE,EACrB,QAAQ,SAAS,MAAM,GAAG,GAAG,CAC7B,SAAQ,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;;IAC5B,QAAQ,CAAC,WAAW,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAKnE,YAAY,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAI7B;IAED,6FAA6F;IAC7F,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,2FAA2F;IAC3F,OAAO,CAAC,CAAC,SAAS,WAAW,EAC3B,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EACtD,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GACrB,mBAAmB,CAAC,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CA2BlE;IAED;;;;;OAKG;IACH,aAAa,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,WAAW,EAAE,EAAE,MAAM,EAAE;QAClE,QAAQ,EAAE,CAAC,IAAI,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;KAC3D,GAAG,mBAAmB,CAAC,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAM1E;IAED,gFAAgF;IAChF,KAAK,CAAC,OAAO,SAAS,MAAM,EAAE,MAAM,SAAS,GAAG,EAAE,SAAS,SAAS,MAAM,EAAE,WAAW,SAAS,MAAM,EACpG,IAAI,EAAE,OAAO,EACb,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC,GACxC,mBAAmB,CAAC,CAAC,EAAE,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAUhG;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,SAAS,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAavG;IAMD,4DAA4D;IAC5D,kBAAkB,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,GAAE,gBAAqB,GAAG,aAAa,CAEhG;IAED,6CAA6C;IAC7C,GAAG,CAAC,CAAC,SAAS,MAAM,EAClB,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,cAAc,EACtB,eAAe,GAAE,gBAAqB,GACrC,mBAAmB,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAIvF;IAED,mGAAmG;IACnG,cAAc,CAAC,OAAO,GAAE,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAa,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAY3G;CA2BF;AAsFD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,IACrC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE7F,yEAAyE;AACzE,wBAAgB,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,MAAM,EAAE,QAAQ,SAAS,MAAM,EACxE,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,GACxB,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAMrC;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
|
package/dist/app.js
CHANGED
|
@@ -14,19 +14,24 @@ const FORM_CONTENT_TYPES = ['multipart/form-data', 'application/x-www-form-urlen
|
|
|
14
14
|
* document can never drift from what the server actually accepts.
|
|
15
15
|
*/
|
|
16
16
|
export class StandardOpenAPIHono extends Hono {
|
|
17
|
-
openAPIRegistry;
|
|
18
17
|
defaultHook;
|
|
18
|
+
#registry;
|
|
19
19
|
#parentApp;
|
|
20
|
+
#routePrefix = '/';
|
|
20
21
|
constructor(init) {
|
|
21
22
|
super(init);
|
|
22
|
-
this
|
|
23
|
+
this.#registry = new OpenAPIRegistry();
|
|
23
24
|
this.defaultHook = init?.defaultHook;
|
|
24
25
|
}
|
|
26
|
+
/** Everything recorded for the document so far. Shared with apps derived by `basePath()`. */
|
|
27
|
+
get openAPIRegistry() {
|
|
28
|
+
return this.#registry;
|
|
29
|
+
}
|
|
25
30
|
/** Registers a route: mounts it, validates its request, and records it in the document. */
|
|
26
31
|
openapi(route, handler, hook) {
|
|
27
32
|
const { hide, middleware, ...documented } = route;
|
|
28
33
|
if (hide !== true) {
|
|
29
|
-
this.openAPIRegistry.registerPath(documented);
|
|
34
|
+
this.openAPIRegistry.registerPath({ ...documented, path: this.#documentPath(route.path) });
|
|
30
35
|
}
|
|
31
36
|
const effectiveHook = (result, c) => {
|
|
32
37
|
const resolved = hook ?? this.getDefaultHook();
|
|
@@ -43,7 +48,12 @@ export class StandardOpenAPIHono extends Hono {
|
|
|
43
48
|
this.on(methods, paths, handler);
|
|
44
49
|
return this;
|
|
45
50
|
}
|
|
46
|
-
/**
|
|
51
|
+
/**
|
|
52
|
+
* Registers reusable route definitions, mounting and documenting each one.
|
|
53
|
+
*
|
|
54
|
+
* The configs are inferred as a tuple and each entry is checked against its own route, so a
|
|
55
|
+
* handler still sees exactly the request and responses its own route declares.
|
|
56
|
+
*/
|
|
47
57
|
openapiRoutes(routes) {
|
|
48
58
|
for (const { route, handler, hook } of routes) {
|
|
49
59
|
this.openapi(route, handler, hook);
|
|
@@ -60,6 +70,28 @@ export class StandardOpenAPIHono extends Hono {
|
|
|
60
70
|
}
|
|
61
71
|
return this;
|
|
62
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* Narrows the app to a path prefix, the way Hono's own `basePath` does.
|
|
75
|
+
*
|
|
76
|
+
* Hono clones into a plain `Hono`, which would drop both the registry and `openapi()`, so the
|
|
77
|
+
* derived app is rebuilt here. It shares the router, the routes and the registry, so either app
|
|
78
|
+
* serves and documents the whole surface.
|
|
79
|
+
*/
|
|
80
|
+
basePath(path) {
|
|
81
|
+
const cloned = super.basePath(path);
|
|
82
|
+
const derived = new StandardOpenAPIHono({ defaultHook: this.defaultHook });
|
|
83
|
+
const prefix = mergePath(this.#routePrefix, path);
|
|
84
|
+
derived.#registry = this.#registry;
|
|
85
|
+
derived.#parentApp = this;
|
|
86
|
+
derived.#routePrefix = prefix;
|
|
87
|
+
derived.router = cloned.router;
|
|
88
|
+
derived.routes = cloned.routes;
|
|
89
|
+
Object.assign(derived, { _basePath: prefix, getPath: cloned.getPath });
|
|
90
|
+
return derived;
|
|
91
|
+
}
|
|
92
|
+
#documentPath(path) {
|
|
93
|
+
return mergePath(this.#routePrefix.replaceAll(/:([^/]+)/g, '{$1}'), path);
|
|
94
|
+
}
|
|
63
95
|
/** Builds the document for everything registered so far. */
|
|
64
96
|
getOpenAPIDocument(config, generatorConfig = {}) {
|
|
65
97
|
return new OpenAPIGenerator(this.openAPIRegistry, generatorConfig).generateDocument(config);
|
|
@@ -142,14 +174,14 @@ function skipWhenBodyAbsent(validator, mediaType, target) {
|
|
|
142
174
|
return undefined;
|
|
143
175
|
};
|
|
144
176
|
}
|
|
145
|
-
function
|
|
177
|
+
function isSingleMiddleware(value) {
|
|
146
178
|
return !Array.isArray(value);
|
|
147
179
|
}
|
|
148
180
|
function normalizeMiddleware(middleware) {
|
|
149
181
|
if (middleware == null) {
|
|
150
182
|
return [];
|
|
151
183
|
}
|
|
152
|
-
if (
|
|
184
|
+
if (isSingleMiddleware(middleware)) {
|
|
153
185
|
return [middleware];
|
|
154
186
|
}
|
|
155
187
|
return [...middleware];
|
package/dist/app.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAY,IAAI,
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAY,IAAI,EAAsD,MAAM,MAAM,CAAC;AAE1F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,OAAO,EAA8C,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC9F,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAsB,iBAAiB,EAAqB,MAAM,YAAY,CAAC;AActF,MAAM,iBAAiB,GAAG,kCAAkC,CAAC;AAE7D,MAAM,kBAAkB,GAAG,CAAC,qBAAqB,EAAE,mCAAmC,CAAC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,OAAO,mBAIX,SAAQ,IAAoB;IACnB,WAAW,CAA+C;IACnE,SAAS,CAAkB;IAC3B,UAAU,CAA4C;IACtD,YAAY,GAAG,GAAG,CAAC;IAEnB,YAAY,IAAkB;QAC5B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,CAAC;IACvC,CAAC;IAED,6FAA6F;IAC7F,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,2FAA2F;IAC3F,OAAO,CACL,KAAQ,EACR,OAAsD,EACtD,IAAsB;QAEtB,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC;QAElD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,aAAa,GAA6B,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5D,MAAM,QAAQ,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAE/C,OAAO,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1C,KAAK,MAAM,iBAAiB,IAAI,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;QAC7C,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC;YAC5E,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAEjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAA+C,MAE3D;QACC,KAAK,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;YAC9C,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gFAAgF;IAChF,KAAK,CACH,IAAa,EACb,GAAyC;QAEzC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEvB,IAAI,GAAG,YAAY,mBAAmB,EAAE,CAAC;YACvC,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC;YACxB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YACpD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAyB,IAAa;QAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAqC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/G,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAElD,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAC1B,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC;QAC9B,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC/B,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAEvE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CAAC,IAAY;QACxB,OAAO,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;IAED,4DAA4D;IAC5D,kBAAkB,CAAC,MAAsB,EAAE,eAAe,GAAqB,EAAE;QAC/E,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC9F,CAAC;IAED,6CAA6C;IAC7C,GAAG,CACD,IAAO,EACP,MAAsB,EACtB,eAAe,GAAqB,EAAE;QAEtC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mGAAmG;IACnG,cAAc,CAAC,OAAO,GAAsC,IAAI,GAAG,EAAE;QACnE,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAED,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,OAAO,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB,CAAC,OAAiC,EAAE,IAA8B;QAChF,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAyB,EAAE,CAAC;QAE5C,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;YAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAE5B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAE1B,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACjB,UAAU,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAED,MAAM,eAAe,GAAG;IACtB,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;IACjC,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;IAClC,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE;IACpC,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE;CACsD,CAAC;AAE7F,SAAS,mBAAmB,CAC1B,OAAsB,EACtB,QAAiB,EACjB,IAA8B;IAE9B,MAAM,UAAU,GAAyB,EAAE,CAAC;IAE5C,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAE5B,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC9C,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnE,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACnD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CACzB,SAA6B,EAC7B,SAAiB,EACjB,MAAuB;IAEvB,OAAO,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;QACvB,MAAM,WAAW,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEjD,IAAI,WAAW,IAAI,IAAI,IAAI,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;YAChF,OAAO,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEnC,MAAM,IAAI,EAAE,CAAC;QAEb,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,KAA0B;IACpD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,mBAAmB,CAAC,UAAqC;IAChE,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QACnC,OAAO,CAAC,UAAU,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAWD,yEAAyE;AACzE,MAAM,UAAU,CAAC,CACf,GAAyB;IAEzB,IAAI,CAAC,CAAC,GAAG,YAAY,mBAAmB,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,SAAS,CAAC,kEAAkE,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
|
package/dist/route.d.ts
CHANGED
|
@@ -1,18 +1,34 @@
|
|
|
1
1
|
import type { Hook } from '@hono/standard-validator';
|
|
2
|
-
import type { Env,
|
|
3
|
-
import type {
|
|
2
|
+
import type { Env, ValidationTargets } from 'hono';
|
|
3
|
+
import type { H } from 'hono/types';
|
|
4
|
+
import type { ConvertPathType, RouteConfigToTypedResponse, RouteEnv, RouteHandler } from './type-inference.ts';
|
|
4
5
|
import type { RouteConfigBase } from './types.ts';
|
|
5
|
-
|
|
6
|
+
/**
|
|
7
|
+
* Middleware attached to a single route.
|
|
8
|
+
*
|
|
9
|
+
* Deliberately not tied to the app's own environment: a route may bring middleware that declares
|
|
10
|
+
* variables the app knows nothing about, and {@link RouteEnv} widens the handler to match.
|
|
11
|
+
*/
|
|
12
|
+
export type RouteMiddlewareList = H | readonly H[];
|
|
13
|
+
export interface RouteConfig extends RouteConfigBase {
|
|
6
14
|
/** Middleware to run before this route's validators and handler. */
|
|
7
|
-
readonly middleware?:
|
|
15
|
+
readonly middleware?: RouteMiddlewareList | undefined;
|
|
8
16
|
/** Keeps the route out of the generated document while still serving it. */
|
|
9
17
|
readonly hide?: boolean | undefined;
|
|
10
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* A hook for one route's validation.
|
|
21
|
+
*
|
|
22
|
+
* The return type is the route's own: a hook that answers early may only answer with a response the
|
|
23
|
+
* route documents. `data` stays wide because the hook runs once per validated target, so its value
|
|
24
|
+
* is whichever part is being validated, not the whole request.
|
|
25
|
+
*/
|
|
26
|
+
export type RouteHook<R extends RouteConfigBase, E extends Env = Env> = Hook<unknown, E, ConvertPathType<R['path']>, keyof ValidationTargets, RouteConfigToTypedResponse<R> | Response | void | Promise<RouteConfigToTypedResponse<R> | Response | void>>;
|
|
11
27
|
/** A route and the functions that register it with {@link StandardOpenAPIHono.openapi}. */
|
|
12
|
-
export interface OpenAPIRoute<E extends Env = Env, R extends RouteConfig
|
|
28
|
+
export interface OpenAPIRoute<E extends Env = Env, R extends RouteConfig = RouteConfig> {
|
|
13
29
|
readonly route: R;
|
|
14
|
-
readonly handler: RouteHandler<R, E
|
|
15
|
-
readonly hook?:
|
|
30
|
+
readonly handler: RouteHandler<R, RouteEnv<R['middleware'], E>>;
|
|
31
|
+
readonly hook?: RouteHook<R, E> | undefined;
|
|
16
32
|
}
|
|
17
33
|
/**
|
|
18
34
|
* Bundles a route with its typed handler and optional validation hook for reuse across modules.
|
|
@@ -20,7 +36,7 @@ export interface OpenAPIRoute<E extends Env = Env, R extends RouteConfig<E> = Ro
|
|
|
20
36
|
* The definition is returned unchanged; register it with
|
|
21
37
|
* `app.openapi(definition.route, definition.handler, definition.hook)`.
|
|
22
38
|
*/
|
|
23
|
-
export declare function defineOpenAPIRoute<E extends Env = Env, R extends RouteConfig
|
|
39
|
+
export declare function defineOpenAPIRoute<E extends Env = Env, R extends RouteConfig = RouteConfig>(definition: OpenAPIRoute<E, R>): OpenAPIRoute<E, R>;
|
|
24
40
|
/**
|
|
25
41
|
* Describes a route once, for both the router and the document.
|
|
26
42
|
*
|
|
@@ -31,7 +47,7 @@ export declare function defineOpenAPIRoute<E extends Env = Env, R extends RouteC
|
|
|
31
47
|
export declare function createRoute<P extends string, R extends Omit<RouteConfig, 'path'> & {
|
|
32
48
|
path: P;
|
|
33
49
|
}>(routeConfig: R): R & {
|
|
34
|
-
getRoutingPath(): ConvertPathType<
|
|
50
|
+
getRoutingPath(): ConvertPathType<R['path']>;
|
|
35
51
|
};
|
|
36
52
|
/** Rewrites `/cards/{cardId}` as `/cards/:cardId`, the same rewrite `ConvertPathType` describes. */
|
|
37
53
|
export declare function toRoutingPath<P extends string>(path: P): ConvertPathType<P>;
|
package/dist/route.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"route.d.ts","sourceRoot":"","sources":["../src/route.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"route.d.ts","sourceRoot":"","sources":["../src/route.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AACnD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,KAAK,EAAE,eAAe,EAAE,0BAA0B,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/G,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;AAEnD,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,oEAAoE;IACpE,QAAQ,CAAC,UAAU,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IACtD,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,IAAI,CAC1E,OAAO,EACP,CAAC,EACD,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAC1B,MAAM,iBAAiB,EACvB,0BAA0B,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,CAC3G,CAAC;AAEF,2FAA2F;AAC3F,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW;IACpF,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChE,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;CAC7C;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EACzF,UAAU,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpB;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,EAC7F,WAAW,EAAE,CAAC,GACb,CAAC,GAAG;IAAE,cAAc,IAAI,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;CAAE,CAOtD;AAED,oGAAoG;AACpG,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC"}
|
package/dist/route.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"route.js","sourceRoot":"","sources":["../src/route.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"route.js","sourceRoot":"","sources":["../src/route.ts"],"names":[],"mappings":"AA4CA;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,UAA8B;IAE9B,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,WAAc;IAEd,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,EAAE,GAAG,WAAW,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;IAEpE,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IAEtE,OAAO,KAAK,CAAC;AACf,CAAC;AAID,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC"}
|
package/dist/type-inference.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
2
|
-
import type { Env, Handler, MiddlewareHandler, TypedResponse, ValidationTargets } from 'hono';
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
2
|
+
import type { Env, Handler, Input, MiddlewareHandler, ToSchema, TypedResponse, ValidationTargets } from 'hono';
|
|
3
|
+
import type { MergePath } from 'hono/types';
|
|
4
|
+
import type { ClientErrorStatusCode, InfoStatusCode, RedirectStatusCode, ServerErrorStatusCode, StatusCode, SuccessStatusCode } from 'hono/utils/http-status';
|
|
5
|
+
import type { ContentObject, RouteConfigBase } from './types.ts';
|
|
5
6
|
type HasUndefined<T> = undefined extends T ? true : false;
|
|
6
7
|
/** Rewrites OpenAPI's `/users/{id}` into the `/users/:id` Hono routes with. */
|
|
7
8
|
export type ConvertPathType<T extends string> = T extends `${infer Start}/{${infer Param}}${infer Rest}` ? `${Start}/:${Param}${ConvertPathType<Rest>}` : T;
|
|
@@ -50,29 +51,57 @@ type InputTypeBody<R extends RouteConfigBase, MediaType, Target extends 'json' |
|
|
|
50
51
|
} : {};
|
|
51
52
|
/** Everything a handler can read off the request, derived from the route's schemas. */
|
|
52
53
|
export type ComputeInput<R extends RouteConfigBase> = InputTypeBase<R, 'params', 'param'> & InputTypeBase<R, 'query', 'query'> & InputTypeBase<R, 'headers', 'header'> & InputTypeBase<R, 'cookies', 'cookie'> & InputTypeBody<R, JsonMediaType<RequestContent<R>>, 'json'> & InputTypeBody<R, FormMediaType<RequestContent<R>>, 'form'>;
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
54
|
+
type StatusCodeRanges = {
|
|
55
|
+
'1XX': InfoStatusCode;
|
|
56
|
+
'2XX': SuccessStatusCode;
|
|
57
|
+
'3XX': RedirectStatusCode;
|
|
58
|
+
'4XX': ClientErrorStatusCode;
|
|
59
|
+
'5XX': ServerErrorStatusCode;
|
|
60
|
+
};
|
|
61
|
+
type StatusFrom<Key> = Key extends keyof StatusCodeRanges ? StatusCodeRanges[Key] : Key extends StatusCode ? Key : Key extends `${infer Status extends number}` ? Status extends StatusCode ? Status : never : never;
|
|
59
62
|
type ResponseBody<ResponseEntry, MediaType> = MediaType extends keyof ResponseEntry ? ResponseEntry[MediaType] extends {
|
|
60
63
|
schema: infer Schema extends StandardSchemaV1;
|
|
61
64
|
} ? StandardSchemaV1.InferOutput<Schema> : never : never;
|
|
62
65
|
type TypedResponseFor<ResponseEntry, Status extends StatusCode> = ResponseEntry extends {
|
|
63
66
|
content: infer Content;
|
|
64
67
|
} ? JsonMediaType<Content> extends never ? Response & TypedResponse<unknown, Status, 'text'> : [ResponseBody<Content, JsonMediaType<Content>>] extends [infer Body] ? [Body] extends [never] ? Response & TypedResponse<unknown, Status, 'json'> : Response & TypedResponse<Body, Status, 'json'> : never : Response & TypedResponse<unknown, Status, 'text'>;
|
|
68
|
+
type StatusKeys<R extends RouteConfigBase> = {
|
|
69
|
+
[Key in keyof R['responses']]: [StatusFrom<Key>] extends [never] ? never : Key;
|
|
70
|
+
}[keyof R['responses']];
|
|
65
71
|
/** The responses a handler is allowed to return, one per documented status code. */
|
|
66
72
|
export type RouteConfigToTypedResponse<R extends RouteConfigBase> = {
|
|
67
|
-
[Key in keyof R['responses']]: TypedResponseFor<R['responses'][Key], StatusFrom<Key>>;
|
|
68
|
-
}[keyof R['responses']];
|
|
73
|
+
[Key in StatusKeys<R> & keyof R['responses']]: TypedResponseFor<R['responses'][Key], Extract<StatusFrom<Key>, StatusCode>>;
|
|
74
|
+
}[StatusKeys<R> & keyof R['responses']] | ('default' extends keyof R['responses'] ? TypedResponseFor<R['responses']['default'], Exclude<StatusCode, Extract<StatusFrom<keyof R['responses']>, StatusCode>>> : never);
|
|
75
|
+
type PinsResponseContent<R extends RouteConfigBase> = {
|
|
76
|
+
[Key in keyof R['responses']]: R['responses'][Key] extends {
|
|
77
|
+
content: ContentObject;
|
|
78
|
+
} ? true : false;
|
|
79
|
+
}[keyof R['responses']] extends true ? true : false;
|
|
69
80
|
/**
|
|
70
|
-
* What a handler may return:
|
|
71
|
-
*
|
|
72
|
-
*
|
|
81
|
+
* What a handler may return: the response typed against the route's own documented schemas, plus a
|
|
82
|
+
* plain `Response` it built itself when the route leaves any response undocumented. Hono accepts a
|
|
83
|
+
* raw `Response` from any handler, so the looser arm only ever loses precision — it is dropped once
|
|
84
|
+
* the route has pinned every response.
|
|
73
85
|
*/
|
|
74
|
-
export type RouteHandlerResponse<R extends RouteConfigBase> = RouteConfigToTypedResponse<R> | Promise<RouteConfigToTypedResponse<R>> | Response | Promise<Response>;
|
|
86
|
+
export type RouteHandlerResponse<R extends RouteConfigBase> = PinsResponseContent<R> extends true ? RouteConfigToTypedResponse<R> | Promise<RouteConfigToTypedResponse<R>> : RouteConfigToTypedResponse<R> | Promise<RouteConfigToTypedResponse<R>> | Response | Promise<Response>;
|
|
75
87
|
export type RouteHandler<R extends RouteConfigBase, E extends Env = Env> = Handler<E, ConvertPathType<R['path']>, ComputeInput<R>, RouteHandlerResponse<R>>;
|
|
88
|
+
type UnionToIntersection<U> = (U extends unknown ? (value: U) => void : never) extends (value: infer I) => void ? I : never;
|
|
89
|
+
type EnvOf<M> = M extends MiddlewareHandler<infer HandlerEnv, string, Input> ? HandlerEnv : never;
|
|
90
|
+
type EnvsOf<M> = M extends readonly unknown[] ? EnvOf<M[number]> : EnvOf<M>;
|
|
91
|
+
/**
|
|
92
|
+
* The environment a route's own middleware adds to its handler.
|
|
93
|
+
*
|
|
94
|
+
* Each middleware contributes its own bindings and variables, so several of them intersect. A route
|
|
95
|
+
* with no middleware adds nothing, which has to be `{}` rather than `never` — intersecting `never`
|
|
96
|
+
* would erase the app's own environment.
|
|
97
|
+
*/
|
|
98
|
+
export type MiddlewareEnv<M> = [EnvsOf<M>] extends [never] ? {} : UnionToIntersection<EnvsOf<M>>;
|
|
99
|
+
/** The environment a route's handler runs in: the app's, widened by the route's own middleware. */
|
|
100
|
+
export type RouteEnv<M, E extends Env> = E & MiddlewareEnv<M>;
|
|
76
101
|
export type RouteMiddleware<E extends Env = Env> = MiddlewareHandler<E> | readonly MiddlewareHandler<E>[];
|
|
102
|
+
/** The Hono schema entry one route contributes, which is what types an RPC client. */
|
|
103
|
+
export type RouteToSchema<R extends RouteConfigBase, BasePath extends string> = ToSchema<R['method'], MergePath<BasePath, ConvertPathType<R['path']>>, ComputeInput<R>, RouteConfigToTypedResponse<R>>;
|
|
104
|
+
/** The schema entries a tuple of routes contributes, in order. */
|
|
105
|
+
export type RoutesToSchema<Configs extends readonly RouteConfigBase[], BasePath extends string> = Configs extends readonly [infer Head, ...infer Tail] ? Head extends RouteConfigBase ? RouteToSchema<Head, BasePath> & RoutesToSchema<Tail extends readonly RouteConfigBase[] ? Tail : [], BasePath> : {} : {};
|
|
77
106
|
export {};
|
|
78
107
|
//# sourceMappingURL=type-inference.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"type-inference.d.ts","sourceRoot":"","sources":["../src/type-inference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"type-inference.d.ts","sourceRoot":"","sources":["../src/type-inference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAC/G,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EAClB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEjE,KAAK,YAAY,CAAC,CAAC,IAAI,SAAS,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1D,+EAA+E;AAC/E,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,KAAK,KAAK,MAAM,KAAK,IAAI,MAAM,IAAI,EAAE,GACpG,GAAG,KAAK,KAAK,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,GAC5C,CAAC,CAAC;AAEN,KAAK,WAAW,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,SAAS,MAAM,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,OAAO,CAAA;CAAE,GACnG,IAAI,SAAS,MAAM,OAAO,GACxB,OAAO,CAAC,IAAI,CAAC,GACb,KAAK,GACP,KAAK,CAAC;AAEV,KAAK,aAAa,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,iBAAiB,IAAI;IACzG,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC;CACrB,SAAS,CAAC,KAAK,CAAC,GACb,EAAE,GACF,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,MAAM,MAAM,SAAS,gBAAgB,GAChE;IACE,EAAE,EAAE;SACD,CAAC,IAAI,IAAI,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GACxD;aAAG,EAAE,IAAI,MAAM,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;SAAE,GAC/F;aAAG,EAAE,IAAI,MAAM,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;SAAE;KACnG,CAAC;IACF,GAAG,EAAE;SAAG,CAAC,IAAI,IAAI,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC;KAAE,CAAC;CAC5D,GACD,EAAE,CAAC;AAET,KAAK,cAAc,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,OAAO,EAAE,MAAM,OAAO,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACxG,OAAO,GACP,KAAK,CAAC;AAEV,KAAK,aAAa,CAAC,OAAO,IAAI;KAC3B,CAAC,IAAI,MAAM,OAAO,GAAG,CAAC,SAAS,eAAe,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK;CACxE,CAAC,MAAM,OAAO,CAAC,CAAC;AAEjB,KAAK,aAAa,CAAC,OAAO,IAAI;KAC3B,CAAC,IAAI,MAAM,OAAO,GAAG,CAAC,SAAS,qBAAqB,GAAG,mCAAmC,GAAG,CAAC,GAAG,KAAK;CACxG,CAAC,MAAM,OAAO,CAAC,CAAC;AAEjB,KAAK,UAAU,CAAC,OAAO,EAAE,SAAS,IAAI,SAAS,SAAS,MAAM,OAAO,GACjE,OAAO,CAAC,SAAS,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,gBAAgB,CAAA;CAAE,GAC1E,MAAM,GACN,KAAK,GACP,KAAK,CAAC;AAEV,KAAK,aAAa,CAAC,CAAC,SAAS,eAAe,EAAE,SAAS,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;IACzF,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;CACzC,SAAS,CAAC,KAAK,CAAC,GACb,EAAE,GACF,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,SAAS,MAAM,MAAM,SAAS,gBAAgB,GACpF;IACE,EAAE,EAAE;SAAG,CAAC,IAAI,MAAM,GAAG,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC;KAAE,CAAC;IAC3D,GAAG,EAAE;SAAG,CAAC,IAAI,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC;KAAE,CAAC;CAC9D,GACD,EAAE,CAAC;AAET,uFAAuF;AACvF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,eAAe,IAAI,aAAa,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,GACvF,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAClC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,GACrC,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,GACrC,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAC1D,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE7D,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,KAAK,EAAE,iBAAiB,CAAC;IACzB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,qBAAqB,CAAC;IAC7B,KAAK,EAAE,qBAAqB,CAAC;CAC9B,CAAC;AAEF,KAAK,UAAU,CAAC,GAAG,IAAI,GAAG,SAAS,MAAM,gBAAgB,GACrD,gBAAgB,CAAC,GAAG,CAAC,GACrB,GAAG,SAAS,UAAU,GACpB,GAAG,GACH,GAAG,SAAS,GAAG,MAAM,MAAM,SAAS,MAAM,EAAE,GAC1C,MAAM,SAAS,UAAU,GACvB,MAAM,GACN,KAAK,GACP,KAAK,CAAC;AAEd,KAAK,YAAY,CAAC,aAAa,EAAE,SAAS,IAAI,SAAS,SAAS,MAAM,aAAa,GAC/E,aAAa,CAAC,SAAS,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,gBAAgB,CAAA;CAAE,GAChF,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,GACpC,KAAK,GACP,KAAK,CAAC;AAEV,KAAK,gBAAgB,CAAC,aAAa,EAAE,MAAM,SAAS,UAAU,IAAI,aAAa,SAAS;IAAE,OAAO,EAAE,MAAM,OAAO,CAAA;CAAE,GAC9G,aAAa,CAAC,OAAO,CAAC,SAAS,KAAK,GAClC,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,GACjD,CAAC,YAAY,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,GAClE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GACpB,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,GACjD,QAAQ,GAAG,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,GAChD,KAAK,GACT,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtD,KAAK,UAAU,CAAC,CAAC,SAAS,eAAe,IAAI;KAC1C,GAAG,IAAI,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,GAAG;CAC/E,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAExB,oFAAoF;AACpF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,eAAe,IAC5D;KACG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAC7D,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EACnB,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CACrC;CACF,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,GACvC,CAAC,SAAS,SAAS,MAAM,CAAC,CAAC,WAAW,CAAC,GACnC,gBAAgB,CACd,CAAC,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,EACzB,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAC3E,GACD,KAAK,CAAC,CAAC;AAEf,KAAK,mBAAmB,CAAC,CAAC,SAAS,eAAe,IAAI;KACnD,GAAG,IAAI,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,SAAS;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,GAAG,IAAI,GAAG,KAAK;CACrG,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,SAAS,IAAI,GAChC,IAAI,GACJ,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,eAAe,IACxD,mBAAmB,CAAC,CAAC,CAAC,SAAS,IAAI,GAC/B,0BAA0B,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,GACtE,0BAA0B,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE5G,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,OAAO,CAChF,CAAC,EACD,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAC1B,YAAY,CAAC,CAAC,CAAC,EACf,oBAAoB,CAAC,CAAC,CAAC,CACxB,CAAC;AAEF,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,GAC3G,CAAC,GACD,KAAK,CAAC;AAEV,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,UAAU,GAAG,KAAK,CAAC;AAElG,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjG,mGAAmG;AACnG,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAE9D,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,iBAAiB,CAAC,CAAC,CAAC,GAAG,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;AAE1G,sFAAsF;AACtF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,eAAe,EAAE,QAAQ,SAAS,MAAM,IAAI,QAAQ,CACtF,CAAC,CAAC,QAAQ,CAAC,EACX,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAC/C,YAAY,CAAC,CAAC,CAAC,EACf,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,cAAc,CACxB,OAAO,SAAS,SAAS,eAAe,EAAE,EAC1C,QAAQ,SAAS,MAAM,IACrB,OAAO,SAAS,SAAS,CAAC,MAAM,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,GACpD,IAAI,SAAS,eAAe,GAC1B,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,cAAc,CAAC,IAAI,SAAS,SAAS,eAAe,EAAE,GAAG,IAAI,GAAG,EAAE,EAAE,QAAQ,CAAC,GAC7G,EAAE,GACJ,EAAE,CAAC"}
|