@athenna/http 1.3.9 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "1.3.9",
+  "version": "1.4.2",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -41,7 +41,10 @@
     "./providers/ControllerProvider": "./src/Providers/ControllerProvider.js",
     "./providers/HttpRouteProvider": "./src/Providers/HttpRouteProvider.js",
     "./providers/HttpServerProvider": "./src/Providers/HttpServerProvider.js",
-    "./providers/MiddlewareProvider": "./src/Providers/MiddlewareProvider.js"
+    "./providers/MiddlewareProvider": "./src/Providers/MiddlewareProvider.js",
+    "./commands/Route/List": "./src/Commands/Route/List.js",
+    "./commands/Make/Controller": "./src/Commands/Make/Controller.js",
+    "./commands/Make/Middleware": "./src/Commands/Make/Middleware.js"
   },
   "types": "./src/index.d.ts",
   "imports": {
@@ -49,6 +52,7 @@
     "#tests/*": "./tests/*.js"
   },
   "dependencies": {
+    "@athenna/artisan": "1.2.7",
     "@athenna/ioc": "1.2.0",
     "@athenna/logger": "1.2.5",
     "@secjs/utils": "1.9.4",
@@ -89,7 +93,11 @@
       "html"
     ],
     "report-dir": "./tests/Coverage",
-    "check-coverage": true
+    "check-coverage": true,
+    "statements": "70",
+    "branches": "70",
+    "functions": "70",
+    "lines": "70"
   },
   "husky": {
     "hooks": {

package/src/Commands/Make/Controller.js

@@ -0,0 +1,72 @@
+/**
+ * @athenna/artisan
+ *
+ * (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 { join } from 'node:path'
+import { Folder, Path, String } from '@secjs/utils'
+import { Artisan, Command, TemplateHelper } from '@athenna/artisan'
+
+export class MakeController extends Command {
+  /**
+   * The name and signature of the console command.
+   */
+  signature = 'make:controller <name>'
+
+  /**
+   * The console command description.
+   */
+  description = 'Make a new controller file.'
+
+  /**
+   * Set additional flags in the commander instance.
+   * This method is executed when registering your command.
+   *
+   * @param {import('commander').Command} commander
+   * @return {import('commander').Command}
+   */
+  addFlags(commander) {
+    return commander.option(
+      '--no-lint',
+      'Do not run eslint in the controller.',
+      true,
+    )
+  }
+
+  /**
+   * Execute the console command.
+   *
+   * @param {string} name
+   * @param {any} options
+   * @return {Promise<void>}
+   */
+  async handle(name, options) {
+    TemplateHelper.setTemplatesFolder(
+      new Folder(join(__dirname, '..', '..', '..', 'templates')).loadSync(),
+    )
+
+    const resource = 'Controller'
+    const subPath = Path.app(`Http/${String.pluralize(resource)}`)
+
+    this.simpleLog(
+      `[ MAKING ${resource.toUpperCase()} ]\n`,
+      'rmNewLineStart',
+      'bold',
+      'green',
+    )
+
+    const file = await TemplateHelper.getResourceFile(name, resource, subPath)
+
+    this.success(`${resource} ({yellow} "${file.name}") successfully created.`)
+
+    if (options.lint) {
+      await Artisan.call(`eslint:fix ${file.path} --resource ${resource}`)
+    }
+
+    TemplateHelper.setOriginalTemplatesFolder()
+  }
+}

package/src/Commands/Make/Middleware.js

@@ -0,0 +1,83 @@
+/**
+ * @athenna/artisan
+ *
+ * (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 { join } from 'node:path'
+import { Folder, Path, String } from '@secjs/utils'
+import { Artisan, Command, TemplateHelper } from '@athenna/artisan'
+
+export class MakeMiddleware extends Command {
+  /**
+   * The name and signature of the console command.
+   */
+  signature = 'make:middleware <name>'
+
+  /**
+   * The console command description.
+   */
+  description = 'Make a new middleware file.'
+
+  /**
+   * Set additional flags in the commander instance.
+   * This method is executed when registering your command.
+   *
+   * @param {import('commander').Command} commander
+   * @return {import('commander').Command}
+   */
+  addFlags(commander) {
+    return commander
+      .option(
+        '--no-register',
+        'Do not register the middleware inside Kernel.',
+        true,
+      )
+      .option('--no-lint', 'Do not run eslint in the middleware.', true)
+  }
+
+  /**
+   * Execute the console command.
+   *
+   * @param {string} name
+   * @param {any} options
+   * @return {Promise<void>}
+   */
+  async handle(name, options) {
+    TemplateHelper.setTemplatesFolder(
+      new Folder(join(__dirname, '..', '..', '..', 'templates')).loadSync(),
+    )
+
+    const resource = 'Middleware'
+    const subPath = Path.app(`Http/${String.pluralize(resource)}`)
+
+    this.simpleLog(
+      `[ MAKING ${resource.toUpperCase()} ]\n`,
+      'rmNewLineStart',
+      'bold',
+      'green',
+    )
+
+    const file = await TemplateHelper.getResourceFile(name, resource, subPath)
+
+    this.success(`${resource} ({yellow} "${file.name}") successfully created.`)
+
+    if (options.lint) {
+      await Artisan.call(`eslint:fix ${file.path} --resource ${resource}`)
+    }
+
+    if (options.register) {
+      await TemplateHelper.replaceObjectProperty(
+        Path.http('Kernel.js'),
+        'namedMiddlewares =',
+        file.name,
+        `#app/Http/Middlewares/${file.name}`,
+      )
+    }
+
+    TemplateHelper.setOriginalTemplatesFolder()
+  }
+}

