@athenna/http 3.11.0 → 4.0.0

package/package.json

@@ -1,245 +1,249 @@
 {
-  "name": "@athenna/http",
-  "version": "3.11.0",
-  "description": "The Athenna Http server. Built on top of fastify.",
-  "license": "MIT",
-  "author": "João Lenon <lenon@athenna.io>",
-  "bugs": "https://github.com/AthennaIO/Http/issues",
-  "repository": "https://github.com/AthennaIO/Http.git",
-  "homepage": "https://github.com/AthennaIO/Http#readme",
-  "keywords": [
-    "fastify",
-    "router",
-    "cors",
-    "ctx",
-    "helmet",
-    "swagger",
-    "exception-handling",
-    "rate-limiting",
-    "middlewares",
-    "terminators",
-    "interceptors",
-    "http-server",
-    "athenna",
-    "esm"
-  ],
-  "scripts": {
-    "lint:fix": "eslint \"{bin,src,tests}/**/*.ts\" --fix",
-    "test": "npm run --silent lint:fix && sh node bin/test.ts",
-    "test:debug": "cross-env DEBUG=api:* sh node --inspect bin/test.ts",
-    "test:coverage": "c8 npm run --silent test"
-  },
-  "files": [
-    "src/*.js",
-    "src/*.d.ts",
-    "src/**/*.js",
-    "src/**/*.d.ts",
-    "templates"
-  ],
-  "type": "module",
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts",
-  "exports": {
-    ".": "./src/index.js",
-    "./testing/plugins": "./src/Testing/Plugins/index.js",
-    "./kernels/HttpKernel": "./src/Kernels/HttpKernel.js",
-    "./handlers/HttpExceptionHandler": "./src/Handlers/HttpExceptionHandler.js",
-    "./providers/HttpRouteProvider": "./src/Providers/HttpRouteProvider.js",
-    "./providers/HttpServerProvider": "./src/Providers/HttpServerProvider.js",
-    "./commands/RouteListCommand": "./src/Commands/RouteListCommand.js",
-    "./commands/MakeControllerCommand": "./src/Commands/MakeControllerCommand.js",
-    "./commands/MakeMiddlewareCommand": "./src/Commands/MakeMiddlewareCommand.js",
-    "./commands/MakeTerminatorCommand": "./src/Commands/MakeTerminatorCommand.js",
-    "./commands/MakeInterceptorCommand": "./src/Commands/MakeInterceptorCommand.js"
-  },
-  "imports": {
-    "#bin/*": "./bin/*.js",
-    "#bin": "./bin/index.js",
-    "#src/*": "./src/*.js",
-    "#src": "./src/index.js",
-    "#tests/*": "./tests/*.js",
-    "#tests": "./tests/index.js"
-  },
-  "dependencies": {
-    "fastify": "^4.15.0"
-  },
-  "devDependencies": {
-    "@athenna/artisan": "^3.9.0",
-    "@athenna/common": "^3.6.0",
-    "@athenna/config": "^3.6.0",
-    "@athenna/ioc": "^3.4.0",
-    "@athenna/logger": "^3.4.0",
-    "@athenna/test": "^3.6.0",
-    "@athenna/view": "^3.3.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",
-    "@swc/core": "^1.3.27",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
-    "c8": "^7.12.0",
-    "commitizen": "^4.2.6",
-    "cross-env": "^7.0.3",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.8.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",
-    "lint-staged": "^12.5.0",
-    "prettier": "^2.8.7",
-    "reflect-metadata": "^0.1.13",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.2"
-  },
-  "c8": {
-    "all": true,
-    "include": [
-      "src/**/*.ts"
+    "name": "@athenna/http",
+    "version": "4.0.0",
+    "description": "The Athenna Http server. Built on top of fastify.",
+    "license": "MIT",
+    "author": "João Lenon <lenon@athenna.io>",
+    "bugs": "https://github.com/AthennaIO/Http/issues",
+    "repository": "https://github.com/AthennaIO/Http.git",
+    "homepage": "https://github.com/AthennaIO/Http#readme",
+    "keywords": [
+        "fastify",
+        "router",
+        "cors",
+        "ctx",
+        "helmet",
+        "swagger",
+        "exception-handling",
+        "rate-limiting",
+        "middlewares",
+        "terminators",
+        "interceptors",
+        "http-server",
+        "athenna",
+        "esm"
     ],
-    "exclude": [
-      "src/Types/*",
-      "src/Contracts/*",
-      "src/Exceptions/*",
-      "src/Commands/*"
-    ],
-    "reporter": [
-      "text-summary",
-      "html"
-    ],
-    "report-dir": "./tests/Coverage",
-    "check-coverage": true
-  },
-  "husky": {
-    "hooks": {
-      "prepare-commit-msg": "lint-staged && exec < /dev/tty && git cz --hook || true"
-    }
-  },
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix",
-      "git add"
+    "scripts": {
+        "build": "rimraf build && tsc --project bin/tsconfig.build.json",
+        "lint:fix": "eslint \"{bin,src,tests}/**/*.ts\" --fix",
+        "test": "npm run --silent lint:fix && sh node bin/test.ts",
+        "test:debug": "cross-env NODE_DEBUG=athenna:* sh node --inspect bin/test.ts",
+        "test:coverage": "c8 npm run --silent test"
+    },
+    "files": [
+        "src/*.js",
+        "src/*.d.ts",
+        "src/**/*.js",
+        "src/**/*.d.ts",
+        "templates"
     ],
-    "*.json": [
-      "prettier --write",
-      "git add"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
-  "prettier": {
-    "singleQuote": true,
-    "trailingComma": "all",
-    "arrowParens": "avoid",
-    "endOfLine": "lf",
-    "semi": false,
-    "printWidth": 80,
-    "overrides": [
-      {
-        "files": "tests/**/*",
-        "options": {
-          "printWidth": 120
+    "type": "module",
+    "main": "./src/index.js",
+    "types": "./src/index.d.ts",
+    "exports": {
+        ".": "./src/index.js",
+        "./types": "./src/types/index.js",
+        "./package.json": "./package.json",
+        "./testing/plugins": "./src/Testing/Plugins/index.js",
+        "./kernels/HttpKernel": "./src/Kernels/HttpKernel.js",
+        "./handlers/HttpExceptionHandler": "./src/Handlers/HttpExceptionHandler.js",
+        "./providers/HttpRouteProvider": "./src/Providers/HttpRouteProvider.js",
+        "./providers/HttpServerProvider": "./src/Providers/HttpServerProvider.js",
+        "./commands/RouteListCommand": "./src/Commands/RouteListCommand.js",
+        "./commands/MakeControllerCommand": "./src/Commands/MakeControllerCommand.js",
+        "./commands/MakeMiddlewareCommand": "./src/Commands/MakeMiddlewareCommand.js",
+        "./commands/MakeTerminatorCommand": "./src/Commands/MakeTerminatorCommand.js",
+        "./commands/MakeInterceptorCommand": "./src/Commands/MakeInterceptorCommand.js"
+    },
+    "imports": {
+        "#bin/*": "./bin/*.js",
+        "#bin": "./bin/index.js",
+        "#src/*": "./src/*.js",
+        "#src": "./src/index.js",
+        "#src/types": "./src/types/index.js",
+        "#src/debug": "./src/debug/index.js",
+        "#tests/*": "./tests/*.js",
+        "#tests": "./tests/index.js"
+    },
+    "dependencies": {
+        "fastify": "^4.21.0"
+    },
+    "devDependencies": {
+        "@athenna/artisan": "^4.0.0",
+        "@athenna/common": "^4.2.0",
+        "@athenna/config": "^4.2.0",
+        "@athenna/ioc": "^4.0.0",
+        "@athenna/logger": "^4.1.0",
+        "@athenna/test": "^4.2.0",
+        "@athenna/view": "^4.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",
+        "@typescript-eslint/eslint-plugin": "^5.56.0",
+        "@typescript-eslint/parser": "^5.56.0",
+        "c8": "^7.12.0",
+        "commitizen": "^4.2.6",
+        "cross-env": "^7.0.3",
+        "cz-conventional-changelog": "^3.3.0",
+        "eslint": "^8.36.0",
+        "eslint-config-prettier": "^8.8.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",
+        "lint-staged": "^12.5.0",
+        "prettier": "^2.8.7",
+        "reflect-metadata": "^0.1.13",
+        "rimraf": "^5.0.1",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.0.2"
+    },
+    "c8": {
+        "all": true,
+        "include": [
+            "src/**/*.ts"
+        ],
+        "exclude": [
+            "src/types/*",
+            "src/exceptions/*",
+            "src/commands/*"
+        ],
+        "reporter": [
+            "text-summary",
+            "html"
+        ],
+        "report-dir": "./tests/coverage",
+        "check-coverage": true
+    },
+    "husky": {
+        "hooks": {
+            "prepare-commit-msg": "lint-staged && exec < /dev/tty && git cz --hook || true"
         }
-      }
-    ]
-  },
-  "eslintIgnore": [],
-  "eslintConfig": {
-    "env": {
-      "es2021": true,
-      "node": true
     },
-    "globals": {
-      "ioc": true,
-      "Env": true,
-      "Path": true,
-      "Config": true
+    "lint-staged": {
+        "*.ts": [
+            "eslint --fix",
+            "git add"
+        ],
+        "*.json": [
+            "prettier --write",
+            "git add"
+        ]
     },
-    "plugins": [
-      "prettier",
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "standard",
-      "eslint:recommended",
-      "plugin:prettier/recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/eslint-recommended"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "rules": {
-      "camelcase": "off",
-      "dot-notation": "off",
-      "prettier/prettier": "error",
-      "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": "^_"
+    "config": {
+        "commitizen": {
+            "path": "./node_modules/cz-conventional-changelog"
         }
-      ]
-    }
-  },
-  "athenna": {
-    "templates": {
-      "controller": "./templates/controller.edge",
-      "interceptor": "./templates/interceptor.edge",
-      "middleware": "./templates/middleware.edge",
-      "terminator": "./templates/terminator.edge",
-      "command": "@athenna/artisan/templates/command.edge"
     },
-    "preloads": [],
-    "services": [],
-    "providers": [],
-    "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"
+    "prettier": {
+        "singleQuote": true,
+        "trailingComma": "all",
+        "arrowParens": "avoid",
+        "endOfLine": "lf",
+        "semi": false,
+        "printWidth": 80,
+        "overrides": [
+            {
+                "files": "tests/**/*",
+                "options": {
+                    "printWidth": 120
+                }
+            }
+        ]
     },
-    "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"
-    ],
-    "commands": {
-      "route:list": {
-        "path": "#src/Commands/RouteListCommand",
-        "route": "./tests/Stubs/routes/http.js",
-        "kernel": "./tests/Stubs/kernels/HttpKernel.js"
-      },
-      "make:controller": "#src/Commands/MakeControllerCommand",
-      "make:interceptor": "#src/Commands/MakeInterceptorCommand",
-      "make:middleware": "#src/Commands/MakeMiddlewareCommand",
-      "make:terminator": "#src/Commands/MakeTerminatorCommand"
+    "eslintIgnore": [],
+    "eslintConfig": {
+        "env": {
+            "es2021": true,
+            "node": true
+        },
+        "globals": {
+            "ioc": true,
+            "Env": true,
+            "Path": true,
+            "Config": true
+        },
+        "plugins": [
+            "prettier",
+            "@typescript-eslint"
+        ],
+        "extends": [
+            "standard",
+            "eslint:recommended",
+            "plugin:prettier/recommended",
+            "plugin:@typescript-eslint/recommended",
+            "plugin:@typescript-eslint/eslint-recommended"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "rules": {
+            "camelcase": "off",
+            "dot-notation": "off",
+            "prettier/prettier": "error",
+            "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": {
+        "templates": {
+            "controller": "./templates/controller.edge",
+            "interceptor": "./templates/interceptor.edge",
+            "middleware": "./templates/middleware.edge",
+            "terminator": "./templates/terminator.edge",
+            "command": "@athenna/artisan/templates/command.edge"
+        },
+        "preloads": [],
+        "services": [],
+        "providers": [],
+        "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"
+        ],
+        "commands": {
+            "route:list": {
+                "path": "#src/commands/RouteListCommand",
+                "route": "./tests/stubs/routes/http.js",
+                "kernel": "./tests/stubs/kernels/HttpKernel.js"
+            },
+            "make:controller": "#src/commands/MakeControllerCommand",
+            "make:interceptor": "#src/commands/MakeInterceptorCommand",
+            "make:middleware": "#src/commands/MakeMiddlewareCommand",
+            "make:terminator": "#src/commands/MakeTerminatorCommand"
+        }
     }
-  }
 }

package/src/{Decorators → annotations}/Controller.d.ts

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { ControllerOptions } from '#src/Types/Controllers/ControllerOptions';
+import type { ControllerOptions } from '#src/types/controllers/ControllerOptions';
 /**
  * Create a controller inside the service provider.
  */

package/src/{Decorators → annotations}/Controller.js

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
+import { debug } from '#src/debug';
 import { Options } from '@athenna/common';
 /**
  * Create a controller inside the service provider.
@@ -20,6 +21,7 @@ export function Controller(options) {
         const alias = options.alias;
         const createCamelAlias = false;
         if (ioc.hasDependency(alias)) {
+            debug('Controller %s was already registered in the service container. Skipping registration via Controller annotation.', alias);
             return;
         }
         ioc[options.type](alias, target, createCamelAlias);

package/src/{Decorators → annotations}/Interceptor.d.ts

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+import type { MiddlewareOptions } from '#src/types/middlewares/MiddlewareOptions';
 /**
- * Create a interceptor inside the service provider.
+ * Create an interceptor inside the service provider.
  */
 export declare function Interceptor(options?: MiddlewareOptions): ClassDecorator;

package/src/{Decorators → annotations}/Interceptor.js

@@ -7,10 +7,11 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { Server } from '#src/Facades/Server';
+import { Server } from '#src/facades/Server';
 import { Options, String } from '@athenna/common';
+import { debug } from '#src/debug/index';
 /**
- * Create a interceptor inside the service provider.
+ * Create an interceptor inside the service provider.
  */
 export function Interceptor(options) {
     return (target) => {
@@ -23,6 +24,7 @@ export function Interceptor(options) {
         const alias = options.alias;
         const createCamelAlias = false;
         if (ioc.hasDependency(alias)) {
+            debug('Interceptor %s was already registered in the service container. Skipping registration via Interceptor annotation.', alias);
             return;
         }
         ioc[options.type](alias, target, createCamelAlias);
@@ -32,6 +34,7 @@ export function Interceptor(options) {
             return;
         }
         const Interceptor = ioc.safeUse(alias);
+        debug('Registering %s as a global interceptor via Interceptor annotation.', Interceptor.constructor.name);
         Server.intercept(Interceptor.intercept);
     };
 }

package/src/{Decorators → annotations}/Middleware.d.ts

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+import type { MiddlewareOptions } from '#src/types/middlewares/MiddlewareOptions';
 /**
  * Create a middleware inside the service provider.
  */

package/src/{Decorators → annotations}/Middleware.js

@@ -7,8 +7,9 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { Server } from '#src/Facades/Server';
+import { Server } from '#src/facades/Server';
 import { Options, String } from '@athenna/common';
+import { debug } from '#src/debug/index';
 /**
  * Create a middleware inside the service provider.
  */
@@ -23,6 +24,7 @@ export function Middleware(options) {
         const alias = options.alias;
         const createCamelAlias = false;
         if (ioc.hasDependency(alias)) {
+            debug('Middleware %s was already registered in the service container. Skipping registration via Middleware annotation.', alias);
             return;
         }
         ioc[options.type](alias, target, createCamelAlias);
@@ -32,6 +34,7 @@ export function Middleware(options) {
             return;
         }
         const Middleware = ioc.safeUse(alias);
+        debug('Registering %s as a global middleware via Middleware annotation.', Middleware.constructor.name);
         Server.middleware(Middleware.handle);
     };
 }

package/src/{Decorators → annotations}/Terminator.d.ts

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+import type { MiddlewareOptions } from '#src/types/middlewares/MiddlewareOptions';
 /**
- * Create a middleware inside the service provider.
+ * Create a terminator inside the service provider.
  */
 export declare function Terminator(options?: MiddlewareOptions): ClassDecorator;

package/src/{Decorators → annotations}/Terminator.js

@@ -7,10 +7,11 @@
  * file that was distributed with this source code.
  */
 import 'reflect-metadata';
-import { Server } from '#src/Facades/Server';
+import { Server } from '#src/facades/Server';
 import { Options, String } from '@athenna/common';
+import { debug } from '#src/debug/index';
 /**
- * Create a middleware inside the service provider.
+ * Create a terminator inside the service provider.
  */
 export function Terminator(options) {
     return (target) => {
@@ -23,6 +24,7 @@ export function Terminator(options) {
         const alias = options.alias;
         const createCamelAlias = false;
         if (ioc.hasDependency(alias)) {
+            debug('Terminator %s was already registered in the service container. Skipping registration via Terminator annotation.', alias);
             return;
         }
         ioc[options.type](alias, target, createCamelAlias);
@@ -32,6 +34,7 @@ export function Terminator(options) {
             return;
         }
         const Terminator = ioc.safeUse(alias);
+        debug('Registering %s as a global terminator via Terminator annotation.', Terminator.constructor.name);
         Server.middleware(Terminator.terminate);
     };
 }

package/src/{Commands → commands}/MakeControllerCommand.js

@@ -16,7 +16,6 @@ import { Path } from '@athenna/common';
 import { sep, resolve, isAbsolute } from 'node:path';
 import { BaseCommand, Argument } from '@athenna/artisan';
 export class MakeControllerCommand extends BaseCommand {
-    name;
     static signature() {
         return 'make:controller';
     }

package/src/{Commands → commands}/MakeInterceptorCommand.js

@@ -16,7 +16,6 @@ import { Path } from '@athenna/common';
 import { sep, resolve, isAbsolute } from 'node:path';
 import { BaseCommand, Argument } from '@athenna/artisan';
 export class MakeInterceptorCommand extends BaseCommand {
-    name;
     static signature() {
         return 'make:interceptor';
     }