🎉 feat: union file extension check

Author: SaltyAom

CHANGELOG.md

@@ -1,6 +1,6 @@
 # 1.3.0
 Feature:
-- add `jsonAccelerator`,`exactMirror`
+- add `jsonAccelerator`, `exactMirror`
 - add `systemRouter` config
 - `standalone Validator`
 - add `Elysia.Ref` for referencing schema with autocompletion instead of `t.Ref`

bun.lock

@@ -4,11 +4,9 @@
     "": {
       "name": "elysia",
       "dependencies": {
-        "@sinclair/typebox": "^0.34.33",
         "cookie": "^1.0.2",
         "exact-mirror": "0.1.1",
         "fast-decode-uri-component": "^1.0.1",
-        "openapi-types": "^12.1.3",
       },
       "devDependencies": {
         "@types/bun": "^1.2.9",
@@ -27,19 +25,17 @@
         "tsup": "^8.4.0",
         "typescript": "^5.8.3",
       },
+      "optionalDependencies": {
+        "@sinclair/typebox": "^0.34.33",
+        "openapi-types": "^12.1.3",
+      },
       "peerDependencies": {
         "@sinclair/typebox": ">= 0.34.0",
         "exact-mirror": ">= 0.0.9",
         "file-type": ">= 20.0.0",
         "openapi-types": ">= 12.0.0",
         "typescript": ">= 5.0.0",
       },
-      "optionalPeers": [
-        "exact-mirror",
-        "file-type",
-        "openapi-types",
-        "typescript",
-      ],
     },
   },
   "packages": {

example/a.ts

@@ -1,9 +1,41 @@
 import { Elysia, t } from '../src'
-import { req } from '../test/utils'
+import { hasType } from '../src/schema'
+import { req, upload } from '../test/utils'
 
 const app = new Elysia()
-	// .onRequest(async () => {})
-	.mount('/auth', () => new Response('OK'))
+	.post('/', ({ body }) => 'ok', {
+		body: t.Union([
+			t.Object({
+				hello: t.String(),
+				file: t.File({
+					type: 'image'
+				}),
+				a: t.File({
+					type: 'image'
+				})
+			}),
+			t.Object({
+				world: t.String(),
+				image: t.File({
+					type: 'image'
+				})
+			}),
+			t.Object({
+				world: t.String()
+			})
+		])
+	})
 	.listen(3000)
 
-console.log(app.router)
+// console.log(app.routes[0].compile().toString())
+
+// app.handle(
+// 	upload('/', {
+// 		hello: 'world',
+// 		file: 'aris-yuzu.jpg'
+// 	}).request
+// )
+// 	.then((x) => x.text())
+// 	.then(console.log)
+
+// // console.log(app.router)

package.json

@@ -178,11 +178,9 @@
 		"release": "npm run build && npm run test && npm publish"
 	},
 	"dependencies": {
-		"@sinclair/typebox": "^0.34.33",
 		"cookie": "^1.0.2",
 		"exact-mirror": "0.1.1",
-		"fast-decode-uri-component": "^1.0.1",
-		"openapi-types": "^12.1.3"
+		"fast-decode-uri-component": "^1.0.1"
 	},
 	"devDependencies": {
 		"@types/bun": "^1.2.9",
@@ -208,21 +206,8 @@
 		"openapi-types": ">= 12.0.0",
 		"typescript": ">= 5.0.0"
 	},
-	"peerDependenciesMeta": {
-		"exact-mirror": {
-			"optional": true
-		},
-		"json-accelerator": {
-			"optional": true
-		},
-		"file-type": {
-			"optional": true
-		},
-		"openapi-types": {
-			"optional": true
-		},
-		"typescript": {
-			"optional": true
-		}
+	"optionalDependencies": {
+		"@sinclair/typebox": "^0.34.33",
+		"openapi-types": "^12.1.3"
 	}
 }

src/compose.ts

@@ -34,7 +34,14 @@ import {
 } from './error'
 import { ELYSIA_TRACE, type TraceHandler } from './trace'
 
