routup 4.0.2 → 5.0.0-beta.0

package/dist/request/helpers/index.d.ts

@@ -1,17 +0,0 @@
-export * from './cache';
-export * from './env';
-export * from './header';
-export * from './header-accept';
-export * from './header-accept-charset';
-export * from './header-accept-encoding';
-export * from './header-accept-language';
-export * from './header-content-type';
-export * from './hostname';
-export * from './http2';
-export * from './ip';
-export * from './mount-path';
-export * from './negotiator';
-export * from './params';
-export * from './path';
-export * from './protocol';
-export * from './router';

package/dist/request/helpers/ip.d.ts

@@ -1,7 +0,0 @@
-import type { TrustProxyInput } from '../../utils';
-import type { Request } from '../types';
-type RequestIpOptions = {
-    trustProxy?: TrustProxyInput;
-};
-export declare function getRequestIP(req: Request, options?: RequestIpOptions): string;
-export {};

package/dist/request/helpers/mount-path.d.ts

@@ -1,3 +0,0 @@
-import type { Request } from '../types';
-export declare function useRequestMountPath(req: Request): string;
-export declare function setRequestMountPath(req: Request, basePath: string): void;

package/dist/request/helpers/negotiator.d.ts

@@ -1,3 +0,0 @@
-import Negotiator from 'negotiator';
-import type { Request } from '../types';
-export declare function useRequestNegotiator(req: Request): Negotiator;

package/dist/request/helpers/params.d.ts

@@ -1,5 +0,0 @@
-import type { Request } from '../types';
-export declare function useRequestParams(req: Request): Record<string, any>;
-export declare function useRequestParam(req: Request, key: string): any;
-export declare function setRequestParams(req: Request, data: Record<string, any>): void;
-export declare function setRequestParam(req: Request, key: string, value: any): void;

package/dist/request/helpers/path.d.ts

@@ -1,2 +0,0 @@
-import type { Request } from '../types';
-export declare function useRequestPath(req: Request): string;

package/dist/request/helpers/protocol.d.ts

@@ -1,8 +0,0 @@
-import type { TrustProxyInput } from '../../utils';
-import type { Request } from '../types';
-type RequestProtocolOptions = {
-    trustProxy?: TrustProxyInput;
-    default?: string;
-};
-export declare function getRequestProtocol(req: Request, options?: RequestProtocolOptions): string;
-export {};

package/dist/request/helpers/router.d.ts

@@ -1,3 +0,0 @@
-import type { Request } from '../types';
-export declare function setRequestRouterPath(req: Request, path: number[]): void;
-export declare function useRequestRouterPath(req: Request): number[] | undefined;

package/dist/request/index.d.ts

@@ -1,3 +0,0 @@
-export * from './helpers';
-export * from './module';
-export * from './types';

package/dist/request/module.d.ts

@@ -1,3 +0,0 @@
-import type { IncomingMessage } from 'node:http';
-import type { RequestCreateContext } from './types';
-export declare function createRequest(context: RequestCreateContext): IncomingMessage;

package/dist/request/types.d.ts

@@ -1,12 +0,0 @@
-import type { IncomingMessage } from 'node:http';
-import type { NodeReadableStream, WebReadableStream } from '../types';
-export type RequestBody = null | Iterable<any> | AsyncIterable<any> | NodeReadableStream | WebReadableStream;
-export type RequestHeaders = Record<string, string | string[]>;
-export type RequestCreateContext = {
-    body?: RequestBody;
-    headers?: RequestHeaders;
-    method?: string;
-    url?: string;
-};
-export interface Request extends IncomingMessage {
-}

package/dist/response/helpers/cache.d.ts

@@ -1,7 +0,0 @@
-import type { Response } from '../types';
-export type ResponseCacheHeadersOptions = {
-    maxAge?: number;
-    modifiedTime?: string | Date;
-    cacheControls?: string[];
-};
-export declare function setResponseCacheHeaders(res: Response, options?: ResponseCacheHeadersOptions): void;

package/dist/response/helpers/event-stream/factory.d.ts

@@ -1,3 +0,0 @@
-import type { Response } from '../../types';
-import { EventStream } from './module';
-export declare function createEventStream(response: Response): EventStream;

package/dist/response/helpers/event-stream/index.d.ts

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

package/dist/response/helpers/event-stream/module.d.ts

