@athenna/http 1.3.2 → 1.3.5

package/LICENSE.md

@@ -2,20 +2,8 @@ MIT License
 
 Copyright (c) 2022 The Athenna Framework
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,9 +1,9 @@
-# Http 📶
+# Http 📡
 
-> The Athenna Http server. Built on top of fastify
+> The Athenna Http server. Built on top of fastify.
 
 [![GitHub followers](https://img.shields.io/github/followers/athennaio.svg?style=social&label=Follow&maxAge=2592000)](https://github.com/athennaio?tab=followers)
-[![GitHub stars](https://img.shields.io/github/stars/athennaio/http.svg?style=social&label=Star&maxAge=2592000)](https://github.com/athennaio/http/stargazers/)
+[![GitHub stars](https://img.shields.io/github/stars/AthennaIO/Http.svg?style=social&label=Star&maxAge=2592000)](https://github.com/AthennaIO/Http/stargazers/)
 
 <p>
     <a href="https://www.buymeacoffee.com/athenna" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
@@ -23,11 +23,14 @@
 
 ## Links
 
-> For project documentation [click here](https://athenna.io). If something is not clear in the documentation please open an issue in the [documentation repository](https://github.com/athennaio/docs)
+> For project documentation [click here](https://athenna.io). If something is not clear in the documentation please open
+> an issue in the [documentation repository](https://github.com/athennaio/docs)
 
 ## Contributing
 
-> If you want to contribute to this project, first read the [CONTRIBUTING.MD](https://github.com/AthennaIO/Http/blob/develop/CONTRIBUTING.md) file. It will be a pleasure to receive your help.
+> If you want to contribute to this project, first read
+> the [CONTRIBUTING.MD](https://github.com/AthennaIO/Http/blob/develop/CONTRIBUTING.md) file. It will be a pleasure to
+> receive your help.
 
 ---
 

package/package.json

@@ -1,54 +1,100 @@
 {
   "name": "@athenna/http",
-  "version": "1.3.2",
-  "description": "The Athenna Http server. Built on top of fastify",
+  "version": "1.3.5",
+  "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
-  "repository": "https://github.com/AthennaIO/Http.git",
   "bugs": "https://github.com/AthennaIO/Http/issues",
+  "repository": "https://github.com/AthennaIO/Http.git",
   "homepage": "https://github.com/AthennaIO/Http#readme",
-  "scripts": {
-    "build": "tsc --project tsconfig.json && tscpaths -p tsconfig.json -s . -o .",
-    "test": "npm run lint:fix && cross-env NODE_TS=true cross-env NODE_ENV=testing jest --verbose --runInBand",
-    "test:debug": "cross-env DEBUG=api:* && npm run test",
-    "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix"
-  },
   "keywords": [
-    "nodejs",
     "fastify",
     "router",
+    "cors",
+    "ctx",
+    "exception-handling",
+    "rate-limiting",
     "middlewares",
     "http-server",
     "athenna",
-    "typescript"
+    "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"
+  },
+  "files": [
+    "src/*.js",
+    "src/*.d.ts",
+    "src/**/*.js",
+    "src/**/*.d.ts"
   ],
+  "type": "module",
+  "main": "./src/index.js",
+  "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"
+  },
+  "types": "./src/index.d.ts",
+  "imports": {
+    "#src/*": "./src/*.js",
+    "#tests/*": "./tests/*.js"
+  },
+  "dependencies": {
+    "@athenna/ioc": "1.1.8",
+    "@athenna/logger": "1.2.3",
+    "@secjs/utils": "1.9.3",
+    "fastify": "3.27.4",
+    "fastify-cors": "6.0.3",
+    "fastify-rate-limit": "5.8.0"
+  },
   "devDependencies": {
-    "@types/jest": "27.0.1",
-    "@types/node": "14.17.0",
-    "@typescript-eslint/eslint-plugin": "4.31.0",
-    "@typescript-eslint/parser": "4.31.0",
+    "@japa/assert": "1.3.4",
+    "@japa/run-failed-tests": "1.0.7",
+    "@japa/runner": "2.0.7",
+    "@japa/spec-reporter": "1.1.12",
+    "c8": "7.11.2",
     "commitizen": "4.2.4",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "7.32.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-config-standard": "16.0.3",
-    "eslint-import-resolver-typescript": "2.4.0",
-    "eslint-plugin-import": "2.24.2",
-    "eslint-plugin-node": "11.1.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": "5.1.0",
-    "eslint-plugin-standard": "5.0.0",
+    "eslint-plugin-promise": "6.0.0",
     "husky": "3.0.9",
-    "jest": "27.1.0",
-    "lint-staged": "9.4.3",
-    "prettier": "2.0.5",
-    "supertest": "^6.2.2",
-    "ts-jest": "27.0.5",
-    "ts-loader": "9.2.3",
-    "ts-node": "10.0.0",
-    "tsconfig-paths": "3.9.0",
-    "typescript": "4.3.5"
+    "lint-staged": "12.4.1",
+    "minimist": "1.2.6",
+    "prettier": "2.6.2",
+    "rimraf": "3.0.2",
+    "typescript": "4.6.4"
+  },
+  "c8": {
+    "all": true,
+    "include": [
+      "src/**/*.js"
+    ],
+    "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": {
     "*.js": [
@@ -60,30 +106,11 @@
       "git add"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged",
-      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
     }
   },
-  "jest": {
-    "modulePaths": [
-      "<rootDir>"
-    ],
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": ".",
-    "testRegex": "Test.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "coverageDirectory": "./coverage",
-    "preset": "ts-jest",
-    "testEnvironment": "node"
-  },
   "prettier": {
     "singleQuote": true,
     "trailingComma": "all",
@@ -102,70 +129,32 @@
   },
   "eslintConfig": {
     "env": {
-      "es6": true,
+      "es2021": true,
       "node": true
     },
+    "globals": {
+      "ioc": true
+    },
+    "plugins": [
+      "prettier"
+    ],
     "extends": [
       "standard",
-      "plugin:@typescript-eslint/recommended",
+      "eslint:recommended",
       "plugin:prettier/recommended"
     ],
-    "globals": {
-      "Atomics": "readonly",
-      "SharedArrayBuffer": "readonly"
-    },
-    "parser": "@typescript-eslint/parser",
+    "ignorePatterns": [
+      "**/*.d.ts"
+    ],
     "parserOptions": {
-      "ecmaVersion": 2018,
+      "ecmaVersion": "latest",
       "sourceType": "module"
     },
-    "plugins": [
-      "@typescript-eslint",
-      "prettier"
-    ],
     "rules": {
-      "dot-notation": "off",
       "camelcase": "off",
-      "no-undef": "off",
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/no-var-requires": "off",
-      "no-useless-constructor": "off",
-      "@typescript-eslint/no-useless-constructor": "off",
-      "@typescript-eslint/camelcase": "off",
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "@typescript-eslint/interface-name-prefix": "off",
-      "@typescript-eslint/no-explicit-any": "off",
+      "dot-notation": "off",
       "prettier/prettier": "error",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          "argsIgnorePattern": "_"
-        }
-      ]
+      "no-useless-constructor": "off"
     }
-  },
-  "files": [
-    "src/*.js",
-    "src/*.d.ts",
-    "src/**/*.js",
-    "src/**/*.d.ts",
-    "*.js",
-    "*.d.ts"
-  ],
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
-  "dependencies": {
-    "@athenna/config": "1.0.8",
-    "@athenna/ioc": "1.1.3",
-    "@athenna/logger": "1.1.8",
-    "@secjs/utils": "1.8.3",
-    "fastify": "3.27.4",
-    "fastify-cors": "6.0.3",
-    "fastify-rate-limit": "5.8.0",
-    "reflect-metadata": "0.1.13",
-    "tscpaths": "0.0.9"
   }
 }

package/src/Context/Request.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,141 +6,173 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Request = void 0;
-const utils_1 = require("@secjs/utils");
-const config_1 = require("@athenna/config");
-const removeSlash_1 = require("../Utils/removeSlash");
-class Request {
-    /**
-     * Create a new instance of Request.
-     *
-     * @return Request
-     */
-    constructor(request) {
-        this.request = request;
-    }
-    /**
-     * Get the request ip.
-     *
-     * @return string
-     */
-    get ip() {
-        return this.request.ip;
-    }
-    /**
-     * Get the request method.
-     *
-     * @return string
-     */
-    get method() {
-        return this.request.method;
-    }
-    /**
-     * Get the host url from request.
-     *
-     * @return string
-     */
-    get hostUrl() {
-        const url = this.request.url;
-        const port = config_1.Config.get('http.port', 1335);
-        let host = config_1.Config.get('http.domain', `http://localhost:${port}`);
-        if (!utils_1.Is.Ip(host) && !host.includes('localhost')) {
-            host = host.replace(`:${port}`, '');
-        }
-        return removeSlash_1.removeSlash(`${host}${url}`);
-    }
-    /**
-     * Get the base request url.
-     *
-     * @return string
-     */
-    get baseUrl() {
-        return this.request.url.split('?')[0];
-    }
-    /**
-     * Get the original request url.
-     *
-     * @return string
-     */
-    get originalUrl() {
-        return this.request.url;
-    }
-    /**
-     * Get all body from request.
-     *
-     * @return any
-     */
-    get body() {
-        return this.request.body;
-    }
-    /**
-     * Get all params from request.
-     *
-     * @return any
-     */
-    get params() {
-        return this.request.params;
-    }
-    /**
-     * Get all queries from request.
-     *
-     * @return any
-     */
-    get queries() {
-        return this.request.query;
-    }
-    /**
-     * Get all headers from request.
-     *
-     * @return any
-     */
-    get headers() {
-        return this.request.headers;
-    }
-    /**
-     * Get a value from the request params or the default value.
-     *
-     * @return any
-     */
-    param(param, defaultValue) {
-        const params = this.request.params;
-        return params[param] || defaultValue;
-    }
-    /**
-     * Get a value from the request query param or the default value.
-     *
-     * @return any
-     */
-    query(query, defaultValue) {
-        const queries = this.request.query;
-        return queries[query] || defaultValue;
-    }
-    /**
-     * Get a value from the request header or the default value.
-     *
-     * @return any
-     */
-    header(header, defaultValue) {
-        const headers = this.request.headers;
-        return headers[header] || defaultValue;
-    }
-    /**
-     * Get a value from the request body or the default value.
-     *
-     * @return any
-     */
-    payload(payload, defaultValue) {
-        const body = this.request.body;
-        return body[payload] || defaultValue;
-    }
-    /**
-     * Get the default fastify request object.
-     *
-     * @return FastifyRequest
-     */
-    getFastifyRequest() {
-        return this.request;
+
+import { Config, Is } from '@secjs/utils'
+
+export class Request {
+  /**
+   * Fastify request object.
+   *
+   * @type {import('fastify').FastifyRequest}
+   */
+  #request
+
+  /**
+   * Create a new instance of Request.
+   *
+   * @param {import('fastify').FastifyRequest} request
+   * @return {Request}
+   */
+  constructor(request) {
+    this.#request = request
+  }
+
+  /**
+   * Get the request ip.
+   *
+   * @return {string}
+   */
+  get ip() {
+    return this.#request.ip
+  }
+
+  /**
+   * Get the request method.
+   *
+   * @return {string}
+   */
+  get method() {
+    return this.#request.method
+  }
+
+  /**
+   * Get the host url from request.
+   *
+   * @return {string}
+   */
+  get hostUrl() {
+    const port = Config.get('http.port', 1335)
+    let host = Config.get('http.domain', `http://localhost:${port}`)
+
+    if (!Is.Ip(host) && !host.includes('localhost')) {
+      host = host.replace(`:${port}`, '')
     }
+
+    return host.concat(this.originalUrl)
+  }
+
+  /**
+   * Get the base request url.
+   *
+   * @return {string}
+   */
+  get baseUrl() {
+    return this.#request.url.split('?')[0]
+  }
+
+  /**
+   * Get the original request url.
+   *
+   * @return {string}
+   */
+  get originalUrl() {
+    return this.#request.url
+  }
+
+  /**
+   * Get all body from request.
+   *
+   * @return {any}
+   */
+  get body() {
+    return this.#request.body
+  }
+
+  /**
+   * Get all params from request.
+   *
+   * @return {any}
+   */
+  get params() {
+    return this.#request.params
+  }
+
+  /**
+   * Get all queries from request.
+   *
+   * @return {any}
+   */
+  get queries() {
+    return this.#request.query
+  }
+
+  /**
+   * Get all headers from request.
+   *
+   * @return {any}
+   */
+  get headers() {
+    return this.#request.headers
+  }
+
+  /**
+   * Get a value from the request params or the default value.
+   *
+   * @param {string} param
+   * @param {string} [defaultValue]
+   * @return {any}
+   */
+  param(param, defaultValue) {
+    const params = this.#request.params
+
+    return params[param] || defaultValue
+  }
+
+  /**
+   * Get a value from the request query param or the default value.
+   *
+   * @param {string} query
+   * @param {string} [defaultValue]
+   * @return {any}
+   */
+  query(query, defaultValue) {
+    const queries = this.#request.query
+
+    return queries[query] || defaultValue
+  }
+
+  /**
+   * Get a value from the request header or the default value.
+   *
+   * @param {string} header
+   * @param {string} [defaultValue]
+   * @return {any}
+   */
+  header(header, defaultValue) {
+    const headers = this.#request.headers
+
+    return headers[header] || defaultValue
+  }
+
+  /**
+   * Get a value from the request body or the default value.
+   *
+   * @param {string} payload
+   * @param {string} [defaultValue]
+   * @return {any}
+   */
+  payload(payload, defaultValue) {
+    const body = this.#request.body
+
+    return body[payload] || defaultValue
+  }
+
+  /**
+   * Get the default fastify request object.
+   *
+   * @return {import('fastify').FastifyRequest}
+   */
+  getFastifyRequest() {
+    return this.#request
+  }
 }
-exports.Request = Request;