@server/next 0.40.4 → 0.42.0

package/index.d.ts

@@ -41,10 +41,14 @@ declare const redirect: (...args: Params<"redirect">) => Response;
 
 type Reply = ReturnType<typeof status>;
 type Method = "get" | "post" | "put" | "patch" | "delete" | "head" | "options" | "socket";
-type ServerConfig<Session = {}, User = {}> = {
-    Session?: Session;
-    User?: User;
+type ContextTypes = {
+    session?: any;
+    user?: any;
+    params?: any;
+    query?: any;
+    body?: any;
 };
+type Field<C, K extends keyof ContextTypes, Fallback> = K extends keyof C ? SchemaOutput<C[K], C[K]> : Fallback;
 declare namespace JSX {
     interface Element {
         type: any;
@@ -55,16 +59,49 @@ declare namespace JSX {
     }
 }
 type BodyMode = "parse" | "raw" | "stream";
-type BodyOption = BodyMode | {
-    mode?: BodyMode;
-    max?: number | string | false;
+type StandardIssue = {
+    readonly message: string;
+    readonly path?: readonly (PropertyKey | {
+        readonly key: PropertyKey;
+    })[];
 };
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    readonly "~standard": {
+        readonly version: 1;
+        readonly vendor: string;
+        readonly validate: (value: unknown) => {
+            value: Output;
+            issues?: undefined;
+        } | {
+            issues: readonly StandardIssue[];
+        } | Promise<{
+            value: Output;
+            issues?: undefined;
+        } | {
+            issues: readonly StandardIssue[];
+        }>;
+        readonly types?: {
+            readonly input: Input;
+            readonly output: Output;
+        };
+    };
+}
+type SchemaOutput<S, Fallback> = [S] extends [
+    StandardSchemaV1<any, infer Output>
+] ? Output : Fallback;
 type CacheOption = string | number | false;
-type RouteOptions = {
+type RouteSchema = {
     tags?: string | string[];
     title?: string;
     description?: string;
-    body?: BodyOption;
+};
+type RouteOptions = {
+    schema?: RouteSchema;
+    parser?: BodyMode;
+    body?: StandardSchemaV1<any, any>;
+    query?: StandardSchemaV1<any, any>;
+    params?: StandardSchemaV1<any, any>;
+    response?: StandardSchemaV1<any, any>;
     cache?: CacheOption;
 };
 type Route = {
@@ -145,10 +182,9 @@ type KVStore = {
 type Provider = "email" | "github" | "google" | "microsoft" | "discord" | "facebook" | "apple";
 type Strategy = "cookie" | "jwt" | "token";
 type AuthSession = {
-    id: string;
-    provider: Provider;
-    strategy: Strategy;
     user: string;
+    provider: Provider;
+    created: string;
 };
 type AuthUser<T = Record<string, any>> = T & {
     id: string | number;
@@ -163,22 +199,22 @@ type ProfileUser = {
 type AuthOption = `${Strategy}:${Provider}` | {
     strategy: Strategy;
     providers?: Provider | Provider[];
-    session?: StoreSource;
-    store?: StoreSource;
+    users?: StoreSource;
     redirect?: string;
     onProfile?: (raw: any, provider: Provider) => ProfileUser | Promise<ProfileUser>;
     onLogin?: (loginUser: AuthUser, existingUser: AuthUser | null, ctx: Context) => ProfileUser | Promise<ProfileUser>;
     onUser?: <T = AuthUser>(user: T, ctx: Context) => T | Promise<T>;
+    onToken?: (user: AuthUser, ctx: Context) => ProfileUser | Promise<ProfileUser>;
     onLogout?: (ctx: Context) => unknown;
 };
 type AuthSettings = {
     providers: Provider[];
     strategy: Strategy;
-    store: KVStore;
-    session: KVStore;
+    users: KVStore;
     onProfile?: (raw: any, provider: Provider) => ProfileUser | Promise<ProfileUser>;
     onLogin?: (loginUser: AuthUser, existingUser: AuthUser | null, ctx: Context) => ProfileUser | Promise<ProfileUser>;
     onUser: <T = AuthUser>(user: T, ctx: Context) => T | Promise<T>;
+    onToken: (user: AuthUser, ctx: Context) => ProfileUser | Promise<ProfileUser>;
     onLogout?: (ctx: Context) => unknown;
     redirect: string;
 };
@@ -197,6 +233,7 @@ type SecurityOptions = {
     hsts?: boolean | string;
     xssProtection?: boolean;
     traversalProtection?: boolean;
+    maxBody?: number | string | false;
     csp?: boolean | string;
     coop?: boolean | string;
     corp?: boolean | string;
@@ -205,6 +242,7 @@ type SecurityOptions = {
 type SecuritySettings = {
     trustProxy: boolean;
     traversalProtection: boolean;
+    maxBody: number;
     headers: Record<string, string>;
     hsts: string | null;
 };
@@ -215,10 +253,7 @@ type Options = {
     secret?: string;
     public?: string | Bucket;
     uploads?: string | Bucket | UploadOptions;
-    store?: StoreSource;
-    session?: StoreSource | {
-        store: StoreSource;
-    };
+    sessions?: StoreSource;
     cors?: CorsOptions;
     auth?: AuthOption;
     openapi?: any;
@@ -227,7 +262,7 @@ type Options = {
     log?: LogLevel | boolean;
     favicon?: string | BucketFile;
     security?: boolean | SecurityOptions;
-    body?: BodyOption;
+    parser?: BodyMode;
     cache?: CacheOption;
 };
 type Settings = {
@@ -237,10 +272,8 @@ type Settings = {
     uploads?: ({
         bucket: Bucket;
     } & LimitOptions) | null;
-    store?: KVStore;
-    session?: {
-        store: KVStore;
-    };
+    sessions: KVStore;
+    sessionsDefault?: boolean;
     cors?: CorsSettings;
     auth?: AuthSettings;
     openapi?: any;
@@ -249,7 +282,7 @@ type Settings = {
     log: Logger;
     favicon?: string | BucketFile;
     security: SecuritySettings;
-    body: BodyOption;
+    parser: BodyMode;
     cache?: CacheOption;
 };
 type Time = {
@@ -280,27 +313,23 @@ type BunEnv = Record<string, string> & {
 };
 interface ContextExtension {
 }
-type Context<Params extends Record<string, string | undefined> = Record<string, string>, O extends ServerConfig = object> = {
+type Context<C extends ContextTypes = {}> = {
     method: Method;
     ip: string;
     headers: Record<string, string | string[]>;
     cookies: Record<string, string>;
-    body?: SerializableValue | Buffer | ReadableStream;
+    body?: Field<C, "body", SerializableValue | Buffer | ReadableStream>;
     url: URL & {
-        params: Params;
-        query: Record<string, string>;
+        params: Field<C, "params", Record<string, any>>;
+        query: Field<C, "query", Record<string, any>>;
     };
     options: Settings;
     platform: Platform;
     time?: Time;
     socket?: WebSocket;
     sockets?: WebSocket[];
-    session: O extends {
-        Session?: infer S;
-    } ? S extends Record<"Session", infer Inner> ? Inner : Record<string, any> : Record<string, any>;
-    user?: O extends {
-        User?: infer U;
-    } ? U extends Record<"User", infer Inner> ? Inner : AuthUser : AuthUser;
+    session: Field<C, "session", Record<string, any>>;
+    user?: Field<C, "user", Record<string, any>>;
     init: number;
     req?: Request;
     res?: Response & {
@@ -313,7 +342,7 @@ type InlineReply = Response | Reply | BucketFile | {
     headers?: Headers;
 } | SerializableValue | JSX.Element | Buffer | ReadableStream;
 type Body = InlineReply;
-type Middleware<O extends ServerConfig = object, Params extends Record<string, string | undefined> = Record<string, string>> = (ctx: Context<Params, O>) => InlineReply | Promise<InlineReply> | void | Promise<void>;
+type Middleware<C extends ContextTypes = {}> = (ctx: Context<C>) => InlineReply | Promise<InlineReply> | void | Promise<void>;
 
 type Variables = Record<string, string | string[]>;
 type ExtendError = string | {
@@ -336,50 +365,68 @@ declare global {
     var env: Record<string, any>;
 }
 
-type Mids<O extends ServerConfig, Path extends string> = Middleware<O, PathToParams<Path>>[];
-declare class Router<O extends ServerConfig = object> {
+type Fn<C extends ContextTypes> = (ctx: Context<C>) => ReturnType<Middleware>;
+type RouteCtx<C extends ContextTypes, RO extends RouteOptions, Params> = Omit<C, "params" | "query" | "body"> & {
+    params: [RO["params"]] extends [StandardSchemaV1<any, any>] ? RO["params"] : Params;
+} & Pick<RO, keyof RO & ("query" | "body")>;
+type Mids<C extends ContextTypes, Path extends string, RO extends RouteOptions = {}> = Fn<RouteCtx<C, RO, PathToParams<Path>>>[];
+type Exact<RO> = RouteOptions & {
+    [K in Exclude<keyof RO, keyof RouteOptions>]: never;
+};
+declare class Router<C extends ContextTypes = {}> {
     middleware: Middleware[];
     handlers: Record<Method, Route[]>;
     self(): this;
     handle(method: Method, pathOrFn?: any, ...rest: any[]): this;
-    socket<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    socket<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    socket(...middleware: Middleware<O>[]): this;
-    socket(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    get<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    get<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    get(...middleware: Middleware<O>[]): this;
-    get(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    head<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    head<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    head(...middleware: Middleware<O>[]): this;
-    head(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    post<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    post<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    post(...middleware: Middleware<O>[]): this;
-    post(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    put<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    put<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    put(...middleware: Middleware<O>[]): this;
-    put(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    patch<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    patch<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    patch(...middleware: Middleware<O>[]): this;
-    patch(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    delete<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    delete<Path extends string>(path: Path, options: RouteOptions, ...middleware: Mids<O, Path>): this;
-    delete(...middleware: Middleware<O>[]): this;
-    delete(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    options<Path extends string>(path: Path, ...middleware: Mids<O, Path>): this;
-    options<Path extends string>(path: Path, options: RouteOptions, ...mid: Mids<O, Path>): this;
-    options(...middleware: Middleware<O>[]): this;
-    options(options: RouteOptions, ...middleware: Middleware<O>[]): this;
-    use(...middleware: Middleware[]): this;
-    use(router: Router): this;
+    socket<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    socket(...middleware: Fn<C>[]): this;
+    socket<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    socket<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    get<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    get(...middleware: Fn<C>[]): this;
+    get<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    get<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    head<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    head(...middleware: Fn<C>[]): this;
+    head<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    head<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    post<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    post(...middleware: Fn<C>[]): this;
+    post<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    post<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    put<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    put(...middleware: Fn<C>[]): this;
+    put<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    put<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    patch<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    patch(...middleware: Fn<C>[]): this;
+    patch<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    patch<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    delete<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    delete(...middleware: Fn<C>[]): this;
+    delete<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    delete<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...middleware: Mids<C, Path, RO>): this;
+    options<Path extends string>(path: Path, ...middleware: Mids<C, Path>): this;
+    options(...middleware: Fn<C>[]): this;
+    options<RO extends Exact<RO>>(options: RO, ...middleware: Fn<RouteCtx<C, RO, Record<string, string>>>[]): this;
+    options<Path extends string, RO extends Exact<RO>>(path: Path, options: RO, ...mid: Mids<C, Path, RO>): this;
+    use(...middleware: Fn<C>[]): this;
+    use(router: Router<any>): this;
 }
-declare function router(): Router;
+declare function router<C extends ContextTypes = {}>(): Router<C>;
 
-declare class Server<O extends ServerConfig = {}> extends Router<O> {
+declare class StatusError extends Error {
+    status: number;
+    constructor(msg: string, status?: number);
+}
+
+declare class ValidationError extends StatusError {
+    source: "body" | "query" | "params" | "response";
+    issues: readonly StandardIssue[];
+    constructor(source: "body" | "query" | "params" | "response", issues: readonly StandardIssue[]);
+}
+
+declare class Server<C extends ContextTypes = {}> extends Router<C> {
     settings: Settings;
     platform: Platform;
     sockets: any[];
@@ -397,111 +444,111 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
     callback(request: Request, context: unknown): Promise<Response>;
     test(): {
         get: (path: string, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
         head: (path: string, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        post: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
+        post: (path: string, body?: string | number | boolean | ArrayBuffer | {
             [key: string]: SerializableValue;
-        } | SerializableValue[], options?: {
+        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        put: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
+        put: (path: string, body?: string | number | boolean | ArrayBuffer | {
             [key: string]: SerializableValue;
-        } | SerializableValue[], options?: {
+        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
-        patch: (path: string, body?: string | number | boolean | ArrayBuffer | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams | {
+        patch: (path: string, body?: string | number | boolean | ArrayBuffer | {
             [key: string]: SerializableValue;
-        } | SerializableValue[], options?: {
+        } | SerializableValue[] | ReadableStream<any> | Blob | ArrayBufferView<ArrayBuffer> | FormData | URLSearchParams, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
         delete: (path: string, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
             window?: null;
         }) => Promise<Response>;
         options: (path: string, options?: {
+            method?: string;
+            headers?: HeadersInit;
             cache?: RequestCache;
+            redirect?: RequestRedirect;
             credentials?: RequestCredentials;
-            headers?: HeadersInit;
             integrity?: string;
             keepalive?: boolean;
-            method?: string;
             mode?: RequestMode;
             priority?: RequestPriority;
-            redirect?: RequestRedirect;
             referrer?: string;
             referrerPolicy?: ReferrerPolicy;
             signal?: AbortSignal | null;
@@ -509,6 +556,6 @@ declare class Server<O extends ServerConfig = {}> extends Router<O> {
         }) => Promise<Response>;
     };
 }
-declare function server<Session extends Record<string, any> = {}, User extends Record<string, any> = {}>(options?: Options): Server<ServerConfig<Session, User>>;
+declare function server<C extends ContextTypes = {}>(options?: Options): Server<C>;
 
-export { type AuthOption, type AuthSession, type AuthSettings, type AuthUser, type BasicValue, type Body, type BodyMode, type BodyOption, type Bucket, type BucketFile, type BunEnv, type CacheOption, type Context, type ContextExtension, type Cookie, type CorsSettings, type ExtractPathParams, type FileInfo, type InferParamType, type InlineReply, type KVStore, type LogLevel, type Logger, type Method, type Middleware, type Options, type ParamTypeMap, type ParamsToObject, type PathToParams, type Platform, type ProfileUser, type Provider, type Route, type RouteOptions, type RouterMethod, type SecurityOptions, type SecuritySettings, type SerializableValue, Server, type ServerConfig, TypedServerError as ServerError, type Settings, type StoreSource, type Strategy, type Time, type UploadOptions, type UploadedFile, cache, cookies, server as default, download, file, headers, json, redirect, router, send, status, type };
+export { type AuthOption, type AuthSession, type AuthSettings, type AuthUser, type BasicValue, type Body, type BodyMode, type Bucket, type BucketFile, type BunEnv, type CacheOption, type Context, type ContextExtension, type ContextTypes, type Cookie, type CorsSettings, type ExtractPathParams, type FileInfo, type InferParamType, type InlineReply, type KVStore, type LogLevel, type Logger, type Method, type Middleware, type Options, type ParamTypeMap, type ParamsToObject, type PathToParams, type Platform, type ProfileUser, type Provider, type Route, type RouteOptions, type RouteSchema, type RouterMethod, type SchemaOutput, type SecurityOptions, type SecuritySettings, type SerializableValue, Server, TypedServerError as ServerError, type Settings, type StandardIssue, type StandardSchemaV1, type StoreSource, type Strategy, type Time, type UploadOptions, type UploadedFile, ValidationError, cache, cookies, server as default, download, file, headers, json, redirect, router, send, status, type };