@@ -1,17 +0,0 @@
-import { PassThrough } from 'readable-stream';
-import type { Response } from '../../types';
-import type { EventStreamListener, EventStreamMessage } from './types';
-export declare class EventStream {
-    protected response: Response;
-    protected passThrough: PassThrough;
-    protected flushed: boolean;
-    protected eventHandlers: Record<string, EventStreamListener[]>;
-    constructor(response: Response);
-    protected open(): void;
-    write(message: EventStreamMessage): void;
-    write(message: string): void;
-    end(): void;
-    on(event: 'close', listener: EventStreamListener): void;
-    on(event: 'error', listener: EventStreamListener): void;
-    protected emit(event: string, ...args: any[]): void;
-}

package/dist/response/helpers/event-stream/types.d.ts

@@ -1,24 +0,0 @@
-/**
- * https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format
- */
-export type EventStreamMessage = {
-    /**
-     * The event ID to set the EventSource object's last event ID value.
-     */
-    id?: string;
-    /**
-     * The reconnection time.
-     * If the connection to the server is lost, the browser will wait for the specified time before attempting to reconnect.
-     * This must be an integer, specifying the reconnection time in milliseconds.
-     */
-    retry?: number;
-    /**
-     * The data field for the message.
-     */
-    data: string;
-    /**
-     * A string identifying the type of event described.
-     */
-    event?: string;
-};
-export type EventStreamListener<T = any> = (err: Error | null, data: T) => void | Promise<void>;

package/dist/response/helpers/event-stream/utils.d.ts

@@ -1,2 +0,0 @@
-import type { EventStreamMessage } from './types';
-export declare function serializeEventStreamMessage(message: EventStreamMessage): string;

package/dist/response/helpers/gone.d.ts

@@ -1,3 +0,0 @@
-import type { Response } from '../types';
-export declare function isResponseGone(res: Response): any;
-export declare function setResponseGone(res: Response, value: boolean): void;

package/dist/response/helpers/header-attachment.d.ts

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function setResponseHeaderAttachment(res: Response, filename?: string): void;

package/dist/response/helpers/header-content-type.d.ts

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function setResponseHeaderContentType(res: Response, input: string, ifNotExists?: boolean): void;

package/dist/response/helpers/header.d.ts

@@ -1,4 +0,0 @@
-import type { OutgoingHttpHeader } from 'node:http';
-import type { Response } from '../types';
-export declare function appendResponseHeader(res: Response, name: string, value: OutgoingHttpHeader): void;
-export declare function appendResponseHeaderDirective(res: Response, name: string, value: OutgoingHttpHeader): void;

package/dist/response/helpers/index.d.ts

@@ -1,16 +0,0 @@
-export * from './cache';
-export * from './event-stream';
-export * from './gone';
-export * from './header';
-export * from './header-attachment';
-export * from './header-content-type';
-export * from './send';
-export * from './send-accepted';
-export * from './send-created';
-export * from './send-file';
-export * from './send-format';
-export * from './send-redirect';
-export * from './send-stream';
-export * from './send-web-response';
-export * from './send-web-blob';
-export * from './utils';

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

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function sendAccepted(res: Response, chunk?: any): Promise<void>;

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

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function sendCreated(res: Response, chunk?: any): Promise<void>;

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

@@ -1,17 +0,0 @@
-import type { Response } from '../types';
-export type SendFileContentOptions = {
-    end?: number;
-    start?: number;
-};
-export type SendFileStats = {
-    size?: number;
-    mtime?: Date | number | string;
-    name?: string;
-};
-export type SendFileOptions = {
-    stats: () => Promise<SendFileStats> | SendFileStats;
-    content: (options: SendFileContentOptions) => Promise<unknown> | unknown;
-    attachment?: boolean;
-    name?: string;
-};
-export declare function sendFile(res: Response, options: SendFileOptions, next?: (err?: Error) => Promise<unknown> | unknown): Promise<unknown>;

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

@@ -1,7 +0,0 @@
-import type { Response } from '../types';
-type ResponseFormats = {
-    default: () => void;
-    [key: string]: () => void;
-};
-export declare function sendFormat(res: Response, input: ResponseFormats): void;
-export {};

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

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function sendRedirect(res: Response, location: string, statusCode?: number): Promise<void>;

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

@@ -1,3 +0,0 @@
-import type { NodeReadableStream, WebReadableStream } from '../../types';
-import type { Response } from '../types';
-export declare function sendStream(res: Response, stream: NodeReadableStream | WebReadableStream, next?: (err?: Error) => Promise<unknown> | unknown): Promise<unknown>;

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

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

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

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

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

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function send(res: Response, chunk?: any): Promise<void>;

