@athenna/http 4.24.0 → 4.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.24.0",
+  "version": "4.25.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package/src/context/Request.d.ts

@@ -6,243 +6,38 @@
  * 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 class Request {
-    /**
-     * The fastify request object.
-     */
-    request: FastifyRequest;
-    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;
-    /**
-     * 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;
-}
+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;
+};

package/src/context/Request.js

@@ -7,313 +7,82 @@
  * file that was distributed with this source code.
  */
 import { Is, Json } from '@athenna/common';
-export class Request {
-    constructor(request) {
-        this.request = request;
-    }
-    /**
-     * Get the request id.
-     *
-     * @example
-     * ```ts
-     * console.log(request.id) // '12345'
-     * ```
-     */
-    get id() {
-        return this.request.id;
-    }
-    /**
-     * Get the request ip.
-     *
-     * @example
-     * ```ts
-     * console.log(request.ip) // '192.168.0.1'
-     * ```
-     */
-    get ip() {
-        return this.request.ip;
-    }
-    /**
-     * Get the request hostname.
-     *
-     * @example
-     * ```ts
-     * console.log(request.hostname) // 'localhost'
-     * ```
-     */
-    get hostname() {
-        return this.request.hostname;
-    }
-    /**
-     * Get the server port.
-     *
-     * @example
-     * ```ts
-     * console.log(request.port) // 3000
-     * ```
-     */
-    get port() {
-        return this.getAddressInfo().port;
-    }
-    /**
-     * Get the http version.
-     *
-     * @example
-     * ```ts
-     * console.log(request.version) // 1
-     * ```
-     */
-    get version() {
-        return this.request.raw.httpVersion;
-    }
-    /**
-     * Get the request protocol.
-     *
-     * @example
-     * ```ts
-     * console.log(request.protocol) // 'http'
-     * ```
-     */
-    get protocol() {
-        return this.request.protocol;
-    }
-    /**
-     * Get the request method.
-     *
-     * @example
-     * ```ts
-     * console.log(request.method) // 'GET'
-     * ```
-     */
-    get method() {
-        return this.request.method;
-    }
-    /**
-     * Get the base url from request.
-     *
-     * @example
-     * ```ts
-     * console.log(request.baseUrl) // '/users/1'
-     * ```
-     */
-    get baseUrl() {
-        return this.request.url.split('?')[0];
-    }
-    /**
-     * Get the base url with host and port info from request.
-     *
-     * @example
-     * ```ts
-     * console.log(request.baseHostUrl) // 'http://localhost:3030/users/1'
-     * ```
-     */
-    get baseHostUrl() {
-        return this.getHostUrlFor(this.baseUrl);
-    }
-    /**
-     * Get the route url from request.
-     *
-     * @example
-     * ```ts
-     * console.log(request.routeUrl) // '/users/:id'
-     * ```
-     */
-    get routeUrl() {
-        return this.request.routeOptions.url;
-    }
-    /**
-     * Get the route url with host and port info from request.
-     *
-     * @example
-     * ```ts
-     * console.log(request.routeHostUrl) // 'http://localhost:3030/users/:id'
-     * ```
-     */
-    get routeHostUrl() {
-        return this.getHostUrlFor(this.routeUrl);
-    }
-    /**
-     * Get the original url from request.
-     *
-     * @example
-     * ```ts
-     * console.log(request.originalUrl) // '/users/1?query=true'
-     * ```
-     */
-    get originalUrl() {
-        return this.request.url;
-    }
-    /**
-     * 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() {
-        return this.getHostUrlFor(this.originalUrl);
-    }
-    /**
-     * Get all body from request.
-     *
-     * @example
-     * ```ts
-     * const { name, email } = request.body
-     * ```
-     */
-    get body() {
-        return this.request.body || {};
-    }
-    /**
-     * Get all params from request.
-     *
-     * @example
-     * ```ts
-     * const { id } = request.params
-     * ```
-     */
-    get params() {
-        return this.request.params || {};
-    }
-    /**
-     * Get all queries from request.
-     *
-     * @example
-     * ```ts
-     * const { page, limit } = request.queries
-     * ```
-     */
-    get queries() {
-        return this.request.query || {};
-    }
-    /**
-     * Get all headers from request.
-     *
-     * @example
-     * ```ts
-     * const { accept } = request.headers
-     * ```
-     */
-    get headers() {
-        return this.request.headers || {};
-    }
-    /**
-     * Get a value from the request params or return
-     * the default value.
-     *
-     * @example
-     * ```ts
-     * const id = request.param('id', '1')
-     * ```
-     */
-    param(param, defaultValue) {
-        return Json.get(this.params, param, defaultValue);
-    }
-    /**
-     * Get a value from the request query param or return
-     * the default value.
-     *
-     * @example
-     * ```ts
-     * const page = request.query('page', '1')
-     * ```
-     */
-    query(query, defaultValue) {
-        return Json.get(this.queries, query, defaultValue);
-    }
-    /**
-     * Get a value from the request header or return
-     * the default value.
-     *
-     * @example
-     * ```ts
-     * const accept = request.header('accept', 'application/json')
-     * ```
-     */
-    header(header, defaultValue) {
-        return Json.get(this.headers, header, defaultValue);
-    }
-    /**
-     * Get a value from the request body or return
-     * the default value.
-     *
-     * @example
-     * ```ts
-     * const name = request.input('name', 'lenon')
-     * ```
-     */
-    input(key, defaultValue) {
-        return this.payload(key, defaultValue);
-    }
-    /**
-     * Get a value from the request body or return
-     * the default value.
-     *
-     * @example
-     * ```ts
-     * const name = request.payload('name', 'lenon')
-     * ```
-     */
-    payload(key, defaultValue) {
-        return Json.get(this.body, key, defaultValue);
-    }
-    /**
-     * Get only the selected values from the request body.
-     *
-     * @example
-     * ```ts
-     * const body = request.only(['name', 'email'])
-     * ```
-     */
-    only(keys) {
-        const body = {};
-        Object.keys(this.body).forEach(key => {
-            if (!keys.includes(key)) {
-                return;
+export function request(req) {
+    const request = {
+        request: req,
+        id: req.id,
+        ip: req.ip,
+        hostname: req.hostname,
+        get port() {
+            return request.getAddressInfo().port;
+        },
+        version: req.raw.httpVersion,
+        protocol: req.protocol,
+        method: req.method,
+        baseUrl: req.url.split('?')[0],
+        get baseHostUrl() {
+            return request.getHostUrlFor(request.baseUrl);
+        },
+        routeUrl: req.routeOptions.url,
+        get routeHostUrl() {
+            return request.getHostUrlFor(request.routeUrl);
+        },
+        originalUrl: req.url,
+        get originalHostUrl() {
+            return request.getHostUrlFor(request.originalUrl);
+        },
+        body: req.body || {},
+        params: req.params || {},
+        queries: req.query || {},
+        headers: req.headers || {},
+        param(param, defaultValue) {
+            return Json.get(request.params, param, defaultValue);
+        },
+        query(query, defaultValue) {
+            return Json.get(request.queries, query, defaultValue);
+        },
+        header(header, defaultValue) {
+            return Json.get(request.headers, header, defaultValue);
+        },
+        input(key, defaultValue) {
+            return request.payload(key, defaultValue);
+        },
+        payload(key, defaultValue) {
+            return Json.get(request.body, key, defaultValue);
+        },
+        only(keys) {
+            const body = {};
+            Object.keys(request.body).forEach(key => {
+                if (!keys.includes(key)) {
+                    return;
+                }
+                body[key] = request.body[key];
+            });
+            return body;
+        },
+        except(keys) {
+            const body = {};
+            Object.keys(request.body).forEach(key => {
+                if (keys.includes(key)) {
+                    return;
+                }
+                body[key] = request.body[key];
+            });
+            return body;
+        },
+        getHostUrlFor(url) {
+            let { address, port } = request.getAddressInfo();
+            if (address === '::1') {
+                address = '127.0.0.1';
             }
-            body[key] = this.body[key];
-        });
-        return body;
-    }
-    /**
-     * Get all the values from the request body except the
-     * selected ones.
-     *
-     * @example
-     * ```ts
-     * const body = request.except(['name'])
-     * ```
-     */
-    except(keys) {
-        const body = {};
-        Object.keys(this.body).forEach(key => {
-            if (keys.includes(key)) {
-                return;
+            if (!Is.Ip(address) && address !== 'localhost') {
+                return `${request.protocol}://${address}${url}`;
             }
-            body[key] = this.body[key];
-        });
-        return body;
-    }
-    /**
-     * Add the hostname and port to the url.
-     */
-    getHostUrlFor(url) {
-        let { address, port } = this.getAddressInfo();
-        if (address === '::1') {
-            address = '127.0.0.1';
+            return `${request.protocol}://${address}:${port}${url}`;
+        },
+        getAddressInfo() {
+            return req.server.server.address();
         }
-        if (!Is.Ip(address) && address !== 'localhost') {
-            return `${this.protocol}://${address}${url}`;
-        }
-        return `${this.protocol}://${address}:${port}${url}`;
-    }
-    /**
-     * 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).
-     */
-    getAddressInfo() {
-        return this.request.server.server.address();
-    }
+    };
+    return request;
 }