@athenna/http 3.0.11 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "3.0.11",
+  "version": "3.1.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -12,103 +12,126 @@
     "router",
     "cors",
     "ctx",
+    "helmet",
+    "swagger",
     "exception-handling",
     "rate-limiting",
     "middlewares",
+    "terminators",
+    "interceptors",
     "http-server",
     "athenna",
     "esm"
   ],
   "scripts": {
-    "lint:fix": "eslint \"{src,tests}/**/*.js\" --fix",
-    "test": "npm run --silent lint:fix && node ./tests/index.js",
-    "test:debug": "cross-env DEBUG=api:* && npm run --silent test",
-    "test:coverage": "c8 npm run --silent test",
-    "gen:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --out src/index.js"
+    "node": "cross-env NODE_OPTIONS=\"--experimental-import-meta-resolve\" ts-node",
+    "build": "npm run node --silent -- bin/build.ts",
+    "artisan": "npm run node --silent -- bin/artisan.ts",
+    "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix",
+    "test": "npm run --silent lint:fix && npm run node --silent -- bin/test.ts",
+    "test:debug": "cross-env DEBUG=api:* npm run node --silent -- bin/test.ts --inspect",
+    "test:coverage": "c8 npm run --silent test"
   },
   "files": [
-    "src/*.js",
-    "src/*.d.ts",
-    "src/**/*.js",
-    "src/**/*.d.ts",
+    "build/*.js",
+    "build/*.d.ts",
+    "build/**/*.js",
+    "build/**/*.d.ts",
     "templates/*",
     "templates/**/*"
   ],
   "type": "module",
-  "main": "./src/index.js",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "exports": {
-    ".": "./src/index.js",
-    "./facades/Route": "./src/Facades/Route.js",
-    "./facades/Server": "./src/Facades/Server.js",
-    "./providers/ControllerProvider": "./src/Providers/ControllerProvider.js",
-    "./providers/HttpRouteProvider": "./src/Providers/HttpRouteProvider.js",
-    "./providers/HttpServerProvider": "./src/Providers/HttpServerProvider.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"
+    ".": "./build/index.js",
+    "./providers/HttpRouteProvider": "./build/Providers/HttpRouteProvider.js",
+    "./providers/HttpServerProvider": "./build/Providers/HttpServerProvider.js",
+    "./commands/RouteListCommand": "./build/Commands/RouteListCommand.js",
+    "./commands/MakeControllerCommand": "./build/Commands/MakeControllerCommand.js",
+    "./commands/MakeMiddlewareCommand": "./build/Commands/MakeMiddlewareCommand.js",
+    "./commands/MakeTerminatorCommand": "./build/Commands/MakeTerminatorCommand.js",
+    "./commands/MakeInterceptorCommand": "./build/Commands/MakeInterceptorCommand.js"
   },
