spiceflow 1.0.0 → 1.0.1

package/src/elysia-fork/types.ts

@@ -4,7 +4,6 @@
 
 import type { BunFile, Serve, Server, WebSocketHandler } from 'bun'
 
-
 import type {
 	TSchema,
 	TObject,
@@ -28,108 +27,7 @@ import {
 	ParseError,
 	ValidationError
 } from './error'
-import { Elysia } from '../spiceflow'
-
-
-export type ElysiaConfig<
-	Prefix extends string | undefined,
-	Scoped extends boolean | undefined
-> = {
-	/**
-	 * Path prefix of the instance
-	 *
-	 * @default '''
-	 */
-	prefix?: Prefix
-	/**
-	 * If set to true, other Elysia handler will not inherits global life-cycle, store, decorators from the current instance
-	 *
-	 * @default false
-	 */
-	scoped?: Scoped
-	/**
-	 * Name of the instance for debugging, and plugin deduplication purpose
-	 */
-	name?: string
-	/**
-	 * Seed for generating checksum for plugin deduplication
-	 *
-	 * @see https://elysiajs.com/essential/plugin.html#plugin-deduplication
-	 */
-	seed?: unknown
-	
-	/**
-	 * OpenAPI documentation (use in Swagger)
-	 *
-	 * @see https://swagger.io/specification/
-	 */
-	detail?: DocumentDecoration
-	/**
-	 * OpenAPI tags
-	 *
-	 * current instance' routes with tags
-	 *
-	 * @see https://swagger.io/specification/#tag-object
-	 */
-	tags?: DocumentDecoration['tags']
-	/**
-	 * Warm up Elysia before starting the server
-	 *
-	 * This will perform Ahead of Time compilation and generate code for route handlers
-	 *
-	 * If set to false, Elysia will perform Just in Time compilation
-	 *
-	 * Only required for root instance (instance which use listen) to effect
-	 *
-	 * ! If performing a benchmark, it's recommended to set this to `true`
-	 *
-	 * @default false
-	 */
-	precompile?:
-		| boolean
-		| {
-				/**
-				 * Perform dynamic code generation for route handlers before starting the server
-				 *
-				 * @default false
-				 */
-				compose?: boolean
-				/**
-				 * Perform Ahead of Time compilation for schema before starting the server
-				 *
-				 * @default false
-				 */
-				schema?: boolean
-		  }
-
-	// /**
-	//  * Override websocket configuration
-	//  *
-	//  * @see https://bun.sh/docs/api/websockets
-	//  */
-	// websocket?: Omit<
-	// 	WebSocketHandler<any>,
-	// 	'open' | 'close' | 'message' | 'drain'
-	// >
-
-	/**
-	 * Capture more detail information for each dependencies
-	 */
-	analytic?: boolean
-	/**
-	 * Enable experimental features
-	 */
-	experimental?: {}
-	/**
-	 * If enabled, the handlers will run a [clean](https://github.com/sinclairzx81/typebox?tab=readme-ov-file#clean) on incoming and outgoing bodies instead of failing directly.
-	 * This allows for sending unknown or disallowed properties in the bodies. These will simply be filtered out instead of failing the request.
-	 * This has no effect when the schemas allow additional properties.
-	 * Since this uses dynamic schema it may have an impact on performance.
-	 *
-	 * @default false
-	 */
-	normalize?: boolean
-}
+import { Spiceflow } from '../spiceflow'
 
 
 export type MaybeArray<T> = T | T[]
@@ -715,7 +613,7 @@ export type BodyHandler<
 	 *
 	 * @example
 	 * ```ts
-	 * new Elysia()
+	 * new Spiceflow()
 	 * 	   .onParse(({ contentType, request }) => {
 	 * 		     if (contentType === 'application/json')
 	 * 			     return request.json()
@@ -752,7 +650,7 @@ export type AfterResponseHandler<
 ) => MaybePromise<void>
 
 export type GracefulHandler<
-	in Instance extends Elysia<any, any, any, any, any, any, any, any>
+	in Instance extends Spiceflow<any, any, any, any, any, any, any, any>
 > = (data: Instance) => any
 
 export type ErrorHandler<
@@ -984,8 +882,6 @@ export interface InternalRoute {
 	hooks: LocalHook<any, any, any, any, any, any, any>
 }
 
-
-
 export type ListenCallback = (server: Server) => MaybePromise<void>
 
 export type AddPrefix<Prefix extends string, T> = {
@@ -1132,13 +1028,16 @@ export type CreateEden<
 	? _CreateEden<'index', Property>
 	: _CreateEden<Path, Property>
 
-export type ComposeElysiaResponse<Response, Handle> = Handle extends (
+export type ComposeSpiceflowResponse<Response, Handle> = Handle extends (
 	...a: any[]
 ) => infer A
-	? _ComposeElysiaResponse<Response, Replace<Awaited<A>, BunFile, File>>
-	: _ComposeElysiaResponse<Response, Replace<Awaited<Handle>, BunFile, File>>
+	? _ComposeSpiceflowResponse<Response, Replace<Awaited<A>, BunFile, File>>
+	: _ComposeSpiceflowResponse<
+			Response,
+			Replace<Awaited<Handle>, BunFile, File>
+	  >
 
-type _ComposeElysiaResponse<Response, Handle> = Prettify<
+type _ComposeSpiceflowResponse<Response, Handle> = Prettify<
 	{} extends Response
 		? {
 				200: Exclude<Handle, { [ELYSIA_RESPONSE]: any }>
@@ -1155,8 +1054,8 @@ type _ComposeElysiaResponse<Response, Handle> = Prettify<
 		: Response
 >
 
-export type MergeElysiaInstances<
-	Instances extends Elysia<any, any, any, any, any, any>[] = [],
+export type MergeSpiceflowInstances<
+	Instances extends Spiceflow<any, any, any, any, any, any>[] = [],
 	Prefix extends string = '',
 	Scoped extends boolean = false,
 	Singleton extends SingletonBase = {
@@ -1176,11 +1075,11 @@ export type MergeElysiaInstances<
 	},
 	Routes extends RouteBase = {}
 > = Instances extends [
-	infer Current extends Elysia<any, any, any, any, any, any>,
-	...infer Rest extends Elysia<any, any, any, any, any, any>[]
+	infer Current extends Spiceflow<any, any, any, any, any, any>,
+	...infer Rest extends Spiceflow<any, any, any, any, any, any>[]
 ]
 	? Current['_types']['Scoped'] extends true
-		? MergeElysiaInstances<
+		? MergeSpiceflowInstances<
 				Rest,
 				Prefix,
 				Scoped,
@@ -1189,7 +1088,7 @@ export type MergeElysiaInstances<
 				Metadata,
 				Routes
 		  >
-		: MergeElysiaInstances<
+		: MergeSpiceflowInstances<
 				Rest,
 				Prefix,
 				Scoped,
@@ -1201,7 +1100,7 @@ export type MergeElysiaInstances<
 						? Current['_routes']
 						: AddPrefix<Prefix, Current['_routes']>)
 		  >
-	: Elysia<
+	: Spiceflow<
 			Prefix,
 			Scoped,
 			{
@@ -1225,13 +1124,13 @@ export type MergeElysiaInstances<
 export type LifeCycleType = 'global' | 'local' | 'scoped'
 
 // Exclude return error()
-export type ExcludeElysiaResponse<T> = Exclude<
+export type ExcludeSpiceflowResponse<T> = Exclude<
 	undefined extends Awaited<T> ? Partial<Awaited<T>> : Awaited<T>,
 	{ [ELYSIA_RESPONSE]: any }
 >
 
 export type InferContext<
-	T extends Elysia<any, any, any, any, any, any, any, any>,
+	T extends Spiceflow<any, any, any, any, any, any, any, any>,
 	Path extends string = T['_types']['Prefix'],
 	Schema extends RouteSchema = T['_types']['Metadata']['schema']
 > = Context<
@@ -1244,7 +1143,7 @@ export type InferContext<
 >
 
 export type InferHandler<
-	T extends Elysia<any, any, any, any, any, any, any, any>,
+	T extends Spiceflow<any, any, any, any, any, any, any, any>,
 	Path extends string = T['_types']['Prefix'],
 	Schema extends RouteSchema = T['_types']['Metadata']['schema']
 > = InlineHandler<
@@ -1303,7 +1202,7 @@ export type HigherOrderFunction<
 	T extends (...arg: unknown[]) => Function = (...arg: unknown[]) => Function
 > = (fn: T, request: Request) => ReturnType<T>
 
-// new Elysia()
+// new Spiceflow()
 // 	.wrap((fn) => {
 // 		return fn()
 // 	})
@@ -1387,7 +1286,7 @@ export type HTTPHeaders = Record<string, string> & {
 
 	// Response context
 	allow?: string
-	server?: 'Elysia' | (string & {})
+	server?: 'spiceflow' | (string & {})
 
 	// Range requests
 	'accept-ranges'?: string
@@ -1438,7 +1337,7 @@ export type HTTPHeaders = Record<string, string> & {
 	'x-forwarded-for'?: string
 	'x-forwarded-host'?: string
 	'x-forwarded-proto'?: string
-	'x-powered-by'?: 'Elysia' | (string & {})
+	'x-powered-by'?: 'spiceflow' | (string & {})
 	'x-request-id'?: string
 	'x-requested-with'?: string
 	'x-robots-tag'?: string

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './spiceflow.js'
+export { Static } from '@sinclair/typebox'

package/src/spiceflow.test.ts

@@ -1,23 +1,23 @@
 import { test, describe, expect } from 'vitest'
 import { Type } from '@sinclair/typebox'
-import { Elysia } from './spiceflow'
+import { Spiceflow } from './spiceflow'
 
 test('works', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.post('/xxx', () => 'hi')
 		.handle(new Request('http://localhost/xxx', { method: 'POST' }))
 	expect(res.status).toBe(200)
 	expect(await res.text()).toBe(JSON.stringify('hi'))
 })
 test('dynamic route', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.post('/ids/:id', () => 'hi')
 		.handle(new Request('http://localhost/ids/xxx', { method: 'POST' }))
 	expect(res.status).toBe(200)
 	expect(await res.text()).toBe(JSON.stringify('hi'))
 })
 test('GET dynamic route', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.get('/ids/:id', () => 'hi')
 		.handle(new Request('http://localhost/ids/xxx', { method: 'GET' }))
 	expect(res.status).toBe(200)
@@ -25,13 +25,13 @@ test('GET dynamic route', async () => {
 })
 
 test('missing route is not found', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.get('/ids/:id', () => 'hi')
 		.handle(new Request('http://localhost/zxxx', { method: 'GET' }))
 	expect(res.status).toBe(404)
 })
 test('state works', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.state('id', '')
 		.onRequest(({ store, request }) => {
 			store.id = 'xxx'
@@ -45,7 +45,7 @@ test('state works', async () => {
 
 test('body is parsed as json', async () => {
 	let body
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.state('id', '')
 
 		.post('/post', (c) => {
@@ -67,7 +67,7 @@ test('body is parsed as json', async () => {
 })
 
 test('validate body works, request success', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 
 		.post(
 			'/post',
@@ -96,7 +96,7 @@ test('validate body works, request success', async () => {
 })
 
 test('validate body works, request fails', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 
 		.post(
 			'/post',
@@ -127,7 +127,7 @@ test('validate body works, request fails', async () => {
 })
 
 test('run onRequest', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.onRequest(({ request }) => {
 			expect(request.method).toBe('HEAD')
 			return new Response('ok', { status: 401 })
@@ -143,7 +143,7 @@ test('run onRequest', async () => {
 })
 
 test('run onRequest', async () => {
-	const res = await new Elysia()
+	const res = await new Spiceflow()
 		.onRequest(({ request }) => {
 			expect(request.method).toBe('HEAD')
 			return new Response('ok', { status: 401 })
@@ -159,7 +159,7 @@ test('run onRequest', async () => {
 })
 
 test('basPath works', async () => {
-	const res = await new Elysia({ basePath: '/one' })
+	const res = await new Spiceflow({ basePath: '/one' })
 		.get('/ids/:id', () => 'hi')
 		.handle(new Request('http://localhost/one/ids/xxx', { method: 'GET' }))
 	expect(res.status).toBe(200)
@@ -169,16 +169,16 @@ test('basPath works', async () => {
 test('use with 2 basPath works', async () => {
 	let oneOnReq = false
 	let twoOnReq = false
-	const app = await new Elysia()
+	const app = await new Spiceflow()
 		.use(
-			new Elysia({ basePath: '/one' })
+			new Spiceflow({ basePath: '/one' })
 				.onRequest(({ request }) => {
 					oneOnReq = true
 				})
 				.get('/ids/:id', ({ params }) => params.id)
 		)
 		.use(
-			new Elysia({ basePath: '/two' })
+			new Spiceflow({ basePath: '/two' })
 				.onRequest((c) => {
 					twoOnReq = true
 				})
@@ -206,16 +206,16 @@ test('use with 2 basPath works', async () => {
 })
 
 test('use with nested basPath works', async () => {
-	const app = await new Elysia({ basePath: '/zero' })
+	const app = await new Spiceflow({ basePath: '/zero' })
 		.use(
-			new Elysia({ basePath: '/one' }).get(
+			new Spiceflow({ basePath: '/one' }).get(
 				'/ids/:id',
 				({ params }) => params.id
 			)
 		)
 		.use(
-			new Elysia({ basePath: '/two' }).use(
-				new Elysia({ basePath: '/nested' }).get(
+			new Spiceflow({ basePath: '/two' }).use(
+				new Spiceflow({ basePath: '/nested' }).get(
 					'/ids/:id',
 					({ params }) => params.id
 				)
@@ -241,7 +241,7 @@ test('use with nested basPath works', async () => {
 test('errors inside basPath works', async () => {
 	let onErrorTriggered = [] as string[]
 	let onReqTriggered = [] as string[]
-	const app = await new Elysia({ basePath: '/zero' })
+	const app = await new Spiceflow({ basePath: '/zero' })
 		.onError(({ error }) => {
 			onErrorTriggered.push('root')
 			// return new Response('root', { status: 500 })
@@ -252,7 +252,7 @@ test('errors inside basPath works', async () => {
 		})
 
 		.use(
-			new Elysia({ basePath: '/two' })
+			new Spiceflow({ basePath: '/two' })
 				.onError(({ error }) => {
 					onErrorTriggered.push('two')
 					// return new Response('two', { status: 500 })
@@ -262,7 +262,7 @@ test('errors inside basPath works', async () => {
 					// return new Response('two', { status: 500 })
 				})
 				.use(
-					new Elysia({ basePath: '/nested' })
+					new Spiceflow({ basePath: '/nested' })
 						.onError(({ error }) => {
 							onErrorTriggered.push('nested')
 							// return new Response('nested', { status: 500 })