📝 function documentations

Author: Kalash Shah

src/app.controller.ts

@@ -19,11 +19,6 @@ import { GithubCallbackQuery } from './constants/profile.types';
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
-  @Get()
-  getHello(): string {
-    return this.appService.getHello2();
-  }
-
   @Get('/error')
   @Render('error')
   error(@Query('message') message: string) {

src/app.service.ts

@@ -10,10 +10,10 @@ import {
   GITHUB_SECRET_KEY,
 } from './constants/env';
 import { PrismaService } from 'prisma/prisma.service';
+import { CloudinaryService } from './cloudinary/cloudinary.service';
 import { GithubCallbackQuery } from './constants/profile.types';
 import * as jwt from 'jsonwebtoken';
 import { decode } from './constants/decode';
-import { CloudinaryService } from './cloudinary/cloudinary.service';
 
 @Injectable()
 export class AppService {
@@ -22,13 +22,12 @@ export class AppService {
     private cloudinary: CloudinaryService,
   ) {}
 
-  getHello(): string {
-    return 'Hello from B-704';
-  }
-  getHello2(): string {
-    return '8 CPI Boi - Akhilesh Manda';
-  }
-
+  /**
+   * It takes a query object as input, verifies the state and code, and then uses the code to get an
+   * access token from Github
+   * @param {GithubCallbackQuery} query - GithubCallbackQuery
+   * @returns A string
+   */
   async githubCallback(query: GithubCallbackQuery): Promise<string> {
     const { code, state } = query;
     if (!code || !state) {
@@ -88,6 +87,13 @@ export class AppService {
     }
   }
 
+  /**
+   * It uploads a profile picture to Cloudinary, deletes the old profile picture from Cloudinary, and
+   * updates the user's profile picture in the database
+   * @param file - Express.Multer.File - This is the file that was uploaded by the user.
+   * @param {string} token - The token that was sent to the client when they logged in.
+   * @returns The secure_url of the uploaded image
+   */
   async uploadProfilePicture(
     file: Express.Multer.File,
     token: string,

src/constants/notifications.ts

@@ -1,3 +1,8 @@
+/**
+ * Function to create a notification message for when a user starts following.
+ * @param {string} name - The name of the user who started following.
+ * @returns Returns a string containing the notification message.
+ */
 export const followingNotification = (name: string) => {
   return `${name} started following you, do you want to follow back?`;
 };

src/constants/profile.data.ts

@@ -27,6 +27,11 @@ const GET_CONTRIBUTION_GRAPH_QUERY = `query ($userName: String!) {
   }
 }`;
 
+/**
+ * It takes a Github token as an argument and returns the Github username associated with that token
+ * @param {string} githubToken - The token that we got from the Github OAuth flow.
+ * @returns The username of the user who is logged in.
+ */
 export const getGithubUsername = async (githubToken: string) => {
   try {
     const response = await axios.get(`https://api.github.com/user`, {
@@ -43,6 +48,13 @@ interface GithubCalendarData {
   weeks: [{ contributionDays: [{ contributionCount: number; date: Date }] }];
 }
 
+/**
+ * It takes a Github username and a Github token as arguments, and returns a promise that resolves to
+ * the Github contribution graph data
+ * @param {string} githubUsername - The username of the Github user whose contribution graph you want to fetch.
+ * @param {string} githubToken - This is the token was generated from the users Github account.
+ * @returns GithubCalendarData
+ */
 export const getGithubContributionGraph = async (
   githubUsername: string,
   githubToken: string,
@@ -71,6 +83,12 @@ query getUserProfile($username: String!) {
   }
 }`;
 
+/**
+ * It makes a POST request to the Leetcode GraphQL API with the username as a variable, and returns the submission calendar data
+ * @param {string} leetcodeUsername - The username of the user whose contribution graph you want to
+ * fetch.
+ * @returns An array of objects containing the date and the number of submissions on that date.
+ */
 export const getLeetcodeContributionGraph = async (
   leetcodeUsername: string,
 ) => {
@@ -139,6 +157,11 @@ interface CodeforcesSubmission {
   timeConsumedMillis: number;
   memoryConsumedBytes: number;
 }
+/**
+ * It takes a Codeforces username as an argument and returns an array of submissions made by that user
+ * @param {string} codeforcesUsername - The username of the user whose submissions you want to fetch.
+ * @returns An array of CodeforcesSubmission objects
+ */
 
 export const getCodeforcesContributionGraph = async (
   codeforcesUsername: string,
@@ -176,6 +199,13 @@ query($userName: String!) {
 }
 `;
 
+/**
+ * It takes a GitHub username and a GitHub token, and returns a list of pinned repositories for that
+ * user
+ * @param {string} username - The username of the user whose pinned repos you want to fetch.
+ * @param {string} githubToken - This is the token that you get from the GitHub API.
+ * @returns An array of Repository objects
+ */
 export const pinnedRepos = async (
   username: string,
   githubToken: string,
@@ -188,6 +218,11 @@ export const pinnedRepos = async (
   return response.data.data.user.pinnedItems.nodes;
 };
 
+/**
+ * It takes a Codeforces username as a parameter and returns an array of CFRating objects
+ * @param {string} codeforcesUsername - The username of the user whose rating graph you want to fetch.
+ * @returns CFRating[]
+ */
 export const getCFRatingGraph = async (
   codeforcesUsername: string,
 ): Promise<CFRating[]> => {
@@ -205,6 +240,12 @@ export const getCFRatingGraph = async (
     throw new Error('Incorrect Codeforces username');
   }
 };
+/**
+ * It takes a Codeforces username as input and returns an object containing an array of tags and an
+ * array of ratings
+ * @param {string} codeforcesUsername - The username of the user whose submissions you want to fetch.
+ * @returns An object with two arrays, one for tags and one for ratings
+ */
 
 export const getCFTagandProblemGraph = async (
   codeforcesUsername: string,
@@ -329,6 +370,13 @@ query userInfo($userName: String!) {
   }
 }`;
 
+/**
+ * It takes a GitHub username and a GitHub token, and returns an object containing the user's language
+ * graph, statistics graph, and streak graph
+ * @param {string} githubUsername - The username of the user you want to get the data for.
+ * @param {string} githubToken - This is the token that you get from the github developer settings.
+ * @returns GithubGraphsOutput
+ */
 export const getGithubGraphsTogether = async (
   githubUsername: string,
   githubToken: string,
@@ -519,6 +567,11 @@ query data($username: String!) {
 }
 `;
 
+/**
+ * It makes a POST request to the Leetcode GraphQL API, and returns the data in a more readable format
+ * @param {string} leetcodeUsername - The username of the user you want to get the graphs for.
+ * @returns LeetcodeGraphsOutput
+ */
 export const getLeetcodeGraphs = async (
   leetcodeUsername: string,
 ): Promise<LeetcodeGraphsOutput> => {

src/dashboard/dashboard.service.ts

@@ -26,6 +26,14 @@ import { HttpException, HttpStatus } from '@nestjs/common';
 export class DashboardService {
   constructor(private prisma: PrismaService) {}
 
+  /**
+   * It takes a userId and a token, decodes the token, finds the user, creates a contribution graph
+   * object, fills it with data from Codeforces, Github and Leetcode, and returns the contribution graph
+   * object
+   * @param {string} userId - The userId of the user whose contribution graph is to be fetched.
+   * @param {string} token - The token that was generated when the user logged in.
+   * @returns A contribution graph object
+   */
   async getContributionGraph(
     userId: string,
     token: string,
@@ -61,6 +69,13 @@ export class DashboardService {
     return contributionGraph;
   }
 
+  /**
+   * It takes a userId and a token, decodes the token, finds the user, and then returns the pinned
+   * repos from the user's github account
+   * @param {string} userId - The userId of the user who's pinned repos we want to get
+   * @param {string} token - The token that was generated when the user logged in.
+   * @returns An array of pinned repos
+   */
   async getPinnedRepos(userId: string, token: string) {
     await decode(token, this.prisma);
     let user: User;
@@ -85,6 +100,13 @@ export class DashboardService {
     return [];
   }
 
+  /**
+   * It takes in a userId and a token, verifies the token, and then fetches the Codeforces username
+   * from the database and uses it to fetch the Codeforces graphs
+   * @param {string} userId - The userId of the user whose graphs are to be fetched.
+   * @param {string} token - The token that is generated when the user logs in.
+   * @returns the CodeforcesGraphsOutput object.
+   */
   async codeforcesGraphs(
     userId: string,
     token: string,
@@ -119,6 +141,13 @@ export class DashboardService {
     return null;
   }
 
+  /**
+   * It takes in a userId and a token, decodes the token, finds the user in the database, and then uses
+   * the user's github token to get their github graphs
+   * @param {string} userId - The userId of the user who's github token we want to use
+   * @param {string} token - The token that was generated by the login mutation.
+   * @returns GithubGraphsOutput | null
+   */
   async githubGraphs(
     userId: string,
     token: string,
@@ -145,6 +174,13 @@ export class DashboardService {
     }
   }
 
+  /**
+   * It takes in a userId and a token, decodes the token, finds the user with the userId, and then
+   * returns the leetcode graphs of the user if the user has a leetcode username
+   * @param {string} userId - The userId of the user who's leetcode graphs we want to fetch
+   * @param {string} token - The token that was generated when the user logged in.
+   * @returns LeetcodeGraphsOutput
+   */
   async leetcodeGraphs(
     userId: string,
     token: string,
@@ -170,6 +206,12 @@ export class DashboardService {
     }
   }
 
+  /**
+   * It takes a user object and a contribution graph object as parameters, and then it fills the
+   * contribution graph object with the user's Codeforces data
+   * @param {User} user - User - The user object that we are getting the contribution graph for.
+   * @param {ContributionGraph} contributionGraph - This is the object that we will be returning to the user.
+   */
   async fillCodeforcesData(user: User, contributionGraph: ContributionGraph) {
     if (user.codeforcesUsername) {
       try {
@@ -202,6 +244,12 @@ export class DashboardService {
     }
   }
 
+  /**
+   * It takes a user object and a contribution graph object, and if the user has a leetcode username,
+   * it fetches the leetcode contribution graph and adds it to the contribution graph object
+   * @param {User} user - User - The user object that we get from the database.
+   * @param {ContributionGraph} contributionGraph - This is the object that we will be returning to the user.
+   */
   async fillLeetcodeData(user: User, contributionGraph: ContributionGraph) {
     if (user.leetcodeUsername) {
       try {
@@ -234,6 +282,14 @@ export class DashboardService {
     }
   }
 
+  /**
+   * It takes a user and a contribution graph as input, and if the user has a github token, it fetches
+   * the user's github contribution data and adds it to the contribution graph
+   * @param {User} user - User - The user object that is passed in from the controller.
+   * @param {ContributionGraph} contributionGraph - This is the object that we will be returning to the
+   * user. It contains the total contributions, total github contributions, and an array of
+   * contributions.
+   */
   async fillGithubData(user: User, contributionGraph: ContributionGraph) {
     if (user.githubToken) {
       try {

src/mail/mail.service.ts

@@ -8,6 +8,11 @@ import { HttpException, HttpStatus } from '@nestjs/common';
 export class MailService {
   constructor(private mailerService: MailerService) {}
 
+  /**
+   * It sends an email to the user's email address with a 6-digit code
+   * @param {User} user - User - The user object that we want to send the email to.
+   * @param {string} code - The 6-digit code that will be sent to the user's email.
+   */
   async sendUserConfirmation(user: User, code: string) {
     try {
       await this.mailerService.sendMail({
@@ -27,6 +32,11 @@ export class MailService {
     }
   }
 
+  /**
+   * It sends an email to the user's email address with a 6-digit code to reset their password
+   * @param {User} user - User - The user object that we want to send the email to.
+   * @param {string} code - The 6-digit code that will be sent to the user's email.
+   */
   async sendPasswordReset(user: User, code: string) {
     try {
       await this.mailerService.sendMail({

src/notification/notification.service.ts

@@ -9,6 +9,14 @@ import { HttpException, HttpStatus } from '@nestjs/common';
 export class NotificationService {
   constructor(private prisma: PrismaService) {}
 
+  /**
+   * It deletes all previous notifications of the same type from the same user, then creates a new
+   * notification
+   * @param {string} toUser - The user who will receive the notification
+   * @param {string} description - The description of the notification
+   * @param {NotificationType} type - NotificationType
+   * @param {string} [fromUser] - The user who sent the notification
+   */
   async sendNotification(
     toUser: string,
     description: string,
@@ -54,6 +62,14 @@ export class NotificationService {
     }
   }
 
+  /**
+   * It takes a notificationId and a token as arguments, decodes the token, and then updates the
+   * notification with the given notificationId to have a seenStatus of true and a seenAt date of the
+   * current date
+   * @param {string} notificationId - The id of the notification to be marked as seen
+   * @param {string} token - The token that was sent to the user's email address.
+   * @returns The notification that was updated.
+   */
   async seeNotification(notificationId: string, token: string) {
     await decode(token, this.prisma);
     try {
@@ -75,6 +91,14 @@ export class NotificationService {
     }
   }
 
+  /**
+   * It takes an array of notification ids and a token as arguments, decodes the token, and then
+   * updates the notifications with the given ids to have a seen status of true and a seenAt date of
+   * the current date
+   * @param {string[]} notificationIds - The ids of the notifications to be marked as seen
+   * @param {string} token - The token of the user who is trying to mark the notifications as seen.
+   * @returns The notifications that were updated
+   */
   async seeNotifications(notificationIds: string[], token: string) {
     await decode(token, this.prisma);
     try {
@@ -98,6 +122,12 @@ export class NotificationService {
     }
   }
 
+  /**
+   * It fetches all the notifications of a user and returns the unseen notifications count and the
+   * notifications themselves
+   * @param {string} token - The token of the user who is requesting the notifications
+   * @returns The notifications of the user.
+   */
   async notifications(token: string): Promise<NotificationOutput> {
     const user = await decode(token, this.prisma);
     this.deleteSeenPreviousNotifications();
@@ -154,6 +184,9 @@ export class NotificationService {
     }
   }
 
+  /**
+   * It deletes all notifications that are older than 24 hours and have been seen by the user
+   */
   async deleteSeenPreviousNotifications() {
     try {
       await this.prisma.notification.deleteMany({