routup 3.0.0 → 3.1.0

package/dist/response/helpers/send-web-blob.d.ts

@@ -1,3 +1,3 @@
 import type { WebBlob } from '../../types';
 import type { Response } from '../types';
-export declare function sendWebBlob(res: Response, blob: WebBlob): Promise<unknown>;
+export declare function sendWebBlob(res: Response, blob: WebBlob): Promise<void>;

package/dist/response/helpers/send-web-response.d.ts

@@ -1,3 +1,3 @@
 import type { WebResponse } from '../../types';
 import type { Response } from '../types';
-export declare function sendWebResponse(res: Response, webResponse: WebResponse): Promise<unknown>;
+export declare function sendWebResponse(res: Response, webResponse: WebResponse): Promise<void>;

package/dist/router/constants.d.ts

@@ -1 +1,9 @@
 export declare const RouterSymbol: unique symbol;
+export declare enum RouterPipelineStep {
+    START = 0,
+    LOOKUP = 1,
+    CHILD_BEFORE = 2,
+    CHILD_DISPATCH = 3,
+    CHILD_AFTER = 4,
+    FINISH = 5
+}

package/dist/router/index.d.ts

@@ -1,2 +1 @@
 export * from './module';
-export { isRouterInstance } from './utils';

package/dist/router/module.d.ts

@@ -1,11 +1,14 @@
 import { MethodName } from '../constants';
-import type { Dispatcher, DispatcherEvent, DispatcherMeta } from '../dispatcher';
-import type { Handler } from '../handler';
-import { Layer } from '../layer';
+import type { DispatchEvent, Dispatcher } from '../dispatcher';
+import type { HandlerConfig } from '../handler';
+import { Handler } from '../handler';
+import type { HookDefaultListener, HookErrorListener, HookListener, HookUnsubscribeFn } from '../hook';
+import { HookManager, HookName } from '../hook';
 import type { Path } from '../path';
 import { PathMatcher } from '../path';
-import type { RouterOptionsInput } from '../router-options';
 import type { Plugin, PluginInstallContext } from '../plugin';
