@athenna/http 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+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:
+
+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.

package/README.md

@@ -0,0 +1,34 @@
+# Http 📶
+
+> 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/)
+
+<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>
+</p>
+
+<p>
+  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/athennaio/http?style=for-the-badge&logo=appveyor">
+
+  <img alt="Repository size" src="https://img.shields.io/github/repo-size/athennaio/http?style=for-the-badge&logo=appveyor">
+
+  <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?style=for-the-badge&logo=appveyor">
+
+  <img alt="Commitizen" src="https://img.shields.io/badge/commitizen-friendly-brightgreen?style=for-the-badge&logo=appveyor">
+</p>
+
+<img src=".github/logo.svg" width="200px" align="right" hspace="30px" vspace="100px">
+
+## 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)
+
+## 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.
+
+---
+
+Made with 🖤 by [Athenna Team](https://github.com/AthennaIO) :wave:

package/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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.
+ */
+export * from './src/Http';
+export * from './src/Router/Router';
+export * from './src/Contracts/MiddlewareContract';
+export * from './src/Contracts/Context/ContextContract';
+export * from './src/Contracts/Context/HandlerContract';
+export * from './src/Contracts/Context/RequestContract';
+export * from './src/Contracts/Context/ResponseContract';
+export * from './src/Contracts/Context/Error/ErrorContextContract';
+export * from './src/Contracts/Context/Error/ErrorHandlerContract';
+export * from './src/Contracts/Context/Middlewares/Handle/HandleContextContract';
+export * from './src/Contracts/Context/Middlewares/Handle/HandleHandlerContract';
+export * from './src/Contracts/Context/Middlewares/Intercept/InterceptContextContract';
+export * from './src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
+export * from './src/Contracts/Context/Middlewares/Terminate/TerminateContextContract';
+export * from './src/Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';

package/index.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * @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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/Http"), exports);
+__exportStar(require("./src/Router/Router"), exports);
+__exportStar(require("./src/Contracts/MiddlewareContract"), exports);
+__exportStar(require("./src/Contracts/Context/ContextContract"), exports);
+__exportStar(require("./src/Contracts/Context/HandlerContract"), exports);
+__exportStar(require("./src/Contracts/Context/RequestContract"), exports);
+__exportStar(require("./src/Contracts/Context/ResponseContract"), exports);
+__exportStar(require("./src/Contracts/Context/Error/ErrorContextContract"), exports);
+__exportStar(require("./src/Contracts/Context/Error/ErrorHandlerContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Handle/HandleContextContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Handle/HandleHandlerContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Intercept/InterceptContextContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Terminate/TerminateContextContract"), exports);
+__exportStar(require("./src/Contracts/Context/Middlewares/Terminate/TerminateHandlerContract"), exports);

package/package.json

@@ -0,0 +1,167 @@
+{
+  "name": "@athenna/http",
+  "version": "1.0.0",
+  "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",
+  "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",
+    "test:debug": "npm run lint:fix && cross-env NODE_TS=true cross-env NODE_ENV=testing cross-env DEBUG=api:* jest --verbose",
+    "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix"
+  },
+  "keywords": [
+    "nodejs",
+    "fastify",
+    "router",
+    "middlewares",
+    "http-server",
+    "athenna",
+    "typescript"
+  ],
+  "devDependencies": {
+    "@types/jest": "27.0.1",
+    "@types/node": "14.17.0",
+    "@typescript-eslint/eslint-plugin": "4.31.0",
+    "@typescript-eslint/parser": "4.31.0",
+    "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-plugin-prettier": "4.0.0",
+    "eslint-plugin-promise": "5.1.0",
+    "eslint-plugin-standard": "5.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": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ],
+    "*.json": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
+    }
+  },
+  "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",
+    "arrowParens": "avoid",
+    "endOfLine": "lf",
+    "semi": false,
+    "printWidth": 80,
+    "overrides": [
+      {
+        "files": "tests/**/*",
+        "options": {
+          "printWidth": 120
+        }
+      }
+    ]
+  },
+  "eslintConfig": {
+    "env": {
+      "es6": true,
+      "node": true
+    },
+    "extends": [
+      "standard",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended"
+    ],
+    "globals": {
+      "Atomics": "readonly",
+      "SharedArrayBuffer": "readonly"
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "ecmaVersion": 2018,
+      "sourceType": "module"
+    },
+    "plugins": [
+      "@typescript-eslint",
+      "prettier"
+    ],
+    "rules": {
+      "dot-notation": "off",
+      "camelcase": "off",
+      "no-undef": "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",
+      "prettier/prettier": "error",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "argsIgnorePattern": "_"
+        }
+      ]
+    }
+  },
+  "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.1",
+    "@athenna/ioc": "1.0.3",
+    "@secjs/utils": "1.8.0",
+    "fastify": "3.27.4",
+    "reflect-metadata": "0.1.13",
+    "tscpaths": "0.0.9"
+  }
+}

package/src/Context/Request.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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';
+import { RequestContract } from '../Contracts/Context/RequestContract';
+export declare class Request implements RequestContract {
+    private request;
+    constructor(request: FastifyRequest);
+    get ip(): string;
+    get method(): string;
+    get hostUrl(): string;
+    get baseUrl(): string;
+    get originalUrl(): string;
+    get body(): Record<string, any>;
+    get params(): Record<string, string>;
+    get queries(): Record<string, string>;
+    get headers(): Record<string, string>;
+    param(param: string, defaultValue?: string): string | undefined;
+    query(query: string, defaultValue?: string): string | undefined;
+    header(header: string, defaultValue?: string): string | undefined;
+    payload(payload: string, defaultValue?: string): any;
+}