package/dist/response/helpers/utils.d.ts

@@ -1,2 +0,0 @@
-import type { Response } from '../types';
-export declare function setResponseContentTypeByFileName(res: Response, fileName: string): void;

package/dist/response/index.d.ts

@@ -1,3 +0,0 @@
-export * from './helpers';
-export * from './module';
-export * from './types';

package/dist/response/module.d.ts

@@ -1,3 +0,0 @@
-import type { Request } from '../request';
-import type { Response } from './types';
-export declare function createResponse(request: Request): Response;

package/dist/response/types.d.ts

@@ -1,3 +0,0 @@
-import type { ServerResponse } from 'node:http';
-export interface Response extends ServerResponse {
-}

package/dist/router/constants.d.ts

@@ -1,9 +0,0 @@
-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 +0,0 @@
-export * from './module';

package/dist/router/module.d.ts

@@ -1,89 +0,0 @@
-import { MethodName } from '../constants';
-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 { Plugin, PluginInstallContext } from '../plugin';
-import type { RouterOptionsInput } from '../router-options';
-import type { RouterPipelineContext } from './types';
-export declare class Router implements Dispatcher {
-    readonly '@instanceof': symbol;
-    /**
-     * An identifier for the router instance.
-     */
-    readonly id: number;
-    /**
-     * A label for the router instance.
-     */
-    readonly name?: string;
-    /**
-     * Array of mounted layers, routes & routers.
-     *
-     * @protected
-     */
-    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);
-    matchPath(path: string): boolean;
-    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 | HandlerConfig): this;
-    use(plugin: Plugin): this;
-    use(path: Path, router: Router): 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

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

package/dist/router/utils.d.ts

@@ -1,3 +0,0 @@
-import type { Router } from './module';
-export declare function generateRouterID(): number;
-export declare function isRouterInstance(input: unknown): input is Router;

package/dist/router-options/index.d.ts

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

package/dist/router-options/module.d.ts

@@ -1,4 +0,0 @@
-import type { RouterOptions } from './type';
-export declare function setRouterOptions(id: number, input: Partial<RouterOptions>): void;
-export declare function unsetRouterOptions(id: number): void;
-export declare function findRouterOption<K extends keyof RouterOptions>(key: K, path?: number[]): RouterOptions[K];

package/dist/router-options/transform.d.ts

@@ -1,2 +0,0 @@
-import type { RouterOptions, RouterOptionsInput } from './type';
-export declare function transformRouterOptions(input: RouterOptionsInput): Partial<RouterOptions>;

package/dist/router-options/type.d.ts

@@ -1,41 +0,0 @@
-import type { Path } from '../path';
-import type { EtagFn, EtagInput, TrustProxyFn, TrustProxyInput } from '../utils';
-export type RouterOptions = {
-    /**
-     * The path the router is mounted on.
-     *
-     * @type string
-     * @default '/'
-     */
-    path?: Path;
-    /**
-     * Name of the router.
-     */
-    name?: string;
-    /**
-     * default: 2
-     */
-    subdomainOffset: number;
-    /**
-     * default: 0
-     */
-    proxyIpMax: number;
-    /**
-     * default: () => true
-     */
-    etag: EtagFn;
-    /**
-     * default: () => false
-     */
-    trustProxy: TrustProxyFn;
-};
-export type RouterOptionsInput = Omit<Partial<RouterOptions>, 'etag' | 'trustProxy'> & {
-    /**
-     * default: true
-     */
-    etag?: EtagInput;
-    /**
-     * default: false
-     */
-    trustProxy?: TrustProxyInput;
-};

package/dist/types.d.ts

@@ -1,9 +0,0 @@
-import type { Readable as NodeReadable } from 'node:stream';
-import type { Readable } from 'readable-stream';
-import type { ReadableStream } from 'stream/web';
-export type NodeReadableStream = NodeReadable | Readable;
-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/cookie.d.ts

@@ -1 +0,0 @@
-export declare function splitCookiesString(input?: string | string[]): string[];

package/dist/utils/etag/index.d.ts

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

package/dist/utils/etag/module.d.ts

