elysia 0.7.0-beta.1 → 0.7.0

package/README.md

@@ -3,16 +3,12 @@
   <img width=480 src=https://user-images.githubusercontent.com/35027979/205498891-b75dc404-3232-4929-b216-823aa7373b71.png alt='Elysia label' />
 </p>
 
-<p align=center>Fast and friendly <a href=https://bun.sh>Bun</a> web framework.</p>
+<p align=center>Ergonomic Framework for Human</p>
 
 <p align=center>
     <a href=https://elysiajs.com>Documentation</a> | <a href=https://discord.gg/eaFJ2KDJck>Discord</a>
 </p>
 
-<h6 align=center>
-    Formerly known as <a href="https://github.com/saltyaom/kingworld">KingWorld</a>
-</h6>
-
 ## Philosophies
 Building on top of 3 philosophies:
 

package/dist/bun/index.d.ts

@@ -3,7 +3,7 @@ import type { Serve, Server } from 'bun';
 import type { Static, TSchema } from '@sinclair/typebox';
 import type { Context } from './context';
 import type { WS } from './ws/types';
-import type { ElysiaConfig, DecoratorBase, DefinitionBase, RouteBase, Handler, InputSchema, LocalHook, MergeSchema, RouteSchema, UnwrapRoute, InternalRoute, HTTPMethod, VoidHandler, PreHandler, BodyHandler, OptionalHandler, AfterHandler, ErrorHandler, LifeCycleStore, MaybePromise, Prettify, ListenCallback, AddPrefix, AddSuffix, AddPrefixCapitalize, AddSuffixCapitalize, TraceReporter, TraceHandler, MaybeArray, IsAny } from './types';
+import type { ElysiaConfig, DecoratorBase, DefinitionBase, RouteBase, Handler, InputSchema, LocalHook, MergeSchema, RouteSchema, UnwrapRoute, InternalRoute, HTTPMethod, VoidHandler, PreHandler, BodyHandler, OptionalHandler, AfterHandler, ErrorHandler, LifeCycleStore, MaybePromise, Prettify, ListenCallback, AddPrefix, AddSuffix, AddPrefixCapitalize, AddSuffixCapitalize, TraceReporter, TraceHandler, MaybeArray } from './types';
 export default class Elysia<BasePath extends string = '', Decorators extends DecoratorBase = {
     request: {};
     store: {};
@@ -95,7 +95,7 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
     }, Prettify<ParentSchema & PluginSchema>, Prettify<Routes & NewElysia['schema']>> : this;
     guard<const LocalSchema extends InputSchema, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(hook: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], BasePath>): Elysia<BasePath, Decorators, Definitions, Route, Routes, Scoped>;
     guard<const LocalSchema extends InputSchema<Extract<keyof Definitions['type'], string>>, const NewElysia extends Elysia<any, any, any, any, any, any>, const Schema extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(schema: LocalHook<LocalSchema, Schema, Decorators, Definitions['error']>, run: (group: Elysia<BasePath, Decorators, Definitions, Schema, {}, Scoped>) => NewElysia): NewElysia extends Elysia<any, infer PluginDecorators, infer PluginDefinitions, infer PluginSchema, any> ? Elysia<BasePath, PluginDecorators, PluginDefinitions, PluginSchema, Prettify<Routes & NewElysia['schema']>> : this;
