routup 1.0.3 → 3.0.0-alpha.1

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

@@ -12,5 +12,5 @@ export type EtagOptions = {
      */
     threshold?: number;
 };
-export type EtagFn = (body: any, encoding?: BufferEncoding, size?: number) => string | undefined;
+export type EtagFn = (body: any, encoding?: BufferEncoding, size?: number) => Promise<string | undefined>;
 export type EtagInput = boolean | EtagOptions | EtagFn;

package/dist/utils/header.d.ts

@@ -0,0 +1,3 @@
+import type { RawResponseHeader } from '../dispatcher';
+export declare function transformHeaderToTuples(key: string, value: RawResponseHeader): [string, string][];
+export declare function transformHeadersToTuples(input: Record<string, RawResponseHeader>): [string, string][];

package/dist/utils/index.d.ts

@@ -1,3 +1,5 @@
+export * from './cookie';
+export * from './header';
 export * from './etag';
 export * from './trust-proxy';
 export * from './is-instance';
@@ -5,5 +7,6 @@ export * from './mime';
 export * from './object';
 export * from './path';
 export * from './promise';
-export * from './request';
+export * from './stream';
 export * from './url';
+export * from './web';

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

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

package/dist/utils/path.d.ts

@@ -1,2 +1,5 @@
-import type { Path } from '../type';
-export declare function isPath(input: unknown): input is Path;
+/**
+ * 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/stream.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
+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/web.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "routup",
-    "version": "1.0.3",
+    "version": "3.0.0-alpha.1",
     "description": "Routup is a minimalistic http based routing framework.",
     "exports": {
         "./package.json": "./package.json",
@@ -50,35 +50,37 @@
     },
     "homepage": "https://github.com/routup/routup#readme",
     "dependencies": {
-        "@ebec/http": "^1.1.0",
-        "continu": "^1.3.2",
+        "@ebec/http": "^2.2.1",
+        "buffer": "^6.0.3",
         "mime-explorer": "^1.0.0",
         "negotiator": "^0.6.3",
         "path-to-regexp": "^6.2.1",
         "proxy-addr": "^2.0.7",
-        "smob": "^1.4.0",
-        "zod": "^3.21.4"
+        "readable-stream": "^4.4.2",
+        "smob": "^1.4.1",
+        "uncrypto": "^0.1.3"
     },
     "devDependencies": {
         "@rollup/plugin-commonjs": "^25.0.4",
-        "@rollup/plugin-node-resolve": "^15.1.0",
-        "@swc/core": "^1.3.82",
+        "@rollup/plugin-node-resolve": "^15.2.1",
+        "@swc/core": "^1.3.90",
         "@swc/jest": "^0.2.29",
-        "@tada5hi/commitlint-config": "^1.1.0",
-        "@tada5hi/eslint-config-typescript": "^1.2.3",
-        "@tada5hi/semantic-release": "^0.2.0",
+        "@tada5hi/commitlint-config": "^1.1.2",
+        "@tada5hi/eslint-config-typescript": "^1.2.5",
+        "@tada5hi/semantic-release": "^0.3.0",
         "@tada5hi/tsconfig": "^0.5.0",
-        "@types/jest": "^29.5.4",
+        "@types/jest": "^29.5.5",
         "@types/negotiator": "^0.6.1",
-        "@types/node": "^20.5.7",
-        "@types/proxy-addr": "^2.0.0",
-        "@types/supertest": "^2.0.12",
+        "@types/node": "^20.7.1",
+        "@types/proxy-addr": "^2.0.1",
+        "@types/readable-stream": "^4.0.3",
+        "@types/supertest": "^2.0.13",
         "cross-env": "^7.0.3",
-        "jest": "^29.6.4",
-        "rimraf": "^5.0.1",
-        "rollup": "^3.28.1",
-        "semantic-release": "^21.0.7",
+        "jest": "^29.7.0",
+        "rimraf": "^5.0.5",
+        "rollup": "^3.29.4",
+        "semantic-release": "^22.0.5",
         "supertest": "^6.3.3",
-        "typescript": "5.1.6"
+        "typescript": "5.2.2"
     }
 }

package/dist/config/module.d.ts

@@ -1,8 +0,0 @@
-import type { FlattenObject } from 'continu';
-import { Continu } from 'continu';
-import type { Options, OptionsInput } from './type';
-export declare function buildConfig(): Continu<Options, OptionsInput>;
-export declare function useConfig(): Continu<Options, OptionsInput>;
-export declare function setConfig(config: Continu<Options, OptionsInput>): void;
-export declare function setConfigOption<K extends keyof FlattenObject<OptionsInput>>(key: K, value: FlattenObject<OptionsInput>[K]): Options;
-export declare function getConfigOption(key: keyof FlattenObject<OptionsInput>): string | number | import("../utils").EtagFn | import("../utils").TrustProxyFn;

package/dist/config/type.d.ts

@@ -1,34 +0,0 @@
-import type { EtagFn, EtagInput } from '../utils/etag/type';
-import type { TrustProxyFn, TrustProxyInput } from '../utils/trust-proxy';
-export type Options = {
-    /**
-     * default: production
-     */
-    env: string;
-    /**
-     * default: () => true
-     */
-    etag: EtagFn;
-    /**
-     * default: 2
-     */
-    subdomainOffset: number;
-    /**
-     * default: () => false
-     */
-    trustProxy: TrustProxyFn;
-    /**
-     * default: 0
-     */
-    proxyIpMax: number;
-};
-export type OptionsInput = {
-    /**
-     * default: true
-     */
-    etag?: EtagInput;
-    /**
-     * default: false
-     */
-    trustProxy?: TrustProxyInput;
-} & Partial<Omit<Options, 'etag' | 'trustProxy'>>;

