🎉 feat: refactor

Author: SaltyAom

CHANGELOG.md

@@ -1,4 +1,15 @@
-# 1.3.1
+# 1.3.2 - 22 Aug 2025
+Feature:
+- add `withHeader` for adding custom headers to response schema
+- spread all possible path for optional params
+
+Breaking change:
+- rename `@elysiajs/swagger` to `@elysiajs/openapi`
+- map all `swagger`, and `scalar` prefix to respective `swagger` and `scalar` properties
+- rename `swaggerConfig`, and `scalarConfig` to `swagger` and `scalar` respectively
+- map `excludePaths`, `excludeMethods`, `excludeTags`, `excludeStaticFiles`	 to property of `excludes`
+
+# 1.3.1 - 28 Jun 2025
 Bug fix:
 - Using relative path for specPath
 

bun.lock

@@ -5,12 +5,11 @@
       "name": "@elysiajs/swagger",
       "dependencies": {
         "@scalar/themes": "^0.9.52",
-        "@scalar/types": "^0.0.12",
         "openapi-types": "^12.1.3",
-        "pathe": "^1.1.2",
       },
       "devDependencies": {
         "@apidevtools/swagger-parser": "^10.1.0",
+        "@scalar/types": "^0.0.12",
         "@types/bun": "1.1.14",
         "elysia": "1.3.0-exp.71",
         "eslint": "9.6.0",
@@ -373,8 +372,6 @@
 
     "path-scurry": ["[email protected]", "", { "dependencies": { "lru-cache": "^10.2.0", "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" } }, "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA=="],
 
-    "pathe": ["[email protected]", "", {}, "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ=="],
-
     "picocolors": ["[email protected]", "", {}, "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="],
 
     "picomatch": ["[email protected]", "", {}, "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg=="],

example/index.ts

@@ -1,18 +1,28 @@
 import { Elysia, t } from 'elysia'
-import { swagger } from '../src/index'
+import { openapi, withHeaders } from '../src/index'
 
 const schema = t.Object({
 	test: t.Literal('hello')
 })
 
-const app = new Elysia({ prefix: '/api' })
+const schema2 = t.Object({
+	test: t.Literal('world')
+})
+
+const user = t.Object({
+	name: t.String({
+		example: 'saltyaom'
+	})
+})
+
+const app = new Elysia()
 	.use(
-		swagger({
+		openapi({
 			provider: 'scalar',
 			documentation: {
 				info: {
 					title: 'Elysia Scalar',
-					version: '0.8.1'
+					version: '1.3.1a'
 				},
 				tags: [
 					{
@@ -21,39 +31,55 @@ const app = new Elysia({ prefix: '/api' })
 					}
 				],
 				components: {
-					schemas: {
-						User: {
-							description: 'string'
-						}
-					},
 					securitySchemes: {
-						JwtAuth: {
+						bearer: {
 							type: 'http',
-							scheme: 'bearer',
-							bearerFormat: 'JWT',
-							description: 'Enter JWT Bearer token **_only_**'
+							scheme: 'bearer'
+						},
+						cookie: {
+							type: 'apiKey',
+							in: 'cookie',
+							name: 'session_id'
 						}
 					}
 				}
-			},
-			swaggerOptions: {
-				persistAuthorization: true
 			}
 		})
 	)
-	.model({ schema })
+	.model({ schema, schema2, user })
 	.get(
 		'/',
-		() => {
-			return { test: 'hello' as const }
-		},
+		{ test: 'hello' as const },
+		{
+			response: {
+				200: t.Object({
+					test: t.Literal('hello')
+				}),
+				204: withHeaders(
+					t.Void({
+						title: 'Thing',
+						description: 'Void response'
+					}),
+					{
+						'X-Custom-Header': t.String()
+					}
+				)
+			}
+		}
+	)
+	.post(
+		'/json',
+		({ body }) => ({
+			test: 'world'
+		}),
 		{
-			response: 'schema'
+			parse: ['json', 'formdata'],
+			body: 'user',
+			response: {
+				200: 'schema',
+				400: 'schema2'
+			}
 		}
 	)
-	.post('/json', ({ body }) => body, {
-		parse: ['json', 'formdata'],
-		body: 'schema',
-		response: 'schema'
-	})
+	.get('/id/:id?/name/:name?', () => {})
 	.listen(3000)

example/index2.ts

@@ -1,7 +1,7 @@
 {
-    "name": "@elysiajs/swagger",
-    "version": "1.3.1",
-    "description": "Plugin for Elysia to auto-generate Swagger page",
+    "name": "@elysiajs/openapi",
+    "version": "1.3.2",
+    "description": "Plugin for Elysia to auto-generate OpenAPI documentation",
     "author": {
         "name": "saltyAom",
         "url": "https://github.com/SaltyAom",
@@ -17,15 +17,10 @@
             "import": "./dist/index.mjs",
             "require": "./dist/cjs/index.js"
         },
-        "./types": {
-            "types": "./dist/types.d.ts",
-            "import": "./dist/types.mjs",
-            "require": "./dist/cjs/types.js"
-        },
-        "./utils": {
-            "types": "./dist/utils.d.ts",
-            "import": "./dist/utils.mjs",
-            "require": "./dist/cjs/utils.js"
+        "./openapi": {
+            "types": "./dist/openapi.d.ts",
+            "import": "./dist/openapi.mjs",
+            "require": "./dist/cjs/openapi.js"
         },
         "./scalar": {
             "types": "./dist/scalar/index.d.ts",
@@ -36,18 +31,35 @@
             "types": "./dist/scalar/theme.d.ts",
             "import": "./dist/scalar/theme.mjs",
             "require": "./dist/cjs/scalar/theme.js"
+        },
+        "./swagger": {
+            "types": "./dist/swagger/index.d.ts",
+            "import": "./dist/swagger/index.mjs",
+            "require": "./dist/cjs/swagger/index.js"
+        },
+        "./swagger/types": {
+            "types": "./dist/swagger/types.d.ts",
+            "import": "./dist/swagger/types.mjs",
+            "require": "./dist/cjs/swagger/types.js"
+        },
+        "./types": {
+            "types": "./dist/types.d.ts",
+            "import": "./dist/types.mjs",
+            "require": "./dist/cjs/types.js"
         }
     },
     "keywords": [
         "elysia",
-        "swagger"
+        "openapi",
+        "swagger",
+        "scalar"
     ],
-    "homepage": "https://github.com/elysiajs/elysia-swagger",
+    "homepage": "https://github.com/elysiajs/elysia-openapi",
     "repository": {
         "type": "git",
-        "url": "https://github.com/elysiajs/elysia-swagger"
+        "url": "https://github.com/elysiajs/elysia-openapi"
     },
-    "bugs": "https://github.com/elysiajs/elysia-swagger/issues",
+    "bugs": "https://github.com/elysiajs/elysia-openapi/issues",
     "license": "MIT",
     "scripts": {
         "dev": "bun run --watch example/index.ts",
@@ -62,15 +74,14 @@
     "devDependencies": {
         "@apidevtools/swagger-parser": "^10.1.0",
         "@types/bun": "1.1.14",
+        "@scalar/types": "^0.0.12",
         "elysia": "1.3.0-exp.71",
         "eslint": "9.6.0",
         "tsup": "^8.1.0",
         "typescript": "^5.5.3"
     },
     "dependencies": {
         "@scalar/themes": "^0.9.52",
-        "@scalar/types": "^0.0.12",
-        "openapi-types": "^12.1.3",
-        "pathe": "^1.1.2"
+        "openapi-types": "^12.1.3"
     }
 }