package/src/Context/Request.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * @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.
+ */
+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 {
+    constructor(request) {
+        this.request = request;
+    }
+    get ip() {
+        return this.request.ip;
+    }
+    get method() {
+        return this.request.method;
+    }
+    get hostUrl() {
+        const url = this.request.url;
+        const port = config_1.Env('PORT', '1335');
+        let host = config_1.Env('APP_DOMAIN', `http://localhost:${port}`);
+        if (!utils_1.Is.Ip(host))
+            host = host.replace(`:${port}`, '');
+        return removeSlash_1.removeSlash(`${host}${url}`);
+    }
+    get baseUrl() {
+        return this.request.url.split('?')[0];
+    }
+    get originalUrl() {
+        return this.request.url;
+    }
+    get body() {
+        return this.request.body;
+    }
+    get params() {
+        return this.request.params;
+    }
+    get queries() {
+        return this.request.query;
+    }
+    get headers() {
+        return this.request.headers;
+    }
+    param(param, defaultValue) {
+        const params = this.request.params;
+        return params[param] || defaultValue;
+    }
+    query(query, defaultValue) {
+        const queries = this.request.query;
+        return queries[query] || defaultValue;
+    }
+    header(header, defaultValue) {
+        const headers = this.request.headers;
+        return headers[header] || defaultValue;
+    }
+    payload(payload, defaultValue) {
+        const body = this.request.body;
+        return body[payload] || defaultValue;
+    }
+}
+exports.Request = Request;

package/src/Context/Response.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 { FastifyReply } from 'fastify';
+import { ResponseContract } from '../Contracts/Context/ResponseContract';
+export declare class Response implements ResponseContract {
+    private response;
+    constructor(response: FastifyReply);
+    send(data?: Record<string, any>): void;
+    json(data?: Record<string, any>): void;
+    status(code: number): this;
+    removeHeader(header: string): this;
+    header(header: string, value: any): this;
+    safeHeader(header: string, value: any): this;
+    redirectTo(url: string, statusCode?: number): this;
+}

package/src/Context/Response.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = void 0;
+class Response {
+    constructor(response) {
+        this.response = response;
+    }
+    send(data) {
+        this.response.send(data);
+    }
+    json(data) {
+        this.response.serialize(data);
+    }
+    status(code) {
+        this.response.status(code);
+        return this;
+    }
+    removeHeader(header) {
+        this.response.removeHeader(header);
+        return this;
+    }
+    header(header, value) {
+        this.response.header(header, value);
+        return this;
+    }
+    safeHeader(header, value) {
+        if (!this.response.hasHeader(header)) {
+            this.response.header(header, value);
+        }
+        return this;
+    }
+    redirectTo(url, statusCode) {
+        if (statusCode) {
+            this.response.redirect(statusCode, url);
+            return this;
+        }
+        this.response.redirect(url);
+        return this;
+    }
+}
+exports.Response = Response;

package/src/Contracts/Context/ContextContract.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 { RequestContract } from './RequestContract';
+import { ResponseContract } from './ResponseContract';
+export interface ContextContract {
+    request: RequestContract;
+    response: ResponseContract;
+    params: Record<string, string>;
+    queries: Record<string, string>;
+    data: Record<string, any>;
+}

package/src/Contracts/Context/ContextContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Error/ErrorContextContract.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 { RequestContract } from '../RequestContract';
+import { ResponseContract } from '../ResponseContract';
+export interface ErrorContextContract {
+    request: RequestContract;
+    response: ResponseContract;
+    params: Record<string, string>;
+    queries: Record<string, string>;
+    data?: Record<string, any>;
+    error: any;
+}

package/src/Contracts/Context/Error/ErrorContextContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Error/ErrorHandlerContract.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 { ErrorContextContract } from './ErrorContextContract';
+export interface ErrorHandlerContract {
+    (ctx?: ErrorContextContract): Promise<any> | any;
+}

package/src/Contracts/Context/Error/ErrorHandlerContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/HandlerContract.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 { ContextContract } from './ContextContract';
+export interface HandlerContract {
+    (ctx?: ContextContract): Promise<any> | any;
+}

package/src/Contracts/Context/HandlerContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Middlewares/Handle/HandleContextContract.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 { NextContract } from '../../NextContract';
+import { RequestContract } from '../../RequestContract';
+import { ResponseContract } from '../../ResponseContract';
+export interface HandleContextContract {
+    request: RequestContract;
+    response: ResponseContract;
+    params: Record<string, string>;
+    queries: Record<string, string>;
+    data: Record<string, any>;
+    next: NextContract;
+}

package/src/Contracts/Context/Middlewares/Handle/HandleContextContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Middlewares/Handle/HandleHandlerContract.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 { HandleContextContract } from './HandleContextContract';
+export interface HandleHandlerContract {
+    (ctx?: HandleContextContract): Promise<any> | any;
+}

package/src/Contracts/Context/Middlewares/Handle/HandleHandlerContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Middlewares/Intercept/InterceptContextContract.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 { RequestContract } from '../../RequestContract';
+import { ResponseContract } from '../../ResponseContract';
+import { NextInterceptContract } from './NextInterceptContract';
+export interface InterceptContextContract {
+    request: RequestContract;
+    response: ResponseContract;
+    params: Record<string, string>;
+    queries: Record<string, string>;
+    body: Record<string, any>;
+    data: Record<string, any>;
+    next: NextInterceptContract;
+}

package/src/Contracts/Context/Middlewares/Intercept/InterceptContextContract.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 { InterceptContextContract } from './InterceptContextContract';
+export interface InterceptHandlerContract {
+    (ctx?: InterceptContextContract): Promise<any> | any;
+}