-  "types": "./src/index.d.ts",
   "imports": {
-    "#src/*": "./src/*.js",
-    "#tests/*": "./tests/*.js"
+    "#src/*": "./build/*.js",
+    "#src": "./build/index.js",
+    "#tests/*": "./tests/*.js",
+    "#tests": "./tests/index.js"
   },
   "dependencies": {
-    "fastify": "4.9.2"
+    "fastify": "^4.13.0"
   },
   "devDependencies": {
-    "@athenna/artisan": "3.0.10",
-    "@athenna/common": "3.0.2",
-    "@athenna/config": "3.0.4",
-    "@athenna/ioc": "3.0.2",
-    "@athenna/logger": "3.0.9",
-    "@fastify/cors": "8.1.1",
-    "@fastify/helmet": "10.0.2",
-    "@fastify/rate-limit": "7.5.0",
-    "@fastify/swagger": "8.1.0",
-    "@fastify/swagger-ui": "1.1.0",
-    "@japa/assert": "1.3.4",
-    "@japa/run-failed-tests": "1.0.7",
-    "@japa/runner": "2.0.7",
-    "@japa/spec-reporter": "1.1.12",
-    "@types/commander": "2.12.2",
-    "c8": "7.11.2",
-    "cls-rtracer": "2.6.2",
-    "commitizen": "4.2.5",
-    "cross-env": "7.0.3",
-    "cz-conventional-changelog": "3.3.0",
-    "eslint": "8.14.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-config-standard": "17.0.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-n": "15.2.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-promise": "6.0.0",
-    "husky": "3.0.9",
-    "lint-staged": "12.4.1",
-    "minimist": "1.2.6",
-    "prettier": "2.6.2",
-    "rimraf": "3.0.2",
-    "typescript": "4.6.4"
+    "@athenna/artisan": "^3.0.0",
+    "@athenna/common": "^3.0.0",
+    "@athenna/config": "^3.0.0",
+    "@athenna/ioc": "^3.0.0",
+    "@athenna/logger": "^3.0.0",
+    "@athenna/view": "^3.0.0",
+    "@fastify/cors": "^8.1.1",
+    "@fastify/helmet": "^10.0.2",
+    "@fastify/rate-limit": "^7.5.0",
+    "@fastify/swagger": "^8.1.0",
+    "@fastify/swagger-ui": "^1.1.0",
+    "@japa/assert": "^1.3.6",
+    "@japa/run-failed-tests": "^1.1.0",
+    "@japa/runner": "^2.2.2",
+    "@japa/spec-reporter": "^1.3.2",
+    "@swc/core": "^1.3.27",
+    "@types/bytes": "^3.1.1",
+    "@types/callsite": "^1.0.31",
+    "@types/columnify": "^1.5.1",
+    "@types/debug": "^4.1.7",
+    "@types/figlet": "^1.5.5",
+    "@types/inquirer": "^9.0.3",
+    "@types/kind-of": "^6.0.0",
+    "@types/lodash": "^4.14.191",
+    "@types/ms": "^0.7.31",
+    "@types/pluralize": "^0.0.29",
+    "@types/sinon": "^10.0.13",
+    "@types/uuid": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
+    "c8": "^7.12.0",
+    "cls-rtracer": "^2.6.2",
+    "commitizen": "^4.2.6",
+    "cross-env": "^7.0.3",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "husky": "^3.1.0",
+    "js-yaml": "^4.1.0",
+    "lint-staged": "^12.5.0",
+    "minimist": "^1.2.7",
+    "prettier": "^2.8.3",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "sinon": "^15.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
   },
   "c8": {
     "all": true,
     "include": [
-      "src/**/*.js"
+      "src/**/*.ts"
     ],
     "exclude": [
-      "src/Exceptions/*.js"
+      "src/Types/*",
+      "src/Contracts/*",
+      "src/Exceptions/*"
     ],
     "reporter": [
       "text-summary",
       "html"
     ],
     "report-dir": "./tests/Coverage",
-    "check-coverage": true,
-    "statements": "70",
-    "branches": "70",
-    "functions": "70",
-    "lines": "70"
+    "check-coverage": true
   },
   "husky": {
     "hooks": {
@@ -116,7 +139,7 @@
     }
   },
   "lint-staged": {
-    "*.js": [
+    "*.ts": [
       "eslint --fix",
       "git add"
     ],
@@ -146,34 +169,93 @@
       }
     ]
   },
