@athenna/http 4.23.0 → 4.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.23.0",
+  "version": "4.25.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -72,14 +72,14 @@
     "#tests": "./tests/index.js"
   },
   "devDependencies": {
-    "@athenna/artisan": "^4.37.0",
-    "@athenna/common": "^4.34.0",
-    "@athenna/config": "^4.16.0",
-    "@athenna/ioc": "^4.16.0",
-    "@athenna/logger": "^4.17.0",
+    "@athenna/artisan": "^4.38.0",
+    "@athenna/common": "^4.35.0",
+    "@athenna/config": "^4.18.0",
+    "@athenna/ioc": "^4.18.0",
+    "@athenna/logger": "^4.18.0",
     "@athenna/test": "^4.22.0",
     "@athenna/tsconfig": "^4.12.0",
-    "@athenna/view": "^4.18.0",
+    "@athenna/view": "^4.20.0",
     "@fastify/cors": "^8.4.2",
     "@fastify/helmet": "^11.1.1",
     "@fastify/rate-limit": "^8.1.1",

package/src/commands/RouteListCommand.js

@@ -8,8 +8,8 @@
  */
 import { sep } from 'node:path';
 import { Config } from '@athenna/config';
-import { Module } from '@athenna/common';
 import { BaseCommand } from '@athenna/artisan';
+import { Path, Module } from '@athenna/common';
 import { Route, HttpKernel, HttpRouteProvider, HttpServerProvider } from '#src';
 export class RouteListCommand extends BaseCommand {
     static signature() {

package/src/context/Request.d.ts

@@ -6,139 +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 12345
-     */
-    get id(): string;
-    /**
-     * Get the request ip.
-     *
-     * @example 192.168.0.1
-     */
-    get ip(): string;
-    /**
-     * Get the request hostname.
-     *
-     * @example localhost
-     */
-    get hostname(): string;
-    /**
-     * Get the request protocol.
-     *
-     * @example http
-     */
-    get protocol(): 'http' | 'https';
-    /**
-     * Get the request method.
-     *
-     * @example GET
-     */
-    get method(): string;
-    /**
-     * Get the base url from request.
-     *
-     * @example /users/1
-     */
-    get baseUrl(): string;
-    /**
-     * Get the base url with host and port info from request.
-     *
-     * @example http://localhost:3030/users/1
-     */
-    get baseHostUrl(): string;
-    /**
-     * Get the route url from request.
-     *
-     * @example /users/:id
-     */
-    get routeUrl(): string;
-    /**
-     * Get the route url with host and port info from request.
-     *
-     * @example http://localhost:3030/users/:id
-     */
-    get routeHostUrl(): string;
-    /**
-     * Get the original url from request.
-     *
-     * @example /users/1?query=true
-     */
-    get originalUrl(): string;
-    /**
-     * Get the original url with host and port info from request.
-     *
-     * @example /users/1?query=true
-     */
-    get originalHostUrl(): string;
-    /**
-     * Get all body from request.
-     */
-    get body(): any | any[];
-    /**
-     * Get all params from request.
-     */
-    get params(): any;
-    /**
-     * Get all queries from request.
-     */
-    get queries(): any;
-    /**
-     * Get all headers from request.
-     */
-    get headers(): any;
-    /**
-     * Get the server port.
-     */
-    get port(): number;
-    /**
-     * Get the http version.
-     */
-    get version(): string;
-    /**
-     * Get a value from the request params or the default value.
-     */
-    param(param: string, defaultValue?: any): any;
-    /**
-     * Get a value from the request query param or the default value.
-     */
-    query(query: string, defaultValue?: any): any;
-    /**
-     * Get a value from the request header or the default value.
-     */
-    header(header: string, defaultValue?: any): any;
-    /**
-     * Get only the selected values from the request body.
-     */
-    only(keys: string[]): any;
-    /**
-     * Get all the values from the request body except the selected ones.
-     */
-    except(keys: string[]): any;
-    /**
-     * Get a value from the request body or the default value.
-     */
-    input(key: string, defaultValue?: any): any;
-    /**
-     * Get a value from the request body or the default value.
-     */
-    payload(key: string, defaultValue?: any): 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,209 +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 12345
-     */
-    get id() {
-        return this.request.id;
-    }
-    /**
-     * Get the request ip.
-     *
-     * @example 192.168.0.1
-     */
-    get ip() {
-        return this.request.ip;
-    }
-    /**
-     * Get the request hostname.
-     *
-     * @example localhost
-     */
-    get hostname() {
-        return this.request.hostname;
-    }
-    /**
-     * Get the request protocol.
-     *
-     * @example http
-     */
-    get protocol() {
-        return this.request.protocol;
-    }
-    /**
-     * Get the request method.
-     *
-     * @example GET
-     */
-    get method() {
-        return this.request.method;
-    }
-    /**
-     * Get the base url from request.
-     *
-     * @example /users/1
-     */
-    get baseUrl() {
-        return this.request.url.split('?')[0];
-    }
-    /**
-     * Get the base url with host and port info from request.
-     *
-     * @example http://localhost:3030/users/1
-     */
-    get baseHostUrl() {
-        return this.getHostUrlFor(this.baseUrl);
-    }
-    /**
-     * Get the route url from request.
-     *
-     * @example /users/:id
-     */
-    get routeUrl() {
-        return this.request.routeOptions.url;
-    }
-    /**
-     * Get the route url with host and port info from request.
-     *
-     * @example http://localhost:3030/users/:id
-     */
-    get routeHostUrl() {
-        return this.getHostUrlFor(this.routeUrl);
-    }
-    /**
-     * Get the original url from request.
-     *
-     * @example /users/1?query=true
-     */
-    get originalUrl() {
-        return this.request.url;
-    }
-    /**
-     * Get the original url with host and port info from request.
-     *
-     * @example /users/1?query=true
-     */
-    get originalHostUrl() {
-        return this.getHostUrlFor(this.originalUrl);
-    }
-    /**
-     * Get all body from request.
-     */
-    get body() {
-        return this.request.body || {};
-    }
-    /**
-     * Get all params from request.
-     */
-    get params() {
-        return this.request.params || {};
-    }
-    /**
-     * Get all queries from request.
-     */
-    get queries() {
-        return this.request.query || {};
-    }
-    /**
-     * Get all headers from request.
-     */
-    get headers() {
-        return this.request.headers || {};
-    }
-    /**
-     * Get the server port.
-     */
-    get port() {
-        return this.getAddressInfo().port;
-    }
-    /**
-     * Get the http version.
-     */
-    get version() {
-        return this.request.raw.httpVersion;
-    }
-    /**
-     * Get a value from the request params or the default value.
-     */
-    param(param, defaultValue) {
-        return this.params[param] || defaultValue;
-    }
-    /**
-     * Get a value from the request query param or the default value.
-     */
-    query(query, defaultValue) {
-        return this.queries[query] || defaultValue;
-    }
-    /**
-     * Get a value from the request header or the default value.
-     */
-    header(header, defaultValue) {
-        return this.headers[header] || defaultValue;
-    }
-    /**
-     * Get only the selected values from the request body.
-     */
-    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.
-     */
-    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;
-    }
-    /**
-     * Get a value from the request body or the default value.
-     */
-    input(key, defaultValue) {
-        return this.payload(key, defaultValue);
-    }
-    /**
-     * Get a value from the request body or the default value.
-     */
-    payload(key, defaultValue) {
-        return Json.get(this.body, key, defaultValue);
-    }
-    /**
-     * 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;
 }

package/src/context/Response.d.ts

@@ -7,81 +7,8 @@
  * file that was distributed with this source code.
  */
 import type { FastifyReply } from 'fastify';
-import type { SendOptions } from '@fastify/static';
-import type { Request } from '#src/context/Request';
-import type { FastifyHelmetOptions } from '@fastify/helmet';
-export declare class Response {
-    /**
-     * The fastify response object.
-     */
-    response: FastifyReply;
-    /**
-     * The request object from request context.
-     */
-    request: Request;
-    constructor(response: FastifyReply, request?: Request);
-    /**
-     * Verify if the response has been already sent.
-     */
-    get sent(): boolean;
-    /**
-     * Get the response body sent in response.
-     */
-    get body(): any | any[];
-    /**
-     * Get the status code sent in response.
-     */
-    get statusCode(): number;
-    /**
-     * Get the headers sent in response.
-     */
-    get headers(): any;
-    /**
-     * Get the time in MS of how much the request has taken to response.
-     */
-    get responseTime(): number;
-    /**
-     * Terminated the request sending a view to be rendered.
-     */
-    view(view: string, data?: any): Promise<Response>;
-    /**
-     * Terminate the request sending the response body or not.
-     */
-    send(data?: any): Promise<Response>;
-    sendFile(filename: string, filepath?: string): Promise<Response>;
-    sendFile(filename: string, options?: string | SendOptions): Promise<Response>;
-    sendFile(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
-    download(filepath: string, filename?: string): Promise<Response>;
-    download(filepath: string, options?: string | SendOptions): Promise<Response>;
-    download(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
-    /**
-     * Set the response status code.
-     */
-    status(code: number): Response;
-    /**
-     * Add some header to the response.
-     */
-    header(header: string, value: any): Response;
-    /**
-     * Verify if response has some header.
-     */
-    hasHeader(header: string): boolean;
-    /**
-     * Add some header safely to the response. This means that the header is not
-     * going to be added if is already set.
-     */
-    safeHeader(header: string, value: any): Response;
-    /**
-     * Remove some header from the response.
-     */
-    removeHeader(header: string): Response;
-    /**
-     * Redirect the response to other url. You can also set a different status code
-     * for the redirect.
-     */
-    redirectTo(url: string, status?: number): Promise<Response>;
-    /**
-     * Apply helmet in response.
-     */
-    helmet(options: FastifyHelmetOptions): Response;
-}
+import type { Request, Response } from '#src/types';
+/**
+ * Create the Athenna response object
+ */
+export declare function response(reply: FastifyReply, request?: Request): Response;