@athenna/http 3.0.11 → 3.1.0

package/build/Commands/MakeControllerCommand.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@athenna/artisan';
+export declare class MakeControllerCommand extends BaseCommand {
+    name: string;
+    static signature(): string;
+    static description(): string;
+    handle(): Promise<void>;
+}

package/build/Commands/MakeControllerCommand.js

@@ -0,0 +1,42 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Path } from '@athenna/common';
+import { BaseCommand, Argument } from '@athenna/artisan';
+export class MakeControllerCommand extends BaseCommand {
+    name;
+    static signature() {
+        return 'make:controller';
+    }
+    static description() {
+        return 'Make a new controller file.';
+    }
+    async handle() {
+        this.logger.simple('({bold,green} [ MAKING CONTROLLER ])\n');
+        const file = await this.generator
+            .path(Path.http(`Controllers/${this.name}.${Path.ext()}`))
+            .template('artisan::controller')
+            .setNameProperties(true)
+            .make();
+        this.logger.success(`Controller ({yellow} "${file.name}") successfully created.`);
+        const importPath = `#app/Http/Controllers/${file.name}`;
+        await this.rc.pushTo('controllers', importPath).save();
+        this.logger.success(`Athenna RC updated: ({dim,yellow} [ controllers += "${importPath}" ])`);
+    }
+}
+__decorate([
+    Argument({
+        description: 'The controller name.',
+    })
+], MakeControllerCommand.prototype, "name", void 0);

package/build/Commands/MakeInterceptorCommand.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@athenna/artisan';
+export declare class MakeInterceptorCommand extends BaseCommand {
+    name: string;
+    static signature(): string;
+    static description(): string;
+    handle(): Promise<void>;
+}

package/build/Commands/MakeInterceptorCommand.js

@@ -0,0 +1,42 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Path } from '@athenna/common';
+import { BaseCommand, Argument } from '@athenna/artisan';
+export class MakeInterceptorCommand extends BaseCommand {
+    name;
+    static signature() {
+        return 'make:interceptor';
+    }
+    static description() {
+        return 'Make a new interceptor file.';
+    }
+    async handle() {
+        this.logger.simple('({bold,green} [ MAKING INTERCEPTOR ])\n');
+        const file = await this.generator
+            .path(Path.http(`Interceptors/${this.name}.${Path.ext()}`))
+            .template('artisan::interceptor')
+            .setNameProperties(true)
+            .make();
+        this.logger.success(`Interceptor ({yellow} "${file.name}") successfully created.`);
+        const importPath = `#app/Http/Interceptors/${file.name}`;
+        await this.rc.pushTo('middlewares', importPath).save();
+        this.logger.success(`Athenna RC updated: ({dim,yellow} [ middlewares += "${importPath}" ])`);
+    }
+}
+__decorate([
+    Argument({
+        description: 'The interceptor name.',
+    })
+], MakeInterceptorCommand.prototype, "name", void 0);

package/build/Commands/MakeMiddlewareCommand.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@athenna/artisan';
+export declare class MakeMiddlewareCommand extends BaseCommand {
+    name: string;
+    static signature(): string;
+    static description(): string;
+    handle(): Promise<void>;
+}

package/build/Commands/MakeMiddlewareCommand.js

@@ -0,0 +1,42 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Path } from '@athenna/common';
+import { BaseCommand, Argument } from '@athenna/artisan';
+export class MakeMiddlewareCommand extends BaseCommand {
+    name;
+    static signature() {
+        return 'make:middleware';
+    }
+    static description() {
+        return 'Make a new middleware file.';
+    }
+    async handle() {
+        this.logger.simple('({bold,green} [ MAKING MIDDLEWARE ])\n');
+        const file = await this.generator
+            .path(Path.http(`Middlewares/${this.name}.${Path.ext()}`))
+            .template('artisan::middleware')
+            .setNameProperties(true)
+            .make();
+        this.logger.success(`Middleware ({yellow} "${file.name}") successfully created.`);
+        const importPath = `#app/Http/Middlewares/${file.name}`;
+        await this.rc.pushTo('middlewares', importPath).save();
+        this.logger.success(`Athenna RC updated: ({dim,yellow} [ middlewares += "${importPath}" ])`);
+    }
+}
+__decorate([
+    Argument({
+        description: 'The middleware name.',
+    })
+], MakeMiddlewareCommand.prototype, "name", void 0);

