cleanup jsdocs

Author: clairep94

server/types/apiKey.ts

@@ -2,6 +2,7 @@ import { Model, Document, Types } from 'mongoose';
 import { VirtualId, MongooseTimestamps } from './mongoose';
 import { Error, RouteParam } from './express';
 
+// -------- MONGOOSE --------
 /** Full Api Key interface */
 export interface IApiKey extends VirtualId, MongooseTimestamps {
   label: string;
@@ -27,20 +28,24 @@ export interface SanitisedApiKey
 /** Mongoose model for API Key */
 export interface ApiKeyModel extends Model<ApiKeyDocument> {}
 
-// HTTP
+// -------- API --------
 /**
  * Response body for userController.createApiKey & userController.removeApiKey
  *   - Either an ApiKeyResponse or Error
  */
 export type ApiKeyResponseOrError = ApiKeyResponse | Error;
 
+/** Response for api-key related endpoints, containing list of keys */
 export interface ApiKeyResponse {
   apiKeys: ApiKeyDocument[];
 }
 
+/** userController.createApiKey - Request */
 export interface CreateApiKeyRequestBody {
   label: string;
 }
+
+/** userController.removeApiKey - Request */
 export interface RemoveApiKeyRequestParams extends RouteParam {
   keyId: string;
 }

server/types/user.ts

@@ -5,6 +5,7 @@ import { EmailConfirmationStates } from './email';
 import { ApiKeyDocument } from './apiKey';
 import { Error, GenericResponseBody, RouteParam } from './express';
 
+// -------- MONGOOSE --------
 /** Full User interface */
 export interface IUser extends VirtualId, MongooseTimestamps {
   name: string;
@@ -76,14 +77,13 @@ export interface UserModel extends Model<UserDocument> {
   EmailConfirmation(): typeof EmailConfirmationStates;
 }
 
-// HTTP:
+// -------- API --------
 /**
  * Response body used for User related routes
  * Contains either the Public (sanitised) User or an Error
  */
 export type PublicUserOrError = PublicUser | Error;
 
-// authManagement:
 /**
  * Note: This type should probably be updated to be removed in the future and use just PublicUserOrError
  *   - Contains either a GenericResponseBody for when there is no user found or attached to a request
@@ -93,6 +93,7 @@ export type PublicUserOrErrorOrGeneric =
   | PublicUserOrError
   | GenericResponseBody;
 
+/** userController.updateSettings - Request */
 export interface UpdateSettingsRequestBody {
   username: string;
   email: string;
@@ -101,38 +102,39 @@ export interface UpdateSettingsRequestBody {
 }
 
 /**
- * Response body used for unlinkGithub and unlinkGoogle
+ * userContoller.unlinkGithub & userContoller.unlinkGoogle - Response
  *   - If user is not logged in, a GenericResponseBody with 404 is returned
  *   - If user is logged in, PublicUserOrError is returned
  */
 export type UnlinkThirdPartyResponseBody = PublicUserOrErrorOrGeneric;
 
+/** userController.resetPasswordInitiate - Request */
 export interface ResetPasswordInitiateRequestBody {
   email: string;
 }
 
-/**
- * Request params used for validateResetPasswordToken & updatePassword
- */
+/** userContoller.validateResetPasswordToken & userController.updatePassword - Request */
 export interface ResetOrUpdatePasswordRequestParams extends RouteParam {
   token: string;
 }
+/** userController.updatePassword - Request */
 export interface UpdatePasswordRequestBody {
   password: string;
 }
-
-// signup:
+/** userController.createUser - Request */
 export interface CreateUserRequestBody {
   username: string;
   email: string;
   password: string;
 }
+/** userController.duplicateUserCheck - Query */
 export interface DuplicateUserCheckQuery {
   // eslint-disable-next-line camelcase
   check_type: 'email' | 'username';
   email?: string;
   username?: string;
 }
+/** userController.verifyEmail - Query */
 export interface VerifyEmailQuery {
   t: string;
 }

server/types/userPreferences.ts

@@ -29,19 +29,16 @@ export enum CookieConsentOptions {
   ALL = 'all'
 }
 
-// HTTP:
-
-export type UpdatePreferencesResponseBody = UserPreferences | Error;
-/**
- * user.controller.updatePreferences
- */
+// -------- API --------
+/** user.controller.updatePreferences - Request */
 export interface UpdatePreferencesRequestBody {
   preferences: Partial<UserPreferences>;
 }
 
-/**
- * user.controller.updateCookieConsent
- */
+/** userController.updatePreferences - Response */
+export type UpdatePreferencesResponseBody = UserPreferences | Error;
+
+/** user.controller.updateCookieConsent - Request */
 export interface UpdateCookieConsentRequestBody {
   cookieConsent: CookieConsentOptions;
 }