+import type { RouterOptionsInput } from '../router-options';
+import type { RouterPipelineContext } from './types';
 export declare class Router implements Dispatcher {
     readonly '@instanceof': symbol;
     /**
@@ -21,37 +24,66 @@ export declare class Router implements Dispatcher {
      *
      * @protected
      */
-    protected stack: (Router | Layer)[];
+    protected stack: (Router | Handler)[];
     /**
      * Path matcher for the current mount path.
      *
      * @protected
      */
     protected pathMatcher: PathMatcher | undefined;
+    /**
+     * A hook manager.
+     *
+     * @protected
+     */
+    protected hookManager: HookManager;
     constructor(options?: RouterOptionsInput);
-    setPath(value?: Path): void;
     matchPath(path: string): boolean;
-    dispatch(event: DispatcherEvent, meta: DispatcherMeta): Promise<boolean>;
-    delete(...handlers: Handler[]): this;
-    delete(path: Path, ...handlers: Handler[]): this;
-    get(...handlers: Handler[]): this;
-    get(path: Path, ...handlers: Handler[]): this;
-    post(...handlers: Handler[]): this;
-    post(path: Path, ...handlers: Handler[]): this;
-    put(...handlers: Handler[]): this;
-    put(path: Path, ...handlers: Handler[]): this;
-    patch(...handlers: Handler[]): this;
-    patch(path: Path, ...handlers: Handler[]): this;
-    head(...handlers: Handler[]): this;
-    head(path: Path, ...handlers: Handler[]): this;
-    options(...handlers: Handler[]): this;
-    options(path: Path, ...handlers: Handler[]): this;
-    protected useForMethod(method: `${MethodName}`, ...input: (Path | Handler)[]): void;
+    setPath(value?: Path): void;
+    protected executePipelineStep(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepStart(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepLookup(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepChildBefore(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepChildAfter(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepChildDispatch(context: RouterPipelineContext): Promise<void>;
+    protected executePipelineStepFinish(context: RouterPipelineContext): Promise<void>;
+    dispatch(event: DispatchEvent): Promise<void>;
+    delete(...handlers: (Handler | HandlerConfig)[]): this;
+    delete(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    get(...handlers: (Handler | HandlerConfig)[]): this;
+    get(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    post(...handlers: (Handler | HandlerConfig)[]): this;
+    post(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    put(...handlers: (Handler | HandlerConfig)[]): this;
+    put(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    patch(...handlers: (Handler | HandlerConfig)[]): this;
+    patch(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    head(...handlers: (Handler | HandlerConfig)[]): this;
+    head(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    options(...handlers: (Handler | HandlerConfig)[]): this;
+    options(path: Path, ...handlers: (Handler | HandlerConfig)[]): this;
+    protected useForMethod(method: MethodName, ...input: (Path | Handler | HandlerConfig)[]): void;
     use(router: Router): this;
-    use(handler: Handler): this;
+    use(handler: Handler | HandlerConfig): this;
     use(plugin: Plugin): this;
     use(path: Path, router: Router): this;
-    use(path: Path, handler: Handler): this;
+    use(path: Path, handler: Handler | HandlerConfig): this;
     use(path: Path, plugin: Plugin): this;
     protected install(plugin: Plugin, context?: PluginInstallContext): this;
+    /**
+     * Add a hook listener.
+     *
+     * @param name
+     * @param fn
+     */
+    on(name: `${HookName.DISPATCH_START}` | `${HookName.DISPATCH_END}` | `${HookName.CHILD_DISPATCH_BEFORE}` | `${HookName.CHILD_DISPATCH_AFTER}`, fn: HookDefaultListener): HookUnsubscribeFn;
+    on(name: `${HookName.CHILD_MATCH}`, fn: HookErrorListener): HookUnsubscribeFn;
+    on(name: `${HookName.ERROR}`, fn: HookErrorListener): HookUnsubscribeFn;
+    /**
+     * Remove single or all hook listeners.
+     *
+     * @param name
+     */
+    off(name: `${HookName}`): this;
+    off(name: `${HookName}`, fn: HookListener): this;
 }

package/dist/router/types.d.ts

@@ -0,0 +1,7 @@
+import type { DispatchEvent } from '../dispatcher';
+import type { RouterPipelineStep } from './constants';
+export type RouterPipelineContext = {
+    step: RouterPipelineStep;
+    event: DispatchEvent;
+    stackIndex: number;
+};

package/dist/types.d.ts

@@ -8,3 +8,4 @@ export type WebReadableStream = globalThis.ReadableStream | ReadableStream;
 export type WebResponse = globalThis.Response;
 export type WebRequest = globalThis.Request;
 export type WebBlob = globalThis.Blob;
+export type Next = (err?: Error) => void;

package/dist/utils/index.d.ts

@@ -1,9 +1,10 @@
 export * from './cookie';
-export * from './header';
 export * from './etag';
 export * from './trust-proxy';
 export * from './is-instance';
 export * from './mime';
+export * from './method';
+export * from './next';
 export * from './object';
 export * from './path';
 export * from './promise';

package/dist/utils/method.d.ts

@@ -0,0 +1,3 @@
+import type { MethodName } from '../constants';
+export declare function toMethodName(input: string | undefined): MethodName | undefined;
+export declare function toMethodName(input: string | undefined, alt: MethodName): MethodName;

package/dist/utils/next.d.ts

@@ -0,0 +1,2 @@
+import type { Next } from '../types';
+export declare const nextPlaceholder: Next;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "routup",
-    "version": "3.0.0",
+    "version": "3.1.0",
     "description": "Routup is a minimalistic http based routing framework.",
     "exports": {
         "./package.json": "./package.json",
@@ -50,7 +50,7 @@
     },
     "homepage": "https://github.com/routup/routup#readme",
     "dependencies": {
-        "@ebec/http": "^2.2.2",
+        "@ebec/http": "^2.3.0",
         "buffer": "^6.0.3",
         "mime-explorer": "^1.0.0",
         "negotiator": "^0.6.3",
@@ -61,9 +61,9 @@
         "uncrypto": "^0.1.3"
     },
     "devDependencies": {
-        "@rollup/plugin-commonjs": "^25.0.4",
-        "@rollup/plugin-node-resolve": "^15.2.1",
-        "@swc/core": "^1.3.91",
+        "@rollup/plugin-commonjs": "^25.0.7",
+        "@rollup/plugin-node-resolve": "^15.2.3",
+        "@swc/core": "^1.3.93",
         "@swc/jest": "^0.2.29",
         "@tada5hi/commitlint-config": "^1.1.2",
         "@tada5hi/eslint-config-typescript": "^1.2.5",
@@ -78,7 +78,7 @@
         "cross-env": "^7.0.3",
         "jest": "^29.7.0",
         "rimraf": "^5.0.5",
-        "rollup": "^3.29.4",
+        "rollup": "^4.1.4",
         "semantic-release": "^22.0.5",
         "supertest": "^6.3.3",
         "typescript": "5.2.2"

package/dist/dispatcher/adapters/node/module.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-import type { RequestListener } from 'node:http';
-import type { Request } from '../../../request';
-import type { Response } from '../../../response';
-import type { Router } from '../../../router';
-export declare function dispatchNodeRequest(router: Router, req: Request, res: Response): Promise<void>;
-export declare function createNodeDispatcher(router: Router): RequestListener;

package/dist/dispatcher/adapters/raw/module.d.ts

@@ -1,4 +0,0 @@
-import type { Router } from '../../../router';
-import type { DispatchRawRequestOptions, RawRequest, RawResponse } from './type';
-export declare function dispatchRawRequest(router: Router, request: RawRequest, options?: DispatchRawRequestOptions): Promise<RawResponse>;
-export declare function createRawDispatcher(router: Router): (request: RawRequest) => Promise<RawResponse>;

package/dist/dispatcher/adapters/web/index.d.ts

@@ -1,2 +0,0 @@
-export * from './module';
-export * from './type';

package/dist/dispatcher/adapters/web/module.d.ts

@@ -1,5 +0,0 @@
-import type { Router } from '../../../router';
-import type { WebRequest } from '../../../types';
-import type { DispatchWebRequestOptions } from './type';
-export declare function dispatchWebRequest(router: Router, request: WebRequest, options?: DispatchWebRequestOptions): Promise<Response>;
-export declare function createWebDispatcher(router: Router): (request: WebRequest) => Promise<Response>;

package/dist/dispatcher/utils.d.ts

@@ -1,5 +0,0 @@
-import type { DispatcherMeta } from './type';
-export declare function buildDispatcherMeta(input: Partial<DispatcherMeta>): DispatcherMeta;
-export declare function cloneDispatcherMeta(input: DispatcherMeta): DispatcherMeta;
-export declare function cloneDispatcherMetaParams(input?: Record<string, any>): Record<string, any>;
-export declare function mergeDispatcherMetaParams(t1?: Record<string, any>, t2?: Record<string, any>): Record<string, any>;

package/dist/layer/constants.d.ts

@@ -1 +0,0 @@
-export declare const LayerSymbol: unique symbol;

package/dist/layer/module.d.ts

@@ -1,17 +0,0 @@
-import type { Dispatcher, DispatcherEvent, DispatcherMeta } from '../dispatcher';
-import type { Handler } from '../handler';
-import { PathMatcher } from '../path';
-import type { Response } from '../response';
-export declare class Layer implements Dispatcher {
-    readonly '@instanceof': symbol;
-    protected handler: Handler;
-    protected pathMatcher: PathMatcher | undefined;
-    constructor(handler: Handler);
-    get type(): "error" | "core";
-    get path(): import("../path").Path | undefined;
-    get method(): string | undefined;
-    dispatch(event: DispatcherEvent, meta: DispatcherMeta): Promise<boolean>;
-    protected sendOutput(res: Response, input: unknown): Promise<any>;
-    matchPath(path: string): boolean;
-    matchMethod(method: string): boolean;
-}

package/dist/layer/type.d.ts

@@ -1,8 +0,0 @@
-import type { MethodName } from '../constants';
-import type { HandlerFn } from '../handler';
-import type { Path } from '../path';
-export type LayerOptions = {
-    handler: HandlerFn;
-    method?: `${MethodName}`;
-    path?: Path;
-};

package/dist/layer/utils.d.ts

@@ -1,2 +0,0 @@
-import type { Layer } from './module';
-export declare function isLayerInstance(input: unknown): input is Layer;