-    use<NewElysia extends Elysia<any, any, any, any, any, any>>(plugin: MaybePromise<(app: NewElysia extends Elysia<infer A, any, any, any, any, any> ? IsAny<A> extends true ? this : NewElysia : NewElysia) => MaybePromise<NewElysia>>): NewElysia extends Elysia<any, infer PluginDecorators, infer PluginDefinitions, infer PluginSchema, any> ? Elysia<BasePath, {
+    use<NewElysia extends Elysia<any, any, any, any, any, any> = this>(plugin: MaybePromise<(app: NewElysia) => MaybePromise<NewElysia>>): NewElysia extends Elysia<any, infer PluginDecorators, infer PluginDefinitions, infer PluginSchema, any> ? Elysia<BasePath, {
         request: Prettify<Decorators['request'] & PluginDecorators['request']>;
         store: Prettify<Decorators['store'] & PluginDecorators['store']>;
     }, {
@@ -143,19 +143,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    get<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            get: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     post<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             post: {
@@ -169,19 +156,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    post<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            post: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     put<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             put: {
@@ -195,19 +169,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    put<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            put: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     patch<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             patch: {
@@ -221,19 +182,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    patch<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            patch: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     delete<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             delete: {
@@ -247,19 +195,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    delete<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            delete: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     options<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             options: {
@@ -273,19 +208,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    options<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            options: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     all<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             [method in string]: {
@@ -299,19 +221,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    all<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            [method in string]: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     head<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             head: {
@@ -325,19 +234,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    head<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            head: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     connect<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>>(path: Path, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             connect: {
@@ -351,19 +247,6 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    connect<const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>>(path: Paths, handler: Function, hook?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Paths[number]}`]: {
-            connect: {
-                body: Route['body'];
-                params: Route['params'];
-                query: Route['query'];
-                headers: Route['headers'];
-                response: unknown extends Route['response'] ? {
-                    200: ReturnType<Function>;
-                } : Route['response'];
-            };
-        };
-    }>, Scoped>;
     ws<const Path extends string, const LocalSchema extends InputSchema<keyof Definitions['type'] & string>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(path: Path, options: WS.LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`>): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
         [path in `${BasePath}${Path}`]: {
             subscribe: {
@@ -375,30 +258,7 @@ export default class Elysia<BasePath extends string = '', Decorators extends Dec
             };
         };
     }>, Scoped>;
-    route<const Method extends HTTPMethod, const Path extends string, const LocalSchema extends InputSchema<Extract<keyof Definitions['type'], string>>, const Function extends Handler<Route, Decorators, `${BasePath}${Path}`>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(method: Method, path: Path, handler: Function, options?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Path}`> & {
-        config: {
-            allowMeta?: boolean;
-        };
-    }): Elysia<BasePath, Decorators, Definitions, ParentSchema, Prettify<Routes & {
-        [path in `${BasePath}${Path}`]: {
-            [method in string]: Route extends {
-                body: infer Body;
-                params: infer Params;
-                query: infer Query;
-                headers: infer Headers;
-                response: infer Response;
-            } ? {
-                body: Body;
-                params: Params;
-                query: Query;
-                headers: Headers;
-                response: unknown extends Response ? {
-                    200: ReturnType<Function>;
-                } : Response;
-            } : never;
-        };
-    }>, Scoped>;
-    route<const Method extends HTTPMethod, const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<Extract<keyof Definitions['type'], string>>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(method: Method, path: Paths, handler: Function, options: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`> & {
+    route<const Method extends HTTPMethod, const Paths extends Readonly<string[]>, const LocalSchema extends InputSchema<Extract<keyof Definitions['type'], string>>, const Function extends Handler<Route, Decorators, `${BasePath}${Paths[number]}`>, const Route extends MergeSchema<UnwrapRoute<LocalSchema, Definitions['type']>, ParentSchema>>(method: Method, path: Paths, handler: Function, { config, ...hook }?: LocalHook<LocalSchema, Route, Decorators, Definitions['error'], `${BasePath}${Paths[number]}`> & {
         config: {
             allowMeta?: boolean;
         };
@@ -513,6 +373,6 @@ export { mapResponse, mapCompactResponse, mapEarlyResponse } from './handler';
 export { t } from './custom-types';
 export { Cookie } from './cookie';
 export { getSchemaValidator, mergeDeep, mergeHook, mergeObjectArray, getResponseSchemaValidator } from './utils';
-export { ParseError, NotFoundError, ValidationError, InternalServerError } from './error';
+export { ParseError, NotFoundError, ValidationError, InternalServerError, InvalidCookieSignature } from './error';
 export type { Context, PreContext } from './context';
-export type { ElysiaConfig, DecoratorBase, DefinitionBase, RouteBase, Handler, ComposedHandler, InputSchema, LocalHook, MergeSchema, RouteSchema, UnwrapRoute, InternalRoute, HTTPMethod, SchemaValidator, VoidHandler, PreHandler, BodyHandler, OptionalHandler, ErrorHandler, LifeCycleStore, MaybePromise, ListenCallback, UnwrapSchema } from './types';
+export type { ElysiaConfig, DecoratorBase, DefinitionBase, RouteBase, Handler, ComposedHandler, InputSchema, LocalHook, MergeSchema, RouteSchema, UnwrapRoute, InternalRoute, HTTPMethod, SchemaValidator, VoidHandler, PreHandler, BodyHandler, OptionalHandler, ErrorHandler, AfterHandler, TraceHandler, TraceStream, LifeCycleEvent, TraceEvent, LifeCycleStore, MaybePromise, ListenCallback, UnwrapSchema } from './types';