routup 0.14.2 → 1.0.0-alpha.2

package/README.md

@@ -6,7 +6,7 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/Tada5hi/routup/badge.svg)](https://snyk.io/test/github/Tada5hi/routup)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 
-**Routup** is a lightweight and extendable http interface based routing framework.
+**Routup** is a lightweight, minimalistic and extendable http interface based routing framework.
 It uses node's vanilla request and response interfaces, which are injected into route handlers aka middlewares as function argument.
 
 Helpers provide additional functionalities to transform and interact with the request and manipulate the response upstream.
@@ -18,6 +18,7 @@ Helpers provide additional functionalities to transform and interact with the re
 - [Documentation](#documentation)
 - [Usage](#usage)
 - [Plugins](#plugins)
+- [Contributing](#contributing)
 - [License](#license)
 
 ## Installation
@@ -29,11 +30,11 @@ npm install routup --save
 ## Features
 
 - 🚀 high performance routing
-- 🧰 response & request helpers/utilities
+- 🧰 response & request composables/helpers
 - 💼 extendable & compact
 - 🛫 named route parameters
 - 📁 nestable routers
-- 😌 define one or many (error-) middlewares
+- 🤝️ define one or many (error-) middlewares
 - ✨ promise support for route- & middleware-handlers
 - 👕 TypeScript fully supported
 - 🤏 Minimalistic to fit into any solution with minimum overhead
@@ -73,6 +74,11 @@ typically http framework functions, which are not integrated in the main package
 | [rate-limit-redis](https://www.npmjs.com/package/@routup/rate-limit-redis) | Redis adapter for the rate-limit plugin.                               |
 | [static](https://www.npmjs.com/package/@routup/static)                     | Serve static files from a directory.                                   |
 | [swagger](https://www.npmjs.com/package/@routup/swagger)                   | Serve generated docs from URL or based on a JSON file.                 |
+## Contributing
+
+Before starting to work on a pull request, it is important to review the guidelines for
+[contributing](./CONTRIBUTING.md) and the [code of conduct](./CODE_OF_CONDUCT.md).
+These guidelines will help to ensure that contributions are made effectively and are accepted.
 
 ## License
 

package/dist/config/index.d.ts

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

package/dist/config/module.d.ts

@@ -0,0 +1,8 @@
+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

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

@@ -0,0 +1,39 @@
+export declare enum Method {
+    GET = "get",
+    POST = "post",
+    PUT = "put",
+    PATCH = "patch",
+    DELETE = "delete",
+    OPTIONS = "options",
+    HEAD = "head"
+}
+export declare enum HeaderName {
+    ACCEPT = "accept",
+    ACCEPT_CHARSET = "accept-charset",
+    ACCEPT_ENCODING = "accept-encoding",
+    ACCEPT_LANGUAGE = "accept-language",
+    ACCEPT_RANGES = "accept-ranges",
+    ALLOW = "allow",
+    CACHE_CONTROL = "cache-control",
+    CONTENT_DISPOSITION = "content-disposition",
+    CONTENT_ENCODING = "content-encoding",
+    CONTENT_LENGTH = "content-length",
+    CONTENT_RANGE = "content-range",
+    CONTENT_TYPE = "content-type",
+    COOKIE = "cookie",
+    ETag = "etag",
+    HOST = "host",
+    IF_NONE_MATCH = "if-none-match",
+    LAST_MODIFIED = "last-modified",
+    LOCATION = "location",
+    RANGE = "range",
+    RATE_LIMIT_LIMIT = "ratelimit-limit",
+    RATE_LIMIT_REMAINING = "ratelimit-remaining",
+    RATE_LIMIT_RESET = "ratelimit-reset",
+    RETRY_AFTER = "retry-after",
+    SET_COOKIE = "set-cookie",
+    TRANSFER_ENCODING = "transfer-encoding",
+    X_FORWARDED_HOST = "x-forwarded-host",
+    X_FORWARDED_FOR = "x-forwarded-for",
+    X_FORWARDED_PROTO = "x-forwarded-proto"
+}

package/dist/handler/index.d.ts

@@ -1,2 +1 @@
 export * from './utils';
-//# sourceMappingURL=index.d.ts.map

package/dist/handler/utils.d.ts

@@ -1,3 +1,2 @@
-import type { Next, Response } from '@routup/core';
+import type { Next, Response } from '../type';
 export declare function processHandlerExecutionOutput(res: Response, next: Next, output?: unknown): void;
-//# sourceMappingURL=utils.d.ts.map

package/dist/helpers/index.d.ts

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

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

@@ -0,0 +1,5 @@
+import type { Request } from '../../type';
+export declare function useRequestBody(req: Request): Record<string, any>;
+export declare function useRequestBody(req: Request, key: string): any | undefined;
+export declare function setRequestBody(req: Request, key: string, value: unknown): void;
+export declare function setRequestBody(req: Request, record: Record<string, any>, append?: boolean): void;

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

@@ -0,0 +1,2 @@
+import type { Request } from '../../type';
+export declare function isRequestCacheable(req: Request, modifiedTime: string | Date): boolean;

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

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import type { IncomingMessage } from 'node:http';
+import type { RequestFn } from '../type';
+export declare function setRequestCookieFn(fn: RequestFn): void;
+export declare function useRequestCookies(req: IncomingMessage): Record<string, string>;
+export declare function hasRequestCookies(req: IncomingMessage): boolean;
+export declare function useRequestCookie(req: IncomingMessage, name: string): string | undefined;
+export declare function setRequestCookies(req: IncomingMessage, record: Record<string, any>, mergeIt?: boolean): void;

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

@@ -0,0 +1,6 @@
+import type { Request } from '../../type';
+export declare function setRequestEnv(req: Request, key: string, value: unknown): void;
+export declare function setRequestEnv(req: Request, record: Record<string, any>, append?: boolean): void;
+export declare function useRequestEnv(req: Request): Record<string, any>;
+export declare function useRequestEnv(req: Request, key: string): unknown | undefined;
+export declare function unsetRequestEnv(req: Request, key: string): void;

package/dist/helpers/request/header-accept-charset.d.ts

@@ -0,0 +1,3 @@
+import type { Request } from '../../type';
+export declare function getRequestAcceptableCharsets(req: Request): string[];
+export declare function getRequestAcceptableCharset(req: Request, input: string | string[]): string | undefined;

package/dist/helpers/request/header-accept-encoding.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import type { IncomingMessage } from 'node:http';
+export declare function getRequestAcceptableEncodings(req: IncomingMessage): string[];
+export declare function getRequestAcceptableEncoding(req: IncomingMessage, input: string | string[]): string | undefined;

package/dist/helpers/request/header-accept-language.d.ts

@@ -0,0 +1,3 @@
+import type { Request } from '../../type';
+export declare function getRequestAcceptableLanguages(req: Request): string[];
+export declare function getRequestAcceptableLanguage(req: Request, input?: string | string[]): string | undefined;

package/dist/helpers/request/header-accept.d.ts

@@ -0,0 +1,3 @@
+import type { Request } from '../../type';
+export declare function getRequestAcceptableContentTypes(req: Request): string[];
+export declare function getRequestAcceptableContentType(req: Request, input?: string | string[]): string | undefined;

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

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

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

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import type { IncomingHttpHeaders } from 'node:http';
+import type { Request } from '../../type';
+export declare function getRequestHeader<K extends keyof IncomingHttpHeaders>(req: Request, name: K): IncomingHttpHeaders[K];
+export declare function setRequestHeader<K extends keyof IncomingHttpHeaders>(req: Request, name: K, value: IncomingHttpHeaders[K]): void;

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

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

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

@@ -0,0 +1,18 @@
+export * from './body';
+export * from './cache';
+export * from './cookie';
+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 './ip';
+export * from './mount-path';
+export * from './negotiator';
+export * from './params';
+export * from './path';
+export * from './protocol';
+export * from './query';

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

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+import type { Request } from '../../type';
+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/helpers/request/path.d.ts

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

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

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

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

@@ -0,0 +1,8 @@
+import type { Request } from '../../type';
+import type { RequestFn } from '../type';
+export declare function setRequestQueryFn(fn: RequestFn): void;
+export declare function useRequestQuery(req: Request): Record<string, any>;
+export declare function useRequestQuery(req: Request, key: string): any;
+export declare function hasRequestQuery(req: Request): boolean;
+export declare function setRequestQuery(req: Request, key: string, value: unknown): void;
+export declare function setRequestQuery(req: Request, record: Record<string, any>, append?: boolean): void;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+import type { Response } from '../../type';
+export type ResponseFormat = {
+    [key: string]: () => void;
+    default: () => void;
+};
+export declare function sendFormat(_res: Response, _format: ResponseFormat): void;

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

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

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

@@ -0,0 +1,4 @@
+/// <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

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

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

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

@@ -0,0 +1,3 @@
+import type { Request, Response } from '../type';
+export type RequestFn = (req: Request) => any;
+export type ResponseFn = (res: Response) => any;