express-generator-typescript 1.10.3 → 2.0.2

package/lib/socket-io/spec/tests/auth.spec.ts

@@ -1,159 +0,0 @@
-import bcrypt from 'bcrypt';
-import StatusCodes from 'http-status-codes';
-import supertest, { SuperTest, Test, Response } from 'supertest';
-
-import app from '@server';
-import userRepo from '@repos/user-repo';
-import envVars from '@shared/env-vars';
-import User, { UserRoles } from '@models/user-model';
-import { p as paths } from '@routes/auth-router';
-import { pErr } from '@shared/functions';
-import { pwdSaltRounds } from 'spec/support/login-agent';
-import { UnauthorizedError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Misc
-const authPath = '/api/auth',
-  loginPath = `${authPath}${paths.login}`,
-  logoutPath = `${authPath}${paths.logout}`,
-  { BAD_REQUEST, OK, UNAUTHORIZED } = StatusCodes;
-
-// Test message
-const msgs = {
-  goodLogin: `should return a response with a status of ${OK} and a cookie with a jwt if the login
-    was successful.`,
-  emailNotFound: `should return a response with a status of ${UNAUTHORIZED} and a json with the 
-    "error ${UnauthorizedError.Msg}" if the email was not found.`,
-  pwdFailed: `should return a response with a status of ${UNAUTHORIZED} and a json with the error
-    "${UnauthorizedError.Msg}" if the password failed.`,
-  fallbackErr: `should return a response with a status of ${BAD_REQUEST} and a json with an error
-    for all other bad responses.`,
-  goodLogout: `should return a response with a status of ${OK}.`,
-}
-
-
-// **** Types **** //
-
-type TReqBody = string | object | undefined;
-
-
-// **** Tests **** //
-
-describe('auth-router', () => {
-
-  let agent: SuperTest<Test>;
-
-  // Run before all tests
-  beforeAll((done) => {
-    agent = supertest.agent(app);
-    done();
-  });
-
-  // Test login
-  describe(`"POST:${loginPath}"`, () => {
-
-    const callApi = (reqBody: TReqBody) => {
-      return agent.post(loginPath).type('form').send(reqBody);
-    };
-
-    // Good login
-    it(msgs.goodLogin, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'Password@1',
-      };
-      const role = UserRoles.Standard;
-      const pwdHash = hashPwd(creds.password);
-      const loginUser = User.new('john smith', creds.email, role, pwdHash);
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
-      // Call API
-      callApi(creds)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          expect(res.headers['set-cookie'][0]).toContain(envVars.cookieProps.key);
-          done();
-        });
-    });
-
-    // Email not found error
-    it(msgs.emailNotFound, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'Password@1',
-      };
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(null));
-      // Call API
-      callApi(creds)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UNAUTHORIZED);
-          expect(res.body.error).toBe(UnauthorizedError.Msg);
-          done();
-        });
-    });
-
-    // Password failed
-    it(msgs.pwdFailed, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'someBadPassword',
-      };
-      const role = UserRoles.Standard;
-      const pwdHash = hashPwd('Password@1');
-      const loginUser = User.new('john smith', creds.email, role, pwdHash);
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
-      // Call API
-      callApi(creds)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UNAUTHORIZED);
-          expect(res.body.error).toBe(UnauthorizedError.Msg);
-          done();
-        });
-    });
-
-    // Fallback error
-    it(msgs.fallbackErr, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'someBadPassword',
-      };
-      spyOn(userRepo, 'getOne').and.throwError('Database query failed.');
-      // Call API
-      callApi(creds)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBeTruthy();
-          done();
-        });
-    });
-  });
-
-  // Test logout
-  describe(`"GET:${logoutPath}"`, () => {
-
-    it(msgs.goodLogout, (done) => {
-      agent.get(logoutPath)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          done();
-        });
-    });
-  });
-});
-
-
-// **** Helper functions **** //
-
-function hashPwd(pwd: string) {
-  return bcrypt.hashSync(pwd, pwdSaltRounds);
-}

package/lib/socket-io/spec/tests/chat.spec.ts