@@ -1,11 +0,0 @@
-import { Buffer } from 'buffer';
-import { type Stats } from 'node:fs';
-import type { EtagOptions } from './type';
-/**
- * Generate an ETag.
- */
-export declare function generateETag(input: string | Buffer | Stats): Promise<string>;
-/**
- * Create a simple ETag.
- */
-export declare function createEtag(input: string | Buffer | Stats, options?: EtagOptions): Promise<string>;

package/dist/utils/etag/type.d.ts

@@ -1,15 +0,0 @@
-export type EtagOptions = {
-    /**
-     * Create a weak ETag?
-     * Output is prefixed with: /W
-     */
-    weak?: boolean;
-    /**
-     * Threshold of bytes from which an etag is generated.
-     *
-     * default: undefined
-     */
-    threshold?: number;
-};
-export type EtagFn = (body: any, encoding?: BufferEncoding, size?: number) => Promise<string | undefined>;
-export type EtagInput = boolean | EtagOptions | EtagFn;

package/dist/utils/etag/utils.d.ts

@@ -1,2 +0,0 @@
-import type { EtagFn, EtagOptions } from './type';
-export declare function buildEtagFn(input?: boolean | EtagOptions | EtagFn): EtagFn;

package/dist/utils/index.d.ts

@@ -1,13 +0,0 @@
-export * from './cookie';
-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';
-export * from './stream';
-export * from './url';
-export * from './web';

package/dist/utils/is-instance.d.ts

@@ -1 +0,0 @@
-export declare function isInstance(input: unknown, sym: symbol): boolean;

package/dist/utils/method.d.ts

@@ -1,3 +0,0 @@
-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/mime.d.ts

@@ -1,2 +0,0 @@
-export declare function getMimeType(type: string): string | undefined;
-export declare function getCharsetForMimeType(type: string): string | undefined;

package/dist/utils/next.d.ts

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

package/dist/utils/object.d.ts

@@ -1,3 +0,0 @@
-export declare function isObject(item: unknown): item is Record<string, any>;
-export declare function setProperty(record: Record<PropertyKey, any>, property: PropertyKey, value: any): void;
-export declare function getProperty<T = any>(req: Record<PropertyKey, any>, property: PropertyKey): T;

package/dist/utils/path.d.ts

@@ -1,5 +0,0 @@
-/**
- * Based on https://github.com/unjs/pathe v1.1.1 (055f50a6f1131f4e5c56cf259dd8816168fba329)
- */
-export declare function extname(input: string): string;
-export declare function basename(input: string, extension?: string): string;

package/dist/utils/promise.d.ts

@@ -1 +0,0 @@
-export declare function isPromise(p: unknown): p is Promise<unknown>;

package/dist/utils/stream.d.ts

@@ -1,6 +0,0 @@
-import type { ReadableStream as WebReadableStream } from 'stream/web';
-import type { Readable as NodeReadable } from 'node:stream';
-import type { Readable } from 'readable-stream';
-export declare function isNodeStream(input: unknown): input is NodeReadable | Readable;
-export declare function isWebStream(input: unknown): input is ReadableStream | WebReadableStream;
-export declare function isStream(data: any): data is NodeReadable | Readable | ReadableStream | WebReadableStream;

package/dist/utils/trust-proxy/index.d.ts

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

package/dist/utils/trust-proxy/module.d.ts

@@ -1,2 +0,0 @@
-import type { TrustProxyFn } from './type';
-export declare function buildTrustProxyFn(input?: boolean | number | string | string[] | TrustProxyFn): TrustProxyFn;

package/dist/utils/trust-proxy/type.d.ts

@@ -1,2 +0,0 @@
-export type TrustProxyFn = (address: string, hop: number) => boolean;
-export type TrustProxyInput = boolean | number | string | string[] | TrustProxyFn;

package/dist/utils/url.d.ts

@@ -1,7 +0,0 @@
-export declare function hasTrailingSlash(input?: string, queryParams?: boolean): boolean;
-export declare function withoutTrailingSlash(input?: string, queryParams?: boolean): string;
-export declare function withTrailingSlash(input?: string, queryParams?: boolean): string;
-export declare function hasLeadingSlash(input?: string): boolean;
-export declare function withoutLeadingSlash(input?: string): string;
-export declare function withLeadingSlash(input?: string): string;
-export declare function cleanDoubleSlashes(input?: string): string;

package/dist/utils/web.d.ts

@@ -1,3 +0,0 @@
-import type { WebBlob, WebResponse } from '../types';
-export declare function isWebBlob(input: unknown): input is WebBlob;
-export declare function isWebResponse(input: unknown): input is WebResponse;