From 02e25d8542f684cc04dc95f102f2f4d4d0b49bb0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rafael=20L=C3=A1szl=C3=B3?= <rlacko99@gmail.com>
Date: Mon, 21 Dec 2020 17:39:51 +0100
Subject: [PATCH] refactor documentations and update CardImage schema
---
src/middlewares/auth/complete.ts | 6 +-----
src/middlewares/auth/isAuthenticated.ts | 4 ----
src/middlewares/auth/login.ts | 3 ---
src/middlewares/auth/logout.ts | 3 ---
src/middlewares/auth/refreshToken.ts | 4 ----
src/middlewares/cards/addCard.ts | 4 ----
src/middlewares/cards/getCard.ts | 4 ----
src/middlewares/cards/getCardList.ts | 4 ----
src/middlewares/cards/getCardListValid.ts | 4 ----
src/middlewares/cards/responseCard.ts | 4 ----
src/middlewares/cards/responseCardList.ts | 4 ----
src/middlewares/files/card/getCardImage.ts | 4 ----
src/middlewares/files/card/getUserCard.ts | 5 -----
src/middlewares/files/card/responseCardImage.ts | 4 ----
src/middlewares/files/card/uploadCardImage.ts | 5 -----
src/models/CardImageSchema.ts | 4 ++--
16 files changed, 3 insertions(+), 63 deletions(-)
diff --git a/src/middlewares/auth/complete.ts b/src/middlewares/auth/complete.ts
index 0eff34dd..3a329b2f 100644
--- a/src/middlewares/auth/complete.ts
+++ b/src/middlewares/auth/complete.ts
@@ -11,12 +11,8 @@ import axios from "axios";
* to get the logged in Users data.
* If the user is registered, then the Profile object
* id from the database will be added to session.profile.id
- *
- * @param {Request} req
- * @param {Response} res
- * @return {*} Redirects to the REDIRECT_URI
*/
-const complete = (): any => async (req: Request, res: Response) => {
+const complete = () => async (req: Request, res: Response) => {
const tokenConfig = {
code: String(req.query.code),
scope: scope,
diff --git a/src/middlewares/auth/isAuthenticated.ts b/src/middlewares/auth/isAuthenticated.ts
index 57e3c0ab..3cbf6fe1 100644
--- a/src/middlewares/auth/isAuthenticated.ts
+++ b/src/middlewares/auth/isAuthenticated.ts
@@ -3,10 +3,6 @@ import { NextFunction, Request, Response } from "express";
/**
* Middleware to check if the user
* is authenticated and registered
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const isAuthenticated = () => (
req: Request,
diff --git a/src/middlewares/auth/login.ts b/src/middlewares/auth/login.ts
index c91659f8..15fad1eb 100644
--- a/src/middlewares/auth/login.ts
+++ b/src/middlewares/auth/login.ts
@@ -7,9 +7,6 @@ const authorizationUri = oauth2().authorizationCode.authorizeURL({
/**
* Redirects to the authorization URL
- *
- * @param {Request} req
- * @param {Response} res
*/
const login = () => (req: Request, res: Response) =>
res.redirect(authorizationUri);
diff --git a/src/middlewares/auth/logout.ts b/src/middlewares/auth/logout.ts
index 6edadfc5..41ea05e8 100644
--- a/src/middlewares/auth/logout.ts
+++ b/src/middlewares/auth/logout.ts
@@ -2,9 +2,6 @@ import { Request, Response } from "express";
/**
* Logs out the user by destroying the session
- *
- * @param {Request} req
- * @param {Response} res
*/
const logout = () => async (req: Request, res: Response) => {
await req.session!.destroy(() => console.log("user logged out."));
diff --git a/src/middlewares/auth/refreshToken.ts b/src/middlewares/auth/refreshToken.ts
index 88ff7959..4a21a6a4 100644
--- a/src/middlewares/auth/refreshToken.ts
+++ b/src/middlewares/auth/refreshToken.ts
@@ -4,10 +4,6 @@ import { oauth2 } from "../../utils/auth";
/**
* Refresh user accessToken
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const refreshToken = () => async (
req: Request,
diff --git a/src/middlewares/cards/addCard.ts b/src/middlewares/cards/addCard.ts
index 3526a3cc..5e77e8b8 100644
--- a/src/middlewares/cards/addCard.ts
+++ b/src/middlewares/cards/addCard.ts
@@ -13,10 +13,6 @@ const fields = [
* Middleware that creates a Card
* from the request body and sets
* res.data.card to the created Card.
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const addCard = () => async (
req: Request,
diff --git a/src/middlewares/cards/getCard.ts b/src/middlewares/cards/getCard.ts
index 8cba976f..99dec4c8 100644
--- a/src/middlewares/cards/getCard.ts
+++ b/src/middlewares/cards/getCard.ts
@@ -6,10 +6,6 @@ import Card from "../../models/CardSchema";
* Middleware to find the card with
* id = req.params.id
* and set res.data.card
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const getCard = () => async (
req: Request,
diff --git a/src/middlewares/cards/getCardList.ts b/src/middlewares/cards/getCardList.ts
index ce02a286..1eacce1c 100644
--- a/src/middlewares/cards/getCardList.ts
+++ b/src/middlewares/cards/getCardList.ts
@@ -5,10 +5,6 @@ import Card from "../../models/CardSchema";
/**
* Middleware to find all cards
* and set res.data.cards
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const getCardList = () => async (
req: Request,
diff --git a/src/middlewares/cards/getCardListValid.ts b/src/middlewares/cards/getCardListValid.ts
index d05c235d..e5c99d30 100644
--- a/src/middlewares/cards/getCardListValid.ts
+++ b/src/middlewares/cards/getCardListValid.ts
@@ -6,10 +6,6 @@ import Card from "../../models/CardSchema";
* Middleware to find all
* not expired cards
* and set res.data.cards
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const getCardListValid = () => async (
req: Request,
diff --git a/src/middlewares/cards/responseCard.ts b/src/middlewares/cards/responseCard.ts
index 34421365..32a6cb87 100644
--- a/src/middlewares/cards/responseCard.ts
+++ b/src/middlewares/cards/responseCard.ts
@@ -2,10 +2,6 @@ import { Request, Response } from "express";
/**
* Return the found card from res.data.card
- *
- * @param {Request} req
- * @param {Response} res
- * @return {*} Found Card or 404
*/
const responseCard = (): any => (req: Request, res: Response) => {
if (!res.data.card)
diff --git a/src/middlewares/cards/responseCardList.ts b/src/middlewares/cards/responseCardList.ts
index 90bef2ee..9a516c15 100644
--- a/src/middlewares/cards/responseCardList.ts
+++ b/src/middlewares/cards/responseCardList.ts
@@ -2,10 +2,6 @@ import { Request, Response } from "express";
/**
* Return the found card from res.data.cards
- *
- * @param {Request} req
- * @param {Response} res
- * @return {*} Found Cards
*/
const responseCardList = (): any => (req: Request, res: Response) => {
return res.json(res.data.cards);
diff --git a/src/middlewares/files/card/getCardImage.ts b/src/middlewares/files/card/getCardImage.ts
index 18a273f2..d103871d 100644
--- a/src/middlewares/files/card/getCardImage.ts
+++ b/src/middlewares/files/card/getCardImage.ts
@@ -5,10 +5,6 @@ import CardImage from "../../../models/CardImageSchema";
/**
* Get the Entry card background image
* and set res.data.cardImage
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
*/
const getCardImage = () => async (
req: Request,
diff --git a/src/middlewares/files/card/getUserCard.ts b/src/middlewares/files/card/getUserCard.ts
index c682239f..59947d0d 100644
--- a/src/middlewares/files/card/getUserCard.ts
+++ b/src/middlewares/files/card/getUserCard.ts
@@ -6,11 +6,6 @@ import fs from "fs";
/**
* Generate Entry card svg from Users data and card
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
- * @return {*} Generated svg file
*/
const getUserCard = (): any => async (
req: Request,
diff --git a/src/middlewares/files/card/responseCardImage.ts b/src/middlewares/files/card/responseCardImage.ts
index a6a3f0b4..bc11170d 100644
--- a/src/middlewares/files/card/responseCardImage.ts
+++ b/src/middlewares/files/card/responseCardImage.ts
@@ -4,10 +4,6 @@ import File from "../../../models/FileSchema";
/**
* Return the Entry card background Image
- *
- * @param {Request} req
- * @param {Response} res
- * @return {*} The Found CardImage or the default
*/
const responseCardImage = (): any => async (req: Request, res: Response) => {
if (!res.data.cardImage)
diff --git a/src/middlewares/files/card/uploadCardImage.ts b/src/middlewares/files/card/uploadCardImage.ts
index 5b176883..a0df799f 100644
--- a/src/middlewares/files/card/uploadCardImage.ts
+++ b/src/middlewares/files/card/uploadCardImage.ts
@@ -6,11 +6,6 @@ import fs from "fs";
/**
* Upload a new Card background Image
- *
- * @param {Request} req
- * @param {Response} res
- * @param {NextFunction} next
- * @return {*} 200 Status code if uploaded
*/
const uploadCardImage = () => async (
req: Request,
diff --git a/src/models/CardImageSchema.ts b/src/models/CardImageSchema.ts
index 8bd205ea..17bfdb35 100644
--- a/src/models/CardImageSchema.ts
+++ b/src/models/CardImageSchema.ts
@@ -1,11 +1,11 @@
import { Document, Schema, model } from "mongoose";
export interface ICardImage extends Document {
- imageId: Number;
+ imageId: String;
}
const CardImageSchema = new Schema({
- imageId: { type: Schema.Types.ObjectId, ref: "File", required: false },
+ imageId: { type: Schema.Types.ObjectId, ref: "File", required: true },
});
export default model<ICardImage>("CardImage", CardImageSchema);
--
GitLab