@@ -1,150 +0,0 @@
-import supertest from 'supertest';
-import StatusCodes from 'http-status-codes';
-import SocketIoClient, { Socket as ClientSocket } from 'socket.io-client';
-import { SuperTest, Test, Response } from 'supertest';
-
-import app from '@server';
-import { pErr } from '@shared/functions';
-import { p as chatPaths } from '@routes/chat-router';
-import loginAgent from '../support/login-agent';
-import { RoomNotFoundError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Paths
-const chatPath = '/api/chat',
-  connectSocketRmPath = `${chatPath}${chatPaths.connect}`,
-  emitMessagePath = `${chatPath}${chatPaths.emit}`;
-
-// Http codes
-const { BAD_REQUEST, OK } = StatusCodes;
-
-// Messages
-const msgs = {
-  connectSuccess: `should return a response with a status of "${OK}" if the user successfully 
-    connected to the socket room`,
-  connectionFailed: `should return a response with a status of "${RoomNotFoundError.HttpStatus}" 
-    if the user did not connect to the socket room`,
-  sendMsgSuccess: `should return a response with a status of "${OK}" and the logged-in user's 
-    name`,
-  sendMsgFailed: `should return a response with a status of "${BAD_REQUEST}" and if the 
-    send-message request failed.`,
-}
-
-
-// **** Types **** //
-
-type TReqBody = string | object | undefined;
-
-
-// **** Tests **** //
-
-describe('chat-router', () => {
-
-  let agent: SuperTest<Test>;
-  let socket: ClientSocket;
-  let jwtCookie = '';
-
-  // Run before all tests
-  beforeAll((done) => {
-    agent = supertest.agent(app);
-    loginAgent.login(agent, (cookie: string) => {
-      const url = agent.get('/').url;
-      jwtCookie = cookie;
-      socket = SocketIoClient(url, {
-        reconnectionDelay: 0,
-        forceNew: true,
-      });
-      socket.on('connect', async () => {
-        console.log('socket connected');
-        done();
-      });
-      socket.on('disconnect', () => {
-        console.log('socket disconnected');
-      });
-    });
-  });
-
-  // Test connect to the socket room
-  describe(`"GET - ${connectSocketRmPath}"`, () => {
-
-    const callApi = (socketId: string) => {
-      const path = connectSocketRmPath.replace(':socketId', socketId);
-      return agent.get(path).set('Cookie', jwtCookie);
-    };
-
-    // Connection to the room successful
-    it(msgs.connectSuccess, (done) => {
-      callApi(socket.id)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          done();
-        });
-    });
-
-    // Connection to the room failed
-    it(msgs.connectionFailed, (done) => {
-      callApi('some-bad-socket-id')
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(RoomNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(RoomNotFoundError.Msg);
-          done();
-        });
-    });
-  });
-
-  // Test sending a message
-  describe(`"POST - ${emitMessagePath}"`, () => {
-
-    const callApi = (reqBody: TReqBody) => {
-      return agent.post(emitMessagePath)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
-    };
-
-    // Send message successfull
-    it(msgs.sendMsgSuccess, (done) => {
-      callApi({
-        socketId: socket.id,
-        message: 'How are you today?',
-      })
-      .end((err: Error, res: Response) => {
-        pErr(err);
-        expect(res.status).toBe(OK);
-        expect(res.body.senderName).toBe(loginAgent.creds.name);
-        done();
-      });
-    });
-
-    // Send message failed
-    it(msgs.sendMsgFailed, (done) => {
-      callApi({
-        socketId: 'Some bad socket id',
-        message: 'How are you today?',
-      })
-      .end((err: Error, res: Response) => {
-        pErr(err);
-        expect(res.status).toBe(RoomNotFoundError.HttpStatus);
-        expect(res.body.error).toBe(RoomNotFoundError.Msg);
-        done();
-      });
-    });
-  });
-
-  // Run after all tests
-  afterAll((done) => {
-    // Cleanup
-    if (socket.connected) {
-      console.log('socket disconnecting...');
-      socket.disconnect();
-    } else {
-      // There will not be a connection unless you have done() in beforeAll, 
-      // socket.on('connect'...)
-      console.log('no connection to break...');
-    }
-    done();
-  });
-});

package/lib/socket-io/spec/tests/users.spec.ts

