Adding comments to app

Author: DanielArturoAlejoAlvarez

src/controllers/auth/auth.controller.ts

@@ -6,6 +6,12 @@ import User from "../../models/User";
 import bcrypt from "bcrypt";
 import jwt from "jsonwebtoken";
 
+/**
+ * Creating tokens 
+ * Using jsonwebtoken
+ * @param user 
+ * @returns
+ */
 function createToken(user: IUser) {
   return jwt.sign(
     {
@@ -19,6 +25,12 @@ function createToken(user: IUser) {
   );
 }
 
+/**
+ * User registration function 
+ * @param req 
+ * @param res 
+ * @returns
+ */
 export const signUp = async (
   req: Request,
   res: Response
@@ -39,6 +51,12 @@ export const signUp = async (
   return res.status(201).json(newUser);
 };
 
+/**
+ * User login function
+ * @param req 
+ * @param res 
+ * @returns
+ */
 export const signIn = async (
   req: Request,
   res: Response

src/database.ts

@@ -1,6 +1,11 @@
 import config from './config/config'
 import mongoose from 'mongoose'
 
+/**
+ * Connection to DB
+ * Using Mongoose
+ * MongoClientOptions
+ */
 mongoose.connect(config.DB.URI, {
   useCreateIndex: true,
   useNewUrlParser: true,

src/index.ts

@@ -1,6 +1,9 @@
 import app from './app'
 import './database'
 
+/**
+ * Starting our application
+ */
 function main() {
   app.listen(app.get('port'))
   console.log('Server running in port: ', app.get('port'))

src/midlewares/passport.ts

@@ -2,11 +2,18 @@ import { Strategy, StrategyOptions, ExtractJwt } from "passport-jwt";
 import config from "../config/config";
 import User from "../models/User";
 
+/**
+ * StrategyOptions interface
+ * Using passport-jwt
+ */
 const opts: StrategyOptions = {
   jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
   secretOrKey: config.secretKey,
 };
 
+/**
+ * Instance Strategy Class
+ */
 export default new Strategy(opts, (payload, done) => {
   try {
     const user = User.findById(payload.id);

src/models/IUser.ts

@@ -1,5 +1,9 @@
 import { Document } from 'mongoose'
 
+/**
+ * IUser Interface
+ * Document class inheritance
+ */
 export interface IUser extends Document {
   displayName: string;
   username: string;

src/models/User.ts

@@ -2,6 +2,9 @@ import { model, Schema } from "mongoose";
 import bcrypt from "bcrypt";
 import { IUser } from "./IUser";
 
+/**
+ * Create a new Schema from mongoose
+ */
 const UserSchema = new Schema(
   {
     displayName: {
@@ -45,6 +48,9 @@ const UserSchema = new Schema(
   }
 );
 
+/**
+ * A promise to be either resolved with the encrypted data salt or rejected with an Error
+ */
 UserSchema.pre<IUser>("save", async function (next) {
   const user = this;
   if (!user.isModified("password")) return next();
@@ -55,4 +61,7 @@ UserSchema.pre<IUser>("save", async function (next) {
   next();
 });
 
+/**
+ * IUser Interface Document class inheritance
+ */
 export default model<IUser>("User", UserSchema);

src/routes/auth.routes.ts

@@ -2,6 +2,10 @@ import { Router } from "express";
 import { signIn, signUp } from "../controllers/auth/auth.controller";
 import passport from "passport";
 
+/**
+ * Router
+ * Using Passport
+ */
 const router = Router();
 
 router.post("/signin", signIn);

src/routes/user.routes.ts

@@ -4,6 +4,10 @@ import passport from "passport";
 
 const router = Router();
 
+/**
+ * Apply Middleware Strategy from Passport
+ * Authentication with Passport
+ */
 router.get("/", passport.authenticate("jwt", { session: false }), getUsers);
 router.get("/:id", passport.authenticate("jwt", { session: false }), getUser);