package/build/Commands/MakeTerminatorCommand.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@athenna/artisan';
+export declare class MakeTerminatorCommand extends BaseCommand {
+    name: string;
+    static signature(): string;
+    static description(): string;
+    handle(): Promise<void>;
+}

package/build/Commands/MakeTerminatorCommand.js

@@ -0,0 +1,42 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Path } from '@athenna/common';
+import { BaseCommand, Argument } from '@athenna/artisan';
+export class MakeTerminatorCommand extends BaseCommand {
+    name;
+    static signature() {
+        return 'make:terminator';
+    }
+    static description() {
+        return 'Make a new terminator file.';
+    }
+    async handle() {
+        this.logger.simple('({bold,green} [ MAKING TERMINATOR ])\n');
+        const file = await this.generator
+            .path(Path.http(`Terminators/${this.name}.${Path.ext()}`))
+            .template('artisan::terminator')
+            .setNameProperties(true)
+            .make();
+        this.logger.success(`Terminator ({yellow} "${file.name}") successfully created.`);
+        const importPath = `#app/Http/Terminators/${file.name}`;
+        await this.rc.pushTo('middlewares', importPath).save();
+        this.logger.success(`Athenna RC updated: ({dim,yellow} [ middlewares += "${importPath}" ])`);
+    }
+}
+__decorate([
+    Argument({
+        description: 'The terminator name.',
+    })
+], MakeTerminatorCommand.prototype, "name", void 0);

package/build/Commands/RouteListCommand.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@athenna/artisan';
+export declare class RouteListCommand extends BaseCommand {
+    routeFilePath: any;
+    static signature(): string;
+    static description(): string;
+    handle(): Promise<void>;
+    /**
+     * Resolve the import path by meta URL and import it.
+     */
+    private resolveRoutePathAndImport;
+}

package/build/Commands/RouteListCommand.js

@@ -0,0 +1,62 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { resolve } from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { Config } from '@athenna/config';
+import { Module } from '@athenna/common';
+import { BaseCommand } from '@athenna/artisan';
+import { Route, HttpKernel, HttpRouteProvider, HttpServerProvider } from '#src';
+export class RouteListCommand extends BaseCommand {
+    routeFilePath = Env('HTTP_ROUTE_FILE_PATH', Path.routes('http.js'));
+    static signature() {
+        return 'route:list';
+    }
+    static description() {
+        return 'List all the http routes registered in your application.';
+    }
+    async handle() {
+        this.logger.simple('({bold,green} [ LISTING ROUTES ])\n');
+        new HttpServerProvider().register();
+        new HttpRouteProvider().register();
+        const kernel = new HttpKernel();
+        await kernel.registerControllers();
+        await kernel.registerMiddlewares();
+        await this.resolveRoutePathAndImport();
+        const routes = Route.list();
+        const table = this.logger.table();
+        table.head('Methods', 'Route', 'Name', 'Handler');
+        routes.forEach(route => {
+            if (route.deleted) {
+                return;
+            }
+            table.row([
+                route.methods.join('|'),
+                route.url,
+                route.name || 'Not found',
+                route.handler.name || 'closure',
+            ]);
+        });
+        table.render();
+    }
+    /**
+     * Resolve the import path by meta URL and import it.
+     */
+    resolveRoutePathAndImport() {
+        if (this.routeFilePath.includes('./') ||
+            this.routeFilePath.includes('../')) {
+            this.routeFilePath = resolve(this.routeFilePath);
+        }
+        if (!this.routeFilePath.startsWith('#')) {
+            this.routeFilePath = pathToFileURL(this.routeFilePath).href;
+        }
+        return import.meta
+            .resolve(this.routeFilePath, Config.get('rc.meta'))
+            .then(meta => Module.get(import(meta)));
+    }
+}

package/build/Context/Request.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { 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 server 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;
+}

package/build/Context/Request.js

@@ -0,0 +1,219 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Is, Json } from '@athenna/common';
+export class Request {
+    /**
+     * The fastify request object.
+     */
+    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.routerPath;
+    }
+    /**
+     * 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 server version.
+     */
+    get version() {
+        return this.request.server.version;
+    }
+    /**
+     * 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;
+            }
+            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;
+            }
+            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';
+        }
+        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();
+    }
+}