@@ -1,283 +0,0 @@
-import supertest from 'supertest';
-import StatusCodes from 'http-status-codes';
-import { SuperTest, Test, Response } from 'supertest';
-
-import app from '@server';
-import userRepo from '@repos/user-repo';
-import User, { IUser } from '@models/user-model';
-import { pErr } from '@shared/functions';
-import { p as userPaths } from '@routes/user-router';
-import loginAgent from '../support/login-agent';
-import { ParamMissingError, UserNotFoundError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Misc
-const usersPath = '/api/users',
-  getUsersPath = `${usersPath}${userPaths.get}`,
-  addUsersPath = `${usersPath}${userPaths.add}`,
-  updateUserPath = `${usersPath}${userPaths.update}`,
-  deleteUserPath = `${usersPath}${userPaths.delete}`,
-  { BAD_REQUEST, CREATED, OK } = StatusCodes;
-
-// Dummy users for GET req
-const dummyGetAllUsers = [
-  User.new('Sean Maxwell', 'sean.maxwell@gmail.com'),
-  User.new('John Smith', 'john.smith@gmail.com'),
-  User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
-] as const;
-
-// Dummy update user
-const dummyUserData = {
-  user: User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
-} as const;
-
-// Test messages
-const msgs = {
-  getUsersSuccess: `should return a JSON object with all the users and a status code of 
-    "${OK}" if the request was successful.`,
-  getUsersBad: `should return a JSON object containing an error message and a status code of
-    "${BAD_REQUEST}" if the request was unsuccessful.`,
-  addUserSuccess: `should return a status code of "${CREATED}" if the request was successful.`,
-  addUserFailedMissingParam: `should return a JSON object with an error message of 
-    "${ParamMissingError.Msg}" and a status code of "${BAD_REQUEST}" if the user param was 
-    missing.`,
-  addUserFallbackErr: `should return a JSON object with an error message and a status code 
-    of "${BAD_REQUEST}" if the request was unsuccessful.`,
-  updateSuccess: `should return a status code of "${OK}" if the request was successful.`,
-  updateParamMissing: `should return a JSON object with an error message of 
-    "${ParamMissingError.Msg}" and a status code of "${BAD_REQUEST}" if the user param was 
-    missing.`,
-  updateUserNotFound: `should return a JSON object with the error message of 
-    ${UserNotFoundError.Msg} and a status code of "${UserNotFoundError.HttpStatus}" if the id 
-    was not found.`,
-  updateFallbackErr: `should return a JSON object with an error message and a status code of 
-    "${BAD_REQUEST}" if the request was unsuccessful.`,
-  deleteSuccessful: `should return a status code of "${OK}" if the request was successful.`,
-  deleteUserNotFound: `should return a JSON object with the error message of 
-    ${UserNotFoundError.Msg} and a status code of "${UserNotFoundError.HttpStatus}" if the id was 
-    not found.`,
-  deleteFallbackErr: `should return a JSON object with an error message and a status code of 
-    "${BAD_REQUEST}" if the request was unsuccessful.`,
-};
-
-
-// **** Types **** //
-
-type TReqBody = string | object | undefined;
-
-
-// **** Tests **** //
-
-describe('user-router', () => {
-
-  let agent: SuperTest<Test>;
-  let jwtCookie: string;
-
-
-  // Run before all tests
-  beforeAll((done) => {
-    agent = supertest.agent(app);
-    loginAgent.login(agent, (cookie: string) => {
-      jwtCookie = cookie;
-      done();
-    });
-  });
-
-  // Test get users
-  describe(`"GET:${getUsersPath}"`, () => {
-
-    const callApi = () => 
-      agent.get(getUsersPath)
-      .set('Cookie', jwtCookie);
-
-    // Get all users
-    it(msgs.getUsersSuccess, (done) => {
-      const ret = Promise.resolve([...dummyGetAllUsers]);
-      spyOn(userRepo, 'getAll').and.returnValue(ret);
-      // Call API
-      callApi().end((err: Error, res: Response) => {
-        pErr(err);
-        expect(res.status).toBe(OK);
-        // Caste instance-objects to 'User' objects
-        const respUsers = res.body.users;
-        const retUsers: IUser[] = respUsers.map((user: IUser) => User.copy(user));
-        expect(retUsers).toEqual(dummyGetAllUsers);
-        expect(res.body.error).toBeUndefined();
-        done();
-      });
-    });
-
-    // Get all users bad
-    it(msgs.getUsersBad, (done) => {
-      const errMsg = 'Could not fetch users.';
-      spyOn(userRepo, 'getAll').and.throwError(errMsg);
-      // Call API
-      callApi()
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(errMsg);
-          done();
-        });
-    });
-  });
-
-  // Test add user
-  describe(`"POST:${addUsersPath}"`, () => {
-
-    // Consts
-    const callApi = (reqBody: TReqBody) => {
-      return agent.post(addUsersPath)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
-    };
-
-    // Test add user success
-    it(msgs.addUserSuccess, (done) => {
-      spyOn(userRepo, 'add').and.returnValue(Promise.resolve());
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(CREATED);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Test add user failed due to missing param
-    it(msgs.addUserFailedMissingParam, (done) => {
-      callApi({})
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ParamMissingError.Msg);
-          done();
-        });
-    });
-
-    // Default error
-    it(msgs.addUserFallbackErr, (done) => {
-      const errMsg = 'Could not add user.';
-      spyOn(userRepo, 'add').and.throwError(errMsg);
-      // Call API
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(errMsg);
-          done();
-        });
-    });
-  });
-
-  // Test update users
-  describe(`"PUT:${updateUserPath}"`, () => {
-
-    const callApi = (reqBody: TReqBody) => 
-      agent.put(updateUserPath)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
-
-    // Test updating a user success
-    it(msgs.updateSuccess, (done) => {
-      spyOn(userRepo, 'update').and.returnValue(Promise.resolve());
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      // Call api
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Test updating a user failed because a param was missing
-    it(msgs.updateParamMissing, (done) => {
-      callApi({})
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ParamMissingError.Msg);
-          done();
-        });
-    });
-
-    // Update user not found
-    it(msgs.updateUserNotFound, (done) => {
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
-          done();
-        });
-    });
-
-    // Update fallback error
-    it(msgs.updateFallbackErr, (done) => {
-      const updateErrMsg = 'Could not update user.';
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      spyOn(userRepo, 'update').and.throwError(updateErrMsg);
-      // Call API
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(updateErrMsg);
-          done();
-        });
-    });
-  });
-
-  // Test delete user
-  describe(`"DELETE:${deleteUserPath}"`, () => {
-
-    const callApi = (id: number) => {
-      const path = deleteUserPath.replace(':id', id.toString());
-      return agent.delete(path).set('Cookie', jwtCookie);
-    };
-
-    // Delete user successful
-    it(msgs.deleteSuccessful, (done) => {
-      spyOn(userRepo, 'delete').and.returnValue(Promise.resolve());
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      // Call api
-      callApi(5)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Delete, user not found error
-    it(msgs.deleteUserNotFound, (done) => {
-      callApi(-1)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
-          done();
-        });
-    });
-
-    // Delete user fallback error
-    it(msgs.deleteFallbackErr, (done) => {
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      const deleteErrMsg = 'Could not delete user.';
-      spyOn(userRepo, 'delete').and.throwError(deleteErrMsg);
-      // Call API
-      callApi(1)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(deleteErrMsg);
-          done();
-        });
-    });
-  });
-});