+  "eslintIgnore": [
+    "build/**/*"
+  ],
   "eslintConfig": {
     "env": {
       "es2021": true,
       "node": true
     },
     "globals": {
-      "ioc": true
+      "ioc": true,
+      "Env": true,
+      "Path": true,
+      "Config": true
     },
     "plugins": [
-      "prettier"
+      "prettier",
+      "@typescript-eslint"
     ],
     "extends": [
       "standard",
       "eslint:recommended",
-      "plugin:prettier/recommended"
-    ],
-    "ignorePatterns": [
-      "**/*.d.ts"
+      "plugin:prettier/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:@typescript-eslint/eslint-recommended"
     ],
-    "parserOptions": {
-      "ecmaVersion": "latest",
-      "sourceType": "module"
-    },
+    "parser": "@typescript-eslint/parser",
     "rules": {
       "camelcase": "off",
       "dot-notation": "off",
       "prettier/prettier": "error",
-      "no-useless-constructor": "off"
+      "no-useless-constructor": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "argsIgnorePattern": "^_",
+          "varsIgnorePattern": "^_",
+          "caughtErrorsIgnorePattern": "^_"
+        }
+      ]
+    }
+  },
+  "athenna": {
+    "preloads": [],
+    "services": [],
+    "providers": [],
+    "commands": [
+      "#src/Commands/MakeControllerCommand",
+      "#src/Commands/MakeInterceptorCommand",
+      "#src/Commands/MakeMiddlewareCommand",
+      "#src/Commands/MakeTerminatorCommand",
+      "#src/Commands/RouteListCommand"
+    ],
+    "controllers": [
+      "#tests/Stubs/controllers/HelloController",
+      "#tests/Stubs/controllers/DecoratedController"
+    ],
+    "middlewares": [
+      "#tests/Stubs/middlewares/Middleware",
+      "#tests/Stubs/middlewares/ImportedMiddleware",
+      "#tests/Stubs/middlewares/DecoratedMiddleware",
+      "#tests/Stubs/middlewares/DecoratedInterceptor",
+      "#tests/Stubs/middlewares/DecoratedTerminator"
+    ],
+    "namedMiddlewares": {
+      "middleware": "#tests/Stubs/middlewares/Middleware",
+      "interceptor": "#tests/Stubs/middlewares/Interceptor",
+      "terminator": "#tests/Stubs/middlewares/Terminator",
+      "not-found-middleware": "#tests/Stubs/middlewares/DecoratedMiddleware",
+      "not-found-interceptor": "#tests/Stubs/middlewares/DecoratedInterceptor",
+      "not-found-terminator": "#tests/Stubs/middlewares/DecoratedTerminator"
+    },
+    "globalMiddlewares": [
+      "#tests/Stubs/middlewares/Middleware",
+      "#tests/Stubs/middlewares/Interceptor",
+      "#tests/Stubs/middlewares/Terminator",
+      "#tests/Stubs/middlewares/DecoratedGlobalMiddleware",
+      "#tests/Stubs/middlewares/DecoratedGlobalInterceptor",
+      "#tests/Stubs/middlewares/DecoratedGlobalTerminator"
+    ],
+    "commandsManifest": {
+      "route:list": "#src/Commands/RouteListCommand",
+      "make:controller": "#src/Commands/MakeControllerCommand",
+      "make:interceptor": "#src/Commands/MakeInterceptorCommand",
+      "make:middleware": "#src/Commands/MakeMiddlewareCommand",
+      "make:terminator": "#src/Commands/MakeTerminatorCommand"
     }
   }
 }

package/templates/controller.edge

