🎉 feat: beta.2

Author: SaltyAom

CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.2.0-beta.2 - 22 Jan 2023
+Feature:
+- Add support for custom openapi field using `schema.detail`
+- Add support for custom code for `response`
+
+Improvement:
+- Unioned status type for response
+- Optimize TypeScript inference performance
+
 # 0.2.0-beta.1 - 22 Jan 2023
 Breaking Change:
 - `onParse` now accepts `(context: PreContext, contentType: string)` instead of `(request: Request, contentType: string)`

bun.lockb

@@ -2,7 +2,7 @@ import { Elysia, t } from '../src'
 
 const app = new Elysia()
 	// Add custom body parser
-	.onParse(async (request, contentType) => {
+	.onParse(async ({ request }, contentType) => {
 		switch (contentType) {
 			case 'application/Elysia':
 				return request.text()
@@ -25,7 +25,10 @@ const app = new Elysia()
 			body: t.Object({
 				id: t.Number(),
 				username: t.String()
-			})
+			}),
+			detail: {
+				summary: 'A'
+			}
 		}
 	})
 	.post('/mirror', ({ body }) => body)

example/a.html

@@ -1,4 +1,4 @@
-import { Elysia, t } from '../src'
+import { Elysia, t, SCHEMA } from '../src'
 
 const app = new Elysia()
 	// Strictly validate response
@@ -16,8 +16,10 @@ const app = new Elysia()
 				profile: t.Object({
 					name: t.String()
 				})
-			}),
-			response: t.Number()
+			})
+			// response: {
+			// 	200: t.Number()
+			// }
 		}
 	})
 	// Strictly validate query, params, and body
@@ -28,7 +30,13 @@ const app = new Elysia()
 			}),
 			params: t.Object({
 				id: t.String()
-			})
+			}),
+			response: {
+				200: t.String(),
+				300: t.Object({
+					error: t.String()
+				})
+			}
 		}
 	})
 	.guard(
@@ -53,7 +61,7 @@ const app = new Elysia()
 						schema: {
 							params: t.Object({
 								id: t.Number()
-							}),
+							})
 						},
 						transform: ({ params }) => {
 							params.id = +params.id
@@ -62,3 +70,5 @@ const app = new Elysia()
 			)
 	)
 	.listen(8080)
+
+type A = typeof app['store'][typeof SCHEMA]['/query/:id']['GET']['query']

example/a.ts

@@ -1,7 +1,7 @@
 {
   "name": "elysia",
   "description": "Fast, and friendly Bun web framework",
-  "version": "0.2.0-beta.1",
+  "version": "0.2.0-beta.2",
   "author": {
     "name": "saltyAom",
     "url": "https://github.com/SaltyAom",
@@ -35,7 +35,8 @@
     "release": "npm run build && npm run test && npm publish"
   },
   "dependencies": {
-    "@sinclair/typebox": "0.25.10"
+    "@sinclair/typebox": "0.25.10",
+    "openapi-types": "^12.1.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.10",

example/body.ts

@@ -94,7 +94,6 @@ export default class Elysia<Instance extends ElysiaInstance = ElysiaInstance> {
 	constructor(config: Partial<ElysiaConfig> = {}) {
 		this.config = {
 			strictPath: false,
-			queryLimit: 48,
 			...config
 		}
 	}
@@ -640,7 +639,7 @@ export default class Elysia<Instance extends ElysiaInstance = ElysiaInstance> {
 	 * ```
 	 */
 	get<
-		Schema extends TypedSchema = {},
+		Schema extends TypedSchema = TypedSchema,
 		Path extends string = string,
 		Response = unknown
 	>(
@@ -1117,7 +1116,9 @@ export default class Elysia<Instance extends ElysiaInstance = ElysiaInstance> {
 			headers: getSchemaValidator(schema?.headers),
 			params: getSchemaValidator(schema?.params),
 			query: getSchemaValidator(schema?.query),
-			response: getSchemaValidator(schema?.response)
+			response: getSchemaValidator(
+				schema?.response?.['200'] ?? schema.response
+			)
 		}
 
 		return this as unknown as NewInstance
@@ -1422,15 +1423,14 @@ export default class Elysia<Instance extends ElysiaInstance = ElysiaInstance> {
 	}
 }
 
-export { Elysia }
+export { Elysia, Router }
 export { Type as t } from '@sinclair/typebox'
 export {
 	SCHEMA,
 	getPath,
 	createValidationError,
 	getSchemaValidator
 } from './utils'
-export { Router } from './router'
 
 export type { Context, PreContext } from './context'
 export type {
@@ -1460,5 +1460,14 @@ export type {
 	VoidLifeCycle,
 	SchemaValidator,
 	ElysiaRoute,
-	ExtractPath
+	ExtractPath,
+	IsPathParameter,
+	IsAny,
+	IsNever,
+	UnknownFallback,
+	WithArray,
+	ObjectValues,
+	PickInOrder,
+	MaybePromise,
+	MergeIfNotNull
 } from './types'

example/schema.ts

@@ -1,4 +1,5 @@
 import type { TSchema } from '@sinclair/typebox'
+import type { OpenAPIV2 } from 'openapi-types'
 
 import type { HTTPMethod, LocalHook } from './types'
 
@@ -23,10 +24,10 @@ export const registerSchemaPath = ({
 	method,
 	hook
 }: {
-	schema: Record<string, Object>
+	schema: OpenAPIV2.PathsObject
 	path: string
 	method: HTTPMethod
-	hook?: LocalHook<any>
+	hook?: LocalHook
 }) => {
 	path = toOpenAPIPath(path)
 
@@ -35,6 +36,7 @@ export const registerSchemaPath = ({
 	const headerSchema = hook?.schema?.headers
 	const querySchema = hook?.schema?.query
 	const responseSchema = hook?.schema?.response
+	const detail = hook?.schema?.detail
 
 	const parameters = [
 		...mapProperties('header', headerSchema),
@@ -66,7 +68,8 @@ export const registerSchemaPath = ({
 							}
 						}
 				  }
-				: {})
+				: {}),
+			...detail
 		}
 	}
 }