package/src/Commands/Route/List.js

@@ -0,0 +1,102 @@
+/**
+ * @athenna/artisan
+ *
+ * (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 { pathToFileURL } from 'node:url'
+import { Command } from '@athenna/artisan'
+import { Exec, Path, String } from '@secjs/utils'
+
+export class RouteList extends Command {
+  /**
+   * The name and signature of the console command.
+   */
+  signature = 'route:list'
+
+  /**
+   * The console command description.
+   */
+  description = 'List all the routes of your application.'
+
+  /**
+   * Set additional flags in the commander instance.
+   * This method is executed when registering your command.
+   *
+   * @param {import('commander').Command} commander
+   * @return {import('commander').Command}
+   */
+  addFlags(commander) {
+    return commander.option(
+      '-m, --middleware',
+      'List the middlewares of each route.',
+      false,
+    )
+  }
+
+  /**
+   * Execute the console command.
+   *
+   * @param {any} options
+   * @return {Promise<void>}
+   */
+  async handle(options) {
+    this.simpleLog('[ ROUTE LISTING ]', 'rmNewLineStart', 'bold', 'green')
+
+    const Route = ioc.safeUse('Athenna/Core/HttpRoute')
+
+    const Kernel = await Exec.getModule(
+      import(pathToFileURL(Path.http('Kernel.js')).href),
+    )
+
+    const kernel = new Kernel()
+
+    await kernel.registerCors()
+    await kernel.registerRateLimit()
+    await kernel.registerMiddlewares()
+    await kernel.registerErrorHandler()
+    await kernel.registerLogMiddleware()
+    await kernel.registerRequestIdMiddleware()
+
+    const routePath = Path.routes('http.js')
+
+    await import(routePath)
+    const routes = Route.listRoutes()
+
+    const header = ['Method', 'Route', 'Handler']
+    const rows = []
+
+    if (options.middleware) header.push('Middlewares')
+
+    routes.forEach(route => {
+      const row = [route.methods.join('|'), route.url, 'Closure']
+
+      if (options.middleware) {
+        let middlewares = ''
+
+        Object.keys(route.middlewares).forEach(key => {
+          if (route.middlewares[key].length) {
+            const number = route.middlewares[key].length
+
+            if (middlewares) {
+              middlewares = middlewares + '\n'
+            }
+
+            middlewares = middlewares + `${String.toPascalCase(key)}: ${number}`
+          }
+        })
+
+        if (!middlewares) middlewares = 'Not found'
+
+        row.push(middlewares)
+      }
+
+      rows.push(row)
+    })
+
+    this.logTable({ head: header }, ...rows)
+  }
+}

package/src/Handlers/HttpExceptionHandler.js

@@ -64,11 +64,11 @@ export class HttpExceptionHandler {
       return
     }
 
-    const prettyError = await new Exception(
-      body.message,
-      body.statusCode,
-      body.code,
-    ).prettify()
+    const exception = new Exception(body.message, body.statusCode, body.code)
+
+    exception.stack = body.stack
+
+    const prettyError = await exception.prettify()
 
     Log.channel('exception').error(prettyError.concat('\n'))
   }

package/src/Helpers/HttpCommandsLoader.js

@@ -0,0 +1,14 @@
+export class HttpCommandsLoader {
+  /**
+   * Return all commands from http package.
+   *
+   * @return {any[]}
+   */
+  static loadCommands() {
+    return [
+      import('#src/Commands/Route/List.js'),
+      import('#src/Commands/Make/Controller.js'),
+      import('#src/Commands/Make/Middleware.js'),
+    ]
+  }
+}

package/src/index.d.ts

@@ -578,6 +578,15 @@ export interface ResponseContract {
   getFastifyResponse(): FastifyReply
 }
 
+export class HttpCommandsLoader {
+  /**
+   * Return all commands from http package.
+   *
+   * @return {any[]}
+   */
+  static loadCommands(): any[]
+}
+
 export interface NextContract {
   (...params: any[]): void
 }

package/src/index.js

@@ -19,6 +19,11 @@ export * from './Facades/Server.js'
 export * from './Kernels/HttpKernel.js'
 export * from './Handlers/HttpExceptionHandler.js'
 
+export * from './Commands/Route/List.js'
+export * from './Commands/Make/Controller.js'
+export * from './Commands/Make/Middleware.js'
+export * from './Helpers/HttpCommandsLoader.js'
+
 export class Http {
   /**
    * Holds the fastify server instance.