Clean up module imports across repo

aliases.ts

@@ -0,0 +1,17 @@
+import { addAliases } from 'module-alias';
+
+// Any changes to aliases must be mirrored in tsconfig.json and jest.config.json as well!!
+addAliases({
+  '@controllers': `${__dirname}/api/controllers`,
+  '@decorators': `${__dirname}/api/decorators`,
+  '@middleware': `${__dirname}/api/middleware`,
+  '@validators': `${__dirname}/api/validators`,
+  '@config': `${__dirname}/config`,
+  '@error': `${__dirname}/error`,
+  '@models': `${__dirname}/models`,
+  '@repositories': `${__dirname}/repositories`,
+  '@services': `${__dirname}/services`,
+  '@tests': `${__dirname}/tests`,
+  '@customtypes': `${__dirname}/types`,
+  '@utils': `${__dirname}/utils`,
+});

api/controllers/AdminController.ts

@@ -1,11 +1,4 @@
 import { JsonController, Post, Patch, UploadedFile, UseBefore, ForbiddenError, Body, Get } from 'routing-controllers';
-import { UserAuthentication } from '../middleware/UserAuthentication';
-import {
-  CreateBonusRequest,
-  CreateMilestoneRequest,
-  SubmitAttendanceForUsersRequest,
-  ModifyUserAccessLevelRequest,
-} from '../validators/AdminControllerRequests';
 import {
   File,
   MediaType,
@@ -16,13 +9,17 @@ import {
   SubmitAttendanceForUsersResponse,
   ModifyUserAccessLevelResponse,
   GetAllUserAccessLevelsResponse,
-} from '../../types';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import UserAccountService from '../../services/UserAccountService';
-import StorageService from '../../services/StorageService';
-import PermissionsService from '../../services/PermissionsService';
-import { UserModel } from '../../models/UserModel';
-import AttendanceService from '../../services/AttendanceService';
+} from '@customtypes';
+import { UserAccountService, StorageService, PermissionsService, AttendanceService } from '@services';
+import { UserModel } from '@models';
+import {
+  CreateBonusRequest,
+  CreateMilestoneRequest,
+  SubmitAttendanceForUsersRequest,
+  ModifyUserAccessLevelRequest,
+} from '@validators';
+import { UserAuthentication } from '@middleware';
+import { AuthenticatedUser } from '@decorators';
 
 @UseBefore(UserAuthentication)
 @JsonController('/admin')

api/controllers/AttendanceController.ts

@@ -1,13 +1,10 @@
 import { JsonController, Get, Post, UseBefore, Params, ForbiddenError, Body } from 'routing-controllers';
