spiceflow 1.1.1 → 1.1.3

package/src/cors.ts

@@ -0,0 +1,115 @@
+import { MiddlewareHandler } from './types.js'
+/**
+ * Options for configuring CORS (Cross-Origin Resource Sharing) middleware.
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS MDN CORS documentation}
+ */
+type CORSOptions = {
+	/** Configures the Access-Control-Allow-Origin CORS header */
+	origin: string | string[]
+	/** Configures the Access-Control-Allow-Methods CORS header */
+	allowMethods?: string[]
+	/** Configures the Access-Control-Allow-Headers CORS header */
+	allowHeaders?: string[]
+	/** Configures the Access-Control-Max-Age CORS header */
+	maxAge?: number
+	/** Configures the Access-Control-Allow-Credentials CORS header */
+	credentials?: boolean
+	/** Configures the Access-Control-Expose-Headers CORS header */
+	exposeHeaders?: string[]
+}
+
+export const cors = (options?: CORSOptions): MiddlewareHandler => {
+	const defaults: CORSOptions = {
+		origin: '*',
+		allowMethods: ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH'],
+		allowHeaders: [],
+		exposeHeaders: [],
+	}
+	const opts = {
+		...defaults,
+		...options,
+	}
+
+	const findAllowOrigin = ((optsOrigin) => {
+		if (typeof optsOrigin === 'string') {
+			return () => optsOrigin
+		} else if (typeof optsOrigin === 'function') {
+			return optsOrigin
+		} else {
+			return (origin: string) =>
+				optsOrigin.includes(origin) ? origin : optsOrigin[0]
+		}
+	})(opts.origin)
+
+	return async function cors(c, next) {
+		let response = await next()
+
+		function set(key: string, value: string) {
+			response.headers.set(key, value)
+		}
+
+		const allowOrigin = findAllowOrigin(
+			c.request.headers.get('origin') || '',
+		)
+		if (allowOrigin) {
+			set('Access-Control-Allow-Origin', allowOrigin)
+		}
+
+		// Suppose the server sends a response with an Access-Control-Allow-Origin value with an explicit origin (rather than the "*" wildcard).
+		// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
+		if (opts.origin !== '*') {
+			const existingVary = c.request.headers.get('Vary')
+
+			if (existingVary) {
+				set('Vary', existingVary)
+			} else {
+				set('Vary', 'Origin')
+			}
+		}
+
+		if (opts.credentials) {
+			set('Access-Control-Allow-Credentials', 'true')
+		}
+
+		if (opts.exposeHeaders?.length) {
+			set('Access-Control-Expose-Headers', opts.exposeHeaders.join(','))
+		}
+
+		if (c.request.method === 'OPTIONS') {
+			if (opts.maxAge != null) {
+				set('Access-Control-Max-Age', opts.maxAge.toString())
+			}
+
+			if (opts.allowMethods?.length) {
+				set('Access-Control-Allow-Methods', opts.allowMethods.join(','))
+			}
+
+			let headers = opts.allowHeaders
+			if (!headers?.length) {
+				const requestHeaders = c.request.headers.get(
+					'Access-Control-Request-Headers',
+				)
+				if (requestHeaders) {
+					headers = requestHeaders.split(/\s*,\s*/)
+				}
+			}
+			if (headers?.length) {
+				set('Access-Control-Allow-Headers', headers.join(','))
+				c.request.headers.append(
+					'Vary',
+					'Access-Control-Request-Headers',
+				)
+			}
+
+			response.headers.delete('Content-Length')
+			response.headers.delete('Content-Type')
+
+			return new Response(null, {
+				headers: response.headers,
+				status: 204,
+				statusText: response.statusText,
+			})
+		}
+		return response
+	}
+}

package/src/error.ts

@@ -1,5 +1,3 @@
-
-
 // ? Cloudflare worker support
 const env =
 	// @ts-ignore
@@ -23,11 +21,6 @@ export class ValidationError extends Error {
 	status = 422
 }
 
