🔧 fix: #262 when failed to convert type to OpenAPI, log the error and continue

Author: SaltyAom

CHANGELOG.md

@@ -4,6 +4,7 @@ Improvement:
 - accept operationId from detail
 - type gen: accept number as path segment
 - add test case for type gen, and OpenAPI schema
+- when failed to convert type to OpenAPI, log the error and continue
 
 Bug fix:
 - [#226](https://github.com/elysiajs/elysia-openapi/issues/266) accept operationId

example/index.ts

@@ -4,31 +4,19 @@ import { JSONSchema, Schema } from 'effect'
 
 import { openapi, withHeaders } from '../src/index'
 
-const schema = t.Object({
-	test: t.Literal('hello')
-})
-
-const schema2 = t.Object({
-	test: t.Literal('world')
-})
-
-const user = t.Object({
-	name: t.String({
-		example: 'saltyaom'
-	})
-})
-
-const model = new Elysia().model(
-	'body',
-	t.Object({
-		name: t.Literal('Lilith')
-	})
-)
+// const a = z.toJSONSchema(z.void())
 
 const app = new Elysia()
-	.use(openapi())
-	.use(model)
-	.post('/user', () => 'hello', {
-		body: 'body'
+	.use(
+		openapi({
+			mapJsonSchema: {
+				zod: z.toJSONSchema
+			}
+		})
+	)
+	.get('/test', ({ status }) => status(204, undefined), {
+		response: {
+			204: z.void()
+		}
 	})
 	.listen(3000)

src/openapi.ts

@@ -139,69 +139,78 @@ export const unwrapSchema = (
 	// @ts-ignore
 	const vendor = schema['~standard'].vendor
 
-	if (mapJsonSchema?.[vendor] && typeof mapJsonSchema[vendor] === 'function')
-		return enumToOpenApi(mapJsonSchema[vendor](schema))
+	try {
+		if (
+			mapJsonSchema?.[vendor] &&
+			typeof mapJsonSchema[vendor] === 'function'
+		)
+			return enumToOpenApi(mapJsonSchema[vendor](schema))
 
-	switch (vendor) {
-		case 'zod':
-			if (warned.zod4 || warned.zod3) break
+		switch (vendor) {
+			case 'zod':
+				if (warned.zod4 || warned.zod3) break
 
-			console.warn(
-				"[@elysiajs/openapi] Zod doesn't provide JSON Schema method on the schema"
-			)
+				console.warn(
+					"[@elysiajs/openapi] Zod doesn't provide JSON Schema method on the schema"
+				)
+
+				if ('_zod' in schema) {
+					warned.zod4 = true
 
-			if ('_zod' in schema) {
-				warned.zod4 = true
+					console.warn(
+						'For Zod v4, please provide z.toJSONSchema as follows:\n'
+					)
+					console.warn(warnings.zod4)
+				} else {
+					warned.zod3 = true
+
+					console.warn(
+						'For Zod v3, please install zod-to-json-schema package and use it like this:\n'
+					)
+					console.warn(warnings.zod3)
+				}
+				break
+
+			case 'valibot':
+				if (warned.valibot) break
+				warned.valibot = true
 
 				console.warn(
-					'For Zod v4, please provide z.toJSONSchema as follows:\n'
+					'[@elysiajs/openapi] Valibot require a separate package for JSON Schema conversion'
 				)
-				console.warn(warnings.zod4)
-			} else {
-				warned.zod3 = true
-
 				console.warn(
-					'For Zod v3, please install zod-to-json-schema package and use it like this:\n'
+					'Please install @valibot/to-json-schema package and use it like this:\n'
 				)
-				console.warn(warnings.zod3)
-			}
-			break
+				console.warn(warnings.valibot)
+				break
 
-		case 'valibot':
-			if (warned.valibot) break
-			warned.valibot = true
+			case 'effect':
+				// Effect does not support toJsonSchema method
+				// Users have to use third party library like effect-zod
+				if (warned.effect) break
+				warned.effect = true
 
-			console.warn(
-				'[@elysiajs/openapi] Valibot require a separate package for JSON Schema conversion'
-			)
-			console.warn(
-				'Please install @valibot/to-json-schema package and use it like this:\n'
-			)
-			console.warn(warnings.valibot)
-			break
+				console.warn(
+					"[@elysiajs/openapi] Effect Schema doesn't provide JSON Schema method on the schema"
+				)
+				console.warn(
+					"please provide JSONSchema from 'effect' package as follows:\n"
+				)
+				console.warn(warnings.effect)
+				break
+		}
 
-		case 'effect':
-			// Effect does not support toJsonSchema method
-			// Users have to use third party library like effect-zod
-			if (warned.effect) break
-			warned.effect = true
+		if (vendor === 'arktype')
+			// @ts-ignore
+			return enumToOpenApi(schema?.toJsonSchema?.())
 
-			console.warn(
-				"[@elysiajs/openapi] Effect Schema doesn't provide JSON Schema method on the schema"
-			)
-			console.warn(
-				"please provide JSONSchema from 'effect' package as follows:\n"
-			)
-			console.warn(warnings.effect)
-			break
+		return enumToOpenApi(
+			// @ts-ignore
+			schema.toJSONSchema?.() ?? schema?.toJsonSchema?.()
+		)
+	} catch (error) {
+		console.warn(error)
 	}
-
-	if (vendor === 'arktype')
-		// @ts-ignore
-		return enumToOpenApi(schema?.toJsonSchema?.())
-
-	// @ts-ignore
-	return enumToOpenApi(schema.toJSONSchema?.() ?? schema?.toJsonSchema?.())
 }
 
 export const enumToOpenApi = <