refactor documentations and update CardImage schema

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,

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,

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);

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."));

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,

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,

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,

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,

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,

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)

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);

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,

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,

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)

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,

src/models/CardImageSchema.ts

 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);