🎉 feat: use fromTypes from index

Author: SaltyAom

bun.lock

@@ -29,7 +29,7 @@
         "@elysiajs/eden": "^1.4.0",
         "@elysiajs/html": "^1.4.0",
         "@elysiajs/jwt": "^1.4.0",
-        "@elysiajs/openapi": "1.4.2",
+        "@elysiajs/openapi": "1.4.10",
         "@elysiajs/opentelemetry": "^1.4.0",
         "@elysiajs/server-timing": "^1.4.0",
         "@elysiajs/static": "^1.4.0",
@@ -189,7 +189,7 @@
 
     "@elysiajs/jwt": ["@elysiajs/[email protected]", "", { "dependencies": { "jose": "^6.0.11" }, "peerDependencies": { "elysia": ">= 1.4.0" } }, "sha512-Z0PvZhQxdDeKZ8HslXzDoXXD83NKExNPmoiAPki3nI2Xvh5wtUrBH+zWOD17yP14IbRo8fxGj3L25MRCAPsgPA=="],
 
-    "@elysiajs/openapi": ["@elysiajs/[email protected].2", "", { "peerDependencies": { "elysia": ">= 1.4.0" } }, "sha512-i+9YYVmX9Qx40dGRI9DE9zZJrEo4qXo5h2lfuxf1WuQZKYY8RonnYQZYbdWr/Azs8upTfIdyCifgjfu3Cht8rw=="],
+    "@elysiajs/openapi": ["@elysiajs/[email protected].10", "", { "peerDependencies": { "elysia": ">= 1.4.0" } }, "sha512-bEsETp/CGcs1CqH3zW6/CAI2g6d0K/g8wUuH7HwXQm0gtP18s9RnljJESuv4of3ePUoYQgy85t+dha+ABv+L/A=="],
 
     "@elysiajs/opentelemetry": ["@elysiajs/[email protected]", "", { "dependencies": { "@opentelemetry/api": "^1.9.0", "@opentelemetry/instrumentation": "^0.200.0", "@opentelemetry/sdk-node": "^0.200.0" }, "peerDependencies": { "elysia": ">= 1.4.0" } }, "sha512-snW/u/mLXU1OR86XgDW+CvsZEL1sFLeatWqxu2Knxk/0c9mxQsWYfDJP7hpP+iOL2Ryp9z9q1uRwgc6Rxze6eA=="],
 

docs/at-glance.md

@@ -223,12 +223,11 @@ Elysia also supports OpenAPI schema generation with **1 line directly from types
 
 ```typescript
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/oepnapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 export const app = new Elysia()
     .use(openapi({
-    	references: fromTypes('src/index.ts') // [!code ++]
+    	references: fromTypes() // [!code ++]
     }))
     .get('/user/:id', ({ params: { id } }) => id, {
         params: t.Object({
@@ -246,12 +245,11 @@ With Elysia, you can synchronize your types with your frontend team automaticall
 
 ```typescript twoslash
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 export const app = new Elysia()
     .use(openapi({
-    	references: fromTypes('src/index.ts')
+    	references: fromTypes()
     }))
     .get('/user/:id', ({ params: { id } }) => id, {
         params: t.Object({

docs/blog/openapi-type-gen.md

@@ -106,17 +106,16 @@ This is something profound, and can hardly replicated by any other framework.
 To add OpenAPI Type Gen to your codebase, simply:
 
 1. export an Elysia instance
-2. provide file path to type generator
+2. provide root Elysia file path (if not provided, Elysia will use `src/index.ts`)
 
 ```ts
 import { Elysia } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen' // [!code ++]
+import { openapi, fromTypes } from '@elysiajs/openapi' // [!code ++]
 
 export const app = new Elysia() // [!code ++]
 	.use(
 		openapi({
-			references: fromTypes('src/index.ts') // [!code ++]
+			references: fromTypes() // [!code ++]
 		})
 	)
 ```

docs/index.md

@@ -250,13 +250,12 @@ new Elysia()
 
 ```typescript [With Type Gen]
 import { Elysia } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 export const app = new Elysia()
 	.use(
 		openapi({
-			references: fromTypes('src/index.ts')
+			references: fromTypes()
 		})
 	)
 ```

docs/patterns/openapi.md

@@ -52,18 +52,17 @@ By default, Elysia relies on runtime schema to generate OpenAPI documentation.
 
 However, you can also generate OpenAPI documentation from types by using a generator from OpenAPI plugin as follows:
 
-1. Specify the root file of your project (usually `src/index.ts`), and export an instance
+1. Specify your Elysia root file (if not specified, Elysia will use `src/index.ts`), and export an instance
 
 2. Import a generator and provide a **file path from project root** to type generator
 ```ts
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen' // [!code ++]
+import { openapi, fromTypes } from '@elysiajs/openapi' // [!code ++]
 
 export const app = new Elysia() // [!code ++]
     .use(
         openapi({
-            references: fromTypes('src/index.ts') // [!code ++]
+            references: fromTypes() // [!code ++]
         })
     )
     .get('/', { test: 'hello' as const })
@@ -86,8 +85,7 @@ It's recommended that you should pre-generate the declaration file (**.d.ts**) t
 
 ```ts
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 const app = new Elysia()
     .use(
@@ -110,8 +108,7 @@ As it's unreliable to guess to root of the project, it's recommended to provide
 
 ```ts
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 export const app = new Elysia()
     .use(
@@ -135,8 +132,7 @@ If you have multiple `tsconfig.json` files, it's important that you must specify
 
 ```ts
 import { Elysia, t } from 'elysia'
-import { openapi } from '@elysiajs/openapi'
-import { fromTypes } from '@elysiajs/openapi/gen'
+import { openapi, fromTypes } from '@elysiajs/openapi'
 
 export const app = new Elysia()
     .use(

package.json

@@ -32,7 +32,7 @@
 		"@elysiajs/eden": "^1.4.0",
 		"@elysiajs/html": "^1.4.0",
 		"@elysiajs/jwt": "^1.4.0",
-		"@elysiajs/openapi": "1.4.2",
+		"@elysiajs/openapi": "1.4.10",
 		"@elysiajs/opentelemetry": "^1.4.0",
 		"@elysiajs/server-timing": "^1.4.0",
 		"@elysiajs/static": "^1.4.0",