🎉 feat: 1.4.3

Author: SaltyAom

CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.4.3 - 18 Sep 2025
+Improvement:
+- unwrap model reference into parameter schema
+- add warning for standard schema without `toJSONSchema` method
+- remove `Provider` from generic type to allow auto-completion
+- auto-completion for `mapJSONSchema`
+- log error when failed to OpenAPI JSON
+
 # 1.4.2 - 14 Sep 2025
 Bug fix:
 - remove xsschema from dependencies

bun.lock

@@ -8,17 +8,16 @@
         "@scalar/types": "^0.2.13",
         "@sinclair/typemap": "^0.10.1",
         "@types/bun": "1.2.20",
-        "elysia": "1.4.0",
+        "effect": "^3.17.13",
+        "elysia": "1.4.6",
         "eslint": "9.6.0",
         "openapi-types": "^12.1.3",
         "tsup": "^8.5.0",
         "typescript": "^5.9.2",
-        "xsschema": "^0.4.0-beta.3",
         "zod": "^4.1.5",
       },
       "peerDependencies": {
         "elysia": ">= 1.4.0",
-        "xsschema": ">= 0.4.0-beta.0",
       },
     },
   },
@@ -169,6 +168,8 @@
 
     "@sinclair/typemap": ["@sinclair/[email protected]", "", { "peerDependencies": { "@sinclair/typebox": "^0.34.30", "valibot": "^1.0.0", "zod": "^3.24.1" } }, "sha512-UXR0fhu/n3c9B6lB+SLI5t1eVpt9i9CdDrp2TajRe3LbKiUhCTZN2kSfJhjPnpc3I59jMRIhgew7+0HlMi08mg=="],
 
+    "@standard-schema/spec": ["@standard-schema/[email protected]", "", {}, "sha512-m2bOd0f2RT9k8QJx1JN85cZYyH1RqFBdlwtkSlf4tBDYLCiiZnv1fIIwacK6cqwXavOydf0NPToMQgpKq+dVlA=="],
+
     "@tokenizer/inflate": ["@tokenizer/[email protected]", "", { "dependencies": { "debug": "^4.4.0", "fflate": "^0.8.2", "token-types": "^6.0.0" } }, "sha512-MADQgmZT1eKjp06jpI2yozxaU9uVs4GzzgSL+uEq7bVcJ9V1ZXQkeGNql1fsSI0gMy1vhvNTNbUqrx+pZfJVmg=="],
 
     "@tokenizer/token": ["@tokenizer/[email protected]", "", {}, "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A=="],
@@ -241,7 +242,9 @@
 
     "eastasianwidth": ["[email protected]", "", {}, "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA=="],
 
-    "elysia": ["[email protected]", "", { "dependencies": { "cookie": "^1.0.2", "exact-mirror": "0.2.2", "fast-decode-uri-component": "^1.0.1" }, "optionalDependencies": { "@sinclair/typebox": ">= 0.34.0 < 1", "openapi-types": ">= 12.0.0" }, "peerDependencies": { "file-type": ">= 20.0.0", "typescript": ">= 5.0.0" } }, "sha512-AVEq8cWo7+fdkbUtqVXDZ7uhjjv8K6NE6bt9oSzdocaawsW5VhJP2ArPoRYkWdJPYmS4f2FI5xWF+Tvs98yXVw=="],
+    "effect": ["[email protected]", "", { "dependencies": { "@standard-schema/spec": "^1.0.0", "fast-check": "^3.23.1" } }, "sha512-JMz5oBxs/6mu4FP9Csjub4jYMUwMLrp+IzUmSDVIzn2NoeoyOXMl7x1lghfr3dLKWffWrdnv/d8nFFdgrHXPqw=="],
+
+    "elysia": ["[email protected]", "", { "dependencies": { "cookie": "^1.0.2", "exact-mirror": "0.2.2", "fast-decode-uri-component": "^1.0.1" }, "optionalDependencies": { "@sinclair/typebox": ">= 0.34.0 < 1", "openapi-types": ">= 12.0.0" }, "peerDependencies": { "file-type": ">= 20.0.0", "typescript": ">= 5.0.0" } }, "sha512-u2CorXLPs5ZXyWP+tQR+bgka/lJA4vNpB8lDE2w/sTmdaIwoPQmHEL4J3ai6OAlluWR1kfG7T9gO3EYT9D8viQ=="],
 
     "emoji-regex": ["[email protected]", "", {}, "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg=="],
 
@@ -267,6 +270,8 @@
 
     "exact-mirror": ["[email protected]", "", { "peerDependencies": { "@sinclair/typebox": "^0.34.15" }, "optionalPeers": ["@sinclair/typebox"] }, "sha512-CrGe+4QzHZlnrXZVlo/WbUZ4qQZq8C0uATQVGVgXIrNXgHDBBNFD1VRfssRA2C9t3RYvh3MadZSdg2Wy7HBoQA=="],
 
+    "fast-check": ["[email protected]", "", { "dependencies": { "pure-rand": "^6.1.0" } }, "sha512-h5+1OzzfCC3Ef7VbtKdcv7zsstUQwUDlYpUTvjeUsJAssPgLn7QzbboPtL5ro04Mq0rPOsMzl7q5hIbRs2wD1A=="],
+
     "fast-decode-uri-component": ["[email protected]", "", {}, "sha512-WKgKWg5eUxvRZGwW8FvfbaH7AXSh2cL+3j5fMGzUMCxWBJ3dV3a7Wz8y2f/uQ0e3B6WmodD3oS54jTQ9HVTIIg=="],
 
     "fast-deep-equal": ["[email protected]", "", {}, "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="],