package/dist/handler/utils.d.ts

@@ -1,2 +0,0 @@
-import type { Next, Response } from '../type';
-export declare function processHandlerExecutionOutput(res: Response, next: Next, output?: unknown): void;

package/dist/helpers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './request';
-export * from './response';

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

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-import type { Stats } from 'node:fs';
-import type { Response } from '../../type';
-export type SendFileOptions = {
-    stats?: Stats;
-    filePath: string;
-    attachment?: boolean;
-};
-export declare function sendFile(res: Response, filePath: string | SendFileOptions, fn?: CallableFunction): void;

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

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

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

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import type { Readable } from 'node:stream';
-import type { Response } from '../../type';
-export declare function sendStream(res: Response, stream: Readable, fn?: CallableFunction): void;

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

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

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

@@ -1,3 +0,0 @@
-import type { Response } from '../../type';
-export declare function setResponseContentTypeByFileName(res: Response, fileName: string): void;
-export declare function onResponseFinished(res: Response, cb: (err?: Error) => void): void;

package/dist/route/module.d.ts

@@ -1,27 +0,0 @@
-import { MethodName } from '../constants';
-import type { DispatcherMeta, Handler, Next, Path, Request, Response } from '../type';
-import { Layer } from '../layer';
-import type { PathMatcherOptions } from '../path';
-import { PathMatcher } from '../path';
-import type { RouteOptions } from './type';
-export declare class Route {
-    readonly '@instanceof': symbol;
-    path: Path;
-    protected pathMatcher: PathMatcher;
-    protected pathMatcherOptions: PathMatcherOptions;
-    protected layers: Record<string, Layer[]>;
-    constructor(options: RouteOptions);
-    matchPath(path: string): boolean;
-    matchMethod(method: string): boolean;
-    getMethods(): string[];
-    dispatch(req: Request, res: Response, meta: DispatcherMeta, done: Next): void;
-    register(method: `${MethodName}`, ...handlers: Handler[]): void;
-    get(...handlers: Handler[]): void;
-    post(...handlers: Handler[]): void;
-    put(...handlers: Handler[]): void;
-    patch(...handlers: Handler[]): void;
-    delete(...handlers: Handler[]): void;
-    head(...handlers: Handler[]): void;
-    options(...handlers: Handler[]): void;
-    private isStrictPath;
-}

package/dist/route/type.d.ts

@@ -1,6 +0,0 @@
-import type { ParseOptions, TokensToRegexpOptions } from 'path-to-regexp';
-import type { Path } from '../type';
-export type RouteOptions = {
-    path: Path;
-    pathMatcher: TokensToRegexpOptions & ParseOptions;
-};

package/dist/route/utils.d.ts

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

package/dist/router/type.d.ts

@@ -1,24 +0,0 @@
-import type { PathMatcherOptions } from '../path';
-import type { Path } from '../type';
-export type RouterOptions = {
-    /**
-     * The path the router is mounted on.
-     *
-     * @type string
-     * @default '/'
-     */
-    path?: Path;
-    /**
-     * Path matcher options.
-     *
-     * @default: {end: false, sensitive: true}
-     */
-    pathMatcher?: PathMatcherOptions;
-    /**
-     * Milliseconds (ms) until the request should be canceled.
-     *
-     * @type number
-     * @default undefined
-     */
-    timeout?: number;
-};

package/dist/type.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="node" />
-import type { IncomingMessage, ServerResponse } from 'node:http';
-export interface Response extends ServerResponse {
-}
-export interface Request extends IncomingMessage {
-}
-export type Next = (err?: Error) => void;
-export type Handler = (req: Request, res: Response, next: Next) => unknown;
-export type ErrorHandler = (err: Error, req: Request, res: Response, next: Next) => unknown;
-export type Path = string | RegExp;
-export type DispatcherMeta = {
-    /**
-     * Params collected on path.
-     */
-    params?: Record<string, any>;
-    /**
-     * Path to check for the current instance.
-     */
-    path?: string;
-    /**
-     * The relative path on which the router is hung.
-     */
-    mountPath?: string;
-};

package/dist/utils/request.d.ts

@@ -1,2 +0,0 @@
-import type { Next, Response } from '../type';
-export declare function createRequestTimeout(res: Response, timeout: number, done?: Next): void;