spiceflow 1.0.2 → 1.0.3

package/src/elysia-fork/types.ts

@@ -8,6 +8,7 @@ import type {
 	Static,
 	StaticDecode,
 	TAnySchema,
+	TObject,
 	TSchema,
 } from '@sinclair/typebox'
 import type { TypeCheck, ValueError } from '@sinclair/typebox/compiler'
@@ -20,12 +21,11 @@ import type { Context, ErrorContext, PreContext } from './context'
 import {
 	ELYSIA_RESPONSE,
 	InternalServerError,
-	InvalidCookieSignature,
 	NotFoundError,
 	ParseError,
 	ValidationError,
 } from './error'
-import { ZodTypeAny } from 'zod'
+import { ZodTypeAny, ZodObject } from 'zod'
 
 export type MaybeArray<T> = T | T[]
 export type MaybePromise<T> = T | Promise<T>
@@ -174,10 +174,10 @@ export interface MetadataBase {
 
 export interface RouteSchema {
 	body?: unknown
-	headers?: unknown
+	// headers?: unknown
 	query?: unknown
 	params?: unknown
-	cookie?: unknown
+	// cookie?: unknown
 	response?: unknown
 }
 
@@ -187,6 +187,8 @@ type OptionalField = {
 
 export type TypeSchema = TSchema | ZodTypeAny
 
+export type TypeObject = TObject | ZodObject<any, any, any>
+
 export type UnwrapSchema<
 	Schema extends TypeSchema | string | undefined,
 	Definitions extends Record<string, unknown> = {},
@@ -210,8 +212,8 @@ export interface UnwrapRoute<
 > {
 	body: UnwrapSchema<Schema['body'], Definitions>
 	// headers: UnwrapSchema<Schema['headers'], Definitions>
-	// query: UnwrapSchema<Schema['query'], Definitions>
-	// params: UnwrapSchema<Schema['params'], Definitions>
+	query: UnwrapSchema<Schema['query'], Definitions>
+	params: UnwrapSchema<Schema['params'], Definitions>
 	// cookie: UnwrapSchema<Schema['cookie'], Definitions>
 	response: Schema['response'] extends TypeSchema | string
 		? {
@@ -320,8 +322,8 @@ export type HTTPMethod =
 export interface InputSchema<Name extends string = string> {
 	body?: TypeSchema | Name
 	// headers?: TObject | TNull | TUndefined | Name
-	// query?: TObject | TNull | TUndefined | Name
-	// params?: TObject | TNull | TUndefined | Name
+	query?: TypeObject | Name
+	params?: TypeObject | Name
 	// cookie?: TObject | TNull | TUndefined | Name
 	response?:
 		| TypeSchema
@@ -335,10 +337,10 @@ export interface MergeSchema<
 	in out B extends RouteSchema,
 > {
 	body: undefined extends A['body'] ? B['body'] : A['body']
-	headers: undefined extends A['headers'] ? B['headers'] : A['headers']
+	// headers: undefined extends A['headers'] ? B['headers'] : A['headers']
 	query: undefined extends A['query'] ? B['query'] : A['query']
 	params: undefined extends A['params'] ? B['params'] : A['params']
-	cookie: undefined extends A['cookie'] ? B['cookie'] : A['cookie']
+	// cookie: undefined extends A['cookie'] ? B['cookie'] : A['cookie']
 	response: {} extends A['response']
 		? {} extends B['response']
 			? {}
@@ -686,22 +688,22 @@ export type ErrorHandler<
 								Volatile['resolve']
 						>
 			  >
-			| Prettify<
-					{
-						request: Request
-						code: 'INVALID_COOKIE_SIGNATURE'
-						error: Readonly<InvalidCookieSignature>
-					} & NeverKey<
-						Singleton['derive'] &
-							Ephemeral['derive'] &
-							Volatile['derive']
-					> &
-						NeverKey<
-							Singleton['derive'] &
-								Ephemeral['resolve'] &
-								Volatile['resolve']
-						>
-			  >
+			// | Prettify<
+			// 		{
+			// 			request: Request
+			// 			code: 'INVALID_COOKIE_SIGNATURE'
+			// 			error: Readonly<InvalidCookieSignature>
+			// 		} & NeverKey<
+			// 			Singleton['derive'] &
+			// 				Ephemeral['derive'] &
+			// 				Volatile['derive']
+			// 		> &
+			// 			NeverKey<
+			// 				Singleton['derive'] &
+			// 					Ephemeral['resolve'] &
+			// 					Volatile['resolve']
+			// 			>
+			//   >
 			| Prettify<
 					{
 						[K in keyof T]: {

package/src/spiceflow.test.ts

@@ -1,6 +1,7 @@
 import { test, describe, expect } from 'vitest'
 import { Type } from '@sinclair/typebox'
 import { bfs, Spiceflow } from './spiceflow'
+import { z } from 'zod'
 
 test('works', async () => {
 	const res = await new Spiceflow()
@@ -24,6 +25,87 @@ test('GET dynamic route', async () => {
 	expect(await res.json()).toEqual('hi')
 })
 
+test('GET with query, untyped', async () => {
+	const res = await new Spiceflow()
+		.get('/query', ({ query }) => {
+			return query.id
+		})
+		.handle(new Request('http://localhost/query?id=hi', { method: 'GET' }))
+	expect(res.status).toBe(200)
+	expect(await res.json()).toEqual('hi')
+})
+
+test('GET with query, zod, fails validation', async () => {
+	const res = await new Spiceflow()
+		.get(
+			'/query',
+			({ query }) => {
+				return query.id
+			},
+			{
+				query: z.object({
+					id: z.number(),
+				}),
+			},
+		)
+		.handle(new Request('http://localhost/query?id=hi', { method: 'GET' }))
+	expect(res.status).toBe(422)
+})
+
+test('GET with query and zod', async () => {
+	const res = await new Spiceflow()
+		.get(
+			'/query',
+			({ query }) => {
+				return query.id
+				// @ts-expect-error
+				void query.sdfsd
+			},
+			{
+				query: z.object({
+					id: z.string(),
+				}),
+			},
+		)
+		.handle(new Request('http://localhost/query?id=hi', { method: 'GET' }))
+	expect(res.status).toBe(200)
+	expect(await res.json()).toEqual('hi')
+})
+
+test('GET dynamic route, params are typed', async () => {
+	const res = await new Spiceflow()
+		.get('/ids/:id', ({ params }) => {
+			let id = params.id
+			// @ts-expect-error
+			params.sdfsd
+			return id
+		})
+		.handle(new Request('http://localhost/ids/hi', { method: 'GET' }))
+	expect(res.status).toBe(200)
+	expect(await res.json()).toEqual('hi')
+})
+
+test('GET dynamic route, params are typed with schema', async () => {
+	const res = await new Spiceflow()
+		.get(
+			'/ids/:id',
+			({ params }) => {
+				let id = params.id
+				// @ts-expect-error
+				params.sdfsd
+				return id
+			},
+			{
+				params: z.object({
+					id: z.string(),
+				}),
+			},
+		)
+		.handle(new Request('http://localhost/ids/hi', { method: 'GET' }))
+	expect(res.status).toBe(200)
+	expect(await res.json()).toEqual('hi')
+})
+
 test('missing route is not found', async () => {
 	const res = await new Spiceflow()
 		.get('/ids/:id', () => 'hi')
@@ -48,9 +130,9 @@ test('body is parsed as json', async () => {
 	const res = await new Spiceflow()
 		.state('id', '')
 
-		.post('/post', (c) => {
-			body = c.body
-			// console.log({ body })
+		.post('/post', async (c) => {
+			body = await c.request.json()
+			// console.log({request})
 			return body
 		})
 		.handle(
@@ -71,8 +153,9 @@ test('validate body works, request success', async () => {
 
 		.post(
 			'/post',
-			({ body }) => {
-				// console.log({ body })
+			async ({ request }) => {
+				// console.log({request})
+				let body = await request.json()
 				expect(body).toEqual({ name: 'John' })
 				return 'ok'
 			},
@@ -100,8 +183,9 @@ test('validate body works, request fails', async () => {
 
 		.post(
 			'/post',
-			({ body, redirect, error }) => {
-				// console.log({ body })
+			async ({ request, redirect }) => {
+				// console.log({request})
+				let body = await request.json()
 				expect(body).toEqual({ name: 'John' })
 			},
 			{
@@ -120,7 +204,7 @@ test('validate body works, request fails', async () => {
 				body: JSON.stringify({ name: 'John' }),
 			}),
 		)
-	expect(res.status).toBe(400)
+	expect(res.status).toBe(422)
 	expect(await res.text()).toMatchInlineSnapshot(
 		`"data must have required property 'requiredField'"`,
 	)

package/src/spiceflow.ts

@@ -89,7 +89,10 @@ export type InternalRoute = {
 	path: string
 	handler: InlineHandler<any, any, any>
 	hooks: LocalHook<any, any, any, any, any, any, any>
-	validate?: ValidateFunction
+	validateBody?: ValidateFunction
+	validateQuery?: ValidateFunction
+	validateParams?: ValidateFunction
+
 	prefix: string
 
 	// store: Record<any, any>
@@ -160,15 +163,9 @@ export class Spiceflow<
 		// }
 
 		let bodySchema: TypeSchema = hooks?.body
-		let validate: ValidateFunction | undefined
-
-		if (isZodSchema(bodySchema)) {
-			let jsonSchema = zodToJsonSchema(bodySchema, {})
-			validate = ajv.compile(jsonSchema)
-		} else if (bodySchema) {
-			// console.log(bodySchema)
-			validate = ajv.compile(bodySchema)
-		}
+		let validateBody = getValidateFunction(bodySchema)
+		let validateQuery = getValidateFunction(hooks?.query)
+		let validateParams = getValidateFunction(hooks?.params)
 
 		const store = router.router.register(path)
 		let route: InternalRoute = {
@@ -180,7 +177,9 @@ export class Spiceflow<
 			// prefix,
 			handler: handler!,
 			hooks,
-			validate,
+			validateBody,
+			validateParams,
+			validateQuery,
 		}
 		router.routes.push(route)
 		store[method] = route
@@ -216,6 +215,7 @@ export class Spiceflow<
 
 				const { onErrorHandlers, onRequestHandlers } = router
 				const params = route['params'] || {}
+
 				return {
 					...data,
 					router,
@@ -355,7 +355,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -422,7 +422,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -487,7 +487,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -553,7 +553,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -619,7 +619,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -685,7 +685,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -751,7 +751,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -819,7 +819,7 @@ export class Spiceflow<
 							? ResolvePath<Path>
 							: Schema['params']
 						query: Schema['query']
-						headers: Schema['headers']
+
 						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
@@ -976,6 +976,7 @@ export class Spiceflow<
 	 */
 	async handle(request: Request, platform?: P): Promise<Response> {
 		platform ??= {} as P
+
 		let u = new URL(request.url)
 		let path = u.pathname + u.search
 		const defaultContext = {
@@ -995,7 +996,7 @@ export class Spiceflow<
 			onErrorHandlers = this.getRouteAndParents(route.router)
 				.reverse()
 				.flatMap((x) => x.onErrorHandlers)
-			const { params, store: defaultStore } = route
+			let { params, store: defaultStore } = route
 			const onReqHandlers = this.getRouteAndParents(route.router)
 				.reverse()
 				.flatMap((x) => x.onRequestHandlers)
@@ -1004,25 +1005,17 @@ export class Spiceflow<
 			// TODO add content type
 
 			let content = route?.hooks?.content
-			let body = await getRequestBody({ request, content })
+			// let body = await getRequestBody({ request, content })
 
-			if (route.validate) {
-				// TODO move compile to the router
+			if (route.validateBody) {
+				// TODO don't clone the request
+				let typedRequest = new TypedRequest(request)
+				typedRequest.validateBody = route.validateBody
+				request = typedRequest
+			}
 
-				const valid = route.validate(body)
-				if (!valid) {
-					const error = ajv.errorsText(route.validate.errors, {
-						separator: '\n',
-					})
+			let query = parseQuery.parse((u.search || '').slice(1))
 
-					return new Response(error, {
-						status: 400,
-						headers: {
-							'content-type': 'text/plain',
-						},
-					})
-				}
-			}
 			if (onReqHandlers.length > 0) {
 				for (const handler of onReqHandlers) {
 					const res = await handler({
@@ -1030,6 +1023,7 @@ export class Spiceflow<
 						response,
 						store,
 						path,
+						query,
 					} satisfies Context<any, any, any>)
 					if (res) {
 						return await turnHandlerResultIntoResponse(res)
@@ -1037,6 +1031,9 @@ export class Spiceflow<
 				}
 			}
 
+			query = runValidation(query, route.validateQuery)
+			params = runValidation(params, route.validateParams)
+
 			// console.log(route)
 
 			const res = route.handler({
@@ -1045,7 +1042,8 @@ export class Spiceflow<
 				response,
 				params: params as any,
 				store,
-				body,
+				query,
+				// body,
 				path,
 
 				// platform
@@ -1060,14 +1058,16 @@ export class Spiceflow<
 
 			return await turnHandlerResultIntoResponse(res)
 		} catch (err: any) {
+			if (err instanceof Response) return err
 			let res = await this.runErrorHandlers({
 				onErrorHandlers,
 				error: err,
 				request,
 			})
 			if (res) return res
+			let status = err?.status ?? 500
 			return new Response(err?.message || 'Internal Server Error', {
-				status: 500,
+				status,
 			})
 		}
 	}
@@ -1201,59 +1201,59 @@ export class Spiceflow<
 	}
 }
 
-async function getRequestBody({
-	request,
-	content,
-}: {
-	content
-	request: Request
-}) {
-	let body: string | Record<string, any> | undefined
-	if (request.method === 'GET' || request.method === 'HEAD') {
-		return
-	}
+// async function getRequestBody({
+// 	request,
+// 	content,
+// }: {
+// 	content
+// 	request: Request
+// }) {
+// 	let body: string | Record<string, any> | undefined
+// 	if (request.method === 'GET' || request.method === 'HEAD') {
+// 		return
+// 	}
 
-	const contentType =
-		content || request.headers.get('content-type')?.split(';')?.[0]
+// 	const contentType =
+// 		content || request.headers.get('content-type')?.split(';')?.[0]
 
-	if (!contentType) {
-		return
-	}
+// 	if (!contentType) {
+// 		return
+// 	}
 
-	switch (contentType) {
-		case 'application/json':
-			body = (await request.json()) as any
-			break
+// 	switch (contentType) {
+// 		case 'application/json':
+// 			body = (await request.json()) as any
+// 			break
 
-		case 'text/plain':
-			body = await request.text()
-			break
+// 		case 'text/plain':
+// 			body = await request.text()
+// 			break
 
-		case 'application/x-www-form-urlencoded':
-			body = parseQuery.parse(await request.text()) as any
-			break
+// 		case 'application/x-www-form-urlencoded':
+// 			body = parseQuery.parse(await request.text()) as any
+// 			break
 
-		case 'application/octet-stream':
-			body = await request.arrayBuffer()
-			break
+// 		case 'application/octet-stream':
+// 			body = await request.arrayBuffer()
+// 			break
 
-		case 'multipart/form-data':
-			body = {}
+// 		case 'multipart/form-data':
+// 			body = {}
 
-			const form = await request.formData()
-			for (const key of form.keys()) {
-				if (body[key]) continue
+// 			const form = await request.formData()
+// 			for (const key of form.keys()) {
+// 				if (body[key]) continue
 
-				const value = form.getAll(key)
-				if (value.length === 1) body[key] = value[0]
-				else body[key] = value
-			}
+// 				const value = form.getAll(key)
+// 				if (value.length === 1) body[key] = value[0]
+// 				else body[key] = value
+// 			}
 
-			break
-	}
+// 			break
+// 	}
 
-	return body
-}
+// 	return body
+// }
 
 const METHODS = [
 	'ALL',
@@ -1288,6 +1288,15 @@ function bfsFind<T>(
 	}
 	return
 }
+export class TypedRequest<T = any> extends Request {
+	validateBody?: ValidateFunction
+
+	async json(): Promise<T> {
+		const body = (await super.json()) as Promise<T>
+		return runValidation(body, this.validateBody)
+	}
+}
+
 export function bfs(tree: RouterTree) {
 	const queue = [tree]
 	let nodes: RouterTree[] = []
@@ -1346,3 +1355,26 @@ export function isZodSchema(value: unknown): value is ZodType {
 			'nullable' in value)
 	)
 }
+
+function getValidateFunction(schema: TypeSchema) {
+	if (isZodSchema(schema)) {
+		let jsonSchema = zodToJsonSchema(schema, {})
+		return ajv.compile(jsonSchema)
+	}
+
+	if (schema) {
+		return ajv.compile(schema)
+	}
+}
+
+function runValidation(value: any, validate?: ValidateFunction) {
+	if (!validate) return value
+	const valid = validate(value)
+	if (!valid) {
+		const error = ajv.errorsText(validate.errors, {
+			separator: '\n',
+		})
+		throw new ValidationError(error)
+	}
+	return value
+}

package/src/zod.test.ts

@@ -11,13 +11,14 @@ test('body is parsed as json', async () => {
 
 		.post(
 			'/post',
-			(c) => {
-				name = c.body.name
+			async (c) => {
+				const body = await c.request.json()
+				name = body.name
 				// @ts-expect-error
-				c.body.nonExistingField
+				body.nonExistingField
 				return {
 					name,
-					nameEcho: c.body.name,
+					nameEcho: body.name,
 					// add: 3,
 				}
 			},
@@ -33,13 +34,14 @@ test('body is parsed as json', async () => {
 		)
 		.post(
 			'/post2',
-			(c) => {
-				name = c.body.name
+			async (c) => {
+				const body = await c.request.json()
+				name = body.name
 				// @ts-expect-error
-				c.body.nonExistingField
+				body.nonExistingField
 				return {
 					name,
-					nameEcho: c.body.name,
+					nameEcho: body.name,
 				}
 			},
 			{