🎉 feat(macro): add introspect

Author: SaltyAom

CHANGELOG.md

@@ -2,6 +2,7 @@
 Improvement:
 - ValidationError: add `messageValue` as an alias of `errorValue`
 - ValidationError.detail now accept optional 2nd parameter `allowUnsafeValidatorDetails`
+- macro: add `introspect`
 
 Bug fix:
 - [#1537](https://github.com/elysiajs/elysia/issues/1537) websocket: ping/pong not being called

example/a.ts

@@ -1,27 +1,31 @@
 import { Elysia } from '../src'
 import { req } from '../test/utils'
 
-new Elysia()
-  .ws("/", {
-    ping() {
-      console.log("onping")
-    },
+const app = new Elysia()
+	.macro('a', {
+		introspect(option) {
+			console.log('a', option)
+		},
+		beforeHandle() {
+			console.log('before handle a')
+		}
+	})
+	.macro({
+		b: {
+			introspect(option) {
+				console.log('b', option)
+			},
+			beforeHandle() {
+				console.log('before handle a')
+			}
+		}
+	})
+	.get('/', () => 'hello world', {
+		a: true,
+		b: true,
+		detail: {
+			description: 'a'
+		}
+	})
 
-    pong() {
-      console.log("onpong")
-    },
-
-    async message(ws) {
-      console.log("onmessage")
-      console.log(ws.body)
-    },
-  })
-  .listen(3005)
-
-const ws = new WebSocket("ws://localhost:3005")
-
-ws.addEventListener("open", () => {
-  ws.ping()
-  ws.send("df")
-  ws.ping()
-})
+app.handle(req('/'))

src/index.ts

@@ -5235,6 +5235,10 @@ export default class Elysia<
 				>,
 		const Property extends MaybeValueOrVoidFunction<
 			MacroProperty<
+				Metadata['macro'] &
+					InputSchema<keyof Definitions['typebox'] & string> & {
+						[name in Name]?: boolean
+					},
 				Schema & MacroContext,
 				Singleton & {
 					derive: Partial<Ephemeral['derive'] & Volatile['derive']>
@@ -5277,6 +5281,8 @@ export default class Elysia<
 		const Input extends Metadata['macro'] &
 			InputSchema<keyof Definitions['typebox'] & string>,
 		const NewMacro extends Macro<
+			Metadata['macro'] &
+				InputSchema<keyof Definitions['typebox'] & string>,
 			Input,
 			IntersectIfObjectSchema<
 				MergeSchema<
@@ -5321,6 +5327,7 @@ export default class Elysia<
 		const NewMacro extends MaybeFunction<
 			Macro<
 				Input,
+				// @ts-ignore trust me bro
 				IntersectIfObjectSchema<
 					MergeSchema<
 						UnwrapRoute<Input, Definitions['typebox'], BasePath>,
@@ -5417,6 +5424,13 @@ export default class Elysia<
 					continue
 				}
 
+				if (k === 'introspect') {
+					value?.(localHook)
+
+					delete localHook[key]
+					continue
+				}
+
 				if (k === 'detail') {
 					if (!localHook.detail) localHook.detail = {}
 					localHook.detail = mergeDeep(localHook.detail, value, {

src/types.ts

@@ -1944,6 +1944,7 @@ export type BaseMacro = Record<
 export type MaybeValueOrVoidFunction<T> = T | ((...a: any) => void | T)
 
 export interface MacroProperty<
+	in out Macro extends BaseMacro = {},
 	in out TypedRoute extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
 		decorator: {}
@@ -1966,9 +1967,16 @@ export interface MacroProperty<
 	afterResponse?: MaybeArray<AfterResponseHandler<TypedRoute, Singleton>>
 	resolve?: MaybeArray<ResolveHandler<TypedRoute, Singleton>>
 	detail?: DocumentDecoration
+	/**
+	 * Introspect hook option for documentation generation or analysis
+	 *
+	 * @param option
+	 */
+	introspect?(option: Prettify<Macro>): unknown
 }
 
 export interface Macro<
+	in out Macro extends BaseMacro = {},
 	in out Input extends BaseMacro = {},
 	in out TypedRoute extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
@@ -1980,7 +1988,7 @@ export interface Macro<
 	in out Errors extends Record<string, Error> = {}
 > {
 	[K: keyof any]: MaybeValueOrVoidFunction<
-		Input & MacroProperty<TypedRoute, Singleton, Errors>
+		Input & MacroProperty<Macro, TypedRoute, Singleton, Errors>
 	>
 }