-import { ElysiaTypeCheck, getCookieValidator, hasType, isUnion } from './schema'
+import {
+	coercePrimitiveRoot,
+	ElysiaTypeCheck,
+	getCookieValidator,
+	getSchemaValidator,
+	hasType,
+	isUnion
+} from './schema'
 import { Sucrose, sucrose } from './sucrose'
 import { parseCookie, type CookieOptions } from './cookies'
 import { validateFileExtension } from './type-system/utils'
@@ -1172,6 +1179,8 @@ export const composeHandler = ({
 		reporter.resolve()
 	}
 
+	const fileUnions = <ElysiaTypeCheck<any>[]>[]
+
 	if (validator) {
 		if (validator.headers) {
 			if (validator.headers.hasDefault)
@@ -1291,10 +1300,8 @@ export const composeHandler = ({
 			if (validator.body.hasTransform || validator.body.isOptional)
 				fnLiteral += `const isNotEmptyObject=c.body&&(typeof c.body==="object"&&isNotEmpty(c.body))\n`
 
-			const hasFile =
-				!isUnion(validator.body.schema) &&
-				(hasType('File', validator.body.schema) ||
-					hasType('Files', validator.body.schema))
+			const hasUnion = isUnion(validator.body.schema)
+			let hasNonUnionFileWithDefault = false
 
 			if (validator.body.hasDefault) {
 				let value = Value.Default(
@@ -1308,8 +1315,15 @@ export const composeHandler = ({
 						: undefined
 				)
 
-				// remove default value of t.File / t.Files
-				if (hasFile && value && typeof value === 'object') {
+				if (
+					!hasUnion &&
+					value &&
+					typeof value === 'object' &&
+					(hasType('File', validator.body.schema) ||
+						hasType('Files', validator.body.schema))
+				) {
+					hasNonUnionFileWithDefault = true
+
 					for (const [k, v] of Object.entries(value))
 						if (v === 'File' || v === 'Files')
 							// @ts-ignore
@@ -1377,26 +1391,90 @@ export const composeHandler = ({
 			if (validator.body.hasTransform)
 				fnLiteral += `if(isNotEmptyObject)c.body=validator.body.Decode(c.body)\n`
 
-			if (hasFile) {
+			if (hasUnion && validator.body.schema.anyOf?.length) {
+				const iterator = Object.values(
+					validator.body.schema.anyOf
+				) as TAnySchema[]
+
+				for (let i = 0; i < iterator.length; i++) {
+					const type = iterator[i]
+
+					if (hasType('File', type) || hasType('Files', type)) {
+						const candidate = getSchemaValidator(type, {
+							// @ts-expect-error private property
+							modules: app.definitions.typebox,
+							dynamic: !app.config.aot,
+							// @ts-expect-error private property
+							models: app.definitions.type,
+							normalize: app.config.normalize,
+							additionalCoerce: coercePrimitiveRoot(),
+							sanitize: () => app.config.sanitize
+						})
+
+						if (candidate) {
+							const isFirst = fileUnions.length === 0
+
+							const iterator = Object.entries(
+								type.properties
+							) as [string, TSchema][]
+
+							let validator = isFirst ? '\n' : ' else '
+							validator += `if(fileUnions[${fileUnions.length}].Check(c.body)){`
+
+							let validateFile = ''
+							let validatorLength = 0
+							for (let i = 0; i < iterator.length; i++) {
+								const [k, v] = iterator[i]
+
+								if (
+									!v.extension ||
+									(v[Kind] !== 'File' && v[Kind] !== 'Files')
+								)
+									continue
+
+								if (validatorLength) validateFile += ','
+								validateFile += `validateFileExtension(c.body.${k},${JSON.stringify(v.extension)},'body.${k}')`
+
+								validatorLength++
+							}
+
+							if (validateFile) {
+								if (validatorLength === 1)
+									validator += `await ${validateFile}\n`
+								else if (validatorLength > 1)
+									validator += `await Promise.all([${validateFile}])\n`
+
+								validator += '}'
+
+								fnLiteral += validator
+								fileUnions.push(candidate)
+							}
+						}
+					}
+				}
+			} else if (
+				hasNonUnionFileWithDefault ||
+				(!hasUnion &&
+					(hasType('File', validator.body.schema) ||
+						hasType('Files', validator.body.schema)))
+			) {
 				let validateFile = ''
 
 				let i = 0
+				for (const [k, v] of Object.entries(
+					validator.body.schema.properties
+				) as [string, TSchema][]) {
+					if (
+						!v.extension ||
+						(v[Kind] !== 'File' && v[Kind] !== 'Files')
+					)
+						continue
 
-				if (validator.body.schema.properties)
-					for (const [k, v] of Object.entries(
-						validator.body.schema.properties
-					) as [string, TSchema][]) {
-						if (
-							!v.extension ||
-							(v[Kind] !== 'File' && v[Kind] !== 'Files')
-						)
-							continue
-
-						if (i) validateFile += ','
-						validateFile += `validateFileExtension(c.body.${k},${JSON.stringify(v.extension)},'body.${k}')`
+					if (i) validateFile += ','
+					validateFile += `validateFileExtension(c.body.${k},${JSON.stringify(v.extension)},'body.${k}')`
 
-						i++
-					}
+					i++
+				}
 
 				if (i) fnLiteral += '\n'
 
@@ -1932,6 +2010,7 @@ export const composeHandler = ({
 		allocateIf(`ELYSIA_REQUEST_ID,`, hasTrace) +
 		allocateIf('parser,', hooks.parse?.length) +
 		allocateIf(`getServer,`, inference.server) +
+		allocateIf(`fileUnions,`, fileUnions.length) +
 		adapterVariables +
 		allocateIf('TypeBoxError', hasValidation) +
 		`}=hooks\n` +
@@ -1983,6 +2062,7 @@ export const composeHandler = ({
 			ELYSIA_REQUEST_ID: hasTrace ? ELYSIA_REQUEST_ID : undefined,
 			// @ts-expect-error private property
 			getServer: () => app.getServer(),
+			fileUnions: fileUnions.length ? fileUnions : undefined,
 			TypeBoxError: hasValidation ? TypeBoxError : undefined,
 			parser: app['~parser'],
 			...adapter.inject
@@ -2394,13 +2474,17 @@ export const composeErrorHandler = (app: AnyElysia) => {
 		}
 
 	fnLiteral +=
-		`if(error.constructor.name==="ValidationError"||error.constructor.name==="TransformDecodeError"){` +
+		`if(error.constructor.name==="ValidationError"||error.constructor.name==="TransformDecodeError"){\n` +
 		`if(error.error)error=error.error\n` +
 		`set.status=error.status??422\n` +
 		adapter.validationError +
-		`}`
+		`\n}\n`
 
-	fnLiteral += `if(error instanceof Error){` + adapter.unknownError + `}`
+	fnLiteral +=
+		`if(error instanceof Error){` +
+		`\nif(typeof error.toResponse==='function')return context.response=error.toResponse()\n` +
+		adapter.unknownError +
+		`\n}`
 
 	const mapResponseReporter = report('mapResponse', {
 		total: hooks.mapResponse?.length,

src/error.ts

@@ -183,13 +183,51 @@ export const mapValueError = (error: ValueError | undefined) => {
 
 export class InvalidFileType extends Error {
 	code = 'INVALID_FILE_TYPE'
-	status = 401
+	status = 422
 
 	constructor(
-		public key: string,
-		message?: string
+		public property: string,
+		public expected: string | string[],
+		public message = `"${property}" has invalid file type`
 	) {
-		super(message ?? `"${key}" has invalid file type`)
+		super(message)
+
+		Object.setPrototypeOf(this, InvalidFileType.prototype)
+	}
+
+	toResponse(headers?: Record<string, any>) {
+		if (isProduction)
+			return new Response(
+				JSON.stringify({
+					type: 'validation',
+					on: 'body'
+				}),
+				{
+					status: 422,
+					headers: {
+						...headers,
+						'content-type': 'application/json'
+					}
+				}
+			)
+
+		return new Response(
+			JSON.stringify({
+				type: 'validation',
+				on: 'body',
+				summary: 'Invalid file type',
+				message: this.message,
+				property: this.property,
+				expected: this.expected
+			}),
+			{
+				status: 422,
+				headers: {
+					...headers,
+					'content-type': 'application/json'
+				}
+			}
+		)
 	}
 }