-export class NotFoundError extends Error {
-	code = 'NOT_FOUND'
-	status = 404
-}
-
 export class ParseError extends Error {
 	code = 'PARSE'
 	status = 400
@@ -37,4 +30,3 @@ export class InternalServerError extends Error {
 	code = 'INTERNAL_SERVER_ERROR'
 	status = 500
 }
-

package/src/index.ts

@@ -1 +1,2 @@
 export { Spiceflow, AnySpiceflow } from './spiceflow.js'
+export { InternalServerError, ParseError, ValidationError } from './error.js'

package/src/middleware.test.ts

@@ -23,6 +23,22 @@ test('middleware with next changes the response', async () => {
 	expect(await res.json()).toEqual('hi')
 	expect(res.headers.get('x-test')).toBe('ok')
 })
+test('middleware next returns a response even for 404, if there are no routes', async () => {
+	const res = await new Spiceflow()
+		.use(async ({ request }, next) => {
+			expect(request.method).toBe('GET')
+			const res = await next()
+			expect(res).toBeInstanceOf(Response)
+			if (res) {
+				res.headers.set('x-test', 'ok')
+			}
+			return res
+		})
+		.handle(new Request('http://localhost/non-existent', { method: 'GET' }))
+	expect(res.status).toBe(404)
+	expect(res.headers.get('x-test')).toBe('ok')
+	expect(await res.text()).toContain('Not Found')
+})
 
 test('middleware without next runs the next middleware and handler', async () => {
 	let middlewaresCalled = [] as string[]
@@ -82,6 +98,29 @@ test('middleware stops other middlewares', async () => {
 	expect(await res.text()).toEqual('ok')
 })
 
+test('calling next and then returning a new response works', async () => {
+	let middlewaresCalled = [] as string[]
+	const res = await new Spiceflow()
+		.use(async (ctx, next) => {
+			middlewaresCalled.push('first')
+			await next()
+			return new Response('middleware response')
+		})
+		.use(async (ctx, next) => {
+			middlewaresCalled.push('second')
+			return next()
+		})
+		.get('/ids/:id', () => {
+			middlewaresCalled.push('handler')
+			return 'handler response'
+		})
+
+		.handle(new Request('http://localhost/ids/xxx', { method: 'GET' }))
+	expect(res.status).toBe(200)
+	expect(middlewaresCalled).toEqual(['first', 'second', 'handler'])
+	expect(await res.text()).toEqual('middleware response')
+})
+
 test('middleware changes handler response body', async () => {
 	let middlewaresCalled = [] as string[]
 	const res = await new Spiceflow()

package/src/spiceflow.test.ts

@@ -28,6 +28,30 @@ test('GET dynamic route', async () => {
 	expect(await res.json()).toEqual('hi')
 })
 
+test.todo('HEAD uses GET route, does not add body', async () => {
+	const app = new Spiceflow().get('/ids/:id', () => {
+		console.trace('GET')
+		return {
+			message: 'hi',
+			length: 10,
+		}
+	})
+
+	const res = await app.handle(
+		new Request('http://localhost/ids/xxx', { method: 'HEAD' }),
+	)
+	expect(res.status).toBe(200)
+	// expect(res.headers.get('Content-Length')).toBe('10')
+	expect(await res.text()).toBe('')
+
+	// Compare with GET to ensure HEAD is using GET route
+	const getRes = await app.handle(
+		new Request('http://localhost/ids/xxx', { method: 'GET' }),
+	)
+	expect(getRes.status).toBe(200)
+	expect(await getRes.json()).toEqual({ message: 'hi', length: 10 })
+})
+
 test('GET with query, untyped', async () => {
 	const res = await new Spiceflow()
 		.get('/query', ({ query }) => {

package/src/spiceflow.ts

@@ -17,7 +17,6 @@ import {
 	JoinPath,
 	LocalHook,
 	MaybeArray,
-	MergeSchema,
 	MetadataBase,
 	MiddlewareHandler,
 	Reconcile,
@@ -30,14 +29,12 @@ import {
 } from './types.js'
 let globalIndex = 0
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
 import OriginalRouter from '@medley/router'
 import Ajv, { ValidateFunction } from 'ajv'
 import { z, ZodType } from 'zod'
 import { zodToJsonSchema } from 'zod-to-json-schema'
 import { Context, MiddlewareContext } from './context.js'
-import { isProduction, NotFoundError, ValidationError } from './error.js'
+import { isProduction, ValidationError } from './error.js'
 import { isAsyncIterable, redirect } from './utils.js'
 
 const ajv = (addFormats.default || addFormats)(
@@ -74,7 +71,7 @@ export type InternalRoute = {
 	validateBody?: ValidateFunction
 	validateQuery?: ValidateFunction
 	validateParams?: ValidateFunction
-	prefix: string
+	// prefix: string
 
 	// store: Record<any, any>
 }
@@ -88,9 +85,11 @@ type MedleyRouter = {
 		| undefined
 	register: (path: string | undefined) => Record<string, InternalRoute>
 }
-/**
- * Router class
- */
+
+const notFoundHandler = (c) => {
+	return new Response('Not Found', { status: 404 })
+}
+
 export class Spiceflow<
 	const in out BasePath extends string = '',
 	const in out Scoped extends boolean = true,
@@ -151,7 +150,6 @@ export class Spiceflow<
 		const store = this.router.register(path)
 		let route: InternalRoute = {
 			...rest,
-			prefix: this.prefix || '',
 			method: (method || '') as any,
 			path: path || '',
 			handler: handler!,
@@ -166,6 +164,7 @@ export class Spiceflow<
 
 	private match(method: string, path: string) {
 		let root = this
+		let foundApp: AnySpiceflow | undefined
 		const result = bfsFind(this, (app) => {
 			app.topLevelApp = root
 			let prefix = this.getAppAndParents(app)
@@ -180,10 +179,12 @@ export class Spiceflow<
 			}
 			const medleyRoute = app.router.find(pathWithoutPrefix)
 			if (!medleyRoute) {
+				foundApp = app
 				return
 			}
 
 			let internalRoute: InternalRoute = medleyRoute.store[method]
+
 			if (internalRoute) {
 				const params = medleyRoute.params || {}
 
@@ -194,9 +195,46 @@ export class Spiceflow<
 				}
 				return res
 			}
+			if (method === 'HEAD') {
+				let internalRouteGet: InternalRoute = medleyRoute.store['GET']
+				if (!internalRouteGet?.handler) {
+					return
+				}
+				return {
+					app,
+					internalRoute: {
+						hooks: {},
+						handler: async (c) => {
+							const response = await internalRouteGet.handler(c)
+							if (response instanceof Response) {
+								return new Response('', {
+									status: response.status,
+									statusText: response.statusText,
+									headers: response.headers,
+								})
+							}
+							return new Response(null, { status: 200 })
+						},
+						method,
+						path,
+					} as InternalRoute,
+					params: medleyRoute.params,
+				}
+			}
 		})
 
-		return result
+		return (
+			result || {
+				app: foundApp || root,
+				internalRoute: {
+					hooks: {},
+					handler: notFoundHandler,
+					method,
+					path,
+				} as InternalRoute,
+				params: {},
+			}
+		)
 	}
 
 	state<const Name extends string | number | symbol, Value>(
@@ -667,45 +705,6 @@ export class Spiceflow<
 
 	private scoped?: Scoped = true as Scoped
 
-	// group is not needed, you can add another prefixed app instead
-	// group<
-	// 	const Prefix extends string,
-	// 	const NewSpiceflow extends Spiceflow<any, any, any, any, any, any, any, any>
-	// >(
-	// 	prefix: Prefix,
-	// 	run: (
-	// 		group: Spiceflow<
-	// 			`${BasePath}${Prefix}`,
-	// 			Scoped,
-	// 			Singleton,
-	// 			Definitions,
-	// 			Metadata,
-	// 			{},
-	// 			Ephemeral,
-	// 			Volatile
-	// 		>
-	// 	) => NewSpiceflow
-	// ): Spiceflow<
-	// 	BasePath,
-	// 	Scoped,
-	// 	Singleton,
-	// 	Definitions,
-	// 	Metadata,
-	// 	Prettify<Routes & NewSpiceflow['_routes']>,
-	// 	Ephemeral,
-	// 	Volatile
-	// > {
-	// 	let thisRouter = this.routers[0]
-	// 	this.routers.push(
-	// 		...instance.routers.map((r) => ({
-	// 			...r,
-	// 			prefix: (thisRouter.prefix || '') + r.prefix
-	// 		}))
-	// 	)
-
-	// 	return this
-	// }
-
 	use<const NewSpiceflow extends AnySpiceflow>(
 		instance: NewSpiceflow,
 	): IsAny<NewSpiceflow> extends true
@@ -752,12 +751,6 @@ export class Spiceflow<
 		return this
 	}
 
-	/**
-	 * Pass a request through all matching route handles and return a response
-	 * @param request   The `Request`
-	 * @param platform  Platform specific context {@link Platform}
-	 * @returns The final `Response`
-	 */
 	async handle(request: Request): Promise<Response> {
 		let u = new URL(request.url, 'http://localhost')
 		let path = u.pathname + u.search
@@ -773,18 +766,6 @@ export class Spiceflow<
 
 			const route = this.match(request.method, path)
 
-			if (!route) {
-				const error = new NotFoundError(`${path} not found`)
-				const res = await this.runErrorHandlers({
-					onErrorHandlers,
-					error,
-					request,
-				})
-				if (res) return res
-				return new Response(`Not Found`, {
-					status: 404,
-				})
-			}
 			onErrorHandlers = this.getAppsInScope(route.app).flatMap(
 				(x) => x.onErrorHandlers,
 			)
@@ -875,11 +856,12 @@ export class Spiceflow<
 				error: err,
 				request,
 			})
-			if (res) return res
+
 			let status = err?.status ?? 500
-			return new Response(err?.message || 'Internal Server Error', {
+			res ||= new Response(err?.message || 'Internal Server Error', {
 				status,
 			})
+			return res
 		}
 	}
 
@@ -954,6 +936,7 @@ export class Spiceflow<
 				port,
 				development: !isProduction,
 				hostname,
+				reusePort: true,
 				error(error) {
 					console.error(error)
 					return new Response('Internal Server Error', {
@@ -966,6 +949,9 @@ export class Spiceflow<
 					return res
 				},
 			})
+			process.on('beforeExit', () => {
+				server.stop()
+			})
 			console.log(`Listening on http://localhost:${port}`)
 			return server
 		}

package/src/types.test.ts

@@ -48,3 +48,4 @@ test('`use` on Spiceflow return', async () => {
 	expect(res.status).toBe(200)
 	expect(await res.json()).toEqual('hi')
 })
+

package/src/types.ts

@@ -19,11 +19,10 @@ import type { Context, ErrorContext, MiddlewareContext } from './context.js'
 import {
 	ELYSIA_RESPONSE,
 	InternalServerError,
-	NotFoundError,
 	ParseError,
 	ValidationError,
 } from './error.js'
-import { AnySpiceflow, Spiceflow } from './spiceflow.js'
+import { Spiceflow } from './spiceflow.js'
 
 export type MaybeArray<T> = T | T[]
 export type MaybePromise<T> = T | Promise<T>
@@ -312,7 +311,6 @@ export interface MergeSchema<
 export type Handler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -353,7 +351,6 @@ export type CoExist<Original, Target, With> = IsAny<Target> extends true
 export type InlineHandler<
 	Route extends RouteSchema = {},
 	Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -386,7 +383,6 @@ export type InlineHandler<
 export type OptionalHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -399,7 +395,6 @@ export type OptionalHandler<
 export type AfterHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -418,7 +413,6 @@ export type AfterHandler<
 export type MapResponse<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -437,7 +431,6 @@ export type MapResponse<
 export type VoidHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 > = (context: Context<Route, Singleton>) => MaybePromise<void>
@@ -445,7 +438,6 @@ export type VoidHandler<
 export type TransformHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	BasePath extends string = '',
@@ -466,7 +458,6 @@ export type TransformHandler<
 export type BodyHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Path extends string = '',
@@ -476,38 +467,23 @@ export type BodyHandler<
 			contentType: string
 		} & Context<Route, Singleton, Path>
 	>,
-	/**
-	 * @deprecated
-	 *
-	 * use `context.contentType` instead
-	 *
-	 * @example
-	 * ```ts
-	 * new Spiceflow()
-	 * 	   .onParse(({ contentType, request }) => {
-	 * 		     if (contentType === 'application/json')
-	 * 			     return request.json()
-	 *     })
-	 * ```
-	 */
+
 	contentType: string,
 ) => MaybePromise<any>
 
 export type MiddlewareHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 > = (
 	context: MiddlewareContext<Singleton>,
-	next: () => Promise<Response | void>,
+	next: () => Promise<Response>,
 ) => MaybePromise<Route['response'] | void>
 
 export type AfterResponseHandler<
 	in out Route extends RouteSchema = {},
 	in out Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 > = (
@@ -550,13 +526,13 @@ export type ErrorHandler<
 						error: Readonly<ValidationError>
 					} & Singleton['store']
 			  >
-			| Prettify<
-					{
-						request: Request
-						code: 'NOT_FOUND'
-						error: Readonly<NotFoundError>
-					} & NeverKey<Singleton['store']>
-			  >
+			// | Prettify<
+			// 		{
+			// 			request: Request
+			// 			code: 'NOT_FOUND'
+			// 			error: Readonly<NotFoundError>
+			// 		} & NeverKey<Singleton['store']>
+			//   >
 			| Prettify<
 					{
 						request: Request
@@ -713,7 +689,6 @@ export type MergeSpiceflowInstances<
 	Prefix extends string = '',
 	Scoped extends boolean = false,
 	Singleton extends SingletonBase = {
-		decorator: {}
 		store: {}
 	},
 	Definitions extends DefinitionBase = {

package/dist/benchmark.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=benchmark.test.d.ts.map

package/dist/benchmark.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"benchmark.test.d.ts","sourceRoot":"","sources":["../src/benchmark.test.ts"],"names":[],"mappings":""}

package/dist/benchmark.test.js

@@ -1,8 +0,0 @@
-import { bench, describe } from 'vitest';
-import { Spiceflow } from './spiceflow.js';
-describe('benchmark listen', () => {
-    bench('handle request', () => {
-        const app = new Spiceflow();
-    });
-});
-//# sourceMappingURL=benchmark.test.js.map

package/dist/benchmark.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"benchmark.test.js","sourceRoot":"","sources":["../src/benchmark.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IACjC,KAAK,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC5B,MAAM,GAAG,GAAG,IAAI,SAAS,EAAE,CAAA;IAC5B,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/src/benchmark.test.ts

@@ -1,8 +0,0 @@
-import { bench, describe } from 'vitest'
-import { Spiceflow } from './spiceflow.js'
-
-describe('benchmark listen', () => {
-	bench('handle request', () => {
-		const app = new Spiceflow()
-	})
-})