package/lib/socket-io/src/index.ts

@@ -1,14 +0,0 @@
-import './pre-start'; // Must be the first import
-import logger from 'jet-logger';
-
-import server from './server';
-import envVars from '@shared/env-vars';
-
-
-// Constants
-const serverStartMsg = 'Express server started on port: ';
-
-// Start server
-server.listen(envVars.port, () => {
-  logger.info(serverStartMsg + envVars.port.toString());
-});

package/lib/socket-io/src/models/user-model.ts

@@ -1,56 +0,0 @@
-// **** Types **** //
-
-export enum UserRoles {
-  Standard,
-  Admin,
-}
-
-export interface IUser {
-  id: number;
-  name: string;
-  email: string;
-  pwdHash: string;
-  role: UserRoles;
-}
-
-
-// **** Functions **** //
-
-/**
- * Get a new User object.
- */
-function _new(
-  name: string,
-  email: string,
-  role?: UserRoles,
-  pwdHash?: string,
-): IUser {
-  return {
-    id: -1,
-    email,
-    name,
-    role: (role ?? UserRoles.Standard),
-    pwdHash: (pwdHash ?? ''),
-  };
-}
-
-/**
- * Copy a user object.
- */
-function copy(user: IUser): IUser {
-  return {
-    id: user.id,
-    email: user.email,
-    name: user.name,
-    role: user.role,
-    pwdHash: user.pwdHash,
-  };
-}
-
-
-// **** Export default **** //
-
-export default {
-  new: _new,
-  copy,
-};

package/lib/socket-io/src/pre-start/env/development.env

@@ -1,23 +0,0 @@
-## Environment ##
-NODE_ENV=development
-
-
-## Server ##
-PORT=3000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000