@athenna/http 4.25.0 → 4.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.25.0",
+  "version": "4.26.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -29,6 +29,7 @@
   "scripts": {
     "build": "node node_modules/@athenna/tsconfig/src/build.js",
     "lint:fix": "eslint \"{bin,src,tests}/**/*.ts\" --fix",
+    "benchmark": "node --no-warnings --enable-source-maps --import=@athenna/tsconfig tests/benchmarks/ServerTest.ts",
     "test": "npm run --silent lint:fix && node --enable-source-maps --import=@athenna/tsconfig bin/test.ts",
     "test:debug": "cross-env NODE_DEBUG=athenna:* node --inspect --enable-source-maps --import=@athenna/tsconfig bin/test.ts",
     "test:coverage": "c8 npm run --silent test"
@@ -88,6 +89,7 @@
     "@fastify/swagger-ui": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
+    "autocannon": "^7.15.0",
     "commitizen": "^4.2.6",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.36.0",
@@ -100,6 +102,7 @@
     "foreground-child": "^2.0.0",
     "husky": "^3.1.0",
     "lint-staged": "^12.5.0",
+    "ora": "^8.0.1",
     "prettier": "^2.8.7"
   },
   "c8": {

package/src/context/Request.d.ts

@@ -6,38 +6,247 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node/http.js" />
-/// <reference types="node_modules/got/dist/source/core/timed-out.js" />
-import type { AddressInfo } from 'node:net';
 import type { FastifyRequest } from 'fastify';
-export declare function request(req: FastifyRequest): {
-    request: FastifyRequest<import("fastify").RouteGenericInterface, import("http").Server, import("http").IncomingMessage, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown, import("fastify").FastifyBaseLogger, import("fastify/types/type-provider.js").ResolveFastifyRequestType<import("fastify").FastifyTypeProviderDefault, import("fastify").FastifySchema, import("fastify").RouteGenericInterface>>;
-    id: string;
-    ip: string;
-    hostname: string;
-    readonly port: number;
-    version: string;
-    protocol: "http" | "https";
-    method: string;
-    baseUrl: string;
-    readonly baseHostUrl: string;
-    routeUrl: string;
-    readonly routeHostUrl: string;
-    originalUrl: string;
-    readonly originalHostUrl: string;
-    body: unknown;
-    params: unknown;
-    queries: unknown;
-    headers: import("http").IncomingHttpHeaders;
-    param(param: string, defaultValue?: any): unknown;
-    query(query: string, defaultValue?: any): unknown;
-    header(header: string, defaultValue?: any): import("http").IncomingHttpHeaders;
-    input(key: string, defaultValue?: any): unknown;
-    payload(key: string, defaultValue?: any): unknown;
-    only(keys: string[]): {};
-    except(keys: string[]): {};
-    getHostUrlFor(url: string): string;
-    getAddressInfo(): AddressInfo;
-};
+export declare class Request {
+    /**
+     * The fastify request object.
+     */
+    private request;
+    constructor(request: FastifyRequest);
+    /**
+     * Get the request id.
+     *
+     * @example
+     * ```ts
+     * console.log(request.id) // '12345'
+     * ```
+     */
+    get id(): string;
+    /**
+     * Get the request ip.
+     *
+     * @example
+     * ```ts
+     * console.log(request.ip) // '192.168.0.1'
+     * ```
+     */
+    get ip(): string;
+    /**
+     * Get the request hostname.
+     *
+     * @example
+     * ```ts
+     * console.log(request.hostname) // 'localhost'
+     * ```
+     */
+    get hostname(): string;
+    /**
+     * Get the server port.
+     *
+     * @example
+     * ```ts
+     * console.log(request.port) // 3000
+     * ```
+     */
+    get port(): number;
+    /**
+     * Get the http version.
+     *
+     * @example
+     * ```ts
+     * console.log(request.version) // 1
+     * ```
+     */
+    get version(): string;
+    /**
+     * Get the request protocol.
+     *
+     * @example
+     * ```ts
+     * console.log(request.protocol) // 'http'
+     * ```
+     */
+    get protocol(): 'http' | 'https';
+    /**
+     * Get the request method.
+     *
+     * @example
+     * ```ts
+     * console.log(request.method) // 'GET'
+     * ```
+     */
+    get method(): string;
+    /**
+     * Get the base url from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.baseUrl) // '/users/1'
+     * ```
+     */
+    get baseUrl(): string;
+    /**
+     * Get the base url with host and port info from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.baseHostUrl) // 'http://localhost:3030/users/1'
+     * ```
+     */
+    get baseHostUrl(): string;
+    /**
+     * Get the route url from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.routeUrl) // '/users/:id'
+     * ```
+     */
+    get routeUrl(): string;
+    /**
+     * Get the route url with host and port info from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.routeHostUrl) // 'http://localhost:3030/users/:id'
+     * ```
+     */
+    get routeHostUrl(): string;
+    /**
+     * Get the original url from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.originalUrl) // '/users/1?query=true'
+     * ```
+     */
+    get originalUrl(): string;
+    /**
+     * Get the original url with host and port info from request.
+     *
+     * @example
+     * ```ts
+     * console.log(request.originalHostUrl) // 'http://localhost:3000/users/1?query=true'
+     * ```
+     */
+    get originalHostUrl(): string;
+    /**
+     * Get all body from request.
+     *
+     * @example
+     * ```ts
+     * const { name, email } = request.body
+     * ```
+     */
+    get body(): any | any[];
+    /**
+     * Get all params from request.
+     *
+     * @example
+     * ```ts
+     * const { id } = request.params
+     * ```
+     */
+    get params(): any;
+    /**
+     * Get all queries from request.
+     *
+     * @example
+     * ```ts
+     * const { page, limit } = request.queries
+     * ```
+     */
+    get queries(): any;
+    /**
+     * Get all headers from request.
+     *
+     * @example
+     * ```ts
+     * const { accept } = request.headers
+     * ```
+     */
+    get headers(): any;
+    /**
+     * Get a value from the request params or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const id = request.param('id', '1')
+     * ```
+     */
+    param(param: string, defaultValue?: any): any;
+    /**
+     * Get a value from the request query param or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const page = request.query('page', '1')
+     * ```
+     */
+    query(query: string, defaultValue?: any): any;
+    /**
+     * Get a value from the request header or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const accept = request.header('accept', 'application/json')
+     * ```
+     */
+    header(header: string, defaultValue?: any): any;
+    /**
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.input('name', 'lenon')
+     * ```
+     */
+    input(key: string, defaultValue?: any): any;
+    /**
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.payload('name', 'lenon')
+     * ```
+     */
+    payload(key: string, defaultValue?: any): any;
+    /**
+     * Get only the selected values from the request body.
+     *
+     * @example
+     * ```ts
+     * const body = request.only(['name', 'email'])
+     * ```
+     */
+    only(keys: string[]): any;
+    /**
+     * Get all the values from the request body except the
+     * selected ones.
+     *
+     * @example
+     * ```ts
+     * const body = request.except(['name'])
+     * ```
+     */
+    except(keys: string[]): any;
+    /**
+     * Get the original fastify request.
+     */
+    getFastifyRequest(): FastifyRequest;
+    /**
+     * Add the hostname and port to the url.
+     */
+    private getHostUrlFor;
+    /**
+     * Get the address info of the server. This method will return the
+     * port used to listen the server, the family (IPv4, IPv6) and the
+     * server address (127.0.0.1).
+     */
+    private getAddressInfo;
+}