@@ -407,6 +412,8 @@
 
     "punycode": ["[email protected]", "", {}, "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg=="],
 
+    "pure-rand": ["[email protected]", "", {}, "sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA=="],
+
     "queue-microtask": ["[email protected]", "", {}, "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="],
 
     "readdirp": ["[email protected]", "", {}, "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg=="],
@@ -491,8 +498,6 @@
 
     "wrap-ansi-cjs": ["[email protected]", "", { "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", "strip-ansi": "^6.0.0" } }, "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q=="],
 
-    "xsschema": ["[email protected]", "", { "peerDependencies": { "@valibot/to-json-schema": "^1.0.0", "arktype": "^2.1.20", "effect": "^3.16.0", "sury": "^10.0.0", "zod": "^3.25.0 || ^4.0.0", "zod-to-json-schema": "^3.24.5" }, "optionalPeers": ["@valibot/to-json-schema", "arktype", "effect", "sury", "zod", "zod-to-json-schema"] }, "sha512-+vKxPksAH0QDk2YXRT25LY+Cn/lGJHiwC88Hb9BNl76Gso7VZYoOsq0T6nSoeSxKjyWRYCGmS6anrOhDQknasw=="],
-
     "yocto-queue": ["[email protected]", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="],
 
     "zod": ["[email protected]", "", {}, "sha512-5R1P+WwQqmmMIEACyzSvo4JXHY5WiAFHRMg+zBZKgKS+Q1viRa0C1hmUKtHltoIFKtIdki3pRxkmpP74jnNYHQ=="],

example/index.ts

@@ -1,5 +1,6 @@
 import { Elysia, t } from 'elysia'
 import z from 'zod'
+import { JSONSchema, Schema } from 'effect'
 
 import { openapi, withHeaders } from '../src/index'
 
@@ -21,6 +22,10 @@ export const app = new Elysia()
 	.use(
 		openapi({
 			provider: 'scalar',
+			mapJsonSchema: {
+				zod: z.toJSONSchema,
+				effect: JSONSchema.make
+			},
 			documentation: {
 				info: {
 					title: 'Elysia Scalar',
@@ -49,6 +54,28 @@ export const app = new Elysia()
 		})
 	)
 	.model({ schema, schema2, user })
+	.model({
+		idParam: t.Object({
+			id: t.Union([
+				t.String({ format: 'uuid' }),
+				t.Number({ minimum: 1, maximum: Number.MAX_SAFE_INTEGER })
+			]),
+			id2: t.String()
+		}),
+		response200: t.Object({
+			message: t.String(),
+			content: t.Array(t.Object({
+				id: t.Union([t.String(), t.Number()])
+			}))
+		})
+	})
+	.get('/test/:id/:id2', ({ params: { id } }) => ({
+		message: 'ok',
+		content: [{ id }]
+	}), {
+		params: 'idParam',
+		response: 'response200'
+	})
 	.get(
 		'/',
 		{ test: 'hello' as const },
@@ -72,17 +99,24 @@ export const app = new Elysia()
 	.post(
 		'/json',
 		({ body }) => ({
-			test: 'world'
+			test: 'hello'
 		}),
 		{
 			parse: ['json', 'formdata'],
 			body: 'schema',
 			response: {
-				200: 'schema',
+				200: t.Object({
+					test: t.Literal('hello')
+				}),
 				400: z.object({
 					a: z.string(),
 					b: z.literal('a')
-				})
+				}),
+				401: Schema.standardSchemaV1(
+					Schema.Struct({
+						a: Schema.Literal('hi')
+					})
+				)
 			}
 		}
 	)

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@elysiajs/openapi",
-    "version": "1.4.2",
+    "version": "1.4.3",
     "description": "Plugin for Elysia to auto-generate API documentation",
     "author": {
         "name": "saltyAom",
@@ -79,7 +79,8 @@
         "@scalar/types": "^0.2.13",
         "@sinclair/typemap": "^0.10.1",
         "@types/bun": "1.2.20",
-        "elysia": "1.4.0",
+        "effect": "^3.17.13",
+        "elysia": "1.4.6",
         "eslint": "9.6.0",
         "openapi-types": "^12.1.3",
         "tsup": "^8.5.0",

src/index.ts

@@ -16,20 +16,19 @@ import type { ElysiaOpenAPIConfig, OpenAPIProvider } from './types'
  */
 export const openapi = <
 	const Enabled extends boolean = true,
-	const Path extends string = '/openapi',
-	const Provider extends OpenAPIProvider = 'scalar'
+	const Path extends string = '/openapi'
 >({
 	enabled = true as Enabled,
 	path = '/openapi' as Path,
-	provider = 'scalar' as Provider,
+	provider = 'scalar',
 	specPath = `${path}/json`,
 	documentation = {},
 	exclude,
 	swagger,
 	scalar,
 	references,
 	mapJsonSchema
-}: ElysiaOpenAPIConfig<Enabled, Path, Provider> = {}) => {
+}: ElysiaOpenAPIConfig<Enabled, Path> = {}) => {
 	if (!enabled) return new Elysia({ name: '@elysiajs/openapi' })
 
 	const info = {
@@ -119,6 +118,10 @@ export const openapi = <
 				} satisfies OpenAPIV3.Document)
 			},
 			{
+				error({ error }) {
+					console.log('[@elysiajs/openapi] error at specPath')
+					console.warn(error)
+				},
 				detail: {
 					hide: true
 				}