spiceflow 1.0.0 → 1.0.1

package/src/spiceflow.ts

@@ -5,7 +5,7 @@ import { Type } from '@sinclair/typebox'
 export { Type as t }
 
 import {
-	ComposeElysiaResponse,
+	ComposeSpiceflowResponse,
 	CreateEden,
 	DefinitionBase,
 	EphemeralType,
@@ -65,7 +65,7 @@ type InternalRouterState = {
 /**
  * Router class
  */
-export class Elysia<
+export class Spiceflow<
 	const in out BasePath extends string = '',
 	const in out Scoped extends boolean = true,
 	const in out Singleton extends SingletonBase = {
@@ -159,7 +159,7 @@ export class Elysia<
 	state<const Name extends string | number | symbol, Value>(
 		name: Name,
 		value: Value
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		{
@@ -230,22 +230,7 @@ export class Elysia<
 	_ephemeral = {} as Ephemeral
 	_volatile = {} as Volatile
 
-	/**
-	 * ### post
-	 * Register handler for path with method [POST]
-	 *
-	 * ---
-	 * @example
-	 * ```typescript
-	 * import { Elysia, t } from 'elysia'
-	 *
-	 * new Elysia()
-	 *     .post('/', () => 'hi')
-	 *     .post('/with-hook', () => 'hi', {
-	 *         response: t.String()
-	 *     })
-	 * ```
-	 */
+	
 	post<
 		const Path extends string,
 		const LocalSchema extends InputSchema<
@@ -280,7 +265,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -297,7 +282,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -347,7 +332,7 @@ export class Elysia<
 			Macro,
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -364,7 +349,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -412,7 +397,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -429,7 +414,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -478,7 +463,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -495,7 +480,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -544,7 +529,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -561,7 +546,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -610,7 +595,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -627,7 +612,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -676,7 +661,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -693,7 +678,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -744,7 +729,7 @@ export class Elysia<
 			Metadata['macro'],
 			JoinPath<BasePath, Path>
 		>
-	): Elysia<
+	): Spiceflow<
 		BasePath,
 		Scoped,
 		Singleton,
@@ -761,7 +746,7 @@ export class Elysia<
 							: Schema['params']
 						query: Schema['query']
 						headers: Schema['headers']
-						response: ComposeElysiaResponse<
+						response: ComposeSpiceflowResponse<
 							Schema['response'],
 							Handle
 						>
@@ -777,7 +762,7 @@ export class Elysia<
 	}
 
 	/**
-	 * If set to true, other Elysia handler will not inherits global life-cycle, store, decorators from the current instance
+	 * If set to true, other Spiceflow handler will not inherits global life-cycle, store, decorators from the current instance
 	 *
 	 * @default false
 	 */
@@ -789,11 +774,11 @@ export class Elysia<
 	// group is not needed, you can add another prefixed app instead
 	// group<
 	// 	const Prefix extends string,
-	// 	const NewElysia extends Elysia<any, any, any, any, any, any, any, any>
+	// 	const NewSpiceflow extends Spiceflow<any, any, any, any, any, any, any, any>
 	// >(
 	// 	prefix: Prefix,
 	// 	run: (
-	// 		group: Elysia<
+	// 		group: Spiceflow<
 	// 			`${BasePath}${Prefix}`,
 	// 			Scoped,
 	// 			Singleton,
@@ -803,14 +788,14 @@ export class Elysia<
 	// 			Ephemeral,
 	// 			Volatile
 	// 		>
-	// 	) => NewElysia
-	// ): Elysia<
+	// 	) => NewSpiceflow
+	// ): Spiceflow<
 	// 	BasePath,
 	// 	Scoped,
 	// 	Singleton,
 	// 	Definitions,
 	// 	Metadata,
-	// 	Prettify<Routes & NewElysia['_routes']>,
+	// 	Prettify<Routes & NewSpiceflow['_routes']>,
 	// 	Ephemeral,
 	// 	Volatile
 	// > {
@@ -825,31 +810,31 @@ export class Elysia<
 	// 	return this
 	// }
 
-	use<const NewElysia extends AnyElysia>(
-		instance: NewElysia
-	): NewElysia['_scoped'] extends false
-		? Elysia<
+	use<const NewSpiceflow extends AnySpiceflow>(
+		instance: NewSpiceflow
+	): NewSpiceflow['_scoped'] extends false
+		? Spiceflow<
 				BasePath,
 				Scoped,
 				// @ts-expect-error - This is truly ideal
-				Prettify2<Singleton & NewElysia['_types']['Singleton']>,
-				Prettify2<Definitions & NewElysia['_types']['Definitions']>,
-				Prettify2<Metadata & NewElysia['_types']['Metadata']>,
+				Prettify2<Singleton & NewSpiceflow['_types']['Singleton']>,
+				Prettify2<Definitions & NewSpiceflow['_types']['Definitions']>,
+				Prettify2<Metadata & NewSpiceflow['_types']['Metadata']>,
 				BasePath extends ``
-					? Routes & NewElysia['_routes']
-					: Routes & CreateEden<BasePath, NewElysia['_routes']>,
+					? Routes & NewSpiceflow['_routes']
+					: Routes & CreateEden<BasePath, NewSpiceflow['_routes']>,
 				Ephemeral,
-				Prettify2<Volatile & NewElysia['_ephemeral']>
+				Prettify2<Volatile & NewSpiceflow['_ephemeral']>
 		  >
-		: Elysia<
+		: Spiceflow<
 				BasePath,
 				Scoped,
 				Singleton,
 				Definitions,
 				Metadata,
 				BasePath extends ``
-					? Routes & NewElysia['_routes']
-					: Routes & CreateEden<BasePath, NewElysia['_routes']>,
+					? Routes & NewSpiceflow['_routes']
+					: Routes & CreateEden<BasePath, NewSpiceflow['_routes']>,
 				Ephemeral,
 				Volatile
 		  > {
@@ -1263,4 +1248,4 @@ export async function turnHandlerResultIntoResponse(result: any) {
 	return new Response(JSON.stringify(result))
 }
 
-export type AnyElysia = Elysia<any, any, any, any, any, any, any, any>
+export type AnySpiceflow = Spiceflow<any, any, any, any, any, any, any, any>

package/src/stream.test.ts

@@ -2,7 +2,7 @@ import { describe, it, expect } from 'vitest'
 
 import { createParser } from 'eventsource-parser'
 
-import { Elysia } from './spiceflow'
+import { Spiceflow } from './spiceflow'
 
 import { req, sleep } from './utils'
 
@@ -21,7 +21,7 @@ describe('Stream', () => {
 	it('handle stream', async () => {
 		const expected = ['a', 'b', 'c']
 
-		const app = new Elysia().get('/', async function* () {
+		const app = new Spiceflow().get('/', async function* () {
 			yield 'a'
 			await sleep(10)
 
@@ -60,7 +60,7 @@ describe('Stream', () => {
 		expect(response).toBe(textEventStream(['a', 'b', 'c']))
 	})
 	it('handle errors after yield', async () => {
-		const app = new Elysia().get('/', async function* () {
+		const app = new Spiceflow().get('/', async function* () {
 			yield 'a'
 			await sleep(10)
 
@@ -75,7 +75,7 @@ describe('Stream', () => {
 	})
 
 	it('handle errors before yield when aot is false', async () => {
-		const app = new Elysia()
+		const app = new Spiceflow()
 			.onError(({ error }) => {
 				return new Response(error.message)
 			})
@@ -89,7 +89,7 @@ describe('Stream', () => {
 	})
 
 	it.todo('handle errors before yield when aot is true', async () => {
-		const app = new Elysia()
+		const app = new Spiceflow()
 			.onError(({ error }) => {
 				return new Response(error.message)
 			})
@@ -104,7 +104,7 @@ describe('Stream', () => {
 
 	it.todo('handle errors before yield with onError', async () => {
 		const expected = 'error expected'
-		const app = new Elysia()
+		const app = new Spiceflow()
 			.onError(({}) => {
 				return new Response(expected)
 			})
@@ -120,7 +120,7 @@ describe('Stream', () => {
 	it('stop stream on canceled request', async () => {
 		const expected = ['a', 'b']
 
-		const app = new Elysia().get('/', async function* () {
+		const app = new Spiceflow().get('/', async function* () {
 			yield 'a'
 			await sleep(10)
 
@@ -174,7 +174,7 @@ describe('Stream', () => {
 	// it('mutate set before yield is called', async () => {
 	// 	const expected = ['a', 'b', 'c']
 
-	// 	const app = new Elysia().get('/', function* () {
+	// 	const app = new Spiceflow().get('/', function* () {
 	// 		set.headers['access-control-allow-origin'] = 'http://saltyaom.com'
 
 	// 		yield 'a'
@@ -195,7 +195,7 @@ describe('Stream', () => {
 			{ data: [1, 2, 3] },
 			{ result: [4, 5, 6] }
 		]
-		const app = new Elysia().get('/', async function* ({}) {
+		const app = new Spiceflow().get('/', async function* ({}) {
 			for (const obj of objects) {
 				yield obj
 			}
@@ -228,7 +228,7 @@ describe('Stream', () => {
 	// it('mutate set before yield is called', async () => {
 	// 	const expected = ['a', 'b', 'c']
 
-	// 	const app = new Elysia().get('/', function* () {
+	// 	const app = new Spiceflow().get('/', function* () {
 	// 		set.headers['access-control-allow-origin'] = 'http://saltyaom.com'
 
 	// 		yield 'a'
@@ -246,7 +246,7 @@ describe('Stream', () => {
 	// it('async mutate set before yield is called', async () => {
 	// 	const expected = ['a', 'b', 'c']
 
-	// 	const app = new Elysia().get('/', async function* () {
+	// 	const app = new Spiceflow().get('/', async function* () {
 	// 		set.headers['access-control-allow-origin'] = 'http://saltyaom.com'
 
 	// 		yield 'a'
@@ -262,7 +262,7 @@ describe('Stream', () => {
 	// })
 
 	it('return value if not yield', async () => {
-		const app = new Elysia()
+		const app = new Spiceflow()
 			.get('/', function* () {
 				return 'hello'
 			})
@@ -282,7 +282,7 @@ describe('Stream', () => {
 	})
 
 	it('return async value if not yield', async () => {
-		const app = new Elysia()
+		const app = new Spiceflow()
 			.get('/', function* () {
 				return 'hello'
 			})
@@ -306,7 +306,7 @@ describe('Stream', () => {
 		const expectedResponse = JSON.stringify([...expected])
 		let i = 0
 
-		const app = new Elysia().get('/', async function* () {
+		const app = new Spiceflow().get('/', async function* () {
 			yield expected[0]
 			await sleep(10)