@sourceregistry/node-webserver 1.2.3 → 1.3.0

package/dist/types/router.d.ts

@@ -17,15 +17,15 @@ export type ExtractSegmentParam<S extends string> = S extends `[...${infer Param
     [K in Param]: string;
 } : {};
 export type MergeParams<A, B> = A & B;
-export type RouteHandler<Path extends string, Locals extends Record<string, any> = {}> = (event: RequestEvent<ExtractPathParams<Path> & RequestEvent['params'], Path, Locals>) => MaybePromise<Response>;
+export type RouteHandler<Path extends string, Locals extends App.Locals = App.Locals> = (event: RequestEvent<ExtractPathParams<Path> & RequestEvent['params'], Path, Locals>) => MaybePromise<Response>;
 export type ActionHandler<Path extends string, OutputData extends Record<string, any> = Record<string, any>> = Action<ExtractPathParams<Path>, OutputData>;
 export type Action<Params extends Partial<Record<string, string>> = Partial<Record<string, string>>, OutputData extends Record<string, any> | void = Record<string, any> | void> = (event: RequestEvent<Params>) => MaybePromise<OutputData>;
-export type Middleware<Path extends string = string, AddedLocals extends Record<string, any> = {}> = (event: RequestEvent<any, Path, any> & {
-    locals: Record<string, any> & AddedLocals;
-}, next: () => MaybePromise<Response | undefined>) => MaybePromise<Response | undefined>;
-export type PreHandler<Locals extends Record<string, any> = {}> = (event: RequestEvent<any, string, Locals>) => MaybePromise<Response | void>;
-export type PostHandler<Locals extends Record<string, any> = {}> = (event: RequestEvent<any, string, Locals>, response: Response) => MaybePromise<Response | void>;
-export type WebSocketHandler<Path extends string, Locals extends Record<string, any> = {}> = (event: RequestEvent<ExtractPathParams<Path> & RequestEvent['params'], Path, Locals> & {
+export type Middleware<Path extends string = string, AddedLocals extends App.Locals = App.Locals> = (event: MiddlewareEvent<Path, AddedLocals>, next: NextFunction) => MaybePromise<Response | undefined>;
+export type NextFunction = () => MaybePromise<Response | undefined>;
+export type MiddlewareEvent<Path extends string = string, AddedLocals extends App.Locals = App.Locals> = RequestEvent<any, Path | null, App.Locals & AddedLocals>;
+export type PreHandler<Locals extends App.Locals = App.Locals> = (event: RequestEvent<any, string, Locals>) => MaybePromise<Response | void>;
+export type PostHandler<Locals extends App.Locals = App.Locals> = (event: RequestEvent<any, string, Locals>, response: Response) => MaybePromise<Response | void>;
+export type WebSocketHandler<Path extends string, Locals extends App.Locals = App.Locals> = (event: RequestEvent<ExtractPathParams<Path> & RequestEvent['params'], Path, Locals> & {
     websocket: WebSocket;
 }) => MaybePromise<any>;
 export interface Route<Path extends string> {
@@ -67,9 +67,9 @@ export declare class Router<Locals extends App.Locals = App.Locals> {
     OPTIONS<Path extends string>(path: Path, handler: RouteHandler<Path, Locals>, ...middlewares: Middleware<Path, any>[]): Router<Locals>;
     USE<Path extends string>(path: Path, handler: RouteHandler<Path, Locals>, ...middlewares: Middleware<Path, any>[]): Router<Locals>;
     action<Path extends string, OutputData extends Record<string, any> = Record<string, any>>(path: Path, handler: ActionHandler<Path, OutputData>, ...middlewares: Middleware<Path, any>[]): Router<Locals>;
-    use<Prefix extends string, InnerLocals extends Record<string, any>>(input: readonly [Prefix, Router<InnerLocals>, ...Middleware<Prefix>[]]): Router<Locals & InnerLocals>;
-    use<Prefix extends string, InnerLocals extends Record<string, any>>(prefix: Prefix, router: Router<InnerLocals>, ...middlewares: Middleware<Prefix>[]): Router<Locals & InnerLocals>;
-    useMiddleware<NewLocals extends Record<string, any>>(...mw: Middleware<string, NewLocals>[]): Router<Locals & NewLocals>;
+    use<Prefix extends string, InnerLocals extends App.Locals = App.Locals>(input: readonly [Prefix, Router<InnerLocals>, ...Middleware<Prefix>[]]): Router<Locals & InnerLocals>;
+    use<Prefix extends string, InnerLocals extends App.Locals = App.Locals>(prefix: Prefix, router: Router<InnerLocals>, ...middlewares: Middleware<Prefix>[]): Router<Locals & InnerLocals>;
+    useMiddleware<NewLocals extends App.Locals = App.Locals>(...mw: Middleware<string, NewLocals>[]): Router<Locals & NewLocals>;
     pre(...handlers: PreHandler<Locals>[]): Router<Locals>;
     post(...handlers: PostHandler<Locals>[]): Router<Locals>;
     discard(path_or_prefix: string, method?: RequestMethod): this;

package/dist/types/server.d.ts

@@ -3,7 +3,7 @@ import { ServerOptions as HttpsServerOptions } from 'https';
 import { RequestEvent, Router } from './';
 import { ListenOptions } from 'net';
 type HostMatcher = string | RegExp | ((host: string) => boolean);
-type InferServerLocals<TServerConfig extends ServerConfig> = Extract<TServerConfig['locals'], (event: RequestEvent) => any> extends (event: RequestEvent) => infer TLocals ? TLocals extends Record<string, any> ? TLocals : App.Locals : App.Locals;
+type InferServerLocals<TServerConfig extends ServerConfig> = Extract<TServerConfig['locals'], (event: RequestEvent) => any> extends (event: RequestEvent) => infer TLocals ? TLocals extends App.Locals ? TLocals : App.Locals : App.Locals;
 export type SecurityConfig = {
     /**
      * Trust the incoming Host header when constructing event.url/request.url.
@@ -78,6 +78,10 @@ export declare class WebServer<TServerConfig extends ServerConfig = ServerConfig
     private sendWebResponse;
     private shouldOmitResponseBody;
     private isAllowedWebSocketOrigin;
+    private createEventFetch;
+    private toEventFetchRequest;
+    private withInheritedRequestHeaders;
+    private inheritRequestHeader;
     private toRequestEvent;
 }
 export {};

package/examples/enhanced.ts

@@ -0,0 +1,12 @@
+// import {text, WebServer} from "@sourceregistry/node-webserver";
+import {enhance, text, WebServer} from "../src";
+
+const server = new WebServer();
+
+server.pre(({request}) => console.log(`[${request.method}] ${request.url}`));
+
+server.GET('/', enhance(({context: {enhanced}}) => text(`Hello ${enhanced ? "enhanced" : "normal"} world!`), () => ({enhanced: true})))
+
+server.listen(3000, () => {
+    console.log("Server listening on port 3000");
+})

package/examples/simple.ts

@@ -1,10 +1,10 @@
-import {WebServer} from "../src";
+import {WebServer, text} from "../src";
 
 const server = new WebServer();
 
 server.pre(({request}) => console.log(`[${request.method}] ${request.url}`));
 
-server.GET('/', () => new Response('Hello world!'))
+server.GET('/', () => text('Hello world!'))
 
 server.listen(3000, () => {
     console.log("Server listening on port 3000");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sourceregistry/node-webserver",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "TypeScript web server for Node.js with web-standard Request and Response APIs",
   "type": "module",
   "main": "./dist/index.cjs.js",