feature/booked-dates

- add jsdoc
- setup jsdoc and modify files to use jsdoc

.eslintrc

@@ -57,7 +57,15 @@
           "err"
         ]
       }
-    ]
+    ],
+    "require-jsdoc": ["error", {
+      "require": {
+        "ClassDeclaration": true,
+        "FunctionDeclaration": true,
+        "ArrowFunctionExpression": true,
+        "MethodDefinition": true
+      }
+    }]
   },
   "globals": {
     "localStorage": true,

server/controllers/center.js

@@ -4,9 +4,20 @@ import serverError from '../errorHandler/serverError';
 import validateInput from '../validators/validateAddCenter';
 
 const { Center } = db;
-const Op = Sequelize.Op;
+const { Op } = Sequelize;
 
+/**
+ * A controller class for handling center actions
+ */
 class CenterController {
+  /**
+   * Create a new center
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static createCenter(request, response) {
     const { errors, isValid } = validateInput(request.body);
 
@@ -52,6 +63,14 @@ class CenterController {
     });
   }
 
+  /**
+   * Edit a center in the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static editCenter(request, response) {
     return Center.findById(request.params.centerId)
       .then((center) => {
@@ -87,6 +106,14 @@ class CenterController {
       });
   }
 
+  /**
+   * Delete a center
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static deleteCenter(request, response) {
     const { username } = request.userDetails;
     Center.findById(request.params.centerId)
@@ -114,6 +141,14 @@ class CenterController {
       });
   }
 
+  /**
+   * Fetch all centers
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static getCenters(request, response) {
     Center.all()
       .then((centers) => {
@@ -127,6 +162,15 @@ class CenterController {
         });
       });
   }
+
+  /**
+   * Search through the centers
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static searchCenters(request, response) {
     const { search } = request.query;
     return Center.findAll({
@@ -156,6 +200,15 @@ class CenterController {
       });
     });
   }
+
+  /**
+   * Fetch one center from the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The center object
+   */
   static getOneCenter(request, response) {
     Center.findById(request.params.centerId)
       .then((foundCenter) => {

server/controllers/event.js

@@ -8,7 +8,18 @@ import validateAddEvent from '../validators/validateAddEvent';
 
 const { Event, Center, User } = db;
 
+/**
+ * A class controller for handling events actions
+ */
 class Events {
+  /**
+   * Adds an event to the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The event object
+   */
   static addEvent(request, response) {
     const { errors, valid } = validateAddEvent(request.body);
     if (!valid) {
@@ -89,6 +100,14 @@ class Events {
     });
   }
 
+  /**
+   * Fetch all the events in the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The event object
+   */
   static getEvents(request, response) {
     return Event.findAndCountAll()
       .then((allEvents) => {
@@ -107,6 +126,15 @@ class Events {
         });
       });
   }
+
+  /**
+   * Edit the event in the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The event object
+   */
   static modifyEvent(request, response) {
     Event.findById(request.params.eventId)
       .then((event) => {
@@ -138,6 +166,14 @@ class Events {
       });
   }
 
+  /**
+   * Delete the event in the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The event object
+   */
   static deleteEvent(request, response) {
     Event.findById(request.params.eventId)
       .then((event) => {
@@ -177,6 +213,15 @@ class Events {
         });
       });
   }
+
+  /**
+   * Fetch events for a particular center in the database
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The event object
+   */
   static getCenterEvents(request, response) {
     Event.findAll({
       where: {

server/controllers/user.js

@@ -6,7 +6,18 @@ import validateSignin from '../validators/validateSignin';
 
 const { User } = db;
 
+/**
+ * Controller class for handling user actions
+ */
 class Users {
+  /**
+   * Create a new User
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The user object
+   */
   static userSignup(request, response) {
     const { errors, isValid } = validateSignup(request.body);
     if (!isValid) {
@@ -64,6 +75,14 @@ class Users {
       });
   }
 
+  /**
+   * Sign-in a user
+   *
+   * @param {object} request - The request object
+   * @param {object} response - The response object
+   *
+   * @returns {object} The user object
+   */
   static userSignin(request, response) {
     const { errors, isValid } = validateSignin(request.body);
     if (!isValid) {

server/validators/validateAddCenter.js

@@ -1,5 +1,11 @@
 import { isEmpty } from 'lodash';
 
+/**
+ * Validates the incoming request
+ *
+ * @param {Object} centerData - The incoming request
+ * data for the creation of a center
+ */
 const validateAddCenter = (centerData) => {
   const errors = {};
   if (centerData.name === undefined || centerData.name.trim() === '') {

server/validators/validateAddEvent.js

@@ -1,5 +1,11 @@
 import { isEmpty } from 'lodash';
 
+/**
+ * Validates the incoming request
+ *
+ * @param {Object} eventData - The incoming request
+ * data for the creation of an event
+ */
 const validateAddEvent = (eventData) => {
   const errors = {};
   if (eventData.name.trim() === '' || eventData.name === undefined) {

server/validators/validateSignin.js

@@ -2,6 +2,12 @@ import { isEmpty } from 'lodash';
 
 const validateEmail = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
 
+/**
+ * Validates the incoming request
+ *
+ * @param {Object} userData - The incoming request
+ * data for the creation of a new user
+ */
 const validateSignin = (userData) => {
   const errors = {};
   if (

server/validators/validateSignup.js

@@ -3,6 +3,12 @@ import { isValidNumber } from 'libphonenumber-js';
 
 const validateEmail = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/;
 
+/**
+ * Validates the incoming request
+ *
+ * @param {Object} userData - The incoming request
+ * data for the creation of a user
+ */
 const validateSignup = (userData) => {
   const errors = {};
   if (