-import EmailService from '../../services/EmailService';
-import { UserAuthentication } from '../middleware/UserAuthentication';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { AttendEventRequest, AttendViaExpressCheckinRequest } from '../validators/AttendanceControllerRequests';
-import { UserModel } from '../../models/UserModel';
-import AttendanceService from '../../services/AttendanceService';
-import PermissionsService from '../../services/PermissionsService';
-import { GetAttendancesForEventResponse, GetAttendancesForUserResponse, AttendEventResponse } from '../../types';
-import { UuidParam } from '../validators/GenericRequests';
+import { GetAttendancesForEventResponse, GetAttendancesForUserResponse, AttendEventResponse } from '@customtypes';
+import { EmailService, AttendanceService, PermissionsService } from '@services';
+import { UserModel } from '@models';
+import { UserAuthentication } from '@middleware';
+import { AttendEventRequest, AttendViaExpressCheckinRequest, UuidParam } from '@validators';
+import { AuthenticatedUser } from '@decorators';
 
 @JsonController('/attendance')
 export class AttendanceController {

api/controllers/AuthController.ts

@@ -8,23 +8,20 @@ import {
   VerifyEmailResponse,
   ResendEmailVerificationResponse,
   EmailModificationResponse,
-} from '../../types';
-import UserAccountService from '../../services/UserAccountService';
-import UserAuthService from '../../services/UserAuthService';
-import { logger as log } from '../../utils/Logger';
-import { RequestTrace } from '../decorators/RequestTrace';
-import EmailService from '../../services/EmailService';
+} from '@customtypes';
+import { UserAccountService, UserAuthService, EmailService } from '@services';
+import { UserModel } from '@models';
 import {
   LoginRequest,
   RegistrationRequest,
   PasswordResetRequest,
   EmailModificationRequest,
-} from '../validators/AuthControllerRequests';
-import { authActionMetadata } from '../../utils/AuthActionMetadata';
-import { OptionalUserAuthentication, UserAuthentication } from '../middleware/UserAuthentication';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { UserModel } from '../../models/UserModel';
-import { EmailParam, AccessCodeParam } from '../validators/GenericRequests';
+  EmailParam,
+  AccessCodeParam,
+} from '@validators';
+import { OptionalUserAuthentication, UserAuthentication } from '@middleware';
+import { RequestTrace, AuthenticatedUser } from '@decorators';
+import { logger as log, authActionMetadata } from '@utils';
 
 @JsonController('/auth')
 export class AuthController {

api/controllers/EventController.ts

@@ -1,13 +1,6 @@
 import {
   JsonController, Get, Patch, Delete, Post, UseBefore, Params, ForbiddenError, QueryParams, UploadedFile, Body,
 } from 'routing-controllers';
-import EventService from '../../services/EventService';
-import { UserAuthentication, OptionalUserAuthentication } from '../middleware/UserAuthentication';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { UserModel } from '../../models/UserModel';
-import PermissionsService from '../../services/PermissionsService';
-import StorageService from '../../services/StorageService';
-import AttendanceService from '../../services/AttendanceService';
 import {
   MediaType,
   File,
@@ -19,8 +12,12 @@ import {
   GetFutureEventsResponse,
   GetAllEventsResponse,
   GetPastEventsResponse,
-} from '../../types';
-import { UuidParam } from '../validators/GenericRequests';
+} from '@customtypes';
+import { EventService, PermissionsService, StorageService, AttendanceService } from '@services';
+import { UserModel } from '@models';
+import { UuidParam } from '@validators';
+import { UserAuthentication, OptionalUserAuthentication } from '@middleware';
+import { AuthenticatedUser } from '@decorators';
 import {
   EventSearchOptions,
   PatchEventRequest,

api/controllers/FeedbackController.ts

@@ -1,12 +1,20 @@
-import { Body, ForbiddenError, Get, JsonController, Params,
-  Patch, Post, UseBefore, QueryParams } from 'routing-controllers';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { UserModel } from '../../models/UserModel';
-import PermissionsService from '../../services/PermissionsService';
-import FeedbackService from '../../services/FeedbackService';
-import { GetFeedbackResponse, SubmitFeedbackResponse, UpdateFeedbackStatusResponse } from '../../types';
-import { UuidParam } from '../validators/GenericRequests';
-import { UserAuthentication } from '../middleware/UserAuthentication';
+import {
+  Body,
+  ForbiddenError,
+  Get,
+  JsonController,
+  Params,
+  Patch,
+  Post,
+  UseBefore,
+  QueryParams,
+} from 'routing-controllers';
+import { GetFeedbackResponse, SubmitFeedbackResponse, UpdateFeedbackStatusResponse } from '@customtypes';
+import { PermissionsService, FeedbackService } from '@services';
+import { UserModel } from '@models';
+import { UuidParam } from '@validators';
+import { UserAuthentication } from '@middleware';
+import { AuthenticatedUser } from '@decorators';
 import {
   SubmitFeedbackRequest,
   UpdateFeedbackStatusRequest,

api/controllers/LeaderboardController.ts

@@ -1,8 +1,8 @@
 import { UseBefore, JsonController, Get, QueryParams } from 'routing-controllers';
-import { GetLeaderboardResponse } from '../../types';
-import { UserAuthentication } from '../middleware/UserAuthentication';
-import UserAccountService from '../../services/UserAccountService';
-import { SlidingLeaderboardQueryParams } from '../validators/LeaderboardControllerRequests';
+import { GetLeaderboardResponse } from '@customtypes';
+import { UserAccountService } from '@services';
+import { SlidingLeaderboardQueryParams } from '@validators';
+import { UserAuthentication } from '@middleware';
 
 @UseBefore(UserAuthentication)
 @JsonController('/leaderboard')

api/controllers/MerchStoreController.ts

@@ -13,8 +13,6 @@ import {
   UploadedFile,
 } from 'routing-controllers';
 import { v4 as uuid } from 'uuid';
-import PermissionsService from '../../services/PermissionsService';
-import { UserAuthentication } from '../middleware/UserAuthentication';
 import {
   GetOneMerchCollectionResponse,
   GetAllMerchCollectionsResponse,
@@ -50,12 +48,11 @@ import {
   GetOrderPickupEventResponse,
   CancelOrderPickupEventResponse,
   CancelMerchOrderResponse,
-} from '../../types';
-import { UuidParam } from '../validators/GenericRequests';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { UserModel } from '../../models/UserModel';
-import MerchStoreService from '../../services/MerchStoreService';
+} from '@customtypes';
+import { PermissionsService, MerchStoreService, StorageService } from '@services';
+import { UserModel } from '@models';
 import {
+  UuidParam,
   CreateMerchCollectionRequest,
   EditMerchCollectionRequest,
   CreateCollectionPhotoRequest,
@@ -70,9 +67,10 @@ import {
   CreateOrderPickupEventRequest,
   EditOrderPickupEventRequest,
   GetCartRequest,
-} from '../validators/MerchStoreRequests';
-import { UserError } from '../../utils/Errors';
-import StorageService from '../../services/StorageService';
+} from '@validators';
+import { UserAuthentication } from '@middleware';
+import { AuthenticatedUser } from '@decorators';
+import { UserError } from '@utils';
 
 @UseBefore(UserAuthentication)
 @JsonController('/merch')

api/controllers/ResumeController.ts

@@ -12,16 +12,19 @@ import {
   Delete,
 } from 'routing-controllers';
 import * as path from 'path';
-import PermissionsService from '../../services/PermissionsService';
-import StorageService from '../../services/StorageService';
-import { UserAuthentication } from '../middleware/UserAuthentication';
-import ResumeService from '../../services/ResumeService';
-import { UserModel } from '../../models/UserModel';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
-import { File, MediaType, GetVisibleResumesResponse,
-  PatchResumeResponse, UpdateResumeResponse, DeleteResumeResponse } from '../../types';
-import { PatchResumeRequest, UploadResumeRequest } from '../validators/ResumeControllerRequests';
-import { UuidParam } from '../validators/GenericRequests';
+import {
+  File,
+  MediaType,
+  GetVisibleResumesResponse,
+  PatchResumeResponse,
+  UpdateResumeResponse,
+  DeleteResumeResponse,
+} from '@customtypes';
+import { PermissionsService, StorageService, ResumeService } from '@services';
+import { UserModel } from '@models';
+import { UserAuthentication } from '@middleware';
+import { PatchResumeRequest, UploadResumeRequest, UuidParam } from '@validators';
+import { AuthenticatedUser } from '@decorators';
 
 @UseBefore(UserAuthentication)
 @JsonController('/resume')

api/controllers/UserController.ts

@@ -1,12 +1,6 @@
 import {
   JsonController, Params, Get, Post, Patch, UseBefore, UploadedFile, Body, Delete,
 } from 'routing-controllers';
-import { UserModel } from '../../models/UserModel';
-import UserAccountService from '../../services/UserAccountService';
-import UserSocialMediaService from '../../services/UserSocialMediaService';
-import StorageService from '../../services/StorageService';
-import { UserAuthentication } from '../middleware/UserAuthentication';
-import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
 import {
   MediaType,
   File,
@@ -18,13 +12,18 @@ import {
   InsertSocialMediaResponse,
   UpdateSocialMediaResponse,
   DeleteSocialMediaResponse,
-} from '../../types';
-import { UserHandleParam, UuidParam } from '../validators/GenericRequests';
-import { PatchUserRequest } from '../validators/UserControllerRequests';
+} from '@customtypes';
+import { UserAccountService, UserSocialMediaService, StorageService } from '@services';
+import { UserModel } from '@models';
 import {
+  UserHandleParam,
+  UuidParam,
+  PatchUserRequest,
   InsertSocialMediaRequest,
   UpdateSocialMediaRequest,
-} from '../validators/UserSocialMediaControllerRequests';
+} from '@validators';
+import { UserAuthentication } from '@middleware';
+import { AuthenticatedUser } from '@decorators';
 
 @UseBefore(UserAuthentication)
 @JsonController('/user')

api/controllers/index.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { UserModel } from '../../models/UserModel';
+import { UserModel } from '@models';
 import { UserController } from './UserController';
 import { AuthController } from './AuthController';
 import { EventController } from './EventController';
@@ -13,7 +13,6 @@ import { ResumeController } from './ResumeController';
 export const controllers = [
   AuthController,
   UserController,
-  ResumeController,
   EventController,
   AttendanceController,
   LeaderboardController,
@@ -23,6 +22,18 @@ export const controllers = [
   ResumeController,
 ];
 
+export {
+  UserController,
+  AuthController,
+  EventController,
+  AttendanceController,
+  AdminController,
+  MerchStoreController,
+  LeaderboardController,
+  FeedbackController,
+  ResumeController,
+};
+
 // this merges our custom properties into Express's Request type
 declare global {
   namespace Express {

api/decorators/Validators.ts

@@ -1,7 +1,7 @@
 import {
   ValidatorConstraintInterface, registerDecorator, ValidationOptions, ValidatorConstraint,
 } from 'class-validator';
-import { PasswordChange, FeedbackType, FeedbackStatus, OrderStatus, SocialMediaType } from '../../types';
+import { PasswordChange, FeedbackType, FeedbackStatus, OrderStatus, SocialMediaType } from '@customtypes';
 
 function templatedValidationDecorator(
   validator: ValidatorConstraintInterface | Function, validationOptions?: ValidationOptions,

api/decorators/index.ts

@@ -0,0 +1,3 @@
+export * from './AuthenticatedUser';
+export * from './RequestTrace';
+export * from './Validators';

api/middleware/ErrorHandler.ts

@@ -1,6 +1,6 @@
 import * as express from 'express';
 import { ExpressErrorMiddlewareInterface, Middleware } from 'routing-controllers';
-import { handleError } from '../../error';
+import { handleError } from '@error';
 
 @Middleware({ type: 'after' })
 export class ErrorHandler implements ExpressErrorMiddlewareInterface {

api/middleware/NotFoundHandler.ts

@@ -1,6 +1,6 @@
 import { ExpressMiddlewareInterface, NotFoundError, Middleware } from 'routing-controllers';
 import * as express from 'express';
-import { handleError } from '../../error';
+import { handleError } from '@error';
 
 @Middleware({ type: 'after' })
 export class NotFoundHandler implements ExpressMiddlewareInterface {

api/middleware/UserAuthentication.ts

@@ -1,9 +1,8 @@
 import { ExpressMiddlewareInterface, ForbiddenError } from 'routing-controllers';
 import * as express from 'express';
 import { Inject } from 'typedi';
-import UserAuthService from '../../services/UserAuthService';
-import { authActionMetadata } from '../../utils/AuthActionMetadata';
-import { logger as log } from '../../utils/Logger';
+import { UserAuthService } from '@services';
+import { authActionMetadata, logger as log } from '@utils';
 
 export class UserAuthentication implements ExpressMiddlewareInterface {
   @Inject()

api/middleware/index.ts

@@ -3,6 +3,9 @@ import { ErrorHandler } from './ErrorHandler';
 import { NotFoundHandler } from './NotFoundHandler';
 import { MetricsRecorder } from './MetricsRecorder';
 
+export * from './UserAuthentication';
+
+// not including UserAuthentication middlewares as part of global middlewares because it depends on the route
 export const middlewares = [
   ErrorHandler,
   NotFoundHandler,

api/validators/AdminControllerRequests.ts

@@ -9,7 +9,7 @@ import {
   Bonus as IBonus,
   UserAccessUpdates as IUserAccessUpdates,
   UserAccessType,
-} from '../../types';
+} from '@customtypes';
 
 const validUserAccessTypes = Object.values(UserAccessType);
 

api/validators/AttendanceControllerRequests.ts

@@ -2,7 +2,7 @@ import { IsDefined, IsNotEmpty, Allow, IsEmail } from 'class-validator';
 import {
   AttendEventRequest as IAttendEventRequest,
   AttendViaExpressCheckinRequest as IAttendViaExpressCheckinRequest,
-} from '../../types';
+} from '@customtypes';
 
 export class AttendEventRequest implements IAttendEventRequest {
   @IsDefined()