Add rest client and fix joi validation

Author: cham11ng

README.md

@@ -109,6 +109,30 @@ $ yarn migrate # to migrate
 $ yarn seed # to seed
 ```
 
+## Setting up REST Client
+
+Create a file or add `.vscode > settings.json` and switch an environment `Cmd/Ctrl + Shift + P` > `REST Client: Switch Environment`. Then, you can request APIs from `api.rest` file.
+
+```
+{
+  "rest-client.environmentVariables": {
+    "$shared": {
+      "refreshToken": "foo",
+      "accessToken": "bar",
+      "email": "sgr.raee@gmail.com",
+      "password": "secret" 
+    },
+    "local": {
+      "host": "localhost",
+      "refreshToken": "{{$shared refreshToken}}",
+      "accessToken": "{{$shared accessToken}}",
+      "email": "{{$shared email}}",
+      "password": "{{$shared password}}"
+    }
+  }
+}
+```
+
 ## Contributing
 
 Feel free to send pull requests.

api.rest

@@ -0,0 +1,18 @@
+GET {{host}} HTTP/1.1
+
+###
+
+POST {{host}}/login HTTP/1.1
+Content-Type: application/json
+
+{
+  "email": "{{email}}",
+  "password": "{{password}}"
+}
+
+###
+
+POST {{host}}/refresh HTTP/1.1
+Authorization: {{refreshToken}}
+
+###

package.json

@@ -91,7 +91,7 @@
     "@typescript-eslint/eslint-plugin": "^5.30.0",
     "@typescript-eslint/parser": "^5.30.0",
     "babel-jest": "^27.0.6",
-    "chalk": "^5.0.1",
+    "chalk": "^4.1.1",
     "concurrently": "^7.2.2",
     "eslint": "^8.18.0",
     "eslint-plugin-security": "^1.4.0",

scripts/fake-loader.ts

@@ -20,7 +20,7 @@ function print<T>(data: T): void {
     print(await fake.generate(factoryCallback, total));
 
     process.exit(0);
-  } catch (err) {
+  } catch (err: any) {
     info(chalk`{red ${err.message}}`);
 
     process.exit(1);

src/middlewares/validate.ts

@@ -2,14 +2,13 @@ import Joi from 'joi';
 import { Request, Response, NextFunction } from 'express';
 
 import logger from '../utils/logger';
-import validate from '../utils/validate';
 
 /**
  * A middleware to validate schema.
  *
- * @param {Joi.Schema} params
+ * @param {Joi.Schema} schema
  */
-export function schema(params: Joi.Schema) {
+export default function validate(schema: Joi.Schema) {
   return async (
     req: Request,
     _: Response,
@@ -18,7 +17,9 @@ export function schema(params: Joi.Schema) {
     try {
       logger.log('info', 'Validating schema');
 
-      await validate(req.body, params);
+      logger.log('debug', 'Validation Payload', req.body);
+      const value = await schema.validateAsync(req.body);
+      logger.log('debug', 'Validation Response:', value);
 
       next();
     } catch (err) {

src/routes.ts

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 
-import * as validate from './middlewares/validate';
+import validate from './middlewares/validate';
 import * as homeController from './controllers/home';
 import * as userController from './controllers/user';
 import * as authController from './controllers/auth';
@@ -13,15 +13,15 @@ const router: Router = Router();
 
 router.get('/', homeController.index);
 
-router.post('/login', validate.schema(loginSchema), authController.login);
+router.post('/login', validate(loginSchema), authController.login);
 router.post('/refresh', validateRefreshToken, authController.refresh);
 router.post('/logout', validateRefreshToken, authController.logout);
 
 router.get('/users', authenticate, userController.index);
 router.post(
   '/users',
   authenticate,
-  validate.schema(userPOSTSchema),
+  validate(userPOSTSchema),
   userController.store
 );
 

src/utils/validate.ts

@@ -3,6 +3,6 @@ import Joi from 'joi';
 export const loginSchema = Joi.object()
   .options({ abortEarly: false })
   .keys({
-    email: Joi.string().min(10).max(100).label('Email').required(),
+    email: Joi.string().max(100).label('Email').required(),
     password: Joi.string().min(6).max(100).label('Password').required()
   });

src/validators/loginRequest.ts

@@ -2302,19 +2302,14 @@ chalk@^2.0.0:
     escape-string-regexp "^1.0.5"
     supports-color "^5.3.0"
 
-chalk@^4.0.0, chalk@^4.1.0:
+chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.1:
   version "4.1.2"
   resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01"
   integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==
   dependencies:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
 
-chalk@^5.0.1:
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.0.1.tgz#ca57d71e82bb534a296df63bbacc4a1c22b2a4b6"
-  integrity sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==
-
 char-regex@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf"