@cfworker/web 2.1.0 → 3.0.0

package/src/router.ts

@@ -2,26 +2,34 @@ import { Key, pathToRegexp, PathToRegexpOptions } from 'path-to-regexp';
 import { Context } from './context.js';
 import { composeMiddleware, Middleware } from './middleware.js';
 
-export const Method = (method: string) => {
+export type Predicate = (context: Context) => boolean;
+
+export const Method: (method: string) => Predicate = (method: string) => {
   method = method.toUpperCase();
   return ({ req }: Context) => req.method === method;
 };
-export const Get = Method('get');
-export const Post = Method('post');
-export const Put = Method('put');
-export const Patch = Method('patch');
-export const Delete = Method('delete');
-export const Head = Method('head');
-export const Options = Method('options');
-
-export const Header = (header: string, value: string) => {
+export const Get: Predicate = Method('get');
+export const Post: Predicate = Method('post');
+export const Put: Predicate = Method('put');
+export const Patch: Predicate = Method('patch');
+export const Delete: Predicate = Method('delete');
+export const Head: Predicate = Method('head');
+export const Options: Predicate = Method('options');
+
+export const Header: (header: string, value: string) => Predicate = (
+  header: string,
+  value: string
+) => {
   value = value.toLowerCase();
   return ({ req }: Context) => req.headers.get(header) === value;
 };
-export const Host = (host: string) => Header('host', host);
-export const Referer = (host: string) => Header('referer', host);
+export const Host: (host: string) => Predicate = (host: string) =>
+  Header('host', host);
 
-export const Path = (pattern: string, options?: PathToRegexpOptions) => {
+export const Path: (
+  pattern: string,
+  options?: PathToRegexpOptions
+) => Predicate = (pattern: string, options?: PathToRegexpOptions) => {
   const regExp = pathToRegexp(pattern, options);
 
   return ({ req: { url, params } }: Context) => {
@@ -56,37 +64,37 @@ export class Router {
     this.routes = [];
   }
 
-  public get(pathname: string, ...middleware: Middleware[]) {
+  public get(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Get, Path(pathname, opts)], ...middleware);
   }
 
-  public post(pathname: string, ...middleware: Middleware[]) {
+  public post(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Post, Path(pathname, opts)], ...middleware);
   }
 
-  public put(pathname: string, ...middleware: Middleware[]) {
+  public put(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Put, Path(pathname, opts)], ...middleware);
   }
 
-  public patch(pathname: string, ...middleware: Middleware[]) {
+  public patch(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Patch, Path(pathname, opts)], ...middleware);
   }
 
-  public delete(pathname: string, ...middleware: Middleware[]) {
+  public delete(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Delete, Path(pathname, opts)], ...middleware);
   }
 
-  public head(pathname: string, ...middleware: Middleware[]) {
+  public head(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Head, Path(pathname, opts)], ...middleware);
   }
 
-  public all(pathname: string, ...middleware: Middleware[]) {
+  public all(pathname: string, ...middleware: Middleware[]): Router {
     const opts = this.options.pathToRegExpOptions;
     return this.compose([Path(pathname, opts)], ...middleware);
   }
@@ -101,7 +109,10 @@ export class Router {
     }
   };
 
-  public compose(conditions: RouteCondition[], ...middleware: Middleware[]) {
+  public compose(
+    conditions: RouteCondition[],
+    ...middleware: Middleware[]
+  ): Router {
     this.routes.push({
       conditions,
       middleware: composeMiddleware(middleware)
@@ -109,7 +120,7 @@ export class Router {
     return this;
   }
 
-  public resolve(ctx: Context) {
+  public resolve(ctx: Context): Route | undefined {
     return this.routes.find(
       ({ conditions }) =>
         conditions.length === 0 || conditions.every(c => c(ctx))

package/src/validate.ts

@@ -30,7 +30,7 @@ const hasBody: Record<string, true> = {
 function middlewareFactory(
   schemas: RequestSchemas,
   parser: RequestParser = Object.fromEntries,
-  lookup = Object.create(null)
+  lookup: Record<string, Schema | boolean> = Object.create(null)
 ): Middleware {
   const {
     headers: $headers,
@@ -118,4 +118,4 @@ function validateRequestPart(
   throw new HttpError(400, errorBody);
 }
 
-export const validate = middlewareFactory;
+export const validate: typeof middlewareFactory = middlewareFactory;

package/dist/router.d.ts

@@ -1,39 +0,0 @@
-import { PathToRegexpOptions } from 'path-to-regexp';
-import { Context } from './context.js';
-import { Middleware } from './middleware.js';
-export declare const Method: (method: string) => ({ req }: Context) => boolean;
-export declare const Get: ({ req }: Context) => boolean;
-export declare const Post: ({ req }: Context) => boolean;
-export declare const Put: ({ req }: Context) => boolean;
-export declare const Patch: ({ req }: Context) => boolean;
-export declare const Delete: ({ req }: Context) => boolean;
-export declare const Head: ({ req }: Context) => boolean;
-export declare const Options: ({ req }: Context) => boolean;
-export declare const Header: (header: string, value: string) => ({ req }: Context) => boolean;
-export declare const Host: (host: string) => ({ req }: Context) => boolean;
-export declare const Referer: (host: string) => ({ req }: Context) => boolean;
-export declare const Path: (pattern: string, options?: PathToRegexpOptions) => ({ req: { url, params } }: Context) => boolean;
-export type RouteCondition = (context: Context) => boolean;
-export interface Route {
-    conditions: RouteCondition[];
-    middleware: Middleware;
-}
-export interface RouterOptions {
-    pathToRegExpOptions?: PathToRegexpOptions;
-}
-export declare const defaultRouterOptions: RouterOptions;
-export declare class Router {
-    private readonly options;
-    private readonly routes;
-    constructor(options?: RouterOptions);
-    get(pathname: string, ...middleware: Middleware[]): this;
-    post(pathname: string, ...middleware: Middleware[]): this;
-    put(pathname: string, ...middleware: Middleware[]): this;
-    patch(pathname: string, ...middleware: Middleware[]): this;
-    delete(pathname: string, ...middleware: Middleware[]): this;
-    head(pathname: string, ...middleware: Middleware[]): this;
-    all(pathname: string, ...middleware: Middleware[]): this;
-    middleware: Middleware;
-    compose(conditions: RouteCondition[], ...middleware: Middleware[]): this;
-    resolve(ctx: Context): Route | undefined;
-}