@@ -1,52 +1,24 @@
-export class {{ namePascal }} {
-    /**
-    * Resolve any dependency of the service container
-    * inside the constructor.
-    */
-    constructor() {}
+import { Context, Controller } from '@athenna/http'
 
-    /**
-    * Index method
-    *
-    * @param {import('@athenna/http').ContextContract} ctx
-    */
-    async index({ response }) {
+@Controller()
+export class {{ namePascal }} {
+    public async index({ response }: Context): Promise<void> {
       return response.status(200).send([{}])
     }
 
-    /**
-    * Store method
-    *
-    * @param {import('@athenna/http').ContextContract} ctx
-    */
-    async store({ response }) {
+    public async store({ response }: Context): Promise<void> {
       return response.status(201).send({})
     }
 
-    /**
-    * Show method
-    *
-    * @param {import('@athenna/http').ContextContract} ctx
-    */
-    async show({ response }) {
+    public async show({ response }: Context): Promise<void> {
       return response.status(200).send({})
     }
 
-    /**
-    * Update method
-    *
-    * @param {import('@athenna/http').ContextContract} ctx
-    */
-    async update({ response, params }) {
+    public async update({ response, params }: Context): Promise<void> {
       return response.status(200).send({ id: params.id })
     }
 
-    /**
-    * Delete method
-    *
-    * @param {import('@athenna/http').ContextContract} ctx
-    */
-    async delete({ response }) {
+    public async delete({ response }: Context): Promise<void> {
       return response.status(204)
     }
 }

package/templates/interceptor.edge

@@ -0,0 +1,8 @@
+import { Interceptor, InterceptContext, InterceptorContract } from '@athenna/http'
+
+@Interceptor()
+export class {{ namePascal }} implements InterceptorContract {
+    public async intercept(ctx: InterceptContext): Promise<unknown> {
+      return ctx.body
+    }
+}

package/templates/middleware.edge

@@ -1,38 +1,6 @@
-export class {{ namePascal }} {
-    /**
-    * Resolve any dependency of the service container
-    * inside the constructor.
-    */
-    constructor() {}
+import { Context, Middleware, MiddlewareContract } from '@athenna/http'
 
-    /**
-    * Handle method is executed before the request gets
-    * in your controller.
-    *
-    * @param {import('@athenna/http').HandleContextContract} ctx
-    * @return {Promise<void>}
-    */
-    async handle(ctx) {}
-
-    /**
-    * Intercept method is executed before the response
-    * has been sent.
-    *
-    * @param {import('@athenna/http').InterceptContextContract} ctx
-    * @return {Promise<any>}
-    */
-    async intercept({ body }) {
-      body.intercepted = true
-
-      return body
-    }
-
-    /**
-    * Terminate method is executed after the response
-    * has been sent.
-    *
-    * @param {import('@athenna/http').TerminateContextContract} ctx
-    * @return {Promise<void>}
-    */
-    async terminate(ctx) {}
+@Middleware()
+export class {{ namePascal }} implements MiddlewareContract {
+    public async handle(ctx: Context): Promise<void> {}
 }

package/templates/terminator.edge

@@ -0,0 +1,6 @@
+import { Terminator, TerminateContext, TerminatorContract } from '@athenna/http'
+
+@Terminator()
+export class {{ namePascal }} implements TerminatorContract {
+    public async terminate(ctx: TerminateContext): Promise<void> {}
+}

package/src/Commands/Make/Controller.js

@@ -1,64 +0,0 @@
-/**
- * @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 { Path } from '@athenna/common'
-import { Command } from '@athenna/artisan'
-
-export class MakeController extends Command {
-  /**
-   * The name and signature of the console command.
-   *
-   * @return {string}
-   */
-  get signature() {
-    return 'make:controller <name>'
-  }
-
-  /**
-   * The console command description.
-   *
-   * @return {string}
-   */
-  get description() {
-    return 'Make a new controller file.'
-  }
-
-  /**
-   * Set additional flags in the commander instance.
-   * This method is executed when registering your command.
-   *
-   * @param {import('@athenna/artisan').Commander} commander
-   * @return {import('@athenna/artisan').Commander}
-   */
-  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) {
-    const resource = 'Controller'
-    const path = Path.http(`Controllers/${name}.${Path.ext()}`)
-
-    this.title(`MAKING ${resource}\n`, 'bold', 'green')
-
-    const file = await this.makeFile(path, 'controller', options.lint)
-
-    this.success(`${resource} ({yellow} "${file.name}") successfully created.`)
-  }
-}

package/src/Commands/Make/Middleware.js

@@ -1,80 +0,0 @@
-/**
- * @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 { Path, String } from '@athenna/common'
-import { Artisan, Command, FilePropertiesHelper } from '@athenna/artisan'
-
-export class MakeMiddleware extends Command {
-  /**
-   * The name and signature of the console command.
-   *
-   * @return {string}
-   */
-  get signature() {
-    return 'make:middleware <name>'
-  }
-
-  /**
-   * The console command description.
-   *
-   * @return {string}
-   */
-  get description() {
-    return 'Make a new middleware file.'
-  }
-
-  /**
-   * Set additional flags in the commander instance.
-   * This method is executed when registering your command.
-   *
-   * @param {import('@athenna/artisan').Commander} commander
-   * @return {import('@athenna/artisan').Commander}
-   */
-  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) {
-    const resource = 'Middleware'
-    const path = Path.http(`Middlewares/${name}.${Path.ext()}`)
-
-    this.title(`MAKING ${resource}\n`, 'bold', 'green')
-
-    const file = await this.makeFile(path, 'middleware', options.lint)
-
-    this.success(`${resource} ({yellow} "${file.name}") successfully created.`)
-
-    if (options.register) {
-      const path = Path.http(`Kernel.${Path.ext()}`)
-
-      await FilePropertiesHelper.addContentToObjectGetter(
-        path,
-        'namedMiddlewares',
-        `${String.toCamelCase(
-          file.name,
-        )}: import('#app/Http/Middlewares/${name}')`,
-      )
-
-      await Artisan.call(`eslint:fix ${path} --quiet`)
-    }
-  }
-}